@equationalapplications/core-okf 4.15.0 → 4.15.2

package/README.md

@@ -1,3 +1,74 @@
 # @equationalapplications/core-okf
 
-Zero-dependency primitives for producing [Open Knowledge Format](https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md) (OKF v0.1) bundles: YAML frontmatter serialization, concept document assembly, and `index.md`/`log.md` builders. No knowledge of any specific data model — bring your own mapping from your domain objects to `OkfFrontmatter` + body strings.
+[![npm version](https://img.shields.io/npm/v/%40equationalapplications%2Fcore-okf?label=core-okf)](https://www.npmjs.com/package/@equationalapplications/core-okf) [![npm downloads](https://img.shields.io/npm/dm/%40equationalapplications%2Fcore-okf?label=downloads)](https://www.npmjs.com/package/@equationalapplications/core-okf)
+
+## Overview
+
+A zero-dependency library for parsing and producing [Open Knowledge Format (OKF) v0.1](https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf) bundles. This package provides the raw primitives to work with OKF frontmatter, concept documents, and index/log files, completely decoupled from any specific database or data model.
+
+For a ready-made `MemoryDump` ⇄ OKF bundle adapter, see the [OKF Import/Export section in `@equationalapplications/core-llm-wiki`](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/core/README.md#okf-importexport).
+
+## Installation
+
+```bash
+npm install @equationalapplications/core-okf
+```
+
+## API Reference
+
+### `serializeFrontmatter` / `parseFrontmatter`
+
+Produces and parses YAML frontmatter for OKF concept documents.
+
+```typescript
+const yaml = serializeFrontmatter({ type: 'fact', id: 'fact_123' });
+const { frontmatter, rest } = parseFrontmatter(fileContent);
+```
+
+### `buildConceptDocument` / `parseConcept`
+
+Combines frontmatter and markdown body into a single string, or splits an existing OKF file into its component parts.
+
+```typescript
+const markdown = buildConceptDocument({ type: 'task', id: 'task_1' }, '# Buy groceries');
+const { frontmatter, body } = parseConcept(markdown);
+```
+
+### `buildIndexMd` / `buildRootIndexMd`
+
+Generates directory index lists or root OKF catalog manifests.
+
+```typescript
+const sections = [{ heading: 'Facts', entries: [{ path: 'facts/fact_123.md', title: 'Fact 123' }] }];
+const dirIndex = buildIndexMd(sections);
+const rootIndex = buildRootIndexMd('0.1', sections);
+```
+
+### `buildLogMd` / `parseLogMd`
+
+Serializes chronological append-only events or parses them back into discrete entries.
+
+```typescript
+const log = buildLogMd([{ date: '2026-06-23', text: 'Observation made' }]);
+const events = parseLogMd(logContent);
+```
+
+### `extractMarkdownLinks`
+
+Parses relative markdown cross-links to map knowledge graph edges.
+
+```typescript
+const links = extractMarkdownLinks('See [preferences](facts/fact_abc.md) for more.');
+// links: [{ text: 'preferences', path: 'facts/fact_abc.md' }]
+```
+
+## Monorepo Ecosystem
+
+| Package | Purpose |
+| --- | --- |
+| [@equationalapplications/core-llm-wiki](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/core/README.md) | Persistent episodic memory |
+| [@equationalapplications/expo-llm-wiki](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/expo/README.md) | Persistent episodic memory for Expo/React Native |
+| [@equationalapplications/react-llm-wiki](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/react/README.md) | Persistent episodic memory for Web |
+| [@equationalapplications/prisma-outbox](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/prisma-outbox/README.md) | Sync SQLite outbox events to Prisma |
+| [@equationalapplications/core-llm-tools](https://github.com/equationalapplications/expo-llm-wiki/blob/main/packages/core-llm-tools/README.md) | Gemini tool schemas and capability injector |
+| **@equationalapplications/core-okf** | Zero-dependency Open Knowledge Format (OKF) v0.1 primitives — parse and produce interoperable knowledge bundles. |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equationalapplications/core-okf",
-  "version": "4.15.0",
+  "version": "4.15.2",
   "description": "Zero-dependency Open Knowledge Format (OKF) v0.1 primitives: frontmatter serialization, concept documents, index.md and log.md builders.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -12,13 +12,6 @@
       "import": "./dist/index.mjs"
     }
   },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest"
-  },
   "files": [
     "dist",
     "LICENSE",
@@ -53,5 +46,12 @@
     "tsup": "^8.0.0",
     "typescript": "^5.4.0",
     "vitest": "4.1.5"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
   }
-}
+}