@kontent-ai/custom-app-sdk 2.1.0 → 2.1.1

package/README.md

@@ -18,6 +18,8 @@ It facilitates the communication between the Kontent.ai app and the custom app p
 ### Installation
 
 ```sh
+pnpm add @kontent-ai/custom-app-sdk
+# or
 npm install @kontent-ai/custom-app-sdk
 ```
 

package/dist/contexts.d.ts

@@ -1,19 +1,24 @@
 import type { CustomAppContextProperties } from "./iframeSchema";
+type MakeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 declare const itemEditorContextProperties: readonly ["path", "pageTitle", "environmentId", "userId", "userEmail", "userRoles", "appConfig", "contentItemId", "languageId", "validationErrors", "currentPage"];
+declare const optionalProperties: readonly ["appConfig"];
 type RawItemEditorContext = Pick<CustomAppContextProperties, (typeof itemEditorContextProperties)[number]>;
-export type ItemEditorContext = Required<WithSpecificPage<CustomAppContextProperties, "itemEditor">>;
+export type ItemEditorContext = MakeOptional<Required<RawItemEditorContext>, (typeof optionalProperties)[number]> & {
+    readonly currentPage: "itemEditor";
+};
 export declare const isItemEditorContext: (context: RawItemEditorContext) => context is ItemEditorContext;
 declare const itemListingContextProperties: readonly ["path", "pageTitle", "environmentId", "userId", "userEmail", "userRoles", "appConfig", "languageId", "itemListingFilter", "itemListingSelection", "currentPage"];
 type RawItemListingContext = Pick<CustomAppContextProperties, (typeof itemListingContextProperties)[number]>;
-export type ItemListingContext = Required<WithSpecificPage<CustomAppContextProperties, "contentInventory">>;
+export type ItemListingContext = MakeOptional<Required<RawItemListingContext>, (typeof optionalProperties)[number]> & {
+    readonly currentPage: "contentInventory";
+};
 export declare const isItemListingContext: (context: RawItemListingContext) => context is ItemListingContext;
 declare const otherContextProperties: readonly ["path", "pageTitle", "environmentId", "userId", "userEmail", "userRoles", "appConfig", "currentPage"];
 type RawOtherContext = Pick<CustomAppContextProperties, (typeof otherContextProperties)[number]>;
-export type OtherContext = Required<WithSpecificPage<CustomAppContextProperties, "other">>;
+export type OtherContext = MakeOptional<Required<RawOtherContext>, (typeof optionalProperties)[number]> & {
+    readonly currentPage: "other";
+};
 export declare const isOtherContext: (context: RawOtherContext) => context is OtherContext;
 export type Context = ItemEditorContext | ItemListingContext | OtherContext;
-type WithSpecificPage<T extends CustomAppContextProperties, Page extends Context["currentPage"]> = T & {
-    readonly currentPage: Page;
-};
 export declare const getContextPropertiesForPage: (currentPage: Context["currentPage"] | undefined) => ReadonlyArray<keyof CustomAppContextProperties>;
 export {};

package/dist/contexts.js

@@ -14,13 +14,12 @@ const itemEditorContextProperties = [
     "validationErrors",
     "currentPage",
 ];
