contentful-ui-extensions-sdk - npm Package Compare versions

Comparing version 3.10.7 to 3.10.8

package.json

 {
   "name": "contentful-ui-extensions-sdk",
   "description": "SDK to develop custom UI Extension for the Contentful Web App",
-  "version": "3.10.7",
+  "version": "3.10.8",
   "author": "Contentful GmbH",
@@ -6,0 +6,0 @@ "license": "MIT",

typings.d.ts

@@ -29,2 +29,28 @@ declare module 'contentful-ui-extensions-sdk' {
 
+  interface Link {
+    sys: {
+      id: string
+      type: string
+      linkType: string
+    }
+  }
+
+  interface EntrySys {
+    space: Link
+    id: string
+    type: string
+    createdAt: string
+    updatedAt: string
+    environment: Link
+    publishedVersion: number
+    publishedAt: string
+    firstPublishedAt: string
+    createdBy: Link
+    updatedBy: Link
+    publishedCounter: number
+    version: number
+    publishedBy: Link
+    contentType: Link
+  }
+
   /* Field API */
@@ -91,5 +117,7 @@
     /** Calls the callback every time the value of the field is changed by an external event or when setValue() is called. */
-    onValueChanged: onValueChangedType | onValueChangeWithLocaleType
+    onValueChanged: onValueChangeWithLocaleType
+    onValueChanged: onValueChangedType
     /** Calls the callback when the disabled status of the field changes. */
-    onIsDisabledChanged: onIsDisabledChangedType | onIsDisabledChangedWithLocaleType
+    onIsDisabledChanged: onIsDisabledChangedWithLocaleType
+    onIsDisabledChanged: onIsDisabledChangedType
   }
@@ -99,5 +127,5 @@
     /** Returns metadata for an entry. */
-    getSys: () => Object
+    getSys: () => EntrySys
     /** Calls the callback with metadata every time that metadata changes. */
-    onSysChanged: (callback: (sys: Object) => void) => Function
+    onSysChanged: (callback: (sys: EntrySys) => void) => Function
     /** Allows to control the values of all other fields in the current entry. */
@@ -122,10 +150,2 @@ fields: { [key: string]: EntryFieldAPI }
 
-  interface Link {
-    sys: {
-      id: string
-      type: string
-      linkType: string
-    }
-  }
-
   interface ContentType {
@@ -188,31 +208,39 @@ sys: {
   interface SpaceAPI {
-    getContentType: (id: string) => Promise<Object>
-    getContentTypes: () => Promise<CollectionResponse<Object>>
-    createContentType: (data: any) => Promise<Object>
-    updateContentType: (data: any) => Promise<Object>
-    deleteContentType: (data: any) => Promise<Object>
+    getContentType: <T = Object>(id: string) => Promise<T>
+    getContentTypes: <T = Object>() => Promise<CollectionResponse<T>>
+    createContentType: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    updateContentType: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    deleteContentType: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
 
-    getEntry: (id: string) => Promise<Object>
-    getEntrySnapshots: (id: string) => Promise<any>
-    getEntries: (query?: SearchQuery) => Promise<CollectionResponse<Object>>
-    createEntry: (contentTypeId: string, data: any) => Promise<Object>
-    updateEntry: (data: any) => Promise<Object>
-    publishEntry: (data: any) => Promise<Object>
-    unpublishEntry: (data: any) => Promise<Object>
-    archiveEntry: (data: any) => Promise<Object>
-    unarchiveEntry: (data: any) => Promise<Object>
-    deleteEntry: (data: any) => Promise<Object>
-    getPublishedEntries: (query?: SearchQuery) => Promise<CollectionResponse<Object>>
+    getEntry: <T = Object>(id: string) => Promise<T>
+    getEntrySnapshots: <T = Object>(id: string) => Promise<CollectionResponse<T>>
+    getEntries: <T = Object, InputArgs = SearchQuery>(
+      query?: InputArgs
+    ) => Promise<CollectionResponse<T>>
+    createEntry: <T = Object, InputArgs = any>(contentTypeId: string, data: InputArgs) => Promise<T>
+    updateEntry: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    publishEntry: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    unpublishEntry: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    archiveEntry: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    unarchiveEntry: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    deleteEntry: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    getPublishedEntries: <T = Object, InputArgs = SearchQuery>(
+      query?: InputArgs
+    ) => Promise<CollectionResponse<T>>
 
-    getAsset: (id: string) => Promise<Object>
-    getAssets: (query?: SearchQuery) => Promise<CollectionResponse<Object>>
-    createAsset: (data: any) => Promise<Object>
-    updateAsset: (data: any) => Promise<Object>
-    deleteAsset: (data: any) => Promise<Object>
-    publishAsset: (data: any) => Promise<Object>
-    unpublishAsset: (data: any) => Promise<Object>
-    archiveAsset: (data: any) => Promise<Object>
-    processAsset: (data: any, locale: string) => Promise<Object>
-    unarchiveAsset: (data: any) => Promise<Object>
-    getPublishedAssets: (query?: SearchQuery) => Promise<CollectionResponse<Object>>
+    getAsset: <T = Object>(id: string) => Promise<T>
+    getAssets: <T = Object, InputArgs = SearchQuery>(
+      query?: SearchQuery
+    ) => Promise<CollectionResponse<T>>
+    createAsset: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    updateAsset: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    deleteAsset: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    publishAsset: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    unpublishAsset: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    archiveAsset: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    processAsset: <T = Object, InputArgs = any>(data: InputArgs, locale: string) => Promise<T>
+    unarchiveAsset: <T = Object, InputArgs = any>(data: InputArgs) => Promise<T>
+    getPublishedAssets: <T = Object, InputArgs = SearchQuery>(
+      query?: InputArgs
+    ) => Promise<CollectionResponse<T>>
     createUpload: (base64data: string) => void
@@ -222,3 +250,3 @@ waitUntilAssetProcessed: (assetId: string, locale: string) => void
     /** Returns all users who belong to the space. */
-    getUsers: () => Promise<CollectionResponse<Object>>
+    getUsers: <T = Object>() => Promise<CollectionResponse<T>>
 
@@ -228,3 +256,3 @@ /** Returns editor interface for a given content type */
     /** Returns editor interfaces for a given environment */
-    getEditorInterfaces: () => Promise<CollectionResponse<Object>>
+    getEditorInterfaces: () => Promise<CollectionResponse<EditorInterface>>
   }
@@ -242,3 +270,3 @@
     /** An object with keys of locale codes and values of corresponding fallback locale codes. If there's no fallback then the value is undefined. */
-    fallbacks: { [key: string]: string }
+    fallbacks: { [key: string]: string | undefined }
     /** An object with keys of locale codes and values of corresponding boolean value indicating if the locale is optional or not. */
@@ -304,8 +332,8 @@ optional: { [key: string]: boolean }
     /** Opens a dialog for selecting a single entry. */
-    selectSingleEntry: (options?: {
+    selectSingleEntry: <T = Object>(options?: {
       locale?: string
       contentTypes?: string[]
-    }) => Promise<Object | null>
+    }) => Promise<T | null>
     /** Opens a dialog for selecting multiple entries. */
-    selectMultipleEntries: (options?: {
+    selectMultipleEntries: <T = Object>(options?: {
       locale?: string
@@ -315,11 +343,11 @@ contentTypes?: string[]
       max?: number
-    }) => Promise<Object[] | null>
+    }) => Promise<T[] | null>
     /** Opens a dialog for selecting a single asset. */
-    selectSingleAsset: (options?: { locale?: string }) => Promise<Object | null>
+    selectSingleAsset: <T = Object>(options?: { locale?: string }) => Promise<T | null>
     /** Opens a dialog for selecting multiple assets. */
-    selectMultipleAssets: (options?: {
+    selectMultipleAssets: <T = Object>(options?: {
       locale?: string
       min?: number
       max?: number
-    }) => Promise<Object[] | null>
+    }) => Promise<T[] | null>
   }
@@ -343,22 +371,22 @@
     /** Opens an existing entry in the current Web App session. */
-    openEntry: (
+    openEntry: <T = Object>(
       entryId: string,
       options?: NavigatorAPIOptions
-    ) => Promise<{ navigated: boolean; entity: Object }>
+    ) => Promise<{ navigated: boolean; entity: T }>
     /** Opens an existing asset in the current Web App session. */
-    openAsset: (
+    openAsset: <T = Object>(
       assetId: string,
       options?: NavigatorAPIOptions
-    ) => Promise<{ navigated: boolean; entity: Object }>
+    ) => Promise<{ navigated: boolean; entity: T }>
     /** Opens a new entry in the current Web App session. */
-    openNewEntry: (
+    openNewEntry: <T = Object>(
       contentTypeId: string,
       options?: NavigatorAPIOptions
-    ) => Promise<{ navigated: boolean; entity: Object }>
+    ) => Promise<{ navigated: boolean; entity: T }>
     /** Opens a new asset in the current Web App session. */
-    openNewAsset: (
+    openNewAsset: <T = Object>(
       options: NavigatorAPIOptions
     ) => Promise<{
       navigated: boolean
-      entity: Object
+      entity: T
     }>
@@ -365,0 +393,0 @@ /** Navigates to a page extension in the current Web App session. Calling without `options` will navigate to the home route of your page extension. */

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

90506

increased by1.41%

Lines of code

1889

increased by1.45%

No dependency changes