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

package/dist/api/Component.d.ts

@@ -392,8 +392,8 @@ export type ComponentError = ComponentErrorOf<ComponentErrorTypes.componentNotFo
     id: MigrationPreviewId;
 }>;
 /**
- * This type represent where a definition's contents stand, as the get content definition API request
- * answers it
+ * This type represent where a definition's contents stand, as the get content definition, update content
+ * definition and get migration API requests answer it
  *
  * An upgrade or adoption that renames, removes or retypes fields bumps the definition's revision and
  * migrates its contents in the background, one migration at a time per definition
@@ -558,6 +558,19 @@ export type GetMigrationPreviewResponse = {
      */
     settingAside: number;
 };
+/**
+ * This type represent the data needed to make a get migration API request
+ */
+export type GetMigrationRequest = {
+    /**
+     * The content definition unique id
+     */
+    id: ContentDefinitionId;
+};
+/**
+ * This type represent the response of a get migration API request, to poll while a migration runs
+ */
+export type GetMigrationResponse = DefinitionMigrationState;
 /**
  * This type represent the data needed to make a resume migration API request
  */

package/dist/api/Content.d.ts

@@ -683,7 +683,12 @@ export type CreateContentResponse = ContentResponse;
 /**
  * This type represent the response of an update content API request
  */
-export type UpdateContentResponse = ContentResponse;
+export type UpdateContentResponse = ContentResponse & {
+    /**
+     * The values set aside left to resolve after the save, so a form need not read the content again
+     */
+    setAside: SetAsideValue[];
+};
 /**
  * This type represent the data needed to make a list public id API request
  */

package/dist/api/ContentDefinition.d.ts

@@ -207,7 +207,12 @@ export type CreateContentDefinitionResponse = ContentDefinitionResponse;
 /**
  * This type represent the response of an update content definition API request
  */
-export type UpdateContentDefinitionResponse = ContentDefinitionResponse;
+export type UpdateContentDefinitionResponse = ContentDefinitionResponse & {
+    /**
+     * Where the definition's contents stand: a save that started a migration has them all behind
+     */
+    migration: DefinitionMigrationState;
+};
 /**
  * This type represent the response of a get content definition API request
  */

package/lib/api/Component.ts

@@ -409,8 +409,8 @@ export type ComponentError =
     | ComponentErrorOf<ComponentErrorTypes.migrationPreviewNotFound, { id: MigrationPreviewId }>;
 
 /**
- * This type represent where a definition's contents stand, as the get content definition API request
- * answers it
+ * This type represent where a definition's contents stand, as the get content definition, update content
+ * definition and get migration API requests answer it
  *
  * An upgrade or adoption that renames, removes or retypes fields bumps the definition's revision and
  * migrates its contents in the background, one migration at a time per definition
@@ -576,6 +576,21 @@ export type GetMigrationPreviewResponse = {
     settingAside: number;
 };
 
+/**
+ * This type represent the data needed to make a get migration API request
+ */
+export type GetMigrationRequest = {
+    /**
+     * The content definition unique id
+     */
+    id: ContentDefinitionId;
+};
+
+/**
+ * This type represent the response of a get migration API request, to poll while a migration runs
+ */
+export type GetMigrationResponse = DefinitionMigrationState;
+
 /**
  * This type represent the data needed to make a resume migration API request
  */

package/lib/api/Content.ts

@@ -745,7 +745,12 @@ export type CreateContentResponse = ContentResponse;
 /**
  * This type represent the response of an update content API request
  */
-export type UpdateContentResponse = ContentResponse;
+export type UpdateContentResponse = ContentResponse & {
+  /**
+   * The values set aside left to resolve after the save, so a form need not read the content again
+   */
+  setAside: SetAsideValue[];
+};
 
 /**
  * This type represent the data needed to make a list public id API request

package/lib/api/ContentDefinition.ts

@@ -224,7 +224,12 @@ export type CreateContentDefinitionResponse = ContentDefinitionResponse;
 /**
  * This type represent the response of an update content definition API request
  */
-export type UpdateContentDefinitionResponse = ContentDefinitionResponse;
+export type UpdateContentDefinitionResponse = ContentDefinitionResponse & {
+    /**
+     * Where the definition's contents stand: a save that started a migration has them all behind
+     */
+    migration: DefinitionMigrationState;
+};
 /**
  * This type represent the response of a get content definition API request
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "11.1.0-alpha.1",
+  "version": "11.1.0-alpha.2",
   "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": "8970d38d1236984dee510da19687d73078f76a70"
+  "gitHead": "6aef68846f09d3cec95ade3d59906d1edc48db85"
 }