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

package/README.md

@@ -18,23 +18,39 @@ It facilitates the communication between the Kontent.ai app and the custom app p
 ### Installation
 
 ```sh
-npm install @kontent-ai/custom-app-sdk-js
+npm install @kontent-ai/custom-app-sdk
 ```
 
 > [!IMPORTANT]  
-> The SDK attaches event listeners to communicate with the Kontent.ai app. Make sure to only include the SDK in the browser environment.
+> The SDK attaches event listeners to communicate with the Kontent.ai app. Make sure to include the SDK only in the browser environment.
 
 ## Usage example
 
 ```typescript
-import { getCustomAppContext, CustomAppContext } from "@kontent-ai/custom-app-sdk-js";
+import { getCustomAppContext, CustomAppContext } from "@kontent-ai/custom-app-sdk";
 
-const response: CustomAppContext = await getCustomAppContext();
+const response = await getCustomAppContext();
 
 if (response.isError) {
-  console.error({ errorCode: response.code, description: response.description});
+  console.error({ errorCode: response.code, description: response.description });
 } else {
-  console.log({ config: response.config, context: response.context });
+  // TypeScript will narrow the type based on currentPage
+  switch (response.context.currentPage) {
+    case "itemEditor":
+      console.log({
+        contentItemId: response.context.contentItemId,
+        languageId: response.context.languageId,
+        validationErrors: response.context.validationErrors
+      });
+      break;
+    case "contentInventory":
+      console.log({
+        languageId: response.context.languageId,
+        itemListingFilter: response.context.itemListingFilter,
+        itemListingSelection: response.context.itemListingSelection
+      });
+      break;
+  }
 }
 ```
 
