@cubejs-client/core 1.3.14 → 1.3.16

package/dist/src/SqlQuery.d.ts

@@ -0,0 +1,17 @@
+export type SqlQueryTuple = [string, any[], any];
+export type SqlData = {
+    aliasNameToMember: Record<string, string>;
+    cacheKeyQueries: SqlQueryTuple[];
+    dataSource: boolean;
+    external: boolean;
+    sql: SqlQueryTuple;
+    preAggregations: any[];
+    rollupMatchResults: any[];
+};
+export default class SqlQuery {
+    private readonly sqlQuery;
+    constructor(sqlQuery: SqlData);
+    rawQuery(): SqlData;
+    sql(): string;
+}
+//# sourceMappingURL=SqlQuery.d.ts.map

package/dist/src/SqlQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqlQuery.d.ts","sourceRoot":"","sources":["../../src/SqlQuery.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC;AAEjD,MAAM,MAAM,OAAO,GAAG;IACpB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,eAAe,EAAE,aAAa,EAAE,CAAC;IACjC,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,aAAa,CAAC;IACnB,eAAe,EAAE,GAAG,EAAE,CAAC;IACvB,kBAAkB,EAAE,GAAG,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;gBAEhB,QAAQ,EAAE,OAAO;IAI7B,QAAQ,IAAI,OAAO;IAInB,GAAG,IAAI,MAAM;CAGrB"}

package/dist/src/SqlQuery.js

@@ -0,0 +1,11 @@
+export default class SqlQuery {
+    constructor(sqlQuery) {
+        this.sqlQuery = sqlQuery;
+    }
+    rawQuery() {
+        return this.sqlQuery;
+    }
+    sql() {
+        return this.rawQuery().sql[0];
+    }
+}

package/dist/src/index.d.ts

