contentful-ui-extensions-sdk 4.13.0 → 4.14.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { KnownSDK } from './types';
 export * from './types';
 export { default as locations } from './locations';
-declare type Init = <T extends KnownSDK = KnownSDK>(initCallback: (sdk: T) => any, options?: {
+type Init = <T extends KnownSDK = KnownSDK>(initCallback: (sdk: T) => any, options?: {
     supressIframeWarning?: boolean;
 }) => void;
 export declare const init: Init;

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

@@ -107,15 +107,15 @@ export interface SharedEditorSDK {
     /** Information about the content type of the entry. */
     contentType: ContentTypeAPI;
 }
-export declare type CrudAction = 'create' | 'read' | 'update' | 'delete';
-export declare type PublishableAction = 'publish' | 'unpublish';
-export declare type ArchiveableAction = 'archive' | 'unarchive';
-export declare type JSONPatchItem = {
+export type CrudAction = 'create' | 'read' | 'update' | 'delete';
+export type PublishableAction = 'publish' | 'unpublish';
+export type ArchiveableAction = 'archive' | 'unarchive';
+export type JSONPatchItem = {
     op: 'remove' | 'replace' | 'add';
     path: string;
     value?: any;
 };
-declare type PatchEntity = Entry | Task | Asset | WorkflowDefinition;
+type PatchEntity = Entry | Task | Asset | WorkflowDefinition;
 export interface AccessAPI {
     can(action: 'read' | 'update', entity: 'EditorInterface' | EditorInterface): Promise<boolean>;
     can<T = Object>(action: CrudAction, entity: 'ContentType' | ContentType | 'Asset' | 'Entry' | T): Promise<boolean>;
@@ -125,7 +125,7 @@ export interface AccessAPI {
     /** Whether the current user can edit app config */
     canEditAppConfig: () => Promise<boolean>;
 }
-declare type EntryScopedIds = 'field' | 'entry' | 'contentType';
+type EntryScopedIds = 'field' | 'entry' | 'contentType';
 export interface BaseExtensionSDK {
     /** @deprecated since version 4.0.0 consider using the CMA instead
      * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details
@@ -152,17 +152,17 @@ export interface BaseExtensionSDK {
     /** Adapter to be injected in contentful-management client */
     cmaAdapter: Adapter;
 }
-export declare type EditorExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & {
+export type EditorExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & {
     /** A set of IDs for the app */
     ids: Omit<IdsAPI, 'field'>;
 };
-export declare type SidebarExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & {
+export type SidebarExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & {
     /** A set of IDs for the app */
     ids: Omit<IdsAPI, 'field'>;
     /** Methods to update the size of the iframe the app is contained within.  */
     window: WindowAPI;
 };
-export declare type FieldExtensionSDK = BaseExtensionSDK & SharedEditorSDK & {
+export type FieldExtensionSDK = BaseExtensionSDK & SharedEditorSDK & {
     /** A set of IDs for the app */
     ids: IdsAPI;
     /** Gives you access to the value and metadata of the field the app is attached to. */
@@ -170,7 +170,7 @@ export declare type FieldExtensionSDK = BaseExtensionSDK & SharedEditorSDK & {
     /** Methods to update the size of the iframe the app is contained within.  */
     window: WindowAPI;
 };
-export declare type DialogExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
+export type DialogExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
     /** A set of IDs for the app */
     ids: Omit<IdsAPI, EntryScopedIds>;
     /** Closes the dialog and resolves openCurrentApp promise with data */
@@ -178,21 +178,21 @@ export declare type DialogExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
     /** Methods to update the size of the iframe the app is contained within.  */
     window: WindowAPI;
 };
-export declare type PageExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
+export type PageExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
     /** A set of IDs actual for the app */
     ids: Omit<IdsAPI, EntryScopedIds>;
 };
-export declare type HomeExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
+export type HomeExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
     ids: Omit<IdsAPI, EntryScopedIds>;
 };
-export declare type AppExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
+export type AppExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & {
     /** A set of IDs actual for the app */
     ids: Omit<IdsAPI, EntryScopedIds | 'extension' | 'app'> & {
         app: string;
     };
     app: AppConfigAPI;
 };
-export declare type KnownSDK = FieldExtensionSDK | SidebarExtensionSDK | DialogExtensionSDK | EditorExtensionSDK | PageExtensionSDK | AppExtensionSDK | HomeExtensionSDK;
+export type KnownSDK = FieldExtensionSDK | SidebarExtensionSDK | DialogExtensionSDK | EditorExtensionSDK | PageExtensionSDK | AppExtensionSDK | HomeExtensionSDK;
 export interface Locations {
     LOCATION_ENTRY_FIELD: 'entry-field';
     LOCATION_ENTRY_FIELD_SIDEBAR: 'entry-field-sidebar';

package/dist/types/app.types.d.ts

@@ -20,11 +20,11 @@ interface AppStateEditorInterfaceItem {
 export interface AppState {
     EditorInterface: Record<ContentType['sys']['id'], AppStateEditorInterfaceItem>;
 }
-export declare type OnConfigureHandlerReturn = {
+export type OnConfigureHandlerReturn = {
     parameters?: KeyValueMap | null;
     targetState?: AppState | null;
 } | false;
-export declare type OnConfigureHandler = () => OnConfigureHandlerReturn | Promise<OnConfigureHandlerReturn>;
+export type OnConfigureHandler = () => OnConfigureHandlerReturn | Promise<OnConfigureHandlerReturn>;
 export interface AppConfigAPI {
     /** Tells the web app that the app is loaded */
     setReady: () => Promise<void>;

package/dist/types/cmaClient.types.d.ts

@@ -0,0 +1,31 @@
+import { PlainClientAPI } from 'contentful-management';
+export type CMAClient = {
+    appAction: Pick<PlainClientAPI['appAction'], 'get' | 'getMany' | 'getManyForEnvironment'>;
+    appDefinition: Pick<PlainClientAPI['appDefinition'], 'get' | 'getInstallationsForOrg'>;
+    appInstallation: Pick<PlainClientAPI['appInstallation'], 'getForOrganization'>;
+    asset: PlainClientAPI['asset'];
+    assetKey: PlainClientAPI['assetKey'];
+    appSignedRequest: Pick<PlainClientAPI['appSignedRequest'], 'create'>;
+    bulkAction: PlainClientAPI['bulkAction'];
+    comment: PlainClientAPI['comment'];
+    contentType: PlainClientAPI['contentType'];
+    editorInterface: PlainClientAPI['editorInterface'];
+    environment: Pick<PlainClientAPI['environment'], 'get'>;
+    environmentAlias: Pick<PlainClientAPI['environmentAlias'], 'get'>;
+    entry: PlainClientAPI['entry'];
+    locale: PlainClientAPI['locale'];
+    release: PlainClientAPI['release'];
+    releaseAction: PlainClientAPI['releaseAction'];
+    role: Pick<PlainClientAPI['role'], 'get' | 'getMany'>;
+    scheduledActions: PlainClientAPI['scheduledActions'];
+    snapshot: PlainClientAPI['snapshot'];
+    space: Pick<PlainClientAPI['space'], 'get'>;
+    upload: PlainClientAPI['upload'];
+    user: Pick<PlainClientAPI['user'], 'getManyForSpace' | 'getForSpace'>;
+    usage: Pick<PlainClientAPI['usage'], 'getManyForSpace'>;
+    team: Pick<PlainClientAPI['team'], 'getManyForSpace'>;
+    task: PlainClientAPI['task'];
+    tag: PlainClientAPI['tag'];
+    uiConfig: PlainClientAPI['uiConfig'];
+    userUIConfig: PlainClientAPI['userUIConfig'];
+};

package/dist/types/dialogs.types.d.ts

@@ -6,7 +6,7 @@ export interface OpenAlertOptions {
     shouldCloseOnEscapePress?: boolean;
     shouldCloseOnOverlayClick?: boolean;
 }
-export declare type OpenConfirmOptions = OpenAlertOptions & {
+export type OpenConfirmOptions = OpenAlertOptions & {
     cancelLabel?: string;
     intent?: 'primary' | 'positive' | 'negative';
 };

package/dist/types/entry.types.d.ts

@@ -1,7 +1,7 @@
 import { Metadata, Task } from './entities';
 import { EntryFieldAPI } from './field.types';
 import { CollectionResponse, ContentEntitySys, SearchQuery } from './utils';
-declare type TaskState = 'active' | 'resolved';
+type TaskState = 'active' | 'resolved';
 export interface TaskInputData {
     assignedToId: string;
     assignedToType?: 'User' | 'Team';

package/dist/types/index.d.ts

@@ -10,3 +10,4 @@ export type { SpaceAPI } from './space.types';
 export type { SearchQuery, CollectionResponse, ContentEntitySys, ContentEntityType, Items, Link, WithOptionalId, WithId, SerializedJSONValue, } from './utils';
 export type { DateRangeValidationError, InValidationError, LinkContentTypeValidationError, LinkMimetypeGroupValidationError, NotResolvableValidationError, ProhibitRegexpValidationError, RangeValidationError, RegexpValidationError, RequiredValidationError, SizeValidationError, TypeValidationError, UniqueValidationError, UnknownValidationError, ValidationError, } from './validation-error';
 export type { WindowAPI } from './window.types';
+export type { CMAClient } from './cmaClient.types';

package/dist/types/space.types.d.ts

@@ -1,6 +1,6 @@
 import { Asset, CanonicalRequest, ContentType, EditorInterface, ScheduledAction, Tag, Team, User, TagVisibility, KeyValueMap, Entry, QueryOptions, Upload } from './entities';
 import { CollectionResponse, ContentEntityType, Link, WithOptionalId, SearchQuery } from './utils';
-declare type Snapshot<T> = {
+type Snapshot<T> = {
     sys: {
         space?: Link;
         status?: Link;

package/dist/types/utils.d.ts

@@ -1,22 +1,22 @@
 import { ContentTypeFieldValidation } from './entities';
-declare type Sys = {
+type Sys = {
     id: string;
     type: string;
     [key: string]: any;
 };
-declare type Entity = {
+type Entity = {
     sys: Sys;
     [key: string]: any;
 };
-declare type Optional<Type, Keys extends keyof Type> = Partial<Type> & Omit<Type, Keys>;
-export declare type WithSysWithAtLeastId = {
+type Optional<Type, Keys extends keyof Type> = Partial<Type> & Omit<Type, Keys>;
+export type WithSysWithAtLeastId = {
     sys: {
         id: string;
         [key: string]: any;
     };
 };
-export declare type WithId<Type extends Entity> = Omit<Type, 'sys'> & WithSysWithAtLeastId;
-export declare type WithOptionalId<Type extends Entity> = Optional<Type, 'sys'> | WithId<Type>;
+export type WithId<Type extends Entity> = Omit<Type, 'sys'> & WithSysWithAtLeastId;
+export type WithOptionalId<Type extends Entity> = Optional<Type, 'sys'> | WithId<Type>;
 export interface Link<LinkType = string, Type = string> {
     sys: {
         id: string;
@@ -33,7 +33,7 @@ export interface CollectionResponse<T> {
         type: string;
     };
 }
-export declare type ContentEntityType = 'Entry' | 'Asset';
+export type ContentEntityType = 'Entry' | 'Asset';
 export interface ContentEntitySys {
     space: Link;
     id: string;
@@ -64,7 +64,7 @@ export interface SearchQuery {
     limit?: number;
     [key: string]: any;
 }
-export declare type SerializedJSONValue = null | string | number | boolean | Array<SerializedJSONValue> | {
+export type SerializedJSONValue = null | string | number | boolean | Array<SerializedJSONValue> | {
     [key: string]: SerializedJSONValue;
 };
 export {};

package/dist/types/validation-error.d.ts

@@ -60,4 +60,4 @@ export interface TypeValidationError extends BaseValidationError {
     name: 'type';
     type: string;
 }
-export declare type ValidationError = SizeValidationError | RangeValidationError | InValidationError | RequiredValidationError | UniqueValidationError | RegexpValidationError | ProhibitRegexpValidationError | LinkMimetypeGroupValidationError | LinkContentTypeValidationError | DateRangeValidationError | NotResolvableValidationError | UnknownValidationError | TypeValidationError | BaseValidationError;
+export type ValidationError = SizeValidationError | RangeValidationError | InValidationError | RequiredValidationError | UniqueValidationError | RegexpValidationError | ProhibitRegexpValidationError | LinkMimetypeGroupValidationError | LinkContentTypeValidationError | DateRangeValidationError | NotResolvableValidationError | UnknownValidationError | TypeValidationError | BaseValidationError;

package/package.json

@@ -1 +1 @@
-{"name":"contentful-ui-extensions-sdk","description":"SDK to develop custom UI Extension for the Contentful Web App","version":"4.13.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","types":"dist/index.d.ts","files":["dist/cf-extension-api.js","dist/cf-extension-api.js.map","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 install","lint-staged":"lint-staged"},"devDependencies":{"@semantic-release/changelog":"6.0.1","@semantic-release/exec":"6.0.3","@semantic-release/git":"10.0.1","@testing-library/dom":"8.19.0","@types/chai-as-promised":"7.1.5","@types/cross-spawn":"6.0.2","@types/fs-extra":"9.0.13","@types/jsdom":"20.0.0","@types/mocha":"10.0.0","@types/nanoid":"3.0.0","@types/sinon":"^10.0.0","@types/sinon-chai":"^3.2.5","@typescript-eslint/eslint-plugin":"4.33.0","@typescript-eslint/parser":"4.33.0","babel-eslint":"10.1.0","chai":"4.3.6","chai-as-promised":"7.1.1","contentful-management":"10.18.2","cross-spawn":"7.0.3","eslint":"7.32.0","eslint-config-prettier":"8.5.0","eslint-config-standard":"16.0.3","eslint-plugin-import":"2.26.0","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"4.2.1","eslint-plugin-promise":"6.1.1","eslint-plugin-react":"7.31.10","eslint-plugin-standard":"5.0.0","fs-extra":"10.1.0","husky":"8.0.1","jsdom":"20.0.1","lint-staged":"13.0.3","mocha":"10.1.0","mocha-junit-reporter":"2.1.0","mocha-multi-reporters":"1.5.1","mochawesome":"7.1.3","mochawesome-merge":"4.2.1","mochawesome-report-generator":"6.2.0","prettier":"2.7.1","rollup":"2.79.1","rollup-plugin-terser":"7.0.2","rollup-plugin-typescript2":"0.34.1","semantic-release":"19.0.5","sinon":"14.0.1","sinon-chai":"3.7.0","ts-mocha":"10.0.0","tslib":"2.4.0","typescript":"4.8.4"},"lint-staged":{"*.ts":["prettier --write","eslint --fix","git add"],"*.md":["prettier --write","git add"]},"release":{"branches":["master",{"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"]},"peerDependencies":{"contentful-management":">=7.30.0"}}
+{"name":"contentful-ui-extensions-sdk","description":"SDK to develop custom UI Extension for the Contentful Web App","version":"4.14.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","types":"dist/index.d.ts","files":["dist/cf-extension-api.js","dist/cf-extension-api.js.map","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 install","lint-staged":"lint-staged"},"devDependencies":{"@semantic-release/changelog":"6.0.2","@semantic-release/exec":"6.0.3","@semantic-release/git":"10.0.1","@testing-library/dom":"8.19.0","@types/chai-as-promised":"7.1.5","@types/cross-spawn":"6.0.2","@types/fs-extra":"9.0.13","@types/jsdom":"20.0.1","@types/mocha":"10.0.1","@types/nanoid":"3.0.0","@types/sinon":"^10.0.0","@types/sinon-chai":"^3.2.5","@typescript-eslint/eslint-plugin":"4.33.0","@typescript-eslint/parser":"4.33.0","babel-eslint":"10.1.0","chai":"4.3.7","chai-as-promised":"7.1.1","contentful-management":"10.25.0","cross-spawn":"7.0.3","eslint":"7.32.0","eslint-config-prettier":"8.5.0","eslint-config-standard":"16.0.3","eslint-plugin-import":"2.26.0","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"4.2.1","eslint-plugin-promise":"6.1.1","eslint-plugin-react":"7.31.11","eslint-plugin-standard":"5.0.0","fs-extra":"11.1.0","husky":"8.0.2","jsdom":"20.0.3","lint-staged":"13.1.0","mocha":"10.2.0","mocha-junit-reporter":"2.2.0","mocha-multi-reporters":"1.5.1","mochawesome":"7.1.3","mochawesome-merge":"4.2.2","mochawesome-report-generator":"6.2.0","prettier":"2.8.1","rollup":"2.79.1","rollup-plugin-terser":"7.0.2","rollup-plugin-typescript2":"0.34.1","semantic-release":"19.0.5","sinon":"15.0.1","sinon-chai":"3.7.0","ts-mocha":"10.0.0","tslib":"2.4.1","typescript":"4.9.4"},"lint-staged":{"*.ts":["prettier --write","eslint --fix","git add"],"*.md":["prettier --write","git add"]},"release":{"branches":["master",{"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"]},"peerDependencies":{"contentful-management":">=7.30.0"}}