@cubejs-client/core 1.3.14 → 1.3.16

package/dist/src/HttpTransport.d.ts

@@ -0,0 +1,54 @@
+import 'url-search-params-polyfill';
+export interface ErrorResponse {
+    error: string;
+}
+export type TransportOptions = {
+    /**
+     * [jwt auth token](security)
+     */
+    authorization?: string;
+    /**
+     * path to `/cubejs-api/v1`
+     */
+    apiUrl: string;
+    /**
+     * custom headers
+     */
+    headers: Record<string, string>;
+    credentials?: 'omit' | 'same-origin' | 'include';
+    method?: 'GET' | 'PUT' | 'POST' | 'PATCH';
+    /**
+     * Fetch timeout in milliseconds. Would be passed as AbortSignal.timeout()
+     */
+    fetchTimeout?: number;
+    /**
+     * AbortSignal to cancel requests
+     */
+    signal?: AbortSignal;
+};
+export interface ITransportResponse<R> {
+    subscribe: <CBResult>(cb: (result: R | ErrorResponse, resubscribe: () => Promise<CBResult>) => CBResult) => Promise<CBResult>;
+    unsubscribe?: () => Promise<void>;
+}
+export interface ITransport<R> {
+    request(method: string, params: Record<string, unknown>): ITransportResponse<R>;
+    authorization: TransportOptions['authorization'];
+}
+/**
+ * Default transport implementation.
+ */
+export declare class HttpTransport implements ITransport<Response> {
+    authorization: TransportOptions['authorization'];
+    protected apiUrl: TransportOptions['apiUrl'];
+    protected method: TransportOptions['method'];
+    protected headers: TransportOptions['headers'];
+    protected credentials: TransportOptions['credentials'];
+    protected fetchTimeout: number | undefined;
+    private readonly signal;
+    constructor({ authorization, apiUrl, method, headers, credentials, fetchTimeout, signal }: Omit<TransportOptions, 'headers'> & {
+        headers?: TransportOptions['headers'];
+    });
+    request(method: string, { baseRequestId, signal, ...params }: any): ITransportResponse<Response>;
+}
+export default HttpTransport;
+//# sourceMappingURL=HttpTransport.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"HttpTransport.d.ts","sourceRoot":"","sources":["../../src/HttpTransport.ts"],"names":[],"mappings":"AACA,OAAO,4BAA4B,CAAC;AAEpC,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC;IACjD,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC,SAAS,EAAE,CAAC,QAAQ,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,aAAa,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,QAAQ,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE9H,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAChF,aAAa,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,qBAAa,aAAc,YAAW,UAAU,CAAC,QAAQ,CAAC;IACjD,aAAa,EAAE,gBAAgB,CAAC,eAAe,CAAC,CAAC;IAExD,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAE7C,SAAS,CAAC,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IAE7C,SAAS,CAAC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE/C,SAAS,CAAC,WAAW,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAEvD,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0B;gBAE9B,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,OAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,GAAG;QAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;KAAE;IAU7K,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,GAAG,GAAG,kBAAkB,CAAC,QAAQ,CAAC;CA2CxG;AAED,eAAe,aAAa,CAAC"}

package/dist/src/HttpTransport.js

