contentful-management 11.59.0-canary.1 → 11.59.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/README.md +0 -14
  2. package/dist/contentful-management.browser.js +55 -514
  3. package/dist/contentful-management.browser.js.map +1 -1
  4. package/dist/contentful-management.browser.min.js +1 -1
  5. package/dist/contentful-management.node.js +55 -456
  6. package/dist/contentful-management.node.js.map +1 -1
  7. package/dist/contentful-management.node.min.js +1 -1
  8. package/dist/es-modules/adapters/REST/endpoints/asset.js +0 -35
  9. package/dist/es-modules/adapters/REST/endpoints/entry.js +0 -19
  10. package/dist/es-modules/adapters/REST/endpoints/index.js +0 -4
  11. package/dist/es-modules/adapters/REST/endpoints/release.js +0 -24
  12. package/dist/es-modules/contentful-management.js +1 -1
  13. package/dist/es-modules/plain/plain-client.js +0 -33
  14. package/dist/typings/adapters/REST/endpoints/index.d.ts +0 -4
  15. package/dist/typings/common-types.d.ts +9 -212
  16. package/dist/typings/create-contentful-api.d.ts +1 -0
  17. package/dist/typings/create-entry-api.d.ts +1 -1
  18. package/dist/typings/create-environment-api.d.ts +4 -4
  19. package/dist/typings/entities/app-action-call.d.ts +16 -9
  20. package/dist/typings/entities/asset.d.ts +3 -3
  21. package/dist/typings/entities/entry.d.ts +3 -3
  22. package/dist/typings/entities/release.d.ts +1 -18
  23. package/dist/typings/export-types.d.ts +1 -1
  24. package/dist/typings/plain/common-types.d.ts +12 -81
  25. package/dist/typings/plain/wrappers/wrap.d.ts +0 -2
  26. package/package.json +1 -5
  27. package/dist/es-modules/adapters/REST/endpoints/release-asset.js +0 -179
  28. package/dist/es-modules/adapters/REST/endpoints/release-entry.js +0 -54
  29. package/dist/typings/adapters/REST/endpoints/release-asset.d.ts +0 -9
  30. package/dist/typings/adapters/REST/endpoints/release-entry.d.ts +0 -7
@@ -486,7 +486,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
486
486
  * .catch(console.error)
487
487
  * ```
488
488
  */
489
- getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
489
+ getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap>>>;
490
490
  /**
491
491
  * Gets a collection of published Entries
492
492
  * @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.
@@ -505,7 +505,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
505
505
  * .catch(console.error)
506
506
  * ```
507
507
  */
508
- getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
508
+ getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap>>>;
509
509
  /**
510
510
  * Creates a Entry
511
511
  * @param contentTypeId - The Content Type ID of the newly created Entry
@@ -625,7 +625,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
625
625
  * .catch(console.error)
626
626
  * ```
627
627
  */
628
- getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
628
+ getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
629
629
  /**
630
630
  * Gets a collection of published Assets
631
631
  * @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): {
644
644
  * .catch(console.error)
645
645
  * ```
646
646
  */
647
- getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
647
+ getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
648
648
  /**
649
649
  * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
650
650
  * @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.
@@ -1,4 +1,4 @@
1
- import type { Except } from 'type-fest';
1
+ import type { Except, JsonValue } from 'type-fest';
2
2
  import type { BasicMetaSysProps, AppActionCallRetryOptions, DefaultElements, MakeRequest, SysLink, CreateWithResponseParams, CreateWithResultParams, GetAppActionCallDetailsParams, GetAppActionCallParamsWithId } from '../common-types';
3
3
  import type { WebhookCallDetailsProps } from './webhook';
4
4
  type AppActionCallSys = Except<BasicMetaSysProps, 'version'> & {
@@ -7,7 +7,7 @@ type AppActionCallSys = Except<BasicMetaSysProps, 'version'> & {
7
7
  environment: SysLink;
8
8
  action: SysLink;
9
9
  appActionCallResponse?: SysLink;
10
- };
10
+ } & (AppActionCallSucceeded | AppActionCallProcessing | AppActionCallFailed);
11
11
  type RetryOptions = AppActionCallRetryOptions;
12
12
  export type AppActionCallStatus = 'processing' | 'succeeded' | 'failed';
13
13
  export interface AppActionCallErrorProps {
@@ -19,16 +19,24 @@ export interface AppActionCallErrorProps {
19
19
  details?: Record<string, unknown>;
20
20
  statusCode?: number;
21
21
  }
22
+ export type AppActionCallSucceeded = {
23
+ status: 'succeeded';
24
+ result: JsonValue;
25
+ };
26
+ export type AppActionCallProcessing = {
27
+ status: 'processing';
28
+ };
29
+ export type AppActionCallFailed = {
30
+ status: 'failed';
31
+ error: AppActionCallErrorProps;
32
+ };
22
33
  export type AppActionCallProps = {
23
34
  /**
24
35
  * System metadata
25
36
  */
