@vizzly/api-client 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,405 @@
+import { VizzlyQueryEngineApi } from './models/VizzlyQueryEngineApi';
+import { VizzlyApi } from './models/VizzlyApi';
+import { VizzlyAppApi } from './models/VizzlyAppApi';
+import { DashboardDefinition } from './types/dashboard';
+export * from './types/dashboard';
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export type Response<T> = {
+    status: number;
+    headers: Headers;
+    body: T;
+};
+export type Request<T> = {
+    path: string;
+    abortSignal?: AbortSignal;
+    method: 'get' | 'post' | 'delete' | 'put';
+    body?: T;
+    headers?: {
+        [key: string]: string;
+    };
+};
+export type UpdateGlobalLibraryParams = {
+    globalLibrarySessionToken: string;
+    deleted?: boolean;
+    library: GlobalLibrary['library'] | string;
+};
+export type CreateDashboardParams = {
+    definition: DashboardDefinition | string;
+    /** @deprecated - use `metadata` instead */
+    meta?: any;
+    metadata?: any;
+    parentDashboardId: string;
+    permissions: Array<any>;
+};
+export type CreateDashboardParamsUnencrypted = Omit<CreateDashboardParams, 'definition'> & {
+    definition: DashboardDefinition;
+};
+export type UpdateDashboardParams = {
+    dashboardSessionToken: string;
+    definition?: DashboardDefinition | string;
+    /** @deprecated - use `metadata` instead */
+    meta?: any;
+    metadata?: any;
+    deleted?: boolean;
+};
+export type APIs = {
+    vizzlyApi: VizzlyApi;
+    vizzlyAppApi: VizzlyAppApi;
+    vizzlyQueryEngineApi: VizzlyQueryEngineApi;
+};
+export type extraHeaders = () => {
+    [key: string]: string;
+};
+export type AuthParams = {
+    projectAdminOverrideToken?: string;
+    queryEngineAccessToken?: string;
+    dashboardAccessToken?: string;
+    projectAccessToken?: string;
+    dataAccessToken?: string;
+    projectApiKey?: string;
+    appSessionToken?: string;
+};
+export declare namespace nVizzlyQueryEngine {
+    type CreateConfigFromUploadParams = {
+        table: string;
+        fieldPublicNames: string;
+    };
+    type CreateResultsParams = {
+        queries: any;
+    };
+    type CreateSqlPreviewParams = {
+        sql: string;
+        parameters: string;
+        limit: number;
+    };
+    type CreateQueryEngineUserParams = {
+        email: string;
+        password: string;
+    };
+    type GetStartedParams = {
+        email: string;
+        password: string;
+    };
+    type SaveConfigParams = {
+        config: any;
+    };
+    type SaveConnectionParams = {
+        connection: any;
+        client: any;
+    };
+    type SignInWithEmailAndPasswordParams = {
+        email: string;
+        password: string;
+    };
+    type UpdateQueryEngineUserParams = {
+        queryEngineUserId: string;
+        password: string;
+    };
+    type UploadDataToVizzlyCloudParams = {
+        ingest: {
+            table: string;
+            fields: Array<{
+                name: string;
+                dataType: string;
+            }>;
+            content: Array<any>;
+        };
+    };
+}
+export declare namespace nVizzlyApi {
+    type CreateParentDashboardParams = {
+        definition: any;
+        projectId: string;
+    };
+    type CreateGlobalLibraryParams = {
+        parentGlobalLibraryId: string;
+        library: any;
+        permissions: Array<{
+            user_reference?: string;
+            scope: 'read' | 'read_write';
+        }>;
+    };
+    type CreateParentGlobalLibraryParams = {
+        library: any;
+        projectId: string;
+    };
+    type CreateQueryEngineUserParams = {
+        projectId: string;
+        email: string;
+        password: string;
+    };
+    type UpdateQueryEngineUserParams = {
+        projectId: string;
+        password: string;
+        queryEngineUserId: string;
+    };
+    type UpdateProjectApiKeyParams = {
+        projectApiKeyId: string;
+        projectId: string;
+        disabled: boolean;
+    };
+    type UpdateParentGlobalLibraryParams = {
+        globalLibraryId: string;
+        deleted?: boolean;
+        name?: string;
+    };
+    type SaveScheduledReportParams = {
+        cronSchedule: string;
+        scheduledReportId: string;
+    };
+    type SaveEncryptedProjectEncryptionSecretParams = {
+        projectId: string;
+        encryptedProjectEncryptionSecret: string;
+        allowRotation: boolean;
+    };
+    type SaveConnectionParams = {
+        projectId: string;
+        encryptedConnection: string;
+        encryptedConfig: string;
+    };
+    type GetVizzlyConfigParams = {
+        projectId: string;
+    };
+    type GetTeamMembers = {
+        projectId: string;
+    };
+    type GetQueryEngineUserParams = {
+        projectId: string;
+        email: string;
+    };
+    type GetProjectAccessTokenParams = {
+        projectId: string;
+        resourceFilters?: string[];
+    };
+    type GetProjectParams = {
+        projectId: string;
+    };
+    type GetManagedQueryEngineKeyPairParams = {
+        managedProjectId: string;
+        keyPairId: string;
+    };
+    type GetConnectionParams = {
+        projectId: string;
+    };
+    type DuplicateParentDashboardParams = {
+        dashboardId: string;
+    };
+    type CreateVizzlyConfigVersionParams = {
+        projectId: string;
+        encryptedConfig: string;
+    };
+    type CreateProjectApiKeyParams = {
+        projectId: string;
+    };
+}
+export declare namespace nVizzlyAppApi {
+    type CreateInstantDashboardParams = {
+        definition: Object;
+    };
+    type CreateProjectAdminOverrideAccessTokenParams = {
+        projectId: string;
+    };
+    type StartEmailChangeParams = {
+        email: string;
+    };
+    type CompleteEmailChangeParams = {
+        token: string;
+    };
+    type GetManagedQueryEngineAccessTokensParams = {
+        managedQueryEngineId: string;
+    };
+    type GetParentDashboardMetaParams = {
+        dashboardId: string;
+    };
+    type GetProjectMetaParams = {
+        projectId: string;
+    };
+    type InAppAcceptTeamMemberInviteParams = {
+        teamMemberId: string;
+    };
+    type AcceptTeamMemberInviteParams = {
+        inviteToken: string;
+    };
+    type ResendTeamMemberInviteParams = {
+        teamMemberId: string;
+    };
+    type RemoveTeamMemberParams = {
+        teamMemberId: string;
+    };
+    type StartSignInParams = {
+        email: string;
+    };
+    type CompleteSignInParams = {
+        token: string;
+    };
+    type SwitchOrganisationParams = {
+        organisationId: string;
+    };
+    type ToggleKeyPairDisabledParams = {
+        keyPairId: string;
+        disabled: boolean;
+    };
+    type UpdateProjectParams = {
+        projectId: string;
+        deleted?: boolean;
+        name?: string;
+    };
+    type UploadPublicKeyParams = {
+        projectId: string;
+        publicKey: string;
+    };
+    type UpdateParentDashboardParams = {
+        dashboardId: string;
+        name?: string;
+        definition?: Object;
+        meta?: any;
+        deleted?: boolean;
+        webhookId?: string;
+    };
+    type InviteTeamMemberParams = {
+        email: string;
+        firstName: string;
+        lastName: string;
+        department: string;
+    };
+    type SignUpParams = {
+        email: string;
+        organisationTitle: string;
+        firstName: string;
+        lastName: string;
+        department: string;
+    };
+}
+export type RawOrganisation = {
+    id: string;
+    name: string;
+    user_id: string;
+    created_at: string;
+    free_trial_ends_at: string;
+    tier: {
+        id: string;
+        name: string;
+        limits: {
+            ai_questions_per_hour_per_end_user: number;
+            allow_js_embed: boolean;
+            max_dashboard_child_copies_per_end_user: number;
+            project_limit_instant_dashboards: number;
+            project_limit_managed_query_engine: number;
+            project_limit_self_hosted: number;
+        };
+    };
+};
+export type GetSelfResponse = {
+    user: {
+        id: string;
+        is_email_verified: boolean;
+        email: string;
+        first_name: string;
+        last_name: string;
+        is_vizz: boolean;
+        department: 'product_management' | 'project_management' | 'sales' | 'marketing' | 'engineering' | 'analyst' | 'c-suite';
+    };
+    organisation: RawOrganisation;
+    default_organisation: RawOrganisation;
+    team_memberships: Array<RawTeamMember>;
+};
+export type RawTeamMember = {
+    id: string;
+    organisation_name: string;
+    user_id: string;
+    department: VizzlyWeb.User.Department;
+    email: VizzlyWeb.User['email'];
+    first_name: VizzlyWeb.User['firstName'];
+    last_name: VizzlyWeb.User['lastName'];
+    status: 'pending' | 'active' | 'removed';
+    organisation_id: string;
+};
+export declare namespace VizzlyWeb {
+    type Tier = {
+        id: string;
+        name: string;
+        limits: {
+            aiQuestionsPerHourPerEndUser: number;
+            allowJsEmbed: boolean;
+            maxDashboardChildCopiesPerEndUser: number;
+            projectLimitInstantDashboards: number;
+            projectLimitManagedQueryEngine: number;
+            projectLimitSelfHosted: number;
+        };
+    };
+    type Organisation = {
+        id: string;
+        userId: string;
+        title: string;
+        createdAt: string;
+        tier: Tier;
+        freeTrialEndsAt: string;
+    };
+    type TeamMember = {
+        id: string;
+        userId: string;
+        department: VizzlyWeb.User.Department;
+        email: VizzlyWeb.User['email'];
+        firstName: VizzlyWeb.User['firstName'];
+        lastName: VizzlyWeb.User['lastName'];
+        status: 'pending' | 'active' | 'removed';
+        organisationTitle: string;
+        organisationId: string;
+    };
+    namespace User {
+        type Department = 'product_management' | 'project_management' | 'sales' | 'marketing' | 'engineering' | 'analyst' | 'c-suite';
+    }
+    type User = {
+        id: string;
+        firstName: string;
+        lastName: string;
+        department: User.Department;
+        email: string;
+        isEmailVerified: boolean;
+        isVizzly: boolean;
+    };
+    type KeyPair = {
+        id: string;
+        uploadedAt: string;
+        uploadedBy: string;
+        publicKey: string;
+        organisationId: string;
+        disabled: boolean;
+        updatedAt: string;
+    };
+    type DateTimeFormat = 'DD/MM/YYYY' | 'MM/DD/YYYY' | 'DD-MM-YYYY' | 'MM-DD-YYYY' | 'DD MMMM YYYY, hh:mm' | 'dddd DD MMMM YYYY, hh:mm' | 'hh:mm' | 'DD MMMM YYYY';
+    type SessionToken = {
+        token: string;
+        maxAge: number;
+    };
+    type ParentDashboardMeta = {
+        dashboardName: string;
+        endUserInstances: number;
+    };
+}
+export type GlobalLibrary = {
+    created_at: string;
+    id: string;
+    library: {
+        views?: Array<{
+            attributes: {
+                viewId: string;
+                protectedByOrganisation?: boolean;
+            };
+        }>;
+        customFields?: {
+            [dataSetId: string]: Array<{
+                id: string;
+            }>;
+        };
+    };
+    name: string;
+    parent_global_library_id: string | null;
+    updated_at: string;
+};
+export type GlobalLibraryPermission = {
+    global_library_id: string;
+    scope: 'read_write' | 'read';
+    token: string;
+    user_reference: string;
+};

package/dist/types.js

@@ -0,0 +1,17 @@
+"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("./types/dashboard"), exports);

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@vizzly/api-client",
+  "version": "0.0.1",
+  "private": false,
+  "license": "NONE",
+  "source": "src/index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/isomorphic-fetch": "^0.0.39",
+    "@types/jest": "^29.5.12",
+    "@types/lodash": "^4.17.0",
+    "@types/uuid": "^9.0.8",
+    "@vizzly/auth": "^0.2.8",
+    "jest": "^29.6.0",
+    "lodash": "^4.17.21",
+    "prettier": "^3.2.5",
+    "ts-jest": "^29.1.1",
+    "ts-loader": "^9.5.1",
+    "typescript": "^5.3.2",
+    "uuid": "^9.0.1"
+  },
+  "scripts": {
+    "test": "jest",
+    "build": "rm -rf ./dist && tsc",
+    "dev": "tsc -w",
+    "format": "prettier --write ./src/** ./__tests__/**",
+    "prepublish": "yarn build"
+  },
+  "dependencies": {
+    "isomorphic-fetch": "^3.0.0"
+  }
+}