@contentchef/contentchef-types 11.0.0-alpha.0 → 11.0.0-alpha.1

package/dist/api/Content.d.ts

@@ -769,7 +769,9 @@ export declare enum ContentFieldViolationCodes {
     textFieldPatternNotMatched = "textField.patternNotMatched",
     textFieldValueMissingInListOfValue = "textField.valueMissingInListOfValue",
     textFieldValueIsNotAString = "textField.valueIsNotAString",
-    textFieldBlankValueNotAllowed = "textField.blankValueNotAllowed"
+    textFieldBlankValueNotAllowed = "textField.blankValueNotAllowed",
+    segmentedFieldValueIsNotSegmented = "segmentedField.valueIsNotSegmented",
+    segmentedFieldSegmentNotDeclared = "segmentedField.segmentNotDeclared"
 }
 /**
  * Request type for getContentStatus

package/dist/api/Content.js

@@ -86,6 +86,8 @@ var ContentFieldViolationCodes;
     ContentFieldViolationCodes["textFieldValueMissingInListOfValue"] = "textField.valueMissingInListOfValue";
     ContentFieldViolationCodes["textFieldValueIsNotAString"] = "textField.valueIsNotAString";
     ContentFieldViolationCodes["textFieldBlankValueNotAllowed"] = "textField.blankValueNotAllowed";
+    ContentFieldViolationCodes["segmentedFieldValueIsNotSegmented"] = "segmentedField.valueIsNotSegmented";
+    ContentFieldViolationCodes["segmentedFieldSegmentNotDeclared"] = "segmentedField.segmentNotDeclared";
 })(ContentFieldViolationCodes || (exports.ContentFieldViolationCodes = ContentFieldViolationCodes = {}));
 var LocalizationSettings;
 (function (LocalizationSettings) {

package/dist/api/ContentDefinition.d.ts

@@ -366,6 +366,7 @@ export declare enum SchemaFieldViolationCodes {
     invalidNumberValueInList = "invalidNumberValueInList",
     invalidArrayValue = "invalidArrayValue",
     invalidEmptyArray = "invalidEmptyArray",
+    invalidEmptyObject = "invalidEmptyObject",
     invalidListOfValuesValue = "invalidListOfValuesValue",
     fragmentNameNotFound = "fragmentNameNotFound",
     fragmentNameAlreadyInUse = "fragmentNameAlreadyInUse",
@@ -387,5 +388,7 @@ export declare enum SchemaFieldViolationCodes {
     extensionNotSupportedForType = "extensionNotSupportedForType",
     translatableNotAllowed = "translatableNotAllowed",
     invalidEnumValue = "invalidEnumValue",
-    compactCannotBeNested = "compactCannotBeNested"
+    compactCannotBeNested = "compactCannotBeNested",
+    segmentTypeNotAllowed = "segmentTypeNotAllowed",
+    segmentNameNotFound = "segmentNameNotFound"
 }

package/dist/api/ContentDefinition.js

@@ -22,6 +22,7 @@ var SchemaFieldViolationCodes;
     SchemaFieldViolationCodes["invalidNumberValueInList"] = "invalidNumberValueInList";
     SchemaFieldViolationCodes["invalidArrayValue"] = "invalidArrayValue";
     SchemaFieldViolationCodes["invalidEmptyArray"] = "invalidEmptyArray";
+    SchemaFieldViolationCodes["invalidEmptyObject"] = "invalidEmptyObject";
     SchemaFieldViolationCodes["invalidListOfValuesValue"] = "invalidListOfValuesValue";
     SchemaFieldViolationCodes["fragmentNameNotFound"] = "fragmentNameNotFound";
     SchemaFieldViolationCodes["fragmentNameAlreadyInUse"] = "fragmentNameAlreadyInUse";
@@ -44,4 +45,6 @@ var SchemaFieldViolationCodes;
     SchemaFieldViolationCodes["translatableNotAllowed"] = "translatableNotAllowed";
     SchemaFieldViolationCodes["invalidEnumValue"] = "invalidEnumValue";
     SchemaFieldViolationCodes["compactCannotBeNested"] = "compactCannotBeNested";
+    SchemaFieldViolationCodes["segmentTypeNotAllowed"] = "segmentTypeNotAllowed";
+    SchemaFieldViolationCodes["segmentNameNotFound"] = "segmentNameNotFound";
 })(SchemaFieldViolationCodes || (exports.SchemaFieldViolationCodes = SchemaFieldViolationCodes = {}));

package/dist/api/ContentDefinitionSchema.d.ts

@@ -19,7 +19,8 @@ export declare enum SchemaTypeIds {
     ONE_LINKED_CONTENT_OF = "oneLinkedContentOf",
     ARRAY = "array",
     SLUG = "slug",
-    MEDIA = "media"
+    MEDIA = "media",
+    SEGMENTED = "segmented"
 }
 /**
  * This enum represent al possible long text sub types
@@ -293,6 +294,68 @@ export type OneLinkedContentOfConstraints = {
     lazy?: boolean;
     linkType?: LinkType;
 };
+/**
+ * This type represent one segment of a segmented field: the same `{ type, constraints }` pair a
+ * schema field carries, minus the name, because the map key in `SegmentsTable` is the name
+ *
+ * `oneLinkedContentOf` is the only reference form admitted, `linked-content` is its single
+ * definition special case and carries the identical payload value
+ */
+export type SegmentDescriptor = {
+    type: SchemaTypeIds.FRAGMENT;
+    constraints: FragmentFieldConstraints;
+} | {
+    type: SchemaTypeIds.ONE_FRAGMENT_OF;
+    constraints: OneFragmentOfConstraints;
+} | {
+    type: SchemaTypeIds.ONE_LINKED_CONTENT_OF;
+    constraints: OneLinkedContentOfConstraints;
+};
+/**
+ * This type represent the model to define a segment of a segmented field
+ */
+export type SegmentDefinition = SegmentDescriptor & {
+    /**
+     * The friendly labels of the segment
+     */
+    labels?: I18NDictionary;
+};
+/**
+ * This type represent the model of the attribute segments of a segmented field, keyed by segment
+ * name, like `FragmentsTable`
+ * Names must match `^[a-z0-9_-]+$` and are unordered
+ */
+export type SegmentsTable = {
+    /**
+     * The name is the unique id of the segment and its value is the model representing the segment
+     */
+    [name: string]: SegmentDefinition;
+};
+/**
+ * This enum constrains every segment of a field to one family
+ * When omitted, segments of both families are allowed in the same field
+ */
+export declare enum SegmentsType {
+    FRAGMENTS = "fragments",
+    REFERENCES = "references"
+}
+/**
+ * This type represent the model of a segmented field constraints
+ */
+export type SegmentedFieldConstraints = {
+    /**
+     * Set this value to define the segments the field is made of
+     */
+    segments: SegmentsTable;
+    /**
+     * Set this value to define the segment served when the request matches none of this field's segments
+     */
+    defaultSegment?: string;
+    /**
+     * Set this value to constrain every segment of the field to one family
+     */
+    segmentsType?: SegmentsType;
+};
 /**
  * This type represent the model of an array field constraints
  * @template T The type of the item used ad children of the array
@@ -444,6 +507,10 @@ export type OneFragmentOfSchemaType = SchemaType<SchemaTypeIds.ONE_FRAGMENT_OF,
  * A one linked content of field can be indexed and searched when requesting the content
  */
 export type OneLinkedContentOfSchemaType = IndexableSchemaType<SchemaTypeIds.ONE_LINKED_CONTENT_OF, OneLinkedContentOfConstraints>;
