@quo-systems/dock 0.1.0

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 2026 Razvan Gherghina
+
+   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,6 @@
+Quo
+Copyright 2026 Razvan Gherghina
+
+This product includes software developed by Razvan Gherghina.
+
+Licensed under the Apache License, Version 2.0. See LICENSE for the terms.

package/README.md

@@ -0,0 +1,27 @@
+# The dock
+
+What every estate on Quo needs and nobody writes twice: a daemon and the
+`quo` command, the front desk, the user being and the avatar, harbors on
+disk, in a tab and on the edge, the model sides and the screen, the
+credential exchange. An estate is all of one owner's harbors, and it is
+built on the dock, on Quo.
+
+```bash
+npm install @quo-systems/dock
+npx quo init
+npx quo serve
+```
+
+`beings/quo-dock.md` is the truth of this package and the trunk of its four
+documents; read it first. It knows nothing the spec of Quo does not say,
+and adds no word to harbor, ward or being.
+
+## Publishing
+
+Published from 0.1.0 with no compatibility promise before 1.0.0. The
+package ships an emitted `dist/` with its command, and the source beside it.
+
+## License
+
+Apache-2.0. Copyright 2026 Razvan Gherghina. See [LICENSE](LICENSE) and
+[NOTICE](NOTICE).

package/beings/avatar.ts

@@ -0,0 +1,84 @@
+// SPDX-License-Identifier: Apache-2.0
+// The avatar. Someone outside Quo's voice: a human at a screen, a model at
+// an MCP client, a model in an API loop. One class for every side. She holds
+// exactly one standing, `user`, and everything her side asks goes through
+// it; the user being reaches her only to push, and she hands the push to
+// every side she has. A side is in-process with her, holds the object, and
+// calls the three methods below. Nothing of a side is in her cells.
+import { Being, isSilence, isWord, wordOf } from '@quo-systems/quo';
+import type { Answer, Blueprint, Invitation, JsonObject, OccupantRecord, Wanted } from '@quo-systems/quo';
+
+// Her one standing, and the id under which the user being pushes to her.
+// Two ids for one far being, because standings and occupants share one
+// namespace and a record holds one or the other.
+export const USER = 'user';
+export const PUSHER = 'user:push';
+
+export class Avatar extends Being {
+  static override cells = { inbox: [] as JsonObject[] };
+  static override asks = {
+    notify: { description: 'a push from the user being', input: { type: 'object' }, for: (occ: OccupantRecord | undefined) => occ?.id === PUSHER },
+  };
+
+  // Her sides' ears. One identity is one avatar for life, and two sessions
+  // of that identity are two sides on her at once, so a push goes to every
+  // ear present; each side adds its own on open and removes it on close.
+  // Dropped if there is none.
+  readonly ears = new Set<(object: JsonObject) => void>();
+
+  // ---- what the user being may ask her
+
+  notify(args: JsonObject) {
+    (this.cells.inbox as JsonObject[]).push(args);
+    for (const ear of this.ears) ear(args);
+    return { notified: true };
+  }
+
+  // ---- what her side calls. Not asks: nobody reaches these through a door.
+
+  // The credential exchange's last step. `desk` is the desk's public
+  // invitation, `proof` is what the route produced. She knocks the desk as a
+  // stranger, gets an invitation the user being minted, and joins with it. A
+  // knock on a public invitation births nothing, so she holds no standing at
+  // the desk afterwards. If she already holds `user`, this is a reconnect and
+  // nothing is minted.
+  async enter(desk: Invitation, proof: JsonObject): Promise<Blueprint | { error: string }> {
+    if (this.standings[USER]) return this.tools();
+    const inv = await this.knock(desk, 'device', { proof });
+    if (isSilence(inv)) return { error: 'silence' };
+    if (isWord(inv)) return { error: wordOf(inv) };
+    if (!inv || typeof inv !== 'object' || Array.isArray(inv) || 'error' in inv) return (inv as { error: string }) ?? { error: 'no invitation' };
+    return this.join(inv as unknown as Invitation);
+  }
+
+  // Knock with an invitation, hand the user being one back so she can push,
+  // and take her as `user`. The only moment a standing is born here.
+  async join(invitation: Invitation): Promise<Blueprint | { error: string }> {
+    if (this.standings[USER]) return this.tools();
+    const mine = await this.invite(PUSHER);
+    if (mine === null) return { error: 'user is taken' };
+    const out = await this.knock(invitation, 'hello', { invitation: mine as unknown as JsonObject });
+    if (isSilence(out) || isWord(out)) {
+      this.occupants.remove(PUSHER);
+      return { error: isSilence(out) ? 'silence' : wordOf(out) };
+    }
+    await this.take(USER, invitation);
+    return this.tools();
+  }
+
+  // Her describe, as the user being shows it to her. This is the tool list.
+  async tools(): Promise<Blueprint | { error: string }> {
+    const st = this.standings[USER];
+    if (!st) return { error: 'not joined' };
+    const bp = await st.ask();
+    if (isSilence(bp) || isWord(bp)) return { error: isSilence(bp) ? 'silence' : wordOf(bp) };
+    return bp as Blueprint;
+  }
+
+  // One call from the side, one ask on the standing. The three words pass
+  // through untouched; the side renders them.
+  call(name: string, args: JsonObject = {}, wanted?: Wanted): Promise<Answer> {
+    const st = this.standings[USER];
+    return st ? st.ask(name, args, wanted) : Promise.resolve({ error: 'not joined' });
+  }
+}

