@nage-api/contracts 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,102 @@
+# @nage-api/contracts
+
+Pure TypeScript contracts for the `@nage-api` framework. **Types only** — no runtime
+code, no NestJS, no validation libraries (PLAN.md §8).
+
+It sits at the bottom of the dependency graph, so every package and every
+generated app may import it, while it imports nothing itself. The boundary lint
+rules in `@nage-api/eslint-config` enforce that.
+
+```ts
+// A query is typed against the entity, and a policy states what a client may reach.
+import type { BaseEntity, Query, QueryPolicy } from '@nage-api/contracts';
+
+interface Invoice extends BaseEntity {
+  readonly id: number;
+  reference: string;
+  total: number;
+  cost_price: number;
+}
+
+const query: Query<Invoice> = {
+  where: { total: { gte: 100 }, reference: { like: 'INV-2026%' } },
+  sort: [['total', 'desc']],
+  select: ['id', 'reference', 'total'],
+  limit: 50,
+};
+
+const invoicePolicy: QueryPolicy<Invoice> = {
+  filterable: ['reference', 'total'],
+  sortable: ['total'],
+  selectable: ['id', 'reference', 'total'],
+  searchable: ['reference'],
+  populatable: [],
+  scopes: [],
+  operators: ['eq', 'gte', 'lte', 'like'],
+  maxLimit: 100,
+  defaultLimit: 25,
+  maxPopulateDepth: 1,
+};
+```
+
+`cost_price` is a field of the entity and is absent from every list in the
+policy, so no spelling of a request can filter, sort or select by it. The legacy
+DSL forwarded whatever `where` the client sent to the ORM.
+
+```ts
+// The envelope is a discriminated union, and the error catalog is closed.
+import type { ApiResponse } from '@nage-api/contracts';
+
+export function referenceOf(response: ApiResponse<{ readonly reference: string }>): string {
+  if (!response.success) {
+    switch (response.error.code) {
+      case 'RESOURCE_NOT_FOUND':
+        return '(deleted)';
+      // `case 'SOMETHING_WENT_WRONG':` does not compile — clients program
+      // against codes, and a code that is not in the catalog is a typo.
+      default:
+        throw new Error(response.error.code);
+    }
+  }
+
+  return response.data.reference;
+}
+```
+
+## Modules
+
+| File                  | Contracts                                                                              |
+| --------------------- | -------------------------------------------------------------------------------------- |
+| `common.types.ts`     | `Id`, `Nullable`, `Maybe`, `DeepPartial`, `DeepReadonly`, `FieldName`, `Brand`         |
+| `error.types.ts`      | `ErrorCode` catalog, `ErrorDetail`, `ErrorPayload`, `NageErrorLike` (§17)              |
+| `pagination.types.ts` | `Paginated<T>`, `PaginationMeta`, cursor variants (§16.1)                              |
+| `query.types.ts`      | `Query<T>`, `Where<T>`, `Sort<T>`, `ComparisonOperator`, `QueryPolicy<T>` (§12, §16.2) |
+| `entity.types.ts`     | `BaseEntity`, audit/soft-delete/version fields, `Writable<T>`, `DeleteMode` (§14.2)    |
+| `auth.types.ts`       | `AuthUser`, `JwtClaims`, `SessionRecord`, `TokenPair`, `RoleMatrix` (§15)              |
+| `context.types.ts`    | `RequestContext`, `ContextStore` — the correlation-id carrier (§18)                    |
+| `response.types.ts`   | `SuccessResponse`, `ErrorResponse`, `ApiResponse`, `Result<T>` (§16.1)                 |
+| `job.types.ts`        | `Job<TEntity, TBody, TParams>`, `QueueJob`, `QueueJobHandler` (§13)                    |
+| `repository.types.ts` | `RepositoryPort<T>`, `UnitOfWork`, `TxContext`, `KeyValueStore` (§14.1)                |
+| `config.types.ts`     | `NageConfig`, `NageCoreConfig` and one block per feature, `SecretProviderPort` (§11)   |
+| `logger.types.ts`     | `LoggerPort`, `LogLevel`, `LogFields` (§18)                                            |
+| `security.types.ts`   | `RateLimitStore`, `RateLimitResult`, `SecurityFinding`, `SecuritySeverity` (§12)       |
+
+## Design notes
+
+- **Roles are project-defined.** `AuthUser<TRole extends string>` keeps the union
+  open so an application constrains it to its own roles.
+- **No unbounded queries.** `QueryPolicy.maxLimit` is required rather than
+  optional, so a model cannot be given a policy that forgot the ceiling. `limit`
+  itself stays a plain `number` — the legacy `limit: -1` is rejected by the
+  parser in `@nage-api/data`, not by the type, because a branded positive integer
+  would make every caller construct one.
+- **Error codes are a closed union.** Clients program against `code`, never
+  against `message`.
+- **Everything is `readonly` by default.** The four `Job` members that lifecycle
+  hooks exist to change (`query`, `body`, `record`, `records`, plus `count`) are
+  deliberately writable; nothing else is.
+- **Config types live here, config _loading_ does not.** A feature package must
+  be able to read the shape of its own config block without importing
+  `@nage-api/config`, which sits above it (§7.2).
+
+The deeper guide is [`docs/packages/contracts.md`](../../docs/packages/contracts.md).

