@visactor/vquery 0.2.5 → 0.2.6

package/dist/node/esm/sql-builder/utils.d.ts

@@ -0,0 +1,8 @@
+import { Where, WhereClause, WhereGroup, WhereLeaf } from '../types';
+import { SelectItem } from '../types/dsl/Select';
+export declare const isSelectItem: <T>(item: keyof T | SelectItem<T>) => item is SelectItem<T>;
+export declare const isWhereLeaf: <T>(where: Where<T> | WhereClause<T>) => where is WhereLeaf<T>;
+export declare const isWhereGroup: <T>(where: Where<T> | WhereClause<T>) => where is WhereGroup<T>;
+export declare const isStringOrNumber: (value: unknown) => value is string | number;
+export declare const escapeLiteral: <T>(value: T[keyof T]) => T[keyof T];
+export declare const escapeValue: (value: unknown) => string;

package/dist/node/esm/types/DataSet.d.ts

@@ -0,0 +1,11 @@
+export type { QueryResult } from './QueryResult';
+export type DataType = 'number' | 'string' | 'date' | 'datetime' | 'timestamp';
+export interface DatasetColumn {
+    type: DataType;
+    name: string;
+}
+export interface DatasetSchema {
+    datasetId: string;
+    datasetAlias: string;
+    columns: DatasetColumn[];
+}

package/dist/node/esm/types/DataSource.d.ts

@@ -0,0 +1,11 @@
+export type TidyDatum = Record<string, number | string | null | boolean | undefined>;
+export type DatasetSourceType = 'csv' | 'json' | 'xlsx' | 'parquet';
+export type DatasetSourceValue = string | ArrayBuffer | Blob | TidyDatum[];
+export interface DatasetSource {
+    type: DatasetSourceType;
+    blob: Blob;
+}
+export interface RawDatasetSource {
+    type: DatasetSourceType;
+    rawDataset: DatasetSourceValue;
+}

package/dist/node/esm/types/QueryResult.d.ts

@@ -0,0 +1 @@
+export type QueryResult = any;

package/dist/node/esm/types/adapters/QueryAdapter.d.ts

@@ -0,0 +1,11 @@
+import { QueryResult } from '../QueryResult';
+export interface QueryAdapter {
+    open: () => Promise<void>;
+    close: () => Promise<void>;
+    writeFile: <T extends Blob>(fileName: string, source: T) => Promise<void>;
+    getSchema: (fileName: string) => Promise<QueryResult>;
+    query: (sql: string) => Promise<{
+        dataset: any[];
+        table: any;
+    }>;
+}

package/dist/node/esm/types/adapters/StorageAdapter.d.ts

@@ -0,0 +1,17 @@
+import { DatasetSchema } from '../DataSet';
+import { DatasetSource } from '../DataSource';
+export interface StorageAdapter {
+    open: () => Promise<void>;
+    close: () => Promise<void>;
+    writeDataset: (datasetId: string, datasetSchema: DatasetSchema, datasetSource?: DatasetSource) => Promise<void>;
+    readDataset: (datasetId: string) => Promise<{
+        datasetSchema: DatasetSchema;
+        datasetSource?: DatasetSource;
+    } | null>;
+    deleteDataset: (datasetId: string) => Promise<void>;
+    listDatasets: () => Promise<{
+        datasetId: string;
+        datasetSchema: DatasetSchema;
+        datasetSource?: DatasetSource;
+    }[]>;
+}

package/dist/node/esm/types/adapters/index.d.ts

@@ -0,0 +1,2 @@
+export * from './QueryAdapter';
+export * from './StorageAdapter';

package/dist/node/esm/types/dsl/GroupBy.d.ts

@@ -0,0 +1 @@
+export type GroupBy<T> = Array<keyof T>;

package/dist/node/esm/types/dsl/OrderBy.d.ts

@@ -0,0 +1,4 @@
+export type OrderBy<T> = Array<{
+    field: string | keyof T;
+    order?: 'asc' | 'desc';
+}>;

package/dist/node/esm/types/dsl/QueryDSL.d.ts

@@ -0,0 +1,12 @@
+import { GroupBy } from './GroupBy';
+import { OrderBy } from './OrderBy';
+import { Select } from './Select';
+import { Where } from './Where';
+export interface QueryDSL<Table> {
+    select: Select<Table>;
+    where?: Where<Table>;
+    groupBy?: GroupBy<Table>;
+    orderBy?: OrderBy<Table>;
+    limit?: number;
+}
+export type VQueryDSL<Table = Record<string, unknown>> = QueryDSL<Table>;

package/dist/node/esm/types/dsl/Select.d.ts

@@ -0,0 +1,7 @@
+export type AggregateFunction = 'count' | 'sum' | 'avg' | 'min' | 'max' | 'quantile';
+export type SelectItem<T> = {
+    field: keyof T;
+    alias?: string;
+    func?: AggregateFunction;
+};
+export type Select<T> = Array<keyof T | SelectItem<T>>;

package/dist/node/esm/types/dsl/Where.d.ts

