@forge/storage 1.1.0 → 1.3.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @forge/storage
 
+## 1.3.0-next.0
+
+### Minor Changes
+
+- 3c3c42b9: Updated EAP filter names to be more readable
+
+## 1.2.0
+
+### Minor Changes
+
+- 21e392d: Added new filters for Early Access Program
+
+## 1.2.0-next.0
+
+### Minor Changes
+
+- 21e392d: Added new filters for Early Access Program
+
 ## 1.1.0
 
 ### Minor Changes

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const query_api_1 = require("../query-api");
 const conditions_1 = require("../conditions");
+const conditions_2 = require("../eap/conditions");
 describe('DefaultQueryBuilder', () => {
     function newGlobalStorage() {
         return {
@@ -48,6 +49,45 @@ describe('DefaultQueryBuilder', () => {
             cursor: 'cursor'
         }));
     });
+    it('should allow specifying a "starts with" condition', async () => {
+        const globalStorage = newGlobalStorage();
+        await new query_api_1.DefaultQueryBuilder(globalStorage).where('key', conditions_1.startsWith('test')).getMany();
+        expect(globalStorage.list).toHaveBeenCalledWith(expect.objectContaining({
+            where: [
+                {
+                    field: 'key',
+                    condition: 'STARTS_WITH',
+                    value: 'test'
+                }
+            ]
+        }));
+    });
+    it('should allow specifying a "not equal to" condition', async () => {
+        const globalStorage = newGlobalStorage();
+        await new query_api_1.DefaultQueryBuilder(globalStorage).where('key', conditions_2.isNotEqualTo(['test', 'test2'])).getMany();
+        expect(globalStorage.list).toHaveBeenCalledWith(expect.objectContaining({
+            where: [
+                {
+                    field: 'key',
+                    condition: 'NOT_EQUAL_TO',
+                    value: ['test', 'test2']
+                }
+            ]
+        }));
+    });
+    it('should allow specifying an "is in" condition', async () => {
+        const globalStorage = newGlobalStorage();
+        await new query_api_1.DefaultQueryBuilder(globalStorage).where('key', conditions_2.isIn(['test', 'test2'])).getMany();
+        expect(globalStorage.list).toHaveBeenCalledWith(expect.objectContaining({
+            where: [
+                {
+                    field: 'key',
+                    condition: 'IN',
+                    value: ['test', 'test2']
+                }
+            ]
+        }));
+    });
     it('should allow specifying a condition', async () => {
         const globalStorage = newGlobalStorage();
         await new query_api_1.DefaultQueryBuilder(globalStorage).where('key', conditions_1.startsWith('test')).getMany();

package/out/eap/conditions.d.ts

@@ -0,0 +1,4 @@
+import { Predicate } from '../storage-adapter';
+export declare function isNotEqualTo(value: string[]): Predicate;
+export declare function isIn(values: string[]): Predicate;
+//# sourceMappingURL=conditions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"conditions.d.ts","sourceRoot":"","sources":["../../src/eap/conditions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,CAKvD;AAED,wBAAgB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAKhD"}

package/out/eap/conditions.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIn = exports.isNotEqualTo = void 0;
+function isNotEqualTo(value) {
+    return {
+        condition: 'NOT_EQUAL_TO',
+        value
+    };
+}
+exports.isNotEqualTo = isNotEqualTo;
+function isIn(values) {
+    return {
+        condition: 'IN',
+        value: values
+    };
+}
+exports.isIn = isIn;

package/out/eap/index.d.ts

@@ -0,0 +1,2 @@
+export * from './conditions';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/eap/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/out/eap/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./conditions"), exports);

package/out/queries.d.ts

@@ -6,11 +6,22 @@ export declare const getQuery: (contextAri: string, key: string, encrypted: bool
         encrypted: boolean;
     };
 };
-export interface WhereClause {
+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;

package/out/queries.d.ts.map

@@ -1 +1 @@
-{"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,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,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"}
+{"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"}

package/out/query-api.d.ts

@@ -5,7 +5,7 @@ export declare class DefaultQueryBuilder implements QueryBuilder {
     private globalStorage;
     private queryOptions;
     constructor(globalStorage: Pick<GlobalStorage, 'list'>, queryOptions?: ListOptions);
-    where(field: 'key', { condition, value }: Condition): QueryBuilder;
+    where(field: 'key', where: Condition): QueryBuilder;
     cursor(cursor: string): QueryBuilder;
     limit(limit: number): QueryBuilder;
     getOne(): Promise<Result | undefined>;

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,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,SAAS,GAAG,YAAY;IAalE,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,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"}

package/out/query-api.js

@@ -6,13 +6,9 @@ class DefaultQueryBuilder {
         this.globalStorage = globalStorage;
         this.queryOptions = queryOptions;
     }
-    where(field, { condition, value }) {
+    where(field, where) {
         return new DefaultQueryBuilder(this.globalStorage, Object.assign(Object.assign({}, this.queryOptions), { where: [
-                {
-                    field,
-                    condition,
-                    value
-                }
+                Object.assign({ field }, where)
             ] }));
     }
     cursor(cursor) {

package/out/storage-adapter.d.ts

@@ -10,10 +10,19 @@ export interface QueryApi {
     query(): QueryBuilder;
 }
 export declare type Value = string;
-export interface Predicate {
+export interface StartsWith {
     condition: 'STARTS_WITH';
     value: Value;
 }
+export interface NotEqualTo {
+    condition: 'NOT_EQUAL_TO';
+    value: Value[];
+}
+export interface In {
+    condition: 'IN';
+    value: Value[];
+}
+export declare type Predicate = StartsWith | NotEqualTo | In;
 export declare type Condition = Predicate;
 export interface QueryBuilder {
     where(field: 'key', condition: Condition): QueryBuilder;

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,SAAS;IACxB,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd;AACD,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,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/storage",
-  "version": "1.1.0",
+  "version": "1.3.0-next.0",
   "description": "Forge Storage methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -16,7 +16,7 @@
   },
   "devDependencies": {
     "@types/node": "^12.12.63",
-    "node-fetch": "^2.6.1",
-    "@types/node-fetch": "^2.5.7"
+    "@types/node-fetch": "^2.5.7",
+    "node-fetch": "2.6.1"
   }
 }