@contentful/app-sdk 4.67.0 → 4.68.0

package/dist/experience.d.ts

@@ -4,7 +4,7 @@ import { ExperienceSDK, ExperienceContext, ExperienceSnapshot } from './types';
  * Creates the Experience SDK namespace for the experience-toolbar location.
  *
  * Throws when called without handshake `experiences` data, mirroring `createAgent`. This keeps the
- * public `ExperienceEditorToolbarAppSDK['experiences']` type sound (non-optional, always present).
+ * public `ExperienceCanvasToolbarAppSDK['experiences']` type sound (non-optional, always present).
  */
 export default function createExperience(channel: Channel, experienceInit?: {
     context?: ExperienceContext;

package/dist/types/api.types.d.ts

@@ -262,14 +262,14 @@ export type AgentAppSDK<InstallationParameters extends KeyValueMap = KeyValueMap
     /** Methods to update the size of the iframe the app is contained within.  */
     window: WindowAPI;
 };
-export type ExperienceEditorToolbarAppSDK<InstallationParameters extends KeyValueMap = KeyValueMap> = Omit<BaseAppSDK<InstallationParameters, never, never>, 'ids'> & {
+export type ExperienceCanvasToolbarAppSDK<InstallationParameters extends KeyValueMap = KeyValueMap> = Omit<BaseAppSDK<InstallationParameters, never, never>, 'ids'> & {
     ids: Omit<IdsAPI, EntryScopedIds>;
     /** Experience SDK for experience-toolbar location */
     experiences: ExperienceSDK;
     /** Methods to update the size of the iframe the app is contained within.  */
     window: WindowAPI;
 };
-export type KnownAppSDK<InstallationParameters extends KeyValueMap = KeyValueMap, InstanceParameters extends KeyValueMap = KeyValueMap, InvocationParameters extends SerializedJSONValue = SerializedJSONValue> = FieldAppSDK<InstallationParameters, InstanceParameters> | SidebarAppSDK<InstallationParameters, InstanceParameters> | DialogAppSDK<InstallationParameters, InvocationParameters> | EditorAppSDK<InstallationParameters, InstanceParameters> | PageAppSDK<InstallationParameters> | ConfigAppSDK<InstallationParameters> | HomeAppSDK<InstallationParameters> | AgentAppSDK<InstallationParameters> | ExperienceEditorToolbarAppSDK<InstallationParameters>;
+export type KnownAppSDK<InstallationParameters extends KeyValueMap = KeyValueMap, InstanceParameters extends KeyValueMap = KeyValueMap, InvocationParameters extends SerializedJSONValue = SerializedJSONValue> = FieldAppSDK<InstallationParameters, InstanceParameters> | SidebarAppSDK<InstallationParameters, InstanceParameters> | DialogAppSDK<InstallationParameters, InvocationParameters> | EditorAppSDK<InstallationParameters, InstanceParameters> | PageAppSDK<InstallationParameters> | ConfigAppSDK<InstallationParameters> | HomeAppSDK<InstallationParameters> | AgentAppSDK<InstallationParameters> | ExperienceCanvasToolbarAppSDK<InstallationParameters>;
 /** @deprecated consider using {@link BaseAppSDK} */
 export type BaseExtensionSDK = BaseAppSDK;
 /** @deprecated consider using {@link EditorAppSDK} */

package/dist/types/experience.types.d.ts

@@ -38,7 +38,7 @@ export interface ComponentPropertyDescriptor<C = unknown, D extends DesignValue
 export type SameSpaceContentSource = 'crn:contentful:::content:spaces/$self/environments/$self';
 /**
  * A reference to a Contentful resource, addressed by `urn`. `linkType` is a `Contentful:`-prefixed
- * resource type (e.g. `'Contentful:Template'`).
+ * resource type (e.g. `'Contentful:Template'` / its canonical `'Contentful:ExperienceTemplate'`).
  */
 export interface ResourceLink<T extends string = string> {
     sys: {
@@ -105,15 +105,22 @@ export interface DataAssemblyAPI extends DataAssemblyParameterAPI {
     /** Subscribes to Data Assembly snapshot changes. Returns an unsubscribe function. */
     onChange(cb: (snapshot: DataAssemblySnapshot) => void): Unsubscribe;
 }
-/** The type of a node within an experience/fragment tree. */
-export type ExperienceNodeType = 'Component' | 'Fragment' | 'InlineFragment' | 'Slot';
+/**
+ * The type of a node within an experience/fragment tree. Accepts both the current
+ * (`Fragment`/`InlineFragment`) and upcoming canonical (`ExperienceFragment`/`InlineExperienceFragment`)
+ * vocabulary — the same node entity, named differently across the ExO data-model transition.
+ */
+export type ExperienceNodeType = 'Component' | 'Fragment' | 'ExperienceFragment' | 'InlineFragment' | 'InlineExperienceFragment' | 'Slot';
 export interface ExperienceNodeSnapshot {
     id: string;
     nodeType: ExperienceNodeType;
 }
-/** One allowed resource for a slot: the Component(s) that may be placed in it. */
+/**
+ * One allowed resource for a slot: the Component(s) that may be placed in it. `type` accepts both
+ * the current (`Contentful:ComponentType`) and upcoming canonical (`Contentful:Component`) URN.
+ */
 export interface SlotAllowedResource {
-    type: 'Contentful:ComponentType';
+    type: 'Contentful:ComponentType' | 'Contentful:Component';
     source: string;
     allowedTypes: string[];
 }
@@ -122,7 +129,7 @@ export interface SlotDescriptor {
     allowedResources: SlotAllowedResource[];
     currentItems: Array<{
         nodeId: string;
-        nodeType: 'Fragment' | 'InlineFragment';
+        nodeType: 'Fragment' | 'ExperienceFragment' | 'InlineFragment' | 'InlineExperienceFragment';
     }>;
 }
 /**
@@ -182,10 +189,13 @@ export interface ExperienceMetadata {
     name?: string;
 }
 /**
- * Snapshot of the root entity being edited. Discriminated on `sys.type`:
- * an `Experience` (optionally backed by a template) or a `Fragment` (no template).
- * `Experience.sys.template` is optional, and `Fragment.sys` carries a `componentType`
- * ResourceLink and no template.
+ * Snapshot of the root entity being edited, discriminated on `sys.type`. Three arms:
+ * an `Experience` (optionally backed by a template) plus two shapes of the same fragment
+ * entity — `Fragment` (current vocabulary: `sys.componentType`, `Contentful:ComponentType`)
+ * and `ExperienceFragment` (upcoming canonical vocabulary: `sys.component`, `Contentful:Component`).
+ * `Fragment` and `ExperienceFragment` are the same entity in legacy vs canonical shape; both are
+ * accepted so apps stay forward-compatible across the ExO data-model transition. The `Experience`
+ * arm carries an optional `template`/`experienceTemplate` (an experience may be un-templated).
  */
 export type ExperienceSnapshot = {
     sys: {
@@ -193,6 +203,7 @@ export type ExperienceSnapshot = {
         type: 'Experience';
         version: number;
         template?: ResourceLink<'Contentful:Template'>;
+        experienceTemplate?: ResourceLink<'Contentful:ExperienceTemplate'>;
     };
     metadata?: ExperienceMetadata;
 } | {
@@ -203,6 +214,14 @@ export type ExperienceSnapshot = {
         componentType: ResourceLink<'Contentful:ComponentType'>;
     };
     metadata?: ExperienceMetadata;
+} | {
+    sys: {
+        id: string;
+        type: 'ExperienceFragment';
+        version: number;
+        component: ResourceLink<'Contentful:Component'>;
+    };
+    metadata?: ExperienceMetadata;
 };
 export interface ExperienceAPI {
     get(): ExperienceSnapshot;
@@ -226,7 +245,7 @@ export interface ExperienceAPI {
     dataAssembly: DataAssemblyAPI;
 }
 export interface ExperienceContext {
-    type: 'experience' | 'fragment';
+    type: 'experience' | 'fragment' | 'experienceFragment';
     entityId: string;
 }
 export interface ExperienceSDK {

package/dist/types/index.d.ts

@@ -1,4 +1,8 @@
-export type { AppExtensionSDK, BaseExtensionSDK, DialogExtensionSDK, EditorExtensionSDK, FieldExtensionSDK, HomeExtensionSDK, KnownSDK, PageExtensionSDK, SidebarExtensionSDK, ConfigAppSDK, BaseAppSDK, DialogAppSDK, EditorAppSDK, FieldAppSDK, HomeAppSDK, KnownAppSDK, PageAppSDK, SidebarAppSDK, AccessAPI, ArchiveableAction, ConnectMessage, ContentTypeAPI, CrudAction, EditorLocaleSettings, IdsAPI, LocalesAPI, LocationAPI, Locations, NotifierAPI, ParametersAPI, PublishableAction, SharedEditorSDK, UserAPI, JSONPatchItem, HostnamesAPI, AgentAppSDK, ExperienceEditorToolbarAppSDK, } from './api.types';
+import type { KeyValueMap } from 'contentful-management';
+import type { ExperienceCanvasToolbarAppSDK } from './api.types';
+export type { AppExtensionSDK, BaseExtensionSDK, DialogExtensionSDK, EditorExtensionSDK, FieldExtensionSDK, HomeExtensionSDK, KnownSDK, PageExtensionSDK, SidebarExtensionSDK, ConfigAppSDK, BaseAppSDK, DialogAppSDK, EditorAppSDK, FieldAppSDK, HomeAppSDK, KnownAppSDK, PageAppSDK, SidebarAppSDK, AccessAPI, ArchiveableAction, ConnectMessage, ContentTypeAPI, CrudAction, EditorLocaleSettings, IdsAPI, LocalesAPI, LocationAPI, Locations, NotifierAPI, ParametersAPI, PublishableAction, SharedEditorSDK, UserAPI, JSONPatchItem, HostnamesAPI, AgentAppSDK, ExperienceCanvasToolbarAppSDK, } from './api.types';
+/** @deprecated Renamed to ExperienceCanvasToolbarAppSDK. Alias kept for the internal migration window; will be removed. */
+export type ExperienceEditorToolbarAppSDK<InstallationParameters extends KeyValueMap = KeyValueMap> = ExperienceCanvasToolbarAppSDK<InstallationParameters>;
 export type { AgentAPI, AgentContext, LayoutVariant, ToolbarAction, ToolbarActionName, } from './agent.types';
 export type { AppConfigAPI, AppState, OnConfigureHandler, OnConfigureHandlerReturn, } from './app.types';
 export type { DialogsAPI, EntityDialogOptions, OpenAlertOptions, OpenConfirmOptions, OpenCustomWidgetOptions, RecommendationsOptions, CrossSpaceAllowedResource, ResourceEntitySelectorOptions, } from './dialogs.types';

package/package.json

@@ -1 +1 @@
-{"name":"@contentful/app-sdk","description":"A JavaScript library to develop custom apps for Contentful","version":"4.67.0","author":"Contentful GmbH","license":"MIT","sideEffects":true,"repository":{"url":"https://github.com/contentful/ui-extensions-sdk.git","type":"git"},"homepage":"https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/","main":"dist/cf-extension-api.js","unpkg":"dist/cf-extension-api.bundled.js","jsdelivr":"dist/cf-extension-api.bundled.js","types":"dist/index.d.ts","files":["dist/cf-extension-api.js","dist/cf-extension-api.js.map","dist/cf-extension-api.bundled.js","dist/cf-extension.css","dist/**/*.d.ts"],"scripts":{"test":"ts-mocha -p tsconfig.test.json 'test/unit/*.[jt]s' --reporter mocha-multi-reporters --reporter-options configFile=mocha.unit-reporters.json","lint":"eslint '{lib,test}/**/*.{t,j}s'","lint:fix":"npm run lint -- --fix","build":"npm run check-types && rollup -c --compact","build:debug":"npm run build -- --sourcemap","prepublishOnly":"npm run build","size":"echo \"Gzipped, estimate: $(gzip -9 -c dist/cf-extension-api.js | wc -c) bytes\"","semantic-release":"semantic-release","publish-all":"node ./scripts/publish.js","verify":"node ./scripts/verify.js","check-types":"tsc --noEmit -m commonjs","prepare":"husky","lint-staged":"lint-staged"},"dependencies":{"contentful-management":"^12.3.1"},"devDependencies":{"@rollup/plugin-commonjs":"^29.0.0","@rollup/plugin-node-resolve":"^16.0.0","@semantic-release/changelog":"6.0.3","@semantic-release/exec":"7.1.0","@semantic-release/git":"10.0.1","@testing-library/dom":"10.4.1","@types/chai-as-promised":"7.1.8","@types/cross-spawn":"6.0.6","@types/fs-extra":"11.0.4","@types/jsdom":"28.0.3","@types/mocha":"10.0.10","@types/nanoid":"3.0.0","@types/sinon":"^21.0.0","@types/sinon-chai":"^3.2.5","@typescript-eslint/eslint-plugin":"7.18.0","@typescript-eslint/parser":"7.18.0","babel-eslint":"10.1.0","chai":"4.5.0","chai-as-promised":"7.1.2","cross-spawn":"7.0.6","eslint":"8.57.1","eslint-config-prettier":"10.1.8","eslint-config-standard":"17.1.0","eslint-plugin-import":"2.32.0","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"5.5.6","eslint-plugin-promise":"6.6.0","eslint-plugin-react":"7.37.5","eslint-plugin-standard":"5.0.0","fs-extra":"11.3.5","husky":"9.1.7","jsdom":"29.1.1","lint-staged":"17.0.8","mocha":"11.7.6","mocha-junit-reporter":"2.2.1","mocha-multi-reporters":"1.5.1","mochawesome":"7.1.4","mochawesome-merge":"5.1.1","mochawesome-report-generator":"6.3.2","prettier":"3.8.4","rollup":"2.80.0","rollup-plugin-terser":"7.0.2","rollup-plugin-typescript2":"0.37.0","semantic-release":"^25.0.2","sinon":"22.0.0","sinon-chai":"3.7.0","ts-mocha":"11.1.0","tslib":"2.8.1","typescript":"5.9.3"},"lint-staged":{"*.ts":["prettier --write","eslint --fix"],"*.md":["prettier --write"]},"release":{"branches":["main",{"name":"canary","channel":"canary","prerelease":"alpha"}],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog",["@semantic-release/npm",{"npmPublish":false}],["@semantic-release/exec",{"verifyConditionsCmd":"node ./scripts/verify.js","publishCmd":"npm run publish-all"}],["@semantic-release/git",{"message":"chore: ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}","assets":["CHANGELOG.md","package.json","package-lock.json"]}],"@semantic-release/github"]}}
+{"name":"@contentful/app-sdk","description":"A JavaScript library to develop custom apps for Contentful","version":"4.68.0","author":"Contentful GmbH","license":"MIT","sideEffects":true,"repository":{"url":"https://github.com/contentful/ui-extensions-sdk.git","type":"git"},"homepage":"https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/","main":"dist/cf-extension-api.js","unpkg":"dist/cf-extension-api.bundled.js","jsdelivr":"dist/cf-extension-api.bundled.js","types":"dist/index.d.ts","files":["dist/cf-extension-api.js","dist/cf-extension-api.js.map","dist/cf-extension-api.bundled.js","dist/cf-extension.css","dist/**/*.d.ts"],"scripts":{"test":"ts-mocha -p tsconfig.test.json 'test/unit/*.[jt]s' --reporter mocha-multi-reporters --reporter-options configFile=mocha.unit-reporters.json","lint":"eslint '{lib,test}/**/*.{t,j}s'","lint:fix":"npm run lint -- --fix","build":"npm run check-types && rollup -c --compact","build:debug":"npm run build -- --sourcemap","prepublishOnly":"npm run build","size":"echo \"Gzipped, estimate: $(gzip -9 -c dist/cf-extension-api.js | wc -c) bytes\"","semantic-release":"semantic-release","publish-all":"node ./scripts/publish.js","verify":"node ./scripts/verify.js","check-types":"tsc --noEmit -m commonjs","prepare":"husky","lint-staged":"lint-staged"},"dependencies":{"contentful-management":"^12.3.1"},"devDependencies":{"@rollup/plugin-commonjs":"^29.0.0","@rollup/plugin-node-resolve":"^16.0.0","@semantic-release/changelog":"6.0.3","@semantic-release/exec":"7.1.0","@semantic-release/git":"10.0.1","@testing-library/dom":"10.4.1","@types/chai-as-promised":"7.1.8","@types/cross-spawn":"6.0.6","@types/fs-extra":"11.0.4","@types/jsdom":"28.0.3","@types/mocha":"10.0.10","@types/nanoid":"3.0.0","@types/sinon":"^21.0.0","@types/sinon-chai":"^3.2.5","@typescript-eslint/eslint-plugin":"7.18.0","@typescript-eslint/parser":"7.18.0","babel-eslint":"10.1.0","chai":"4.5.0","chai-as-promised":"7.1.2","cross-spawn":"7.0.6","eslint":"8.57.1","eslint-config-prettier":"10.1.8","eslint-config-standard":"17.1.0","eslint-plugin-import":"2.32.0","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"5.5.6","eslint-plugin-promise":"6.6.0","eslint-plugin-react":"7.37.5","eslint-plugin-standard":"5.0.0","fs-extra":"11.3.5","husky":"9.1.7","jsdom":"29.1.1","lint-staged":"17.0.8","mocha":"11.7.6","mocha-junit-reporter":"2.2.1","mocha-multi-reporters":"1.5.1","mochawesome":"7.1.4","mochawesome-merge":"5.1.1","mochawesome-report-generator":"6.3.2","prettier":"3.8.4","rollup":"2.80.0","rollup-plugin-terser":"7.0.2","rollup-plugin-typescript2":"0.37.0","semantic-release":"^25.0.2","sinon":"22.0.0","sinon-chai":"3.7.0","ts-mocha":"11.1.0","tslib":"2.8.1","typescript":"5.9.3"},"lint-staged":{"*.ts":["prettier --write","eslint --fix"],"*.md":["prettier --write"]},"release":{"branches":["main",{"name":"canary","channel":"canary","prerelease":"alpha"}],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog",["@semantic-release/npm",{"npmPublish":false}],["@semantic-release/exec",{"verifyConditionsCmd":"node ./scripts/verify.js","publishCmd":"npm run publish-all"}],["@semantic-release/git",{"message":"chore: ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}","assets":["CHANGELOG.md","package.json","package-lock.json"]}],"@semantic-release/github"]}}