@forge/os 2.0.5-next.0-experimental-5ae8c1c → 2.1.0-next.0

package/out/__test__/os.test.js

@@ -102,7 +102,7 @@ describe('ObjectStoreClient', () => {
         });
     });
     describe('get', () => {
-        it('should send a GET request with the correct headers and b', async () => {
+        it('should send a POST request with the correct headers and body', async () => {
             const mockResponse = {
                 ok: true,
                 status: 200,
@@ -111,12 +111,16 @@ describe('ObjectStoreClient', () => {
             mockFetch.mockResolvedValue(mockResponse);
             const objectId = '1';
             const response = await osClient.get(objectId);
-            expect(mockFetch).toHaveBeenCalledWith('api/v1/objects/1', {
-                method: 'GET',
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/metadata', {
+                method: 'POST',
                 redirect: 'follow',
                 headers: {
-                    Accept: 'application/json'
-                }
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({
+                    key: objectId
+                })
             });
             expect(mockResponse.status).toBe(200);
             expect(mockResponse.text).toHaveBeenCalled();
@@ -124,17 +128,19 @@ describe('ObjectStoreClient', () => {
         });
     });
     describe('delete', () => {
-        it('should send a DELETE request with the correct headers', async () => {
+        it('should send a POST request with the correct headers and body', async () => {
             const mockResponse = { ok: true, status: 204, text: createMockBody(null) };
             mockFetch.mockResolvedValue(mockResponse);
             const objectId = '1';
             await osClient.delete(objectId);
-            expect(mockFetch).toHaveBeenCalledWith('api/v1/objects/1', {
-                method: 'DELETE',
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/delete', {
+                method: 'POST',
                 redirect: 'follow',
                 headers: {
-                    Accept: 'application/json'
-                }
+                    Accept: 'application/json',
+                    'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({ key: objectId })
             });
             expect(mockResponse.status).toBe(204);
             expect(mockResponse.text).toHaveBeenCalled();
@@ -162,4 +168,60 @@ describe('ObjectStoreClient', () => {
             expect(response?.toString('utf-8')).toEqual('I shall be downloaded as buffer!');
         });
     });
+    describe('createUploadUrl', () => {
+        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: '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.createUploadUrl(fileProperties);
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/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: 'upload-url' });
+        });
+    });
+    describe('createDownloadUrl', () => {
+        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: 'download-url' }))
+            };
+            mockFetch.mockResolvedValue(mockResponse);
+            const objectId = '1';
+            const response = await osClient.createDownloadUrl(objectId);
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/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: 'download-url' });
+        });
+    });
 });

package/out/os.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { ObjectReference } from './types';
+import { ObjectReference, PresignedUrlResponse, UploadUrlBody } from './types';
 export declare class ObjectStoreClient {
     private sendRequest;
     private requestJson;
@@ -8,6 +8,8 @@ export declare class ObjectStoreClient {
     get(objectId: string): Promise<ObjectReference | undefined>;
     delete(objectId: string): Promise<void>;
     download(objectId: string): Promise<Buffer | undefined>;
+    createUploadUrl(body: UploadUrlBody): Promise<PresignedUrlResponse | undefined>;
+    createDownloadUrl(objectId: string): Promise<PresignedUrlResponse | undefined>;
 }
 export declare const os: ObjectStoreClient;
 //# sourceMappingURL=os.d.ts.map

package/out/os.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"os.d.ts","sourceRoot":"","sources":["../src/os.ts"],"names":[],"mappings":";;AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAQ1C,qBAAa,iBAAiB;YAEd,WAAW;YASX,WAAW;IAqCZ,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAahG,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAU3D,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQvC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAerE;AAED,eAAO,MAAM,EAAE,mBAA0B,CAAC"}
+{"version":3,"file":"os.d.ts","sourceRoot":"","sources":["../src/os.ts"],"names":[],"mappings":";;AAGA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAS/E,qBAAa,iBAAiB;YAEd,WAAW;YASX,WAAW;IAqCZ,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAahG,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IAgB3D,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAavC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAoBvD,eAAe,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;IAgB/E,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC;CAW5F;AAED,eAAO,MAAM,EAAE,mBAA0B,CAAC"}

package/out/os.js

@@ -9,6 +9,7 @@ var ValidHttpMethod;
     ValidHttpMethod["PUT"] = "PUT";
     ValidHttpMethod["GET"] = "GET";
     ValidHttpMethod["DELETE"] = "DELETE";
