@altopelago/aeon-annotation-stream 0.9.1 → 0.9.2
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 +22 -0
- package/package.json +8 -6
package/README.md
CHANGED
|
@@ -20,5 +20,27 @@ if (result.errors.length === 0) {
|
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
+
## What This Package Does
|
|
24
|
+
|
|
25
|
+
- binds AEON comments and source annotations to nearby structural targets
|
|
26
|
+
- emits annotation stream records without mutating canonical data semantics
|
|
27
|
+
- preserves source-oriented metadata for editors, documentation tools, and
|
|
28
|
+
semantic processors
|
|
29
|
+
|
|
30
|
+
## API
|
|
31
|
+
|
|
32
|
+
- `buildAnnotationStream(input, options?)`
|
|
33
|
+
- `buildAnnotationStreamFromSource(input, options?)`
|
|
34
|
+
- annotation record and placement metadata types
|
|
35
|
+
|
|
36
|
+
## When To Use It
|
|
37
|
+
|
|
23
38
|
Use this package when you need comment and annotation binding behavior directly.
|
|
24
39
|
For the stable compile entry point, prefer `@altopelago/aeon-core` and enable annotation emission there when appropriate.
|
|
40
|
+
|
|
41
|
+
## Notes
|
|
42
|
+
|
|
43
|
+
- Annotation streams are separate from canonical data output.
|
|
44
|
+
- Semantic comments can guide tools without changing finalized JSON.
|
|
45
|
+
- Attribute values remain part of the structural AEON data model; comment
|
|
46
|
+
annotations remain soft metadata.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@altopelago/aeon-annotation-stream",
|
|
3
|
-
"version": "0.9.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.9.2",
|
|
4
|
+
"description": "Build AEON annotation streams from comments, attributes, and source metadata.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"main": "./dist/index.js",
|
|
@@ -35,16 +35,18 @@
|
|
|
35
35
|
"keywords": [
|
|
36
36
|
"aeon",
|
|
37
37
|
"aeonite",
|
|
38
|
-
"
|
|
39
|
-
"
|
|
38
|
+
"annotations",
|
|
39
|
+
"comments",
|
|
40
|
+
"metadata",
|
|
41
|
+
"source-map",
|
|
40
42
|
"typescript"
|
|
41
43
|
],
|
|
42
44
|
"publishConfig": {
|
|
43
45
|
"access": "public"
|
|
44
46
|
},
|
|
45
47
|
"dependencies": {
|
|
46
|
-
"@altopelago/aeon-
|
|
47
|
-
"@altopelago/aeon-
|
|
48
|
+
"@altopelago/aeon-lexer": "0.9.2",
|
|
49
|
+
"@altopelago/aeon-aes": "0.9.2"
|
|
48
50
|
},
|
|
49
51
|
"scripts": {
|
|
50
52
|
"build": "tsc -p tsconfig.json",
|