@forge/cache 0.10.0-next.1 → 0.10.0-next.2

package/out/__test__/cache.test.js

@@ -5,7 +5,7 @@ const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const cache_1 = require("../cache");
 jest.mock('node-fetch');
 const fetchMock = node_fetch_1.default;
-describe('connect', () => {
+describe('Forge Cache', () => {
     describe('v1', () => {
         beforeEach(() => {
             jest.resetAllMocks();

package/out/__test__/tunnel.test.js

@@ -1,12 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 const tunnel_1 = require("../tunnel");
 const validator_1 = require("../utils/validator");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const tmp_1 = require("tmp");
 describe('Forge Cache Tunnel', () => {
     let cache;
     beforeEach(() => {
-        const __localStore = new Map();
-        cache = new tunnel_1.TunnelCache(__localStore);
+        const fileName = (0, tmp_1.tmpNameSync)({ postfix: '.json' });
+        cache = new tunnel_1.TunnelCache(fileName);
     });
     test('set method', async () => {
         const response = await cache.set('key', 'value');
@@ -18,12 +21,12 @@ describe('Forge Cache Tunnel', () => {
         expect(response).toStrictEqual('value');
     });
     test('get method throws error for list value', async () => {
-        cache.__localStore.set('key', ['value1', 'value2']);
+        await cache.leftPush('key', 'value1');
         try {
             await cache.get('key');
         }
         catch (error) {
-            expect(error).toEqual(new validator_1.ForgeCacheTunnelError((0, validator_1.getErrorMessageObj)('WRONGTYPE Operation against a key holding the wrong kind of value', 'UnprocessableContent'), {}, 422));
+            expect(error).toEqual(new validator_1.WrongTypeOperationError());
         }
     });
     test('setIfNotExists method', async () => {
@@ -52,9 +55,9 @@ describe('Forge Cache Tunnel', () => {
         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;
+        await cache.leftPush('key', 'value1');
+        const response = await cache.leftPush('key', 'value2');
+        const result = ['value2', 'value1'].length;
         expect(response).toStrictEqual(result);
     });
     test('rightPop method', async () => {
@@ -75,12 +78,12 @@ describe('Forge Cache Tunnel', () => {
         expect(response).toStrictEqual(4);
     });
     test('incrementAndGet method throws error when key holds a list value', async () => {
-        cache.__localStore.set('key', ['value1', 'value2']);
+        await cache.leftPush('key', 'value1');
         try {
             await cache.incrementAndGet('key');
         }
         catch (error) {
-            expect(error).toEqual(new validator_1.ForgeCacheTunnelError((0, validator_1.getErrorMessageObj)('WRONGTYPE Operation against a key holding the wrong kind of value', 'UnprocessableContent'), {}, 422));
+            expect(error).toEqual(new validator_1.WrongTypeOperationError());
         }
     });
     test('leftPush method throws error when key holds a non-list value', async () => {
@@ -89,7 +92,7 @@ describe('Forge Cache Tunnel', () => {
             await cache.leftPush('key', 'newValue');
         }
         catch (error) {
-            expect(error).toEqual(new validator_1.ForgeCacheTunnelError((0, validator_1.getErrorMessageObj)('WRONGTYPE Operation against a key holding the wrong kind of value', 'UnprocessableContent'), {}, 422));
+            expect(error).toEqual(new validator_1.WrongTypeOperationError());
         }
     });
     test('rightPop method throws error when key holds a non-list value', async () => {
@@ -98,7 +101,7 @@ describe('Forge Cache Tunnel', () => {
             await cache.rightPop('key');
         }
         catch (error) {
-            expect(error).toEqual(new validator_1.ForgeCacheTunnelError((0, validator_1.getErrorMessageObj)('WRONGTYPE Operation against a key holding the wrong kind of value', 'UnprocessableContent'), {}, 422));
+            expect(error).toEqual(new validator_1.WrongTypeOperationError());
         }
     });
     test('listLength method throws error when key holds a non-list value', async () => {
@@ -107,59 +110,67 @@ describe('Forge Cache Tunnel', () => {
             await cache.listLength('key');
         }
         catch (error) {
-            expect(error).toEqual(new validator_1.ForgeCacheTunnelError((0, validator_1.getErrorMessageObj)('WRONGTYPE Operation against a key holding the wrong kind of value', 'UnprocessableContent'), {}, 422));
+            expect(error).toEqual(new validator_1.WrongTypeOperationError());
         }
     });
     test('decrementAndGet method throws error when key holds a list value', async () => {
-        cache.__localStore.set('key', ['value1', 'value2']);
+        await cache.leftPush('key', 'value');
         try {
             await cache.decrementAndGet('key');
         }
         catch (error) {
-            expect(error).toEqual(new validator_1.ForgeCacheTunnelError((0, validator_1.getErrorMessageObj)('WRONGTYPE Operation against a key holding the wrong kind of value', 'UnprocessableContent'), {}, 422));
+            expect(error).toEqual(new validator_1.WrongTypeOperationError());
         }
     });
-    describe('scan method', () => {
-        beforeEach(() => {
-            const __localStore = new Map();
-            cache = new tunnel_1.TunnelCache(__localStore);
-        });
-        test('scan method returns empty array when no matching keys', async () => {
-            cache.__localStore.set('key1', 'value1');
-            cache.__localStore.set('key2', 'value2');
-            cache.__localStore.set('key3', 'value3');
-            cache.__localStore.set('key4', 'value4');
-            cache.__localStore.set('key5', 'value5');
-            const scanResult = await cache.scan('nonexistent*');
-            expect(scanResult.keys).toEqual([]);
-        });
-        test('scan method returns keys starting with "key" prefix', async () => {
-            cache.__localStore.set('key1', 'value1');
-            cache.__localStore.set('key2', 'value2');
-            cache.__localStore.set('otherKey1', 'value3');
-            cache.__localStore.set('otherKey2', 'value4');
-            cache.__localStore.set('key3', 'value5');
-            const scanResult = await cache.scan('key*');
-            expect(scanResult.keys).toEqual(['key1', 'key2', 'key3']);
-        });
-        test('scan method returns keys with "2" in the middle', async () => {
-            cache.__localStore.set('key1', 'value1');
-            cache.__localStore.set('key2', 'value2');
-            cache.__localStore.set('otherKey1', 'value3');
-            cache.__localStore.set('otherKey2', 'value4');
-            cache.__localStore.set('key3', 'value5');
-            const scanResult = await cache.scan('*2*');
-            expect(scanResult.keys).toEqual(['key2', 'otherKey2']);
-        });
-        test('scan method returns keys with "l?st*" redis pattern', async () => {
-            cache.__localStore.set('list1', 'value1');
-            cache.__localStore.set('list2', 'value2');
-            cache.__localStore.set('list3', 'value3');
-            cache.__localStore.set('list4', 'value4');
-            cache.__localStore.set('lest5', 'value5');
-            cache.__localStore.set('key1', 'value1');
-            const scanResult = await cache.scan('l?st*');
-            expect(scanResult.keys).toEqual(['list1', 'list2', 'list3', 'list4', 'lest5']);
-        });
+    test('scan method returns empty array when no matching keys', async () => {
+        await cache.set('key1', 'value1');
+        await cache.set('key2', 'value2');
+        await cache.set('key3', 'value3');
+        await cache.set('key4', 'value4');
+        await cache.set('key5', 'value5');
+        const scanResult = await cache.scan('nonexistent*');
+        expect(scanResult.keys).toEqual([]);
+    });
+    test('scan method returns keys starting with "key" prefix', async () => {
+        await cache.set('key1', 'value1');
+        await cache.set('key2', 'value2');
+        await cache.set('otherKey1', 'value3');
+        await cache.set('otherKey2', 'value4');
+        await cache.set('key3', 'value5');
+        const scanResult = await cache.scan('key*');
+        expect(scanResult.keys).toEqual(['key1', 'key2', 'key3']);
+    });
+    test('scan method returns keys with "2" in the middle', async () => {
+        await cache.set('key1', 'value1');
+        await cache.set('key2', 'value2');
+        await cache.set('otherKey1', 'value3');
+        await cache.set('otherKey2', 'value4');
+        await cache.set('key3', 'value5');
+        const scanResult = await cache.scan('*2*');
+        expect(scanResult.keys).toEqual(['key2', 'otherKey2']);
+    });
+    test('scan method returns keys with "l?st*" redis pattern', async () => {
+        await cache.set('list1', 'value1');
+        await cache.set('list2', 'value2');
+        await cache.set('list3', 'value3');
+        await cache.set('list4', 'value4');
+        await cache.set('lest5', 'value5');
+        await cache.set('key1', 'value1');
+        const scanResult = await cache.scan('l?st*');
+        expect(scanResult.keys).toEqual(['list1', 'list2', 'list3', 'list4', 'lest5']);
+    });
+});
+describe('Forge Cache Tunnel with json file', () => {
+    it('should save and load data from file', async () => {
+        const fileName = (0, tmp_1.tmpNameSync)({ postfix: '.json' });
+        const cache1 = new tunnel_1.TunnelCache(fileName);
+        await cache1.set('key', 'value');
+        await cache1.set('key2', 'value2');
+        await new Promise((resolve) => setTimeout(resolve, 500));
+        const savedFileContent = fs_1.default.readFileSync(fileName, `utf-8`);
+        expect(JSON.parse(savedFileContent)).toStrictEqual({ key: 'value', key2: 'value2' });
+        const cache2 = new tunnel_1.TunnelCache(fileName);
+        const res = await cache2.get('key');
+        expect(res).toBe('value');
     });
 });

package/out/cache.d.ts

@@ -44,5 +44,5 @@ export declare class Cache implements IForgeCache {
 }
 export declare function getFetchRmsRuntimeV1(): ((path: string, options?: RequestInit) => Promise<Response>) | undefined;
 export declare function createFetchRmsRuntimeV2(): (path: string, options?: RequestInit) => Promise<Response>;
-export declare function connect(): Cache | TunnelCache;
+export declare function connect(localCacheFileName?: string): Cache | TunnelCache;
 //# sourceMappingURL=cache.d.ts.map

package/out/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AACA,OAAkB,EAAE,WAAW,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEnF,OAAO,EAAE,WAAW,EAAmB,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAOjD,oBAAY,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAEzE,oBAAY,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAEF,qBAAa,QAAS,SAAQ,KAAK;IAE/B,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,QAAQ,CAAC,IAAI,CAAC;gBAHL,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACN,IAAI,CAAC,KAAK;CAItB;AAED,wBAAsB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CA6BtE;AAED,qBAAa,KAAM,YAAW,WAAW;IAC3B,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;IAGtF,OAAO,CAAC,YAAY;IAUP,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5E,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;IAO9F,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOxC,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;IAO3F,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAO3E,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAO3E,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUpC,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;IAUrF,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUrD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAU7C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAMtD;AAED,wBAAgB,oBAAoB,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAG/G;AAID,wBAAgB,uBAAuB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CA0BpG;AAED,wBAAgB,OAAO,IAAI,KAAK,GAAG,WAAW,CAS7C"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AACA,OAAkB,EAAE,WAAW,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEnF,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,oBAAY,QAAQ,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAAC,CAAC;AAEzE,oBAAY,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAEF,qBAAa,QAAS,SAAQ,KAAK;IAE/B,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,QAAQ,CAAC,IAAI,CAAC;gBAHL,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACN,IAAI,CAAC,KAAK;CAItB;AAED,wBAAsB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CA6BtE;AAED,qBAAa,KAAM,YAAW,WAAW;IAC3B,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;IAGtF,OAAO,CAAC,YAAY;IAUP,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5E,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;IAO9F,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAOxC,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;IAO3F,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAO3E,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAO3E,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUpC,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;IAUrF,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUrD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAU7C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAMtD;AAED,wBAAgB,oBAAoB,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAG/G;AAID,wBAAgB,uBAAuB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CA0BpG;AAED,wBAAgB,OAAO,CAAC,kBAAkB,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,WAAW,CASxE"}

package/out/cache.js

@@ -6,7 +6,6 @@ const https_1 = require("https");
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const api_1 = require("@forge/api");
 const tunnel_1 = require("./tunnel");
-const __localStore = new Map();
 class ApiError extends Error {
     constructor(status, code, message, data) {
         super(message);
@@ -128,10 +127,10 @@ function createFetchRmsRuntimeV2() {
     };
 }
 exports.createFetchRmsRuntimeV2 = createFetchRmsRuntimeV2;
-function connect() {
+function connect(localCacheFileName) {
     var _a;
     if (global.__forge_tunnel__) {
-        return new tunnel_1.TunnelCache(__localStore);
+        return new tunnel_1.TunnelCache(localCacheFileName);
     }
     const fetch = (_a = getFetchRmsRuntimeV1()) !== null && _a !== void 0 ? _a : createFetchRmsRuntimeV2();
     return new Cache(fetch);

package/out/tunnel.d.ts

@@ -1,9 +1,15 @@
 import { ScanResult } from './cache';
 import { IForgeCache } from './interfaces/cache';
 export declare type TunnelStoreType = Map<string, string | undefined | string[]>;
+export declare const CACHE_DIR = ".forge";
+export declare const CACHE_FILE: string;
 export declare class TunnelCache implements IForgeCache {
-    __localStore: TunnelStoreType;
-    constructor(store: TunnelStoreType);
+    private readonly fileName;
+    private __localStore;
+    private events;
+    constructor(fileName?: string);
+    private saveToFile;
+    private loadFromFile;
     set(key: string, value: string, opt?: {
         ttlSeconds: number;
     }): Promise<void>;
@@ -28,6 +34,6 @@ export declare class TunnelCache implements IForgeCache {
         cursor?: string;
         count?: number;
     }): Promise<ScanResult>;
-    parseSuccessResponse(response: string | number | null | string[] | any): Promise<any>;
+    private parseSuccessResponse;
 }
 //# 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;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;IAa3E,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBrD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAkB7C,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;IAe3E,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"}
+{"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;AAWjD,oBAAY,eAAe,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,CAAC,CAAC;AAGzE,eAAO,MAAM,SAAS,WAAW,CAAC;AAClC,eAAO,MAAM,UAAU,QAA4B,CAAC;AAgBpD,qBAAa,WAAY,YAAW,WAAW;IAGjC,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAFrC,OAAO,CAAC,YAAY,CAAkB;IACtC,OAAO,CAAC,MAAM,CAAe;gBACA,QAAQ,GAAE,MAAmB;IAY1D,OAAO,CAAC,UAAU;IAiBlB,OAAO,CAAC,YAAY;IAmBP,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;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;IAc9F,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;IAY3F,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYpC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAc3E,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBrD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAmB7C,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;IAgB3E,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,OAAO,CAAC,oBAAoB;CAK7B"}

package/out/tunnel.js

@@ -1,16 +1,70 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TunnelCache = void 0;
+exports.TunnelCache = exports.CACHE_FILE = exports.CACHE_DIR = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
 const validator_1 = require("./utils/validator");
+const events_1 = tslib_1.__importDefault(require("events"));
+const path_1 = require("path");
+const LOG_PREFIX = '@forge/cache tunnel: ';
+exports.CACHE_DIR = '.forge';
+exports.CACHE_FILE = exports.CACHE_DIR + '/cache.json';
+const warn = (message, meta) => {
+    console.warn(LOG_PREFIX + message, meta !== null && meta !== void 0 ? meta : '');
+};
+const info = (message, meta) => {
+    console.info(LOG_PREFIX + message, meta !== null && meta !== void 0 ? meta : '');
+};
+const error = (err) => {
+    console.error(LOG_PREFIX, err);
+};
 class TunnelCache {
-    constructor(store) {
-        this.__localStore = store;
+    constructor(fileName = exports.CACHE_FILE) {
+        this.fileName = fileName;
+        warn('Using local implementation of @forge/cache.');
+        this.events = new events_1.default();
+        this.__localStore = this.loadFromFile();
+        this.events.on('change', () => {
+            this.saveToFile();
+        });
+    }
+    saveToFile() {
+        const obj = {};
+        for (const [k, v] of this.__localStore) {
+            obj[k] = v;
+        }
+        try {
+            (0, fs_1.mkdirSync)((0, path_1.dirname)(this.fileName), { recursive: true });
+            (0, fs_1.writeFileSync)(this.fileName, JSON.stringify(obj));
+        }
+        catch (err) {
+            warn('Saving cache to file failed.', err);
+        }
+    }
+    loadFromFile() {
+        const _obj = new Map();
+        try {
+            if ((0, fs_1.existsSync)(this.fileName)) {
+                const data = JSON.parse((0, fs_1.readFileSync)(this.fileName, 'utf-8'));
+                for (const key in data) {
+                    _obj.set(key, data[key]);
+                }
+            }
+            return _obj;
+        }
+        catch (err) {
+            warn('Loading cache from file failed.');
+            error(err);
+            info('Initializing empty cache.');
+            return _obj;
+        }
     }
     async set(key, value, opt) {
         (0, validator_1.assertIsValidKey)(key);
         (0, validator_1.assertIsValidValue)(value);
         (0, validator_1.assertIsSizedValue)(value);
         this.__localStore.set(key, value);
+        this.events.emit('change');
     }
     async get(key) {
         (0, validator_1.assertIsValidKey)(key);
@@ -28,6 +82,7 @@ class TunnelCache {
             return result;
         }
         this.__localStore.set(key, value);
+        this.events.emit('change');
         const { response: result } = await this.parseSuccessResponse('OK');
         return result;
     }
@@ -38,6 +93,7 @@ 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);
+        this.events.emit('change');
         const { response: result } = await this.parseSuccessResponse(oldValue);
         return result;
     }
@@ -45,6 +101,7 @@ class TunnelCache {
         (0, validator_1.assertIsValidKey)(key);
         if (this.__localStore.get(key)) {
             this.__localStore.delete(key);
+            this.events.emit('change');
             const { response: result } = await this.parseSuccessResponse(1);
             return result;
         }
@@ -58,6 +115,7 @@ 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());
+        this.events.emit('change');
         const { response: result } = await this.parseSuccessResponse(newValue);
         return result;
     }
@@ -71,6 +129,7 @@ class TunnelCache {
             this.__localStore.set(key, []);
         }
         this.__localStore.get(key).unshift(value);
+        this.events.emit('change');
         const { response: result } = await this.parseSuccessResponse(this.__localStore.get(key).length);
         return result;
     }
@@ -83,6 +142,7 @@ class TunnelCache {
         }
         (0, validator_1.assertAndThrowIfNotArray)(oldValue);
         const { response: result } = await this.parseSuccessResponse(this.__localStore.get(key).pop() || null);
+        this.events.emit('change');
         return result;
     }
     async listLength(key) {
@@ -103,6 +163,7 @@ 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());
+        this.events.emit('change');
         const { response: result } = await this.parseSuccessResponse(newValue);
         return result;
     }

package/out/utils/validator.d.ts

@@ -1,9 +1,29 @@
-import { HttpError } from '@forge/api';
-export declare class ForgeCacheTunnelError extends HttpError {
-    readonly message: string;
-    readonly reason?: any;
+export declare class TunnelError extends Error {
     readonly status: number;
-    constructor(message: string, reason?: any, status?: number);
+    readonly code: string;
+    readonly data?: any;
+    constructor(status: number, code: string, message: string, data?: any);
+}
+export declare class MinValidKeyLengthRequiredError extends TunnelError {
+    constructor(length: number, minLength: number);
+}
+export declare class MaxValidKeyLengthExceededError extends TunnelError {
+    constructor(length: number, maxLength: number);
+}
+export declare class InvalidKeyPatternError extends TunnelError {
+    constructor();
+}
+export declare class MaxValueSizeExceededError extends TunnelError {
+    constructor(bytes: number, maxBytes: number);
+}
+export declare class ValueIsRequiredError extends TunnelError {
+    constructor();
+}
+export declare class WrongTypeOperationError extends TunnelError {
+    constructor();
+}
+export declare class InvalidValueTypeError extends TunnelError {
+    constructor(type: string);
 }
 export declare function assertIsValidValue(value: unknown): void;
 export declare function assertAndThrowIfArray(value: string | number | undefined | string[]): void;

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

@@ -1 +1 @@
-{"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,QAQlF;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,QAQrF;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,QAsB5C;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,QAOhD;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,SAAe,GAAG,MAAM,CAQ7E"}
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/utils/validator.ts"],"names":[],"mappings":"AASA,qBAAa,WAAY,SAAQ,KAAK;IAElC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM;IAErB,QAAQ,CAAC,IAAI,CAAC;gBAHL,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM,EACN,IAAI,CAAC,KAAK;CAItB;AAED,qBAAa,8BAA+B,SAAQ,WAAW;gBACjD,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAM9C;AAED,qBAAa,8BAA+B,SAAQ,WAAW;gBACjD,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;CAM9C;AAED,qBAAa,sBAAuB,SAAQ,WAAW;;CAMtD;AAED,qBAAa,yBAA0B,SAAQ,WAAW;gBAC5C,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAM5C;AAED,qBAAa,oBAAqB,SAAQ,WAAW;;CAIpD;AAED,qBAAa,uBAAwB,SAAQ,WAAW;;CAIvD;AAED,qBAAa,qBAAsB,SAAQ,WAAW;gBACxC,IAAI,EAAE,MAAM;CAGzB;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,QAc5C;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,QAIhD;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,SAAe,GAAG,MAAM,CAQ7E"}

package/out/utils/validator.js

@@ -1,42 +1,93 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getErrorMessageObj = 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.InvalidValueTypeError = exports.WrongTypeOperationError = exports.ValueIsRequiredError = exports.MaxValueSizeExceededError = exports.InvalidKeyPatternError = exports.MaxValidKeyLengthExceededError = exports.MinValidKeyLengthRequiredError = exports.TunnelError = 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 api_1.HttpError {
-    constructor(message, reason, status = 400) {
-        super(message);
-        this.message = message;
-        this.reason = reason;
+class TunnelError extends Error {
+    constructor(status, code, message, data) {
+        super(`"title":"${message}"`);
         this.status = status;
-        this.message = `${status}: ${message}`;
+        this.code = code;
+        this.data = data;
     }
 }
-exports.ForgeCacheTunnelError = ForgeCacheTunnelError;
+exports.TunnelError = TunnelError;
+class MinValidKeyLengthRequiredError extends TunnelError {
+    constructor(length, minLength) {
+        super(400, 'MIN_VALID_KEY_LENGTH_REQUIRED', 'Provided key length was under the minimum valid key length', {
+            length,
+            minLength
+        });
+    }
+}
+exports.MinValidKeyLengthRequiredError = MinValidKeyLengthRequiredError;
+class MaxValidKeyLengthExceededError extends TunnelError {
+    constructor(length, maxLength) {
+        super(400, 'MAX_VALID_KEY_LENGTH_EXCEEDED', 'Provided key length was above the maximum valid key length', {
+            length,
+            maxLength
+        });
+    }
+}
+exports.MaxValidKeyLengthExceededError = MaxValidKeyLengthExceededError;
+class InvalidKeyPatternError extends TunnelError {
+    constructor() {
+        super(400, 'INVALID_KEY_PATTERN', 'Provided key must match regex', {
+            regex: VALID_KEY_REGEX
+        });
+    }
+}
+exports.InvalidKeyPatternError = InvalidKeyPatternError;
+class MaxValueSizeExceededError extends TunnelError {
+    constructor(bytes, maxBytes) {
+        super(400, 'MAX_VALUE_SIZE_EXCEEDED', 'Provided value bytes was over maximum valid value size', {
+            bytes,
+            maxBytes
+        });
+    }
+}
+exports.MaxValueSizeExceededError = MaxValueSizeExceededError;
+class ValueIsRequiredError extends TunnelError {
+    constructor() {
+        super(400, 'VALUE_IS_REQUIRED', 'Provided value is required');
+    }
+}
+exports.ValueIsRequiredError = ValueIsRequiredError;
+class WrongTypeOperationError extends TunnelError {
+    constructor() {
+        super(400, 'UnprocessableContent', 'WRONGTYPE Operation against a key holding the wrong kind of value');
+    }
+}
+exports.WrongTypeOperationError = WrongTypeOperationError;
+class InvalidValueTypeError extends TunnelError {
+    constructor(type) {
+        super(400, 'INVALID_VALUE_TYPE', 'Provided value must be a string', { type });
+    }
+}
+exports.InvalidValueTypeError = InvalidValueTypeError;
 function assertIsValidValue(value) {
     if (value === undefined || value === null) {
-        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided value is required'));
+        throw new ValueIsRequiredError();
     }
     if (typeof value !== 'string') {
-        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided value must be a string'), { type: typeof value });
+        throw new InvalidValueTypeError(typeof value);
     }
 }
 exports.assertIsValidValue = assertIsValidValue;
 function assertAndThrowIfArray(value) {
     if (value && Array.isArray(value)) {
-        throw new ForgeCacheTunnelError(getErrorMessageObj('WRONGTYPE Operation against a key holding the wrong kind of value', 'UnprocessableContent'), {}, 422);
+        throw new WrongTypeOperationError();
     }
 }
 exports.assertAndThrowIfArray = assertAndThrowIfArray;
 function assertAndThrowIfNotArray(value) {
     if (value && !Array.isArray(value)) {
-        throw new ForgeCacheTunnelError(getErrorMessageObj('WRONGTYPE Operation against a key holding the wrong kind of value', 'UnprocessableContent'), {}, 422);
+        throw new WrongTypeOperationError();
     }
 }
 exports.assertAndThrowIfNotArray = assertAndThrowIfNotArray;
@@ -45,30 +96,19 @@ function assertIsValidKey(key) {
         throw new Error('Provided key must be a string');
     }
     if (key.length < MIN_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
-        });
+        throw new MinValidKeyLengthRequiredError(key.length, MIN_VALID_KEY_LENGTH);
     }
     if (key.length > MAX_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
-        });
+        throw new MaxValidKeyLengthExceededError(key.length, MAX_VALID_KEY_LENGTH);
     }
     if (!VALID_KEY_REGEX.test(key)) {
-        throw new ForgeCacheTunnelError(getErrorMessageObj('Provided key must match regex'), {
-            regex: VALID_KEY_REGEX
-        });
+        throw new InvalidKeyPatternError();
     }
 }
 exports.assertIsValidKey = assertIsValidKey;
 function assertIsSizedValue(value) {
     if ((0, object_sizeof_1.default)(value) > MAX_VALID_VALUE_LENGTH) {
-        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
-        });
+        throw new MaxValueSizeExceededError((0, object_sizeof_1.default)(value), MAX_VALID_VALUE_LENGTH);
     }
 }
 exports.assertIsSizedValue = assertIsSizedValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cache",
-  "version": "0.10.0-next.1",
+  "version": "0.10.0-next.2",
   "description": "Forge Cache methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -17,7 +17,8 @@
   "devDependencies": {
     "@types/node": "14.18.63",
     "@types/node-fetch": "^2.6.11",
-    "node-fetch": "2.7.0"
+    "node-fetch": "2.7.0",
+    "tmp": "^0.2.3"
   },
   "dependencies": {
     "@forge/api": "^3.7.0-next.0",