contentful-management 11.58.0-canary.1 → 11.58.0-canary.2

package/dist/typings/common-types.d.ts

@@ -159,6 +159,7 @@ export interface EntityMetaSysProps extends MetaSysProps {
     fieldStatus?: {
         '*': Record<string, 'draft' | 'changed' | 'published'>;
     };
+    release?: Link<'Release'>;
 }
 export interface EntryMetaSysProps extends EntityMetaSysProps {
     contentType: SysLink;
@@ -454,6 +455,14 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'ReleaseAction', 'get', UA>): MRReturn<'ReleaseAction', 'get'>;
     (opts: MROpts<'ReleaseAction', 'getMany', UA>): MRReturn<'ReleaseAction', 'getMany'>;
     (opts: MROpts<'ReleaseAction', 'queryForRelease', UA>): MRReturn<'ReleaseAction', 'queryForRelease'>;
+    (opts: MROpts<'ReleaseAsset', 'get', UA>): MRReturn<'ReleaseAsset', 'get'>;
+    (opts: MROpts<'ReleaseAsset', 'getMany', UA>): MRReturn<'ReleaseAsset', 'getMany'>;
+    (opts: MROpts<'ReleaseAsset', 'update', UA>): MRReturn<'ReleaseAsset', 'update'>;
+    (opts: MROpts<'ReleaseAsset', 'create', UA>): MRReturn<'ReleaseAsset', 'create'>;
+    (opts: MROpts<'ReleaseAsset', 'createWithId', UA>): MRReturn<'ReleaseAsset', 'createWithId'>;
+    (opts: MROpts<'ReleaseAsset', 'createFromFiles', UA>): MRReturn<'ReleaseAsset', 'createFromFiles'>;
+    (opts: MROpts<'ReleaseAsset', 'processForAllLocales', UA>): MRReturn<'ReleaseAsset', 'processForAllLocales'>;
+    (opts: MROpts<'ReleaseAsset', 'processForLocale', UA>): MRReturn<'ReleaseAsset', 'processForLocale'>;
     (opts: MROpts<'ReleaseEntry', 'get', UA>): MRReturn<'ReleaseEntry', 'get'>;
     (opts: MROpts<'ReleaseEntry', 'getMany', UA>): MRReturn<'ReleaseEntry', 'getMany'>;
     (opts: MROpts<'ReleaseEntry', 'update', UA>): MRReturn<'ReleaseEntry', 'update'>;
