@forge/kvs 1.2.7-next.0-experimental-44a932f → 1.3.0-next.1

package/out/storage-api.js

@@ -4,6 +4,12 @@ exports.StorageApi = void 0;
 const types_1 = require("./interfaces/types");
 const error_handling_1 = require("./utils/error-handling");
 const errors_1 = require("./errors");
+var ResponseType;
+(function (ResponseType) {
+    ResponseType[ResponseType["NONE"] = 0] = "NONE";
+    ResponseType[ResponseType["EXPECTED"] = 1] = "EXPECTED";
+    ResponseType[ResponseType["OPTIONAL"] = 2] = "OPTIONAL";
+})(ResponseType || (ResponseType = {}));
 class StorageApi {
     apiClient;
     constructor(apiClient) {
@@ -11,69 +17,72 @@ class StorageApi {
     }
     async get(body) {
         const rs = await this.handleKeyNotFound(async () => {
-            return this.request('/api/v1/get', body, true);
+            return this.request('/api/v1/get', body, ResponseType.EXPECTED);
         });
-        return this.processGetResponse(rs, body.options?.metadataFields);
+        return this.processGetResponse(rs, body.options);
     }
     async getSecret(body) {
         const rs = await this.handleKeyNotFound(async () => {
-            return this.request('/api/v1/secret/get', body, true);
+            return this.request('/api/v1/secret/get', body, ResponseType.EXPECTED);
         });
-        return this.processGetResponse(rs, body.options?.metadataFields);
+        return this.processGetResponse(rs, body.options);
     }
     async getEntity(body) {
         const rs = await this.handleKeyNotFound(async () => {
-            return this.request('/api/v1/entity/get', body, true);
+            return this.request('/api/v1/entity/get', body, ResponseType.EXPECTED);
         });
-        return this.processGetResponse(rs, body.options?.metadataFields);
+        return this.processGetResponse(rs, body.options);
     }
     async set(body) {
-        await this.request('/api/v1/set', body, false);
+        const rs = await this.request('/api/v1/set', body, ResponseType.OPTIONAL);
+        return rs && (0, types_1.isOverrideAndReturnOptions)(body.options) ? this.processSetResponse(rs, body.options) : undefined;
     }
     async setSecret(body) {
-        await this.request('/api/v1/secret/set', body, false);
+        const rs = await this.request('/api/v1/secret/set', body, ResponseType.OPTIONAL);
+        return rs && (0, types_1.isOverrideAndReturnOptions)(body.options) ? this.processSetResponse(rs, body.options) : undefined;
     }
     async setEntity(body) {
-        await this.request('/api/v1/entity/set', body, false);
+        const rs = await this.request('/api/v1/entity/set', body, ResponseType.OPTIONAL);
+        return rs && (0, types_1.isOverrideAndReturnOptions)(body.options) ? this.processSetResponse(rs, body.options) : undefined;
     }
     async delete(body) {
         await this.handleKeyNotFound(async () => {
-            return this.request('/api/v1/delete', body, false);
+            return this.request('/api/v1/delete', body, ResponseType.NONE);
         });
     }
     async deleteSecret(body) {
         await this.handleKeyNotFound(async () => {
-            return this.request('/api/v1/secret/delete', body, false);
+            return this.request('/api/v1/secret/delete', body, ResponseType.NONE);
         });
     }
     async deleteEntity(body) {
         await this.handleKeyNotFound(async () => {
-            return this.request('/api/v1/entity/delete', body, false);
+            return this.request('/api/v1/entity/delete', body, ResponseType.NONE);
         });
     }
     async query(body) {
-        const rs = await this.request('/api/v1/query', body, true);
+        const rs = await this.request('/api/v1/query', body, ResponseType.EXPECTED);
         return {
             results: rs.data,
             nextCursor: rs.cursor
         };
     }
     async queryEntity(body) {
-        const rs = await this.request('/api/v1/entity/query', body, true);
+        const rs = await this.request('/api/v1/entity/query', body, ResponseType.EXPECTED);
         return {
             results: rs.data,
             nextCursor: rs.cursor
         };
     }
     async batchSet(body) {
-        const rs = await this.request('/api/v1/batch/set', body, true);
+        const rs = await this.request('/api/v1/batch/set', body, ResponseType.EXPECTED);
         return {
             successfulKeys: rs.successfulKeys,
             failedKeys: rs.failedKeys
         };
     }
     async transact(transactionRequest) {
-        await this.request('/api/v1/transaction', transactionRequest, false);
+        await this.request('/api/v1/transaction', transactionRequest, ResponseType.NONE);
     }
     async handleKeyNotFound(fn) {
         try {
@@ -86,7 +95,7 @@ class StorageApi {
             throw e;
         }
     }
-    async request(path, body, isResponseExpected) {
+    async request(path, body, responseType) {
         const requestBody = {
             method: 'POST',
             body: JSON.stringify(body),
@@ -96,10 +105,13 @@ class StorageApi {
         };
         const response = await this.apiClient(path, requestBody);
         await (0, error_handling_1.checkResponseError)(response);
-        if (!isResponseExpected) {
-            return {};
+        if (responseType === ResponseType.NONE) {
+            return;
         }
         const responseText = await response.text();
+        if (responseType === ResponseType.OPTIONAL && !responseText) {
+            return undefined;
+        }
         try {
             return JSON.parse(responseText);
         }
@@ -107,22 +119,38 @@ class StorageApi {
             throw new errors_1.ForgeKvsError(`Unexpected error. Response was not valid JSON: ${responseText}`);
         }
     }
-    processGetResponse(response, requestedMetadataFields) {
-        if (response && requestedMetadataFields?.length) {
-            const maybeCreatedAt = requestedMetadataFields.includes(types_1.MetadataField.CREATED_AT)
+    processGetResponse(response, options) {
+        if (response && options) {
+            const maybeCreatedAt = options.metadataFields?.includes(types_1.MetadataField.CREATED_AT)
                 ? { createdAt: response.createdAt }
                 : {};
-            const maybeUpdatedAt = requestedMetadataFields.includes(types_1.MetadataField.UPDATED_AT)
+            const maybeUpdatedAt = options.metadataFields?.includes(types_1.MetadataField.UPDATED_AT)
                 ? { updatedAt: response.updatedAt }
                 : {};
+            const maybeExpireTime = options.metadataFields?.includes(types_1.MetadataField.EXPIRE_TIME)
+                ? { expireTime: response.expireTime }
+                : {};
             return {
                 key: response.key,
                 value: response.value,
                 ...maybeCreatedAt,
-                ...maybeUpdatedAt
+                ...maybeUpdatedAt,
+                ...maybeExpireTime
             };
         }
         return response?.value;
     }
+    processSetResponse(response, options) {
+        if (!response) {
+            return undefined;
+        }
+        return {
+            key: response.key,
+            value: response.value,
+            ...(options.returnMetadataFields?.includes(types_1.MetadataField.CREATED_AT) && { createdAt: response.createdAt }),
+            ...(options.returnMetadataFields?.includes(types_1.MetadataField.UPDATED_AT) && { updatedAt: response.updatedAt }),
+            ...(options.returnMetadataFields?.includes(types_1.MetadataField.EXPIRE_TIME) && { expireTime: response.expireTime })
+        };
+    }
 }
 exports.StorageApi = StorageApi;

package/out/transaction-api.d.ts

@@ -1,12 +1,13 @@
 import { StorageApi } from './storage-api';
 import { EntityConditions, EntityRequiredConditions, TransactCheck, TransactDelete, TransactionBuilder, TransactSet } from './interfaces/transaction';
+import { SetOptions } from './interfaces/types';
 export declare class TransactionBuilderImpl implements TransactionBuilder {
     private readonly storageApi;
     protected sets: TransactSet<unknown>[];
     protected deletes: TransactDelete<unknown>[];
     protected checks: TransactCheck<unknown>[];
     constructor(storageApi: StorageApi, sets?: TransactSet<unknown>[], deletes?: TransactDelete<unknown>[], checks?: TransactCheck<unknown>[]);
-    set<T>(key: string, value: T, entity?: EntityConditions<T>): this;
+    set<T>(key: string, value: T, entity?: EntityConditions<T>, options?: SetOptions): this;
     delete<T>(key: string, entity?: EntityConditions<T>): this;
     check<T>(key: string, { entityName, conditions }: EntityRequiredConditions<T>): this;
     execute(): Promise<void>;

package/out/transaction-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-api.d.ts","sourceRoot":"","sources":["../src/transaction-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EACL,gBAAgB,EAChB,wBAAwB,EACxB,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAIlC,qBAAa,sBAAuB,YAAW,kBAAkB;IAE7D,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE;IACtC,SAAS,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE;IAC5C,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE;gBAHzB,UAAU,EAAE,UAAU,EAC7B,IAAI,GAAE,WAAW,CAAC,OAAO,CAAC,EAAO,EACjC,OAAO,GAAE,cAAc,CAAC,OAAO,CAAC,EAAO,EACvC,MAAM,GAAE,aAAa,CAAC,OAAO,CAAC,EAAO;IAGjD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;IAkBjE,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;IAiB1D,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,IAAI;IAa9E,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAY/B"}
+{"version":3,"file":"transaction-api.d.ts","sourceRoot":"","sources":["../src/transaction-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EACL,gBAAgB,EAChB,wBAAwB,EACxB,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,qBAAa,sBAAuB,YAAW,kBAAkB;IAE7D,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,EAAE;IACtC,SAAS,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,EAAE;IAC5C,SAAS,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE;gBAHzB,UAAU,EAAE,UAAU,EAC7B,IAAI,GAAE,WAAW,CAAC,OAAO,CAAC,EAAO,EACjC,OAAO,GAAE,cAAc,CAAC,OAAO,CAAC,EAAO,EACvC,MAAM,GAAE,aAAa,CAAC,OAAO,CAAC,EAAO;IAGjD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,IAAI;IAmBvF,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;IAiB1D,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,IAAI;IAa9E,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAY/B"}

package/out/transaction-api.js

@@ -13,10 +13,11 @@ class TransactionBuilderImpl {
         this.deletes = deletes;
         this.checks = checks;
     }
-    set(key, value, entity) {
+    set(key, value, entity, options) {
         const transactSet = {
             key,
-            value
+            value,
+            options
         };
         if (entity) {
             transactSet.entity = {

package/out/utils/transaction-request-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-request-builder.d.ts","sourceRoot":"","sources":["../../src/utils/transaction-request-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACpG,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAoBvF,eAAO,MAAM,eAAe,oDAW3B,CAAC;AAEF,eAAO,MAAM,mBAAmB,6CAA4C,aAU3E,CAAC;AAEF,eAAO,MAAM,kBAAkB,2CAA0C,YAUxE,CAAC"}
+{"version":3,"file":"transaction-request-builder.d.ts","sourceRoot":"","sources":["../../src/utils/transaction-request-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACpG,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAoBvF,eAAO,MAAM,eAAe,oDAY3B,CAAC;AAEF,eAAO,MAAM,mBAAmB,6CAA4C,aAU3E,CAAC;AAEF,eAAO,MAAM,kBAAkB,2CAA0C,YAUxE,CAAC"}

package/out/utils/transaction-request-builder.js

@@ -14,14 +14,15 @@ function buildConditionsRequest(filter) {
     };
 }
 const buildRequestSet = (setOperation) => {
-    const { key, value, entity } = setOperation;
+    const { key, value, entity, options } = setOperation;
     const entityName = entity?.entityName;
     const conditions = buildConditionsRequest(entity?.conditions);
     return {
         key,
         value,
         entityName,
-        conditions
+        conditions,
+        options
     };
 };
 exports.buildRequestSet = buildRequestSet;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/kvs",
-  "version": "1.2.7-next.0-experimental-44a932f",
+  "version": "1.3.0-next.1",
   "description": "Forge Key Value Store SDK",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -19,7 +19,7 @@
     "@types/node": "20.19.1"
   },
   "dependencies": {
-    "@forge/api": "^7.0.1-next.0-experimental-44a932f"
+    "@forge/api": "^7.0.1-next.0"
   },
   "publishConfig": {
     "registry": "https://packages.atlassian.com/api/npm/npm-public/"