@contentful/app-sdk 5.0.0-alpha.2 → 5.0.0-alpha.3

package/dist/app.d.ts

@@ -1,3 +1,4 @@
 import { Channel } from './channel';
 import { AppConfigAPI } from './types';
-export default function createApp(channel: Channel): AppConfigAPI;
+import { KeyValueMap } from './types/entities';
+export default function createApp(channel: Channel): AppConfigAPI<KeyValueMap>;

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

@@ -228,7 +228,7 @@ export type ConfigAppSDK<InstallationParameters extends KeyValueMap = KeyValueMa
     ids: Omit<IdsAPI, EntryScopedIds | 'app'> & {
         app: string;
     };
-    app: AppConfigAPI;
+    app: AppConfigAPI<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>;
 export interface ConnectMessage {

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

@@ -16,12 +16,12 @@ interface AppStateEditorInterfaceItem {
 export interface AppState {
     EditorInterface: Record<ContentType['sys']['id'], AppStateEditorInterfaceItem>;
 }
-export type OnConfigureHandlerReturn = {
-    parameters?: KeyValueMap | null;
+export type OnConfigureHandlerReturn<InstallationParameters extends KeyValueMap> = {
+    parameters?: InstallationParameters | null;
     targetState?: AppState | null;
 } | false;
-export type OnConfigureHandler = () => OnConfigureHandlerReturn | Promise<OnConfigureHandlerReturn>;
-export interface AppConfigAPI {
+export type OnConfigureHandler<InstallationParameters extends KeyValueMap> = () => OnConfigureHandlerReturn<InstallationParameters> | Promise<OnConfigureHandlerReturn<InstallationParameters>>;
+export interface AppConfigAPI<InstallationParameters extends KeyValueMap> {
     /** Tells the web app that the app is loaded */
     setReady: () => Promise<void>;
     /** Returns true if an App is installed */
@@ -29,9 +29,9 @@ export interface AppConfigAPI {
     /** Returns current state of an App */
     getCurrentState: () => Promise<AppState | null>;
     /** Returns parameters of an App, null otherwise */
-    getParameters: <T extends KeyValueMap = KeyValueMap>() => Promise<null | T>;
+    getParameters: () => Promise<null | InstallationParameters>;
     /** Registers a handler to be called to produce parameters for an App */
-    onConfigure: (handler: OnConfigureHandler) => void;
+    onConfigure: (handler: OnConfigureHandler<InstallationParameters>) => void;
     /** Registers a handler to be called once configuration was finished */
     onConfigurationCompleted: (handler: (err: null | {
         message: string;

package/dist/types/index.d.ts

@@ -5,7 +5,7 @@ export type { Asset, CanonicalRequest, ContentType, ContentTypeField, EditorInte
 export type { EntryAPI, TaskAPI, TaskInputData } from './entry.types';
 export type { FieldInfo, EntryFieldInfo, EntryFieldAPI } from './field.types';
 export type { FieldAPI } from './field-locale.types';
-export type { NavigatorAPI, AppPageLocationOptions, NavigatorAPIOptions, NavigatorOpenResponse, NavigatorPageResponse, NavigatorSlideInfo, } from './navigator.types';
+export type { NavigatorAPI, AppPageLocationOptions, NavigatorAPIOptions, NavigatorOpenResponse, NavigatorPageResponse, NavigatorSlideInfo, OpenEntriesListOptions, OpenAssetsListOptions, } from './navigator.types';
 export type { SearchQuery, CollectionResponse, EntrySys, ContentEntitySys, ContentEntityType, FieldType, FieldLinkType, 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';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentful/app-sdk",
   "description": "A JavaScript library to develop custom apps for Contentful",
-  "version": "5.0.0-alpha.2",
+  "version": "5.0.0-alpha.3",
   "author": "Contentful GmbH",
   "license": "MIT",
   "sideEffects": true,