@contentchef/contentchef-types 10.1.0-alpha.4 → 10.1.0-alpha.6

package/dist/api/Content.d.ts

@@ -17,6 +17,39 @@ export declare enum ContentsStatus {
     unarchived = "unarchived",
     all = "all"
 }
+/**
+ * This enum represent the fields that can be used to sort a list of contents
+ */
+export declare 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 declare 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
  */
@@ -351,6 +384,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;
 };
 /**
  * This type represent the model of the single content returned from the list of content API request

package/dist/api/Content.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LocalizationSettings = exports.ContentFieldViolationCodes = exports.ContentsStatus = void 0;
+exports.LocalizationSettings = exports.ContentFieldViolationCodes = exports.SortDirection = exports.ContentSortField = exports.ContentsStatus = void 0;
 /**
  * This enum represent the possible content status
  */
@@ -10,6 +10,28 @@ var ContentsStatus;
     ContentsStatus["unarchived"] = "unarchived";
     ContentsStatus["all"] = "all";
 })(ContentsStatus || (exports.ContentsStatus = ContentsStatus = {}));
+/**
+ * This enum represent the fields that can be used to sort a list of contents
+ */
+var ContentSortField;
+(function (ContentSortField) {
+    ContentSortField["name"] = "name";
+    ContentSortField["publicId"] = "publicId";
+    ContentSortField["createdDate"] = "createdDate";
+    ContentSortField["lastModifiedDate"] = "lastModifiedDate";
+    ContentSortField["onlineDate"] = "onlineDate";
+    ContentSortField["offlineDate"] = "offlineDate";
+    ContentSortField["locale"] = "locale";
+    ContentSortField["definitionName"] = "definitionName";
+})(ContentSortField || (exports.ContentSortField = ContentSortField = {}));
+/**
+ * This enum represent the possible sort directions
+ */
+var SortDirection;
+(function (SortDirection) {
+    SortDirection["asc"] = "asc";
+    SortDirection["desc"] = "desc";
+})(SortDirection || (exports.SortDirection = SortDirection = {}));
 /**
  * Thin enum represent all content fields violations error codes
  */

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

@@ -13,6 +13,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

@@ -29,6 +29,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
  */
@@ -383,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;
 };
 
 /**

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

@@ -13,6 +13,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.4",
+  "version": "10.1.0-alpha.6",
   "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": "8d55c6ca85b34f658c27a974daf759e2adcf358c"
+  "gitHead": "44d000ee30bfadef421bea413b472ee5290a1000"
 }