@noy-db/core 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,56 @@
+# @noy-db/core
+
+> Zero-knowledge, offline-first, encrypted document store — core library.
+
+[![npm](https://img.shields.io/npm/v/@noy-db/core.svg)](https://www.npmjs.com/package/@noy-db/core)
+[![license](https://img.shields.io/npm/l/@noy-db/core.svg)](https://github.com/vLannaAi/noy-db/blob/main/LICENSE)
+
+Part of [**noy-db**](https://github.com/vLannaAi/noy-db) — *"None Of Your Damn Business"*.
+
+## Install
+
+```bash
+pnpm add @noy-db/core @noy-db/memory
+```
+
+You need `@noy-db/core` plus at least one adapter: [`@noy-db/memory`](https://npmjs.com/package/@noy-db/memory), [`@noy-db/file`](https://npmjs.com/package/@noy-db/file), [`@noy-db/browser`](https://npmjs.com/package/@noy-db/browser), [`@noy-db/dynamo`](https://npmjs.com/package/@noy-db/dynamo), [`@noy-db/s3`](https://npmjs.com/package/@noy-db/s3).
+
+## Quick start
+
+```ts
+import { createNoydb } from '@noy-db/core'
+import { memory } from '@noy-db/memory'
+
+type Invoice = { id: string; amount: number; customer: string }
+
+const db = await createNoydb({
+  adapter: memory(),
+  userId: 'alice',
+  passphrase: 'correct horse battery staple',
+})
+
+const c101 = await db.openCompartment('C101')
+const invoices = c101.collection<Invoice>('invoices')
+
+await invoices.put('INV-001', { id: 'INV-001', amount: 8500, customer: 'ABC Trading' })
+const all = await invoices.list()
+```
+
+## What it does
+
+- **Zero-knowledge encryption** — AES-256-GCM + PBKDF2 (600K iterations) + AES-KW, all via Web Crypto API
+- **Per-collection keys** — one DEK per collection, wrapped with a per-user KEK
+- **Multi-user access control** — owner, admin, operator, viewer, client roles
+- **Offline-first sync** — push/pull with optimistic concurrency on encrypted envelopes
+- **Audit history** — full-copy snapshots with `history()`, `diff()`, `revert()`, `pruneHistory()`
+- **Zero runtime dependencies**
+
+## Documentation
+
+- Full docs: https://github.com/vLannaAi/noy-db#readme
+- Spec: https://github.com/vLannaAi/noy-db/blob/main/NOYDB_SPEC.md
+- AI reference: https://github.com/vLannaAi/noy-db/blob/main/docs/NOYDB_FOR_AI.md
+
+## License
+
+MIT © vLannaAi

package/dist/index.cjs

@@ -54,24 +54,6 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/env-check.ts
-function checkEnvironment() {
-  if (typeof process !== "undefined" && process.versions?.node) {
-    const major = parseInt(process.versions.node.split(".")[0], 10);
-    if (major < 18) {
-      throw new Error(
-        `@noy-db/core requires Node.js 18 or later (found ${process.versions.node}). Node.js 18+ is required for the Web Crypto API (crypto.subtle).`
-      );
-    }
-  }
-  if (typeof globalThis.crypto?.subtle === "undefined") {
-    throw new Error(
-      "@noy-db/core requires the Web Crypto API (crypto.subtle). Ensure you are running Node.js 18+ or a modern browser (Chrome 63+, Firefox 57+, Safari 13+)."
-    );
-  }
-}
-checkEnvironment();
-
 // src/types.ts
 var NOYDB_FORMAT_VERSION = 1;
 var NOYDB_KEYRING_VERSION = 1;