@twick/cli 0.11.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 motion-canvas
+
+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/dist/editor.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.launchEditor = launchEditor;
+const vite_plugin_1 = __importDefault(require("@twick/vite-plugin"));
+const vite_1 = require("vite");
+async function launchEditor(projectPath, port) {
+    const server = await (0, vite_1.createServer)({
+        configFile: false,
+        plugins: [
+            (0, vite_plugin_1.default)({
+                project: projectPath,
+                buildForEditor: false,
+            }),
+        ],
+        build: {
+            minify: false,
+            rollupOptions: {
+                output: {
+                    entryFileNames: '[name].js',
+                },
+            },
+        },
+        server: {
+            port: parseInt(port),
+        },
+    });
+    return server.listen();
+}

package/dist/index.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const telemetry_1 = require("@twick/telemetry");
+const commander_1 = require("commander");
+const editor_1 = require("./editor");
+const index_1 = require("./server/index");
+const program = new commander_1.Command();
+const VERSION = '0.10.4';
+program
+    .name('twick')
+    .description('CLI to interact with the twick service')
+    .version(VERSION);
+program
+    .command('serve')
+    .description('Exposes a render endpoint to render videos from a project file. Automatically rebuilds the project when the project file changes. Use for local development.')
+    .option('--projectFile <path>', 'Path to the project file', './src/project.ts')
+    .option('--port <number>', 'Port on which to start the server', '4000')
+    .action(async (options) => {
+    (0, telemetry_1.sendEvent)(telemetry_1.EventName.CLICommand);
+    const { projectFile, port } = options;
+    process.env.PROJECT_FILE = projectFile;
+    process.env.REVIDEO_PORT = port;
+    (0, index_1.createServer)().listen(port, () => {
+        console.log(`Server listening on port ${port}`);
+        console.log();
+    });
+});
+program
+    .command('editor')
+    .description('Start the twick editor')
+    .option('--projectFile <path>', 'Path to the project file', './src/project.ts')
+    .option('--port <number>', 'Port on which to start the server', '9000')
+    .action(async (options) => {
+    const editor = await (0, editor_1.launchEditor)(options.projectFile, options.port);
+    console.log(`Editor running on port ${editor.config.server.port}`);
+});
+program.parse(process.argv);

package/dist/server/download.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.download = download;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+async function download(req, res) {
+    const { projectName } = req.params;
+    const resultFilePath = path_1.default.join(process.cwd(), `output/${projectName}`);
+    try {
+        await fs_1.promises.access(resultFilePath);
+        res.download(resultFilePath, `${projectName}`, async (err) => {
+            if (err) {
+                console.error(err);
+                res.status(500).send('Error downloading the file.');
+            }
+        });
+    }
+    catch (error) {
+        console.error(`File not found ${resultFilePath}:`, error);
+        res.status(404).send('File not found.');
+    }
+}

package/dist/server/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createServer = createServer;
+const cors_1 = __importDefault(require("cors"));
+const express_1 = __importDefault(require("express"));
+const download_1 = require("./download");
+const render_1 = require("./render");
+function createServer() {
+    const app = (0, express_1.default)();
+    app.use(express_1.default.json({ limit: '50mb' }));
+    app.use((0, cors_1.default)());
+    app.post('/render', render_1.render);
+    app.get('/download/:projectName', download_1.download);
+    return app;
+}

package/dist/server/render.js

