@contentchef/contentchef-types 2.5.1 → 2.5.5

package/dist/api/ContentDefinition.d.ts

@@ -1,6 +1,6 @@
 import { AuthorResponse } from './Author';
-import { ContentDefinitionSchema, Field, I18NDictionary } from './ContentDefinitionSchema';
 import { PagedListResponse } from './common';
+import { ContentDefinitionSchema, Field, I18NDictionary } from './ContentDefinitionSchema';
 import { Extension } from './Extension';
 /**
  * This type represent the unique content definition id type
@@ -15,6 +15,9 @@ export declare type GetContentDefinitionRequest = {
      */
     id: ContentDefinitionId;
 };
+export declare type ArrayField = {
+    path: string;
+};
 /**
  * This type represent the data needed to make a list content definition API request
  */
@@ -160,6 +163,10 @@ export declare type ContentDefinitionResponse = {
      * Extensions used by the definition (type Extension or string (mnemonicId) depending if they are resolved or not)
      */
     extensions: Extension[] | string[];
+    /**
+     * Valued with paths to each array or null if definition is legacy
+     */
+    trackableArrayFields?: ArrayField[] | null;
 };
 /**
  * This type represent the response of a create content definition API request

package/dist/api/ContentDefinitionSchema.d.ts

@@ -18,7 +18,8 @@ export declare enum SchemaTypeIds {
     ONE_FRAGMENT_OF = "oneFragmentOf",
     ONE_LINKED_CONTENT_OF = "oneLinkedContentOf",
     ARRAY = "array",
-    SLUG = "slug"
+    SLUG = "slug",
+    MEDIA = "media"
 }
 /**
  * This enum represent al possible long text sub types
@@ -328,6 +329,15 @@ export declare type SlugConstraints = {
     prefix?: string;
     allowSlash?: boolean;
 };
+/**
+ * Constraints of a `media` field
+ */
+export declare type MediaConstraints = {
+    /**
+     * Determines type of media (raw, video, image)
+     */
+    type: MediaType;
+};
 /**
  * This type represent the model of a Schema Type Field
  * @template T The type of the field
@@ -403,6 +413,10 @@ export declare type CloudinaryVideoSchemaType = TranslatableSchemaType<SchemaTyp
  * This type represent a cloudinary raw field schema type
  */
 export declare type CloudinaryRawSchemaType = TranslatableSchemaType<SchemaType<SchemaTypeIds.CLOUDINARY_RAW, {}>>;
+/**
+ * Media field schema type
+ */
+export declare type MediaSchemaType = TranslatableSchemaType<SchemaType<SchemaTypeIds.MEDIA, MediaConstraints>>;
 /**
  * This type represent a number field schema type
  * A number field can be indexed and searched when requesting the content
@@ -451,7 +465,7 @@ export declare type IndexableSchemaTypes = TextSchemaType | LongTextSchemaType |
 /**
  * This are all the fields that can be localized
  */
-export declare type TranslatableSchemaTypes = TextSchemaType | LongTextSchemaType | CloudinaryPublicIdSchemaType | CloudinaryImageSchemaType | CloudinaryVideoSchemaType | CloudinaryRawSchemaType;
+export declare type TranslatableSchemaTypes = TextSchemaType | LongTextSchemaType | CloudinaryPublicIdSchemaType | CloudinaryImageSchemaType | CloudinaryVideoSchemaType | CloudinaryRawSchemaType | MediaSchemaType;
 /**
  * This type group all the schema types of a content definition that are not indexable
  */

package/dist/api/ContentDefinitionSchema.js

@@ -22,6 +22,7 @@ var SchemaTypeIds;
     SchemaTypeIds["ONE_LINKED_CONTENT_OF"] = "oneLinkedContentOf";
     SchemaTypeIds["ARRAY"] = "array";
     SchemaTypeIds["SLUG"] = "slug";
