@forge/os 1.1.0 → 1.1.2-next.1

package/out/__test__/os.test.js

@@ -42,14 +42,11 @@ describe('ObjectStoreClient', () => {
             const path = 'api/v1/objects/1';
             const response = await osClient['sendRequest'](path);
             expect(mockFetch).toHaveBeenCalledWith(path, {
-                redirect: 'follow',
-                headers: {
-                    ...DEFAULT_HEADERS
-                }
+                redirect: 'follow'
             });
             expect(response).toBe(mockResponse);
         });
-        it('should handle requests that override the default headers', async () => {
+        it('should handle requests that set headers', async () => {
             const mockResponse = { ok: true, status: 200 };
             mockFetch.mockResolvedValue(mockResponse);
             const path = 'api/v1/objects/1';
@@ -59,47 +56,44 @@ describe('ObjectStoreClient', () => {
                 redirect: 'follow',
                 method: 'GET',
                 headers: {
-                    ...DEFAULT_HEADERS,
                     'Content-Type': 'application/octet-stream'
                 }
             });
             expect(response).toBe(mockResponse);
         });
     });
-    describe('echo', () => {
-        it('should send a GET request to the echo endpoint', async () => {
-            const mockResponse = {
-                ok: true,
-                status: 200,
-                text: createMockBody(JSON.stringify({ message: 'Blåhaj' }))
-            };
+    describe('put', () => {
+        it('should send a PUT request with the correct headers and body', async () => {
+            const mockResponse = { ok: true, status: 201, text: createMockBody(null) };
             mockFetch.mockResolvedValue(mockResponse);
-            const response = await osClient.echo();
-            expect(mockFetch).toHaveBeenCalledWith('api/v1/echo', {
-                method: 'GET',
+            const objectId = '1';
+            const buffer = Buffer.from('hello world');
+            await osClient.put(objectId, buffer);
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/objects/1', {
+                method: 'PUT',
                 redirect: 'follow',
                 headers: {
-                    ...DEFAULT_HEADERS
-                }
+                    ...DEFAULT_HEADERS,
+                    'Content-Type': 'application/octet-stream'
+                },
+                body: buffer
             });
-            expect(mockResponse.status).toBe(200);
+            expect(mockResponse.status).toBe(201);
             expect(mockResponse.text).toHaveBeenCalled();
-            expect(response).toEqual({ message: 'Blåhaj' });
         });
-    });
-    describe('put', () => {
-        it('should send a PUT request with the correct headers and body', async () => {
+        it('should send a PUT request with the ttl headers and body', async () => {
             const mockResponse = { ok: true, status: 201, text: createMockBody(null) };
             mockFetch.mockResolvedValue(mockResponse);
             const objectId = '1';
             const buffer = Buffer.from('hello world');
-            await osClient.put(objectId, buffer);
+            await osClient.put(objectId, buffer, 100);
             expect(mockFetch).toHaveBeenCalledWith('api/v1/objects/1', {
                 method: 'PUT',
                 redirect: 'follow',
                 headers: {
                     ...DEFAULT_HEADERS,
-                    'Content-Type': 'application/octet-stream'
+                    'Content-Type': 'application/octet-stream',
+                    'ttl-seconds': '100'
                 },
                 body: buffer
             });
@@ -121,7 +115,7 @@ describe('ObjectStoreClient', () => {
                 method: 'GET',
                 redirect: 'follow',
                 headers: {
-                    ...DEFAULT_HEADERS
+                    Accept: 'application/json'
                 }
             });
             expect(mockResponse.status).toBe(200);
@@ -139,7 +133,7 @@ describe('ObjectStoreClient', () => {
                 method: 'DELETE',
                 redirect: 'follow',
                 headers: {
-                    ...DEFAULT_HEADERS
+                    Accept: 'application/json'
                 }
             });
             expect(mockResponse.status).toBe(204);
@@ -156,11 +150,10 @@ describe('ObjectStoreClient', () => {
             mockFetch.mockResolvedValue(mockResponse);
             const objectId = '1';
             const response = await osClient.download(objectId);
-            expect(mockFetch).toHaveBeenCalledWith('api/v1/objects/1', {
+            expect(mockFetch).toHaveBeenCalledWith('api/v1/objects/1/download', {
                 method: 'GET',
                 redirect: 'follow',
                 headers: {
-                    ...DEFAULT_HEADERS,
                     Accept: 'application/octet-stream'
                 }
             });

package/out/index.d.ts

@@ -1,6 +1,7 @@
 import { os } from './os';
 import { errorCodes } from './errorCodes';
 import { ForgeError } from './errors';
-export { errorCodes, os, ForgeError };
+import { ObjectReference, VersionsList } from './types';
+export { errorCodes, os, ForgeError, ObjectReference, VersionsList };
 export default os;
 //# 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,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC;AAEtC,eAAe,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,MAAM,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAExD,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC;AAErE,eAAe,EAAE,CAAC"}

package/out/os.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="node" />
+import { ObjectReference, VersionsList } from './types';
 export declare class ObjectStoreClient {
     private sendRequest;
-    private storageApi;
-    echo(): Promise<string | null>;
-    put(objectId: string, buffer: Buffer): Promise<void>;
-    get<DataType>(objectId: string): Promise<DataType | null>;
+    private requestJson;
+    put(objectId: string, buffer: Buffer, ttlSeconds?: number): Promise<ObjectReference | null>;
+    get(objectId: string): Promise<ObjectReference | null>;
     delete(objectId: string): Promise<void>;
-    listVersions(objectId: string): Promise<unknown>;
+    listVersions(objectId: string): Promise<VersionsList | null>;
     download(objectId: string): Promise<Buffer | null>;
 }
 export declare const os: ObjectStoreClient;

package/out/os.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"os.d.ts","sourceRoot":"","sources":["../src/os.ts"],"names":[],"mappings":";AAgBA,qBAAa,iBAAiB;YAEd,WAAW;YAYX,UAAU;IA8BX,IAAI;IAIJ,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQpD,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAIzD,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC,YAAY,CAAC,QAAQ,EAAE,MAAM;IAI7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAOhE;AAED,eAAO,MAAM,EAAE,mBAA0B,CAAC"}
+{"version":3,"file":"os.d.ts","sourceRoot":"","sources":["../src/os.ts"],"names":[],"mappings":";AAIA,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAQxD,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,IAAI,CAAC;IAa3F,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAUtD,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQvC,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAU5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAehE;AAED,eAAO,MAAM,EAAE,mBAA0B,CAAC"}

package/out/os.js

@@ -10,67 +10,68 @@ var ValidHttpMethod;
     ValidHttpMethod["GET"] = "GET";
     ValidHttpMethod["DELETE"] = "DELETE";
 })(ValidHttpMethod || (ValidHttpMethod = {}));
-const DEFAULT_HEADERS = {
-    Accept: 'application/json',
-    'Content-Type': 'application/json'
-};
 class ObjectStoreClient {
     async sendRequest(path, options) {
         return await (0, api_1.__fetchProduct)({ provider: 'app', remote: 'os' })(path, {
             ...options,
             redirect: 'follow',
-            headers: {
-                ...DEFAULT_HEADERS,
-                ...options?.headers
-            }
+            headers: options?.headers
         });
     }
-    async storageApi(method, path, headers, body) {
+    async requestJson(method, path, headers, body) {
         const response = await this.sendRequest(path, {
             method,
             headers,
             body
         });
-        await (0, error_handling_1.checkResponseError)(response);
-        if (headers?.Accept === 'application/octet-stream') {
-            return response.arrayBuffer().then((buffer) => Buffer.from(buffer));
+        if (response.status === 404) {
+            return null;
         }
+        await (0, error_handling_1.checkResponseError)(response);
         const responseText = await response.text();
-        if (responseText) {
-            try {
-                return JSON.parse(responseText);
-            }
-            catch (error) {
-                throw new errors_1.ForgeObjectStoreError(`Unexpected error. Response was not valid JSON: ${responseText}`);
-            }
+        if (!responseText || responseText.trim().length === 0) {
+            return null;
+        }
+        try {
+            return JSON.parse(responseText);
+        }
+        catch (error) {
+            throw new errors_1.ForgeObjectStoreError(`Unexpected error. Response was not valid JSON: ${responseText}`);
         }
-        return null;
-    }
-    async echo() {
-        return this.storageApi(ValidHttpMethod.GET, `api/v1/echo`, { 'Content-Type': 'application/json' });
     }
-    async put(objectId, buffer) {
+    async put(objectId, buffer, ttlSeconds) {
         const headers = {
-            ...DEFAULT_HEADERS,
-            'Content-Type': 'application/octet-stream'
+            Accept: 'application/json',
+            'Content-Type': 'application/octet-stream',
+            ...(ttlSeconds ? { 'ttl-seconds': ttlSeconds.toString() } : {})
         };
-        await this.storageApi(ValidHttpMethod.PUT, `api/v1/objects/${objectId}`, headers, buffer);
+        return this.requestJson(ValidHttpMethod.PUT, `api/v1/objects/${objectId}`, headers, buffer);
     }
     async get(objectId) {
-        return this.storageApi(ValidHttpMethod.GET, `api/v1/objects/${objectId}`, DEFAULT_HEADERS);
+        return this.requestJson(ValidHttpMethod.GET, `api/v1/objects/${objectId}`, {
+            Accept: 'application/json'
+        });
     }
     async delete(objectId) {
-        await this.storageApi(ValidHttpMethod.DELETE, `api/v1/objects/${objectId}`, DEFAULT_HEADERS);
+        await this.requestJson(ValidHttpMethod.DELETE, `api/v1/objects/${objectId}`, { Accept: 'application/json' });
     }
     async listVersions(objectId) {
-        return this.storageApi(ValidHttpMethod.GET, `api/v1/objects/${objectId}/versions`, DEFAULT_HEADERS);
+        return this.requestJson(ValidHttpMethod.GET, `api/v1/objects/${objectId}/versions`, {
+            Accept: 'application/json'
+        });
     }
     async download(objectId) {
-        const headers = {
-            ...DEFAULT_HEADERS,
-            Accept: 'application/octet-stream'
-        };
-        return this.storageApi(ValidHttpMethod.GET, `api/v1/objects/${objectId}`, headers);
+        const response = await this.sendRequest(`api/v1/objects/${objectId}/download`, {
+            method: ValidHttpMethod.GET,
+            headers: {
+                Accept: 'application/octet-stream'
+            }
+        });
+        if (response.status === 404) {
+            return null;
+        }
+        await (0, error_handling_1.checkResponseError)(response);
+        return await response.arrayBuffer().then((buffer) => Buffer.from(buffer));
     }
 }
 exports.ObjectStoreClient = ObjectStoreClient;

package/out/types.d.ts

@@ -0,0 +1,11 @@
+export interface ObjectReference {
+    key: string;
+    checksum: string;
+    size: number;
+    createdAt?: string;
+    currentVersion?: string;
+}
+export interface VersionsList {
+    versions: ObjectReference[];
+}
+//# sourceMappingURL=types.d.ts.map

package/out/types.d.ts.map

@@ -0,0 +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;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,eAAe,EAAE,CAAC;CAC7B"}

package/out/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/os",
-  "version": "1.1.0",
+  "version": "1.1.2-next.1",
   "description": "Forge Object Store SDK",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -22,6 +22,6 @@
     "jest-when": "^3.6.0"
   },
   "dependencies": {
-    "@forge/api": "^4.1.2"
+    "@forge/api": "^4.2.0-next.0"
   }
 }