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
|
@@ -28,7 +28,7 @@ import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } f
|
|
|
28
28
|
import type { OrganizationMembershipProps } from './entities/organization-membership';
|
|
29
29
|
import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from './entities/personal-access-token';
|
|
30
30
|
import type { PreviewApiKeyProps } from './entities/preview-api-key';
|
|
31
|
-
import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
|
|
31
|
+
import type { ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
|
|
32
32
|
import type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions } from './entities/release-action';
|
|
33
33
|
import type { CreateRoleProps, RoleProps } from './entities/role';
|
|
34
34
|
import type { ScheduledActionProps } from './entities/scheduled-action';
|
|
@@ -159,6 +159,7 @@ export interface EntityMetaSysProps extends MetaSysProps {
|
|
|
159
159
|
fieldStatus?: {
|
|
160
160
|
'*': Record<string, 'draft' | 'changed' | 'published'>;
|
|
161
161
|
};
|
|
162
|
+
release?: Link<'Release'>;
|
|
162
163
|
}
|
|
163
164
|
export interface EntryMetaSysProps extends EntityMetaSysProps {
|
|
164
165
|
contentType: SysLink;
|
|
@@ -454,6 +455,20 @@ type MRInternal<UA extends boolean> = {
|
|
|
454
455
|
(opts: MROpts<'ReleaseAction', 'get', UA>): MRReturn<'ReleaseAction', 'get'>;
|
|
455
456
|
(opts: MROpts<'ReleaseAction', 'getMany', UA>): MRReturn<'ReleaseAction', 'getMany'>;
|
|
456
457
|
(opts: MROpts<'ReleaseAction', 'queryForRelease', UA>): MRReturn<'ReleaseAction', 'queryForRelease'>;
|
|
458
|
+
(opts: MROpts<'ReleaseAsset', 'get', UA>): MRReturn<'ReleaseAsset', 'get'>;
|
|
459
|
+
(opts: MROpts<'ReleaseAsset', 'getMany', UA>): MRReturn<'ReleaseAsset', 'getMany'>;
|
|
460
|
+
(opts: MROpts<'ReleaseAsset', 'update', UA>): MRReturn<'ReleaseAsset', 'update'>;
|
|
461
|
+
(opts: MROpts<'ReleaseAsset', 'create', UA>): MRReturn<'ReleaseAsset', 'create'>;
|
|
462
|
+
(opts: MROpts<'ReleaseAsset', 'createWithId', UA>): MRReturn<'ReleaseAsset', 'createWithId'>;
|
|
463
|
+
(opts: MROpts<'ReleaseAsset', 'createFromFiles', UA>): MRReturn<'ReleaseAsset', 'createFromFiles'>;
|
|
464
|
+
(opts: MROpts<'ReleaseAsset', 'processForAllLocales', UA>): MRReturn<'ReleaseAsset', 'processForAllLocales'>;
|
|
465
|
+
(opts: MROpts<'ReleaseAsset', 'processForLocale', UA>): MRReturn<'ReleaseAsset', 'processForLocale'>;
|
|
466
|
+
(opts: MROpts<'ReleaseEntry', 'get', UA>): MRReturn<'ReleaseEntry', 'get'>;
|
|
467
|
+
(opts: MROpts<'ReleaseEntry', 'getMany', UA>): MRReturn<'ReleaseEntry', 'getMany'>;
|
|
468
|
+
(opts: MROpts<'ReleaseEntry', 'update', UA>): MRReturn<'ReleaseEntry', 'update'>;
|
|
469
|
+
(opts: MROpts<'ReleaseEntry', 'patch', UA>): MRReturn<'ReleaseEntry', 'patch'>;
|
|
470
|
+
(opts: MROpts<'ReleaseEntry', 'create', UA>): MRReturn<'ReleaseEntry', 'create'>;
|
|
471
|
+
(opts: MROpts<'ReleaseEntry', 'createWithId', UA>): MRReturn<'ReleaseEntry', 'createWithId'>;
|
|
457
472
|
(opts: MROpts<'Resource', 'getMany', UA>): MRReturn<'Resource', 'getMany'>;
|
|
458
473
|
(opts: MROpts<'ResourceProvider', 'get', UA>): MRReturn<'ResourceProvider', 'get'>;
|
|
459
474
|
(opts: MROpts<'ResourceProvider', 'upsert', UA>): MRReturn<'ResourceProvider', 'upsert'>;
|
|
@@ -1041,13 +1056,16 @@ export type MRActions = {
|
|
|
1041
1056
|
return: CollectionProp<AssetProps>;
|
|
1042
1057
|
};
|
|
1043
1058
|
getMany: {
|
|
1044
|
-
params: GetSpaceEnvironmentParams & QueryParams
|
|
1059
|
+
params: GetSpaceEnvironmentParams & QueryParams & {
|
|
1060
|
+
releaseId?: string;
|
|
1061
|
+
};
|
|
1045
1062
|
headers?: RawAxiosRequestHeaders;
|
|
1046
1063
|
return: CollectionProp<AssetProps>;
|
|
1047
1064
|
};
|
|
1048
1065
|
get: {
|
|
1049
1066
|
params: GetSpaceEnvironmentParams & {
|
|
1050
1067
|
assetId: string;
|
|
1068
|
+
releaseId?: string;
|
|
1051
1069
|
} & QueryParams;
|
|
1052
1070
|
headers?: RawAxiosRequestHeaders;
|
|
1053
1071
|
return: AssetProps;
|
|
@@ -1055,6 +1073,7 @@ export type MRActions = {
|
|
|
1055
1073
|
update: {
|
|
1056
1074
|
params: GetSpaceEnvironmentParams & {
|
|
1057
1075
|
assetId: string;
|
|
1076
|
+
releaseId?: string;
|
|
1058
1077
|
};
|
|
1059
1078
|
payload: AssetProps;
|
|
1060
1079
|
headers?: RawAxiosRequestHeaders;
|
|
@@ -1092,13 +1111,16 @@ export type MRActions = {
|
|
|
1092
1111
|
return: AssetProps;
|
|
1093
1112
|
};
|
|
1094
1113
|
create: {
|
|
1095
|
-
params: GetSpaceEnvironmentParams
|
|
1114
|
+
params: GetSpaceEnvironmentParams & {
|
|
1115
|
+
releaseId?: string;
|
|
1116
|
+
};
|
|
1096
1117
|
payload: CreateAssetProps;
|
|
1097
1118
|
return: AssetProps;
|
|
1098
1119
|
};
|
|
1099
1120
|
createWithId: {
|
|
1100
1121
|
params: GetSpaceEnvironmentParams & {
|
|
1101
1122
|
assetId: string;
|
|
1123
|
+
releaseId?: string;
|
|
1102
1124
|
};
|
|
1103
1125
|
payload: CreateAssetProps;
|
|
1104
1126
|
return: AssetProps;
|
|
@@ -1106,6 +1128,7 @@ export type MRActions = {
|
|
|
1106
1128
|
createFromFiles: {
|
|
1107
1129
|
params: GetSpaceEnvironmentParams & {
|
|
1108
1130
|
uploadTimeout?: number;
|
|
1131
|
+
releaseId?: string;
|
|
1109
1132
|
};
|
|
1110
1133
|
payload: Omit<AssetFileProp, 'sys'>;
|
|
1111
1134
|
return: AssetProps;
|
|
@@ -1504,27 +1527,28 @@ export type MRActions = {
|
|
|
1504
1527
|
return: CollectionProp<EntryProps<any>>;
|
|
1505
1528
|
};
|
|
1506
1529
|
getMany: {
|
|
1507
|
-
params:
|
|
1508
|
-
|
|
1530
|
+
params: GetManyEntryParams & QueryParams & {
|
|
1531
|
+
releaseId?: string;
|
|
1532
|
+
};
|
|
1533
|
+
return: CollectionProp<EntryProps<any, any>>;
|
|
1509
1534
|
};
|
|
1510
1535
|
get: {
|
|
1511
|
-
params:
|
|
1512
|
-
|
|
1513
|
-
}
|
|
1514
|
-
return: EntryProps<any>;
|
|
1536
|
+
params: GetEntryParams & QueryParams & {
|
|
1537
|
+
releaseId?: string;
|
|
1538
|
+
};
|
|
1539
|
+
return: EntryProps<any, any>;
|
|
1515
1540
|
};
|
|
1516
1541
|
patch: {
|
|
1517
|
-
params:
|
|
1518
|
-
|
|
1519
|
-
version: number;
|
|
1542
|
+
params: PatchEntryParams & QueryParams & {
|
|
1543
|
+
releaseId?: string;
|
|
1520
1544
|
};
|
|
1521
1545
|
payload: OpPatch[];
|
|
1522
1546
|
headers?: RawAxiosRequestHeaders;
|
|
1523
1547
|
return: EntryProps<any>;
|
|
1524
1548
|
};
|
|
1525
1549
|
update: {
|
|
1526
|
-
params:
|
|
1527
|
-
|
|
1550
|
+
params: UpdateEntryParams & QueryParams & {
|
|
1551
|
+
releaseId?: string;
|
|
1528
1552
|
};
|
|
1529
1553
|
payload: EntryProps<any>;
|
|
1530
1554
|
headers?: RawAxiosRequestHeaders;
|
|
@@ -1564,7 +1588,8 @@ export type MRActions = {
|
|
|
1564
1588
|
create: {
|
|
1565
1589
|
params: GetSpaceEnvironmentParams & {
|
|
1566
1590
|
contentTypeId: string;
|
|
1567
|
-
|
|
1591
|
+
releaseId?: string;
|
|
1592
|
+
} & QueryParams;
|
|
1568
1593
|
payload: CreateEntryProps<any>;
|
|
1569
1594
|
return: EntryProps<any>;
|
|
1570
1595
|
};
|
|
@@ -1572,9 +1597,10 @@ export type MRActions = {
|
|
|
1572
1597
|
params: GetSpaceEnvironmentParams & {
|
|
1573
1598
|
entryId: string;
|
|
1574
1599
|
contentTypeId: string;
|
|
1600
|
+
releaseId?: string;
|
|
1575
1601
|
};
|
|
1576
1602
|
payload: CreateEntryProps<any>;
|
|
1577
|
-
return: EntryProps<any>;
|
|
1603
|
+
return: EntryProps<any, any>;
|
|
1578
1604
|
};
|
|
1579
1605
|
references: {
|
|
1580
1606
|
params: GetSpaceEnvironmentParams & {
|
|
@@ -1831,14 +1857,14 @@ export type MRActions = {
|
|
|
1831
1857
|
};
|
|
1832
1858
|
create: {
|
|
1833
1859
|
params: GetSpaceEnvironmentParams;
|
|
1834
|
-
payload: ReleasePayload;
|
|
1860
|
+
payload: ReleasePayload | ReleasePayloadV2;
|
|
1835
1861
|
return: ReleaseProps;
|
|
1836
1862
|
};
|
|
1837
1863
|
update: {
|
|
1838
1864
|
params: GetReleaseParams & {
|
|
1839
1865
|
version: number;
|
|
1840
1866
|
};
|
|
1841
|
-
payload: ReleasePayload;
|
|
1867
|
+
payload: ReleasePayload | ReleasePayloadV2;
|
|
1842
1868
|
return: ReleaseProps;
|
|
1843
1869
|
};
|
|
1844
1870
|
delete: {
|
|
@@ -1869,6 +1895,112 @@ export type MRActions = {
|
|
|
1869
1895
|
return: ReleaseActionProps<'validate'>;
|
|
1870
1896
|
};
|
|
1871
1897
|
};
|
|
1898
|
+
ReleaseAsset: {
|
|
1899
|
+
get: {
|
|
1900
|
+
params: GetReleaseAssetParams & QueryParams;
|
|
1901
|
+
headers?: RawAxiosRequestHeaders;
|
|
1902
|
+
return: AssetProps<{
|
|
1903
|
+
release: Link<'Release'>;
|
|
1904
|
+
}>;
|
|
1905
|
+
};
|
|
1906
|
+
getMany: {
|
|
1907
|
+
params: GetManyReleaseAssetParams & QueryParams;
|
|
1908
|
+
headers?: RawAxiosRequestHeaders;
|
|
1909
|
+
return: CollectionProp<AssetProps<{
|
|
1910
|
+
release: Link<'Release'>;
|
|
1911
|
+
}>>;
|
|
1912
|
+
};
|
|
1913
|
+
update: {
|
|
1914
|
+
params: UpdateReleaseAssetParams & QueryParams;
|
|
1915
|
+
payload: AssetProps;
|
|
1916
|
+
headers?: RawAxiosRequestHeaders;
|
|
1917
|
+
return: AssetProps<{
|
|
1918
|
+
release: Link<'Release'>;
|
|
1919
|
+
}>;
|
|
1920
|
+
};
|
|
1921
|
+
create: {
|
|
1922
|
+
params: CreateReleaseAssetParams & QueryParams;
|
|
1923
|
+
payload: CreateAssetProps;
|
|
1924
|
+
headers?: RawAxiosRequestHeaders;
|
|
1925
|
+
return: AssetProps<{
|
|
1926
|
+
release: Link<'Release'>;
|
|
1927
|
+
}>;
|
|
1928
|
+
};
|
|
1929
|
+
createWithId: {
|
|
1930
|
+
params: CreateWithIdReleaseAssetParams & QueryParams;
|
|
1931
|
+
payload: CreateAssetProps;
|
|
1932
|
+
headers?: RawAxiosRequestHeaders;
|
|
1933
|
+
return: AssetProps<{
|
|
1934
|
+
release: Link<'Release'>;
|
|
1935
|
+
}>;
|
|
1936
|
+
};
|
|
1937
|
+
createFromFiles: {
|
|
1938
|
+
params: CreateWithFilesReleaseAssetParams & QueryParams;
|
|
1939
|
+
payload: Omit<AssetFileProp, 'sys'>;
|
|
1940
|
+
headers?: RawAxiosRequestHeaders;
|
|
1941
|
+
return: AssetProps<{
|
|
1942
|
+
release: Link<'Release'>;
|
|
1943
|
+
}>;
|
|
1944
|
+
};
|
|
1945
|
+
processForAllLocales: {
|
|
1946
|
+
params: ProcessForAllLocalesReleaseAssetParams;
|
|
1947
|
+
return: AssetProps<{
|
|
1948
|
+
release: Link<'Release'>;
|
|
1949
|
+
}>;
|
|
1950
|
+
};
|
|
1951
|
+
processForLocale: {
|
|
1952
|
+
params: ProcessForLocaleReleaseAssetParams;
|
|
1953
|
+
return: AssetProps<{
|
|
1954
|
+
release: Link<'Release'>;
|
|
1955
|
+
}>;
|
|
1956
|
+
};
|
|
1957
|
+
};
|
|
1958
|
+
ReleaseEntry: {
|
|
1959
|
+
get: {
|
|
1960
|
+
params: GetReleaseEntryParams & QueryParams;
|
|
1961
|
+
headers?: RawAxiosRequestHeaders;
|
|
1962
|
+
return: EntryProps<any, any>;
|
|
1963
|
+
};
|
|
1964
|
+
getMany: {
|
|
1965
|
+
params: GetManyReleaseEntryParams & QueryParams;
|
|
1966
|
+
headers?: RawAxiosRequestHeaders;
|
|
1967
|
+
return: CollectionProp<EntryProps<any, any>>;
|
|
1968
|
+
};
|
|
1969
|
+
update: {
|
|
1970
|
+
params: UpdateReleaseEntryParams & QueryParams;
|
|
1971
|
+
payload: EntryProps<any>;
|
|
1972
|
+
headers?: RawAxiosRequestHeaders;
|
|
1973
|
+
return: EntryProps<any, {
|
|
1974
|
+
release: Link<'Release'>;
|
|
1975
|
+
}>;
|
|
1976
|
+
};
|
|
1977
|
+
patch: {
|
|
1978
|
+
params: PatchReleaseEntryParams & QueryParams;
|
|
1979
|
+
payload: OpPatch[];
|
|
1980
|
+
headers?: RawAxiosRequestHeaders;
|
|
1981
|
+
return: EntryProps<any, {
|
|
1982
|
+
release: Link<'Release'>;
|
|
1983
|
+
}>;
|
|
1984
|
+
};
|
|
1985
|
+
create: {
|
|
1986
|
+
params: CreateReleaseEntryParams & QueryParams;
|
|
1987
|
+
payload: CreateEntryProps<any>;
|
|
1988
|
+
headers?: RawAxiosRequestHeaders;
|
|
1989
|
+
return: EntryProps<any, {
|
|
1990
|
+
release: Link<'Release'>;
|
|
1991
|
+
}>;
|
|
1992
|
+
};
|
|
1993
|
+
createWithId: {
|
|
1994
|
+
params: CreateReleaseEntryParams & {
|
|
1995
|
+
entryId: string;
|
|
1996
|
+
} & QueryParams;
|
|
1997
|
+
payload: CreateEntryProps<any>;
|
|
1998
|
+
headers?: RawAxiosRequestHeaders;
|
|
1999
|
+
return: EntryProps<any, {
|
|
2000
|
+
release: Link<'Release'>;
|
|
2001
|
+
}>;
|
|
2002
|
+
};
|
|
2003
|
+
};
|
|
1872
2004
|
ReleaseAction: {
|
|
1873
2005
|
get: {
|
|
1874
2006
|
params: GetReleaseParams & {
|
|
@@ -2548,6 +2680,16 @@ export type GetEditorInterfaceParams = GetSpaceEnvironmentParams & {
|
|
|
2548
2680
|
export type GetEntryParams = GetSpaceEnvironmentParams & {
|
|
2549
2681
|
entryId: string;
|
|
2550
2682
|
};
|
|
2683
|
+
export type GetManyEntryParams = GetSpaceEnvironmentParams;
|
|
2684
|
+
export type PatchEntryParams = GetSpaceEnvironmentParams & {
|
|
2685
|
+
entryId: string;
|
|
2686
|
+
version: number;
|
|
2687
|
+
releaseId?: string;
|
|
2688
|
+
};
|
|
2689
|
+
export type UpdateEntryParams = GetSpaceEnvironmentParams & {
|
|
2690
|
+
entryId: string;
|
|
2691
|
+
releaseId?: string;
|
|
2692
|
+
};
|
|
2551
2693
|
export type GetExtensionParams = GetSpaceEnvironmentParams & {
|
|
2552
2694
|
extensionId: string;
|
|
2553
2695
|
};
|
|
@@ -2570,9 +2712,69 @@ export type GetFunctionLogParams = GetManyFunctionLogParams & {
|
|
|
2570
2712
|
export type GetOrganizationParams = {
|
|
2571
2713
|
organizationId: string;
|
|
2572
2714
|
};
|
|
2573
|
-
export type GetReleaseParams =
|
|
2715
|
+
export type GetReleaseParams = ReleaseEnvironmentParams & {
|
|
2716
|
+
releaseId: string;
|
|
2717
|
+
};
|
|
2718
|
+
export type GetReleaseAssetParams = GetSpaceEnvironmentParams & {
|
|
2719
|
+
releaseId: string;
|
|
2720
|
+
assetId: string;
|
|
2721
|
+
};
|
|
2722
|
+
export type GetManyReleaseAssetParams = GetSpaceEnvironmentParams & {
|
|
2574
2723
|
releaseId: string;
|
|
2575
2724
|
};
|
|
2725
|
+
export type GetReleaseEntryParams = GetSpaceEnvironmentParams & {
|
|
2726
|
+
releaseId: string;
|
|
2727
|
+
entryId: string;
|
|
2728
|
+
};
|
|
2729
|
+
export type CreateReleaseAssetParams = GetSpaceEnvironmentParams & {
|
|
2730
|
+
releaseId: string;
|
|
2731
|
+
};
|
|
2732
|
+
export type CreateWithIdReleaseAssetParams = GetSpaceEnvironmentParams & {
|
|
2733
|
+
releaseId: string;
|
|
2734
|
+
assetId: string;
|
|
2735
|
+
};
|
|
2736
|
+
export type CreateWithFilesReleaseAssetParams = GetSpaceEnvironmentParams & {
|
|
2737
|
+
releaseId: string;
|
|
2738
|
+
uploadTimeout?: number;
|
|
2739
|
+
};
|
|
2740
|
+
export type UpdateReleaseAssetParams = GetSpaceEnvironmentParams & {
|
|
2741
|
+
releaseId: string;
|
|
2742
|
+
assetId: string;
|
|
2743
|
+
};
|
|
2744
|
+
export type ProcessForLocaleReleaseAssetParams = GetSpaceEnvironmentParams & {
|
|
2745
|
+
asset: AssetProps<{
|
|
2746
|
+
release: Link<'Release'>;
|
|
2747
|
+
}>;
|
|
2748
|
+
locale: string;
|
|
2749
|
+
options?: AssetProcessingForLocale;
|
|
2750
|
+
};
|
|
2751
|
+
export type ProcessForAllLocalesReleaseAssetParams = GetSpaceEnvironmentParams & {
|
|
2752
|
+
asset: AssetProps<{
|
|
2753
|
+
release: Link<'Release'>;
|
|
2754
|
+
}>;
|
|
2755
|
+
options?: AssetProcessingForLocale;
|
|
2756
|
+
};
|
|
2757
|
+
export type GetManyReleaseEntryParams = GetSpaceEnvironmentParams & {
|
|
2758
|
+
releaseId: string;
|
|
2759
|
+
};
|
|
2760
|
+
export type UpdateReleaseEntryParams = GetSpaceEnvironmentParams & {
|
|
2761
|
+
releaseId: string;
|
|
2762
|
+
entryId: string;
|
|
2763
|
+
};
|
|
2764
|
+
export type PatchReleaseEntryParams = GetSpaceEnvironmentParams & {
|
|
2765
|
+
releaseId: string;
|
|
2766
|
+
entryId: string;
|
|
2767
|
+
version: number;
|
|
2768
|
+
};
|
|
2769
|
+
export type CreateReleaseEntryParams = GetSpaceEnvironmentParams & {
|
|
2770
|
+
releaseId: string;
|
|
2771
|
+
contentTypeId: string;
|
|
2772
|
+
};
|
|
2773
|
+
export type CreateWithIdReleaseEntryParams = GetSpaceEnvironmentParams & {
|
|
2774
|
+
releaseId: string;
|
|
2775
|
+
entryId: string;
|
|
2776
|
+
contentTypeId: string;
|
|
2777
|
+
};
|
|
2576
2778
|
export type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & {
|
|
2577
2779
|
contentTypeId: string;
|
|
2578
2780
|
};
|
|
@@ -2719,4 +2921,7 @@ export type GetUserParams = {
|
|
|
2719
2921
|
export declare enum ScheduledActionReferenceFilters {
|
|
2720
2922
|
contentTypeAnnotationNotIn = "sys.contentType.metadata.annotations.ContentType[nin]"
|
|
2721
2923
|
}
|
|
2924
|
+
export type ReleaseEnvironmentParams = GetSpaceEnvironmentParams & {
|
|
2925
|
+
releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
|
|
2926
|
+
};
|
|
2722
2927
|
export {};
|
|
@@ -327,5 +327,5 @@ export default function createEntryApi(makeRequest: MakeRequest): {
|
|
|
327
327
|
/**
|
|
328
328
|
* Recursively collects references of an entry and their descendants
|
|
329
329
|
*/
|
|
330
|
-
references: (options?: EntryReferenceOptionsProps) => Promise<import("./common-types").Collection<Entry, EntryProps<import("./common-types").KeyValueMap>>>;
|
|
330
|
+
references: (options?: EntryReferenceOptionsProps) => Promise<import("./common-types").Collection<Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
|
|
331
331
|
};
|
|
@@ -8,7 +8,7 @@ import type { AssetFileProp, AssetProps, CreateAssetFromFilesOptions, CreateAsse
|
|
|
8
8
|
import type { CreateAssetKeyProps } from './entities/asset-key';
|
|
9
9
|
import type { BulkAction, BulkActionPayload, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from './entities/bulk-action';
|
|
10
10
|
import type { ReleaseActionQueryOptions } from './entities/release-action';
|
|
11
|
-
import type { ReleasePayload, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
|
|
11
|
+
import type { ReleasePayload, ReleaseQueryOptions, ReleaseValidatePayload, ReleasePayloadV2 } from './entities/release';
|
|
12
12
|
import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type';
|
|
13
13
|
import type { CreateEntryProps, EntryProps, EntryReferenceOptionsProps, EntryReferenceProps } from './entities/entry';
|
|
14
14
|
import type { CreateExtensionProps } from './entities/extension';
|
|
@@ -269,7 +269,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
269
269
|
*
|
|
270
270
|
* // Using Thenables
|
|
271
271
|
* client.getSpace('<space_id>')
|
|
272
|
-
* .then((space) => space.getEnvironment('<
|
|
272
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
273
273
|
* .then((environment) => environment.createUnpublishBulkAction(payload))
|
|
274
274
|
* .then((bulkAction) => console.log(bulkAction.waitProcessing()))
|
|
275
275
|
* .catch(console.error)
|
|
@@ -277,7 +277,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
277
277
|
* // Using async/await
|
|
278
278
|
* try {
|
|
279
279
|
* const space = await clientgetSpace('<space_id>')
|
|
280
|
-
* const environment = await space.getEnvironment('<
|
|
280
|
+
* const environment = await space.getEnvironment('<environment-id>')
|
|
281
281
|
* const bulkActionInProgress = await environment.createUnpublishBulkAction(payload)
|
|
282
282
|
*
|
|
283
283
|
* // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
|
|
@@ -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>>>;
|
|
489
|
+
getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
|
|
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>>>;
|
|
508
|
+
getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
|
|
509
509
|
/**
|
|
510
510
|
* Creates a Entry
|
|
511
511
|
* @param contentTypeId - The Content Type ID of the newly created Entry
|
|
@@ -574,7 +574,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
574
574
|
*
|
|
575
575
|
* // Get entry references
|
|
576
576
|
* client.getSpace('<space_id>')
|
|
577
|
-
* .then((space) => space.getEnvironment('<
|
|
577
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
578
578
|
* .then((environment) => environment.getEntryReferences('<entry_id>', {include: number}))
|
|
579
579
|
* .then((entry) => console.log(entry.includes))
|
|
580
580
|
* // or
|
|
@@ -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.
|
|
@@ -1380,7 +1380,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1380
1380
|
*/
|
|
1381
1381
|
updateRelease({ releaseId, payload, version, }: {
|
|
1382
1382
|
releaseId: string;
|
|
1383
|
-
payload: ReleasePayload;
|
|
1383
|
+
payload: ReleasePayload | ReleasePayloadV2;
|
|
1384
1384
|
version: number;
|
|
1385
1385
|
}): Promise<import("./entities/release").Release>;
|
|
1386
1386
|
/**
|
|
@@ -1612,7 +1612,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
|
|
|
1612
1612
|
* })
|
|
1613
1613
|
*
|
|
1614
1614
|
* client.getSpace('<space_id>')
|
|
1615
|
-
* .then((space) => space.getEnvironment('<
|
|
1615
|
+
* .then((space) => space.getEnvironment('<environment-id>'))
|
|
1616
1616
|
* .then((environment) => environment.getResourceTypes({limit: 10}))
|
|
1617
1617
|
* .then((installations) => console.log(installations.items))
|
|
1618
1618
|
* .catch(console.error)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Except } from 'type-fest';
|
|
2
|
-
import type { BasicMetaSysProps, AppActionCallRetryOptions, DefaultElements, MakeRequest, SysLink
|
|
2
|
+
import type { BasicMetaSysProps, AppActionCallRetryOptions, DefaultElements, MakeRequest, SysLink } from '../common-types';
|
|
3
3
|
import type { WebhookCallDetailsProps } from './webhook';
|
|
4
4
|
type AppActionCallSys = Except<BasicMetaSysProps, 'version'> & {
|
|
5
5
|
appDefinition: SysLink;
|
|
@@ -38,10 +38,10 @@ export type CreateAppActionCallProps = {
|
|
|
38
38
|
};
|
|
39
39
|
};
|
|
40
40
|
type AppActionCallApi = {
|
|
41
|
-
createWithResponse(
|
|
42
|
-
getCallDetails(
|
|
43
|
-
get(
|
|
44
|
-
createWithResult(
|
|
41
|
+
createWithResponse(): Promise<AppActionCallResponse>;
|
|
42
|
+
getCallDetails(): Promise<AppActionCallResponse>;
|
|
43
|
+
get(): Promise<AppActionCallProps>;
|
|
44
|
+
createWithResult(): Promise<AppActionCallProps>;
|
|
45
45
|
};
|
|
46
46
|
export type AppActionCallResponse = WebhookCallDetailsProps;
|
|
47
47
|
export interface AppActionCallRawResponseProps {
|
|
@@ -58,7 +58,6 @@ export interface AppActionCallRawResponseProps {
|
|
|
58
58
|
headers?: {
|
|
59
59
|
contentType?: string;
|
|
60
60
|
};
|
|
61
|
-
statusCode?: number;
|
|
62
61
|
body: string;
|
|
63
62
|
};
|
|
64
63
|
}
|
|
@@ -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 = {
|
|
4
|
-
sys: EntityMetaSysProps;
|
|
3
|
+
export type AssetProps<S = {}> = {
|
|
4
|
+
sys: EntityMetaSysProps & S;
|
|
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
|
|
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> = {
|
|
5
|
-
sys: EntryMetaSysProps;
|
|
4
|
+
export type EntryProps<T = KeyValueMap, S = unknown> = {
|
|
5
|
+
sys: EntryMetaSysProps & S;
|
|
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>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap>>;
|
|
53
|
+
export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap, unknown>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap, unknown>>;
|
|
@@ -18,6 +18,8 @@ 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';
|
|
21
23
|
/** Comma-separated filter (exclusion) by Release status (active, archived) */
|
|
22
24
|
'sys.status[nin]'?: ReleaseStatus;
|
|
23
25
|
/** Find releases using full text phrase and term matching */
|
|
@@ -55,6 +57,7 @@ export type ReleaseSysProps = {
|
|
|
55
57
|
createdAt: ISO8601Timestamp;
|
|
56
58
|
updatedAt: ISO8601Timestamp;
|
|
57
59
|
lastAction?: Link<'ReleaseAction'>;
|
|
60
|
+
schemaVersion?: 'Release.v2';
|
|
58
61
|
};
|
|
59
62
|
export type ReleaseReferenceFilters = ScheduledActionReferenceFilters;
|
|
60
63
|
export declare const ReleaseReferenceFilters: typeof ScheduledActionReferenceFilters;
|
|
@@ -72,9 +75,23 @@ export interface ReleaseProps {
|
|
|
72
75
|
metadata?: ReleaseMetadata;
|
|
73
76
|
}
|
|
74
77
|
export interface ReleasePayload extends MakeRequestPayload {
|
|
78
|
+
sys?: {
|
|
79
|
+
type: 'Release';
|
|
80
|
+
schemaVersion?: 'Release.v1' | undefined;
|
|
81
|
+
};
|
|
75
82
|
title: string;
|
|
76
83
|
entities: BaseCollection<Link<Entity>>;
|
|
77
84
|
}
|
|
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
|
+
}
|
|
78
95
|
export interface ReleaseValidatePayload {
|
|
79
96
|
action?: 'publish';
|
|
80
97
|
}
|
|
@@ -95,7 +112,7 @@ export interface ReleaseApiMethods {
|
|
|
95
112
|
* */
|
|
96
113
|
unarchive(): Promise<Release>;
|
|
97
114
|
/** Updates a Release and returns the updated Release object */
|
|
98
|
-
update(payload: ReleasePayload): Promise<Release>;
|
|
115
|
+
update(payload: ReleasePayload | ReleasePayloadV2): Promise<Release>;
|
|
99
116
|
/** Deletes a Release and all ReleaseActions linked to it (non-reversible) */
|
|
100
117
|
delete(): Promise<void>;
|
|
101
118
|
/** Publishes a Release and waits until the asynchronous action is completed */
|