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

package/dist/api/PublishedContent.d.ts

@@ -2,6 +2,7 @@ import { ContentId } 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,122 @@ export type UpdateReleaseRequest = {
  * This type represent the response of an update release API request
  */
 export type UpdateReleaseResponse = Release;
+/**
+ * This type represent the filters that can be applied to release items in the release V2 API requests
+ */
+export type ReleaseItemFilters = {
+    /**
+     * Case insensitive search applied to the release item content name and public id
+     */
+    search?: string;
+    /**
+     * The release item related content locale
+     */
+    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;
+};
+/**
+ * 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
+     */
+    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 the response of a list release items V2 API request.
+ * The facets ([[locales]], [[contentDefinitionMnemonicIds]]) and [[selectedCount]] are computed
+ * over the whole release, ignoring the request filters
+ */
+export type ListReleaseItemsV2Response = PagedListResponse<ReleaseItem> & {
+    /**
+     * 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/PublishingRequest.d.ts

@@ -119,3 +119,71 @@ export type ListPublishingRequestsResponse = PublishingRequestResponse[];
  * This type represent the response of a create publishing request API request
  */
 export type CreatePublishingRequestResponse = PublishingRequestResponse;
+/**
+ * The maximum number of items that can be sent in a single bulk publishing request
+ */
+export declare const MAX_BULK_PUBLISHING_REQUESTS = 50;
+/**
+ * This type represent a single item of a bulk publishing request
+ */
+export type BulkPublishingRequestItem = PublishingRequestRequest;
+/**
+ * This type represent the data needed to make a bulk create publishing request API request
+ */
+export type CreateBulkPublishingRequestRequest = {
+    /**
+     * The list of contents (and their version) to create a publishing request for.
+     * Must contain between 1 and [[MAX_BULK_PUBLISHING_REQUESTS]] items.
+     * Duplicate content id / version pairs are deduplicated server-side.
+     */
+    requests: BulkPublishingRequestItem[];
+};
+/**
+ * This enum represent the outcome of a single item within a bulk publishing request
+ */
+export declare enum BulkPublishingRequestStatus {
+    ACCEPTED = "accepted",
+    FAILED = "failed"
+}
+/**
+ * This type represent the error attached to a failed bulk publishing request item
+ */
+export type BulkPublishingRequestError = {
+    /**
+     * The error type discriminator
+     */
+    type: string;
+    /**
+     * The human readable error message
+     */
+    message: string;
+};
+/**
+ * This type represent the outcome of a single item within a bulk publishing request
+ */
+export type BulkPublishingRequestResult = {
+    /**
+     * The content id the result refers to
+     */
+    contentId: number;
+    /**
+     * The content version the result refers to
+     */
+    contentVersion: number;
+    /**
+     * Whether the publishing request for this item was accepted or failed
+     */
+    status: BulkPublishingRequestStatus;
+    /**
+     * The created publishing request unique id, present only when [[status]] is `accepted`
+     */
+    publishingRequestId?: PublishingRequestId;
+    /**
+     * The error describing why the item failed, present only when [[status]] is `failed`
+     */
+    error?: BulkPublishingRequestError;
+};
+/**
+ * This type represent the response of a bulk create publishing request API request
+ */
+export type CreateBulkPublishingRequestResponse = BulkPublishingRequestResult[];

package/dist/api/PublishingRequest.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PublishingStatus = void 0;
+exports.BulkPublishingRequestStatus = exports.MAX_BULK_PUBLISHING_REQUESTS = exports.PublishingStatus = void 0;
 /**
  * This enum represent the available publishing request status
  */
@@ -11,3 +11,15 @@ var PublishingStatus;
     PublishingStatus["PUBLISHED"] = "published";
     PublishingStatus["FAILED"] = "failed";
 })(PublishingStatus || (exports.PublishingStatus = PublishingStatus = {}));
+/**
+ * The maximum number of items that can be sent in a single bulk publishing request
+ */
+exports.MAX_BULK_PUBLISHING_REQUESTS = 50;
+/**
+ * This enum represent the outcome of a single item within a bulk publishing request
+ */
+var BulkPublishingRequestStatus;
+(function (BulkPublishingRequestStatus) {
+    BulkPublishingRequestStatus["ACCEPTED"] = "accepted";
+    BulkPublishingRequestStatus["FAILED"] = "failed";
+})(BulkPublishingRequestStatus || (exports.BulkPublishingRequestStatus = BulkPublishingRequestStatus = {}));

package/lib/api/PublishedContent.ts

@@ -2,6 +2,7 @@ import { ContentId } 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,129 @@ 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
+ */
+export type ReleaseItemFilters = {
+  /**
+   * Case insensitive search applied to the release item content name and public id
+   */
+  search?: string;
+  /**
+   * The release item related content locale
+   */
+  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;
+};
+
+/**
+ * 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
+   */
+  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 the response of a list release items V2 API request.
+ * The facets ([[locales]], [[contentDefinitionMnemonicIds]]) and [[selectedCount]] are computed
+ * over the whole release, ignoring the request filters
+ */
+export type ListReleaseItemsV2Response = PagedListResponse<ReleaseItem> & {
+  /**
+   * 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/PublishingRequest.ts

@@ -126,3 +126,78 @@ export type ListPublishingRequestsResponse = PublishingRequestResponse[];
  * This type represent the response of a create publishing request API request
  */
 export type CreatePublishingRequestResponse = PublishingRequestResponse;
+
+/**
+ * The maximum number of items that can be sent in a single bulk publishing request
+ */
+export const MAX_BULK_PUBLISHING_REQUESTS = 50;
+
+/**
+ * This type represent a single item of a bulk publishing request
+ */
+export type BulkPublishingRequestItem = PublishingRequestRequest;
+
+/**
+ * This type represent the data needed to make a bulk create publishing request API request
+ */
+export type CreateBulkPublishingRequestRequest = {
+    /**
+     * The list of contents (and their version) to create a publishing request for.
+     * Must contain between 1 and [[MAX_BULK_PUBLISHING_REQUESTS]] items.
+     * Duplicate content id / version pairs are deduplicated server-side.
+     */
+    requests: BulkPublishingRequestItem[];
+};
+
+/**
+ * This enum represent the outcome of a single item within a bulk publishing request
+ */
+export enum BulkPublishingRequestStatus {
+    ACCEPTED = 'accepted',
+    FAILED = 'failed'
+}
+
+/**
+ * This type represent the error attached to a failed bulk publishing request item
+ */
+export type BulkPublishingRequestError = {
+    /**
+     * The error type discriminator
+     */
+    type: string;
+    /**
+     * The human readable error message
+     */
+    message: string;
+};
+
+/**
+ * This type represent the outcome of a single item within a bulk publishing request
+ */
+export type BulkPublishingRequestResult = {
+    /**
+     * The content id the result refers to
+     */
+    contentId: number;
+    /**
+     * The content version the result refers to
+     */
+    contentVersion: number;
+    /**
+     * Whether the publishing request for this item was accepted or failed
+     */
+    status: BulkPublishingRequestStatus;
+    /**
+     * The created publishing request unique id, present only when [[status]] is `accepted`
+     */
+    publishingRequestId?: PublishingRequestId;
+    /**
+     * The error describing why the item failed, present only when [[status]] is `failed`
+     */
+    error?: BulkPublishingRequestError;
+};
+
+/**
+ * This type represent the response of a bulk create publishing request API request
+ */
+export type CreateBulkPublishingRequestResponse = BulkPublishingRequestResult[];

package/package.json

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