dynamodb-reactive 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024
+
+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/README.md

@@ -0,0 +1,174 @@
+# **dynamodb-reactive**
+
+**Tagline:** A Serverless, Reactive tRPC replacement for AWS - unified package.
+
+## **1. Overview**
+
+`dynamodb-reactive` provides type-safe, real-time DynamoDB subscriptions with automatic JSON Patch diffing over WebSockets.
+
+**Key Features:**
+
+* **Full TypeScript Support:** End-to-end type safety from schema definition to React hooks.
+
+## **2. Installation**
+
+```bash
+npm install dynamodb-reactive zod
+# or
+pnpm add dynamodb-reactive zod
+```
+
+**Peer Dependencies (install as needed):**
+
+| Dependency | Required For |
+| :--- | :--- |
+| `zod` | Schema definitions (required) |
+| `react` | React hooks |
+| `aws-cdk-lib` | Infrastructure |
+| `constructs` | Infrastructure |
+
+## **3. Package Exports**
+
+| Import Path | Purpose |
+| :--- | :--- |
+| `dynamodb-reactive` | Core exports (DynamoTable, schemas) |
+| `dynamodb-reactive/core` | Core table definitions |
+| `dynamodb-reactive/server` | Server runtime (Router, handlers) |
+| `dynamodb-reactive/client` | Frontend client |
+| `dynamodb-reactive/react` | React hooks |
+| `dynamodb-reactive/infra` | CDK constructs |
+
+## **4. Quick Start**
+
+### **Step 1: Define Your Schema**
+
+```typescript
+import { z } from 'zod';
+import { DynamoTable } from 'dynamodb-reactive/core';
+
+export const TodoTable = new DynamoTable({
+  tableName: 'my-table',
+  schema: z.object({
+    PK: z.string(),
+    SK: z.string(),
+    id: z.string(),
+    text: z.string(),
+    completed: z.boolean(),
+    createdAt: z.number(),
+  }),
+  pk: 'PK',
+  sk: 'SK',
+});
+```
+
+### **Step 2: Create the Router**
+
+```typescript
+import { z } from 'zod';
+import { initReactive } from 'dynamodb-reactive/server';
+import { TodoTable } from './schema';
+
+type AppContext = Record<string, unknown>;
+const t = initReactive<AppContext>();
+
+export const appRouter = t.router({
+  todos: {
+    // Query procedure
+    list: t.procedure
+      .input(z.object({}).optional())
+      .query(async ({ ctx }) => {
+        return ctx.db
+          .query(TodoTable)
+          .filter((q) => q.eq(TodoTable.field.PK, 'TODO'))
+          .execute();
+      }),
+
+    // Mutation procedure
+    create: t.procedure
+      .input(z.object({ text: z.string() }))
+      .mutation(async ({ ctx, input }) => {
+        const item = {
+          PK: 'TODO',
+          SK: Date.now().toString(),
+          id: Date.now().toString(),
+          text: input.text,
+          completed: false,
+          createdAt: Date.now(),
+        };
+        await ctx.db.put(TodoTable, item);
+        return item;
+      }),
+  },
+});
+
+export type AppRouter = typeof appRouter;
+```
+
+### **Step 3: Create API Handler**
+
+```typescript
+import { createReactiveHandler } from 'dynamodb-reactive/server';
+import { appRouter } from './router';
+
+export const handler = createReactiveHandler({
+  router: appRouter,
+  dbConfig: { region: 'us-east-1' },
+  getContext: async () => ({}),
+});
+
+// In Next.js API route:
+export async function POST(request: Request) {
+  const body = await request.json();
+  const response = await handler.handleRequest('client-id', body);
+  return Response.json(response);
+}
+```
+
+### **Step 4: Call from Client**
+
+```typescript
+// Query
+const response = await fetch('/api/reactive', {
+  method: 'POST',
+  body: JSON.stringify({
+    type: 'subscribe',
+    subscriptionId: 'sub-1',
+    path: 'todos.list',
+    input: {},
+  }),
+});
+const { data } = await response.json();
+
+// Mutation
+const response = await fetch('/api/reactive', {
+  method: 'POST',
+  body: JSON.stringify({
+    type: 'call',
+    callId: 'call-1',
+    path: 'todos.create',
+    input: { text: 'New todo' },
+  }),
+});
+const { data } = await response.json();
+```
+
+## **5. Database Context Methods**
+
+The `ctx.db` object provides these methods:
+
+| Method | Description |
+| :--- | :--- |
+| `query(table).filter(...).execute()` | Query with filters |
+| `get(table, key)` | Get single item by key |
+| `put(table, item)` | Create/replace item |
+| `update(table, key, updates)` | Update item fields |
+| `delete(table, key)` | Delete item |
+
+## **6. Requirements**
+
+* Node.js >= 18.0.0
+* TypeScript >= 5.3.0
+
+## **7. License**
+
+MIT

