contentful-management 12.6.0-dev.2 → 12.6.0-dev.3

package/dist/esm/adapters/REST/endpoints/fragment.mjs

@@ -15,7 +15,7 @@ const create = (http, params, rawData, headers) => {
     const data = copy(rawData);
     return post(http, getBaseUrl(params), data, { headers });
 };
-const update = (http, params, rawData, headers) => {
+const upsert = (http, params, rawData, headers) => {
     const { sys, ...body } = copy(rawData);
     return put(http, getBaseUrl(params) + `/${params.fragmentId}`, body, {
         headers: {
@@ -46,5 +46,5 @@ const unpublish = (http, params, headers) => {
     });
 };
 
-export { create, del, get, getMany, publish, unpublish, update };
+export { create, del, get, getMany, publish, unpublish, upsert };
 //# sourceMappingURL=fragment.mjs.map

package/dist/esm/common-types.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"common-types.mjs","sources":["../../lib/common-types.ts"],"sourcesContent":[null],"names":[],"mappings":"AA80GA;IACY;AAAZ,CAAA,UAAY,+BAA+B,EAAA;AACzC,IAAA,+BAAA,CAAA,4BAAA,CAAA,GAAA,uDAAoF;AACtF,CAAC,EAFW,+BAA+B,KAA/B,+BAA+B,GAAA,EAAA,CAAA,CAAA;;;;"}
+{"version":3,"file":"common-types.mjs","sources":["../../lib/common-types.ts"],"sourcesContent":[null],"names":[],"mappings":"AAi1GA;IACY;AAAZ,CAAA,UAAY,+BAA+B,EAAA;AACzC,IAAA,+BAAA,CAAA,4BAAA,CAAA,GAAA,uDAAoF;AACtF,CAAC,EAFW,+BAA+B,KAA/B,+BAA+B,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/esm/plain/plain-client.mjs

@@ -602,7 +602,7 @@ const createPlainClient = (makeRequest, defaults) => {
             getMany: wrap(wrapParams, 'Fragment', 'getMany'),
             get: wrap(wrapParams, 'Fragment', 'get'),
             create: wrap(wrapParams, 'Fragment', 'create'),
-            update: wrap(wrapParams, 'Fragment', 'update'),
+            upsert: wrap(wrapParams, 'Fragment', 'upsert'),
             delete: wrap(wrapParams, 'Fragment', 'delete'),
             publish: wrap(wrapParams, 'Fragment', 'publish'),
             unpublish: wrap(wrapParams, 'Fragment', 'unpublish'),

package/dist/types/adapters/REST/endpoints/fragment.d.ts

@@ -2,7 +2,7 @@ import type { RestEndpoint } from '../types';
 export declare const getMany: RestEndpoint<'Fragment', 'getMany'>;
 export declare const get: RestEndpoint<'Fragment', 'get'>;
 export declare const create: RestEndpoint<'Fragment', 'create'>;
-export declare const update: RestEndpoint<'Fragment', 'update'>;
+export declare const upsert: RestEndpoint<'Fragment', 'upsert'>;
 export declare const del: RestEndpoint<'Fragment', 'delete'>;
 export declare const publish: RestEndpoint<'Fragment', 'publish'>;
 export declare const unpublish: RestEndpoint<'Fragment', 'unpublish'>;

package/dist/types/adapters/REST/endpoints/fragment.js

@@ -15,7 +15,7 @@ const create = (http, params, rawData, headers) => {
     const data = copy(rawData);
     return post(http, getBaseUrl(params), data, { headers });
 };
-const update = (http, params, rawData, headers) => {
+const upsert = (http, params, rawData, headers) => {
     const { sys, ...body } = copy(rawData);
     return put(http, getBaseUrl(params) + `/${params.fragmentId}`, body, {
         headers: {
@@ -46,5 +46,5 @@ const unpublish = (http, params, headers) => {
     });
 };
 
-export { create, del, get, getMany, publish, unpublish, update };
+export { create, del, get, getMany, publish, unpublish, upsert };
 //# sourceMappingURL=fragment.js.map

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

@@ -17,7 +17,7 @@ import type { AvailableLicenseProps } from './entities/available-license';
 import type { BulkActionProps, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionV2Payload, BulkActionValidatePayload, PublishBulkActionV2Payload, UnpublishBulkActionV2Payload, ValidateBulkActionV2Payload } from './entities/bulk-action';
 import type { CommentProps, CreateCommentParams, CreateCommentProps, DeleteCommentParams, GetCommentParentEntityParams, GetManyCommentsParams, PlainTextBodyFormat, RichTextBodyFormat, RichTextCommentBodyPayload, RichTextCommentProps, UpdateCommentParams, UpdateCommentProps } from './entities/comment';
 import type { ComponentTypeProps, ComponentTypeQueryOptions, CreateComponentTypeProps, UpsertComponentTypeProps } from './entities/component-type';
-import type { CreateFragmentProps, FragmentProps, FragmentQueryOptions, UpdateFragmentProps } from './entities/fragment';
+import type { CreateFragmentProps, FragmentProps, FragmentQueryOptions, UpsertFragmentProps } from './entities/fragment';
 import type { CreateTemplateProps, TemplateProps, TemplateQueryOptions, UpsertTemplateProps } from './entities/template';
 import type { CreateExperienceProps, UpsertExperienceProps, ExperienceLocalePublishPayload, ExperienceProps, ExperienceQueryOptions } from './entities/experience';
 import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type';
@@ -142,7 +142,19 @@ export type DiscriminatedUnionDataTypeDefinition = BaseDataTypeDefinition & {
 };
 export type DataTypeDefinition = PrimitiveDataTypeDefinition | RichTextDataTypeDefinition | ArrayDataTypeDefinition | RecordDataTypeDefinition | TypeRefDataTypeDefinition | LiteralDataTypeDefinition | DiscriminatedUnionDataTypeDefinition;
 export type PointerExpressionValue = string | {
+    $from: string | {
+        source: string;
+        select?: PointerExpressionValue;
+    };
+} | {
     $literal: JsonValue;
+} | {
+    $object: Record<string, PointerExpressionValue>;
+} | {
+    $on: {
+        type: Record<string, PointerExpressionValue>;
+        default?: PointerExpressionValue;
+    };
 } | {
     [key: string]: PointerExpressionValue;
 };
@@ -712,7 +724,7 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'Fragment', 'getMany', UA>): MRReturn<'Fragment', 'getMany'>;
     (opts: MROpts<'Fragment', 'get', UA>): MRReturn<'Fragment', 'get'>;
     (opts: MROpts<'Fragment', 'create', UA>): MRReturn<'Fragment', 'create'>;
-    (opts: MROpts<'Fragment', 'update', UA>): MRReturn<'Fragment', 'update'>;
+    (opts: MROpts<'Fragment', 'upsert', UA>): MRReturn<'Fragment', 'upsert'>;
     (opts: MROpts<'Fragment', 'delete', UA>): MRReturn<'Fragment', 'delete'>;
     (opts: MROpts<'Fragment', 'publish', UA>): MRReturn<'Fragment', 'publish'>;
     (opts: MROpts<'Fragment', 'unpublish', UA>): MRReturn<'Fragment', 'unpublish'>;
@@ -2944,9 +2956,9 @@ export type MRActions = {
             payload: CreateFragmentProps;
             return: FragmentProps;
         };
-        update: {
+        upsert: {
             params: GetFragmentParams;
-            payload: UpdateFragmentProps;
+            payload: UpsertFragmentProps;
             return: FragmentProps;
         };
         delete: {

package/dist/types/common-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"common-types.js","sources":["../../lib/common-types.ts"],"sourcesContent":[null],"names":[],"mappings":"AA80GA;IACY;AAAZ,CAAA,UAAY,+BAA+B,EAAA;AACzC,IAAA,+BAAA,CAAA,4BAAA,CAAA,GAAA,uDAAoF;AACtF,CAAC,EAFW,+BAA+B,KAA/B,+BAA+B,GAAA,EAAA,CAAA,CAAA;;;;"}
+{"version":3,"file":"common-types.js","sources":["../../lib/common-types.ts"],"sourcesContent":[null],"names":[],"mappings":"AAi1GA;IACY;AAAZ,CAAA,UAAY,+BAA+B,EAAA;AACzC,IAAA,+BAAA,CAAA,4BAAA,CAAA,GAAA,uDAAoF;AACtF,CAAC,EAFW,+BAA+B,KAA/B,+BAA+B,GAAA,EAAA,CAAA,CAAA;;;;"}

package/dist/types/entities/component-type.d.ts

@@ -52,9 +52,6 @@ export type TokenBackedDesignProperty = DesignPropertyCommonFields & {
     allowedResources?: DesignTokenAllowedResource[];
 };
 export type ComponentTypeDesignProperty = StringDesignProperty | BooleanDesignProperty | TokenBackedDesignProperty;
-export type ComponentTypeDimensionKeyMap = {
-    designProperties: Record<string, Record<string, string>>;
-};
 export type ContentPropertyPointerValue = `$contentProperties/${string}`;
 export type DesignPropertyPointerValue = `$designProperties/${string}`;
 export type ManualDesignValue = {
@@ -91,6 +88,7 @@ export type SlotNode = {
 };
 export type TreeNode = ComponentNode | FragmentNode | SlotNode;
 export type DataAssemblyLink = ResourceLink<'Contentful:DataAssembly'>;
+export declare const COMPONENT_TYPE_ALLOWED_RESOURCE_SOURCE: "crn:contentful:::experience:spaces/$self/environments/$self";
 export type ComponentTypeSlotDefinition = {
     id: string;
     name: string;
@@ -103,7 +101,7 @@ export type ComponentTypeSlotDefinition = {
     }>;
     allowedResources?: Array<{
         type: 'Contentful:ComponentType';
-        source: string;
+        source: typeof COMPONENT_TYPE_ALLOWED_RESOURCE_SOURCE;
         allowedTypes: string[];
     }>;
 };
@@ -134,7 +132,6 @@ export type ComponentTypeProps = {
     viewports: ComponentTypeViewport[];
     contentProperties: ComponentTypeContentProperty[];
     designProperties: ComponentTypeDesignProperty[];
-    dimensionKeyMap: ComponentTypeDimensionKeyMap;
     componentTree?: TreeNode[];
     slots?: ComponentTypeSlotDefinition[];
     metadata?: ExoMetadataProps;

package/dist/types/entities/data-assembly.d.ts

@@ -1,28 +1,30 @@
 import type { CursorPaginationParams, DataTypeDefinition, ExoCursorPaginatedCollectionProp, Link, MetadataProps, PointerExpressionValue, ResourceLink } from '../common-types';
-export type DataAssemblyDataTypeField = DataTypeDefinition & {
+export declare const SAME_SPACE_CONTENT_SOURCE: "crn:contentful:::content:spaces/$self/environments/$self";
+export type CanonicalDataAssemblyDataTypeField = DataTypeDefinition & {
     id: string;
     name: string;
-    source?: string;
 };
-export type DataAssemblyLinkParameter = {
-    name?: string;
-    description?: string;
-    type: 'Link';
-    linkType: string;
-    allowedContentTypes: string[];
+export type LegacyDataAssemblyDataTypeField = {
+    id: string;
+    name: string;
+    type: string;
+    required?: boolean;
+    source?: string;
+    ref?: unknown;
 };
+export type DataAssemblyDataTypeField = CanonicalDataAssemblyDataTypeField | LegacyDataAssemblyDataTypeField;
 export type DataAssemblyResourceLinkParameter = {
     name?: string;
     description?: string;
     type: 'ResourceLink';
-    linkType: string;
+    linkType: 'Contentful:Entry';
     allowedResources: Array<{
-        type: string;
-        source: string;
+        type: 'Contentful:Entry';
+        source: typeof SAME_SPACE_CONTENT_SOURCE;
         allowedTypes: string[];
     }>;
 };
-export type DataAssemblyParameterConfig = Record<string, DataAssemblyLinkParameter | DataAssemblyResourceLinkParameter>;
+export type DataAssemblyParameterConfig = Record<string, DataAssemblyResourceLinkParameter>;
 export type DataAssemblyGraphQLResolver = {
     source: 'Contentful:GraphQL';
     query: string;
@@ -35,7 +37,7 @@ export type DataAssemblyNestedResolver = {
 };
 export type DataAssemblyResolverDefinition = DataAssemblyGraphQLResolver | DataAssemblyNestedResolver;
 export type DataAssemblyResolverConfig = Record<string, DataAssemblyResolverDefinition>;
-export type DataAssemblyReturnMappingConfig = Record<string, PointerExpressionValue>;
+export type DataAssemblyReturnMappingConfig = PointerExpressionValue;
 export type DataAssemblySys = {
     id: string;
     type: 'DataAssembly';

package/dist/types/entities/experience.d.ts

@@ -1,10 +1,5 @@
 import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExperienceMetadataProps, ExoQueryFilters, Link, ResourceLink } from '../common-types';
 import type { ComponentTypeViewport, DimensionedDesignPropertyValue, FragmentNode } from './component-type';
-export type ExperienceDimensionKeyMap = {
-    designProperties: Record<string, {
-        breakpoint: string;
-    }>;
-};
 export type ExperienceContentBindings = {
     sys: ResourceLink<'Contentful:DataAssembly'>['sys'];
     parameters: Record<string, ResourceLink<string>>;
@@ -38,7 +33,6 @@ type ExperienceCommonProps = {
     description: string;
     viewports: ComponentTypeViewport[];
     designProperties: Record<string, DimensionedDesignPropertyValue>;
-    dimensionKeyMap: ExperienceDimensionKeyMap;
     contentBindings?: ExperienceContentBindings;
     metadata?: ExperienceMetadataProps;
     slots?: Record<string, Array<FragmentNode | InlineFragmentNode>>;

package/dist/types/entities/fragment.d.ts

@@ -1,7 +1,7 @@
 import type { Except } from 'type-fest';
 import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExoQueryFilters, ExperienceMetadataProps, Link, ResourceLink } from '../common-types';
 import type { ComponentTypeViewport, DimensionedDesignPropertyValue, FragmentNode } from './component-type';
-import type { ExperienceContentBindings, ExperienceDimensionKeyMap, InlineFragmentNode } from './experience';
+import type { ExperienceContentBindings, InlineFragmentNode } from './experience';
 export type FragmentSys = {
     id: string;
     type: 'Fragment';
@@ -31,7 +31,6 @@ export type FragmentProps = {
     description: string;
     viewports: ComponentTypeViewport[];
     designProperties: Record<string, DimensionedDesignPropertyValue>;
-    dimensionKeyMap: ExperienceDimensionKeyMap;
     contentBindings?: ExperienceContentBindings;
     metadata?: ExperienceMetadataProps;
     slots?: Record<string, Array<FragmentNode | InlineFragmentNode>>;
@@ -39,11 +38,11 @@ export type FragmentProps = {
 export type CreateFragmentProps = Except<FragmentProps, 'sys'> & {
     componentType: ResourceLink<'Contentful:ComponentType'>;
 };
-export type UpdateFragmentProps = Omit<FragmentProps, 'sys'> & {
+export type UpsertFragmentProps = Omit<FragmentProps, 'sys'> & {
     sys: {
         id: string;
         type: 'Fragment';
-        version: number;
+        version?: number;
     };
     componentType?: ResourceLink<'Contentful:ComponentType'>;
 };

package/dist/types/entities/template.d.ts

@@ -1,6 +1,6 @@
 import type { Except } from 'type-fest';
 import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExoMetadataProps, ExoQueryFilters, Link } from '../common-types';
-import type { ComponentTypeContentProperty, ComponentTypeDesignProperty, ComponentTypeDimensionKeyMap, ComponentTypeSlotDefinition, ComponentTypeViewport, DataAssemblyLink, TreeNode } from './component-type';
+import type { ComponentTypeContentProperty, ComponentTypeDesignProperty, ComponentTypeSlotDefinition, ComponentTypeViewport, DataAssemblyLink, TreeNode } from './component-type';
 export type TemplateSys = {
     id: string;
     type: 'Template';
@@ -28,7 +28,6 @@ export type TemplateProps = {
     viewports: ComponentTypeViewport[];
     contentProperties: ComponentTypeContentProperty[];
     designProperties: ComponentTypeDesignProperty[];
-    dimensionKeyMap: ComponentTypeDimensionKeyMap;
     componentTree?: TreeNode[];
     slots?: ComponentTypeSlotDefinition[];
     metadata?: ExoMetadataProps;

package/dist/types/plain/entities/component-type.d.ts

@@ -59,7 +59,6 @@ export type ComponentTypePlainClientAPI = {
      *   viewports: [],
      *   contentProperties: [],
      *   designProperties: [],
-     *   dimensionKeyMap: { designProperties: {} },
      * });
      * ```
      */

package/dist/types/plain/entities/experience.d.ts

@@ -57,7 +57,6 @@ export type ExperiencePlainClientAPI = {
      *   viewports: [],
      *   contentProperties: {},
      *   designProperties: {},
-     *   dimensionKeyMap: { designProperties: {} },
      * });
      * ```
      */

package/dist/types/plain/entities/fragment.d.ts

@@ -1,5 +1,5 @@
 import type { ExoCursorPaginatedCollectionProp, GetFragmentParams, GetSpaceEnvironmentParams } from '../../common-types';
-import type { CreateFragmentProps, FragmentProps, FragmentQueryOptions, UpdateFragmentProps } from '../../entities/fragment';
+import type { CreateFragmentProps, FragmentProps, FragmentQueryOptions, UpsertFragmentProps } from '../../entities/fragment';
 import type { OptionalDefaults } from '../wrappers/wrap';
 export type FragmentPlainClientAPI = {
     /**
@@ -56,28 +56,27 @@ export type FragmentPlainClientAPI = {
      *   componentType: { sys: { type: 'Link', linkType: 'ComponentType', id: '<component_type_id>' } },
      *   viewports: [],
      *   designProperties: {},
-     *   dimensionKeyMap: { designProperties: {} },
      * });
      * ```
      */
     create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateFragmentProps): Promise<FragmentProps>;
     /**
-     * Updates a fragment with PUT
+     * Upserts a fragment (creates or updates via PUT)
      * @param params the space, environment, and fragment IDs
-     * @param data the fragment data (including sys.version)
-     * @returns the updated fragment
+     * @param data the fragment data to upsert (include sys.version for updates, omit for creates)
+     * @returns the upserted fragment
      * @throws if the request fails, or the space, environment, or fragment is not found
      * @internal - Experimental endpoint, subject to breaking changes without notice
      * @example
      * ```javascript
-     * const fragment = await client.fragment.update({
+     * const fragment = await client.fragment.upsert({
      *   spaceId: '<space_id>',
      *   environmentId: '<environment_id>',
      *   fragmentId: '<fragment_id>',
      * }, fragmentData);
      * ```
      */
-    update(params: OptionalDefaults<GetFragmentParams>, data: UpdateFragmentProps): Promise<FragmentProps>;
+    upsert(params: OptionalDefaults<GetFragmentParams>, data: UpsertFragmentProps): Promise<FragmentProps>;
     /**
      * Deletes a fragment
      * @param params the space, environment, and fragment IDs

package/dist/types/plain/entities/template.d.ts

@@ -56,7 +56,6 @@ export type TemplatePlainClientAPI = {
      *   viewports: [],
      *   contentProperties: [],
      *   designProperties: [],
-     *   dimensionKeyMap: { designProperties: {} },
      * });
      * ```
      */

package/dist/types/plain/plain-client.js

@@ -602,7 +602,7 @@ const createPlainClient = (makeRequest, defaults) => {
             getMany: wrap(wrapParams, 'Fragment', 'getMany'),
             get: wrap(wrapParams, 'Fragment', 'get'),
             create: wrap(wrapParams, 'Fragment', 'create'),
-            update: wrap(wrapParams, 'Fragment', 'update'),
+            upsert: wrap(wrapParams, 'Fragment', 'upsert'),
             delete: wrap(wrapParams, 'Fragment', 'delete'),
             publish: wrap(wrapParams, 'Fragment', 'publish'),
             unpublish: wrap(wrapParams, 'Fragment', 'unpublish'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "12.6.0-dev.2",
+  "version": "12.6.0-dev.3",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "exports": {