@forge/object-store 1.1.1 → 1.1.2-next.0-experimental-0c74a4b

package/out/__test__/object-store.test.js

@@ -87,6 +87,31 @@ describe('ObjectStoreClient', () => {
             expect(mockResponse.text).toHaveBeenCalled();
             expect(response).toEqual({ message: 'Blåhaj' });
         });
+        it('should send a POST request with cdn:true option', async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                text: createMockBody(JSON.stringify({ message: 'Blåhaj' }))
+            };
+            mockFetch.mockResolvedValue(mockResponse);
+            const objectId = '1';
+            const response = await osClient.get(objectId, { cdn: true });
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/metadata', {
+                method: 'POST',
+                redirect: 'follow',
+                headers: {
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({
+                    key: objectId,
+                    cdn: true
+                })
+            });
+            expect(mockResponse.status).toBe(200);
+            expect(mockResponse.text).toHaveBeenCalled();
+            expect(response).toEqual({ message: 'Blåhaj' });
+        });
     });
     describe('delete', () => {
         it('should send a POST request with the correct headers and body', async () => {
@@ -106,6 +131,23 @@ describe('ObjectStoreClient', () => {
             expect(mockResponse.status).toBe(204);
             expect(mockResponse.text).toHaveBeenCalled();
         });
+        it('should send a POST request with cdn:true option', async () => {
+            const mockResponse = { ok: true, status: 204, text: createMockBody(null) };
+            mockFetch.mockResolvedValue(mockResponse);
+            const objectId = '1';
+            await osClient.delete(objectId, { cdn: true });
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/delete', {
+                method: 'POST',
+                redirect: 'follow',
+                headers: {
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({ key: objectId, cdn: true })
+            });
+            expect(mockResponse.status).toBe(204);
+            expect(mockResponse.text).toHaveBeenCalled();
+        });
     });
     describe('createUploadUrl', () => {
         it('should send a POST request with the correct headers and body, and return a URL', async () => {
@@ -162,5 +204,27 @@ describe('ObjectStoreClient', () => {
             expect(mockResponse.text).toHaveBeenCalled();
             expect(response).toEqual({ url: 'download-url' });
         });
+        it('should send a POST request with cdn:true option and return a URL', async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                text: createMockBody(JSON.stringify({ url: 'download-url' }))
+            };
+            mockFetch.mockResolvedValue(mockResponse);
+            const objectId = '1';
+            const response = await osClient.createDownloadUrl(objectId, { cdn: true });
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/download-url', {
+                method: 'POST',
+                redirect: 'follow',
+                headers: {
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({ key: objectId, cdn: true })
+            });
+            expect(mockResponse.status).toBe(200);
+            expect(mockResponse.text).toHaveBeenCalled();
+            expect(response).toEqual({ url: 'download-url' });
+        });
     });
 });

package/out/index.d.ts

@@ -1,7 +1,7 @@
 import { objectStore } from './object-store';
 import { errorCodes } from './errorCodes';
 import { ForgeError } from './errors';
-import { ObjectReference, UploadUrlBody, PresignedUrlResponse } from './types';
-export { errorCodes, objectStore, ForgeError, ObjectReference, UploadUrlBody, PresignedUrlResponse };
+import { ObjectReference, UploadUrlBody, PresignedUrlResponse, GetOptions, DeleteOptions, CreateDownloadUrlOptions } from './types';
+export { errorCodes, objectStore, ForgeError, ObjectReference, UploadUrlBody, PresignedUrlResponse, GetOptions, DeleteOptions, CreateDownloadUrlOptions };
 export default objectStore;
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/E,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAC;AAErG,eAAe,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EACL,eAAe,EACf,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,aAAa,EACb,wBAAwB,EACzB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,UAAU,EACV,WAAW,EACX,UAAU,EACV,eAAe,EACf,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,aAAa,EACb,wBAAwB,EACzB,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/out/object-store.d.ts

@@ -1,11 +1,11 @@
-import { ObjectReference, PresignedUrlResponse, UploadUrlBody } from './types';
+import { CreateDownloadUrlOptions, DeleteOptions, GetOptions, ObjectReference, PresignedUrlResponse, UploadUrlBody } from './types';
 export declare class ObjectStoreClient {
     private sendRequest;
     private requestJson;
-    get(key: string): Promise<ObjectReference | undefined>;
-    delete(key: string): Promise<void>;
+    get(key: string, options?: GetOptions): Promise<ObjectReference | undefined>;
+    delete(key: string, options?: DeleteOptions): Promise<void>;
     createUploadUrl(body: UploadUrlBody): Promise<PresignedUrlResponse | undefined>;
-    createDownloadUrl(key: string): Promise<PresignedUrlResponse | undefined>;
+    createDownloadUrl(key: string, options?: CreateDownloadUrlOptions): Promise<PresignedUrlResponse | undefined>;
 }
 export declare const objectStore: ObjectStoreClient;
 //# sourceMappingURL=object-store.d.ts.map

