@tetrascience-npm/tetrascience-react-ui 0.3.0 → 0.4.0-beta.10.1

package/dist/providers/athena.d.ts

@@ -0,0 +1,79 @@
+import * as _aws_sdk_client_athena from '@aws-sdk/client-athena';
+export { I as InvalidProviderConfigurationError, M as MissingTableError, P as ProviderConfiguration, a as ProviderConnectionError, b as ProviderError, Q as QueryError, c as QueryResult } from './types-Ck4uFaGp.js';
+
+/**
+ * Athena Data Provider
+ *
+ * TypeScript equivalent of AthenaProvider from
+ * ts-lib-ui-kit-streamlit/tetrascience/data_app_providers/provider.py
+ *
+ * @remarks
+ * This provider requires the `@aws-sdk/client-athena` package to be installed.
+ * It is an optional peer dependency - install it only if you need Athena support:
+ * ```bash
+ * npm install @aws-sdk/client-athena
+ * # or
+ * yarn add @aws-sdk/client-athena
+ * ```
+ */
+type AthenaClient = _aws_sdk_client_athena.AthenaClient;
+type AthenaSDK = typeof _aws_sdk_client_athena;
+/**
+ * Athena data provider
+ */
+declare class AthenaProvider {
+    private client;
+    private sdk;
+    private workgroup;
+    private database;
+    private outputLocation?;
+    /**
+     * Initialize the Athena data provider
+     *
+     * @param client - AWS Athena client
+     * @param sdk - AWS Athena SDK module (for accessing command classes)
+     * @param workgroup - Athena workgroup to use
+     * @param database - Default database/schema
+     * @param outputLocation - Optional S3 output location
+     */
+    constructor(client: AthenaClient, sdk: AthenaSDK, workgroup: string, database: string, outputLocation?: string);
+    /**
+     * Query the Athena database
+     *
+     * @param sqlQuery - SQL query to execute
+     * @param _params - Parameters to pass to the query (currently not used - Athena doesn't support parameterized queries)
+     * @returns Promise resolving to array of row objects
+     *
+     * @remarks
+     * **Security Note:** AWS Athena does not support parameterized queries.
+     * Unlike traditional databases, there is no native way to use bind parameters
+     * with Athena. Callers are responsible for properly sanitizing any user input
+     * before constructing the SQL query string. This is a known limitation of the
+     * Athena service, not a design flaw in this implementation.
+     */
+    query(sqlQuery: string, _params?: Record<string, unknown>): Promise<Array<Record<string, unknown>>>;
+    /**
+     * Wait for query to complete
+     */
+    private waitForQueryCompletion;
+    /**
+     * Fetch all results from a completed query
+     */
+    private fetchAllResults;
+    /**
+     * Close the Athena client (no-op for AWS SDK clients)
+     */
+    close(): Promise<void>;
+}
+/**
+ * Get the TDP Athena provider
+ *
+ * Creates an Athena provider using TDP environment configuration
+ *
+ * @returns Promise resolving to Athena data provider
+ * @throws {InvalidProviderConfigurationError} If @aws-sdk/client-athena is not installed
+ * @throws {Error} If ATHENA_S3_OUTPUT_LOCATION is not set when using the 'primary' workgroup
+ */
+declare function getTdpAthenaProvider(): Promise<AthenaProvider>;
+
+export { AthenaProvider, getTdpAthenaProvider };

package/dist/providers/databricks.d.ts

