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

package/lib/api/PublishedContent.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
@@ -234,6 +235,244 @@ export type UpdateReleaseRequest = {
  */
 export type UpdateReleaseResponse = Release;
 
+/**
+ * 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 = {
+  /**
+   * 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/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.0",
+  "version": "10.1.0-alpha.10",
   "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": "b8990446304be212c6953c04b2a148669d190cf9"
+  "gitHead": "0cc1e6b2a9468100a09fed18ab3ffaca0bcb53e8"
 }