@forge/kvs 0.0.2-next.2 → 0.1.0-next.3

package/README.md

@@ -2,12 +2,12 @@ Library for Forge KVS.
 
 Usage example:
 ```typescript
-import kvs, { Conditions, Sort, Filter } from "@forge/kvs";
+import kvs, { FilterConditons, WhereConditions, Sort, Filter } from "@forge/kvs";
 
 await kvs.set<string>('example-key', 'bar');
 await kvs.get<string>('example-key');
 await kvs.delete('example-key');
-await kvs.query().where('key', Conditions.beginsWith('example'))
+await kvs.query().where('key', WhereConditions.beginsWith('example'))
 
 type Employee = {
   surname: string;
@@ -30,12 +30,29 @@ await kvs
   .entity<Employee>('employee')
   .query()
   .index('by-age')
-  .where(Conditions.greaterThan(30))
-  .filters(new Filter<Employee>().and('employmentyear', Conditions.equalTo(2025)))
+  .where(WhereConditions.greaterThan(30))
+  .filters(new Filter<Employee>().and('employmentyear', FilterConditions.equalTo(2025)))
   .sort(Sort.DESC)
   .getMany()
 
 await kvs.setSecret('example-key', 'Hello world');
 await kvs.getSecret('example-key');
 await kvs.deleteSecret('example-key');
+
+const conditions = new Filter<Employee>().and('lastName', FilterConditions.beginsWith('S'))
+  .and('firstName', FilterConditions.beginsWith('blah'));
+
+await kvs
+   .transact()
+   .set('key', 'value')
+   .set('entityKey', 'value', {
+     entityName: 'author',
+       conditions: new Filter<Employee>().and('lastName', FilterConditions.beginsWith('S'))
+         .and('firstName', FilterConditions.beginsWith('blah'))
+   })
+   .delete('some-key')
+   .delete('another-key', { entityName: 'employee', conditions })
+   .check('third-key', conditions)
+   .check('fourth-key', conditions, { entityName: 'author' })
+   .execute();
 ```

package/out/__test__/index.test.js

@@ -506,4 +506,18 @@ describe('KVS', () => {
             })
         }));
     });
+    it('should sumbit transaction correctly', async () => {
+        const response = new Response(undefined, {
+            status: 200,
+            headers: { 'x-trace-id': traceId }
+        });
+        const { sut, apiClient } = prepare(response);
+        await sut.transact().set('foo', 'bar').delete('bar').execute();
+        expect(apiClient).toHaveBeenCalledWith('/api/v1/transaction', expect.objectContaining({
+            body: JSON.stringify({
+                set: [{ key: 'foo', value: 'bar' }],
+                delete: [{ key: 'bar' }]
+            })
+        }));
+    });
 });

package/out/__test__/transaction-api.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=transaction-api.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-api.test.d.ts","sourceRoot":"","sources":["../../src/__test__/transaction-api.test.ts"],"names":[],"mappings":""}

