keri-ts 0.2.1 → 0.2.3

package/README.md

@@ -1,150 +1,25 @@
-# keri-ts : KERI TypeScript Library
+# keri-ts
 
-An aspiring full implementation of the KERI, ACDC, CESR, and PTEL specifications
-in TypeScript.
+KERI TypeScript runtime package with the `tufa` CLI and foundational
+database/runtime modules.
 
-### Usage
+## Install
 
 ```bash
-# Run the CLI
-deno task tufa --help
-
-# Initialize a keystore
-deno task tufa init --name mykeystore
-
-# Get help for specific commands
-deno task tufa init --help
-
-# Show CLI version
-deno task tufa version
-deno task tufa --version
-
-# Annotate a CESR file
-deno task tufa annotate --in samples/cesr-streams/CESR_1_0-oor-auth-vc.cesr
-
-# Annotate CESR from stdin
-cat samples/cesr-streams/CESR_1_0-oor-auth-vc.cesr | deno task tufa annotate
-```
-
-### Install CLI (`tufa`)
-
-```bash
-# npm (global)
-npm install -g keri-ts
-tufa --help
-
-# Deno (global)
-deno install --global --allow-all --unstable-ffi --name tufa mod.ts
-tufa --help
-
-# make sure to add the Deno bin path to your PATH var
-export PATH="$HOME/.deno/bin:$PATH"
-```
-
-### Features
-
-- TODO Fully integrates with KERIpy, KERIA, and SignifyTS, both CESR 1.0 and
-  CESR 2.0
-- TODO Creates and manages keystores
-- TODO Parses and packs CESR streams
-- ✅ Provides CLI for interaction with KERI keystores (basic implementation)
-- TODO Provides a mailbox agent, controller agent, direct mode, and indirect
-  mode agents.
-- TODO Creates, Issues, and Verifies ACDC credentials.
-- TODO Provides a JSON Schema server to host ACDC schemas.
-
-### Importing library
-
-TBD
-
-### Build scripts (Deno)
-
-```bash
-# Run CLI commands
-deno task tufa init --name test
-
-# Start server (legacy)
-deno task start
-```
-
-### Versioning and Releases
-
-- `keri-ts` and `cesr-ts` are versioned independently with Changesets.
-- Runtime CLI version strings are generated from package manifest versions.
-- CI builds automatically append build metadata to CLI display versions.
-
-```bash
-# Add a patch/minor/major release intent file
-deno task release:changeset
-
-# Apply version bumps/changelog updates from pending changesets
-deno task release:version
-
-# Regenerate and verify runtime version modules
-deno task version:generate
-deno task version:check
+npm install keri-ts
 ```
 
-### LMDB v1 Format Requirement
-
-**KERIpy Compatibility**: This project requires LMDB data format v1 for
-interoperability with KERIpy databases. The `lmdb-js` package defaults to LMDB
-v2 format, using v0.9.90 of LMDB, which is incompatible with databases created
-by KERIpy (which uses `py-lmdb` with LMDB 0.9.33).
-
-**Rebuilding lmdb with v1 support**:
-
-After installing dependencies, rebuild the `lmdb` package with v1 data format
-support:
+## CLI
 
 ```bash
-cd node_modules/lmdb
-export LMDB_DATA_V1=true
-npm run recompile
-cd ../..
+npx tufa --help
+npx tufa version
 ```
 
-**When to rebuild**:
-
-- After initial `npm install`
-- After updating the `lmdb` package
-- If you encounter `malloc` errors or database format incompatibility errors
-  when opening KERIpy-created databases
-
-The `malloc` error looks like the following:
+## Deno tasks (package-local)
 
 ```bash
-node(42074,0x1f6bde0c0) malloc: *** error for object 0x3c7e805c00e0: pointer being freed was not allocated
-node(42074,0x1f6bde0c0) malloc: *** set a breakpoint in malloc_error_break to debug
-```
-
-**Note**: The v1 format uses LMDB 0.9.29 (via `lmdb-data-v1`), which is
-compatible with KERIpy's LMDB 0.9.33. Some newer LMDB features (encryption,
-remapping) are not available with v1 format.
-
-## Development Notes
-
-### Deno install locally
-
-`tufa` will show a few warnings locally unless you install it with the
-`--allow-scripts` option like below:
-
-```zsh
-deno install --global \
-  --config /Users/kbull/code/keri/kentbull/keri-ts/deno.json \
-  --node-modules-dir=auto \
-  --allow-scripts=npm:lmdb,npm:msgpackr-extract \
-  --allow-all \
-  --unstable-ffi \
-  --name tufa \
-  /Users/kbull/code/keri/kentbull/keri-ts/mod.ts
-```
-
-This is because of how Deno blocks build/install scripts for installed
-dependencies unless explicitly allowed.
-
-You may need to warm dependencies once with the following command:
-
-```zsh
-deno install --node-modules-dir=auto --allow-scripts=npm:lmdb,npm:msgpackr-extract
+deno task tufa --help
+deno task test:quality
+deno task build:npm
 ```

