@contentchef/contentchef-types 11.0.0-alpha.2 → 11.0.0-alpha.3

package/dist/api/ContentDefinition.d.ts

@@ -266,6 +266,15 @@ export type ContentDefinitionSchemaErrors = {
      * This attribute represents an error if the language of the schema is not a valid string
      */
     lang?: string;
+    /**
+     * This attribute represents all the error that occurs inside the segments declaration of the
+     * definition schema object
+     *
+     * - The value is a string if the segments value is not in the expected format
+     * - The value is a list of AttributeViolation, one per declared segment that does not exist in the
+     *   space or is archived
+     */
+    segments?: string | AttributeViolation[];
 };
 /**
  * This type represent the model for the schema fragment errors
@@ -397,5 +406,6 @@ export declare enum SchemaFieldViolationCodes {
     segmentTypeNotAllowed = "segmentTypeNotAllowed",
     segmentNameNotFound = "segmentNameNotFound",
     segmentArchived = "segmentArchived",
+    segmentNotDeclaredByDefinition = "segmentNotDeclaredByDefinition",
     duplicateSegmentName = "duplicateSegmentName"
 }

package/dist/api/ContentDefinition.js

@@ -48,5 +48,6 @@ var SchemaFieldViolationCodes;
     SchemaFieldViolationCodes["segmentTypeNotAllowed"] = "segmentTypeNotAllowed";
     SchemaFieldViolationCodes["segmentNameNotFound"] = "segmentNameNotFound";
     SchemaFieldViolationCodes["segmentArchived"] = "segmentArchived";
+    SchemaFieldViolationCodes["segmentNotDeclaredByDefinition"] = "segmentNotDeclaredByDefinition";
     SchemaFieldViolationCodes["duplicateSegmentName"] = "duplicateSegmentName";
 })(SchemaFieldViolationCodes || (exports.SchemaFieldViolationCodes = SchemaFieldViolationCodes = {}));

package/dist/api/ContentDefinitionSchema.d.ts

@@ -48,6 +48,14 @@ export type ContentDefinitionSchema = {
      * A Fragment is a custom field defined by the user and can be used internally in the definition
      */
     fragments: FragmentsTable;
+    /**
+     * The segments this definition depends on, chosen by the author. Every one has to exist in the
+     * space and not be archived, and a segmented field may only vary by segments named here, so this
+     * is what scopes a definition and gives the field editor a short list to offer
+     *
+     * Optional: a definition that declares none simply cannot hold a segmented field
+     */
+    segments?: string[];
 };
 /**
  * This type represent the model of the attribute fragments in a content definition schema
@@ -318,8 +326,13 @@ export type SegmentVariantType = {
  */
 export type SegmentedFieldConstraints = {
     /**
-     * The mnemonic ids of the segments this field varies by. Declaration order carries no meaning: a
-     * rule wins by being first in the content, not by which segment it constrains
+     * The mnemonic ids of the segments this field varies by, which must be among the ones the
+     * definition declares in [[ContentDefinitionSchema.segments]]. Only the declaration is checked
+     * against the space, so a segment that does not exist is one error on the definition rather than
+     * one on every field that reached for it
+     *
+     * Declaration order carries no meaning: a rule wins by being first in the content, not by which
+     * segment it constrains
      */
     segments: string[];
     /**

package/lib/api/ContentDefinition.ts

@@ -287,6 +287,15 @@ export type ContentDefinitionSchemaErrors = {
      * This attribute represents an error if the language of the schema is not a valid string
      */
     lang?: string;
+    /**
+     * This attribute represents all the error that occurs inside the segments declaration of the
+     * definition schema object
+     *
+     * - The value is a string if the segments value is not in the expected format
+     * - The value is a list of AttributeViolation, one per declared segment that does not exist in the
+     *   space or is archived
+     */
+    segments?: string | AttributeViolation[];
 };
 
 /**
@@ -425,5 +434,6 @@ export enum SchemaFieldViolationCodes {
     segmentTypeNotAllowed = 'segmentTypeNotAllowed',
     segmentNameNotFound = 'segmentNameNotFound',
     segmentArchived = 'segmentArchived',
+    segmentNotDeclaredByDefinition = 'segmentNotDeclaredByDefinition',
     duplicateSegmentName = 'duplicateSegmentName'
 }

package/lib/api/ContentDefinitionSchema.ts

@@ -51,6 +51,14 @@ export type ContentDefinitionSchema = {
      * A Fragment is a custom field defined by the user and can be used internally in the definition
      */
     fragments: FragmentsTable;
+    /**
+     * The segments this definition depends on, chosen by the author. Every one has to exist in the
+     * space and not be archived, and a segmented field may only vary by segments named here, so this
+     * is what scopes a definition and gives the field editor a short list to offer
+     *
+     * Optional: a definition that declares none simply cannot hold a segmented field
+     */
+    segments?: string[];
 };
 
 /**
@@ -341,8 +349,13 @@ export type SegmentVariantType =
  */
 export type SegmentedFieldConstraints = {
     /**
-     * The mnemonic ids of the segments this field varies by. Declaration order carries no meaning: a
-     * rule wins by being first in the content, not by which segment it constrains
+     * The mnemonic ids of the segments this field varies by, which must be among the ones the
+     * definition declares in [[ContentDefinitionSchema.segments]]. Only the declaration is checked
+     * against the space, so a segment that does not exist is one error on the definition rather than
+     * one on every field that reached for it
+     *
+     * Declaration order carries no meaning: a rule wins by being first in the content, not by which
+     * segment it constrains
      */
     segments: string[];
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "11.0.0-alpha.2",
+  "version": "11.0.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": "58fd14f63fafe3be82bc829bb3a835a2e4f94c30"
+  "gitHead": "778b33af62f27ed0f992fc1d50025f2cf8c90836"
 }