package/out/__test__/transaction-api.test.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const transaction_api_1 = require("../transaction-api");
+const storage_api_1 = require("../storage-api");
+const xen_test_util_1 = require("@atlassian/xen-test-util");
+const entity_query_1 = require("../entity-query");
+const TransactionUtils = tslib_1.__importStar(require("../utils/transaction-request-builder"));
+const key = 'key';
+const entityName = 'entity';
+const defaultEntity = { field1: 'test' };
+jest.mock('../utils/transaction-request-builder');
+class TestTransactionBuilderImpl extends transaction_api_1.TransactionBuilderImpl {
+    getSets() {
+        return this.sets;
+    }
+    getDeletes() {
+        return this.deletes;
+    }
+    getChecks() {
+        return this.checks;
+    }
+}
+describe('TransactionBuilderImpl', () => {
+    function setupForTests(sets = [], deletes = [], checks = []) {
+        const storageApi = (0, xen_test_util_1.mock)(storage_api_1.StorageApi);
+        const transactionBuilder = new TestTransactionBuilderImpl(storageApi, sets, deletes, checks);
+        return { storageApi, transactionBuilder };
+    }
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    describe('set', () => {
+        it.each(['test', 100, false, [1, 2, 3], { key: 'value' }])('set should add into array of transaction set with value %s', (value) => {
+            const { transactionBuilder } = setupForTests();
+            transactionBuilder.set(key, value);
+            expect(transactionBuilder.getSets()).toContainEqual({ key, value });
+            expect(transactionBuilder.getDeletes()).toHaveLength(0);
+            expect(transactionBuilder.getChecks()).toHaveLength(0);
+        });
+        it('set should add into array of transaction set with entity and condition', () => {
+            const { transactionBuilder } = setupForTests();
+            const filterBuilder = new entity_query_1.FilterBuilder();
+            transactionBuilder.set(key, defaultEntity, { entityName, conditions: filterBuilder });
+            expect(transactionBuilder.getSets()).toContainEqual({
+                key,
+                value: defaultEntity,
+                entity: { entityName, conditions: filterBuilder }
+            });
+            expect(transactionBuilder.getDeletes()).toHaveLength(0);
+            expect(transactionBuilder.getChecks()).toHaveLength(0);
+        });
+    });
+    describe('delete', () => {
+        it('delete should add into array of transaction delete', () => {
+            const { transactionBuilder } = setupForTests();
+            transactionBuilder.delete(key);
+            expect(transactionBuilder.getDeletes()).toContainEqual({ key });
+            expect(transactionBuilder.getSets()).toHaveLength(0);
+            expect(transactionBuilder.getChecks()).toHaveLength(0);
+        });
+        it('delete should add into array of transaction delete with entity and condition', () => {
+            const { transactionBuilder } = setupForTests();
+            const filterBuilder = new entity_query_1.FilterBuilder();
+            transactionBuilder.delete(key, { entityName, conditions: filterBuilder });
+            expect(transactionBuilder.getDeletes()).toContainEqual({
+                key,
+                entity: { entityName, conditions: filterBuilder }
+            });
+            expect(transactionBuilder.getSets()).toHaveLength(0);
+            expect(transactionBuilder.getChecks()).toHaveLength(0);
+        });
+    });
+    describe('check', () => {
+        it('check should add into array of transaction check with entity and condition', () => {
+            const { transactionBuilder } = setupForTests();
+            const filterBuilder = new entity_query_1.FilterBuilder();
+            transactionBuilder.check(key, { entityName, conditions: filterBuilder });
+            expect(transactionBuilder.getChecks()).toContainEqual({
+                key,
+                entity: { entityName, conditions: filterBuilder }
+            });
+            expect(transactionBuilder.getSets()).toHaveLength(0);
+            expect(transactionBuilder.getDeletes()).toHaveLength(0);
+        });
+    });
+    describe('execute', () => {
+        it('should map items to request state before sending to storage api', async () => {
+            const transactSet = [{ key, value: 'test' }];
+            const requestSet = { key, value: 'test' };
+            const transactDelete = [{ key }];
+            const requestDelete = { key };
+            const transactCheck = [
+                { key, entity: { entityName, conditions: new entity_query_1.FilterBuilder() } }
+            ];
+            const requestCheck = { key, entityName, conditions: { and: [] } };
+            const { storageApi, transactionBuilder } = setupForTests(transactSet, transactDelete, transactCheck);
+            const buildSetSpy = jest.spyOn(TransactionUtils, 'buildRequestSet');
+            buildSetSpy.mockReturnValueOnce(requestSet);
+            const buildDeleteSpy = jest.spyOn(TransactionUtils, 'buildRequestDeletes');
+            buildDeleteSpy.mockReturnValueOnce(requestDelete);
+            const buildCheckSpy = jest.spyOn(TransactionUtils, 'buildRequestChecks');
+            buildCheckSpy.mockReturnValueOnce(requestCheck);
+            await transactionBuilder.execute();
+            expect(buildSetSpy).toHaveBeenCalledWith(transactSet[0], 0, transactSet);
+            expect(buildDeleteSpy).toHaveBeenCalledWith(transactDelete[0], 0, transactDelete);
+            expect(buildCheckSpy).toHaveBeenCalledWith(transactCheck[0], 0, transactCheck);
+            expect(storageApi.transact).toHaveBeenCalledWith({
+                set: [requestSet],
+                delete: [requestDelete],
+                check: [requestCheck]
+            });
+        });
+        it('should set undefined if no items are present', async () => {
+            const { storageApi, transactionBuilder } = setupForTests();
+            const buildSetSpy = jest.spyOn(TransactionUtils, 'buildRequestSet');
+            const buildDeleteSpy = jest.spyOn(TransactionUtils, 'buildRequestDeletes');
+            const buildCheckSpy = jest.spyOn(TransactionUtils, 'buildRequestChecks');
+            await transactionBuilder.execute();
+            expect(buildSetSpy).not.toHaveBeenCalled();
+            expect(buildDeleteSpy).not.toHaveBeenCalled();
+            expect(buildCheckSpy).not.toHaveBeenCalled();
+            expect(storageApi.transact).toHaveBeenCalledWith({
+                set: undefined,
+                delete: undefined,
+                check: undefined
+            });
+        });
+    });
+});

package/out/entity-query.d.ts

