@cubejs-client/react 1.7.13 → 1.7.15

package/dist/CubeContext.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="react" />
+import type { CubeContextProps } from './types';
+/**
+ * In case when you need direct access to `cubeApi` you can use `CubeContext` anywhere in your app
+ *
+ * ```js
+ * import React from 'react';
+ * import { CubeContext } from '@cubejs-client/react';
+ *
+ * export default function DisplayComponent() {
+ *   const { cubeApi } = React.useContext(CubeContext);
+ *   const [rawResults, setRawResults] = React.useState([]);
+ *   const query = {
+ *     ...
+ *   };
+ *
+ *   React.useEffect(() => {
+ *     cubeApi.load(query).then((resultSet) => {
+ *       setRawResults(resultSet.rawData());
+ *     });
+ *   }, [query]);
+ *
+ *   return (
+ *     <>
+ *       {rawResults.map(row => (
+ *         ...
+ *       ))}
+ *     </>
+ *   )
+ * }
+ * ```
+ */
+declare const _default: import("react").Context<CubeContextProps>;
+export default _default;
+//# sourceMappingURL=CubeContext.d.ts.map

package/dist/CubeContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CubeContext.d.ts","sourceRoot":"","sources":["../src/CubeContext.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;;AAGH,wBAAoF"}

package/dist/CubeProvider.d.ts

@@ -0,0 +1,31 @@
+import React from 'react';
+import type { CubeProviderProps } from './types';
+/**
+ * Cube.js context provider
+ * ```js
+ * import React from 'react';
+ * import cube from '@cubejs-client/core';
+ * import { CubeProvider } from '@cubejs-client/react';
+ *
+ * const API_URL = 'https://harsh-eel.aws-us-east-2.cubecloudapp.dev';
+ * const CUBE_TOKEN =
+ *   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.* eyJpYXQiOjE1OTE3MDcxNDgsImV4cCI6MTU5NDI5OTE0OH0.* n5jGLQJ14igg6_Hri_Autx9qOIzVqp4oYxmX27V-4T4';
+ *
+ * const cubeApi = cube(CUBE_TOKEN, {
+ *   apiUrl: `${API_URL}/cubejs-api/v1`,
+ * });
+ *
+ * export default function App() {
+ *   return (
+ *     <CubeProvider cubeApi={cubeApi}>
+ *       //...
+ *     </CubeProvider>
+ *   )
+ * }
+ * ```
+ * @stickyTypes
+ * @order 10
+ */
+declare const CubeProvider: React.FC<CubeProviderProps>;
+export default CubeProvider;
+//# sourceMappingURL=CubeProvider.d.ts.map

package/dist/CubeProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CubeProvider.d.ts","sourceRoot":"","sources":["../src/CubeProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,KAAK,EAAoB,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEnE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,QAAA,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAQ7C,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/QueryBuilder.d.ts

