@nage-api/data 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,160 @@
+# @nage-api/data
+
+The engine-agnostic data layer (PLAN.md §14): one contract, pluggable drivers,
+**one engine per project**.
+
+The legacy framework compiled both SQL and Mongo into every application and
+chose between them at runtime with `APP_ENGINE` — so a "SQL" deployment still
+booted a Mongo connection it never used. Here the driver is a scaffold-time
+choice: application code depends on `RepositoryPort`, and exactly one driver is
+installed. `@nage-api/data-sql` is the driver that exists today; the Mongo driver
+§8 names is not written yet.
+
+## What it provides
+
+| Area             | Export                                                          | Notes                                                                     |
+| ---------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| Query DSL        | `defineQueryPolicy`, `parseQuery`, `parseWhere`, `parseSort`    | Allow-listed fields and operators, enforced `maxLimit` (§12)              |
+| Audit            | `stampCreate`, `stampUpdate`, `stampSoftDelete`, `stampRestore` | Who and when, taken from the request context (§14.2)                      |
+| Service          | `ModelService<TEntity>`                                         | The retained lifecycle hooks, typed; ownership scoping via `scopeToOwner` |
+| In-memory driver | `MemoryRepository`, `MemoryUnitOfWork`                          | A real implementation, used as a test double (§19)                        |
+| Migrations       | `MigrationRunner`, `SeedRunner`                                 | Versioned and recorded; replaces `synchronize` auto-sync                  |
+| Health           | `checkDataSourceHealth`                                         | Feeds `/health/ready` (§21)                                               |
+| Conformance      | `describeRepositoryConformance`                                 | The suite **every** driver must pass                                      |
+
+## The query DSL
+
+The DSL survives — it is what made the legacy framework productive — but a model
+now declares what a client may reach:
+
+```ts
+import { defineQueryPolicy, parseQuery, type RawQuery } from '@nage-api/data';
+import type { Query } from '@nage-api/contracts';
+
+interface Product {
+  readonly id: number;
+  name: string;
+  price: number;
+  archived: boolean;
+  created_at: string;
+}
+
+const productPolicy = defineQueryPolicy<Product>({
+  filterable: ['name', 'price', 'archived'],
+  sortable: ['name', 'price', 'created_at'],
+  selectable: ['id', 'name', 'price'],
+  searchable: ['name'],
+  maxLimit: 100,
+});
+
+/** `request.query`, as the platform hands it over. Nothing has validated it yet. */
+declare const request: { readonly query: RawQuery };
+
+const query: Query<Product> = parseQuery(request.query, productPolicy); // throws INVALID_QUERY
+```
+
+Nothing is filterable by default: a model with no policy exposes no fields, so
+forgetting to write one fails closed. `limit: -1` has no representation, and a
+page larger than the ceiling is **refused** rather than clamped — silently
+clamping would let a client believe it received the 100 000 rows it asked for.
+Mongo-style `$`-operators are rejected outright; only names in the operator
+allow-list are ever emitted to a driver.
+
+`parseQuery` is the allow-list, and a repository's own policy is not a second
+one: a `where` clause built in server code reaches the driver whatever the
+policy lists. Untrusted input goes through `parseQuery`; nothing else does.
+
+## ModelService
+
+```ts
+import type { BaseEntity, Job } from '@nage-api/contracts';
+import { ModelService } from '@nage-api/data';
+
+interface Note extends BaseEntity {
+  readonly id: number;
+  user_id: string;
+  body: string;
+}
+
+class NoteService extends ModelService<Note> {
+  // `audit` is the application's own collaborator; `ModelService` supplies the
+  // lifecycle and the transaction, not the side effect.
+  private readonly audit!: { record(event: string, entity: Note | undefined): Promise<void> };
+
+  protected override doBeforeRead(job: Job<Note>): void {
+    this.scopeToOwner(job, 'user_id'); // typed `job.where.user_id = job.owner.id`
+  }
+
+  protected override async doAfterCreate(job: Job<Note>): Promise<void> {
+    // Runs inside the transaction, so a failure here rolls the insert back.
+    await this.audit.record('note.created', job.record);
+  }
+}
+```
+
+Hooks run **inside** the unit of work, so a failing `doAfterCreate` rolls the
+create back. Ownership scoping applies to reads by id as well as to lists, and
+`update` and `delete` load the record through the same path first, so a caller
+cannot reach another owner's record by guessing an id. `restore` is the
+exception: it runs no read hook, so a route exposing it needs its own check
+until that is fixed (see "Not yet implemented").
+
+## Conformance
+
+Driver parity is this layer's risk, so it is a gate rather than a promise: every
+driver runs the _same_ suite.
+
+```ts
+import { afterEach, beforeEach, describe, expect, it } from 'vitest';
+import { MemoryRepository, MemoryUnitOfWork, describeRepositoryConformance } from '@nage-api/data';
+import type { ConformanceWidget } from '@nage-api/data';
+
+describeRepositoryConformance(
+  { describe, it, beforeEach, afterEach, expect },
+  {
+    name: 'memory',
+    // A fresh, empty repository per test; the suite seeds what each case needs.
+    setup: () => {
+      const unitOfWork = new MemoryUnitOfWork();
+      const repository = new MemoryRepository<ConformanceWidget>('Widget', { unitOfWork });
+
+      return Promise.resolve({ repository, unitOfWork });
+    },
+  },
+);
+```
+
+The test API is injected, so the published package carries no test-framework
+dependency and any runner can drive it. A driver that genuinely lacks a
+capability declares it in `unsupported` — an escape hatch a reviewer can see.
+
+The suite covers creates and audit stamping, pagination and counts, the operator
+set, sorting, projection, soft delete and restore, hard delete, bulk operations,
+cursor pagination, search, and transactions — including that a failure rolls back
+every write in the unit and that the **original** error propagates rather than
+being wrapped.
+
+## Not yet implemented
+
+- **`@nage-api/data-mongo`.** §8 and §14.1 both name it; only the SQL driver exists.
+  Nothing in this package assumes SQL, so the second driver is work rather than a
+  redesign — but "one engine per project" currently has one engine to choose.
+- **Named scopes.** `defineQueryPolicy({ scopes })` and `Query.scope` are
+  validated by `parseQuery` and then read by no driver, so `?scope=active`
+  returns the unscoped collection with a 200. Express the fragment in a
+  `doBeforeRead` hook instead.
+- **`withDeleted` is not gated.** §14.2 says including soft-deleted rows
+  "requires an explicit permission"; `parseQuery` accepts `withDeleted=true` from
+  any client. Drop the key before parsing, or overwrite it in a read hook, until
+  a permission check exists.
+- **Ownership scoping on `restore`.** `restore` calls the driver directly, so no
+  read hook narrows it.
+- **Optimistic locking.** `ModelDescriptor.versioned` and
+  `OptimisticLockError` exist; no driver reads or throws either.
+- **History and trash** (§14.2, an optional plugin) and the `database.maxQueryLimit`
+  ceiling — a policy states its own `maxLimit` and nothing reads the config value.
+- **`ModelDescriptor.timestamps`** is accepted and ignored: audit columns are
+  always stamped.
+
+`docs/packages/data.md` is the longer guide: every policy option and its default,
+the mistakes worth knowing about, and how to test against this package.