+/**
+ * This type represent a segmented field schema type
+ */
+export type SegmentedSchemaType = SchemaType<SchemaTypeIds.SEGMENTED, SegmentedFieldConstraints>;
 /**
  * Slug schema type
  * This type is indexable and translatable by default
@@ -469,7 +536,7 @@ export type TranslatableSchemaTypes = NumberSchemaType | TextSchemaType | LongTe
 /**
  * This type group all the schema types of a content definition that are not indexable
  */
-export type PlainSchemaTypes = DateSchemaType | FragmentSchemaType | OneFragmentOfSchemaType | SlugSchemaType;
+export type PlainSchemaTypes = DateSchemaType | FragmentSchemaType | OneFragmentOfSchemaType | SlugSchemaType | SegmentedSchemaType;
 /**
  * This type group all schema types of a content definition
  */

package/dist/api/ContentDefinitionSchema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LinkType = exports.LongTextSubTypes = exports.SchemaTypeIds = void 0;
+exports.SegmentsType = exports.LinkType = exports.LongTextSubTypes = exports.SchemaTypeIds = void 0;
 /**
  * This enum represent al possible schema field type ids
  */
@@ -23,6 +23,7 @@ var SchemaTypeIds;
     SchemaTypeIds["ARRAY"] = "array";
     SchemaTypeIds["SLUG"] = "slug";
     SchemaTypeIds["MEDIA"] = "media";
