@vinaverse/client 0.1.0-alpha.1 → 0.1.0-alpha.10

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

@@ -6,9 +6,14 @@ the conversation's state, and your app draws it. Runs in React Native, browsers
 dependencies.
 
 ```sh
-npm install @vinaverse/client
+npm install @vinaverse/client@alpha
 ```
 
+Alphas are published under the `alpha` tag. Upgrading from an earlier alpha: [MIGRATION.md](https://github.com/vinaverse-ai/vinaverse-js/blob/develop/MIGRATION.md)
+lists every change against the alpha before and what your app does (often nothing); each package's changes are in its
+changelog ([client](https://github.com/vinaverse-ai/vinaverse-js/blob/develop/packages/client/CHANGELOG.md), [react](https://github.com/vinaverse-ai/vinaverse-js/blob/develop/packages/react/CHANGELOG.md), [react-native](https://github.com/vinaverse-ai/vinaverse-js/blob/develop/packages/react-native/CHANGELOG.md),
+[server](https://github.com/vinaverse-ai/vinaverse-js/blob/develop/packages/server/CHANGELOG.md), [tokens](https://github.com/vinaverse-ai/vinaverse-js/blob/develop/packages/tokens/CHANGELOG.md)).
+
 ## Use
 
 Your backend creates the session with its service key (`@vinaverse/server`) and hands the app the session's `id`,
@@ -88,6 +93,111 @@ conversation.subscribe(() => draw(conversation.getSnapshot()));
 
 How it works, and what it guarantees: [docs/architecture/client.md](../../docs/architecture/client.md).
 
+## The agent runtime (`@vinaverse/client/agent`)
+
+An app that hosts an agent writes one thing, its `AgentBackend` (its own API: open a session, a fresh secret, status,
+feedback, sign-out), and the runtime does the rest: one conversation per person, mode, business and thread; kept
+across screens while its session lives; the backend waited out, never answered with a new conversation; the agent's
+status and name; ratings; sign-out; events for analytics. `readCard` reads a card for drawing, every field checked.
+
+```ts
+import { AgentRefusal, createAgentRuntime } from '@vinaverse/client/agent';
+
+const runtime = createAgentRuntime({
+  backend: {
+    openSession: async (request) => {
+      const answer = await api.openAgentSession(request); // your API, with the person's own sign-in
+      if (!answer.available) throw new AgentRefusal('unavailable');
+      return answer.session; // id, realtime_url, turns_url, client_secret, conversation_id, expires_at …
+    },
+    refreshSecret: (sessionId) => api.refreshAgentSecret(sessionId),
+    status: () => api.agentStatus(),
+  },
+  conversation: { locale: 'en-US', closeInBackground: true, deepLinkPrefixes: ['yourapp://'] },
+  onEvent: (event) => analytics.track(`agent_${event.type}`, event),
+});
+
+const chat = runtime.conversation({ subject: user.id, mode: 'customer' });
+const release = chat.show({ place: { screen: 'explore' }, entryPoint: 'button' }); // when the screen goes: release()
+```
+
+Policies and adapters: `retry: { delays, isRetryable }`, `clock: { now }` (the server's time for a session's end),
+`keepAlive: 'session' | 'view'`, `onEvent` (analytics). `AgentBackend.updateContext` tells a new place live where your
+API serves it. Failures are typed on the conversation (`failure`, `reason`, `code`), with `startNew(key)`.
+History's "Continue" is `continue(key, conversationId)`: the key goes on with that conversation, and one that is gone
+is said as `ended` (your backend throws `AgentRefusal('ended', { code })` on a 404 or 410). A session must have an id
+and a secret, and `wss://` and `https://` addresses whatever transport you supply (a wrapper adding headers or logging
+still gets only secure ones). `insecureAddresses: { realtime, turns }` allows plaintext for one leg: dangerous, for mocks
+and local development only, and the runtime warns outside `__DEV__` (through `onWarning(message, { code })`, your
+logger, else `console.warn`; `code` is `insecure_addresses`, `callback_threw` with the `callback` that threw, or
+`events_dropped`).
+A UI binding reads the key's conversation with `peek(key)`, which ends nothing (a render must not): one past its
+session's end is ended when it is next shown, and `subscribe` then tells the binding to read the next one. One no view
+shows ends at its session's end while the app's timers run, and on `sweep()` (the React Native parts call it when the
+app comes back to the foreground).
+
+**Your backend, in two lines** (`@vinaverse/client/backend`): `backendFromFetch({ routes, headers })` is an
+`AgentBackend` over your own routes, sending the person's credentials from `headers`, never in a body.
+`backendRoutes(base)` gives the routes the .NET SDK's `MapVinaverseAgentSessions` serves by default (`session`,
+`refresh`, `status`, `feedback`, `end`, `context`, `delete`); give your own where they differ. Both sides speak
+`vinaverse.agent-backend/1` (vinaverse-contracts `docs/agent-backend.md`, tested here against its fixture): successes
+wrapped with the version (`{ version: 1, session }`, `{ version: 1, client_secret: { value, expires_at } }`,
+`{ version: 1, status }`, or 204), and one failure body for every route. Every session creation (a first open, a
+resume, continue-here, a rollover) carries a new `open_id`, the gateway's idempotency key; a creation that could not
+reach your backend is asked again unchanged, under the same `open_id`, by the runtime's tries and the person's "try
+again" alike, for 24 hours, so a lost answer never opens two sessions.
+
+Failures, yours or the adapter's, are read by `decodeBackendFailure(status, body, headers)` without matching strings:
+`{ version: 1, outcome, retryable, retry_after?, open_id?, current_revision?, code? }` at its outcome's status, one
+meaning per outcome with the contract's client action (`OUTCOMES`): `conversation_not_found`, `_expired`, `_mismatch`
+and `_completed` end the conversation (`not_found`, `expired`, `mismatch`, `completed`); `session_closed` on a refresh
+rolls over to a new session of the same conversation; `feature_off`, `unauthorized` and `forbidden_ownership` refuse
+(`off`, `auth`, `forbidden`); `rate_limited` is waited out, `retry_after` apart, at most 60 s; `unavailable` is retried
+when `retryable`; `unknown_open` (the backend could not tell whether the session opened) is final, said as unavailable,
+its `open_id` kept on the conversation's state (`openId`) for support; `context_conflict` (with `current_revision`)
+resends the newest place once. `code` is the gateway's code it was translated from (`gatewayCode` on the error).
+Anything else, another version, another status, a proxy page, a 2xx that is not the operation's success, is read by
+its status alone (401 auth; 429, 408 and 5xx retried; anything else, a 404 or 410 too, unavailable, never "ended");
+what `fetch` threw is a network failure, retried.
+
+**Keys, forgetting, signing out, erasing.** Keys are encoded so no person, mode or business can pass for another (a
+guest is `null`, never a subject named "guest"), and `agent` (the agent's id) is part of each, so two agents sharing a
+device's storage never share a conversation. `dispose(key)` closes a conversation and keeps what continues it;
+`forget(key)` also drops the conversation it continued and the transcript the device kept.
+`deleteConversation(key, conversationId)` is history's delete: your backend deletes it (`AgentBackend.deleteConversation`),
+then the device forgets it only where the key still continues that conversation (`conversationId` on its state). `signOut()` ends the sessions at your
+backend while it removes everything the runtime ever kept under `conversation.persistenceKey`: its durable index finds
+what an earlier process wrote and the alpha.5 and alpha.6 names of those conversations go too. Removal of keys no index
+lists (an earlier version's, a write lost with its process) is guaranteed only with a storage that can list
+(`keys(prefix)`: AsyncStorage's or MMKV's `getAllKeys()` filtered by the prefix) or clear (`removePrefix(prefix)`); without
+either, the index, the shapes derived from it, and the `legacyKeys` you pass (what your earlier code wrote) go. It clears the status and the name,
+and a write, a read or a status from before it lands nowhere. The launcher's greeting record outlives a sign-out on
+purpose (no greeting again after signing back in), under `vinaverse.greeted.` (outside the transcripts' prefix); give
+the runtime `greetingStorage` and `erase()` removes it too, with the analytics salt, for the person's erasure
+(`forgetGreeting` is the low-level helper for one person and modes in a storage of your own). A thumbs rates a reply
+against the session it was given in; a reply restored from the device or a resumed transcript cannot be rated
+(`canRate(turnId)` is false, and `AgentChat` draws no thumbs for it).
+
+**Places and steps.** `tell({ place })` with `undefined` keeps the place, with `null` clears it (`updateContext` gets
+`{ screen: 'other' }`, no entity); revisions only grow across a conversation's sessions (`placeRevision` on the
+session request), a `context_conflict` (409, with `current_revision`) sends the newest place once more above it, only while the session
+and the person are the same, then says `moved`,
+and a telling lands only on the session it was told to. `onEvent` also says `message_sent`, `reply_completed` and
+`card_shown` (never the words), its `key` is a salted SHA-256 hash of the conversation's key (`hashKey`), never the person's id: stable per install
+(the salt is kept at `<persistenceKey>:salt` in your storage, a new one after `erase()`), and
+`session_opened` says where the chat was opened from (`entryPoint`: `launcher`, `ask`, `deep_link`, or your own).
+`isRefusal(error)` recognises an `AgentRefusal` from any copy of the package (the mock, the backend helpers).
+
+For a mock mode and tests, `@vinaverse/client/testing` has a scripted agent:
+`createMockAgent({ script, reply, refuse, welcome })` gives an `AgentBackend` and a WebSocket factory that speaks the
+protocol (`conversation.transport.webSocket`). `script` is the replies in order, one per turn, each with its text, its
+cards or a failure; `reply` answers after it. `mockCards` gives the cards your tools would: `professional`,
+`workspace`, `timeSlots`, `proposal` (pending, confirmed in your app) and `links`. Scripted history comes with the
+runtime's history.
+
+The contract's types are exported too (`paths`, `components`, `operations`, `Schemas`): import them instead of copying
+the spec. Design: [docs/architecture/agent-runtime.md](../../docs/architecture/agent-runtime.md).
+
 ## License
 
 Apache-2.0