@contentchef/contentchef-types 10.1.0-alpha.8 → 10.1.0-alpha.9

package/dist/api/ContentExportImport.d.ts

@@ -77,8 +77,8 @@ export type ContentExportImportError = {
 };
 /**
  * This type represent one of the files produced by a content export, one per exported content
- * definition. Files are appended as soon as they are uploaded, so a still `processing` export
- * already lists the files that can be downloaded
+ * definition. The whole list is written when the export completes, so a `processing` export
+ * exposes no file yet
  */
 export type ContentExportFile = {
     /**
@@ -125,8 +125,8 @@ export type ContentExportRequestResponse = {
      */
     csvSeparator: string;
     /**
-     * The files produced so far, one per exported content definition.
-     * Null until the export starts producing them
+     * The produced files, one per exported content definition. Empty until [[status]] is
+     * `completed`, the whole list is written in one go when the export finalizes
      */
     files: ContentExportFile[] | null;
     /**
@@ -158,10 +158,10 @@ export type CreateContentExportRequestRequest = {
     /**
      * The filters selecting the contents to export, the same ones accepted by
      * [[ContentFacade.list]]. When omitted every unarchived content of the space is exported.
-     * Archived contents cannot be imported back, so [[ListContentsFilters.contentsStatus]]
-     * defaults to `unarchived`
+     * [[ListContentsFilters.contentsStatus]] cannot be given: archived contents cannot be
+     * imported back, so an export always covers the unarchived ones only
      */
-    filters?: Partial<ListContentsFilters>;
+    filters?: Omit<Partial<ListContentsFilters>, 'contentsStatus'>;
     /**
      * The format to write the export files in, defaults to `json`
      */
@@ -431,7 +431,8 @@ export type ContentImportRequestItemResponse = {
      */
     locale: string | null;
     /**
-     * What the import did to the content, null when the row failed
+     * What the import did to the content. Null when the row failed, and on a translation row
+     * that carried nothing to apply, which succeeds as a no-op
      */
     action: ContentImportItemAction | null;
     /**

package/lib/api/ContentExportImport.ts

@@ -88,8 +88,8 @@ export type ContentExportImportError = {
 
 /**
  * This type represent one of the files produced by a content export, one per exported content
- * definition. Files are appended as soon as they are uploaded, so a still `processing` export
- * already lists the files that can be downloaded
+ * definition. The whole list is written when the export completes, so a `processing` export
+ * exposes no file yet
  */
 export type ContentExportFile = {
     /**
@@ -137,8 +137,8 @@ export type ContentExportRequestResponse = {
      */
     csvSeparator: string;
     /**
-     * The files produced so far, one per exported content definition.
-     * Null until the export starts producing them
+     * The produced files, one per exported content definition. Empty until [[status]] is
+     * `completed`, the whole list is written in one go when the export finalizes
      */
     files: ContentExportFile[] | null;
     /**
@@ -171,10 +171,10 @@ export type CreateContentExportRequestRequest = {
     /**
      * The filters selecting the contents to export, the same ones accepted by
      * [[ContentFacade.list]]. When omitted every unarchived content of the space is exported.
-     * Archived contents cannot be imported back, so [[ListContentsFilters.contentsStatus]]
-     * defaults to `unarchived`
+     * [[ListContentsFilters.contentsStatus]] cannot be given: archived contents cannot be
+     * imported back, so an export always covers the unarchived ones only
      */
-    filters?: Partial<ListContentsFilters>;
+    filters?: Omit<Partial<ListContentsFilters>, 'contentsStatus'>;
     /**
      * The format to write the export files in, defaults to `json`
      */
@@ -457,7 +457,8 @@ export type ContentImportRequestItemResponse = {
      */
     locale: string | null;
     /**
-     * What the import did to the content, null when the row failed
+     * What the import did to the content. Null when the row failed, and on a translation row
+     * that carried nothing to apply, which succeeds as a no-op
      */
     action: ContentImportItemAction | null;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "10.1.0-alpha.8",
+  "version": "10.1.0-alpha.9",
   "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": "972240c74e54c066563cc1460d5331bbfc9c0d65"
+  "gitHead": "59a529509218c3cae23624036aadddc279af60ac"
 }