@interncom/diplomatic 0.1.2 → 0.2.0-rc1

package/README.md

@@ -1,46 +1,73 @@
-# diplomatic
-
-Secure sync layer for web apps.
-
-## Usage
-
-```tsx
-import {
-  DiplomaticClient,
-  localStorageStore,
-  StateManager,
-  useStateWatcher,
-} from "@interncom/diplomatic";
-
-const appState = { count: 0 };
-const stateMgr = new StateManager(async (op) => {
-  if (op.type === "count" && typeof op.body === "number") {
-    appState.count = op.body;
-  }
-});
-
-const client = new DiplomaticClient({
-  seed: "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
-  hostURL: "https://diplomatic-cloudflare-host.root-a00.workers.dev",
-  stateManager: stateMgr,
-  store: localStorageStore,
-});
-
-export default function App() {
-  const count = useStateWatcher(stateMgr, "count", () => appState.count);
-  const inc = () => client.upsert("count", count + 1);
-
-  return (
-    <div style={{ width: "100vw", textAlign: "center" }}>
-      <h1>COUNT</h1>
-      <h2>{count}</h2>
-      <button onClick={inc}>+1</button>
-    </div>
-  );
+# @interncom/diplomatic Package
+
+This directory manages the build and packaging of the `@interncom/diplomatic` NPM module, which provides secure sync layer and CLI utilities for the DIPLOMATIC protocol.
+
+## Overview
+
+The `@interncom/diplomatic` package exposes both web (browser) and CLI (Node.js) components from the monorepo:
+
+- **Web components**: React hooks, client APIs, and storage utilities for browser-based applications
+- **CLI components**: Command-line tools and host server for Node.js environments
+
+## Building the NPM Module
+
+First, install dependencies:
+
+```bash
+bun install
+```
+
+To clean previous builds:
+
+```bash
+bun run clean
+```
+
+Then run the build script to generate the distribution bundles:
+
+```bash
+bun run build
+```
+
+This command:
+1. Builds the web bundle (`dist/web/index.mjs`) from `../web/src/index.ts`
+2. Builds the CLI bundle (`dist/cli/index.mjs`) from `../web/src/cli/index.ts` (with external dependencies like `libsodium-wrappers`)
+3. Generates the CLI binary (`dist/cli/bin/host.js`) for the `diplomatic-host` command
+
+Note: The CLI bundle uses external dependencies that must be installed and available at runtime.
+
+## Package Exports
+
+The package uses conditional exports for environment-specific loading:
+
+```json
+{
+  ".": {
+    "browser": "./dist/web/index.mjs",
+    "node": "./dist/cli/index.mjs"
+  },
+  "./web": "./dist/web/index.mjs",
+  "./cli": "./dist/cli/index.mjs"
 }
 ```
 
-## Development
+- **Browser environments**: Automatically loads web components
+- **Node.js environments**: Automatically loads CLI components
+- **Explicit imports**: Use `./web` or `./cli` subpaths for specific components
+
+## Dependencies
+
+This package pulls source code from:
+- `../shared/`: Common TypeScript utilities
+- `../web/`: Web client source
+- `../bun/`: Additional utilities (via symlinks in `../web/src/`)
+
+## Publishing
+
+To publish the package:
+
+```bash
+npm publish
+```
 
-To deploy npm package, from the `web` dir, run:
-`npm run build && npm run tsc && npm publish --public`.
+The package is configured for public access with scoped name `@interncom/diplomatic`.

package/dist/cli/bin/host.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+import { runBunHost } from '../index.mjs';
+
+const port = process.argv[2] ? Number.parseInt(process.argv[2]) : undefined;
+runBunHost(port);

package/dist/cli/bun/src/codec.d.ts

@@ -0,0 +1,3 @@
+import type { IMsgpackCodec } from "../../shared/types.ts";
+declare const bunMsgpack: IMsgpackCodec;
+export default bunMsgpack;

package/dist/cli/bun/src/crypto.d.ts

@@ -0,0 +1,3 @@
+import { NobleCrypto } from "../../shared/crypto/noble.ts";
+declare const crypto: NobleCrypto;
+export default crypto;

package/dist/cli/bun/src/host.d.ts

@@ -0,0 +1 @@
+export declare function runBunHost(port?: number): Promise<void>;

package/dist/cli/bun/src/storage/sqlite.d.ts

@@ -0,0 +1,3 @@
+import type { IStorage } from "../../../shared/types.ts";
+declare const sqliteStorage: IStorage;
+export default sqliteStorage;