contentful-ui-extensions-sdk
Advanced tools
Comparing version 4.17.0 to 4.17.1
@@ -1,3 +0,3 @@ | ||
import { KnownSDK, ConnectMessage } from './types'; | ||
import { ConnectMessage, KnownAppSDK } from './types'; | ||
import { Channel } from './channel'; | ||
export default function createAPI(channel: Channel, data: ConnectMessage, currentGlobal: typeof globalThis): KnownSDK; | ||
export default function createAPI(channel: Channel, data: ConnectMessage, currentGlobal: typeof globalThis): KnownAppSDK; |
@@ -1,7 +0,7 @@ | ||
import { KnownSDK } from './types'; | ||
import { KnownAppSDK } from './types'; | ||
export * from './types'; | ||
export { default as locations } from './locations'; | ||
type Init = <T extends KnownSDK = KnownSDK>(initCallback: (sdk: T) => any, options?: { | ||
type Init = <T extends KnownAppSDK = KnownAppSDK>(initCallback: (sdk: T) => any, options?: { | ||
supressIframeWarning?: boolean; | ||
}) => void; | ||
export declare const init: Init; |
@@ -1,6 +0,6 @@ | ||
import { ConnectMessage, KnownSDK } from './types'; | ||
import { ConnectMessage, KnownAppSDK } from './types'; | ||
import { Channel } from './channel'; | ||
export declare function createInitializer(currentGlobal: typeof globalThis, apiCreator: (channel: Channel, data: ConnectMessage, currentGlobal: typeof globalThis) => KnownSDK): (initCb: (sdk: KnownSDK, customSdk: any) => any, { makeCustomApi, supressIframeWarning, }?: { | ||
export declare function createInitializer(currentGlobal: typeof globalThis, apiCreator: (channel: Channel, data: ConnectMessage, currentGlobal: typeof globalThis) => KnownAppSDK): (initCb: (sdk: KnownAppSDK, customSdk: any) => any, { makeCustomApi, supressIframeWarning, }?: { | ||
makeCustomApi?: Function | undefined; | ||
supressIframeWarning?: boolean | undefined; | ||
}) => void; |
@@ -165,3 +165,3 @@ import { ContentType, EditorInterface, SpaceMembership, Role, ContentTypeField, Metadata, Entry, Task, Asset, WorkflowDefinition } from './entities'; | ||
type EntryScopedIds = 'field' | 'entry' | 'contentType'; | ||
export interface BaseExtensionSDK { | ||
export interface BaseAppSDK { | ||
/** @deprecated since version 4.0.0 consider using the CMA instead | ||
@@ -192,7 +192,7 @@ * See https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/#using-the-contentful-management-library for more details | ||
} | ||
export type EditorExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & { | ||
export type EditorAppSDK = Omit<BaseAppSDK, 'ids'> & SharedEditorSDK & { | ||
/** A set of IDs for the app */ | ||
ids: Omit<IdsAPI, 'field'>; | ||
}; | ||
export type SidebarExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & { | ||
export type SidebarAppSDK = Omit<BaseAppSDK, 'ids'> & SharedEditorSDK & { | ||
/** A set of IDs for the app */ | ||
@@ -203,3 +203,3 @@ ids: Omit<IdsAPI, 'field'>; | ||
}; | ||
export type FieldExtensionSDK = BaseExtensionSDK & SharedEditorSDK & { | ||
export type FieldAppSDK = BaseAppSDK & SharedEditorSDK & { | ||
/** A set of IDs for the app */ | ||
@@ -212,3 +212,3 @@ ids: IdsAPI; | ||
}; | ||
export type DialogExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & { | ||
export type DialogAppSDK = Omit<BaseAppSDK, 'ids'> & { | ||
/** A set of IDs for the app */ | ||
@@ -221,10 +221,10 @@ ids: Omit<IdsAPI, EntryScopedIds>; | ||
}; | ||
export type PageExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & { | ||
export type PageAppSDK = Omit<BaseAppSDK, 'ids'> & { | ||
/** A set of IDs actual for the app */ | ||
ids: Omit<IdsAPI, EntryScopedIds>; | ||
}; | ||
export type HomeExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & { | ||
export type HomeAppSDK = Omit<BaseAppSDK, 'ids'> & { | ||
ids: Omit<IdsAPI, EntryScopedIds>; | ||
}; | ||
export type AppExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & { | ||
export type ConfigAppSDK = Omit<BaseAppSDK, 'ids'> & { | ||
/** A set of IDs actual for the app */ | ||
@@ -236,3 +236,21 @@ ids: Omit<IdsAPI, EntryScopedIds | 'extension' | 'app'> & { | ||
}; | ||
export type KnownSDK = FieldExtensionSDK | SidebarExtensionSDK | DialogExtensionSDK | EditorExtensionSDK | PageExtensionSDK | AppExtensionSDK | HomeExtensionSDK; | ||
export type KnownAppSDK = FieldAppSDK | SidebarAppSDK | DialogAppSDK | EditorAppSDK | PageAppSDK | ConfigAppSDK | HomeAppSDK; | ||
/** @deprecated consider using {@link BaseAppSDK} */ | ||
export type BaseExtensionSDK = BaseAppSDK; | ||
/** @deprecated consider using {@link EditorAppSDK} */ | ||
export type EditorExtensionSDK = EditorAppSDK; | ||
/** @deprecated consider using {@link SidebarAppSDK} */ | ||
export type SidebarExtensionSDK = SidebarAppSDK; | ||
/** @deprecated consider using {@link FieldAppSDK} */ | ||
export type FieldExtensionSDK = FieldAppSDK; | ||
/** @deprecated consider using {@link DialogAppSDK} */ | ||
export type DialogExtensionSDK = DialogAppSDK; | ||
/** @deprecated consider using {@link PageAppSDK} */ | ||
export type PageExtensionSDK = PageAppSDK; | ||
/** @deprecated consider using {@link HomeAppSDK} */ | ||
export type HomeExtensionSDK = HomeAppSDK; | ||
/** @deprecated consider using {@link ConfigAppSDK} */ | ||
export type AppExtensionSDK = ConfigAppSDK; | ||
/** @deprecated consider using {@link KnownAppSDK} */ | ||
export type KnownSDK = KnownAppSDK; | ||
export interface Locations { | ||
@@ -239,0 +257,0 @@ LOCATION_ENTRY_FIELD: 'entry-field'; |
@@ -1,2 +0,2 @@ | ||
export type { AccessAPI, AppExtensionSDK, ArchiveableAction, BaseExtensionSDK, ConnectMessage, ContentTypeAPI, CrudAction, DialogExtensionSDK, EditorExtensionSDK, EditorLocaleSettings, FieldExtensionSDK, HomeExtensionSDK, IdsAPI, KnownSDK, LocalesAPI, LocationAPI, Locations, NotifierAPI, PageExtensionSDK, ParametersAPI, PublishableAction, SharedEditorSDK, SidebarExtensionSDK, UserAPI, JSONPatchItem, } 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, } from './api.types'; | ||
export type { AppConfigAPI, AppState, OnConfigureHandler, OnConfigureHandlerReturn, } from './app.types'; | ||
@@ -3,0 +3,0 @@ export type { DialogsAPI, EntityDialogOptions, OpenAlertOptions, OpenConfirmOptions, OpenCustomWidgetOptions, } from './dialogs.types'; |
@@ -1,1 +0,1 @@ | ||
{"name":"contentful-ui-extensions-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"}} | ||
{"name":"contentful-ui-extensions-sdk","description":"A JavaScript library to develop custom apps for Contentful","version":"4.17.1","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.5","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.3"},"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"}} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
100096
1837