@contentchef/contentchef-types 3.0.0-alpha.0 → 10.0.0-alpha.0

package/lib/api/ContentTranslation.ts

@@ -1,75 +1,77 @@
-import { AuthorResponse } from './Author';
-import { ContentId, ContentResponse, FieldPath } from './Content';
+import { AuthorResponse } from "./Author";
+import { ContentId, ContentResponse, FieldPath } from "./Content";
 
 export type ContentTranslationId = number;
 
 export type FieldTranslation = {
-    key: string;
-    path: FieldPath;
-    value: string;
-    checksum: string;
+  key: string;
+  path: FieldPath;
+  value: string;
+  checksum: string;
 };
 
 export type ContentTranslation = {
-    id: ContentTranslationId;
-    spaceId: string;
-    locale: string;
-    translations: FieldTranslation[];
-    createdDate: Date;
-    lastModifiedDate: Date;
-    author: AuthorResponse;
-    latestContributor: AuthorResponse;
-    content: ContentResponse;
-    status: ContentTranslationStatus;
+  id: ContentTranslationId;
+  spaceId: string;
+  locale: string;
+  translations: FieldTranslation[];
+  createdDate: Date;
+  lastModifiedDate: Date;
+  author: AuthorResponse;
+  latestContributor: AuthorResponse;
+  content: ContentResponse;
+  status: ContentTranslationStatus;
+  version: number;
 };
 
 export type GetContentTranslationRequest = {
-    contentId: ContentId;
-    locale: string;
+  contentId: ContentId;
+  locale: string;
 };
 
-export type GetContentTranslationResponse = ContentTranslation & { translatedContent: ContentResponse; };
+export type GetContentTranslationResponse = ContentTranslation & {
+  translatedContent: ContentResponse;
+};
 
 export type CreateContentTranslationRequest = {
-    contentId: ContentId;
-    locale: string;
+  contentId: ContentId;
+  locale: string;
 };
 
 export type CreateContentTranslationResponse = ContentTranslation;
 
 export type UpdateContentTranslationRequest = {
-    contentId: ContentId;
-    locale: string;
-    translations: Pick<FieldTranslation, 'path' | 'value'>[];
-    checksum: string;
+  contentId: ContentId;
+  locale: string;
+  translations: Pick<FieldTranslation, "path" | "value">[];
+  checksum: string;
 };
 
 export type UpdateContentTranslationResponse = ContentTranslation;
 
 export enum ContentTranslationStatus {
-    UPTODATE = 0,
-    TO_VERIFY = 1,
-    INCOMPLETE = 2,
-    MISSING = 3
+  UPTODATE = 0,
+  TO_VERIFY = 1,
+  INCOMPLETE = 2,
+  MISSING = 3,
 }
 
 export type ListContentTranslationRequest = {
-    contentId: ContentId;
+  contentId: ContentId;
 };
 
 export type ListContentTranslationResponse = ContentTranslation[];
 
-
 export type DeleteContentTranslationRequest = {
-    contentId: ContentId;
-    locale: string;
+  contentId: ContentId;
+  locale: string;
 };
 
 export type DeleteContentTranslationResponse = boolean;
 
 export type CleanContentTranslationRequest = {
-    contentId: ContentId;
-    locales: string[];
+  contentId: ContentId;
+  locales: string[];
 };
 
 export type CleanContentTranslationResponse = boolean;

package/lib/api/PublishedContent.ts

@@ -2,7 +2,6 @@ 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
@@ -190,6 +189,11 @@ export type SetStageContentsToLiveRequest = {
    * The release id to publish to live
    */
   releaseId: ReleaseId;
+
+  /**
+   * Skip validating linked contents resolution
+   */
+  skipLinkedContentValidation?: boolean;
 };
 
 /**
@@ -202,19 +206,10 @@ export type SetStageContentsToLiveResponse = {};
  */
 export type CreateReleaseRequest = {};
 
-/**
- * This type represent the response of a create release API request
- */
-export type CreateReleaseResponse = {
-  /**
-   * The release unique id
-   */
-  releaseId: ReleaseId;
-  /**
-   * The number of items in the release
-   */
-  releaseItemsCount: number;
-};
+/**
+ * This type represent the response of a create release API request
+ */
+export type CreateReleaseResponse = Release;
 
 /**
  * This type represent the data needed to make an update release API request
@@ -243,26 +238,3 @@ 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/Space.ts

@@ -178,6 +178,11 @@ export type SpaceLocale = {
      * Fallback locale (defaults to 'en')
      */
     fallbackLocale: string;
+
+    /**
+     * List of locales that are enabled for publishing
+     */
+    publishingLocales?: string[];
 }
 
 /**
@@ -239,3 +244,17 @@ export type UpdateSpaceDefaultLocaleResponse = SpaceLocale;
  * Return type of `updateSpacefallbackLocale`
  */
 export type UpdateSpaceFallbackLocaleResponse = SpaceLocale;
+
+/**
+ * Request type to update space's publishing locales
+ */
+export type UpdateSpacePublishingLocalesRequest = {
+    /**
+     * Locales to enable for publishing (must be a subset of space's supported locales)
+     */
+    publishingLocales: string[];
+}
+/**
+ * Return type of `updateSpacePublishingLocales`
+ */
+export type UpdateSpacePublishingLocalesResponse = SpaceLocale;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "3.0.0-alpha.0",
+  "version": "10.0.0-alpha.0",
   "description": "ContentChef types",
   "author": "PierpaoloIannone <piannone@byte-code.com>",
   "homepage": "https://github.com/ContentChef/contentchef-management-js-client#readme",
@@ -33,5 +33,6 @@
   },
   "devDependencies": {
     "typescript": "^5.9.3"
-  }
+  },
+  "gitHead": "e3fc5951334f5cb34918aa048addb81afc90937f"
 }