@vinaverse/server 0.0.0-stage → 0.1.0-alpha.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

@@ -1,3 +1,166 @@
-# Temporary Holding Version
+# @vinaverse/server
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Vinaverse for Node backends: call the Vinaverse API typed with a service key, verify webhooks into typed events,
+and serve the tools the agent calls with the contract enforced, with adapters for AWS Lambda, Express, Fastify, Hono
+and any Fetch API runtime. Runs on Node 18+, AWS Lambda and edge runtimes: it uses Web APIs only (Web Crypto, never a
+Node-only API).
+
+Pre-release (`0.x`): it targets the contract named in `CONTRACT`. Its types need TypeScript 5.0 or newer (the gate
+compiles a consumer against the published declarations with 5.0). Errors it throws carry a `name`
+(`WebCryptoUnavailableError`, `RawBodyRequiredError`): check `error.name`, since each entry point and module format
+has its own copy of the class.
+
+## Verify a delivery
+
+```ts
+import { verifyWebhook } from '@vinaverse/server';
+
+const result = await verifyWebhook({
+  rawBody, // the body exactly as received: string, Uint8Array/Buffer or ArrayBuffer
+  header: request.headers['vinaverse-signature'],
+  secret: process.env.VINAVERSE_WEBHOOK_SECRET, // the whole vv_whsec_… value; two while rotating
+});
+
+if (!result.ok) return reply(400); // result.error.code says why
+if (result.kind === 'event') {
+  switch (result.event.type) {
+    case 'conversation.completed':
+      result.event.data.answers; // typed ConversationState
+      break;
+  }
+}
+return reply(200); // also for 'test' (a Studio test delivery) and 'unrecognized' (a newer event type)
+```
+
+Deliveries are at least once: deduplicate on `event.id`. Answer within 5 seconds and do the work afterwards.
+
+## Adapters
+
+Each answers 200 when handled, 400 when refused, 413 over `maxBodyBytes` (default 1 MiB), and lets your handler's
+error through so Vinaverse retries.
+
+```ts
+// AWS Lambda: API Gateway REST (v1), HTTP API (v2) or a function URL; base64 bodies handled
+import { createLambdaWebhookHandler } from '@vinaverse/server/lambda';
+export const handler = createLambdaWebhookHandler({ secret, onEvent: async (event) => { /* … */ } });
+
+// Express: mount before express.json() (or behind express.raw({ type: 'application/json' }))
+import { vinaverseWebhook } from '@vinaverse/server/express';
+app.post('/webhooks/vinaverse', vinaverseWebhook({ secret, onEvent }));
+
+// Fastify: the plugin reads its route's body raw; the rest of the app keeps its JSON parser
+import { vinaverseWebhookPlugin } from '@vinaverse/server/fastify';
+await app.register(vinaverseWebhookPlugin({ path: '/webhooks/vinaverse', secret, onEvent }));
+
+// Hono
+import { vinaverseWebhook } from '@vinaverse/server/hono';
+app.post('/webhooks/vinaverse', vinaverseWebhook({ secret, onEvent }));
+
+// Next.js route handlers, Cloudflare Workers, Deno, Bun: any Request → Response runtime
+import { createFetchWebhookHandler } from '@vinaverse/server';
+export const POST = createFetchWebhookHandler({ secret, onEvent });
+```
+
+`onTest`, `onUnrecognized` and `onRejected` are optional.
+
+## Order a conversation's states
+
+```ts
+import { applyConversationState, missingSequences } from '@vinaverse/server';
+
+const { record, action } = applyConversationState(stored, event.data);
+// action: 'apply' or 'stale' (an equal or lower sequence, even under a new envelope id)
+// record: what to store: { state, seen, fullReadNeeded }. fullReadNeeded: the webhook left out the answers
+// (over 64 KB); read GET /v1/conversations/{id}. missingSequences(record): the states still to come.
+// Deduplicate deliveries on event.id first; ConversationReceiver does all of it in memory, for one process.
+```
+
+## Serve your tools
+
+```ts
+import { createToolProvider, MemoryNonceStore, MemoryIdempotencyStore, ToolRefusal } from '@vinaverse/server';
+import { redisNonceStore, redisIdempotencyStore } from '@vinaverse/server/stores'; // shared, for several instances
+
+const tools = createToolProvider({
+  secret: process.env.VINAVERSE_TOOL_SECRET, // the whole tool signing secret; two while rotating
+  nonces: new MemoryNonceStore(),            // or redisNonceStore({ command: (args) => redis.sendCommand(args) })
+  idempotency: new MemoryIdempotencyStore(), // or the matching shared store
+  basePath: '/api/v2/ai',                    // the path of the tool base URL registered in Studio
+  authenticate: async (token) => (await verifyMyToken(token)) ?? throwExpired(), // your principal
+  handlers: {
+    get_flow_definition: ({ params, query }) => myFlows.definition(params.flow, query.version),
+    submit_flow: async ({ params, body, principal }) => {
+      const problem = await myFlows.check(params.flow, body);
+      if (problem) throw ToolRefusal.flowRefused(problem.code, problem.questionId);
+      await myFlows.store(principal, body); // returning nothing accepts it
+    },
+    create_handoff: ({ body, principal }) => mySupport.openTicket(principal, body),
+  },
+  leaseSeconds: 60,                          // above the longest a handler can run
+  onRefused: (reason) => log.warn({ reason }, 'tool call signature refused'),
+  onError: (error, operation) => log.error({ error, operation }),
+});
+```
+
+A `submit_flow` handler refuses only with `ToolRefusal.flowRefused` (any other 422 is answered as a 500), and every
+handler validates what it acts on. Idempotent answers are kept under a SHA-256 fingerprint of the request, never the
+request itself; `scope(principal)` keeps them apart per tenant or environment.
+
+Then mount it: `createLambdaToolHandler(tools)` (`/lambda`), `app.use('/api/v2/ai', vinaverseTools(tools))`
+(`/express`), `vinaverseToolsPlugin({ provider: tools, basePath })` (`/fastify`), `vinaverseTools(tools)` (`/hono`)
+or `createFetchToolHandler(tools)`. Signatures, nonces, token presence, sizes, refusals and idempotent submissions,
+proposals and handoffs are handled; your handlers decide what an answer or a ticket means. Details:
+[docs/architecture/tools.md](../../docs/architecture/tools.md).
+
+## Test your route
+
+```ts
+import { signToolCall, signWebhook } from '@vinaverse/server/testing';
+const header = await signWebhook({ body, secret }); // the Vinaverse-Signature value Vinaverse would send
+const toolHeader = await signToolCall({ secret, method: 'POST', target, token, body }); // a tool call's
+```
+
+## The Vinaverse API (`@vinaverse/server/api`)
+
+Typed calls to the Vinaverse API with a service key, generated from the pinned public contract.
+
+```ts
+import { createApiClient, VinaverseApiError } from '@vinaverse/server/api';
+
+const vinaverse = createApiClient({ apiKey: process.env.VINAVERSE_API_KEY }); // vv_sk_<mock|dev|live>_…
+
+// Your app asks your backend for a session; give it the session's id, URLs and client_secret only.
+const session = await vinaverse.sessions.create({ agent: 'intake', subject, tool_access }); // your agent's id
+
+try {
+  await vinaverse.moderation.createJob({ policy: 'default', items });
+} catch (error) {
+  if (error instanceof VinaverseApiError && error.code === 'invalid_request') console.log(error.errors);
+}
+```
+
+- **Idempotency keys** are added to the calls that take one (`sessions.create`, `moderation.createJob`,
+  `media.createJob`, `documentChecks.create`, `subjects.erase`); pass `{ idempotencyKey }` to use your own.
+- **Retries are safe:** a `429` is retried after its `Retry-After`; a `5xx`, a retryable problem, a timeout or a
+  network error is retried only for a read or a call with an idempotency key. Default 2 retries, 30 s timeout per try
+  (reading the body included), and a `Retry-After` over 30 s is not waited for (`maxRetries`, `timeout`,
+  `maxRetryDelay`, checked when the client is made).
+- **Trying again yourself:** when a keyed call still fails (`VinaverseTimeoutError`, `VinaverseNetworkError`, or a
+  retryable `VinaverseApiError`), its error carries `idempotencyKey`. Send the call again later with
+  `{ idempotencyKey: error.idempotencyKey }`: the API does it once, however many times it was sent.
+- **Aborts:** pass `{ signal }`; aborting stops the call at once, during a try, a body read or a wait between tries,
+  and an already aborted signal sends nothing.
+- **Refusals throw `VinaverseApiError`**, with the problem's `status`, `code`, `retryable`, `requestId`, `retryAfter`
+  and, for `invalid_request`, the field `errors`.
+- **Every operation** is also on `vinaverse.api`, the typed openapi-fetch client (`api.GET('/v1/usage')`).
+- **Backend only.** The client refuses a client secret, and refuses to start in a browser or in React Native: a
+  service key there ships to everyone who loads the app. Apps use `@vinaverse/client` with the session's client secret.
+- The base URL follows the key: `https://api.vinaverse.com` for a live key, `https://api-dev.vinaverse.com` for mock
+  and dev keys. A `baseUrl` of your own must be `https:` (or `http:` on `localhost` for tests), and redirects are
+  refused: a service key never travels in clear or follows a redirect. Every request, the raw `api` client's included,
+  goes to that origin only. In the mock environment, the `Vinaverse-Mock-Scenario` header (`headers`
+  option) provokes a `429` or a `503` to test your handling.
+
+Details: [docs/architecture/webhooks.md](../../docs/architecture/webhooks.md),
+[docs/architecture/tools.md](../../docs/architecture/tools.md) and
+[docs/architecture/api-client.md](../../docs/architecture/api-client.md). Licence: Apache-2.0.