@forge/cache 0.7.5-next.1 → 0.8.0-next.0

package/out/__test__/cache.test.js

@@ -56,6 +56,7 @@ describe('createFetch', () => {
         await expect((0, cache_1.createFetchRmsRuntimeV2)()).rejects.toThrowError(new Error('RMS config not available.'));
     });
     it('creates a fetch that adds the right headers and url', async () => {
+        var _a;
         global['__forge_runtime__'] = {
             proxy: {
                 token: 'token',
@@ -72,10 +73,10 @@ describe('createFetch', () => {
         };
         const fetch = (0, cache_1.createFetchRmsRuntimeV2)();
         await fetch('path');
-        const [absoluteUrl, options] = fetchMock.mock.lastCall ?? ['', {}];
+        const [absoluteUrl, options] = (_a = fetchMock.mock.lastCall) !== null && _a !== void 0 ? _a : ['', {}];
         expect(absoluteUrl.toString()).toEqual('https://rms/path');
-        expect((options?.agent)['passthrough']['keepAlive']).toBeTruthy();
-        expect(options?.headers).toMatchObject({
+        expect((options === null || options === void 0 ? void 0 : options.agent)['passthrough']['keepAlive']).toBeTruthy();
+        expect(options === null || options === void 0 ? void 0 : options.headers).toMatchObject({
             Authorization: 'Bearer token',
             Host: 'rockmelon-storage.dev.atl-paas.net',
             'x-b3-traceid': 'trace-id-test',
@@ -207,6 +208,13 @@ describe('Cache', () => {
             expect(result).toEqual(0);
             expect(fetch.mock.lastCall).toMatchSnapshot();
         });
+        it('handles success with ttl', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: 0 }), status: 200 });
+            const result = await cache.incrementAndGet('key', { ttlSeconds: 100 });
+            expect(result).toEqual(0);
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
         it('handles success when key exists', async () => {
             const { cache, fetch } = buildCache();
             fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: 11 }), status: 200 });
@@ -229,6 +237,13 @@ describe('Cache', () => {
             expect(result).toEqual(0);
             expect(fetch.mock.lastCall).toMatchSnapshot();
         });
+        it('handles success with ttl', async () => {
+            const { cache, fetch } = buildCache();
+            fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: 0 }), status: 200 });
+            const result = await cache.decrementAndGet('key', { ttlSeconds: 100 });
+            expect(result).toEqual(0);
+            expect(fetch.mock.lastCall).toMatchSnapshot();
+        });
         it('handles success when key exists', async () => {
             const { cache, fetch } = buildCache();
             fetch.mockResolvedValueOnce({ ok: true, text: async () => JSON.stringify({ response: 11 }), status: 200 });

package/out/cache.d.ts

@@ -19,8 +19,12 @@ export declare class Cache {
     getAndSet(key: string, value: string, opt?: {
         ttlSeconds: number;
     }): Promise<string | null>;
-    incrementAndGet(key: string): Promise<number>;
-    decrementAndGet(key: string): Promise<number>;
+    incrementAndGet(key: string, opt?: {
+        ttlSeconds: number;
+    }): Promise<number>;
+    decrementAndGet(key: string, opt?: {
+        ttlSeconds: number;
+    }): Promise<number>;
     delete(key: string): Promise<number>;
     scan(pattern: string, opt?: {
         cursor?: string;

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;AAInF,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;AAGF,wBAAsB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAYtE;AAED,qBAAa,KAAK;IACJ,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,GAAG,OAAO,CAAC,MAAM,CAAC;IAO7C,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO7C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOpC,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;IAOrF,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOrD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAO7C,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,UAItB"}
+{"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;AAInF,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;AAGF,wBAAsB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAYtE;AAED,qBAAa,KAAK;IACJ,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;IAOpC,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;IAOrF,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOrD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAO7C,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,UAItB"}

package/out/cache.js

@@ -19,7 +19,6 @@ async function getResponseBody(response) {
 }
 exports.getResponseBody = getResponseBody;
 class Cache {
-    client;
     constructor(client) {
         this.client = client;
     }
@@ -33,11 +32,11 @@ class Cache {
         };
     }
     async set(key, value, opt) {
-        const response = await this.client('rms/store/set', this.buildRequest({ key, value, ...opt }));
+        const response = await this.client('rms/store/set', this.buildRequest(Object.assign({ key, value }, opt)));
         await getResponseBody(response);
     }
     async setIfNotExists(key, value, opt) {
-        const response = await this.client('rms/store/setnx', this.buildRequest({ key, value, ...opt }));
+        const response = await this.client('rms/store/setnx', this.buildRequest(Object.assign({ key, value }, opt)));
         const { response: result } = await getResponseBody(response);
         return result;
     }
@@ -47,17 +46,17 @@ class Cache {
         return result;
     }
     async getAndSet(key, value, opt) {
-        const response = await this.client('rms/store/getset', this.buildRequest({ key, value, ...opt }));
+        const response = await this.client('rms/store/getset', this.buildRequest(Object.assign({ key, value }, opt)));
         const { response: result } = await getResponseBody(response);
         return result;
     }
-    async incrementAndGet(key) {
-        const response = await this.client('rms/store/incr', this.buildRequest({ key }));
+    async incrementAndGet(key, opt) {
+        const response = await this.client('rms/store/incr', this.buildRequest(Object.assign({ key }, opt)));
         const { response: result } = await getResponseBody(response);
         return result;
     }
-    async decrementAndGet(key) {
-        const response = await this.client('rms/store/decr', this.buildRequest({ key }));
+    async decrementAndGet(key, opt) {
+        const response = await this.client('rms/store/decr', this.buildRequest(Object.assign({ key }, opt)));
         const { response: result } = await getResponseBody(response);
         return result;
     }
@@ -89,34 +88,26 @@ class Cache {
 }
 exports.Cache = Cache;
 function getFetchRmsRuntimeV1() {
-    return global.api?.requestRmsStore;
+    var _a;
+    return (_a = global.api) === null || _a === void 0 ? void 0 : _a.requestRmsStore;
 }
 exports.getFetchRmsRuntimeV1 = getFetchRmsRuntimeV1;
 function createFetchRmsRuntimeV2() {
     const agent = new https_1.Agent({ keepAlive: true });
     return async function (path, options) {
         const { proxy, rms, tracing } = (0, api_1.__getRuntime)();
-        if (!rms?.url || !rms?.host) {
+        if (!(rms === null || rms === void 0 ? void 0 : rms.url) || !(rms === null || rms === void 0 ? void 0 : rms.host)) {
             throw new Error('RMS config not available.');
         }
         const rmsAgent = new String('FORGE_PRODUCT_REQUEST');
         rmsAgent['passthrough'] = agent;
-        return await (0, node_fetch_1.default)(new URL(path, 'https://rms/'), {
-            ...options,
-            agent: rmsAgent,
-            headers: {
-                ...options?.headers,
-                Authorization: `Bearer ${proxy.token}`,
-                Host: rms.host,
-                'x-b3-traceid': tracing.traceId,
-                'x-b3-spanid': tracing.spanId
-            }
-        });
+        return await (0, node_fetch_1.default)(new URL(path, 'https://rms/'), Object.assign(Object.assign({}, options), { agent: rmsAgent, headers: Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.headers), { Authorization: `Bearer ${proxy.token}`, Host: rms.host, 'x-b3-traceid': tracing.traceId, 'x-b3-spanid': tracing.spanId }) }));
     };
 }
 exports.createFetchRmsRuntimeV2 = createFetchRmsRuntimeV2;
 function connect() {
-    const fetch = getFetchRmsRuntimeV1() ?? createFetchRmsRuntimeV2();
+    var _a;
+    const fetch = (_a = getFetchRmsRuntimeV1()) !== null && _a !== void 0 ? _a : createFetchRmsRuntimeV2();
     return new Cache(fetch);
 }
 exports.connect = connect;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cache",
-  "version": "0.7.5-next.1",
+  "version": "0.8.0-next.0",
   "description": "Forge Cache methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -20,6 +20,6 @@
     "node-fetch": "2.7.0"
   },
   "dependencies": {
-    "@forge/api": "^3.5.0-next.1"
+    "@forge/api": "^3.5.0"
   }
 }