flowerbi-react 2.0.0 → 3.1.0

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,mDAAiC;AACjC,gDAA8B"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "flowerbi-react",
-    "version": "2.0.0",
+    "version": "3.1.0",
     "author": "Daniel Earwicker <dan@earwicker.com>",
     "license": "MIT",
     "description": "React helpers for FlowerBI",
@@ -9,7 +9,7 @@
     "dependencies": {
         "@types/json-stable-stringify": "^1.0.32",
         "@types/react": "^16.9.0",
-        "flowerbi": "2.0.0",
+        "flowerbi": "3.1.0",
         "json-stable-stringify": "^1.0.1"
     },
     "devDependencies": {

package/dist/useQuery.d.ts

@@ -1,46 +0,0 @@
-import { Query, QueryFetch, QuerySelect, ExpandedQueryResult } from "flowerbi";
-export declare type UseQueryState = "init" | "ready" | "refresh" | "error";
-export interface UseQueryResult<S extends QuerySelect> extends ExpandedQueryResult<S> {
-    /**
-     * The state of the query operation:
-     *
-     * - `init` - no result has been downloaded yet
-     * - `ready` - result has been downloaded
-     * - `refresh` - a new result is being downloaded
-     * - `error` - most recent query attempt failed
-     */
-    state: UseQueryState;
-}
-/**
- * Defines another query on which our query depends - for example a
- * first query may return the top 10 vendors, and a subsequent query
- * may then use an `in` filter to get details about those 10 vendors.
- */
-export declare type QueryDependency = {
-    /**
-     * The result of the query we depend on
-     */
-    dependency: UseQueryResult<QuerySelect>;
-    /**
-     * If true (default is false) then if the dependency query produces
-     * an empty result, our query should also produce an empty result,
-     * so there is no need to execute it.
-     */
-    nonEmpty?: boolean;
-};
-/**
- * A custom React hook that evaluates to the result of a
- * [Query](../flowerbi/interfaces/query.html), making it easy to perform a
- * query from within a component.
- *
- * The returned object has a strongly-typed `records` array, and optionally
- * a `totals` object. It has a `state` of type {@link UseQueryState} that
- * can be used to show a loading indicator.
- *
- * @param fetch The fetch function to use.
- * @param query The [Query](../flowerbi/interfaces/query.html) specification.
- * @param dependencies Optionally, a list of one or more other queries whose
- * results are used to build this query, so we wait for them before executing,
- * and optionally short-circuit to an empty result if the dependency is empty.
- */
-export declare function useQuery<S extends QuerySelect>(fetch: QueryFetch, query: Query<S>, dependencies?: QueryDependency[]): UseQueryResult<S>;

package/dist/useQuery.js

@@ -1,78 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useQuery = void 0;
-var react_1 = require("react");
-var flowerbi_1 = require("flowerbi");
-var json_stable_stringify_1 = __importDefault(require("json-stable-stringify"));
-/**
- * A custom React hook that evaluates to the result of a
- * [Query](../flowerbi/interfaces/query.html), making it easy to perform a
- * query from within a component.
- *
- * The returned object has a strongly-typed `records` array, and optionally
- * a `totals` object. It has a `state` of type {@link UseQueryState} that
- * can be used to show a loading indicator.
- *
- * @param fetch The fetch function to use.
- * @param query The [Query](../flowerbi/interfaces/query.html) specification.
- * @param dependencies Optionally, a list of one or more other queries whose
- * results are used to build this query, so we wait for them before executing,
- * and optionally short-circuit to an empty result if the dependency is empty.
- */
-function useQuery(fetch, query, dependencies) {
-    var queryJson = (0, flowerbi_1.jsonifyQuery)(query);
-    var _a = (0, react_1.useState)("init"), state = _a[0], setState = _a[1];
-    var _b = (0, react_1.useState)({ records: [] }), result = _b[0], setResult = _b[1];
-    (0, react_1.useEffect)(function () {
-        var disposed = false; // discard stale results
-        if (dependencies === null || dependencies === void 0 ? void 0 : dependencies.length) {
-            // if any not ready, neither are we
-            if (dependencies.some(function (x) { return x.dependency.state !== "ready"; })) {
-                if (state !== "init") {
-                    setState("refresh");
-                }
-                return;
-            }
-            // if any with option nonEmpty produced empty result, so do we
-            if (dependencies.filter(function (x) { return !!x.nonEmpty; }).some(function (x) { return !x.dependency.records.length; })) {
-                setState("ready");
-                setResult({ records: [] });
-                return;
-            }
-        }
-        if (state !== "init") {
-            setState("refresh");
-        }
-        fetch(queryJson).then(function (x) {
-            if (!disposed) {
-                setState("ready");
-                setResult(x);
-            }
-        }, function () {
-            if (!disposed) {
-                setState("error");
-            }
-        });
-        return function () {
-            disposed = true;
-        };
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [fetch, (0, json_stable_stringify_1.default)(queryJson)]);
-    return __assign(__assign({}, (0, flowerbi_1.expandQueryResult)(query.select, result)), { state: state });
-}
-exports.useQuery = useQuery;
-//# sourceMappingURL=useQuery.js.map

package/dist/useQuery.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useQuery.js","sourceRoot":"","sources":["../src/useQuery.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+BAAoD;AACpD,qCAAiI;AACjI,gFAAoD;AAkCpD;;;;;;;;;;;;;;GAcG;AACH,SAAgB,QAAQ,CAAwB,KAAiB,EAAE,KAAe,EAAE,YAAgC;IAChH,IAAM,SAAS,GAAG,IAAA,uBAAY,EAAC,KAAK,CAAC,CAAC;IAEhC,IAAA,KAAoB,IAAA,gBAAQ,EAAgB,MAAM,CAAC,EAAlD,KAAK,QAAA,EAAE,QAAQ,QAAmC,CAAC;IACpD,IAAA,KAAsB,IAAA,gBAAQ,EAAkB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,EAA/D,MAAM,QAAA,EAAE,SAAS,QAA8C,CAAC;IAEvE,IAAA,iBAAS,EAAC;QACN,IAAI,QAAQ,GAAG,KAAK,CAAC,CAAC,wBAAwB;QAE9C,IAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,EAAE;YACtB,mCAAmC;YACnC,IAAI,YAAY,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,UAAU,CAAC,KAAK,KAAK,OAAO,EAA9B,CAA8B,CAAC,EAAE;gBACxD,IAAI,KAAK,KAAK,MAAM,EAAE;oBAClB,QAAQ,CAAC,SAAS,CAAC,CAAC;iBACvB;gBACD,OAAO;aACV;YAED,8DAA8D;YAC9D,IAAI,YAAY,CAAC,MAAM,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAZ,CAAY,CAAC,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAA5B,CAA4B,CAAC,EAAE;gBAChF,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAClB,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC3B,OAAO;aACV;SACJ;QAED,IAAI,KAAK,KAAK,MAAM,EAAE;YAClB,QAAQ,CAAC,SAAS,CAAC,CAAC;SACvB;QAED,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CACjB,UAAA,CAAC;YACG,IAAI,CAAC,QAAQ,EAAE;gBACX,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAClB,SAAS,CAAC,CAAC,CAAC,CAAC;aAChB;QACL,CAAC,EACD;YACI,IAAI,CAAC,QAAQ,EAAE;gBACX,QAAQ,CAAC,OAAO,CAAC,CAAC;aACrB;QACL,CAAC,CACJ,CAAC;QAEF,OAAO;YACH,QAAQ,GAAG,IAAI,CAAC;QACpB,CAAC,CAAC;QACF,uDAAuD;IAC3D,CAAC,EAAE,CAAC,KAAK,EAAE,IAAA,+BAAe,EAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAExC,6BAAY,IAAA,4BAAiB,EAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,KAAE,KAAK,OAAA,IAAG;AACjE,CAAC;AAnDD,4BAmDC"}