package/dist/client.d.ts

@@ -0,0 +1,2 @@
+export * from '@dynamodb-reactive/client';
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}

package/dist/client.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@dynamodb-reactive/client"), exports);
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C"}

package/dist/core.d.ts

@@ -0,0 +1,2 @@
+export * from '@dynamodb-reactive/core';
+//# sourceMappingURL=core.d.ts.map

package/dist/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/core.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@dynamodb-reactive/core"), exports);
+//# sourceMappingURL=core.js.map

package/dist/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from '@dynamodb-reactive/core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@dynamodb-reactive/core"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC"}

package/dist/infra.d.ts

@@ -0,0 +1,2 @@
+export * from '@dynamodb-reactive/infra';
+//# sourceMappingURL=infra.d.ts.map

package/dist/infra.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"infra.d.ts","sourceRoot":"","sources":["../src/infra.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/dist/infra.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@dynamodb-reactive/infra"), exports);
+//# sourceMappingURL=infra.js.map

package/dist/infra.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"infra.js","sourceRoot":"","sources":["../src/infra.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC"}

package/dist/react.d.ts

@@ -0,0 +1,2 @@
+export * from '@dynamodb-reactive/client/react';
+//# sourceMappingURL=react.d.ts.map

package/dist/react.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC"}

package/dist/react.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@dynamodb-reactive/client/react"), exports);
+//# sourceMappingURL=react.js.map

package/dist/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kEAAgD"}

package/dist/server.d.ts

@@ -0,0 +1,2 @@
+export * from '@dynamodb-reactive/server';
+//# sourceMappingURL=server.d.ts.map

package/dist/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC"}

package/dist/server.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@dynamodb-reactive/server"), exports);
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C"}

package/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "dynamodb-reactive",
+  "version": "0.1.0",
+  "description": "A Serverless, Reactive tRPC replacement for AWS DynamoDB",
+  "keywords": [
+    "dynamodb",
+    "reactive",
+    "realtime",
+    "websocket",
+    "aws",
+    "serverless",
+    "trpc",
+    "typescript"
+  ],
+  "license": "MIT",
+  "author": "andreigec@gmail.com",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js",
+      "default": "./dist/client.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.js",
+      "default": "./dist/react.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.js",
+      "default": "./dist/server.js"
+    },
+    "./core": {
+      "types": "./dist/core.d.ts",
+      "import": "./dist/core.js",
+      "default": "./dist/core.js"
+    },
+    "./infra": {
+      "types": "./dist/infra.d.ts",
+      "import": "./dist/infra.js",
+      "default": "./dist/infra.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.spec.*",
+    "!**/*.test.*"
+  ],
+  "dependencies": {
+    "@dynamodb-reactive/core": "0.1.0",
+    "@dynamodb-reactive/client": "0.1.0",
+    "@dynamodb-reactive/server": "0.1.0",
+    "@dynamodb-reactive/infra": "0.1.0"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.0",
+    "typescript": "^5.3.0",
+    "eslint": "8.57.1"
+  },
+  "peerDependencies": {
+    "zod": "^3.22.0",
+    "react": "^18.0.0",
+    "aws-cdk-lib": "^2.115.0",
+    "constructs": "^10.3.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "aws-cdk-lib": {
+      "optional": true
+    },
+    "constructs": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit",
+    "format": "eslint src --fix"
+  }
+}