n8n-nodes-janction-render 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,27 @@
-# Temporary Holding Version
+# n8n-nodes-janction-render
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An [n8n](https://n8n.io) community node for [JANCTION Render](https://render.janction.jp): render Blender scenes and 3D models (GLB, glTF, FBX, USD, OBJ, STL, .blend, or a bpy script) on cloud GPUs. Turn a product model into studio shots or a 360-degree turntable MP4 inside a workflow, with no local Blender or GPU.
+
+## Install
+
+In n8n: **Settings > Community Nodes > Install**, then enter `n8n-nodes-janction-render`.
+
+## Credentials
+
+Create a key at https://render.janction.jp/start (a new key comes with free GPU time) and paste it into **JANCTION Render API** (`jr_...`, sent as `X-API-Key`).
+
+## Operations
+
+- **Render**: start a preview (up to 4 frames tiled in one image, seconds) or a final render. The scene is a file URL, a bpy script or a `scene_id` from an earlier job. Presets: `product` (4 studio shots), `turntable` (one full turn as MP4), `animation`. Returns `job_id`.
+- **Estimate**: GPU seconds, wall time, queue wait and the cost in JPY before rendering.
+- **Get Job**: status, ETA and, when done, the image or MP4 links (no key needed, about 24 hours).
+
+A typical workflow: trigger (new product in your shop) > **Render** (File URL = the GLB, Preset = Product Shots, Kind = Final) > **Wait** 60 s > **Get Job** > loop until `status` is `done` > send the links.
+
+## Pricing
+
+Free GPU time for a new key, then 0.1 JPY per GPU-second from prepaid credit. Current numbers: https://render.janction.jp/pricing
+
+## License
+
+MIT. Operated by JasmyLab Inc. (Tokyo, Japan).

package/dist/credentials/JanctionRenderApi.credentials.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JanctionRenderApi = void 0;
+class JanctionRenderApi {
+    constructor() {
+        this.name = 'janctionRenderApi';
+        this.displayName = 'JANCTION Render API';
+        this.documentationUrl = 'https://github.com/JasmyLab-JANCTION/janction-render/tree/main/integrations/n8n';
+        this.properties = [
+            {
+                displayName: 'API Key',
+                name: 'apiKey',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                description: 'A key that starts with jr_. Create one at https://render.janction.jp/start (free GPU time to start).',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: { headers: { 'X-API-Key': '={{$credentials.apiKey}}' } },
+        };
+        this.test = {
+            request: { baseURL: 'https://render.janction.jp', url: '/v1/me?src=n8n' },
+        };
+    }
+}
+exports.JanctionRenderApi = JanctionRenderApi;

package/dist/nodes/JanctionRender/JanctionRender.node.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JanctionRender = void 0;
+// The scene to render: one of a link (.blend, .py, GLB/glTF, FBX, USD, OBJ, STL) or bpy code. Shared by Render and Estimate.
+const sceneFields = [
+    {
+        displayName: 'Scene Source',
+        name: 'source',
+        type: 'options',
+        default: 'url',
+        options: [
+            { name: 'File URL', value: 'url', description: 'An https link to a .blend, .py or 3D file (GLB, glTF, FBX, USD, OBJ, STL)' },
+            { name: 'Bpy Script', value: 'script', description: 'Blender Python code that builds the scene' },
+            { name: 'Scene ID', value: 'id', description: 'A scene_id returned by an earlier job (kept 24 hours after last use)' },
+        ],
+    },
+    {
+        displayName: 'File URL',
+        name: 'sceneUrl',
+        type: 'string',
+        default: '',
+        placeholder: 'https://example.com/product.glb',
+        displayOptions: { show: { source: ['url'] } },
+        routing: { send: { type: 'body', property: 'scene_url' } },
+    },
+    {
+        displayName: 'Bpy Script',
+        name: 'sceneScript',
+        type: 'string',
+        typeOptions: { rows: 8 },
+        default: '',
+        displayOptions: { show: { source: ['script'] } },
+        routing: { send: { type: 'body', property: 'scene_script' } },
+    },
+    {
+        displayName: 'Scene ID',
+        name: 'sceneId',
+        type: 'string',
+        default: '',
+        placeholder: 'f_0123456789abcdef',
+        displayOptions: { show: { source: ['id'] } },
+        routing: { send: { type: 'body', property: 'scene_id' } },
+    },
+    {
+        displayName: 'Kind',
+        name: 'kind',
+        type: 'options',
+        default: 'preview',
+        options: [
+            { name: 'Preview', value: 'preview', description: 'Up to 4 frames tiled in one image, back in seconds' },
+            { name: 'Final', value: 'final', description: 'Full-size frames or a video' },
+        ],
+        routing: { send: { type: 'body', property: 'kind' } },
+    },
+    {
+        displayName: 'Preset',
+        name: 'preset',
+        type: 'options',
+        default: '',
+        options: [
+            { name: 'None', value: '' },
+            { name: 'Product Shots', value: 'product', description: '4 studio shots at 0/90/180/270 degrees on a plain backdrop' },
+            { name: 'Turntable', value: 'turntable', description: 'One full turn as an MP4 on a plain backdrop' },
+            { name: 'Animation', value: 'animation', description: "The scene's own camera, lights and frame range" },
+        ],
+        routing: { send: { type: 'body', property: 'preset', value: '={{ $value || undefined }}' } },
+    },
+    {
+        displayName: 'Additional Fields',
+        name: 'additionalFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        options: [
+            { displayName: 'Frame Start', name: 'frame_start', type: 'number', default: 1, routing: { send: { type: 'body', property: 'frame_start' } } },
+            { displayName: 'Frame End', name: 'frame_end', type: 'number', default: 1, routing: { send: { type: 'body', property: 'frame_end' } } },
+            { displayName: 'Width', name: 'width', type: 'number', default: 1920, routing: { send: { type: 'body', property: 'width' } } },
+            { displayName: 'Height', name: 'height', type: 'number', default: 1080, routing: { send: { type: 'body', property: 'height' } } },
+            { displayName: 'Samples', name: 'samples', type: 'number', default: 128, routing: { send: { type: 'body', property: 'samples' } } },
+            {
+                displayName: 'Output',
+                name: 'output',
+                type: 'options',
+                default: 'auto',
+                options: ['auto', 'png', 'exr', 'mp4', 'webm', 'gif', 'webp'].map((v) => ({ name: v.toUpperCase(), value: v })),
+                routing: { send: { type: 'body', property: 'output' } },
+            },
+            {
+                displayName: 'Environment',
+                name: 'environment',
+                type: 'options',
+                default: 'studio',
+                options: ['studio', 'sunset', 'overcast', 'night'].map((v) => ({ name: v[0].toUpperCase() + v.slice(1), value: v })),
+                routing: { send: { type: 'body', property: 'environment' } },
+            },
+            { displayName: 'Transparent Background', name: 'transparent', type: 'boolean', default: false, routing: { send: { type: 'body', property: 'transparent' } } },
+            {
+                displayName: 'Max JPY',
+                name: 'max_yen',
+                type: 'number',
+                default: 0,
+                description: 'Refuse the job if it would cost more than this (0 = only when the free GPU time covers it)',
+                routing: { send: { type: 'body', property: 'max_yen' } },
+            },
+        ],
+    },
+];
+class JanctionRender {
+    constructor() {
+        this.description = {
+            displayName: 'JANCTION Render',
+            name: 'janctionRender',
+            icon: 'file:janction.png',
+            group: ['transform'],
+            version: 1,
+            subtitle: '={{$parameter["operation"]}}',
+            description: 'Render Blender scenes and 3D models on cloud GPUs: product shots, turntables, animations and stills',
+            defaults: { name: 'JANCTION Render' },
+            inputs: ['main'],
+            outputs: ['main'],
+            credentials: [{ name: 'janctionRenderApi', required: true }],
+            requestDefaults: {
+                baseURL: 'https://render.janction.jp',
+                headers: { Accept: 'application/json', 'Content-Type': 'application/json' },
+                qs: { src: 'n8n' },
+            },
+            properties: [
+                {
+                    displayName: 'Operation',
+                    name: 'operation',
+                    type: 'options',
+                    noDataExpression: true,
+                    default: 'render',
+                    options: [
+                        {
+                            name: 'Render',
+                            value: 'render',
+                            action: 'Start a render',
+                            description: 'Start a preview or final render. Returns job_id; use Get Job (after a Wait node) for the links.',
+                            routing: { request: { method: 'POST', url: '/v1/jobs' } },
+                        },
+                        {
+                            name: 'Estimate',
+                            value: 'estimate',
+                            action: 'Estimate a render',
+                            description: 'GPU seconds, wall time, queue wait and cost in JPY before rendering',
+                            routing: { request: { method: 'POST', url: '/v1/estimate' } },
+                        },
+                        {
+                            name: 'Get Job',
+                            value: 'getJob',
+                            action: 'Get a render job',
+                            description: 'Status, ETA and, when done, the image or MP4 links (no key needed, about 24 hours)',
+                            routing: { request: { method: 'GET', url: '=/v1/jobs/{{$parameter["jobId"]}}' } },
+                        },
+                    ],
+                },
+                ...sceneFields.map((f) => { var _a, _b; return ({ ...f, displayOptions: { show: { ...((_b = (_a = f.displayOptions) === null || _a === void 0 ? void 0 : _a.show) !== null && _b !== void 0 ? _b : {}), operation: ['render', 'estimate'] } } }); }),
+                {
+                    displayName: 'Job ID',
+                    name: 'jobId',
+                    type: 'string',
+                    default: '',
+                    required: true,
+                    placeholder: 'j_0123456789abcdef',
+                    displayOptions: { show: { operation: ['getJob'] } },
+                },
+            ],
+        };
+    }
+}
+exports.JanctionRender = JanctionRender;

package/package.json

@@ -1,6 +1,28 @@
 {
   "name": "n8n-nodes-janction-render",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "n8n node for JANCTION Render: render Blender scenes and 3D models (GLB, FBX, USD, OBJ, STL) on cloud GPUs. Product shots, 360-degree turntables, animations and stills as PNG or MP4.",
+  "keywords": ["n8n-community-node-package", "blender", "3d", "rendering", "gpu", "glb", "product-photos", "turntable"],
+  "license": "MIT",
+  "homepage": "https://github.com/JasmyLab-JANCTION/janction-render/tree/main/integrations/n8n",
+  "author": { "name": "JasmyLab Inc.", "email": "contact@jasmylab.com" },
+  "repository": { "type": "git", "url": "git+https://github.com/JasmyLab-JANCTION/janction-render.git", "directory": "integrations/n8n" },
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc && node -e \"require('fs').cpSync('nodes/JanctionRender/janction.png','dist/nodes/JanctionRender/janction.png')\"",
+    "prepublishOnly": "npm run build"
+  },
+  "files": ["dist"],
+  "n8n": {
+    "n8nNodesApiVersion": 1,
+    "credentials": ["dist/credentials/JanctionRenderApi.credentials.js"],
+    "nodes": ["dist/nodes/JanctionRender/JanctionRender.node.js"]
+  },
+  "devDependencies": {
+    "n8n-workflow": "*",
+    "typescript": "^5.6.0"
+  },
+  "peerDependencies": {
+    "n8n-workflow": "*"
+  }
+}