@imagineio/configurator-sdk 0.1.5 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +138 -134
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,134 +1,138 @@
|
|
|
1
|
-
# @imagineio/configurator-sdk
|
|
2
|
-
|
|
3
|
-
Build a 3D product configurator and make it yours. One publishable engine — scene,
|
|
4
|
-
options, pricing, save/share, AR, AI chat — driven entirely by your backend: data
|
|
5
|
-
selects behavior, your code implements overrides through registries, and nothing
|
|
6
|
-
needs an SDK release to change.
|
|
7
|
-
|
|
8
|
-
## Install
|
|
9
|
-
|
|
10
|
-
The 3D stack (three / fiber / drei) is installed for you — npm 7+ adds the SDK's
|
|
11
|
-
peer packages automatically at the versions the SDK is built against, so your app
|
|
12
|
-
ends up with exactly one copy of `three`.
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
//
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
the
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
-
|
|
101
|
-
|
|
102
|
-
-
|
|
103
|
-
|
|
104
|
-
-
|
|
105
|
-
|
|
106
|
-
-
|
|
107
|
-
|
|
108
|
-
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
**
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
1
|
+
# @imagineio/configurator-sdk
|
|
2
|
+
|
|
3
|
+
Build a 3D product configurator and make it yours. One publishable engine — scene,
|
|
4
|
+
options, pricing, save/share, AR, AI chat — driven entirely by your backend: data
|
|
5
|
+
selects behavior, your code implements overrides through registries, and nothing
|
|
6
|
+
needs an SDK release to change.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
The 3D stack (three / fiber / drei) is installed for you — npm 7+ adds the SDK's
|
|
11
|
+
peer packages automatically at the versions the SDK is built against, so your app
|
|
12
|
+
ends up with exactly one copy of `three`.
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install @imagineio/configurator-sdk
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
To install with React 18, use this command:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
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
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
(The second line matters even in a JavaScript project: create-vite scaffolds React 19
|
|
25
|
+
*types*, and pinning the runtime alone leaves them mismatched — no error, just wrong
|
|
26
|
+
autocomplete everywhere.)
|
|
27
|
+
|
|
28
|
+
Then either add the Vite plugin (recommended — serves the SDK's static assets and
|
|
29
|
+
dedupes three/react for you):
|
|
30
|
+
|
|
31
|
+
```js
|
|
32
|
+
// vite.config.js
|
|
33
|
+
import imagineConfigurator from '@imagineio/configurator-sdk/vite';
|
|
34
|
+
export default defineConfig({ plugins: [react(), imagineConfigurator()] });
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
…or follow the manual steps in the Getting Started guide.
|
|
38
|
+
|
|
39
|
+
```jsx
|
|
40
|
+
import { mount, config } from '@imagineio/configurator-sdk';
|
|
41
|
+
|
|
42
|
+
// The backend endpoint is built into the SDK — only the key is yours to set.
|
|
43
|
+
config.setApiKey('YOUR_ORG_API_KEY');
|
|
44
|
+
// systemId is REQUIRED — it names which configurator loads. Without it nothing does.
|
|
45
|
+
mount(document.getElementById('root'), { systemId: YOUR_SYSTEM_ID });
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Documentation
|
|
49
|
+
|
|
50
|
+
**https://configurator-platform.imagine.io/sdk/index.html**
|
|
51
|
+
|
|
52
|
+
The full documentation site — Getting Started (install to a live configurator in
|
|
53
|
+
five steps), theming and UI customization, placement customization, the complete
|
|
54
|
+
function reference with runnable examples, the e-commerce bridge protocol, and
|
|
55
|
+
troubleshooting — is published by your imagine.io contact. No guides ship inside
|
|
56
|
+
this package.
|
|
57
|
+
|
|
58
|
+
## Requirements
|
|
59
|
+
|
|
60
|
+
Node ≥ 18, React 19, Vite (recommended). Peer deps (auto-installed by npm 7+):
|
|
61
|
+
`react`, `react-dom` , `three` 0.185,
|
|
62
|
+
`@react-three/fiber` 9, `@react-three/drei` 10. Everything else is installed as a
|
|
63
|
+
regular npm dependency — nothing third-party is bundled into the package itself.
|
|
64
|
+
|
|
65
|
+
**Strict CSP?** Two things load at runtime from Google, not from the package: the AR
|
|
66
|
+
viewer script (`https://ajax.googleapis.com`, overridable with `VITE_MODEL_VIEWER_SRC`
|
|
67
|
+
to self-host it) and theme fonts (`https://fonts.googleapis.com` +
|
|
68
|
+
`https://fonts.gstatic.com`, only when a theme names a Google font). Allow those hosts
|
|
69
|
+
in `script-src` / `style-src` / `font-src`, or point the override at your own origin.
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
**Proprietary — licensed, not sold.** Not open source. Copyright (c) 2026 Live Furnish,
|
|
74
|
+
Inc., dba imagine.io. Installing or using the package means you accept the licence.
|
|
75
|
+
|
|
76
|
+
What follows is a plain-English summary, so you can see the shape of the terms before
|
|
77
|
+
installing. **It is not the licence** — the full text in `LICENSE.md` governs, and where
|
|
78
|
+
the two differ, that text wins.
|
|
79
|
+
|
|
80
|
+
**Free to evaluate and build with.** With an imagine.io Account — a free plan counts — you
|
|
81
|
+
may install the SDK to evaluate it, to develop and test your own application (including
|
|
82
|
+
with your own data), and to demo that application internally or non-commercially, such as
|
|
83
|
+
in a talk, tutorial, or portfolio piece.
|
|
84
|
+
|
|
85
|
+
**A Subscription or Agreement is required before you go live** — that is, before you deploy
|
|
86
|
+
to production or any customer-facing environment, use the SDK in anything sold or monetised
|
|
87
|
+
(including ad-supported and lead-generating deployments), or deliver your application to a
|
|
88
|
+
third party. One Subscription covers one organisation or brand; building for several
|
|
89
|
+
clients or brands needs one each.
|
|
90
|
+
|
|
91
|
+
**Explicitly allowed**, so there is no doubt:
|
|
92
|
+
|
|
93
|
+
- copying the SDK as needed to install, build, and back up your application;
|
|
94
|
+
- bundling and minifying it into your application's deployed build;
|
|
95
|
+
- configuring and customising it through its documented extension points — themes,
|
|
96
|
+
registries, hooks, plugins, configuration options.
|
|
97
|
+
|
|
98
|
+
**Not allowed:**
|
|
99
|
+
|
|
100
|
+
- redistributing the SDK itself — publishing, sublicensing, selling, renting, or shipping
|
|
101
|
+
it as a package, library, SDK, template, or starter kit, repackaged or not;
|
|
102
|
+
- reverse engineering, decompiling, or deobfuscating it (except where law permits despite
|
|
103
|
+
this);
|
|
104
|
+
- modifying it outside the documented extension points, including patching or runtime
|
|
105
|
+
monkey-patching of the distributed files;
|
|
106
|
+
- removing or altering any notice, attribution, watermark, licence check, usage meter, or
|
|
107
|
+
integrity mechanism, or circumventing a plan limit;
|
|
108
|
+
- building anything that competes with imagine.io, or copying its features or interfaces
|
|
109
|
+
for that purpose;
|
|
110
|
+
- using the SDK or its documentation to train, fine-tune, or evaluate ML/AI models — your
|
|
111
|
+
application's use of imagine.io's own AI features is fine;
|
|
112
|
+
- publishing benchmarks or security/performance results without written consent.
|
|
113
|
+
|
|
114
|
+
These apply whether or not you hold a Subscription.
|
|
115
|
+
|
|
116
|
+
**Minification is not a grant.** The code ships minified as a technical measure. Unreadable
|
|
117
|
+
source does not imply permission, and readable source does not waive any restriction.
|
|
118
|
+
|
|
119
|
+
**Pre-release builds** — including `@imagineio/configurator-sdk-staging` — are for
|
|
120
|
+
evaluation and development only. They may change or be withdrawn at any time, with no
|
|
121
|
+
stability or compatibility commitment.
|
|
122
|
+
|
|
123
|
+
**Credentials.** The SDK is a client for the imagine.io Platform and needs an Account and
|
|
124
|
+
valid credentials. Never put a permanent API key in client-side code or any publicly
|
|
125
|
+
reachable page — production must use a server-side auth flow with short-lived session
|
|
126
|
+
tokens.
|
|
127
|
+
|
|
128
|
+
The licence terminates automatically on material breach or if your Account is terminated.
|
|
129
|
+
The Software is provided "as is" without warranty, and liability is limited. The imagine.io
|
|
130
|
+
Terms and Conditions also apply, and govern the Platform, your Account, billing, and usage
|
|
131
|
+
limits.
|
|
132
|
+
|
|
133
|
+
Full text: `LICENSE.md`, shipped inside the package — readable at
|
|
134
|
+
`node_modules/@imagineio/configurator-sdk/LICENSE.md` after install. It also carries the
|
|
135
|
+
notice and Apache-2.0 text for the one third-party component redistributed here (Google
|
|
136
|
+
Draco).
|
|
137
|
+
|
|
138
|
+
**Licensing enquiries:** finance@imagine.io
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@imagineio/configurator-sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.6",
|
|
4
4
|
"description": "Configurator SDK — backend Configuration Engine client, state stores, shared 3D scene primitives, and pluggable placement (strategy + type). Drives every configurator (kitchen, sectional, …) from one self-contained surface.",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
6
6
|
"type": "module",
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"postprocessing": "^6.36.0",
|
|
56
56
|
"react": "^18.2.0 || ^19.0.0",
|
|
57
57
|
"react-dom": "^18.2.0 || ^19.0.0",
|
|
58
|
-
"three": "
|
|
58
|
+
"three": ">=0.159.0 <0.187.0"
|
|
59
59
|
},
|
|
60
60
|
"peerDependenciesComment": "Two supported lines, picked by the consumer's React: React 19 -> fiber 9 / drei 10 / @react-three/postprocessing 3; React 18 -> fiber 8 / drei 9 / @react-three/postprocessing 2. Recommended three on BOTH lines is 0.186 (drei 9 / fiber 8 accept it; one three means one HDRI prefilter and one lighting result - 0.159 lights the same HDR visibly differently, its PMREM was rewritten in r16x). The original React 18 stack (three 0.159) stays installable by naming it, with postprocessing pinned ~6.36 because 6.39+ needs three >=0.168. The || operator only widens what is ACCEPTED: npm resolves each range to its highest match independently, so an empty project gets the React 19 line and a React 18 project must name its whole line in one install command (README). The two postprocessing packages are peers, not dependencies, because their major follows the React line; the dist bundles import both dynamically and leave them external.",
|
|
61
61
|
"devDependencies": {
|