@contentful/app-sdk 4.16.0 → 4.17.0

package/dist/types/utils.d.ts

@@ -1,74 +1,74 @@
-import { ContentTypeFieldValidation } from './entities';
-type Sys = {
-    id: string;
-    type: string;
-    [key: string]: any;
-};
-type Entity = {
-    sys: Sys;
-    [key: string]: any;
-};
-type Optional<Type, Keys extends keyof Type> = Partial<Type> & Omit<Type, Keys>;
-export type WithSysWithAtLeastId = {
-    sys: {
-        id: string;
-        [key: string]: any;
-    };
-};
-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;
-        type: Type;
-        linkType: LinkType;
-    };
-}
-export interface CollectionResponse<T> {
-    items: T[];
-    total: number;
-    skip: number;
-    limit: number;
-    sys: {
-        type: string;
-    };
-}
-export type ContentEntityType = 'Entry' | 'Asset';
-export type ContentEntitySys = {
-    space: Link;
-    id: string;
-    type: ContentEntityType;
-    createdAt: string;
-    updatedAt: string;
-    environment: Link;
-    publishedVersion?: number;
-    deletedVersion?: number;
-    archivedVersion?: number;
-    publishedAt?: string;
-    firstPublishedAt?: string;
-    createdBy?: Link;
-    updatedBy?: Link;
-    publishedCounter?: number;
-    version: number;
-    publishedBy?: Link;
-    contentType: Link;
-};
-export interface EntrySys extends ContentEntitySys {
-    type: 'Entry';
-    automationTags: Link<'Tag'>[];
-}
-export interface Items {
-    type: string;
-    linkType?: string;
-    validations?: ContentTypeFieldValidation[];
-}
-export interface SearchQuery {
-    order?: string;
-    skip?: number;
-    limit?: number;
-    [key: string]: any;
-}
-export type SerializedJSONValue = null | string | number | boolean | Array<SerializedJSONValue> | {
-    [key: string]: SerializedJSONValue;
-};
-export {};
+import { ContentTypeFieldValidation } from './entities';
+type Sys = {
+    id: string;
+    type: string;
+    [key: string]: any;
+};
+type Entity = {
+    sys: Sys;
+    [key: string]: any;
+};
+type Optional<Type, Keys extends keyof Type> = Partial<Type> & Omit<Type, Keys>;
+export type WithSysWithAtLeastId = {
+    sys: {
+        id: string;
+        [key: string]: any;
+    };
+};
+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;
+        type: Type;
+        linkType: LinkType;
+    };
+}
+export interface CollectionResponse<T> {
+    items: T[];
+    total: number;
+    skip: number;
+    limit: number;
+    sys: {
+        type: string;
+    };
+}
+export type ContentEntityType = 'Entry' | 'Asset';
+export type ContentEntitySys = {
+    space: Link;
+    id: string;
+    type: ContentEntityType;
+    createdAt: string;
+    updatedAt: string;
+    environment: Link;
+    publishedVersion?: number;
+    deletedVersion?: number;
+    archivedVersion?: number;
+    publishedAt?: string;
+    firstPublishedAt?: string;
+    createdBy?: Link;
+    updatedBy?: Link;
+    publishedCounter?: number;
+    version: number;
+    publishedBy?: Link;
+    contentType: Link;
+};
+export interface EntrySys extends ContentEntitySys {
+    type: 'Entry';
+    automationTags: Link<'Tag'>[];
+}
+export interface Items {
+    type: string;
+    linkType?: string;
+    validations?: ContentTypeFieldValidation[];
+}
+export interface SearchQuery {
+    order?: string;
+    skip?: number;
+    limit?: number;
+    [key: string]: any;
+}
+export type SerializedJSONValue = null | string | number | boolean | Array<SerializedJSONValue> | {
+    [key: string]: SerializedJSONValue;
+};
+export {};

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

