@forge/storage 1.3.2 → 1.4.0-next.0

package/out/gql-queries.js

@@ -0,0 +1,222 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomEntityQueries = exports.UntypedQueries = void 0;
+class UntypedQueries {
+}
+exports.UntypedQueries = UntypedQueries;
+UntypedQueries.get = (contextAri, key, encrypted) => ({
+    query: `
+      query forge_app_getApplicationStorageEntity($contextAri: ID!, $key: ID!, $encrypted: Boolean!) {
+        appStoredEntity(contextAri: $contextAri, key: $key, encrypted: $encrypted) {
+          key
+          value
+        }
+      }
+    `,
+    variables: {
+        contextAri,
+        key,
+        encrypted
+    }
+});
+UntypedQueries.set = (contextAri, key, value, encrypted) => ({
+    query: `
+      mutation forge_app_setApplicationStorageEntity($input: SetAppStoredEntityMutationInput!) {
+        appStorage{
+          setAppStoredEntity(input: $input) {
+            success
+  
+            errors {
+              message
+              extensions {
+                errorType
+              }
+            }
+          }
+        }
+      }
+    `,
+    variables: {
+        input: {
+            contextAri,
+            key,
+            value,
+            encrypted
+        }
+    }
+});
+UntypedQueries.delete = (contextAri, key, encrypted) => ({
+    query: `
+      mutation forge_app_deleteApplicationStorageEntity($input: DeleteAppStoredEntityMutationInput!) {
+        appStorage {
+          deleteAppStoredEntity(input: $input) {
+            success
+  
+            errors {
+              message
+              extensions {
+                errorType
+              }
+            }
+          }
+        }
+      }
+    `,
+    variables: {
+        input: {
+            contextAri,
+            key,
+            encrypted
+        }
+    }
+});
+UntypedQueries.listQuery = (contextAri, options) => {
+    var _a, _b, _c;
+    return ({
+        query: `
+      query forge_app_getApplicationStorageEntities($contextAri: ID!, $where: [AppStoredEntityFilter!], $cursor: String, $limit: Int) {
+        appStoredEntities(contextAri: $contextAri, where: $where, after: $cursor, first: $limit) {
+          edges {
+            node {
+              value
+              key
+            }
+  
+            cursor
+          }
+        }
+      }
+    `,
+        variables: {
+            contextAri,
+            where: (_a = options.where) !== null && _a !== void 0 ? _a : null,
+            cursor: (_b = options.cursor) !== null && _b !== void 0 ? _b : null,
+            limit: (_c = options.limit) !== null && _c !== void 0 ? _c : null
+        }
+    });
+};
+UntypedQueries.listQueryForCleanup = (contextAri, options) => {
+    var _a, _b, _c;
+    return ({
+        query: `
+      query forge_app_getApplicationStorageEntitiesForCleanup($contextAri: ID!, $where: [AppStoredEntityFilter!], $cursor: String, $limit: Int) {
+        appStoredEntitiesForCleanup(contextAri: $contextAri, where: $where, after: $cursor, first: $limit) {
+          edges {
+            node {
+              value
+              key
+            }
+  
+            cursor
+          }
+        }
+      }
+    `,
+        variables: {
+            contextAri,
+            where: (_a = options.where) !== null && _a !== void 0 ? _a : null,
+            cursor: (_b = options.cursor) !== null && _b !== void 0 ? _b : null,
+            limit: (_c = options.limit) !== null && _c !== void 0 ? _c : null
+        }
+    });
+};
+class CustomEntityQueries {
+}
+exports.CustomEntityQueries = CustomEntityQueries;
+CustomEntityQueries.get = (contextAri, entityName, key) => ({
+    query: `
+    query forge_app_getApplicationStorageCustomEntity ($contextAri: ID!, $key: ID!, $entityName: String!) {
+      appStoredCustomEntity(contextAri: $contextAri, key: $key, entityName: $entityName) {
+          value
+          entityName
+          key
+      }
+  }
+    `,
+    variables: {
+        contextAri,
+        entityName,
+        key
+    }
+});
+CustomEntityQueries.set = (contextAri, entityName, key, value) => ({
+    query: `
+      mutation forge_app_setApplicationStorageCustomEntity($input: SetAppStoredCustomEntityMutationInput!) {
+        appStorageCustomEntity{
+          setAppStoredCustomEntity(input: $input) {
+            success
+  
+            errors {
+              message
+              extensions {
+                errorType
+              }
+            }
+          }
+        }
+      }
+    `,
+    variables: {
+        input: {
+            contextAri,
+            entityName,
+            key,
+            value
+        }
+    }
+});
+CustomEntityQueries.delete = (contextAri, entityName, key) => ({
+    query: `
+      mutation forge_app_deleteApplicationStorageCustomEntity($input: DeleteAppStoredCustomEntityMutationInput!) {
+        appStorageCustomEntity {
+          deleteAppStoredCustomEntity(input: $input) {
+            success
+  
+            errors {
+              message
+              extensions {
+                errorType
+              }
+            }
+          }
+        }
+      }
+    `,
+    variables: {
+        input: {
+            contextAri,
+            entityName,
+            key
+        }
+    }
+});
+CustomEntityQueries.listQuery = (contextAri, options) => {
+    return {
+        query: `
+      query AppStorageCustomEntityQueries ($contextAri: ID!, $entityName: String!, $indexName: String!, $range: AppStoredCustomEntityRange, $filters: AppStoredCustomEntityFilters, $sort:SortOrder, $limit: Int, $cursor: String, $partition: [AppStoredCustomEntityFieldValue!]) {
+        appStoredCustomEntities(contextAri: $contextAri, entityName: $entityName, indexName: $indexName, range: $range, filters: $filters, sort:$sort, limit: $limit, cursor: $cursor, partition: $partition) {
+            edges {
+                node {
+                    key
+                    value
+                }
+                cursor
+            }
+            pageInfo {
+                hasNextPage
+                hasPreviousPage
+            }
+            totalCount
+            cursor
+        }
+  } 
+      `,
+        variables: Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({ contextAri, entityName: options.entityName, indexName: options.indexName, range: options.range }, (options.filters && options.filters.length
+            ? {
+                filters: {
+                    [options.filterOperator || 'and']: options.filters
+                }
+            }
+            : {})), (options.partition ? { partition: options.partition } : {})), (options.sort ? { sort: options.sort } : {})), (options.cursor ? { cursor: options.cursor } : {})), (options.limit ? { limit: options.limit } : {}))
+    };
+};