26
37
  sys: AppActionCallSys;
27
- /** The execution status of the app action call, if available */
28
- status?: AppActionCallStatus;
29
- /** Structured result when execution succeeded */
30
- result?: unknown;
31
- /** Structured error when execution failed */
38
+ status: AppActionCallStatus;
39
+ result?: JsonValue;
32
40
  error?: AppActionCallErrorProps;
33
41
  };
34
42
  export type CreateAppActionCallProps = {
@@ -64,8 +72,7 @@ export interface AppActionCallRawResponseProps {
64
72
  }
65
73
  export interface AppActionCallResponseData extends AppActionCallResponse, DefaultElements<AppActionCallResponse>, AppActionCallApi {
66
74
  }
67
- export interface AppActionCall extends AppActionCallProps, DefaultElements<AppActionCallProps> {
68
- }
75
+ export type AppActionCall = AppActionCallProps & DefaultElements<AppActionCallProps>;
69
76
  /**
70
77
  * @private
71
78
  */
@@ -1,7 +1,7 @@
1
1
  import type { Stream } from 'stream';
2
2
  import type { MetaSysProps, DefaultElements, EntityMetaSysProps, MetadataProps, MakeRequest } from '../common-types';
3
- export type AssetProps<S = {}> = {
4
- sys: EntityMetaSysProps & S;
3
+ export type AssetProps = {
4
+ sys: EntityMetaSysProps;
5
5
  fields: {
6
6
  /** Title for this asset */
7
7
  title: {
@@ -274,5 +274,5 @@ export declare function wrapAsset(makeRequest: MakeRequest, data: AssetProps): A
274
274
  /**
275
275
  * @private
276
276
  */
277
- export declare const wrapAssetCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AssetProps<{}>>) => import("../common-types").Collection<Asset, AssetProps<{}>>;
277
+ export declare const wrapAssetCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AssetProps>) => import("../common-types").Collection<Asset, AssetProps>;
278
278
  export {};
@@ -1,8 +1,8 @@
1
1
  import type { CollectionProp, DefaultElements, EntryMetaSysProps, KeyValueMap, MakeRequest, MetadataProps } from '../common-types';
2
2
  import type { ContentfulEntryApi } from '../create-entry-api';
3
3
  import type { AssetProps } from './asset';
4
- export type EntryProps<T = KeyValueMap, S = unknown> = {
5
- sys: EntryMetaSysProps & S;
4
+ export type EntryProps<T = KeyValueMap> = {
5
+ sys: EntryMetaSysProps;
6
6
  metadata?: MetadataProps;
7
7
  fields: T;
8
8
  };
@@ -50,4 +50,4 @@ export declare function wrapEntry(makeRequest: MakeRequest, data: EntryProps): E
50
50
  * Data is also mixed in with link getters if links exist and includes were requested
51
51
  * @private
52
52
  */
53
- export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap, unknown>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap, unknown>>;
53
+ export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap>>;
@@ -18,8 +18,6 @@ export interface ReleaseQueryOptions {
18
18
  'sys.createdBy.sys.id[in]'?: string;
19
19
  /** Comma-separated filter (inclusion) by Release status (active, archived) */
20
20
  'sys.status[in]'?: ReleaseStatus;
21
- /** Determines the Release API version to use. 'Release.v1' refers to Launch, 'Release.v2' refers to Releases. */
22
- 'sys.schemaVersion'?: 'Release.v1' | 'Release.v2';
23
21
  /** Comma-separated filter (exclusion) by Release status (active, archived) */
24
22
  'sys.status[nin]'?: ReleaseStatus;
25
23
  /** Find releases using full text phrase and term matching */
@@ -57,7 +55,6 @@ export type ReleaseSysProps = {
57
55
  createdAt: ISO8601Timestamp;
58
56
  updatedAt: ISO8601Timestamp;
59
57
  lastAction?: Link<'ReleaseAction'>;
60
- schemaVersion?: 'Release.v2';
61
58
  };
62
59
  export type ReleaseReferenceFilters = ScheduledActionReferenceFilters;
63
60
  export declare const ReleaseReferenceFilters: typeof ScheduledActionReferenceFilters;
@@ -75,25 +72,11 @@ export interface ReleaseProps {
75
72
  metadata?: ReleaseMetadata;
76
73
  }
77
74
  export interface ReleasePayload extends MakeRequestPayload {
78
- sys?: {
79
- type: 'Release';
80
- schemaVersion?: 'Release.v1' | undefined;
81
- };
82
75
  title: string;
83
76
  entities: BaseCollection<Link<Entity>>;
84
77
  }
85
- export interface ReleasePayloadV2 extends MakeRequestPayload {
86
- sys?: {
87
- type: 'Release';
88
- schemaVersion: 'Release.v2';
89
- };
90
- title: string;
91
- entities: BaseCollection<{
92
- entity: Link<Entity>;
93
- } & ReleaseValidatePayload>;
94
- }
95
78
  export interface ReleaseValidatePayload {
96
- action?: 'publish' | 'unpublish';
79
+ action?: 'publish';
97
80
  }
98
81
  export interface ReleaseValidateOptions {
99
82
  payload?: ReleaseValidatePayload;
@@ -37,7 +37,7 @@ export type { CreateOrganizationInvitationProps, OrganizationInvitation, Organiz
37
37
  export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership';
38
38
  export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, PersonalAccessTokenProps, } from './entities/personal-access-token';
39
39
  export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key';
40
- export type { Release, ReleaseMetadata, ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
40
+ export type { Release, ReleaseMetadata, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
41
41
  export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
42
42
  export type { CreateRoleProps, Role, RoleProps } from './entities/role';
43
43
  export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, } from './entities/scheduled-action';
@@ -1,6 +1,6 @@
1
1
  import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
2
2
  import type { OpPatch } from 'json-patch';
3
- import type { BasicCursorPaginationOptions, CollectionProp, CreateReleaseAssetParams, CreateReleaseEntryParams, CreateWithFilesReleaseAssetParams, CreateWithIdReleaseAssetParams, CreateWithIdReleaseEntryParams, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetManyReleaseAssetParams, GetManyReleaseEntryParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseAssetParams, GetReleaseEntryParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, Link, PatchReleaseEntryParams, ProcessForAllLocalesReleaseAssetParams, ProcessForLocaleReleaseAssetParams, QueryParams, ReleaseEnvironmentParams, UpdateReleaseAssetParams, UpdateReleaseEntryParams } from '../common-types';
3
+ import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types';
4
4
  import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
5
5
  import type { ApiKeyProps, CreateApiKeyProps } from '../entities/api-key';
6
6
  import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from '../entities/asset';
@@ -14,7 +14,7 @@ import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } f
14
14
  import type { OrganizationMembershipProps } from '../entities/organization-membership';
15
15
  import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token';
16
16
  import type { PreviewApiKeyProps } from '../entities/preview-api-key';
17
- import type { ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release';
17
+ import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release';
18
18
  import type { ReleaseActionProps, ReleaseActionQueryOptions } from '../entities/release-action';
19
19
  import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action';
20
20
  import type { SnapshotProps } from '../entities/snapshot';
@@ -104,6 +104,7 @@ export type PlainClientAPI = {
104
104
  getMany(params: GetOrganizationParams & {
105
105
  query?: BasicCursorPaginationOptions & {
106
106
  select?: string;
107
+ forTemplatedSpaces?: boolean;
107
108
  };
108
109
  }, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
109
110
  create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
@@ -162,21 +163,16 @@ export type PlainClientAPI = {
162
163
  user: UserPlainClientAPI;
163
164
  entry: {
164
165
  getPublished<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
165
- getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
166
- releaseId?: string;
167
- }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
166
+ getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
168
167
  get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
169
168
  entryId: string;
170
- releaseId?: string;
171
169
  }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
172
170
  update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
173
171
  entryId: string;
174
- releaseId?: string;
175
172
  }>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
176
173
  patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
177
174
  entryId: string;
178
175
  version?: number;
179
- releaseId?: string;
180
176
  }>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
181
177
  delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
182
178
  entryId: string;
@@ -197,12 +193,10 @@ export type PlainClientAPI = {
197
193
  }>): Promise<EntryProps<T>>;
198
194
  create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
199
195
  contentTypeId: string;
200
- releaseId?: string;
201
196
  }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
202
197
  createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
203
198
  entryId: string;
204
199
  contentTypeId: string;
205
- releaseId?: string;
206
200
  }>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
207
201
  references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
208
202
  entryId: string;
@@ -211,16 +205,12 @@ export type PlainClientAPI = {
211
205
  };
212
206
  asset: {
213
207
  getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
214
- getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams & {
215
- releaseId?: string;
216
- }>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
208
+ getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
217
209
  get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
218
210
  assetId: string;
219
- releaseId?: string;
220
211
  } & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<AssetProps>;
221
212
  update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
222
213
  assetId: string;
223
- releaseId?: string;
224
214
  }>, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps>;
225
215
  delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
226
216
  assetId: string;
@@ -239,22 +229,13 @@ export type PlainClientAPI = {
239
229
  unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
240
230
  assetId: string;
241
231
  }>): Promise<AssetProps>;
242
- create(params: OptionalDefaults<GetSpaceEnvironmentParams & {
243
- releaseId?: string;
244
- }>, rawData: CreateAssetProps): Promise<AssetProps>;
232
+ create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
245
233
  createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
246
234
  assetId: string;
247
- releaseId?: string;
248
235
  }>, rawData: CreateAssetProps): Promise<AssetProps>;