@@ -1047,13 +1056,16 @@ export type MRActions = {
             return: CollectionProp<AssetProps>;
         };
         getMany: {
-            params: GetSpaceEnvironmentParams & QueryParams;
+            params: GetSpaceEnvironmentParams & QueryParams & {
+                releaseId?: string;
+            };
             headers?: RawAxiosRequestHeaders;
             return: CollectionProp<AssetProps>;
         };
         get: {
             params: GetSpaceEnvironmentParams & {
                 assetId: string;
+                releaseId?: string;
             } & QueryParams;
             headers?: RawAxiosRequestHeaders;
             return: AssetProps;
@@ -1061,6 +1073,7 @@ export type MRActions = {
         update: {
             params: GetSpaceEnvironmentParams & {
                 assetId: string;
+                releaseId?: string;
             };
             payload: AssetProps;
             headers?: RawAxiosRequestHeaders;
@@ -1098,13 +1111,16 @@ export type MRActions = {
             return: AssetProps;
         };
         create: {
-            params: GetSpaceEnvironmentParams;
+            params: GetSpaceEnvironmentParams & {
+                releaseId?: string;
+            };
             payload: CreateAssetProps;
             return: AssetProps;
         };
         createWithId: {
             params: GetSpaceEnvironmentParams & {
                 assetId: string;
+                releaseId?: string;
             };
             payload: CreateAssetProps;
             return: AssetProps;
@@ -1112,6 +1128,7 @@ export type MRActions = {
         createFromFiles: {
             params: GetSpaceEnvironmentParams & {
                 uploadTimeout?: number;
+                releaseId?: string;
             };
             payload: Omit<AssetFileProp, 'sys'>;
             return: AssetProps;
@@ -1510,21 +1527,29 @@ export type MRActions = {
             return: CollectionProp<EntryProps<any>>;
         };
         getMany: {
-            params: GetManyEntryParams & QueryParams;
+            params: GetManyEntryParams & QueryParams & {
+                releaseId?: string;
+            };
             return: CollectionProp<EntryProps<any, any>>;
         };
         get: {
-            params: GetEntryParams & QueryParams;
+            params: GetEntryParams & QueryParams & {
+                releaseId?: string;
+            };
             return: EntryProps<any, any>;
         };
         patch: {
-            params: PatchEntryParams & QueryParams;
+            params: PatchEntryParams & QueryParams & {
+                releaseId?: string;
+            };
             payload: OpPatch[];
             headers?: RawAxiosRequestHeaders;
             return: EntryProps<any>;
         };
         update: {
-            params: UpdateEntryParams & QueryParams;
+            params: UpdateEntryParams & QueryParams & {
+                releaseId?: string;
+            };
             payload: EntryProps<any>;
             headers?: RawAxiosRequestHeaders;
             return: EntryProps<any>;
@@ -1870,78 +1895,109 @@ export type MRActions = {
             return: ReleaseActionProps<'validate'>;
         };
     };
+    ReleaseAsset: {
+        get: {
+            params: GetReleaseAssetParams & QueryParams;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        getMany: {
+            params: GetManyReleaseAssetParams & QueryParams;
+            headers?: RawAxiosRequestHeaders;
+            return: CollectionProp<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+        };
+        update: {
+            params: UpdateReleaseAssetParams & QueryParams;
+            payload: AssetProps;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        create: {
+            params: CreateReleaseAssetParams & QueryParams;
+            payload: CreateAssetProps;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        createWithId: {
+            params: CreateWithIdReleaseAssetParams & QueryParams;
+            payload: CreateAssetProps;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        createFromFiles: {
+            params: CreateWithFilesReleaseAssetParams & QueryParams;
+            payload: Omit<AssetFileProp, 'sys'>;
+            headers?: RawAxiosRequestHeaders;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        processForAllLocales: {
+            params: ProcessForAllLocalesReleaseAssetParams;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+        processForLocale: {
+            params: ProcessForLocaleReleaseAssetParams;
+            return: AssetProps<{
+                release: Link<'Release'>;
+            }>;
+        };
+    };
     ReleaseEntry: {
         get: {
-            params: GetReleaseEntryParams;
+            params: GetReleaseEntryParams & QueryParams;
+            headers?: RawAxiosRequestHeaders;
             return: EntryProps<any, any>;
         };
         getMany: {
-            params: GetManyReleaseEntryParams;
+            params: GetManyReleaseEntryParams & QueryParams;
+            headers?: RawAxiosRequestHeaders;
             return: CollectionProp<EntryProps<any, any>>;
         };
         update: {
-            params: UpdateReleaseEntryParams & {
-                entryId: string;
-            };
+            params: UpdateReleaseEntryParams & QueryParams;
             payload: EntryProps<any>;
             headers?: RawAxiosRequestHeaders;
             return: EntryProps<any, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+                release: Link<'Release'>;
             }>;
         };
         patch: {
-            params: PatchReleaseEntryParams & {
-                entryId: string;
-                version: number;
-            };
+            params: PatchReleaseEntryParams & QueryParams;
             payload: OpPatch[];
             headers?: RawAxiosRequestHeaders;
             return: EntryProps<any, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+                release: Link<'Release'>;
             }>;
         };
         create: {
-            params: CreateReleaseEntryParams;
+            params: CreateReleaseEntryParams & QueryParams;
             payload: CreateEntryProps<any>;
             headers?: RawAxiosRequestHeaders;
             return: EntryProps<any, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+                release: Link<'Release'>;
             }>;
         };
         createWithId: {
-            params: GetSpaceEnvironmentParams & {
-                releaseId: string;
+            params: CreateReleaseEntryParams & {
                 entryId: string;
-                contentTypeId: string;
-            };
+            } & QueryParams;
             payload: CreateEntryProps<any>;
             headers?: RawAxiosRequestHeaders;
             return: EntryProps<any, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+                release: Link<'Release'>;
             }>;
         };
     };
@@ -2623,11 +2679,8 @@ export type GetEditorInterfaceParams = GetSpaceEnvironmentParams & {
 };
 export type GetEntryParams = GetSpaceEnvironmentParams & {
     entryId: string;
-    releaseId?: string;
-};
-export type GetManyEntryParams = GetSpaceEnvironmentParams & {
-    releaseId?: string;
 };
+export type GetManyEntryParams = GetSpaceEnvironmentParams;
 export type PatchEntryParams = GetSpaceEnvironmentParams & {
     entryId: string;
     version: number;
@@ -2662,10 +2715,45 @@ export type GetOrganizationParams = {
 export type GetReleaseParams = ReleaseEnvironmentParams & {
     releaseId: string;
 };
+export type GetReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    assetId: string;
+};
+export type GetManyReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+};
 export type GetReleaseEntryParams = GetSpaceEnvironmentParams & {
-    releaseId?: string;
+    releaseId: string;
     entryId: string;
 };
+export type CreateReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+};
+export type CreateWithIdReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    assetId: string;
+};
+export type CreateWithFilesReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    uploadTimeout?: number;
+};
+export type UpdateReleaseAssetParams = GetSpaceEnvironmentParams & {
+    releaseId: string;
+    assetId: string;
+};
+export type ProcessForLocaleReleaseAssetParams = GetSpaceEnvironmentParams & {
+    asset: AssetProps<{
+        release: Link<'Release'>;
+    }>;
+    locale: string;
+    options?: AssetProcessingForLocale;
+};
+export type ProcessForAllLocalesReleaseAssetParams = GetSpaceEnvironmentParams & {
+    asset: AssetProps<{
+        release: Link<'Release'>;
+    }>;
+    options?: AssetProcessingForLocale;
+};
 export type GetManyReleaseEntryParams = GetSpaceEnvironmentParams & {
     releaseId: string;
 };

package/dist/typings/create-environment-api.d.ts

@@ -625,7 +625,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
+    getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
     /**
      * Gets a collection of published Assets
      * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -644,7 +644,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
      * .catch(console.error)
      * ```
      */
-    getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
+    getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
     /**
      * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
      * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.

package/dist/typings/entities/asset.d.ts

@@ -1,7 +1,7 @@
 import type { Stream } from 'stream';
 import type { MetaSysProps, DefaultElements, EntityMetaSysProps, MetadataProps, MakeRequest } from '../common-types';
-export type AssetProps = {
-    sys: EntityMetaSysProps;
+export type AssetProps<S = {}> = {
+    sys: EntityMetaSysProps & S;
     fields: {
         /** Title for this asset */
         title: {
@@ -274,5 +274,5 @@ export declare function wrapAsset(makeRequest: MakeRequest, data: AssetProps): A
 /**
  * @private
  */
-export declare const wrapAssetCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AssetProps>) => import("../common-types").Collection<Asset, AssetProps>;
+export declare const wrapAssetCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AssetProps<{}>>) => import("../common-types").Collection<Asset, AssetProps<{}>>;
 export {};

package/dist/typings/plain/common-types.d.ts

@@ -1,6 +1,6 @@
 import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
 import type { OpPatch } from 'json-patch';
-import type { BasicCursorPaginationOptions, CollectionProp, CreateReleaseEntryParams, CreateWithIdReleaseEntryParams, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEntryParams, GetEnvironmentTemplateParams, GetManyEntryParams, GetManyReleaseEntryParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseEntryParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, PatchEntryParams, PatchReleaseEntryParams, QueryParams, ReleaseEnvironmentParams, UpdateEntryParams, UpdateReleaseEntryParams } from '../common-types';
+import type { BasicCursorPaginationOptions, CollectionProp, CreateReleaseAssetParams, CreateReleaseEntryParams, CreateWithFilesReleaseAssetParams, CreateWithIdReleaseAssetParams, CreateWithIdReleaseEntryParams, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEntryParams, GetEnvironmentTemplateParams, GetManyEntryParams, GetManyReleaseAssetParams, GetManyReleaseEntryParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseAssetParams, GetReleaseEntryParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, Link, PatchEntryParams, PatchReleaseEntryParams, ProcessForAllLocalesReleaseAssetParams, ProcessForLocaleReleaseAssetParams, QueryParams, ReleaseEnvironmentParams, UpdateEntryParams, UpdateReleaseAssetParams, UpdateReleaseEntryParams } from '../common-types';
 import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
 import type { ApiKeyProps, CreateApiKeyProps } from '../entities/api-key';
 import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from '../entities/asset';
@@ -162,24 +162,8 @@ export type PlainClientAPI = {
     user: UserPlainClientAPI;
     entry: {
         getPublished<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
-        getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T, {
-            release: {
-                sys: {
-                    type: 'Link';
-                    linkType: 'Entry' | 'Asset';
-                    id: string;
-                };
-            };
-        }>>>;
-        get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
-            release: {
-                sys: {
-                    type: 'Link';
-                    linkType: 'Entry' | 'Asset';
-                    id: string;
-                };
-            };
-        }>>;
+        getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
+        get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
         update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<UpdateEntryParams & QueryParams>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
         patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<PatchEntryParams & QueryParams>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
         delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
@@ -285,60 +269,54 @@ export type PlainClientAPI = {
     };
     usage: UsagePlainClientAPI;
     release: {
+        asset: {
+            get(params: OptionalDefaults<GetReleaseAssetParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            getMany(params: OptionalDefaults<GetManyReleaseAssetParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps<{
+                release: Link<'Release'>;
+            }>>>;
+            update(params: OptionalDefaults<UpdateReleaseAssetParams & QueryParams>, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            create(params: OptionalDefaults<CreateReleaseAssetParams & QueryParams>, rawData: CreateAssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            createWithId(params: OptionalDefaults<CreateWithIdReleaseAssetParams & QueryParams>, rawData: CreateAssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            createFromFiles(params: OptionalDefaults<CreateWithFilesReleaseAssetParams & QueryParams>, data: Omit<AssetFileProp, 'sys'>, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            processForLocale(params: OptionalDefaults<ProcessForLocaleReleaseAssetParams>, asset: AssetProps<{
+                release: Link<'Release'>;
+            }>, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+            processForAllLocales(params: OptionalDefaults<ProcessForAllLocalesReleaseAssetParams>, asset: AssetProps<{
+                release: Link<'Release'>;
+            }>, processingOptions?: AssetProcessingForLocale): Promise<AssetProps<{
+                release: Link<'Release'>;
+            }>>;
+        };
         entry: {
-            get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetReleaseEntryParams & QueryParams>): Promise<EntryProps<T, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+            get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetReleaseEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
+                release: Link<'Release'>;
             }>>;
-            getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyReleaseEntryParams & QueryParams>): Promise<CollectionProp<EntryProps<T, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+            getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyReleaseEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T, {
+                release: Link<'Release'>;
             }>>>;
             update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<UpdateReleaseEntryParams & QueryParams>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+                release: Link<'Release'>;
             }>>;
             patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<PatchReleaseEntryParams & QueryParams>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+                release: Link<'Release'>;
             }>>;
             create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+                release: Link<'Release'>;
             }>>;
             createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateWithIdReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
-                release: {
-                    sys: {
-                        type: 'Link';
-                        linkType: 'Entry' | 'Asset';
-                        id: string;
-                    };
-                };
+                release: Link<'Release'>;
             }>>;
         };
         archive(params: OptionalDefaults<GetReleaseParams & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.58.0-canary.1",
+  "version": "11.58.0-canary.2",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",