@contentchef/contentchef-types 11.1.0-alpha.1 → 11.1.0-alpha.3

package/dist/api/Component.d.ts

@@ -309,7 +309,7 @@ export declare enum ComponentVersionViolationCodes {
      */
     compactOrFacet = "component.compactOrFacet",
     /**
-     * A kept field may only change its texts, or loosen its constraints
+     * A kept field may only change its texts and `describes`, or loosen its constraints
      */
     notLooser = "component.notLooser",
     /**
@@ -392,8 +392,8 @@ export type ComponentError = ComponentErrorOf<ComponentErrorTypes.componentNotFo
     id: MigrationPreviewId;
 }>;
 /**
- * This type represent where a definition's contents stand, as the get content definition API request
- * answers it
+ * This type represent where a definition's contents stand, as the get content definition, update content
+ * definition and get migration API requests answer it
  *
  * An upgrade or adoption that renames, removes or retypes fields bumps the definition's revision and
  * migrates its contents in the background, one migration at a time per definition
@@ -558,6 +558,19 @@ export type GetMigrationPreviewResponse = {
      */
     settingAside: number;
 };
+/**
+ * This type represent the data needed to make a get migration API request
+ */
+export type GetMigrationRequest = {
+    /**
+     * The content definition unique id
+     */
+    id: ContentDefinitionId;
+};
+/**
+ * This type represent the response of a get migration API request, to poll while a migration runs
+ */
+export type GetMigrationResponse = DefinitionMigrationState;
 /**
  * This type represent the data needed to make a resume migration API request
  */

package/dist/api/Component.js

@@ -42,7 +42,7 @@ var ComponentVersionViolationCodes;
      */
     ComponentVersionViolationCodes["compactOrFacet"] = "component.compactOrFacet";
     /**
-     * A kept field may only change its texts, or loosen its constraints
+     * A kept field may only change its texts and `describes`, or loosen its constraints
      */
     ComponentVersionViolationCodes["notLooser"] = "component.notLooser";
     /**

package/dist/api/Content.d.ts

@@ -683,7 +683,12 @@ export type CreateContentResponse = ContentResponse;
 /**
  * This type represent the response of an update content API request
  */
-export type UpdateContentResponse = ContentResponse;
+export type UpdateContentResponse = ContentResponse & {
+    /**
+     * The values set aside left to resolve after the save, so a form need not read the content again
+     */
+    setAside: SetAsideValue[];
+};
 /**
  * This type represent the data needed to make a list public id API request
  */

package/dist/api/ContentDefinition.d.ts

@@ -207,7 +207,12 @@ export type CreateContentDefinitionResponse = ContentDefinitionResponse;
 /**
  * This type represent the response of an update content definition API request
  */
-export type UpdateContentDefinitionResponse = ContentDefinitionResponse;
+export type UpdateContentDefinitionResponse = ContentDefinitionResponse & {
+    /**
+     * Where the definition's contents stand: a save that started a migration has them all behind
+     */
+    migration: DefinitionMigrationState;
+};
 /**
  * This type represent the response of a get content definition API request
  */
@@ -425,5 +430,8 @@ export declare enum SchemaFieldViolationCodes {
     variantTypeNotAllowed = "variantTypeNotAllowed",
     componentArchived = "componentArchived",
     componentNotPublished = "componentNotPublished",
-    invalidComponentMarker = "invalidComponentMarker"
+    invalidComponentMarker = "invalidComponentMarker",
+    invalidDescribes = "invalidDescribes",
+    describesUnknownField = "describesUnknownField",
+    describesUnsupportedField = "describesUnsupportedField"
 }

package/dist/api/ContentDefinition.js

@@ -49,4 +49,7 @@ var SchemaFieldViolationCodes;
     SchemaFieldViolationCodes["componentArchived"] = "componentArchived";
     SchemaFieldViolationCodes["componentNotPublished"] = "componentNotPublished";
     SchemaFieldViolationCodes["invalidComponentMarker"] = "invalidComponentMarker";