package/out/index.d.ts

@@ -1,4 +1,5 @@
 import { RequestInit, Response } from 'node-fetch';
+import { EntityStorageBuilder } from './entity-storage';
 import { GlobalStorage } from './global-storage';
 import { DefaultQueryBuilder } from './query-api';
 export declare type APIResponse = Pick<Response, 'json' | 'text' | 'arrayBuffer' | 'ok' | 'status' | 'statusText'>;
@@ -11,9 +12,12 @@ export declare const getStorageInstanceWithQuery: (adapter: GlobalStorage) => {
     setSecret: (key: string, value: any) => Promise<void>;
     deleteSecret: (key: string) => Promise<void>;
     query: () => DefaultQueryBuilder;
+    entity: <T>(entityName: string) => EntityStorageBuilder<T>;
 };
 export { GlobalStorage } from './global-storage';
 export { startsWith } from './conditions';
-export { QueryBuilder, QueryApi, Condition, ListResult, Predicate, Result, Value } from './storage-adapter';
+export { WhereConditions, FilterConditions } from './eap/conditions';
+export { QueryBuilder, QueryApi, Condition, ListResult, Predicate, Result, EntityStorageApi, WherePredicate, FilterPredicate } from './storage-adapter';
+export { Value } from './query-interfaces';
 export { APIError } from './errors';
 //# sourceMappingURL=index.d.ts.map

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,oBAAY,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAC3G,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAEnF,eAAO,MAAM,2BAA2B,YAAa,aAAa;;;;;;;;CAUjE,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE5G,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAElD,oBAAY,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAC3G,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAEnF,eAAO,MAAM,2BAA2B,YAAa,aAAa;;;;;;;iBAQnD,mBAAmB;4BACN,MAAM;CAEjC,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAErE,OAAO,EACL,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,UAAU,EACV,SAAS,EACT,MAAM,EACN,gBAAgB,EAChB,cAAc,EACd,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC"}