@@ -0,0 +1,55 @@
+import fetch from 'cross-fetch';
+import 'url-search-params-polyfill';
+/**
+ * Default transport implementation.
+ */
+export class HttpTransport {
+    constructor({ authorization, apiUrl, method, headers = {}, credentials, fetchTimeout, signal }) {
+        this.authorization = authorization;
+        this.apiUrl = apiUrl;
+        this.method = method;
+        this.headers = headers;
+        this.credentials = credentials;
+        this.fetchTimeout = fetchTimeout;
+        this.signal = signal;
+    }
+    request(method, { baseRequestId, signal, ...params }) {
+        let spanCounter = 1;
+        const searchParams = new URLSearchParams(params && Object.keys(params)
+            .map(k => ({ [k]: typeof params[k] === 'object' ? JSON.stringify(params[k]) : params[k] }))
+            .reduce((a, b) => ({ ...a, ...b }), {}));
+        let url = `${this.apiUrl}/${method}${searchParams.toString().length ? `?${searchParams}` : ''}`;
+        const requestMethod = this.method || (url.length < 2000 ? 'GET' : 'POST');
+        if (requestMethod === 'POST') {
+            url = `${this.apiUrl}/${method}`;
+            this.headers['Content-Type'] = 'application/json';
+        }
+        // Currently, all methods make GET requests. If a method makes a request with a body payload,
+        // remember to add {'Content-Type': 'application/json'} to the header.
+        const runRequest = () => fetch(url, {
+            method: requestMethod,
+            headers: {
+                Authorization: this.authorization,
+                'x-request-id': baseRequestId && `${baseRequestId}-span-${spanCounter++}`,
+                ...this.headers
+            },
+            credentials: this.credentials,
+            body: requestMethod === 'POST' ? JSON.stringify(params) : null,
+            signal: signal || this.signal || (this.fetchTimeout ? AbortSignal.timeout(this.fetchTimeout) : undefined),
+        });
+        return {
+            /* eslint no-unsafe-finally: off */
+            async subscribe(callback) {
+                try {
+                    const result = await runRequest();
+                    return callback(result, () => this.subscribe(callback));
+                }
+                catch (e) {
+                    const result = { error: 'network Error' };
+                    return callback(result, () => this.subscribe(callback));
+                }
+            }
+        };
+    }
+}
+export default HttpTransport;

package/dist/src/Meta.d.ts

@@ -0,0 +1,62 @@
+import { Cube, CubesMap, MemberType, MetaResponse, TCubeMeasure, TCubeDimension, TCubeMember, TCubeMemberByType, Query, FilterOperator, TCubeSegment, NotFoundMember } from './types';
+import { DeeplyReadonly } from './index';
+export interface CubeMemberWrapper<T> {
+    cubeName: string;
+    cubeTitle: string;
+    type: 'view' | 'cube';
+    public: boolean;
+    members: T[];
+}
+export type AggregatedMembers = {
+    measures: CubeMemberWrapper<TCubeMeasure>[];
+    dimensions: CubeMemberWrapper<TCubeDimension>[];
+    segments: CubeMemberWrapper<TCubeSegment>[];
+    timeDimensions: CubeMemberWrapper<TCubeDimension>[];
+};
+/**
+ * Contains information about available cubes and it's members.
+ */
+export default class Meta {
+    /**
+     * Raw meta response
+     */
+    readonly meta: MetaResponse;
+    /**
+     * An array of all available cubes with their members
+     */
+    readonly cubes: Cube[];
+    /**
+     * A map of all cubes where the key is a cube name
+     */
+    readonly cubesMap: CubesMap;
+    constructor(metaResponse: MetaResponse);
+    /**
+     * Get all members of a specific type for a given query.
+     * If empty query is provided no filtering is done based on query context and all available members are retrieved.
+     * @param _query - context query to provide filtering of members available to add to this query
+     * @param memberType
+     */
+    membersForQuery(_query: DeeplyReadonly<Query> | null, memberType: MemberType): (TCubeMeasure | TCubeDimension | TCubeMember | TCubeSegment)[];
+    membersGroupedByCube(): AggregatedMembers;
+    /**
+     * Get meta information for a cube member
+     * meta information contains:
+     * ```javascript
+     * {
+     *   name,
+     *   title,
+     *   shortTitle,
+     *   type,
+     *   description,
+     *   format
+     * }
+     * ```
+     * @param memberName - Fully qualified member name in a form `Cube.memberName`
+     * @param memberType
+     * @return An object containing meta information about member
+     */
+    resolveMember<T extends MemberType>(memberName: string, memberType: T | T[]): NotFoundMember | TCubeMemberByType<T>;
+    defaultTimeDimensionNameFor(memberName: string): string | null | undefined;
+    filterOperatorsForMember(memberName: string, memberType: MemberType | MemberType[]): FilterOperator[];
+}
+//# sourceMappingURL=Meta.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Meta.d.ts","sourceRoot":"","sources":["../../src/Meta.ts"],"names":[],"mappings":"AACA,OAAO,EACL,IAAI,EACJ,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,WAAW,EACX,iBAAiB,EACjB,KAAK,EACL,cAAc,EACd,YAAY,EACZ,cAAc,EACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,CAAC,EAAE,CAAC;CACd;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC;IAC5C,UAAU,EAAE,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC;IAChD,QAAQ,EAAE,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC;IAC5C,cAAc,EAAE,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC;CACrD,CAAC;AAyCF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACvB;;OAEG;IACH,SAAgB,IAAI,EAAE,YAAY,CAAC;IAEnC;;OAEG;IACH,SAAgB,KAAK,EAAE,IAAI,EAAE,CAAC;IAE9B;;OAEG;IACH,SAAgB,QAAQ,EAAE,QAAQ,CAAC;gBAEhB,YAAY,EAAE,YAAY;IAgB7C;;;;;OAKG;IACI,eAAe,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,UAAU,EAAE,UAAU,GAAG,CAAC,YAAY,GAAG,cAAc,GAAG,WAAW,GAAG,YAAY,CAAC,EAAE;IAK7I,oBAAoB;IA8C3B;;;;;;;;;;;;;;;;OAgBG;IACI,aAAa,CAAC,CAAC,SAAS,UAAU,EACvC,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,CAAC,GAAG,CAAC,EAAE,GAClB,cAAc,GAAG,iBAAiB,CAAC,CAAC,CAAC;IAsBjC,2BAA2B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;IAU1E,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,UAAU,EAAE,GAAG,cAAc,EAAE;CAS7G"}

