codehooks-js 1.3.16 → 1.3.18

package/README.md

@@ -1,98 +1,130 @@
 # codehooks-js
 
-The official JavaScript/TypeScript library for [Codehooks.io](https://codehooks.io) - a serverless backend platform that provides everything you need to build and deploy backend applications.
+The official JavaScript/TypeScript library for [Codehooks.io](https://codehooks.io) - the platform for webhooks, automations, and integrations.
 
-## What is Codehooks.io?
+## Why Codehooks?
 
-Codehooks.io is a complete serverless backend platform that combines:
+Deploy production-ready webhook endpoints in under a minute. No need to assemble API Gateway, Lambda, DynamoDB, and SQS yourself.
 
-- **Database** - NoSQL document storage with MongoDB-like queries
-- **API Server** - Express.js-style routing and middleware
-- **Background Jobs** - Queues, workers, and scheduled tasks
-- **Real-time** - Server-sent events for live updates
-- **File Storage** - Static file serving and blob storage
-- **Workflows** - Step-based application logic
-
-All in one platform with zero infrastructure management.
+- **Webhook-First Design** - Built-in `rawBody` access for HMAC signature verification
+- **Reliable Processing** - Automatic retries via queues and workers
+- **All-in-One Infrastructure** - Database, key-value store, queues, and workers included
+- **Flat-Rate Pricing** - Unlimited compute, no surprise bills from webhook volume
 
 ## Quick Start
 
 Install the [Codehooks CLI](https://codehooks.io/docs/cli):
 
 ```shell
-$ npm install -g codehooks
+npm install -g codehooks
 ```
 
-Install the codehooks-js library in your project:
+Create a new project and install the library:
 
 ```shell
+codehooks create myproject
+cd myproject
 npm install codehooks-js
 ```
 
-## JavaScript ES6 development
+## Webhook Handler Example
 
-Example code for a serverless backend API and NoSQL database:
+Handle incoming webhooks with signature verification and reliable background processing:
 
 ```javascript
-/*
- * REST API with NoSQL database storage.
- * Codehooks (c) example code.
- */
-
 import { app, datastore } from 'codehooks-js';
+import crypto from 'crypto';
+
+// Webhook endpoint with HMAC signature verification
+app.post('/webhooks/incoming', async (req, res) => {
+  const signature = req.headers['x-webhook-signature'];
+  const secret = process.env.WEBHOOK_SECRET;
+
+  // Use rawBody for signature verification (preserves exact bytes)
+  const expectedSig = crypto
+    .createHmac('sha256', secret)
+    .update(req.rawBody)
+    .digest('hex');
 
-// Example GET route and a NoSQL database insert operation
-app.get('/myroute', async (req, res) => {
-  console.log('GET');
+  if (signature !== expectedSig) {
+    return res.status(401).json({ error: 'Invalid signature' });
+  }
+
+  // Store the webhook event
   const conn = await datastore.open();
-  const doc = await conn.insertOne('greetings', {
-    message: 'Hello World!',
-    when: new Date(),
+  const event = await conn.insertOne('webhook_events', {
+    payload: req.body,
+    received: new Date()
   });
-  res.json({ ...doc });
+
+  // Queue for reliable background processing
+  await conn.enqueue('processWebhook', { eventId: event._id });
+
+  res.json({ received: true });
 });
 
-// Serve web content from the uploaded directory /static
-app.static({ directory: '/static' });
+// Background worker with automatic retries
+app.worker('processWebhook', async (req, res) => {
+  const { eventId } = req.body.payload;
+  const conn = await datastore.open();
+
+  const event = await conn.getOne('webhook_events', eventId);
+  console.log('Processing webhook:', event.payload);
 
-// CRUD REST API for any collection
-app.crudlify({}, { prefix: '/' });
+  // Your processing logic here
+
+  res.end();
+});
 
-// return app to serverless runtime engine
 export default app.init();
 ```
 
-## TypeScript development
+## TypeScript Support
 
-Rename the index.js to index.ts or create a new index.ts file.
-Start developing using TypeScript and strong types shown in the example code below.
+Full TypeScript support with strong types:
 
 ```typescript
-/*
- * REST API with NoSQL database storage.
- * Codehooks (c) example code in TypeScript.
- */
+import { app, datastore, httpRequest, httpResponse } from 'codehooks-js';
 
-import { app, datastore, httpResponse, httpRequest } from 'codehooks-js';
+app.post('/webhooks/github', async (req: httpRequest, res: httpResponse) => {
+  const event = req.headers['x-github-event'];
+  const payload = req.body;
 
-// Example GET route and a NoSQL database insert operation
-app.get('/myroute', async (req: httpRequest, res: httpResponse) => {
-  console.log('GET');
   const conn = await datastore.open();
-  const doc = await conn.insertOne('greetings', {
-    message: 'Hello World!',
-    when: new Date(),
+  await conn.insertOne('github_events', {
+    event,
+    payload,
+    timestamp: new Date()
   });
-  res.json({ ...doc });
+
+  res.json({ status: 'ok' });
 });
 
-// Serve web content from the uploaded directory /static
-app.static({ directory: '/static' });
+export default app.init();
+```
+
+## REST API Example
+
+Build traditional REST APIs with the same simplicity:
+
+```javascript
+import { app, datastore } from 'codehooks-js';
+
+app.get('/api/users/:id', async (req, res) => {
+  const conn = await datastore.open();
+  const user = await conn.getOne('users', req.params.id);
+  res.json(user);
+});
+
+app.post('/api/users', async (req, res) => {
+  const conn = await datastore.open();
+  const user = await conn.insertOne('users', req.body);
+  res.status(201).json(user);
+});
 
-// CRUD REST API for any collection
-app.crudlify({}, { prefix: '/' });
+// Auto-generate CRUD endpoints for any collection
+app.crudlify();
 
-// return app to serverless runtime engine
 export default app.init();
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codehooks-js",
-  "version": "1.3.16",
+  "version": "1.3.18",
   "type": "module",
   "description": "Codehooks.io official library - provides express.JS like syntax",
   "main": "index.js",

package/types/index.d.ts

@@ -513,6 +513,10 @@ export type httpRequest = {
    * - JSON payload
    */
   body: any;
+  /**
+   * - Get the raw unparsed request body as a string
+   */
+  rawBody: string;
   /**
    * - Get the URL full path, e.g. /dev/myroute
    */
@@ -622,6 +626,11 @@ export type httpResponse = {
 
 export type nextFunction = (error?: string) => void;
 
+// Aliases for developers familiar with Express.js conventions
+export type Request = httpRequest;
+export type Response = httpResponse;
+export type NextFunction = nextFunction;
+
 export type Filesystem = {
   /**
    * - Get binary file input stream. Takes a path (string) to file (e.g. /static/logo.png) and an options object (Object) for future use. Returns a Promise resolving to a binary data stream emitter.