@@ -1,63 +1,63 @@
-import { Link } from './utils';
-export interface BaseValidationError {
-    name: string;
-    message?: string;
-    details?: string;
-    value?: any;
-    customMessage?: string;
-    path: string[];
-}
-export interface SizeValidationError extends BaseValidationError {
-    name: 'size';
-    max: number;
-    min: number;
-}
-export interface RangeValidationError extends BaseValidationError {
-    name: 'range';
-    min?: number;
-    max?: number;
-}
-export interface InValidationError extends BaseValidationError {
-    name: 'in';
-    expected: string[];
-}
-export interface RequiredValidationError extends BaseValidationError {
-    name: 'required';
-}
-export interface UniqueValidationError extends BaseValidationError {
-    name: 'unique';
-    conflicting: Link<'Entry', 'Link'>[];
-}
-export interface ProhibitRegexpValidationError extends BaseValidationError {
-    name: 'prohibitRegexp';
-}
-export interface RegexpValidationError extends BaseValidationError {
-    name: 'regexp';
-}
-export interface LinkMimetypeGroupValidationError extends BaseValidationError {
-    name: 'linkMimetypeGroup';
-    mimetypeGroupName: string[];
-}
-export interface LinkContentTypeValidationError extends BaseValidationError {
-    name: 'linkContentType';
-    contentTypeId: string[];
-}
-export interface DateRangeValidationError extends BaseValidationError {
-    name: 'dateRange';
-    min: number;
-    max: number;
-}
-export interface NotResolvableValidationError extends BaseValidationError {
-    name: 'notResolvable';
-    link: {
-        linkType: string;
-    };
-}
-export interface UnknownValidationError extends BaseValidationError {
-    name: 'unknown';
-}
-export interface TypeValidationError extends BaseValidationError {
-    name: 'type';
-    type: string;
-}
-export type ValidationError = SizeValidationError | RangeValidationError | InValidationError | RequiredValidationError | UniqueValidationError | RegexpValidationError | ProhibitRegexpValidationError | LinkMimetypeGroupValidationError | LinkContentTypeValidationError | DateRangeValidationError | NotResolvableValidationError | UnknownValidationError | TypeValidationError | BaseValidationError;
+import { Link } from './utils';
+export interface BaseValidationError {
+    name: string;
+    message?: string;
+    details?: string;
+    value?: any;
+    customMessage?: string;
+    path: string[];
+}
+export interface SizeValidationError extends BaseValidationError {
+    name: 'size';
+    max: number;
+    min: number;
+}
+export interface RangeValidationError extends BaseValidationError {
+    name: 'range';
+    min?: number;
+    max?: number;
+}
+export interface InValidationError extends BaseValidationError {
+    name: 'in';
+    expected: string[];
+}
+export interface RequiredValidationError extends BaseValidationError {
+    name: 'required';
+}
+export interface UniqueValidationError extends BaseValidationError {
+    name: 'unique';
+    conflicting: Link<'Entry', 'Link'>[];
+}
+export interface ProhibitRegexpValidationError extends BaseValidationError {
+    name: 'prohibitRegexp';
+}
+export interface RegexpValidationError extends BaseValidationError {
+    name: 'regexp';
+}
+export interface LinkMimetypeGroupValidationError extends BaseValidationError {
+    name: 'linkMimetypeGroup';
+    mimetypeGroupName: string[];
+}
+export interface LinkContentTypeValidationError extends BaseValidationError {
+    name: 'linkContentType';
+    contentTypeId: string[];
+}
+export interface DateRangeValidationError extends BaseValidationError {
+    name: 'dateRange';
+    min: number;
+    max: number;
+}
+export interface NotResolvableValidationError extends BaseValidationError {
+    name: 'notResolvable';
+    link: {
+        linkType: string;
+    };
+}
+export interface UnknownValidationError extends BaseValidationError {
+    name: 'unknown';
+}
+export interface TypeValidationError extends BaseValidationError {
+    name: 'type';
+    type: string;
+}
+export type ValidationError = SizeValidationError | RangeValidationError | InValidationError | RequiredValidationError | UniqueValidationError | RegexpValidationError | ProhibitRegexpValidationError | LinkMimetypeGroupValidationError | LinkContentTypeValidationError | DateRangeValidationError | NotResolvableValidationError | UnknownValidationError | TypeValidationError | BaseValidationError;

package/dist/types/window.types.d.ts

