Merge pull request #44 from cosmicjs/jazib/add-slug-and-trigger_webho…

…ok-support add typing for insert revision method
cosmicjs · Oct 28, 2024 · 2d26642 · 2d26642
2 parents e279862 + 9057418
commit 2d26642
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/.changeset/cool-games-cover.md b/.changeset/cool-games-cover.md
@@ -0,0 +1,5 @@
+---
+'@cosmicjs/sdk': patch
+---
+
+Added typescript type for add revision method
diff --git a/src/clients/bucket/objectRevisions/index.ts b/src/clients/bucket/objectRevisions/index.ts
@@ -1,5 +1,6 @@
 import HTTP_METHODS from '../../../constants/httpMethods.constants';
 import { APIConfig, BucketConfig } from '../../../types/config.types';
+import { InsertObjectRevisionType } from '../../../types/objectRevision.type';
 import { GenericObject } from '../../../types/generic.types';
 import { requestHandler } from '../../../utils/request.handler';
 import { validateWriteKeyAndReturnHeaders } from '../../../utils/writeKey.validation';
@@ -10,7 +11,7 @@ export const objectRevisionsChainMethods = (
   bucketConfig: BucketConfig,
   apiConfig: APIConfig
 ) => ({
-  async insertOne(objectId: string, data: GenericObject) {
+  async insertOne(objectId: string, data: InsertObjectRevisionType) {
     const endpoint = `${apiConfig.apiUrl}/buckets/${bucketConfig.bucketSlug}/objects/${objectId}/revisions`;
     headers = validateWriteKeyAndReturnHeaders(bucketConfig.writeKey);
     return requestHandler(HTTP_METHODS.POST, endpoint, data, headers);

diff --git a/src/types/objectRevision.type.ts b/src/types/objectRevision.type.ts
@@ -0,0 +1,14 @@
+import { GenericObject } from './generic.types';
+
+export type InsertObjectRevisionType = {
+  title?: string;
+  slug?: string;
+  content?: string;
+  publish_at?: number;
+  unpublish_at?: number;
+  metadata?: GenericObject;
+  locale?: string;
+  thumbnail?: string;
+  trigger_webhook?: boolean;
+  pretty?: boolean;
+};