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

package/dist/api/ContentDefinition.d.ts

@@ -1,6 +1,7 @@
 import { AuthorResponse } from './Author';
 import { PagedListResponse } from './common';
-import { ContentDefinitionSchema, Field, I18NDictionary } from './ContentDefinitionSchema';
+import { DefinitionMigrationState, FieldChanges } from './Component';
+import { ComponentMarker, ContentDefinitionSchema, ContentDefinitionSchemaInput, Field, I18NDictionary } from './ContentDefinitionSchema';
 import { Extension } from './Extension';
 /**
  * This type represent the unique content definition id type
@@ -100,7 +101,7 @@ export type CreateContentDefinitionRequest = {
     /**
      * The content definition fields schema
      */
-    schema: ContentDefinitionSchema;
+    schema: ContentDefinitionSchemaInput;
     /**
      * will bypass content definition mnemonicId validation for every linked-content field
      */
@@ -125,7 +126,7 @@ export type UpdateContentDefinitionRequest = {
     /**
      * The content definition fields schema
      */
-    schema: ContentDefinitionSchema;
+    schema: ContentDefinitionSchemaInput;
     /**
      * will bypass content definition mnemonicId validation for every linked-content field
      */
@@ -175,6 +176,29 @@ export type ContentDefinitionResponse = {
      * Valued with paths to each array or null if definition is legacy
      */
     trackableArrayFields?: ArrayField[] | null;
+    /**
+     * The components the definition's managed fragments copy, one per component
+     */
+    components: ComponentMarker[];
+};
+/**
+ * This type represent one component a definition uses, as the get content definition API request
+ * describes it
+ */
+export type DefinitionComponent = ComponentMarker & {
+    /**
+     * The component latest version
+     */
+    latestVersion: number;
+    /**
+     * The archived status of the component
+     */
+    archived: boolean;
+    /**
+     * What upgrading from `version` to `latestVersion` would add, remove, change and rename, all empty
+     * when up to date. What it would do to the contents is only known by previewing it
+     */
+    changes: FieldChanges;
 };
 /**
  * This type represent the response of a create content definition API request
@@ -187,7 +211,16 @@ export type UpdateContentDefinitionResponse = ContentDefinitionResponse;
 /**
  * This type represent the response of a get content definition API request
  */
-export type GetContentDefinitionResponse = ContentDefinitionResponse | undefined;
+export type GetContentDefinitionResponse = (Omit<ContentDefinitionResponse, 'components'> & {
+    /**
+     * The components the definition uses, each with its latest version and what upgrading to it changes
+     */
+    components: DefinitionComponent[];
+    /**
+     * Where the definition's contents stand in its migrations
+     */
+    migration: DefinitionMigrationState;
+}) | undefined;
 /**
  * This type represent the data needed to make a validate definition field API request
  */
@@ -389,5 +422,8 @@ export declare enum SchemaFieldViolationCodes {
     translatableNotAllowed = "translatableNotAllowed",
     invalidEnumValue = "invalidEnumValue",
     compactCannotBeNested = "compactCannotBeNested",
-    variantTypeNotAllowed = "variantTypeNotAllowed"
+    variantTypeNotAllowed = "variantTypeNotAllowed",
+    componentArchived = "componentArchived",
+    componentNotPublished = "componentNotPublished",
+    invalidComponentMarker = "invalidComponentMarker"
 }

package/dist/api/ContentDefinition.js

@@ -46,4 +46,7 @@ var SchemaFieldViolationCodes;
     SchemaFieldViolationCodes["invalidEnumValue"] = "invalidEnumValue";
     SchemaFieldViolationCodes["compactCannotBeNested"] = "compactCannotBeNested";
     SchemaFieldViolationCodes["variantTypeNotAllowed"] = "variantTypeNotAllowed";
+    SchemaFieldViolationCodes["componentArchived"] = "componentArchived";
+    SchemaFieldViolationCodes["componentNotPublished"] = "componentNotPublished";
+    SchemaFieldViolationCodes["invalidComponentMarker"] = "invalidComponentMarker";
 })(SchemaFieldViolationCodes || (exports.SchemaFieldViolationCodes = SchemaFieldViolationCodes = {}));

package/dist/api/ContentDefinitionSchema.d.ts

@@ -71,6 +71,43 @@ export type FragmentDefinition = {
      * The friendly labels of the fragment
      */
     labels?: I18NDictionary;
+    /**
+     * Set on a managed fragment: a copy of a component version, keyed by the component's mnemonic id,
+     * that the backend writes and nobody edits by hand. Saving a definition with the marker alone has
+     * the backend fill in labels and fields, and saving it with a later `version` upgrades the fragment
+     */
+    component?: ComponentMarker;
+};
+/**
+ * This type represent a content definition schema as the create and update content definition API
+ * requests take it, whose managed fragments may leave out their labels and fields
+ */
+export type ContentDefinitionSchemaInput = Omit<ContentDefinitionSchema, 'fragments'> & {
+    fragments: {
+        [name: string]: FragmentDefinition | ManagedFragmentInput;
+    };
+};
+/**
+ * This type represent a managed fragment as a definition save may send it: labels and fields left out
+ * are filled in from the component version, and labels and fields sent must be the version's
+ */
+export type ManagedFragmentInput = {
+    component: ComponentMarker;
+    labels?: I18NDictionary;
+    fields?: Field[];
+};
+/**
+ * This type represent the marker of a managed fragment, naming the component and the version it copies
+ */
+export type ComponentMarker = {
+    /**
+     * The component mnemonic id, which is also the fragment's key in the schema
+     */
+    mnemonicId: string;
+    /**
+     * The component version the fragment copies
+     */
+    version: number;
 };
 /**
  * This type represent the base model of a schema field

package/dist/api/index.d.ts

@@ -3,6 +3,7 @@ export * from './AuditLog';
 export * from './Author';
 export * from './Channel';
 export * from './Content';
+export * from './Component';
 export * from './ContentDefinition';
 export * from './ContentDefinitionSchema';
 export * from './ContentExportImport';

package/dist/api/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./AuditLog"), exports);
 __exportStar(require("./Author"), exports);
 __exportStar(require("./Channel"), exports);
 __exportStar(require("./Content"), exports);
+__exportStar(require("./Component"), exports);
 __exportStar(require("./ContentDefinition"), exports);
 __exportStar(require("./ContentDefinitionSchema"), exports);
 __exportStar(require("./ContentExportImport"), exports);