@vizzly/api-client 0.0.1

package/README.md

@@ -0,0 +1 @@
+# Vizzly API client

package/dist/errors/DashboardQuotaReached.d.ts

@@ -0,0 +1,3 @@
+export declare class DashboardQuotaReached extends Error {
+    constructor(message: string);
+}

package/dist/errors/DashboardQuotaReached.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashboardQuotaReached = void 0;
+class DashboardQuotaReached extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'DashboardQuotaReached';
+    }
+}
+exports.DashboardQuotaReached = DashboardQuotaReached;

package/dist/errors/FailedToCreateDashboard.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToCreateDashboard extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToCreateDashboard.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToCreateDashboard = void 0;
+class FailedToCreateDashboard extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToCreateDashboard';
+    }
+}
+exports.FailedToCreateDashboard = FailedToCreateDashboard;

package/dist/errors/FailedToFetchDashboardAccessTokens.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToFetchDashboardAccessTokens extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToFetchDashboardAccessTokens.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToFetchDashboardAccessTokens = void 0;
+class FailedToFetchDashboardAccessTokens extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToFetchDashboardAccessTokens';
+    }
+}
+exports.FailedToFetchDashboardAccessTokens = FailedToFetchDashboardAccessTokens;

package/dist/errors/FailedToFetchDashboards.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToFetchDashboards extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToFetchDashboards.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToFetchDashboards = void 0;
+class FailedToFetchDashboards extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToFetchDashboards';
+    }
+}
+exports.FailedToFetchDashboards = FailedToFetchDashboards;

package/dist/errors/FailedToFetchGlobalLibraries.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToFetchGlobalLibraries extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToFetchGlobalLibraries.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToFetchGlobalLibraries = void 0;
+class FailedToFetchGlobalLibraries extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToFetchGlobalLibraries';
+    }
+}
+exports.FailedToFetchGlobalLibraries = FailedToFetchGlobalLibraries;

package/dist/errors/FailedToFetchGlobalLibraryAccessTokens.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToFetchGlobalLibraryAccessTokens extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToFetchGlobalLibraryAccessTokens.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToFetchGlobalLibraryAccessTokens = void 0;
+class FailedToFetchGlobalLibraryAccessTokens extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToFetchGlobalLibraryAccessTokens';
+    }
+}
+exports.FailedToFetchGlobalLibraryAccessTokens = FailedToFetchGlobalLibraryAccessTokens;

package/dist/errors/FailedToResolveDataSets.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToResolveDataSets extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToResolveDataSets.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToResolveDataSets = void 0;
+class FailedToResolveDataSets extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToResolveDataSets';
+    }
+}
+exports.FailedToResolveDataSets = FailedToResolveDataSets;

package/dist/errors/FailedToSetupProject.d.ts

@@ -0,0 +1,3 @@
+export declare class FailedToSetupProject extends Error {
+    constructor(message: string);
+}

package/dist/errors/FailedToSetupProject.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedToSetupProject = void 0;
+class FailedToSetupProject extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'FailedToSetupProject';
+    }
+}
+exports.FailedToSetupProject = FailedToSetupProject;

package/dist/errors/MissingAuthParameter.d.ts

@@ -0,0 +1,4 @@
+import { AuthParams } from '../types';
+export declare class MissingAuthParameter extends Error {
+    constructor(missingParameter: keyof AuthParams);
+}

package/dist/errors/MissingAuthParameter.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MissingAuthParameter = void 0;
+class MissingAuthParameter extends Error {
+    constructor(missingParameter) {
+        super(`Missing required auth parameter ${missingParameter}`);
+    }
+}
+exports.MissingAuthParameter = MissingAuthParameter;

package/dist/errors/MissingRequiredVizzlyQueryEngineApi.d.ts

@@ -0,0 +1,2 @@
+export declare class MissingRequiredVizzlyQueryEngineApi extends Error {
+}