-const optionalProperties = [
-    "appConfig",
-];
+const optionalProperties = ["appConfig"];
+const isOptionalProperty = (property) => !optionalProperties.includes(property);
 export const isItemEditorContext = (context) => {
     return (context.currentPage === "itemEditor" &&
         itemEditorContextProperties
-            .filter((property) => !optionalProperties.includes(property))
+            .filter(isOptionalProperty)
             .every((property) => property in context && context[property] !== undefined));
 };
 const itemListingContextProperties = [
@@ -33,7 +32,7 @@ const itemListingContextProperties = [
 export const isItemListingContext = (context) => {
     return (context.currentPage === "contentInventory" &&
         itemListingContextProperties
-            .filter((property) => !optionalProperties.includes(property))
+            .filter(isOptionalProperty)
             .every((property) => property in context && context[property] !== undefined));
 };
 const otherContextProperties = [
@@ -43,7 +42,7 @@ const otherContextProperties = [
 export const isOtherContext = (context) => {
     return (context.currentPage === "other" &&
         otherContextProperties
-            .filter((property) => !optionalProperties.includes(property))
+            .filter(isOptionalProperty)
             .every((property) => property in context && context[property] !== undefined));
 };
 export const getContextPropertiesForPage = (currentPage) => {

package/dist/contexts.js.map

@@ -1 +1 @@
-{"version":3,"file":"contexts.js","sourceRoot":"","sources":["../src/contexts.ts"],"names":[],"mappings":"AAEA,MAAM,uBAAuB,GAAG;IAC9B,MAAM;IACN,WAAW;IACX,eAAe;IACf,QAAQ;IACR,WAAW;IACX,WAAW;IACX,WAAW;CACuD,CAAC;AAErE,MAAM,2BAA2B,GAAG;IAClC,GAAG,uBAAuB;IAC1B,eAAe;IACf,YAAY;IACZ,kBAAkB;IAClB,aAAa;CACqD,CAAC;AAErE,MAAM,kBAAkB,GAAoD;IAC1E,WAAW;CACuD,CAAC;AAWrE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,OAA6B,EACC,EAAE;IAChC,OAAO,CACL,OAAO,CAAC,WAAW,KAAK,YAAY;QACpC,2BAA2B;aACxB,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;aAC5D,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,CAC/E,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,4BAA4B,GAAG;IACnC,GAAG,uBAAuB;IAC1B,YAAY;IACZ,mBAAmB;IACnB,sBAAsB;IACtB,aAAa;CACqD,CAAC;AAWrE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,OAA8B,EACC,EAAE;IACjC,OAAO,CACL,OAAO,CAAC,WAAW,KAAK,kBAAkB;QAC1C,4BAA4B;aACzB,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;aAC5D,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,CAC/E,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG;IAC7B,GAAG,uBAAuB;IAC1B,aAAa;CACqD,CAAC;AAMrE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAwB,EAA2B,EAAE;IAClF,OAAO,CACL,OAAO,CAAC,WAAW,KAAK,OAAO;QAC/B,sBAAsB;aACnB,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;aAC5D,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,CAC/E,CAAC;AACJ,CAAC,CAAC;AASF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,WAA+C,EACE,EAAE;IACnD,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,YAAY;YACf,OAAO,2BAA2B,CAAC;QACrC,KAAK,kBAAkB;YACrB,OAAO,4BAA4B,CAAC;QACtC,KAAK,OAAO;YACV,OAAO,sBAAsB,CAAC;QAChC,KAAK,SAAS;YACZ,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"contexts.js","sourceRoot":"","sources":["../src/contexts.ts"],"names":[],"mappings":"AAIA,MAAM,uBAAuB,GAAG;IAC9B,MAAM;IACN,WAAW;IACX,eAAe;IACf,QAAQ;IACR,WAAW;IACX,WAAW;IACX,WAAW;CACuD,CAAC;AAErE,MAAM,2BAA2B,GAAG;IAClC,GAAG,uBAAuB;IAC1B,eAAe;IACf,YAAY;IACZ,kBAAkB;IAClB,aAAa;CACqD,CAAC;AAErE,MAAM,kBAAkB,GAAG,CAAC,WAAW,CAEtC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,QAA0C,EAAW,EAAE,CACjF,CAAE,kBAAwC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAYhE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,OAA6B,EACC,EAAE;IAChC,OAAO,CACL,OAAO,CAAC,WAAW,KAAK,YAAY;QACpC,2BAA2B;aACxB,MAAM,CAAC,kBAAkB,CAAC;aAC1B,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,CAC/E,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,4BAA4B,GAAG;IACnC,GAAG,uBAAuB;IAC1B,YAAY;IACZ,mBAAmB;IACnB,sBAAsB;IACtB,aAAa;CACqD,CAAC;AAYrE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,OAA8B,EACC,EAAE;IACjC,OAAO,CACL,OAAO,CAAC,WAAW,KAAK,kBAAkB;QAC1C,4BAA4B;aACzB,MAAM,CAAC,kBAAkB,CAAC;aAC1B,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,CAC/E,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG;IAC7B,GAAG,uBAAuB;IAC1B,aAAa;CACqD,CAAC;AASrE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAwB,EAA2B,EAAE;IAClF,OAAO,CACL,OAAO,CAAC,WAAW,KAAK,OAAO;QAC/B,sBAAsB;aACnB,MAAM,CAAC,kBAAkB,CAAC;aAC1B,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,CAC/E,CAAC;AACJ,CAAC,CAAC;AAIF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,WAA+C,EACE,EAAE;IACnD,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,YAAY;YACf,OAAO,2BAA2B,CAAC;QACrC,KAAK,kBAAkB;YACrB,OAAO,4BAA4B,CAAC;QACtC,KAAK,OAAO;YACV,OAAO,sBAAsB,CAAC;QAChC,KAAK,SAAS;YACZ,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC,CAAC"}

package/dist/contexts.test-d.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/contexts.test-d.js

@@ -0,0 +1,26 @@
+import { describe, expectTypeOf, test } from "vitest";
+describe("Context types have correct properties", () => {
+    test("ItemEditorContext has only item editor properties", () => {
+        expectTypeOf().toBeNullable();
+        expectTypeOf().toEqualTypeOf();
+    });
+    test("ItemListingContext has only item listing properties", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    test("OtherContext has only shared properties", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    test("Context is a discriminated union by currentPage", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    test("ItemEditorContext has literal currentPage", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    test("ItemListingContext has literal currentPage", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    test("OtherContext has literal currentPage", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+});
+//# sourceMappingURL=contexts.test-d.js.map

package/dist/contexts.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contexts.test-d.js","sourceRoot":"","sources":["../src/contexts.test-d.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAGtD,QAAQ,CAAC,uCAAuC,EAAE,GAAG,EAAE;IACrD,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC7D,YAAY,EAAkC,CAAC,YAAY,EAAE,CAAC;QAC9D,YAAY,EAA2B,CAAC,aAAa,EAYlD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC/D,YAAY,EAA4B,CAAC,aAAa,EAYnD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACnD,YAAY,EAAsB,CAAC,aAAa,EAS7C,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;QAC3D,YAAY,EAA0B,CAAC,aAAa,EAEjD,CAAC;IACN,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACrD,YAAY,EAAoC,CAAC,aAAa,EAAgB,CAAC;IACjF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACtD,YAAY,EAAqC,CAAC,aAAa,EAAsB,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAChD,YAAY,EAA+B,CAAC,aAAa,EAAW,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kontent-ai/custom-app-sdk",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "description": "The Kontent.ai Custom App SDK enhances the integration of your custom app with the Kontent.ai platform.",
   "license": "MIT",
   "author": "Kontent.ai",
@@ -19,17 +19,19 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "scripts": {
-    "build": "tsc",
-    "format-check": "npx @biomejs/biome ci ./src",
-    "format": "npx @biomejs/biome check --write ./src"
-  },
   "dependencies": {
     "zod": "^4.1.11"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.2.4",
     "@types/node": "^22.9.0",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "vitest": "^4.0.15"
+  },
+  "scripts": {
+    "build": "tsc",
+    "format-check": "biome ci ./src",
+    "format": "biome check --write ./src",
+    "test": "vitest run --typecheck"
   }
-}
+}

package/vitest.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    include: ["**/*.test.ts"],
+    typecheck: {
+      enabled: true,
+      include: ["**/*.test-d.ts"],
+    },
+  },
+});