@@ -0,0 +1,135 @@
+import React from 'react';
+import type { CubeApi, DryRunResponse, Meta, PivotConfig, Query } from '@cubejs-client/core';
+import type { ChartType, CubeContextProps, QueryBuilderInternalState, QueryBuilderProps, QueryBuilderRenderProps, QueryBuilderStateUpdate, QueryMemberType, QueryRendererRenderProps, ResolveMemberArgs } from './types';
+/**
+ * `<QueryBuilder />` is used to build interactive analytics query builders. It abstracts state management and API calls to Cube.js Backend. It uses render prop technique and doesn’t render anything itself, but calls the render function instead.
+ *
+ * **Example**
+ *
+ * [Open in CodeSandbox](https://codesandbox.io/s/z6r7qj8wm)
+ * ```js
+ * import React from 'react';
+ * import ReactDOM from 'react-dom';
+ * import { Layout, Divider, Empty, Select } from 'antd';
+ * import { QueryBuilder } from '@cubejs-client/react';
+ * import cube from '@cubejs-client/core';
+ * import 'antd/dist/antd.css';
+ *
+ * import ChartRenderer from './ChartRenderer';
+ *
+ * const cubeApi = cube('YOUR-CUBE-API-TOKEN', {
+ *   apiUrl: 'http://localhost:4000/cubejs-api/v1',
+ * });
+ *
+ * const App = () => (
+ *   <QueryBuilder
+ *     query={{
+ *       timeDimensions: [
+ *         {
+ *           dimension: 'LineItems.createdAt',
+ *           granularity: 'month',
+ *         },
+ *       ],
+ *     }}
+ *     cubeApi={cubeApi}
+ *     render={({ resultSet, measures, availableMeasures, updateMeasures }) => (
+ *       <Layout.Content style={{ padding: '20px' }}>
+ *         <Select
+ *           mode="multiple"
+ *           style={{ width: '100%' }}
+ *           placeholder="Please select"
+ *           onSelect={(measure) => updateMeasures.add(measure)}
+ *           onDeselect={(measure) => updateMeasures.remove(measure)}
+ *         >
+ *           {availableMeasures.map((measure) => (
+ *             <Select.Option key={measure.name} value={measure}>
+ *               {measure.title}
+ *             </Select.Option>
+ *           ))}
+ *         </Select>
+ *         <Divider />
+ *         {measures.length > 0 ? (
+ *           <ChartRenderer resultSet={resultSet} />
+ *         ) : (
+ *           <Empty description="Select measure or dimension to get started" />
+ *         )}
+ *       </Layout.Content>
+ *     )}
+ *   />
+ * );
+ *
+ * const rootElement = document.getElementById("root");
+ * ReactDOM.render(<App />, rootElement);
+ * ```
+ * @stickyTypes QueryBuilderProps, QueryBuilderRenderProps, QueryBuilderState
+ * @noInheritDoc
+ * @order 2
+ */
+export default class QueryBuilder extends React.Component<QueryBuilderProps, QueryBuilderInternalState> {
+    static contextType: React.Context<CubeContextProps>;
+    static defaultProps: {
+        cubeApi: null;
+        stateChangeHeuristics: null;
+        disableHeuristics: boolean;
+        render: null;
+        wrapWithQueryRenderer: boolean;
+        defaultChartType: string;
+        defaultQuery: {};
+        initialVizState: null;
+        onVizStateChanged: null;
+        query: null;
+        setQuery: null;
+        vizState: null;
+        setVizState: null;
+    };
+    static getDerivedStateFromProps(props: QueryBuilderProps, state: QueryBuilderInternalState): {
+        query: {
+            measures?: string[] | undefined;
+            dimensions?: string[] | undefined;
+            filters?: import("@cubejs-client/core").Filter[] | undefined;
+            timeDimensions?: import("@cubejs-client/core").TimeDimension[] | undefined;
+            segments?: string[] | undefined;
+            limit?: number | null | undefined;
+            rowLimit?: number | null | undefined;
+            offset?: number | undefined;
+            order?: import("@cubejs-client/core").TQueryOrderObject | import("@cubejs-client/core").TQueryOrderArray | undefined;
+            timezone?: string | undefined;
+            ungrouped?: boolean | undefined;
+            responseFormat?: "compact" | "columnar" | "default" | undefined;
+            total?: boolean | undefined;
+        };
+        pivotConfig?: PivotConfig | undefined;
+        chartType?: ChartType | undefined;
+        validatedQuery?: Query | undefined;
+        missingMembers: string[];
+        isFetchingMeta: boolean;
+        dryRunResponse?: DryRunResponse | null | undefined;
+        meta?: Meta | undefined;
+        metaError?: Error | null | undefined;
+        richMetaError?: Error | null | undefined;
+        metaErrorStack?: string | null | undefined;
+        queryError?: Error | null | undefined;
+        richQueryError?: Error | null | undefined;
+        sessionGranularity?: string | null | undefined;
+        shouldApplyHeuristicOrder?: boolean | undefined;
+    } | null;
+    static resolveMember(type: QueryMemberType, { meta, query }: ResolveMemberArgs): unknown[];
+    constructor(props: QueryBuilderProps);
+    componentDidMount(): Promise<void>;
+    componentDidUpdate(prevProps: QueryBuilderProps): Promise<void>;
+    private mutexObj;
+    private orderMembersOrderKeys;
+    private prevContext?;
+    fetchMeta: () => Promise<void>;
+    cubeApi(): CubeApi;
+    getMissingMembers(query: Query, meta?: Meta): string[];
+    isQueryPresent(): boolean;
+    prepareRenderProps(queryRendererProps?: QueryRendererRenderProps): QueryBuilderRenderProps;
+    updateQuery(queryUpdate: Query): void;
+    updateVizState(state: QueryBuilderStateUpdate): Promise<void>;
+    validatedQuery(state?: QueryBuilderStateUpdate): Query;
+    defaultHeuristics(newState: QueryBuilderStateUpdate): QueryBuilderStateUpdate;
+    applyStateChangeHeuristics(newState: QueryBuilderStateUpdate): QueryBuilderStateUpdate;
+    render(): React.ReactNode;
+}
+//# sourceMappingURL=QueryBuilder.d.ts.map

