@xylex-group/athena 2.11.0 → 2.12.1

package/dist/{shared-B1ueL-Ox.d.cts → shared-DZSGAmXs.d.cts}

@@ -1,5 +1,5 @@
-import { bK as AthenaCreateClientAuthOptions, bC as AthenaClientExperimentalOptions, cb as AthenaHeaderBag } from './client-WqBuu60O.cjs';
-import { p as BackendConfig, q as BackendType } from './types-BeZIHduP.cjs';
+import { bK as AthenaCreateClientAuthOptions, bC as AthenaClientExperimentalOptions, cb as AthenaHeaderBag } from './client-CMtx5P4D.cjs';
+import { o as BackendConfig, p as BackendType } from './types-BRUHGXo2.cjs';
 
 interface AthenaRequestCookiesBag {
     getAll(): Array<{

package/dist/{shared-GPAprhBb.d.ts → shared-MMnVBBfy.d.ts}

@@ -1,5 +1,5 @@
-import { bK as AthenaCreateClientAuthOptions, bC as AthenaClientExperimentalOptions, cb as AthenaHeaderBag } from './client-DD_UeF3Q.js';
-import { p as BackendConfig, q as BackendType } from './types-BeZIHduP.js';
+import { bK as AthenaCreateClientAuthOptions, bC as AthenaClientExperimentalOptions, cb as AthenaHeaderBag } from './client-Dre8H24u.js';
+import { o as BackendConfig, p as BackendType } from './types-BRUHGXo2.js';
 
 interface AthenaRequestCookiesBag {
     getAll(): Array<{

package/dist/{types-CRjDwmtJ.d.ts → types-BLizCLd1.d.cts}

@@ -1,4 +1,5 @@
-import { q as BackendType, I as IntrospectionSnapshot, S as SchemaIntrospectionProvider } from './types-BeZIHduP.js';
+import { p as BackendType } from './types-BRUHGXo2.cjs';
+import { I as IntrospectionSnapshot, S as SchemaIntrospectionProvider } from './types-Bez4HSbI.cjs';
 
 /**
  * Supported case transformations for generated symbols and path token variants.

package/dist/types-BRUHGXo2.d.cts

@@ -0,0 +1,236 @@
+/**
+ * athena gateway types
+ *
+ * type definitions for the athena gateway api client and react hook
+ */
+type AthenaGatewayMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type AthenaGatewayEndpointPath = '/gateway/fetch' | '/gateway/insert' | '/gateway/update' | '/gateway/delete' | '/gateway/rpc' | '/gateway/query' | `/rpc/${string}` | `/storage/${string}`;
+type AthenaCountOption = 'exact' | 'planned' | 'estimated';
+type AthenaJsonPrimitive = string | number | boolean | null;
+type AthenaJsonValue = AthenaJsonPrimitive | AthenaJsonObject | AthenaJsonArray;
+interface AthenaJsonObject {
+    [key: string]: AthenaJsonValue;
+}
+type AthenaJsonArray = AthenaJsonValue[];
+type AthenaConditionValue = AthenaJsonPrimitive;
+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 {
+    select?: string | AthenaJsonObject;
+    view_name?: string;
+    table_name?: string;
+    columns?: string[] | string;
+    where?: AthenaJsonObject;
+    orderBy?: AthenaJsonObject | AthenaJsonArray;
+    conditions?: AthenaGatewayCondition[];
+    limit?: number;
+    offset?: number;
+    current_page?: number;
+    page_size?: number;
+    total_pages?: number;
+    strip_nulls?: boolean;
+    count?: AthenaCountOption;
+    head?: boolean;
+    group_by?: string;
+    time_granularity?: 'day' | 'hour' | 'minute';
+    aggregation_column?: string;
+    aggregation_strategy?: 'cumulative_sum';
+    aggregation_dedup?: boolean;
+    sort_by?: AthenaSortBy;
+}
+interface AthenaInsertPayload<TInsertBody = AthenaJsonObject, TUpdateBody = AthenaJsonObject> {
+    table_name: string;
+    insert_body: TInsertBody | TInsertBody[];
+    update_body?: TUpdateBody;
+    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<TUpdateBody = AthenaJsonObject> extends AthenaFetchPayload {
+    set?: TUpdateBody;
+    data?: TUpdateBody;
+}
+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<TArgs = AthenaJsonObject> {
+    function: string;
+    function_name?: string;
+    schema?: string;
+    args?: TArgs;
+    select?: string;
+    filters?: AthenaRpcFilter[];
+    count?: AthenaCountOption;
+    head?: boolean;
+    limit?: number;
+    offset?: number;
+    order?: AthenaRpcOrder;
+}
+interface AthenaQueryPayload {
+    query: string;
+}
+/** 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?: AthenaJsonObject;
+}
+/** 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;
+    /** Overrides `X-Athena-Key` while leaving `apikey` / `x-api-key` / `X-Api-Key` on `apiKey`. */
+    athenaKey?: string | null;
+    client?: string;
+    backend?: BackendOption;
+    publishEvent?: string;
+    forceNoCache?: boolean;
+    headers?: Record<string, string>;
+    userId?: string | null;
+    organizationId?: string | null;
+    /** Direct PostgreSQL URI forwarded as `x-pg-uri` (OpenAPI preferred routing header). */
+    pgUri?: string | null;
+    /** JDBC/PostgreSQL URI mirrored to `x-athena-jdbc-url` and `x-jdbc-url` compatibility headers. */
+    jdbcUrl?: string | null;
+    bearerToken?: string | null;
+    cookie?: string | null;
+    sessionToken?: string | null;
+}
+type AthenaGatewayHookConfig = AthenaGatewayBaseOptions;
+interface AthenaGatewayCallOptions extends AthenaGatewayBaseOptions {
+    schema?: string;
+    count?: AthenaCountOption;
+    head?: boolean;
+    defaultToNull?: boolean;
+    stripNulls?: boolean;
+    onConflict?: string | string[];
+    updateBody?: AthenaJsonObject;
+}
+interface AthenaRpcCallOptions extends AthenaGatewayCallOptions {
+    count?: AthenaCountOption;
+    get?: boolean;
+}
+interface AthenaGatewayResponse<T = unknown> {
+    ok: boolean;
+    status: number;
+    statusText?: string | null;
+    data: T | null;
+    count?: number | null;
+    error?: string;
+    errorDetails?: AthenaGatewayErrorDetails | null;
+    raw: unknown;
+}
+type AthenaGatewayErrorCode = 'NETWORK_ERROR' | 'INVALID_URL' | '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 AthenaGatewayConnectionOptions {
+    path?: `/${string}`;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}
+interface AthenaGatewayConnectionResult {
+    ok: boolean;
+    reachable: boolean;
+    status: number;
+    statusText?: string | null;
+    baseUrl: string;
+    url: string;
+    error?: string;
+    errorDetails?: AthenaGatewayErrorDetails | null;
+    raw: unknown;
+}
+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 AthenaConditionCastType as A, Backend as B, type AthenaGatewayBaseOptions as C, type AthenaConditionValue as D, type AthenaConditionArrayValue as E, type AthenaGatewayCondition as F, type AthenaSortBy as G, type AthenaConditionOperator as H, type BackendOption as I, type AthenaGatewayCallOptions as a, type AthenaGatewayConnectionOptions as b, type AthenaGatewayConnectionResult as c, type AthenaGatewayErrorCode as d, type AthenaGatewayErrorDetails as e, type AthenaJsonArray as f, type AthenaJsonObject as g, type AthenaJsonPrimitive as h, type AthenaJsonValue as i, type AthenaRpcCallOptions as j, type AthenaRpcFilter as k, type AthenaRpcFilterOperator as l, type AthenaRpcOrder as m, type AthenaRpcPayload as n, type BackendConfig as o, type BackendType as p, type AthenaGatewayHookConfig as q, type AthenaGatewayHookResult as r, type AthenaDeletePayload as s, type AthenaFetchPayload as t, type AthenaGatewayResponse as u, type AthenaInsertPayload as v, type AthenaUpdatePayload as w, type AthenaGatewayEndpointPath as x, type AthenaGatewayMethod as y, type AthenaQueryPayload as z };

package/dist/types-BRUHGXo2.d.ts

@@ -0,0 +1,236 @@
+/**
+ * athena gateway types
+ *
+ * type definitions for the athena gateway api client and react hook
+ */
+type AthenaGatewayMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type AthenaGatewayEndpointPath = '/gateway/fetch' | '/gateway/insert' | '/gateway/update' | '/gateway/delete' | '/gateway/rpc' | '/gateway/query' | `/rpc/${string}` | `/storage/${string}`;
+type AthenaCountOption = 'exact' | 'planned' | 'estimated';
+type AthenaJsonPrimitive = string | number | boolean | null;
+type AthenaJsonValue = AthenaJsonPrimitive | AthenaJsonObject | AthenaJsonArray;
+interface AthenaJsonObject {
+    [key: string]: AthenaJsonValue;
+}
+type AthenaJsonArray = AthenaJsonValue[];
+type AthenaConditionValue = AthenaJsonPrimitive;
+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 {
+    select?: string | AthenaJsonObject;
+    view_name?: string;
+    table_name?: string;
+    columns?: string[] | string;
+    where?: AthenaJsonObject;
+    orderBy?: AthenaJsonObject | AthenaJsonArray;
+    conditions?: AthenaGatewayCondition[];
+    limit?: number;
+    offset?: number;
+    current_page?: number;
+    page_size?: number;
+    total_pages?: number;
+    strip_nulls?: boolean;
+    count?: AthenaCountOption;
+    head?: boolean;
+    group_by?: string;
+    time_granularity?: 'day' | 'hour' | 'minute';
+    aggregation_column?: string;
+    aggregation_strategy?: 'cumulative_sum';
+    aggregation_dedup?: boolean;
+    sort_by?: AthenaSortBy;
+}
+interface AthenaInsertPayload<TInsertBody = AthenaJsonObject, TUpdateBody = AthenaJsonObject> {
+    table_name: string;
+    insert_body: TInsertBody | TInsertBody[];
+    update_body?: TUpdateBody;
+    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<TUpdateBody = AthenaJsonObject> extends AthenaFetchPayload {
+    set?: TUpdateBody;
+    data?: TUpdateBody;
+}
+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<TArgs = AthenaJsonObject> {
+    function: string;
+    function_name?: string;
+    schema?: string;
+    args?: TArgs;
+    select?: string;
+    filters?: AthenaRpcFilter[];
+    count?: AthenaCountOption;
+    head?: boolean;
+    limit?: number;
+    offset?: number;
+    order?: AthenaRpcOrder;
+}
+interface AthenaQueryPayload {
+    query: string;
+}
+/** 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?: AthenaJsonObject;
+}
+/** 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;
+    /** Overrides `X-Athena-Key` while leaving `apikey` / `x-api-key` / `X-Api-Key` on `apiKey`. */
+    athenaKey?: string | null;
+    client?: string;
+    backend?: BackendOption;
+    publishEvent?: string;
+    forceNoCache?: boolean;
+    headers?: Record<string, string>;
+    userId?: string | null;
+    organizationId?: string | null;
+    /** Direct PostgreSQL URI forwarded as `x-pg-uri` (OpenAPI preferred routing header). */
+    pgUri?: string | null;
+    /** JDBC/PostgreSQL URI mirrored to `x-athena-jdbc-url` and `x-jdbc-url` compatibility headers. */
+    jdbcUrl?: string | null;
+    bearerToken?: string | null;
+    cookie?: string | null;
+    sessionToken?: string | null;
+}
+type AthenaGatewayHookConfig = AthenaGatewayBaseOptions;
+interface AthenaGatewayCallOptions extends AthenaGatewayBaseOptions {
+    schema?: string;
+    count?: AthenaCountOption;
+    head?: boolean;
+    defaultToNull?: boolean;
+    stripNulls?: boolean;
+    onConflict?: string | string[];
+    updateBody?: AthenaJsonObject;
+}
+interface AthenaRpcCallOptions extends AthenaGatewayCallOptions {
+    count?: AthenaCountOption;
+    get?: boolean;
+}
+interface AthenaGatewayResponse<T = unknown> {
+    ok: boolean;
+    status: number;
+    statusText?: string | null;
+    data: T | null;
+    count?: number | null;
+    error?: string;
+    errorDetails?: AthenaGatewayErrorDetails | null;
+    raw: unknown;
+}
+type AthenaGatewayErrorCode = 'NETWORK_ERROR' | 'INVALID_URL' | '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 AthenaGatewayConnectionOptions {
+    path?: `/${string}`;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}
+interface AthenaGatewayConnectionResult {
+    ok: boolean;
+    reachable: boolean;
+    status: number;
+    statusText?: string | null;
+    baseUrl: string;
+    url: string;
+    error?: string;
+    errorDetails?: AthenaGatewayErrorDetails | null;
+    raw: unknown;
+}
+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 AthenaConditionCastType as A, Backend as B, type AthenaGatewayBaseOptions as C, type AthenaConditionValue as D, type AthenaConditionArrayValue as E, type AthenaGatewayCondition as F, type AthenaSortBy as G, type AthenaConditionOperator as H, type BackendOption as I, type AthenaGatewayCallOptions as a, type AthenaGatewayConnectionOptions as b, type AthenaGatewayConnectionResult as c, type AthenaGatewayErrorCode as d, type AthenaGatewayErrorDetails as e, type AthenaJsonArray as f, type AthenaJsonObject as g, type AthenaJsonPrimitive as h, type AthenaJsonValue as i, type AthenaRpcCallOptions as j, type AthenaRpcFilter as k, type AthenaRpcFilterOperator as l, type AthenaRpcOrder as m, type AthenaRpcPayload as n, type BackendConfig as o, type BackendType as p, type AthenaGatewayHookConfig as q, type AthenaGatewayHookResult as r, type AthenaDeletePayload as s, type AthenaFetchPayload as t, type AthenaGatewayResponse as u, type AthenaInsertPayload as v, type AthenaUpdatePayload as w, type AthenaGatewayEndpointPath as x, type AthenaGatewayMethod as y, type AthenaQueryPayload as z };