package/out/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.APIError = exports.startsWith = exports.GlobalStorage = exports.getStorageInstanceWithQuery = void 0;
+exports.APIError = exports.FilterConditions = exports.WhereConditions = exports.startsWith = exports.GlobalStorage = exports.getStorageInstanceWithQuery = void 0;
+const entity_storage_1 = require("./entity-storage");
 const query_api_1 = require("./query-api");
 const getStorageInstanceWithQuery = (adapter) => {
     return {
@@ -10,7 +11,8 @@ const getStorageInstanceWithQuery = (adapter) => {
         getSecret: adapter.getSecret.bind(adapter),
         setSecret: adapter.setSecret.bind(adapter),
         deleteSecret: adapter.deleteSecret.bind(adapter),
-        query: () => new query_api_1.DefaultQueryBuilder(adapter)
+        query: () => new query_api_1.DefaultQueryBuilder(adapter),
+        entity: (entityName) => new entity_storage_1.EntityStorageBuilder(entityName, adapter)
     };
 };
 exports.getStorageInstanceWithQuery = getStorageInstanceWithQuery;
@@ -18,5 +20,8 @@ var global_storage_1 = require("./global-storage");
 Object.defineProperty(exports, "GlobalStorage", { enumerable: true, get: function () { return global_storage_1.GlobalStorage; } });
 var conditions_1 = require("./conditions");
 Object.defineProperty(exports, "startsWith", { enumerable: true, get: function () { return conditions_1.startsWith; } });
+var conditions_2 = require("./eap/conditions");
+Object.defineProperty(exports, "WhereConditions", { enumerable: true, get: function () { return conditions_2.WhereConditions; } });
+Object.defineProperty(exports, "FilterConditions", { enumerable: true, get: function () { return conditions_2.FilterConditions; } });
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return errors_1.APIError; } });

package/out/query-api.d.ts

@@ -1,5 +1,5 @@
 import { GlobalStorage } from './global-storage';
