@prismiq/react 0.1.0

package/dist/types-WrCbOeAV.d.ts

@@ -0,0 +1,569 @@
+/**
+ * Prismiq TypeScript type definitions.
+ *
+ * These types match the Python backend exactly (snake_case field names).
+ * Keep in sync with packages/python/prismiq/types.py
+ */
+/**
+ * Schema information for a single database column.
+ */
+interface ColumnSchema {
+    /** Column name. */
+    name: string;
+    /** PostgreSQL data type (e.g., 'integer', 'character varying'). */
+    data_type: string;
+    /** Whether the column allows NULL values. */
+    is_nullable: boolean;
+    /** Whether this column is part of the primary key. */
+    is_primary_key: boolean;
+    /** Default value expression, if any. */
+    default_value: string | null;
+}
+/**
+ * Schema information for a database table.
+ */
+interface TableSchema {
+    /** Table name. */
+    name: string;
+    /** Database schema (namespace) containing the table. */
+    schema_name: string;
+    /** List of columns in the table. */
+    columns: ColumnSchema[];
+    /** Approximate row count (from pg_class.reltuples). Undefined if not fetched. */
+    row_count?: number;
+}
+/**
+ * Foreign key relationship between two tables.
+ */
+interface Relationship {
+    /** Name of the table containing the foreign key. */
+    from_table: string;
+    /** Column name in the from_table. */
+    from_column: string;
+    /** Name of the referenced table. */
+    to_table: string;
+    /** Column name in the to_table (usually primary key). */
+    to_column: string;
+}
+/**
+ * Complete schema for an exposed database.
+ */
+interface DatabaseSchema {
+    /** List of exposed tables. */
+    tables: TableSchema[];
+    /** Foreign key relationships between tables. */
+    relationships: Relationship[];
+}
+/**
+ * A table reference in a query.
+ */
+interface QueryTable {
+    /** Unique identifier for this table in the query (e.g., 't1', 't2'). */
+    id: string;
+    /** Actual table name in the database. */
+    name: string;
+    /** Optional alias for the table in the query. */
+    alias?: string;
+}
+/**
+ * SQL join types.
+ */
+type JoinType = 'INNER' | 'LEFT' | 'RIGHT' | 'FULL';
+/**
+ * Definition of a join between two tables.
+ */
+interface JoinDefinition {
+    /** ID of the left table in the join. */
+    from_table_id: string;
+    /** Column name in the left table. */
+    from_column: string;
+    /** ID of the right table in the join. */
+    to_table_id: string;
+    /** Column name in the right table. */
+    to_column: string;
+    /** Type of join to perform. */
+    join_type: JoinType;
+}
+/**
+ * SQL aggregation functions.
+ */
+type AggregationType = 'none' | 'sum' | 'avg' | 'count' | 'count_distinct' | 'min' | 'max';
+/**
+ * Date truncation intervals for date/timestamp columns.
+ */
+type DateTruncInterval = 'year' | 'quarter' | 'month' | 'week' | 'day';
+/**
+ * A column to select in a query.
+ */
+interface ColumnSelection {
+    /** ID of the table containing the column. */
+    table_id: string;
+    /** Column name. */
+    column: string;
+    /** Aggregation function to apply. */
+    aggregation: AggregationType;
+    /** Optional alias for the result column. */
+    alias?: string;
+    /** Date truncation unit for date/timestamp columns. */
+    date_trunc?: DateTruncInterval;
+}
+/**
+ * SQL filter operators.
+ */
+type FilterOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in_' | 'not_in' | 'in_or_null' | 'like' | 'ilike' | 'not_like' | 'not_ilike' | 'between' | 'is_null' | 'is_not_null';
+/**
+ * A filter condition in a query.
+ *
+ * Value types:
+ * - Single value for eq, neq, gt, gte, lt, lte, like, ilike, not_like, not_ilike
+ * - Array for in_, not_in, in_or_null
+ * - [min, max] tuple for between
+ * - null/undefined for is_null, is_not_null
+ */
+interface FilterDefinition {
+    /** ID of the table containing the column to filter. */
+    table_id: string;
+    /** Column name to filter on. */
+    column: string;
+    /** Filter operator. */
+    operator: FilterOperator;
+    /** Value(s) for the filter. */
+    value?: unknown;
+}
+/**
+ * SQL sort directions.
+ */
+type SortDirection = 'ASC' | 'DESC';
+/**
+ * A sort order definition.
+ */
+interface SortDefinition {
+    /** ID of the table containing the column to sort by. */
+    table_id: string;
+    /** Column name to sort by. */
+    column: string;
+    /** Sort direction. */
+    direction: SortDirection;
+}
+/**
+ * A group by column definition.
+ */
+interface GroupByDefinition {
+    /** ID of the table containing the column. */
+    table_id: string;
+    /** Column name to group by. */
+    column: string;
+}
+/**
+ * A calculated field definition with an expression.
+ *
+ * Calculated fields allow defining computed columns using expressions
+ * that can reference other columns and calculated fields.
+ */
+interface CalculatedField {
+    /** Name of the calculated field. */
+    name: string;
+    /**
+     * Expression defining the calculation.
+     * Uses a SQL-like expression language with functions like:
+     * - if(condition, true_val, false_val)
+     * - sum(expr), avg(expr), count(expr)
+     * - year(date), month(date), today()
+     * - Field references: [field_name]
+     */
+    expression: string;
+    /** Data type of the result: 'number', 'string', 'date', 'boolean'. */
+    data_type?: string;
+}
+/**
+ * Time series interval options for date bucketing.
+ * Reuses DateTruncInterval since both represent the same concept.
+ */
+type TimeSeriesInterval = DateTruncInterval;
+/**
+ * Time series configuration for date-based charts.
+ *
+ * Enables automatic date bucketing and gap filling for continuous
+ * time series data visualization.
+ */
+interface TimeSeriesConfig {
+    /** ID of the table containing the date column. */
+    table_id: string;
+    /** Column name of the date/timestamp field. */
+    date_column: string;
+    /** Time bucket interval for grouping. */
+    interval: TimeSeriesInterval;
+    /** Whether to fill missing time buckets with a default value. */
+    fill_missing?: boolean;
+    /** Value to use when filling missing buckets (default: 0). */
+    fill_value?: number;
+    /** Optional alias for the bucketed date column. */
+    alias?: string;
+}
+/**
+ * Complete query definition.
+ */
+interface QueryDefinition {
+    /** Tables used in the query. */
+    tables: QueryTable[];
+    /** Join definitions between tables. */
+    joins?: JoinDefinition[];
+    /** Columns to select. */
+    columns: ColumnSelection[];
+    /** Filter conditions. */
+    filters?: FilterDefinition[];
+    /** Explicit group by columns. If empty and aggregations are present, will be auto-derived. */
+    group_by?: GroupByDefinition[];
+    /** Sort order. */
+    order_by?: SortDefinition[];
+    /** Maximum number of rows to return. */
+    limit?: number;
+    /** Number of rows to skip. */
+    offset?: number;
+    /** Calculated field definitions. These fields can be referenced in columns, filters, etc. */
+    calculated_fields?: CalculatedField[];
+    /** Time series configuration for automatic date bucketing and gap filling. */
+    time_series?: TimeSeriesConfig;
+}
+/**
+ * Result of executing a query.
+ */
+interface QueryResult {
+    /** Column names in the result. */
+    columns: string[];
+    /** PostgreSQL data types for each column. */
+    column_types: string[];
+    /** Result rows as a list of lists. */
+    rows: unknown[][];
+    /** Number of rows returned. */
+    row_count: number;
+    /** Whether the result was truncated due to row limit. */
+    truncated: boolean;
+    /** Query execution time in milliseconds. */
+    execution_time_ms: number;
+    /** Unix timestamp when result was cached (undefined if not from cache). */
+    cached_at?: number;
+    /** Whether this result came from cache. */
+    is_from_cache?: boolean;
+}
+/**
+ * Result of query validation.
+ */
+interface ValidationResult {
+    /** Whether the query is valid. */
+    valid: boolean;
+    /** List of validation errors, if any. */
+    errors: string[];
+}
+/**
+ * Widget types available in Prismiq.
+ */
+declare enum WidgetType {
+    METRIC = "metric",
+    BAR_CHART = "bar_chart",
+    LINE_CHART = "line_chart",
+    AREA_CHART = "area_chart",
+    PIE_CHART = "pie_chart",
+    SCATTER_CHART = "scatter_chart",
+    TABLE = "table",
+    TEXT = "text"
+}
+/**
+ * Widget position on the dashboard grid.
+ */
+interface WidgetPosition {
+    /** X coordinate (column). */
+    x: number;
+    /** Y coordinate (row). */
+    y: number;
+    /** Width in columns. */
+    w: number;
+    /** Height in rows. */
+    h: number;
+}
+/**
+ * Widget display configuration.
+ */
+interface WidgetConfig {
+    /** X-axis column for charts. */
+    xAxis?: string;
+    /** Y-axis column for charts. */
+    yAxis?: string;
+    /** Value column for metrics. */
+    valueColumn?: string;
+    /** Number format for metrics. */
+    format?: 'number' | 'currency' | 'percent' | 'compact';
+    /** Show trend indicator for metrics. */
+    showTrend?: boolean;
+    /** Chart orientation. */
+    orientation?: 'vertical' | 'horizontal';
+    /** Stack bars. */
+    stacked?: boolean;
+    /** Show data points. */
+    showPoints?: boolean;
+    /** Donut style for pie charts. */
+    donut?: boolean;
+    /** Striped rows for tables. */
+    striped?: boolean;
+    /** Allow column sorting for tables. */
+    sortable?: boolean;
+    /** Rows per page for tables. */
+    pageSize?: number;
+    /** Text content for text widgets. */
+    content?: string;
+    /** Additional config options. */
+    [key: string]: unknown;
+}
+/**
+ * A widget on a dashboard.
+ */
+interface Widget {
+    /** Unique widget ID. */
+    id: string;
+    /** Widget type. */
+    type: WidgetType;
+    /** Widget title. */
+    title: string;
+    /** Query definition for data widgets. */
+    query: QueryDefinition | null;
+    /** Position on the dashboard grid. */
+    position: WidgetPosition;
+    /** Display configuration. */
+    config: WidgetConfig;
+    /** Creation timestamp. */
+    created_at: string;
+    /** Last update timestamp. */
+    updated_at: string;
+}
+/**
+ * Data for creating a new widget.
+ */
+interface WidgetCreate {
+    /** Widget type. */
+    type: WidgetType;
+    /** Widget title. */
+    title: string;
+    /** Query definition for data widgets. */
+    query?: QueryDefinition | null;
+    /** Position on the dashboard grid. */
+    position: WidgetPosition;
+    /** Display configuration. */
+    config?: WidgetConfig;
+}
+/**
+ * Data for updating a widget.
+ */
+interface WidgetUpdate {
+    /** Widget title. */
+    title?: string;
+    /** Query definition. */
+    query?: QueryDefinition | null;
+    /** Position on the grid. */
+    position?: WidgetPosition;
+    /** Display configuration. */
+    config?: WidgetConfig;
+}
+/**
+ * Dashboard filter types.
+ */
+declare enum DashboardFilterType {
+    TEXT = "text",
+    SELECT = "select",
+    MULTI_SELECT = "multi_select",
+    DATE = "date",
+    DATE_RANGE = "date_range",
+    NUMBER = "number",
+    NUMBER_RANGE = "number_range"
+}
+/**
+ * A filter on a dashboard.
+ */
+interface DashboardFilter {
+    /** Unique filter ID. */
+    id: string;
+    /** Filter type. */
+    type: DashboardFilterType;
+    /** Filter label. */
+    label: string;
+    /** Column to filter on. */
+    column: string;
+    /** Table containing the column. */
+    table_id: string;
+    /** Default value. */
+    default_value?: unknown;
+}
+/**
+ * Dashboard layout options.
+ */
+interface DashboardLayout {
+    /** Number of columns in the grid. */
+    columns?: number;
+    /** Row height in pixels. */
+    row_height?: number;
+}
+/**
+ * A dashboard.
+ */
+interface Dashboard {
+    /** Unique dashboard ID. */
+    id: string;
+    /** Dashboard name. */
+    name: string;
+    /** Dashboard description. */
+    description: string | null;
+    /** Owner user ID. */
+    owner_id: string | null;
+    /** Whether the dashboard is public. */
+    is_public: boolean;
+    /** List of user IDs with view access. */
+    allowed_viewers: string[];
+    /** Widgets on the dashboard. */
+    widgets: Widget[];
+    /** Dashboard filters. */
+    filters: DashboardFilter[];
+    /** Layout configuration. */
+    layout: DashboardLayout;
+    /** Creation timestamp. */
+    created_at: string;
+    /** Last update timestamp. */
+    updated_at: string;
+}
+/**
+ * Data for creating a new dashboard.
+ */
+interface DashboardCreate {
+    /** Dashboard name. */
+    name: string;
+    /** Dashboard description. */
+    description?: string;
+    /** Layout configuration. */
+    layout?: DashboardLayout;
+}
+/**
+ * Data for updating a dashboard.
+ */
+interface DashboardUpdate {
+    /** Dashboard name. */
+    name?: string;
+    /** Dashboard description. */
+    description?: string | null;
+    /** Whether the dashboard is public. */
+    is_public?: boolean;
+    /** List of user IDs with view access. */
+    allowed_viewers?: string[];
+    /** Dashboard filters. */
+    filters?: DashboardFilter[];
+    /** Layout configuration. */
+    layout?: DashboardLayout;
+}
+/**
+ * Position update for a widget.
+ */
+interface WidgetPositionUpdate {
+    /** Widget ID. */
+    widget_id: string;
+    /** New position. */
+    position: WidgetPosition;
+}
+/**
+ * A saved query for reuse across dashboards.
+ */
+interface SavedQuery {
+    /** Unique saved query ID. */
+    id: string;
+    /** Query name. */
+    name: string;
+    /** Query description. */
+    description: string | null;
+    /** The query definition. */
+    query: QueryDefinition;
+    /** Tenant ID for multi-tenancy. */
+    tenant_id: string;
+    /** Owner user ID. */
+    owner_id: string | null;
+    /** Whether the query is shared with all users. */
+    is_shared: boolean;
+    /** Creation timestamp. */
+    created_at: string | null;
+    /** Last update timestamp. */
+    updated_at: string | null;
+}
+/**
+ * Data for creating a saved query.
+ */
+interface SavedQueryCreate {
+    /** Query name. */
+    name: string;
+    /** Query description. */
+    description?: string | null;
+    /** The query definition. */
+    query: QueryDefinition;
+    /** Whether to share with all users. */
+    is_shared?: boolean;
+}
+/**
+ * Data for updating a saved query.
+ */
+interface SavedQueryUpdate {
+    /** Query name. */
+    name?: string;
+    /** Query description. */
+    description?: string | null;
+    /** The query definition. */
+    query?: QueryDefinition;
+    /** Whether to share with all users. */
+    is_shared?: boolean;
+}
+/**
+ * Request for executing raw SQL.
+ */
+interface ExecuteSQLRequest {
+    /** Raw SQL query (SELECT only). */
+    sql: string;
+    /** Optional named parameters for the query. */
+    params?: Record<string, unknown>;
+}
+/**
+ * Result of SQL validation.
+ */
+interface SQLValidationResult {
+    /** Whether the SQL is valid. */
+    valid: boolean;
+    /** List of validation errors (empty if valid). */
+    errors: string[];
+    /** List of tables referenced in the query. */
+    tables: string[];
+}
+/**
+ * A pinned dashboard entry.
+ */
+interface PinnedDashboard {
+    /** Unique pin ID. */
+    id: string;
+    /** Dashboard ID that is pinned. */
+    dashboard_id: string;
+    /** Context the dashboard is pinned to (e.g., "accounts", "dashboard"). */
+    context: string;
+    /** Position in the pinned list (0-based). */
+    position: number;
+    /** Timestamp when the dashboard was pinned. */
+    pinned_at: string;
+}
+/**
+ * Response from getting pinned dashboards for a context.
+ */
+interface PinnedDashboardsResponse {
+    /** List of pinned dashboards, ordered by position. */
+    dashboards: Dashboard[];
+    /** Pin metadata for each dashboard. */
+    pins: PinnedDashboard[];
+}
+/**
+ * Response from getting contexts where a dashboard is pinned.
+ */
+interface DashboardPinContextsResponse {
+    /** List of context names where the dashboard is pinned. */
+    contexts: string[];
+}
+
+export type { AggregationType as A, CalculatedField as C, DatabaseSchema as D, ExecuteSQLRequest as E, FilterOperator as F, GroupByDefinition as G, JoinDefinition as J, PinnedDashboard as P, QueryResult as Q, Relationship as R, SQLValidationResult as S, TimeSeriesConfig as T, ValidationResult as V, WidgetCreate as W, QueryDefinition as a, QueryTable as b, TableSchema as c, Dashboard as d, DashboardCreate as e, DashboardUpdate as f, Widget as g, WidgetUpdate as h, WidgetPositionUpdate as i, SavedQuery as j, SavedQueryCreate as k, SavedQueryUpdate as l, PinnedDashboardsResponse as m, WidgetPosition as n, ColumnSchema as o, JoinType as p, ColumnSelection as q, FilterDefinition as r, SortDirection as s, SortDefinition as t, DashboardPinContextsResponse as u };

