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

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`
      */
@@ -244,6 +244,11 @@ export type ContentImportOptions = {
      * The separator the imported csv file is read with. Meaningless when [[format]] is `json`
      */
     csvSeparator?: string;
+    /**
+     * Whether payloads violating their content definition schema are applied anyway, with the
+     * violations logged instead of failing the row
+     */
+    skipPayloadValidation?: boolean;
 };
 /**
  * This type represent the model of a content import request
@@ -330,6 +335,12 @@ export type CreateContentImportRequestRequest = {
          * Ignored when [[format]] is `json`
          */
         csvSeparator?: string;
+        /**
+         * Whether to apply payloads that violate their content definition schema, recording the
+         * violations instead of failing the row. Defaults to false.
+         * [[ContentExportImportFacade.retryImport]] can turn it on for an already uploaded file
+         */
+        skipPayloadValidation?: boolean;
     };
 };
 /**
@@ -355,6 +366,46 @@ export type CreateContentImportRequestResponse = {
      */
     expiresInSeconds: number;
 };
+/**
+ * This type represent the data needed to make a retry content import API request
+ */
+export type RetryContentImportRequest = {
+    /**
+     * The unique id of the import request to re-run the file of. It must have been uploaded:
+     * an import still `awaiting_upload` has nothing to retry
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * Whether to apply payloads that violate their content definition schema, recording the
+     * violations instead of failing the row. Use it to push through a run whose validation
+     * failures have been judged acceptable. Defaults to false
+     */
+    skipPayloadValidation?: boolean;
+};
+/**
+ * This type represent the response of a retry content import API request.
+ * A retry is a new import request re-running the whole original file, not only its failed rows:
+ * imports are update only and idempotent. Nothing has to be uploaded again, the file is copied
+ * server side, and that copy is what starts the new import
+ */
+export type RetryContentImportResponse = {
+    /**
+     * The unique id of the created import request, the one to follow from now on
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * The unique id of the import request being retried
+     */
+    retryOf: ContentImportRequestId;
+    /**
+     * The storage key the original file has been copied to
+     */
+    s3Key: string;
+    /**
+     * Whether the retry applies payloads violating their content definition schema
+     */
+    skipPayloadValidation: boolean;
+};
 /**
  * This type represent the data needed to make a list content import requests API request
  */
@@ -431,7 +482,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/dist/api/Space.d.ts

@@ -240,3 +240,107 @@ export type UpdateSpacePublishingLocalesRequest = {
  * Return type of `updateSpacePublishingLocales`
  */
 export type UpdateSpacePublishingLocalesResponse = SpaceLocale;
+/**
+ * This enum represent the lifecycle of a space deletion. A freshly requested deletion is
+ * `requested` and stays revocable until [[SpaceDeletionResponse.deleteAfter]], after which it
+ * becomes `running` and can no longer be withdrawn
+ */
+export declare enum SpaceDeletionStatus {
+    /**
+     * Asked for, inside the revocation window, still revocable
+     */
+    REQUESTED = "requested",
+    /**
+     * Withdrawn inside the revocation window, nothing has been deleted
+     */
+    REVOKED = "revoked",
+    RUNNING = "running",
+    DELETED = "deleted",
+    FAILED = "failed",
+    /**
+     * A dry run, only started by hand: it reports what it would delete and changes nothing
+     */
+    INSPECTED = "inspected"
+}
+/**
+ * This type represent the model of a space deletion, the only record that outlives a deleted space
+ */
+export type SpaceDeletionResponse = {
+    /**
+     * The space the deletion refers to
+     */
+    spaceId: string;
+    /**
+     * The current status of the deletion
+     */
+    status: SpaceDeletionStatus;
+    /**
+     * The name the space had, captured when the deletion was requested because deleting the space
+     * destroys it
+     */
+    spaceName?: string;
+    /**
+     * The subscription the space was claimed under, preserved for the same reason as [[spaceName]]
+     */
+    subscriptionId?: string;
+    /**
+     * The account that requested the deletion
+     */
+    requestedBy?: string;
+    /**
+     * The account that withdrew the deletion, only set when [[status]] is `revoked`
+     */
+    revokedBy?: string;
+    /**
+     * The ISO date the revocation window shuts at: until then the deletion can be withdrawn with
+     * [[SystemFacade.revokeSpaceDeletion]], after it the deletion starts
+     */
+    deleteAfter?: string;
+    /**
+     * The arn of the workflow execution performing the deletion
+     */
+    executionArn?: string;
+    /**
+     * Whether the deletion only reported what it would delete, without deleting anything
+     */
+    dryRun?: boolean;
+    /**
+     * How many rows have been deleted, per domain and per table. Written when the deletion ends
+     */
+    counts?: {
+        [domain: string]: {
+            [table: string]: number;
+        };
+    };
+    /**
+     * The message describing why the deletion failed, only set when [[status]] is `failed`
+     */
+    error?: string;
+    /**
+     * The ISO date the deletion record was last written at
+     */
+    updatedAt?: string;
+};
+/**
+ * This type represent the response of a delete space API request. The deletion has not happened
+ * yet: it is only requested, and stays revocable for [[revocableForHours]]
+ */
+export type DeleteSpaceResponse = {
+    /**
+     * Always true, the request has been accepted
+     */
+    requested: boolean;
+    /**
+     * How long the deletion stays revocable, in hours
+     */
+    revocableForHours: number;
+};
+/**
+ * Return type of `revokeSpaceDeletion`, the withdrawn deletion record
+ */
+export type RevokeSpaceDeletionResponse = SpaceDeletionResponse;
+/**
+ * Return type of `getSpaceDeletionStatus`. It is null when the space has never had a deletion
+ * requested: no request is a normal answer, not a missing resource
+ */
+export type GetSpaceDeletionStatusResponse = SpaceDeletionResponse | null;

package/dist/api/Space.js

@@ -1,2 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpaceDeletionStatus = void 0;
+/**
+ * This enum represent the lifecycle of a space deletion. A freshly requested deletion is
+ * `requested` and stays revocable until [[SpaceDeletionResponse.deleteAfter]], after which it
+ * becomes `running` and can no longer be withdrawn
+ */
+var SpaceDeletionStatus;
+(function (SpaceDeletionStatus) {
+    /**
+     * Asked for, inside the revocation window, still revocable
+     */
+    SpaceDeletionStatus["REQUESTED"] = "requested";
+    /**
+     * Withdrawn inside the revocation window, nothing has been deleted
+     */
+    SpaceDeletionStatus["REVOKED"] = "revoked";
+    SpaceDeletionStatus["RUNNING"] = "running";
+    SpaceDeletionStatus["DELETED"] = "deleted";
+    SpaceDeletionStatus["FAILED"] = "failed";
+    /**
+     * A dry run, only started by hand: it reports what it would delete and changes nothing
+     */
+    SpaceDeletionStatus["INSPECTED"] = "inspected";
+})(SpaceDeletionStatus || (exports.SpaceDeletionStatus = SpaceDeletionStatus = {}));

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`
      */
