@contentchef/contentchef-types 2.6.0-alpha.0 → 2.6.1-alpha.0

package/dist/api/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/extension/index.d.ts

@@ -28,15 +28,15 @@ export declare enum Message {
     UPDATE_PUBLISHING_CHANNEL = "updatePublishingChannel",
     PUBLISH_CONTENT = "publishContent"
 }
-export declare type SystemMessage = Message.CONNECT | Message.RESULT | Message.ERROR;
-export declare type UIMessage = Message.RESIZE;
-export declare type FieldMessage = Message.GET_VALUE | Message.SET_VALUE | Message.SCHEMA_FIELD_ERROR | Message.VALUE_CHANGED;
-export declare type APIContentMessage = Message.GET_CONTENT | Message.LIST_CONTENT | Message.CREATE_CONTENT | Message.UPDATE_CONTENT;
-export declare type APIDefinitionMessage = Message.GET_DEFINITION | Message.LIST_DEFINITION | Message.CREATE_DEFINITION | Message.UPDATE_DEFINITION;
-export declare type APIRepositoryMessage = Message.GET_REPOSITORY | Message.LIST_REPOSITORY | Message.CREATE_REPOSITORY | Message.UPDATE_REPOSITORY;
-export declare type APIPublishingChannelMessage = Message.GET_PUBLISHING_CHANNEL | Message.LIST_PUBLISHING_CHANNEL | Message.CREATE_PUBLISHING_CHANNEL | Message.UPDATE_PUBLISHING_CHANNEL;
-export declare type APIPublishMessage = Message.PUBLISH_CONTENT;
-export declare type MessageType = SystemMessage | UIMessage | FieldMessage | APIContentMessage | APIDefinitionMessage | APIRepositoryMessage | APIPublishingChannelMessage | APIPublishMessage;
+export type SystemMessage = Message.CONNECT | Message.RESULT | Message.ERROR;
+export type UIMessage = Message.RESIZE;
+export type FieldMessage = Message.GET_VALUE | Message.SET_VALUE | Message.SCHEMA_FIELD_ERROR | Message.VALUE_CHANGED;
+export type APIContentMessage = Message.GET_CONTENT | Message.LIST_CONTENT | Message.CREATE_CONTENT | Message.UPDATE_CONTENT;
+export type APIDefinitionMessage = Message.GET_DEFINITION | Message.LIST_DEFINITION | Message.CREATE_DEFINITION | Message.UPDATE_DEFINITION;
+export type APIRepositoryMessage = Message.GET_REPOSITORY | Message.LIST_REPOSITORY | Message.CREATE_REPOSITORY | Message.UPDATE_REPOSITORY;
+export type APIPublishingChannelMessage = Message.GET_PUBLISHING_CHANNEL | Message.LIST_PUBLISHING_CHANNEL | Message.CREATE_PUBLISHING_CHANNEL | Message.UPDATE_PUBLISHING_CHANNEL;
+export type APIPublishMessage = Message.PUBLISH_CONTENT;
+export type MessageType = SystemMessage | UIMessage | FieldMessage | APIContentMessage | APIDefinitionMessage | APIRepositoryMessage | APIPublishingChannelMessage | APIPublishMessage;
 export interface MessagePayload {
     type: Message;
     value?: any;
@@ -60,4 +60,4 @@ export interface ContentInfo {
     contentId?: number;
     contentPublicId?: string;
 }
-export declare type System = ContentInfo & FieldInfo;
+export type System = ContentInfo & FieldInfo;

package/dist/extension/index.js

@@ -40,4 +40,4 @@ var Message;
     Message["UPDATE_PUBLISHING_CHANNEL"] = "updatePublishingChannel";
     // PUBLISH
     Message["PUBLISH_CONTENT"] = "publishContent";
-})(Message = exports.Message || (exports.Message = {}));
+})(Message || (exports.Message = Message = {}));

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/api/Content.ts

