@contentchef/contentchef-types 11.2.0-alpha.3 → 11.2.0-alpha.4

package/dist/api/PublishedContent.d.ts

@@ -1,4 +1,4 @@
-import { ContentId, LocalizationSettings } from "./Content";
+import { ContentId, LocalizationSettings, SortDirection } from "./Content";
 import { AuthorResponse } from "./Author";
 import { ContentRepositoryId } from "./ContentRepository";
 import { ContentTranslationStatus } from "./ContentTranslation";
@@ -452,3 +452,312 @@ export type ListReleaseItemsV2Response = PagedListResponse<ReleaseItemGroup> & {
  * This type represent the response of a get published content API request
  */
 export type GetPublishedContentResponse = PublishedContentResponse | undefined;
+/**
+ * This enum represent how the items of [[PropFilters]] combine
+ */
+export declare enum LogicalOperators {
+    AND = "AND",
+    OR = "OR"
+}
+/**
+ * This enum represent how a [[PropFilterItem]] compares an indexed field with its value. The `_IC`
+ * variants ignore case
+ */
+export declare enum ConditionOperators {
+    CONTAINS = "CONTAINS",
+    CONTAINS_IC = "CONTAINS_IC",
+    EQUALS = "EQUALS",
+    EQUALS_IC = "EQUALS_IC",
+    IN = "IN",
+    IN_IC = "IN_IC",
+    STARTS_WITH = "STARTS_WITH",
+    STARTS_WITH_IC = "STARTS_WITH_IC"
+}
+/**
+ * This type represent one condition over an indexed field of a published content, as the delivery API
+ * takes it
+ */
+export type PropFilterItem = {
+    field: string;
+    operator: ConditionOperators;
+    /**
+     * An array for [[ConditionOperators.IN]] and [[ConditionOperators.IN_IC]]
+     */
+    value: string | string[];
+};
+/**
+ * This type represent the delivery API's property filters, over the indexed fields of a published content
+ */
+export type PropFilters = {
+    condition: LogicalOperators;
+    /**
+     * From 1 to 10
+     */
+    items: PropFilterItem[];
+};
+/**
+ * This type represent which date of a content's online window has to fall within a timeline's range:
+ * `overlap`, online at some point of it, `starts`, its online date, or `ends`, its offline date
+ */
+export type TimelineMatch = "overlap" | "starts" | "ends";
+/**
+ * This type represent the range and filters of the timeline API requests. Every filter given applies,
+ * together, and a list filter matches a content that has one of its values
+ */
+export type TimelineFilters = {
+    /**
+     * The range's start, as an ISO 8601 string. With `from` equal to `to`, what is online at that instant
+     */
+    from: string;
+    /**
+     * The range's end, as an ISO 8601 string, not before `from` and at most 400 days after it
+     */
+    to: string;
+    /**
+     * `overlap` by default
+     */
+    match?: TimelineMatch;
+    /**
+     * Whether the contents with neither date, online all the time, are left out, by default, or included
+     */
+    undated?: "exclude" | "include";
+    /**
+     * From 2 to 100 characters, matched anywhere in the name, the public id or the external identifier,
+     * ignoring case
+     */
+    search?: string;
+    /**
+     * Up to 500
+     */
+    publicIds?: string[];
+    /**
+     * Up to 500
+     */
+    contentIds?: ContentId[];
+    /**
+     * Content definition mnemonic ids, up to 100
+     */
+    definitions?: string[];
+    /**
+     * Content repository mnemonic ids, up to 100
+     */
+    repositories?: string[];
+    /**
+     * Up to 100
+     */
+    channels?: string[];
+    /**
+     * Up to 100
+     */
+    tags?: string[];
+    /**
+     * Up to 100
+     */
+    locales?: string[];
+    propFilters?: PropFilters;
+};
+/**
+ * This type represent a version of a content on the timeline: `live`, the one delivery serves, or
+ * `pending`, the one published to stage and not promoted yet
+ */
+export type TimelineVersionKind = "live" | "pending";
+/**
+ * This type represent what the timeline can be sorted by. With both versions, a content sorts by the
+ * earlier online date, the later offline date and the latest publish of the two
+ */
+export type TimelineSort = "onlineDate" | "offlineDate" | "name" | "publicId" | "definition" | "lastPublished";
+/**
+ * This type represent the data needed to make a list timeline API request
+ */
+export type ListTimelineRequest = TimelineFilters & {
+    /**
+     * Both by default
+     */
+    versions?: TimelineVersionKind[];
+    /**
+     * `onlineDate` by default
+     */
+    sort?: TimelineSort;
+    /**
+     * Ascending by default
+     */
+    order?: SortDirection;
+    /**
+     * true counts the filtered contents per definition, repository, channel, tag and locale
+     */
+    facets?: boolean;
+    /**
+     * 0 by default
+     */
+    skip?: number;
+    /**
+     * 50 by default, at most 200, counted in contents
+     */
+    take?: number;
+};
+/**
+ * This type represent one version of a content on the timeline, as its default locale has it
+ */
+export type TimelineVersion = {
+    version: number;
+    /**
+     * As an ISO 8601 string, null without one
+     */
+    onlineDate: string | null;
+    /**
+     * As an ISO 8601 string, null without one
+     */
+    offlineDate: string | null;
+    /**
+     * When the version was published to stage, as an ISO 8601 string
+     */
+    publishedDate: string;
+    channels: string[];
+    tags: string[];
+    /**
+     * Every locale of the version
+     */
+    locales: string[];
+};
+/**
+ * This type represent a content on the timeline, with each of its versions asked for
+ */
+export type TimelineItem = {
+    contentId: ContentId;
+    /**
+     * The pending version's when there is one, as `name` and `externalIdentifier`
+     */
+    publicId: string;
+    name: string;
+    externalIdentifier: string | null;
+    /**
+     * The content definition mnemonic id
+     */
+    definition: string;
+    /**
+     * The content repository mnemonic id
+     */
+    repository: string;
+    /**
+     * null for a content only in stage
+     */
+    live: TimelineVersion | null;
+    /**
+     * null for a content whose staged version is the live one
+     */
+    pending: TimelineVersion | null;
+};
+/**
+ * This type represent, per value, how many of the filtered contents have it. A content with two versions
+ * counts once per value either has
+ */
+export type TimelineFacets = {
+    definitions: {
+        [mnemonicId: string]: number;
+    };
+    repositories: {
+        [mnemonicId: string]: number;
+    };
+    channels: {
+        [channel: string]: number;
+    };
+    tags: {
+        [tag: string]: number;
+    };
+    locales: {
+        [locale: string]: number;
+    };
+};
+/**
+ * This type represent the response of a list timeline API request
+ */
+export type ListTimelineResponse = {
+    items: TimelineItem[];
+    total: number;
+    /**
+     * The contents with neither date, whether `undated` excludes them or not
+     */
+    undated: number;
+    /**
+     * Only when asked for
+     */
+    facets?: TimelineFacets;
+};
+/**
+ * This type represent the size of a timeline summary's buckets. A week starts on Monday
+ */
+export type TimelineBucket = "day" | "week" | "month";
+/**
+ * This type represent what a timeline summary counts: `live`, what delivery serves, or `afterRelease`,
+ * what it would serve were the staged versions promoted
+ */
+export type TimelineState = "live" | "afterRelease";
+/**
+ * This type represent the data needed to make a get timeline summary API request
+ */
+export type GetTimelineSummaryRequest = TimelineFilters & {
+    bucket: TimelineBucket;
+    /**
+     * An IANA time zone, `UTC` by default: buckets start at its midnights
+     */
+    timeZone?: string;
+    /**
+     * `live` by default
+     */
+    state?: TimelineState;
+};
+/**
+ * This type represent the counts of one bucket of a timeline summary
+ */
+export type TimelineBucketCount = {
+    /**
+     * The bucket's first day in the time zone, as `YYYY-MM-DD`
+     */
+    date: string;
+    /**
+     * The bucket's start, as an ISO 8601 string in UTC
+     */
+    from: string;
+    /**
+     * The bucket's end, as an ISO 8601 string in UTC
+     */
+    to: string;
+    /**
+     * The contents online at some point of the bucket
+     */
+    online: number;
+    /**
+     * The contents whose online date falls within the bucket
+     */
+    comingOnline: number;
+    /**
+     * The contents whose offline date falls within the bucket
+     */
+    goingOffline: number;
+};
+/**
+ * This type represent the response of a get timeline summary API request: one entry per bucket, from the
+ * one holding `from` to the one holding `to`
+ */
+export type GetTimelineSummaryResponse = TimelineBucketCount[];
+/**
+ * Thin enum represent the error types of the timeline API requests. Each is the `type` of a
+ * `RequestError`, whose `details` is a [[TimelineError]]
+ */
+export declare enum TimelineErrorTypes {
+    /**
+     * `to` before `from`, a range over 400 days, or an unknown time zone
+     */
+    invalidTimelineQuery = "InvalidTimelineQuery",
+    /**
+     * The query took over 4 seconds and was stopped: narrow the range or the filters
+     */
+    timelineTooSlow = "TimelineTooSlow"
+}
+/**
+ * This type represent the `details` of a `RequestError` whose `type` is one of [[TimelineErrorTypes]]
+ */
+export type TimelineError = {
+    type: TimelineErrorTypes;
+    message: string;
+};

package/dist/api/PublishedContent.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DateFilterOperator = void 0;
+exports.TimelineErrorTypes = exports.ConditionOperators = exports.LogicalOperators = exports.DateFilterOperator = void 0;
 /**
  * This enum represent the comparison operators available to a release item date filter
  */
@@ -9,3 +9,41 @@ var DateFilterOperator;
     DateFilterOperator["lte"] = "lte";
     DateFilterOperator["gte"] = "gte";
 })(DateFilterOperator || (exports.DateFilterOperator = DateFilterOperator = {}));
