@contentchef/contentchef-types 11.2.0-alpha.5 → 11.2.0-alpha.6

package/dist/api/Component.d.ts

@@ -31,7 +31,8 @@ export type ComponentRename = {
  */
 export type DefinitionRename = ComponentRename & {
     /**
-     * The definition's own fragment holding the field, left out or null at the root
+     * The definition's own fragment holding the field, named as the definition has it before the save,
+     * left out or null at the root
      */
     fragment?: string | null;
 };
@@ -416,11 +417,29 @@ export type ComponentVersionViolation = {
     message: string;
 };
 /**
- * This type represent a rename a definition save may not declare: from a field the definition does not
- * have or the save still has, onto one the save does not have or the definition has already, a field in
- * two renames, or a `fragment` that is not one of the definition's own on both sides
+ * This type represent a rename a definition save may not declare
  */
-export type DefinitionRenameViolation = {
+export type DefinitionRenameViolation = 
+/**
+ * A fragment rename from one that is not the definition's own or that the save still has, onto one the
+ * save does not have as its own or the definition has already, or a name in two fragment renames.
+ * Field renames are not judged until the fragment renames fit
+ */
+{
+    /**
+     * The fragment's new name
+     */
+    fragment: string;
+    field: null;
+    code: 'definition.invalidFragmentRename';
+    message: string;
+}
+/**
+ * A field rename from a field the definition does not have or the save still has, onto one the save
+ * does not have or the definition has already, a field in two renames, or a `fragment` that is none of
+ * the definition's own kept or renamed by the save
+ */
+ | {
     /**
      * The rename's fragment, null at the root
      */
@@ -608,6 +627,7 @@ export type MigrationPreviewRequest = {
     id: ContentDefinitionId;
     schema: ContentDefinitionSchemaInput;
     renames?: DefinitionRename[];
+    fragmentRenames?: ComponentRename[];
 } | {
     id: ContentDefinitionId;
     adopt: {
@@ -683,6 +703,13 @@ export type GetMigrationPreviewResponse = {
     scanned: number;
     total: number;
     fields: MigrationPreviewField[];
+    /**
+     * The definition's own fragments renamed, and how many `oneFragmentOf` values take their new name;
+     * empty for a component
+     */
+    fragments: (ComponentRename & {
+        values: number;
+    })[];
     /**
      * The contents whose payload or translations would change
      */

package/dist/api/ContentDefinition.d.ts

@@ -1,6 +1,6 @@
 import { AuthorResponse } from './Author';
 import { PagedListResponse } from './common';
-import { DefinitionMigrationState, DefinitionRename, FieldChanges } from './Component';
+import { ComponentRename, DefinitionMigrationState, DefinitionRename, FieldChanges } from './Component';
 import { ComponentMarker, ContentDefinitionSchema, ContentDefinitionSchemaInput, Field, I18NDictionary } from './ContentDefinitionSchema';
 import { Extension } from './Extension';
 /**
@@ -132,10 +132,17 @@ export type UpdateContentDefinitionRequest = {
      */
     bypassLinkedContentValidation?: boolean;
     /**
-     * The fields the save gives another name, at the root or in one of the definition's own fragments, for
-     * their values to follow. Undeclared, a rename is a removal and an addition, and the values are set aside
+     * The fields the save gives another name, at the root or in one of the definition's own fragments named
+     * as before the save, for their values to follow. Undeclared, a rename is a removal and an addition, and
+     * the values are set aside
      */
     renames?: DefinitionRename[];
+    /**
+     * The definition's own fragments the save gives another name: the fields using them move nothing, and
+     * the stored `oneFragmentOf` values take the new name. Undeclared, a fragment rename is a removal and an
+     * addition, and the values that no longer fit are set aside whole
+     */
+    fragmentRenames?: ComponentRename[];
 };
 /**
  * This type represent the model of a content definition

package/lib/api/Component.ts

@@ -41,7 +41,8 @@ export type ComponentRename = {
  */
 export type DefinitionRename = ComponentRename & {
     /**
-     * The definition's own fragment holding the field, left out or null at the root
+     * The definition's own fragment holding the field, named as the definition has it before the save,
+     * left out or null at the root
      */
     fragment?: string | null;
 };
@@ -439,22 +440,40 @@ export type ComponentVersionViolation = {
 };
 
 /**
- * This type represent a rename a definition save may not declare: from a field the definition does not
- * have or the save still has, onto one the save does not have or the definition has already, a field in
- * two renames, or a `fragment` that is not one of the definition's own on both sides
+ * This type represent a rename a definition save may not declare
  */
-export type DefinitionRenameViolation = {
+export type DefinitionRenameViolation =
     /**
-     * The rename's fragment, null at the root
+     * A fragment rename from one that is not the definition's own or that the save still has, onto one the
+     * save does not have as its own or the definition has already, or a name in two fragment renames.
+     * Field renames are not judged until the fragment renames fit
      */
-    fragment: string | null;
+    | {
+        /**
+         * The fragment's new name
+         */
+        fragment: string;
+        field: null;
+        code: 'definition.invalidFragmentRename';
+        message: string;
+    }
     /**
-     * The rename's `to`
+     * A field rename from a field the definition does not have or the save still has, onto one the save
+     * does not have or the definition has already, a field in two renames, or a `fragment` that is none of
+     * the definition's own kept or renamed by the save
      */
-    field: string;
-    code: 'definition.invalidRename';
-    message: string;
-};
+    | {
+        /**
+         * The rename's fragment, null at the root
+         */
+        fragment: string | null;
+        /**
+         * The rename's `to`
+         */
+        field: string;
+        code: 'definition.invalidRename';
+        message: string;
+    };
 
 type ComponentErrorOf<T extends ComponentErrorTypes, D = {}> = { type: T; message: string } & D;
 
@@ -617,7 +636,12 @@ export type MigrationPreviewId = number;
  * declare, or the adoption about to be made
  */
 export type MigrationPreviewRequest =
-    | { id: ContentDefinitionId; schema: ContentDefinitionSchemaInput; renames?: DefinitionRename[] }
+    | {
+        id: ContentDefinitionId;
+        schema: ContentDefinitionSchemaInput;
+        renames?: DefinitionRename[];
+        fragmentRenames?: ComponentRename[];
+    }
     | { id: ContentDefinitionId; adopt: { mnemonicId: string; version: number; renames?: ComponentRename[] } };
 
 /**
@@ -690,6 +714,11 @@ export type GetMigrationPreviewResponse = {
     scanned: number;
     total: number;
     fields: MigrationPreviewField[];
+    /**
+     * The definition's own fragments renamed, and how many `oneFragmentOf` values take their new name;
+     * empty for a component
+     */
+    fragments: (ComponentRename & { values: number })[];
     /**
      * The contents whose payload or translations would change
      */

package/lib/api/ContentDefinition.ts

@@ -1,6 +1,6 @@
 import { AuthorResponse } from './Author';
 import { PagedListResponse } from './common';
-import { DefinitionMigrationState, DefinitionRename, FieldChanges } from './Component';
+import { ComponentRename, DefinitionMigrationState, DefinitionRename, FieldChanges } from './Component';
 import { ComponentMarker, ContentDefinitionSchema, ContentDefinitionSchemaInput, Field, I18NDictionary } from './ContentDefinitionSchema';
 import { Extension } from './Extension';
 
@@ -143,10 +143,17 @@ export type UpdateContentDefinitionRequest = {
      */
     bypassLinkedContentValidation?: boolean;
     /**
-     * The fields the save gives another name, at the root or in one of the definition's own fragments, for
-     * their values to follow. Undeclared, a rename is a removal and an addition, and the values are set aside
+     * The fields the save gives another name, at the root or in one of the definition's own fragments named
+     * as before the save, for their values to follow. Undeclared, a rename is a removal and an addition, and
+     * the values are set aside
      */
     renames?: DefinitionRename[];
+    /**
+     * The definition's own fragments the save gives another name: the fields using them move nothing, and
+     * the stored `oneFragmentOf` values take the new name. Undeclared, a fragment rename is a removal and an
+     * addition, and the values that no longer fit are set aside whole
+     */
+    fragmentRenames?: ComponentRename[];
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "11.2.0-alpha.5",
+  "version": "11.2.0-alpha.6",
   "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": "ccaa9d0ae10d67701cf34df7ec127c3c40fefae4"
+  "gitHead": "e8292eac50e55b57a28d69b9128d46eb41d225a9"
 }