@@ -218,6 +218,16 @@ export type CreateContentRequest = {
      * Controls if translations should be ignored when publishing
     */
     contentLocalizationSettings?: LocalizationSettings;
+
+    /**
+     * will bypass content definition mnemonicId validation for every linked-content field
+     */
+    bypassLinkedContentValidation?: boolean;
+
+    /**
+     * set an identifier coming from a third party application
+     */
+    externalIdentifier?: string;
 };
 
 /**
@@ -269,6 +279,16 @@ export type UpdateContentRequest = {
      * Controls if translations should be ignored when publishing
     */
     contentLocalizationSettings?: LocalizationSettings;
+
+    /**
+     * will bypass content definition mnemonicId validation for every linked-content field
+     */
+    bypassLinkedContentValidation?: boolean;
+
+    /**
+     * set an identifier coming from a third party application
+     */
+    externalIdentifier?: string;
 };
 
 /**
@@ -586,6 +606,11 @@ export type ContentResponse = {
      * Content's locale
      */
     locale: string;
+
+    /**
+     * Content's external identifier
+     */
+    externalIdentifier?: string;
 };
 
 /**

package/lib/api/ContentDefinition.ts

@@ -109,6 +109,11 @@ export type CreateContentDefinitionRequest = {
      * The content definition fields schema
      */
     schema: ContentDefinitionSchema;
+
+    /**
+     * will bypass content definition mnemonicId validation for every linked-content field
+     */
+    bypassLinkedContentValidation?: boolean;
 };
 
 /**
@@ -131,6 +136,11 @@ export type UpdateContentDefinitionRequest = {
      * The content definition fields schema
      */
     schema: ContentDefinitionSchema;
+
+    /**
+     * will bypass content definition mnemonicId validation for every linked-content field
+     */
+    bypassLinkedContentValidation?: boolean;
 };
 
 /**

package/lib/api/ContentDefinitionSchema.ts

@@ -459,7 +459,7 @@ export type MediaSchemaType = TranslatableSchemaType<SchemaType<SchemaTypeIds.ME
  * This type represent a number field schema type
  * A number field can be indexed and searched when requesting the content
  */
-export type NumberSchemaType = IndexableSchemaType<SchemaTypeIds.NUMBER, NumberFieldConstraints>;
+export type NumberSchemaType = TranslatableSchemaType<IndexableSchemaType<SchemaTypeIds.NUMBER, NumberFieldConstraints>>;
 /**
  * This type represent a boolean field schema type
  * A boolean field can be indexed and searched when requesting the content
@@ -510,7 +510,7 @@ export type IndexableSchemaTypes = TextSchemaType | LongTextSchemaType | LinkedC
 /**
  * This are all the fields that can be localized
  */