+/**
+ * This enum represent how the items of [[PropFilters]] combine
+ */
+var LogicalOperators;
+(function (LogicalOperators) {
+    LogicalOperators["AND"] = "AND";
+    LogicalOperators["OR"] = "OR";
+})(LogicalOperators || (exports.LogicalOperators = LogicalOperators = {}));
+/**
+ * This enum represent how a [[PropFilterItem]] compares an indexed field with its value. The `_IC`
+ * variants ignore case
+ */
+var ConditionOperators;
+(function (ConditionOperators) {
+    ConditionOperators["CONTAINS"] = "CONTAINS";
+    ConditionOperators["CONTAINS_IC"] = "CONTAINS_IC";
+    ConditionOperators["EQUALS"] = "EQUALS";
+    ConditionOperators["EQUALS_IC"] = "EQUALS_IC";
+    ConditionOperators["IN"] = "IN";
+    ConditionOperators["IN_IC"] = "IN_IC";
+    ConditionOperators["STARTS_WITH"] = "STARTS_WITH";
+    ConditionOperators["STARTS_WITH_IC"] = "STARTS_WITH_IC";
+})(ConditionOperators || (exports.ConditionOperators = ConditionOperators = {}));
+/**
+ * Thin enum represent the error types of the timeline API requests. Each is the `type` of a
+ * `RequestError`, whose `details` is a [[TimelineError]]
+ */
+var TimelineErrorTypes;
+(function (TimelineErrorTypes) {
+    /**
+     * `to` before `from`, a range over 400 days, or an unknown time zone
+     */
+    TimelineErrorTypes["invalidTimelineQuery"] = "InvalidTimelineQuery";
+    /**
+     * The query took over 4 seconds and was stopped: narrow the range or the filters
+     */
+    TimelineErrorTypes["timelineTooSlow"] = "TimelineTooSlow";
+})(TimelineErrorTypes || (exports.TimelineErrorTypes = TimelineErrorTypes = {}));