+    SchemaFieldViolationCodes["invalidDescribes"] = "invalidDescribes";
+    SchemaFieldViolationCodes["describesUnknownField"] = "describesUnknownField";
+    SchemaFieldViolationCodes["describesUnsupportedField"] = "describesUnsupportedField";
 })(SchemaFieldViolationCodes || (exports.SchemaFieldViolationCodes = SchemaFieldViolationCodes = {}));

package/dist/api/ContentDefinitionSchema.d.ts

@@ -448,16 +448,40 @@ export type IndexableSchemaType<T, C> = SchemaType<T, C> & IndexingConf;
  * @template T Type of the field
  */
 export type TranslatableSchemaType<T extends SchemaType<any, any>> = T & TranslatableConf;
+/**
+ * This type represent the image a text field describes, so that the content form can generate its text
+ * with the space's model. The value stays plain text
+ */
+export type Describes = {
+    /**
+     * A sibling field of the same fields list, of type `media` with `constraints.type` `image`
+     */
+    field: string;
+    /**
+     * `altText` is written with fixed alt text rules, `description` following `instructions`
+     */
+    as: 'altText' | 'description';
+    /**
+     * With `description` only, at most 2000 characters, written for the model by the definition's author
+     */
+    instructions?: string;
+};
+/**
+ * Not admitted on an array's `items`, which have no siblings
+ */
+export type DescribingConf = {
+    describes?: Describes;
+};
 /**
  * This type represent a text field schema type
- * A text field can be indexed, searched when requesting the content and localized
+ * A text field can be indexed, searched when requesting the content, localized and describe an image
  */
-export type TextSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.TEXT, TextFieldConstraints>>;
+export type TextSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.TEXT, TextFieldConstraints>> & DescribingConf;
 /**
  * This type represent a long text field schema type
- * A long text field can be indexed, searched when requesting the content and localized
+ * A long text field can be indexed, searched when requesting the content, localized and describe an image
  */
-export type LongTextSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.LONG_TEXT, LongTextFieldConstraints>>;
+export type LongTextSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.LONG_TEXT, LongTextFieldConstraints>> & DescribingConf;
 /**
  * This type represent a linked content field schema type
  * A linked content field can be indexed and searched when requesting the content

package/lib/api/Component.ts

@@ -337,7 +337,7 @@ export enum ComponentVersionViolationCodes {
      */
     compactOrFacet = 'component.compactOrFacet',
     /**
-     * A kept field may only change its texts, or loosen its constraints
+     * A kept field may only change its texts and `describes`, or loosen its constraints
      */
     notLooser = 'component.notLooser',
     /**
@@ -409,8 +409,8 @@ export type ComponentError =
     | ComponentErrorOf<ComponentErrorTypes.migrationPreviewNotFound, { id: MigrationPreviewId }>;
 
 /**
- * This type represent where a definition's contents stand, as the get content definition API request
- * answers it
+ * This type represent where a definition's contents stand, as the get content definition, update content
+ * definition and get migration API requests answer it
  *
  * An upgrade or adoption that renames, removes or retypes fields bumps the definition's revision and
  * migrates its contents in the background, one migration at a time per definition
@@ -576,6 +576,21 @@ export type GetMigrationPreviewResponse = {
     settingAside: number;
 };
 
+/**
+ * This type represent the data needed to make a get migration API request
+ */
+export type GetMigrationRequest = {
+    /**
+     * The content definition unique id
+     */
+    id: ContentDefinitionId;
+};
+
+/**
+ * This type represent the response of a get migration API request, to poll while a migration runs
+ */
+export type GetMigrationResponse = DefinitionMigrationState;
+
 /**
  * This type represent the data needed to make a resume migration API request
  */

package/lib/api/Content.ts

