@xylex-group/athena 1.6.2 → 1.9.0

package/dist/types-v6UyGg-x.d.cts

@@ -1,195 +0,0 @@
-/**
- * athena gateway types
- *
- * type definitions for the athena gateway api client and react hook
- */
-type AthenaGatewayMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
-type AthenaGatewayEndpointPath = '/gateway/fetch' | '/gateway/insert' | '/gateway/update' | '/gateway/delete' | '/gateway/rpc' | '/gateway/query' | `/rpc/${string}`;
-type AthenaCountOption = 'exact' | 'planned' | 'estimated';
-type AthenaConditionValue = string | number | boolean | null;
-type AthenaConditionArrayValue = Array<AthenaConditionValue>;
-type AthenaConditionCastType = string;
-type AthenaConditionOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'ilike' | 'is' | 'in' | 'contains' | 'containedBy' | 'not' | 'or';
-interface AthenaGatewayCondition {
-    column?: string;
-    operator: AthenaConditionOperator;
-    value?: AthenaConditionValue | AthenaConditionArrayValue | string;
-    /**
-     * Optional explicit cast for `value` (for example `"uuid"`).
-     * Older gateways ignore unknown fields; newer gateways may use this hint.
-     */
-    value_cast?: AthenaConditionCastType;
-    /**
-     * Optional explicit cast for `column` (for example `"text"`).
-     * Used by SDK SQL fallback for typed comparisons.
-     */
-    column_cast?: AthenaConditionCastType;
-    /** Back-compat shape expected by older gateway implementations */
-    eq_column?: string;
-    eq_value?: AthenaConditionValue | AthenaConditionArrayValue | string;
-    /** Optional cast hint aligned with legacy eq_* fields */
-    eq_value_cast?: AthenaConditionCastType;
-    /** Optional cast hint aligned with legacy eq_* fields */
-    eq_column_cast?: AthenaConditionCastType;
-}
-type AthenaSortDirection = 'ascending' | 'descending';
-interface AthenaSortBy {
-    field: string;
-    direction: AthenaSortDirection;
-}
-interface AthenaFetchPayload {
-    view_name?: string;
-    table_name?: string;
-    columns?: string[] | string;
-    conditions?: AthenaGatewayCondition[];
-    limit?: number;
-    offset?: number;
-    current_page?: number;
-    page_size?: number;
-    total_pages?: number;
-    strip_nulls?: boolean;
-    group_by?: string;
-    time_granularity?: 'day' | 'hour' | 'minute';
-    aggregation_column?: string;
-    aggregation_strategy?: 'cumulative_sum';
-    aggregation_dedup?: boolean;
-    sort_by?: AthenaSortBy;
-}
-interface AthenaInsertPayload {
-    table_name: string;
-    insert_body: Record<string, unknown> | Record<string, unknown>[];
-    update_body?: Record<string, unknown>;
-    columns?: string[] | string;
-    count?: AthenaCountOption;
-    head?: boolean;
-    default_to_null?: boolean;
-    on_conflict?: string | string[];
-}
-interface AthenaDeletePayload {
-    table_name: string;
-    resource_id?: string;
-    columns?: string[] | string;
-    conditions?: AthenaGatewayCondition[];
-    sort_by?: AthenaSortBy;
-    current_page?: number;
-    page_size?: number;
-    total_pages?: number;
-}
-interface AthenaUpdatePayload extends AthenaFetchPayload {
-    set?: Record<string, unknown>;
-    data?: Record<string, unknown>;
-}
-type AthenaRpcFilterOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'ilike' | 'is' | 'in';
-interface AthenaRpcFilter {
-    column: string;
-    operator: AthenaRpcFilterOperator;
-    value?: AthenaConditionValue | AthenaConditionArrayValue | string;
-}
-interface AthenaRpcOrder {
-    column: string;
-    ascending?: boolean;
-}
-interface AthenaRpcPayload {
-    function: string;
-    function_name?: string;
-    schema?: string;
-    args?: Record<string, unknown>;
-    select?: string;
-    filters?: AthenaRpcFilter[];
-    count?: AthenaCountOption;
-    head?: boolean;
-    limit?: number;
-    offset?: number;
-    order?: AthenaRpcOrder;
-}
-/** Backend type for Athena client (aligns with athena-rs) */
-type BackendType = 'athena' | 'postgrest' | 'postgresql' | 'scylladb';
-/** Backend config: type from SDK + backend-scoped options */
-interface BackendConfig {
-    type: BackendType;
-    options?: Record<string, unknown>;
-}
-/** Pre-defined backends for lean usage: backend: Backend.Athena */
-declare const Backend: {
-    readonly Athena: {
-        readonly type: "athena";
-    };
-    readonly Postgrest: {
-        readonly type: "postgrest";
-    };
-    readonly PostgreSQL: {
-        readonly type: "postgresql";
-    };
-    readonly ScyllaDB: {
-        readonly type: "scylladb";
-    };
-};
-type BackendOption = BackendConfig | BackendType;
-interface AthenaGatewayBaseOptions {
-    baseUrl?: string;
-    apiKey?: string;
-    client?: string;
-    backend?: BackendOption;
-    publishEvent?: string;
-    headers?: Record<string, string>;
-    userId?: string | null;
-    organizationId?: string | null;
-}
-type AthenaGatewayHookConfig = AthenaGatewayBaseOptions;
-interface AthenaGatewayCallOptions extends AthenaGatewayBaseOptions {
-    count?: AthenaCountOption;
-    head?: boolean;
-    defaultToNull?: boolean;
-    stripNulls?: boolean;
-    onConflict?: string | string[];
-    updateBody?: Record<string, unknown>;
-}
-interface AthenaRpcCallOptions extends AthenaGatewayCallOptions {
-    schema?: string;
-    count?: AthenaCountOption;
-    get?: boolean;
-}
-interface AthenaGatewayResponse<T = unknown> {
-    ok: boolean;
-    status: number;
-    data: T | null;
-    count?: number | null;
-    error?: string;
-    errorDetails?: AthenaGatewayErrorDetails | null;
-    raw: unknown;
-}
-type AthenaGatewayErrorCode = 'NETWORK_ERROR' | 'HTTP_ERROR' | 'INVALID_JSON' | 'UNKNOWN_ERROR';
-interface AthenaGatewayErrorDetails {
-    code: AthenaGatewayErrorCode;
-    message: string;
-    status: number;
-    endpoint?: AthenaGatewayEndpointPath;
-    method?: AthenaGatewayMethod;
-    requestId?: string;
-    hint?: string;
-    cause?: string;
-}
-interface AthenaGatewayResponseLog extends AthenaGatewayResponse {
-    timestamp: string;
-}
-interface AthenaGatewayCallLog {
-    endpoint: AthenaGatewayEndpointPath;
-    method: AthenaGatewayMethod;
-    payload: unknown;
-    headers: Record<string, string>;
-    timestamp: string;
-}
-interface AthenaGatewayHookResult {
-    fetchGateway: <T = unknown>(payload: AthenaFetchPayload, options?: AthenaGatewayCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    insertGateway: <T = unknown>(payload: AthenaInsertPayload, options?: AthenaGatewayCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    updateGateway: <T = unknown>(payload: AthenaUpdatePayload, options?: AthenaGatewayCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    deleteGateway: <T = unknown>(payload: AthenaDeletePayload, options?: AthenaGatewayCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    rpcGateway: <T = unknown>(payload: AthenaRpcPayload, options?: AthenaRpcCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    isLoading: boolean;
-    error: string | null;
-    lastRequest: AthenaGatewayCallLog | null;
-    lastResponse: AthenaGatewayResponseLog | null;
-    baseUrl: string;
-}
-
-export { type AthenaGatewayCallOptions as A, type BackendConfig as B, type AthenaConditionValue as a, type AthenaConditionCastType as b, type AthenaConditionArrayValue as c, type AthenaConditionOperator as d, type AthenaGatewayErrorDetails as e, type AthenaRpcCallOptions as f, type BackendType as g, Backend as h, type AthenaRpcFilter as i, type AthenaRpcFilterOperator as j, type AthenaRpcOrder as k, type AthenaRpcPayload as l, type AthenaGatewayErrorCode as m, type AthenaGatewayHookConfig as n, type AthenaGatewayHookResult as o, type AthenaFetchPayload as p, type AthenaInsertPayload as q, type AthenaUpdatePayload as r, type AthenaDeletePayload as s, type AthenaGatewayResponse as t, type AthenaGatewayEndpointPath as u, type AthenaGatewayMethod as v };

package/dist/types-v6UyGg-x.d.ts

@@ -1,195 +0,0 @@
-/**
- * athena gateway types
- *
- * type definitions for the athena gateway api client and react hook
- */
-type AthenaGatewayMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
-type AthenaGatewayEndpointPath = '/gateway/fetch' | '/gateway/insert' | '/gateway/update' | '/gateway/delete' | '/gateway/rpc' | '/gateway/query' | `/rpc/${string}`;
-type AthenaCountOption = 'exact' | 'planned' | 'estimated';
-type AthenaConditionValue = string | number | boolean | null;
-type AthenaConditionArrayValue = Array<AthenaConditionValue>;
-type AthenaConditionCastType = string;
-type AthenaConditionOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'ilike' | 'is' | 'in' | 'contains' | 'containedBy' | 'not' | 'or';
-interface AthenaGatewayCondition {
-    column?: string;
-    operator: AthenaConditionOperator;
-    value?: AthenaConditionValue | AthenaConditionArrayValue | string;
-    /**
-     * Optional explicit cast for `value` (for example `"uuid"`).
-     * Older gateways ignore unknown fields; newer gateways may use this hint.
-     */
-    value_cast?: AthenaConditionCastType;
-    /**
-     * Optional explicit cast for `column` (for example `"text"`).
-     * Used by SDK SQL fallback for typed comparisons.
-     */
-    column_cast?: AthenaConditionCastType;
-    /** Back-compat shape expected by older gateway implementations */
-    eq_column?: string;
-    eq_value?: AthenaConditionValue | AthenaConditionArrayValue | string;
-    /** Optional cast hint aligned with legacy eq_* fields */
-    eq_value_cast?: AthenaConditionCastType;
-    /** Optional cast hint aligned with legacy eq_* fields */
-    eq_column_cast?: AthenaConditionCastType;
-}
-type AthenaSortDirection = 'ascending' | 'descending';
-interface AthenaSortBy {
-    field: string;
-    direction: AthenaSortDirection;
-}
-interface AthenaFetchPayload {
-    view_name?: string;
-    table_name?: string;
-    columns?: string[] | string;
-    conditions?: AthenaGatewayCondition[];
-    limit?: number;
-    offset?: number;
-    current_page?: number;
-    page_size?: number;
-    total_pages?: number;
-    strip_nulls?: boolean;
-    group_by?: string;
-    time_granularity?: 'day' | 'hour' | 'minute';
-    aggregation_column?: string;
-    aggregation_strategy?: 'cumulative_sum';
-    aggregation_dedup?: boolean;
-    sort_by?: AthenaSortBy;
-}
-interface AthenaInsertPayload {
-    table_name: string;
-    insert_body: Record<string, unknown> | Record<string, unknown>[];
-    update_body?: Record<string, unknown>;
-    columns?: string[] | string;
-    count?: AthenaCountOption;
-    head?: boolean;
-    default_to_null?: boolean;
-    on_conflict?: string | string[];
-}
-interface AthenaDeletePayload {
-    table_name: string;
-    resource_id?: string;
-    columns?: string[] | string;
-    conditions?: AthenaGatewayCondition[];
-    sort_by?: AthenaSortBy;
-    current_page?: number;
-    page_size?: number;
-    total_pages?: number;
-}
-interface AthenaUpdatePayload extends AthenaFetchPayload {
-    set?: Record<string, unknown>;
-    data?: Record<string, unknown>;
-}
-type AthenaRpcFilterOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'ilike' | 'is' | 'in';
-interface AthenaRpcFilter {
-    column: string;
-    operator: AthenaRpcFilterOperator;
-    value?: AthenaConditionValue | AthenaConditionArrayValue | string;
-}
-interface AthenaRpcOrder {
-    column: string;
-    ascending?: boolean;
-}
-interface AthenaRpcPayload {
-    function: string;
-    function_name?: string;
-    schema?: string;
-    args?: Record<string, unknown>;
-    select?: string;
-    filters?: AthenaRpcFilter[];
-    count?: AthenaCountOption;
-    head?: boolean;
-    limit?: number;
-    offset?: number;
-    order?: AthenaRpcOrder;
-}
-/** Backend type for Athena client (aligns with athena-rs) */
-type BackendType = 'athena' | 'postgrest' | 'postgresql' | 'scylladb';
-/** Backend config: type from SDK + backend-scoped options */
-interface BackendConfig {
-    type: BackendType;
-    options?: Record<string, unknown>;
-}
-/** Pre-defined backends for lean usage: backend: Backend.Athena */
-declare const Backend: {
-    readonly Athena: {
-        readonly type: "athena";
-    };
-    readonly Postgrest: {
-        readonly type: "postgrest";
-    };
-    readonly PostgreSQL: {
-        readonly type: "postgresql";
-    };
-    readonly ScyllaDB: {
-        readonly type: "scylladb";
-    };
-};
-type BackendOption = BackendConfig | BackendType;
-interface AthenaGatewayBaseOptions {
-    baseUrl?: string;
-    apiKey?: string;
-    client?: string;
-    backend?: BackendOption;
-    publishEvent?: string;
-    headers?: Record<string, string>;
-    userId?: string | null;
-    organizationId?: string | null;
-}
-type AthenaGatewayHookConfig = AthenaGatewayBaseOptions;
-interface AthenaGatewayCallOptions extends AthenaGatewayBaseOptions {
-    count?: AthenaCountOption;
-    head?: boolean;
-    defaultToNull?: boolean;
-    stripNulls?: boolean;
-    onConflict?: string | string[];
-    updateBody?: Record<string, unknown>;
-}
-interface AthenaRpcCallOptions extends AthenaGatewayCallOptions {
-    schema?: string;
-    count?: AthenaCountOption;
-    get?: boolean;
-}
-interface AthenaGatewayResponse<T = unknown> {
-    ok: boolean;
-    status: number;
-    data: T | null;
-    count?: number | null;
-    error?: string;
-    errorDetails?: AthenaGatewayErrorDetails | null;
-    raw: unknown;
-}
-type AthenaGatewayErrorCode = 'NETWORK_ERROR' | 'HTTP_ERROR' | 'INVALID_JSON' | 'UNKNOWN_ERROR';
-interface AthenaGatewayErrorDetails {
-    code: AthenaGatewayErrorCode;
-    message: string;
-    status: number;
-    endpoint?: AthenaGatewayEndpointPath;
-    method?: AthenaGatewayMethod;
-    requestId?: string;
-    hint?: string;
-    cause?: string;
-}
-interface AthenaGatewayResponseLog extends AthenaGatewayResponse {
-    timestamp: string;
-}
-interface AthenaGatewayCallLog {
-    endpoint: AthenaGatewayEndpointPath;
-    method: AthenaGatewayMethod;
-    payload: unknown;
-    headers: Record<string, string>;
-    timestamp: string;
-}
-interface AthenaGatewayHookResult {
-    fetchGateway: <T = unknown>(payload: AthenaFetchPayload, options?: AthenaGatewayCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    insertGateway: <T = unknown>(payload: AthenaInsertPayload, options?: AthenaGatewayCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    updateGateway: <T = unknown>(payload: AthenaUpdatePayload, options?: AthenaGatewayCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    deleteGateway: <T = unknown>(payload: AthenaDeletePayload, options?: AthenaGatewayCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    rpcGateway: <T = unknown>(payload: AthenaRpcPayload, options?: AthenaRpcCallOptions) => Promise<AthenaGatewayResponse<T>>;
-    isLoading: boolean;
-    error: string | null;
-    lastRequest: AthenaGatewayCallLog | null;
-    lastResponse: AthenaGatewayResponseLog | null;
-    baseUrl: string;
-}
-
-export { type AthenaGatewayCallOptions as A, type BackendConfig as B, type AthenaConditionValue as a, type AthenaConditionCastType as b, type AthenaConditionArrayValue as c, type AthenaConditionOperator as d, type AthenaGatewayErrorDetails as e, type AthenaRpcCallOptions as f, type BackendType as g, Backend as h, type AthenaRpcFilter as i, type AthenaRpcFilterOperator as j, type AthenaRpcOrder as k, type AthenaRpcPayload as l, type AthenaGatewayErrorCode as m, type AthenaGatewayHookConfig as n, type AthenaGatewayHookResult as o, type AthenaFetchPayload as p, type AthenaInsertPayload as q, type AthenaUpdatePayload as r, type AthenaDeletePayload as s, type AthenaGatewayResponse as t, type AthenaGatewayEndpointPath as u, type AthenaGatewayMethod as v };