@forge/cache 1.0.2 → 1.0.3-next.0-experimental-ab129b0

package/out/cache.d.ts

@@ -1,7 +1,7 @@
 import { RequestInit, Response as nodeFetchResponse } from 'node-fetch';
 import { TunnelCache } from './tunnel';
 import { IForgeCache } from './interfaces/cache';
-export declare type Response = Pick<nodeFetchResponse, 'text' | 'ok' | 'status'>;
+export declare type Response = nodeFetchResponse;
 export declare type ScanResult = {
     cursor: string;
     keys: string[];
@@ -15,8 +15,11 @@ export declare class ApiError extends Error {
 export declare function getResponseBody(response: Response): Promise<any>;
 export declare class Cache implements IForgeCache {
     private client;
+    private kvsImpl;
     constructor(client: (path: string, options?: RequestInit) => Promise<Response>);
     private buildRequest;
+    setKvs<T>(key: string, value: T): Promise<void>;
+    getKvs<T>(key: string): Promise<T | undefined>;
     set(key: string, value: string, opt?: {
         ttlSeconds: number;
     }): Promise<void>;

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,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;AAQD,wBAAgB,uBAAuB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAiCpG;AAED,wBAAgB,OAAO,CAAC,kBAAkB,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,WAAW,CAQxE"}
+{"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;AAKjD,oBAAY,QAAQ,GAAG,iBAAiB,CAAC;AAEzC,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;IAG3B,OAAO,CAAC,MAAM;IAF1B,OAAO,CAAC,OAAO,CAAU;gBAEL,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;IAMtF,OAAO,CAAC,YAAY;IAUP,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,MAAM,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAI9C,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;AAQD,wBAAgB,uBAAuB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAiCpG;AAED,wBAAgB,OAAO,CAAC,kBAAkB,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,WAAW,CAQxE"}

package/out/cache.js

@@ -5,6 +5,8 @@ const tslib_1 = require("tslib");
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const api_1 = require("@forge/api");
 const tunnel_1 = require("./tunnel");
+const kvs_1 = require("./kvs/kvs");
+const storage_api_1 = require("./kvs/storage-api");
 class ApiError extends Error {
     status;
     code;
@@ -43,8 +45,11 @@ async function getResponseBody(response) {
 exports.getResponseBody = getResponseBody;
 class Cache {
     client;
+    kvsImpl;
     constructor(client) {
         this.client = client;
+        const storageApi = new storage_api_1.StorageApi(client);
+        this.kvsImpl = new kvs_1.KvsImpl(storageApi);
     }
     buildRequest(requestBody) {
         return {
@@ -55,6 +60,12 @@ class Cache {
             }
         };
     }
+    async setKvs(key, value) {
+        return await this.kvsImpl.set(key, value);
+    }
+    async getKvs(key) {
+        return await this.kvsImpl.get(key);
+    }
     async set(key, value, opt) {
         const response = await this.client('rms/store/set', this.buildRequest({ key, value, ...opt }));
         await getResponseBody(response);

package/out/kvs/conditions.d.ts

@@ -0,0 +1,38 @@
+import { BeginsWithClause, BetweenClause, ContainsClause, EqualToClause, ExistsClause, GreaterThanClause, GreaterThanEqualToClause, LessThanClause, LessThanEqualToClause, NotContainsClause, NotEqualToClause, NotExistsClause, StringOrNumber, StringOrNumberOrBoolean } from './interfaces/types';
+declare function between<T extends StringOrNumber>(firstValue: T, secondValue: T): BetweenClause<T>;
+declare function beginsWith(value: StringOrNumber): BeginsWithClause;
+declare function exists(): ExistsClause;
+declare function notExists(): NotExistsClause;
+declare function greaterThan(value: StringOrNumber): GreaterThanClause;
+declare function greaterThanEqualTo(value: StringOrNumber): GreaterThanEqualToClause;
+declare function lessThan(value: StringOrNumber): LessThanClause;
+declare function lessThanEqualTo(value: StringOrNumber): LessThanEqualToClause;
+declare function contains(value: string): ContainsClause;
+declare function notContains(value: string): NotContainsClause;
+declare function equalTo(value: StringOrNumberOrBoolean): EqualToClause;
+declare function notEqualTo(value: StringOrNumberOrBoolean): NotEqualToClause;
+export declare const WhereConditions: {
+    beginsWith: typeof beginsWith;
+    between: typeof between;
+    equalTo: typeof equalTo;
+    greaterThan: typeof greaterThan;
+    greaterThanEqualTo: typeof greaterThanEqualTo;
+    lessThan: typeof lessThan;
+    lessThanEqualTo: typeof lessThanEqualTo;
+};
+export declare const FilterConditions: {
+    beginsWith: typeof beginsWith;
+    between: typeof between;
+    contains: typeof contains;
+    notContains: typeof notContains;
+    equalTo: typeof equalTo;
+    notEqualTo: typeof notEqualTo;
+    exists: typeof exists;
+    notExists: typeof notExists;
+    greaterThan: typeof greaterThan;
+    greaterThanEqualTo: typeof greaterThanEqualTo;
+    lessThan: typeof lessThan;
+    lessThanEqualTo: typeof lessThanEqualTo;
+};
+export {};
+//# sourceMappingURL=conditions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"conditions.d.ts","sourceRoot":"","sources":["../../src/kvs/conditions.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,aAAa,EACb,YAAY,EACZ,iBAAiB,EACjB,wBAAwB,EACxB,cAAc,EACd,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,uBAAuB,EACxB,MAAM,oBAAoB,CAAC;AAE5B,iBAAS,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,UAAU,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAK1F;AAED,iBAAS,UAAU,CAAC,KAAK,EAAE,cAAc,GAAG,gBAAgB,CAK3D;AAED,iBAAS,MAAM,IAAI,YAAY,CAK9B;AAED,iBAAS,SAAS,IAAI,eAAe,CAKpC;AAED,iBAAS,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,iBAAiB,CAK7D;AAED,iBAAS,kBAAkB,CAAC,KAAK,EAAE,cAAc,GAAG,wBAAwB,CAK3E;AAED,iBAAS,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,cAAc,CAKvD;AAED,iBAAS,eAAe,CAAC,KAAK,EAAE,cAAc,GAAG,qBAAqB,CAKrE;AAED,iBAAS,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAK/C;AAED,iBAAS,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAKrD;AAED,iBAAS,OAAO,CAAC,KAAK,EAAE,uBAAuB,GAAG,aAAa,CAK9D;AAED,iBAAS,UAAU,CAAC,KAAK,EAAE,uBAAuB,GAAG,gBAAgB,CAKpE;AAED,eAAO,MAAM,eAAe;;;;;;;;CAQ3B,CAAC;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;CAa5B,CAAC"}

package/out/kvs/conditions.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterConditions = exports.WhereConditions = void 0;
+function between(firstValue, secondValue) {
+    return {
+        condition: 'BETWEEN',
+        values: [firstValue, secondValue]
+    };
+}
+function beginsWith(value) {
+    return {
+        condition: 'BEGINS_WITH',
+        values: [value]
+    };
+}
+function exists() {
+    return {
+        condition: 'EXISTS',
+        values: [true]
+    };
+}
+function notExists() {
+    return {
+        condition: 'NOT_EXISTS',
+        values: [true]
+    };
+}
+function greaterThan(value) {
+    return {
+        condition: 'GREATER_THAN',
+        values: [value]
+    };
+}
+function greaterThanEqualTo(value) {
+    return {
+        condition: 'GREATER_THAN_EQUAL_TO',
+        values: [value]
+    };
+}
+function lessThan(value) {
+    return {
+        condition: 'LESS_THAN',
+        values: [value]
+    };
+}
+function lessThanEqualTo(value) {
+    return {
+        condition: 'LESS_THAN_EQUAL_TO',
+        values: [value]
+    };
+}
+function contains(value) {
+    return {
+        condition: 'CONTAINS',
+        values: [value]
+    };
+}
+function notContains(value) {
+    return {
+        condition: 'NOT_CONTAINS',
+        values: [value]
+    };
+}
+function equalTo(value) {
+    return {
+        condition: 'EQUAL_TO',
+        values: [value]
+    };
+}
+function notEqualTo(value) {
+    return {
+        condition: 'NOT_EQUAL_TO',
+        values: [value]
+    };
+}
+exports.WhereConditions = {
+    beginsWith,
+    between,
+    equalTo,
+    greaterThan,
+    greaterThanEqualTo,
+    lessThan,
+    lessThanEqualTo
+};
+exports.FilterConditions = {
+    beginsWith,
+    between,
+    contains,
+    notContains,
+    equalTo,
+    notEqualTo,
+    exists,
+    notExists,
+    greaterThan,
+    greaterThanEqualTo,
+    lessThan,
+    lessThanEqualTo
+};

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

@@ -0,0 +1,26 @@
+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;
+    private readonly storageApi;
+    constructor(entityName: string, storageApi: StorageApi);
+    index(name: string, indexOptions?: IndexOptions<T>): EntityQueryBuilder<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/kvs/entity-query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-query.d.ts","sourceRoot":"","sources":["../../src/kvs/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/kvs/entity-query.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterBuilder = exports.BaseFilter = exports.KvsIndexQueryBuilder = void 0;
+class KvsIndexQueryBuilder {
+    entityName;
+    storageApi;
+    constructor(entityName, storageApi) {
+        this.entityName = entityName;
+        this.storageApi = storageApi;
+    }
+    index(name, indexOptions) {
+        return new KvsEntityQueryBuilder(this.storageApi, {
+            entityName: this.entityName,
+            indexName: name,
+            partition: indexOptions?.partition,
+            filters: []
+        });
+    }
+}
+exports.KvsIndexQueryBuilder = KvsIndexQueryBuilder;
+class KvsEntityQueryBuilder {
+    storageApi;
+    queryOptions;
+    constructor(storageApi, queryOptions) {
+        this.storageApi = storageApi;
+        this.queryOptions = queryOptions;
+    }
+    where(condition) {
+        this.queryOptions.range = condition;
+        return this;
+    }
+    filters(filter) {
+        this.queryOptions.filters = filter.filters();
+        this.queryOptions.filterOperator = filter.operator();
+        return this;
+    }
+    sort(sort) {
+        this.queryOptions.sort = sort;
+        return this;
+    }
+    cursor(cursor) {
+        this.queryOptions.cursor = cursor;
+        return this;
+    }
+    limit(limit) {
+        this.queryOptions.limit = limit;
+        return this;
+    }
+    async getOne() {
+        const { results } = await this.limit(1).getMany();
+        if (results && results.length > 0) {
+            return results[0];
+        }
+        return undefined;
+    }
+    async getMany() {
+        const { filters, filterOperator, ...rest } = this.queryOptions;
+        if (filters && filterOperator && filters.length > 0) {
+            return this.storageApi.queryEntity({
+                ...rest,
+                filters: {
+                    [filterOperator]: filters
+                }
+            });
+        }
+        return this.storageApi.queryEntity(rest);
+    }
+}
+class BaseFilter {
+    items;
+    constructor(items = []) {
+        this.items = items;
+    }
+    filters() {
+        return this.items;
+    }
+    operator() {
+        return this instanceof AndFilterBuilder ? 'and' : 'or';
+    }
+}
+exports.BaseFilter = BaseFilter;
+class FilterBuilder extends BaseFilter {
+    and(field, condition) {
+        return new AndFilterBuilder().and(field, condition);
+    }
+    or(field, condition) {
+        return new OrFilterBuilder().or(field, condition);
+    }
+}
+exports.FilterBuilder = FilterBuilder;
+class AndFilterBuilder extends BaseFilter {
+    and(field, condition) {
+        this.items.push({ property: field, ...condition });
+        return this;
+    }
+}
+class OrFilterBuilder extends BaseFilter {
+    or(field, condition) {
+        this.items.push({ property: field, ...condition });
+        return this;
+    }
+}

package/out/kvs/entity.d.ts

@@ -0,0 +1,13 @@
+import { IndexQueryBuilder } from './interfaces/entity-query';
+import { KvsEntity } from './interfaces/kvs';
+import { StorageApi } from './storage-api';
+export declare class EntityImpl<T> implements KvsEntity<T> {
+    private readonly entityName;
+    private readonly storageApi;
+    constructor(entityName: string, storageApi: StorageApi);
+    get(key: string): Promise<T | undefined>;
+    set(key: string, value: T): Promise<void>;
+    delete(key: string): Promise<void>;
+    query(): IndexQueryBuilder<T>;
+}
+//# sourceMappingURL=entity.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../src/kvs/entity.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,SAAS,CAAC,CAAC,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,UAAU;gBADV,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,UAAU;IAGzC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAOxC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlC,KAAK,IAAI,iBAAiB,CAAC,CAAC,CAAC;CAG9B"}

package/out/kvs/entity.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityImpl = void 0;
+const entity_query_1 = require("./entity-query");
+class EntityImpl {
+    entityName;
+    storageApi;
+    constructor(entityName, storageApi) {
+        this.entityName = entityName;
+        this.storageApi = storageApi;
+    }
+    get(key) {
+        return this.storageApi.getEntity({
+            entityName: this.entityName,
+            key
+        });
+    }
+    set(key, value) {
+        return this.storageApi.setEntity({
+            entityName: this.entityName,
+            key,
+            value
+        });
+    }
+    delete(key) {
+        return this.storageApi.deleteEntity({
+            entityName: this.entityName,
+            key
+        });
+    }
+    query() {
+        return new entity_query_1.KvsIndexQueryBuilder(this.entityName, this.storageApi);
+    }
+}
+exports.EntityImpl = EntityImpl;

package/out/kvs/errors.d.ts

@@ -0,0 +1,21 @@
+export interface ForgeError {
+    code: string;
+    message: string;
+    context?: Record<string, unknown>;
+}
+export interface APIErrorResponseDetails {
+    status: number;
+    statusText: string;
+    traceId?: string | null;
+}
+export declare class ForgeKvsError extends Error {
+    constructor(message: string);
+}
+export declare class ForgeKvsAPIError extends ForgeKvsError {
+    responseDetails: APIErrorResponseDetails;
+    code: string;
+    message: string;
+    context: Record<string, unknown>;
+    constructor(responseDetails: APIErrorResponseDetails, forgeError: ForgeError);
+}
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/kvs/errors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAI5B;AAED,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,eAAe,EAAE,uBAAuB,CAAC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAErB,eAAe,EAAE,uBAAuB,EAAE,UAAU,EAAE,UAAU;CAU7E"}

package/out/kvs/errors.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForgeKvsAPIError = exports.ForgeKvsError = void 0;
+class ForgeKvsError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'ForgeKvsError';
+    }
+}
+exports.ForgeKvsError = ForgeKvsError;
+class ForgeKvsAPIError extends ForgeKvsError {
+    responseDetails;
+    code;
+    message;
+    context;
+    constructor(responseDetails, forgeError) {
+        super(forgeError.message);
+        const { status, statusText, traceId } = responseDetails;
+        this.responseDetails = { status, statusText, traceId };
+        const { code, message, context, ...bodyData } = forgeError;
+        this.code = code;
+        this.message = message;
+        this.context = { ...context, ...bodyData };
+    }
+}
+exports.ForgeKvsAPIError = ForgeKvsAPIError;

package/out/kvs/index.d.ts

@@ -0,0 +1,10 @@
+import { KvsImpl } from './kvs';
+declare const kvs: KvsImpl;
+export { FilterConditions, WhereConditions } from './conditions';
+export { FilterBuilder as Filter } from './entity-query';
+export * from './errors';
+export { AndFilter, OrFilter } from './interfaces/entity-query';
+export * from './interfaces/types';
+export { kvs };
+export default kvs;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/kvs/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAqChC,QAAA,MAAM,GAAG,SAA0B,CAAC;AAEpC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACzD,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAChE,cAAc,oBAAoB,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,CAAC;AACf,eAAe,GAAG,CAAC"}

package/out/kvs/index.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kvs = exports.Filter = exports.WhereConditions = exports.FilterConditions = void 0;
+const tslib_1 = require("tslib");
+const kvs_1 = require("./kvs");
+const storage_api_1 = require("./storage-api");
+function getFetchClient() {
+    const runtime = global.__forge_runtime__;
+    if (runtime?.kvs?.url && runtime?.kvs?.host) {
+        const { proxy, kvs, tracing } = runtime;
+        return async function (path, options) {
+            return await global.__forge_fetch__({ type: 'kvs' }, path, {
+                ...options,
+                headers: {
+                    ...options?.headers,
+                    Authorization: `Bearer ${proxy.token}`,
+                    Host: kvs?.host,
+                    'x-b3-traceid': tracing.traceId,
+                    'x-b3-spanid': tracing.spanId
+                }
+            });
+        };
+    }
+    return async function (path, options) {
+        return await global.__forge_fetch__({
+            type: 'kvs',
+            provider: 'app',
+            remote: 'kvs'
+        }, path, options);
+    };
+}
+const storageApi = new storage_api_1.StorageApi(getFetchClient());
+const kvs = new kvs_1.KvsImpl(storageApi);
+exports.kvs = kvs;
+var conditions_1 = require("./conditions");
+Object.defineProperty(exports, "FilterConditions", { enumerable: true, get: function () { return conditions_1.FilterConditions; } });
+Object.defineProperty(exports, "WhereConditions", { enumerable: true, get: function () { return conditions_1.WhereConditions; } });
+var entity_query_1 = require("./entity-query");
+Object.defineProperty(exports, "Filter", { enumerable: true, get: function () { return entity_query_1.FilterBuilder; } });
+tslib_1.__exportStar(require("./errors"), exports);
+tslib_1.__exportStar(require("./interfaces/types"), exports);
+exports.default = kvs;

package/out/kvs/interfaces/entity-query.d.ts

@@ -0,0 +1,41 @@
+import { BeginsWithClause, BetweenClause, ContainsClause, EqualToClause, ExistsClause, FilterOperator, GreaterThanClause, GreaterThanEqualToClause, LessThanClause, LessThanEqualToClause, ListResult, NotContainsClause, NotEqualToClause, NotExistsClause, Result, Sort, StringOrNumber } from './types';
+export declare type IndexOptions<T> = Pick<EntityQueryOptions<T>, 'partition'>;
+export interface IndexQueryBuilder<T> {
+    index(name: string, indexOptions?: IndexOptions<T>): EntityQueryBuilder<T>;
+}
+export interface EntityQueryBuilder<T> {
+    where(condition: EntityWhereClauses): this;
+    filters(filters: AndFilter<T> | OrFilter<T>): this;
+    sort(sort: Sort): this;
+    cursor(cursor: string): this;
+    limit(limit: number): this;
+    getOne(): Promise<Result<T> | undefined>;
+    getMany(): Promise<ListResult<T>>;
+}
+export declare type FilterItem<T> = EntityFilterClauses & {
+    property: keyof T;
+};
+export interface Filter<T> {
+    and(field: keyof T, condition: EntityFilterClauses): AndFilter<T>;
+    or(field: keyof T, condition: EntityFilterClauses): OrFilter<T>;
+}
+export interface AndFilter<T> {
+    and(field: keyof T, condition: EntityFilterClauses): this;
+}
+export interface OrFilter<T> {
+    or(field: keyof T, condition: EntityFilterClauses): this;
+}
+export declare type EntityFilterClauses = BetweenClause<StringOrNumber> | BeginsWithClause | ExistsClause | NotExistsClause | GreaterThanClause | GreaterThanEqualToClause | LessThanClause | LessThanEqualToClause | ContainsClause | NotContainsClause | EqualToClause | NotEqualToClause;
+export declare type EntityWhereClauses = BetweenClause<StringOrNumber> | BeginsWithClause | EqualToClause | GreaterThanClause | GreaterThanEqualToClause | LessThanClause | LessThanEqualToClause;
+export interface EntityQueryOptions<T> {
+    sort?: Sort;
+    entityName: string;
+    indexName: string;
+    partition?: Array<unknown>;
+    range?: EntityWhereClauses;
+    filters?: Array<FilterItem<T>>;
+    filterOperator?: FilterOperator;
+    cursor?: string;
+    limit?: number;
+}
+//# sourceMappingURL=entity-query.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entity-query.d.ts","sourceRoot":"","sources":["../../../src/kvs/interfaces/entity-query.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,cAAc,EACd,aAAa,EACb,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,wBAAwB,EACxB,cAAc,EACd,qBAAqB,EACrB,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,MAAM,EACN,IAAI,EACJ,cAAc,EACf,MAAM,SAAS,CAAC;AAEjB,oBAAY,YAAY,CAAC,CAAC,IAAI,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;AAEvE,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;CAC5E;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,KAAK,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAC3C,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACnD,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IACzC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC;AAED,oBAAY,UAAU,CAAC,CAAC,IAAI,mBAAmB,GAAG;IAChD,QAAQ,EAAE,MAAM,CAAC,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAClE,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC3D;AAED,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC1D;AAED,oBAAY,mBAAmB,GAC3B,aAAa,CAAC,cAAc,CAAC,GAC7B,gBAAgB,GAChB,YAAY,GACZ,eAAe,GACf,iBAAiB,GACjB,wBAAwB,GACxB,cAAc,GACd,qBAAqB,GACrB,cAAc,GACd,iBAAiB,GACjB,aAAa,GACb,gBAAgB,CAAC;AAErB,oBAAY,kBAAkB,GAC1B,aAAa,CAAC,cAAc,CAAC,GAC7B,gBAAgB,GAChB,aAAa,GACb,iBAAiB,GACjB,wBAAwB,GACxB,cAAc,GACd,qBAAqB,CAAC;AAE1B,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/out/kvs/interfaces/entity-query.js

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

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

@@ -0,0 +1,95 @@
+declare type KeySchema = {
+    key: string;
+};
+declare type KeyValueSchema<T> = KeySchema & {
+    value: T;
+};
+export declare type GetRequest = KeySchema;
+export declare type GetResponse<T> = KeyValueSchema<T>;
+export declare type SetRequest<T> = KeyValueSchema<T>;
+export declare type SetResponse = void;
+export declare type DeleteRequest = KeySchema;
+export declare type DeleteResponse = void;
+declare type QueryWhere = {
+    condition: 'BEGINS_WITH';
+    property: 'key';
+    values: Array<unknown>;
+};
+export declare type QueryRequest = {
+    limit?: number;
+    after?: string;
+    where?: Array<QueryWhere>;
+};
+export declare type QueryResponse<T> = {
+    data: Array<KeyValueSchema<T>>;
+    cursor?: string;
+};
+export declare type SecretGetRequest = KeySchema;
+export declare type SecretGetResponse<T> = KeyValueSchema<T>;
+export declare type SecretSetRequest<T> = KeyValueSchema<T>;
+export declare type SecretSetResponse = void;
+export declare type SecretDeleteRequest = KeySchema;
+export declare type SecretDeleteResponse = void;
+declare type EntityKeySchema = {
+    entityName: string;
+    key: string;
+};
+declare type EntityKeyValueSchema<T> = EntityKeySchema & {
+    value: T;
+};
+export declare type EntityGetRequest = EntityKeySchema;
+export declare type EntityGetResponse<T> = EntityKeyValueSchema<T>;
+export declare type EntitySetRequest<T> = EntityKeyValueSchema<T>;
+export declare type EntitySetResponse = void;
+export declare type EntityDeleteRequest = EntityKeySchema;
+export declare type EntityDeleteResponse = void;
+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;
+    range?: {
+        condition: 'BEGINS_WITH' | 'BETWEEN' | 'EQUAL_TO' | 'GREATER_THAN' | 'GREATER_THAN_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_EQUAL_TO';
+        values: Array<unknown>;
+    };
+    filters?: EntityQueryFilters;
+    sort?: 'ASC' | 'DESC';
+    partition?: Array<unknown>;
+    entityName: string;
+    indexName: string;
+};
+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