@@ -0,0 +1,43 @@
+import * as _databricks_sql_dist_contracts_IDBSQLSession from '@databricks/sql/dist/contracts/IDBSQLSession';
+import * as _databricks_sql from '@databricks/sql';
+import { P as ProviderConfiguration } from './types-Ck4uFaGp.js';
+export { I as InvalidProviderConfigurationError, M as MissingTableError, a as ProviderConnectionError, b as ProviderError, Q as QueryError, c as QueryResult } from './types-Ck4uFaGp.js';
+
+type DBSQLClient = _databricks_sql.DBSQLClient;
+type IDBSQLSession = _databricks_sql_dist_contracts_IDBSQLSession.default;
+/**
+ * Databricks data provider
+ */
+declare class DatabricksProvider {
+    private client;
+    private session;
+    /**
+     * Initialize the Databricks data provider
+     *
+     * @param client - Databricks SQL client
+     * @param session - Databricks SQL session
+     */
+    constructor(client: DBSQLClient, session: IDBSQLSession);
+    /**
+     * Query the Databricks database
+     *
+     * @param sqlQuery - SQL query to execute
+     * @param _params - Parameters to pass to the query (currently not used)
+     * @returns Promise resolving to array of row objects
+     */
+    query(sqlQuery: string, _params?: Record<string, unknown>): Promise<Array<Record<string, unknown>>>;
+    /**
+     * Close the Databricks connection
+     */
+    close(): Promise<void>;
+}
+/**
+ * Build a Databricks data provider from the configuration
+ *
+ * @param config - Provider configuration
+ * @returns Promise resolving to Databricks data provider
+ * @throws {InvalidProviderConfigurationError} If @databricks/sql is not installed or config is invalid
+ */
+declare function buildDatabricksProvider(config: ProviderConfiguration): Promise<DatabricksProvider>;
+
+export { DatabricksProvider, ProviderConfiguration, buildDatabricksProvider };

package/dist/providers/snowflake.d.ts

@@ -0,0 +1,40 @@
+import * as snowflake_sdk from 'snowflake-sdk';
+import { P as ProviderConfiguration } from './types-Ck4uFaGp.js';
+export { I as InvalidProviderConfigurationError, M as MissingTableError, a as ProviderConnectionError, b as ProviderError, Q as QueryError, c as QueryResult } from './types-Ck4uFaGp.js';
+
+type SnowflakeConnection = snowflake_sdk.Connection;
+/**
+ * Snowflake data provider
+ */
+declare class SnowflakeProvider {
+    private connection;
+    /**
+     * Initialize the Snowflake data provider
+     *
+     * @param connection - Snowflake connection
+     */
+    constructor(connection: SnowflakeConnection);
+    /**
+     * Query the Snowflake database
+     *
+     * @param sqlText - SQL query to execute
+     * @param params - Parameters to pass to the query. For positional binds, use an array.
+     *                 For named binds, use an object with keys matching the bind variable names.
+     * @returns Promise resolving to array of row objects
+     */
+    query(sqlText: string, params?: Record<string, unknown> | unknown[]): Promise<Array<Record<string, unknown>>>;
+    /**
+     * Close the Snowflake connection
+     */
+    close(): Promise<void>;
+}
+/**
+ * Build a Snowflake data provider from the configuration
+ *
+ * @param config - Provider configuration
+ * @returns Promise resolving to Snowflake data provider
+ * @throws {InvalidProviderConfigurationError} If snowflake-sdk is not installed or config is invalid
+ */
+declare function buildSnowflakeProvider(config: ProviderConfiguration): Promise<SnowflakeProvider>;
+
+export { ProviderConfiguration, SnowflakeProvider, buildSnowflakeProvider };

package/dist/providers/types-Ck4uFaGp.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Provider Exceptions
+ *
+ * TypeScript equivalents of the Python exceptions from
+ * ts-lib-ui-kit-streamlit/tetrascience/data_app_providers/exceptions.py
+ */
+/**
+ * Base class for provider errors
+ */
+declare class ProviderError extends Error {
+    constructor(message: string);
+}
+/**
+ * Raised when a table is missing in the database
+ */
+declare class MissingTableError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when a query fails
+ */
+declare class QueryError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when connecting to a provider fails
+ */
+declare class ProviderConnectionError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when the provider configuration is invalid
+ */
+declare class InvalidProviderConfigurationError extends ProviderError {
+    constructor(message: string);
+}
+
+/**
+ * Data App Provider Types
+ *
+ * TypeScript equivalents of the Python ProviderConfiguration Pydantic models
+ * from ts-lib-ui-kit-streamlit/tetrascience/data_app_providers/provider_typing.py
+ */
+/**
+ * Configuration model for data providers.
+ *
+ * This interface represents the configuration needed to connect to various
+ * database providers (Snowflake, Databricks, Athena, Benchling, etc.)
+ * attached to a data app.
+ */
+interface ProviderConfiguration {
+    /** Human-readable name of the provider */
+    name: string;
+    /** Provider type (snowflake, databricks, benchling, custom, etc.) */
+    type: string;
+    /** Optional URL to the provider's icon */
+    iconUrl?: string;
+    /** Dictionary containing connection details and credentials */
+    fields: Record<string, string | undefined>;
+}
+/**
+ * Standardized query result from data providers.
+ *
+ * This interface provides a consistent shape for query results across
+ * all provider types (Snowflake, Databricks, Athena), with optional
+ * metadata for API responses.
+ */
+interface QueryResult {
+    /** Array of row objects returned by the query */
+    data: Array<Record<string, unknown>>;
+    /** Number of rows returned */
+    rowCount: number;
+    /** Name of the provider that executed the query */
+    provider?: string;
+    /** Whether this is mock/demo data */
+    mock?: boolean;
+    /** Optional message (e.g., for errors or warnings) */
+    message?: string;
+}
+
+export { InvalidProviderConfigurationError as I, MissingTableError as M, QueryError as Q, ProviderConnectionError as a, ProviderError as b };
+export type { ProviderConfiguration as P, QueryResult as c };