package/dist/errors/MissingRequiredVizzlyQueryEngineApi.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MissingRequiredVizzlyQueryEngineApi = void 0;
+class MissingRequiredVizzlyQueryEngineApi extends Error {
+}
+exports.MissingRequiredVizzlyQueryEngineApi = MissingRequiredVizzlyQueryEngineApi;

package/dist/errors/SQLPreviewError.d.ts

@@ -0,0 +1,4 @@
+import { ValidationError } from './ValidationError';
+export declare class SQLPreviewError extends ValidationError {
+    constructor(message: string);
+}

package/dist/errors/SQLPreviewError.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQLPreviewError = void 0;
+const ValidationError_1 = require("./ValidationError");
+class SQLPreviewError extends ValidationError_1.ValidationError {
+    constructor(message) {
+        super(message);
+        this.name = 'SQLPreviewError';
+    }
+}
+exports.SQLPreviewError = SQLPreviewError;

package/dist/errors/ValidationError.d.ts

@@ -0,0 +1,3 @@
+export declare class ValidationError extends Error {
+    constructor(message: string);
+}

package/dist/errors/ValidationError.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationError = void 0;
+class ValidationError extends Error {
+    constructor(message) {
+        super(message); // (1)
+        this.name = 'ValidationError'; // (2)
+    }
+}
+exports.ValidationError = ValidationError;

package/dist/errors/index.d.ts

@@ -0,0 +1,10 @@
+export * from './DashboardQuotaReached';
+export * from './FailedToCreateDashboard';
+export * from './FailedToFetchDashboardAccessTokens';
+export * from './FailedToFetchDashboards';
+export * from './MissingAuthParameter';
+export * from './MissingRequiredVizzlyQueryEngineApi';
+export * from './ValidationError';
+export * from './SQLPreviewError';
+export * from './FailedToSetupProject';
+export * from './FailedToResolveDataSets';

package/dist/errors/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./DashboardQuotaReached"), exports);
+__exportStar(require("./FailedToCreateDashboard"), exports);
+__exportStar(require("./FailedToFetchDashboardAccessTokens"), exports);
+__exportStar(require("./FailedToFetchDashboards"), exports);
+__exportStar(require("./MissingAuthParameter"), exports);
+__exportStar(require("./MissingRequiredVizzlyQueryEngineApi"), exports);
+__exportStar(require("./ValidationError"), exports);
+__exportStar(require("./SQLPreviewError"), exports);
+__exportStar(require("./FailedToSetupProject"), exports);
+__exportStar(require("./FailedToResolveDataSets"), exports);

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './models/Vizzly';
+export * from './models/VizzlyApi';
+export * from './models/VizzlyAppApi';
+export * from './models/VizzlyQueryEngineApi';
+export * from './models/Authentication';
+export * from './models/ImplementationStrategy';
+export * from './types';
+export * as Errors from './errors';

package/dist/index.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Errors = void 0;
+__exportStar(require("./models/Vizzly"), exports);
+__exportStar(require("./models/VizzlyApi"), exports);
+__exportStar(require("./models/VizzlyAppApi"), exports);
+__exportStar(require("./models/VizzlyQueryEngineApi"), exports);
+__exportStar(require("./models/Authentication"), exports);
+__exportStar(require("./models/ImplementationStrategy"), exports);
+__exportStar(require("./types"), exports);
+exports.Errors = __importStar(require("./errors"));

package/dist/interfaces/iSerialize.d.ts

@@ -0,0 +1,10 @@
+interface iSerialize<DumpedType, LoadedType> {
+    /** Converts attributes from a previously saved version to the latest version. */
+    upcast(dumped: unknown): LoadedType;
+    /** Load JSON into the instance */
+    deserialize(dumped: DumpedType): LoadedType;
+    /** Output JSON that can be saved */
+    serialize(loaded: LoadedType): DumpedType;
+    /** Throws if the loaded type is not valid */
+    validate(loaded: LoadedType): void;
+}

package/dist/interfaces/iSerialize.js

