@vortex-os/base 0.0.1 → 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.
Files changed (7) hide show
  1. package/README.md +50 -36
  2. package/dist/index.d.ts +1526 -23
  3. package/dist/index.js +3279 -20
  4. package/dist/index.js.map +1 -1
  5. package/package.json +16 -9
  6. package/dist/index.d.ts.map +0 -1
  7. package/src/index.ts +0 -33
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # @vortex-os/base
2
2
 
3
- Base framework entry point for **VortEX** — a Multi-Agent Personal AI Work OS.
3
+ Base entry point for **VortEX** — a Multi-Agent Personal AI Work OS framework.
4
4
 
5
- > This is the initial release (0.0.1) and exposes framework metadata only. The full v0.1.0 — which aggregates the framework's modules into a single importable surface — ships in a follow-up cycle. See [phase-10-split-plan.md](https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md) for the capability-cluster packaging design.
5
+ `@vortex-os/base` bundles the framework's 13 internal workspaces (core utilities, slash-command runtime, memory store, daily-log store, decision-log store, runbook store, link-rewriter, index-generator, data-linter, report-generator, two catalog modules, and the session-rituals plugin) into a single installable package. Install once, get the whole framework.
6
6
 
7
7
  ## Install
8
8
 
@@ -10,53 +10,67 @@ Base framework entry point for **VortEX** — a Multi-Agent Personal AI Work OS.
10
10
  npm install @vortex-os/base
11
11
  ```
12
12
 
13
- ## Usage (0.0.1)
13
+ ## Usage
14
14
 
15
15
  ```ts
