@xylex-group/athena 3.1.0 → 3.5.1

package/dist/schema-handlers-CvWqF-dW.d.ts

@@ -0,0 +1,138 @@
+import { ag as AthenaClient } from './v3-client-OAai_JNs.js';
+
+/**
+ * Config accepted by the table schema catalog route and {@link fetchAthenaTableCatalog}.
+ *
+ * Shape matches the Athena Auth UI table builder client config fields used for
+ * gateway schema introspection (not the full builder experimental surface).
+ */
+interface AthenaTableSchemaConfig {
+    /** Registry client name (`X-Athena-Client` / `createClient({ client })`). */
+    clientName: string;
+    /** Logical database label returned in the catalog response. */
+    gatewayDatabase: string;
+    /** Athena gateway API key. */
+    gatewayKey: string;
+    /** Athena gateway base URL. */
+    gatewayUrl: string;
+    /**
+     * Comma-separated PostgreSQL schema names to introspect
+     * (e.g. `"public,athena"`).
+     */
+    schemaScope: string;
+}
+interface AthenaTableCatalogColumn {
+    dataType: string;
+    isNullable: boolean;
+    isPrimaryKey: boolean;
+    name: string;
+}
+interface AthenaTableCatalogRelation {
+    columns: AthenaTableCatalogColumn[];
+    name: string;
+    targetSchema: string;
+    targetTable: string;
+}
+interface AthenaTableCatalogTable {
+    columns: AthenaTableCatalogColumn[];
+    id: string;
+    name: string;
+    primaryKey: string[];
+    relations: AthenaTableCatalogRelation[];
+    schema: string;
+}
+interface AthenaTableCatalogResponse {
+    database: string;
+    generatedAt: string;
+    tables: AthenaTableCatalogTable[];
+}
+/** @deprecated Prefer {@link AthenaTableSchemaConfig}. */
+type AthenaTableShowcaseConfig = AthenaTableSchemaConfig;
+/** @deprecated Prefer {@link AthenaTableCatalogColumn}. */
+type TableCatalogColumn = AthenaTableCatalogColumn;
+/** @deprecated Prefer {@link AthenaTableCatalogRelation}. */
+type TableCatalogRelation = AthenaTableCatalogRelation;
+/** @deprecated Prefer {@link AthenaTableCatalogTable}. */
+type TableCatalogTable = AthenaTableCatalogTable;
+/** @deprecated Prefer {@link AthenaTableCatalogResponse}. */
+type TableCatalogResponse = AthenaTableCatalogResponse;
+
+/** Minimal query surface used by the catalog (v3 client or compatible). */
+interface AthenaTableCatalogQueryClient {
+    query: AthenaClient['query'];
+}
+interface FetchAthenaTableCatalogOptions {
+    /**
+     * Optional pre-built client. When omitted, a short-lived client is created
+     * from `config.gatewayUrl`, `config.gatewayKey`, and `config.clientName`.
+     */
+    client?: AthenaTableCatalogQueryClient;
+}
+/**
+ * Parse a comma-separated schema scope into unique non-empty names.
+ */
+declare function parseAthenaTableSchemaScope(value: string): string[];
+/**
+ * Build gateway SQL for columns, primary keys, and foreign keys for the
+ * given schema list (parameter placeholders inlined for gateway SQL).
+ */
+declare function buildAthenaTableCatalogQueries(schemas: readonly string[]): {
+    columns: string;
+    foreignKeys: string;
+    primaryKeys: string;
+};
+/**
+ * Whether `value` has the required string fields for schema catalog config.
+ */
+declare function isAthenaTableSchemaConfig(value: unknown): value is AthenaTableSchemaConfig;
+/**
+ * Whether gateway credentials are non-empty after trim.
+ */
+declare function hasAthenaTableSchemaCredentials(config: AthenaTableSchemaConfig): boolean;
+/**
+ * Introspect tables, columns, primary keys, and relations for the schemas in
+ * `config.schemaScope` via the Athena gateway SQL API.
+ */
+declare function fetchAthenaTableCatalog(config: AthenaTableSchemaConfig, options?: FetchAthenaTableCatalogOptions): Promise<AthenaTableCatalogResponse>;
+/** @deprecated Prefer {@link fetchAthenaTableCatalog}. */
+declare const fetchTableCatalog: typeof fetchAthenaTableCatalog;
+
+/** Default path for the table schema catalog App Router route. */
+declare const ATHENA_TABLE_SCHEMA_ROUTE = "/api/tables/schema";
+interface AthenaTableSchemaHandlerOptions extends FetchAthenaTableCatalogOptions {
+    /**
+     * Optional transform after a valid config is parsed (e.g. fill defaults from
+     * server env). Return `null` to reject with 400.
+     */
+    resolveConfig?: (config: AthenaTableSchemaConfig, request: Request) => AthenaTableSchemaConfig | null | Promise<AthenaTableSchemaConfig | null>;
+}
+/**
+ * Handle `POST /api/tables/schema` — introspect gateway table metadata.
+ *
+ * Expected body: `{ "config": AthenaTableSchemaConfig }`.
+ *
+ * @returns `200` catalog JSON, `400` for invalid config, `500` on failure
+ */
+declare function handleAthenaTableSchemaPost(request: Request, options?: AthenaTableSchemaHandlerOptions): Promise<Response>;
+/**
+ * Create App Router handlers for the table schema catalog route.
+ *
+ * Drop into a route file with no additional wiring:
+ *
+ * @example
+ * ```ts
+ * // app/api/tables/schema/route.ts
+ * import { createAthenaTableSchemaHandlers } from '@xylex-group/athena'
+ *
+ * export const dynamic = 'force-dynamic'
+ * export const { POST } = createAthenaTableSchemaHandlers()
+ * ```
+ *
+ * @param options - Optional client injection or config resolution
+ * @returns Object with a `POST` route handler
+ */
+declare function createAthenaTableSchemaHandlers(options?: AthenaTableSchemaHandlerOptions): {
+    POST: (request: Request) => Promise<Response>;
+};
+
+export { ATHENA_TABLE_SCHEMA_ROUTE as A, type FetchAthenaTableCatalogOptions as F, type TableCatalogColumn as T, type AthenaTableCatalogColumn as a, type AthenaTableCatalogQueryClient as b, type AthenaTableCatalogRelation as c, type AthenaTableCatalogResponse as d, type AthenaTableCatalogTable as e, type AthenaTableSchemaConfig as f, type AthenaTableSchemaHandlerOptions as g, type AthenaTableShowcaseConfig as h, type TableCatalogRelation as i, type TableCatalogResponse as j, type TableCatalogTable as k, buildAthenaTableCatalogQueries as l, createAthenaTableSchemaHandlers as m, fetchAthenaTableCatalog as n, fetchTableCatalog as o, handleAthenaTableSchemaPost as p, hasAthenaTableSchemaCredentials as q, isAthenaTableSchemaConfig as r, parseAthenaTableSchemaScope as s };

