@forge/dashboards-bridge 1.1.3-next.0 → 1.2.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @forge/dashboards-bridge
 
+## 1.2.0-next.2
+
+### Patch Changes
+
+- fca9900: Add useFilter hook and export bridge types
+
+## 1.2.0-next.1
+
+### Minor Changes
+
+- d2d8203: Add dashboard filter bridge methods
+
 ## 1.1.3-next.0
 
 ### Patch Changes

package/out/filters/get-filter-bridge.d.ts

@@ -0,0 +1,7 @@
+export declare const getFilterBridge: () => Promise<{
+    onSave: (onSave: import("./types").FilterOnSave) => void;
+    onProductSave: (onProductSave: import("./types").FilterOnProductSave) => void;
+    updateOverrides: (overrides: import("./types").FilterOverride) => import("./types").FilterOverride;
+    onOverrideClear: (onOverrideClear: import("./types").OnOverrideClear) => void;
+}>;
+//# sourceMappingURL=get-filter-bridge.d.ts.map

package/out/filters/get-filter-bridge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-filter-bridge.d.ts","sourceRoot":"","sources":["../../src/filters/get-filter-bridge.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe;;;;;EAAiD,CAAC"}

package/out/filters/get-filter-bridge.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFilterBridge = void 0;
+const bridge_1 = require("../bridge");
+const getFilterBridge = () => (0, bridge_1.getCallBridge)()('getDashboardFilterApi');
+exports.getFilterBridge = getFilterBridge;

package/out/filters/index.d.ts

@@ -0,0 +1,12 @@
+import { onProductSave } from './onProductSave';
+import { onSave } from './onSave';
+import { updateOverrides } from './updateOverrides';
+import { onOverrideClear } from './onOverrideClear';
+export declare const filter: {
+    onProductSave: typeof onProductSave;
+    onSave: typeof onSave;
+    updateOverrides: typeof updateOverrides;
+    onOverrideClear: typeof onOverrideClear;
+};
+export type { FilterPayload, FilterGroupPayload, FilterDimension, Filter, FilterGroup, FilterOverride, FilterOnProductSave, FilterOnSave, OnOverrideClear } from './types';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/filters/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,MAAM;;;;;CAKlB,CAAC;AAEF,YAAY,EACV,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,MAAM,EACN,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,YAAY,EACZ,eAAe,EAChB,MAAM,SAAS,CAAC"}

package/out/filters/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filter = void 0;
+const onProductSave_1 = require("./onProductSave");
+const onSave_1 = require("./onSave");
+const updateOverrides_1 = require("./updateOverrides");
+const onOverrideClear_1 = require("./onOverrideClear");
+exports.filter = {
+    onProductSave: onProductSave_1.onProductSave,
+    onSave: onSave_1.onSave,
+    updateOverrides: updateOverrides_1.updateOverrides,
+    onOverrideClear: onOverrideClear_1.onOverrideClear
+};

package/out/filters/onOverrideClear.d.ts

@@ -0,0 +1,3 @@
+import { OnOverrideClear } from './types';
+export declare function onOverrideClear(onOverrideClear: OnOverrideClear): Promise<void>;
+//# sourceMappingURL=onOverrideClear.d.ts.map

package/out/filters/onOverrideClear.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onOverrideClear.d.ts","sourceRoot":"","sources":["../../src/filters/onOverrideClear.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAc1C,wBAAsB,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAOrF"}

package/out/filters/onOverrideClear.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onOverrideClear = onOverrideClear;
+const errors_1 = require("../errors");
+const get_filter_bridge_1 = require("./get-filter-bridge");
+async function onOverrideClear(onOverrideClear) {
+    try {
+        const bridge = await (0, get_filter_bridge_1.getFilterBridge)();
+        bridge.onOverrideClear(onOverrideClear);
+    }
+    catch (err) {
+        throw new errors_1.BridgeAPIError('Unable to set filter.onOverrideClear: ' + err.message);
+    }
+}

package/out/filters/onProductSave.d.ts

@@ -0,0 +1,3 @@
+import { FilterOnProductSave } from './types';
+export declare function onProductSave(onProductSave: FilterOnProductSave): Promise<void>;
+//# sourceMappingURL=onProductSave.d.ts.map

package/out/filters/onProductSave.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onProductSave.d.ts","sourceRoot":"","sources":["../../src/filters/onProductSave.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAkC9C,wBAAsB,aAAa,CAAC,aAAa,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAOrF"}

package/out/filters/onProductSave.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onProductSave = onProductSave;
+const errors_1 = require("../errors");
+const get_filter_bridge_1 = require("./get-filter-bridge");
+async function onProductSave(onProductSave) {
+    try {
+        const bridge = await (0, get_filter_bridge_1.getFilterBridge)();
+        bridge.onProductSave(onProductSave);
+    }
+    catch (err) {
+        throw new errors_1.BridgeAPIError('Unable to set filter.onProductSave: ' + err.message);
+    }
+}

