contentful-ui-extensions-sdk
Advanced tools
Comparing version 4.0.0-alpha.30 to 4.0.0-alpha.31
@@ -0,1 +1,8 @@ | ||
# [4.0.0-alpha.31](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0-alpha.30...v4.0.0-alpha.31) (2021-07-29) | ||
### Bug Fixes | ||
* adjust comments to mention apps instead of extensions ([#880](https://github.com/contentful/ui-extensions-sdk/issues/880)) ([f5fcc8f](https://github.com/contentful/ui-extensions-sdk/commit/f5fcc8f49084b02bb7de25bf84985580ca856139)) | ||
# [4.0.0-alpha.30](https://github.com/contentful/ui-extensions-sdk/compare/v4.0.0-alpha.29...v4.0.0-alpha.30) (2021-07-26) | ||
@@ -2,0 +9,0 @@ |
@@ -56,3 +56,3 @@ import { ContentType, EditorInterface, SpaceMembership, Role, ContentTypeField, Metadata } from './entities'; | ||
export interface LocationAPI { | ||
/** Checks the location in which your extension is running */ | ||
/** Checks the location in which your app is running */ | ||
is: (type: string) => boolean; | ||
@@ -121,3 +121,3 @@ } | ||
export interface BaseExtensionSDK { | ||
/** Exposes methods that allow the extension to read and manipulate a wide range of objects in the space. */ | ||
/** Exposes methods that allow the app to read and manipulate a wide range of objects in the space. */ | ||
space: SpaceAPI; | ||
@@ -134,5 +134,5 @@ /** Information about the current user and roles */ | ||
notifier: NotifierAPI; | ||
/** Exposes extension configuration parameters */ | ||
/** Exposes app configuration parameters */ | ||
parameters: ParametersAPI; | ||
/** Exposes method to identify extension's location */ | ||
/** Exposes method to identify app's location */ | ||
location: LocationAPI; | ||
@@ -147,27 +147,27 @@ /** Exposes methods for checking user's access level */ | ||
export declare type EditorExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & { | ||
/** A set of IDs actual for the extension */ | ||
/** A set of IDs actual for the app */ | ||
ids: Omit<IdsAPI, 'field'>; | ||
}; | ||
export declare type SidebarExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & SharedEditorSDK & { | ||
/** A set of IDs actual for the extension */ | ||
/** A set of IDs actual for the app */ | ||
ids: Omit<IdsAPI, 'field'>; | ||
/** Methods to update the size of the iframe the extension is contained within. */ | ||
/** Methods to update the size of the iframe the app is contained within. */ | ||
window: WindowAPI; | ||
}; | ||
export declare type FieldExtensionSDK = BaseExtensionSDK & SharedEditorSDK & { | ||
/** Gives you access to the value and metadata of the field the extension is attached to. */ | ||
/** Gives you access to the value and metadata of the field the app is attached to. */ | ||
field: FieldAPI; | ||
/** Methods to update the size of the iframe the extension is contained within. */ | ||
/** Methods to update the size of the iframe the app is contained within. */ | ||
window: WindowAPI; | ||
}; | ||
export declare type DialogExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & { | ||
/** A set of IDs actual for the extension */ | ||
/** A set of IDs actual for the app */ | ||
ids: Omit<IdsAPI, EntryScopedIds>; | ||
/** Closes the dialog and resolves openExtension promise with data */ | ||
/** Closes the dialog and resolves openCurrentApp promise with data */ | ||
close: (data?: any) => void; | ||
/** Methods to update the size of the iframe the extension is contained within. */ | ||
/** Methods to update the size of the iframe the app is contained within. */ | ||
window: WindowAPI; | ||
}; | ||
export declare type PageExtensionSDK = Omit<BaseExtensionSDK, 'ids'> & { | ||
/** A set of IDs actual for the extension */ | ||
/** A set of IDs actual for the app */ | ||
ids: Omit<IdsAPI, EntryScopedIds>; | ||
@@ -174,0 +174,0 @@ }; |
@@ -42,3 +42,3 @@ export interface OpenAlertOptions { | ||
openCurrentApp: (options?: Omit<OpenCustomWidgetOptions, 'id'>) => Promise<any>; | ||
/** Opens the current extension or app in a dialog */ | ||
/** Opens the current app or extension in a dialog */ | ||
openCurrent: (options?: Omit<OpenCustomWidgetOptions, 'id'> | OpenCustomWidgetOptions) => Promise<any>; | ||
@@ -45,0 +45,0 @@ /** Opens a dialog for selecting a single entry. */ |
@@ -7,5 +7,5 @@ import { ContentTypeFieldValidation } from './entities'; | ||
id: string; | ||
/** The current locale of a field the extension is attached to. */ | ||
/** The current locale of a field the app is attached to. */ | ||
locale: string; | ||
/** Holds the type of the field the extension is attached to. */ | ||
/** Holds the type of the field the app is attached to. */ | ||
type: string; | ||
@@ -12,0 +12,0 @@ /** Indicates if a value for this field is required */ |
{ | ||
"name": "contentful-ui-extensions-sdk", | ||
"description": "SDK to develop custom UI Extension for the Contentful Web App", | ||
"version": "4.0.0-alpha.30", | ||
"version": "4.0.0-alpha.31", | ||
"author": "Contentful GmbH", | ||
@@ -6,0 +6,0 @@ "license": "MIT", |
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
86298