@quillsql/admin 1.6.1 → 1.6.3

package/dist/esm/utils/dataFetcher.d.ts

@@ -1,3 +1,21 @@
-export declare function getData(client: any, cloudQueryEndpoint: string, noCred: RequestCredentials, hostedRequestBody: any, cloudRequestBody: any, method?: string): Promise<any>;
-export declare function getDataFromCloud(client: any, cloudQueryEndpoint: string, cloudRequestBody: any, method?: string): Promise<any>;
+import { QuillProviderClient } from '../Admin';
+export interface QuillFetchOptions {
+    client: Pick<QuillProviderClient, 'clientId' | 'queryEndpoint' | 'queryHeaders' | 'withCredentials'>;
+    task: string;
+    method?: string;
+    metadata: any;
+    abortSignal?: AbortSignal;
+    credentials?: RequestCredentials;
+    urlParameters?: string;
+    getToken: () => Promise<string>;
+    adminMode?: boolean;
+}
+export interface QuillResults {
+    data?: any;
+    queries?: any;
+    status?: string;
+    error?: string;
+    message?: string;
+}
+export declare const quillFetch: ({ client, task, method, metadata, abortSignal, credentials, urlParameters, getToken, }: QuillFetchOptions) => Promise<QuillResults>;
 //# sourceMappingURL=dataFetcher.d.ts.map