-import { ListOptions } from './queries';
+import { ListOptions } from './query-interfaces';
 import { QueryBuilder, Condition, Result, ListResult } from './storage-adapter';
 export declare class DefaultQueryBuilder implements QueryBuilder {
     private globalStorage;

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

@@ -1 +1 @@
-{"version":3,"file":"query-api.d.ts","sourceRoot":"","sources":["../src/query-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEhF,qBAAa,mBAAoB,YAAW,YAAY;IAC1C,OAAO,CAAC,aAAa;IAA+B,OAAO,CAAC,YAAY;gBAAhE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAU,YAAY,GAAE,WAAgB;IAEtG,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,GAAG,YAAY;IAYnD,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAOpC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAO5B,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAQrC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC;CAGrC"}
+{"version":3,"file":"query-api.d.ts","sourceRoot":"","sources":["../src/query-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEhF,qBAAa,mBAAoB,YAAW,YAAY;IAC1C,OAAO,CAAC,aAAa;IAA+B,OAAO,CAAC,YAAY;gBAAhE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAU,YAAY,GAAE,WAAgB;IAEtG,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,GAAG,YAAY;IAYnD,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;IAOpC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAO5B,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAQrC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC;CAGrC"}

package/out/query-interfaces.d.ts

@@ -0,0 +1,113 @@
+export declare type Value = string;
+export interface StartsWith {
+    condition: 'STARTS_WITH';
+    value: Value;
+}
+export interface NotEqualTo {
+    condition: 'NOT_EQUAL_TO';
+    value: Value[];
+}
+export interface In {
+    condition: 'IN';
+    value: Value[];
+}
+interface FieldClause {
+    field: string;
+}
+export declare type StartsWithClause = FieldClause & StartsWith;
+export declare type NotEqualToClause = FieldClause & NotEqualTo;
+export declare type InClause = FieldClause & In;
+export declare type WhereClause = StartsWithClause | NotEqualToClause | InClause;
+export interface ListOptions {
+    where?: Array<WhereClause>;
+    cursor?: string;
+    limit?: number;
+}
+export declare type CustomEntityQueryValue = string | number | boolean;
+export interface BetweenClause {
+    condition: 'BETWEEN';
+    values: CustomEntityQueryValue[];
+}
+export interface BeginsWithClause {
+    condition: 'BEGINS_WITH';
+    values: CustomEntityQueryValue[];
+}
+export interface ExistsClause {
+    condition: 'EXISTS';
+    values: CustomEntityQueryValue[];
+}
+export interface DoesNotExistClause {
+    condition: 'NOT_EXISTS';
+    values: CustomEntityQueryValue[];
+}
+export interface GreaterThanClause {
+    condition: 'GREATER_THAN';
+    values: CustomEntityQueryValue[];
+}
+export interface GreaterThanEqualToClause {
+    condition: 'GREATER_THAN_EQUAL_TO';
+    values: CustomEntityQueryValue[];
+}
+export interface LessThanClause {
+    condition: 'LESS_THAN';
+    values: CustomEntityQueryValue[];
+}
+export interface LessThanEqualToClause {
+    condition: 'LESS_THAN_EQUAL_TO';
+    values: CustomEntityQueryValue[];
+}
+export interface ContainsClause {
+    condition: 'CONTAINS';
+    values: CustomEntityQueryValue[];
+}
+export interface DoesNotContainClause {
+    condition: 'NOT_CONTAINS';
+    values: CustomEntityQueryValue[];
+}
+export interface EqualToClause {
+    condition: 'EQUAL_TO';
+    values: CustomEntityQueryValue[];
+}
+export interface IsNotEqualToClause {
+    condition: 'NOT_EQUAL_TO';
+    values: CustomEntityQueryValue[];
+}
+export declare type FilterOperator = 'or' | 'and';
+export interface FilterPropertyClause {
+    property: string;
+}
+export declare type BetweenFilterClause = FilterPropertyClause & BetweenClause;
+export declare type BeginsWithFilterClause = FilterPropertyClause & BeginsWithClause;
+export declare type ExistsFilterClause = FilterPropertyClause & ExistsClause;
+export declare type DoesNotExistFilterClause = FilterPropertyClause & DoesNotExistClause;
+export declare type GreaterThanFilterClause = FilterPropertyClause & GreaterThanClause;
+export declare type GreaterThanEqualToFilterClause = FilterPropertyClause & GreaterThanEqualToClause;
+export declare type LessThanFilterClause = FilterPropertyClause & LessThanClause;
+export declare type LessThanEqualToFilterClause = FilterPropertyClause & LessThanEqualToClause;
+export declare type ContainsFilterClause = FilterPropertyClause & ContainsClause;
+export declare type DoesNotContainFilterClause = FilterPropertyClause & DoesNotContainClause;
+export declare type EqualToFilterClause = FilterPropertyClause & EqualToClause;
+export declare type IsNotEqualToFilterClause = FilterPropertyClause & IsNotEqualToClause;
+export declare type RangeClause = BetweenClause | BeginsWithClause | EqualToClause | GreaterThanClause | GreaterThanEqualToClause | LessThanClause | LessThanEqualToClause;
+export declare type FilterClause = BetweenFilterClause | BeginsWithFilterClause | ExistsFilterClause | DoesNotExistFilterClause | GreaterThanFilterClause | GreaterThanEqualToFilterClause | LessThanFilterClause | LessThanEqualToFilterClause | ContainsFilterClause | DoesNotContainFilterClause | EqualToFilterClause | IsNotEqualToFilterClause;
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CustomEntityQueryIndexOptions {
+    partition: CustomEntityPartitionValue[];
+}
+export declare type CustomEntityPartitionValue = string | number | boolean;
+export interface CustomEntityListOptions {
+    sort?: SortOrder;
+    entityName?: string;
+    indexName?: string;
+    partition?: CustomEntityPartitionValue[];
+    range?: RangeClause;
+    filters?: FilterClause[];
+    filterOperator?: FilterOperator;
+    cursor?: string;
+    limit?: number;
+}
+export {};
+//# sourceMappingURL=query-interfaces.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"query-interfaces.d.ts","sourceRoot":"","sources":["../src/query-interfaces.ts"],"names":[],"mappings":"AAMA,oBAAY,KAAK,GAAG,MAAM,CAAC;AAC3B,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd;AACD,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,cAAc,CAAC;IAC1B,KAAK,EAAE,KAAK,EAAE,CAAC;CAChB;AACD,MAAM,WAAW,EAAE;IACjB,SAAS,EAAE,IAAI,CAAC;IAChB,KAAK,EAAE,KAAK,EAAE,CAAC;CAChB;AAED,UAAU,WAAW;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,oBAAY,gBAAgB,GAAG,WAAW,GAAG,UAAU,CAAC;AACxD,oBAAY,gBAAgB,GAAG,WAAW,GAAG,UAAU,CAAC;AACxD,oBAAY,QAAQ,GAAG,WAAW,GAAG,EAAE,CAAC;AAExC,oBAAY,WAAW,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,QAAQ,CAAC;AACzE,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAKD,oBAAY,sBAAsB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE/D,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,aAAa,CAAC;IACzB,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,QAAQ,CAAC;IACpB,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,cAAc,CAAC;IAC1B,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,uBAAuB,CAAC;IACnC,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,oBAAoB,CAAC;IAChC,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,UAAU,CAAC;IACtB,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,cAAc,CAAC;IAC1B,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,UAAU,CAAC;IACtB,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,cAAc,CAAC;IAC1B,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC;AAKD,oBAAY,cAAc,GAAG,IAAI,GAAG,KAAK,CAAC;AAE1C,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,mBAAmB,GAAG,oBAAoB,GAAG,aAAa,CAAC;AACvE,oBAAY,sBAAsB,GAAG,oBAAoB,GAAG,gBAAgB,CAAC;AAC7E,oBAAY,kBAAkB,GAAG,oBAAoB,GAAG,YAAY,CAAC;AACrE,oBAAY,wBAAwB,GAAG,oBAAoB,GAAG,kBAAkB,CAAC;AACjF,oBAAY,uBAAuB,GAAG,oBAAoB,GAAG,iBAAiB,CAAC;AAC/E,oBAAY,8BAA8B,GAAG,oBAAoB,GAAG,wBAAwB,CAAC;AAC7F,oBAAY,oBAAoB,GAAG,oBAAoB,GAAG,cAAc,CAAC;AACzE,oBAAY,2BAA2B,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AACvF,oBAAY,oBAAoB,GAAG,oBAAoB,GAAG,cAAc,CAAC;AACzE,oBAAY,0BAA0B,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AACrF,oBAAY,mBAAmB,GAAG,oBAAoB,GAAG,aAAa,CAAC;AACvE,oBAAY,wBAAwB,GAAG,oBAAoB,GAAG,kBAAkB,CAAC;AAEjF,oBAAY,WAAW,GACnB,aAAa,GACb,gBAAgB,GAChB,aAAa,GACb,iBAAiB,GACjB,wBAAwB,GACxB,cAAc,GACd,qBAAqB,CAAC;AAE1B,oBAAY,YAAY,GACpB,mBAAmB,GACnB,sBAAsB,GACtB,kBAAkB,GAClB,wBAAwB,GACxB,uBAAuB,GACvB,8BAA8B,GAC9B,oBAAoB,GACpB,2BAA2B,GAC3B,oBAAoB,GACpB,0BAA0B,GAC1B,mBAAmB,GACnB,wBAAwB,CAAC;AAE7B,oBAAY,SAAS;IACnB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,MAAM,WAAW,6BAA6B;IAC5C,SAAS,EAAE,0BAA0B,EAAE,CAAC;CACzC;AAED,oBAAY,0BAA0B,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AACnE,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACzC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB"}

package/out/query-interfaces.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = void 0;
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));

package/out/storage-adapter.d.ts

@@ -1,3 +1,5 @@
+import { EntityStorageBuilderType } from './entity-storage';
+import { BeginsWithClause, BetweenClause, ExistsClause, DoesNotExistClause, FilterOperator, GreaterThanClause, GreaterThanEqualToClause, StartsWith, NotEqualTo, In, LessThanClause, LessThanEqualToClause, ContainsClause, DoesNotContainClause, IsNotEqualToClause, EqualToClause, SortOrder, CustomEntityQueryIndexOptions } from './query-interfaces';
 export interface StorageAdapter {
     get(key: string): Promise<any>;
     set(key: string, value: any): Promise<void>;
@@ -6,21 +8,17 @@ export interface StorageAdapter {
     setSecret(key: string, value: any): Promise<void>;
     deleteSecret(key: string): Promise<void>;
 }
-export interface QueryApi {
-    query(): QueryBuilder;
-}
-export declare type Value = string;
-export interface StartsWith {
-    condition: 'STARTS_WITH';
-    value: Value;
+export interface EntityStorageAdapter {
+    getEntity<T>(entityName: string, entityKey: string): Promise<T>;
+    setEntity<T>(entityName: string, entityKey: string, value: T): Promise<void>;
+    deleteEntity(entityName: string, entityKey: string): Promise<void>;
 }
-export interface NotEqualTo {
-    condition: 'NOT_EQUAL_TO';
-    value: Value[];
+export interface EntityStorageApi {
+    entity<T>(entityKey: string): EntityStorageBuilderType<T>;
 }
-export interface In {
-    condition: 'IN';
-    value: Value[];
+export declare type SharedStorageAdapter = StorageAdapter & EntityStorageAdapter;
+export interface QueryApi {
+    query(): QueryBuilder;
 }
 export declare type Predicate = StartsWith | NotEqualTo | In;
 export declare type Condition = Predicate;
@@ -31,12 +29,25 @@ export interface QueryBuilder {
     getMany(): Promise<ListResult>;
     getOne(): Promise<Result | undefined>;
 }
-export interface Result {
+export declare type FilterPredicate = BetweenClause | BeginsWithClause | ExistsClause | DoesNotExistClause | GreaterThanClause | GreaterThanEqualToClause | LessThanClause | LessThanEqualToClause | ContainsClause | DoesNotContainClause | EqualToClause | IsNotEqualToClause;
+export declare type WherePredicate = BetweenClause | BeginsWithClause | EqualToClause | GreaterThanClause | GreaterThanEqualToClause | LessThanClause | LessThanEqualToClause;
+export interface CustomEntityQueryBuilder<T> {
+    index(indexName: string, indexOptions?: CustomEntityQueryIndexOptions): CustomEntityQueryBuilder<T>;
+    where(condition: WherePredicate): CustomEntityQueryBuilder<T>;
+    sort(sort: SortOrder): CustomEntityQueryBuilder<T>;
+    filters(property: string, condition: FilterPredicate): CustomEntityQueryBuilder<T>;
+    filterOperator(operator: FilterOperator): CustomEntityQueryBuilder<T>;
+    cursor(cursor: string): CustomEntityQueryBuilder<T>;
+    limit(limit: number): CustomEntityQueryBuilder<T>;
+    getMany(): Promise<ListResult<T>>;
+    getOne(): Promise<Result<T> | undefined>;
+}
+export interface Result<T = object> {
     key: string;
-    value: object;
+    value: T;
 }
-export interface ListResult {
-    results: Result[];
+export interface ListResult<T = object> {
+    results: Result<T>[];
     nextCursor?: string;
 }
 //# sourceMappingURL=storage-adapter.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"storage-adapter.d.ts","sourceRoot":"","sources":["../src/storage-adapter.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,IAAI,YAAY,CAAC;CACvB;AAED,oBAAY,KAAK,GAAG,MAAM,CAAC;AAC3B,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd;AACD,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,cAAc,CAAC;IAC1B,KAAK,EAAE,KAAK,EAAE,CAAC;CAChB;AACD,MAAM,WAAW,EAAE;IACjB,SAAS,EAAE,IAAI,CAAC;IAChB,KAAK,EAAE,KAAK,EAAE,CAAC;CAChB;AAED,oBAAY,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,EAAE,CAAC;AACrD,oBAAY,SAAS,GAAG,SAAS,CAAC;AAElC,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,GAAG,YAAY,CAAC;IACxD,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;IACnC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"storage-adapter.d.ts","sourceRoot":"","sources":["../src/storage-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,wBAAwB,EACxB,UAAU,EACV,UAAU,EACV,EAAE,EACF,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,aAAa,EACb,SAAS,EACT,6BAA6B,EAC9B,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAChE,SAAS,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;CAC3D;AAED,oBAAY,oBAAoB,GAAG,cAAc,GAAG,oBAAoB,CAAC;AAEzE,MAAM,WAAW,QAAQ;IACvB,KAAK,IAAI,YAAY,CAAC;CACvB;AAED,oBAAY,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,EAAE,CAAC;AACrD,oBAAY,SAAS,GAAG,SAAS,CAAC;AAElC,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,GAAG,YAAY,CAAC;IACxD,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAAC;IACrC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAC;IACnC,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,MAAM,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACvC;AAMD,oBAAY,eAAe,GACvB,aAAa,GACb,gBAAgB,GAChB,YAAY,GACZ,kBAAkB,GAClB,iBAAiB,GACjB,wBAAwB,GACxB,cAAc,GACd,qBAAqB,GACrB,cAAc,GACd,oBAAoB,GACpB,aAAa,GACb,kBAAkB,CAAC;AAEvB,oBAAY,cAAc,GACtB,aAAa,GACb,gBAAgB,GAChB,aAAa,GACb,iBAAiB,GACjB,wBAAwB,GACxB,cAAc,GACd,qBAAqB,CAAC;AAE1B,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,6BAA6B,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;IACpG,KAAK,CAAC,SAAS,EAAE,cAAc,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAC9D,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;IACnD,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;IACnF,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;IACtE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;IACpD,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAClD,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CAC1C;AAED,MAAM,WAAW,MAAM,CAAC,CAAC,GAAG,MAAM;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,CAAC,CAAC;CACV;AAED,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,MAAM;IACpC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/storage",
-  "version": "1.3.2",
+  "version": "1.4.0-next.0",
   "description": "Forge Storage methods",
   "author": "Atlassian",
   "license": "UNLICENSED",

package/out/queries.d.ts

@@ -1,69 +0,0 @@
-export declare const getQuery: (contextAri: string, key: string, encrypted: boolean) => {
-    query: string;
-    variables: {
-        contextAri: string;
-        key: string;
-        encrypted: boolean;
-    };
-};
-export interface StartsWithClause {
-    field: string;
-    condition: 'STARTS_WITH';
-    value: string;
-}
-export interface NotEqualToClause {
-    field: string;
-    condition: 'NOT_EQUAL_TO';
-    value: string[];
-}
-export interface InClause {
-    field: string;
-    condition: 'IN';
-    value: string[];
-}
-export declare type WhereClause = StartsWithClause | NotEqualToClause | InClause;
-export interface ListOptions {
-    where?: Array<WhereClause>;
-    cursor?: string;
-    limit?: number;
-}
-export declare const listQuery: (contextAri: string, options: ListOptions) => {
-    query: string;
-    variables: {
-        contextAri: string;
-        where: WhereClause[] | null;
-        cursor: string | null;
-        limit: number | null;
-    };
-};
-export declare const listQueryForCleanup: (contextAri: string, options: ListOptions) => {
-    query: string;
-    variables: {
-        contextAri: string;
-        where: WhereClause[] | null;
-        cursor: string | null;
-        limit: number | null;
-    };
-};
-export declare const setQuery: (contextAri: string, key: string, value: any, encrypted: boolean) => {
-    query: string;
-    variables: {
-        input: {
-            contextAri: string;
-            key: string;
-            value: any;
-            encrypted: boolean;
-        };
-    };
-};
-export declare const deleteQuery: (contextAri: string, key: string, encrypted: boolean) => {
-    query: string;
-    variables: {
-        input: {
-            contextAri: string;
-            key: string;
-            encrypted: boolean;
-        };
-    };
-};
-//# sourceMappingURL=queries.d.ts.map

package/out/queries.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,eAAgB,MAAM,OAAO,MAAM,aAAa,OAAO;;;;;;;CAc1E,CAAC;AAEH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,cAAc,CAAC;IAC1B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAChB,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,oBAAY,WAAW,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,QAAQ,CAAC;AAEzE,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,eAAO,MAAM,SAAS,eAAgB,MAAM,WAAW,WAAW;;;;;;;;CAuBhE,CAAC;AAEH,eAAO,MAAM,mBAAmB,eAAgB,MAAM,WAAW,WAAW;;;;;;;;CAuB1E,CAAC;AAEH,eAAO,MAAM,QAAQ,eAAgB,MAAM,OAAO,MAAM,SAAS,GAAG,aAAa,OAAO;;;;;;;;;;CAyBtF,CAAC;AAEH,eAAO,MAAM,WAAW,eAAgB,MAAM,OAAO,MAAM,aAAa,OAAO;;;;;;;;;CAwB7E,CAAC"}