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

package/dist/api/AuditLog.d.ts

@@ -1,10 +1,10 @@
+import { AuthorResponse } from './Author';
+import { PublishingChannelId } from './Channel';
 import { PagedListResponse } from './common';
 import { ContentId } from './Content';
-import { ContentRepositoryId } from './ContentRepository';
 import { ContentDefinitionId } from './ContentDefinition';
+import { ContentRepositoryId } from './ContentRepository';
 import { MediaGalleryId } from './MediaGallery';
-import { PublishingChannelId } from './Channel';
-import { AuthorResponse } from './Author';
 /**
  * This type represent the audit log unique id type
  */
@@ -94,8 +94,13 @@ export declare enum SubjectActions {
 export declare type ListAuditLogRequest = {
     skip: number;
     take: number;
-    filters: ListAuditLogFilters;
+    filters?: ListAuditLogFilters;
 };
+declare type LatestActivitesRequest<ToRemove extends keyof ListAuditLogFilters> = Omit<ListAuditLogRequest, 'filters'> & {
+    filters: Omit<ListAuditLogFilters, ToRemove>;
+};
+export declare type UserTeamLatestActivitiesRequest = LatestActivitesRequest<'userTeamLatestActivities'>;
+export declare type UserLatestActivitiesRequest = LatestActivitesRequest<'userLatestActivities'>;
 /**
  * This type represent all the filters used to filter a list of audit logs
  */
@@ -133,7 +138,7 @@ export declare type ListByRepositoryIdRequest = {
      * The unique repository id
      */
     repositoryId: ContentRepositoryId;
-};
+} & (Partial<UserTeamLatestActivitiesRequest> | Partial<UserLatestActivitiesRequest>);
 /**
  * The model the represent the audit log parent filter used in the list of audit logs
  */
