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

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
  */
@@ -298,6 +331,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
      */
@@ -323,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/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;
 };
 
 /**

package/package.json

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