@xylex-group/athena 2.7.0 → 2.8.0

package/dist/{types-BSIsyss1.d.cts → types-BzY6fETM.d.ts}

@@ -1,4 +1,4 @@
-import { p as BackendType, I as IntrospectionSnapshot, S as SchemaIntrospectionProvider } from './types-BsyRW49r.cjs';
+import { q as BackendType, I as IntrospectionSnapshot, S as SchemaIntrospectionProvider } from './types-vikz9YIO.js';
 
 /**
  * Supported case transformations for generated symbols and path token variants.
@@ -35,6 +35,13 @@ interface GeneratorExperimentalFlags {
      */
     scyllaProviderContracts: boolean;
 }
+/**
+ * Internal generator metadata carried on normalized configs and generated
+ * registry artifacts so downstream tooling can detect contract revisions.
+ */
+interface GeneratorInternalConfig {
+    schemaVersion: number;
+}
 /**
  * Path templates for each generated artifact category.
  */
@@ -44,10 +51,20 @@ interface GeneratorOutputTargets {
     database: string;
     registry: string;
 }
+type GeneratorOutputFormat = 'define-model' | 'table-builder';
 /**
  * Output configuration including dynamic placeholder aliases.
  */
 interface GeneratorOutputConfig {
+    format?: GeneratorOutputFormat;
+    targets?: Partial<GeneratorOutputTargets>;
+    placeholderMap?: Record<string, string>;
+}
+/**
+ * Normalized output configuration with defaults applied.
+ */
+interface NormalizedGeneratorOutputConfig {
+    format: GeneratorOutputFormat;
     targets: GeneratorOutputTargets;
     placeholderMap: Record<string, string>;
 }
@@ -66,6 +83,13 @@ interface PostgresDirectProviderConfig {
     database?: string;
     schemas?: GeneratorSchemaSelection;
 }
+interface PostgresDirectProviderInputConfig {
+    kind: 'postgres';
+    mode: 'direct';
+    connectionString?: string;
+    database?: string;
+    schemas?: GeneratorSchemaSelection;
+}
 /**
  * Athena gateway-backed PostgreSQL introspection mode using `/gateway/query`.
  */
@@ -78,6 +102,15 @@ interface PostgresGatewayProviderConfig {
     schemas?: GeneratorSchemaSelection;
     backend?: BackendType;
 }
+interface PostgresGatewayProviderInputConfig {
+    kind: 'postgres';
+    mode: 'gateway';
+    gatewayUrl?: string;
+    apiKey?: string;
+    database?: string;
+    schemas?: GeneratorSchemaSelection;
+    backend?: BackendType;
+}
 /**
  * Scylla introspection provider contract placeholder (phase-two scaffold).
  */
@@ -88,13 +121,21 @@ interface ScyllaDirectProviderConfig {
     keyspace: string;
     datacenter?: string;
 }
+interface ScyllaDirectProviderInputConfig {
+    kind: 'scylla';
+    mode: 'direct';
+    contactPoints?: string[];
+    keyspace?: string;
+    datacenter?: string;
+}
 type GeneratorProviderConfig = PostgresDirectProviderConfig | PostgresGatewayProviderConfig | ScyllaDirectProviderConfig;
