@forge/cache 0.8.0-next.2 → 0.9.0-next.0

package/out/__test__/tunnel.test.js

@@ -2,9 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tunnel_1 = require("../tunnel");
 const validator_1 = require("../utils/validator");
-const parseSuccessResponse = (response) => {
-    return { response };
-};
 describe('Forge Cache Tunnel', () => {
     let cache;
     beforeEach(() => {
@@ -13,12 +10,12 @@ describe('Forge Cache Tunnel', () => {
     });
     test('set method', async () => {
         const response = await cache.set('key', 'value');
-        expect(response).toStrictEqual(parseSuccessResponse('OK'));
+        expect(response).toStrictEqual(undefined);
     });
     test('get method', async () => {
         await cache.set('key', 'value');
         const response = await cache.get('key');
-        expect(response).toStrictEqual(parseSuccessResponse('value'));
+        expect(response).toStrictEqual('value');
     });
     test('get method throws error for list value', async () => {
         cache.__localStore.set('key', ['value1', 'value2']);
@@ -31,51 +28,51 @@ describe('Forge Cache Tunnel', () => {
     });
     test('setIfNotExists method', async () => {
         const response = await cache.setIfNotExists('key', 'value');
-        expect(response).toStrictEqual(parseSuccessResponse('OK'));
+        expect(response).toStrictEqual('OK');
         const newResponse = await cache.setIfNotExists('key', 'new value');
-        expect(newResponse).toStrictEqual(parseSuccessResponse(null));
+        expect(newResponse).toStrictEqual(null);
     });
     test('getAndSet method', async () => {
         await cache.set('key', 'value');
         const response = await cache.getAndSet('key', 'new value');
-        expect(response).toStrictEqual(parseSuccessResponse('value'));
+        expect(response).toStrictEqual('value');
         const newResponse = await cache.get('key');
-        expect(newResponse).toStrictEqual(parseSuccessResponse('new value'));
+        expect(newResponse).toStrictEqual('new value');
     });
     test('delete method', async () => {
         await cache.set('key', 'value');
         const response = await cache.delete('key');
-        expect(response).toStrictEqual(parseSuccessResponse(1));
+        expect(response).toStrictEqual(1);
         const newResponse = await cache.get('key');
-        expect(newResponse).toStrictEqual(parseSuccessResponse(null));
+        expect(newResponse).toStrictEqual(null);
     });
     test('incrementAndGet method', async () => {
         await cache.set('key', '5');
         const response = await cache.incrementAndGet('key');
-        expect(response).toStrictEqual(parseSuccessResponse(6));
+        expect(response).toStrictEqual(6);
     });
     test('leftPush method', async () => {
         cache.__localStore.set('key', ['value1', 'value2']);
         const response = await cache.leftPush('key', 'value3');
         const result = ['value3', 'value1', 'value2'].length;
-        expect(response).toStrictEqual(parseSuccessResponse(result));
+        expect(response).toStrictEqual(result);
     });
     test('rightPop method', async () => {
         await cache.leftPush('key', 'value1');
         await cache.leftPush('key', 'value2');
         const response = await cache.rightPop('key');
-        expect(response).toStrictEqual(parseSuccessResponse('value1'));
+        expect(response).toStrictEqual('value1');
     });
     test('listLength method', async () => {
         await cache.leftPush('key', 'value1');
         await cache.leftPush('key', 'value2');
         const response = await cache.listLength('key');
-        expect(response).toStrictEqual(parseSuccessResponse(2));
+        expect(response).toStrictEqual(2);
     });
     test('decrementAndGet method', async () => {
         await cache.set('key', '5');
         const response = await cache.decrementAndGet('key');
-        expect(response).toStrictEqual(parseSuccessResponse(4));
+        expect(response).toStrictEqual(4);
     });
     test('incrementAndGet method throws error when key holds a list value', async () => {
         cache.__localStore.set('key', ['value1', 'value2']);

package/out/tunnel.d.ts

@@ -28,6 +28,6 @@ export declare class TunnelCache implements IForgeCache {
         cursor?: string;
         count?: number;
     }): Promise<ScanResult>;
-    parseSuccessResponse(response: string | number | null | string[]): Promise<any>;
+    parseSuccessResponse(response: string | number | null | string[] | any): Promise<any>;
 }
 //# sourceMappingURL=tunnel.d.ts.map

package/out/tunnel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tunnel.d.ts","sourceRoot":"","sources":["../src/tunnel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAQjD,oBAAY,eAAe,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,CAAC,CAAC;AAEzE,qBAAa,WAAY,YAAW,WAAW;IACtC,YAAY,EAAE,eAAe,CAAC;gBACzB,KAAK,EAAE,eAAe;IAKrB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAS5E,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAQxC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAW9F,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAU3F,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IASpC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAS3E,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAcrD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAW7C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAWxC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAW3E,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IAsBlG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;CAKhF"}
+{"version":3,"file":"tunnel.d.ts","sourceRoot":"","sources":["../src/tunnel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAQjD,oBAAY,eAAe,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,CAAC,CAAC;AAEzE,qBAAa,WAAY,YAAW,WAAW;IACtC,YAAY,EAAE,eAAe,CAAC;gBACzB,KAAK,EAAE,eAAe;IAKrB,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ5E,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IASxC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;IAa9F,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAW3F,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAWpC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAU3E,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAerD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAe7C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAaxC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAY3E,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IAsBlG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,EAAE,GAAG,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;CAKtF"}

package/out/tunnel.js

@@ -11,23 +11,25 @@ class TunnelCache {
         (0, validator_1.assertIsValidValue)(value);
         (0, validator_1.assertIsSizedValue)(value);
         this.__localStore.set(key, value);
-        return await this.parseSuccessResponse('OK');
     }
     async get(key) {
         (0, validator_1.assertIsValidKey)(key);
         const value = this.__localStore.get(key);
         (0, validator_1.assertAndThrowIfArray)(value);
-        return await this.parseSuccessResponse(value !== null && value !== void 0 ? value : null);
+        const { response: result } = await this.parseSuccessResponse(value !== null && value !== void 0 ? value : null);
+        return result;
     }
     async setIfNotExists(key, value, opt) {
         (0, validator_1.assertIsValidKey)(key);
         (0, validator_1.assertIsValidValue)(value);
         (0, validator_1.assertIsSizedValue)(value);
         if (this.__localStore.get(key)) {
-            return await this.parseSuccessResponse(null);
+            const { response: result } = await this.parseSuccessResponse(null);
+            return result;
         }
         this.__localStore.set(key, value);
-        return await this.parseSuccessResponse('OK');
+        const { response: result } = await this.parseSuccessResponse('OK');
+        return result;
     }
     async getAndSet(key, value, opt) {
         var _a;
@@ -36,15 +38,18 @@ class TunnelCache {
         (0, validator_1.assertIsSizedValue)(value);
         const oldValue = (_a = this.__localStore.get(key)) !== null && _a !== void 0 ? _a : null;
         this.__localStore.set(key, value);
-        return await this.parseSuccessResponse(oldValue);
+        const { response: result } = await this.parseSuccessResponse(oldValue);
+        return result;
     }
     async delete(key) {
         (0, validator_1.assertIsValidKey)(key);
         if (this.__localStore.get(key)) {
             this.__localStore.delete(key);
-            return await this.parseSuccessResponse(1);
+            const { response: result } = await this.parseSuccessResponse(1);
+            return result;
         }
-        return await this.parseSuccessResponse(0);
+        const { response: result } = await this.parseSuccessResponse(0);
+        return result;
     }
     async incrementAndGet(key, opt) {
         var _a;
@@ -53,7 +58,8 @@ class TunnelCache {
         (0, validator_1.assertAndThrowIfArray)(oldValue);
         const newValue = Number.parseInt((_a = oldValue) !== null && _a !== void 0 ? _a : '0') + 1;
         this.__localStore.set(key, newValue.toString());
-        return await this.parseSuccessResponse(newValue);
+        const { response: result } = await this.parseSuccessResponse(newValue);
+        return result;
     }
     async leftPush(key, value) {
         (0, validator_1.assertIsValidKey)(key);
@@ -65,25 +71,30 @@ class TunnelCache {
             this.__localStore.set(key, []);
         }
         this.__localStore.get(key).unshift(value);
-        return await this.parseSuccessResponse(this.__localStore.get(key).length);
+        const { response: result } = await this.parseSuccessResponse(this.__localStore.get(key).length);
+        return result;
     }
     async rightPop(key) {
         (0, validator_1.assertIsValidKey)(key);
         const oldValue = this.__localStore.get(key);
         if (!oldValue) {
-            return await this.parseSuccessResponse(null);
+            const { response: result } = await this.parseSuccessResponse(null);
+            return result;
         }
         (0, validator_1.assertAndThrowIfNotArray)(oldValue);
-        return await this.parseSuccessResponse(this.__localStore.get(key).pop() || null);
+        const { response: result } = await this.parseSuccessResponse(this.__localStore.get(key).pop() || null);
+        return result;
     }
     async listLength(key) {
         (0, validator_1.assertIsValidKey)(key);
         const oldValue = this.__localStore.get(key);
         if (!oldValue) {
-            return await this.parseSuccessResponse(0);
+            const { response: result } = await this.parseSuccessResponse(0);
+            return result;
         }
         (0, validator_1.assertAndThrowIfNotArray)(oldValue);
-        return await this.parseSuccessResponse(this.__localStore.get(key).length);
+        const { response: result } = await this.parseSuccessResponse(this.__localStore.get(key).length);
+        return result;
     }
     async decrementAndGet(key, opt) {
         var _a;
@@ -92,7 +103,8 @@ class TunnelCache {
         (0, validator_1.assertAndThrowIfArray)(oldValue);
         const newValue = Number.parseInt((_a = oldValue) !== null && _a !== void 0 ? _a : '0') - 1;
         this.__localStore.set(key, newValue.toString());
-        return await this.parseSuccessResponse(newValue);
+        const { response: result } = await this.parseSuccessResponse(newValue);
+        return result;
     }
     async scan(pattern, opt) {
         const cursor = (opt === null || opt === void 0 ? void 0 : opt.cursor) ? Number(opt.cursor) : 0;

package/out/utils/validator.d.ts

@@ -1,11 +1,14 @@
-export declare class ForgeCacheTunnelError extends Error {
+import { HttpError } from '@forge/api';
+export declare class ForgeCacheTunnelError extends HttpError {
     readonly message: string;
     readonly reason?: any;
-    constructor(message: string, reason?: any);
+    readonly status: number;
+    constructor(message: string, reason?: any, status?: number);
 }
 export declare function assertIsValidValue(value: unknown): void;
 export declare function assertAndThrowIfArray(value: string | number | undefined | string[]): void;
 export declare function assertAndThrowIfNotArray(value: string | number | undefined | string[]): void;
 export declare function assertIsValidKey(key: unknown): void;
 export declare function assertIsSizedValue(value: unknown): void;
+export declare function getErrorMessageObj(title: string): string;
 //# sourceMappingURL=validator.d.ts.map

package/out/utils/validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/utils/validator.ts"],"names":[],"mappings":"AASA,qBAAa,qBAAsB,SAAQ,KAAK;IAE5C,QAAQ,CAAC,OAAO,EAAE,MAAM;IACxB,QAAQ,CAAC,MAAM,CAAC;gBADP,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,KAAK;CAIxB;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,QAOhD;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,QAIlF;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,QAIrF;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,QAsB5C;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,QAOhD"}
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/utils/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAUvC,qBAAa,qBAAsB,SAAQ,SAAS;IAEhD,QAAQ,CAAC,OAAO,EAAE,MAAM;IACxB,QAAQ,CAAC,MAAM,CAAC;IAChB,QAAQ,CAAC,MAAM,EAAE,MAAM;gBAFd,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,KAAK,EACZ,MAAM,GAAE,MAAY;CAKhC;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,QAOhD;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,QAIlF;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,QAIrF;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,QAsB5C;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,QAOhD;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQxD"}

package/out/utils/validator.js

@@ -1,27 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertIsSizedValue = exports.assertIsValidKey = exports.assertAndThrowIfNotArray = exports.assertAndThrowIfArray = exports.assertIsValidValue = exports.ForgeCacheTunnelError = void 0;
+exports.getErrorMessageObj = exports.assertIsSizedValue = exports.assertIsValidKey = exports.assertAndThrowIfNotArray = exports.assertAndThrowIfArray = exports.assertIsValidValue = exports.ForgeCacheTunnelError = void 0;
 const tslib_1 = require("tslib");
+const api_1 = require("@forge/api");
 const object_sizeof_1 = tslib_1.__importDefault(require("object-sizeof"));
 const MIN_VALID_KEY_LENGTH = 1;
 const MAX_VALID_KEY_LENGTH = 500;
 const VALID_KEY_REGEX = /^(?!\s+$)[a-zA-Z0-9:._\s-#]+$/;
 const KiB = 1024;
 const MAX_VALID_VALUE_LENGTH = 240 * KiB;
-class ForgeCacheTunnelError extends Error {
-    constructor(message, reason) {
+class ForgeCacheTunnelError extends api_1.HttpError {
+    constructor(message, reason, status = 400) {
         super(message);
         this.message = message;
         this.reason = reason;
+        this.status = status;
+        this.message = `${status}: ${message}`;
     }
 }
 exports.ForgeCacheTunnelError = ForgeCacheTunnelError;
 function assertIsValidValue(value) {
     if (value === undefined || value === null) {
-        throw new ForgeCacheTunnelError('Provided value is required');
+        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided value is required'));
     }
     if (typeof value !== 'string') {
-        throw new ForgeCacheTunnelError('Provided value must be a string', { type: typeof value });
+        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided value must be a string'), { type: typeof value });
     }
 }
 exports.assertIsValidValue = assertIsValidValue;
@@ -42,19 +45,19 @@ function assertIsValidKey(key) {
         throw new Error('Provided key must be a string');
     }
     if (key.length < MIN_VALID_KEY_LENGTH) {
-        throw new ForgeCacheTunnelError('Provided key length was under the minimum valid key length', {
+        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided key length was under the minimum valid key length'), {
             length: key.length,
             minLength: MIN_VALID_KEY_LENGTH
         });
     }
     if (key.length > MAX_VALID_KEY_LENGTH) {
-        throw new ForgeCacheTunnelError('Provided key length was above the maximum valid key length', {
+        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided key length was above the maximum valid key length'), {
             length: key.length,
             maxLength: MAX_VALID_KEY_LENGTH
         });
     }
     if (!VALID_KEY_REGEX.test(key)) {
-        throw new ForgeCacheTunnelError('Provided key must match regex', {
+        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided key must match regex'), {
             regex: VALID_KEY_REGEX
         });
     }
@@ -62,10 +65,20 @@ function assertIsValidKey(key) {
 exports.assertIsValidKey = assertIsValidKey;
 function assertIsSizedValue(value) {
     if ((0, object_sizeof_1.default)(value) > MAX_VALID_VALUE_LENGTH) {
-        throw new ForgeCacheTunnelError('Provided value bytes was over maximum valid value size', {
+        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided value bytes was over maximum valid value size'), {
             bytes: (0, object_sizeof_1.default)(value),
             maxBytes: MAX_VALID_VALUE_LENGTH
         });
     }
 }
 exports.assertIsSizedValue = assertIsSizedValue;
+function getErrorMessageObj(title) {
+    const obj = {
+        error: {
+            code: 'BadRequest',
+            title: title
+        }
+    };
+    return JSON.stringify(obj);
+}
+exports.getErrorMessageObj = getErrorMessageObj;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cache",
-  "version": "0.8.0-next.2",
+  "version": "0.9.0-next.0",
   "description": "Forge Cache methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -20,7 +20,7 @@
     "node-fetch": "2.7.0"
   },
   "dependencies": {
-    "@forge/api": "^3.6.0-next.0",
+    "@forge/api": "^3.6.0",
     "object-sizeof": "^2.6.4"
   }
 }