+    ValidHttpMethod["POST"] = "POST";
 })(ValidHttpMethod || (ValidHttpMethod = {}));
 class ObjectStoreClient {
     async sendRequest(path, options) {
@@ -48,12 +49,13 @@ class ObjectStoreClient {
         return this.requestJson(ValidHttpMethod.PUT, `api/v1/objects/${objectId}`, headers, buffer);
     }
     async get(objectId) {
-        return this.requestJson(ValidHttpMethod.GET, `api/v1/objects/${objectId}`, {
-            Accept: 'application/json'
-        });
+        return this.requestJson(ValidHttpMethod.POST, `api/v1/metadata`, {
+            Accept: 'application/json',
+            'Content-Type': 'application/json'
+        }, JSON.stringify({ key: objectId }));
     }
     async delete(objectId) {
-        await this.requestJson(ValidHttpMethod.DELETE, `api/v1/objects/${objectId}`, { Accept: 'application/json' });
+        return this.requestJson(ValidHttpMethod.POST, `api/v1/delete`, { Accept: 'application/json', 'Content-Type': 'application/json' }, JSON.stringify({ key: objectId }));
     }
     async download(objectId) {
         const response = await this.sendRequest(`api/v1/objects/${objectId}/download`, {
@@ -68,6 +70,18 @@ class ObjectStoreClient {
         await (0, error_handling_1.checkResponseError)(response);
         return await response.arrayBuffer().then((buffer) => Buffer.from(buffer));
     }
+    async createUploadUrl(body) {
+        return this.requestJson(ValidHttpMethod.POST, 'api/v1/upload-url', {
+            Accept: 'application/json',
+            'Content-Type': 'application/json'
+        }, JSON.stringify(body));
+    }
+    async createDownloadUrl(objectId) {
+        return this.requestJson(ValidHttpMethod.POST, `api/v1/download-url`, {
+            Accept: 'application/json',
+            'Content-Type': 'application/json'
+        }, JSON.stringify({ key: objectId }));
+    }
 }
 exports.ObjectStoreClient = ObjectStoreClient;
 exports.os = new ObjectStoreClient();

package/out/types.d.ts

@@ -5,4 +5,15 @@ export interface ObjectReference {
     createdAt?: string;
     currentVersion?: string;
 }
+export interface UploadUrlBody {
+    key: string;
+    length: number;
+    checksum: string;
+    checksumType: 'SHA1' | 'SHA256' | 'CRC32' | 'CRC32C';
+    ttlSeconds?: number;
+    overwrite?: boolean;
+}
+export interface PresignedUrlResponse {
+    url: string;
+}
 //# 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;CACzB"}
+{"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;CACzB;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"}

package/out/utils/__test__/error-handling.test.js

@@ -96,7 +96,7 @@ describe('error-handling', () => {
                     }, {
                         code: errorCodes_1.errorCodes.UNKNOWN_ERROR,
                         context: { responseText: '' },
-                        message: 'Unexpected error in Forge SQL API request'
+                        message: 'Unexpected error in Forge OS API request'
                     }));
                 });
                 it("returns UNKNOWN_ERROR if there is a JSON body that isn't a forge error", async () => {
@@ -113,7 +113,7 @@ describe('error-handling', () => {
                     }, {
                         code: errorCodes_1.errorCodes.UNKNOWN_ERROR,
                         context: { responseText: body },
-                        message: 'Unexpected error in Forge SQL API request'
+                        message: 'Unexpected error in Forge OS API request'
                     }));
                 });
                 it('returns RATE_LIMIT_EXCEEDED when status is 429', async () => {

package/out/utils/error-handling.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-handling.d.ts","sourceRoot":"","sources":["../../src/utils/error-handling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAA2B,UAAU,EAA4B,MAAM,WAAW,CAAC;AAG1F,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,UAAU,CAE9D;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAMnE;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAEnE;AAED,wBAAsB,kBAAkB,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA+B/F"}
+{"version":3,"file":"error-handling.d.ts","sourceRoot":"","sources":["../../src/utils/error-handling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAA2B,UAAU,EAA4B,MAAM,WAAW,CAAC;AAG1F,wBAAgB,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,UAAU,CAE9D;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAMnE;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAInE;AAED,wBAAsB,kBAAkB,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA+B/F"}

package/out/utils/error-handling.js

@@ -17,7 +17,7 @@ function safeGetParsedBody(text) {
 }
 exports.safeGetParsedBody = safeGetParsedBody;
 function extractTraceId(response) {
-    return response.headers.get('x-b3-traceid') || response.headers.get('x-trace-id');
+    return (response.headers.get('x-b3-traceid') || response.headers.get('x-trace-id') || response.headers.get('atl-traceid'));
 }
 exports.extractTraceId = extractTraceId;
 async function checkResponseError(response, message) {
@@ -42,7 +42,7 @@ async function checkResponseError(response, message) {
     }
     throw new errors_1.ForgeObjectStoreAPIError(details, {
         code: errorCodes_1.errorCodes.UNKNOWN_ERROR,
-        message: message || 'Unexpected error in Forge SQL API request',
+        message: message || 'Unexpected error in Forge OS API request',
         context: { responseText }
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/os",
-  "version": "2.0.5-next.0-experimental-5ae8c1c",
+  "version": "2.1.0-next.0",
   "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.1.1-next.0-experimental-5ae8c1c"
+    "@forge/api": "^6.1.1"
   },
   "publishConfig": {
     "registry": "https://packages.atlassian.com/api/npm/npm-public/"