package/dist/esm/utils/dataFetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataFetcher.d.ts","sourceRoot":"","sources":["../../../src/utils/dataFetcher.tsx"],"names":[],"mappings":"AAEA,wBAAsB,OAAO,CAC3B,MAAM,EAAE,GAAG,EACX,kBAAkB,EAAE,MAAM,EAC1B,MAAM,EAAE,kBAAkB,EAC1B,iBAAiB,EAAE,GAAG,EACtB,gBAAgB,EAAE,GAAG,EACrB,MAAM,SAAS,gBAkChB;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,GAAG,EACX,kBAAkB,EAAE,MAAM,EAC1B,gBAAgB,EAAE,GAAG,EACrB,MAAM,SAAS,gBAgChB"}
+{"version":3,"file":"dataFetcher.d.ts","sourceRoot":"","sources":["../../../src/utils/dataFetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAG/C,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,IAAI,CACV,mBAAmB,EACnB,UAAU,GAAG,eAAe,GAAG,cAAc,GAAG,iBAAiB,CAClE,CAAC;IACF,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,GAAG,CAAC;IACd,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,UAAU,2FASpB,iBAAiB,KAAG,OAAO,CAAC,YAAY,CAwD1C,CAAC"}

package/dist/esm/utils/dataFetcher.js

@@ -1,63 +1,54 @@
-// this function gets the data either from the self hosted endpoint or
-// our cloud server
-export async function getData(client, cloudQueryEndpoint, noCred, hostedRequestBody, cloudRequestBody, method = 'POST') {
-    if (client.queryEndpoint) {
-        // self hosted
-        const resp = await fetch(client.queryEndpoint, {
-            method: 'POST',
+import { QUILL_QUERY_ENDPOINT, QUILL_SERVER } from './constants';
+export const quillFetch = async ({ client, task, method = 'POST', metadata, abortSignal, credentials = 'omit', urlParameters, getToken, }) => {
+    const token = await getToken();
+    const queryString = urlParameters ?? `task=${task}`;
+    const endpoint = client.queryEndpoint
+        ? `${client.queryEndpoint}?${queryString}`
+        : `${QUILL_SERVER}${QUILL_QUERY_ENDPOINT}?${queryString}`;
+    try {
+        const response = await fetch(endpoint, {
+            method,
             headers: {
+                ...(token ? { Authorization: `Bearer ${token}` } : {}),
                 ...client.queryHeaders,
                 'Content-Type': 'application/json',
+                'Vercel-Env': process.env.NEXT_PUBLIC_VERCEL_ENV ?? 'production',
             },
-            credentials: client.withCredentials ? 'include' : noCred,
-            body: JSON.stringify(hostedRequestBody),
+            body: JSON.stringify({
+                metadata: {
+                    task,
+                    clientId: client.clientId,
+                    adminMode: true,
+                    ...metadata,
+                },
+            }),
+            credentials: client.withCredentials ? 'include' : credentials,
+            signal: abortSignal,
         });
-        try {
-            const responseJson = await resp.json();
-            const result = {
-                ...responseJson.data,
-                rows: responseJson?.queries?.queryResults[0]?.rows,
-                compareRows: responseJson?.queries?.queryResults[1]?.rows,
-            };
-            return result;
+        if (!response.ok) {
+            throw new Error('API request failed');
         }
-        catch (e) {
-            console.error('Failed to parse JSON:', e);
-            return null;
+        let result = await response.json();
+        // Not sure if this is required, but putting it here just in case
+        // based on other lines of code I've seen
+        // Probably happens if self-hosted endpoint was not set up correctly and
+        // the response was wrapped in an additional data object
+        if (result.data?.data &&
+            (result.data.queries || result.data.status || result.data.error)) {
+            result = result.data;
         }
-    }
-    else {
-        // cloud
-        return await getDataFromCloud(client, cloudQueryEndpoint, cloudRequestBody, method);
-    }
-}
-export async function getDataFromCloud(client, cloudQueryEndpoint, cloudRequestBody, method = 'POST') {
-    const environment = client?.environment;
-    const resp = await fetch(
-    // `https://quill-344421.uc.r.appspot.com/${cloudQueryEndpoint}`,
-    `http://localhost:8080/${cloudQueryEndpoint}`, {
-        method,
-        headers: {
-            Authorization: 'Bearer ',
-            ...(environment ? { environment } : {}), // Remember to provide the actual token
-            'Content-Type': 'application/json',
-            environment: environment || undefined,
-        },
-        body: method === 'POST'
-            ? JSON.stringify({
-                ...cloudRequestBody,
-                ...{
-                    publicKey: client?._id,
-                    orgId: client?.adminCustomerId,
-                },
-            })
-            : null,
-    });
-    try {
-        return await resp.json();
+        return {
+            data: result.data,
+            queries: result.queries,
+            status: result.status,
+            error: result.error,
+        };
     }
     catch (e) {
-        console.error('Failed to parse JSON:', e);
-        return null;
+        if (e instanceof Error && e.name === 'AbortError') {
+            throw e;
+        }
+        console.error('Failed to fetch:', e);
+        return { error: 'Failed to fetch data' };
     }
-}
+};

package/dist/esm/utils/databases.d.ts

@@ -7,38 +7,50 @@ export interface ConnectionError {
     schemas: string[];
     schemaName?: string;
 }
-interface PostgresConnection extends DatabaseConnection {
+export interface PostgresConnection extends DatabaseConnection {
     user: string;
     password: string;
     host: string;
     databaseName: string;
     port: string;
 }
-interface MySQLConnection extends DatabaseConnection {
+export interface ClickHouseConnection extends DatabaseConnection {
+    user: string;
+    password: string;
+    host: string;
+    port: string;
+}
+export interface MySQLConnection extends DatabaseConnection {
     user: string;
     password: string;
     host: string;
     databaseName: string;
     port: string;
 }
-interface SnowflakeConnection extends DatabaseConnection {
+export interface SQLServerConnection extends DatabaseConnection {
     user: string;
     password: string;
     host: string;
     databaseName: string;
     port: string;
 }
-interface BigQueryConnection extends DatabaseConnection {
+export interface SnowflakeConnection extends DatabaseConnection {
+    user: string;
+    password: string;
+    host: string;
+    databaseName: string;
+    warehouse: string;
+}
+export interface BigQueryConnection extends DatabaseConnection {
     jsonString: string;
 }
-export type ConnectionType = DatabaseConnection | PostgresConnection | MySQLConnection | SnowflakeConnection | BigQueryConnection;
+export type ConnectionType = DatabaseConnection | PostgresConnection | MySQLConnection | SnowflakeConnection | BigQueryConnection | ClickHouseConnection | SQLServerConnection;
 export interface DatabaseDefaultInfo {
     label: string;
     value: string;
     imageUrl: string;
 }
 export declare const DATABASE_DEFAULT_INFO: DatabaseDefaultInfo[];
-export declare function getDatabaseConnectionFormat(databaseName: string): ConnectionType | undefined;
-export declare function formConnectionString(connection?: DatabaseConnection, jsonFile?: File): string;
-export {};
+export declare function getDatabaseConnectionFormat(databaseName: string): ConnectionType;
+export declare function formConnectionString(connection?: DatabaseConnection): string;
 //# sourceMappingURL=databases.d.ts.map

package/dist/esm/utils/databases.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"databases.d.ts","sourceRoot":"","sources":["../../../src/utils/databases.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,kBAAmB,SAAQ,kBAAkB;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,UAAU,eAAgB,SAAQ,kBAAkB;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,UAAU,mBAAoB,SAAQ,kBAAkB;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,UAAU,kBAAmB,SAAQ,kBAAkB;IACrD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,cAAc,GACtB,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,mBAAmB,GACnB,kBAAkB,CAAC;AAEvB,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,qBAAqB,EAAE,mBAAmB,EAyBtD,CAAC;AAEF,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,MAAM,GACnB,cAAc,GAAG,SAAS,CAuC5B;AAED,wBAAgB,oBAAoB,CAClC,UAAU,CAAC,EAAE,kBAAkB,EAC/B,QAAQ,CAAC,EAAE,IAAI,UAkChB"}
+{"version":3,"file":"databases.d.ts","sourceRoot":"","sources":["../../../src/utils/databases.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,cAAc,GACtB,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,GACf,mBAAmB,GACnB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,CAAC;AAExB,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,eAAO,MAAM,qBAAqB,EAAE,mBAAmB,EAoCtD,CAAC;AAEF,wBAAgB,2BAA2B,CACzC,YAAY,EAAE,MAAM,GACnB,cAAc,CA0DhB;AAED,wBAAgB,oBAAoB,CAAC,UAAU,CAAC,EAAE,kBAAkB,UA6CnE"}

package/dist/esm/utils/databases.js

@@ -5,9 +5,19 @@ export const DATABASE_DEFAULT_INFO = [
         imageUrl: 'https://upload.wikimedia.org/wikipedia/commons/thumb/2/29/Postgresql_elephant.svg/640px-Postgresql_elephant.svg.png',
     },
     {
-        label: 'Big Query',
-        value: 'BigQuery',
-        imageUrl: 'https://cdn.icon-icons.com/icons2/2699/PNG/512/google_bigquery_logo_icon_168150.png',
+        label: 'MySQL',
+        value: 'MySQL',
+        imageUrl: 'https://d1.awsstatic.com/asset-repository/products/amazon-rds/1024px-MySQL.ff87215b43fd7292af172e2a5d9b844217262571.png',
+    },
+    {
+        label: 'SQL Server',
+        value: 'MSSQL',
+        imageUrl: 'https://img.icons8.com/?size=512&id=laYYF3dV0Iew&format=png',
+    },
+    {
+        label: 'ClickHouse',
+        value: 'ClickHouse',
+        imageUrl: 'https://cdn.bfldr.com/TIYO9DJD/at/ngj52bwft4884275bgbgf/Logomark_Black_72dpi_FNL.png?auto=webp&format=png',
     },
     {
         label: 'Snowflake',
@@ -15,55 +25,76 @@ export const DATABASE_DEFAULT_INFO = [
         imageUrl: 'https://estuary.dev/static/972ca52d0addb818460efc144940d25f/f8411/7154a4_Snowflake_a6a3c49601.png',
     },
     {
-        label: 'MySQL',
-        value: 'MySQL',
-        imageUrl: 'https://d1.awsstatic.com/asset-repository/products/amazon-rds/1024px-MySQL.ff87215b43fd7292af172e2a5d9b844217262571.png',
+        label: 'BigQuery',
+        value: 'BigQuery',
+        imageUrl: 'https://www.gstatic.com/bricks/image/702bc723dcfcddf8942bb459be20163106a5f64ed91404df38c73ca955f96260.svg',
     },
 ];
 export function getDatabaseConnectionFormat(databaseName) {
-    if (databaseName === 'PostgreSQL') {
+    if (databaseName === 'MySQL') {
         return {
             user: '',
             password: '',
             host: '',
             databaseName: '',
             port: '',
-            type: 'PostgreSQL',
+            type: 'MySQL',
             connectionString: '',
         };
     }
-    else if (databaseName === 'MySQL') {
+    else if (databaseName === 'Snowflake') {
         return {
             user: '',
             password: '',
             host: '',
             databaseName: '',
+            warehouse: '',
+            type: 'Snowflake',
+            connectionString: '',
+        };
+    }
+    else if (databaseName === 'BigQuery') {
+        return {
+            type: 'BigQuery',
+            connectionString: '',
+            jsonString: '',
+        };
+    }
+    else if (databaseName === 'ClickHouse') {
+        return {
+            user: '',
+            password: '',
+            host: '',
             port: '',
-            type: 'MySQL',
+            type: 'ClickHouse',
             connectionString: '',
         };
     }
-    else if (databaseName === 'Snowflake') {
+    else if (databaseName === 'MSSQL') {
         return {
             user: '',
             password: '',
             host: '',
             databaseName: '',
             port: '',
-            type: 'Snowflake',
+            type: 'MSSQL',
             connectionString: '',
         };
     }
-    else if (databaseName === 'BigQuery') {
+    else {
+        // Postgres by default
         return {
-            type: 'BigQuery',
+            user: '',
+            password: '',
+            host: '',
+            databaseName: '',
+            port: '',
+            type: 'PostgreSQL',
             connectionString: '',
-            jsonString: '',
         };
     }
-    return undefined;
 }
-export function formConnectionString(connection, jsonFile) {
+export function formConnectionString(connection) {
     if (!connection) {
         return 'There is no connection info';
     }
@@ -74,13 +105,13 @@ export function formConnectionString(connection, jsonFile) {
         const typedConnection = connection;
         return `postgres://${typedConnection.user}:${typedConnection.password}@${typedConnection.host}:${typedConnection.port}/${typedConnection.databaseName}`.replaceAll(' ', '');
     }
-    else if (connection.type === 'mysql') {
+    else if (connection.type === 'MySQL') {
         const typedConnection = connection;
-        return `mysql://${typedConnection.user}:${typedConnection.password}@${typedConnection.host}:${typedConnection.port}`.replaceAll(' ', '');
+        return `mysql://${typedConnection.user}:${typedConnection.password}@${typedConnection.host}:${typedConnection.port}/${typedConnection.databaseName}`.replaceAll(' ', '');
     }
-    else if (connection.type === 'snowflake') {
+    else if (connection.type === 'Snowflake') {
         const typedConnection = connection;
-        return `mysql://${typedConnection.user}:${typedConnection.password}@${typedConnection.host}:${typedConnection.port}`.replaceAll(' ', '');
+        return `snowflake://${typedConnection.user}:${typedConnection.password}@${typedConnection.host}/${typedConnection.databaseName}/${typedConnection.warehouse}`.replaceAll(' ', '');
     }
     else if (connection.type === 'BigQuery') {
         const typedConnection = connection;
@@ -89,5 +120,13 @@ export function formConnectionString(connection, jsonFile) {
             .replace(/\n/g, '');
         return cleanedJsonString;
     }
+    else if (connection.type === 'ClickHouse') {
+        const typedConnection = connection;
+        return `https://${typedConnection.user}:${typedConnection.password}@${typedConnection.host}:${typedConnection.port}/`.replaceAll(' ', '');
+    }
+    else if (connection.type === 'MSSQL') {
+        const typedConnection = connection;
+        return `mssql://${typedConnection.user}:${typedConnection.password}@${typedConnection.host}:${typedConnection.port}/${typedConnection.databaseName}`.replaceAll(' ', '');
+    }
     return '';
 }

package/dist/esm/utils/filter.d.ts

@@ -0,0 +1,222 @@
+export declare enum StringOperator {
+    IsExactly = "is exactly",
+    IsNotExactly = "is not exactly",
+    Contains = "contains",
+    Is = "is",
+    IsNot = "is not"
+}
+export declare enum DateOperator {
+    Custom = "custom",
+    InTheLast = "in the last",
+    InThePrevious = "in the previous",
+    InTheCurrent = "in the current",
+    EqualTo = "equal to",
+    NotEqualTo = "not equal to",
+    GreaterThan = "greater than",
+    LessThan = "less than",
+    GreaterThanOrEqualTo = "greater than or equal to",
+    LessThanOrEqualTo = "less than or equal to"
+}
+export declare enum NumberOperator {
+    EqualTo = "equal to",
+    NotEqualTo = "not equal to",
+    GreaterThan = "greater than",
+    LessThan = "less than",
+    GreaterThanOrEqualTo = "greater than or equal to",
+    LessThanOrEqualTo = "less than or equal to"
+}
+export declare enum NullOperator {
+    IsNotNull = "is not null",
+    IsNull = "is null"
+}
+export declare enum BoolOperator {
+    EqualTo = "equal to",
+    NotEqualTo = "not equal to"
+}
+export declare enum TimeUnit {
+    Year = "year",
+    Quarter = "quarter",
+    Month = "month",
+    Week = "week",
+    Day = "day",
+    Hour = "hour"
+}
+export declare enum FieldType {
+    String = "string",
+    Number = "number",
+    Date = "date",
+    Null = "null",
+    Boolean = "boolean"
+}
+export declare enum InternalFilterType {
+    StringFilter = "string-filter",
+    DateFilter = "date-filter",
+    DateCustomFilter = "date-custom-filter",
+    DateComparisonFilter = "date-comparison-filter",
+    NumericFilter = "numeric-filter",
+    NullFilter = "null-filter",
+    StringInFilter = "string-in-filter",
+    BooleanFilter = "boolean-filter"
+}
+export type Operator = StringOperator | DateOperator | NumberOperator | NullOperator | BoolOperator;
+export interface BaseFilter {
+    filterType: InternalFilterType;
+    fieldType: FieldType;
+    operator: Operator;
+    field: string;
+    value: any;
+    table?: string;
+}
+export declare enum FilterType {
+    String = "string",
+    Date = "date",
+    Numeric = "numeric",
+    Boolean = "boolean",
+    Null = "null"
+}
+export interface Filter {
+    filterType: FilterType;
+    operator?: StringOperator | DateOperator | NumberOperator | NullOperator | BoolOperator;
+    value: boolean | number | string | string[] | {
+        startDate: string;
+        endDate: string;
+    } | {
+        value?: number;
+        unit: TimeUnit;
+    } | null;
+    field?: string;
+    table?: string;
+}
+export interface StringFilter extends BaseFilter {
+    filterType: InternalFilterType.StringFilter;
+    fieldType: FieldType.String;
+    value: string;
+}
+export interface StringInFilter extends BaseFilter {
+    filterType: InternalFilterType.StringInFilter;
+    fieldType: FieldType.String;
+    value: string[];
+}
+export interface NumericFilter extends BaseFilter {
+    filterType: InternalFilterType.NumericFilter;
+    fieldType: FieldType.Number;
+    value: number;
+}
+export interface DateFilter extends BaseFilter {
+    filterType: InternalFilterType.DateFilter;
+    fieldType: FieldType.Date;
+    value: {
+        value: number;
+        unit: TimeUnit;
+    };
+}
+export interface DateCustomFilter extends BaseFilter {
+    filterType: InternalFilterType.DateCustomFilter;
+    fieldType: FieldType.Date;
+    value: {
+        startDate: string;
+        endDate: string;
+    };
+}
+export interface DateComparisonFilter extends BaseFilter {
+    filterType: InternalFilterType.DateComparisonFilter;
+    fieldType: FieldType.Date;
+    value: string;
+}
+export interface BooleanFilter extends BaseFilter {
+    filterType: InternalFilterType.BooleanFilter;
+    fieldType: FieldType.Boolean;
+    value: boolean;
+}
+export interface NullFilter extends BaseFilter {
+    filterType: InternalFilterType.NullFilter;
+    fieldType: FieldType.Null;
+    value: null;
+}
+export interface UserFilter extends BaseFilter {
+    isUserFilter: boolean;
+    dashboardName: string;
+}
+export type InternalFilter = BaseFilter | StringFilter | StringInFilter | NumericFilter | DateFilter | DateCustomFilter | DateComparisonFilter | BooleanFilter | NullFilter;
+export type FilterInfo = {
+    filter?: InternalFilter;
+    conditional?: string;
+};
+export type BooleanOperator = 'AND' | 'OR';
+export type Filters = [InternalFilter] | [
+    InternalFilter,
+    BooleanOperator,
+    ...Array<[InternalFilter, BooleanOperator]>,
+    InternalFilter
+];
+/** Dashboard filters are filters that persist with the dashboard */
+export declare enum DashboardFilterType {
+    String = "string",
+    Date = "date_range"
+}
+declare enum StringFilterType {
+    Default = "default",
+    Multiselect = "multiselect"
+}
+export type DashboardFilter = DashboardStringFilter | DashboardDateFilter;
+export interface DashboardBaseFilter {
+    filterType: DashboardFilterType;
+    label: string;
+    field: string;
+    dashboardName: string;
+    isUserFilter?: boolean;
+}
+export interface DashboardStringFilter extends DashboardBaseFilter {
+    table: string;
+    labelField: string;
+    filterType: DashboardFilterType.String;
+    stringFilterType: StringFilterType;
+    options: {
+        [fieldName: string]: string;
+    }[] | undefined;
+    selectedValue?: string;
+    values?: string[];
+}
+export interface DashboardDateFilter extends DashboardBaseFilter {
+    filterType: DashboardFilterType.Date;
+    comparison?: boolean;
+    defaultComparisonRange?: string;
+    options: {
+        label: string;
+        value: string;
+    }[] | undefined;
+    primaryRange: {
+        label: string;
+        value: string;
+    };
+    presetRanges?: {
+        label: string;
+        value: string;
+        startDate: Date;
+        endDate: Date;
+    }[];
+    preset: {
+        label: string;
+        value: string;
+    };
+    startDate?: Date;
+    endDate?: Date;
+    comparisonRange?: {
+        startDate?: Date;
+        endDate?: Date;
+        value: string;
+    };
+}
+export declare const convertCustomFilter: (filter: Filter) => InternalFilter;
+type QuillDateRange = {
+    startDate: Date;
+    endDate: Date;
+};
+export declare const PRIMARY_RANGE: {
+    [key: string]: QuillDateRange | {
+        startDate: undefined;
+        endDate: undefined;
+    };
+};
+export {};
+//# sourceMappingURL=filter.d.ts.map

package/dist/esm/utils/filter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../../../src/utils/filter.ts"],"names":[],"mappings":"AA0CA,oBAAY,cAAc;IACxB,SAAS,eAAa;IACtB,YAAY,mBAAiB;IAC7B,QAAQ,aAAW;IACnB,EAAE,OAAK;IACP,KAAK,WAAS;CACf;AAED,oBAAY,YAAY;IACtB,MAAM,WAAS;IACf,SAAS,gBAAc;IACvB,aAAa,oBAAkB;IAC/B,YAAY,mBAAiB;IAC7B,OAAO,aAAW;IAClB,UAAU,iBAAe;IACzB,WAAW,iBAAe;IAC1B,QAAQ,cAAY;IACpB,oBAAoB,6BAA2B;IAC/C,iBAAiB,0BAAwB;CAC1C;AAED,oBAAY,cAAc;IACxB,OAAO,aAAW;IAClB,UAAU,iBAAe;IACzB,WAAW,iBAAe;IAC1B,QAAQ,cAAY;IACpB,oBAAoB,6BAA2B;IAC/C,iBAAiB,0BAAwB;CAC1C;AAED,oBAAY,YAAY;IACtB,SAAS,gBAAc;IACvB,MAAM,YAAU;CACjB;AAED,oBAAY,YAAY;IACtB,OAAO,aAAW;IAClB,UAAU,iBAAe;CAC1B;AAED,oBAAY,QAAQ;IAClB,IAAI,SAAO;IACX,OAAO,YAAU;IACjB,KAAK,UAAQ;IACb,IAAI,SAAO;IACX,GAAG,QAAM;IACT,IAAI,SAAO;CACZ;AAED,oBAAY,SAAS;IACnB,MAAM,WAAS;IACf,MAAM,WAAS;IACf,IAAI,SAAO;IACX,IAAI,SAAO;IACX,OAAO,YAAU;CAClB;AAED,oBAAY,kBAAkB;IAC5B,YAAY,kBAAkB;IAC9B,UAAU,gBAAgB;IAC1B,gBAAgB,uBAAuB;IACvC,oBAAoB,2BAA2B;IAC/C,aAAa,mBAAmB;IAChC,UAAU,gBAAgB;IAC1B,cAAc,qBAAqB;IACnC,aAAa,mBAAmB;CACjC;AAED,MAAM,MAAM,QAAQ,GAChB,cAAc,GACd,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,YAAY,CAAC;AAEjB,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,IAAI,SAAS;CACd;AAGD,MAAM,WAAW,MAAM;IACrB,UAAU,EAAE,UAAU,CAAC;IACvB,QAAQ,CAAC,EACL,cAAc,GACd,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,YAAY,CAAC;IACjB,KAAK,EACD,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,EAAE,GACR;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GACtC;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,GAClC,IAAI,CAAC;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,UAAU,EAAE,kBAAkB,CAAC,YAAY,CAAC;IAC5C,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,UAAU,EAAE,kBAAkB,CAAC,cAAc,CAAC;IAC9C,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;IAC5B,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C,UAAU,EAAE,kBAAkB,CAAC,aAAa,CAAC;IAC7C,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,UAAU,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAC1C,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC;IAC1B,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAA;KAAE,CAAC;CAC1C;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,UAAU,EAAE,kBAAkB,CAAC,gBAAgB,CAAC;IAChD,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC;IAC1B,KAAK,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,UAAU,EAAE,kBAAkB,CAAC,oBAAoB,CAAC;IACpD,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC/C,UAAU,EAAE,kBAAkB,CAAC,aAAa,CAAC;IAC7C,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC;IAC7B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,UAAU,EAAE,kBAAkB,CAAC,UAAU,CAAC;IAC1C,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC;IAC1B,KAAK,EAAE,IAAI,CAAC;CACb;AAED,MAAM,WAAW,UAAW,SAAQ,UAAU;IAC5C,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,cAAc,GACtB,UAAU,GACV,YAAY,GACZ,cAAc,GACd,aAAa,GACb,UAAU,GACV,gBAAgB,GAChB,oBAAoB,GACpB,aAAa,GACb,UAAU,CAAC;AAGf,MAAM,MAAM,UAAU,GAAG;IAAE,MAAM,CAAC,EAAE,cAAc,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3E,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,IAAI,CAAC;AAE3C,MAAM,MAAM,OAAO,GACf,CAAC,cAAc,CAAC,GAChB;IACE,cAAc;IACd,eAAe;IACf,GAAG,KAAK,CAAC,CAAC,cAAc,EAAE,eAAe,CAAC,CAAC;IAC3C,cAAc;CACf,CAAC;AAEN,oEAAoE;AACpE,oBAAY,mBAAmB;IAC7B,MAAM,WAAW;IACjB,IAAI,eAAe;CACpB;AAED,aAAK,gBAAgB;IACnB,OAAO,YAAY;IACnB,WAAW,gBAAgB;CAC5B;AAED,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,mBAAmB,CAAC;AAE1E,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,mBAAmB,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,mBAAmB,CAAC,MAAM,CAAC;IACvC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,OAAO,EAAE;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;IACvD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,UAAU,EAAE,mBAAmB,CAAC,IAAI,CAAC;IACrC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;IACxD,YAAY,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/C,YAAY,CAAC,EAAE;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,IAAI,CAAC;QAChB,OAAO,EAAE,IAAI,CAAC;KACf,EAAE,CAAC;IACJ,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,eAAe,CAAC,EAAE;QAChB,SAAS,CAAC,EAAE,IAAI,CAAC;QACjB,OAAO,CAAC,EAAE,IAAI,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED,eAAO,MAAM,mBAAmB,WAAY,MAAM,KAAG,cA0QpD,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,IAAI,CAAC;CACf,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,OAAO,EAAE,SAAS,CAAA;KAAE,CAAC;CAyB9E,CAAC"}