@contentchef/contentchef-types 10.1.0-alpha.0 → 10.1.0-alpha.10

package/dist/api/ContentExportImport.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE = exports.ContentImportItemAction = exports.ContentImportItemStatus = exports.ContentImportRowType = exports.ContentImportStatus = exports.ContentExportStatus = exports.ContentExportFormat = void 0;
+/**
+ * This enum represent the file format of a content export, and the format an import file is read with
+ */
+var ContentExportFormat;
+(function (ContentExportFormat) {
+    ContentExportFormat["JSON"] = "json";
+    ContentExportFormat["CSV"] = "csv";
+})(ContentExportFormat || (exports.ContentExportFormat = ContentExportFormat = {}));
+/**
+ * This enum represent the lifecycle of a content export request. Exports are processed
+ * asynchronously, so a freshly created request is always `queued`
+ */
+var ContentExportStatus;
+(function (ContentExportStatus) {
+    ContentExportStatus["QUEUED"] = "queued";
+    ContentExportStatus["PROCESSING"] = "processing";
+    ContentExportStatus["COMPLETED"] = "completed";
+    ContentExportStatus["FAILED"] = "failed";
+})(ContentExportStatus || (exports.ContentExportStatus = ContentExportStatus = {}));
+/**
+ * This enum represent the lifecycle of a content import request. A freshly created request is
+ * `awaiting_upload` until the import file is uploaded to
+ * [[CreateContentImportRequestResponse.uploadUrl]], which is what starts the import
+ */
+var ContentImportStatus;
+(function (ContentImportStatus) {
+    ContentImportStatus["AWAITING_UPLOAD"] = "awaiting_upload";
+    ContentImportStatus["PROCESSING"] = "processing";
+    ContentImportStatus["COMPLETED"] = "completed";
+    ContentImportStatus["COMPLETED_WITH_ERRORS"] = "completed_with_errors";
+    ContentImportStatus["FAILED"] = "failed";
+})(ContentImportStatus || (exports.ContentImportStatus = ContentImportStatus = {}));
+/**
+ * This enum represent what an imported row describes: the content itself or one of its translations
+ */
+var ContentImportRowType;
+(function (ContentImportRowType) {
+    ContentImportRowType["CONTENT"] = "content";
+    ContentImportRowType["TRANSLATION"] = "translation";
+})(ContentImportRowType || (exports.ContentImportRowType = ContentImportRowType = {}));
+/**
+ * This enum represent the outcome of a single imported row
+ */
+var ContentImportItemStatus;
+(function (ContentImportItemStatus) {
+    ContentImportItemStatus["SUCCESS"] = "success";
+    ContentImportItemStatus["FAILED"] = "failed";
+})(ContentImportItemStatus || (exports.ContentImportItemStatus = ContentImportItemStatus = {}));
+/**
+ * This enum represent what the import did to the content of a successfully imported row
+ */
+var ContentImportItemAction;
+(function (ContentImportItemAction) {
+    ContentImportItemAction["UPDATED"] = "updated";
+})(ContentImportItemAction || (exports.ContentImportItemAction = ContentImportItemAction = {}));
+/**
+ * The maximum number of items a content export or import list API request can take in a single page
+ */
+exports.MAX_CONTENT_EXPORT_IMPORT_PAGE_SIZE = 100;

package/dist/api/PublishedContent.d.ts

@@ -1,7 +1,8 @@
-import { ContentId } from "./Content";
+import { ContentId, LocalizationSettings } from "./Content";
 import { AuthorResponse } from "./Author";
 import { ContentRepositoryId } from "./ContentRepository";
 import { ContentTranslationStatus } from "./ContentTranslation";
+import { PagedListResponse } from "./common";
 /**
  * The published content unique id
  */