+type GeneratorProviderInputConfig = PostgresDirectProviderInputConfig | PostgresGatewayProviderInputConfig | ScyllaDirectProviderInputConfig;
 /**
  * Root config contract loaded from `athena.config.ts`.
  */
 interface AthenaGeneratorConfig {
-    provider: GeneratorProviderConfig;
-    output: GeneratorOutputConfig;
+    provider: GeneratorProviderInputConfig;
+    output?: GeneratorOutputConfig;
     naming?: Partial<GeneratorNamingConfig>;
     features?: Partial<GeneratorFeatureFlags>;
     experimental?: Partial<GeneratorExperimentalFlags>;
@@ -104,10 +145,11 @@ interface AthenaGeneratorConfig {
  */
 interface NormalizedAthenaGeneratorConfig {
     provider: GeneratorProviderConfig;
-    output: GeneratorOutputConfig;
+    output: NormalizedGeneratorOutputConfig;
     naming: GeneratorNamingConfig;
     features: GeneratorFeatureFlags;
     experimental: GeneratorExperimentalFlags;
+    internal: GeneratorInternalConfig;
 }
 /**
  * Config loader options for CLI/programmatic usage.
@@ -156,4 +198,4 @@ interface RunGeneratorResult extends GeneratedArtifacts {
     writtenFiles: string[];
 }
 
-export type { AthenaGeneratorConfig as A, GeneratedArtifacts as G, LoadGeneratorConfigOptions as L, NormalizedAthenaGeneratorConfig as N, RunGeneratorOptions as R, LoadedGeneratorConfig as a, GeneratorProviderConfig as b, GeneratorExperimentalFlags as c, GeneratedArtifact as d, GeneratorArtifactKind as e, GeneratorFeatureFlags as f, GeneratorNamingConfig as g, GeneratorOutputConfig as h, GeneratorOutputTargets as i, GeneratorSchemaSelection as j, NamingStyle as k, RunGeneratorResult as l };
+export type { AthenaGeneratorConfig as A, GeneratedArtifacts as G, LoadGeneratorConfigOptions as L, NormalizedAthenaGeneratorConfig as N, RunGeneratorOptions as R, LoadedGeneratorConfig as a, GeneratorProviderConfig as b, GeneratorExperimentalFlags as c, GeneratedArtifact as d, GeneratorArtifactKind as e, GeneratorFeatureFlags as f, GeneratorInternalConfig as g, GeneratorNamingConfig as h, GeneratorOutputConfig as i, GeneratorOutputFormat as j, GeneratorOutputTargets as k, GeneratorSchemaSelection as l, NamingStyle as m, NormalizedGeneratorOutputConfig as n, RunGeneratorResult as o };

package/dist/{types-t_TVqnmp.d.ts → types-CAtTGGoz.d.cts}

@@ -1,4 +1,4 @@
-import { p as BackendType, I as IntrospectionSnapshot, S as SchemaIntrospectionProvider } from './types-BsyRW49r.js';
+import { q as BackendType, I as IntrospectionSnapshot, S as SchemaIntrospectionProvider } from './types-vikz9YIO.cjs';
 
 /**
  * Supported case transformations for generated symbols and path token variants.
@@ -35,6 +35,13 @@ interface GeneratorExperimentalFlags {
      */
     scyllaProviderContracts: boolean;
 }
+/**
+ * Internal generator metadata carried on normalized configs and generated
+ * registry artifacts so downstream tooling can detect contract revisions.
+ */
+interface GeneratorInternalConfig {
+    schemaVersion: number;
+}
 /**
  * Path templates for each generated artifact category.
  */
@@ -44,10 +51,20 @@ interface GeneratorOutputTargets {
     database: string;
     registry: string;
 }
+type GeneratorOutputFormat = 'define-model' | 'table-builder';
 /**
  * Output configuration including dynamic placeholder aliases.
  */
 interface GeneratorOutputConfig {
+    format?: GeneratorOutputFormat;
+    targets?: Partial<GeneratorOutputTargets>;
+    placeholderMap?: Record<string, string>;
+}
+/**
+ * Normalized output configuration with defaults applied.
+ */
+interface NormalizedGeneratorOutputConfig {
+    format: GeneratorOutputFormat;
     targets: GeneratorOutputTargets;
     placeholderMap: Record<string, string>;
 }
@@ -66,6 +83,13 @@ interface PostgresDirectProviderConfig {
     database?: string;
     schemas?: GeneratorSchemaSelection;
 }
+interface PostgresDirectProviderInputConfig {
+    kind: 'postgres';
+    mode: 'direct';
+    connectionString?: string;
+    database?: string;
+    schemas?: GeneratorSchemaSelection;
+}
 /**
  * Athena gateway-backed PostgreSQL introspection mode using `/gateway/query`.
  */
@@ -78,6 +102,15 @@ interface PostgresGatewayProviderConfig {
     schemas?: GeneratorSchemaSelection;
     backend?: BackendType;
 }
+interface PostgresGatewayProviderInputConfig {
+    kind: 'postgres';
+    mode: 'gateway';
+    gatewayUrl?: string;
+    apiKey?: string;
+    database?: string;
+    schemas?: GeneratorSchemaSelection;
+    backend?: BackendType;
+}
 /**
  * Scylla introspection provider contract placeholder (phase-two scaffold).
  */
@@ -88,13 +121,21 @@ interface ScyllaDirectProviderConfig {
     keyspace: string;
     datacenter?: string;
 }
+interface ScyllaDirectProviderInputConfig {
+    kind: 'scylla';
+    mode: 'direct';
+    contactPoints?: string[];
+    keyspace?: string;
+    datacenter?: string;
+}
 type GeneratorProviderConfig = PostgresDirectProviderConfig | PostgresGatewayProviderConfig | ScyllaDirectProviderConfig;
+type GeneratorProviderInputConfig = PostgresDirectProviderInputConfig | PostgresGatewayProviderInputConfig | ScyllaDirectProviderInputConfig;
 /**
  * Root config contract loaded from `athena.config.ts`.
  */
 interface AthenaGeneratorConfig {
-    provider: GeneratorProviderConfig;
-    output: GeneratorOutputConfig;
+    provider: GeneratorProviderInputConfig;
+    output?: GeneratorOutputConfig;
     naming?: Partial<GeneratorNamingConfig>;
     features?: Partial<GeneratorFeatureFlags>;
     experimental?: Partial<GeneratorExperimentalFlags>;
@@ -104,10 +145,11 @@ interface AthenaGeneratorConfig {
  */
 interface NormalizedAthenaGeneratorConfig {
     provider: GeneratorProviderConfig;
-    output: GeneratorOutputConfig;
+    output: NormalizedGeneratorOutputConfig;
     naming: GeneratorNamingConfig;
     features: GeneratorFeatureFlags;
     experimental: GeneratorExperimentalFlags;
+    internal: GeneratorInternalConfig;
 }
 /**
  * Config loader options for CLI/programmatic usage.
@@ -156,4 +198,4 @@ interface RunGeneratorResult extends GeneratedArtifacts {
     writtenFiles: string[];
 }
 
-export type { AthenaGeneratorConfig as A, GeneratedArtifacts as G, LoadGeneratorConfigOptions as L, NormalizedAthenaGeneratorConfig as N, RunGeneratorOptions as R, LoadedGeneratorConfig as a, GeneratorProviderConfig as b, GeneratorExperimentalFlags as c, GeneratedArtifact as d, GeneratorArtifactKind as e, GeneratorFeatureFlags as f, GeneratorNamingConfig as g, GeneratorOutputConfig as h, GeneratorOutputTargets as i, GeneratorSchemaSelection as j, NamingStyle as k, RunGeneratorResult as l };
+export type { AthenaGeneratorConfig as A, GeneratedArtifacts as G, LoadGeneratorConfigOptions as L, NormalizedAthenaGeneratorConfig as N, RunGeneratorOptions as R, LoadedGeneratorConfig as a, GeneratorProviderConfig as b, GeneratorExperimentalFlags as c, GeneratedArtifact as d, GeneratorArtifactKind as e, GeneratorFeatureFlags as f, GeneratorInternalConfig as g, GeneratorNamingConfig as h, GeneratorOutputConfig as i, GeneratorOutputFormat as j, GeneratorOutputTargets as k, GeneratorSchemaSelection as l, NamingStyle as m, NormalizedGeneratorOutputConfig as n, RunGeneratorResult as o };

package/dist/{types-BsyRW49r.d.cts → types-vikz9YIO.d.cts}

@@ -222,6 +222,21 @@ interface AthenaGatewayHookResult {
 
 type ModelKey = string;
 type ColumnKey = string;
+/**
+ * Supported column helper families for table-builder definitions.
+ */
+type ModelColumnKind = 'boolean' | 'number' | 'string' | 'json' | 'enumeration';
+/**
+ * Optional per-column metadata carried by model contracts.
+ */
+interface ModelColumnMetadata {
+    kind: ModelColumnKind;
+    columnName?: string;
+    nullable?: boolean;
+    hasDefault?: boolean;
+    isGenerated?: boolean;
+    enumValues?: readonly string[];
+}
 /**
  * Runtime values that can safely be serialized into tenant-scoped headers.
  */
@@ -249,6 +264,7 @@ interface ModelMetadataBase {
     tableName?: string;
     primaryKey: string[];
     nullable?: Partial<Record<string, boolean>>;
+    columns?: Partial<Record<string, ModelColumnMetadata>>;
     relations?: Record<string, ModelRelationMetadata>;
 }
 /**
@@ -257,6 +273,7 @@ interface ModelMetadataBase {
 type ModelMetadata<Row> = Omit<ModelMetadataBase, 'primaryKey' | 'nullable'> & {
     primaryKey: Array<Extract<keyof Row, string>>;
     nullable?: Partial<Record<Extract<keyof Row, string>, boolean>>;
+    columns?: Partial<Record<Extract<keyof Row, string>, ModelColumnMetadata>>;
 };
 /**
  * Relation metadata for model contracts and introspection snapshots.
@@ -290,6 +307,11 @@ interface ModelDef<Row, Insert = Partial<Row>, Update = Partial<Insert>, Meta ex
  * Row-agnostic model definition used as a generic constraint.
  */
 type AnyModelDef = ModelDef<unknown, unknown, unknown, ModelMetadataBase>;
+/**
+ * Public model/table value that carries Athena target metadata plus row/write typings.
+ * This can be passed directly to `client.from(...)` for opt-in target inference.
+ */
+type AthenaModelTarget<Row = unknown, Insert = unknown, Update = unknown> = ModelDef<Row, Insert, Update, ModelMetadataBase>;
 /**
  * Schema-level model registry.
  */
@@ -399,4 +421,4 @@ interface SchemaIntrospectionProvider {
     inspect(options?: IntrospectionInspectOptions): Promise<IntrospectionSnapshot>;
 }
 
-export { type AthenaConditionCastType as A, Backend as B, type ModelRelationMetadata as C, type DatabaseDef as D, type RowOf as E, type SchemaDef as F, type TenantContextValue as G, type TenantKeyMap as H, type IntrospectionSnapshot as I, type AnyModelDef as J, type AthenaGatewayHookConfig as K, type AthenaGatewayHookResult as L, type ModelAt as M, type AthenaDeletePayload as N, type AthenaFetchPayload as O, type AthenaGatewayResponse as P, type AthenaInsertPayload as Q, type RegistryDef as R, type SchemaIntrospectionProvider as S, type TenantContext as T, type UpdateOf as U, type AthenaUpdatePayload as V, type AthenaGatewayEndpointPath as W, type AthenaGatewayMethod as X, type AthenaConditionValue as Y, type AthenaConditionArrayValue as Z, type AthenaConditionOperator as _, 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 InsertOf as q, type IntrospectionColumn as r, type IntrospectionInspectOptions as s, type IntrospectionRelation as t, type IntrospectionSchema as u, type IntrospectionTable as v, type IntrospectionTypeKind as w, type ModelDef as x, type ModelMetadata as y, type ModelRelationKind as z };
+export { type AthenaConditionValue as $, type AthenaConditionCastType as A, Backend as B, type ModelDef as C, type DatabaseDef as D, type ModelMetadata as E, type ModelRelationKind as F, type ModelRelationMetadata as G, type RowOf as H, type IntrospectionSnapshot as I, type SchemaDef as J, type TenantContextValue as K, type TenantKeyMap as L, type ModelAt as M, type AnyModelDef as N, type AthenaGatewayHookConfig as O, type AthenaGatewayHookResult as P, type AthenaDeletePayload as Q, type RegistryDef as R, type SchemaIntrospectionProvider as S, type TenantContext as T, type UpdateOf as U, type AthenaFetchPayload as V, type AthenaGatewayResponse as W, type AthenaInsertPayload as X, type AthenaUpdatePayload as Y, type AthenaGatewayEndpointPath as Z, type AthenaGatewayMethod as _, type AthenaGatewayCallOptions as a, type AthenaConditionArrayValue as a0, type AthenaGatewayCondition as a1, type AthenaSortBy as a2, type AthenaConditionOperator as a3, 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 AthenaModelTarget as j, type AthenaRpcCallOptions as k, type AthenaRpcFilter as l, type AthenaRpcFilterOperator as m, type AthenaRpcOrder as n, type AthenaRpcPayload as o, type BackendConfig as p, type BackendType as q, type InsertOf as r, type IntrospectionColumn as s, type IntrospectionInspectOptions as t, type IntrospectionRelation as u, type IntrospectionSchema as v, type IntrospectionTable as w, type IntrospectionTypeKind as x, type ModelColumnKind as y, type ModelColumnMetadata as z };

package/dist/{types-BsyRW49r.d.ts → types-vikz9YIO.d.ts}

@@ -222,6 +222,21 @@ interface AthenaGatewayHookResult {
 
 type ModelKey = string;
 type ColumnKey = string;
+/**
+ * Supported column helper families for table-builder definitions.
+ */
+type ModelColumnKind = 'boolean' | 'number' | 'string' | 'json' | 'enumeration';
+/**
+ * Optional per-column metadata carried by model contracts.
+ */
+interface ModelColumnMetadata {
+    kind: ModelColumnKind;
+    columnName?: string;
+    nullable?: boolean;
+    hasDefault?: boolean;
+    isGenerated?: boolean;
+    enumValues?: readonly string[];
+}
 /**
  * Runtime values that can safely be serialized into tenant-scoped headers.
  */
@@ -249,6 +264,7 @@ interface ModelMetadataBase {
     tableName?: string;
     primaryKey: string[];
     nullable?: Partial<Record<string, boolean>>;
+    columns?: Partial<Record<string, ModelColumnMetadata>>;
     relations?: Record<string, ModelRelationMetadata>;
 }
 /**
@@ -257,6 +273,7 @@ interface ModelMetadataBase {
 type ModelMetadata<Row> = Omit<ModelMetadataBase, 'primaryKey' | 'nullable'> & {
     primaryKey: Array<Extract<keyof Row, string>>;
     nullable?: Partial<Record<Extract<keyof Row, string>, boolean>>;
+    columns?: Partial<Record<Extract<keyof Row, string>, ModelColumnMetadata>>;
 };
 /**
  * Relation metadata for model contracts and introspection snapshots.
@@ -290,6 +307,11 @@ interface ModelDef<Row, Insert = Partial<Row>, Update = Partial<Insert>, Meta ex
  * Row-agnostic model definition used as a generic constraint.
  */
 type AnyModelDef = ModelDef<unknown, unknown, unknown, ModelMetadataBase>;
+/**
+ * Public model/table value that carries Athena target metadata plus row/write typings.
+ * This can be passed directly to `client.from(...)` for opt-in target inference.
+ */
+type AthenaModelTarget<Row = unknown, Insert = unknown, Update = unknown> = ModelDef<Row, Insert, Update, ModelMetadataBase>;
 /**
  * Schema-level model registry.
  */
@@ -399,4 +421,4 @@ interface SchemaIntrospectionProvider {
     inspect(options?: IntrospectionInspectOptions): Promise<IntrospectionSnapshot>;
 }
 
-export { type AthenaConditionCastType as A, Backend as B, type ModelRelationMetadata as C, type DatabaseDef as D, type RowOf as E, type SchemaDef as F, type TenantContextValue as G, type TenantKeyMap as H, type IntrospectionSnapshot as I, type AnyModelDef as J, type AthenaGatewayHookConfig as K, type AthenaGatewayHookResult as L, type ModelAt as M, type AthenaDeletePayload as N, type AthenaFetchPayload as O, type AthenaGatewayResponse as P, type AthenaInsertPayload as Q, type RegistryDef as R, type SchemaIntrospectionProvider as S, type TenantContext as T, type UpdateOf as U, type AthenaUpdatePayload as V, type AthenaGatewayEndpointPath as W, type AthenaGatewayMethod as X, type AthenaConditionValue as Y, type AthenaConditionArrayValue as Z, type AthenaConditionOperator as _, 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 InsertOf as q, type IntrospectionColumn as r, type IntrospectionInspectOptions as s, type IntrospectionRelation as t, type IntrospectionSchema as u, type IntrospectionTable as v, type IntrospectionTypeKind as w, type ModelDef as x, type ModelMetadata as y, type ModelRelationKind as z };
+export { type AthenaConditionValue as $, type AthenaConditionCastType as A, Backend as B, type ModelDef as C, type DatabaseDef as D, type ModelMetadata as E, type ModelRelationKind as F, type ModelRelationMetadata as G, type RowOf as H, type IntrospectionSnapshot as I, type SchemaDef as J, type TenantContextValue as K, type TenantKeyMap as L, type ModelAt as M, type AnyModelDef as N, type AthenaGatewayHookConfig as O, type AthenaGatewayHookResult as P, type AthenaDeletePayload as Q, type RegistryDef as R, type SchemaIntrospectionProvider as S, type TenantContext as T, type UpdateOf as U, type AthenaFetchPayload as V, type AthenaGatewayResponse as W, type AthenaInsertPayload as X, type AthenaUpdatePayload as Y, type AthenaGatewayEndpointPath as Z, type AthenaGatewayMethod as _, type AthenaGatewayCallOptions as a, type AthenaConditionArrayValue as a0, type AthenaGatewayCondition as a1, type AthenaSortBy as a2, type AthenaConditionOperator as a3, 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 AthenaModelTarget as j, type AthenaRpcCallOptions as k, type AthenaRpcFilter as l, type AthenaRpcFilterOperator as m, type AthenaRpcOrder as n, type AthenaRpcPayload as o, type BackendConfig as p, type BackendType as q, type InsertOf as r, type IntrospectionColumn as s, type IntrospectionInspectOptions as t, type IntrospectionRelation as u, type IntrospectionSchema as v, type IntrospectionTable as w, type IntrospectionTypeKind as x, type ModelColumnKind as y, type ModelColumnMetadata as z };

package/package.json

@@ -9,7 +9,8 @@
     "cron-parser": "^4.9.0",
     "pg": "^8.16.0",
     "use-sync-external-store": "^1.5.0",
-    "uuid": "^9.0.1"
+    "uuid": "^9.0.1",
+    "zod": "^4.0.1"
   },
   "description": "Athena JS SDK",
   "devDependencies": {
@@ -189,5 +190,5 @@
       ]
     }
   },
-  "version": "2.7.0"
+  "version": "2.8.0"
 }