16
- import { FRAMEWORK_META, VORTEX_BASE_VERSION } from "@vortex-os/base";
17
-
18
- console.log(FRAMEWORK_META);
19
- // {
20
- // version: "0.0.1",
21
- // framework: "vortex-os",
22
- // fullReleaseTarget: "0.1.0",
23
- // designReference: "...",
24
- // repository: "...",
25
- // }
16
+ import {
17
+ core,
18
+ slashCommands,
19
+ memorySystem,
20
+ til,
21
+ decisionLog,
22
+ sessionRituals,
23
+ } from "@vortex-os/base";
24
+
25
+ // Use the slash-rituals registry against your own data directory
26
+ const registry = sessionRituals.createRitualRegistry();
27
+ const ctx = core.makeContext(process.cwd());
28
+
29
+ await slashCommands.runSlash("/session-start", { registry, context: ctx });
26
30
  ```
27
31
 
28
- ## What ships in v0.1.0
29
-
30
- `@vortex-os/base` v0.1.0 will re-export the framework's modules as a single package:
31
-
32
- - `core` — frontmatter, privacy, types, ModuleContext
33
- - `slash-commands` — Command, CommandRegistry, runSlash
34
- - `memory-system` — markdown-frontmatter memory layer
35
- - `til` — daily work-log store
36
- - `decision-log` — decision-log store
37
- - `runbooks` — runbook store
38
- - `index-generator` — `_INDEX.md` rendering
39
- - `link-rewriter` — wiki-link detect / resolve / check / rewrite
40
- - `data-lint` — directory linter
41
- - `report-generator` — HTML reports with privacy filtering
42
- - `ai-coding-pitfalls` — coding pitfall catalog
43
- - `tool-rules` — tool usage rules catalog
44
- - `session-rituals` plugin — `/session-start`, `/reindex`, `/decision`, `/til`, `/vortex`
32
+ ## Exported namespaces
33
+
34
+ Each internal workspace is exposed as a top-level namespace on the package:
35
+
36
+ | Namespace | Source workspace | Role |
37
+ |---|---|---|
38
+ | `core` | `@vortex-os/core` | Frontmatter parser (BOM-safe), three-tier privacy filter, `ModuleContext` path resolver, shared types |
39
+ | `slashCommands` | `@vortex-os/slash-commands` | `Command`, `CommandRegistry`, `runSlash` primitives |
40
+ | `memorySystem` | `@vortex-os/memory-system` | Markdown-frontmatter memory store + `MEMORY.md` index writer + diff helpers |
41
+ | `dataLint` | `@vortex-os/data-lint` | Pluggable linter for markdown directories (frontmatter / privacy / wiki-link checks) |
42
+ | `aiCodingPitfalls` | `@vortex-os/ai-coding-pitfalls` | Typed catalog of AI coding pitfall patterns |
43
+ | `toolRules` | `@vortex-os/tool-rules` | Typed catalog of tool usage rules |
44
+ | `reportGenerator` | `@vortex-os/report-generator` | HTML reports with privacy-marker section filtering |
45
+ | `til` | `@vortex-os/til` | Daily work-log store with year/month layout |
46
+ | `decisionLog` | `@vortex-os/decision-log` | Decision-log store with template-driven entry creation |
47
+ | `indexGenerator` | `@vortex-os/index-generator` | `_INDEX.md` rendering (flat + nested modes) |
48
+ | `runbooks` | `@vortex-os/runbooks` | Runbook store with `last_tested`-based stale detection |
49
+ | `linkRewriter` | `@vortex-os/link-rewriter` | Wiki-link extract / resolve / check / rewrite |
50
+ | `sessionRituals` | `@vortex-os/session-rituals` | Daily session-loop slash commands: `/session-start`, `/reindex`, `/decision`, `/til`, `/vortex` |
45
51
 
46
52
  ## Capability add-ons (Phase 11+)
47
53
 
48
- Future capability clusters publish as siblings under the `@vortex-os` scope:
54
+ Future capability clusters publish as siblings under the `@vortex-os` scope and install alongside the base. The base auto-detects installed add-ons at session-start:
49
55
 
50
- - `@vortex-os/memory-extended` (Phase 11) — sqlite + vector + recall for scale + semantic search
51
- - `@vortex-os/dev-toolkit` (Phase 12) — vibe coding + self-QA + CI/CD assistance
52
- - `@vortex-os/vision` (Phase 14, under review) — screen context + visual reasoning
56
+ - `@vortex-os/memory-extended` (Phase 11) — sqlite + vector + recall for scale and semantic search. Peer-depends on this base. See [memory-extended-design.md](https://github.com/dydan77/vortex/blob/main/docs/memory-extended-design.md).
57
+ - `@vortex-os/dev-toolkit` (Phase 12) — vibe coding + self-QA + CI/CD assistance.
58
+ - `@vortex-os/vision` (Phase 14, under review) — screen context + visual reasoning.
53
59
 
54
60
  Each add-on installs alongside the base and extends what the agent can do without forcing a base upgrade.
55
61
 
62
+ ## Packaging notes
63
+
64
+ - **Bundled**: all 13 workspaces are bundled into the published artifact via `tsup`. Consumers do not need to install workspace packages individually.
65
+ - **External dependency**: `yaml` is left as a runtime dependency (npm resolves it on install).
66
+ - **Format**: ESM only. `"type": "module"` in your consumer is required (or set up `.mjs`).
67
+ - **Types**: a single `dist/index.d.ts` exposes all namespace types.
68
+
56
69
  ## Related
57
70
 
58
- - [VortEX framework](https://github.com/dydan77/vortex) — integration template + current monorepo source
59
- - [Phase 10 split plan](https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md) — capability-cluster design (revision 2)
71
+ - [VortEX framework repository](https://github.com/dydan77/vortex) — source, design docs, integration template for instances
72
+ - [Phase 10 split plan v2](https://github.com/dydan77/vortex/blob/main/docs/phase-10-split-plan.md) — capability-cluster packaging design
73
+ - [Memory-extended design](https://github.com/dydan77/vortex/blob/main/docs/memory-extended-design.md) — Phase 11 (memory-extended add-on) reference
60
74
 
61
75
  ## License
62
76