@egox/contracts 0.5.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2025 EgoX
+
+   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/NOTICE

@@ -0,0 +1,10 @@
+EgoX Contracts (@egox/contracts)
+Copyright 2025 EgoX
+
+This product includes software developed by EgoX.
+
+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

package/README.md

@@ -0,0 +1,87 @@
+# @egox/contracts
+
+Wire-format TypeScript contracts shared by every EgoX surface — backend,
+SDK (`@egox/client`), MCP server, and console. **Types only**, no runtime
+exports. Published to npm as [`@egox/contracts`](https://www.npmjs.com/package/@egox/contracts) so every surface can pin the same version.
+
+## Why this exists
+
+The `answer === undefined` bug in `@egox/client@1.1.0` was caused by the
+SDK's response decoder reading `data.response` while the backend was
+writing `data.answer`. Two parallel hand-maintained interface sets in two
+packages, drifting silently — exactly the failure mode this package is
+designed to make impossible.
+
+Anything that crosses the network between EgoX components is declared
+here once. Backend response builders and SDK decoders both reference the
+same `AskResponseData` interface, so a field rename is a one-edit change
+that the TypeScript compiler enforces across the stack.
+
+## Why types-only
+
+`import type { … } from '@egox/contracts'` is fully erased by `tsc` /
+`tsup`. That means:
+
+- **Zero runtime cost.** No JS file is ever required. End users of
+  `@egox/client` see no `@egox/contracts` in their `node_modules`.
+- **No path-alias-at-runtime headaches.** Path resolution only matters at
+  compile time; `dist` output has no leftover references.
+- **No publish.** This package is `private: true` and is consumed via
+  tsconfig `paths` only.
+
+If you need a runtime constant (e.g. `SDK_RESERVED_HEADERS`,
+`HEADER_FORWARD_BLOCKLIST`), keep it in the package that actually uses it
+and add a `// must mirror @egox/contracts` comment if it shadows a contract.
+
+## How to consume it
+
+In any package that needs the wire types, add to its `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "paths": {
+      "@egox/contracts": ["../egox-contracts/src"]
+    }
+  }
+}
+```
+
+Adjust the relative path if the package isn't a sibling of `egox-contracts/`.
+Then in code:
+
+```ts
+import type { AskRequestBody, AskResponseData, AskStreamEvent } from '@egox/contracts';
+```
+
+`tsup`-built packages (`@egox/client`) inline the imported types into
+their generated `.d.ts` automatically — end users see the types as if
+they were declared in the SDK itself.
+
+## When to bump
+
+- **Adding** an optional field — non-breaking, no version bump required
+  (still good practice to bump the minor).
+- **Renaming or removing** a field — breaking, bump major **and** ship a
+  coordinated update of backend + SDK + MCP in one release.
+- **Adding** a new SSE event variant to `AskStreamEvent` — non-breaking
+  for producers (backend just starts emitting it), breaking for consumers
+  who exhaustively switch on `event.type` and rely on `never` checks. Bump
+  the minor and call it out in the release notes.
+
+## What's in scope today
+
+- `EgoxApiResponse<T>` envelope
+- `/ask` request + response (`AskRequestBody`, `AskResponseData`)
+- `/ask/stream` request + full SSE event union
+- Common building blocks: `Intent`, `ResponseFormat`, `TokenUsage`,
+  `JsonSchemaDefinition`
+
+What's **not** in scope yet (planned, see TODOs in each module):
+
+- Tool CRUD wire shapes (`/tools/*`)
+- RAG document wire shapes (`/rag/*`)
+- API key / MCP token wire shapes (`/api-keys/*`, `/mcp-tokens/*`)
+- Tenant / project wire shapes
+
+These will be migrated incrementally as we touch them.

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@egox/contracts",
+  "version": "0.5.0",
+  "description": "Wire-format type contracts shared between EgoX backend, SDK, MCP and console. Type-only — no runtime artifacts.",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts"
+    }
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "egox",
+    "contracts",
+    "types",
+    "typescript",
+    "wire-format"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/egox-io/contracts.git"
+  },
+  "homepage": "https://github.com/egox-io/contracts#readme",
+  "bugs": {
+    "url": "https://github.com/egox-io/contracts/issues"
+  },
+  "author": "EgoX Team",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

package/src/api-key.d.ts

