@imagineio/configurator-sdk 0.1.5 → 0.1.7

package/README.md

@@ -1,134 +1,134 @@
-# @imagineio/configurator-sdk
-
-Build a 3D product configurator and make it yours. One publishable engine — scene,
-options, pricing, save/share, AR, AI chat — driven entirely by your backend: data
-selects behavior, your code implements overrides through registries, and nothing
-needs an SDK release to change.
-
-## Install
-
-The 3D stack (three / fiber / drei) is installed for you — npm 7+ adds the SDK's
-peer packages automatically at the versions the SDK is built against, so your app
-ends up with exactly one copy of `three`. Pin React 19 in the same command: a fresh
-Vite template scaffolds React 19, which the SDK's 3D stack doesn't support yet
-(`@react-three/fiber@9` requires React 19), so installing the SDK alone there
-fails with `ERESOLVE`:
-
-```bash
-npm install @imagineio/configurator-sdk react@^19.3.1 react-dom@^19.3.1
-npm install -D @types/react@^19.3.0 @types/react-dom@^19.3.0   # the scaffold's are React 19's
-```
-
-(The second line matters even in a JavaScript project: create-vite scaffolds React 19
-*types*, and pinning the runtime alone leaves them mismatched — no error, just wrong
-autocomplete everywhere.)
-
-Then either add the Vite plugin (recommended — serves the SDK's static assets and
-dedupes three/react for you):
-
-```js
-// vite.config.js
-import imagineConfigurator from '@imagineio/configurator-sdk/vite';
-export default defineConfig({ plugins: [react(), imagineConfigurator()] });
-```
-
-…or follow the manual steps in the Getting Started guide.
-
-```jsx
-import { mount, config } from '@imagineio/configurator-sdk';
-
-// The backend endpoint is built into the SDK — only the key is yours to set.
-config.setApiKey('YOUR_ORG_API_KEY');
-// systemId is REQUIRED — it names which configurator loads. Without it nothing does.
-mount(document.getElementById('root'), { systemId: YOUR_SYSTEM_ID });
-```
-
-## Documentation
-
-The full documentation site — Getting Started (install to a live configurator in
-five steps), theming and UI customization, placement customization, the complete
-function reference with runnable examples, the e-commerce bridge protocol, and
-troubleshooting — is published by your imagine.io contact. No guides ship inside
-this package.
-
-## Requirements
-
-Node ≥ 18, React 19, Vite (recommended). Peer deps (auto-installed by npm 7+):
-`react`, `react-dom` , `three` 0.185,
-`@react-three/fiber` 9, `@react-three/drei` 10. Everything else is installed as a
-regular npm dependency — nothing third-party is bundled into the package itself.
-
-**Strict CSP?** Two things load at runtime from Google, not from the package: the AR
-viewer script (`https://ajax.googleapis.com`, overridable with `VITE_MODEL_VIEWER_SRC`
-to self-host it) and theme fonts (`https://fonts.googleapis.com` +
-`https://fonts.gstatic.com`, only when a theme names a Google font). Allow those hosts
-in `script-src` / `style-src` / `font-src`, or point the override at your own origin.
-
-## License
-
-**Proprietary — licensed, not sold.** Not open source. Copyright (c) 2026 Live Furnish,
-Inc., dba imagine.io. Installing or using the package means you accept the licence.
-
-What follows is a plain-English summary, so you can see the shape of the terms before
-installing. **It is not the licence** — the full text in `LICENSE.md` governs, and where
-the two differ, that text wins.
-
-**Free to evaluate and build with.** With an imagine.io Account — a free plan counts — you
-may install the SDK to evaluate it, to develop and test your own application (including
-with your own data), and to demo that application internally or non-commercially, such as
-in a talk, tutorial, or portfolio piece.
-
-**A Subscription or Agreement is required before you go live** — that is, before you deploy
-to production or any customer-facing environment, use the SDK in anything sold or monetised
-(including ad-supported and lead-generating deployments), or deliver your application to a
-third party. One Subscription covers one organisation or brand; building for several
-clients or brands needs one each.
-
-**Explicitly allowed**, so there is no doubt:
-
-- copying the SDK as needed to install, build, and back up your application;
-- bundling and minifying it into your application's deployed build;
-- configuring and customising it through its documented extension points — themes,
-  registries, hooks, plugins, configuration options.
-
-**Not allowed:**
-
-- redistributing the SDK itself — publishing, sublicensing, selling, renting, or shipping
-  it as a package, library, SDK, template, or starter kit, repackaged or not;
-- reverse engineering, decompiling, or deobfuscating it (except where law permits despite
-  this);
-- modifying it outside the documented extension points, including patching or runtime
-  monkey-patching of the distributed files;
-- removing or altering any notice, attribution, watermark, licence check, usage meter, or
-  integrity mechanism, or circumventing a plan limit;
-- building anything that competes with imagine.io, or copying its features or interfaces
-  for that purpose;
-- using the SDK or its documentation to train, fine-tune, or evaluate ML/AI models — your
-  application's use of imagine.io's own AI features is fine;
-- publishing benchmarks or security/performance results without written consent.
-
-These apply whether or not you hold a Subscription.
-
-**Minification is not a grant.** The code ships minified as a technical measure. Unreadable
-source does not imply permission, and readable source does not waive any restriction.
-
-**Pre-release builds** — including `@imagineio/configurator-sdk-staging` — are for
-evaluation and development only. They may change or be withdrawn at any time, with no
-stability or compatibility commitment.
-
-**Credentials.** The SDK is a client for the imagine.io Platform and needs an Account and
-valid credentials. Never put a permanent API key in client-side code or any publicly
-reachable page — production must use a server-side auth flow with short-lived session
-tokens.
-
-The licence terminates automatically on material breach or if your Account is terminated.
-The Software is provided "as is" without warranty, and liability is limited. The imagine.io
-Terms and Conditions also apply, and govern the Platform, your Account, billing, and usage
-limits.
-
-Full text: `LICENSE.md`, shipped inside the package — readable at
-`node_modules/@imagineio/configurator-sdk/LICENSE.md` after install. It also carries the
-notice and Apache-2.0 text for the one third-party component redistributed here (Google
-Draco).
-
-**Licensing enquiries:** finance@imagine.io
+# @imagineio/configurator-sdk
+
+Build a 3D product configurator and make it yours. One publishable engine — scene,
+options, pricing, save/share, AR, AI chat — driven entirely by your backend: data
+selects behavior, your code implements overrides through registries, and nothing
+needs an SDK release to change.
+
+## Install
+
+The 3D stack (three / fiber / drei) is installed for you — npm 7+ adds the SDK's
+peer packages automatically at the versions the SDK is built against, so your app
+ends up with exactly one copy of `three`.
+
+```bash
+npm install @imagineio/configurator-sdk
+```
+
+To install with React 18, use this command:
+
+```bash
+npm install @imagineio/configurator-sdk react@^18.2 react-dom@^18.2 three@~0.159.0 @react-three/fiber@^8.15 @react-three/drei@^9.88 @react-three/postprocessing@^2.16 postprocessing@~6.36.0
+```
+
+Then either add the Vite plugin (recommended — serves the SDK's static assets and
+dedupes three/react for you):
+
+```js
+// vite.config.js
+import imagineConfigurator from '@imagineio/configurator-sdk/vite';
+export default defineConfig({ plugins: [react(), imagineConfigurator()] });
+```
+
+…or follow the manual steps in the Getting Started guide.
+
+```jsx
+import { mount, config } from '@imagineio/configurator-sdk';
+
+// The backend endpoint is built into the SDK — only the key is yours to set.
+config.setApiKey('YOUR_ORG_API_KEY');
+// systemId is REQUIRED — it names which configurator loads. Without it nothing does.
+mount(document.getElementById('root'), { systemId: YOUR_SYSTEM_ID });
+```
+
+## Documentation
+
+**https://configurator-platform.imagine.io/sdk/index.html**
+
+The full documentation site — Getting Started (install to a live configurator in
+five steps), theming and UI customization, placement customization, the complete
+function reference with runnable examples, the e-commerce bridge protocol, and
+troubleshooting — is published by your imagine.io contact. No guides ship inside
+this package.
+
+## Requirements
+
+Node ≥ 18, React 19, Vite (recommended). Peer deps (auto-installed by npm 7+):
+`react`, `react-dom` , `three` 0.185,
+`@react-three/fiber` 9, `@react-three/drei` 10. Everything else is installed as a
+regular npm dependency — nothing third-party is bundled into the package itself.
+
+**Strict CSP?** Two things load at runtime from Google, not from the package: the AR
+viewer script (`https://ajax.googleapis.com`, overridable with `VITE_MODEL_VIEWER_SRC`
+to self-host it) and theme fonts (`https://fonts.googleapis.com` +
+`https://fonts.gstatic.com`, only when a theme names a Google font). Allow those hosts
+in `script-src` / `style-src` / `font-src`, or point the override at your own origin.
+
+## License
+
+**Proprietary — licensed, not sold.** Not open source. Copyright (c) 2026 Live Furnish,
+Inc., dba imagine.io. Installing or using the package means you accept the licence.
+
+What follows is a plain-English summary, so you can see the shape of the terms before
+installing. **It is not the licence** — the full text in `LICENSE.md` governs, and where
+the two differ, that text wins.
+
+**Free to evaluate and build with.** With an imagine.io Account — a free plan counts — you
+may install the SDK to evaluate it, to develop and test your own application (including
+with your own data), and to demo that application internally or non-commercially, such as
+in a talk, tutorial, or portfolio piece.
+
+**A Subscription or Agreement is required before you go live** — that is, before you deploy
+to production or any customer-facing environment, use the SDK in anything sold or monetised
+(including ad-supported and lead-generating deployments), or deliver your application to a
+third party. One Subscription covers one organisation or brand; building for several
+clients or brands needs one each.
+
+**Explicitly allowed**, so there is no doubt:
+
+- copying the SDK as needed to install, build, and back up your application;
+- bundling and minifying it into your application's deployed build;
+- configuring and customising it through its documented extension points — themes,
+  registries, hooks, plugins, configuration options.
+
+**Not allowed:**
+
+- redistributing the SDK itself — publishing, sublicensing, selling, renting, or shipping
+  it as a package, library, SDK, template, or starter kit, repackaged or not;
+- reverse engineering, decompiling, or deobfuscating it (except where law permits despite
+  this);
+- modifying it outside the documented extension points, including patching or runtime
+  monkey-patching of the distributed files;
+- removing or altering any notice, attribution, watermark, licence check, usage meter, or
+  integrity mechanism, or circumventing a plan limit;
+- building anything that competes with imagine.io, or copying its features or interfaces
+  for that purpose;
+- using the SDK or its documentation to train, fine-tune, or evaluate ML/AI models — your
+  application's use of imagine.io's own AI features is fine;
+- publishing benchmarks or security/performance results without written consent.
+
+These apply whether or not you hold a Subscription.
+
+**Minification is not a grant.** The code ships minified as a technical measure. Unreadable
+source does not imply permission, and readable source does not waive any restriction.
+
+**Pre-release builds** — including `@imagineio/configurator-sdk-staging` — are for
+evaluation and development only. They may change or be withdrawn at any time, with no
+stability or compatibility commitment.
+
+**Credentials.** The SDK is a client for the imagine.io Platform and needs an Account and
+valid credentials. Never put a permanent API key in client-side code or any publicly
+reachable page — production must use a server-side auth flow with short-lived session
+tokens.
+
+The licence terminates automatically on material breach or if your Account is terminated.
+The Software is provided "as is" without warranty, and liability is limited. The imagine.io
+Terms and Conditions also apply, and govern the Platform, your Account, billing, and usage
+limits.
+
+Full text: `LICENSE.md`, shipped inside the package — readable at
+`node_modules/@imagineio/configurator-sdk/LICENSE.md` after install. It also carries the
+notice and Apache-2.0 text for the one third-party component redistributed here (Google
+Draco).
+
+**Licensing enquiries:** finance@imagine.io

