contentful-management 12.4.0 → 12.6.0-dev.1

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

@@ -1,8 +1,7 @@
-import type { Link, MetadataProps, SysLink } from '../common-types';
-export type ComponentTypeQueryOptions = {
-    _experienceCtId: string;
-    skip?: number;
-    limit?: number;
+import type { Except } from 'type-fest';
+import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExoMetadataProps, ExoQueryFilters, Link, ResourceLink } from '../common-types';
+export type ComponentTypeQueryOptions = CursorPaginationParams & ExoQueryFilters & {
+    order?: string;
 };
 export type ComponentTypeViewport = {
     id: string;
@@ -10,76 +9,109 @@ export type ComponentTypeViewport = {
     displayName: string;
     previewSize: string;
 };
-export type ComponentTypeContentProperty = {
+export type ComponentTypePrimitiveContentProperty = {
     id: string;
     name: string;
-    type: 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;
-    description?: string;
+    name?: string;
+} | {
+    type: 'DesignToken';
+    value: string;
+    name?: string;
+};
+export type StringDesignPropertyRegexpValidation = {
+    regexp: {
+        pattern: string;
+    };
+};
+export type DesignTokenAllowedResource = {
+    type: 'DesignToken';
+    value: string;
+    name?: string;
 };
-export type ComponentTypeDesignProperty = {
+export type DTCGDesignPropertyType = 'DTCG.Color' | 'DTCG.Dimension' | 'DTCG.FontFamily' | 'DTCG.FontWeight' | 'DTCG.Duration' | 'DTCG.CubicBezier' | 'DTCG.Number' | 'DTCG.StrokeStyle' | 'DTCG.Border' | 'DTCG.Transition' | 'DTCG.Shadow' | 'DTCG.Gradient' | 'DTCG.Typography';
+type DesignPropertyCommonFields = {
     id: string;
     name: string;
-    type: string;
     required: boolean;
     description?: string;
-    defaultValue?: unknown;
+};
+export type LegacyDesignProperty = DesignPropertyCommonFields & {
+    type: 'Symbol' | 'Number' | 'Boolean';
+    defaultValue?: DesignPropertyDefinitionValue;
     validations?: {
-        in: ComponentTypeDesignPropertyValidation[];
+        in?: ComponentTypeDesignPropertyValidation[];
     };
-    designTokenSet?: string[];
 };
+export type StringDesignProperty = DesignPropertyCommonFields & {
+    type: 'String';
+    defaultValue?: {
+        type: 'ManualDesignValue';
+        value: string;
+    };
+    validations?: StringDesignPropertyRegexpValidation[];
+};
+export type TokenBackedDesignProperty = DesignPropertyCommonFields & {
+    type: DTCGDesignPropertyType;
+    defaultValue?: DesignTokenValue;
+    allowedResources?: DesignTokenAllowedResource[];
+};
+export type ComponentTypeDesignProperty = LegacyDesignProperty | StringDesignProperty | TokenBackedDesignProperty;
 export type ComponentTypeDimensionKeyMap = {
     designProperties: Record<string, Record<string, string>>;
 };
-export type ContentPropertyPointerValue = `$contentProperties/${string}` | `$contentBindings/${string}`;
+export type ContentPropertyPointerValue = `$contentProperties/${string}`;
 export type DesignPropertyPointerValue = `$designProperties/${string}`;
 export type ManualDesignValue = {
     type: 'ManualDesignValue';
-    value: string | number | boolean | Record<string, unknown>;
+    value: string | number | boolean;
 };
 export type DesignTokenValue = {
-    type: 'DesignValue';
-    token: string;
-};
-export type DesignPropertyValue = ManualDesignValue | DesignTokenValue | DesignPropertyPointerValue | Record<string, ManualDesignValue | DesignTokenValue | DesignPropertyPointerValue>;
+    type: 'DesignToken';
+    /** 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;
 export type ComponentNode = {
     id: string;
+    name?: string;
     nodeType: 'Component';
     componentTypeId: string;
-    contentProperties: Record<string, ContentPropertyPointerValue | unknown>;
-    designProperties: Record<string, DesignPropertyValue>;
+    contentProperties: Record<string, ContentPropertyPointerValue | unknown> | string;
+    designProperties: Record<string, ComponentTreeDesignPropertyValue>;
     slots: Record<string, TreeNode[]>;
     contentBindings?: string;
 };
-export type ViewNode = {
+export type FragmentNode = {
     id: string;
-    nodeType: 'View';
-    viewId: string;
+    name?: string;
+    nodeType: 'Fragment';
+    fragmentId: string;
 };
 export type SlotNode = {
     id: string;
     nodeType: 'Slot';
     slotId: string;
 };
-export type TreeNode = ComponentNode | ViewNode | SlotNode;
-export type ComponentTypeDataTypeField = {
-    id: string;
-    name: string;
-    type: string;
-    required: boolean;
-    source?: string;
-};
+export type TreeNode = ComponentNode | FragmentNode | SlotNode;
 export type DataAssemblyLink = Link<'DataAssembly'>;
-export type ComponentTypeContentBindings = DataAssemblyLink['sys'] & {
-    required: boolean;
-    dataType: ComponentTypeDataTypeField[];
-};
 export type ComponentTypeSlotDefinition = {
     id: string;
     name: string;
@@ -91,8 +123,8 @@ export type ComponentTypeSys = {
     id: string;
     type: 'ComponentType';
     version: number;
-    space: SysLink;
-    environment: SysLink;
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
     fieldStatus?: Record<string, Record<string, 'draft' | 'published' | 'changed'>>;
     publishedAt?: string;
     publishedVersion?: number;
@@ -100,10 +132,12 @@ export type ComponentTypeSys = {
     firstPublishedAt?: string;
     publishedBy?: Link<'User'> | Link<'AppDefinition'>;
     variant?: string;
-    createdAt?: string;
-    createdBy?: Link<'User'>;
-    updatedAt?: string;
-    updatedBy?: Link<'User'>;
+    variantType?: string;
+    variantDimension?: string;
+    createdAt: string;
+    createdBy: Link<'User'>;
+    updatedAt: string;
+    updatedBy: Link<'User'>;
 };
 export type ComponentTypeProps = {
     sys: ComponentTypeSys;
@@ -114,8 +148,18 @@ export type ComponentTypeProps = {
     designProperties: ComponentTypeDesignProperty[];
     dimensionKeyMap: ComponentTypeDimensionKeyMap;
     componentTree?: TreeNode[];
-    contentBindings?: ComponentTypeContentBindings;
     slots?: ComponentTypeSlotDefinition[];
-    metadata?: MetadataProps;
+    metadata?: ExoMetadataProps;
     dataAssemblies?: DataAssemblyLink[];
+    source?: ResourceLink<'Contentful:DesignSystemSource'>;
+};
+export type CreateComponentTypeProps = Except<ComponentTypeProps, 'sys'>;
+export type UpsertComponentTypeProps = Except<ComponentTypeProps, 'sys'> & {
+    sys: {
+        id: string;
+        type: 'ComponentType';
+        version?: number;
+    };
 };
+export type ComponentTypeCollection = ExoCursorPaginatedCollectionProp<ComponentTypeProps>;
+export {};

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

@@ -0,0 +1,119 @@
+import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, Link, MetadataProps, ResourceLink } from '../common-types';
+export type DataAssemblyPrimitiveDataTypeField = {
+    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;
+    type: 'Link';
+    linkType: string;
+    allowedContentTypes: string[];
+};
+export type DataAssemblyResourceLinkParameter = {
+    name?: string;
+    description?: string;
+    type: 'ResourceLink';
+    linkType: string;
+    allowedResources: Array<{
+        type: string;
+        source: string;
+        allowedTypes: string[];
+    }>;
+};
+export type DataAssemblyParameterConfig = Record<string, DataAssemblyLinkParameter | DataAssemblyResourceLinkParameter>;
+export type DataAssemblyGraphQLResolver = {
+    source: 'Contentful:GraphQL';
+    query: string;
+    parameters?: Record<string, unknown>;
+};
+export type DataAssemblyNestedResolver = {
+    source: 'Contentful:DataAssembly';
+    dataAssembly: ResourceLink<'Contentful:DataAssembly'>;
+    parameters?: Record<string, unknown>;
+};
+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 DataAssemblySys = {
+    id: string;
+    type: 'DataAssembly';
+    dataType: DataAssemblyDataTypeField[];
+    version: number;
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+    createdBy: Link<'User'>;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    updatedBy?: Link<'User'>;
+    publishedAt?: string | Date;
+    publishedVersion?: number;
+    publishedCounter?: number;
+    firstPublishedAt?: string | Date;
+    publishedBy?: Link<'User'> | Link<'AppDefinition'>;
+    variant?: string;
+};
+type DataAssemblyCommonProps = {
+    metadata: Pick<MetadataProps, 'tags'>;
+    name: string;
+    description: string;
+    parameters: DataAssemblyParameterConfig;
+    resolvers: DataAssemblyResolverConfig;
+    return: DataAssemblyReturnMappingConfig;
+};
+export type DataAssemblyProps = DataAssemblyCommonProps & {
+    sys: DataAssemblySys;
+};
+export type CreateDataAssemblyProps = DataAssemblyCommonProps & {
+    sys: {
+        type: 'DataAssembly';
+        variant?: string;
+        dataType: DataAssemblyDataTypeField[];
+    };
+};
+export type UpdateDataAssemblyProps = DataAssemblyCommonProps & {
+    sys: {
+        id: string;
+        type: 'DataAssembly';
+        variant?: string;
+        version: number;
+        dataType: DataAssemblyDataTypeField[];
+    };
+};
+export type DataAssemblyQueryOptions = CursorPaginationParams & {
+    'sys.id[in]'?: string;
+};
+export type DataAssemblyCollection = ExoCursorPaginatedCollectionProp<DataAssemblyProps> & {
+    errors?: {
+        notFoundIds: string[];
+    };
+};
+export {};

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

@@ -0,0 +1,89 @@
+import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExperienceMetadataProps, ExoQueryFilters, Link } from '../common-types';
+import type { ComponentTypeViewport, DimensionedDesignPropertyValue, FragmentNode } from './component-type';
+export type ExperienceDimensionKeyMap = {
+    designProperties: Record<string, {
+        breakpoint: string;
+    }>;
+};
+export type ExperienceContentBindings = {
+    sys: {
+        type: 'Link';
+        id: string;
+        linkType: 'DataAssembly';
+    };
+    parameters: Record<string, Link<string>>;
+};
+export type ExperienceSys = {
+    id: string;
+    type: 'Experience';
+    version: number;
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+    template?: Link<'Template'>;
+    createdAt: string;
+    updatedAt: string;
+    createdBy: Link<'User'>;
+    updatedBy: Link<'User'>;
+    archivedAt?: string;
+    archivedBy?: Link<'User'>;
+    archivedVersion?: number;
+    variant?: string;
+    variantType?: string;
+    variantDimension?: string;
+    publishedAt?: string;
+    publishedVersion?: number;
+    publishedCounter?: number;
+    firstPublishedAt?: string;
+    publishedBy?: Link<'User'> | Link<'AppDefinition'>;
+    localeStatus?: Record<string, 'draft' | 'published' | 'changed'>;
+};
+type ExperienceCommonProps = {
+    name: string;
+    description: string;
+    viewports: ComponentTypeViewport[];
+    contentProperties: Record<string, unknown>;
+    designProperties: Record<string, DimensionedDesignPropertyValue>;
+    dimensionKeyMap: ExperienceDimensionKeyMap;
+    contentBindings?: ExperienceContentBindings;
+    metadata?: ExperienceMetadataProps;
+    slots?: Record<string, Array<FragmentNode | InlineFragmentNode>>;
+};
+export type ExperienceProps = ExperienceCommonProps & {
+    sys: ExperienceSys;
+};
+export type ExperienceQueryOptions = CursorPaginationParams & ExoQueryFilters & {
+    order?: string;
+};
+export type ExperienceLocalePublishPayload = {
+    add: string[];
+} | {
+    remove: string[];
+};
+export type CreateExperienceProps = ExperienceCommonProps & {
+    template: Link<'Template'>;
+};
+export type UpsertExperienceProps = ExperienceCommonProps & {
+    sys: {
+        id: string;
+        type: 'Experience';
+        version?: number;
+    };
+    template?: Link<'Template'>;
+};
+export type InlineFragmentNode = {
+    id: string;
+    nodeType: 'InlineFragment';
+    componentTypeId: string;
+    designProperties: Record<string, DimensionedDesignPropertyValue>;
+    contentBindings?: ExperienceContentBindings;
+    slots?: Record<string, Array<FragmentNode | InlineFragmentNode>>;
+};
+export type ExperienceCollection = ExoCursorPaginatedCollectionProp<ExperienceProps>;
+export type ReleaseExperienceSys = Omit<ExperienceSys, 'variant' | 'variantType' | 'variantDimension'> & {
+    release: Link<'Release'>;
+};
+export type ReleaseExperience = Omit<ExperienceProps, 'sys'> & {
+    sys: ReleaseExperienceSys;
+};
+export type ReleaseExperienceCollection = ExoCursorPaginatedCollectionProp<ReleaseExperience>;
+export {};

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

@@ -0,0 +1,52 @@
+import type { Except } from 'type-fest';
+import type { CursorPaginationParams, ExoCursorPaginatedCollectionProp, ExoQueryFilters, ExperienceMetadataProps, Link } from '../common-types';
+import type { ComponentTypeViewport, DimensionedDesignPropertyValue, FragmentNode } from './component-type';
+import type { ExperienceContentBindings, ExperienceDimensionKeyMap, InlineFragmentNode } from './experience';
+export type FragmentSys = {
+    id: string;
+    type: 'Fragment';
+    version: number;
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+    componentType: Link<'ComponentType'>;
+    archivedAt?: string;
+    archivedBy?: Link<'User'>;
+    archivedVersion?: number;
+    createdAt: string;
+    updatedAt: string;
+    createdBy: Link<'User'>;
+    updatedBy: Link<'User'>;
+    variant?: string;
+    variantType?: string;
+    variantDimension?: string;
+    publishedAt?: string;
+    publishedVersion?: number;
+    publishedCounter?: number;
+    firstPublishedAt?: string;
+    publishedBy?: Link<'User'> | Link<'AppDefinition'>;
+};
+export type FragmentProps = {
+    sys: FragmentSys;
+    name: string;
+    description: string;
+    viewports: ComponentTypeViewport[];
+    designProperties: Record<string, DimensionedDesignPropertyValue>;
+    dimensionKeyMap: ExperienceDimensionKeyMap;
+    contentBindings?: ExperienceContentBindings;
+    metadata?: ExperienceMetadataProps;
+    slots?: Record<string, Array<FragmentNode | InlineFragmentNode>>;
+};
+export type CreateFragmentProps = Except<FragmentProps, 'sys'> & {
+    componentType: Link<'ComponentType'>;
+};
+export type UpdateFragmentProps = Omit<FragmentProps, 'sys'> & {
+    sys: {
+        id: string;
+        type: 'Fragment';
+        version: number;
+    };
+};
+export type FragmentQueryOptions = CursorPaginationParams & ExoQueryFilters & {
+    order?: string;
+};
+export type FragmentCollection = ExoCursorPaginatedCollectionProp<FragmentProps>;

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

@@ -1,5 +1,15 @@
 import type { BasicMetaSysProps, DefaultElements, MakeRequest } from '../common-types';
 import type { ContentfulSpaceAPI } from '../create-space-api';
+export type SpaceLicenseProps = {
+    sys: {
+        type: 'SpaceLicense';
+        id: string;
+    };
+    isTrial: boolean;
+    expiresAt: string;
+    productId: string;
+    productName: string;
+};
 export type SpaceProps = {
     sys: BasicMetaSysProps & {
         organization: {
@@ -8,9 +18,22 @@ export type SpaceProps = {
             };
         };
         archivedAt?: string;
+        license?: {
+            sys: {
+                type: 'Link';
+                linkType: 'SpaceLicense';
+                id: string;
+            };
+        };
     };
     name: string;
 };
+export type SpaceIncludes = {
+    SpaceLicense?: SpaceLicenseProps[];
+};
+export type SpaceIncludeParam = {
+    include?: 'sys.license';
+};
 export type UnarchiveProps = {
     productId: string;
 };

package/dist/types/entities/space.js.map

@@ -1 +1 @@
-{"version":3,"file":"space.js","sources":["../../../lib/entities/space.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAmBA;;;;;;;;;AASG;AACG,SAAU,SAAS,CAAC,WAAwB,EAAE,IAAgB,EAAA;IAClE,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvC,IAAA,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,CAAC;IAC5C,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC;AACzD,IAAA,OAAO,SAAS,CAAC,aAAa,CAAC;AACjC;AAEA;;;;AAIG;MACU,mBAAmB,GAAG,cAAc,CAAC,SAAS;MAC9C,kCAAkC,GAAG,6BAA6B,CAAC,SAAS;;;;"}
+{"version":3,"file":"space.js","sources":["../../../lib/entities/space.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAwCA;;;;;;;;;AASG;AACG,SAAU,SAAS,CAAC,WAAwB,EAAE,IAAgB,EAAA;IAClE,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACvC,IAAA,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,CAAC;IAC5C,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC;AACzD,IAAA,OAAO,SAAS,CAAC,aAAa,CAAC;AACjC;AAEA;;;;AAIG;MACU,mBAAmB,GAAG,cAAc,CAAC,SAAS;MAC9C,kCAAkC,GAAG,6BAA6B,CAAC,SAAS;;;;"}

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

@@ -0,0 +1,48 @@
+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';
+export type TemplateSys = {
+    id: string;
+    type: 'Template';
+    version: number;
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+    fieldStatus?: Record<string, Record<string, 'draft' | 'published' | 'changed'>>;
+    publishedAt?: string;
+    publishedVersion?: number;
+    publishedCounter?: number;
+    firstPublishedAt?: string;
+    publishedBy?: Link<'User'> | Link<'AppDefinition'>;
+    variant?: string;
+    variantType?: string;
+    variantDimension?: string;
+    createdAt: string;
+    createdBy: Link<'User'>;
+    updatedAt: string;
+    updatedBy: Link<'User'>;
+};
+export type TemplateProps = {
+    sys: TemplateSys;
+    name: string;
+    description: string;
+    viewports: ComponentTypeViewport[];
+    contentProperties: ComponentTypeContentProperty[];
+    designProperties: ComponentTypeDesignProperty[];
+    dimensionKeyMap: ComponentTypeDimensionKeyMap;
+    componentTree?: TreeNode[];
+    slots?: ComponentTypeSlotDefinition[];
+    metadata?: ExoMetadataProps;
+    dataAssemblies?: DataAssemblyLink[];
+};
+export type CreateTemplateProps = Except<TemplateProps, 'sys'>;
+export type UpsertTemplateProps = Except<TemplateProps, 'sys'> & {
+    sys: {
+        id: string;
+        type: 'Template';
+        version?: number;
+    };
+};
+export type TemplateQueryOptions = CursorPaginationParams & ExoQueryFilters & {
+    order?: string;
+};
+export type TemplateCollection = ExoCursorPaginatedCollectionProp<TemplateProps>;

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

@@ -85,3 +85,8 @@ export type { SemanticSearchProps, SemanticSearch } from './entities/semantic-se
 export type { DefinedParameters, FreeFormParameters, InstallationParameterType, ParameterDefinition, ParameterOption, ParameterType, } from './entities/widget-parameters';
 export type { CreateWorkflowProps, DeleteWorkflowParams, UpdateWorkflowProps, Workflow, WorkflowProps, WorkflowQueryOptions, } from './entities/workflow';
 export type { WorkflowsChangelogEntry, WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions, } from './entities/workflows-changelog-entry';
+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';