@xylex-group/athena 2.8.0 → 2.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -6
- package/dist/browser.cjs +663 -17
- package/dist/browser.cjs.map +1 -1
- package/dist/browser.d.cts +7 -7
- package/dist/browser.d.ts +7 -7
- package/dist/browser.js +663 -17
- package/dist/browser.js.map +1 -1
- package/dist/cli/index.cjs +693 -18
- package/dist/cli/index.cjs.map +1 -1
- package/dist/cli/index.d.cts +3 -3
- package/dist/cli/index.d.ts +3 -3
- package/dist/cli/index.js +693 -18
- package/dist/cli/index.js.map +1 -1
- package/dist/index.cjs +664 -17
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +7 -7
- package/dist/index.d.ts +7 -7
- package/dist/index.js +664 -17
- package/dist/index.js.map +1 -1
- package/dist/{model-form-DMed05gE.d.cts → model-form-Cx3wtvi8.d.ts} +641 -36
- package/dist/{model-form-DXPlOnlI.d.ts → model-form-_ugfOXao.d.cts} +641 -36
- package/dist/{pipeline-D4sJRKqN.d.cts → pipeline-BtD-Uo5X.d.cts} +1 -1
- package/dist/{pipeline-CkMnhwPI.d.ts → pipeline-yCIZNJHE.d.ts} +1 -1
- package/dist/{react-email-DZhDDlEl.d.cts → react-email-CiiSVa9F.d.cts} +4 -6
- package/dist/{react-email-Lrz9A-BW.d.ts → react-email-WN8UU3AL.d.ts} +4 -6
- package/dist/react.cjs +1 -1
- package/dist/react.cjs.map +1 -1
- package/dist/react.d.cts +4 -4
- package/dist/react.d.ts +4 -4
- package/dist/react.js +1 -1
- package/dist/react.js.map +1 -1
- package/dist/{types-CAtTGGoz.d.cts → types-89EfjLjV.d.cts} +2 -1
- package/dist/{types-BzY6fETM.d.ts → types-C2kiTt6-.d.ts} +2 -1
- package/dist/{types-vikz9YIO.d.cts → types-g8G6J0xE.d.cts} +4 -1
- package/dist/{types-vikz9YIO.d.ts → types-g8G6J0xE.d.ts} +4 -1
- package/package.json +26 -56
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# athena-js
|
|
2
2
|
|
|
3
|
-
current version: `2.8.
|
|
3
|
+
current version: `2.8.2`
|
|
4
4
|
`@xylex-group/athena` is a database driver and API gateway SDK that lets you interact with SQL backends over HTTP through a fluent builder API. It ships a typed query builder for Node.js / server environments plus Athena-native React hooks for client-side use.
|
|
5
5
|
|
|
6
6
|
## Install
|
|
@@ -396,7 +396,7 @@ export default defineGeneratorConfig({
|
|
|
396
396
|
});
|
|
397
397
|
```
|
|
398
398
|
|
|
399
|
-
Smallest table-builder config:
|
|
399
|
+
Smallest table-builder config:
|
|
400
400
|
|
|
401
401
|
```ts
|
|
402
402
|
import { defineGeneratorConfig } from "@xylex-group/athena";
|
|
@@ -409,8 +409,15 @@ export default defineGeneratorConfig({
|
|
|
409
409
|
output: {
|
|
410
410
|
format: "table-builder",
|
|
411
411
|
},
|
|
412
|
-
});
|
|
413
|
-
```
|
|
412
|
+
});
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
Important:
|
|
416
|
+
|
|
417
|
+
- `output.format = "table-builder"` is stable generator behavior, not an experimental flag.
|
|
418
|
+
- `experimental.findManyAst` is a separate runtime transport opt-in for `findMany(...)`; it does not enable generated table artifacts.
|
|
419
|
+
- the default generator mode is still legacy `define-model`, and the default model target is still schema-scoped (`athena/models/{schema_kebab}/{model_kebab}.ts`)
|
|
420
|
+
- if you want flat `athena/models/*.ts` files, set `output.targets.model = "athena/models/{model_kebab}.ts"` (or `ATHENA_GENERATOR_MODEL_TARGET=athena/models/{model_kebab}.ts`); multi-schema collisions are still auto-scoped by schema when needed
|
|
414
421
|
|
|
415
422
|
Common copy-paste starts:
|
|
416
423
|
|
|
@@ -451,8 +458,8 @@ Generator supports:
|
|
|
451
458
|
|
|
452
459
|
- PostgreSQL direct introspection (`provider.mode = "direct"`, `provider.connectionString` from your `PG_URL`/`DATABASE_URL`)
|
|
453
460
|
- PostgreSQL gateway-only introspection (`provider.mode = "gateway"` via Athena `POST /gateway/query`)
|
|
454
|
-
- Multiple schema syncs such as `public` plus `athena`, with schema-safe default output paths
|
|
455
|
-
- Two output formats: legacy `define-model` artifacts (default) or the new Zero-style `table-builder` format via `output.format`
|
|
461
|
+
- Multiple schema syncs such as `public` plus `athena`, with schema-safe default output paths
|
|
462
|
+
- Two output formats: legacy `define-model` artifacts (default) or the new Zero-style `table-builder` format via `output.format`
|
|
456
463
|
- Placeholder-driven output paths
|
|
457
464
|
- Feature flags (`features.emitRegistry`, `features.emitRelations`)
|
|
458
465
|
- Typed env-backed config fields via `generatorEnv(...)` for connection strings, schema lists, naming styles, flags, and placeholder maps
|