package/dist/auth.types.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Authentication & authorization contracts (PLAN.md §15).
+ *
+ * Roles are a **project-defined union**, not a hard-coded Admin/User pair —
+ * hence the `TRole extends string` parameter threaded through these types.
+ */
+import type { Id } from './common.types.js';
+/** Default role union when a project does not narrow it. */
+export type RoleName = string;
+/** Fine-grained permission, e.g. `user:read`, `order:write`. */
+export type Permission = `${string}:${string}`;
+/** The authenticated principal, resolved once per request into the CLS context. */
+export interface AuthUser<TRole extends string = RoleName> {
+    readonly id: Id;
+    readonly email?: string;
+    readonly roles: readonly TRole[];
+    readonly permissions: readonly Permission[];
+    /** Session family id — the unit revoked on refresh-token reuse detection. */
+    readonly sessionId?: string;
+    /** Reserved for multi-tenancy (PLAN.md §27.6 — designed for, implemented later). */
+    readonly tenantId?: Id;
+    /** Set when an administrator is impersonating this user. */
+    readonly impersonatedBy?: Id;
+}
+/** Typed JWT access-token claims (RS256, 15m — PLAN.md §12). */
+export interface JwtClaims<TRole extends string = RoleName> {
+    /** Subject: the user id. */
+    readonly sub: string;
+    readonly iss: string;
+    readonly aud: string | readonly string[];
+    /** Session id, so a token can be tied to a revocable session family. */
+    readonly sid: string;
+    readonly iat: number;
+    readonly exp: number;
+    readonly roles?: readonly TRole[];
+    readonly permissions?: readonly Permission[];
+    readonly tenantId?: Id;
+}
+/** Opaque refresh token as handed to the client (never stored in this form). */
+export type RefreshToken = string;
+/** A stored session, hashed and rotated on every use (PLAN.md §12). */
+export interface SessionRecord {
+    readonly id: string;
+    /** Session family; reuse of a rotated token revokes the whole family. */
+    readonly familyId: string;
+    readonly userId: Id;
+    readonly hashedToken: string;
+    readonly issuedAt: number;
+    readonly expiresAt: number;
+    readonly rotatedAt?: number;
+    readonly revokedAt?: number;
+    readonly userAgent?: string;
+    readonly ip?: string;
+}
+/** Token pair returned by login/refresh. */
+export interface TokenPair {
+    readonly accessToken: string;
+    readonly refreshToken: RefreshToken;
+    /** Access-token lifetime in seconds. */
+    readonly expiresIn: number;
+    readonly tokenType: 'Bearer';
+}
+/** RBAC mapping consumed by the authorization guard. */
+export type RoleMatrix<TRole extends string = RoleName> = Readonly<Record<TRole, readonly Permission[]>>;
+/** Result of a policy/ability evaluation (opt-in ABAC layer). */
+export interface PolicyDecision {
+    readonly allowed: boolean;
+    readonly reason?: string;
+}
+//# sourceMappingURL=auth.types.d.ts.map

package/dist/auth.types.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Authentication & authorization contracts (PLAN.md §15).
+ *
+ * Roles are a **project-defined union**, not a hard-coded Admin/User pair —
+ * hence the `TRole extends string` parameter threaded through these types.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=auth.types.js.map

package/dist/common.types.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Primitive building blocks shared by every other contract.
+ *
+ * Nothing in `@nage-api/contracts` emits runtime code (PLAN.md §8) — this package is
+ * the bottom of the dependency graph and must stay importable from anywhere.
+ */
+/** Identifier of a persisted record. SQL drivers use `number`, Mongo uses `string`. */
+export type Id = string | number;
+/** An ISO-8601 timestamp, e.g. `2026-08-14T09:12:33.000Z`. */
+export type IsoDateString = string;
+/** A value that may be explicitly absent. */
+export type Nullable<T> = T | null;
+/** A value that may be absent or not provided at all. */
+export type Maybe<T> = T | null | undefined;
+/** An object with unknown — but not `any` — values (PLAN.md §13). */
+export type UnknownRecord = Record<string, unknown>;
+/** Recursively optional version of `T`, used for create/update payloads. */
+export type DeepPartial<T> = T extends readonly (infer U)[] ? DeepPartial<U>[] : T extends Date ? T : T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+/** Recursively read-only version of `T`. */
+export type DeepReadonly<T> = T extends readonly (infer U)[] ? readonly DeepReadonly<U>[] : T extends Date ? T : T extends object ? {
+    readonly [K in keyof T]: DeepReadonly<T[K]>;
+} : T;
+/** Keys of `T` whose values are assignable to `V`. */
+export type KeysMatching<T, V> = {
+    [K in keyof T]-?: T[K] extends V ? K : never;
+}[keyof T];
+/** String keys of `T` — the only keys a client may reference in a query DSL. */
+export type FieldName<T> = Extract<keyof T, string>;
+/** Marks a `T` as semantically distinct at compile time without runtime cost. */
+export type Brand<T, TBrand extends string> = T & {
+    readonly __brand: TBrand;
+};
+/** Exhaustiveness helper: `const _: Never = value` fails when a union grows. */
+export type Never = never;
+/** Anything awaitable, for ports whose implementations may be sync or async. */
+export type Awaitable<T> = T | Promise<T>;
+/** A constructor type — used by DI token helpers in `@nage-api/core`. */
+export type Constructor<T = unknown> = new (...args: never[]) => T;
+//# sourceMappingURL=common.types.d.ts.map

package/dist/common.types.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Primitive building blocks shared by every other contract.
+ *
+ * Nothing in `@nage-api/contracts` emits runtime code (PLAN.md §8) — this package is
+ * the bottom of the dependency graph and must stay importable from anywhere.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.types.js.map