contentful-management 11.57.4 → 11.58.0-canary.2
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.
- package/README.md +14 -0
- package/dist/contentful-management.browser.js +570 -73
- package/dist/contentful-management.browser.js.map +1 -1
- package/dist/contentful-management.browser.min.js +1 -1
- package/dist/contentful-management.node.js +512 -73
- package/dist/contentful-management.node.js.map +1 -1
- package/dist/contentful-management.node.min.js +1 -1
- package/dist/es-modules/adapters/REST/endpoints/asset.js +35 -0
- package/dist/es-modules/adapters/REST/endpoints/entry.js +27 -6
- package/dist/es-modules/adapters/REST/endpoints/index.js +4 -0
- package/dist/es-modules/adapters/REST/endpoints/release-asset.js +179 -0
- package/dist/es-modules/adapters/REST/endpoints/release-entry.js +54 -0
- package/dist/es-modules/adapters/REST/endpoints/release.js +24 -0
- package/dist/es-modules/contentful-management.js +1 -1
- package/dist/es-modules/create-environment-api.js +4 -4
- package/dist/es-modules/entities/app-action-call.js +44 -8
- package/dist/es-modules/plain/plain-client.js +33 -0
- package/dist/typings/adapters/REST/endpoints/index.d.ts +4 -0
- package/dist/typings/adapters/REST/endpoints/release-asset.d.ts +9 -0
- package/dist/typings/adapters/REST/endpoints/release-entry.d.ts +7 -0
- package/dist/typings/common-types.d.ts +224 -19
- package/dist/typings/create-entry-api.d.ts +1 -1
- package/dist/typings/create-environment-api.d.ts +10 -10
- package/dist/typings/entities/app-action-call.d.ts +5 -6
- package/dist/typings/entities/asset.d.ts +3 -3
- package/dist/typings/entities/entry.d.ts +3 -3
- package/dist/typings/entities/release.d.ts +18 -1
- package/dist/typings/plain/common-types.d.ts +70 -17
- package/dist/typings/plain/wrappers/wrap.d.ts +2 -0
- package/package.json +6 -2
|
@@ -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, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types';
|
|
3
|
+
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';
|
|
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, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release';
|
|
17
|
+
import type { ReleasePayload, ReleasePayloadV2, 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';
|
|
@@ -162,17 +162,10 @@ export type PlainClientAPI = {
|
|
|
162
162
|
user: UserPlainClientAPI;
|
|
163
163
|
entry: {
|
|
164
164
|
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<
|
|
166
|
-
get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
|
170
|
-
entryId: string;
|
|
171
|
-
}>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
|
|
172
|
-
patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
|
173
|
-
entryId: string;
|
|
174
|
-
version?: number;
|
|
175
|
-
}>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
|
|
165
|
+
getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
|
|
166
|
+
get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
|
|
167
|
+
update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<UpdateEntryParams & QueryParams>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
|
|
168
|
+
patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<PatchEntryParams & QueryParams>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
|
|
176
169
|
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
|
177
170
|
entryId: string;
|
|
178
171
|
}>): Promise<any>;
|
|
@@ -192,11 +185,21 @@ export type PlainClientAPI = {
|
|
|
192
185
|
}>): Promise<EntryProps<T>>;
|
|
193
186
|
create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
|
194
187
|
contentTypeId: string;
|
|
195
|
-
|
|
188
|
+
releaseId?: string;
|
|
189
|
+
} & QueryParams>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
|
|
196
190
|
createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
|
197
191
|
entryId: string;
|
|
198
192
|
contentTypeId: string;
|
|
199
|
-
|
|
193
|
+
releaseId?: string;
|
|
194
|
+
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T, {
|
|
195
|
+
release: {
|
|
196
|
+
sys: {
|
|
197
|
+
type: 'Link';
|
|
198
|
+
linkType: 'Entry' | 'Asset';
|
|
199
|
+
id: string;
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
}>>;
|
|
200
203
|
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
|
201
204
|
entryId: string;
|
|
202
205
|
include?: number;
|
|
@@ -266,6 +269,56 @@ export type PlainClientAPI = {
|
|
|
266
269
|
};
|
|
267
270
|
usage: UsagePlainClientAPI;
|
|
268
271
|
release: {
|
|
272
|
+
asset: {
|
|
273
|
+
get(params: OptionalDefaults<GetReleaseAssetParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
|
|
274
|
+
release: Link<'Release'>;
|
|
275
|
+
}>>;
|
|
276
|
+
getMany(params: OptionalDefaults<GetManyReleaseAssetParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps<{
|
|
277
|
+
release: Link<'Release'>;
|
|
278
|
+
}>>>;
|
|
279
|
+
update(params: OptionalDefaults<UpdateReleaseAssetParams & QueryParams>, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
|
|
280
|
+
release: Link<'Release'>;
|
|
281
|
+
}>>;
|
|
282
|
+
create(params: OptionalDefaults<CreateReleaseAssetParams & QueryParams>, rawData: CreateAssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
|
|
283
|
+
release: Link<'Release'>;
|
|
284
|
+
}>>;
|
|
285
|
+
createWithId(params: OptionalDefaults<CreateWithIdReleaseAssetParams & QueryParams>, rawData: CreateAssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
|
|
286
|
+
release: Link<'Release'>;
|
|
287
|
+
}>>;
|
|
288
|
+
createFromFiles(params: OptionalDefaults<CreateWithFilesReleaseAssetParams & QueryParams>, data: Omit<AssetFileProp, 'sys'>, headers?: RawAxiosRequestHeaders): Promise<AssetProps<{
|
|
289
|
+
release: Link<'Release'>;
|
|
290
|
+
}>>;
|
|
291
|
+
processForLocale(params: OptionalDefaults<ProcessForLocaleReleaseAssetParams>, asset: AssetProps<{
|
|
292
|
+
release: Link<'Release'>;
|
|
293
|
+
}>, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps<{
|
|
294
|
+
release: Link<'Release'>;
|
|
295
|
+
}>>;
|
|
296
|
+
processForAllLocales(params: OptionalDefaults<ProcessForAllLocalesReleaseAssetParams>, asset: AssetProps<{
|
|
297
|
+
release: Link<'Release'>;
|
|
298
|
+
}>, processingOptions?: AssetProcessingForLocale): Promise<AssetProps<{
|
|
299
|
+
release: Link<'Release'>;
|
|
300
|
+
}>>;
|
|
301
|
+
};
|
|
302
|
+
entry: {
|
|
303
|
+
get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetReleaseEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
|
|
304
|
+
release: Link<'Release'>;
|
|
305
|
+
}>>;
|
|
306
|
+
getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetManyReleaseEntryParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T, {
|
|
307
|
+
release: Link<'Release'>;
|
|
308
|
+
}>>>;
|
|
309
|
+
update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<UpdateReleaseEntryParams & QueryParams>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
|
|
310
|
+
release: Link<'Release'>;
|
|
311
|
+
}>>;
|
|
312
|
+
patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<PatchReleaseEntryParams & QueryParams>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
|
|
313
|
+
release: Link<'Release'>;
|
|
314
|
+
}>>;
|
|
315
|
+
create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
|
|
316
|
+
release: Link<'Release'>;
|
|
317
|
+
}>>;
|
|
318
|
+
createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<CreateWithIdReleaseEntryParams & QueryParams>, rawData: CreateEntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T, {
|
|
319
|
+
release: Link<'Release'>;
|
|
320
|
+
}>>;
|
|
321
|
+
};
|
|
269
322
|
archive(params: OptionalDefaults<GetReleaseParams & {
|
|
270
323
|
version: number;
|
|
271
324
|
}>): Promise<ReleaseProps>;
|
|
@@ -273,10 +326,10 @@ export type PlainClientAPI = {
|
|
|
273
326
|
query(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
|
|
274
327
|
query?: ReleaseQueryOptions;
|
|
275
328
|
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
|
|
276
|
-
create(params: OptionalDefaults<
|
|
329
|
+
create(params: OptionalDefaults<ReleaseEnvironmentParams>, data: ReleasePayload | ReleasePayloadV2): Promise<ReleaseProps>;
|
|
277
330
|
update(params: OptionalDefaults<GetReleaseParams & {
|
|
278
331
|
version: number;
|
|
279
|
-
}>, data: ReleasePayload): Promise<ReleaseProps>;
|
|
332
|
+
}>, data: ReleasePayload | ReleasePayloadV2): Promise<ReleaseProps>;
|
|
280
333
|
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
|
|
281
334
|
publish(params: OptionalDefaults<GetReleaseParams & {
|
|
282
335
|
version: number;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "contentful-management",
|
|
3
|
-
"version": "11.
|
|
3
|
+
"version": "11.58.0-canary.2",
|
|
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",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"test:types": "npx vitest --project types --run",
|
|
46
46
|
"test:unit-watch": "npx vitest --project unit",
|
|
47
47
|
"test:integration": "npx vitest --project integration --run --no-file-parallelism",
|
|
48
|
-
"test:integration-watch": "npx vitest --project integration --no-file-parallelism",
|
|
48
|
+
"test:integration-watch": "npx vitest --project integration --no-file-parallelism entry-integration",
|
|
49
49
|
"test:browser": "npx playwright install && npx vitest --project browser-unit --run && npx vitest --project browser-integration --run",
|
|
50
50
|
"test:version": "grep -r \"0.0.0-determined-by-semantic-release\" ./dist > /dev/null && echo \"version 0.0.0-determined-by-semantic-release found in output\" && exit 1 || exit 0",
|
|
51
51
|
"test:size": "size-limit",
|
|
@@ -142,6 +142,10 @@
|
|
|
142
142
|
"name": "beta",
|
|
143
143
|
"channel": "beta",
|
|
144
144
|
"prerelease": true
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"name": "canary",
|
|
148
|
+
"prerelease": true
|
|
145
149
|
}
|
|
146
150
|
],
|
|
147
151
|
"plugins": [
|