@@ -263,6 +263,11 @@ export type ContentImportOptions = {
      * The separator the imported csv file is read with. Meaningless when [[format]] is `json`
      */
     csvSeparator?: string;
+    /**
+     * Whether payloads violating their content definition schema are applied anyway, with the
+     * violations logged instead of failing the row
+     */
+    skipPayloadValidation?: boolean;
 };
 
 /**
@@ -351,6 +356,12 @@ export type CreateContentImportRequestRequest = {
          * Ignored when [[format]] is `json`
          */
         csvSeparator?: string;
+        /**
+         * Whether to apply payloads that violate their content definition schema, recording the
+         * violations instead of failing the row. Defaults to false.
+         * [[ContentExportImportFacade.retryImport]] can turn it on for an already uploaded file
+         */
+        skipPayloadValidation?: boolean;
     };
 };
 
@@ -378,6 +389,48 @@ export type CreateContentImportRequestResponse = {
     expiresInSeconds: number;
 };
 
+/**
+ * This type represent the data needed to make a retry content import API request
+ */
+export type RetryContentImportRequest = {
+    /**
+     * The unique id of the import request to re-run the file of. It must have been uploaded:
+     * an import still `awaiting_upload` has nothing to retry
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * Whether to apply payloads that violate their content definition schema, recording the
+     * violations instead of failing the row. Use it to push through a run whose validation
+     * failures have been judged acceptable. Defaults to false
+     */
+    skipPayloadValidation?: boolean;
+};
+
+/**
+ * This type represent the response of a retry content import API request.
+ * A retry is a new import request re-running the whole original file, not only its failed rows:
+ * imports are update only and idempotent. Nothing has to be uploaded again, the file is copied
+ * server side, and that copy is what starts the new import
+ */
+export type RetryContentImportResponse = {
+    /**
+     * The unique id of the created import request, the one to follow from now on
+     */
+    importRequestId: ContentImportRequestId;
+    /**
+     * The unique id of the import request being retried
+     */
+    retryOf: ContentImportRequestId;
+    /**
+     * The storage key the original file has been copied to
+     */
+    s3Key: string;
+    /**
+     * Whether the retry applies payloads violating their content definition schema
+     */
+    skipPayloadValidation: boolean;
+};
+
 /**
  * This type represent the data needed to make a list content import requests API request
  */
