@oa-sdk/spec-bundler 0.1.0
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/LICENSE +201 -0
- package/README.md +240 -0
- package/dist/archiver.d.ts +22 -0
- package/dist/archiver.js +155 -0
- package/dist/category-parser.d.ts +15 -0
- package/dist/category-parser.js +115 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.js +760 -0
- package/dist/context-generator.d.ts +14 -0
- package/dist/context-generator.js +297 -0
- package/dist/freshness.d.ts +41 -0
- package/dist/freshness.js +365 -0
- package/dist/index.d.ts +71 -0
- package/dist/index.js +705 -0
- package/dist/link-rewriter.d.ts +65 -0
- package/dist/link-rewriter.js +777 -0
- package/dist/resolver.d.ts +27 -0
- package/dist/resolver.js +276 -0
- package/dist/schema.d.ts +563 -0
- package/dist/schema.js +670 -0
- package/dist/section-slicer.d.ts +12 -0
- package/dist/section-slicer.js +114 -0
- package/dist/topic.d.ts +62 -0
- package/dist/topic.js +262 -0
- package/dist/tree-shaker.d.ts +40 -0
- package/dist/tree-shaker.js +523 -0
- package/dist/types.d.ts +369 -0
- package/dist/types.js +2 -0
- package/package.json +29 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
++ Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
# @oa-sdk/spec-bundler
|
|
2
|
+
|
|
3
|
+
Declarative manifest-driven asset bundler, AST-free markdown link rewriter, and dependency reachability engine with cryptographic lockfile freshness verification.
|
|
4
|
+
|
|
5
|
+
[](#zero-runtime-dependencies)
|
|
6
|
+
[](https://www.typescriptlang.org/)
|
|
7
|
+
[](LICENSE)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 1. Overview & Architecture Boundaries
|
|
12
|
+
|
|
13
|
+
`@oa-sdk/spec-bundler` is designed as a standalone, zero-dependency distribution packager within the specification ecosystem.
|
|
14
|
+
|
|
15
|
+
```mermaid
|
|
16
|
+
flowchart TD
|
|
17
|
+
subgraph Ecosystem ["Specification Ecosystem Boundaries"]
|
|
18
|
+
DP["@spec-platform/document-parser<br/>(Full AST & Knowledge Graph)"]
|
|
19
|
+
TE["@samchon/typespec-evidence<br/>(Compile-time Verification & CI Gate)"]
|
|
20
|
+
MB["@oa-sdk/spec-bundler<br/>(Zero-Dependency Bundler & Link Rewriter)"]
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
SRC["Source Specs & Documentation<br/>(Markdown, TypeSpec, Assets)"]
|
|
24
|
+
SRC --> DP
|
|
25
|
+
SRC --> TE
|
|
26
|
+
SRC --> MB
|
|
27
|
+
|
|
28
|
+
MB -->|1. BFS Reachability Traversal| TS["Tree-Shaking of Unused Docs"]
|
|
29
|
+
MB -->|2. Regex Masking| LR["Relative Link Coordinate Rewriting"]
|
|
30
|
+
MB -->|3. Anchor Integrity Auditing| AV["--check-anchors + 'Did you mean?'"]
|
|
31
|
+
MB -->|4. Cryptographic BOM| PK["Deterministic ZIP Archive + Lockfile"]
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Architectural Directives:
|
|
35
|
+
- **Zero Runtime Dependencies**: Built strictly using Node.js built-ins (`node:fs`, `node:path`, `node:crypto`, `node:zlib`). Runs seamlessly via `npx` or `pnpm` without installing third-party parser runtimes.
|
|
36
|
+
- **AST-Free Parsing via Code Fence Masking**: Avoids heavy AST parsers. Protects multi-line code fences (```` ```...``` ````), inline spans (`` `...` ``), and HTML blocks with temporary token masking to rewrite Markdown links at line/character-accurate offsets without mutating code samples.
|
|
37
|
+
- **Single Source of Truth (SSOT) for Heading Slugs**: Implements GitHub-compliant Unicode slug normalization (`/[^\p{L}\p{N}\s-]/gu`), guaranteeing identical slug generation across Korean, CJK, and multilingual specifications.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 2. Core Features
|
|
42
|
+
|
|
43
|
+
### 2.1 BFS Tree-Shaking Reachability Traversal
|
|
44
|
+
When `treeShake: true` is configured with entrypoints (e.g. `["META-GUIDE.md", "AGENTS.md"]`), the bundler performs a Breadth-First Search (BFS) over internal document links and TypeSpec `@evidence` citations:
|
|
45
|
+
- Retains only explicitly referenced specifications, skills, and assets.
|
|
46
|
+
- Automatically excludes unreferenced legacy guides, templates, and intermediate scratch files.
|
|
47
|
+
- Operates safely on cyclic links and multi-hop references.
|
|
48
|
+
|
|
49
|
+
### 2.2 Automated Markdown Link Rewriting
|
|
50
|
+
- **Coordinate Recalculation**: Automatically updates relative paths when documents move to new positions in the bundle hierarchy.
|
|
51
|
+
- **Protocol Normalization**: Converts absolute local `file:///...` links to portable bundle-relative paths.
|
|
52
|
+
- **Fragment & Query Preservation**: Preserves URL fragments (`#heading-slug`) and search parameters (`?view=detail`).
|
|
53
|
+
- **Reference Definition Support**: Seamlessly parses and rewrites CommonMark link reference definitions (`[id]: path/to/doc.md`).
|
|
54
|
+
- **Unbundled Policy**: Configurable behavior for links pointing outside the bundle:
|
|
55
|
+
- `warn`: Emits a diagnostic warning.
|
|
56
|
+
- `error`: Blocks packaging with exit code 1.
|
|
57
|
+
- `preserve`: Retains the link as-is.
|
|
58
|
+
- `github-fallback`: Rewrites to GitHub repository URLs (using `gitRepositoryUrl`).
|
|
59
|
+
|
|
60
|
+
### 2.3 Comprehensive Anchor Verification (`--check-anchors`)
|
|
61
|
+
- Validates **intra-file anchors** (`[link](#heading)`) and **cross-file anchors** (`[link](./doc.md#heading)`).
|
|
62
|
+
- Extracts heading slugs, explicit custom IDs (`{#custom-id}`), and HTML anchors (`<a id="...">`).
|
|
63
|
+
- Employs a zero-dependency **Levenshtein distance matcher** to provide intelligent "Did you mean?" suggestions for broken anchor links.
|
|
64
|
+
|
|
65
|
+
### 2.4 TypeSpec (`.tsp`) Bundle Reference Rewriting
|
|
66
|
+
- Automatically rewrites outbound references in TypeSpec files during bundle assembly:
|
|
67
|
+
- `@evidence("path/to/doc.md#anchor", "reason")` rewritten to point to bundle-internal destination coordinates.
|
|
68
|
+
- Relative TypeSpec imports (`import "./common.tsp";`) rewritten to new bundle layout.
|
|
69
|
+
- Markdown links embedded within `@doc("... [Link](path) ...")` or `@doc("""...""")` rewritten.
|
|
70
|
+
- Validates TypeSpec outbound references during `spec-bundler verify` with dead link detection and anchor fuzzy suggestions.
|
|
71
|
+
|
|
72
|
+
### 2.5 Embedded Path-Mapping BOM & Bundle Path Resolver
|
|
73
|
+
- Automatically embeds bidirectional path mappings in `META-INF/bundle.manifest.json`:
|
|
74
|
+
- `sourceToBundle`: Maps repository source paths to bundle-internal coordinates.
|
|
75
|
+
- `bundleToSource`: Maps bundle-internal coordinates back to original workspace source paths.
|
|
76
|
+
- Provides `spec-bundler resolve` CLI and `resolveBundlePath()` API to instantly locate any workspace path or reference (including `#anchor` and `?query`) within a packaged archive with Levenshtein typo suggestions.
|
|
77
|
+
|
|
78
|
+
### 2.6 Cryptographic Freshness & CI Gate
|
|
79
|
+
- Tracks content hashes (SHA-256) of all bundled files in `bundle.manifest.lock.json`.
|
|
80
|
+
- `spec-bundler check`: Instantaneous CI pre-commit gate (exits with code 1 if upstream sources drifted without regenerating the bundle).
|
|
81
|
+
- Emits GitHub Actions workflow annotations (`::error file=...::...`) automatically in CI environments.
|
|
82
|
+
|
|
83
|
+
### 2.7 Developer Experience & Visibility
|
|
84
|
+
- **Dry-Run Preview (`--dry-run`)**: Simulates destination mappings, planned link rewrites, and lockfile updates with zero disk writes.
|
|
85
|
+
- **Structured JSON (`--json`)**: Emits machine-readable output for orchestration pipelines.
|
|
86
|
+
- **Detailed Diff Reporting (`--diff`)**: Prints terminal-colored line-by-line link rewriting plans.
|
|
87
|
+
- **Visual ASCII Reachability Tree (`spec-bundler inspect`)**: Renders hierarchical entrypoint-to-dependency dependency trees.
|
|
88
|
+
- **Reachability Provenance (`spec-bundler pack --explain <target>`)**: Explains exactly *why* a file was retained across hop-by-hop reference chains.
|
|
89
|
+
- **JSON Schema Draft 2020-12 (`spec-bundler schema`)**: Emits and validates manifest configurations with typo detection.
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## 3. CLI Usage Reference
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
# Package the bundle (auto-detects evidence-bundle.manifest.json or bundle.manifest.json)
|
|
97
|
+
spec-bundler pack
|
|
98
|
+
|
|
99
|
+
# Preview packaging with zero disk writes
|
|
100
|
+
spec-bundler pack --dry-run
|
|
101
|
+
|
|
102
|
+
# Output detailed terminal diff reporting of planned rewrites
|
|
103
|
+
spec-bundler pack --dry-run --diff
|
|
104
|
+
|
|
105
|
+
# Output structured machine-readable JSON
|
|
106
|
+
spec-bundler pack --dry-run --json
|
|
107
|
+
|
|
108
|
+
# Explain why a specific file was retained in the bundle
|
|
109
|
+
spec-bundler pack --explain architecture-guides/core-flow.md
|
|
110
|
+
|
|
111
|
+
# Force re-bundle even if files are fresh
|
|
112
|
+
spec-bundler pack --force
|
|
113
|
+
|
|
114
|
+
# Inspect hierarchical ASCII dependency reachability tree
|
|
115
|
+
spec-bundler inspect
|
|
116
|
+
|
|
117
|
+
# CI Gate: verify that bundle and lockfile are fresh
|
|
118
|
+
spec-bundler check
|
|
119
|
+
|
|
120
|
+
# Audit bundle links and verify anchor validity with fuzzy suggestions
|
|
121
|
+
spec-bundler verify --check-anchors
|
|
122
|
+
|
|
123
|
+
# Resolve workspace path or reference inside packaged bundle
|
|
124
|
+
spec-bundler resolve dist/bundle.zip docs/requirements.md#user-profile
|
|
125
|
+
spec-bundler resolve dist/bundle.zip docs/requirements.md#user-profile --json
|
|
126
|
+
|
|
127
|
+
# Emit official JSON Schema (Draft 2020-12) for manifests
|
|
128
|
+
spec-bundler schema --out docs/bundle-manifest.schema.json
|
|
129
|
+
|
|
130
|
+
# Extract a bundle archive cleanly into a target directory
|
|
131
|
+
spec-bundler unpack dist/bundle.zip --dest .agents/skills/
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## 4. Manifest Configuration (`bundle.manifest.json`)
|
|
137
|
+
|
|
138
|
+
```json
|
|
139
|
+
{
|
|
140
|
+
"$schema": "https://spec-platform.dev/schemas/bundle-manifest.v1.json",
|
|
141
|
+
"name": "evidence-meta-skill-bundle",
|
|
142
|
+
"version": "1.0.0",
|
|
143
|
+
"description": "Evidence meta skills and architecture contracts",
|
|
144
|
+
"archive": {
|
|
145
|
+
"output": "dist/evidence-bundle.zip"
|
|
146
|
+
},
|
|
147
|
+
"treeShake": true,
|
|
148
|
+
"entrypoints": [
|
|
149
|
+
"META-GUIDE.md",
|
|
150
|
+
"AGENTS.md"
|
|
151
|
+
],
|
|
152
|
+
"targets": [
|
|
153
|
+
{
|
|
154
|
+
"source": "docs/**/*.md",
|
|
155
|
+
"dest": "docs/",
|
|
156
|
+
"include": ["**/*.md"]
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"source": ".agents/skills/**",
|
|
160
|
+
"dest": "skills/"
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"source": "specs/**/*.tsp",
|
|
164
|
+
"dest": "specs/"
|
|
165
|
+
}
|
|
166
|
+
],
|
|
167
|
+
"exclude": [
|
|
168
|
+
"**/node_modules/**",
|
|
169
|
+
"**/.git/**",
|
|
170
|
+
"**/tmp/**"
|
|
171
|
+
],
|
|
172
|
+
"unbundledPolicy": "warn",
|
|
173
|
+
"gitRepositoryUrl": "https://github.com/organization/repository"
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## 5. Programmatic API
|
|
180
|
+
|
|
181
|
+
`@oa-sdk/spec-bundler` can be imported directly in Node.js / TypeScript:
|
|
182
|
+
|
|
183
|
+
```typescript
|
|
184
|
+
import {
|
|
185
|
+
createBundle,
|
|
186
|
+
verifyBundle,
|
|
187
|
+
checkFreshness,
|
|
188
|
+
inspectBundle,
|
|
189
|
+
explainReachability,
|
|
190
|
+
resolveBundlePath,
|
|
191
|
+
rewriteTypeSpecContent,
|
|
192
|
+
loadManifest,
|
|
193
|
+
normalizeSlug,
|
|
194
|
+
extractDocumentAnchors,
|
|
195
|
+
} from "@oa-sdk/spec-bundler";
|
|
196
|
+
|
|
197
|
+
// 1. Pack bundle programmatically
|
|
198
|
+
const result = await createBundle("bundle.manifest.json", {
|
|
199
|
+
dryRun: false,
|
|
200
|
+
force: false,
|
|
201
|
+
});
|
|
202
|
+
console.log(`Generated ${result.outputPath} (${result.filesCount} files)`);
|
|
203
|
+
|
|
204
|
+
// 2. Resolve references inside a bundle archive
|
|
205
|
+
const resolution = resolveBundlePath(
|
|
206
|
+
result.outputPath,
|
|
207
|
+
"docs/requirements.md#user-profile",
|
|
208
|
+
);
|
|
209
|
+
console.log(resolution.bundlePath); // "docs/requirements.md"
|
|
210
|
+
console.log(resolution.fullReference); // "docs/requirements.md#user-profile"
|
|
211
|
+
|
|
212
|
+
// 3. Audit links and anchors
|
|
213
|
+
const { freshness, deadLinks, warnings } = verifyBundle("bundle.manifest.json", {
|
|
214
|
+
checkAnchors: true,
|
|
215
|
+
});
|
|
216
|
+
if (deadLinks.length > 0) {
|
|
217
|
+
console.error("Dead links found:", deadLinks);
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
// 4. Inspect dependency reachability tree
|
|
221
|
+
const tree = inspectBundle("bundle.manifest.json");
|
|
222
|
+
console.log(tree.asciiTree);
|
|
223
|
+
|
|
224
|
+
// 5. Trace reachability provenance
|
|
225
|
+
const explanation = explainReachability("bundle.manifest.json", "docs/guide.md");
|
|
226
|
+
console.log(explanation.retained ? `Retained via: ${explanation.chain?.join(" -> ")}` : "Eliminated");
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## 6. Conformance & Tolerance Rules
|
|
232
|
+
|
|
233
|
+
| Rule | Specification | Example |
|
|
234
|
+
| :--- | :--- | :--- |
|
|
235
|
+
| **Unicode Slugification** | `/[^\p{L}\p{N}\s-]/gu` + `replace(/\s+/g, "-")` | `## 사용자 계정 검증` → `사용자-계정-검증` |
|
|
236
|
+
| **Explicit Custom Anchor** | `{#custom-id}` syntax | `### 주문 정책 {#ca-order-policy}` → `ca-order-policy` |
|
|
237
|
+
| **Dash Collapsing** | `replace(/-+/g, "-")` | `1. 개요 & 설정` → `1-개요-설정` |
|
|
238
|
+
| **Numeric Prefix Tolerance** | Strips leading `^\d+[\.\)]\s*` | `1. 개요` matches `#1-개요` and `#개요` |
|
|
239
|
+
| **HTML Anchors** | Matches `<a id="...">` and `<a name="...">` | `<a id="overview">` → `overview` |
|
|
240
|
+
| **Fuzzy Suggestion** | Levenshtein distance $\le 3$ or substring ratio | `#user-prfole` → `(Did you mean '#user-profile'?)` |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export declare function computeCrc32(buffer: Buffer): number;
|
|
2
|
+
export interface ZipArchiveEntry {
|
|
3
|
+
path: string;
|
|
4
|
+
data: Buffer;
|
|
5
|
+
mtime?: Date;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Creates a standard, deterministic PKZIP archive buffer in pure Node.js.
|
|
9
|
+
*/
|
|
10
|
+
export declare function createZipArchive(entries: ZipArchiveEntry[]): Buffer;
|
|
11
|
+
/**
|
|
12
|
+
* Reads and decompresses all entries from a ZIP archive buffer into an in-memory Map.
|
|
13
|
+
*/
|
|
14
|
+
export declare function readZipArchive(zipBuffer: Buffer): Map<string, Buffer>;
|
|
15
|
+
/**
|
|
16
|
+
* Extracts a ZIP archive buffer into destination directory in pure Node.js.
|
|
17
|
+
*/
|
|
18
|
+
export declare function extractZipArchive(zipBuffer: Buffer, destDir: string): {
|
|
19
|
+
extractedCount: number;
|
|
20
|
+
files: string[];
|
|
21
|
+
};
|
|
22
|
+
//# sourceMappingURL=archiver.d.ts.map
|
package/dist/archiver.js
ADDED
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import fs from "node:fs";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
import zlib from "node:zlib";
|
|
4
|
+
// CRC-32 lookup table for universal fallback
|
|
5
|
+
const CRC32_TABLE = new Uint32Array(256);
|
|
6
|
+
for (let i = 0; i < 256; i++) {
|
|
7
|
+
let c = i;
|
|
8
|
+
for (let k = 0; k < 8; k++) {
|
|
9
|
+
c = c & 1 ? 0xedb88320 ^ (c >>> 1) : c >>> 1;
|
|
10
|
+
}
|
|
11
|
+
CRC32_TABLE[i] = c >>> 0;
|
|
12
|
+
}
|
|
13
|
+
export function computeCrc32(buffer) {
|
|
14
|
+
if (typeof zlib.crc32 === "function") {
|
|
15
|
+
return zlib.crc32(buffer) >>> 0;
|
|
16
|
+
}
|
|
17
|
+
let crc = 0xffffffff;
|
|
18
|
+
for (let i = 0; i < buffer.length; i++) {
|
|
19
|
+
crc = (crc >>> 8) ^ CRC32_TABLE[(crc ^ buffer[i]) & 0xff];
|
|
20
|
+
}
|
|
21
|
+
return (crc ^ 0xffffffff) >>> 0;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Converts a JavaScript Date or timestamp to MS-DOS date and time format.
|
|
25
|
+
*/
|
|
26
|
+
function toDosDateTime(date) {
|
|
27
|
+
const d = date.getFullYear() < 1980 ? new Date("1980-01-01T00:00:00Z") : date;
|
|
28
|
+
const dosTime = ((d.getHours() & 0x1f) << 11) |
|
|
29
|
+
((d.getMinutes() & 0x3f) << 5) |
|
|
30
|
+
((Math.floor(d.getSeconds() / 2)) & 0x1f);
|
|
31
|
+
const dosDate = (((d.getFullYear() - 1980) & 0x7f) << 9) |
|
|
32
|
+
(((d.getMonth() + 1) & 0x0f) << 5) |
|
|
33
|
+
(d.getDate() & 0x1f);
|
|
34
|
+
return { time: dosTime, date: dosDate };
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Creates a standard, deterministic PKZIP archive buffer in pure Node.js.
|
|
38
|
+
*/
|
|
39
|
+
export function createZipArchive(entries) {
|
|
40
|
+
// Sort entries alphabetically by path for reproducible archive output
|
|
41
|
+
const sorted = [...entries].sort((a, b) => a.path.localeCompare(b.path));
|
|
42
|
+
const localChunks = [];
|
|
43
|
+
const centralChunks = [];
|
|
44
|
+
let offset = 0;
|
|
45
|
+
for (const entry of sorted) {
|
|
46
|
+
const filenameBuf = Buffer.from(entry.path, "utf8");
|
|
47
|
+
const uncompressedSize = entry.data.length;
|
|
48
|
+
const crc = computeCrc32(entry.data);
|
|
49
|
+
const compressedData = zlib.deflateRawSync(entry.data);
|
|
50
|
+
const compressedSize = compressedData.length;
|
|
51
|
+
const { time: dosTime, date: dosDate } = toDosDateTime(entry.mtime ?? new Date("2026-01-01T00:00:00Z"));
|
|
52
|
+
// --- Local File Header (30 bytes + filename + compressed data) ---
|
|
53
|
+
const localHeader = Buffer.alloc(30);
|
|
54
|
+
localHeader.writeUInt32LE(0x04034b50, 0); // Signature
|
|
55
|
+
localHeader.writeUInt16LE(20, 4); // Version needed (2.0)
|
|
56
|
+
localHeader.writeUInt16LE(0x0800, 6); // General purpose bit flag (UTF-8 filename)
|
|
57
|
+
localHeader.writeUInt16LE(8, 8); // Compression method (8 = Deflate)
|
|
58
|
+
localHeader.writeUInt16LE(dosTime, 10);
|
|
59
|
+
localHeader.writeUInt16LE(dosDate, 12);
|
|
60
|
+
localHeader.writeUInt32LE(crc, 14);
|
|
61
|
+
localHeader.writeUInt32LE(compressedSize, 18);
|
|
62
|
+
localHeader.writeUInt32LE(uncompressedSize, 22);
|
|
63
|
+
localHeader.writeUInt16LE(filenameBuf.length, 26);
|
|
64
|
+
localHeader.writeUInt16LE(0, 28); // Extra field length
|
|
65
|
+
const localEntry = Buffer.concat([localHeader, filenameBuf, compressedData]);
|
|
66
|
+
localChunks.push(localEntry);
|
|
67
|
+
// --- Central Directory Header (46 bytes + filename) ---
|
|
68
|
+
const centralHeader = Buffer.alloc(46);
|
|
69
|
+
centralHeader.writeUInt32LE(0x02014b50, 0); // Signature
|
|
70
|
+
centralHeader.writeUInt16LE(0x031e, 4); // Version made by (UNIX 3.0)
|
|
71
|
+
centralHeader.writeUInt16LE(20, 6); // Version needed (2.0)
|
|
72
|
+
centralHeader.writeUInt16LE(0x0800, 8); // General purpose bit flag (UTF-8)
|
|
73
|
+
centralHeader.writeUInt16LE(8, 10); // Compression method (Deflate)
|
|
74
|
+
centralHeader.writeUInt16LE(dosTime, 12);
|
|
75
|
+
centralHeader.writeUInt16LE(dosDate, 14);
|
|
76
|
+
centralHeader.writeUInt32LE(crc, 16);
|
|
77
|
+
centralHeader.writeUInt32LE(compressedSize, 20);
|
|
78
|
+
centralHeader.writeUInt32LE(uncompressedSize, 24);
|
|
79
|
+
centralHeader.writeUInt16LE(filenameBuf.length, 28);
|
|
80
|
+
centralHeader.writeUInt16LE(0, 30); // Extra field length
|
|
81
|
+
centralHeader.writeUInt16LE(0, 32); // File comment length
|
|
82
|
+
centralHeader.writeUInt16LE(0, 34); // Disk number start
|
|
83
|
+
centralHeader.writeUInt16LE(0, 36); // Internal file attributes
|
|
84
|
+
centralHeader.writeUInt16LE(0, 38); // External file attributes (DOS)
|
|
85
|
+
centralHeader.writeUInt16LE(0o100644, 40); // External file attributes (UNIX permissions)
|
|
86
|
+
centralHeader.writeUInt32LE(offset, 42); // Relative offset of local header
|
|
87
|
+
const centralEntry = Buffer.concat([centralHeader, filenameBuf]);
|
|
88
|
+
centralChunks.push(centralEntry);
|
|
89
|
+
offset += localEntry.length;
|
|
90
|
+
}
|
|
91
|
+
const centralDirectoryOffset = offset;
|
|
92
|
+
const centralDirectoryBuf = Buffer.concat(centralChunks);
|
|
93
|
+
const centralDirectorySize = centralDirectoryBuf.length;
|
|
94
|
+
// --- End of Central Directory Record (22 bytes) ---
|
|
95
|
+
const eocd = Buffer.alloc(22);
|
|
96
|
+
eocd.writeUInt32LE(0x06054b50, 0); // Signature
|
|
97
|
+
eocd.writeUInt16LE(0, 4); // Disk number
|
|
98
|
+
eocd.writeUInt16LE(0, 6); // Disk where central directory starts
|
|
99
|
+
eocd.writeUInt16LE(sorted.length, 8); // Records on this disk
|
|
100
|
+
eocd.writeUInt16LE(sorted.length, 10); // Total records
|
|
101
|
+
eocd.writeUInt32LE(centralDirectorySize, 12);
|
|
102
|
+
eocd.writeUInt32LE(centralDirectoryOffset, 16);
|
|
103
|
+
eocd.writeUInt16LE(0, 20); // Comment length
|
|
104
|
+
return Buffer.concat([...localChunks, centralDirectoryBuf, eocd]);
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Reads and decompresses all entries from a ZIP archive buffer into an in-memory Map.
|
|
108
|
+
*/
|
|
109
|
+
export function readZipArchive(zipBuffer) {
|
|
110
|
+
const entries = new Map();
|
|
111
|
+
let offset = 0;
|
|
112
|
+
while (offset + 30 <= zipBuffer.length) {
|
|
113
|
+
const sig = zipBuffer.readUInt32LE(offset);
|
|
114
|
+
if (sig !== 0x04034b50) {
|
|
115
|
+
break;
|
|
116
|
+
}
|
|
117
|
+
const compressionMethod = zipBuffer.readUInt16LE(offset + 8);
|
|
118
|
+
const compressedSize = zipBuffer.readUInt32LE(offset + 18);
|
|
119
|
+
const filenameLen = zipBuffer.readUInt16LE(offset + 26);
|
|
120
|
+
const extraLen = zipBuffer.readUInt16LE(offset + 28);
|
|
121
|
+
const filename = zipBuffer
|
|
122
|
+
.subarray(offset + 30, offset + 30 + filenameLen)
|
|
123
|
+
.toString("utf8");
|
|
124
|
+
const dataStart = offset + 30 + filenameLen + extraLen;
|
|
125
|
+
const compressedData = zipBuffer.subarray(dataStart, dataStart + compressedSize);
|
|
126
|
+
let uncompressedData;
|
|
127
|
+
if (compressionMethod === 8) {
|
|
128
|
+
uncompressedData = zlib.inflateRawSync(compressedData);
|
|
129
|
+
}
|
|
130
|
+
else if (compressionMethod === 0) {
|
|
131
|
+
uncompressedData = Buffer.from(compressedData);
|
|
132
|
+
}
|
|
133
|
+
else {
|
|
134
|
+
throw new Error(`Unsupported compression method in ZIP: ${compressionMethod}`);
|
|
135
|
+
}
|
|
136
|
+
entries.set(filename, uncompressedData);
|
|
137
|
+
offset = dataStart + compressedSize;
|
|
138
|
+
}
|
|
139
|
+
return entries;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Extracts a ZIP archive buffer into destination directory in pure Node.js.
|
|
143
|
+
*/
|
|
144
|
+
export function extractZipArchive(zipBuffer, destDir) {
|
|
145
|
+
const entries = readZipArchive(zipBuffer);
|
|
146
|
+
const files = [];
|
|
147
|
+
for (const [filename, uncompressedData] of entries.entries()) {
|
|
148
|
+
const targetPath = path.join(destDir, filename);
|
|
149
|
+
fs.mkdirSync(path.dirname(targetPath), { recursive: true });
|
|
150
|
+
fs.writeFileSync(targetPath, uncompressedData);
|
|
151
|
+
files.push(filename);
|
|
152
|
+
}
|
|
153
|
+
return { extractedCount: files.length, files };
|
|
154
|
+
}
|
|
155
|
+
//# sourceMappingURL=archiver.js.map
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { DocumentCategory, DocumentFidelity } from "./types.js";
|
|
2
|
+
export declare const STANDARD_CONTRACT_HEADINGS: string[];
|
|
3
|
+
/**
|
|
4
|
+
* Parses the document category from YAML frontmatter or infers it from path heuristics.
|
|
5
|
+
*/
|
|
6
|
+
export declare function parseDocumentCategory(content: string, filePath: string): DocumentCategory;
|
|
7
|
+
/**
|
|
8
|
+
* Extracts document content according to requested fidelity level (full, contract-only, summary).
|
|
9
|
+
* Prevents bundle bloat by stripping non-contract details for background/upstream documents.
|
|
10
|
+
*/
|
|
11
|
+
export declare function extractDocumentFidelity(content: string, category: DocumentCategory, fidelity?: DocumentFidelity, customSections?: string[]): {
|
|
12
|
+
content: string;
|
|
13
|
+
isModified: boolean;
|
|
14
|
+
};
|
|
15
|
+
//# sourceMappingURL=category-parser.d.ts.map
|