@remnic/import-okf 9.69.64

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Joshua Warren
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { ImporterAdapter } from '@remnic/core';
+
+interface ParsedOkfDocument {
+    relPath: string;
+    category: string;
+    content: string;
+    sourceId?: string;
+    sourceTimestamp?: string;
+}
+interface ParsedOkfBundle {
+    root: string;
+    documents: ParsedOkfDocument[];
+}
+declare function parseOkfBundle(input: unknown): ParsedOkfBundle;
+
+declare const OKF_SOURCE_LABEL = "okf";
+declare const adapter: ImporterAdapter<ParsedOkfBundle>;
+declare const okfAdapter: ImporterAdapter<ParsedOkfBundle>;
+
+export { OKF_SOURCE_LABEL, type ParsedOkfBundle, type ParsedOkfDocument, adapter, okfAdapter, parseOkfBundle };

package/dist/index.js

@@ -0,0 +1,117 @@
+// openclaw-engram: Local-first memory plugin
+
+// src/adapter.ts
+import { defaultWriteMemoriesToOrchestrator } from "@remnic/core";
+
+// src/parser.ts
+import { readdirSync, readFileSync, statSync } from "fs";
+import path from "path";
+var RESERVED = /* @__PURE__ */ new Set(["index.md", "log.md"]);
+var CATEGORY_BY_TYPE = {
+  "Memory Fact": "fact",
+  Decision: "decision",
+  Preference: "preference",
+  Commitment: "commitment",
+  Relationship: "relationship",
+  Principle: "principle",
+  Moment: "moment",
+  Skill: "skill",
+  Correction: "correction",
+  Rule: "rule"
+};
+function parseOkfBundle(input) {
+  if (typeof input !== "string" || input.trim() === "") {
+    throw new Error("OKF import requires a directory path");
+  }
+  const root = path.resolve(input.trim());
+  if (/\.(zip|tgz|tar\.gz)$/i.test(root)) {
+    throw new Error(`unpack first: archive imports are not supported (${root})`);
+  }
+  let stat;
+  try {
+    stat = statSync(root);
+  } catch {
+    throw new Error(`OKF bundle not found: ${root}`);
+  }
+  if (!stat.isDirectory()) {
+    throw new Error(`OKF import requires a directory, got a file: ${root}`);
+  }
+  const documents = [];
+  walk(root, root, documents);
+  documents.sort((a, b) => a.relPath.localeCompare(b.relPath));
+  return { root, documents };
+}
+function walk(root, dir, out) {
+  const entries = readdirSync(dir, { withFileTypes: true }).sort(
+    (a, b) => a.name.localeCompare(b.name)
+  );
+  for (const entry of entries) {
+    const full = path.join(dir, entry.name);
+    if (entry.isDirectory()) {
+      walk(root, full, out);
+      continue;
+    }
+    if (!entry.isFile() || !entry.name.endsWith(".md")) continue;
+    if (RESERVED.has(entry.name)) continue;
+    out.push(parseDocument(root, full));
+  }
+}
+function parseDocument(root, filePath) {
+  const raw = readFileSync(filePath, "utf8");
+  const { fields, body } = splitFrontmatter(raw);
+  const type = fields.type ?? "";
+  return {
+    relPath: path.relative(root, filePath).split(path.sep).join("/"),
+    category: CATEGORY_BY_TYPE[type] ?? "fact",
+    content: body.trim(),
+    ...fields.id ? { sourceId: fields.id } : {},
+    ...fields.timestamp ?? fields.updated ?? fields.created ? { sourceTimestamp: fields.timestamp ?? fields.updated ?? fields.created } : {}
+  };
+}
+function splitFrontmatter(text) {
+  if (!text.startsWith("---\n") && !text.startsWith("---\r\n")) {
+    return { fields: {}, body: text };
+  }
+  const end = text.indexOf("\n---", 4);
+  if (end < 0) return { fields: {}, body: text };
+  const raw = text.slice(4, end);
+  const body = text.slice(end + 4).replace(/^\r?\n/, "");
+  const fields = {};
+  for (const line of raw.split(/\r?\n/)) {
+    const match = line.match(/^([A-Za-z0-9_-]+):\s*(.*)$/);
+    if (!match) continue;
+    fields[match[1]] = match[2].replace(/^["']|["']$/g, "").trim();
+  }
+  return { fields, body };
+}
+
+// src/adapter.ts
+var OKF_SOURCE_LABEL = "okf";
+var adapter = {
+  name: "okf",
+  sourceLabel: OKF_SOURCE_LABEL,
+  parse(input, options) {
+    return parseOkfBundle(typeof input === "string" ? input : options?.filePath);
+  },
+  transform(parsed) {
+    return parsed.documents.filter((doc) => doc.content.length > 0).map((doc) => ({
+      content: doc.content,
+      sourceLabel: OKF_SOURCE_LABEL,
+      importedFromPath: `${parsed.root}/${doc.relPath}`,
+      metadata: { category: doc.category, relPath: doc.relPath },
+      ...doc.sourceId ? { sourceId: doc.sourceId } : {},
+      ...doc.sourceTimestamp ? { sourceTimestamp: doc.sourceTimestamp } : {}
+    }));
+  },
+  async writeTo(target, memories) {
+    return defaultWriteMemoriesToOrchestrator(target, memories);
+  }
+};
+var okfAdapter = adapter;
+export {
+  OKF_SOURCE_LABEL,
+  adapter,
+  okfAdapter,
+  parseOkfBundle
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/adapter.ts","../src/parser.ts"],"sourcesContent":["import type {\n  ImportedMemory,\n  ImporterAdapter,\n  ImporterParseOptions,\n  ImporterWriteResult,\n  ImporterWriteTarget,\n} from \"@remnic/core\";\nimport { defaultWriteMemoriesToOrchestrator } from \"@remnic/core\";\n\nimport { parseOkfBundle, type ParsedOkfBundle } from \"./parser.js\";\n\nexport const OKF_SOURCE_LABEL = \"okf\";\n\nexport const adapter: ImporterAdapter<ParsedOkfBundle> = {\n  name: \"okf\",\n  sourceLabel: OKF_SOURCE_LABEL,\n\n  parse(input: unknown, options?: ImporterParseOptions): ParsedOkfBundle {\n    return parseOkfBundle(typeof input === \"string\" ? input : options?.filePath);\n  },\n\n  transform(parsed: ParsedOkfBundle): ImportedMemory[] {\n    return parsed.documents\n      .filter((doc) => doc.content.length > 0)\n      .map((doc) => ({\n        content: doc.content,\n        sourceLabel: OKF_SOURCE_LABEL,\n        importedFromPath: `${parsed.root}/${doc.relPath}`,\n        metadata: { category: doc.category, relPath: doc.relPath },\n        ...(doc.sourceId ? { sourceId: doc.sourceId } : {}),\n        ...(doc.sourceTimestamp ? { sourceTimestamp: doc.sourceTimestamp } : {}),\n      }));\n  },\n\n  async writeTo(\n    target: ImporterWriteTarget,\n    memories: ImportedMemory[],\n  ): Promise<ImporterWriteResult> {\n    return defaultWriteMemoriesToOrchestrator(target, memories);\n  },\n};\n\nexport const okfAdapter = adapter;\n","import { readdirSync, readFileSync, statSync } from \"node:fs\";\nimport path from \"node:path\";\n\nconst RESERVED = new Set([\"index.md\", \"log.md\"]);\n\nconst CATEGORY_BY_TYPE: Record<string, string> = {\n  \"Memory Fact\": \"fact\",\n  Decision: \"decision\",\n  Preference: \"preference\",\n  Commitment: \"commitment\",\n  Relationship: \"relationship\",\n  Principle: \"principle\",\n  Moment: \"moment\",\n  Skill: \"skill\",\n  Correction: \"correction\",\n  Rule: \"rule\",\n};\n\nexport interface ParsedOkfDocument {\n  relPath: string;\n  category: string;\n  content: string;\n  sourceId?: string;\n  sourceTimestamp?: string;\n}\n\nexport interface ParsedOkfBundle {\n  root: string;\n  documents: ParsedOkfDocument[];\n}\n\nexport function parseOkfBundle(input: unknown): ParsedOkfBundle {\n  if (typeof input !== \"string\" || input.trim() === \"\") {\n    throw new Error(\"OKF import requires a directory path\");\n  }\n  const root = path.resolve(input.trim());\n  if (/\\.(zip|tgz|tar\\.gz)$/i.test(root)) {\n    throw new Error(`unpack first: archive imports are not supported (${root})`);\n  }\n  let stat;\n  try {\n    stat = statSync(root);\n  } catch {\n    throw new Error(`OKF bundle not found: ${root}`);\n  }\n  if (!stat.isDirectory()) {\n    throw new Error(`OKF import requires a directory, got a file: ${root}`);\n  }\n  const documents: ParsedOkfDocument[] = [];\n  walk(root, root, documents);\n  documents.sort((a, b) => a.relPath.localeCompare(b.relPath));\n  return { root, documents };\n}\n\nfunction walk(root: string, dir: string, out: ParsedOkfDocument[]): void {\n  const entries = readdirSync(dir, { withFileTypes: true }).sort((a, b) =>\n    a.name.localeCompare(b.name),\n  );\n  for (const entry of entries) {\n    const full = path.join(dir, entry.name);\n    if (entry.isDirectory()) {\n      walk(root, full, out);\n      continue;\n    }\n    if (!entry.isFile() || !entry.name.endsWith(\".md\")) continue;\n    if (RESERVED.has(entry.name)) continue;\n    out.push(parseDocument(root, full));\n  }\n}\n\nfunction parseDocument(root: string, filePath: string): ParsedOkfDocument {\n  const raw = readFileSync(filePath, \"utf8\");\n  const { fields, body } = splitFrontmatter(raw);\n  const type = fields.type ?? \"\";\n  return {\n    relPath: path.relative(root, filePath).split(path.sep).join(\"/\"),\n    category: CATEGORY_BY_TYPE[type] ?? \"fact\",\n    content: body.trim(),\n    ...(fields.id ? { sourceId: fields.id } : {}),\n    ...(fields.timestamp ?? fields.updated ?? fields.created\n      ? { sourceTimestamp: fields.timestamp ?? fields.updated ?? fields.created }\n      : {}),\n  };\n}\n\nfunction splitFrontmatter(text: string): { fields: Record<string, string>; body: string } {\n  if (!text.startsWith(\"---\\n\") && !text.startsWith(\"---\\r\\n\")) {\n    return { fields: {}, body: text };\n  }\n  const end = text.indexOf(\"\\n---\", 4);\n  if (end < 0) return { fields: {}, body: text };\n  const raw = text.slice(4, end);\n  const body = text.slice(end + 4).replace(/^\\r?\\n/, \"\");\n  const fields: Record<string, string> = {};\n  for (const line of raw.split(/\\r?\\n/)) {\n    const match = line.match(/^([A-Za-z0-9_-]+):\\s*(.*)$/);\n    if (!match) continue;\n    fields[match[1]] = match[2].replace(/^[\"']|[\"']$/g, \"\").trim();\n  }\n  return { fields, body };\n}\n"],"mappings":";;;AAOA,SAAS,0CAA0C;;;ACPnD,SAAS,aAAa,cAAc,gBAAgB;AACpD,OAAO,UAAU;AAEjB,IAAM,WAAW,oBAAI,IAAI,CAAC,YAAY,QAAQ,CAAC;AAE/C,IAAM,mBAA2C;AAAA,EAC/C,eAAe;AAAA,EACf,UAAU;AAAA,EACV,YAAY;AAAA,EACZ,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,WAAW;AAAA,EACX,QAAQ;AAAA,EACR,OAAO;AAAA,EACP,YAAY;AAAA,EACZ,MAAM;AACR;AAeO,SAAS,eAAe,OAAiC;AAC9D,MAAI,OAAO,UAAU,YAAY,MAAM,KAAK,MAAM,IAAI;AACpD,UAAM,IAAI,MAAM,sCAAsC;AAAA,EACxD;AACA,QAAM,OAAO,KAAK,QAAQ,MAAM,KAAK,CAAC;AACtC,MAAI,wBAAwB,KAAK,IAAI,GAAG;AACtC,UAAM,IAAI,MAAM,oDAAoD,IAAI,GAAG;AAAA,EAC7E;AACA,MAAI;AACJ,MAAI;AACF,WAAO,SAAS,IAAI;AAAA,EACtB,QAAQ;AACN,UAAM,IAAI,MAAM,yBAAyB,IAAI,EAAE;AAAA,EACjD;AACA,MAAI,CAAC,KAAK,YAAY,GAAG;AACvB,UAAM,IAAI,MAAM,gDAAgD,IAAI,EAAE;AAAA,EACxE;AACA,QAAM,YAAiC,CAAC;AACxC,OAAK,MAAM,MAAM,SAAS;AAC1B,YAAU,KAAK,CAAC,GAAG,MAAM,EAAE,QAAQ,cAAc,EAAE,OAAO,CAAC;AAC3D,SAAO,EAAE,MAAM,UAAU;AAC3B;AAEA,SAAS,KAAK,MAAc,KAAa,KAAgC;AACvE,QAAM,UAAU,YAAY,KAAK,EAAE,eAAe,KAAK,CAAC,EAAE;AAAA,IAAK,CAAC,GAAG,MACjE,EAAE,KAAK,cAAc,EAAE,IAAI;AAAA,EAC7B;AACA,aAAW,SAAS,SAAS;AAC3B,UAAM,OAAO,KAAK,KAAK,KAAK,MAAM,IAAI;AACtC,QAAI,MAAM,YAAY,GAAG;AACvB,WAAK,MAAM,MAAM,GAAG;AACpB;AAAA,IACF;AACA,QAAI,CAAC,MAAM,OAAO,KAAK,CAAC,MAAM,KAAK,SAAS,KAAK,EAAG;AACpD,QAAI,SAAS,IAAI,MAAM,IAAI,EAAG;AAC9B,QAAI,KAAK,cAAc,MAAM,IAAI,CAAC;AAAA,EACpC;AACF;AAEA,SAAS,cAAc,MAAc,UAAqC;AACxE,QAAM,MAAM,aAAa,UAAU,MAAM;AACzC,QAAM,EAAE,QAAQ,KAAK,IAAI,iBAAiB,GAAG;AAC7C,QAAM,OAAO,OAAO,QAAQ;AAC5B,SAAO;AAAA,IACL,SAAS,KAAK,SAAS,MAAM,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,KAAK,GAAG;AAAA,IAC/D,UAAU,iBAAiB,IAAI,KAAK;AAAA,IACpC,SAAS,KAAK,KAAK;AAAA,IACnB,GAAI,OAAO,KAAK,EAAE,UAAU,OAAO,GAAG,IAAI,CAAC;AAAA,IAC3C,GAAI,OAAO,aAAa,OAAO,WAAW,OAAO,UAC7C,EAAE,iBAAiB,OAAO,aAAa,OAAO,WAAW,OAAO,QAAQ,IACxE,CAAC;AAAA,EACP;AACF;AAEA,SAAS,iBAAiB,MAAgE;AACxF,MAAI,CAAC,KAAK,WAAW,OAAO,KAAK,CAAC,KAAK,WAAW,SAAS,GAAG;AAC5D,WAAO,EAAE,QAAQ,CAAC,GAAG,MAAM,KAAK;AAAA,EAClC;AACA,QAAM,MAAM,KAAK,QAAQ,SAAS,CAAC;AACnC,MAAI,MAAM,EAAG,QAAO,EAAE,QAAQ,CAAC,GAAG,MAAM,KAAK;AAC7C,QAAM,MAAM,KAAK,MAAM,GAAG,GAAG;AAC7B,QAAM,OAAO,KAAK,MAAM,MAAM,CAAC,EAAE,QAAQ,UAAU,EAAE;AACrD,QAAM,SAAiC,CAAC;AACxC,aAAW,QAAQ,IAAI,MAAM,OAAO,GAAG;AACrC,UAAM,QAAQ,KAAK,MAAM,4BAA4B;AACrD,QAAI,CAAC,MAAO;AACZ,WAAO,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,EAAE,QAAQ,gBAAgB,EAAE,EAAE,KAAK;AAAA,EAC/D;AACA,SAAO,EAAE,QAAQ,KAAK;AACxB;;;ADzFO,IAAM,mBAAmB;AAEzB,IAAM,UAA4C;AAAA,EACvD,MAAM;AAAA,EACN,aAAa;AAAA,EAEb,MAAM,OAAgB,SAAiD;AACrE,WAAO,eAAe,OAAO,UAAU,WAAW,QAAQ,SAAS,QAAQ;AAAA,EAC7E;AAAA,EAEA,UAAU,QAA2C;AACnD,WAAO,OAAO,UACX,OAAO,CAAC,QAAQ,IAAI,QAAQ,SAAS,CAAC,EACtC,IAAI,CAAC,SAAS;AAAA,MACb,SAAS,IAAI;AAAA,MACb,aAAa;AAAA,MACb,kBAAkB,GAAG,OAAO,IAAI,IAAI,IAAI,OAAO;AAAA,MAC/C,UAAU,EAAE,UAAU,IAAI,UAAU,SAAS,IAAI,QAAQ;AAAA,MACzD,GAAI,IAAI,WAAW,EAAE,UAAU,IAAI,SAAS,IAAI,CAAC;AAAA,MACjD,GAAI,IAAI,kBAAkB,EAAE,iBAAiB,IAAI,gBAAgB,IAAI,CAAC;AAAA,IACxE,EAAE;AAAA,EACN;AAAA,EAEA,MAAM,QACJ,QACA,UAC8B;AAC9B,WAAO,mCAAmC,QAAQ,QAAQ;AAAA,EAC5D;AACF;AAEO,IAAM,aAAa;","names":[]}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@remnic/import-okf",
+  "version": "9.69.64",
+  "description": "Import an OKF v0.1 knowledge bundle into Remnic memories",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "peerDependencies": {
+    "@remnic/core": "^9.69.64"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.7.0",
+    "@remnic/core": "9.69.64"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joshuaswarren/remnic.git",
+    "directory": "packages/import-okf"
+  },
+  "keywords": [
+    "remnic",
+    "memory",
+    "okf",
+    "import"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts",
+    "precheck-types": "node ../../scripts/ensure-bench-build-deps.mjs",
+    "check-types": "tsc --noEmit",
+    "test": "NODE_OPTIONS=\"${NODE_OPTIONS:+$NODE_OPTIONS }--conditions=remnic-source\" tsx --test src/adapter.test.ts src/parser.test.ts"
+  }
+}