@buffercreations/levelsui 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +84 -18
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,30 +1,96 @@
1
- # BufferCore LevelsUI
1
+ # LevelsUI
2
2
 
3
- The optional UI Asset Library and levelsui CLI, prepared locally as @buffercreations/levelsui. Not published by this implementation. BufferCore is the complete standalone design system and remains independent.
3
+ **LevelsUI** is a modular UI Asset Library built on [BufferCore](https://www.npmjs.com/package/@buffercreations/buffercore), providing reusable interface elements, layouts, components, templates and pages.
4
4
 
5
- Categories: 01. Elements, 02. Layouts, 03. Components, 04. Templates, 05. Pages. The current catalogue contains Button, Avatar, six authored Layouts and the utility-only Stack recipe. IDs/classes are preserved. Component means only the Components category.
5
+ Assets are designed to work with BufferCore's design tokens, utilities, Runtime and shared Behaviours, keeping custom CSS and JavaScript to a minimum.
6
6
 
7
- From a consumer with the locally packed packages installed:
7
+ ## Installation
8
8
 
9
- ```powershell
10
- npx --no-install levelsui init
11
- npx --no-install levelsui list
12
- npx --no-install levelsui add button
13
- npx --no-install levelsui activate button
14
- npx --no-install levelsui build --report --verbose
15
- npx --no-install levelsui doctor
9
+ Install BufferCore and LevelsUI:
10
+
11
+ ```bash
12
+ npm install @buffercreations/buffercore
13
+ npm install -D @buffercreations/levelsui
14
+ ```
15
+
16
+ Initialise LevelsUI in your project:
17
+
18
+ ```bash
19
+ npx levelsui init
20
+ ```
21
+
22
+ ## Usage
23
+
24
+ Browse the available Assets:
25
+
26
+ ```bash
27
+ npx levelsui list
28
+ npx levelsui info button
29
+ ```
30
+
31
+ Add an Asset to your project:
32
+
33
+ ```bash
34
+ npx levelsui add button
16
35
  ```
17
36
 
18
- Install Sass as a consumer dev dependency; add esbuild for interactive builds. Generated buffercore-levels.css already includes full Core CSS. Generated ESM never auto-mounts: import mountBufferCoreAssets and call it explicitly; destroy its returned controller on teardown. No automatic lazy loading or CSS selector purging is claimed.
37
+ Activate it and build your Assets:
38
+
39
+ ```bash
40
+ npx levelsui activate button
41
+ npx levelsui build
42
+ ```
43
+
44
+ Only active Assets and their required dependencies are included in the generated Asset output.
45
+
46
+ ## Asset Library
47
+
48
+ LevelsUI organises Assets into five categories:
49
+
50
+ | Category | Purpose |
51
+ |---|---|
52
+ | Elements | Fundamental interface building blocks |
53
+ | Layouts | Structure, positioning and composition |
54
+ | Components | Reusable interface patterns |
55
+ | Templates | Compositions for common interface structures |
56
+ | Pages | Complete page-level compositions |
57
+
58
+ Assets can reference other Assets and shared BufferCore Behaviours.
59
+
60
+ ## CLI
61
+
62
+ | Command | Description |
63
+ |---|---|
64
+ | `init` | Initialise LevelsUI in a project |
65
+ | `list` | List available or installed Assets |
66
+ | `info` | View Asset information |
67
+ | `add` | Install an Asset |
68
+ | `activate` | Enable an installed Asset |
69
+ | `deactivate` | Disable an Asset |
70
+ | `update` | Update an installed Asset |
71
+ | `remove` | Remove an Asset |
72
+ | `prune` | Identify unused dependencies |
73
+ | `entries` | Generate Asset entry points |
74
+ | `build` | Build active Assets |
75
+ | `validate` | Validate Asset definitions |
76
+ | `doctor` | Check project configuration and installation health |
77
+
78
+ Run `npx levelsui help` for command details.
79
+
80
+ ## Requirements
81
+
82
+ - Node.js 20 or later
83
+ - BufferCore installed in the project
19
84
 
20
- Commands: init, list [--installed], info <id>, add <id>, activate/deactivate <id>, update <id>, remove <id>, prune, entries, build, validate, doctor, migrate [--rollback], help, --version. Options include --project and --registry. remove/prune/migrate are previews until --apply; add/update support --dry-run. Unknown options fail. buffercore and use/unuse remain compatibility aliases in this same package.
85
+ ## Packages
21
86
 
22
- Installed schemaVersion 3 metadata is authoritative for build dependencies/source/mount contracts. Old consumers must run levelsui migrate, review the plan, then levelsui migrate --apply. Old trees and a hashed state backup remain; levelsui migrate --rollback --apply restores state while leaving copies intact. Modified files retain original recorded hashes; collisions, missing tracked source and modified definitions require manual review. See the workspace MIGRATION-GUIDE.md.
87
+ - [BufferCore](https://www.npmjs.com/package/@buffercreations/buffercore) — standalone design system
88
+ - [LevelsUI](https://www.npmjs.com/package/@buffercreations/levelsui) — optional UI Asset Library
23
89
 
24
- Authored definitions require className and source.scss/source.css. Utility-only definitions use kind: recipe and source.html, with no dummy CSS. Sources must be co-located with their definition and may use different filenames. Direct typed dependencies resolve once; cycles/type mismatches fail. Canonical examples have no inline presentation styles. Arbitrary registry executable source remains trusted input; path validation and checksums are not a sandbox or signature system.
90
+ ## Licence
25
91
 
26
- The package includes required compiled CSS, schemas, examples and tooling; excludes Studio, Figma, private Flavours and token-authoring tools. npm run build compiles catalogue SCSS; npm run validate uses the same schema/graph as Studio and CLI.
92
+ See the included `LICENSE` file for terms of use.
27
93
 
28
- ## Workspace maintainer releases
94
+ ---
29
95
 
30
- From the private workspace root, `npm run release:levelsui -- --core-archive "<verified compatible Core.tgz>"` packages only LevelsUI after testing that explicit Core archive. `release:package` prepares both products; versions remain independent. Versioned archives/checksums/metadata go under NPM Releases outside public package roots. `release:verify` rechecks existing bytes; `release:publish` is separate and requires owner authorisation and exact interactive confirmation. Application `levelsui` commands never publish packages. Development dependencies and useful caches remain in place.
96
+ Developed by **BufferCreations**.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@buffercreations/levelsui",
3
3
  "private": false,
4
- "version": "0.1.0",
4
+ "version": "0.1.1",
5
5
  "type": "module",
6
6
  "description": "BufferCore LevelsUI: optional Assets and management tooling",
7
7
  "scripts": {
@@ -42,7 +42,7 @@
42
42
  "ajv": "8.20.0"
43
43
  },
44
44
  "peerDependencies": {
45
- "@buffercreations/buffercore": "^1.0.2"
45
+ "@buffercreations/buffercore": "^0.8.0"
46
46
  },
47
47
  "publishConfig": {
48
48
  "access": "public"