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

package/dist/api/PublishedContent.d.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";
@@ -230,9 +230,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
      */
@@ -318,12 +318,89 @@ 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/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";
@@ -244,9 +244,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
    */
@@ -338,12 +338,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/package.json

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