@foundrynorth/flux-schema 1.9.3 → 1.10.0
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 +36 -0
- package/dist/schema.d.ts +1353 -587
- package/dist/schema.d.ts.map +1 -1
- package/dist/schema.js +62 -1
- package/dist/schema.js.map +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# @foundrynorth/flux-schema
|
|
2
|
+
|
|
3
|
+
Canonical Drizzle ORM schema for the Foundry Flux database (`broad-firefly-00588697`). All tables use the `flux_*` prefix.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @foundrynorth/flux-schema
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { fluxProjects, fluxFulfillmentTickets, fluxActivityItems } from "@foundrynorth/flux-schema";
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Consumers
|
|
18
|
+
|
|
19
|
+
- **fn-flux** (Compass Ops) — migration authority
|
|
20
|
+
- **fn-v2** (Trigger.dev tasks) — read + write
|
|
21
|
+
|
|
22
|
+
## Shared Database Warning
|
|
23
|
+
|
|
24
|
+
The `broad-firefly` database is shared between fn-flux (`flux_*` tables) and fn-forge (unprefixed tables). **Only fn-flux has `drizzle-kit push` authority.** fn-forge uses a `tablesFilter: ["!flux_*"]` to avoid touching Flux tables.
|
|
25
|
+
|
|
26
|
+
## Schema Change Workflow
|
|
27
|
+
|
|
28
|
+
1. Edit schema in this repo
|
|
29
|
+
2. `npm run build && npm version patch && npm publish`
|
|
30
|
+
3. Update fn-flux: `npm install @foundrynorth/flux-schema@latest`
|
|
31
|
+
4. Run `drizzle-kit push` from fn-flux only
|
|
32
|
+
5. Update fn-v2 to the new version
|
|
33
|
+
|
|
34
|
+
## Full Documentation
|
|
35
|
+
|
|
36
|
+
See [fn-docs: Shared Packages](https://fn-docs.vercel.app/docs/compass-v2/shared-packages).
|