package/dist/src/Meta.js

@@ -0,0 +1,150 @@
+import { unnest, fromPairs } from 'ramda';
+const memberMap = (memberArray) => fromPairs(memberArray.map((m) => [m.name, m]));
+const operators = {
+    string: [
+        { name: 'contains', title: 'contains' },
+        { name: 'notContains', title: 'does not contain' },
+        { name: 'equals', title: 'equals' },
+        { name: 'notEquals', title: 'does not equal' },
+        { name: 'set', title: 'is set' },
+        { name: 'notSet', title: 'is not set' },
+        { name: 'startsWith', title: 'starts with' },
+        { name: 'notStartsWith', title: 'does not start with' },
+        { name: 'endsWith', title: 'ends with' },
+        { name: 'notEndsWith', title: 'does not end with' },
+    ],
+    number: [
+        { name: 'equals', title: 'equals' },
+        { name: 'notEquals', title: 'does not equal' },
+        { name: 'set', title: 'is set' },
+        { name: 'notSet', title: 'is not set' },
+        { name: 'gt', title: '>' },
+        { name: 'gte', title: '>=' },
+        { name: 'lt', title: '<' },
+        { name: 'lte', title: '<=' },
+    ],
+    time: [
+        { name: 'equals', title: 'equals' },
+        { name: 'notEquals', title: 'does not equal' },
+        { name: 'inDateRange', title: 'in date range' },
+        { name: 'notInDateRange', title: 'not in date range' },
+        { name: 'afterDate', title: 'after date' },
+        { name: 'afterOrOnDate', title: 'after or on date' },
+        { name: 'beforeDate', title: 'before date' },
+        { name: 'beforeOrOnDate', title: 'before or on date' },
+    ],
+};
+/**
+ * Contains information about available cubes and it's members.
+ */
+export default class Meta {
+    constructor(metaResponse) {
+        this.meta = metaResponse;
+        const { cubes } = this.meta;
+        this.cubes = cubes;
+        this.cubesMap = fromPairs(cubes.map((c) => [
+            c.name,
+            {
+                measures: memberMap(c.measures),
+                dimensions: memberMap(c.dimensions),
+                segments: memberMap(c.segments),
+            },
+        ]));
+    }
+    /**
+     * Get all members of a specific type for a given query.
+     * If empty query is provided no filtering is done based on query context and all available members are retrieved.
+     * @param _query - context query to provide filtering of members available to add to this query
+     * @param memberType
+     */
+    membersForQuery(_query, memberType) {
+        return unnest(this.cubes.map((c) => c[memberType]))
+            .sort((a, b) => (a.title > b.title ? 1 : -1));
+    }
+    membersGroupedByCube() {
+        const memberKeys = ['measures', 'dimensions', 'segments', 'timeDimensions'];
+        return this.cubes.reduce((memo, cube) => {
+            memberKeys.forEach((key) => {
+                let members = [];
+                // eslint-disable-next-line default-case
+                switch (key) {
+                    case 'measures':
+                        members = cube.measures || [];
+                        break;
+                    case 'dimensions':
+                        members = cube.dimensions || [];
+                        break;
+                    case 'segments':
+                        members = cube.segments || [];
+                        break;
+                    case 'timeDimensions':
+                        members = cube.dimensions.filter((m) => m.type === 'time') || [];
+                        break;
+                }
+                // TODO: Convince TS this is working
+                // @ts-ignore
+                memo[key].push({
+                    cubeName: cube.name,
+                    cubeTitle: cube.title,
+                    type: cube.type,
+                    public: cube.public,
+                    members,
+                });
+            });
+            return memo;
+        }, {
+            measures: [],
+            dimensions: [],
+            segments: [],
+            timeDimensions: [],
+        });
+    }
+    /**
+     * Get meta information for a cube member
+     * meta information contains:
+     * ```javascript
+     * {
+     *   name,
+     *   title,
+     *   shortTitle,
+     *   type,
+     *   description,
+     *   format
+     * }
+     * ```
+     * @param memberName - Fully qualified member name in a form `Cube.memberName`
+     * @param memberType
+     * @return An object containing meta information about member
+     */
+    resolveMember(memberName, memberType) {
+        const [cube] = memberName.split('.');
+        if (!this.cubesMap[cube]) {
+            return { title: memberName, error: `Cube not found ${cube} for path '${memberName}'` };
+        }
+        const memberTypes = Array.isArray(memberType) ? memberType : [memberType];
+        const member = memberTypes
+            .map((type) => this.cubesMap[cube][type] && this.cubesMap[cube][type][memberName])
+            .find((m) => m);
+        if (!member) {
+            return {
+                title: memberName,
+                error: `Path not found '${memberName}'`,
+            };
+        }
+        return member;
+    }
+    defaultTimeDimensionNameFor(memberName) {
+        const [cube] = memberName.split('.');
+        if (!this.cubesMap[cube]) {
+            return null;
+        }
+        return Object.keys(this.cubesMap[cube].dimensions || {}).find((d) => this.cubesMap[cube].dimensions[d].type === 'time');
+    }
+    filterOperatorsForMember(memberName, memberType) {
+        const member = this.resolveMember(memberName, memberType);
+        if ('error' in member || !('type' in member) || member.type === 'boolean') {
+            return operators.string;
+        }
+        return operators[member.type] || operators.string;
+    }
+}