@@ -1,17 +1,17 @@
-export interface WindowAPI {
-    /** Sets the iframe height to the given value in pixels or using scrollHeight if value is not passed */
-    updateHeight: (height?: number) => void;
-    /**
-     * Listens for DOM changes and updates height when the size changes.
-     *
-     * When passing absoluteElements true, an infinite loop can happen if elements are always rendered below the height of the window.
-     * e.g. transformed elements or absolute elements with negative bottom
-     * @param {Object} opts - Options to be passed to auto resize
-     * @param {Boolean} opts.absoluteElements - Defines if auto resize should consider absolut elements
-     */
-    startAutoResizer: ({ absoluteElements }?: {
-        absoluteElements?: boolean;
-    }) => void;
-    /** Stops resizing the iframe automatically. */
-    stopAutoResizer: () => void;
-}
+export interface WindowAPI {
+    /** Sets the iframe height to the given value in pixels or using scrollHeight if value is not passed */
+    updateHeight: (height?: number) => void;
+    /**
+     * Listens for DOM changes and updates height when the size changes.
+     *
+     * When passing absoluteElements true, an infinite loop can happen if elements are always rendered below the height of the window.
+     * e.g. transformed elements or absolute elements with negative bottom
+     * @param {Object} opts - Options to be passed to auto resize
+     * @param {Boolean} opts.absoluteElements - Defines if auto resize should consider absolut elements
+     */
+    startAutoResizer: ({ absoluteElements }?: {
+        absoluteElements?: boolean;
+    }) => void;
+    /** Stops resizing the iframe automatically. */
+    stopAutoResizer: () => void;
+}

package/dist/utils/deferred.d.ts

@@ -1,6 +1,6 @@
-export interface Deferred<T> {
-    promise: Promise<T>;
-    resolve: (value: T | PromiseLike<T>) => void;
-    isFulfilled: boolean;
-}
-export declare function createDeferred<T = unknown>(): Deferred<T>;
+export interface Deferred<T> {
+    promise: Promise<T>;
+    resolve: (value: T | PromiseLike<T>) => void;
+    isFulfilled: boolean;
+}
+export declare function createDeferred<T = unknown>(): Deferred<T>;

package/dist/window.d.ts

@@ -1,3 +1,3 @@
-import { Channel } from './channel';
-import { WindowAPI } from './types/window.types';
-export default function createWindow(currentGlobal: typeof globalThis, channel: Channel): WindowAPI;
+import { Channel } from './channel';
+import { WindowAPI } from './types/window.types';
+export default function createWindow(currentGlobal: typeof globalThis, channel: Channel): WindowAPI;

package/package.json

@@ -1 +1 @@
-{"name":"@contentful/app-sdk","description":"A JavaScript library to develop custom apps for Contentful","version":"4.16.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.20.0","@types/chai-as-promised":"7.1.5","@types/cross-spawn":"6.0.2","@types/fs-extra":"11.0.1","@types/jsdom":"21.1.0","@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.29.1","cross-spawn":"7.0.3","eslint":"7.32.0","eslint-config-prettier":"8.6.0","eslint-config-standard":"16.0.3","eslint-plugin-import":"2.27.5","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"4.2.1","eslint-plugin-promise":"6.1.1","eslint-plugin-react":"7.32.2","eslint-plugin-standard":"5.0.0","fs-extra":"11.1.0","husky":"8.0.3","jsdom":"21.1.0","lint-staged":"13.1.1","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.4","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.5.0","typescript":"4.9.5"},"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/app-sdk","description":"A JavaScript library to develop custom apps for Contentful","version":"4.17.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.3","@semantic-release/exec":"6.0.3","@semantic-release/git":"10.0.1","@testing-library/dom":"9.2.0","@types/chai-as-promised":"7.1.5","@types/cross-spawn":"6.0.2","@types/fs-extra":"11.0.1","@types/jsdom":"21.1.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.31.3","cross-spawn":"7.0.3","eslint":"7.32.0","eslint-config-prettier":"8.8.0","eslint-config-standard":"16.0.3","eslint-plugin-import":"2.27.5","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"4.2.1","eslint-plugin-promise":"6.1.1","eslint-plugin-react":"7.32.2","eslint-plugin-standard":"5.0.0","fs-extra":"11.1.1","husky":"8.0.3","jsdom":"21.1.1","lint-staged":"13.2.0","mocha":"10.2.0","mocha-junit-reporter":"2.2.0","mocha-multi-reporters":"1.5.1","mochawesome":"7.1.3","mochawesome-merge":"4.3.0","mochawesome-report-generator":"6.2.0","prettier":"2.8.7","rollup":"2.79.1","rollup-plugin-terser":"7.0.2","rollup-plugin-typescript2":"0.34.1","semantic-release":"19.0.5","sinon":"15.0.3","sinon-chai":"3.7.0","ts-mocha":"10.0.0","tslib":"2.5.0","typescript":"5.0.2"},"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"}}