@@ -0,0 +1,194 @@
+import ResultSet from './ResultSet';
+import SqlQuery from './SqlQuery';
+import Meta from './Meta';
+import ProgressResult from './ProgressResult';
+import { ITransport, TransportOptions } from './HttpTransport';
+import { ExtractTimeMembers, LoadResponse, PivotQuery, Query, QueryOrder, QueryType, TransformedQuery } from './types';
+export type LoadMethodCallback<T> = (error: Error | null, resultSet: T) => void;
+export type LoadMethodOptions = {
+    /**
+     * Key to store the current request's MUTEX inside the `mutexObj`. MUTEX object is used to reject orphaned queries results when new queries are sent. For example: if two queries are sent with the same `mutexKey` only the last one will return results.
+     */
+    mutexKey?: string;
+    /**
+     * Object to store MUTEX
+     */
+    mutexObj?: {
+        [key: string]: any;
+    };
+    /**
+     * Pass `true` to use continuous fetch behavior.
+     */
+    subscribe?: boolean;
+    /**
+     * A Cube API instance. If not provided will be taken from `CubeProvider`
+     */
+    cubeApi?: CubeApi;
+    /**
+     * If enabled, all members of the 'number' type will be automatically converted to numerical values on the client side
+     */
+    castNumerics?: boolean;
+    /**
+     * Function that receives `ProgressResult` on each `Continue wait` message.
+     */
+    progressCallback?(result: ProgressResult): void;
+    /**
+     * AbortSignal to cancel requests
+     */
+    signal?: AbortSignal;
+};
+export type DeeplyReadonly<T> = {
+    readonly [K in keyof T]: DeeplyReadonly<T[K]>;
+};
+export type ExtractMembers<T extends DeeplyReadonly<Query>> = (T extends {
+    dimensions: readonly (infer Names)[];
+} ? Names : never) | (T extends {
+    measures: readonly (infer Names)[];
+} ? Names : never) | (T extends {
+    timeDimensions: (infer U);
+} ? ExtractTimeMembers<U> : never);
+export type SingleQueryRecordType<T extends DeeplyReadonly<Query>> = ExtractMembers<T> extends never ? any : {
+    [K in string & ExtractMembers<T>]: string | number | boolean | null;
+};
+export type QueryArrayRecordType<T extends DeeplyReadonly<Query[]>> = T extends readonly [infer First, ...infer Rest] ? SingleQueryRecordType<DeeplyReadonly<First>> | QueryArrayRecordType<Rest & DeeplyReadonly<Query[]>> : never;
+export type QueryRecordType<T extends DeeplyReadonly<Query | Query[]>> = T extends DeeplyReadonly<Query[]> ? QueryArrayRecordType<T> : T extends DeeplyReadonly<Query> ? SingleQueryRecordType<T> : never;
+export interface UnsubscribeObj {
+    /**
+     * Allows to stop requests in-flight in long polling or web socket subscribe loops.
+     * It doesn't cancel any submitted requests to the underlying databases.
+     */
+    unsubscribe(): Promise<void>;
+}
+/**
+ * @deprecated use DryRunResponse
+ */
+export type TDryRunResponse = {
+    queryType: QueryType;
+    normalizedQueries: Query[];
+    pivotQuery: PivotQuery;
+    queryOrder: Array<{
+        [k: string]: QueryOrder;
+    }>;
+    transformedQueries: TransformedQuery[];
+};
+export type DryRunResponse = {
+    queryType: QueryType;
+    normalizedQueries: Query[];
+    pivotQuery: PivotQuery;
+    queryOrder: Array<{
+        [k: string]: QueryOrder;
+    }>;
+    transformedQueries: TransformedQuery[];
+};
+export type ResponseFormat = 'compact' | 'default' | undefined;
+export type CubeApiOptions = {
+    /**
+     * URL of your Cube.js Backend. By default, in the development environment it is `http://localhost:4000/cubejs-api/v1`
+     */
+    apiUrl: string;
+    /**
+     * Transport implementation to use. [HttpTransport](#http-transport) will be used by default.
+     */
+    transport?: ITransport<any>;
+    method?: TransportOptions['method'];
+    headers?: TransportOptions['headers'];
+    pollInterval?: number;
+    credentials?: TransportOptions['credentials'];
+    parseDateMeasures?: boolean;
+    resType?: 'default' | 'compact';
+    castNumerics?: boolean;
+    /**
+     * How many network errors would be retried before returning to users. Default to 0.
+     */
+    networkErrorRetries?: number;
+    /**
+     * AbortSignal to cancel requests
+     */
+    signal?: AbortSignal;
+    /**
+     * Fetch timeout in milliseconds. Would be passed as AbortSignal.timeout()
+     */
+    fetchTimeout?: number;
+};
+/**
+ * Main class for accessing Cube API
+ */
+declare class CubeApi {
+    private readonly apiToken;
+    private readonly apiUrl;
+    private readonly method;
+    private readonly headers;
+    private readonly credentials;
+    protected readonly transport: ITransport<any>;
+    private readonly pollInterval;
+    private readonly parseDateMeasures;
+    private readonly castNumerics;
+    private readonly networkErrorRetries;
+    private updateAuthorizationPromise;
+    constructor(apiToken: string | (() => Promise<string>) | undefined, options: CubeApiOptions);
+    constructor(options: CubeApiOptions);
+    protected request(method: string, params?: any): import("./HttpTransport").ITransportResponse<any>;
+    private loadMethod;
+    private updateTransportAuthorization;
+    /**
+     * Add system properties to a query object.
+     */
+    private patchQueryInternal;
+    /**
+     * Process result fetched from the gateway#load method according
+     * to the network protocol.
+     */
+    protected loadResponseInternal(response: LoadResponse<any>, options?: LoadMethodOptions | null): ResultSet<any>;
+    load<QueryType extends DeeplyReadonly<Query | Query[]>>(query: QueryType, options?: LoadMethodOptions): Promise<ResultSet<QueryRecordType<QueryType>>>;
+    load<QueryType extends DeeplyReadonly<Query | Query[]>>(query: QueryType, options?: LoadMethodOptions, callback?: LoadMethodCallback<ResultSet<QueryRecordType<QueryType>>>): UnsubscribeObj;
+    load<QueryType extends DeeplyReadonly<Query | Query[]>>(query: QueryType, options?: LoadMethodOptions, callback?: LoadMethodCallback<ResultSet<any>>, responseFormat?: string): Promise<ResultSet<QueryRecordType<QueryType>>>;
+    private prepareQueryOptions;
+    /**
+     * Allows you to fetch data and receive updates over time. See [Real-Time Data Fetch](/product/apis-integrations/rest-api/real-time-data-fetch)
+     *
+     * ```js
+     * // Subscribe to a query's updates
+     * const subscription = await cubeApi.subscribe(
+     *   {
+     *     measures: ['Logs.count'],
+     *     timeDimensions: [
+     *       {
+     *         dimension: 'Logs.time',
+     *         granularity: 'hour',
+     *         dateRange: 'last 1440 minutes',
+     *       },
+     *     ],
+     *   },
+     *   options,
+     *   (error, resultSet) => {
+     *     if (!error) {
+     *       // handle the update
+     *     }
+     *   }
+     * );
+     *
+     * // Unsubscribe from a query's updates
+     * subscription.unsubscribe();
+     * ```
+     */
+    subscribe<QueryType extends DeeplyReadonly<Query | Query[]>>(query: QueryType, options: LoadMethodOptions | null, callback: LoadMethodCallback<ResultSet<QueryRecordType<QueryType>>>, responseFormat?: ResponseFormat): UnsubscribeObj;
+    sql(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions): Promise<SqlQuery>;
+    sql(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions, callback?: LoadMethodCallback<SqlQuery>): UnsubscribeObj;
+    meta(options?: LoadMethodOptions): Promise<Meta>;
+    meta(options?: LoadMethodOptions, callback?: LoadMethodCallback<Meta>): UnsubscribeObj;
+    dryRun(query: DeeplyReadonly<Query | Query[]>, options?: LoadMethodOptions): Promise<DryRunResponse>;
+    dryRun(query: DeeplyReadonly<Query | Query[]>, options: LoadMethodOptions, callback?: LoadMethodCallback<DryRunResponse>): UnsubscribeObj;
+}
+declare const _default: (apiToken: string | (() => Promise<string>), options: CubeApiOptions) => CubeApi;
+export default _default;
+export { CubeApi };
+export { default as Meta } from './Meta';
+export { default as SqlQuery } from './SqlQuery';
+export { default as RequestError } from './RequestError';
+export { default as ProgressResult } from './ProgressResult';
+export { default as ResultSet } from './ResultSet';
+export * from './HttpTransport';
+export * from './utils';
+export * from './time';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC1B,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAsB,EAAiB,UAAU,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAE7F,OAAO,EACL,kBAAkB,EAClB,YAAY,EAEZ,UAAU,EAEV,KAAK,EACL,UAAU,EACV,SAAS,EACT,gBAAgB,EACjB,MAAM,SAAS,CAAC;AAEjB,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,IAAI,CAAC;AAEhF,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAClC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IAEH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,gBAAgB,CAAC,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAAC;IAChD;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAC9B,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,cAAc,CAAC,KAAK,CAAC,IACtD,CAAC,CAAC,SAAS;IAAE,UAAU,EAAE,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;CAAE,GAAG,KAAK,GAAG,KAAK,CAAC,GACrE,CAAC,CAAC,SAAS;IAAE,QAAQ,EAAE,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;CAAE,GAAG,KAAK,GAAG,KAAK,CAAC,GACnE,CAAC,CAAC,SAAS;IAAE,cAAc,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;CAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AAG/E,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,cAAc,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,SAAS,KAAK,GAChG,GAAG,GACH;KAAG,CAAC,IAAI,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI;CAAE,CAAC;AAE5E,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,cAAc,CAAC,KAAK,EAAE,CAAC,IAChE,CAAC,SAAS,SAAS,CAAC,MAAM,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,GAC3C,qBAAqB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,GAAG,oBAAoB,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,GACnG,KAAK,CAAC;AAEZ,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,IACnE,CAAC,SAAS,cAAc,CAAC,KAAK,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,GACzD,CAAC,SAAS,cAAc,CAAC,KAAK,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,GACxD,KAAK,CAAC;AAEZ,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,EAAE,SAAS,CAAC;IACrB,iBAAiB,EAAE,KAAK,EAAE,CAAC;IAC3B,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,KAAK,CAAC;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAC,CAAC;IAC/C,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,SAAS,CAAC;IACrB,iBAAiB,EAAE,KAAK,EAAE,CAAC;IAC3B,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,KAAK,CAAC;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAC,CAAC;IAC/C,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;CACxC,CAAC;AAqBF,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAC;AAE/D,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;IAC5B,MAAM,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACpC,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC9C,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,OAAO,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAChC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,cAAM,OAAO;IACX,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA0E;IAEnG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6B;IAEpD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA8B;IAEtD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAkC;IAE9D,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAsB;IAExD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAU;IAEvC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;IAE7C,OAAO,CAAC,0BAA0B,CAAsB;gBAErC,QAAQ,EAAE,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,cAAc;gBAE/E,OAAO,EAAE,cAAc;IA4D1C,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG;IAO9C,OAAO,CAAC,UAAU;YAgJJ,4BAA4B;IA0B1C;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;;OAGG;IACH,SAAS,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,OAAO,GAAE,iBAAiB,GAAG,IAAS,GAAG,SAAS,CAAC,GAAG,CAAC;IAkD5G,IAAI,CAAC,SAAS,SAAS,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,EAC3D,KAAK,EAAE,SAAS,EAChB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1C,IAAI,CAAC,SAAS,SAAS,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,EAC3D,KAAK,EAAE,SAAS,EAChB,OAAO,CAAC,EAAE,iBAAiB,EAC3B,QAAQ,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,GACnE,cAAc;IAEV,IAAI,CAAC,SAAS,SAAS,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,EAC3D,KAAK,EAAE,SAAS,EAChB,OAAO,CAAC,EAAE,iBAAiB,EAC3B,QAAQ,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAC7C,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IA2CjD,OAAO,CAAC,mBAAmB;IAmB3B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,SAAS,CAAC,SAAS,SAAS,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,EAChE,KAAK,EAAE,SAAS,EAChB,OAAO,EAAE,iBAAiB,GAAG,IAAI,EACjC,QAAQ,EAAE,kBAAkB,CAAC,SAAS,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC,EACnE,cAAc,GAAE,cAA0B,GACzC,cAAc;IAcV,GAAG,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAE3F,GAAG,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,GAAG,cAAc;IAiBjI,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhD,IAAI,CAAC,OAAO,CAAC,EAAE,iBAAiB,EAAE,QAAQ,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC,GAAG,cAAc;IAgBtF,MAAM,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,CAAC;IAEpG,MAAM,CAAC,KAAK,EAAE,cAAc,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,EAAE,kBAAkB,CAAC,cAAc,CAAC,GAAG,cAAc;CAgBjJ;mCAEyB,MAAM,GAAG,CAAC,MAAM,QAAQ,MAAM,CAAC,CAAC,WAAW,cAAc;AAAnF,wBAAuH;AAEvH,OAAO,EAAE,OAAO,EAAE,CAAC;AACnB,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,MAAM,QAAQ,CAAC;AACzC,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,411 @@
+import { v4 as uuidv4 } from 'uuid';
+import ResultSet from './ResultSet';
+import SqlQuery from './SqlQuery';
+import Meta from './Meta';
+import ProgressResult from './ProgressResult';
+import HttpTransport from './HttpTransport';
+import RequestError from './RequestError';
+let mutexCounter = 0;
+const MUTEX_ERROR = 'Mutex has been changed';
+function mutexPromise(promise) {
+    return promise
+        .then((result) => result)
+        .catch((error) => {
+        if (error !== MUTEX_ERROR) {
+            throw error;
+        }
+    });
+}
+/**
+ * Main class for accessing Cube API
+ */
+class CubeApi {
+    /**
+     * Creates an instance of the `CubeApi`. The API entry point.
+     *
+     * ```js
+     * import cube from '@cubejs-client/core';
+     * const cubeApi = cube(
+     *   'CUBE-API-TOKEN',
+     *   { apiUrl: 'http://localhost:4000/cubejs-api/v1' }
+     * );
+     * ```
+     *
+     * You can also pass an async function or a promise that will resolve to the API token
+     *
+     * ```js
+     * import cube from '@cubejs-client/core';
+     * const cubeApi = cube(
+     *   async () => await Auth.getJwtToken(),
+     *   { apiUrl: 'http://localhost:4000/cubejs-api/v1' }
+     * );
+     * ```
+     */
+    constructor(apiToken, options) {
+        if (apiToken && !Array.isArray(apiToken) && typeof apiToken === 'object') {
+            options = apiToken;
+            apiToken = undefined;
+        }
+        if (!options || (!options.transport && !options.apiUrl)) {
+            throw new Error('The `apiUrl` option is required');
+        }
+        this.apiToken = apiToken;
+        this.apiUrl = options.apiUrl;
+        this.method = options.method;
+        this.headers = options.headers || {};
+        this.credentials = options.credentials;
+        this.transport = options.transport || new HttpTransport({
+            authorization: typeof apiToken === 'string' ? apiToken : undefined,
+            apiUrl: this.apiUrl,
+            method: this.method,
+            headers: this.headers,
+            credentials: this.credentials,
+            fetchTimeout: options.fetchTimeout,
+            signal: options.signal
+        });
+        this.pollInterval = options.pollInterval || 5;
+        this.parseDateMeasures = options.parseDateMeasures;
+        this.castNumerics = typeof options.castNumerics === 'boolean' ? options.castNumerics : false;
+        this.networkErrorRetries = options.networkErrorRetries || 0;
+        this.updateAuthorizationPromise = null;
+    }
+    request(method, params) {
+        return this.transport.request(method, {
+            baseRequestId: uuidv4(),
+            ...params
+        });
+    }
+    loadMethod(request, toResult, options, callback) {
+        const mutexValue = ++mutexCounter;
+        if (typeof options === 'function' && !callback) {
+            callback = options;
+            options = undefined;
+        }
+        options = options || {};
+        const mutexKey = options.mutexKey || 'default';
+        if (options.mutexObj) {
+            options.mutexObj[mutexKey] = mutexValue;
+        }
+        const requestPromise = this
+            .updateTransportAuthorization()
+            .then(() => request());
+        let skipAuthorizationUpdate = true;
+        let unsubscribed = false;
+        const checkMutex = async () => {
+            const requestInstance = await requestPromise;
+            if (options &&
+                options.mutexObj &&
+                options.mutexObj[mutexKey] !== mutexValue) {
+                unsubscribed = true;
+                if (requestInstance.unsubscribe) {
+                    await requestInstance.unsubscribe();
+                }
+                throw MUTEX_ERROR;
+            }
+        };
+        let networkRetries = this.networkErrorRetries;
+        const loadImpl = async (response, next) => {
+            const requestInstance = await requestPromise;
+            const subscribeNext = async () => {
+                if (options?.subscribe && !unsubscribed) {
+                    if (requestInstance.unsubscribe) {
+                        return next();
+                    }
+                    else {
+                        await new Promise(resolve => setTimeout(() => resolve(), this.pollInterval * 1000));
+                        return next();
+                    }
+                }
+                return null;
+            };
+            const continueWait = async (wait = false) => {
+                if (!unsubscribed) {
+                    if (wait) {
+                        await new Promise(resolve => setTimeout(() => resolve(), this.pollInterval * 1000));
+                    }
+                    return next();
+                }
+                return null;
+            };
+            if (options?.subscribe && !skipAuthorizationUpdate) {
+                await this.updateTransportAuthorization();
+            }
+            skipAuthorizationUpdate = false;
+            if (('status' in response && response.status === 502) ||
+                ('error' in response && response.error?.toLowerCase() === 'network error') &&
+                    --networkRetries >= 0) {
+                await checkMutex();
+                return continueWait(true);
+            }
+            // From here we're sure that response is only fetch Response
+            response = response;
+            let body = {};
+            let text = '';
+            try {
+                text = await response.text();
+                body = JSON.parse(text);
+            }
+            catch (_) {
+                body.error = text;
+            }
+            if (body.error === 'Continue wait') {
+                await checkMutex();
+                if (options?.progressCallback) {
+                    options.progressCallback(new ProgressResult(body));
+                }
+                return continueWait();
+            }
+            if (response.status !== 200) {
+                await checkMutex();
+                if (!options?.subscribe && requestInstance.unsubscribe) {
+                    await requestInstance.unsubscribe();
+                }
+                const error = new RequestError(body.error || '', body, response.status);
+                if (callback) {
+                    callback(error);
+                }
+                else {
+                    throw error;
+                }
+                return subscribeNext();
+            }
+            await checkMutex();
+            if (!options?.subscribe && requestInstance.unsubscribe) {
+                await requestInstance.unsubscribe();
+            }
+            const result = toResult(body);
+            if (callback) {
+                callback(null, result);
+            }
+            else {
+                return result;
+            }
+            return subscribeNext();
+        };
+        const promise = requestPromise.then(requestInstance => mutexPromise(requestInstance.subscribe(loadImpl)));
+        if (callback) {
+            return {
+                unsubscribe: async () => {
+                    const requestInstance = await requestPromise;
+                    unsubscribed = true;
+                    if (requestInstance.unsubscribe) {
+                        return requestInstance.unsubscribe();
+                    }
+                    return null;
+                }
+            };
+        }
+        else {
+            return promise;
+        }
+    }
+    async updateTransportAuthorization() {
+        if (this.updateAuthorizationPromise) {
+            await this.updateAuthorizationPromise;
+            return;
+        }
+        const tokenFetcher = this.apiToken;
+        if (typeof tokenFetcher === 'function') {
+            const promise = (async () => {
+                try {
+                    const token = await tokenFetcher();
+                    if (this.transport.authorization !== token) {
+                        this.transport.authorization = token;
+                    }
+                }
+                finally {
+                    this.updateAuthorizationPromise = null;
+                }
+            })();
+            this.updateAuthorizationPromise = promise;
+            await promise;
+        }
+    }
+    /**
+     * Add system properties to a query object.
+     */
+    patchQueryInternal(query, responseFormat) {
+        if (responseFormat === 'compact' &&
+            query.responseFormat !== 'compact') {
+            return {
+                ...query,
+                responseFormat: 'compact',
+            };
+        }
+        else {
+            return query;
+        }
+    }
+    /**
+     * Process result fetched from the gateway#load method according
+     * to the network protocol.
+     */
+    loadResponseInternal(response, options = {}) {
+        if (response.results.length) {
+            if (options?.castNumerics) {
+                response.results.forEach((result) => {
+                    const numericMembers = Object.entries({
+                        ...result.annotation.measures,
+                        ...result.annotation.dimensions,
+                    }).reduce((acc, [k, v]) => {
+                        if (v.type === 'number') {
+                            acc.push(k);
+                        }
+                        return acc;
+                    }, []);
+                    result.data = result.data.map((row) => {
+                        numericMembers.forEach((key) => {
+                            if (row[key] != null) {
+                                row[key] = Number(row[key]);
+                            }
+                        });
+                        return row;
+                    });
+                });
+            }
+            if (response.results[0].query.responseFormat &&
+                response.results[0].query.responseFormat === 'compact') {
+                response.results.forEach((result, j) => {
+                    const data = [];
+                    const { dataset, members } = result.data;
+                    dataset.forEach((r) => {
+                        const row = {};
+                        members.forEach((m, i) => {
+                            row[m] = r[i];
+                        });
+                        data.push(row);
+                    });
+                    response.results[j].data = data;
+                });
+            }
+        }
+        return new ResultSet(response, {
+            parseDateMeasures: this.parseDateMeasures
+        });
+    }
+    /**
+     * Fetch data for the passed `query`.
+     *
+     * ```js
+     * import cube from '@cubejs-client/core';
+     * import Chart from 'chart.js';
+     * import chartjsConfig from './toChartjsData';
+     *
+     * const cubeApi = cube('CUBEJS_TOKEN');
+     *
+     * const resultSet = await cubeApi.load({
+     *  measures: ['Stories.count'],
+     *  timeDimensions: [{
+     *    dimension: 'Stories.time',
+     *    dateRange: ['2015-01-01', '2015-12-31'],
+     *    granularity: 'month'
+     *   }]
+     * });
+     *
+     * const context = document.getElementById('myChart');
+     * new Chart(context, chartjsConfig(resultSet));
+     * ```
+     * @param query - [Query object](/product/apis-integrations/rest-api/query-format)
+     * @param options
+     * @param callback
+     * @param responseFormat
+     */
+    load(query, options, callback, responseFormat = 'default') {
+        [query, options] = this.prepareQueryOptions(query, options, responseFormat);
+        return this.loadMethod(() => this.request('load', {
+            query,
+            queryType: 'multi',
+            signal: options?.signal
+        }), (response) => this.loadResponseInternal(response, options), options, callback);
+    }
+    prepareQueryOptions(query, options, responseFormat = 'default') {
+        options = {
+            castNumerics: this.castNumerics,
+            ...options
+        };
+        if (responseFormat === 'compact') {
+            if (Array.isArray(query)) {
+                const patched = query.map((q) => this.patchQueryInternal(q, 'compact'));
+                return [patched, options];
+            }
+            else {
+                const patched = this.patchQueryInternal(query, 'compact');
+                return [patched, options];
+            }
+        }
+        return [query, options];
+    }
+    /**
+     * Allows you to fetch data and receive updates over time. See [Real-Time Data Fetch](/product/apis-integrations/rest-api/real-time-data-fetch)
+     *
+     * ```js
+     * // Subscribe to a query's updates
+     * const subscription = await cubeApi.subscribe(
+     *   {
+     *     measures: ['Logs.count'],
+     *     timeDimensions: [
+     *       {
+     *         dimension: 'Logs.time',
+     *         granularity: 'hour',
+     *         dateRange: 'last 1440 minutes',
+     *       },
+     *     ],
+     *   },
+     *   options,
+     *   (error, resultSet) => {
+     *     if (!error) {
+     *       // handle the update
+     *     }
+     *   }
+     * );
+     *
+     * // Unsubscribe from a query's updates
+     * subscription.unsubscribe();
+     * ```
+     */
+    subscribe(query, options, callback, responseFormat = 'default') {
+        [query, options] = this.prepareQueryOptions(query, options, responseFormat);
+        return this.loadMethod(() => this.request('subscribe', {
+            query,
+            queryType: 'multi',
+            signal: options?.signal
+        }), (response) => this.loadResponseInternal(response, options), { ...options, subscribe: true }, callback);
+    }
+    /**
+     * Get generated SQL string for the given `query`.
+     */
+    sql(query, options, callback) {
+        return this.loadMethod(() => this.request('sql', {
+            query,
+            signal: options?.signal
+        }), (response) => (Array.isArray(response) ? response.map((body) => new SqlQuery(body)) : new SqlQuery(response)), options, callback);
+    }
+    /**
+     * Get meta description of cubes available for querying.
+     */
+    meta(options, callback) {
+        return this.loadMethod(() => this.request('meta', {
+            signal: options?.signal
+        }), (body) => new Meta(body), options, callback);
+    }
+    /**
+     * Get query related meta without query execution
+     */
+    dryRun(query, options, callback) {
+        return this.loadMethod(() => this.request('dry-run', {
+            query,
+            signal: options?.signal
+        }), (response) => response, options, callback);
+    }
+}
+export default (apiToken, options) => new CubeApi(apiToken, options);
+export { CubeApi };
+export { default as Meta } from './Meta';
+export { default as SqlQuery } from './SqlQuery';
+export { default as RequestError } from './RequestError';
+export { default as ProgressResult } from './ProgressResult';
+export { default as ResultSet } from './ResultSet';
+export * from './HttpTransport';
+export * from './utils';
+export * from './time';
+export * from './types';

package/dist/src/index.umd.d.ts

@@ -0,0 +1,3 @@
+declare const cubeAll: any;
+export default cubeAll;
+//# sourceMappingURL=index.umd.d.ts.map

package/dist/src/index.umd.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.d.ts","sourceRoot":"","sources":["../../src/index.umd.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,OAAO,EAAE,GAAU,CAAC;AAM1B,eAAe,OAAO,CAAC"}

package/dist/src/index.umd.js

@@ -0,0 +1,6 @@
+import cube, * as clientCoreExports from './index';
+const cubeAll = cube;
+Object.keys(clientCoreExports).forEach((key) => {
+    cubeAll[key] = clientCoreExports[key];
+});
+export default cubeAll;