package/dist/src/ProgressResult.d.ts

@@ -0,0 +1,8 @@
+import { ProgressResponse } from './types';
+export default class ProgressResult {
+    private progressResponse;
+    constructor(progressResponse: ProgressResponse);
+    stage(): string;
+    timeElapsed(): number;
+}
+//# sourceMappingURL=ProgressResult.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ProgressResult.d.ts","sourceRoot":"","sources":["../../src/ProgressResult.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,OAAO,CAAC,gBAAgB,CAAmB;gBAExB,gBAAgB,EAAE,gBAAgB;IAI9C,KAAK,IAAI,MAAM;IAIf,WAAW,IAAI,MAAM;CAG7B"}

package/dist/src/ProgressResult.js

@@ -0,0 +1,11 @@
+export default class ProgressResult {
+    constructor(progressResponse) {
+        this.progressResponse = progressResponse;
+    }
+    stage() {
+        return this.progressResponse.stage;
+    }
+    timeElapsed() {
+        return this.progressResponse.timeElapsed;
+    }
+}

package/dist/src/RequestError.d.ts

@@ -0,0 +1,6 @@
+export default class RequestError extends Error {
+    response: any;
+    status: number;
+    constructor(message: string, response: any, status: number);
+}
+//# sourceMappingURL=RequestError.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RequestError.d.ts","sourceRoot":"","sources":["../../src/RequestError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,KAAK;IACtC,QAAQ,EAAE,GAAG,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;gBAEH,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM;CAKlE"}

package/dist/src/RequestError.js

@@ -0,0 +1,7 @@
+export default class RequestError extends Error {
+    constructor(message, response, status) {
+        super(message);
+        this.response = response;
+        this.status = status;
+    }
+}