package/beings/desk.ts

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: Apache-2.0
+// The front desk. The one public being of a world, and public for the first
+// hello only: everything after is behind an invitation. It holds a standing
+// to every user being, placed by the root, and trades a proof for a device
+// invitation that the user being mints herself. The desk never mints one.
+//
+// A proof is what a route produced after authenticating by its own means. A
+// verifier turns a proof of one kind into who it is for: which user, which
+// client identity. Verifiers are the device's, set on the class before boot
+// the way an envoy reads a secret from the device: never through cells.
+import { Being, isSilence, isWord, wordOf } from '@quo-systems/quo';
+import type { Asker, Json, JsonObject } from '@quo-systems/quo';
+
+export type Proof = { kind: string; [more: string]: Json };
+export type Verified = { user: string; client: string; wake?: boolean };
+export type Verifier = (proof: Proof) => Promise<Verified | null> | Verified | null;
+
+export class Desk extends Being {
+  // proof kind -> verifier. The route that makes a proof kind registers the
+  // verifier for it; the desk knows no kind by itself.
+  static verifiers: Record<string, Verifier> = {};
+
+  static override asks = {
+    hello: { description: 'how to get in', input: { type: 'object' } },
+    device: { description: 'trade a proof for a device invitation', input: { type: 'object', properties: { proof: { type: 'object' } }, required: ['proof'] } },
+  };
+
+  hello(_args: JsonObject, asker: Asker) {
+    return { desk: true, asker: asker.id ?? null, kinds: Object.keys(Desk.verifiers), users: Object.keys(this.cells.standings).filter((k) => k.startsWith('user:')).map((k) => k.slice(5)) };
+  }
+
+  async device(args: JsonObject) {
+    const proof = args.proof;
+    if (!proof || typeof proof !== 'object' || Array.isArray(proof) || typeof proof.kind !== 'string') return { error: 'proof has a kind' };
+    const verify = Object.hasOwn(Desk.verifiers, proof.kind) ? Desk.verifiers[proof.kind] : undefined;
+    if (typeof verify !== 'function') return { error: 'no such proof kind' };
+    const who = await verify(proof as Proof);
+    if (!who) return { error: 'refused' };
+    const user = this.standings[`user:${who.user}`];
+    if (!user) return { error: 'no such user' };
+    const inv = await user.ask('device', who.wake === true ? { client: who.client, wake: true } : { client: who.client });
+    if (isSilence(inv)) return { error: 'silence' };
+    if (isWord(inv)) return { error: wordOf(inv) };
+    return inv;
+  }
+}

package/beings/index.ts

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+// The beings every side shares. See quo-estate.md, the trunk.
+export { User, DESK } from './user.ts';
+export { Desk, type Proof, type Verified, type Verifier } from './desk.ts';
+export { Avatar, USER, PUSHER } from './avatar.ts';