249
- createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams & {
250
- releaseId?: string;
251
- }>, data: Omit<AssetFileProp, 'sys'>): Promise<AssetProps>;
252
- processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams & {
253
- releaseId?: string;
254
- }>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
255
- processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams & {
256
- releaseId?: string;
257
- }>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
236
+ createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, 'sys'>): Promise<AssetProps>;
237
+ processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
238
+ processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
258
239
  };
259
240
  appUpload: AppUploadPlainClientAPI;
260
241
  assetKey: {
@@ -286,67 +267,17 @@ export type PlainClientAPI = {
286
267
  };
287
268
  usage: UsagePlainClientAPI;
288
269
  release: {
289
- asset: {
290
- get(params: OptionalDefaults<GetReleaseAssetParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
291
- release: Link<'Release'>;
292
- }>>;
293
- getMany(params: OptionalDefaults<GetManyReleaseAssetParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps<{
294
- release: Link<'Release'>;
295
- }>>>;
296
- update(params: OptionalDefaults<UpdateReleaseAssetParams & QueryParams>, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
297
- release: Link<'Release'>;
298
- }>>;
299
- create(params: OptionalDefaults<CreateReleaseAssetParams & QueryParams>, rawData: CreateAssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
300
- release: Link<'Release'>;
301
- }>>;
302
- createWithId(params: OptionalDefaults<CreateWithIdReleaseAssetParams & QueryParams>, rawData: CreateAssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
303
- release: Link<'Release'>;
304
- }>>;
305
- createFromFiles(params: OptionalDefaults<CreateWithFilesReleaseAssetParams & QueryParams>, data: Omit<AssetFileProp, 'sys'>, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
306
- release: Link<'Release'>;
307
- }>>;
308
- processForLocale(params: OptionalDefaults<ProcessForLocaleReleaseAssetParams>, asset: AssetProps<{
309
- release: Link<'Release'>;
310
- }>, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps<{
311
- release: Link<'Release'>;
312
- }>>;
313
- processForAllLocales(params: OptionalDefaults<ProcessForAllLocalesReleaseAssetParams>, asset: AssetProps<{
314
- release: Link<'Release'>;
315
- }>, processingOptions?: AssetProcessingForLocale): Promise<AssetProps<{
316
- release: Link<'Release'>;
317
- }>>;
318
- };
319
- entry: {
320
- get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetReleaseEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
321
- release: Link<'Release'>;
322
- }>>;
323
- getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyReleaseEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T, {
324
- release: Link<'Release'>;
325
- }>>>;
326
- update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<UpdateReleaseEntryParams & QueryParams>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
327
- release: Link<'Release'>;
328
- }>>;
329
- patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<PatchReleaseEntryParams & QueryParams>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
330
- release: Link<'Release'>;
331
- }>>;
332
- create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
333
- release: Link<'Release'>;
334
- }>>;
335
- createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateWithIdReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
336
- release: Link<'Release'>;
337
- }>>;
338
- };
339
270
  archive(params: OptionalDefaults<GetReleaseParams & {
340
271
  version: number;
341
272
  }>): Promise<ReleaseProps>;