package/dist/066fc9aa40.js

@@ -1 +1 @@
-import{themeLayoutKey as u}from"./5c9fd9201c.js";import o from"./8f60e5059a.js";import m from"./872c4302e0.js";import a from"./be337ddda5.js";function p(){const t=o(e=>e.bootLoading),r=o(e=>e.uiReady),s=o(e=>e.bootDetail),n=o(e=>e.bootProgress),c=o(e=>e.themeReady),i=m(e=>e.isLoading),d=a(e=>e.isLoading);return{loading:!!t,uiReady:!!r,detail:s??null,progress:n??null,themeReady:!!c,catalogLoading:!!i,configLoading:!!d,ready:!i&&!d}}function h(){try{o.getState().endBootLoading?.()}catch{}}function L(){const t=a(n=>n.systemId),r=a(n=>n.systemName),s=a(n=>n.systemConfiguratorKey);return{id:t??null,name:r??null,configuratorKey:s??null}}function S(){try{o.setState(t=>t.themeReady?t:{themeReady:!0})}catch{}}function b(t){try{o.setState({embedded:!!t})}catch{}}function R(t){try{a.setState({systemTheme:u(t),systemThemeRecord:t&&typeof t=="object"?t:null})}catch{}}export{h as endBootLoading,S as markThemeReady,b as setEmbedded,R as setSystemTheme,p as useBootStatus,L as useSystem};
+import{themeLayoutKey as c}from"./5c9fd9201c.js";import o from"./8f60e5059a.js";import m from"./872c4302e0.js";import s from"./be337ddda5.js";function p(){const e=o(t=>t.bootLoading),a=o(t=>t.uiReady),n=o(t=>t.bootDetail),r=o(t=>t.bootProgress),u=o(t=>t.themeReady),d=m(t=>t.isLoading),i=s(t=>t.isLoading);return{loading:!!e,uiReady:!!a,detail:n??null,progress:r??null,themeReady:!!u,catalogLoading:!!d,configLoading:!!i,ready:!d&&!i}}function h(){try{o.getState().endBootLoading?.()}catch{}}function L(){const e=s(r=>r.systemId),a=s(r=>r.systemName),n=s(r=>r.systemConfiguratorKey);return{id:e??null,name:a??null,configuratorKey:n??null}}function R(){try{o.setState(e=>e.themeReady?e:{themeReady:!0})}catch{}}function S(e){try{o.setState({embedded:!!e})}catch{}}function b(e){try{s.setState({systemTheme:c(e),systemThemeRecord:e&&typeof e=="object"?e:null})}catch{}}function x(){return o(e=>e.hostMode)||"public"}function K(){const e=s(n=>n.systemRenderMode)||"3d",a=s(n=>n.systemRender)||null;return{mode:e,render:a}}export{h as endBootLoading,R as markThemeReady,S as setEmbedded,b as setSystemTheme,p as useBootStatus,x as useHostMode,K as useRenderMode,L as useSystem};

package/dist/17876f4322.css

@@ -54,6 +54,24 @@
   transition: background 0.2s;
 }
 
+/* why AR did not start (Android, 2026-11-11): above the button */
+.arv-status {
+  position: absolute;
+  left: 16px;
+  right: 16px;
+  bottom: 104px;
+  z-index: 10;
+  margin: 0;
+  padding: 10px 14px;
+  border-radius: 10px;
+  background: rgba(255, 255, 255, 0.92);
+  color: #b42318;
+  font-size: 13px;
+  line-height: 1.4;
+  text-align: center;
+  word-break: break-word;
+}
+
 .arv-view-btn:active {
   background: var(--color-brand-primary-dark, #e64a19);
 }