+    SchemaTypeIds["MEDIA"] = "media";
 })(SchemaTypeIds = exports.SchemaTypeIds || (exports.SchemaTypeIds = {}));
 /**
  * This enum represent al possible long text sub types

package/dist/api/ContentTranslation.d.ts

@@ -48,3 +48,13 @@ export declare type ListContentTranslationRequest = {
     contentId: ContentId;
 };
 export declare type ListContentTranslationResponse = ContentTranslation[];
+export declare type DeleteContentTranslationRequest = {
+    contentId: ContentId;
+    locale: string;
+};
+export declare type DeleteContentTranslationResponse = boolean;
+export declare type CleanContentTranslationRequest = {
+    contentId: ContentId;
+    locales: string[];
+};
+export declare type CleanContentTranslationResponse = boolean;

package/lib/api/ContentDefinition.ts

@@ -1,6 +1,6 @@
 import { AuthorResponse } from './Author';
-import { ContentDefinitionSchema, Field, I18NDictionary } from './ContentDefinitionSchema';
 import { PagedListResponse } from './common';
+import { ContentDefinitionSchema, Field, I18NDictionary } from './ContentDefinitionSchema';
 import { Extension } from './Extension';
 
 /**
@@ -18,6 +18,10 @@ export type GetContentDefinitionRequest = {
     id: ContentDefinitionId;
 };
 
+export type ArrayField = {
+    path: string;
+};
+
 /**
  * This type represent the data needed to make a list content definition API request
  */
@@ -42,7 +46,7 @@ export type ListContentDefinitionsRequest = {
          * This filter is used to search contents that contain the value inserted in the mnemonic id
          */
         mnemonicId?: string;
-    }
+    };
 };
 
 /**
@@ -81,7 +85,7 @@ export type ListContentDefinitionsItem = {
     /**
      * Extensions used by the definition
      */
-     extensions: string[];
+    extensions: string[];
 };
 
 /**
@@ -170,6 +174,11 @@ export type ContentDefinitionResponse = {
      * Extensions used by the definition (type Extension or string (mnemonicId) depending if they are resolved or not)
      */
     extensions: Extension[] | string[];
+
+    /**
+     * Valued with paths to each array or null if definition is legacy
+     */
+    trackableArrayFields?: ArrayField[] | null;
 };
 
 /**
@@ -200,7 +209,7 @@ export type ValidateDefinitionFieldRequest = {
     /**
      * The default content definition schema language
      */
-    defaultLanguage: string
+    defaultLanguage: string;
 };
 
 /**
@@ -261,7 +270,7 @@ export type ContentDefinitionSchemaErrors = {
     /**
      * This attribute represents an error if the language of the schema is not a valid string
      */
-    lang?: string
+    lang?: string;
 };
 
 /**
@@ -275,7 +284,7 @@ export type SchemaFragmentErrors = {
      *  - The value is a SchemaFieldViolationErrors if the fragment is valid but there are internal fields with validation validation errors
      *  - The value is a AttributeViolation if the fragment has invalid attributes
      */
-    [key: string]: (SchemaFieldViolationsErrors | AttributeViolation)[]
+    [key: string]: (SchemaFieldViolationsErrors | AttributeViolation)[];
 };
 
 /**
@@ -307,7 +316,7 @@ export type AttributeViolation = {
     /**
      * The detailed list of errors that occurred
      */
-    details: AttributeViolationDetail[]
+    details: AttributeViolationDetail[];
 };
 
 /**
@@ -323,7 +332,7 @@ export type AttributeViolationDetail = {
      * The attributes affected by the error
      *
      */
-    affectedAttributes: string[]
+    affectedAttributes: string[];
 };
 
 /**
@@ -337,7 +346,7 @@ export type ArrayAttributeViolation = {
     /**
      * The list of errors inside the attribute
      */
-    itemsDetails: ArrayAttributeViolationDetail[]
+    itemsDetails: ArrayAttributeViolationDetail[];
 };
 
 /**
@@ -351,7 +360,7 @@ export type ArrayAttributeViolationDetail = {
     /**
      * The detailed errors of the value
      */