package/dist/QueryBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBuilder.d.ts","sourceRoot":"","sources":["../src/QueryBuilder.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAc1B,OAAO,KAAK,EACV,OAAO,EAEP,cAAc,EACd,IAAI,EAEJ,WAAW,EAEX,KAAK,EAQN,MAAM,qBAAqB,CAAC;AAK7B,OAAO,KAAK,EAGV,SAAS,EACT,gBAAgB,EAYhB,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EAEvB,uBAAuB,EACvB,eAAe,EACf,wBAAwB,EAExB,iBAAiB,EAMlB,MAAM,SAAS,CAAC;AAcjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,KAAK,CAAC,SAAS,CAAC,iBAAiB,EAAE,yBAAyB,CAAC;IACrG,MAAM,CAAC,WAAW,kCAAe;IAEjC,MAAM,CAAC,YAAY;;;;;;;;;;;;;;MAgBjB;IAIF,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAsB1F,MAAM,CAAC,aAAa,CAClB,IAAI,EAAE,eAAe,EACrB,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,iBAAiB,GACjC,OAAO,EAAE;gBAkCA,KAAK,EAAE,iBAAiB;IAmB9B,iBAAiB;IAKjB,kBAAkB,CAAC,SAAS,EAAE,iBAAiB;IAmCrD,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,CAAC,qBAAqB,CAAW;IAExC,OAAO,CAAC,WAAW,CAAC,CAAmB;IAEvC,SAAS,sBAmCP;IAEF,OAAO,IAAI,OAAO;IAMlB,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI;IAgB3C,cAAc;IAKd,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,wBAAwB,GAAG,uBAAuB;IAgP1F,WAAW,CAAC,WAAW,EAAE,KAAK;IAWxB,cAAc,CAAC,KAAK,EAAE,uBAAuB;IAkGnD,cAAc,CAAC,KAAK,CAAC,EAAE,uBAAuB;IAM9C,iBAAiB,CAAC,QAAQ,EAAE,uBAAuB,GAAG,uBAAuB;IAS7E,0BAA0B,CAAC,QAAQ,EAAE,uBAAuB,GAAG,uBAAuB;IAQtF,MAAM;CAyBP"}

package/dist/QueryRenderer.d.ts

@@ -0,0 +1,34 @@
+import React from 'react';
+import type { CubeApi, Query } from '@cubejs-client/core';
+import type { QueryRendererProps, QueryRendererState } from './types';
+/**
+ * `<QueryRenderer />` a react component that accepts a query, fetches the given query, and uses the render prop to render the resulting data
+ * @stickyTypes QueryRendererProps, QueryRendererRenderProps
+ * @noInheritDoc
+ */
+export default class QueryRenderer extends React.Component<QueryRendererProps, QueryRendererState> {
+    static contextType: React.Context<import("./types").CubeContextProps>;
+    static defaultProps: {
+        cubeApi: null;
+        query: null;
+        render: null;
+        queries: null;
+        loadSql: null;
+        updateOnlyOnStateChange: boolean;
+        resetResultSetOnChange: boolean;
+        cache: null;
+    };
+    static isQueryPresent(query: Query | Query[]): boolean;
+    constructor(props: QueryRendererProps);
+    componentDidMount(): void;
+    shouldComponentUpdate(nextProps: QueryRendererProps, nextState: QueryRendererState): boolean;
+    componentDidUpdate(prevProps: QueryRendererProps): void;
+    private mutexObj;
+    cubeApi(): CubeApi;
+    load(query: Query | Query[]): void;
+    loadQueries(queries?: {
+        [key: string]: Query;
+    }): void;
+    render(): React.ReactNode;
+}
+//# sourceMappingURL=QueryRenderer.d.ts.map

package/dist/QueryRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryRenderer.d.ts","sourceRoot":"","sources":["../src/QueryRenderer.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,KAAK,EAAE,OAAO,EAAqB,KAAK,EAAa,MAAM,qBAAqB,CAAC;AAGxF,OAAO,KAAK,EAGV,kBAAkB,EAElB,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAEjB;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,KAAK,CAAC,SAAS,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChG,MAAM,CAAC,WAAW,oDAAe;IAEjC,MAAM,CAAC,YAAY;;;;;;;;;MASjB;IAGF,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,EAAE;gBAIhC,KAAK,EAAE,kBAAkB;IAMrC,iBAAiB;IAUjB,qBAAqB,CAAC,SAAS,EAAE,kBAAkB,EAAE,SAAS,EAAE,kBAAkB;IAgBlF,kBAAkB,CAAC,SAAS,EAAE,kBAAkB;IAmBhD,OAAO,CAAC,QAAQ,CAAW;IAE3B,OAAO,IAAI,OAAO;IAKlB,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,EAAE;IAkD3B,WAAW,CAAC,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAA;KAAE;IA8B9C,MAAM;CAqBP"}

package/dist/QueryRendererWithTotals.d.ts

@@ -0,0 +1,4 @@
+import type { QueryRendererWithTotalsProps } from './types';
+declare const QueryRendererWithTotals: ({ query, ...restProps }: QueryRendererWithTotalsProps) => JSX.Element;
+export default QueryRendererWithTotals;
+//# sourceMappingURL=QueryRendererWithTotals.d.ts.map

package/dist/QueryRendererWithTotals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryRendererWithTotals.d.ts","sourceRoot":"","sources":["../src/QueryRendererWithTotals.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAC;AAE5D,QAAA,MAAM,uBAAuB,4BAA6B,4BAA4B,gBAerF,CAAC;AAEF,eAAe,uBAAuB,CAAC"}