package/out/object-store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object-store.d.ts","sourceRoot":"","sources":["../src/object-store.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAS/E,qBAAa,iBAAiB;YAEd,WAAW;YASX,WAAW;IAmCZ,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAgBtD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAalC,eAAe,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAgB/E,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;CAWvF;AAED,eAAO,MAAM,WAAW,mBAA0B,CAAC"}
+{"version":3,"file":"object-store.d.ts","sourceRoot":"","sources":["../src/object-store.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,wBAAwB,EACxB,aAAa,EACb,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,aAAa,EACd,MAAM,SAAS,CAAC;AASjB,qBAAa,iBAAiB;YAEd,WAAW;YASX,WAAW;IAmCZ,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAiB5E,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAc3D,eAAe,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAgB/E,iBAAiB,CAC5B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;CAY7C;AAED,eAAO,MAAM,WAAW,mBAA0B,CAAC"}

package/out/object-store.js

@@ -40,14 +40,16 @@ class ObjectStoreClient {
             throw new errors_1.ForgeObjectStoreError(`Unexpected error. Response was not valid JSON: ${responseText}`);
         }
     }
-    async get(key) {
+    async get(key, options) {
+        const cdn = options?.cdn;
         return this.requestJson(ValidHttpMethod.POST, `api/v1/metadata`, {
             Accept: 'application/json',
             'Content-Type': 'application/json'
-        }, JSON.stringify({ key }));
+        }, JSON.stringify({ key, cdn }));
     }
-    async delete(key) {
-        return this.requestJson(ValidHttpMethod.POST, `api/v1/delete`, { Accept: 'application/json', 'Content-Type': 'application/json' }, JSON.stringify({ key }));
+    async delete(key, options) {
+        const cdn = options?.cdn;
+        return this.requestJson(ValidHttpMethod.POST, `api/v1/delete`, { Accept: 'application/json', 'Content-Type': 'application/json' }, JSON.stringify({ key, cdn }));
     }
     async createUploadUrl(body) {
         return this.requestJson(ValidHttpMethod.POST, 'api/v1/upload-url', {
@@ -55,11 +57,12 @@ class ObjectStoreClient {
             'Content-Type': 'application/json'
         }, JSON.stringify(body));
     }
-    async createDownloadUrl(key) {
+    async createDownloadUrl(key, options) {
+        const cdn = options?.cdn;
         return this.requestJson(ValidHttpMethod.POST, `api/v1/download-url`, {
             Accept: 'application/json',
             'Content-Type': 'application/json'
-        }, JSON.stringify({ key }));
+        }, JSON.stringify({ key, cdn }));
     }
 }
 exports.ObjectStoreClient = ObjectStoreClient;

package/out/types.d.ts

@@ -13,8 +13,15 @@ export interface UploadUrlBody {
     checksumType: 'SHA1' | 'SHA256' | 'CRC32' | 'CRC32C';
     ttlSeconds?: number;
     overwrite?: boolean;
+    cdn?: boolean;
 }
 export interface PresignedUrlResponse {
     url: string;
 }
+export interface BaseOptions {
+    cdn?: boolean;
+}
+export declare type GetOptions = BaseOptions;
+export declare type DeleteOptions = BaseOptions;
+export declare type CreateDownloadUrlOptions = BaseOptions;
 //# sourceMappingURL=types.d.ts.map

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IACrD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;CACb"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IACrD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,oBAAY,UAAU,GAAG,WAAW,CAAC;AACrC,oBAAY,aAAa,GAAG,WAAW,CAAC;AACxC,oBAAY,wBAAwB,GAAG,WAAW,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/object-store",
-  "version": "1.1.1",
+  "version": "1.1.2-next.0-experimental-0c74a4b",
   "description": "Forge Object Store SDK",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -20,7 +20,7 @@
     "jest-when": "^3.6.0"
   },
   "dependencies": {
-    "@forge/api": "^6.4.1"
+    "@forge/api": "^6.4.2-next.0-experimental-0c74a4b"
   },
   "publishConfig": {
     "registry": "https://packages.atlassian.com/api/npm/npm-public/"