@@ -0,0 +1,133 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.render = render;
+const renderer_1 = require("@twick/renderer");
+const axios_1 = __importDefault(require("axios"));
+const path_1 = __importDefault(require("path"));
+const uuid_1 = require("uuid");
+const utils_1 = require("../utils");
+async function render(req, res) {
+    const { callbackUrl } = req.body;
+    if (callbackUrl) {
+        await renderWithCallback(req, res);
+    }
+    else {
+        await renderWithoutCallback(req, res);
+    }
+}
+async function renderWithCallback(req, res) {
+    // TODO: validate request body
+    const { variables, callbackUrl, settings } = req.body;
+    const tempProjectName = (0, uuid_1.v4)();
+    const outputFileName = `${tempProjectName}.mp4`;
+    res.json({ tempProjectName });
+    try {
+        await (0, renderer_1.renderVideo)({
+            projectFile: process.env.PROJECT_FILE || '',
+            variables,
+            settings: {
+                ...settings,
+                outFile: outputFileName,
+            },
+        });
+        const resultFilePath = path_1.default.join(process.cwd(), `output/${outputFileName}`);
+        const downloadLink = `${req.protocol}://${req.get('host')}/download/${outputFileName}`;
+        const response = await axios_1.default.post(callbackUrl, {
+            tempProjectName,
+            status: 'success',
+            downloadLink,
+        }, {
+            headers: {
+                // eslint-disable-next-line
+                'Content-Type': 'application/json',
+            },
+        });
+        if (response.status !== 200) {
+            throw new Error('Callback URL responded with an error');
+        }
+        (0, utils_1.scheduleCleanup)(resultFilePath);
+    }
+    catch (error) {
+        console.error(error);
+        await axios_1.default.post(callbackUrl, {
+            tempProjectName,
+            status: 'error',
+            error: error.message,
+        }, {
+            headers: {
+                // eslint-disable-next-line
+                'Content-Type': 'application/json',
+            },
+        });
+    }
+}
+async function renderWithoutCallback(req, res) {
+    // TODO: validate request body
+    const { variables, streamProgress, settings } = req.body;
+    const tempProjectName = `${(0, uuid_1.v4)()}.mp4`;
+    const resultFilePath = path_1.default.join(process.cwd(), `output/${tempProjectName}`);
+    if (streamProgress) {
+        res.writeHead(200, {
+            // eslint-disable-next-line
+            'Content-Type': 'text/event-stream',
+            // eslint-disable-next-line
+            'Cache-Control': 'no-cache',
+            // eslint-disable-next-line
+            Connection: 'keep-alive',
+        });
+        const sendProgress = (worker, progress) => {
+            res.write(`event: progress\n`);
+            res.write(`data: ${JSON.stringify({ worker, progress })}\n\n`);
+        };
+        try {
+            await (0, renderer_1.renderVideo)({
+                projectFile: process.env.PROJECT_FILE || '',
+                variables,
+                settings: {
+                    ...settings,
+                    outFile: tempProjectName,
+                    progressCallback: sendProgress,
+                },
+            });
+            const downloadLink = `${req.protocol}://${req.get('host')}/download/${tempProjectName}`;
+            res.write(`event: completed\n`);
+            res.write(`data: ${JSON.stringify({ status: 'success', downloadLink })}\n\n`);
+            res.end();
+            (0, utils_1.scheduleCleanup)(resultFilePath);
+        }
+        catch (error) {
+            console.error(error);
+            res.write(`event: error\n`);
+            res.write(`data: ${JSON.stringify({ status: 'error', message: error.message })}\n\n`);
+            res.end();
+        }
+    }
+    else {
+        try {
+            await (0, renderer_1.renderVideo)({
+                projectFile: process.env.PROJECT_FILE || '',
+                variables,
+                settings: {
+                    ...settings,
+                    outFile: tempProjectName,
+                },
+            });
+            const downloadLink = `${req.protocol}://${req.get('host')}/download/${tempProjectName}`;
+            res.json({
+                status: 'success',
+                downloadLink: downloadLink,
+            });
+            (0, utils_1.scheduleCleanup)(resultFilePath);
+        }
+        catch (error) {
+            console.error(error);
+            res.status(500).json({
+                status: 'error',
+                message: error.message,
+            });
+        }
+    }
+}

package/dist/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scheduleCleanup = scheduleCleanup;
+const fs_1 = require("fs");
+function scheduleCleanup(filePath) {
+    const clean = async () => {
+        try {
+            await fs_1.promises.unlink(filePath);
+            console.log(`Successfully deleted file: ${filePath}`);
+        }
+        catch (error) {
+            console.error(`Error deleting file ${filePath}: ${error}`);
+        }
+    };
+    // Wait 10 minutes before removing file.
+    setTimeout(clean, 10 * 60 * 1000);
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@twick/cli",
+  "version": "0.11.0",
+  "description": "A CLI for twick",
+  "main": "dist/index.js",
+  "author": "twick",
+  "homepage": "https://re.video/",
+  "bugs": "https://github.com/ncounterspecialist/twick-base/issues",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "ts-node-dev --respawn --transpile-only src/index.ts"
+  },
+  "bin": {
+    "twick": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "types"
+  ],
+  "devDependencies": {
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "typescript": "^5.4.3"
+  },
+  "dependencies": {
+    "@twick/renderer": "^0.11.0",
+    "@twick/telemetry": "^0.11.0",
+    "@twick/vite-plugin": "^0.11.0",
+    "chokidar": "^3.5.3",
+    "commander": "^12.0.0",
+    "cors": "^2.8.5",
+    "express": "^4.19.2",
+    "uuid": "^9.0.1"
+  },
+  "gitHead": "59f38f4e7d3a9a30943bbad830dc0201eaa57ce7"
+}