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

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

@@ -1 +1 @@
-{"version":3,"file":"common-types.mjs","sources":["../../lib/common-types.ts"],"sourcesContent":[null],"names":[],"mappings":"AA6wGA;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":"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;;;;"}

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

@@ -104,6 +104,48 @@ export interface ResourceLink<T extends string> {
         urn: string;
     };
 }
+export type PrimitiveDataTypeName = 'String' | 'Number' | 'Integer' | 'Boolean';
+export type BaseDataTypeDefinition = {
+    name?: string;
+    required?: boolean;
+};
+export type PrimitiveDataTypeDefinition = BaseDataTypeDefinition & {
+    type: PrimitiveDataTypeName;
+};
+export type RichTextDataTypeDefinition = BaseDataTypeDefinition & {
+    type: 'RichText';
+};
+export type ArrayDataTypeDefinition = BaseDataTypeDefinition & {
+    type: 'Array';
+    items: DataTypeDefinition;
+};
+export type RecordDataTypeDefinition = BaseDataTypeDefinition & {
+    type: 'Record';
+    fields: Record<string, DataTypeDefinition>;
+};
+export type TypeRefDataTypeDefinition = BaseDataTypeDefinition & {
+    type: 'TypeRef';
+    ref: ResourceLink<string>;
+};
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export type LiteralDataTypeDefinition = BaseDataTypeDefinition & {
+    type: 'Literal';
+    value: JsonValue;
+    valueType: DataTypeDefinition;
+};
+export type DiscriminatedUnionDataTypeDefinition = BaseDataTypeDefinition & {
+    type: 'DiscriminatedUnion';
+    discriminator: string;
+    members: DataTypeDefinition[];
+};
+export type DataTypeDefinition = PrimitiveDataTypeDefinition | RichTextDataTypeDefinition | ArrayDataTypeDefinition | RecordDataTypeDefinition | TypeRefDataTypeDefinition | LiteralDataTypeDefinition | DiscriminatedUnionDataTypeDefinition;
+export type PointerExpressionValue = string | {
+    $literal: JsonValue;
+} | {
+    [key: string]: PointerExpressionValue;
+};
 export interface VersionedLink<T extends string> {
     sys: {
         type: 'Link';

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

@@ -1 +1 @@
-{"version":3,"file":"common-types.js","sources":["../../lib/common-types.ts"],"sourcesContent":[null],"names":[],"mappings":"AA6wGA;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":"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;;;;"}

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

@@ -1,5 +1,5 @@
 import type { Except } from 'type-fest';
-import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExoMetadataProps, ExoQueryFilters, Link, ResourceLink } from '../common-types';
+import type { CursorPaginationParams, DataTypeDefinition, ExoCursorPaginatedCollectionProp, ExoMetadataProps, ExoQueryFilters, Link, ResourceLink } from '../common-types';
 export type ComponentTypeQueryOptions = CursorPaginationParams & ExoQueryFilters & {
     order?: string;
 };
@@ -9,30 +9,12 @@ export type ComponentTypeViewport = {
     displayName: string;
     previewSize: string;
 };
-export type ComponentTypePrimitiveContentProperty = {
+export type ComponentTypeContentProperty = DataTypeDefinition & {
     id: string;
     name: string;
-    type: 'String' | 'Number' | 'Boolean';
     required: boolean;
     defaultValue?: unknown;
 };
-export type ComponentTypeTypeRefContentProperty = {
-    id: string;
-    name: string;
-    type: 'TypeRef';
-    ref: ResourceLink<'Contentful:DataAssembly'> | ResourceLink<'Contentful:ComponentType'>;
-    required: boolean;
-};
-export type ComponentTypeContentProperty = ComponentTypePrimitiveContentProperty | ComponentTypeTypeRefContentProperty;
-export type ComponentTypeDesignPropertyValidation = {
-    type: 'ManualDesignValue';
-    value: string | number | boolean;
-    name?: string;
-} | {
-    type: 'DesignToken';
-    value: string;
-    name?: string;
-};
 export type StringDesignPropertyRegexpValidation = {
     regexp: {
         pattern: string;
@@ -47,30 +29,29 @@ export type DTCGDesignPropertyType = 'DTCG.Color' | 'DTCG.Dimension' | 'DTCG.Fon
 type DesignPropertyCommonFields = {
     id: string;
     name: string;
-    required: boolean;
     description?: string;
 };
-export type LegacyDesignProperty = DesignPropertyCommonFields & {
-    type: 'Symbol' | 'Number' | 'Boolean';
-    defaultValue?: DesignPropertyDefinitionValue;
-    validations?: {
-        in?: ComponentTypeDesignPropertyValidation[];
-    };
-};
 export type StringDesignProperty = DesignPropertyCommonFields & {
     type: 'String';
-    defaultValue?: {
+    fallbackValue?: {
         type: 'ManualDesignValue';
         value: string;
     };
     validations?: StringDesignPropertyRegexpValidation[];
 };
+export type BooleanDesignProperty = DesignPropertyCommonFields & {
+    type: 'Boolean';
+    fallbackValue?: {
+        type: 'ManualDesignValue';
+        value: boolean;
+    };
+};
 export type TokenBackedDesignProperty = DesignPropertyCommonFields & {
     type: DTCGDesignPropertyType;
-    defaultValue?: DesignTokenValue;
+    fallbackValue?: DesignTokenValue;
     allowedResources?: DesignTokenAllowedResource[];
 };
-export type ComponentTypeDesignProperty = LegacyDesignProperty | StringDesignProperty | TokenBackedDesignProperty;
+export type ComponentTypeDesignProperty = StringDesignProperty | BooleanDesignProperty | TokenBackedDesignProperty;
 export type ComponentTypeDimensionKeyMap = {
     designProperties: Record<string, Record<string, string>>;
 };
@@ -85,7 +66,6 @@ export type DesignTokenValue = {
     /** Must be non-empty (min length 1) */
     value: string;
 };
-export type DesignPropertyDefinitionValue = ManualDesignValue | DesignTokenValue;
 export type DesignPropertyValue = ManualDesignValue | DesignTokenValue;
 export type DimensionedDesignPropertyValue = Record<string, DesignPropertyValue>;
 export type ComponentTreeDesignPropertyValue = DesignPropertyValue | DesignPropertyPointerValue | DimensionedDesignPropertyValue;
@@ -93,17 +73,16 @@ export type ComponentNode = {
     id: string;
     name?: string;
     nodeType: 'Component';
-    componentTypeId: string;
+    componentType: ResourceLink<'Contentful:ComponentType'>;
     contentProperties: Record<string, ContentPropertyPointerValue | unknown> | string;
     designProperties: Record<string, ComponentTreeDesignPropertyValue>;
     slots: Record<string, TreeNode[]>;
-    contentBindings?: string;
 };
 export type FragmentNode = {
     id: string;
     name?: string;
     nodeType: 'Fragment';
-    fragmentId: string;
+    fragment: ResourceLink<'Contentful:Fragment'>;
 };
 export type SlotNode = {
     id: string;
@@ -111,13 +90,22 @@ export type SlotNode = {
     slotId: string;
 };
 export type TreeNode = ComponentNode | FragmentNode | SlotNode;
-export type DataAssemblyLink = Link<'DataAssembly'>;
+export type DataAssemblyLink = ResourceLink<'Contentful:DataAssembly'>;
 export type ComponentTypeSlotDefinition = {
     id: string;
     name: string;
-    componentTypeId: string[];
     required: boolean;
-    validations: unknown[];
+    validations: Array<{
+        size?: {
+            min?: number;
+            max?: number;
+        };
+    }>;
+    allowedResources?: Array<{
+        type: 'Contentful:ComponentType';
+        source: string;
+        allowedTypes: string[];
+    }>;
 };
 export type ComponentTypeSys = {
     id: string;
@@ -153,13 +141,16 @@ export type ComponentTypeProps = {
     dataAssemblies?: DataAssemblyLink[];
     source?: ResourceLink<'Contentful:DesignSystemSource'>;
 };
-export type CreateComponentTypeProps = Except<ComponentTypeProps, 'sys'>;
-export type UpsertComponentTypeProps = Except<ComponentTypeProps, 'sys'> & {
+export type CreateComponentTypeProps = Except<ComponentTypeProps, 'sys' | 'source'> & {
+    source?: ResourceLink<'Contentful:DesignSystemSource'> | null;
+};
+export type UpsertComponentTypeProps = Except<ComponentTypeProps, 'sys' | 'source'> & {
     sys: {
         id: string;
         type: 'ComponentType';
         version?: number;
     };
+    source?: ResourceLink<'Contentful:DesignSystemSource'> | null;
 };
 export type ComponentTypeCollection = ExoCursorPaginatedCollectionProp<ComponentTypeProps>;
 export {};

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

@@ -1,19 +1,9 @@
-import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, Link, MetadataProps, ResourceLink } from '../common-types';
-export type DataAssemblyPrimitiveDataTypeField = {
+import type { CursorPaginationParams, DataTypeDefinition, ExoCursorPaginatedCollectionProp, Link, MetadataProps, PointerExpressionValue, ResourceLink } from '../common-types';
+export type DataAssemblyDataTypeField = DataTypeDefinition & {
     id: string;
     name: string;
-    type: string;
-    required: boolean;
     source?: string;
 };
-export type DataAssemblyTypeRefDataTypeField = {
-    id: string;
-    name: string;
-    type: 'TypeRef';
-    ref: ResourceLink<'Contentful:DataAssembly'>;
-    required: boolean;
-};
-export type DataAssemblyDataTypeField = DataAssemblyPrimitiveDataTypeField | DataAssemblyTypeRefDataTypeField;
 export type DataAssemblyLinkParameter = {
     name?: string;
     description?: string;
@@ -36,33 +26,16 @@ export type DataAssemblyParameterConfig = Record<string, DataAssemblyLinkParamet
 export type DataAssemblyGraphQLResolver = {
     source: 'Contentful:GraphQL';
     query: string;
-    parameters?: Record<string, unknown>;
+    parameters?: PointerExpressionValue;
 };
 export type DataAssemblyNestedResolver = {
     source: 'Contentful:DataAssembly';
     dataAssembly: ResourceLink<'Contentful:DataAssembly'>;
-    parameters?: Record<string, unknown>;
+    parameters?: PointerExpressionValue;
 };
 export type DataAssemblyResolverDefinition = DataAssemblyGraphQLResolver | DataAssemblyNestedResolver;
 export type DataAssemblyResolverConfig = Record<string, DataAssemblyResolverDefinition>;
-export type DataAssemblyReturnMappingSelectValue = string | {
-    $on: {
-        type: Record<string, DataAssemblyReturnMappingSelectValue>;
-        default?: DataAssemblyReturnMappingSelectValue;
-    };
-} | {
-    [key: string]: DataAssemblyReturnMappingSelectValue;
-};
-export type DataAssemblyReturnMappingFromObject = {
-    $from: {
-        source: string;
-        select?: DataAssemblyReturnMappingSelectValue;
-    };
-};
-export type DataAssemblyReturnMappingValue = string | DataAssemblyReturnMappingFromObject | {
-    [key: string]: DataAssemblyReturnMappingValue;
-};
-export type DataAssemblyReturnMappingConfig = Record<string, DataAssemblyReturnMappingValue>;
+export type DataAssemblyReturnMappingConfig = Record<string, PointerExpressionValue>;
 export type DataAssemblySys = {
     id: string;
     type: 'DataAssembly';

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

@@ -1,4 +1,4 @@
-import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExperienceMetadataProps, ExoQueryFilters, Link } from '../common-types';
+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, {
@@ -6,12 +6,8 @@ export type ExperienceDimensionKeyMap = {
     }>;
 };
 export type ExperienceContentBindings = {
-    sys: {
-        type: 'Link';
-        id: string;
-        linkType: 'DataAssembly';
-    };
-    parameters: Record<string, Link<string>>;
+    sys: ResourceLink<'Contentful:DataAssembly'>['sys'];
+    parameters: Record<string, ResourceLink<string>>;
 };
 export type ExperienceSys = {
     id: string;
@@ -19,7 +15,7 @@ export type ExperienceSys = {
     version: number;
     space: Link<'Space'>;
     environment: Link<'Environment'>;
-    template?: Link<'Template'>;
+    template: ResourceLink<'Contentful:Template'>;
     createdAt: string;
     updatedAt: string;
     createdBy: Link<'User'>;
@@ -41,7 +37,6 @@ type ExperienceCommonProps = {
     name: string;
     description: string;
     viewports: ComponentTypeViewport[];
-    contentProperties: Record<string, unknown>;
     designProperties: Record<string, DimensionedDesignPropertyValue>;
     dimensionKeyMap: ExperienceDimensionKeyMap;
     contentBindings?: ExperienceContentBindings;
@@ -60,7 +55,7 @@ export type ExperienceLocalePublishPayload = {
     remove: string[];
 };
 export type CreateExperienceProps = ExperienceCommonProps & {
-    template: Link<'Template'>;
+    template: ResourceLink<'Contentful:Template'>;
 };
 export type UpsertExperienceProps = ExperienceCommonProps & {
     sys: {
@@ -68,12 +63,12 @@ export type UpsertExperienceProps = ExperienceCommonProps & {
         type: 'Experience';
         version?: number;
     };
-    template?: Link<'Template'>;
+    template?: ResourceLink<'Contentful:Template'>;
 };
 export type InlineFragmentNode = {
     id: string;
     nodeType: 'InlineFragment';
-    componentTypeId: string;
+    componentType: ResourceLink<'Contentful:ComponentType'>;
     designProperties: Record<string, DimensionedDesignPropertyValue>;
     contentBindings?: ExperienceContentBindings;
     slots?: Record<string, Array<FragmentNode | InlineFragmentNode>>;

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

@@ -1,5 +1,5 @@
 import type { Except } from 'type-fest';
-import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExoQueryFilters, ExperienceMetadataProps, Link } from '../common-types';
+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';
 export type FragmentSys = {
@@ -8,7 +8,7 @@ export type FragmentSys = {
     version: number;
     space: Link<'Space'>;
     environment: Link<'Environment'>;
-    componentType: Link<'ComponentType'>;
+    componentType: ResourceLink<'Contentful:ComponentType'>;
     archivedAt?: string;
     archivedBy?: Link<'User'>;
     archivedVersion?: number;
@@ -37,7 +37,7 @@ export type FragmentProps = {
     slots?: Record<string, Array<FragmentNode | InlineFragmentNode>>;
 };
 export type CreateFragmentProps = Except<FragmentProps, 'sys'> & {
-    componentType: Link<'ComponentType'>;
+    componentType: ResourceLink<'Contentful:ComponentType'>;
 };
 export type UpdateFragmentProps = Omit<FragmentProps, 'sys'> & {
     sys: {
@@ -45,6 +45,7 @@ export type UpdateFragmentProps = Omit<FragmentProps, 'sys'> & {
         type: 'Fragment';
         version: number;
     };
+    componentType?: ResourceLink<'Contentful:ComponentType'>;
 };
 export type FragmentQueryOptions = CursorPaginationParams & ExoQueryFilters & {
     order?: string;

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

@@ -89,4 +89,4 @@ export type { ComponentTypeCollection } from './entities/component-type';
 export type { TemplateCollection } from './entities/template';
 export type { ExperienceCollection, ReleaseExperience, ReleaseExperienceCollection, ReleaseExperienceSys, } from './entities/experience';
 export type { FragmentCollection } from './entities/fragment';
-export type { DataAssemblyCollection, DataAssemblyResourceLinkParameter, DataAssemblyReturnMappingFromObject, DataAssemblyReturnMappingSelectValue, } from './entities/data-assembly';
+export type { DataAssemblyCollection, DataAssemblyResourceLinkParameter, } from './entities/data-assembly';

package/package.json

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