@@ -0,0 +1 @@
+"use strict";

package/dist/models/Api.d.ts

@@ -0,0 +1,9 @@
+import { Authentication } from './Authentication';
+import { Request, Response } from '../types';
+export declare class Api {
+    private host;
+    private extraHeaders;
+    protected auth: Authentication;
+    constructor(auth: Authentication, host: string, extraHeaders?: () => {});
+    execute<ResponseBody>(request: Request<any>): Promise<Response<ResponseBody>>;
+}

package/dist/models/Api.js

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Api = void 0;
+const isomorphic_fetch_1 = __importDefault(require("isomorphic-fetch"));
+class Api {
+    constructor(auth, host, extraHeaders = () => ({})) {
+        this.host = host;
+        this.extraHeaders = extraHeaders;
+        this.auth = auth;
+    }
+    execute(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const authHeaders = this.auth.buildAuthHeaders();
+            const customHeaders = Object.assign(Object.assign({}, (request.headers || {})), (this.extraHeaders() || {}));
+            const path = `${this.host}${request.path}`;
+            console.debug(`[REQUEST] ${path}`);
+            const res = yield (0, isomorphic_fetch_1.default)(path, {
+                method: request.method,
+                headers: Object.assign(Object.assign({ 'Content-Type': 'application/json', Accept: 'application/json' }, authHeaders), customHeaders),
+                redirect: 'follow',
+                referrerPolicy: 'no-referrer',
+                body: request.body ? JSON.stringify(request.body) : null,
+                signal: request.abortSignal,
+            });
+            let body = ((_a = res.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.includes('json')) ? yield res.json() : res.text();
+            const debugRequestId = res.headers.get('vizzly-query-engine-request-id') || res.headers.get('x-request-id');
+            if (debugRequestId && res.status != 200) {
+                console.debug(`[Vizzly Query Engine Request Id] ${debugRequestId}`);
+            }
+            return { body: body, status: res.status, headers: res.headers };
+        });
+    }
+}
+exports.Api = Api;

package/dist/models/Authentication.d.ts

@@ -0,0 +1,16 @@
+import { AuthParams } from '../types';
+export declare class Authentication {
+    private authParams;
+    constructor(authParams: AuthParams);
+    updateAuthParams(authParams: Partial<AuthParams>): void;
+    getQueryEngineAccessToken(): string;
+    getProjectAdminOverrideToken(): string | undefined;
+    getDashboardAccessToken(): string;
+    getAppSessionToken(): string | undefined;
+    getDataAccessToken(): string;
+    getProjectApiKey(): string;
+    getProjectAccessToken(): string;
+    buildAuthHeaders(): {
+        [key: string]: string;
+    };
+}