package/lib/api/PublishedContent.ts

@@ -1,4 +1,4 @@
-import { ContentId, LocalizationSettings } from "./Content";
+import { ContentId, LocalizationSettings, SortDirection } from "./Content";
 import { AuthorResponse } from "./Author";
 import { ContentRepositoryId } from "./ContentRepository";
 import { ContentTranslationStatus } from "./ContentTranslation";
@@ -477,3 +477,325 @@ export type ListReleaseItemsV2Response = PagedListResponse<ReleaseItemGroup> & {
  * This type represent the response of a get published content API request
  */
 export type GetPublishedContentResponse = PublishedContentResponse | undefined;
+
+/**
+ * This enum represent how the items of [[PropFilters]] combine
+ */
+export enum LogicalOperators {
+  AND = "AND",
+  OR = "OR",
+}
+
+/**
+ * This enum represent how a [[PropFilterItem]] compares an indexed field with its value. The `_IC`
+ * variants ignore case
+ */
+export enum ConditionOperators {
+  CONTAINS = "CONTAINS",
+  CONTAINS_IC = "CONTAINS_IC",
+  EQUALS = "EQUALS",
+  EQUALS_IC = "EQUALS_IC",
+  IN = "IN",
+  IN_IC = "IN_IC",
+  STARTS_WITH = "STARTS_WITH",
+  STARTS_WITH_IC = "STARTS_WITH_IC",
+}
+
+/**
+ * This type represent one condition over an indexed field of a published content, as the delivery API
+ * takes it
+ */
+export type PropFilterItem = {
+  field: string;
+  operator: ConditionOperators;
+  /**
+   * An array for [[ConditionOperators.IN]] and [[ConditionOperators.IN_IC]]
+   */
+  value: string | string[];
+};
+
+/**
+ * This type represent the delivery API's property filters, over the indexed fields of a published content
+ */
+export type PropFilters = {
+  condition: LogicalOperators;
+  /**
+   * From 1 to 10
+   */
+  items: PropFilterItem[];
+};
+
+/**
+ * This type represent which date of a content's online window has to fall within a timeline's range:
+ * `overlap`, online at some point of it, `starts`, its online date, or `ends`, its offline date
+ */
+export type TimelineMatch = "overlap" | "starts" | "ends";
+
+/**
+ * This type represent the range and filters of the timeline API requests. Every filter given applies,
+ * together, and a list filter matches a content that has one of its values
+ */
+export type TimelineFilters = {
+  /**
+   * The range's start, as an ISO 8601 string. With `from` equal to `to`, what is online at that instant
+   */
+  from: string;
+  /**
+   * The range's end, as an ISO 8601 string, not before `from` and at most 400 days after it
+   */
+  to: string;
+  /**
+   * `overlap` by default
+   */
+  match?: TimelineMatch;
+  /**
+   * Whether the contents with neither date, online all the time, are left out, by default, or included
+   */
+  undated?: "exclude" | "include";
+  /**
+   * From 2 to 100 characters, matched anywhere in the name, the public id or the external identifier,
+   * ignoring case
+   */
+  search?: string;
+  /**
+   * Up to 500
+   */
+  publicIds?: string[];
+  /**
+   * Up to 500
+   */
+  contentIds?: ContentId[];
+  /**
+   * Content definition mnemonic ids, up to 100
+   */
+  definitions?: string[];
+  /**
+   * Content repository mnemonic ids, up to 100
+   */
+  repositories?: string[];
+  /**
+   * Up to 100
+   */
+  channels?: string[];
+  /**
+   * Up to 100
+   */
+  tags?: string[];
+  /**
+   * Up to 100
+   */
+  locales?: string[];
+  propFilters?: PropFilters;
+};
+
+/**
+ * This type represent a version of a content on the timeline: `live`, the one delivery serves, or
+ * `pending`, the one published to stage and not promoted yet
+ */
+export type TimelineVersionKind = "live" | "pending";
+
+/**
+ * This type represent what the timeline can be sorted by. With both versions, a content sorts by the
+ * earlier online date, the later offline date and the latest publish of the two
+ */
+export type TimelineSort =
+  | "onlineDate"
+  | "offlineDate"
+  | "name"
+  | "publicId"
+  | "definition"
+  | "lastPublished";
+
+/**
+ * This type represent the data needed to make a list timeline API request
+ */
+export type ListTimelineRequest = TimelineFilters & {
+  /**
+   * Both by default
+   */
+  versions?: TimelineVersionKind[];
+  /**
+   * `onlineDate` by default
+   */
+  sort?: TimelineSort;
+  /**
+   * Ascending by default
+   */
+  order?: SortDirection;
+  /**
+   * true counts the filtered contents per definition, repository, channel, tag and locale
+   */
+  facets?: boolean;
+  /**
+   * 0 by default
+   */
+  skip?: number;
+  /**
+   * 50 by default, at most 200, counted in contents
+   */
+  take?: number;
+};
+
+/**
+ * This type represent one version of a content on the timeline, as its default locale has it
+ */
+export type TimelineVersion = {
+  version: number;
+  /**
+   * As an ISO 8601 string, null without one
+   */
+  onlineDate: string | null;
+  /**
+   * As an ISO 8601 string, null without one
+   */
+  offlineDate: string | null;
+  /**
+   * When the version was published to stage, as an ISO 8601 string
+   */
+  publishedDate: string;
+  channels: string[];
+  tags: string[];
+  /**
+   * Every locale of the version
+   */
+  locales: string[];
+};
+
+/**
+ * This type represent a content on the timeline, with each of its versions asked for
+ */
+export type TimelineItem = {
+  contentId: ContentId;
+  /**
+   * The pending version's when there is one, as `name` and `externalIdentifier`
+   */
+  publicId: string;
+  name: string;
+  externalIdentifier: string | null;
+  /**
+   * The content definition mnemonic id
+   */
+  definition: string;
+  /**
+   * The content repository mnemonic id
+   */
+  repository: string;
+  /**
+   * null for a content only in stage
+   */
+  live: TimelineVersion | null;
+  /**
+   * null for a content whose staged version is the live one
+   */
+  pending: TimelineVersion | null;
+};
+
+/**
+ * This type represent, per value, how many of the filtered contents have it. A content with two versions
+ * counts once per value either has
+ */
+export type TimelineFacets = {
+  definitions: { [mnemonicId: string]: number };
+  repositories: { [mnemonicId: string]: number };
+  channels: { [channel: string]: number };
+  tags: { [tag: string]: number };
+  locales: { [locale: string]: number };
+};
+
+/**
+ * This type represent the response of a list timeline API request
+ */
+export type ListTimelineResponse = {
+  items: TimelineItem[];
+  total: number;
+  /**
+   * The contents with neither date, whether `undated` excludes them or not
+   */
+  undated: number;
+  /**
+   * Only when asked for
+   */
+  facets?: TimelineFacets;
+};
+
+/**
+ * This type represent the size of a timeline summary's buckets. A week starts on Monday
+ */
+export type TimelineBucket = "day" | "week" | "month";
+
+/**
+ * This type represent what a timeline summary counts: `live`, what delivery serves, or `afterRelease`,
+ * what it would serve were the staged versions promoted
+ */
+export type TimelineState = "live" | "afterRelease";
+
+/**
+ * This type represent the data needed to make a get timeline summary API request
+ */
+export type GetTimelineSummaryRequest = TimelineFilters & {
+  bucket: TimelineBucket;
+  /**
+   * An IANA time zone, `UTC` by default: buckets start at its midnights
+   */
+  timeZone?: string;
+  /**
+   * `live` by default
+   */
+  state?: TimelineState;
+};
+
+/**
+ * This type represent the counts of one bucket of a timeline summary
+ */
+export type TimelineBucketCount = {
+  /**
+   * The bucket's first day in the time zone, as `YYYY-MM-DD`
+   */
+  date: string;
+  /**
+   * The bucket's start, as an ISO 8601 string in UTC
+   */
+  from: string;
+  /**
+   * The bucket's end, as an ISO 8601 string in UTC
+   */
+  to: string;
+  /**
+   * The contents online at some point of the bucket
+   */
+  online: number;
+  /**
+   * The contents whose online date falls within the bucket
+   */
+  comingOnline: number;
+  /**
+   * The contents whose offline date falls within the bucket
+   */
+  goingOffline: number;
+};
+
+/**
+ * This type represent the response of a get timeline summary API request: one entry per bucket, from the
+ * one holding `from` to the one holding `to`
+ */
+export type GetTimelineSummaryResponse = TimelineBucketCount[];
+
+/**
+ * Thin enum represent the error types of the timeline API requests. Each is the `type` of a
+ * `RequestError`, whose `details` is a [[TimelineError]]
+ */
+export enum TimelineErrorTypes {
+  /**
+   * `to` before `from`, a range over 400 days, or an unknown time zone
+   */
+  invalidTimelineQuery = "InvalidTimelineQuery",
+  /**
+   * The query took over 4 seconds and was stopped: narrow the range or the filters
+   */
+  timelineTooSlow = "TimelineTooSlow",
+}
+
+/**
+ * This type represent the `details` of a `RequestError` whose `type` is one of [[TimelineErrorTypes]]
+ */
+export type TimelineError = { type: TimelineErrorTypes; message: string };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "11.2.0-alpha.3",
+  "version": "11.2.0-alpha.4",
   "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": "2c7d06e055598e85bcd776844dc388f0633009a3"
+  "gitHead": "4768ad3fee441d17e997f7461a28ec12dbe19b5e"
 }