+    SchemaTypeIds["SEGMENTED"] = "segmented";
 })(SchemaTypeIds || (exports.SchemaTypeIds = SchemaTypeIds = {}));
 /**
  * This enum represent al possible long text sub types
@@ -39,3 +40,12 @@ var LinkType;
     LinkType[LinkType["LAZY"] = 1] = "LAZY";
     LinkType[LinkType["COMPACT"] = 2] = "COMPACT";
 })(LinkType || (exports.LinkType = LinkType = {}));
+/**
+ * This enum constrains every segment of a field to one family
+ * When omitted, segments of both families are allowed in the same field
+ */
+var SegmentsType;
+(function (SegmentsType) {
+    SegmentsType["FRAGMENTS"] = "fragments";
+    SegmentsType["REFERENCES"] = "references";
+})(SegmentsType || (exports.SegmentsType = SegmentsType = {}));

package/lib/api/Content.ts

@@ -838,6 +838,8 @@ export enum ContentFieldViolationCodes {
   textFieldValueMissingInListOfValue = "textField.valueMissingInListOfValue",
   textFieldValueIsNotAString = "textField.valueIsNotAString",
   textFieldBlankValueNotAllowed = "textField.blankValueNotAllowed",
+  segmentedFieldValueIsNotSegmented = "segmentedField.valueIsNotSegmented",
+  segmentedFieldSegmentNotDeclared = "segmentedField.segmentNotDeclared",
 }
 
 /**

package/lib/api/ContentDefinition.ts

@@ -393,6 +393,7 @@ export enum SchemaFieldViolationCodes {
     invalidNumberValueInList = 'invalidNumberValueInList',
     invalidArrayValue = 'invalidArrayValue',
     invalidEmptyArray = 'invalidEmptyArray',
+    invalidEmptyObject = 'invalidEmptyObject',
     invalidListOfValuesValue = 'invalidListOfValuesValue',
     fragmentNameNotFound = 'fragmentNameNotFound',
     fragmentNameAlreadyInUse = 'fragmentNameAlreadyInUse',
@@ -414,5 +415,7 @@ export enum SchemaFieldViolationCodes {
     extensionNotSupportedForType = 'extensionNotSupportedForType',
     translatableNotAllowed = 'translatableNotAllowed',
     invalidEnumValue = 'invalidEnumValue',
-    compactCannotBeNested = 'compactCannotBeNested'
+    compactCannotBeNested = 'compactCannotBeNested',
+    segmentTypeNotAllowed = 'segmentTypeNotAllowed',
+    segmentNameNotFound = 'segmentNameNotFound'
 }

package/lib/api/ContentDefinitionSchema.ts

@@ -21,6 +21,7 @@ export enum SchemaTypeIds {
     ARRAY = 'array',
     SLUG = 'slug',
     MEDIA = 'media',
+    SEGMENTED = 'segmented',
 }
 
 /**
@@ -319,6 +320,67 @@ export type OneLinkedContentOfConstraints = {
     linkType?: LinkType;
 };
 
+/**
+ * This type represent one segment of a segmented field: the same `{ type, constraints }` pair a
+ * schema field carries, minus the name, because the map key in `SegmentsTable` is the name
+ *
+ * `oneLinkedContentOf` is the only reference form admitted, `linked-content` is its single
+ * definition special case and carries the identical payload value
+ */
+export type SegmentDescriptor =
+    | { type: SchemaTypeIds.FRAGMENT; constraints: FragmentFieldConstraints; }
+    | { type: SchemaTypeIds.ONE_FRAGMENT_OF; constraints: OneFragmentOfConstraints; }
+    | { type: SchemaTypeIds.ONE_LINKED_CONTENT_OF; constraints: OneLinkedContentOfConstraints; };
+
+/**
+ * This type represent the model to define a segment of a segmented field
+ */
+export type SegmentDefinition = SegmentDescriptor & {
+    /**
+     * The friendly labels of the segment
+     */
+    labels?: I18NDictionary;
+};
+
+/**
+ * This type represent the model of the attribute segments of a segmented field, keyed by segment
+ * name, like `FragmentsTable`
+ * Names must match `^[a-z0-9_-]+$` and are unordered
+ */
+export type SegmentsTable = {
+    /**
+     * The name is the unique id of the segment and its value is the model representing the segment
+     */
+    [name: string]: SegmentDefinition;
+};
+
+/**
+ * This enum constrains every segment of a field to one family
+ * When omitted, segments of both families are allowed in the same field
+ */
+export enum SegmentsType {
+    FRAGMENTS = 'fragments',
+    REFERENCES = 'references'
+}
+
+/**
+ * This type represent the model of a segmented field constraints
+ */
+export type SegmentedFieldConstraints = {
+    /**
+     * Set this value to define the segments the field is made of
+     */
+    segments: SegmentsTable;
+    /**
+     * Set this value to define the segment served when the request matches none of this field's segments
+     */
+    defaultSegment?: string;
+    /**
+     * Set this value to constrain every segment of the field to one family
+     */
+    segmentsType?: SegmentsType;
+};
+
 /**
  * This type represent the model of an array field constraints
  * @template T The type of the item used ad children of the array
@@ -483,6 +545,11 @@ export type OneFragmentOfSchemaType = SchemaType<SchemaTypeIds.ONE_FRAGMENT_OF,
  */
 export type OneLinkedContentOfSchemaType = IndexableSchemaType<SchemaTypeIds.ONE_LINKED_CONTENT_OF, OneLinkedContentOfConstraints>;
 
+/**
+ * This type represent a segmented field schema type
+ */
+export type SegmentedSchemaType = SchemaType<SchemaTypeIds.SEGMENTED, SegmentedFieldConstraints>;
+
 /**
  * Slug schema type
  * This type is indexable and translatable by default
@@ -515,7 +582,7 @@ export type TranslatableSchemaTypes = NumberSchemaType | TextSchemaType | LongTe
 /**
  * This type group all the schema types of a content definition that are not indexable
  */
-export type PlainSchemaTypes = DateSchemaType | FragmentSchemaType | OneFragmentOfSchemaType | SlugSchemaType;
+export type PlainSchemaTypes = DateSchemaType | FragmentSchemaType | OneFragmentOfSchemaType | SlugSchemaType | SegmentedSchemaType;
 
 /**
  * This type group all schema types of a content definition

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "11.0.0-alpha.0",
+  "version": "11.0.0-alpha.1",
   "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": "2e427740786a96ee2e1d8262371799287a33dc88"
+  "gitHead": "b618c00d0b1642ac9a75685fa08e214b83e22fc8"
 }