@iblai/iblai-js 1.0.8 → 1.0.9
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 +54 -0
- package/dist/package.json +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -30,6 +30,39 @@ npm install react react-dom @reduxjs/toolkit react-redux @iblai/iblai-api
|
|
|
30
30
|
|
|
31
31
|
`next` (>= 15) is an **optional** peer dependency, required only when using `@iblai/iblai-js/web-containers/next`.
|
|
32
32
|
|
|
33
|
+
## Framework Configuration
|
|
34
|
+
|
|
35
|
+
### Next.js
|
|
36
|
+
|
|
37
|
+
The SDK ships pre-compiled with `'use client'` directives already applied to client components. **Do not** add `@iblai/iblai-js` or its sub-packages (`@iblai/data-layer`, `@iblai/web-containers`, `@iblai/web-utils`) to `transpilePackages` in your `next.config.ts` — they are ready to use as-is.
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
// next.config.ts
|
|
41
|
+
const nextConfig = {
|
|
42
|
+
// Do NOT add @iblai packages here — they ship pre-built dist files
|
|
43
|
+
// transpilePackages: ['@iblai/iblai-js'], // ← Don't do this
|
|
44
|
+
};
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Node.js 25+
|
|
48
|
+
|
|
49
|
+
If you're running Node.js 25 or later, you **must** disable the experimental Web Storage API in Node.js. Without this flag, Node.js provides a server-side `localStorage` that conflicts with the SDK's browser-only storage guards, causing hydration errors and runtime failures.
|
|
50
|
+
|
|
51
|
+
Add this to your `package.json` scripts:
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"scripts": {
|
|
56
|
+
"dev": "NODE_OPTIONS='--no-experimental-webstorage' next dev",
|
|
57
|
+
"start": "NODE_OPTIONS='--no-experimental-webstorage' next start"
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Vite / CRA / Other React Frameworks
|
|
63
|
+
|
|
64
|
+
No special configuration required. Install and import directly.
|
|
65
|
+
|
|
33
66
|
## Quick Start
|
|
34
67
|
|
|
35
68
|
### 1. Initialize the data layer
|
|
@@ -328,6 +361,27 @@ pnpm build
|
|
|
328
361
|
|
|
329
362
|
Produces CommonJS, ESM, and TypeScript declaration files under `dist/`.
|
|
330
363
|
|
|
364
|
+
## Publishing (Maintainers)
|
|
365
|
+
|
|
366
|
+
This package uses `workspace:*` references for its dependencies on `@iblai/data-layer`, `@iblai/web-containers`, and `@iblai/web-utils`. These are automatically converted to real version numbers during publish.
|
|
367
|
+
|
|
368
|
+
**You must use `pnpm publish` (not `npm publish`) to publish this package.** Only `pnpm publish` converts `workspace:` references to actual version numbers. Using `npm publish` will publish with raw `workspace:*` strings, which breaks installation for all external consumers.
|
|
369
|
+
|
|
370
|
+
```bash
|
|
371
|
+
# Correct — converts workspace:* to resolved versions
|
|
372
|
+
pnpm publish --no-git-checks
|
|
373
|
+
|
|
374
|
+
# Wrong — leaves workspace:* in published package.json
|
|
375
|
+
npm publish # ← Never use this for workspace packages
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
Publish the underlying packages first (in dependency order), then this package:
|
|
379
|
+
|
|
380
|
+
1. `@iblai/data-layer` — no internal deps
|
|
381
|
+
2. `@iblai/web-utils` — depends on data-layer
|
|
382
|
+
3. `@iblai/web-containers` — depends on data-layer and web-utils
|
|
383
|
+
4. `@iblai/iblai-js` — depends on all three
|
|
384
|
+
|
|
331
385
|
## License
|
|
332
386
|
|
|
333
387
|
ISC
|
package/dist/package.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iblai/iblai-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.9",
|
|
4
4
|
"description": "Unified JavaScript SDK for IBL.ai — re-exports data-layer, web-containers, and web-utils under a single package",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"engines": {
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"author": "iblai",
|
|
48
48
|
"license": "ISC",
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@iblai/data-layer": "1.1.
|
|
50
|
+
"@iblai/data-layer": "1.1.5",
|
|
51
51
|
"@iblai/web-containers": "1.1.7",
|
|
52
52
|
"@iblai/web-utils": "1.1.8"
|
|
53
53
|
},
|