342
273
  get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
343
- query(params: OptionalDefaults<ReleaseEnvironmentParams> & {
274
+ query(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
344
275
  query?: ReleaseQueryOptions;
345
276
  }): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
346
- create(params: OptionalDefaults<ReleaseEnvironmentParams>, data: ReleasePayload | ReleasePayloadV2): Promise<ReleaseProps>;
277
+ create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
347
278
  update(params: OptionalDefaults<GetReleaseParams & {
348
279
  version: number;
349
- }>, data: ReleasePayload | ReleasePayloadV2): Promise<ReleaseProps>;
280
+ }>, data: ReleasePayload): Promise<ReleaseProps>;
350
281
  delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
351
282
  publish(params: OptionalDefaults<GetReleaseParams & {
352
283
  version: number;
@@ -3,8 +3,6 @@ export type DefaultParams = {
3
3
  spaceId?: string;
4
4
  environmentId?: string;
5
5
  organizationId?: string;
6
- releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
7
- releaseId?: string;
8
6
  };
9
7
  /**
10
8
  * @private
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "contentful-management",
3
- "version": "11.59.0-canary.1",
3
+ "version": "11.59.0",
4
4
  "description": "Client for Contentful's Content Management API",
5
5
  "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
6
6
  "main": "./dist/contentful-management.node.js",
@@ -142,10 +142,6 @@
142
142
  "name": "beta",
143
143
  "channel": "beta",
144
144
  "prerelease": true
145
- },
146
- {
147
- "name": "canary",
148
- "prerelease": true
149
145
  }
150
146
  ],
151
147
  "plugins": [
@@ -1,179 +0,0 @@
1
- const _excluded = ["asset", "locale", "options"],
2
- _excluded2 = ["asset", "options"];
3
- function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
4
- function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
5
- function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
6
- function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
7
- function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
8
- function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
9
- function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
10
- import { errorHandler } from 'contentful-sdk-core';
11
- import copy from 'fast-copy';
12
- import { getUploadHttpClient } from '../../../upload-http-client';
13
- import * as raw from './raw';
14
- import { create as createUpload } from './upload';
15
- import { normalizeSelect } from './utils';
16
- export const get = (http, params, rawData, headers) => {
17
- return raw.get(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/assets/${params.assetId}`, {
18
- params: normalizeSelect(params.query),
19
- headers: headers ? _objectSpread({}, headers) : undefined
20
- });
21
- };
22
- export const getMany = (http, params, rawData, headers) => {
23
- params.query = _objectSpread(_objectSpread({}, params.query), {}, {
24
- 'sys.schemaVersion': 'Release.V2'
25
- });
26
- return raw.get(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/assets`, {
27
- params: normalizeSelect(params.query),
28
- headers: headers ? _objectSpread({}, headers) : undefined
29
- });
30
- };
31
- export const update = (http, params, rawData, headers) => {
32
- var _rawData$sys$version;
33
- const data = copy(rawData);
34
- delete data.sys;
35
- return raw.put(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/assets/${params.assetId}`, data, {
36
- headers: _objectSpread({
37
- 'X-Contentful-Version': (_rawData$sys$version = rawData.sys.version) !== null && _rawData$sys$version !== void 0 ? _rawData$sys$version : 0
38
- }, headers)
39
- });
40
- };
41
- export const create = (http, params, rawData, headers) => {
42
- const data = copy(rawData);
43
- return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/assets`, data, {
44
- headers
45
- });
46
- };
47
- export const createWithId = (http, params, rawData, headers) => {
48
- const data = copy(rawData);
49
- return raw.put(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/assets/${params.assetId}`, data, {
50
- headers
51
- });
52
- };
53
- export const createFromFiles = async (http, params, data) => {
54
- const httpUpload = getUploadHttpClient(http, {
55
- uploadTimeout: params.uploadTimeout
56
- });
57
- const {
58
- file
59
- } = data.fields;
60
- return Promise.all(Object.keys(file).map(async locale => {
61
- const {
62
- contentType,
63
- fileName
64
- } = file[locale];
65
- return createUpload(httpUpload, params, file[locale]).then(upload => {
66
- return {
67
- [locale]: {
68
- contentType,
69
- fileName,
70
- uploadFrom: {
71
- sys: {
72
- type: 'Link',
73
- linkType: 'Upload',
74
- id: upload.sys.id
75
- }
76
- }
77
- }
78
- };
79
- });
80
- })).then(uploads => {
81
- const file = uploads.reduce((fieldsData, upload) => _objectSpread(_objectSpread({}, fieldsData), upload), {});
82
- const asset = _objectSpread(_objectSpread({}, data), {}, {
83
- fields: _objectSpread(_objectSpread({}, data.fields), {}, {
84
- file
85
- })
86
- });
87
- return create(http, params, asset, {});
88
- }).catch(errorHandler);
89
- };
90
-
91
- /**
92
- * Asset processing
93
- */
94
-
95
- const ASSET_PROCESSING_CHECK_WAIT = 3000;
96
- const ASSET_PROCESSING_CHECK_RETRIES = 10;
97
- async function checkIfAssetHasUrl(http, params, {
98
- resolve,
99
- reject,
100
- locale,
101
- processingCheckWait = ASSET_PROCESSING_CHECK_WAIT,
102
- processingCheckRetries = ASSET_PROCESSING_CHECK_RETRIES,
103
- checkCount = 0
104
- }) {
105
- return get(http, params).then(asset => {
106
- if (asset.fields.file[locale].url) {
107
- resolve(asset);
108
- } else if (checkCount === processingCheckRetries) {
109
- const error = new Error();
110
- error.name = 'AssetProcessingTimeout';
111
- error.message = 'Asset is taking longer then expected to process.';
112
- reject(error);
113
- } else {
114
- checkCount++;
115
- setTimeout(() => checkIfAssetHasUrl(http, params, {
116
- resolve: resolve,
117
- reject: reject,
118
- locale: locale,
119
- checkCount: checkCount,
120
- processingCheckWait,
121
- processingCheckRetries
122
- }), processingCheckWait);
123
- }
124
- });
125
- }
126
- export const processForLocale = async (http, _ref) => {
127
- let {
128
- asset,
129
- locale,
130
- options: {
131
- processingCheckRetries,
132
- processingCheckWait
133
- } = {}
134
- } = _ref,
135
- params = _objectWithoutProperties(_ref, _excluded);
136
- return raw.put(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${asset.sys.release.sys.id}/assets/${asset.sys.id}/files/${locale}/process`, null, {
137
- headers: {
138
- 'X-Contentful-Version': asset.sys.version
139
- }
140
- }).then(() => {
141
- return new Promise((resolve, reject) => checkIfAssetHasUrl(http, {
142
- spaceId: params.spaceId,
143
- environmentId: params.environmentId,
144
- assetId: asset.sys.id,
145
- releaseId: asset.sys.release.sys.id
146
- }, {
147
- resolve,
148
- reject,
149
- locale,
150
- processingCheckWait,
151
- processingCheckRetries
152
- }));
153
- });
154
- };
155
- export const processForAllLocales = async (http, _ref2) => {
156
- let {
157
- asset,
158
- options = {}
159
- } = _ref2,
160
- params = _objectWithoutProperties(_ref2, _excluded2);
161
- const locales = Object.keys(asset.fields.file || {});
162
- let mostUpToDateAssetVersion = asset;
163
-
164
- // Let all the locales process
165
- // Since they all resolve at different times,
166
- // we need to pick the last resolved value
167
- // to reflect the most recent state
168
- const allProcessingLocales = locales.map(locale => processForLocale(http, _objectSpread(_objectSpread({}, params), {}, {
169
- asset,
170
- locale,
171
- options
172
- })).then(result => {
173
- // Side effect of always setting the most up to date asset version
174
- // The last one to call this will be the last one that finished
175
- // and thus the most up to date
176
- mostUpToDateAssetVersion = result;
177
- }));
178
- return Promise.all(allProcessingLocales).then(() => mostUpToDateAssetVersion);
179
- };
@@ -1,54 +0,0 @@
1
- function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
2
- function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
3
- function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
4
- function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
5
- function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
6
- import copy from 'fast-copy';
7
- import * as raw from './raw';
8
- import { normalizeSelect } from './utils';
9
- export const get = (http, params, rawData, headers) => {
10
- return raw.get(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`, {
11
- params: normalizeSelect(params.query),
12
- headers: _objectSpread({}, headers)
13
- });
14
- };
15
- export const getMany = (http, params, rawData, headers) => {
16
- return raw.get(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries`, {
17
- params: normalizeSelect(params.query),
18
- headers: _objectSpread({}, headers)
19
- });
20
- };
21
- export const update = (http, params, rawData, headers) => {
22
- var _rawData$sys$version;
23
- const data = copy(rawData);
24
- delete data.sys;
25
- return raw.put(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`, data, {
26
- headers: _objectSpread({
27
- 'X-Contentful-Version': (_rawData$sys$version = rawData.sys.version) !== null && _rawData$sys$version !== void 0 ? _rawData$sys$version : 0
28
- }, headers)
29
- });
30
- };
31
- export const patch = (http, params, data, headers) => {
32
- return raw.patch(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`, data, {
33
- headers: _objectSpread({
34
- 'X-Contentful-Version': params.version,
35
- 'Content-Type': 'application/json-patch+json'
36
- }, headers)
37
- });
38
- };
39
- export const create = (http, params, rawData, headers) => {
40
- const data = copy(rawData);
41
- return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries`, data, {
42
- headers: _objectSpread({
43
- 'X-Contentful-Content-Type': params.contentTypeId
44
- }, headers)
45
- });
46
- };
47
- export const createWithId = (http, params, rawData, headers) => {
48
- const data = copy(rawData);
49
- return raw.put(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/releases/${params.releaseId}/entries/${params.entryId}`, data, {
50
- headers: _objectSpread({
51
- 'X-Contentful-Content-Type': params.contentTypeId
52
- }, headers)
53
- });
54
- };
@@ -1,9 +0,0 @@
1
- import type { RestEndpoint } from '../types';
2
- export declare const get: RestEndpoint<'ReleaseAsset', 'get'>;
3
- export declare const getMany: RestEndpoint<'ReleaseAsset', 'getMany'>;
4
- export declare const update: RestEndpoint<'ReleaseAsset', 'update'>;
5
- export declare const create: RestEndpoint<'ReleaseAsset', 'create'>;
6
- export declare const createWithId: RestEndpoint<'ReleaseAsset', 'createWithId'>;
7
- export declare const createFromFiles: RestEndpoint<'ReleaseAsset', 'createFromFiles'>;
8
- export declare const processForLocale: RestEndpoint<'ReleaseAsset', 'processForLocale'>;
9
- export declare const processForAllLocales: RestEndpoint<'ReleaseAsset', 'processForAllLocales'>;
@@ -1,7 +0,0 @@
1
- import type { RestEndpoint } from '../types';
2
- export declare const get: RestEndpoint<'ReleaseEntry', 'get'>;
3
- export declare const getMany: RestEndpoint<'ReleaseEntry', 'getMany'>;
4
- export declare const update: RestEndpoint<'ReleaseEntry', 'update'>;
5
- export declare const patch: RestEndpoint<'ReleaseEntry', 'patch'>;
6
- export declare const create: RestEndpoint<'ReleaseEntry', 'create'>;
7
- export declare const createWithId: RestEndpoint<'ReleaseEntry', 'createWithId'>;