@twick/render-server 0.14.2 → 0.14.4

package/README.md

@@ -2,13 +2,19 @@
 
 A simple Node.js server for rendering videos using Twick.
 
+## Overview
+
+This package provides a server-side rendering solution for Twick video projects. It allows you to render video projects on the server and download the resulting video files.
+
 ## Installation
 
 ```bash
-pnpm install @twick/render-server
+npm install @twick/render-server
+# or
+pnpm add @twick/render-server
 ```
 
-## Usage
+## Quick Start
 
 ### Starting the server
 
@@ -23,9 +29,9 @@ pnpm start
 
 The server will start on port 3001 by default. You can change this by setting the `PORT` environment variable.
 
-### API Endpoints
+## API Endpoints
 
-#### POST /api/render-video
+### POST /api/render-video
 
 Renders a video using Twick.
 
@@ -75,11 +81,11 @@ Renders a video using Twick.
 }
 ```
 
-#### GET /download/:outFile
+### GET /download/:outFile
 
 Downloads a rendered video file.
 
-#### GET /health
+### GET /health
 
 Health check endpoint.
 
@@ -111,6 +117,25 @@ node test.js
 
 > **Note:** This server will work on Linux and macOS only. Windows is not supported.
 
+## Browser Support
+
+This package requires a Node.js environment with support for:
+- Node.js 18 or higher
+- Puppeteer for video rendering
+- File system operations
+
+## Documentation
+
+For complete documentation, refer to the project documentation site.
+
 ## License
 
-Apache-2.0 
+This package is licensed under the **Sustainable Use License (SUL) Version 1.0**.
+
+- Free for use in commercial and non-commercial apps
+- Can be modified and self-hosted
+- Cannot be sold, rebranded, or distributed as a standalone SDK
+
+For commercial licensing inquiries, contact: contact@kifferai.com
+
+For full license terms, see the main LICENSE.md file in the project root. 

package/dist/renderer.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Renders a Twick video with the provided variables and settings.
+ * Processes project variables, merges settings with defaults, and
+ * generates a video file using the Twick renderer.
+ *
+ * @param variables - Project variables containing input configuration
+ * @param settings - Optional render settings to override defaults
+ * @returns Promise resolving to the path of the rendered video file
+ *
+ * @example
+ * ```js
+ * const videoPath = await renderTwickVideo(
+ *   { input: { properties: { width: 1920, height: 1080 } } },
+ *   { quality: "high", outFile: "my-video.mp4" }
+ * );
+ * // videoPath = "./output/my-video.mp4"
+ * ```
+ */
 declare const renderTwickVideo: (variables: any, settings: any) => Promise<string>;
 export default renderTwickVideo;
 //# sourceMappingURL=renderer.d.ts.map

package/dist/renderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,gBAAgB,GAAU,WAAW,GAAG,EAAE,UAAU,GAAG,oBAiC5D,CAAC;AAEF,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AACH,QAAA,MAAM,gBAAgB,GAAU,WAAW,GAAG,EAAE,UAAU,GAAG,oBAiC5D,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/dist/renderer.js

@@ -1,4 +1,22 @@
 import { renderVideo } from "@twick/renderer";
+/**
+ * Renders a Twick video with the provided variables and settings.
+ * Processes project variables, merges settings with defaults, and
+ * generates a video file using the Twick renderer.
+ *
+ * @param variables - Project variables containing input configuration
+ * @param settings - Optional render settings to override defaults
+ * @returns Promise resolving to the path of the rendered video file
+ *
+ * @example
+ * ```js
+ * const videoPath = await renderTwickVideo(
+ *   { input: { properties: { width: 1920, height: 1080 } } },
+ *   { quality: "high", outFile: "my-video.mp4" }
+ * );
+ * // videoPath = "./output/my-video.mp4"
+ * ```
+ */
 const renderTwickVideo = async (variables, settings) => {
     try {
         const { input } = variables;

package/dist/renderer.js.map

@@ -1 +1 @@
-{"version":3,"file":"renderer.js","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,gBAAgB,GAAG,KAAK,EAAE,SAAc,EAAE,QAAa,EAAE,EAAE;IAC/D,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;QAC5B,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAC7B,oCAAoC;QACpC,MAAM,cAAc,GAAG;YACrB,WAAW,EAAE,IAAI;YACjB,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,UAAU,CAAC,SAAS,IAAI,SAAS,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM;YAC/D,OAAO,EAAE,QAAQ;YACjB,eAAe,EAAE;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,kBAAkB;iBACzB;gBACD,IAAI,EAAE;oBACJ,CAAC,EAAE,UAAU,CAAC,KAAK;oBACnB,CAAC,EAAE,UAAU,CAAC,MAAM;iBACrB;aACF;YACD,GAAG,QAAQ,EAAE,2CAA2C;SACzD,CAAC;QAEF,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC;YAC7B,WAAW,EAAE,mCAAmC;YAChD,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,cAAc;SACzB,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACtC,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"renderer.js","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,gBAAgB,GAAG,KAAK,EAAE,SAAc,EAAE,QAAa,EAAE,EAAE;IAC/D,IAAI,CAAC;QACH,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;QAC5B,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAC7B,oCAAoC;QACpC,MAAM,cAAc,GAAG;YACrB,WAAW,EAAE,IAAI;YACjB,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,UAAU,CAAC,SAAS,IAAI,SAAS,IAAI,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM;YAC/D,OAAO,EAAE,QAAQ;YACjB,eAAe,EAAE;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,kBAAkB;iBACzB;gBACD,IAAI,EAAE;oBACJ,CAAC,EAAE,UAAU,CAAC,KAAK;oBACnB,CAAC,EAAE,UAAU,CAAC,MAAM;iBACrB;aACF;YACD,GAAG,QAAQ,EAAE,2CAA2C;SACzD,CAAC;QAEF,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC;YAC7B,WAAW,EAAE,mCAAmC;YAChD,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,cAAc;SACzB,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,IAAI,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACtC,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/dist/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AA+EA,QAAA,MAAM,OAAO,EAAE,OAAO,SAAS,EAAE,OAAmB,CAAC;AAyDrD,eAAe,OAAO,CAAC"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AA6FA,QAAA,MAAM,OAAO,EAAE,OAAO,SAAS,EAAE,OAAmB,CAAC;AAiGrD,eAAe,OAAO,CAAC"}

package/dist/server.js

@@ -21,7 +21,21 @@ setInterval(() => {
         }
     }
 }, RATE_LIMIT_CLEANUP_INTERVAL_MS);
-// Rate limiting middleware
+/**
+ * Rate limiting middleware for API endpoints.
+ * Tracks request counts per IP address and enforces rate limits
+ * to prevent abuse of the render server.
+ *
+ * @param req - Express request object
+ * @param res - Express response object
+ * @param next - Express next function
+ *
+ * @example
+ * ```js
+ * app.use('/api', rateLimitMiddleware);
+ * // Applies rate limiting to all /api routes
+ * ```
+ */
 const rateLimitMiddleware = (req, res, next) => {
     const clientIP = req.ip || req.connection.remoteAddress || 'unknown';
     const now = Date.now();
@@ -64,6 +78,21 @@ nodeApp.use(cors());
 nodeApp.use(express.json());
 // Serve static files from output directory
 nodeApp.use("/output", express.static(path.join(__dirname, "../output")));
+/**
+ * POST endpoint for video rendering requests.
+ * Accepts project variables and settings, renders the video,
+ * and returns a download URL for the completed video.
+ *
+ * @param req - Express request object containing variables and settings
+ * @param res - Express response object
+ *
+ * @example
+ * ```js
+ * POST /api/render-video
+ * Body: { variables: {...}, settings: {...} }
+ * Response: { success: true, downloadUrl: "..." }
+ * ```
+ */
 nodeApp.post("/api/render-video", async (req, res) => {
     const { variables, settings } = req.body;
     try {
@@ -81,7 +110,20 @@ nodeApp.post("/api/render-video", async (req, res) => {
         });
     }
 });
-// Apply rate limiting to download endpoint
+/**
+ * GET endpoint for downloading rendered videos.
+ * Serves video files with rate limiting and security checks
+ * to prevent path traversal attacks.
+ *
+ * @param req - Express request object with filename parameter
+ * @param res - Express response object
+ *
+ * @example
+ * ```js
+ * GET /download/video-123.mp4
+ * // Downloads the specified video file
+ * ```
+ */
 nodeApp.get("/download/:filename", rateLimitMiddleware, (req, res) => {
     const outputDir = path.resolve(__dirname, "../output");
     const requestedPath = path.resolve(outputDir, req.params.filename);
@@ -102,7 +144,19 @@ nodeApp.get("/download/:filename", rateLimitMiddleware, (req, res) => {
         }
     });
 });
-// Health check endpoint
+/**
+ * Health check endpoint for monitoring server status.
+ * Returns server status and current timestamp for health monitoring.
+ *
+ * @param req - Express request object
+ * @param res - Express response object
+ *
+ * @example
+ * ```js
+ * GET /health
+ * Response: { status: "ok", timestamp: "2024-01-01T00:00:00.000Z" }
+ * ```
+ */
 nodeApp.get("/health", (req, res) => {
     res.json({
         status: "ok",

package/dist/server.js.map

@@ -1 +1 @@
-{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,gBAAgB,MAAM,eAAe,CAAC;AAE7C,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC;AACtC,MAAM,SAAS,GAAG,oBAAoB,IAAI,EAAE,CAAC;AAE7C,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAE3C,8BAA8B;AAC9B,MAAM,oBAAoB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAC1D,MAAM,uBAAuB,GAAG,GAAG,CAAC,CAAC,8BAA8B;AACnE,MAAM,8BAA8B,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,uBAAuB;AAQzE,MAAM,cAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;AAEzD,uCAAuC;AACvC,WAAW,CAAC,GAAG,EAAE;IACf,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;QACpD,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;YAC1B,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC,EAAE,8BAA8B,CAAC,CAAC;AAEnC,2BAA2B;AAC3B,MAAM,mBAAmB,GAAG,CAAC,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAE,EAAE;IACtG,MAAM,QAAQ,GAAG,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,SAAS,CAAC;IACrE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,6CAA6C;IAC7C,IAAI,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEzC,IAAI,CAAC,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QACpC,8BAA8B;QAC9B,KAAK,GAAG;YACN,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,GAAG,GAAG,oBAAoB;SACtC,CAAC;QACF,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;SAAM,CAAC;QACN,oCAAoC;QACpC,KAAK,CAAC,KAAK,EAAE,CAAC;QAEd,IAAI,KAAK,CAAC,KAAK,GAAG,uBAAuB,EAAE,CAAC;YAC1C,sBAAsB;YACtB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;YAC7D,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC9C,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,uBAAuB,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjE,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YACtC,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAEtE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,mBAAmB;gBAC1B,OAAO,EAAE,qCAAqC,UAAU,WAAW;gBACnE,UAAU;aACX,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,yBAAyB;IACzB,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,uBAAuB,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjE,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,CAAC,uBAAuB,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrF,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAEtE,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAEF,MAAM,OAAO,GAA8B,OAAO,EAAE,CAAC;AAErD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AACpB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;AAE5B,2CAA2C;AAC3C,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;AAE1E,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;IACnD,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC;IAEzC,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC/D,GAAG,CAAC,IAAI,CAAC;YACP,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;SAClE,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACtC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;SAChE,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,2CAA2C;AAC3C,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,mBAAmB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACnE,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACvD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnE,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACpD,8DAA8D;QAC9D,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE;QAClC,IAAI,GAAG,EAAE,CAAC;YACR,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACnB,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,gBAAgB;aACxB,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,wBAAwB;AACxB,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IAClC,GAAG,CAAC,IAAI,CAAC;QACP,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,wCAAwC;AACxC,eAAe,OAAO,CAAC;AAEvB,mBAAmB;AACnB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;IACxB,OAAO,CAAC,GAAG,CAAC,iCAAiC,IAAI,EAAE,CAAC,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,iBAAiB,SAAS,SAAS,CAAC,CAAC;IACjD,OAAO,CAAC,GAAG,CAAC,iBAAiB,SAAS,mBAAmB,CAAC,CAAC;IAC3D,OAAO,CAAC,GAAG,CAAC,mCAAmC,uBAAuB,iBAAiB,oBAAoB,GAAG,KAAK,UAAU,CAAC,CAAC;AACjI,CAAC,CAAC,CAAC"}
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,OAAO,gBAAgB,MAAM,eAAe,CAAC;AAE7C,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC;AACtC,MAAM,SAAS,GAAG,oBAAoB,IAAI,EAAE,CAAC;AAE7C,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAE3C,8BAA8B;AAC9B,MAAM,oBAAoB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,aAAa;AAC1D,MAAM,uBAAuB,GAAG,GAAG,CAAC,CAAC,8BAA8B;AACnE,MAAM,8BAA8B,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,uBAAuB;AAQzE,MAAM,cAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;AAEzD,uCAAuC;AACvC,WAAW,CAAC,GAAG,EAAE;IACf,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;QACpD,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;YAC1B,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;AACH,CAAC,EAAE,8BAA8B,CAAC,CAAC;AAEnC;;;;;;;;;;;;;;GAcG;AACH,MAAM,mBAAmB,GAAG,CAAC,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAE,EAAE;IACtG,MAAM,QAAQ,GAAG,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,SAAS,CAAC;IACrE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,6CAA6C;IAC7C,IAAI,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEzC,IAAI,CAAC,KAAK,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QACpC,8BAA8B;QAC9B,KAAK,GAAG;YACN,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,GAAG,GAAG,oBAAoB;SACtC,CAAC;QACF,cAAc,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;SAAM,CAAC;QACN,oCAAoC;QACpC,KAAK,CAAC,KAAK,EAAE,CAAC;QAEd,IAAI,KAAK,CAAC,KAAK,GAAG,uBAAuB,EAAE,CAAC;YAC1C,sBAAsB;YACtB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;YAC7D,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC9C,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,uBAAuB,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjE,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;YACtC,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAEtE,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,mBAAmB;gBAC1B,OAAO,EAAE,qCAAqC,UAAU,WAAW;gBACnE,UAAU;aACX,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,yBAAyB;IACzB,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,uBAAuB,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjE,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,CAAC,uBAAuB,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrF,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAEtE,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAEF,MAAM,OAAO,GAA8B,OAAO,EAAE,CAAC;AAErD,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AACpB,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;AAE5B,2CAA2C;AAC3C,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;AAE1E;;;;;;;;;;;;;;GAcG;AACH,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;IACnD,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC;IAEzC,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC/D,GAAG,CAAC,IAAI,CAAC;YACP,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,GAAG,SAAS,aAAa,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;SAClE,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QACtC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;SAChE,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;;GAaG;AACH,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,mBAAmB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACnE,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACvD,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACnE,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACpD,8DAA8D;QAC9D,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IACD,GAAG,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,EAAE;QAClC,IAAI,GAAG,EAAE,CAAC;YACR,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACnB,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,gBAAgB;aACxB,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IAClC,GAAG,CAAC,IAAI,CAAC;QACP,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;KACpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,wCAAwC;AACxC,eAAe,OAAO,CAAC;AAEvB,mBAAmB;AACnB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;IACxB,OAAO,CAAC,GAAG,CAAC,iCAAiC,IAAI,EAAE,CAAC,CAAC;IACrD,OAAO,CAAC,GAAG,CAAC,iBAAiB,SAAS,SAAS,CAAC,CAAC;IACjD,OAAO,CAAC,GAAG,CAAC,iBAAiB,SAAS,mBAAmB,CAAC,CAAC;IAC3D,OAAO,CAAC,GAAG,CAAC,mCAAmC,uBAAuB,iBAAiB,oBAAoB,GAAG,KAAK,UAAU,CAAC,CAAC;AACjI,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@twick/render-server",
-  "version": "0.14.2",
-  "license": "Apache-2.0",
+  "version": "0.14.4",
+  "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",
   "main": "dist/server.js",
   "scripts": {
@@ -14,12 +14,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@twick/2d": "0.14.2",
-    "@twick/core": "0.14.2",
-    "@twick/ffmpeg": "0.14.2",
-    "@twick/renderer": "0.14.2",
-    "@twick/ui": "0.14.2",
-    "@twick/visualizer": "0.14.2",
+    "@twick/2d": "0.14.4",
+    "@twick/core": "0.14.4",
+    "@twick/ffmpeg": "0.14.4",
+    "@twick/renderer": "0.14.4",
+    "@twick/ui": "0.14.4",
+    "@twick/visualizer": "0.14.4",
     "@types/express-rate-limit": "^6.0.2",
     "cors": "^2.8.5",
     "express": "^4.18.2",

package/package.json.bak

@@ -1,7 +1,7 @@
 {
   "name": "@twick/render-server",
-  "version": "0.14.2",
-  "license": "Apache-2.0",
+  "version": "0.14.4",
+  "license": "SEE LICENSE IN LICENSE.md",
   "type": "module",
   "main": "dist/server.js",
   "scripts": {
@@ -14,12 +14,12 @@
     "access": "public"
   },
   "dependencies": {
-    "@twick/2d": "0.14.2",
-    "@twick/core": "0.14.2",
-    "@twick/ffmpeg": "0.14.2",
-    "@twick/renderer": "0.14.2",
-    "@twick/ui": "0.14.2",
-    "@twick/visualizer": "0.14.2",
+    "@twick/2d": "0.14.4",
+    "@twick/core": "0.14.4",
+    "@twick/ffmpeg": "0.14.4",
+    "@twick/renderer": "0.14.4",
+    "@twick/ui": "0.14.4",
+    "@twick/visualizer": "0.14.4",
     "@types/express-rate-limit": "^6.0.2",
     "cors": "^2.8.5",
     "express": "^4.18.2",

package/src/renderer.ts

@@ -1,5 +1,23 @@
 import { renderVideo } from "@twick/renderer";
 
+/**
+ * Renders a Twick video with the provided variables and settings.
+ * Processes project variables, merges settings with defaults, and
+ * generates a video file using the Twick renderer.
+ *
+ * @param variables - Project variables containing input configuration
+ * @param settings - Optional render settings to override defaults
+ * @returns Promise resolving to the path of the rendered video file
+ * 
+ * @example
+ * ```js
+ * const videoPath = await renderTwickVideo(
+ *   { input: { properties: { width: 1920, height: 1080 } } },
+ *   { quality: "high", outFile: "my-video.mp4" }
+ * );
+ * // videoPath = "./output/my-video.mp4"
+ * ```
+ */
 const renderTwickVideo = async (variables: any, settings: any) => {
   try {
     const { input } = variables;

package/src/server.ts

@@ -33,7 +33,21 @@ setInterval(() => {
   }
 }, RATE_LIMIT_CLEANUP_INTERVAL_MS);
 
-// Rate limiting middleware
+/**
+ * Rate limiting middleware for API endpoints.
+ * Tracks request counts per IP address and enforces rate limits
+ * to prevent abuse of the render server.
+ *
+ * @param req - Express request object
+ * @param res - Express response object
+ * @param next - Express next function
+ * 
+ * @example
+ * ```js
+ * app.use('/api', rateLimitMiddleware);
+ * // Applies rate limiting to all /api routes
+ * ```
+ */
 const rateLimitMiddleware = (req: express.Request, res: express.Response, next: express.NextFunction) => {
   const clientIP = req.ip || req.connection.remoteAddress || 'unknown';
   const now = Date.now();
@@ -85,6 +99,21 @@ nodeApp.use(express.json());
 // Serve static files from output directory
 nodeApp.use("/output", express.static(path.join(__dirname, "../output")));
 
+/**
+ * POST endpoint for video rendering requests.
+ * Accepts project variables and settings, renders the video,
+ * and returns a download URL for the completed video.
+ *
+ * @param req - Express request object containing variables and settings
+ * @param res - Express response object
+ * 
+ * @example
+ * ```js
+ * POST /api/render-video
+ * Body: { variables: {...}, settings: {...} }
+ * Response: { success: true, downloadUrl: "..." }
+ * ```
+ */
 nodeApp.post("/api/render-video", async (req, res) => {
   const { variables, settings } = req.body;
 
@@ -103,7 +132,20 @@ nodeApp.post("/api/render-video", async (req, res) => {
   }
 });
 
-// Apply rate limiting to download endpoint
+/**
+ * GET endpoint for downloading rendered videos.
+ * Serves video files with rate limiting and security checks
+ * to prevent path traversal attacks.
+ *
+ * @param req - Express request object with filename parameter
+ * @param res - Express response object
+ * 
+ * @example
+ * ```js
+ * GET /download/video-123.mp4
+ * // Downloads the specified video file
+ * ```
+ */
 nodeApp.get("/download/:filename", rateLimitMiddleware, (req, res) => {
   const outputDir = path.resolve(__dirname, "../output");
   const requestedPath = path.resolve(outputDir, req.params.filename);
@@ -125,7 +167,19 @@ nodeApp.get("/download/:filename", rateLimitMiddleware, (req, res) => {
   });
 });
 
-// Health check endpoint
+/**
+ * Health check endpoint for monitoring server status.
+ * Returns server status and current timestamp for health monitoring.
+ *
+ * @param req - Express request object
+ * @param res - Express response object
+ * 
+ * @example
+ * ```js
+ * GET /health
+ * Response: { status: "ok", timestamp: "2024-01-01T00:00:00.000Z" }
+ * ```
+ */
 nodeApp.get("/health", (req, res) => {
   res.json({
     status: "ok",

package/test.js

@@ -104,10 +104,10 @@ async function testHealth() {
   try {
     const response = await fetch(`${API_URL}/health`);
     const result = await response.json();
-    console.log('✅ Health check passed:', result);
+    console.log('Health check passed:', result);
     return true;
   } catch (error) {
-    console.error('❌ Health check failed:', error.message);
+    console.error('Health check failed:', error.message);
     return false;
   }
 }
@@ -132,15 +132,15 @@ async function testRender() {
     const result = await response.json();
     
     if (result.success) {
-      console.log('✅ Render test passed!');
+      console.log('Render test passed!');
       console.log('📁 Output:', result.downloadUrl);
       return true;
     } else {
-      console.error('❌ Render test failed:', result.error);
+      console.error('Render test failed:', result.error);
       return false;
     }
   } catch (error) {
-    console.error('❌ Render test failed:', error.message);
+    console.error('Render test failed:', error.message);
     return false;
   }
 }
@@ -154,7 +154,7 @@ async function runTests() {
   if (healthPassed) {
     await testRender();
   } else {
-    console.log('❌ Skipping render test due to health check failure');
+    console.log('Skipping render test due to health check failure');
   }
   
   console.log('\n🏁 Tests completed');