@@ -457,7 +510,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/Space.ts

@@ -258,3 +258,108 @@ export type UpdateSpacePublishingLocalesRequest = {
  * Return type of `updateSpacePublishingLocales`
  */
 export type UpdateSpacePublishingLocalesResponse = SpaceLocale;
+
+/**
+ * This enum represent the lifecycle of a space deletion. A freshly requested deletion is
+ * `requested` and stays revocable until [[SpaceDeletionResponse.deleteAfter]], after which it
+ * becomes `running` and can no longer be withdrawn
+ */
+export enum SpaceDeletionStatus {
+    /**
+     * Asked for, inside the revocation window, still revocable
+     */
+    REQUESTED = 'requested',
+    /**
+     * Withdrawn inside the revocation window, nothing has been deleted
+     */
+    REVOKED = 'revoked',
+    RUNNING = 'running',
+    DELETED = 'deleted',
+    FAILED = 'failed',
+    /**
+     * A dry run, only started by hand: it reports what it would delete and changes nothing
+     */
+    INSPECTED = 'inspected'
+}
+
+/**
+ * This type represent the model of a space deletion, the only record that outlives a deleted space
+ */
+export type SpaceDeletionResponse = {
+    /**
+     * The space the deletion refers to
+     */
+    spaceId: string;
+    /**
+     * The current status of the deletion
+     */
+    status: SpaceDeletionStatus;
+    /**
+     * The name the space had, captured when the deletion was requested because deleting the space
+     * destroys it
+     */
+    spaceName?: string;
+    /**
+     * The subscription the space was claimed under, preserved for the same reason as [[spaceName]]
+     */
+    subscriptionId?: string;
+    /**
+     * The account that requested the deletion
+     */
+    requestedBy?: string;
+    /**
+     * The account that withdrew the deletion, only set when [[status]] is `revoked`
+     */
+    revokedBy?: string;
+    /**
+     * The ISO date the revocation window shuts at: until then the deletion can be withdrawn with
+     * [[SystemFacade.revokeSpaceDeletion]], after it the deletion starts
+     */
+    deleteAfter?: string;
+    /**
+     * The arn of the workflow execution performing the deletion
+     */
+    executionArn?: string;
+    /**
+     * Whether the deletion only reported what it would delete, without deleting anything
+     */
+    dryRun?: boolean;
+    /**
+     * How many rows have been deleted, per domain and per table. Written when the deletion ends
+     */
+    counts?: { [domain: string]: { [table: string]: number; }; };
+    /**
+     * The message describing why the deletion failed, only set when [[status]] is `failed`
+     */
+    error?: string;
+    /**
+     * The ISO date the deletion record was last written at
+     */
+    updatedAt?: string;
+};
+
+/**
+ * This type represent the response of a delete space API request. The deletion has not happened
+ * yet: it is only requested, and stays revocable for [[revocableForHours]]
+ */
+export type DeleteSpaceResponse = {
+    /**
+     * Always true, the request has been accepted
+     */
+    requested: boolean;
+    /**
+     * How long the deletion stays revocable, in hours
+     */
+    revocableForHours: number;
+};
+
+/**
+ * Return type of `revokeSpaceDeletion`, the withdrawn deletion record
+ */
+export type RevokeSpaceDeletionResponse = SpaceDeletionResponse;
+
+/**
+ * Return type of `getSpaceDeletionStatus`. It is null when the space has never had a deletion
+ * requested: no request is a normal answer, not a missing resource
+ */
+export type GetSpaceDeletionStatusResponse = SpaceDeletionResponse | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "10.1.0-alpha.8",
+  "version": "10.1.0",
   "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": "686fc2951c882a81cdbe56b5df9d60309dfebf95"
 }