@protoboardai/views 0.0.0-stage → 0.2.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 [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/NOTICE

@@ -0,0 +1,13 @@
+Protoboard Stack: @protoboardai/views
+Copyright 2026 Delta Robotics, Inc.
+
+This product includes software developed at Delta Robotics, Inc.
+(https://deltaroboticsinc.com).
+
+Licensed under the Apache License, Version 2.0 (the "License").
+See the LICENSE file in this package for full terms.
+
+"Protoboard", the Protoboard logo and the "0" mark are trademarks of
+Delta Robotics, Inc. The License grants no rights to them (section 6);
+see TRADEMARKS.md in the Protoboard Stack repository
+(https://github.com/Delta-Robotics-Inc/protoboard-stack).

package/README.md

@@ -1,3 +1,22 @@
-# Temporary Holding Version
+# @protoboardai/views
 
-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.
+Protoboard's views as React components, the view registry the shells' tabs
+come from, and the host and theme adapter interfaces the shells implement.
+Private. Architecture: [docs/specs/viewer-stack.md](../../docs/specs/viewer-stack.md).
+
+```ts
+import { createViewRegistry, registerContributedViews, themeAdapterFor } from "@protoboardai/views";
+
+const registry = createViewRegistry();          // diagram, 3d; planned schematic, pcb, bom, pair, library
+registerContributedViews(registry, views);      // from extension manifests (core's resolveViews)
+const tabs = registry.forModule(module, bundle, path);
+```
+
+A stage 2 track lands its view by registering a component under the planned
+id with `{ replace: true }`, or by declaring it in its extension's
+`contributes.views`.
+
+`@protoboardai/views/inspector` holds the Inspector's selection
+(`SelectionInspector`: a shell's card around the viewer's own details, every
+artifact as a card) and the DRC panel (`DrcPanel`), data in and actions out;
+`@protoboardai/views/inspector-model` is their models' types alone.

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@protoboardai/views",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Protoboard's domain views as components, the view registry the shells' tabs come from (extensions declare views in contributes.views), and the host and theme adapter interfaces the shells implement",
+  "license": "Apache-2.0",
+  "author": "Delta Robotics, Inc.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Delta-Robotics-Inc/protoboard-stack.git",
+    "directory": "packages/views"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts",
+    "./registry": "./src/registry.ts",
+    "./tabs": "./src/tabs.ts",
+    "./theme": "./src/theme.ts",
+    "./parts": "./src/parts/index.ts",
+    "./parts-data": "./src/parts/library-data.ts",
+    "./parts-model": "./src/parts/model.ts",
+    "./part-status": "./src/parts/part-status.ts",
+    "./inspector": "./src/inspector/index.ts",
+    "./inspector-model": "./src/inspector/model.ts",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@deltarobotics/uhd-viewer": "^0.2.0",
+    "@radix-ui/react-select": "^2.3.7"
+  },
+  "peerDependencies": {
+    "@deltarobotics/uhd": ">=0.3.0",
+    "@protoboardai/core": "^0.2.0",
+    "react": "^19.0.0",
+    "three": ">=0.170.0"
+  }
+}

package/src/applies.ts

@@ -0,0 +1,54 @@
+/**
+ * `applies` predicates: from a manifest's declarative `appliesTo`
+ * (core's ViewAppliesTo), and the helpers the built-in views use.
+ */
+import type { ModuleDef, UhdBundle } from "@deltarobotics/uhd";
+import type { ViewAppliesTo } from "@protoboardai/core";
+
+/** An artifact's file name (the last path segment, without query or hash). */
+export const fileName = (a: { filePath?: string; url?: string }): string => (a.filePath ?? a.url ?? "").split(/[?#]/)[0].split("/").pop() ?? "";
+
+/** A definition by id in the bundle. */
+export const definition = (bundle: UhdBundle, id: string | undefined): ModuleDef | undefined => (id ? bundle.definitions.find((d) => d.id === id) : undefined);
+
+/** The module and every module below it, each definition once. */
+export function* subtree(module: ModuleDef, bundle: UhdBundle): Generator<ModuleDef> {
+  const seen = new Set<string>();
+  const stack: ModuleDef[] = [module];
+  while (stack.length) {
+    const d = stack.pop()!;
+    if (seen.has(d.id)) continue;
+    seen.add(d.id);
+    yield d;
+    for (const c of d.children ?? []) {
+      const child = definition(bundle, c.moduleDefId);
+      if (child) stack.push(child);
+    }
+  }
+}
+
+/** The module (or, with `descendants`, any module below it) has an artifact named one of `names`. */
+export function hasFile(module: ModuleDef, bundle: UhdBundle, names: readonly string[], descendants = false): boolean {
+  const own = (d: ModuleDef) => (d.artifacts ?? []).some((a) => names.includes(fileName(a)));
+  if (!descendants) return own(module);
+  for (const d of subtree(module, bundle)) if (own(d)) return true;
+  return false;
+}
+
+/** The module or any module below it has an artifact matching `test` (`.glb` models for the 3D view). */
+export function hasArtifact(module: ModuleDef, bundle: UhdBundle, test: (name: string) => boolean): boolean {
+  for (const d of subtree(module, bundle)) if ((d.artifacts ?? []).some((a) => test(fileName(a)))) return true;
+  return false;
+}
+
+/** The predicate a manifest's `appliesTo` declares: every given condition holds. */
+export function appliesFromDecl(decl: ViewAppliesTo | undefined): (module: ModuleDef, bundle: UhdBundle, at?: { path: string }) => boolean {
+  if (!decl) return () => true;
+  return (module, bundle, at) => {
+    const root = at ? at.path === "" : module.id === bundle.root;
+    if (decl.root !== undefined && decl.root !== root) return false;
+    if (decl.files && !hasFile(module, bundle, decl.files, decl.descendants)) return false;
+    if (decl.categories && !(module.categories ?? []).some((c) => decl.categories!.some((p) => c === p || c.startsWith(`${p}.`)))) return false;
+    return true;
+  };
+}

package/src/builtins.tsx

@@ -0,0 +1,89 @@
+/**
+ * The built-in views: the UHD diagram and the 3D assembly (both the
+/**
+ * The built-in views: the UHD diagram and the 3D assembly (both the
+ * uhd-viewer's, sharing one viewer state in a shell), the board drawings
+ * (schematic and PCB, PB-898), the pair comparator (PB-905), and the parts
+ * views' BOM and library (parts/views.tsx, PB-912, with data from the
+ * shell's PartsDataProvider). A planned view has its tab and placeholder
+ * until its track replaces the registration with the working component.
+ */
+import { DiagramCanvas, EmptyState, Scene3D } from "@deltarobotics/uhd-viewer/components";
+import { ViewIcon } from "./icons.js";
+import { BUILTIN_TABS } from "./tabs.js";
+import { PcbView, SchematicView } from "./drawing/BoardDrawingView.js";
+import { PairView } from "./pair/PairView.js";
+import { BomView, LibraryView } from "./parts/views.js";
+import { Button } from "./parts/ui.js";
+import { ViewRegistry } from "./registry.js";
+import type { HostAdapter, ViewDefinition, ViewProps } from "./types.js";
+
+/**
+ * What the diagram's notice adds when the project names parts it does not
+ * hold (a template made while signed out, or with the part library out of
+ * reach): how they are fetched. The viewer itself only says they are missing.
+ * The commands are `.cmd` spans, not <code>: a VS Code webview styles <code>
+ * for the editor's background, which the notice does not have.
+ */
+export function MissingPartsHint({ host }: { host?: HostAdapter }) {
+  // a host with a Fetch Parts of its own (VS Code, B6): its button, not a command to type
+  if (host?.fetchParts) {
+    const fetch = host.fetchParts;
+    return (
+      <>
+        These are library parts the project has not fetched: Fetch Parts adds them from the Protoboard library.
+        <span className="mt-1.5 flex">
+          <Button size="sm" kind="primary" icon="download" onClick={() => fetch()}>
+            Fetch Parts
+          </Button>
+        </span>
+      </>
+    );
+  }
+  return (
+    <>
+      These are library parts the project has not fetched. Sign in (<span className="cmd">protoboard login</span>), then run <span className="cmd">npx --no-install protoboard parts add</span> with their ids in the project; the check lists each one.
+    </>
+  );
+}
+
+/** The diagram of the focused level (the shell drills the shared viewer to the view's module). */
+export function DiagramView({ host }: Partial<ViewProps>) {
+  return <DiagramCanvas missingHint={<MissingPartsHint host={host} />} />;
+}
+
+/** The assembled 3D model (the whole system at any level), with its inspector while the shell's panel is open. */
+export function AssemblyView() {
+  return <Scene3D />;
+}
+
+/** What a planned view shows until its track lands. */
+export function PlannedView({ view, module }: ViewProps) {
+  return (
+    <div className="grid size-full place-items-center bg-canvas">
+      <EmptyState icon={<ViewIcon name={view.icon} size={28} strokeWidth={1.25} />} title={view.title}>
+        {view.description ?? `The ${view.title.toLowerCase()} view is planned.`} It will show {module.name}.
+      </EmptyState>
+    </div>
+  );
+}
+
+/** Each built-in tab's component (tabs.ts holds their registrations, which the command line reads too). */
+const COMPONENTS: Record<string, ViewDefinition["component"]> = {
+  diagram: DiagramView,
+  "3d": AssemblyView,
+  schematic: SchematicView,
+  pcb: PcbView,
+  bom: BomView,
+  pair: PairView,
+  library: LibraryView,
+};
+
+export const BUILTIN_VIEWS: readonly ViewDefinition[] = BUILTIN_TABS.map((t) => ({ ...t, component: COMPONENTS[t.id] }));
+
+/** A registry with the built-in views. */
+export function createViewRegistry(): ViewRegistry {
+  const r = new ViewRegistry();
+  for (const v of BUILTIN_VIEWS) r.register(v);
+  return r;
+}