@fjell/lib-sequelize 4.4.84 → 4.4.85

package/guide/index.md

@@ -0,0 +1,30 @@
+# @fjell/lib-sequelize - Agentic Guide
+
+## Purpose
+
+Sequelize-backed Fjell library implementation for relational database persistence.
+
+This guide is optimized for AI-assisted code generation and integration workflows.
+
+## Documentation
+
+- **[Usage Guide](./usage.md)** - API-oriented usage patterns and model-safe examples
+- **[Integration Guide](./integration.md)** - Architecture placement, composition rules, and implementation guidance
+
+## Key Capabilities
+
+- Implements primary and contained operations on Sequelize models
+- Provides definition and coordinate helpers for relational mappings
+- Includes reference builder and Sequelize instance wrapper utilities
+
+## Installation
+
+```bash
+npm install @fjell/lib-sequelize
+```
+
+## Public API Highlights
+
+- `SequelizeLibrary` and `SequelizeLibraryFactory`
+- `createCoordinate`, `SCOPE_SEQUELIZE`, and definition/options exports
+- `ReferenceBuilder` and `SequelizeInstanceWrapper` utilities

package/guide/integration.md

@@ -0,0 +1,32 @@
+# Integration Guide
+
+Guide for integrating `@fjell/lib-sequelize` into larger Fjell-based systems.
+
+## Where It Fits
+
+Sequelize-backed Fjell library implementation for relational database persistence.
+
+## Recommended Integration Pattern
+
+- Coordinate Sequelize model definitions with Fjell key conventions before first deployment
+- Use transaction boundaries around multi-step provider operations
+- Tune eager/lazy loading and indexing for predictable query performance
+
+## System Composition Checklist
+
+- Define package boundaries: schema/types, transport, operations, adapters, and UI.
+- Keep contracts stable by sharing @fjell/types interfaces where applicable.
+- Centralize retries/timeouts/logging around infrastructure-facing operations.
+- Validate inputs at API boundaries before invoking persistence or provider layers.
+- Add contract and integration tests for every generated workflow.
+
+## Cross-Library Pairings
+
+- Pair with @fjell/types for shared contracts.
+- Pair with @fjell/validation for input and schema checks.
+- Pair with @fjell/logging for observability in integration flows.
+- Pair with storage/router/provider packages based on your runtime architecture.
+
+## Integration Example Shape
+
+Use this package behind an application service layer that exposes stable domain methods. Generated code should call those service methods, not raw infrastructure primitives, unless your architecture intentionally keeps infrastructure at the edge.

package/guide/usage.md

@@ -0,0 +1,43 @@
+# Usage Guide
+
+Comprehensive usage guidance for `@fjell/lib-sequelize`.
+
+## Installation
+
+```bash
+npm install @fjell/lib-sequelize
+```
+
+## API Highlights
+
+- `SequelizeLibrary` and `SequelizeLibraryFactory`
+- `createCoordinate`, `SCOPE_SEQUELIZE`, and definition/options exports
+- `ReferenceBuilder` and `SequelizeInstanceWrapper` utilities
+
+## Quick Example
+
+```ts
+import { SequelizeLibraryFactory } from "@fjell/lib-sequelize";
+
+const factory = new SequelizeLibraryFactory({
+  sequelize,
+  tablePrefix: "fjell",
+});
+
+const library = factory.createPrimaryLibrary();
+await library.save({ pri: { pk: "widget#1", sk: "meta" }, name: "Widget One" });
+```
+
+## Model Consumption Rules
+
+1. Import from the package root (`@fjell/lib-sequelize`) instead of deep-internal paths unless explicitly documented.
+2. Keep usage aligned with exported public symbols listed in this guide.
+3. Prefer explicit typing at package boundaries so generated code remains robust during upgrades.
+4. Keep error handling deterministic and map infrastructure failures into domain-level errors.
+5. Co-locate integration wrappers in your app so model-generated code has one canonical entry point.
+
+## Best Practices
+
+- Keep examples and abstractions consistent with existing Fjell package conventions.
+- Favor composable wrappers over one-off inline integration logic.
+- Add targeted tests around generated integration code paths.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fjell/lib-sequelize",
-  "version": "4.4.84",
+  "version": "4.4.85",
   "license": "Apache-2.0",
   "keywords": [
     "library",
@@ -25,7 +25,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "guide"
   ],
   "scripts": {
     "build": "npm run lint && node build.js",
@@ -41,12 +42,12 @@
     "docs:test": "cd docs && npm run test"
   },
   "dependencies": {
-    "@fjell/core": "^4.4.77",
-    "@fjell/lib": "^4.4.88",
-    "@fjell/logging": "^4.4.67",
-    "@fjell/registry": "^4.4.84",
-    "@fjell/types": "^4.4.7",
-    "@fjell/validation": "^4.4.4",
+    "@fjell/core": "^4.4.79",
+    "@fjell/lib": "^4.4.89",
+    "@fjell/logging": "^4.4.72",
+    "@fjell/registry": "^4.4.86",
+    "@fjell/types": "^4.4.9",
+    "@fjell/validation": "^4.4.6",
     "dayjs": "^1.11.13",
     "deepmerge": "^4.3.1",
     "sequelize": "^6.37.7",
@@ -55,7 +56,7 @@
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.32.0",
-    "@fjell/common-config": "^1.1.37",
+    "@fjell/common-config": "^1.1.38",
     "@swc/core": "^1.13.2",
     "@tsconfig/recommended": "^1.0.10",
     "@types/node": "^24.1.0",