@vinaverse/client 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,95 @@
-# Temporary Holding Version
+# @vinaverse/client
 
-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.
+The realtime session for apps: a conversation with an agent over the WebSocket, with SSE as the fallback, that
+reconnects and resumes, resends what was never acknowledged, and gives typed events and cards. Headless: it holds
+the conversation's state, and your app draws it. Runs in React Native, browsers and Node 18+, with no runtime
+dependencies.
+
+```sh
+npm install @vinaverse/client@alpha
+```
+
+Alphas are published under the `alpha` tag.
+
+## Use
+
+Your backend creates the session with its service key (`@vinaverse/server`) and hands the app the session's `id`,
+`realtime_url`, `turns_url` and `client_secret`. The app never holds a service key: the client refuses one.
+
+```ts
+import { VinaverseSession, isKnownCard } from '@vinaverse/client';
+
+const session = new VinaverseSession({
+  session, // from your backend
+  // On 4401, a fresh secret for the session in use: after resume() that is the newer one.
+  refreshSecret: (sessionId) => api.refreshClientSecret(sessionId),
+  // React Native and Node 22+: their WebSocket takes headers
+  // auth: 'header',
+});
+
+session.on('state', (state) => render(state)); // messages, cards, the open question, what is not sent
+session.on('event', (event) => {
+  if (event.type === 'message.delta') appendStreaming(event.text);
+});
+session.on('status', (status) => {
+  if (status !== 'ended') return;
+  // Ended idle, expired or at its limit: on the next action, a new session for the conversation, then resume().
+  if (session.state.reconnect === 'new_session_on_next_action') resumeOnNextAction();
+  else showContinuedElsewhere(); // replaced or revoked: resume only on the user's action
+});
+session.connect(); // now: a client secret opens its first connection within two minutes of issue
+
+session.sendText('Find me a silk press stylist near Midtown');
+session.answer(card.id, card.question.question_id, { values: ['opt_repair'] });
+session.reportOutcome(proposalCard.id, 'confirmed'); // after your backend applied it
+
+for (const card of session.state.cards) if (isKnownCard(card.card)) draw(card);
+```
+
+- **Connect early.** The gateway accepts a client secret's first connection within two minutes of issue
+  (`client_secret.expires_at`). Call `connect()` when the conversation opens, or pass `refreshSecret`: otherwise a
+  person who types after that window gets an `unauthorized` session.
+- **Resume** a conversation on a new session your backend created (by `conversation_key` or `conversation_id`):
+  `session.resume(newSession)`. The client resends what the old one never acknowledged.
+- **Idle.** After 10 minutes without input (pings do not count) the gateway ends the session: the status is `ended`
+  with `state.reconnect` `new_session_on_next_action`. On the person's next action, have your backend create a new
+  session for the same conversation (`conversation_id` or `conversation_key`) and call `session.resume(newSession)`.
+  Anything sent in between is held and resent there (`state.heldForNextSession` lists it, to draw as "sends when
+  you continue"); `connect()` would only spend a dead secret, so it throws `needs_new_session`.
+- **Turn limit.** When a session has no turns left, the text sent is held, not refused: the status is `ended` with
+  `state.reconnect` `new_session_on_next_action`, as after an idle close. Create the next session from your backend and
+  `resume()`; the held text is sent there.
+- **The end of the session.** `session.expiring` arrives about a minute before it (WebSocket only), and
+  `state.expiring` holds its seconds left: a good moment to have your backend create the next session.
+- **Background**: `session.setForeground(false)` stops the pings.
+- **Drawing the conversation.** Sort `state.messages` and `state.cards` together by `seq`, and key each by its `key`
+  (messages) or `id` (cards). `state.streaming` is the reply so far; a reply cut off stays, with `partial`. When a
+  person from the business takes over, `state.takeover` names their role: draw `role: 'staff'` messages as that
+  person, never as the agent. Always show `state.disclosure`.
+- **Without a WebSocket** (after two failed first connections, or none in the runtime) the session runs turns over
+  SSE (`status === 'sse'`) and `connect()` tries the WebSocket again. Answers to question cards need the WebSocket:
+  one that cannot be sent is shown as not sent (its question unlocks) and reported on the `error` listener.
+- **`auth: 'header'`** works where the WebSocket takes headers: React Native, and Node 22+ with the default factory.
+  A browser's cannot: keep the default (`subprotocol`).
+
+## A UI on top: the conversation store
+
+`@vinaverse/client/conversation` holds a whole conversation for a UI, with no framework: an immutable, structurally
+shared view (`getSnapshot`, `subscribe`), the streaming reply once per frame, resume on the person's next action,
+pending and held texts, proposals decided through your handler. The UI kits bind to it.
+
+```ts
+import { createConversation } from '@vinaverse/client/conversation';
+
+const conversation = createConversation({ getSession: (req) => api.vinaverseSession(req) });
+conversation.start();
+conversation.subscribe(() => draw(conversation.getSnapshot()));
+```
+
+[docs/architecture/conversation.md](../../docs/architecture/conversation.md).
+
+How it works, and what it guarantees: [docs/architecture/client.md](../../docs/architecture/client.md).
+
+## License
+
+Apache-2.0