@forge/object-store 1.3.5-next.0 → 1.4.0-next.1

package/README.md

@@ -49,6 +49,10 @@ const payload = {
 const uploadUrlResponse = await fos.createUploadUrl(payload);
 const uploadUrl = uploadUrlResponse.url;
 
+// Create a pre-signed upload url for use in browsers
+const publicUploadUrlResponse = await fos.createUploadUrl(payload);
+const publicUploadUrl = publicUploadUrlResponse.url;
+
 // Both standard fetch or api.fetch can be used to upload the buffer
 const response = await fetch(url, {
       method: 'PUT',

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

@@ -181,6 +181,38 @@ describe('ObjectStoreClient', () => {
             expect(response).toEqual({ url: 'upload-url' });
         });
     });
+    describe('createPublicUploadUrl', () => {
+        it('should send a POST request with the correct headers and body, and return a URL', async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                text: createMockBody(JSON.stringify({ url: 'public-upload-url' }))
+            };
+            mockFetch.mockResolvedValue(mockResponse);
+            const objectId = '1';
+            const fileProperties = {
+                key: objectId,
+                length: 123,
+                checksum: 'abc123',
+                checksumType: 'SHA1',
+                ttlSeconds: 3600,
+                overwrite: true
+            };
+            const response = await osClient.createPublicUploadUrl(fileProperties);
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/public-upload-url', {
+                method: 'POST',
+                redirect: 'follow',
+                headers: {
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(fileProperties)
+            });
+            expect(mockResponse.status).toBe(200);
+            expect(mockResponse.text).toHaveBeenCalled();
+            expect(response).toEqual({ url: 'public-upload-url' });
+        });
+    });
     describe('createDownloadUrl', () => {
         it('should send a POST request with the correct headers and body, and return a URL', async () => {
             const mockResponse = {
@@ -227,6 +259,52 @@ describe('ObjectStoreClient', () => {
             expect(response).toEqual({ url: 'download-url' });
         });
     });
+    describe('createPublicDownloadUrl', () => {
+        it('should send a POST request with the correct headers and body, and return a URL', async () => {
+            const mockResponse = {
+                ok: true,
+                status: 200,
+                text: createMockBody(JSON.stringify({ url: 'public-download-url' }))
+            };
+            mockFetch.mockResolvedValue(mockResponse);
+            const objectId = '1';
+            const response = await osClient.createPublicDownloadUrl(objectId);
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/public-download-url', {
+                method: 'POST',
+                redirect: 'follow',
+                headers: {
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({ key: objectId })
+            });
+            expect(mockResponse.status).toBe(200);
+            expect(mockResponse.text).toHaveBeenCalled();
+            expect(response).toEqual({ url: 'public-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: 'public-download-url' }))
+            };
+            mockFetch.mockResolvedValue(mockResponse);
+            const objectId = '1';
+            const response = await osClient.createPublicDownloadUrl(objectId, { cdn: true });
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/public-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: 'public-download-url' });
+        });
+    });
     describe('createCDNUrl', () => {
         it('should send a POST request with the correct headers and body, and return a URL', async () => {
             const mockResponse = {

package/out/object-store.d.ts

@@ -5,7 +5,9 @@ export declare class ObjectStoreClient {
     get(key: string, options?: GetOptions): Promise<ObjectReference | undefined>;
     delete(key: string, options?: DeleteOptions): Promise<void>;
     createUploadUrl(body: UploadUrlBody): Promise<PresignedUrlResponse | undefined>;
+    createPublicUploadUrl(body: UploadUrlBody): Promise<PresignedUrlResponse | undefined>;
     createDownloadUrl(key: string, options?: CreateDownloadUrlOptions): Promise<PresignedUrlResponse | undefined>;
+    createPublicDownloadUrl(key: string, options?: CreateDownloadUrlOptions): Promise<PresignedUrlResponse | undefined>;
     createCDNUrl(key: string, options?: CDNOptions): Promise<PresignedUrlResponse | undefined>;
 }
 export declare const objectStore: ObjectStoreClient;

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,EACL,UAAU,EACV,wBAAwB,EACxB,aAAa,EACb,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,aAAa,EACd,MAAM,SAAS,CAAC;AASjB,qBAAa,iBAAiB;YAEd,WAAW;YASX,WAAW;IAoCZ,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAkB5E,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;IAiB/E,iBAAiB,CAC5B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAkB/B,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;CAYxG;AAED,eAAO,MAAM,WAAW,mBAA0B,CAAC"}
+{"version":3,"file":"object-store.d.ts","sourceRoot":"","sources":["../src/object-store.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,UAAU,EACV,wBAAwB,EACxB,aAAa,EACb,UAAU,EACV,eAAe,EACf,oBAAoB,EACpB,aAAa,EACd,MAAM,SAAS,CAAC;AASjB,qBAAa,iBAAiB;YAEd,WAAW;YASX,WAAW;IAoCZ,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAkB5E,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,qBAAqB,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAiBrF,iBAAiB,CAC5B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAkB/B,uBAAuB,CAClC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAkB/B,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;CAYxG;AAED,eAAO,MAAM,WAAW,mBAA0B,CAAC"}

package/out/object-store.js

@@ -57,6 +57,12 @@ class ObjectStoreClient {
             'Content-Type': 'application/json'
         }, JSON.stringify(body));
     }
+    async createPublicUploadUrl(body) {
+        return this.requestJson(ValidHttpMethod.POST, 'api/v1/public-upload-url', {
+            Accept: 'application/json',
+            'Content-Type': 'application/json'
+        }, JSON.stringify(body));
+    }
     async createDownloadUrl(key, options) {
         const cdn = options?.cdn;
         return this.requestJson(ValidHttpMethod.POST, 'api/v1/download-url', {
@@ -64,6 +70,13 @@ class ObjectStoreClient {
             'Content-Type': 'application/json'
         }, JSON.stringify({ key, cdn }));
     }
+    async createPublicDownloadUrl(key, options) {
+        const cdn = options?.cdn;
+        return this.requestJson(ValidHttpMethod.POST, 'api/v1/public-download-url', {
+            Accept: 'application/json',
+            'Content-Type': 'application/json'
+        }, JSON.stringify({ key, cdn }));
+    }
     async createCDNUrl(key, options) {
         const ttlSeconds = options?.ttlSeconds;
         return this.requestJson(ValidHttpMethod.POST, 'api/v1/cdn-url', {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/object-store",
-  "version": "1.3.5-next.0",
+  "version": "1.4.0-next.1",
   "description": "Forge Object Store SDK",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",