@@ -196,3 +201,4 @@ export declare type ListAuditLogItem = {
  * This type represent the response of a list audit log API request
  */
 export declare type ListAuditLogResponse = PagedListResponse<ListAuditLogItem>;
+export {};

package/dist/api/Channel.d.ts

@@ -18,7 +18,7 @@ export declare type CreatePublishingChannelRequest = {
     /**
      * The publishing channel color
      */
-    color: string;
+    color?: string;
 };
 /**
  * This type represent the model of a publishing channel

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/ContentRepository.d.ts

@@ -102,7 +102,7 @@ export declare type CreateContentRepositoryRequest = {
     /**
      * The content repository color
      */
-    color: string;
+    color?: string;
     /**
      * The content repository description
      */

package/dist/api/MediaGallery.d.ts

@@ -1,5 +1,5 @@
-import { PagedListResponse } from './common';
 import { AuthorResponse } from './Author';
+import { PagedListResponse } from './common';
 /**
  * This type describe the result of a list request on media
  * @template T The type of media requested
@@ -191,7 +191,7 @@ export declare type CreateMediaGalleryRequest = {
     /**
      * The color of the media gallery
      */
-    color: string;
+    color?: string;
     /**
      * This description of the media gallery
      */
@@ -321,14 +321,18 @@ export declare type ListMediaRequest = {
      * The number of media to take
      */
     take: number;
+    /**
+     * The number of media to skip
+     * This is used to paginate the media
+     * e.g. -> skip = 0 -> take = 10 -> media[0-9]
+     * skip = 10 -> take = 10 -> media[10-19]
+     * skip = 20 -> take = 10 -> media[20-29]
+    */
+    skip: number;
     /**
      * The folder path where to list the media
      */
     folderPath?: string;
-    /**
-     * The cursor needed to get the next segment of media
-     */
-    nextCursor?: string;
     /**
      * The type of media to retrieve
      */
@@ -350,10 +354,6 @@ export declare type GetMediaRequest = {
      * The media gallery unique id
      */
     mediaGalleryId: MediaGalleryId;
-    /**
-     * The media type
-     */
-    mediaType: MediaType;
     /**
      * The path needed to locate the media in the media gallery
      */
@@ -481,3 +481,24 @@ export declare type UpdateMediaResponse = Media;
  * This type represent the possible type of media accepted
  */
 export declare type MediaType = 'image' | 'video' | 'raw';
+/**
+ * Parameters needed to delete a media
+ */
+export declare type DeleteMediaRequest = {
+    /**
+     * The media gallery unique id where the media is located
+     */
+    mediaGalleryId: number;
+    /**
+     * The media public id
+     */
+    mediaPublicId: string;
+    /**
+     * The type of the media to add
+     */
+    resourceType: MediaType;
+};
+/**
+ * Success or failure (boolean) of a delete media request
+ */
+export declare type DeleteMediaResponse = boolean;

package/dist/api/Space.d.ts

@@ -162,6 +162,10 @@ export declare type SpaceLocale = {
      * List of supported locales (default locale is included)
      */
     locales: string[];
+    /**
+     * Fallback locale (defaults to 'en')
+     */
+    fallbackLocale: string;
 };
 /**
  * Return type of `getSpaceLocale`
@@ -206,3 +210,16 @@ export declare type UpdateSpaceDefaultLocaleRequest = {
  * Return type of `updateSpaceDefaultLocale`
  */
 export declare type UpdateSpaceDefaultLocaleResponse = SpaceLocale;
+/**
+ * Request type to update space's fallback locale
+ */
+export declare type UpdateSpaceFallbackLocaleRequest = {
+    /**
+     * Locale to update to space's fallback locale
+     */
+    locale: string;
+};
+/**
+ * Return type of `updateSpacefallbackLocale`
+ */
+export declare type UpdateSpaceFallbackLocaleResponse = SpaceLocale;

package/lib/api/AuditLog.ts

@@ -1,10 +1,10 @@
+import { AuthorResponse } from './Author';
+import { PublishingChannelId } from './Channel';
 import { PagedListResponse } from './common';
 import { ContentId } from './Content';
-import { ContentRepositoryId } from './ContentRepository';
 import { ContentDefinitionId } from './ContentDefinition';
+import { ContentRepositoryId } from './ContentRepository';
 import { MediaGalleryId } from './MediaGallery';
-import { PublishingChannelId } from './Channel';
-import { AuthorResponse } from './Author';
 
 /**
  * This type represent the audit log unique id type
@@ -98,9 +98,14 @@ export enum SubjectActions {
 export type ListAuditLogRequest = {
     skip: number;
     take: number;
-    filters: ListAuditLogFilters;
+    filters?: ListAuditLogFilters;
 };
 
+type LatestActivitesRequest<ToRemove extends keyof ListAuditLogFilters> = Omit<ListAuditLogRequest, 'filters'> & {filters: Omit<ListAuditLogFilters, ToRemove>}
+
+export type UserTeamLatestActivitiesRequest = LatestActivitesRequest<'userTeamLatestActivities'>;
+export type UserLatestActivitiesRequest = LatestActivitesRequest<'userLatestActivities'>;
+
 /**
  * This type represent all the filters used to filter a list of audit logs
  */
@@ -139,7 +144,7 @@ export type ListByRepositoryIdRequest = {
      * The unique repository id
      */
     repositoryId: ContentRepositoryId;
-};
+} & (Partial<UserTeamLatestActivitiesRequest> | Partial<UserLatestActivitiesRequest>);
 
 /**
  * The model the represent the audit log parent filter used in the list of audit logs

package/lib/api/Channel.ts

@@ -20,7 +20,7 @@ export type CreatePublishingChannelRequest = {
     /**
      * The publishing channel color
      */
-    color: string;
+    color?: string;
 };
 
 /**

package/lib/api/ContentDefinitionSchema.ts

@@ -20,6 +20,7 @@ export enum SchemaTypeIds {
     ONE_LINKED_CONTENT_OF = 'oneLinkedContentOf',
     ARRAY = 'array',
     SLUG = 'slug',
+    MEDIA = 'media',
 }
 
 /**
@@ -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
@@ -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/ContentRepository.ts

@@ -109,7 +109,7 @@ export type CreateContentRepositoryRequest = {
     /**
      * The content repository color
      */
-    color: string;
+    color?: string;
     /**
      * The content repository description
      */

package/lib/api/MediaGallery.ts

@@ -1,5 +1,5 @@
-import { PagedListResponse } from './common';
 import { AuthorResponse } from './Author';
+import { PagedListResponse } from './common';
 
 /**
  * This type describe the result of a list request on media
@@ -202,7 +202,7 @@ export type CreateMediaGalleryRequest = {
     /**
      * The color of the media gallery
      */
-    color: string;
+    color?: string;
     /**
      * This description of the media gallery
      */
@@ -339,14 +339,18 @@ export type ListMediaRequest = {
      * The number of media to take
      */
     take: number;
+    /**
+     * The number of media to skip
+     * This is used to paginate the media
+     * e.g. -> skip = 0 -> take = 10 -> media[0-9]
+     * skip = 10 -> take = 10 -> media[10-19]
+     * skip = 20 -> take = 10 -> media[20-29]
+    */
+    skip: number;
     /**
      * The folder path where to list the media
      */
     folderPath?: string;
-    /**
-     * The cursor needed to get the next segment of media
-     */
-    nextCursor?: string;
     /**
      * The type of media to retrieve
      */
@@ -370,10 +374,6 @@ export type GetMediaRequest = {
      * The media gallery unique id
      */
     mediaGalleryId: MediaGalleryId;
-    /**
-     * The media type
-     */
-    mediaType: MediaType;
     /**
      * The path needed to locate the media in the media gallery
      */
@@ -509,3 +509,26 @@ export type UpdateMediaResponse = Media;
  * This type represent the possible type of media accepted
  */
 export type MediaType = 'image' | 'video' | 'raw';
+
+/**
+ * Parameters needed to delete a media
+ */
+export type DeleteMediaRequest = {
+    /**
+     * The media gallery unique id where the media is located
+     */
+    mediaGalleryId: number;
+    /**
+     * The media public id
+     */
+    mediaPublicId: string;
+    /**
+     * The type of the media to add
+     */
+    resourceType: MediaType;
+};
+
+/**
+ * Success or failure (boolean) of a delete media request
+ */
+export type DeleteMediaResponse = boolean;

package/lib/api/Space.ts

@@ -173,6 +173,11 @@ export type SpaceLocale = {
      * List of supported locales (default locale is included)
      */
     locales: string[];
+
+    /**
+     * Fallback locale (defaults to 'en')
+     */
+    fallbackLocale: string;
 }
 
 /**
@@ -220,3 +225,17 @@ export type UpdateSpaceDefaultLocaleRequest = {
  * Return type of `updateSpaceDefaultLocale`
  */
 export type UpdateSpaceDefaultLocaleResponse = SpaceLocale;
+
+/**
+ * Request type to update space's fallback locale
+ */
+ export type UpdateSpaceFallbackLocaleRequest = {
+    /**
+     * Locale to update to space's fallback locale
+     */
+    locale: string;
+}
+/**
+ * Return type of `updateSpacefallbackLocale`
+ */
+export type UpdateSpaceFallbackLocaleResponse = SpaceLocale;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "2.5.4",
+  "version": "2.6.0-alpha.0",
   "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": "b0dc55381014c85de9ac26775586963a2584ebd5"
+  "gitHead": "dd738eb3c9ee0725393bfa725d4843b533744229"
 }