Merge pull request #7987 from getkirby/refact/ts-object-helper

refact: Migrate `$helper.object` to TypeScript

Author: distantnative

panel/lab/internals/helpers/object/index.php

@@ -1,5 +1,5 @@
 <?php
 
 return [
-	'source' => 'panel/src/helpers/object.js'
+	'source' => 'panel/src/helpers/object.ts'
 ];

panel/src/api/request.js

@@ -1,5 +1,5 @@
 import { responder, safeFetch } from "@/panel/request.js";
-import { toLowerKeys } from "@/helpers/object.js";
+import { toLowerKeys } from "@/helpers/object";
 import { ltrim, rtrim } from "@/helpers/string";
 
 export default (api) => {

panel/src/components/Dialogs/Elements/Buttons.vue

@@ -6,8 +6,6 @@
 </template>
 
 <script>
-import { isObject } from "@/helpers/object.js";
-
 export const props = {
 	props: {
 		/**
@@ -94,7 +92,7 @@ export default {
 				return false;
 			}
 
-			if (isObject(button) === false) {
+			if (this.$helper.object.isObject(button) === false) {
 				return defaults;
 			}
 

panel/src/helpers/index.js

@@ -10,7 +10,7 @@ import isComponent from "./isComponent";
 import isUploadEvent from "./isUploadEvent";
 import keyboard from "./keyboard";
 import link from "./link.js";
-import object from "./object.js";
+import object from "./object";
 import page from "./page.js";
 import ratio from "./ratio.js";
 import sort from "./sort.js";

panel/src/helpers/link.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { length } from "./object.js";
+import { length } from "./object";
 import link from "./link.js";
 
 // mock $t() function

panel/src/helpers/object.clone.test.js panel/src/helpers/object.clone.test.tspanel/src/helpers/object.clone.test.js renamed to panel/src/helpers/object.clone.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { clone } from "./object.js";
+import { clone } from "./object";
 
 describe.concurrent("$helper.object.clone()", () => {
 	it("should clone an object", () => {

panel/src/helpers/object.isEmpty.test.js panel/src/helpers/object.isEmpty.test.tspanel/src/helpers/object.isEmpty.test.js renamed to panel/src/helpers/object.isEmpty.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from "vitest";
-import { isEmpty } from "./object.js";
+import { isEmpty } from "./object";
 
 describe.concurrent("$helper.object.isEmpty()", () => {
 	it("should detect empty values as true", () => {

panel/src/helpers/object.isObject.test.js panel/src/helpers/object.isObject.test.tspanel/src/helpers/object.isObject.test.js renamed to panel/src/helpers/object.isObject.test.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it } from "vitest";
 import { isObject } from "./object";
 
-describe.concurrent("isObject", () => {
+describe.concurrent("$helper.object.isObject()", () => {
 	it("returns true for an object", () => {
 		expect(isObject({})).toBe(true);
 		expect(isObject({ a: 1, b: 2 })).toBe(true);

panel/src/helpers/object.js

@@ -1,9 +1,9 @@
 import { describe, expect, it } from "vitest";
-import object from "./object.js";
+import { length } from "./object";
 
-describe("$helper.object.merge", () => {
+describe("$helper.object.length()", () => {
 	it("should count object props", () => {
-		const result = object.length({
+		const result = length({
 			a: "a",
 			b: "b",
 			c: "c"
@@ -13,17 +13,17 @@ describe("$helper.object.merge", () => {
 	});
 
 	it("should work with empty objects", () => {
-		const result = object.length({});
+		const result = length({});
 		expect(result).toStrictEqual(0);
 	});
 
 	it("should work with undefined objects", () => {
-		const result = object.length();
+		const result = length();
 		expect(result).toStrictEqual(0);
 	});
 
 	it("should also work with arrays", () => {
-		const result = object.length(["a", "b", "c"]);
+		const result = length(["a", "b", "c"]);
 
 		expect(result).toStrictEqual(3);
 	});