udsl-sdk 1.0.0 → 1.0.4

package/README.md

@@ -0,0 +1,218 @@
+# UDSL SDK
+
+Crash-Safe Data Recovery SDK for JavaScript and TypeScript applications.
+
+UDSL (Universal Data Safety Layer) helps applications prevent data loss by using Write-Ahead Logging (WAL), Snapshots, Recovery, Version History, and Rollback mechanisms.
+
+## Why UDSL?
+
+Applications can lose user data because of:
+
+* Application crashes
+* Power failures
+* Unexpected shutdowns
+* Network interruptions
+* Software bugs
+
+UDSL provides a recovery layer that ensures user data can be restored even after failures.
+
+---
+
+## Features
+
+* Write-Ahead Logging (WAL)
+* Snapshot-based recovery
+* Crash recovery
+* Version history
+* Rollback support
+* Multi-tenant architecture
+* API key authentication
+* Offline-first support
+* TypeScript support
+
+---
+
+## Installation
+
+```bash
+npm install udsl-sdk
+```
+
+---
+
+## Initialization
+
+```typescript
+import { UDSL } from "udsl-sdk";
+
+UDSL.init({
+  baseUrl: "http://localhost:3001",
+  apiKey: "your-api-key"
+});
+```
+
+---
+
+## Save Data
+
+```typescript
+await UDSL.save("doc1", {
+  title: "Project Notes",
+  content: "Building a crash-safe recovery system"
+});
+```
+
+---
+
+## Read Data
+
+```typescript
+const data = await UDSL.get("doc1");
+
+console.log(data);
+```
+
+---
+
+## View History
+
+```typescript
+const history = await UDSL.history("doc1");
+
+console.log(history);
+```
+
+---
+
+## Rollback
+
+```typescript
+await UDSL.rollback("doc1", 1);
+```
+
+This restores the document to version 1.
+
+---
+
+## How It Works
+
+### Step 1
+
+Application writes data.
+
+```text
+Application
+     ↓
+UDSL SDK
+```
+
+### Step 2
+
+SDK sends data to the recovery engine.
+
+```text
+SDK
+ ↓
+Recovery Server
+```
+
+### Step 3
+
+Server writes to WAL before acknowledging.
+
+```text
+Request
+  ↓
+WAL
+  ↓
+Snapshot
+```
+
+### Step 4
+
+If a crash occurs, recovery rebuilds the latest state.
+
+```text
+Snapshot
+    +
+WAL Replay
+    ↓
+Recovered State
+```
+
+---
+
+## Architecture
+
+```text
+Application
+    ↓
+UDSL SDK
+    ↓
+Recovery API
+    ↓
+WAL
+Snapshot
+History
+Rollback
+```
+
+---
+
+## Example Use Cases
+
+### Notes Applications
+
+Recover user notes after crashes.
+
+### Form Builders
+
+Prevent loss of partially completed forms.
+
+### Code Editors
+
+Restore unsaved work automatically.
+
+### Enterprise Applications
+
+Maintain audit trails and recovery history.
+
+### SaaS Platforms
+
+Provide reliable data recovery for customers.
+
+---
+
+## Security
+
+* API Key Authentication
+* Tenant Isolation
+* Crash-Safe Writes
+* Recovery Validation
+
+---
+
+## Roadmap
+
+* Local Offline Queue
+* Background Sync Engine
+* Data Encryption
+* Cloud Dashboard
+* Analytics
+* Mobile SDK
+* React SDK
+* Automatic Backup System
+
+---
+
+## License
+
+MIT License
+
+---
+
+## Author
+
+Om Ghadage
+
+Building reliable systems that help applications recover data after failures.

package/cli/index.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+const { start } = require("./installer");
+
+const command = process.argv[2];
+
+if (command === "start") {
+  start();
+} else {
+  console.log("Usage: npx udsl start");
+}

package/cli/installer.js

@@ -0,0 +1,42 @@
+const { execSync } = require("child_process");
+
+function run(cmd) {
+  return execSync(cmd, { stdio: "inherit" });
+}
+
+function start() {
+  console.log("🚀 Starting UDSL...");
+
+  // STEP 1: Check Docker
+  try {
+    run("docker --version");
+  } catch (e) {
+    console.log("❌ Docker is not installed");
+    process.exit(1);
+  }
+
+  // STEP 2: Pull or build image
+  try {
+    console.log("📦 Pulling UDSL image...");
+    run("docker pull udsl-server");
+  } catch (e) {
+    console.log("⚠️ Image not found. Building locally...");
+    run("docker build -t udsl-server .");
+  }
+
+  // STEP 3: Stop old container if exists
+  try {
+    run("docker stop udsl-server");
+    run("docker rm udsl-server");
+  } catch (e) {}
+
+  // STEP 4: Run container
+  console.log("🔥 Starting server...");
+  run(
+    "docker run -d -p 3001:3001 --name udsl-server udsl-server"
+  );
+
+  console.log("✅ UDSL running at http://localhost:3001");
+}
+
+module.exports = { start };

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "udsl-sdk",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "Crash-safe data recovery SDK (WAL + Snapshot based)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "cli"
   ],
+  "bin": {
+    "udsl": "./cli/index.js"
+  },
   "scripts": {
     "build": "tsc",
     "prepublishOnly": "npm run build"
@@ -24,4 +28,4 @@
   "devDependencies": {
     "typescript": "^6.0.3"
   }
-}
+}