@contentchef/contentchef-types 11.0.0-alpha.4 → 11.0.0-alpha.5

package/lib/api/ContentDefinition.ts

@@ -191,10 +191,10 @@ export type ContentDefinitionResponse = {
     trackableArrayFields?: ArrayField[] | null;
 
     /**
-     * The mnemonic ids of the segments this definition's segmented fields vary by
+     * The mnemonic ids of the audiences this definition's personalized fields vary by
      * Derived from the schema on every save, never assigned by the client
      */
-    segments?: string[];
+    audiences?: string[];
 };
 
 /**
@@ -288,14 +288,14 @@ export type ContentDefinitionSchemaErrors = {
      */
     lang?: string;
     /**
-     * This attribute represents all the error that occurs inside the segments declaration of the
+     * This attribute represents all the error that occurs inside the audiences 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
+     * - The value is a string if the audiences value is not in the expected format
+     * - The value is a list of AttributeViolation, one per declared audience that does not exist in the
      *   space or is archived
      */
-    segments?: string | AttributeViolation[];
+    audiences?: string | AttributeViolation[];
 };
 
 /**
@@ -431,9 +431,9 @@ export enum SchemaFieldViolationCodes {
     translatableNotAllowed = 'translatableNotAllowed',
     invalidEnumValue = 'invalidEnumValue',
     compactCannotBeNested = 'compactCannotBeNested',
-    segmentTypeNotAllowed = 'segmentTypeNotAllowed',
-    segmentNameNotFound = 'segmentNameNotFound',
-    segmentArchived = 'segmentArchived',
-    segmentNotDeclaredByDefinition = 'segmentNotDeclaredByDefinition',
-    duplicateSegmentName = 'duplicateSegmentName'
+    audienceTypeNotAllowed = 'audienceTypeNotAllowed',
+    audienceNameNotFound = 'audienceNameNotFound',
+    audienceArchived = 'audienceArchived',
+    audienceNotDeclaredByDefinition = 'audienceNotDeclaredByDefinition',
+    duplicateAudienceName = 'duplicateAudienceName'
 }

package/lib/api/ContentDefinitionSchema.ts

@@ -21,7 +21,7 @@ export enum SchemaTypeIds {
     ARRAY = 'array',
     SLUG = 'slug',
     MEDIA = 'media',
-    SEGMENTED = 'segmented',
+    PERSONALIZED = 'personalized',
 }
 
 /**
@@ -52,13 +52,13 @@ export type ContentDefinitionSchema = {
      */
     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
+     * The audiences this definition depends on, chosen by the author. Every one has to exist in the
+     * space and not be archived, and a personalized field may only vary by audiences 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
+     * Optional: a definition that declares none simply cannot hold a personalized field
      */
-    segments?: string[];
+    audiences?: string[];
 };
 
 /**
@@ -329,39 +329,39 @@ export type OneLinkedContentOfConstraints = {
 };
 
 /**
- * This type represent what every value of a segmented field holds: one descriptor for the whole field,
+ * This type represent what every value of a personalized field holds: one descriptor for the whole field,
  * so the rules and the fallback cannot differ in type
  *
  * Only the two `one...Of` forms are admitted: `fragment` and `linked-content` are each the
  * single-target special case of one of them, carrying an identical payload value
  */
-export type SegmentVariantType =
+export type PersonalizedVariantType =
     | { type: SchemaTypeIds.ONE_FRAGMENT_OF; constraints: OneFragmentOfConstraints; }
     | { type: SchemaTypeIds.ONE_LINKED_CONTENT_OF; constraints: OneLinkedContentOfConstraints; };
 
 /**
- * This type represent the model of a segmented field constraints
+ * This type represent the model of a personalized field constraints
  *
- * A segmented field declares only *what varies* and *what shape the values have*. Which conditions
+ * A personalized field declares only *what varies* and *what shape the values have*. Which conditions
  * exist and what each of them serves is authored per content, as an ordered list of rules plus a
- * fallback - see [[SegmentedFieldPayload]] - so no combination has to be pre-declared here and two
+ * fallback - see [[PersonalizedFieldPayload]] - so no combination has to be pre-declared here and two
  * contents of the same definition may carry entirely different rule sets
  */
-export type SegmentedFieldConstraints = {
+export type PersonalizedFieldConstraints = {
     /**
-     * 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
+     * The mnemonic ids of the audiences this field varies by, which must be among the ones the
+     * definition declares in [[ContentDefinitionSchema.audiences]]. Only the declaration is checked
+     * against the space, so an audience 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
+     * audience it constrains
      */
-    segments: string[];
+    audiences: string[];
     /**
      * The shape every rule value and the fallback conform to
      */
-    variantType: SegmentVariantType;
+    variantType: PersonalizedVariantType;
 };
 
 /**
@@ -529,9 +529,9 @@ 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
+ * This type represent a personalized field schema type
  */
-export type SegmentedSchemaType = SchemaType<SchemaTypeIds.SEGMENTED, SegmentedFieldConstraints>;
+export type PersonalizedSchemaType = SchemaType<SchemaTypeIds.PERSONALIZED, PersonalizedFieldConstraints>;
 
 /**
  * Slug schema type
@@ -565,7 +565,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 | SegmentedSchemaType;
+export type PlainSchemaTypes = DateSchemaType | FragmentSchemaType | OneFragmentOfSchemaType | SlugSchemaType | PersonalizedSchemaType;
 
 /**
  * This type group all schema types of a content definition

package/lib/api/index.ts

@@ -12,7 +12,7 @@ export * from './Invites';
 export * from './MediaGallery';
 export * from './PublishedContent';
 export * from './PublishingRequest';
-export * from './Segment';
+export * from './Audience';
 export * from './Space';
 export * from './Subscription';
 export * from './UnpublishRequest';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "11.0.0-alpha.4",
+  "version": "11.0.0-alpha.5",
   "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": "e6dc1e7bcc12adafcb1d1428f27bbd3b9e3c2bc5"
+  "gitHead": "9aec2cdbb2d04b788dec73666e71eb36f867944a"
 }