@getaster/elements-preview 0.2.0 → 0.3.5

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 (3) hide show
  1. package/NOTICE +3 -8
  2. package/README.md +65 -3
  3. package/package.json +14 -3
package/NOTICE CHANGED
@@ -1,10 +1,5 @@
1
- Aster UI
1
+ @getaster/elements-preview
2
2
  Copyright 2026 Aster UI contributors
3
3
 
4
- Aster UI source and the separately supplied OData mock WebAssembly binary are
5
- licensed under the Apache License, Version 2.0. Third-party components retain
6
- their respective licenses. The binary's attribution inventory and license texts
7
- are supplied in packages/mock/wasm/; packages include those notices when shipped.
8
-
9
- Geist and IBM Plex Mono fonts retain their SIL Open Font License notices.
10
- ECharts is an optional separately loaded third-party runtime.
4
+ Aster UI code in this package is licensed under the Apache License, Version 2.0.
5
+ See LICENSE. Separately installed dependencies retain their respective licenses.
package/README.md CHANGED
@@ -1,7 +1,69 @@
1
1
  # @getaster/elements-preview
2
2
 
3
- Aster UI experimental controls (API may change).
3
+ Experimental Aster controls and component integrations. APIs may change or be
4
+ removed; inclusion here is not a commitment to ship them in the stable library.
4
5
 
5
- Documentation: https://ui.getaster.now/docs/guide/library.html
6
+ Experiments use the public APIs of `@getaster/data` and `@getaster/elements` and
7
+ follow the same ownership, accessibility, reduced-motion and CSS layout rules.
8
+ Stable packages must not depend on this package. Applications opt in explicitly;
9
+ preview exports are not re-exported by `elements` or the standard browser bundle.
6
10
 
7
- Licensed under Apache-2.0. See LICENSE and NOTICE.
11
+ Keep application examples, sample data and showcase-specific composition in
12
+ `apps/` or `scripts/site/`. This package is for reusable experiments.
13
+
14
+ Each experiment should describe its purpose, known limitations and checks needed
15
+ for adoption. Promote it to a stable package after review, or remove it when it
16
+ does not justify keeping. Vendor dependencies remain optional where practical.
17
+
18
+ ## Install and compatibility
19
+
20
+ ```sh
21
+ npm install @getaster/data @getaster/elements @getaster/elements-preview
22
+ ```
23
+
24
+ Use matching Aster package versions. The browser entry requires a modern browser
25
+ with custom elements and ES modules. A bundler resolves the npm and CSS imports.
26
+ TypeScript declarations are included; package tooling requires Node 22 or later.
27
+ There are no install scripts. Load the stable base styles and application theme
28
+ before the preview stylesheet.
29
+
30
+ ## Conversation reader
31
+
32
+ The first experiment exports `ConversationSession` and `ConversationReader`.
33
+ See [the conversation guide](https://ui.getaster.now/docs/guide/conversation-preview.html). Import its stylesheet explicitly:
34
+
35
+ ```ts
36
+ import { ConversationSession, ConversationReader } from '@getaster/elements-preview';
37
+ import '@getaster/elements-preview/styles/conversation.css';
38
+ ```
39
+
40
+ DOM-free session types are also available from `@getaster/elements-preview/conversation`.
41
+ The browser distribution uses a separate `aster-ui-preview.js` and stylesheet,
42
+ sharing the stable module's runtime. Existing integrations, including ECharts,
43
+ remain in place while future integrations inform packaging decisions.
44
+
45
+ ## Ownership and limitations
46
+
47
+ Supply a conversation adapter that opens a window and loads older/newer entries.
48
+ The application owns its root `ConversationSession` and calls `dispose()` when
49
+ leaving the workspace. The reader owns context sessions it creates. Give the
50
+ reader a bounded CSS height so history can scroll within the page.
51
+
52
+ The reader supports bounded history, drafts, discussion contexts and a reading
53
+ overlay. It does not provide a chat backend, durable delivery, authorization or
54
+ reload persistence. The adapter must handle write safety, ordering, revision
55
+ conflicts and reconnection gaps. The
56
+ [guide's adapter example](https://ui.getaster.now/docs/guide/conversation-preview.html#supply-a-conversation-window-adapter)
57
+ shows the complete connection contract.
58
+
59
+ ## Documentation and support
60
+
61
+ - [Conversation reader guide](https://ui.getaster.now/docs/guide/conversation-preview.html)
62
+ - [Live example](https://ui.getaster.now/docs/playground/conversations.html)
63
+ - [API reference](https://ui.getaster.now/docs/reference/)
64
+ - [Report a bug](https://github.com/GetAster/aster-ui/issues)
65
+
66
+ ## License
67
+
68
+ Apache-2.0. See the included `LICENSE` and package-specific `NOTICE`.
69
+ Separately installed dependencies retain their own licenses.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getaster/elements-preview",
3
- "version": "0.2.0",
3
+ "version": "0.3.5",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -15,8 +15,8 @@
15
15
  }
16
16
  },
17
17
  "dependencies": {
18
- "@getaster/data": "0.2.0",
19
- "@getaster/elements": "0.2.0",
18
+ "@getaster/data": "0.3.5",
19
+ "@getaster/elements": "0.3.5",
20
20
  "@preact/signals-core": "1.14.4",
21
21
  "lit-html": "3.3.3"
22
22
  },
@@ -26,6 +26,17 @@
26
26
  "url": "git+https://github.com/GetAster/aster-ui.git",
27
27
  "directory": "packages/elements-preview"
28
28
  },
29
+ "description": "Experimental Aster UI controls, including a windowed conversation reader.",
30
+ "homepage": "https://ui.getaster.now/docs/guide/conversation-preview.html",
31
+ "bugs": {
32
+ "url": "https://github.com/GetAster/aster-ui/issues"
33
+ },
34
+ "keywords": [
35
+ "web-components",
36
+ "conversation",
37
+ "experimental",
38
+ "typescript"
39
+ ],
29
40
  "types": "./dist/index.d.ts",
30
41
  "publishConfig": {
31
42
  "access": "public"