package/dist/utils/index.cjs

@@ -0,0 +1,64 @@
+'use strict';
+
+var chunk4AVL6GQK_cjs = require('../chunk-4AVL6GQK.cjs');
+
+
+
+Object.defineProperty(exports, "announceToScreenReader", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.announceToScreenReader; }
+});
+Object.defineProperty(exports, "createDateFormatter", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.createDateFormatter; }
+});
+Object.defineProperty(exports, "createDateFormatters", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.createDateFormatters; }
+});
+Object.defineProperty(exports, "focusVisibleStyles", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.focusVisibleStyles; }
+});
+Object.defineProperty(exports, "formatRelativeTime", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.formatRelativeTime; }
+});
+Object.defineProperty(exports, "parseColumnRef", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.parseColumnRef; }
+});
+Object.defineProperty(exports, "parseMarkdownSafe", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.parseMarkdownSafe; }
+});
+Object.defineProperty(exports, "pivotQueryResult", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.pivotQueryResult; }
+});
+Object.defineProperty(exports, "skipLinkFocusStyles", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.skipLinkFocusStyles; }
+});
+Object.defineProperty(exports, "skipLinkStyles", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.skipLinkStyles; }
+});
+Object.defineProperty(exports, "useArrowNavigation", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.useArrowNavigation; }
+});
+Object.defineProperty(exports, "useFocusTrap", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.useFocusTrap; }
+});
+Object.defineProperty(exports, "useFocusVisible", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.useFocusVisible; }
+});
+Object.defineProperty(exports, "useRovingTabIndex", {
+  enumerable: true,
+  get: function () { return chunk4AVL6GQK_cjs.useRovingTabIndex; }
+});
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/utils/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.cjs"}