package/dist/models/Authentication.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Authentication = void 0;
+const MissingAuthParameter_1 = require("../errors/MissingAuthParameter");
+class Authentication {
+    constructor(authParams) {
+        this.authParams = authParams;
+    }
+    updateAuthParams(authParams) {
+        this.authParams = Object.assign(Object.assign({}, this.authParams), authParams);
+    }
+    getQueryEngineAccessToken() {
+        if (!this.authParams.queryEngineAccessToken)
+            throw new MissingAuthParameter_1.MissingAuthParameter('queryEngineAccessToken');
+        return this.authParams.queryEngineAccessToken;
+    }
+    getProjectAdminOverrideToken() {
+        return this.authParams.projectAdminOverrideToken;
+    }
+    getDashboardAccessToken() {
+        if (!this.authParams.dashboardAccessToken)
+            throw new MissingAuthParameter_1.MissingAuthParameter('dashboardAccessToken');
+        return this.authParams.dashboardAccessToken;
+    }
+    getAppSessionToken() {
+        return this.authParams.appSessionToken;
+    }
+    getDataAccessToken() {
+        if (!this.authParams.dataAccessToken)
+            throw new MissingAuthParameter_1.MissingAuthParameter('dataAccessToken');
+        return this.authParams.dataAccessToken;
+    }
+    getProjectApiKey() {
+        if (!this.authParams.projectApiKey)
+            throw new MissingAuthParameter_1.MissingAuthParameter('projectApiKey');
+        return this.authParams.projectApiKey;
+    }
+    getProjectAccessToken() {
+        if (!this.authParams.projectAccessToken)
+            throw new MissingAuthParameter_1.MissingAuthParameter('projectAccessToken');
+        return this.authParams.projectAccessToken;
+    }
+    buildAuthHeaders() {
+        if (this.authParams.dashboardAccessToken) {
+            console.debug('Using dashboard access token');
+            return {
+                auth: `Bearer ${this.authParams.dashboardAccessToken}`,
+            };
+        }
+        // If a project access token has been set on the config, use that instead
+        // of fetching one. This is most likely used on the managed query-engine where we
+        // pass the project access token through in a request header.
+        if (this.authParams.projectAccessToken) {
+            console.debug('Using project access token for auth header');
+            return {
+                auth: `Bearer ${this.authParams.projectAccessToken}`,
+            };
+        }
+        if (this.authParams.projectApiKey) {
+            console.debug('Using API Key for auth header');
+            return {
+                auth: `Api-Key ${this.authParams.projectApiKey}`,
+            };
+        }
+        if (this.authParams.appSessionToken) {
+            console.debug('Using app session access token');
+            return {
+                auth: `Bearer ${this.authParams.appSessionToken}`,
+            };
+        }
+        // Try without this extra logic to fetch the project tokens...
+        // else if (request.preFetchProjectAccessTokens && (config.useCookieAuth || !!config.appSessionAuthToken)) {
+        //   logDebug(
+        //     'Fetching project access token from the Vizzly API',
+        //     request.preFetchProjectAccessTokens.projectId,
+        //     'Filtering by',
+        //     request.preFetchProjectAccessTokens.resourceFilters
+        //   );
+        //   const accessToken = await getProjectAccessToken(httpClient(config))(
+        //     request.preFetchProjectAccessTokens.projectId,
+        //     config.appSessionAuthToken,
+        //     request.preFetchProjectAccessTokens.resourceFilters
+        //   );
+        //   if (accessToken) {
+        //     logDebug('Project access token received.');
+        //     return {
+        //       auth: `Bearer ${accessToken}`,
+        //     };
+        //   } else {
+        //     logDebug('Failed to receive project access token.');
+        //   }
+        // } else {
+        //   logDebug('Not pre-fetching project access token.');
+        // }
+        return {};
+    }
+}
+exports.Authentication = Authentication;

package/dist/models/Dashboard.d.ts

@@ -0,0 +1,24 @@
+import { Vizzly } from './Vizzly';
+import { CreateDashboardParams, DashboardDefinition, Dashboard as DashboardType, GlobalLibrary, UpdateDashboardParams } from '../types';
+export declare class Dashboard {
+    private vizzly;
+    constructor(vizzly: Vizzly);
+    create(params: CreateDashboardParams): Promise<{
+        dashboard: DashboardType;
+        permissions: ({
+            userReference: string;
+            token: string;
+            scope: "read" | "read_write";
+        } & {
+            dashboardId: string;
+        })[];
+    }>;
+    update(params: Omit<UpdateDashboardParams, 'dashboardSessionToken' | 'definition'> & {
+        dashboardId: string;
+        definition?: DashboardDefinition;
+    }): Promise<void>;
+    getDashboards(): Promise<DashboardType[]>;
+    static mergeDashboardsAndGlobalLibraries(dashboards: DashboardType[], globalLibraries: GlobalLibrary[]): DashboardType[];
+    static mergeCustomFields(dashboard: DashboardType, dashboards: DashboardType[], parentGlobalLibrariesForDashboard: GlobalLibrary[], childGlobalLibrariesForDashboard: GlobalLibrary[]): DashboardType['definition']['customFields'];
+    static markViewsAsProtected(componentLibrary: DashboardType['definition']['componentLibrary']): DashboardType['definition']['componentLibrary'];
+}