-export type TranslatableSchemaTypes = TextSchemaType | LongTextSchemaType | CloudinaryPublicIdSchemaType | CloudinaryImageSchemaType | CloudinaryVideoSchemaType | CloudinaryRawSchemaType | MediaSchemaType;
+export type TranslatableSchemaTypes = NumberSchemaType | TextSchemaType | LongTextSchemaType | CloudinaryPublicIdSchemaType | CloudinaryImageSchemaType | CloudinaryVideoSchemaType | CloudinaryRawSchemaType | MediaSchemaType;
 
 /**
  * This type group all the schema types of a content definition that are not indexable

package/lib/api/PublishedContent.ts

@@ -1,7 +1,8 @@
-import { ContentId } from './Content';
-import { AuthorResponse } from './Author';
-import { ContentRepositoryId } from './ContentRepository';
-import { ContentTranslationStatus } from './ContentTranslation';
+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
@@ -20,175 +21,175 @@ export type ReleaseItemId = number;
  * This type represent the model of a release item
  */
 export type ReleaseItem = {
-    /**
-     * The release item unique id
-     */
-    id: ReleaseItemId;
-    /**
-     * The release item related space id
-     */
-    spaceId: string;
-    /**
-     * The release item related content name
-     */
-    contentName: string;
-    /**
-     * The release item related content id
-     */
-    contentId: ContentId;
-    /**
-     * The release item related content tags
-     */
-    contentTags: string[];
-    /**
-     * The release item related content definition mnemonic id
-     */
-    contentDefinitionMnemonicId: string;
-    /**
-     * The release item related content repository unique id
-     */
-    contentRepositoryId: ContentRepositoryId;
-    /**
-     * The release item related content published id
-     */
-    publishedContentId: PublishedContentId;
-    /**
-     * The release item related content public id
-     */
-    publicId: string;
-    /**
-     * The release item related content online date
-     */
-    onlineDate?: Date;
-    /**
-     * The release item related content offline date
-     */
-    offlineDate?: Date;
-    /**
-     * Mark if the release item have to be publish
-     */
-    toPublish: boolean;
+  /**
+   * The release item unique id
+   */
+  id: ReleaseItemId;
+  /**
+   * The release item related space id
+   */
+  spaceId: string;
+  /**
+   * The release item related content name
+   */
+  contentName: string;
+  /**
+   * The release item related content id
+   */
+  contentId: ContentId;
+  /**
+   * The release item related content tags
+   */
+  contentTags: string[];
+  /**
+   * The release item related content definition mnemonic id
+   */
+  contentDefinitionMnemonicId: string;
+  /**
+   * The release item related content repository unique id
+   */
+  contentRepositoryId: ContentRepositoryId;
+  /**
+   * The release item related content published id
+   */
+  publishedContentId: PublishedContentId;
+  /**
+   * The release item related content public id
+   */
+  publicId: string;
+  /**
+   * The release item related content online date
+   */
+  onlineDate?: Date;
+  /**
+   * The release item related content offline date
+   */
+  offlineDate?: Date;
+  /**
+   * Mark if the release item have to be publish
+   */
+  toPublish: boolean;
 
-    /**
-     * Content`s locale
-     */
-    contentLocale: string;
-    /**
-     * Status of the ContentTranslation (defined if content is derived from a translation)
-     */
-    translationStatus?: ContentTranslationStatus;
+  /**
+   * Content`s locale
+   */
+  contentLocale: string;
+  /**
+   * Status of the ContentTranslation (defined if content is derived from a translation)
+   */
+  translationStatus?: ContentTranslationStatus;
 };
 
 /**
  * This type represent the model of a release
  */
 export type Release = {
-    /**
-     * The Release unique id
-     */
-    id: ReleaseId;
-    /**
-     * The release related space id
-     */
-    spaceId: string;
-    /**
-     * The list of content item in the release
-     */
-    releaseItems: ReleaseItem[];
-    /**
-     * Mark if the release is archived
-     */
-    archived: boolean;
+  /**
+   * The Release unique id
+   */
+  id: ReleaseId;
+  /**
+   * The release related space id
+   */
+  spaceId: string;
+  /**
+   * The list of content item in the release
+   */
+  releaseItems: ReleaseItem[];
+  /**
+   * Mark if the release is archived
+   */
+  archived: boolean;
 };
 
 /**
  * This type represent the data needed to make a get published content API request
  */
 export type GetPublishedContentRequest = {
-    /**
-     * This published content public id
-     */
-    publicId: string;
-    /**
-     * The date where to find the published content
-     */
-    targetDate?: Date;
-    /**
-     * This publishing channel of the content
-     */
-    publishingChannel: string;
+  /**
+   * This published content public id
+   */
+  publicId: string;
+  /**
+   * The date where to find the published content
+   */
+  targetDate?: Date;
+  /**
+   * This publishing channel of the content
+   */
+  publishingChannel: string;
 };
 
 /**
  * This type represent the model of a published content
  */
 export type PublishedContentResponse = {
-    /**
-     * The published content unique id
-     */
-    id: PublishedContentId;
-    /**
-     * The related content unique id
-     */
-    contentId: ContentId
-    /**
-     * The published content current version
-     */
-    contentVersion: number;
-    /**
-     * The publishing channels where the content is published
-     */
-    contentChannels: string[];
-    /**
-     * The published content tags
-     */
-    contentTags: string[];
-    /**
-     * The published content related content definition mnemonic id
-     */
-    contentDefinitionMnemonicId: string;
-    /**
-     * The published content related content repository id
-     */
-    contentRepositoryId: ContentRepositoryId;
-    /**
-     * The published content public id
-     */
-    publicId: string;
-    /**
-     * The published content payload
-     */
-    payload: object;
-    /**
-     * The published content online date
-     */
-    onlineDate?: Date;
-    /**
-     * The published content offline date
-     */
-    offlineDate?: Date;
-    /**
-     * The creation date of the related content
-     */
-    createdDate: Date;
-    /**
-    * The update date of the related content
-    */
-    lastModifiedDate: Date;
-    /**
-     * The creator of the content
-     */
-    author: AuthorResponse;
+  /**
+   * The published content unique id
+   */
+  id: PublishedContentId;
+  /**
+   * The related content unique id
+   */
+  contentId: ContentId;
+  /**
+   * The published content current version
+   */
+  contentVersion: number;
+  /**
+   * The publishing channels where the content is published
+   */
+  contentChannels: string[];
+  /**
+   * The published content tags
+   */
+  contentTags: string[];
+  /**
+   * The published content related content definition mnemonic id
+   */
+  contentDefinitionMnemonicId: string;
+  /**
+   * The published content related content repository id
+   */
+  contentRepositoryId: ContentRepositoryId;
+  /**
+   * The published content public id
+   */
+  publicId: string;
+  /**
+   * The published content payload
+   */
+  payload: object;
+  /**
+   * The published content online date
+   */
+  onlineDate?: Date;
+  /**
+   * The published content offline date
+   */
+  offlineDate?: Date;
+  /**
+   * The creation date of the related content
+   */
+  createdDate: Date;
+  /**
+   * The update date of the related content
+   */
+  lastModifiedDate: Date;
+  /**
+   * The creator of the content
+   */
+  author: AuthorResponse;
 };
 
 /**
  * This type represent the data needed to make a set stage content to live API request
  */
 export type SetStageContentsToLiveRequest = {
-    /**
-     * The release id to publish to live
-     */
-    releaseId: ReleaseId;
+  /**
+   * The release id to publish to live
+   */
+  releaseId: ReleaseId;
 };
 
 /**
@@ -210,18 +211,18 @@ export type CreateReleaseResponse = Release;
  * This type represent the data needed to make an update release API request
  */
 export type UpdateReleaseRequest = {
-    /**
-     * The release unique id to update
-     */
-    releaseId: ReleaseId;
-    /**
-     * The release item to publish
-     */
-    itemsToPromote: ReleaseItemId[];
-    /**
-     * Mark if all the puslished content in stage have to be publish to live
-     */
-    includeAll?: boolean;
+  /**
+   * The release unique id to update
+   */
+  releaseId: ReleaseId;
+  /**
+   * The release item to publish
+   */
+  itemsToPromote: ReleaseItemId[];
+  /**
+   * Mark if all the puslished content in stage have to be publish to live
+   */
+  includeAll?: boolean;
 };
 
 /**
@@ -233,3 +234,26 @@ export type UpdateReleaseResponse = Release;
  * This type represent the response of a get published content API request
  */
 export type GetPublishedContentResponse = PublishedContentResponse | undefined;