@@ -0,0 +1,155 @@
+/**
+ * @egox/contracts — `/egox/tenants/:tenantId/api-keys/*` wire types.
+ *
+ * Per-project API keys (the `egox_live_*` / `egox_test_*` credentials
+ * the SDK and any service calling the public `/ask` API present as
+ * `Authorization: Bearer <key>`).
+ *
+ * Drift cleaned up here:
+ *   - Backend's `ApiKeyInfo` used `Date` for `expiresAt` / `lastUsedAt`
+ *     / `createdAt`; the wire (and the Console mirror) already used
+ *     ISO strings. Backend now matches via `formatKeyInfo` + ISO emit.
+ *   - The console hand-maintained an `ApiKeyScope` union that mirrored
+ *     the backend's `API_KEY_SCOPES` constant. The union now lives here
+ *     once and both surfaces re-export.
+ */
+
+// ============================================================================
+// Locked vocabularies
+// ============================================================================
+
+/**
+ * Scopes a per-project API key can hold. Mirrors `API_KEY_SCOPES` in
+ * `backend/egox/modules/tenant-api-key/constants.ts` — adding a new
+ * scope is a one-edit change here (plus the backend constant) and
+ * propagates to console + SDK at compile time.
+ *
+ *   - `'ask'`           — call the `/ask` and `/ask/stream` endpoints.
+ *   - `'rag:read'`      — read knowledge-base documents.
+ *   - `'rag:write'`     — create / update / delete KB documents.
+ *   - `'tools:read'`    — read tool definitions.
+ *   - `'tools:write'`   — create / update / delete tools.
+ *   - `'threads:read'`  — read conversation threads.
+ *   - `'admin'`         — full access (implies every scope above).
+ */
+export type ApiKeyScope =
+    | 'ask'
+    | 'rag:read'
+    | 'rag:write'
+    | 'tools:read'
+    | 'tools:write'
+    | 'threads:read'
+    | 'admin';
+
+// ============================================================================
+// ApiKeyWire — the canonical row shape (no secrets)
+// ============================================================================
+
+/**
+ * Public-facing API key info. Returned by every
+ * `GET /egox/tenants/:tenantId/api-keys` and
+ * `GET /egox/tenants/:tenantId/api-keys/:keyId` response.
+ *
+ * Carries NO secret material — only the hashed-prefix display value.
+ * The raw key is exposed exactly once on create / rotate via
+ * `ApiKeyCreatedWire`; there is no endpoint that returns it again.
+ *
+ * Timestamps are ISO 8601 strings (backend's `formatKeyInfo` emits
+ * ISO to match the wire — verified by re-anchor in Phase 9.3).
+ */
+export interface ApiKeyWire {
+    id: string;
+    tenantId: string;
+    name: string;
+    /**
+     * Public-display prefix of the raw key (the part the SDK shows in
+     * connection-test errors, e.g. `egox_live_abc12345`). Safe to log;
+     * the full key is unrecoverable from this value.
+     */
+    keyPrefix: string;
+    scopes: ApiKeyScope[];
+    expiresAt: string | null;
+    isActive: boolean;
+    /**
+     * Server-computed convenience flag: `true` when `expiresAt` is in
+     * the past. Saves consumers from re-implementing the comparison
+     * (and from forgetting timezone handling on it).
+     */
+    isExpired: boolean;
+    lastUsedAt: string | null;
+    /**
+     * Total successful authentications using this key. Denormalised
+     * counter, updated by the auth middleware on every accepted
+     * request.
+     */
+    usageCount: number;
+    createdAt: string;
+}
+
+/**
+ * Returned exactly once at creation / rotation. The raw `apiKey`
+ * string is unrecoverable afterwards — only the SHA-256 hash and
+ * prefix are persisted server-side. Consumers MUST surface the value
+ * to the human operator immediately and clear it from memory after
+ * confirmation.
+ */
+export interface ApiKeyCreatedWire {
+    /** Raw key — show once, then forget. */
+    apiKey: string;
+    keyId: string;
+    keyPrefix: string;
+    name: string;
+    scopes: ApiKeyScope[];
+    expiresAt: string | null;
+    createdAt: string;
+}
+
+// ============================================================================
+// Request bodies (what the client SENDS)
+// ============================================================================
+
+/**
+ * Wire body of `POST /egox/tenants/:tenantId/api-keys`. `tenantId`
+ * is the URL param, not the body.
+ */
+export interface ApiKeyCreateBody {
+    name: string;
+    scopes?: ApiKeyScope[];
+    /**
+     * Optional TTL in days. Omit (or `undefined`) for never-expiring.
+     * Server caps at `MAX_EXPIRY_DAYS` from
+     * `backend/egox/modules/tenant-api-key/constants.ts`.
+     */
+    expiresInDays?: number;
+}
+
+/**
+ * Wire body of `POST /egox/tenants/:tenantId/api-keys/:keyId/rotate`.
+ * Rotation generates a new raw key (returned in `ApiKeyCreatedWire`)
+ * and revokes the old one. The `name` defaults to the old key's name.
+ */
+export interface ApiKeyRotateBody {
+    name?: string;
+}
+
+// ============================================================================
+// Response data shapes (carried inside `EgoxApiResponse.data`)
+// ============================================================================
+
+export interface ApiKeyListResponseData {
+    keys: ApiKeyWire[];
+}
+
+export interface ApiKeyGetResponseData {
+    key: ApiKeyWire;
+}
+
+/**
+ * Returned by both `POST /egox/tenants/:tenantId/api-keys` (create)
+ * and `POST /egox/tenants/:tenantId/api-keys/:keyId/rotate`. Wraps
+ * `ApiKeyCreatedWire` so the response data shape is consistent with
+ * `ApiKeyGetResponseData` / `ApiKeyListResponseData`.
+ */
+export interface ApiKeyCreatedResponseData {
+    key: ApiKeyCreatedWire;
+}