@proto-labs-inc/rig-vue 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Proto Labs Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# @proto-labs-inc/rig-vue
+
+The rig for Vue prototypes: `app.use(protoRig(manifest))` at the root, and
+`usePreviewState` / `useVariant` in components. All logic lives in
+`@proto-labs-inc/rig-core`; this package is the Vue idiom.

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @proto-labs-inc/rig-vue — the Vue 3 adapter over @proto-labs-inc/rig-core. All rig logic
+ * lives in the core; this file is only the Vue idiom: an app plugin +
+ * composables mirroring the React hooks' [value, set] shape.
+ *
+ * Usage:
+ *   app.use(protoRig(manifest))
+ *   const [state, setState] = usePreviewState("populated", ["populated", "empty"])
+ */
+import { type Plugin, type Ref } from "vue";
+import type { Manifest } from "@proto-labs-inc/wire";
+/** Install on the app root; wires the bridge once, client-side. */
+export declare function protoRig(manifest: Manifest): Plugin;
+/** The prototype's preview state, addressable as ?state=<id>. */
+export declare function usePreviewState(defaultId: string, validIds?: readonly string[]): readonly [Readonly<Ref<string, string>>, (v: string) => void];
+/** A component's design variant, addressable as ?v.<component>=<id>. */
+export declare function useVariant(component: string, defaultVariant: string, validIds?: readonly string[]): readonly [Readonly<Ref<string, string>>, (v: string) => void];

package/dist/index.js

@@ -0,0 +1,50 @@
+/**
+ * @proto-labs-inc/rig-vue — the Vue 3 adapter over @proto-labs-inc/rig-core. All rig logic
+ * lives in the core; this file is only the Vue idiom: an app plugin +
+ * composables mirroring the React hooks' [value, set] shape.
+ *
+ * Usage:
+ *   app.use(protoRig(manifest))
+ *   const [state, setState] = usePreviewState("populated", ["populated", "empty"])
+ */
+import { inject, onScopeDispose, shallowRef, } from "vue";
+import { RigStore, wireRig, STATE_PARAM, variantParam } from "@proto-labs-inc/rig-core";
+const RIG_KEY = Symbol("proto-rig");
+/** Install on the app root; wires the bridge once, client-side. */
+export function protoRig(manifest) {
+    return {
+        install(app) {
+            const store = new RigStore(manifest);
+            app.provide(RIG_KEY, store);
+            if (typeof window !== "undefined") {
+                const dispose = wireRig(store, manifest);
+                const unmount = app.unmount.bind(app);
+                app.unmount = () => {
+                    dispose();
+                    unmount();
+                };
+            }
+        },
+    };
+}
+function useRigValue(key, fallback, valid) {
+    const store = inject(RIG_KEY, null);
+    if (!store)
+        throw new Error("useRig* composables require app.use(protoRig(manifest))");
+    const normalize = (raw) => valid && !valid.includes(raw) ? fallback : raw;
+    const value = shallowRef(normalize(store.get(key) ?? fallback));
+    const unsubscribe = store.subscribe(() => {
+        value.value = normalize(store.get(key) ?? fallback);
+    });
+    onScopeDispose(unsubscribe);
+    const set = (v) => store.set(key, v);
+    return [value, set];
+}
+/** The prototype's preview state, addressable as ?state=<id>. */
+export function usePreviewState(defaultId, validIds) {
+    return useRigValue(STATE_PARAM, defaultId, validIds);
+}
+/** A component's design variant, addressable as ?v.<component>=<id>. */
+export function useVariant(component, defaultVariant, validIds) {
+    return useRigValue(variantParam(component), defaultVariant, validIds);
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@proto-labs-inc/rig-vue",
+  "version": "0.1.0",
+  "description": "Proto's rig for Vue prototypes: an app plugin and composables over @proto-labs-inc/rig-core.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/proto-labs-inc/proto.git",
+    "directory": "packages/rig-vue"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "vue": ">=3.3"
+  },
+  "dependencies": {
+    "@proto-labs-inc/rig-core": "^0.1.0",
+    "@proto-labs-inc/wire": "^0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "~6.0.2",
+    "vue": "^3.5.13"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts"
+}