package/out/filters/onSave.d.ts

@@ -0,0 +1,3 @@
+import { FilterOnSave } from './types';
+export declare function onSave(onSave: FilterOnSave): Promise<void>;
+//# sourceMappingURL=onSave.d.ts.map

package/out/filters/onSave.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onSave.d.ts","sourceRoot":"","sources":["../../src/filters/onSave.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAavC,wBAAsB,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAOhE"}

package/out/filters/onSave.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.onSave = onSave;
+const errors_1 = require("../errors");
+const get_filter_bridge_1 = require("./get-filter-bridge");
+async function onSave(onSave) {
+    try {
+        const bridge = await (0, get_filter_bridge_1.getFilterBridge)();
+        bridge.onSave(onSave);
+    }
+    catch (err) {
+        throw new errors_1.BridgeAPIError('Unable to set filter.onSave: ' + err.message);
+    }
+}

package/out/filters/types.d.ts

@@ -0,0 +1,22 @@
+import type { Filter, FilterDimension, FilterGroup } from '../widgets/types';
+export type { Filter, FilterDimension, FilterGroup };
+export type FilterPayload = {
+    id?: string;
+    label?: string | null;
+    comparison: string;
+    defaultValues?: Array<string | null> | null;
+    dimensions: string[];
+};
+export type FilterGroupPayload = {
+    id?: string;
+    operator: 'AND' | 'OR';
+    groups: FilterPayload[];
+};
+export type FilterOverride = {
+    values?: (string | null)[];
+    comparison?: string;
+};
+export type FilterOnProductSave = (filterGroupPayload: FilterGroupPayload | undefined) => Promise<FilterGroupPayload | null | undefined>;
+export type FilterOnSave = (filterGroup: FilterGroup) => Promise<void>;
+export type OnOverrideClear = () => Promise<void>;
+//# sourceMappingURL=types.d.ts.map

package/out/filters/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/filters/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE7E,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG;IAK1B,EAAE,CAAC,EAAE,MAAM,CAAC;IAIZ,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAItB,UAAU,EAAE,MAAM,CAAC;IAInB,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAI5C,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAQF,MAAM,MAAM,kBAAkB,GAAG;IAK/B,EAAE,CAAC,EAAE,MAAM,CAAC;IAIZ,QAAQ,EAAE,KAAK,GAAG,IAAI,CAAC;IAIvB,MAAM,EAAE,aAAa,EAAE,CAAC;CACzB,CAAC;AAKF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAChC,kBAAkB,EAAE,kBAAkB,GAAG,SAAS,KAC/C,OAAO,CAAC,kBAAkB,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAEpD,MAAM,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvE,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/out/filters/types.js

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

package/out/filters/updateOverrides.d.ts

@@ -0,0 +1,3 @@
+import type { FilterOverride } from './types';
+export declare function updateOverrides(overrides: FilterOverride): Promise<FilterOverride>;
+//# sourceMappingURL=updateOverrides.d.ts.map

package/out/filters/updateOverrides.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateOverrides.d.ts","sourceRoot":"","sources":["../../src/filters/updateOverrides.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAc9C,wBAAsB,eAAe,CAAC,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAOxF"}

package/out/filters/updateOverrides.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateOverrides = updateOverrides;
+const errors_1 = require("../errors");
+const get_filter_bridge_1 = require("./get-filter-bridge");
+async function updateOverrides(overrides) {
+    try {
+        const bridge = await (0, get_filter_bridge_1.getFilterBridge)();
+        return bridge.updateOverrides(overrides);
+    }
+    catch (err) {
+        throw new errors_1.BridgeAPIError('Unable to update overrides: ' + err.message);
+    }
+}

package/out/index.d.ts

@@ -1,2 +1,4 @@
 export * from './widgets';
+export { filter } from './filters';
+export type { FilterPayload, FilterGroupPayload, FilterOverride, OnOverrideClear, FilterOnSave, FilterOnProductSave } from './filters';
 //# 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,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAE1B,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,YAAY,EACV,aAAa,EACb,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,mBAAmB,EACpB,MAAM,WAAW,CAAC"}

package/out/index.js

@@ -1,4 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.filter = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./widgets"), exports);
+var filters_1 = require("./filters");
+Object.defineProperty(exports, "filter", { enumerable: true, get: function () { return filters_1.filter; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/dashboards-bridge",
-  "version": "1.1.3-next.0",
+  "version": "1.2.0-next.2",
   "description": "Forge Dashboards custom bridge API",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",