@@ -220,6 +221,233 @@ export type UpdateReleaseRequest = {
  * This type represent the response of an update release API request
  */
 export type UpdateReleaseResponse = Release;
+/**
+ * This enum represent the comparison operators available to a release item date filter
+ */
+export declare 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 = {
+    /**
+     * Case insensitive search applied to the release item content name and public id
+     */
+    search?: string;
+    /**
+     * The release item related content locales. Matches items whose content locale is any of the given values
+     */
+    locale?: string[];
+    /**
+     * The release item related content definition mnemonic ids
+     */
+    contentDefinitionMnemonicIds?: string[];
+    /**
+     * 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;
+};
+/**
+ * This type represent the data needed to make a create release V2 API request
+ */
+export type CreateReleaseV2Request = {};
+/**
+ * This type represent the response of a create release V2 API request.
+ * Unlike [[CreateReleaseResponse]] it does not return the release items, only their count
+ */
+export type CreateReleaseV2Response = Omit<Release, "releaseItems"> & {
+    /**
+     * The number of items in the drafted release
+     */
+    itemsCount: number;
+};
+/**
+ * This type represent the data needed to make an update release V2 API request.
+ * The selection of items to publish is replaced atomically: exactly one of
+ * [[includeAll]], [[filters]] or [[releaseItemIds]] must be provided
+ */
+export type UpdateReleaseV2Request = {
+    /**
+     * The release unique id to update
+     */
+    releaseId: ReleaseId;
+    /**
+     * When true, select all the release items to be published
+     */
+    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.
+     * 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;
+    /**
+     * Select the release items with the given ids. An empty list deselects all the release items
+     */
+    releaseItemIds?: ReleaseItemId[];
+};
+/**
+ * This type represent the response of an update release V2 API request
+ */
+export type UpdateReleaseV2Response = {
+    /**
+     * The updated release unique id
+     */
+    releaseId: ReleaseId;
+    /**
+     * The number of release items selected to be published
+     */
+    selectedCount: number;
+    /**
+     * The total number of items in the release
+     */
+    totalCount: number;
+};
+/**
+ * This type represent the data needed to make a list release items V2 API request
+ */
+export type ListReleaseItemsV2Request = {
+    /**
+     * The release unique id
+     */
+    releaseId: ReleaseId;
+    /**
+     * The number of release items to skip
+     */
+    skip: number;
+    /**
+     * The number of release items to return (between 1 and 100)
+     */
+    take: number;
+    /**
+     * The filters to apply to the returned page of release items
+     */
+    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<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
+     */
+    selectedCount: number;
+    /**
+     * The distinct content locales present in the whole release
+     */
+    locales: string[];
+    /**
+     * The distinct content definition mnemonic ids present in the whole release
+     */
+    contentDefinitionMnemonicIds: string[];
+};
 /**
  * This type represent the response of a get published content API request
  */

package/dist/api/PublishedContent.js

@@ -1,2 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateFilterOperator = void 0;
+/**
+ * This enum represent the comparison operators available to a release item date filter
+ */
+var DateFilterOperator;
+(function (DateFilterOperator) {
+    DateFilterOperator["lte"] = "lte";
+    DateFilterOperator["gte"] = "gte";
+})(DateFilterOperator || (exports.DateFilterOperator = DateFilterOperator = {}));

package/dist/api/UnpublishRequest.d.ts

@@ -0,0 +1,97 @@
+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 declare const MAX_LISTED_UNPUBLISH_REQUESTS = 5;

package/dist/api/UnpublishRequest.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_LISTED_UNPUBLISH_REQUESTS = void 0;
+/**
+ * The maximum number of unpublish requests returned by a list unpublish requests API request
+ */
+exports.MAX_LISTED_UNPUBLISH_REQUESTS = 5;

package/dist/api/index.d.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/dist/api/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./Channel"), exports);
 __exportStar(require("./Content"), exports);
 __exportStar(require("./ContentDefinition"), exports);
 __exportStar(require("./ContentDefinitionSchema"), exports);
+__exportStar(require("./ContentExportImport"), exports);
 __exportStar(require("./ContentRepository"), exports);
 __exportStar(require("./ContentTag"), exports);
 __exportStar(require("./Invites"), exports);
@@ -29,6 +30,7 @@ __exportStar(require("./PublishedContent"), exports);
 __exportStar(require("./PublishingRequest"), exports);
 __exportStar(require("./Space"), exports);
 __exportStar(require("./Subscription"), exports);
+__exportStar(require("./UnpublishRequest"), exports);
 __exportStar(require("./User"), exports);
 __exportStar(require("./UserConsents"), exports);
 __exportStar(require("./UserPermission"), exports);

package/lib/api/Content.ts

@@ -29,6 +29,42 @@ export enum ContentsStatus {
   all = "all",
 }
 
+/**
+ * This enum represent the fields that can be used to sort a list of contents
+ */
+export enum ContentSortField {
+  name = "name",
+  publicId = "publicId",
+  createdDate = "createdDate",
+  lastModifiedDate = "lastModifiedDate",
+  onlineDate = "onlineDate",
+  offlineDate = "offlineDate",
+  locale = "locale",
+  definitionName = "definitionName",
+}
+
+/**
+ * This enum represent the possible sort directions
+ */
+export enum SortDirection {
+  asc = "asc",
+  desc = "desc",
+}
+
+/**
+ * This type represent the data that can be used to sort a list of contents
+ */
+export type ListContentsSort = {
+  /**
+   * The field to sort the list of contents by
+   */
+  field: ContentSortField;
+  /**
+   * The direction to sort the list of contents in
+   */
+  direction: SortDirection;
+};
+
 /**
  * This type represent the model of facet
  */
@@ -328,6 +364,34 @@ export type ListContentsFilters = {
    * This filter is used to search contents that has the tags inserted
    */
   tags?: string[];
+  /**
+   * This filter is used to search contents whose author matches (case-insensitively) one of the full names or emails inserted
+   */
+  authors?: string[];
+  /**
+   * This filter is used to search contents whose locale, or one of their translation locales, matches (case-insensitively) one of the locales inserted
+   */
+  locales?: string[];
+  /**
+   * This filter is used to search contents published in channels matching (case-insensitively) one of the mnemonic ids or names inserted
+   */
+  channels?: string[];
+  /**
+   * This filter is used to search contents with an online date starting from the ISO 8601 date inserted
+   */
+  onlineDateFrom?: string;
+  /**
+   * This filter is used to search contents with an online date up to the ISO 8601 date inserted
+   */
+  onlineDateTo?: string;
+  /**
+   * This filter is used to search contents with an offline date starting from the ISO 8601 date inserted
+   */
+  offlineDateFrom?: string;
+  /**
+   * This filter is used to search contents with an offline date up to the ISO 8601 date inserted
+   */
+  offlineDateTo?: string;
   /**
    * This filter is used to search contents in the content status inserted
    */
@@ -355,6 +419,10 @@ export type ListContentsRequest = {
    * The data used to filter the list of content
    */
   filters: ListContentsFilters;
+  /**
+   * The data used to sort the list of content
+   */
+  sort?: ListContentsSort;
 };
 
 /**