@@ -0,0 +1,24 @@
+export type Where<T> = WhereGroup<T>;
+export type WhereGroup<T> = {
+    op: 'and' | 'or';
+    conditions: Array<WhereClause<T>>;
+};
+export type WhereClause<T> = WhereLeaf<T> | WhereGroup<T>;
+export type WhereLeaf<T> = {
+    [K in keyof T]: {
+        [O in Operator]: {
+            field: K;
+            op: O;
+        } & (O extends 'is null' | 'is not null' ? {
+            value?: never;
+        } : O extends 'in' | 'not in' ? {
+            value: T[K] | T[K][];
+        } : O extends 'between' | 'not between' ? {
+            value: [T[K], T[K]];
+        } : {
+            value: T[K];
+        });
+    }[Operator];
+}[keyof T];
+type Operator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'like' | 'not like' | 'ilike' | 'not ilike' | 'in' | 'not in' | 'between' | 'not between' | 'is null' | 'is not null';
+export {};

package/dist/node/esm/types/dsl/demo.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/node/esm/types/dsl/index.d.ts

@@ -0,0 +1,5 @@
+export type { QueryDSL, VQueryDSL } from './QueryDSL';
+export type { GroupBy } from './GroupBy';
+export type { OrderBy } from './OrderBy';
+export type { Select } from './Select';
+export type { Where, WhereClause, WhereLeaf, WhereGroup } from './Where';

package/dist/node/esm/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './DataSet';
+export * from './DataSource';
+export * from './QueryResult';
+export * from './dsl';
+export * from './adapters';

package/dist/node/esm/utils/index.d.ts

@@ -0,0 +1 @@
+export { isUrl, isHttpUrl, isBase64Url } from './url';

package/dist/node/esm/utils/url.d.ts

@@ -0,0 +1,3 @@
+export declare const isUrl: (url: string) => boolean;
+export declare const isHttpUrl: (url: string) => boolean;
+export declare const isBase64Url: (url: string) => boolean;

package/dist/node/esm/vquery-browser.d.ts

@@ -0,0 +1,21 @@
+import { Dataset } from './dataset/dataset';
+import { RawDatasetSource, DatasetColumn } from './types';
+export declare class VQuery {
+    private queryAdapter;
+    private storageAdapter;
+    private isInitialized;
+    constructor();
+    private checkInitialized;
+    private checkDatasetExists;
+    createDataset(datasetId: string, columns?: DatasetColumn[], rawDatasetSource?: RawDatasetSource): Promise<void>;
+    updateDatasetSource(datasetId: string, columns?: DatasetColumn[], rawDatasetSource?: RawDatasetSource): Promise<void>;
+    dropDataset(datasetId: string): Promise<void>;
+    connectDataset(datasetId: string, temporaryColumns?: DatasetColumn[], temporaryRawDatasetSource?: RawDatasetSource): Promise<Dataset>;
+    hasDataset(datasetId: string): Promise<boolean>;
+    listDatasets(): Promise<{
+        datasetId: string;
+        datasetSchema: import("./types").DatasetSchema;
+        datasetSource?: import("./types").DatasetSource;
+    }[]>;
+    close(): Promise<void>;
+}

package/dist/node/esm/vquery-node.d.ts

@@ -0,0 +1,21 @@
+import { Dataset } from './dataset/dataset';
+import { RawDatasetSource, DatasetColumn } from './types';
+export declare class VQuery {
+    private queryAdapter;
+    private storageAdapter;
+    private isInitialized;
+    constructor();
+    private checkInitialized;
+    private checkDatasetExists;
+    createDataset(datasetId: string, columns?: DatasetColumn[], rawDatasetSource?: RawDatasetSource): Promise<void>;
+    updateDatasetSource(datasetId: string, columns?: DatasetColumn[], rawDatasetSource?: RawDatasetSource): Promise<void>;
+    dropDataset(datasetId: string): Promise<void>;
+    connectDataset(datasetId: string, temporaryColumns?: DatasetColumn[], temporaryRawDatasetSource?: RawDatasetSource): Promise<Dataset>;
+    hasDataset(datasetId: string): Promise<boolean>;
+    listDatasets(): Promise<{
+        datasetId: string;
+        datasetSchema: import("./types").DatasetSchema;
+        datasetSource?: import("./types").DatasetSource;
+    }[]>;
+    close(): Promise<void>;
+}

package/package.json

@@ -1,21 +1,26 @@
 {
   "name": "@visactor/vquery",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "type": "module",
   "exports": {
     ".": {
-      "require": {
-        "types": "./dist/cjs/node.d.ts",
-        "default": "./dist/cjs/node.cjs"
+      "node": {
+        "types": "./dist/node/esm/node.d.ts",
+        "import": "./dist/node/esm/node.js",
+        "require": "./dist/node/cjs/node.cjs"
       },
-      "import": {
-        "types": "./dist/esm/browser.d.js",
-        "default": "./dist/esm/browser.js"
+      "browser": {
+        "types": "./dist/browser/esm/browser.d.ts",
+        "import": "./dist/browser/esm/browser.js"
+      },
+      "default": {
+        "types": "./dist/browser/esm/browser.d.ts",
+        "import": "./dist/browser/esm/browser.js"
       }
     }
   },
-  "main": "./dist/cjs/node.cjs",
-  "types": "./dist/cjs/node.d.ts",
+  "main": "./dist/node/cjs/node.cjs",
+  "types": "./dist/node/esm/node.d.ts",
   "files": [
     "dist"
   ],