@contentchef/contentchef-types 10.1.0-alpha.1 → 10.1.0-alpha.11

package/lib/api/PublishedContent.ts

@@ -1,4 +1,4 @@
-import { ContentId } from "./Content";
+import { ContentId, LocalizationSettings } from "./Content";
 import { AuthorResponse } from "./Author";
 import { ContentRepositoryId } from "./ContentRepository";
 import { ContentTranslationStatus } from "./ContentTranslation";
@@ -236,7 +236,31 @@ export type UpdateReleaseRequest = {
 export type UpdateReleaseResponse = Release;
 
 /**
- * This type represent the filters that can be applied to release items in the release V2 API requests
+ * This enum represent the comparison operators available to a release item date filter
+ */
+export enum DateFilterOperator {
+  lte = "lte",
+  gte = "gte",
+}
+
+/**
+ * This type represent a filter applied to one of the release item date fields
+ */
+export type ReleaseItemDateFilter = {
+  /**
+   * The date to compare the release item date field with, as an ISO 8601 string
+   */
+  value: string;
+  /**
+   * The comparison to apply to the release item date field.
+   * Defaults to [[DateFilterOperator.lte]], i.e. "at or before"
+   */
+  operator?: DateFilterOperator;
+};
+
+/**
+ * This type represent the filters that can be applied to release items in the release V2 API requests.
+ * When more than one filter is given they are combined with AND
  */
 export type ReleaseItemFilters = {
   /**
@@ -244,9 +268,9 @@ export type ReleaseItemFilters = {
    */
   search?: string;
   /**
-   * The release item related content locale
+   * The release item related content locales. Matches items whose content locale is any of the given values
    */
-  locale?: string;
+  locale?: string[];
   /**
    * The release item related content definition mnemonic ids
    */
@@ -255,6 +279,16 @@ export type ReleaseItemFilters = {
    * Match only the release items that are (or are not) currently selected to be published
    */
   toPublish?: boolean;
+  /**
+   * Match only the release items whose related content online date satisfies the filter.
+   * Release items with no online date never match, whatever the operator
+   */
+  onlineDate?: ReleaseItemDateFilter;
+  /**
+   * Match only the release items whose related content offline date satisfies the filter.
+   * Release items with no offline date never match, whatever the operator
+   */
+  offlineDate?: ReleaseItemDateFilter;
 };
 
 /**
@@ -289,7 +323,9 @@ export type UpdateReleaseV2Request = {
   includeAll?: boolean;
   /**
    * Select the release items matching the given filters. Empty filters select all the release items.
-   * A toPublish filter is evaluated against the selection before the update
+   * A toPublish filter is evaluated against the selection before the update.
+   * The filters are the same ones accepted by [[ListReleaseItemsV2Request]], so a selection can be
+   * previewed with `listReleaseItemsV2` and then applied by passing the very same filters here
    */
   filters?: ReleaseItemFilters;
   /**
@@ -338,12 +374,91 @@ export type ListReleaseItemsV2Request = {
   filters?: ReleaseItemFilters;
 };
 
+/**
+ * This type represent a single locale variant of a content inside a release item group
+ */
+export type ReleaseItemVariant = {
+  /**
+   * The release item unique id
+   */
+  id: ReleaseItemId;
+  /**
+   * The variant content locale
+   */
+  contentLocale: string | null;
+  /**
+   * Mark if the release item is selected to be published
+   */
+  toPublish: boolean;
+  /**
+   * Status of the ContentTranslation (defined if content is derived from a translation)
+   */
+  translationStatus: ContentTranslationStatus | null;
+  /**
+   * The localization settings of the related content
+   */
+  contentLocalizationSettings: LocalizationSettings;
+  /**
+   * The localized content unique id (defined if content is derived from a translation)
+   */
+  localizedContentId: string | null;
+  /**
+   * The release item related content tags
+   */
+  contentTags: string[];
+  /**
+   * The release item related content online date, as an ISO 8601 string
+   */
+  onlineDate: string | null;
+  /**
+   * The release item related content offline date, as an ISO 8601 string
+   */
+  offlineDate: string | null;
+};
+
+/**
+ * This type represent a release content along with its locale variants matching the request filters
+ */
+export type ReleaseItemGroup = {
+  /**
+   * The related content unique id
+   */
+  contentId: ContentId;
+  /**
+   * The related content public id
+   */
+  publicId: string;
+  /**
+   * The related content name
+   */
+  contentName: string;
+  /**
+   * The related content definition mnemonic id
+   */
+  contentDefinitionMnemonicId: string;
+  /**
+   * The related content repository mnemonic id
+   */
+  contentRepositoryMnemonicId: string;
+  /**
+   * The locale variants of the content matching the request filters
+   */
+  variants: ReleaseItemVariant[];
+};
+
 /**
  * This type represent the response of a list release items V2 API request.
+ * The release items are grouped by content: one [[ReleaseItemGroup]] per content id with all of its
+ * filter-matching locale variants, so pagination (over groups) never splits a content across pages
+ * and [[PagedListResponse.total]] counts the matching groups.
  * The facets ([[locales]], [[contentDefinitionMnemonicIds]]) and [[selectedCount]] are computed
  * over the whole release, ignoring the request filters
  */
-export type ListReleaseItemsV2Response = PagedListResponse<ReleaseItem> & {
+export type ListReleaseItemsV2Response = PagedListResponse<ReleaseItemGroup> & {
+  /**
+   * The total number of release items matching the request filters
+   */
+  totalItems: number;
   /**
    * The number of release items selected to be published in the whole release
    */

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/lib/api/UnpublishRequest.ts

@@ -0,0 +1,104 @@
+import { ContentId } from './Content';
+import { AuthorResponse } from './Author';
+
+/**
+ * The unpublish request unique id
+ */
+export type UnpublishRequestId = number;
+
+/**
+ * This type represent the data needed to make an unpublish content API request
+ */
+export type UnpublishContentRequest = {
+    /**
+     * The content id to unpublish. Every staged locale of the content is unpublished
+     */
+    contentId: number;
+};
+
+/**
+ * This type represent the response of an unpublish content API request
+ */
+export type UnpublishContentResponse = {
+    /**
+     * The staged content version that has been removed.
+     * Undefined when nothing was staged, meaning the request was a no-op
+     */
+    contentVersion?: number;
+    /**
+     * The content locales whose staged content has actually been removed or reverted to its live version
+     */
+    locales: string[];
+    /**
+     * The number of release items dropped from the non archived releases containing the content
+     */
+    removedReleaseItems: number;
+};
+
+/**
+ * This type represent the data needed to make a list unpublish requests API request
+ */
+export type ListUnpublishRequestsRequest = {
+    /**
+     * The content id to list the unpublish requests of
+     */
+    contentId: number;
+    /**
+     * The content version to list the unpublish requests of.
+     * When omitted the whole unpublish history of the content is returned
+     */
+    contentVersion?: number;
+};
+
+/**
+ * This type represent the model of an unpublish request, the audit record of a content
+ * having been unpublished. It is written after the unpublish has been applied, so it always
+ * describes a completed unpublish
+ */
+export type UnpublishRequestResponse = {
+    /**
+     * The unpublish request unique id
+     */
+    id: UnpublishRequestId;
+    /**
+     * The author that unpublished the content
+     */
+    author: AuthorResponse;
+    /**
+     * The unique id of the unpublished content
+     */
+    contentId: ContentId;
+    /**
+     * The unpublished content version
+     */
+    contentVersion: number;
+    /**
+     * The content locales that have been unpublished
+     */
+    locales: string[];
+    /**
+     * The date the content has been unpublished, as opposed to [[createdDate]]
+     * which is the date this audit record has been written
+     */
+    unpublishedDate: Date;
+    /**
+     * The unpublish request creation date
+     */
+    createdDate: Date;
+    /**
+     * The unpublish request last modified date
+     */
+    lastModifiedDate: Date;
+};
+
+/**
+ * This type represent the response of a list unpublish requests API request, sorted by
+ * [[UnpublishRequestResponse.unpublishedDate]] descending.
+ * Only the [[MAX_LISTED_UNPUBLISH_REQUESTS]] most recent unpublish requests are returned
+ */
+export type ListUnpublishRequestsResponse = UnpublishRequestResponse[];
+
+/**
+ * The maximum number of unpublish requests returned by a list unpublish requests API request
+ */
+export const MAX_LISTED_UNPUBLISH_REQUESTS = 5;

package/lib/api/index.ts

@@ -5,6 +5,7 @@ export * from './Channel';
 export * from './Content';
 export * from './ContentDefinition';
 export * from './ContentDefinitionSchema';
+export * from './ContentExportImport';
 export * from './ContentRepository';
 export * from './ContentTag';
 export * from './Invites';
@@ -13,6 +14,7 @@ export * from './PublishedContent';
 export * from './PublishingRequest';
 export * from './Space';
 export * from './Subscription';
+export * from './UnpublishRequest';
 export * from './User';
 export * from './UserConsents';
 export * from './UserPermission';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "10.1.0-alpha.1",
+  "version": "10.1.0-alpha.11",
   "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": "05e45ae2e7f58035520a882982dceabef27a063d"
+  "gitHead": "ea72e6f60f7e98e9b54477fc72ec7673502d9e93"
 }