@@ -745,7 +745,12 @@ export type CreateContentResponse = ContentResponse;
 /**
  * This type represent the response of an update content API request
  */
-export type UpdateContentResponse = ContentResponse;
+export type UpdateContentResponse = ContentResponse & {
+  /**
+   * The values set aside left to resolve after the save, so a form need not read the content again
+   */
+  setAside: SetAsideValue[];
+};
 
 /**
  * This type represent the data needed to make a list public id API request

package/lib/api/ContentDefinition.ts

@@ -224,7 +224,12 @@ export type CreateContentDefinitionResponse = ContentDefinitionResponse;
 /**
  * This type represent the response of an update content definition API request
  */
-export type UpdateContentDefinitionResponse = ContentDefinitionResponse;
+export type UpdateContentDefinitionResponse = ContentDefinitionResponse & {
+    /**
+     * Where the definition's contents stand: a save that started a migration has them all behind
+     */
+    migration: DefinitionMigrationState;
+};
 /**
  * This type represent the response of a get content definition API request
  */
@@ -454,5 +459,8 @@ export enum SchemaFieldViolationCodes {
     variantTypeNotAllowed = 'variantTypeNotAllowed',
     componentArchived = 'componentArchived',
     componentNotPublished = 'componentNotPublished',
-    invalidComponentMarker = 'invalidComponentMarker'
+    invalidComponentMarker = 'invalidComponentMarker',
+    invalidDescribes = 'invalidDescribes',
+    describesUnknownField = 'describesUnknownField',
+    describesUnsupportedField = 'describesUnsupportedField'
 }

package/lib/api/ContentDefinitionSchema.ts

@@ -487,16 +487,42 @@ export type IndexableSchemaType<T, C> = SchemaType<T, C> & IndexingConf;
  */
 export type TranslatableSchemaType<T extends SchemaType<any, any>> = T & TranslatableConf;
 
+/**
+ * This type represent the image a text field describes, so that the content form can generate its text
+ * with the space's model. The value stays plain text
+ */
+export type Describes = {
+    /**
+     * A sibling field of the same fields list, of type `media` with `constraints.type` `image`
+     */
+    field: string;
+    /**
+     * `altText` is written with fixed alt text rules, `description` following `instructions`
+     */
+    as: 'altText' | 'description';
+    /**
+     * With `description` only, at most 2000 characters, written for the model by the definition's author
+     */
+    instructions?: string;
+};
+
+/**
+ * Not admitted on an array's `items`, which have no siblings
+ */
+export type DescribingConf = {
+    describes?: Describes;
+};
+
 /**
  * This type represent a text field schema type
- * A text field can be indexed, searched when requesting the content and localized
+ * A text field can be indexed, searched when requesting the content, localized and describe an image
  */
-export type TextSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.TEXT, TextFieldConstraints>>;
+export type TextSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.TEXT, TextFieldConstraints>> & DescribingConf;
 /**
  * This type represent a long text field schema type
- * A long text field can be indexed, searched when requesting the content and localized
+ * A long text field can be indexed, searched when requesting the content, localized and describe an image
  */
-export type LongTextSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.LONG_TEXT, LongTextFieldConstraints>>;
+export type LongTextSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.LONG_TEXT, LongTextFieldConstraints>> & DescribingConf;
 /**
  * This type represent a linked content field schema type
  * A linked content field can be indexed and searched when requesting the content

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "11.1.0-alpha.1",
+  "version": "11.1.0-alpha.3",
   "description": "ContentChef types",
   "author": "PierpaoloIannone <piannone@byte-code.com>",
   "homepage": "https://github.com/ContentChef/contentchef-management-js-client#readme",
@@ -34,5 +34,5 @@
   "devDependencies": {
     "typescript": "^5.9.3"
   },
-  "gitHead": "8970d38d1236984dee510da19687d73078f76a70"
+  "gitHead": "0887d17c48dd6a544fb97cf43a8f30a7f86126c4"
 }