package/dist/schema-handlers-Dr8h9Jg-.d.cts

@@ -0,0 +1,138 @@
+import { ag as AthenaClient } from './v3-client-DP-qg82X.cjs';
+
+/**
+ * Config accepted by the table schema catalog route and {@link fetchAthenaTableCatalog}.
+ *
+ * Shape matches the Athena Auth UI table builder client config fields used for
+ * gateway schema introspection (not the full builder experimental surface).
+ */
+interface AthenaTableSchemaConfig {
+    /** Registry client name (`X-Athena-Client` / `createClient({ client })`). */
+    clientName: string;
+    /** Logical database label returned in the catalog response. */
+    gatewayDatabase: string;
+    /** Athena gateway API key. */
+    gatewayKey: string;
+    /** Athena gateway base URL. */
+    gatewayUrl: string;
+    /**
+     * Comma-separated PostgreSQL schema names to introspect
+     * (e.g. `"public,athena"`).
+     */
+    schemaScope: string;
+}
+interface AthenaTableCatalogColumn {
+    dataType: string;
+    isNullable: boolean;
+    isPrimaryKey: boolean;
+    name: string;
+}
+interface AthenaTableCatalogRelation {
+    columns: AthenaTableCatalogColumn[];
+    name: string;
+    targetSchema: string;
+    targetTable: string;
+}
+interface AthenaTableCatalogTable {
+    columns: AthenaTableCatalogColumn[];
+    id: string;
+    name: string;
+    primaryKey: string[];
+    relations: AthenaTableCatalogRelation[];
+    schema: string;
+}
+interface AthenaTableCatalogResponse {
+    database: string;
+    generatedAt: string;
+    tables: AthenaTableCatalogTable[];
+}
+/** @deprecated Prefer {@link AthenaTableSchemaConfig}. */
+type AthenaTableShowcaseConfig = AthenaTableSchemaConfig;
+/** @deprecated Prefer {@link AthenaTableCatalogColumn}. */
+type TableCatalogColumn = AthenaTableCatalogColumn;
+/** @deprecated Prefer {@link AthenaTableCatalogRelation}. */
+type TableCatalogRelation = AthenaTableCatalogRelation;
+/** @deprecated Prefer {@link AthenaTableCatalogTable}. */
+type TableCatalogTable = AthenaTableCatalogTable;
+/** @deprecated Prefer {@link AthenaTableCatalogResponse}. */
+type TableCatalogResponse = AthenaTableCatalogResponse;
+
+/** Minimal query surface used by the catalog (v3 client or compatible). */
+interface AthenaTableCatalogQueryClient {
+    query: AthenaClient['query'];
+}
+interface FetchAthenaTableCatalogOptions {
+    /**
+     * Optional pre-built client. When omitted, a short-lived client is created
+     * from `config.gatewayUrl`, `config.gatewayKey`, and `config.clientName`.
+     */
+    client?: AthenaTableCatalogQueryClient;
+}
+/**
+ * Parse a comma-separated schema scope into unique non-empty names.
+ */
+declare function parseAthenaTableSchemaScope(value: string): string[];
+/**
+ * Build gateway SQL for columns, primary keys, and foreign keys for the
+ * given schema list (parameter placeholders inlined for gateway SQL).
+ */
+declare function buildAthenaTableCatalogQueries(schemas: readonly string[]): {
+    columns: string;
+    foreignKeys: string;
+    primaryKeys: string;
+};
+/**
+ * Whether `value` has the required string fields for schema catalog config.
+ */
+declare function isAthenaTableSchemaConfig(value: unknown): value is AthenaTableSchemaConfig;
+/**
+ * Whether gateway credentials are non-empty after trim.
+ */
+declare function hasAthenaTableSchemaCredentials(config: AthenaTableSchemaConfig): boolean;
+/**
+ * Introspect tables, columns, primary keys, and relations for the schemas in
+ * `config.schemaScope` via the Athena gateway SQL API.
+ */
+declare function fetchAthenaTableCatalog(config: AthenaTableSchemaConfig, options?: FetchAthenaTableCatalogOptions): Promise<AthenaTableCatalogResponse>;
+/** @deprecated Prefer {@link fetchAthenaTableCatalog}. */
+declare const fetchTableCatalog: typeof fetchAthenaTableCatalog;
+
+/** Default path for the table schema catalog App Router route. */
+declare const ATHENA_TABLE_SCHEMA_ROUTE = "/api/tables/schema";
+interface AthenaTableSchemaHandlerOptions extends FetchAthenaTableCatalogOptions {
+    /**
+     * Optional transform after a valid config is parsed (e.g. fill defaults from
+     * server env). Return `null` to reject with 400.
+     */
+    resolveConfig?: (config: AthenaTableSchemaConfig, request: Request) => AthenaTableSchemaConfig | null | Promise<AthenaTableSchemaConfig | null>;
+}
+/**
+ * Handle `POST /api/tables/schema` — introspect gateway table metadata.
+ *
+ * Expected body: `{ "config": AthenaTableSchemaConfig }`.
+ *
+ * @returns `200` catalog JSON, `400` for invalid config, `500` on failure
+ */
+declare function handleAthenaTableSchemaPost(request: Request, options?: AthenaTableSchemaHandlerOptions): Promise<Response>;
+/**
+ * Create App Router handlers for the table schema catalog route.
+ *
+ * Drop into a route file with no additional wiring:
+ *
+ * @example
+ * ```ts
+ * // app/api/tables/schema/route.ts
+ * import { createAthenaTableSchemaHandlers } from '@xylex-group/athena'
+ *
+ * export const dynamic = 'force-dynamic'
+ * export const { POST } = createAthenaTableSchemaHandlers()
+ * ```
+ *
+ * @param options - Optional client injection or config resolution
+ * @returns Object with a `POST` route handler
+ */
+declare function createAthenaTableSchemaHandlers(options?: AthenaTableSchemaHandlerOptions): {
+    POST: (request: Request) => Promise<Response>;
+};
+
+export { ATHENA_TABLE_SCHEMA_ROUTE as A, type FetchAthenaTableCatalogOptions as F, type TableCatalogColumn as T, type AthenaTableCatalogColumn as a, type AthenaTableCatalogQueryClient as b, type AthenaTableCatalogRelation as c, type AthenaTableCatalogResponse as d, type AthenaTableCatalogTable as e, type AthenaTableSchemaConfig as f, type AthenaTableSchemaHandlerOptions as g, type AthenaTableShowcaseConfig as h, type TableCatalogRelation as i, type TableCatalogResponse as j, type TableCatalogTable as k, buildAthenaTableCatalogQueries as l, createAthenaTableSchemaHandlers as m, fetchAthenaTableCatalog as n, fetchTableCatalog as o, handleAthenaTableSchemaPost as p, hasAthenaTableSchemaCredentials as q, isAthenaTableSchemaConfig as r, parseAthenaTableSchemaScope as s };

package/dist/social-providers.cjs

@@ -32,7 +32,7 @@ function shouldPublishLog(current, level) {
 }
 function resolveLogLevel() {
   try {
-    const env = typeof process !== "undefined" && process.env ? process.env.ATHENA_AUTH_LOG_LEVEL : void 0;
+    const env = globalThis.process?.env?.ATHENA_AUTH_LOG_LEVEL;
     if (env === "debug" || env === "info" || env === "warn" || env === "error" || env === "success") {
       return env;
     }