@tetrascience-npm/tetrascience-react-ui 0.7.0-beta.128.1 → 0.7.0-beta.130.1

package/dist/server/providers/SnowflakeProvider.d.ts

@@ -0,0 +1,36 @@
+import { ProviderConfiguration } from './types';
+type SnowflakeConnection = import('snowflake-sdk').Connection;
+/**
+ * Snowflake data provider
+ */
+export 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
+ */
+export declare function buildSnowflakeProvider(config: ProviderConfiguration): Promise<SnowflakeProvider>;
+export {};

package/dist/server/providers/buildProvider.d.ts

@@ -0,0 +1,39 @@
+import { AthenaProvider } from './AthenaProvider';
+import { DatabricksProvider } from './DatabricksProvider';
+import { SnowflakeProvider } from './SnowflakeProvider';
+import { ProviderConfiguration } from './types';
+/**
+ * Union type of all supported data providers
+ */
+export 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');
+ * }
+ * ```
+ */
+export declare function buildProvider(config: ProviderConfiguration): Promise<DataProvider>;

package/dist/server/providers/entries/athena.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Athena Provider Entry Point
+ *
+ * Standalone entry point for the Athena provider.
+ * Import from '@tetrascience-npm/tetrascience-react-ui/server/providers/athena'
+ * to only include Athena-related code in your bundle.
+ *
+ * @example
+ * ```typescript
+ * import { AthenaProvider, getTdpAthenaProvider } from '@tetrascience-npm/tetrascience-react-ui/server/providers/athena';
+ *
+ * const provider = await getTdpAthenaProvider(config);
+ * const result = await provider.query('SELECT * FROM my_table');
+ * ```
+ *
+ * @remarks
+ * Requires `@aws-sdk/client-athena` to be installed:
+ * ```bash
+ * npm install @aws-sdk/client-athena
+ * ```
+ */
+export { AthenaProvider, getTdpAthenaProvider } from '../AthenaProvider';
+export { ProviderError, MissingTableError, QueryError, ProviderConnectionError, InvalidProviderConfigurationError, } from '../exceptions';
+export type { ProviderConfiguration, QueryResult } from '../types';

package/dist/server/providers/entries/databricks.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Databricks Provider Entry Point
+ *
+ * Standalone entry point for the Databricks provider.
+ * Import from '@tetrascience-npm/tetrascience-react-ui/server/providers/databricks'
+ * to only include Databricks-related code in your bundle.
+ *
+ * @example
+ * ```typescript
+ * import { DatabricksProvider, buildDatabricksProvider } from '@tetrascience-npm/tetrascience-react-ui/server/providers/databricks';
+ *
+ * const provider = await buildDatabricksProvider(config);
+ * const result = await provider.query('SELECT * FROM my_table');
+ * await provider.close();
+ * ```
+ *
+ * @remarks
+ * Requires `@databricks/sql` to be installed:
+ * ```bash
+ * npm install @databricks/sql
+ * ```
+ */
+export { DatabricksProvider, buildDatabricksProvider, } from '../DatabricksProvider';
+export { ProviderError, MissingTableError, QueryError, ProviderConnectionError, InvalidProviderConfigurationError, } from '../exceptions';
+export type { ProviderConfiguration, QueryResult } from '../types';

package/dist/server/providers/entries/snowflake.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Snowflake Provider Entry Point
+ *
+ * Standalone entry point for the Snowflake provider.
+ * Import from '@tetrascience-npm/tetrascience-react-ui/server/providers/snowflake'
+ * to only include Snowflake-related code in your bundle.
+ *
+ * @example
+ * ```typescript
+ * import { SnowflakeProvider, buildSnowflakeProvider } from '@tetrascience-npm/tetrascience-react-ui/server/providers/snowflake';
+ *
+ * const provider = await buildSnowflakeProvider(config);
+ * const result = await provider.query('SELECT * FROM my_table');
+ * await provider.close();
+ * ```
+ *
+ * @remarks
+ * Requires `snowflake-sdk` to be installed:
+ * ```bash
+ * npm install snowflake-sdk
+ * ```
+ */
+export { SnowflakeProvider, buildSnowflakeProvider } from '../SnowflakeProvider';
+export { ProviderError, MissingTableError, QueryError, ProviderConnectionError, InvalidProviderConfigurationError, } from '../exceptions';
+export type { ProviderConfiguration, QueryResult } from '../types';

package/dist/server/providers/exceptions.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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
+ */
+export declare class ProviderError extends Error {
+    constructor(message: string);
+}
+/**
+ * Raised when a table is missing in the database
+ */
+export declare class MissingTableError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when a query fails
+ */
+export declare class QueryError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when connecting to a provider fails
+ */
+export declare class ProviderConnectionError extends ProviderError {
+    constructor(message: string);
+}
+/**
+ * Raised when the provider configuration is invalid
+ */
+export declare class InvalidProviderConfigurationError extends ProviderError {
+    constructor(message: string);
+}

package/dist/server/providers/getProviderConfigurations.d.ts

@@ -0,0 +1,45 @@
+import { InvalidProviderConfigurationError } from './exceptions';
+import { GetProviderConfigurationsOptions, ProviderConfiguration } from './types';
+import { TDPClient } from '@tetrascience-npm/ts-connectors-sdk';
+export { InvalidProviderConfigurationError };
+/**
+ * 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})`);
+ * }
+ * ```
+ */
+export declare function getProviderConfigurations(client: TDPClient, options?: GetProviderConfigurationsOptions): Promise<ProviderConfiguration[]>;

package/dist/server/providers/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Data App Provider utilities for TetraScience data apps
+ *
+ * TypeScript equivalents of the Python helpers from ts-lib-ui-kit-streamlit
+ * for retrieving data app provider configurations and database providers.
+ *
+ * Note: This module uses TDPClient from @tetrascience-npm/ts-connectors-sdk
+ * for TDP API calls. Initialize TDPClient with the user's JWT token:
+ *
+ * @example
+ * ```typescript
+ * import { TDPClient } from '@tetrascience-npm/ts-connectors-sdk';
+ * import { 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 providers = await getProviderConfigurations(client);
+ * ```
+ */
+export { getProviderConfigurations } from './getProviderConfigurations';
+export { getProviderInfoList, getProviderByName, getProvidersByType, getProviderNames, getProviderTypes, } from './providerDiscovery';
+export { ProviderError, MissingTableError, QueryError, ProviderConnectionError, InvalidProviderConfigurationError, } from './exceptions';
+export { SnowflakeProvider, buildSnowflakeProvider } from './SnowflakeProvider';
+export { DatabricksProvider, buildDatabricksProvider, } from './DatabricksProvider';
+export { AthenaProvider, getTdpAthenaProvider } from './AthenaProvider';
+export { buildProvider, type DataProvider } from './buildProvider';
+export type { ProviderConfiguration, MinimalProvider, ProviderSecret, ProviderApiResponse, ContainerDataApp, OrganizationApiResponse, GetProviderConfigurationsOptions, ProviderInfo, QueryResult, } from './types';

package/dist/server/providers/providerDiscovery.d.ts

@@ -0,0 +1,81 @@
+import { ProviderConfiguration, ProviderInfo } from './types';
+/**
+ * Extract display-friendly provider information from full configurations.
+ *
+ * Returns a list of {@link ProviderInfo} objects containing name, type,
+ * iconUrl, and the names of available connection fields — suitable for
+ * populating UI dropdowns and selection lists without exposing secret values.
+ *
+ * @param configs - Array of provider configurations from getProviderConfigurations()
+ * @returns Array of display-friendly provider info objects
+ *
+ * @example
+ * ```typescript
+ * const configs = await getProviderConfigurations(client);
+ * const providerList = getProviderInfoList(configs);
+ * // [{ name: "my-snowflake", type: "snowflake", iconUrl: "...", availableFields: ["user", "password", "account"] }, ...]
+ * ```
+ */
+export declare function getProviderInfoList(configs: ProviderConfiguration[]): ProviderInfo[];
+/**
+ * Find a provider configuration by name.
+ *
+ * @param configs - Array of provider configurations from getProviderConfigurations()
+ * @param name - The provider name to search for (case-sensitive)
+ * @returns The matching provider configuration, or undefined if not found
+ *
+ * @example
+ * ```typescript
+ * const configs = await getProviderConfigurations(client);
+ * const snowflake = getProviderByName(configs, "my-snowflake-provider");
+ * if (snowflake) {
+ *   const provider = await buildProvider(snowflake);
+ * }
+ * ```
+ */
+export declare function getProviderByName(configs: ProviderConfiguration[], name: string): ProviderConfiguration | undefined;
+/**
+ * Find all provider configurations of a given type.
+ *
+ * @param configs - Array of provider configurations from getProviderConfigurations()
+ * @param type - The provider type to filter by (e.g., "snowflake", "databricks", "athena")
+ * @returns Array of matching provider configurations (may be empty)
+ *
+ * @example
+ * ```typescript
+ * const configs = await getProviderConfigurations(client);
+ * const snowflakeProviders = getProvidersByType(configs, "snowflake");
+ * for (const config of snowflakeProviders) {
+ *   console.log(`Found Snowflake provider: ${config.name}`);
+ * }
+ * ```
+ */
+export declare function getProvidersByType(configs: ProviderConfiguration[], type: string): ProviderConfiguration[];
+/**
+ * Get the names of all attached providers.
+ *
+ * @param configs - Array of provider configurations from getProviderConfigurations()
+ * @returns Array of provider names
+ *
+ * @example
+ * ```typescript
+ * const configs = await getProviderConfigurations(client);
+ * const names = getProviderNames(configs);
+ * // ["my-snowflake", "my-databricks", "my-athena"]
+ * ```
+ */
+export declare function getProviderNames(configs: ProviderConfiguration[]): string[];
+/**
+ * Get the unique provider types available.
+ *
+ * @param configs - Array of provider configurations from getProviderConfigurations()
+ * @returns Array of unique provider type strings
+ *
+ * @example
+ * ```typescript
+ * const configs = await getProviderConfigurations(client);
+ * const types = getProviderTypes(configs);
+ * // ["snowflake", "databricks"]
+ * ```
+ */
+export declare function getProviderTypes(configs: ProviderConfiguration[]): string[];

package/dist/server/providers/types.d.ts

@@ -0,0 +1,145 @@
+/**
+ * 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.
+ */
+export 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
+ */
+export 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
+ */
+export interface ProviderSecret {
+    name: string;
+    value?: string;
+    type: string;
+    required: boolean;
+    arn: string;
+    envName: string;
+}
+/**
+ * Full provider API response including secrets
+ */
+export 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}
+ */
+export 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
+ */
+export 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
+ */
+export 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.
+ */
+export 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.
+ */
+export 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;
+}

package/dist/server/search/TdpSearchManager.d.ts

@@ -0,0 +1,40 @@
+import { ExpressRequestLike, JwtTokenManager } from '../auth/JwtTokenManager';
+import { SearchEqlRequest, SearchEqlResponse } from '@tetrascience-npm/ts-connectors-sdk';
+/** Configuration options for TdpSearchManager */
+export interface TdpSearchManagerConfig {
+    /** TDP API base URL. Defaults to TDP_ENDPOINT env var */
+    baseUrl?: string;
+    /** Organization slug. Defaults to ORG_SLUG env var */
+    orgSlug?: string;
+    /** Optional custom JwtTokenManager instance. Defaults to the shared jwtManager */
+    jwtManager?: JwtTokenManager;
+}
+/**
+ * Manages TDP search requests on the server: resolves auth from request cookies,
+ * creates a TDPClient with that token, and runs searchEql.
+ */
+export declare class TdpSearchManager {
+    private baseUrlOverride;
+    private orgSlugOverride;
+    private tokenManager;
+    constructor(config?: TdpSearchManagerConfig);
+    private getBaseUrl;
+    private getOrgSlug;
+    /** Strip undefined values; convert searchTerm to ES query so TDP API accepts the body. */
+    private toSearchEqlRequest;
+    /**
+     * Handle a search request: resolves the JWT from request cookies via
+     * jwtManager, calls TDP searchEql, and returns the response.
+     *
+     * @param req - Express-like request (cookies must carry a valid JWT)
+     * @param body - Search request body (searchTerm, from, size, sort, order, …)
+     * @returns Search response from TDP
+     * @throws Error if auth or config is missing, or TDP request fails
+     */
+    handleSearchRequest<TSource = Record<string, unknown>>(req: ExpressRequestLike, body: SearchEqlRequest): Promise<SearchEqlResponse<TSource>>;
+}
+/**
+ * Default singleton instance (uses TDP_ENDPOINT and ORG_SLUG from env,
+ * and the shared jwtManager for token resolution).
+ */
+export declare const tdpSearchManager: TdpSearchManager;

package/dist/server/search/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * TDP Search utilities for TetraScience data apps
+ */
+export { TdpSearchManager, tdpSearchManager } from './TdpSearchManager';
+export type { TdpSearchManagerConfig } from './TdpSearchManager';