-    details: AttributeViolationDetail[]
+    details: AttributeViolationDetail[];
 };
 
 /**

package/lib/api/ContentDefinitionSchema.ts

@@ -19,7 +19,8 @@ export enum SchemaTypeIds {
     ONE_FRAGMENT_OF = 'oneFragmentOf',
     ONE_LINKED_CONTENT_OF = 'oneLinkedContentOf',
     ARRAY = 'array',
-    SLUG = 'slug'
+    SLUG = 'slug',
+    MEDIA = 'media',
 }
 
 /**
@@ -43,7 +44,7 @@ export type ContentDefinitionSchema = {
     /**
      * The list of fields defined for the definition
      */
-    fields: Field[]
+    fields: Field[];
     /**
      * The fragments defined for the definition
      * A Fragment is a custom field defined by the user and can be used internally in the definition
@@ -272,7 +273,7 @@ export type LinkedContentFieldConstraints = {
      */
     lazy?: boolean;
 
-    linkType?: LinkType; 
+    linkType?: LinkType;
 };
 
 /**
@@ -292,7 +293,7 @@ export type OneFragmentOfConstraints = {
     /**
      * Set this value to define which fragments the field can use
      */
-    names: string[]
+    names: string[];
 };
 
 /**
@@ -360,6 +361,16 @@ export type SlugConstraints = {
     allowSlash?: boolean;
 };
 
+/**
+ * Constraints of a `media` field
+ */
+export type MediaConstraints = {
+    /**
+     * Determines type of media (raw, video, image)
+     */
+    type: MediaType;
+};
+
 /**
  * This type represent the model of a Schema Type Field
  * @template T The type of the field
@@ -373,7 +384,7 @@ export type SchemaType<T, C> = {
     /**
      * This attribute represent the constraints of the field
      */
-    constraints: C
+    constraints: C;
 };
 
 /**
@@ -440,6 +451,10 @@ export type CloudinaryVideoSchemaType = TranslatableSchemaType<SchemaType<Schema
  * This type represent a cloudinary raw field schema type
  */
 export type CloudinaryRawSchemaType = TranslatableSchemaType<SchemaType<SchemaTypeIds.CLOUDINARY_RAW, {}>>;
+/**
+ * Media field schema type
+ */
+export type MediaSchemaType = TranslatableSchemaType<SchemaType<SchemaTypeIds.MEDIA, MediaConstraints>>;
 /**
  * This type represent a number field schema type
  * A number field can be indexed and searched when requesting the content
@@ -495,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;
+export type TranslatableSchemaTypes = 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/ContentTranslation.ts

@@ -8,7 +8,7 @@ export type FieldTranslation = {
     path: FieldPath;
     value: string;
     checksum: string;
-}
+};
 
 export type ContentTranslation = {
     id: ContentTranslationId;
@@ -21,14 +21,14 @@ export type ContentTranslation = {
     latestContributor: AuthorResponse;
     content: ContentResponse;
     status: ContentTranslationStatus;
-}
+};
 
 export type GetContentTranslationRequest = {
     contentId: ContentId;
     locale: string;
-}
+};
 
-export type GetContentTranslationResponse = ContentTranslation & { translatedContent: ContentResponse };
+export type GetContentTranslationResponse = ContentTranslation & { translatedContent: ContentResponse; };
 
 export type CreateContentTranslationRequest = {
     contentId: ContentId;
@@ -55,6 +55,21 @@ export enum ContentTranslationStatus {
 
 export type ListContentTranslationRequest = {
     contentId: ContentId;
-}
+};
+
+export type ListContentTranslationResponse = ContentTranslation[];
+
+
+export type DeleteContentTranslationRequest = {
+    contentId: ContentId;
+    locale: string;
+};
+
+export type DeleteContentTranslationResponse = boolean;
+
+export type CleanContentTranslationRequest = {
+    contentId: ContentId;
+    locales: string[];
+};
 
-export type ListContentTranslationResponse = ContentTranslation[];
+export type CleanContentTranslationResponse = boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "2.5.1",
+  "version": "2.5.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": "^4.0.5"
   },
-  "gitHead": "3b76f517459613abd6eaa0867e25d4f6b91b3d93"
+  "gitHead": "74ebc47fe87871c7e31fb1e8803e31589c7158d4"
 }