package/dist/server.d.ts

@@ -1,3 +1,9 @@
+import { TDPClient } from '@tetrascience-npm/ts-connectors-sdk';
+import * as snowflake_sdk from 'snowflake-sdk';
+import * as _databricks_sql_dist_contracts_IDBSQLSession from '@databricks/sql/dist/contracts/IDBSQLSession';
+import * as _databricks_sql from '@databricks/sql';
+import * as _aws_sdk_client_athena from '@aws-sdk/client-athena';
+
 /**
  * JWT Token Manager for TetraScience Data Apps
  *
@@ -90,5 +96,430 @@ declare class JwtTokenManager {
  */
 declare const jwtManager: JwtTokenManager;
 
-export { JwtTokenManager, jwtManager };
-export type { CookieDict, ExpressRequestLike, JwtTokenManagerConfig };
+/**
+ * Provider Exceptions
+ *
+ * TypeScript equivalents of the Python exceptions from
+ * ts-lib-ui-kit-streamlit/tetrascience/data_app_providers/exceptions.py
+ */
+/**
+ * Base class for provider errors
+ */
+declare class ProviderError extends Error {
+    constructor(message: string);
+}
+/**
+ * Raised when a table is missing in the database
+ */
+declare class MissingTableError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when a query fails
+ */
+declare class QueryError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when connecting to a provider fails
+ */
+declare class ProviderConnectionError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when the provider configuration is invalid
+ */
+declare class InvalidProviderConfigurationError extends ProviderError {
+    constructor(message: string);
+}
+
+/**
+ * Data App Provider Types
+ *
+ * TypeScript equivalents of the Python ProviderConfiguration Pydantic models
+ * from ts-lib-ui-kit-streamlit/tetrascience/data_app_providers/provider_typing.py
+ */
+/**
+ * Configuration model for data providers.
+ *
+ * This interface represents the configuration needed to connect to various
+ * database providers (Snowflake, Databricks, Athena, Benchling, etc.)
+ * attached to a data app.
+ */
+interface ProviderConfiguration {
+    /** Human-readable name of the provider */
+    name: string;
+    /** Provider type (snowflake, databricks, benchling, custom, etc.) */
+    type: string;
+    /** Optional URL to the provider's icon */
+    iconUrl?: string;
+    /** Dictionary containing connection details and credentials */
+    fields: Record<string, string | undefined>;
+}
+/**
+ * Minimal provider information as returned by the /dataapps/apps/{appId} endpoint
+ */
+interface MinimalProvider {
+    id: string;
+    orgSlug: string;
+    name: string;
+    type: string;
+    iconUrl: string;
+    createdAt: string;
+    updatedAt?: string;
+    createdBy: string;
+    updatedBy?: string;
+}
+/**
+ * Provider secret information from the provider API response
+ */
+interface ProviderSecret {
+    name: string;
+    value?: string;
+    type: string;
+    required: boolean;
+    arn: string;
+    envName: string;
+}
+/**
+ * Full provider API response including secrets
+ */
+interface ProviderApiResponse {
+    id: string;
+    orgSlug: string;
+    name: string;
+    type: string;
+    iconUrl: string;
+    createdAt: string;
+    updatedAt?: string;
+    createdBy: string;
+    updatedBy?: string;
+    dataAppCount: string;
+    secrets: ProviderSecret[];
+}
+/**
+ * Container data app response from /dataapps/apps/container/{connectorId}
+ */
+interface ContainerDataApp {
+    id: string;
+    orgSlug: string;
+    connectorId: string;
+    serviceNamespace: string;
+    serviceDiscoveryName: string;
+    createdAt: string;
+    updatedAt?: string;
+    createdBy: string;
+    updatedBy?: string;
+    port: string;
+    config: Record<string, unknown>;
+    providers: MinimalProvider[];
+}
+/**
+ * Organization API response
+ */
+interface OrganizationApiResponse {
+    id: string;
+    orgSlug: string;
+    name: string;
+    emailDomain: string;
+    authType: string;
+    features: Record<string, unknown>;
+    tenantId: string;
+    createdAt: string;
+    createdBy: string;
+    modifiedAt?: string;
+    modifiedBy?: string;
+    subdomain: string;
+    ssoEnabledOnTenant: boolean;
+}
+/**
+ * Options for getProviderConfigurations function
+ */
+interface GetProviderConfigurationsOptions {
+    /** Override provider configurations JSON (for local development) */
+    providerConfigOverride?: string;
+    /** Connector ID (defaults to CONNECTOR_ID env var) */
+    connectorId?: string;
+}
+/**
+ * Display-friendly provider information for UI components.
+ *
+ * A simplified subset of ProviderConfiguration containing only the
+ * fields needed for displaying provider information in the UI,
+ * including the names of available connection fields without their
+ * secret values.
+ */
+interface ProviderInfo {
+    /** Human-readable name of the provider */
+    name: string;
+    /** Provider type (snowflake, databricks, athena, etc.) */
+    type: string;
+    /** Optional URL to the provider's icon */
+    iconUrl?: string | null;
+    /** Names of available connection fields (without secret values) */
+    availableFields: string[];
+}
+/**
+ * Standardized query result from data providers.
+ *
+ * This interface provides a consistent shape for query results across
+ * all provider types (Snowflake, Databricks, Athena), with optional
+ * metadata for API responses.
+ */
+interface QueryResult {
+    /** Array of row objects returned by the query */
+    data: Array<Record<string, unknown>>;
+    /** Number of rows returned */
+    rowCount: number;
+    /** Name of the provider that executed the query */
+    provider?: string;
+    /** Whether this is mock/demo data */
+    mock?: boolean;
+    /** Optional message (e.g., for errors or warnings) */
+    message?: string;
+}
+
+/**
+ * Get Provider Configurations
+ *
+ * TypeScript equivalent of get_provider_configurations from
+ * ts-lib-ui-kit-streamlit/tetrascience/data_app_providers/provider.py
+ *
+ * Retrieves data app provider configurations either from environment variable
+ * override or by fetching from the TDP API.
+ */
+
+/**
+ * Get the provider configurations.
+ *
+ * There are two ways to get the provider configurations:
+ * 1. If the environment variable `DATA_APP_PROVIDER_CONFIG` is set or
+ *    providerConfigOverride is provided, the provider configurations are read from it.
+ * 2. If the environment variable `CONNECTOR_ID` is set or connectorId is provided,
+ *    the provider configurations are fetched from TDP. The secrets are read from
+ *    environment variables.
+ * 3. If neither of the above is set, an empty array is returned.
+ *
+ * Option 1 is used for local development to specify the provider configurations directly.
+ * Option 2 is used in production to fetch the provider configurations from TDP.
+ *
+ * @param client - Initialized TDPClient instance (call client.init() first)
+ * @param options - Optional configuration overrides
+ * @returns Array of provider configurations
+ * @throws {InvalidProviderConfigurationError} If provider config JSON is invalid
+ * @throws {Error} If TDPClient is not initialized
+ *
+ * @example
+ * ```typescript
+ * import { TDPClient } from '@tetrascience-npm/ts-connectors-sdk';
+ * import { getProviderConfigurations } from '@tetrascience-npm/tetrascience-react-ui/server';
+ *
+ * // Initialize TDPClient with user's JWT token
+ * // Other fields (tdpEndpoint, connectorId, orgSlug) are read from environment variables
+ * const client = new TDPClient({
+ *   authToken: userJwtToken, // from jwtManager.getTokenFromExpressRequest(req)
+ *   artifactType: "data-app",
+ * });
+ * await client.init();
+ *
+ * const providers = await getProviderConfigurations(client);
+ *
+ * for (const provider of providers) {
+ *   console.log(`Provider: ${provider.name} (${provider.type})`);
+ * }
+ * ```
+ */
+declare function getProviderConfigurations(client: TDPClient, options?: GetProviderConfigurationsOptions): Promise<ProviderConfiguration[]>;
+
+type SnowflakeConnection = snowflake_sdk.Connection;
+/**
+ * Snowflake data provider
+ */
+declare class SnowflakeProvider {
+    private connection;
+    /**
+     * Initialize the Snowflake data provider
+     *
+     * @param connection - Snowflake connection
+     */
+    constructor(connection: SnowflakeConnection);
+    /**
+     * Query the Snowflake database
+     *
+     * @param sqlText - SQL query to execute
+     * @param params - Parameters to pass to the query. For positional binds, use an array.
+     *                 For named binds, use an object with keys matching the bind variable names.
+     * @returns Promise resolving to array of row objects
+     */
+    query(sqlText: string, params?: Record<string, unknown> | unknown[]): Promise<Array<Record<string, unknown>>>;
+    /**
+     * Close the Snowflake connection
+     */
+    close(): Promise<void>;
+}
+/**
+ * Build a Snowflake data provider from the configuration
+ *
+ * @param config - Provider configuration
+ * @returns Promise resolving to Snowflake data provider
+ * @throws {InvalidProviderConfigurationError} If snowflake-sdk is not installed or config is invalid
+ */
+declare function buildSnowflakeProvider(config: ProviderConfiguration): Promise<SnowflakeProvider>;
+
+type DBSQLClient = _databricks_sql.DBSQLClient;
+type IDBSQLSession = _databricks_sql_dist_contracts_IDBSQLSession.default;
+/**
+ * Databricks data provider
+ */
+declare class DatabricksProvider {
+    private client;
+    private session;
+    /**
+     * Initialize the Databricks data provider
+     *
+     * @param client - Databricks SQL client
+     * @param session - Databricks SQL session
+     */
+    constructor(client: DBSQLClient, session: IDBSQLSession);
+    /**
+     * Query the Databricks database
+     *
+     * @param sqlQuery - SQL query to execute
+     * @param _params - Parameters to pass to the query (currently not used)
+     * @returns Promise resolving to array of row objects
+     */
+    query(sqlQuery: string, _params?: Record<string, unknown>): Promise<Array<Record<string, unknown>>>;
+    /**
+     * Close the Databricks connection
+     */
+    close(): Promise<void>;
+}
+/**
+ * Build a Databricks data provider from the configuration
+ *
+ * @param config - Provider configuration
+ * @returns Promise resolving to Databricks data provider
+ * @throws {InvalidProviderConfigurationError} If @databricks/sql is not installed or config is invalid
+ */
+declare function buildDatabricksProvider(config: ProviderConfiguration): Promise<DatabricksProvider>;
+
+/**
+ * Athena Data Provider
+ *
+ * TypeScript equivalent of AthenaProvider from
+ * ts-lib-ui-kit-streamlit/tetrascience/data_app_providers/provider.py
+ *
+ * @remarks
+ * This provider requires the `@aws-sdk/client-athena` package to be installed.
+ * It is an optional peer dependency - install it only if you need Athena support:
+ * ```bash
+ * npm install @aws-sdk/client-athena
+ * # or
+ * yarn add @aws-sdk/client-athena
+ * ```
+ */
+type AthenaClient = _aws_sdk_client_athena.AthenaClient;
+type AthenaSDK = typeof _aws_sdk_client_athena;
+/**
+ * Athena data provider
+ */
+declare class AthenaProvider {
+    private client;
+    private sdk;
+    private workgroup;
+    private database;
+    private outputLocation?;
+    /**
+     * Initialize the Athena data provider
+     *
+     * @param client - AWS Athena client
+     * @param sdk - AWS Athena SDK module (for accessing command classes)
+     * @param workgroup - Athena workgroup to use
+     * @param database - Default database/schema
+     * @param outputLocation - Optional S3 output location
+     */
+    constructor(client: AthenaClient, sdk: AthenaSDK, workgroup: string, database: string, outputLocation?: string);
+    /**
+     * Query the Athena database
+     *
+     * @param sqlQuery - SQL query to execute
+     * @param _params - Parameters to pass to the query (currently not used - Athena doesn't support parameterized queries)
+     * @returns Promise resolving to array of row objects
+     *
+     * @remarks
+     * **Security Note:** AWS Athena does not support parameterized queries.
+     * Unlike traditional databases, there is no native way to use bind parameters
+     * with Athena. Callers are responsible for properly sanitizing any user input
+     * before constructing the SQL query string. This is a known limitation of the
+     * Athena service, not a design flaw in this implementation.
+     */
+    query(sqlQuery: string, _params?: Record<string, unknown>): Promise<Array<Record<string, unknown>>>;
+    /**
+     * Wait for query to complete
+     */
+    private waitForQueryCompletion;
+    /**
+     * Fetch all results from a completed query
+     */
+    private fetchAllResults;
+    /**
+     * Close the Athena client (no-op for AWS SDK clients)
+     */
+    close(): Promise<void>;
+}
+/**
+ * Get the TDP Athena provider
+ *
+ * Creates an Athena provider using TDP environment configuration
+ *
+ * @returns Promise resolving to Athena data provider
+ * @throws {InvalidProviderConfigurationError} If @aws-sdk/client-athena is not installed
+ * @throws {Error} If ATHENA_S3_OUTPUT_LOCATION is not set when using the 'primary' workgroup
+ */
+declare function getTdpAthenaProvider(): Promise<AthenaProvider>;
+
+/**
+ * Build Provider Factory
+ *
+ * TypeScript equivalent of build_provider from
+ * ts-lib-ui-kit-streamlit/tetrascience/data_app_providers/provider.py
+ */
+
+/**
+ * Union type of all supported data providers
+ */
+type DataProvider = SnowflakeProvider | DatabricksProvider | AthenaProvider;
+/**
+ * Build a data provider from the configuration
+ *
+ * The return type is a union of specific provider types. More provider types
+ * may be added in the future.
+ *
+ * @param config - Provider configuration
+ * @returns Promise resolving to the appropriate data provider
+ * @throws {InvalidProviderConfigurationError} If the provider type is not supported
+ *
+ * @example
+ * ```typescript
+ * import { TDPClient } from '@tetrascience-npm/ts-connectors-sdk';
+ * import { buildProvider, getProviderConfigurations } from '@tetrascience-npm/tetrascience-react-ui/server';
+ *
+ * // Other fields (tdpEndpoint, connectorId, orgSlug) are read from environment variables
+ * const client = new TDPClient({
+ *   authToken: userJwt,
+ *   artifactType: "data-app",
+ * });
+ * await client.init();
+ * const configs = await getProviderConfigurations(client);
+ *
+ * const snowflakeConfig = configs.find(c => c.type === 'snowflake');
+ * if (snowflakeConfig) {
+ *   const provider = await buildProvider(snowflakeConfig);
+ *   const results = await provider.query('SELECT * FROM my_table');
+ * }
+ * ```
+ */
+declare function buildProvider(config: ProviderConfiguration): Promise<DataProvider>;
+
+export { AthenaProvider, DatabricksProvider, InvalidProviderConfigurationError, JwtTokenManager, MissingTableError, ProviderConnectionError, ProviderError, QueryError, SnowflakeProvider, buildDatabricksProvider, buildProvider, buildSnowflakeProvider, getProviderConfigurations, getTdpAthenaProvider, jwtManager };
+export type { ContainerDataApp, CookieDict, DataProvider, ExpressRequestLike, GetProviderConfigurationsOptions, JwtTokenManagerConfig, MinimalProvider, OrganizationApiResponse, ProviderApiResponse, ProviderConfiguration, ProviderInfo, ProviderSecret, QueryResult };