package/dist/conformance/repository-conformance.d.ts

@@ -0,0 +1,76 @@
+/**
+ * The shared `RepositoryPort` conformance suite (PLAN.md §24 Phase 5).
+ *
+ * Driver parity is the risk this phase carries, and a shared suite is the gate.
+ * Every driver runs *these* tests — not its own paraphrase of them — so a
+ * behaviour that differs between SQL and Mongo is a failing test rather than a
+ * surprise in production.
+ *
+ * The test API is injected rather than imported, so the published package does
+ * not depend on a test framework and any runner can drive the suite.
+ */
+import type { Id, RepositoryPort, UnitOfWork } from '@nage-api/contracts';
+/** The entity every driver must be able to store for the suite to run. */
+export interface ConformanceWidget {
+    readonly id: Id;
+    name: string;
+    price: number;
+    archived: boolean;
+    owner_id?: Id | null;
+    created_at?: string;
+    updated_at?: string;
+    created_by?: Id | null;
+    updated_by?: Id | null;
+    deleted_at?: string | null;
+    deleted_by?: Id | null;
+}
+/** What a driver supplies to run the suite. */
+export interface ConformanceHarness {
+    /** Driver name, used in the suite's description. */
+    readonly name: string;
+    /** Fresh, empty repository per test. */
+    setup(): Promise<{
+        repository: RepositoryPort<ConformanceWidget>;
+        unitOfWork?: UnitOfWork;
+    }>;
+    /** Release whatever `setup` acquired. */
+    teardown?(): Promise<void>;
+    /**
+     * Capabilities a driver legitimately may not have. Everything not listed is
+     * required — an escape hatch that has to be declared is one a reviewer sees.
+     */
+    readonly unsupported?: readonly ('cursor' | 'search' | 'transactions')[];
+}
+/** The slice of a test framework the suite uses (vitest and jest both fit). */
+export interface TestApi {
+    describe: (name: string, fn: () => void) => void;
+    it: (name: string, fn: () => Promise<void> | void) => void;
+    beforeEach: (fn: () => Promise<void> | void) => void;
+    afterEach: (fn: () => Promise<void> | void) => void;
+    expect: (actual: unknown) => {
+        toBe(expected: unknown): void;
+        toEqual(expected: unknown): void;
+        toBeNull(): void;
+        toBeUndefined(): void;
+        toBeDefined(): void;
+        toHaveLength(length: number): void;
+        toMatchObject(expected: object): void;
+        toBeGreaterThan(value: number): void;
+        rejects: {
+            toThrow(expected?: unknown): Promise<void>;
+        };
+        not: {
+            toBe(expected: unknown): void;
+            toBeNull(): void;
+        };
+    };
+}
+/**
+ * Register the conformance suite for one driver.
+ *
+ * ```ts
+ * describeRepositoryConformance({ describe, it, beforeEach, afterEach, expect }, harness);
+ * ```
+ */
+export declare function describeRepositoryConformance(api: TestApi, harness: ConformanceHarness): void;
+//# sourceMappingURL=repository-conformance.d.ts.map