package/esm/app/cli/annotate.js

@@ -1,6 +1,6 @@
 import * as dntShim from "../../_dnt.shims.js";
-import { spawnSync } from "node:child_process";
-import { AppError } from "../../core/errors.js";
+import { annotate } from "cesr-ts";
+const TEXT_DECODER = new TextDecoder();
 function readAllStdinSync() {
     const chunks = [];
     let total = 0;
@@ -22,80 +22,6 @@ function readAllStdinSync() {
     }
     return output;
 }
-function buildDenoAnnotateArgs(options) {
-    const args = [
-        "run",
-        "--allow-read",
-        "--allow-write",
-        "packages/cesr/src/annotate/cli-deno.ts",
-        "--in",
-        options.inPath,
-    ];
-    if (options.outPath) {
-        args.push("--out", options.outPath);
-    }
-    if (options.qb2) {
-        args.push("--qb2");
-    }
-    if (options.pretty) {
-        args.push("--pretty");
-    }
-    return args;
-}
-function buildNodeAnnotateArgs(options) {
-    const nodeScript = [
-        "import { annotate } from 'cesr-ts';",
-        "import fs from 'node:fs';",
-        "const [inPath, outPath, qb2, pretty] = process.argv.slice(1);",
-        "const input = fs.readFileSync(inPath);",
-        "const output = qb2 === '1'",
-        "  ? annotate(new Uint8Array(input), { domainHint: 'bny', pretty: pretty === '1' })",
-        "  : annotate(input.toString('utf8'), { domainHint: 'txt', pretty: pretty === '1' });",
-        "if (outPath) {",
-        "  fs.writeFileSync(outPath, output, 'utf8');",
-        "} else {",
-        "  process.stdout.write(output + '\\n');",
-        "}",
-    ].join("\n");
-    return [
-        "--input-type=module",
-        "--eval",
-        nodeScript,
-        options.inPath,
-        options.outPath ?? "",
-        options.qb2 ? "1" : "0",
-        options.pretty ? "1" : "0",
-    ];
-}
-function forwardChildOutput(output) {
-    if (output.stdout.length > 0) {
-        dntShim.Deno.stdout.writeSync(output.stdout);
-    }
-    if (output.stderr.length > 0) {
-        dntShim.Deno.stderr.writeSync(output.stderr);
-    }
-}
-function runDenoAnnotator(options) {
-    const child = new dntShim.Deno.Command(dntShim.Deno.execPath(), {
-        args: buildDenoAnnotateArgs(options),
-        stdout: "piped",
-        stderr: "piped",
-    });
-    return child.outputSync();
-}
-function runNodeAnnotator(options) {
-    const maybeProcess = dntShim.dntGlobalThis;
-    const executable = maybeProcess.process?.execPath || "node";
-    const output = spawnSync(executable, buildNodeAnnotateArgs(options), {
-        stdio: "pipe",
-    });
-    return {
-        success: output.status === 0,
-        code: output.status ?? 1,
-        stdout: output.stdout ? new Uint8Array(output.stdout) : new Uint8Array(),
-        stderr: output.stderr ? new Uint8Array(output.stderr) : new Uint8Array(),
-    };
-}
 // deno-lint-ignore require-yield
 export function* annotateCommand(args) {
     const options = {
@@ -104,40 +30,18 @@ export function* annotateCommand(args) {
         qb2: args.qb2,
         pretty: args.pretty,
     };
-    let tempInPath;
-    if (!options.inPath) {
-        tempInPath = dntShim.Deno.makeTempFileSync({ suffix: ".cesr" });
-        dntShim.Deno.writeFileSync(tempInPath, readAllStdinSync());
-        options.inPath = tempInPath;
-    }
-    try {
-        let output;
-        try {
-            output = runDenoAnnotator(options);
-        }
-        catch (error) {
-            const isDenoMissing = error instanceof Error &&
-                (error.message.includes("not found: deno") ||
-                    (typeof error.code === "string" &&
-                        error.code === "ENOENT"));
-            if (!isDenoMissing) {
-                throw error;
-            }
-            output = runNodeAnnotator(options);
-        }
-        forwardChildOutput(output);
-        if (!output.success) {
-            throw new AppError(`annotate command failed with exit code ${output.code}`);
-        }
-    }
-    finally {
-        if (tempInPath) {
-            try {
-                dntShim.Deno.removeSync(tempInPath);
-            }
-            catch {
-                // best-effort cleanup
-            }
-        }
+    const inputBytes = options.inPath
+        ? dntShim.Deno.readFileSync(options.inPath)
+        : readAllStdinSync();
+    const annotated = options.qb2
+        ? annotate(inputBytes, { domainHint: "bny", pretty: options.pretty })
+        : annotate(TEXT_DECODER.decode(inputBytes), {
+            domainHint: "txt",
+            pretty: options.pretty,
+        });
+    if (options.outPath) {
+        dntShim.Deno.writeTextFileSync(options.outPath, annotated);
+        return;
     }
+    console.log(annotated);
 }

package/esm/app/cli/index.js

@@ -0,0 +1,7 @@
+/**
+ * CLI module - public API
+ *
+ * This module provides the KERI TypeScript CLI interface.
+ */
+export { tufa } from "./cli.js";
+export { initCommand } from "./init.js";

package/esm/app/index.js

@@ -0,0 +1,7 @@
+/**
+ * Application module - public API
+ *
+ * This module provides application-level functionality including CLI and server.
+ */
+export * from "./cli/index.js";
+export { startServer } from "./server.js";

package/esm/app/version.js

@@ -2,8 +2,8 @@
  * Generated by scripts/generate_versions.ts.
  * Do not edit by hand.
  */
-export const PACKAGE_VERSION = "0.2.1";
-export const BUILD_METADATA = "";
+export const PACKAGE_VERSION = "0.2.3";
+export const BUILD_METADATA = "build.2.ae619744";
 export const DISPLAY_VERSION = BUILD_METADATA
     ? `${PACKAGE_VERSION}+${BUILD_METADATA}`
     : PACKAGE_VERSION;

package/esm/npm/index.js

@@ -1,5 +1,10 @@
+/**
+ * npm package root entrypoint.
+ *
+ * Keep this file stable because build_npm.ts and package export paths
+ * are wired to ./src/npm/index.ts -> ./esm/npm/index.js.
+ */
 import "../_dnt.polyfills.js";
 export * from "../core/index.js";
 export * from "../db/index.js";
-export { tufa } from "../app/cli/cli.js";
-export * from "../app/version.js";
+export * from "../app/index.js";

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "keri-ts",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "KERI TypeScript package with database primitives and CLI runtime",
   "homepage": "https://github.com/kentbull/keri-ts",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/kentbull/keri-ts.git"
+    "url": "git+https://github.com/kentbull/keri-ts.git",
+    "directory": "packages/keri"
   },
   "license": "Apache-2.0",
   "bugs": {
@@ -45,11 +46,11 @@
     "node": ">=18"
   },
   "dependencies": {
+    "cesr-ts": ">=0.2.0 <0.3.0",
     "commander": "^10.0.1",
     "effection": "^3.6.0",
     "lmdb": "^3.4.4",
-    "@deno/shim-deno": "~0.18.0",
-    "cesr-ts": ">=0.2.0 <0.3.0"
+    "@deno/shim-deno": "~0.18.0"
   },
   "devDependencies": {
     "@types/node": "^20.9.0"

package/types/app/cli/annotate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"annotate.d.ts","sourceRoot":"","sources":["../../../src/app/cli/annotate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AAkI3C,wBAAiB,eAAe,CAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,SAAS,CAAC,IAAI,CAAC,CA+CjB"}
+{"version":3,"file":"annotate.d.ts","sourceRoot":"","sources":["../../../src/app/cli/annotate.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AAsC3C,wBAAiB,eAAe,CAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,SAAS,CAAC,IAAI,CAAC,CAyBjB"}

package/types/app/cli/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CLI module - public API
+ *
+ * This module provides the KERI TypeScript CLI interface.
+ */
+export { tufa } from "./cli.js";
+export { initCommand } from "./init.js";
+//# sourceMappingURL=index.d.ts.map

package/types/app/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/app/cli/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC"}

package/types/app/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Application module - public API
+ *
+ * This module provides application-level functionality including CLI and server.
+ */
+export * from "./cli/index.js";
+export { startServer } from "./server.js";
+//# sourceMappingURL=index.d.ts.map

package/types/app/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/app/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC"}

package/types/app/version.d.ts

@@ -2,7 +2,7 @@
  * Generated by scripts/generate_versions.ts.
  * Do not edit by hand.
  */
-export declare const PACKAGE_VERSION = "0.2.1";
-export declare const BUILD_METADATA = "";
+export declare const PACKAGE_VERSION = "0.2.3";
+export declare const BUILD_METADATA = "build.2.ae619744";
 export declare const DISPLAY_VERSION: string;
 //# sourceMappingURL=version.d.ts.map

package/types/app/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/app/version.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,eAAe,UAAU,CAAC;AACvC,eAAO,MAAM,cAAc,KAAK,CAAC;AACjC,eAAO,MAAM,eAAe,QAET,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/app/version.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,eAAe,UAAU,CAAC;AACvC,eAAO,MAAM,cAAc,qBAAqB,CAAC;AACjD,eAAO,MAAM,eAAe,QAET,CAAC"}

package/types/npm/index.d.ts

@@ -1,6 +1,11 @@
+/**
+ * npm package root entrypoint.
+ *
+ * Keep this file stable because build_npm.ts and package export paths
+ * are wired to ./src/npm/index.ts -> ./esm/npm/index.js.
+ */
 import "../_dnt.polyfills.js";
 export * from "../core/index.js";
 export * from "../db/index.js";
-export { tufa } from "../app/cli/cli.js";
-export * from "../app/version.js";
+export * from "../app/index.js";
 //# sourceMappingURL=index.d.ts.map

package/types/npm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/npm/index.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/npm/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,sBAAsB,CAAC;AAE9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC"}