@flui-cloud/semantic-surface 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 Flui
+
+   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

@@ -0,0 +1,106 @@
+# Semantic Surface
+
+**A serializable, medium-independent record of what an interface has actually
+presented to a person, and of what their attention is on.**
+
+It answers one question: what is the user looking at right now, and what does
+"this" refer to?
+
+## The problem
+
+Ask an assistant to "restart this one" and it has to work out what "this one"
+is. There are two usual ways to find out, and both are bad.
+
+Hand it a screenshot, and it reads pixels: it recovers a picture of the screen
+but none of the identity behind it, so a name on screen is just a string that
+resembles a name.
+
+Hand it the application's database, and it has the identities but not the
+attention: it can see every cluster the person owns and no reason to prefer the
+one they are looking at.
+
+A Semantic Surface snapshot is neither. It is a small, declared, validatable
+document in which the interface states what it put in front of the person — the
+areas on screen, the entities they name, the readings they showed, and which of
+those the user's attention is on. The interface already knows all of it. The
+snapshot is simply the interface saying it out loud, instead of leaving an agent
+to infer it.
+
+## What a snapshot is not
+
+It is descriptive, never authoritative. A snapshot does not say what the current
+truth of the domain is, which operations are available, who may perform them, or
+how they are carried out. Every entity in it is a **reference to be resolved**
+through a real tool before anything is acted on.
+
+That boundary is the whole safety argument. A snapshot can be stale, partial, or
+supplied by a browser, and none of that matters as long as nothing is ever
+decided from it. It narrows the question; it never answers it.
+
+## Where it is used
+
+Semantic Surface was designed at Flui, and Flui is where it runs today.
+
+The **Flui dashboard** produces a snapshot for each of its screens: which
+clusters, applications, keys or policies are on display, what state each was
+shown in, and which one the person has selected. The **Flui assistant** consumes
+those snapshots, so that a question asked in front of a screen is understood in
+terms of what that screen was showing.
+
+The specification's annexes carry worked examples drawn from a real producer, and
+they are worth a word, because they keep one distinction clear. The scheme a
+reference is written in, the namespace an extension key sits under, the address
+that identifies the schema — those belong to **whoever produces the snapshot**,
+not to the contract. What the specification fixes is how a reference and an
+extension key are *formed*. A second implementation coins its own and is no less
+conformant.
+
+## The contract
+
+The contract is the **wire format**: the shape of a snapshot as it travels, not
+any particular language binding.
+
+- Normative specification: `docs/agent-surface/semantic-surface-core-v0.2.md`
+- JSON Schema (draft 2020-12): `docs/agent-surface/semantic-surface.schema.json`
+
+Sections 1 to 13 of the specification are normative; the annexes are
+informative. The TypeScript types in this package are a convenient rendering of
+the same contract, and where they and the schema disagree, the schema wins.
+
+One further document travels with the package for provenance only, and is not
+normative: the decision record answering the technical review of v0.1. The two
+documents behind it were internal working papers and are not distributed.
+
+## What this package provides
+
+A reference implementation of the **consumer** side — the half that receives a
+snapshot and has to decide whether to trust it — in three layers.
+
+**Acceptance** caps the size of the payload and validates it against the schema.
+A snapshot that fails is dropped rather than raised: a defect in the Surface must
+never be allowed to fail the user's question.
+
+**Semantic validation** makes the cross-document checks a schema cannot: broken
+references, cycles, duplicate identifiers, counts larger than the totals they
+belong to, timestamps that are well formed but not real instants, revisions that
+do not advance.
+
+**Rendering** turns a snapshot into a bounded, deterministic block of text for a
+prompt. Deterministic matters more than it sounds: no clock is ever read, so the
+same snapshot always renders to the same bytes. Every string that could have come
+from a machine is escaped on the way in, because a resource name is data and must
+never be able to end the block and start giving instructions.
+
+Producers — the code inside an application that builds a snapshot — are
+deliberately not here. They are written against the schema, in whatever language
+the interface itself is written in.
+
+## Install
+
+```
+npm install @flui-cloud/semantic-surface
+```
+
+## Licence
+
+Apache-2.0. See [LICENSE](LICENSE).