+
+/**
+ * This type represent the data needed to make a list release items API request
+ */
+export type ListReleaseItemsRequest = {
+  /**
+   * The release id to retrieve items from
+   */
+  releaseId: number;
+  /**
+   * The contents to skip (used to paginate the result)
+   */
+  skip: number;
+  /**
+   * The contents to take (used to paginate the result)
+   */
+  take: number;
+};
+
+/**
+ * This type represent the response of the list release items API request
+ */
+export type ListReleaseItemsResponse = PagedListResponse<ReleaseItem>;

package/lib/api/Webhooks.ts

@@ -2,7 +2,8 @@
  * This enum represent all possible webhook lifecycle events
  */
 export enum WebhookLifecycleEvents {
-    PublishToLIve = 'publish_to_live',
+    PublishToLive = 'publish_to_live',
+    PublishToStage = 'publish_to_stage'
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "2.6.0-alpha.0",
+  "version": "2.6.1-alpha.0",
   "description": "ContentChef types",
   "author": "PierpaoloIannone <piannone@byte-code.com>",
   "homepage": "https://github.com/ContentChef/contentchef-management-js-client#readme",
@@ -32,7 +32,6 @@
     "url": "https://github.com/ContentChef/contentchef-management-js-client/issues"
   },
   "devDependencies": {
-    "typescript": "^4.0.5"
-  },
-  "gitHead": "dd738eb3c9ee0725393bfa725d4843b533744229"
+    "typescript": "^5.9.3"
+  }
 }