@@ -42,38 +58,233 @@ if (response.isError) {
 
 ### getCustomAppContext
 
-Use the `getCustomAppContext` function to retrieve context of the custom app. The function takes no arguments and returns a promise with a value of an object of type `CustomAppContext`.
+Retrieves the context of the custom app. The function takes no arguments and automatically detects the current page type, returning the appropriate context with all relevant properties for that page.
 
-#### CustomAppContext
+#### Return Type
+
+Returns a promise that resolves to a discriminated union type with two possible states:
+
+##### Success Response (`isError: false`)
 
 | Property      | Type                   | Description                                                                  |
 |---------------|------------------------|------------------------------------------------------------------------------|
-| `isError`     | boolean                | Determines if there was an error while getting the context of the custom app |
-| `code`        | ErrorCode enum \| null | The code of the error message                                                |
-| `description` | string \| null         | The description of the error message                                         |
-| `context`     | object \| null         | Contains data provided by the Kontent.ai application                         |
-| `config`      | object \| null         | Contains JSON object specified in the custom app configuration               |
+| `isError`     | `false`                | Indicates the request was successful                                         |
+| `context`     | `CustomAppContext`     | A discriminated union of page-specific context objects                      |
+
+##### Error Response (`isError: true`)
+
+| Property      | Type                   | Description                                                                  |
+|---------------|------------------------|------------------------------------------------------------------------------|
+| `isError`     | `true`                 | Indicates an error occurred                                                  |
+| `code`        | ErrorCode enum         | The code of the error message                                                |
+| `description` | string                 | The description of the error message                                         |
+
+#### CustomAppContext
+
+`CustomAppContext` is a discriminated union type based on the `currentPage` property. Each page type includes only the relevant properties for that specific page:
+
+##### Shared Properties
 
-#### Config 
-The `config` object is a JSON object that can be defined within the Custom App configuration under Environment settings in the Kontent.ai app.
+All context types include the following shared properties:
 
-#### Context 
-The `context` object contains data provided by the Kontent.ai application that you can leverage in your custom app. 
+| Property                | Type                                  | Description                                                          |
+|-------------------------|---------------------------------------|----------------------------------------------------------------------|
+| `environmentId`         | UUID                                  | The environment's ID                                                 |
+| `userId`                | string                                | The current user's ID                                                |
+| `userEmail`             | string                                | The current user's email                                             |
+| `userRoles`             | Array\<UserRole\>                     | An array containing all the roles of the current user in the environment |
+| `path`                  | string                                | The current path within the Kontent.ai application                  |
+| `pageTitle`             | string                                | The title of the current page                                       |
+| `appConfig`             | unknown \| undefined                  | JSON object specified in the custom app configuration               |
 
-| Property        | Type              | Description                                                              |
-|-----------------|-------------------|--------------------------------------------------------------------------|
-| `environmentId` | UUID              | The environment's ID                                                     |
-| `userId`        | string            | The current user's ID                                                    |
-| `userEmail`     | string            | The current user's email                                                 |
-| `userRoles`     | Array of UserRole | An array containing all the roles of the current user in the environment |
+##### Item Editor Page Context
 
-#### UserRole 
+When `currentPage` is `"itemEditor"`, the context includes the shared properties above plus:
+
+| Property                | Type                                  | Description                                                          |
+|-------------------------|---------------------------------------|----------------------------------------------------------------------|
+| `currentPage`           | `"itemEditor"`                       | Identifies this as an item editor page                              |
+| `contentItemId`         | UUID                                  | The ID of the content item being edited                             |
+| `languageId`            | UUID                                  | The ID of the current language                                      |
+| `validationErrors`      | Record<string, Array<string>>              | A record of validation errors for content item fields               |
+
+##### Content Inventory Page Context
+
+When `currentPage` is `"contentInventory"`, the context includes the shared properties above plus:
+
+| Property                | Type                                  | Description                                                          |
+|-------------------------|---------------------------------------|----------------------------------------------------------------------|
+| `currentPage`           | `"contentInventory"`                 | Identifies this as a content inventory (item listing) page          |
+| `languageId`            | UUID                                  | The ID of the current language                                      |
+| `itemListingFilter`     | SerializedListingFilter               | The current filter settings applied to the content item listing     |
+| `itemListingSelection`  | ItemListingSelection                  | The current selection state of items in the listing                 |
+
+##### Other Page Context
+
+When `currentPage` is `"other"`, the context includes the shared properties above plus:
+
+| Property                | Type                                  | Description                                                          |
+|-------------------------|---------------------------------------|----------------------------------------------------------------------|
+| `currentPage`           | `"other"`                            | Identifies this as any other page type                              |
+
+#### UserRole
 
 | Property   | Type   | Description                                                          |
 |------------|--------|----------------------------------------------------------------------|
 | `id`       | UUID   | The role's ID                                                        |
 | `codename` | string | The role's codename - applicable only for the _Project manager_ role |
 
+#### SerializedListingFilter
+
+The filter settings applied to the content item listing.
+
+| Property                    | Type                                                | Description                                                  |
+|-----------------------------|-----------------------------------------------------|--------------------------------------------------------------|
+| `selectedCollections`       | Array\<string\>                                     | IDs of collections selected in the filter                    |
+| `selectedContentItemStatus` | Array\<VariantCompletionStatus\>                    | Selected content item workflow status states                 |
+| `selectedContentTypes`      | Array\<string\>                                     | IDs of content types selected in the filter                  |
+| `selectedContributors`      | Array\<string\>                                     | IDs of contributors selected in the filter                   |
+| `selectedPublishingStates`  | Array\<PublishingState\>                            | Selected publishing states                                   |
+| `selectedSpaces`            | Array\<string\>                                     | IDs of spaces selected in the filter                         |
+| `selectedTaxonomies`        | Record\<string, Array\<string\>\>                   | Selected taxonomy terms grouped by taxonomy ID               |
+| `selectedWorkflows`         | Record\<string, Array\<string\>\>                   | Selected workflow steps grouped by workflow ID               |
+| `searchPhrase`              | string                                              | The search phrase entered by the user                        |
+| `searchScope`               | Array\<string\>                                     | The scope of the search (e.g., content item names, elements) |
+
+##### VariantCompletionStatus
+
+An enum representing the possible workflow completion status states for content item variants.
+
+| Value            | Description                                    |
+|------------------|------------------------------------------------|
+| `"unfinished"`   | Content item variant is unfinished             |
+| `"ready"`        | Content item variant is ready                  |
+| `"notTranslated"`| Content item variant is not translated         |
+| `"allDone"`      | Content item variant is all done               |
+
+##### PublishingState
+
+An enum representing the possible publishing states for content items.
+
+| Value          | Description                                       |
+|----------------|---------------------------------------------------|
+| `"published"`  | Content item is published                         |
+| `"unpublished"`| Content item is unpublished                       |
+| `"none"`       | Content item has no publishing state              |
+
+#### ItemListingSelection
+
+The current selection state of items in the content inventory listing.
+
+| Property              | Type           | Description                                                                      |
+|-----------------------|----------------|----------------------------------------------------------------------------------|
+| `selectAll`           | boolean        | Whether the "select all" option is active                                        |
+| `selectedItemIds`     | Array\<UUID\>  | IDs of content items that are selected (when `selectAll` is false, these are the selected items; when `selectAll` is true, these are exceptions to the selection) |
+| `unselectedItemIds`   | Array\<UUID\>  | IDs of content items that are explicitly unselected (used when `selectAll` is true to exclude specific items) |
+
+### observeCustomAppContext
+
+Subscribes to context changes and receives notifications when the context is updated. The function takes a callback that will be invoked whenever the context changes.
+
+#### Parameters
+
+| Parameter  | Type                        | Description                                           |
+|------------|-----------------------------|-------------------------------------------------------|
+| `callback` | `(context: CustomAppContext) => void` | Function to be called when the context changes |
+
+#### Return Type
+
+Returns a promise that resolves to a discriminated union type with two possible states:
+
+##### Success Response (`isError: false`)
+
+| Property      | Type                   | Description                                                                  |
+|---------------|------------------------|------------------------------------------------------------------------------|
+| `isError`     | `false`                | Indicates the request was successful                                         |
+| `context`     | `CustomAppContext`     | The initial context value                                                    |
+| `unsubscribe` | `() => Promise<void>`  | Function to call to stop receiving context updates                          |
+
+##### Error Response (`isError: true`)
+
+| Property      | Type                   | Description                                                                  |
+|---------------|------------------------|------------------------------------------------------------------------------|
+| `isError`     | `true`                 | Indicates an error occurred                                                  |
+| `code`        | ErrorCode enum         | The code of the error message                                                |
+| `description` | string                 | The description of the error message                                         |
+
+#### Usage Example
+
+```typescript
+import { observeCustomAppContext } from "@kontent-ai/custom-app-sdk";
+
+const response = await observeCustomAppContext((context) => {
+  console.log("Context updated:", context);
+});
+
+if (response.isError) {
+  console.error({ errorCode: response.code, description: response.description });
+} else {
+  console.log("Initial context:", response.context);
+
+  // Later, when you want to stop observing
+  await response.unsubscribe();
+}
+```
+
+### setPopupSize
+
+Sets the size of the popup window when the custom app is displayed in a popup.
+
+#### Parameters
+
+| Parameter | Type                 | Description                                      |
+|-----------|----------------------|--------------------------------------------------|
+| `width`   | `PopupSizeDimension` | The desired width of the popup                   |
+| `height`  | `PopupSizeDimension` | The desired height of the popup                  |
+
+#### PopupSizeDimension
+
+A discriminated union type for specifying dimensions in either pixels or percentages:
+
+```typescript
+type PopupSizeDimension =
+  | { unit: "px"; value: number }
+  | { unit: "%"; value: number };
+```
+
+#### Return Type
+
+Returns a promise that resolves to a discriminated union type with two possible states:
+
+##### Success Response (`isError: false`)
+
+| Property      | Type                   | Description                                                                  |
+|---------------|------------------------|------------------------------------------------------------------------------|
+| `isError`     | `false`                | Indicates the request was successful                                         |
+
+##### Error Response (`isError: true`)
+
+| Property      | Type                   | Description                                                                  |
+|---------------|------------------------|------------------------------------------------------------------------------|
+| `isError`     | `true`                 | Indicates an error occurred                                                  |
+| `code`        | ErrorCode enum         | The code of the error message                                                |
+| `description` | string                 | The description of the error message                                         |
+
+#### Usage Example
+
+```typescript
+import { setPopupSize } from "@kontent-ai/custom-app-sdk";
+
+const response = await setPopupSize(
+  { unit: "px", value: 800 },
+  { unit: "%", value: 90 }
+);
+
+if (response.isError) {
+  console.error({ errorCode: response.code, description: response.description });
+}
+```
+
 ## Contributing
 
 For Contributing please see  <a href="./CONTRIBUTING.md">`CONTRIBUTING.md`</a> for more information.

package/dist/contexts.d.ts

@@ -0,0 +1,19 @@
+import type { CustomAppContextProperties } from "./iframeSchema";
+declare const itemEditorContextProperties: readonly ["path", "pageTitle", "environmentId", "userId", "userEmail", "userRoles", "appConfig", "contentItemId", "languageId", "validationErrors", "currentPage"];
+type RawItemEditorContext = Pick<CustomAppContextProperties, (typeof itemEditorContextProperties)[number]>;
+export type ItemEditorContext = Required<WithSpecificPage<CustomAppContextProperties, "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 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 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

@@ -0,0 +1,61 @@
+const sharedContextProperties = [
+    "path",
+    "pageTitle",
+    "environmentId",
+    "userId",
+    "userEmail",
+    "userRoles",
+    "appConfig",
+];
+const itemEditorContextProperties = [
+    ...sharedContextProperties,
+    "contentItemId",
+    "languageId",
+    "validationErrors",
+    "currentPage",
+];
+const optionalProperties = [
+    "appConfig",
+];
+export const isItemEditorContext = (context) => {
+    return (context.currentPage === "itemEditor" &&
+        itemEditorContextProperties
+            .filter((property) => !optionalProperties.includes(property))
+            .every((property) => property in context && context[property] !== undefined));
+};
+const itemListingContextProperties = [
+    ...sharedContextProperties,
+    "languageId",
+    "itemListingFilter",
+    "itemListingSelection",
+    "currentPage",
+];
+export const isItemListingContext = (context) => {
+    return (context.currentPage === "contentInventory" &&
+        itemListingContextProperties
+            .filter((property) => !optionalProperties.includes(property))
+            .every((property) => property in context && context[property] !== undefined));
+};
+const otherContextProperties = [
+    ...sharedContextProperties,
+    "currentPage",
+];
+export const isOtherContext = (context) => {
+    return (context.currentPage === "other" &&
+        otherContextProperties
+            .filter((property) => !optionalProperties.includes(property))
+            .every((property) => property in context && context[property] !== undefined));
+};
+export const getContextPropertiesForPage = (currentPage) => {
+    switch (currentPage) {
+        case "itemEditor":
+            return itemEditorContextProperties;
+        case "contentInventory":
+            return itemListingContextProperties;
+        case "other":
+            return otherContextProperties;
+        case undefined:
+            return [];
+    }
+};
+//# sourceMappingURL=contexts.js.map

package/dist/contexts.js.map

@@ -0,0 +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"}

package/dist/customAppSdk.d.ts

@@ -1,21 +1,33 @@
+import { type Context } from "./contexts";
+import { PublishingState, type SerializedListingFilter, type Uuid, VariantCompletionStatus } from "./iframeSchema";
+export { PublishingState, VariantCompletionStatus };
+export type { SerializedListingFilter, Uuid };
 export declare enum ErrorCode {
-    UnknownMessage = "unknown-message"
+    UnknownMessage = "unknown-message",
+    NotSupported = "not-supported",
+    OutdatedContext = "outdated-context"
 }
-export type CustomAppContext = {
-    readonly isError: false;
-    readonly context: {
-        readonly environmentId: string;
-        readonly userId: string;
-        readonly userEmail: string;
-        readonly userRoles: ReadonlyArray<{
-            readonly id: string;
-            readonly codename: string | null;
-        }>;
-    };
-    readonly config?: unknown;
+export declare const getCustomAppContext: () => Promise<Result<{
+    readonly context: Context;
+}>>;
+export type PopupSizeDimension = {
+    readonly unit: "px";
+    readonly value: number;
 } | {
-    readonly isError: true;
-    readonly code: ErrorCode;
-    readonly description: string;
+    readonly unit: "%";
+    readonly value: number;
+};
+export declare const setPopupSize: (width: PopupSizeDimension, height: PopupSizeDimension) => Promise<Result<{
+    readonly isError: false;
+}>>;
+export declare const observeCustomAppContext: (callback: (context: Context) => void) => Promise<Result<{
+    readonly context: Context;
+    readonly unsubscribe: () => Promise<void>;
+}>>;
+type Result<T> = ({
+    isError: false;
+} & T) | {
+    isError: true;
+    code: ErrorCode;
+    description: string;
 };
-export declare const getCustomAppContext: () => Promise<CustomAppContext>;

package/dist/customAppSdk.js

@@ -1,27 +1,147 @@
-import { sendMessage } from "./iframeMessenger";
-import { ErrorMessage } from "./iframeSchema";
+import { getContextPropertiesForPage, isItemEditorContext, isItemListingContext, isOtherContext, } from "./contexts";
+import { addNotificationCallback, removeNotificationCallback, sendMessage, } from "./iframeMessenger";
+import { ErrorMessage, PublishingState, VariantCompletionStatus, } from "./iframeSchema";
 import { matchesSchema } from "./matchesSchema";
+export { PublishingState, VariantCompletionStatus };
 export var ErrorCode;
 (function (ErrorCode) {
     ErrorCode["UnknownMessage"] = "unknown-message";
+    ErrorCode["NotSupported"] = "not-supported";
+    ErrorCode["OutdatedContext"] = "outdated-context";
 })(ErrorCode || (ErrorCode = {}));
-export const getCustomAppContext = () => new Promise((resolve, reject) => {
-    try {
-        sendMessage({
-            type: "get-context-request",
+export const getCustomAppContext = async () => {
+    const currentPageResponse = await sendMessage({
+        type: "get-context-request",
+        version: "2.0.0",
+        payload: {
+            properties: ["currentPage"],
+        },
+    });
+    if (matchesSchema(ErrorMessage, currentPageResponse)) {
+        return {
+            isError: true,
+            code: currentPageResponse.code,
+            description: currentPageResponse.description,
+        };
+    }
+    const currentPage = currentPageResponse.payload.properties.currentPage;
+    const propertiesToFetch = getContextPropertiesForPage(currentPage);
+    const response = await sendMessage({
+        type: "get-context-request",
+        version: "2.0.0",
+        payload: {
+            properties: propertiesToFetch,
+        },
+    });
+    if (matchesSchema(ErrorMessage, response)) {
+        return { isError: true, code: response.code, description: response.description };
+    }
+    return getContextFromProperties(response.payload.properties);
+};
+export const setPopupSize = async (width, height) => {
+    const response = await sendMessage({
+        type: "set-popup-size-request",
+        version: "1.0.0",
+        payload: {
+            width,
+            height,
+        },
+    });
+    if (matchesSchema(ErrorMessage, response)) {
+        return { isError: true, code: response.code, description: response.description };
+    }
+    return { isError: false };
+};
+const outdatedContextError = {
+    isError: true,
+    code: ErrorCode.OutdatedContext,
+    description: "The context we received is outdated, please try to get the context again.",
+};
+export const observeCustomAppContext = async (callback) => {
+    const currentPageResponse = await sendMessage({
+        type: "get-context-request",
+        version: "2.0.0",
+        payload: {
+            properties: ["currentPage"],
+        },
+    });
+    if (matchesSchema(ErrorMessage, currentPageResponse)) {
+        return {
+            isError: true,
+            code: currentPageResponse.code,
+            description: currentPageResponse.description,
+        };
+    }
+    const currentPage = currentPageResponse.payload.properties.currentPage;
+    const propertiesToObserve = getContextPropertiesForPage(currentPage);
+    const observeResponse = await sendMessage({
+        type: "observe-context-request",
+        version: "1.0.0",
+        payload: {
+            properties: propertiesToObserve,
+        },
+    });
+    if (matchesSchema(ErrorMessage, observeResponse)) {
+        return { isError: true, code: observeResponse.code, description: observeResponse.description };
+    }
+    const initialContextResponse = await sendMessage({
+        type: "get-context-request",
+        version: "2.0.0",
+        payload: {
+            properties: propertiesToObserve,
+        },
+    });
+    if (matchesSchema(ErrorMessage, initialContextResponse)) {
+        return {
+            isError: true,
+            code: initialContextResponse.code,
+            description: initialContextResponse.description,
+        };
+    }
+    const initialContext = getContextFromProperties(initialContextResponse.payload.properties);
+    if (initialContext.isError) {
+        return initialContext;
+    }
+    const notificationHandler = (notification) => {
+        const contextResult = getContextFromProperties(notification.payload.properties);
+        if (!contextResult.isError) {
+            callback(contextResult.context);
+        }
+    };
+    addNotificationCallback(observeResponse.payload.subscriptionId, notificationHandler);
+    const unsubscribe = async () => {
+        removeNotificationCallback(observeResponse.payload.subscriptionId);
+        await sendMessage({
+            type: "unsubscribe-context-request",
             version: "1.0.0",
-            payload: null,
-        }, (response) => {
-            if (matchesSchema(ErrorMessage, response)) {
-                resolve({ isError: true, code: response.code, description: response.description });
-            }
-            else {
-                resolve({ ...response.payload, isError: false });
-            }
+            payload: {
+                subscriptionId: observeResponse.payload.subscriptionId,
+            },
         });
+    };
+    return {
+        isError: false,
+        context: initialContext.context,
+        unsubscribe,
+    };
+};
+const getContextFromProperties = (properties) => {
+    const currentPage = properties.currentPage;
+    switch (currentPage) {
+        case "itemEditor":
+            return isItemEditorContext(properties)
+                ? { isError: false, context: properties }
+                : outdatedContextError;
+        case "contentInventory":
+            return isItemListingContext(properties)
+                ? { isError: false, context: properties }
+                : outdatedContextError;
+        case "other":
+            return isOtherContext(properties)
+                ? { isError: false, context: properties }
+                : outdatedContextError;
+        default:
+            return outdatedContextError;
     }
-    catch (error) {
-        reject(error);
-    }
-});
+};
 //# sourceMappingURL=customAppSdk.js.map

package/dist/customAppSdk.js.map

@@ -1 +1 @@
-{"version":3,"file":"customAppSdk.js","sourceRoot":"","sources":["../src/customAppSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,CAAN,IAAY,SAEX;AAFD,WAAY,SAAS;IACnB,+CAAkC,CAAA;AACpC,CAAC,EAFW,SAAS,KAAT,SAAS,QAEpB;AAsBD,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAA8B,EAAE,CACjE,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;IAC9B,IAAI,CAAC;QACH,WAAW,CACT;YACE,IAAI,EAAE,qBAAqB;YAC3B,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,IAAI;SACd,EACD,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;gBAC1C,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;YACrF,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;YACnD,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC;AACH,CAAC,CAAC,CAAC"}
+{"version":3,"file":"customAppSdk.js","sourceRoot":"","sources":["../src/customAppSdk.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,2BAA2B,EAC3B,mBAAmB,EACnB,oBAAoB,EACpB,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,uBAAuB,EACvB,0BAA0B,EAC1B,WAAW,GACZ,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAGL,YAAY,EACZ,eAAe,EAGf,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,CAAC;AAGpD,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,+CAAkC,CAAA;IAClC,2CAA8B,CAAA;IAC9B,iDAAoC,CAAA;AACtC,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,IAAoD,EAAE;IAC5F,MAAM,mBAAmB,GAAG,MAAM,WAAW,CAAsB;QACjE,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE;YACP,UAAU,EAAE,CAAC,aAAa,CAAC;SAC5B;KACF,CAAC,CAAC;IAEH,IAAI,aAAa,CAAC,YAAY,EAAE,mBAAmB,CAAC,EAAE,CAAC;QACrD,OAAO;YACL,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,mBAAmB,CAAC,IAAI;YAC9B,WAAW,EAAE,mBAAmB,CAAC,WAAW;SAC7C,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,mBAAmB,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;IACvE,MAAM,iBAAiB,GAAG,2BAA2B,CAAC,WAAW,CAAC,CAAC;IAEnE,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAsB;QACtD,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE;YACP,UAAU,EAAE,iBAAiB;SAC9B;KACF,CAAC,CAAC;IAEH,IAAI,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;QAC1C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC;IACnF,CAAC;IAED,OAAO,wBAAwB,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAC/D,CAAC,CAAC;AAYF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,KAAyB,EACzB,MAA0B,EACoB,EAAE;IAChD,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAyB;QACzD,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE;YACP,KAAK;YACL,MAAM;SACP;KACF,CAAC,CAAC;IAEH,IAAI,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;QAC1C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC;IACnF,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG;IAC3B,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,SAAS,CAAC,eAAe;IAC/B,WAAW,EAAE,2EAA2E;CAChF,CAAC;AAEX,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAC1C,QAAoC,EACuD,EAAE;IAC7F,MAAM,mBAAmB,GAAG,MAAM,WAAW,CAAsB;QACjE,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE;YACP,UAAU,EAAE,CAAC,aAAa,CAAC;SAC5B;KACF,CAAC,CAAC;IAEH,IAAI,aAAa,CAAC,YAAY,EAAE,mBAAmB,CAAC,EAAE,CAAC;QACrD,OAAO;YACL,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,mBAAmB,CAAC,IAAI;YAC9B,WAAW,EAAE,mBAAmB,CAAC,WAAW;SAC7C,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,mBAAmB,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;IACvE,MAAM,mBAAmB,GAAG,2BAA2B,CAAC,WAAW,CAAC,CAAC;IAErE,MAAM,eAAe,GAAG,MAAM,WAAW,CAA0B;QACjE,IAAI,EAAE,yBAAyB;QAC/B,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE;YACP,UAAU,EAAE,mBAAmB;SAChC;KACF,CAAC,CAAC;IAEH,IAAI,aAAa,CAAC,YAAY,EAAE,eAAe,CAAC,EAAE,CAAC;QACjD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,eAAe,CAAC,WAAW,EAAE,CAAC;IACjG,CAAC;IAED,MAAM,sBAAsB,GAAG,MAAM,WAAW,CAAsB;QACpE,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE;YACP,UAAU,EAAE,mBAAmB;SAChC;KACF,CAAC,CAAC;IAEH,IAAI,aAAa,CAAC,YAAY,EAAE,sBAAsB,CAAC,EAAE,CAAC;QACxD,OAAO;YACL,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,sBAAsB,CAAC,IAAI;YACjC,WAAW,EAAE,sBAAsB,CAAC,WAAW;SAChD,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,wBAAwB,CAAC,sBAAsB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3F,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;QAC3B,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,MAAM,mBAAmB,GAAG,CAC1B,YAAgE,EAChE,EAAE;QACF,MAAM,aAAa,GAAG,wBAAwB,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAChF,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;YAC3B,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;IACH,CAAC,CAAC;IAEF,uBAAuB,CAAC,eAAe,CAAC,OAAO,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAC;IAErF,MAAM,WAAW,GAAG,KAAK,IAAmB,EAAE;QAC5C,0BAA0B,CAAC,eAAe,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAEnE,MAAM,WAAW,CAA8B;YAC7C,IAAI,EAAE,6BAA6B;YACnC,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE;gBACP,cAAc,EAAE,eAAe,CAAC,OAAO,CAAC,cAAc;aACvD;SACF,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,KAAK;QACd,OAAO,EAAE,cAAc,CAAC,OAAO;QAC/B,WAAW;KACZ,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAC/B,UAAsC,EACC,EAAE;IACzC,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC;IAE3C,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,YAAY;YACf,OAAO,mBAAmB,CAAC,UAAU,CAAC;gBACpC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE;gBACzC,CAAC,CAAC,oBAAoB,CAAC;QAC3B,KAAK,kBAAkB;YACrB,OAAO,oBAAoB,CAAC,UAAU,CAAC;gBACrC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE;gBACzC,CAAC,CAAC,oBAAoB,CAAC;QAC3B,KAAK,OAAO;YACV,OAAO,cAAc,CAAC,UAAU,CAAC;gBAC/B,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE;gBACzC,CAAC,CAAC,oBAAoB,CAAC;QAC3B;YACE,OAAO,oBAAoB,CAAC;IAChC,CAAC;AACH,CAAC,CAAC"}

package/dist/iframeMessenger.d.ts

@@ -1,2 +1,5 @@
-import type { Schema } from "./iframeSchema";
-export declare const sendMessage: <TMessageType extends keyof Schema["client"]>(message: Omit<Schema["client"][TMessageType]["request"], "requestId">, callback: (data: Schema["client"][TMessageType]["response"]) => void) => void;
+import type { z } from "zod";
+import type { ClientContextChangedV1Notification, Schema } from "./iframeSchema";
+export declare const sendMessage: <TMessageType extends keyof Schema["client"]>(message: Omit<Schema["client"][TMessageType]["request"], "requestId">) => Promise<Schema["client"][TMessageType]["response"]>;
+export declare const addNotificationCallback: (subscriptionId: string, callback: (notification: z.infer<typeof ClientContextChangedV1Notification>) => void) => void;
+export declare const removeNotificationCallback: (subscriptionId: string) => void;