@@ -1,4 +1,4 @@
-import { EntityFilterClauses, AndFilter, EntityQueryBuilder, IndexQueryBuilder, Filter, IndexOptions, OrFilter } from './interfaces/entity-query';
+import { EntityFilterClauses, AndFilter, EntityQueryBuilder, IndexQueryBuilder, Filter, FilterItem, IndexOptions, OrFilter } from './interfaces/entity-query';
 import { StorageApi } from './storage-api';
 export declare class KvsIndexQueryBuilder<T> implements IndexQueryBuilder<T> {
     private readonly entityName;
@@ -6,8 +6,21 @@ export declare class KvsIndexQueryBuilder<T> implements IndexQueryBuilder<T> {
     constructor(entityName: string, storageApi: StorageApi);
     index(name: string, indexOptions?: IndexOptions<T>): EntityQueryBuilder<T>;
 }
-export declare class FilterBuilder<T> implements Filter<T> {
-    and(field: keyof T, condition: EntityFilterClauses): AndFilter<T>;
-    or(field: keyof T, condition: EntityFilterClauses): OrFilter<T>;
+export declare abstract class BaseFilter<T> {
+    protected readonly items: Array<FilterItem<T>>;
+    constructor(items?: Array<FilterItem<T>>);
+    filters(): Array<FilterItem<T>>;
+    operator(): "or" | "and";
 }
+export declare class FilterBuilder<T> extends BaseFilter<T> implements Filter<T> {
+    and(field: keyof T, condition: EntityFilterClauses): AndFilterBuilder<T>;
+    or(field: keyof T, condition: EntityFilterClauses): OrFilterBuilder<T>;
+}
+declare class AndFilterBuilder<T> extends BaseFilter<T> implements AndFilter<T> {
+    and(field: keyof T, condition: EntityFilterClauses): this;
+}
+declare class OrFilterBuilder<T> extends BaseFilter<T> implements OrFilter<T> {
+    or(field: keyof T, condition: EntityFilterClauses): this;
+}
+export {};
 //# sourceMappingURL=entity-query.d.ts.map

package/out/entity-query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entity-query.d.ts","sourceRoot":"","sources":["../src/entity-query.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAGnB,SAAS,EACT,kBAAkB,EAClB,iBAAiB,EACjB,MAAM,EAEN,YAAY,EACZ,QAAQ,EACT,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,oBAAoB,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;gBADV,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU;IAGzC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC;CAQ3E;AAgED,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,MAAM,CAAC,CAAC,CAAC;IAChD,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,SAAS,CAAC,CAAC,CAAC;IAIjE,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,QAAQ,CAAC,CAAC,CAAC;CAGhE"}
+{"version":3,"file":"entity-query.d.ts","sourceRoot":"","sources":["../src/entity-query.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EAGnB,SAAS,EACT,kBAAkB,EAClB,iBAAiB,EACjB,MAAM,EACN,UAAU,EACV,YAAY,EACZ,QAAQ,EACT,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,oBAAoB,CAAC,CAAC,CAAE,YAAW,iBAAiB,CAAC,CAAC,CAAC;IAEhE,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;gBADV,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU;IAGzC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC;CAQ3E;AAwDD,8BAAsB,UAAU,CAAC,CAAC;IACpB,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBAA3B,KAAK,GAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAM;IAExD,OAAO,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAI/B,QAAQ;CAGhB;AAED,qBAAa,aAAa,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,MAAM,CAAC,CAAC,CAAC;IACtE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,gBAAgB,CAAC,CAAC,CAAC;IAIxE,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,eAAe,CAAC,CAAC,CAAC;CAGvE;AAED,cAAM,gBAAgB,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,SAAS,CAAC,CAAC,CAAC;IACrE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,IAAI;CAI1D;AAED,cAAM,eAAe,CAAC,CAAC,CAAE,SAAQ,UAAU,CAAC,CAAC,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC;IACnE,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,IAAI;CAIzD"}

package/out/entity-query.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FilterBuilder = exports.KvsIndexQueryBuilder = void 0;
+exports.FilterBuilder = exports.BaseFilter = exports.KvsIndexQueryBuilder = void 0;
 class KvsIndexQueryBuilder {
     entityName;
     storageApi;
@@ -30,13 +30,8 @@ class KvsEntityQueryBuilder {
         return this;
     }
     filters(filter) {
-        this.queryOptions.filters = filter.items;
-        if (filter instanceof AndFilterBuilder) {
-            this.queryOptions.filterOperator = 'and';
-        }
-        else {
-            this.queryOptions.filterOperator = 'or';
-        }
+        this.queryOptions.filters = filter.filters();
+        this.queryOptions.filterOperator = filter.operator();
         return this;
     }
     sort(sort) {
@@ -76,8 +71,15 @@ class BaseFilter {
     constructor(items = []) {
         this.items = items;
     }
+    filters() {
+        return this.items;
+    }
+    operator() {
+        return this instanceof AndFilterBuilder ? 'and' : 'or';
+    }
 }
-class FilterBuilder {
+exports.BaseFilter = BaseFilter;
+class FilterBuilder extends BaseFilter {
     and(field, condition) {
         return new AndFilterBuilder().and(field, condition);
     }

package/out/interfaces/kvs-api.d.ts

@@ -43,11 +43,15 @@ export declare type EntitySetRequest<T> = EntityKeyValueSchema<T>;
 export declare type EntitySetResponse = void;
 export declare type EntityDeleteRequest = EntityKeySchema;
 export declare type EntityDeleteResponse = void;
-declare type EntityQueryFilter = {
+export declare type EntityQueryFilter = {
     condition: 'BEGINS_WITH' | 'BETWEEN' | 'CONTAINS' | 'EQUAL_TO' | 'EXISTS' | 'GREATER_THAN' | 'GREATER_THAN_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_EQUAL_TO' | 'NOT_CONTAINS' | 'NOT_EQUAL_TO' | 'NOT_EXISTS';
     property: string;
     values: Array<unknown>;
 };
+export declare type EntityQueryFilters = {
+    or?: Array<EntityQueryFilter>;
+    and?: Array<EntityQueryFilter>;
+};
 export declare type EntityQueryRequest = {
     limit?: number;
     cursor?: string;
@@ -55,10 +59,7 @@ export declare type EntityQueryRequest = {
         condition: 'BEGINS_WITH' | 'BETWEEN' | 'EQUAL_TO' | 'GREATER_THAN' | 'GREATER_THAN_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_EQUAL_TO';
         values: Array<unknown>;
     };
-    filters?: {
-        or?: Array<EntityQueryFilter>;
-        and?: Array<EntityQueryFilter>;
-    };
+    filters?: EntityQueryFilters;
     sort?: 'ASC' | 'DESC';
     partition?: Array<unknown>;
     entityName: string;
@@ -68,5 +69,27 @@ export declare type EntityQueryResponse<T> = {
     data: Array<KeyValueSchema<T>>;
     cursor?: string;
 };
+export declare type TransactionCondition = EntityQueryFilters;
+export declare type RequestSet<T> = {
+    key: string;
+    value: T;
+    entityName?: string;
+    conditions?: TransactionCondition;
+};
+export declare type RequestDelete = {
+    key: string;
+    entityName?: string;
+    conditions?: TransactionCondition;
+};
+export declare type RequestCheck = {
+    key: string;
+    entityName?: string;
+    conditions: TransactionCondition;
+};
+export declare type TransactionRequest<T> = {
+    set?: RequestSet<T>[];
+    delete?: RequestDelete[];
+    check?: RequestCheck[];
+};
 export {};
 //# sourceMappingURL=kvs-api.d.ts.map

package/out/interfaces/kvs-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kvs-api.d.ts","sourceRoot":"","sources":["../../src/interfaces/kvs-api.ts"],"names":[],"mappings":"AAAA,aAAK,SAAS,GAAG;IACf,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,aAAK,cAAc,CAAC,CAAC,IAAI,SAAS,GAAG;IACnC,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,oBAAY,UAAU,GAAG,SAAS,CAAC;AACnC,oBAAY,WAAW,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;AAE/C,oBAAY,UAAU,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;AAC9C,oBAAY,WAAW,GAAG,IAAI,CAAC;AAE/B,oBAAY,aAAa,GAAG,SAAS,CAAC;AACtC,oBAAY,cAAc,GAAG,IAAI,CAAC;AAElC,aAAK,UAAU,GAAG;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,QAAQ,EAAE,KAAK,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACxB,CAAC;AACF,oBAAY,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC3B,CAAC;AACF,oBAAY,aAAa,CAAC,CAAC,IAAI;IAC7B,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAGF,oBAAY,gBAAgB,GAAG,SAAS,CAAC;AACzC,oBAAY,iBAAiB,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;AAErD,oBAAY,gBAAgB,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;AACpD,oBAAY,iBAAiB,GAAG,IAAI,CAAC;AAErC,oBAAY,mBAAmB,GAAG,SAAS,CAAC;AAC5C,oBAAY,oBAAoB,GAAG,IAAI,CAAC;AAGxC,aAAK,eAAe,GAAG;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,aAAK,oBAAoB,CAAC,CAAC,IAAI,eAAe,GAAG;IAC/C,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,oBAAY,gBAAgB,GAAG,eAAe,CAAC;AAC/C,oBAAY,iBAAiB,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAE3D,oBAAY,gBAAgB,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAC1D,oBAAY,iBAAiB,GAAG,IAAI,CAAC;AAErC,oBAAY,mBAAmB,GAAG,eAAe,CAAC;AAClD,oBAAY,oBAAoB,GAAG,IAAI,CAAC;AAExC,aAAK,iBAAiB,GAAG;IACvB,SAAS,EACL,aAAa,GACb,SAAS,GACT,UAAU,GACV,UAAU,GACV,QAAQ,GACR,cAAc,GACd,uBAAuB,GACvB,WAAW,GACX,oBAAoB,GACpB,cAAc,GACd,cAAc,GACd,YAAY,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACxB,CAAC;AACF,oBAAY,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE;QACN,SAAS,EACL,aAAa,GACb,SAAS,GACT,UAAU,GACV,cAAc,GACd,uBAAuB,GACvB,WAAW,GACX,oBAAoB,CAAC;QACzB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;KACxB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,EAAE,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC9B,GAAG,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;KAChC,CAAC;IACF,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AACF,oBAAY,mBAAmB,CAAC,CAAC,IAAI;IACnC,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"kvs-api.d.ts","sourceRoot":"","sources":["../../src/interfaces/kvs-api.ts"],"names":[],"mappings":"AAAA,aAAK,SAAS,GAAG;IACf,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,aAAK,cAAc,CAAC,CAAC,IAAI,SAAS,GAAG;IACnC,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,oBAAY,UAAU,GAAG,SAAS,CAAC;AACnC,oBAAY,WAAW,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;AAE/C,oBAAY,UAAU,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;AAC9C,oBAAY,WAAW,GAAG,IAAI,CAAC;AAE/B,oBAAY,aAAa,GAAG,SAAS,CAAC;AACtC,oBAAY,cAAc,GAAG,IAAI,CAAC;AAElC,aAAK,UAAU,GAAG;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,QAAQ,EAAE,KAAK,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACxB,CAAC;AACF,oBAAY,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC3B,CAAC;AACF,oBAAY,aAAa,CAAC,CAAC,IAAI;IAC7B,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAGF,oBAAY,gBAAgB,GAAG,SAAS,CAAC;AACzC,oBAAY,iBAAiB,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;AAErD,oBAAY,gBAAgB,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC;AACpD,oBAAY,iBAAiB,GAAG,IAAI,CAAC;AAErC,oBAAY,mBAAmB,GAAG,SAAS,CAAC;AAC5C,oBAAY,oBAAoB,GAAG,IAAI,CAAC;AAGxC,aAAK,eAAe,GAAG;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,aAAK,oBAAoB,CAAC,CAAC,IAAI,eAAe,GAAG;IAC/C,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF,oBAAY,gBAAgB,GAAG,eAAe,CAAC;AAC/C,oBAAY,iBAAiB,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAE3D,oBAAY,gBAAgB,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAC1D,oBAAY,iBAAiB,GAAG,IAAI,CAAC;AAErC,oBAAY,mBAAmB,GAAG,eAAe,CAAC;AAClD,oBAAY,oBAAoB,GAAG,IAAI,CAAC;AAExC,oBAAY,iBAAiB,GAAG;IAC9B,SAAS,EACL,aAAa,GACb,SAAS,GACT,UAAU,GACV,UAAU,GACV,QAAQ,GACR,cAAc,GACd,uBAAuB,GACvB,WAAW,GACX,oBAAoB,GACpB,cAAc,GACd,cAAc,GACd,YAAY,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACxB,CAAC;AACF,oBAAY,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC9B,GAAG,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;CAChC,CAAC;AACF,oBAAY,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE;QACN,SAAS,EACL,aAAa,GACb,SAAS,GACT,UAAU,GACV,cAAc,GACd,uBAAuB,GACvB,WAAW,GACX,oBAAoB,CAAC;QACzB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;KACxB,CAAC;IACF,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AACF,oBAAY,mBAAmB,CAAC,CAAC,IAAI;IACnC,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAGF,oBAAY,oBAAoB,GAAG,kBAAkB,CAAC;AAEtD,oBAAY,UAAU,CAAC,CAAC,IAAI;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,CAAC,CAAC;IACT,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC,CAAC;AAEF,oBAAY,aAAa,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC,CAAC;AAEF,oBAAY,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,oBAAoB,CAAC;CAClC,CAAC;AAGF,oBAAY,kBAAkB,CAAC,CAAC,IAAI;IAClC,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB,CAAC"}

package/out/interfaces/kvs.d.ts

@@ -1,5 +1,6 @@
 import { IndexQueryBuilder } from './entity-query';
 import { QueryBuilder } from './query';
+import { TransactionBuilder } from './transaction';
 export interface Kvs {
     get<T>(key: string): Promise<T>;
     set<T>(key: string, value: T): Promise<void>;
@@ -9,6 +10,7 @@ export interface Kvs {
     setSecret<T>(key: string, value: T): Promise<void>;
     deleteSecret(key: string): Promise<void>;
     entity<T>(entityName: string): KvsEntity<T>;
+    transact(): TransactionBuilder;
 }
 export interface KvsEntity<T> {
     get(key: string): Promise<T>;

package/out/interfaces/kvs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kvs.d.ts","sourceRoot":"","sources":["../../src/interfaces/kvs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,MAAM,WAAW,GAAG;IAClB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAChC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,KAAK,IAAI,YAAY,CAAC;IAEtB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACtC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,KAAK,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAC/B"}
+{"version":3,"file":"kvs.d.ts","sourceRoot":"","sources":["../../src/interfaces/kvs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAEnD,MAAM,WAAW,GAAG;IAClB,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAChC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,KAAK,IAAI,YAAY,CAAC;IAEtB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACtC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAE5C,QAAQ,IAAI,kBAAkB,CAAC;CAChC;AAED,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,KAAK,IAAI,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAC/B"}

package/out/interfaces/transaction.d.ts

@@ -0,0 +1,29 @@
+import { BaseFilter } from '../entity-query';
+export interface TransactSet<T> {
+    key: string;
+    value: T;
+    entity?: EntityConditions<T>;
+}
+export interface TransactDelete<T> {
+    key: string;
+    entity?: EntityConditions<T>;
+}
+export interface TransactCheck<T> {
+    key: string;
+    entity: EntityRequiredConditions<T>;
+}
+export declare type EntityConditions<T> = {
+    entityName: string;
+    conditions?: BaseFilter<T>;
+};
+export declare type EntityRequiredConditions<T> = Omit<EntityConditions<T>, 'conditions'> & {
+    conditions: BaseFilter<T>;
+};
+export declare type StorageValue = string | number | boolean | Record<string, any> | any[];
+export interface TransactionBuilder {
+    set<T>(key: string, value: T, entity?: EntityConditions<T>): this;
+    delete<T>(key: string, entity?: EntityConditions<T>): this;
+    check<T>(key: string, entity: EntityRequiredConditions<T>): this;
+    execute(): Promise<void>;
+}
+//# sourceMappingURL=transaction.d.ts.map

package/out/interfaces/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../src/interfaces/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAK7C,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,CAAC,CAAC;IACT,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9B;AAKD,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;CAC9B;AAKD,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC;CACrC;AAKD,oBAAY,gBAAgB,CAAC,CAAC,IAAI;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;CAC5B,CAAC;AAKF,oBAAY,wBAAwB,CAAC,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG;IAClF,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;CAC3B,CAAC;AAKF,oBAAY,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC;AAMnF,MAAM,WAAW,kBAAkB;IACjC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAClE,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC3D,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACjE,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B"}

package/out/interfaces/transaction.js

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

package/out/kvs.d.ts

@@ -1,5 +1,6 @@
 import { KvsEntity, Kvs } from './interfaces/kvs';
 import { QueryBuilder } from './interfaces/query';
+import { TransactionBuilder } from './interfaces/transaction';
 import { StorageApi } from './storage-api';
 export declare class KvsImpl implements Kvs {
     private readonly storageApi;
@@ -12,5 +13,6 @@ export declare class KvsImpl implements Kvs {
     setSecret<T>(key: string, value: T): Promise<void>;
     deleteSecret(key: string): Promise<void>;
     entity<T>(entityName: string): KvsEntity<T>;
+    transact(): TransactionBuilder;
 }
 //# sourceMappingURL=kvs.d.ts.map

package/out/kvs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kvs.d.ts","sourceRoot":"","sources":["../src/kvs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,OAAQ,YAAW,GAAG;IACrB,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU;IAEnD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI/B,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,KAAK,IAAI,YAAY;IAIrB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAIrC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxC,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CAG5C"}
+{"version":3,"file":"kvs.d.ts","sourceRoot":"","sources":["../src/kvs.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3C,qBAAa,OAAQ,YAAW,GAAG;IACrB,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU;IAEnD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI/B,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,KAAK,IAAI,YAAY;IAIrB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAIrC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxC,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;IAI3C,QAAQ,IAAI,kBAAkB;CAG/B"}

package/out/kvs.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KvsImpl = void 0;
 const entity_1 = require("./entity");
 const query_1 = require("./query");
+const transaction_api_1 = require("./transaction-api");
 class KvsImpl {
     storageApi;
     constructor(storageApi) {
@@ -32,5 +33,8 @@ class KvsImpl {
     entity(entityName) {
         return new entity_1.EntityImpl(entityName, this.storageApi);
     }
+    transact() {
+        return new transaction_api_1.TransactionBuilderImpl(this.storageApi);
+    }
 }
 exports.KvsImpl = KvsImpl;

package/out/storage-api.d.ts

@@ -1,6 +1,6 @@
 import { FetchMethod } from '@forge/api';
 import { ListResult } from './interfaces/types';
-import { DeleteRequest, EntityDeleteRequest, EntityGetRequest, EntityQueryRequest, EntitySetRequest, GetRequest, QueryRequest, SecretDeleteRequest, SecretGetRequest, SecretSetRequest, SetRequest } from './interfaces/kvs-api';
+import { DeleteRequest, EntityDeleteRequest, EntityGetRequest, EntityQueryRequest, EntitySetRequest, GetRequest, QueryRequest, SecretDeleteRequest, SecretGetRequest, SecretSetRequest, SetRequest, TransactionRequest } from './interfaces/kvs-api';
 export declare class StorageApi {
     private apiClient;
     constructor(apiClient: FetchMethod);
@@ -15,6 +15,7 @@ export declare class StorageApi {
     deleteEntity(body: EntityDeleteRequest): Promise<void>;
     query<T>(body: QueryRequest): Promise<ListResult<T>>;
     queryEntity<T>(body: EntityQueryRequest): Promise<ListResult<T>>;
+    transact<T>(transactionRequest: TransactionRequest<T>): Promise<void>;
     private request;
 }
 //# sourceMappingURL=storage-api.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"storage-api.d.ts","sourceRoot":"","sources":["../src/storage-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGhD,OAAO,EACL,aAAa,EAEb,mBAAmB,EAEnB,gBAAgB,EAEhB,kBAAkB,EAElB,gBAAgB,EAEhB,UAAU,EAEV,YAAY,EAEZ,mBAAmB,EAEnB,gBAAgB,EAEhB,gBAAgB,EAEhB,UAAU,EAEX,MAAM,sBAAsB,CAAC;AAE9B,qBAAa,UAAU;IACT,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,WAAW;IAEpC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC;IAKpC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKhD,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKhD,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,MAAM,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAQpD,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAQxD,OAAO;CAyBtB"}
+{"version":3,"file":"storage-api.d.ts","sourceRoot":"","sources":["../src/storage-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGhD,OAAO,EACL,aAAa,EAEb,mBAAmB,EAEnB,gBAAgB,EAEhB,kBAAkB,EAElB,gBAAgB,EAEhB,UAAU,EAEV,YAAY,EAEZ,mBAAmB,EAEnB,gBAAgB,EAEhB,gBAAgB,EAEhB,UAAU,EAEV,kBAAkB,EACnB,MAAM,sBAAsB,CAAC;AAE9B,qBAAa,UAAU;IACT,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,WAAW;IAEpC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC;IAKpC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKhD,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,CAAC,CAAC;IAKhD,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,MAAM,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,YAAY,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAQpD,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAQhE,QAAQ,CAAC,CAAC,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;YAI7D,OAAO;CAyBtB"}

package/out/storage-api.js

@@ -52,6 +52,9 @@ class StorageApi {
             nextCursor: rs.cursor
         };
     }
+    async transact(transactionRequest) {
+        await this.request('/api/v1/transaction', transactionRequest, false);
+    }
     async request(path, body, isResponseExpected) {
         const requestBody = {
             method: 'POST',

package/out/transaction-api.d.ts

@@ -0,0 +1,14 @@
+import { StorageApi } from './storage-api';
+import { EntityConditions, EntityRequiredConditions, TransactCheck, TransactDelete, TransactionBuilder, TransactSet } from './interfaces/transaction';
+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;
+    delete<T>(key: string, entity?: EntityConditions<T>): this;
+    check<T>(key: string, { entityName, conditions }: EntityRequiredConditions<T>): this;
+    execute(): Promise<void>;
+}
+//# sourceMappingURL=transaction-api.d.ts.map

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

@@ -0,0 +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"}

package/out/transaction-api.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionBuilderImpl = void 0;
+const transaction_request_builder_1 = require("./utils/transaction-request-builder");
+class TransactionBuilderImpl {
+    storageApi;
+    sets;
+    deletes;
+    checks;
+    constructor(storageApi, sets = [], deletes = [], checks = []) {
+        this.storageApi = storageApi;
+        this.sets = sets;
+        this.deletes = deletes;
+        this.checks = checks;
+    }
+    set(key, value, entity) {
+        const transactSet = {
+            key,
+            value
+        };
+        if (entity) {
+            transactSet.entity = {
+                entityName: entity.entityName,
+                conditions: entity.conditions
+            };
+        }
+        this.sets.push(transactSet);
+        return this;
+    }
+    delete(key, entity) {
+        const transactDelete = {
+            key
+        };
+        if (entity) {
+            transactDelete.entity = {
+                entityName: entity.entityName,
+                conditions: entity.conditions
+            };
+        }
+        this.deletes.push(transactDelete);
+        return this;
+    }
+    check(key, { entityName, conditions }) {
+        const transactCheck = {
+            key,
+            entity: {
+                entityName,
+                conditions
+            }
+        };
+        this.checks.push(transactCheck);
+        return this;
+    }
+    async execute() {
+        const undefineEmptyArray = (arr) => {
+            return arr.length === 0 ? undefined : arr;
+        };
+        const request = {
+            set: undefineEmptyArray(this.sets.map(transaction_request_builder_1.buildRequestSet)),
+            delete: undefineEmptyArray(this.deletes.map(transaction_request_builder_1.buildRequestDeletes)),
+            check: undefineEmptyArray(this.checks.map(transaction_request_builder_1.buildRequestChecks))
+        };
+        await this.storageApi.transact(request);
+    }
+}
+exports.TransactionBuilderImpl = TransactionBuilderImpl;

package/out/utils/__test__/transaction-request-builder.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=transaction-request-builder.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-request-builder.test.d.ts","sourceRoot":"","sources":["../../../src/utils/__test__/transaction-request-builder.test.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const transaction_request_builder_1 = require("../transaction-request-builder");
+const entity_query_1 = require("../../entity-query");
+const conditions_1 = require("../../conditions");
+const errors_1 = require("../../errors");
+const key = 'key';
+const entityName = 'testEntity';
+describe('transaction-request-builder', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    describe('buildRequestSet', () => {
+        it('should build request set without entity', () => {
+            const value = 'value';
+            const transactSet = {
+                key,
+                value
+            };
+            const result = (0, transaction_request_builder_1.buildRequestSet)(transactSet);
+            expect(result).toEqual({ key, value });
+        });
+        it('should build request set with entity and conditions', () => {
+            const conditions = new entity_query_1.FilterBuilder().and('field1', conditions_1.FilterConditions.beginsWith('S'));
+            const transactSet = {
+                key,
+                value: { field1: 'test' },
+                entity: {
+                    entityName,
+                    conditions
+                }
+            };
+            const result = (0, transaction_request_builder_1.buildRequestSet)(transactSet);
+            expect(result).toEqual({
+                key,
+                value: { field1: 'test' },
+                entityName,
+                conditions: { and: conditions.filters() }
+            });
+        });
+        it('should throw error if no conditions are set', () => {
+            const conditions = new entity_query_1.FilterBuilder();
+            const transactSet = {
+                key,
+                value: { field1: 'test' },
+                entity: {
+                    entityName,
+                    conditions
+                }
+            };
+            expect(() => (0, transaction_request_builder_1.buildRequestSet)(transactSet)).toMatchError(new errors_1.ForgeKvsError('Builder must have at least one condition set'));
+        });
+    });
+    describe('buildRequestDelete', () => {
+        it('should build request delete without entity', () => {
+            const transactDelete = { key };
+            const result = (0, transaction_request_builder_1.buildRequestDeletes)(transactDelete);
+            expect(result).toEqual({ key });
+        });
+        it('should build request delete with entity and conditions', () => {
+            const conditions = new entity_query_1.FilterBuilder().and('field1', conditions_1.FilterConditions.beginsWith('S'));
+            const transactDelete = {
+                key,
+                entity: {
+                    entityName,
+                    conditions
+                }
+            };
+            const result = (0, transaction_request_builder_1.buildRequestDeletes)(transactDelete);
+            expect(result).toEqual({
+                key,
+                entityName,
+                conditions: { and: conditions.filters() }
+            });
+        });
+        it('should throw error if no conditions are set', () => {
+            const conditions = new entity_query_1.FilterBuilder();
+            const transactDelete = {
+                key,
+                entity: {
+                    entityName,
+                    conditions
+                }
+            };
+            expect(() => (0, transaction_request_builder_1.buildRequestDeletes)(transactDelete)).toMatchError(new errors_1.ForgeKvsError('Builder must have at least one condition set'));
+        });
+    });
+    describe('buildRequestCheck', () => {
+        it('should build request check with entity and conditions', () => {
+            const conditions = new entity_query_1.FilterBuilder().and('field1', conditions_1.FilterConditions.beginsWith('S'));
+            const transactCheck = {
+                key,
+                entity: {
+                    entityName,
+                    conditions
+                }
+            };
+            const result = (0, transaction_request_builder_1.buildRequestChecks)(transactCheck);
+            expect(result).toEqual({
+                key,
+                entityName,
+                conditions: { and: conditions.filters() }
+            });
+        });
+        it('should throw error if no conditions are set', () => {
+            const conditions = new entity_query_1.FilterBuilder();
+            const transactCheck = {
+                key,
+                entity: {
+                    entityName,
+                    conditions
+                }
+            };
+            expect(() => (0, transaction_request_builder_1.buildRequestChecks)(transactCheck)).toMatchError(new errors_1.ForgeKvsError('Builder must have at least one condition set'));
+        });
+    });
+});

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

@@ -0,0 +1,6 @@
+import { RequestCheck, RequestDelete, RequestSet } from '../interfaces/kvs-api';
+import { TransactCheck, TransactDelete, TransactSet } from '../interfaces/transaction';
+export declare const buildRequestSet: <T>(setOperation: TransactSet<T>) => RequestSet<T>;
+export declare const buildRequestDeletes: <T>(deleteOperation: TransactDelete<T>) => RequestDelete;
+export declare const buildRequestChecks: <T>(checkOperation: TransactCheck<T>) => RequestCheck;
+//# sourceMappingURL=transaction-request-builder.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildRequestChecks = exports.buildRequestDeletes = exports.buildRequestSet = void 0;
+const errors_1 = require("../errors");
+function buildConditionsRequest(filter) {
+    if (!filter) {
+        return undefined;
+    }
+    if (filter.filters().length === 0) {
+        throw new errors_1.ForgeKvsError('Builder must have at least one condition set');
+    }
+    return {
+        [filter.operator()]: filter.filters()
+    };
+}
+const buildRequestSet = (setOperation) => {
+    const { key, value, entity } = setOperation;
+    const entityName = entity?.entityName;
+    const conditions = buildConditionsRequest(entity?.conditions);
+    return {
+        key,
+        value,
+        entityName,
+        conditions
+    };
+};
+exports.buildRequestSet = buildRequestSet;
+const buildRequestDeletes = (deleteOperation) => {
+    const { key, entity } = deleteOperation;
+    const entityName = entity?.entityName;
+    const conditions = buildConditionsRequest(entity?.conditions);
+    return {
+        key,
+        entityName,
+        conditions
+    };
+};
+exports.buildRequestDeletes = buildRequestDeletes;
+const buildRequestChecks = (checkOperation) => {
+    const { key, entity } = checkOperation;
+    const entityName = entity.entityName;
+    const conditions = buildConditionsRequest(entity.conditions);
+    return {
+        key,
+        entityName,
+        conditions
+    };
+};
+exports.buildRequestChecks = buildRequestChecks;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/kvs",
-  "version": "0.0.2-next.2",
+  "version": "0.1.0-next.3",
   "description": "Forge Key Value Store SDK",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -15,6 +15,7 @@
     "compile": "tsc -b -v"
   },
   "devDependencies": {
+    "@atlassian/xen-test-util": "^4.2.0",
     "@types/node": "14.18.63"
   },
   "dependencies": {