orshot 0.1.2 → 0.3.0

package/README.md

@@ -5,11 +5,13 @@ View on npmjs: https://www.npmjs.com/package/orshot
 ## Installation
 
 Using `npm`
+
 ```
 npm install --save orshot
 ```
 
 Using `yarn`
+
 ```
 yarn add orshot
 ```
@@ -20,13 +22,13 @@ If you don't have your API key, get one from [orshot.com](https://orshot.com)
 
 ### Import
 
-```
-const { Orshot } = require('orshot');
+```js
+const { Orshot } = require("orshot");
 ```
 
 With `ES6`
 
-```
+```js
 import { Orshot } from "orshot";
 ```
 
@@ -36,176 +38,217 @@ import { Orshot } from "orshot";
 const orshot = new Orshot("Your API key");
 ```
 
-### Generate image
+## renderFromStudioTemplate
 
-```js
-const response = await Orshot.renderFromTemplate({templateId, modifications, responseType: "base64", responseFormat: "png"});
-console.log(response);
-```
+Render from a custom [Studio template](https://orshot.com/features/orshot-studio). Supports image, PDF, video generation and publishing to social accounts.
 
-### Generate signed URL
+### Generate Image
 
 ```js
-const response = await Orshot.renderFromTemplate({templateId, modifications, expiresAt: 1744276943, renderType: "images", responseFormat: "png"});
-console.log(response);
+const response = await orshot.renderFromStudioTemplate({
+  templateId: 1234,
+  modifications: {
+    title: "Orshot Studio",
+    description: "Generate images from custom templates",
+  },
+  response: { type: "url", format: "png", scale: 2 },
+});
 ```
 
-## Example
-
-### `Base64` response format
+### Generate PDF
 
 ```js
-import { Orshot } from "orshot";
-
-const orshot = new Orshot("os-ha2jdus1cbz1dpt4mktgjyvx");
-
-let templateId = "open-graph-image-1";
-let modifications = {
-  title: "Orshot",
-  description: "Create Visuals and Automate Image Generation",
-  textColor: "",
-  backgroundImageUrl: "",
-  backgroundColor: ""
-}
-
-const response = await orshot.renderFromTemplate({templateId, modifications, responseType: "base64", responseFormat: "png"});
-console.log(response);
+const response = await orshot.renderFromStudioTemplate({
+  templateId: 1234,
+  modifications: { title: "Invoice #1234" },
+  response: { type: "url", format: "pdf" },
+  pdfOptions: {
+    margin: "20px",
+    rangeFrom: 1,
+    rangeTo: 2,
+    colorMode: "rgb",
+    dpi: 300,
+  },
+});
 ```
 
-API Response
-```
-{
-  data: {
-    content: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABLAAAAJ2CAYAAABPQHtcAAAAAXNSR0IArs4c6QAAIABJREFUeJzs3XmYJXdZL/Bvna37dM90FghLCBAQkC1BCBAMShLFBJAgKnofroBeFUUF5LrhiihXcV8BQRYVUUAlIewIGPbFmLCFLWwCYZEtzPR+trp/TM/......',
-    format: 'png',
-    type: 'base64',
-    responseTime: 3375.72
-  }
-}
-```
-
-### `URL` response format
+### Generate Video
 
 ```js
-import { Orshot } from "orshot";
-
-const orshot = new Orshot("os-ha2jdus1cbz1dpt4mktgjyvx");
-
-let templateId = "open-graph-image-1";
-let modifications = {
-  title: "Orshot",
-  description: "Create Visuals and Automate Image Generation",
-  textColor: "",
-  backgroundImageUrl: "",
-  backgroundColor: ""
-}
-
-const response = await orshot.renderFromTemplate({templateId, modifications, responseType: "url", responseFormat: "png"});
-console.log(response);
-```
-
-API Response
-```
-{
-  data: {
-    content: 'https://storage.orshot.com/10631481-fd26-44ff-9a61-f52cdf1b8e62/images/r1wCliKXC2B.png',
-    type: 'url',
-    format: 'png',
-    responseTime: 3550.43
-  }
-}
+const response = await orshot.renderFromStudioTemplate({
+  templateId: 1234,
+  modifications: {
+    videoElement: "https://example.com/custom-video.mp4",
+    "videoElement.trimStart": 0,
+    "videoElement.trimEnd": 10,
+  },
+  response: { type: "url", format: "mp4" },
+  videoOptions: {
+    trimStart: 0,
+    trimEnd: 20,
+    muted: false,
+    loop: true,
+    fps: 30,
+    audioSource: "https://example.com/audio.mp3",
+  },
+});
 ```
 
-### `Binary` response format
+### Multi-page Video with Transitions
 
 ```js
-import { Orshot } from "orshot";
-import { createWriteStream } from 'fs';
-
-const orshot = new Orshot("os-he2jdus1cbz1dpt4mktgjyvx");
-
-let templateId = "open-graph-image-1";
-let modifications = {
-  title: "Orshot",
-  description: "Create Visuals and Automate Image Generation",
-  textColor: "",
-  backgroundImageUrl: "",
-  backgroundColor: ""
-}
-
-const response = await orshot.renderFromTemplate({templateId, modifications, responseType: "binary", responseFormat: "png"});
-const arrayBuffer = await response.arrayBuffer();
-const buffer = Buffer.from(arrayBuffer);
-
-createWriteStream("og.png").write(buffer);
+const response = await orshot.renderFromStudioTemplate({
+  templateId: 1234,
+  response: { type: "url", format: "mp4" },
+  videoOptions: {
+    combinePages: true,
+    pageTransition: "fade",
+    pageTransitionDuration: 0.5,
+  },
+});
 ```
 
-This example writes the binary image to the file `og.png` in the current directory.
-
-### Signed URL
+### Publish to Social Accounts
 
 ```js
-import { Orshot } from "orshot";
-
-const orshot = new Orshot("os-ha2jdus1cbz1dpt4mktgjyvx");
+const response = await orshot.renderFromStudioTemplate({
+  templateId: 1234,
+  modifications: { title: "Check out our latest update!" },
+  response: { type: "url", format: "png" },
+  publish: {
+    accounts: [1, 2],
+    content: "Check out our latest design!",
+  },
+});
+// response.publish => [{ platform: "twitter", username: "acmehq", status: "published" }, ...]
+```
 
-let templateId = "open-graph-image-1";
-let modifications = {
-  title: "Orshot",
-  description: "Create Visuals and Automate Image Generation",
-  textColor: "",
-  backgroundImageUrl: "",
-  backgroundColor: ""
-}
+### Schedule a Post
 
-const response = await Orshot.renderFromTemplate({templateId, modifications, expiresAt: 1744276943, renderType: "images", responseFormat: "png"});
-console.log(response);
+```js
+const response = await orshot.renderFromStudioTemplate({
+  templateId: 1234,
+  modifications: { title: "Scheduled post" },
+  response: { type: "url", format: "png" },
+  publish: {
+    accounts: [1],
+    content: "This will be posted later!",
+    schedule: { scheduledFor: "2026-04-01T10:00:00Z" },
+    timezone: "America/New_York",
+  },
+});
 ```
 
+### Parameters
+
+| key                             | required | description                                                                              |
+| ------------------------------- | -------- | ---------------------------------------------------------------------------------------- |
+| `templateId`                    | Yes      | ID of the Studio template.                                                               |
+| `modifications`                 | No       | Object of dynamic modifications for the template.                                        |
+| `response.type`                 | No       | `base64`, `binary`, `url` (Defaults to `url`).                                           |
+| `response.format`               | No       | `png`, `webp`, `jpg`, `jpeg`, `avif`, `pdf`, `mp4`, `webm`, `gif` (Defaults to `png`).   |
+| `response.scale`                | No       | Scale of the output (`1` = original, `2` = double). Defaults to `1`.                     |
+| `response.quality`              | No       | Output quality (`1`-`100`). Controls compression for the rendered output.                 |
+| `response.includePages`         | No       | Page numbers to render for multi-page templates (e.g. `[1, 3]`).                         |
+| `response.fileName`             | No       | Custom file name (without extension). Works with `url` and `binary` types.               |
+| `pdfOptions.margin`             | No       | CSS margin value (e.g. `"20px"`).                                                        |
+| `pdfOptions.rangeFrom`          | No       | Start page number for PDF output.                                                        |
+| `pdfOptions.rangeTo`            | No       | End page number for PDF output.                                                          |
+| `pdfOptions.colorMode`          | No       | `rgb` or `cmyk`.                                                                         |
+| `pdfOptions.dpi`                | No       | DPI for print quality (e.g. `300`).                                                      |
+| `videoOptions.trimStart`        | No       | Trim start time in seconds.                                                              |
+| `videoOptions.trimEnd`          | No       | Trim end time in seconds.                                                                |
+| `videoOptions.muted`            | No       | Mute audio track.                                                                        |
+| `videoOptions.loop`             | No       | Loop the video.                                                                          |
+| `videoOptions.duration`         | No       | Total video duration in seconds.                                                         |
+| `videoOptions.fps`              | No       | Frames per second (`1`-`30`).                                                            |
+| `videoOptions.quality`          | No       | Video quality (`1`-`100`).                                                               |
+| `videoOptions.audioSource`      | No       | External audio URL or array of per-page audio sources.                                   |
+| `videoOptions.subtitleSource`   | No       | Subtitle file URL.                                                                       |
+| `videoOptions.combinePages`     | No       | Combine multi-page templates into a single video.                                        |
+| `videoOptions.pageTransition`   | No       | Transition effect between pages (e.g. `"fade"`, `"dissolve"`, `"wipe"`, `"slide"`).      |
+| `videoOptions.pageTransitionDuration` | No | Transition duration in seconds (`0.1`-`2`).                                              |
+| `publish.accounts`              | No       | Array of social account IDs from your workspace.                                         |
+| `publish.content`               | No       | Caption/text for the social post.                                                        |
+| `publish.isDraft`               | No       | `true` to save as draft instead of publishing.                                           |
+| `publish.schedule.scheduledFor` | No       | ISO date string to schedule the post.                                                    |
+| `publish.timezone`              | No       | Timezone string (e.g. `"America/New_York"`).                                             |
+| `publish.platformOptions`       | No       | Per-account options keyed by account ID.                                                 |
+
+---
+
 ## renderFromTemplate
 
-Use this function to render an image/pdf. Render template takes in 4 options passed as an object
+Render from a pre-built Orshot template.
 
-```
-{
-  templateId,
-  modifications,
-  responseType,
-  responseFormat
-}
+```js
+const response = await orshot.renderFromTemplate({
+  templateId: "open-graph-image-1",
+  modifications: { title: "Hello World", description: "Description here" },
+  responseType: "url",
+  responseFormat: "png",
+});
 ```
 
-| key | required | description |
-|----------|----------|-------------|
-| `templateId` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`, ...) |
-| `modifications` | Yes | Modifications for the selected template. |
-| `responseType` | No | `base64`, `binary`, `url` (Defaults to `base64`). |
-| `responseFormat` | No | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`). |
+| key              | required | description                                                      |
+| ---------------- | -------- | ---------------------------------------------------------------- |
+| `templateId`     | Yes      | ID of the template (`open-graph-image-1`, `tweet-image-1`, etc.) |
+| `modifications`  | Yes      | Modifications for the selected template.                         |
+| `responseType`   | No       | `base64`, `binary`, `url` (Defaults to `url`).                   |
+| `responseFormat` | No       | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`).         |
 
 For available templates and their modifications refer [Orshot Templates Page](https://orshot.com/templates)
 
 ## generateSignedUrl
 
-Use this function to generate signed URL.
+Generate a signed URL for a template.
 
+```js
+const response = await orshot.generateSignedUrl({
+  templateId: "open-graph-image-1",
+  modifications: { title: "Hello World" },
+  expiresAt: 1744276943,
+  renderType: "images",
+  responseFormat: "png",
+});
 ```
-{
-  templateId,
-  modifications,
-  renderType,
-  responseFormat,
-  expiresAt
+
+Use `"never"` for `expiresAt` to create a non-expiring signed URL.
+
+| key              | required | description                                                        |
+| ---------------- | -------- | ------------------------------------------------------------------ |
+| `templateId`     | Yes      | ID of the template.                                                |
+| `modifications`  | Yes      | Modifications for the selected template.                           |
+| `expiresAt`      | Yes      | Unix timestamp (number) or `"never"` for no expiration.            |
+| `renderType`     | No       | `images`, `pdfs`, `videos` (Defaults to `images`).                 |
+| `responseFormat` | No       | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`).           |
+
+## Error Handling
+
+The SDK throws errors with descriptive messages from the API when a request fails.
+
+```js
+try {
+  const response = await orshot.renderFromStudioTemplate({
+    templateId: 1234,
+    modifications: { title: "Hello" },
+  });
+} catch (error) {
+  console.error(error.message);
+  // e.g. "Template not found in workspace"
+  // e.g. "Subscription inactive"
+  // e.g. "Invalid API Key"
 }
 ```
 
-| key | required | description |
-|----------|----------|-------------|
-| `templateId` | Yes | ID of the template (`open-graph-image-1`, `tweet-image-1`, `beautify-screenshot-1`, ...) |
-| `modifications` | Yes | Modifications for the selected template. |
-| `expiresAt` | Yes | Expires at in unix timestamp (Number). |
-| `renderType` | No | `images`, `pdfs` (Defaults to `images`). |
-| `responseFormat` | No | `png`, `webp`, `pdf`, `jpg`, `jpeg` (Defaults to `png`). |
+## TypeScript
 
+All types are exported from the package:
+
+```ts
+import { Orshot } from "orshot";
+import type { StudioRenderOptions, VideoOptions, PdfOptions, PublishOptions } from "orshot";
+```
 
 ## Local development and testing
 

package/dist/constants.d.ts

@@ -1,6 +1,6 @@
 export declare const ORSHOT_SOURCE = "orshot-node-sdk";
 export declare const ORSHOT_API_BASE_URL = "https://api.orshot.com";
 export declare const ORSHOT_API_VERSION = "v1";
-export declare const DEFAULT_RESPONSE_TYPE = "base64";
+export declare const DEFAULT_RESPONSE_TYPE = "url";
 export declare const DEFAULT_RESPONSE_FORMAT = "png";
 export declare const DEFAULT_RENDER_TYPE = "images";

package/dist/constants.js

@@ -4,7 +4,7 @@ exports.DEFAULT_RENDER_TYPE = exports.DEFAULT_RESPONSE_FORMAT = exports.DEFAULT_
 exports.ORSHOT_SOURCE = "orshot-node-sdk";
 exports.ORSHOT_API_BASE_URL = "https://api.orshot.com";
 exports.ORSHOT_API_VERSION = "v1";
-exports.DEFAULT_RESPONSE_TYPE = "base64";
+exports.DEFAULT_RESPONSE_TYPE = "url";
 exports.DEFAULT_RESPONSE_FORMAT = "png";
 exports.DEFAULT_RENDER_TYPE = "images";
 //# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,aAAa,GAAG,iBAAiB,CAAC;AAClC,QAAA,mBAAmB,GAAG,wBAAwB,CAAC;AAC/C,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAC1B,QAAA,qBAAqB,GAAG,QAAQ,CAAC;AACjC,QAAA,uBAAuB,GAAG,KAAK,CAAC;AAChC,QAAA,mBAAmB,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,aAAa,GAAG,iBAAiB,CAAC;AAClC,QAAA,mBAAmB,GAAG,wBAAwB,CAAC;AAC/C,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAC1B,QAAA,qBAAqB,GAAG,KAAK,CAAC;AAC9B,QAAA,uBAAuB,GAAG,KAAK,CAAC;AAChC,QAAA,mBAAmB,GAAG,QAAQ,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { TemplateRenderOptions, SignedUrlOptions } from "./types";
+import { TemplateRenderOptions, SignedUrlOptions, StudioRenderOptions } from "./types";
+export type { ResponseType, ResponseFormat, RenderType, TemplateRenderOptions, SignedUrlOptions, StudioRenderOptions, StudioResponseOptions, PdfOptions, VideoOptions, PublishOptions, PublishSchedule, } from "./types";
 export declare class Orshot {
     private readonly apiKey;
     constructor(apiKey: string);
@@ -9,5 +10,6 @@ export declare class Orshot {
     };
     renderFromTemplate(renderOptions: TemplateRenderOptions): Promise<any>;
     generateSignedUrl(signedUrlOptions: SignedUrlOptions): Promise<any>;
+    renderFromStudioTemplate(options: StudioRenderOptions): Promise<any>;
 }
 export default Orshot;

package/dist/index.js

@@ -46,7 +46,16 @@ class Orshot {
             }),
         });
         if (!response.ok) {
-            throw new Error("Failed to fetch image: " + response.status);
+            let message = `Request failed with status ${response.status}`;
+            try {
+                const errorData = await response.json();
+                if (errorData?.error)
+                    message = errorData.error;
+                else if (errorData?.message)
+                    message = errorData.message;
+            }
+            catch { }
+            throw new Error(message);
         }
         if (responseType === "base64" || responseType === "url") {
             const jsonData = await response.json();
@@ -78,11 +87,81 @@ class Orshot {
             }),
         });
         if (!response.ok) {
-            throw new Error("Failed to fetch image: " + response.status);
+            let message = `Request failed with status ${response.status}`;
+            try {
+                const errorData = await response.json();
+                if (errorData?.error)
+                    message = errorData.error;
+                else if (errorData?.message)
+                    message = errorData.message;
+            }
+            catch { }
+            throw new Error(message);
         }
         const jsonData = await response.json();
         return jsonData;
     }
+    async renderFromStudioTemplate(options) {
+        const { templateId, modifications, response: responseOptions, pdfOptions, videoOptions, publish } = options;
+        const endpoint = `${this.getBaseUrl()}/studio/render`;
+        const body = {
+            templateId,
+            source: constants_1.ORSHOT_SOURCE,
+        };
+        if (modifications) {
+            body.modifications = modifications;
+        }
+        body.response = {
+            type: responseOptions?.type ?? constants_1.DEFAULT_RESPONSE_TYPE,
+            format: responseOptions?.format ?? constants_1.DEFAULT_RESPONSE_FORMAT,
+        };
+        if (responseOptions?.scale !== undefined) {
+            body.response.scale = responseOptions.scale;
+        }
+        if (responseOptions?.includePages) {
+            body.response.includePages = responseOptions.includePages;
+        }
+        if (responseOptions?.quality !== undefined) {
+            body.response.quality = responseOptions.quality;
+        }
+        if (responseOptions?.fileName) {
+            body.response.fileName = responseOptions.fileName;
+        }
+        if (pdfOptions) {
+            body.pdfOptions = pdfOptions;
+        }
+        if (videoOptions) {
+            body.videoOptions = videoOptions;
+        }
+        if (publish) {
+            body.publish = publish;
+        }
+        const response = await fetch(endpoint, {
+            method: "POST",
+            headers: this.getHeaders(),
+            body: JSON.stringify(body),
+        });
+        if (!response.ok) {
+            let message = `Request failed with status ${response.status}`;
+            try {
+                const errorData = await response.json();
+                if (errorData?.error)
+                    message = errorData.error;
+                else if (errorData?.message)
+                    message = errorData.message;
+            }
+            catch { }
+            throw new Error(message);
+        }
+        const responseType = responseOptions?.type ?? constants_1.DEFAULT_RESPONSE_TYPE;
+        if (responseType === "base64" || responseType === "url") {
+            const jsonData = await response.json();
+            return jsonData;
+        }
+        else {
+            return response;
+        }
+    }
 }
 exports.Orshot = Orshot;
 exports.default = Orshot;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,2CAA0J;AAE1J,MAAa,MAAM;IACA,MAAM,CAAS;IAEhC,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,UAAU,CAAC,OAAgB;QAChC,MAAM,OAAO,GAAG,+BAAmB,CAAC;QAEpC,IAAI,UAAU,GAAG,8BAAkB,CAAC;QAEpC,IAAI,OAAO,EAAE,CAAC;YACZ,UAAU,GAAG,OAAO,CAAC;QACvB,CAAC;QAED,OAAO,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC;IACpC,CAAC;IAEM,UAAU;QACf,OAAO;YACL,cAAc,EAAE,kBAAkB;YAClC,eAAe,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;SACzC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,aAAoC;QAClE,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC;QAEhF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,YAAY,GAAG,iCAAqB,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,mCAAuB,CAAC;QAC3C,CAAC;QAED,IAAI,QAAQ,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,oBAAoB,UAAU,EAAE,CAAC;QAEpE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;YAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,QAAQ,EAAE;oBACR,IAAI,EAAE,YAAY;oBAClB,MAAM,EAAE,cAAc;iBACvB;gBACD,aAAa,EAAE,aAAa;gBAC5B,MAAM,EAAE,yBAAa;aACtB,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC/D,CAAC;QAED,IAAI,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,KAAK,EAAE,CAAC;YACxD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACvC,OAAO,QAAQ,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,gBAAkC;QAC/D,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC;QAE5F,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,UAAU,GAAG,+BAAmB,CAAC;QACnC,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,mCAAuB,CAAC;QAC3C,CAAC;QAED,IAAI,QAAQ,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,oBAAoB,CAAC;QAExD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;YAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,UAAU,EAAE,UAAU;gBACtB,UAAU,EAAE,UAAU;gBACtB,cAAc,EAAE,cAAc;gBAC9B,aAAa,EAAE,aAAa;gBAC5B,MAAM,EAAE,yBAAa;gBACrB,SAAS,EAAE,SAAS;aACrB,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACvC,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AApGD,wBAoGC;AAED,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,2CAA0J;AAgB1J,MAAa,MAAM;IACA,MAAM,CAAS;IAEhC,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,UAAU,CAAC,OAAgB;QAChC,MAAM,OAAO,GAAG,+BAAmB,CAAC;QAEpC,IAAI,UAAU,GAAG,8BAAkB,CAAC;QAEpC,IAAI,OAAO,EAAE,CAAC;YACZ,UAAU,GAAG,OAAO,CAAC;QACvB,CAAC;QAED,OAAO,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC;IACpC,CAAC;IAEM,UAAU;QACf,OAAO;YACL,cAAc,EAAE,kBAAkB;YAClC,eAAe,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;SACzC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,aAAoC;QAClE,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC;QAEhF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,YAAY,GAAG,iCAAqB,CAAC;QACvC,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,mCAAuB,CAAC;QAC3C,CAAC;QAED,IAAI,QAAQ,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,oBAAoB,UAAU,EAAE,CAAC;QAEpE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;YAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,QAAQ,EAAE;oBACR,IAAI,EAAE,YAAY;oBAClB,MAAM,EAAE,cAAc;iBACvB;gBACD,aAAa,EAAE,aAAa;gBAC5B,MAAM,EAAE,yBAAa;aACtB,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,OAAO,GAAG,8BAA8B,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC9D,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,IAAI,SAAS,EAAE,KAAK;oBAAE,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC;qBAC3C,IAAI,SAAS,EAAE,OAAO;oBAAE,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3D,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,KAAK,EAAE,CAAC;YACxD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACvC,OAAO,QAAQ,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,gBAAkC;QAC/D,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,gBAAgB,CAAC;QAE5F,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,UAAU,GAAG,+BAAmB,CAAC;QACnC,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,mCAAuB,CAAC;QAC3C,CAAC;QAED,IAAI,QAAQ,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,oBAAoB,CAAC;QAExD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;YAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,UAAU,EAAE,UAAU;gBACtB,UAAU,EAAE,UAAU;gBACtB,cAAc,EAAE,cAAc;gBAC9B,aAAa,EAAE,aAAa;gBAC5B,MAAM,EAAE,yBAAa;gBACrB,SAAS,EAAE,SAAS;aACrB,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,OAAO,GAAG,8BAA8B,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC9D,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,IAAI,SAAS,EAAE,KAAK;oBAAE,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC;qBAC3C,IAAI,SAAS,EAAE,OAAO;oBAAE,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3D,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACvC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,OAA4B;QAChE,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAE5G,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC;QAEtD,MAAM,IAAI,GAAwB;YAChC,UAAU;YACV,MAAM,EAAE,yBAAa;SACtB,CAAC;QAEF,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACrC,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG;YACd,IAAI,EAAE,eAAe,EAAE,IAAI,IAAI,iCAAqB;YACpD,MAAM,EAAE,eAAe,EAAE,MAAM,IAAI,mCAAuB;SAC3D,CAAC;QAEF,IAAI,eAAe,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC;QAC9C,CAAC;QAED,IAAI,eAAe,EAAE,YAAY,EAAE,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,eAAe,CAAC,YAAY,CAAC;QAC5D,CAAC;QAED,IAAI,eAAe,EAAE,OAAO,KAAK,SAAS,EAAE,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;QAClD,CAAC;QAED,IAAI,eAAe,EAAE,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC;QACpD,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/B,CAAC;QAED,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACnC,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE;YAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,OAAO,GAAG,8BAA8B,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC9D,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACxC,IAAI,SAAS,EAAE,KAAK;oBAAE,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC;qBAC3C,IAAI,SAAS,EAAE,OAAO;oBAAE,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3D,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,YAAY,GAAG,eAAe,EAAE,IAAI,IAAI,iCAAqB,CAAC;QAEpE,IAAI,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,KAAK,EAAE,CAAC;YACxD,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACvC,OAAO,QAAQ,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;CACF;AAzLD,wBAyLC;AAED,kBAAe,MAAM,CAAC"}

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 export type ResponseType = "base64" | "binary" | "url";
-export type ResponseFormat = "png" | "webp" | "pdf" | "jpg" | "jpeg";
-export type RenderType = "images" | "pdfs";
+export type ResponseFormat = "png" | "webp" | "pdf" | "jpg" | "jpeg" | "avif" | "mp4" | "webm" | "gif";
+export type RenderType = "images" | "pdfs" | "videos";
 export type TemplateRenderOptions = {
     templateId: string;
     modifications: any;
@@ -12,5 +12,58 @@ export type SignedUrlOptions = {
     modifications: any;
     renderType?: RenderType;
     responseFormat?: ResponseFormat;
-    expiresAt: number;
+    expiresAt: number | "never";
+};
+export type StudioResponseOptions = {
+    type?: ResponseType;
+    format?: ResponseFormat;
+    scale?: number;
+    quality?: number;
+    includePages?: number[];
+    fileName?: string;
+};
+export type PdfOptions = {
+    margin?: string;
+    rangeFrom?: number | null;
+    rangeTo?: number | null;
+    colorMode?: "rgb" | "cmyk";
+    dpi?: number;
+};
+export type VideoOptions = {
+    trimStart?: number;
+    trimEnd?: number;
+    muted?: boolean;
+    loop?: boolean;
+    duration?: number;
+    fps?: number;
+    quality?: number;
+    audioSource?: string | Array<{
+        url: string;
+        pageId?: string;
+        page?: number;
+        track?: string;
+    }>;
+    subtitleSource?: string;
+    combinePages?: boolean;
+    pageTransition?: string;
+    pageTransitionDuration?: number;
+};
+export type PublishSchedule = {
+    scheduledFor?: string;
+};
+export type PublishOptions = {
+    accounts: number[];
+    content?: string;
+    isDraft?: boolean;
+    schedule?: PublishSchedule;
+    timezone?: string;
+    platformOptions?: Record<string, any>;
+};
+export type StudioRenderOptions = {
+    templateId: number | string;
+    modifications?: Record<string, any>;
+    response?: StudioResponseOptions;
+    pdfOptions?: PdfOptions;
+    videoOptions?: VideoOptions;
+    publish?: PublishOptions;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orshot",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "description": "Orshot API SDK for Node.js",
   "homepage": "https://orshot.com",
   "bugs": {
@@ -14,6 +14,9 @@
   "author": "Rishi Mohan <iamrishi.ms@gmail.com>",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc"
   },

package/.github/workflows/npm-publish.yml

@@ -1,24 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: Publish Package to npmjs
-on:
-  release:
-    types: [published]
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - run: npm ci
-      - run: npm run build
-      - run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/src/constants.ts

@@ -1,6 +0,0 @@
-export const ORSHOT_SOURCE = "orshot-node-sdk";
-export const ORSHOT_API_BASE_URL = "https://api.orshot.com";
-export const ORSHOT_API_VERSION = "v1";
-export const DEFAULT_RESPONSE_TYPE = "base64";
-export const DEFAULT_RESPONSE_FORMAT = "png";
-export const DEFAULT_RENDER_TYPE = "images";

package/src/index.ts

@@ -1,106 +0,0 @@
-import { TemplateRenderOptions, SignedUrlOptions } from "./types";
-import { DEFAULT_RESPONSE_TYPE, DEFAULT_RESPONSE_FORMAT, DEFAULT_RENDER_TYPE, ORSHOT_API_BASE_URL, ORSHOT_API_VERSION, ORSHOT_SOURCE } from "./constants";
-
-export class Orshot {
-  private readonly apiKey: string;
-
-  constructor(apiKey: string) {
-    if (!apiKey) {
-      throw new Error("API Key is required.")
-    }
-    this.apiKey = apiKey;
-  }
-
-  public getBaseUrl(version?: string) {
-    const baseUrl = ORSHOT_API_BASE_URL;
-
-    let apiVersion = ORSHOT_API_VERSION;
-
-    if (version) {
-      apiVersion = version;
-    }
-
-    return `${baseUrl}/${apiVersion}`;
-  }
-
-  public getHeaders() {
-    return {
-      'Content-Type': 'application/json',
-      'Authorization': `Bearer ${this.apiKey}`
-    };
-  }
-
-  public async renderFromTemplate(renderOptions: TemplateRenderOptions) {
-    let { templateId, modifications, responseType, responseFormat } = renderOptions;
-
-    if (!responseType) {
-      responseType = DEFAULT_RESPONSE_TYPE;
-    }
-
-    if (!responseFormat) {
-      responseFormat = DEFAULT_RESPONSE_FORMAT;
-    }
-
-    let endpoint = `${this.getBaseUrl()}/generate/images/${templateId}`;
-
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: this.getHeaders(),
-      body: JSON.stringify({
-        response: {
-          type: responseType,
-          format: responseFormat
-        },
-        modifications: modifications,
-        source: ORSHOT_SOURCE
-      }),
-    });
-
-    if (!response.ok) {
-      throw new Error("Failed to fetch image: " + response.status);
-    }
-
-    if (responseType === "base64" || responseType === "url") {
-      const jsonData = await response.json();
-      return jsonData;
-    } else {
-      return response;
-    }
-  }
-
-  public async generateSignedUrl(signedUrlOptions: SignedUrlOptions) {
-    let { templateId, modifications, renderType, responseFormat, expiresAt } = signedUrlOptions;
-
-    if (!renderType) {
-      renderType = DEFAULT_RENDER_TYPE;
-    }
-
-    if (!responseFormat) {
-      responseFormat = DEFAULT_RESPONSE_FORMAT;
-    }
-
-    let endpoint = `${this.getBaseUrl()}/signed-url/create`;
-
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: this.getHeaders(),
-      body: JSON.stringify({
-        templateId: templateId,
-        renderType: renderType,
-        responseFormat: responseFormat,
-        modifications: modifications,
-        source: ORSHOT_SOURCE,
-        expiresAt: expiresAt
-      }),
-    });
-
-    if (!response.ok) {
-      throw new Error("Failed to fetch image: " + response.status);
-    }
-
-    const jsonData = await response.json();
-    return jsonData;
-  }
-}
-
-export default Orshot;

package/src/types.ts

@@ -1,18 +0,0 @@
-export type ResponseType = "base64" | "binary" | "url";
-export type ResponseFormat = "png" | "webp" | "pdf" | "jpg" | "jpeg" ;
-export type RenderType = "images" | "pdfs";
-
-export type TemplateRenderOptions = {
-  templateId: string;
-  modifications: any;
-  responseType?: ResponseType;
-  responseFormat?: ResponseFormat;
-};
-
-export type SignedUrlOptions = {
-  templateId: string;
-  modifications: any;
-  renderType?: RenderType;
-  responseFormat?: ResponseFormat;
-  expiresAt: number;
-};

package/tsconfig.json

@@ -1,18 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "commonjs",
-    "esModuleInterop": true,
-    "declaration": true,
-    "target": "esnext",
-    "moduleResolution": "node",
-    "sourceMap": true,
-    "outDir": "dist"
-  },
-  "include": [
-    "src/**/*"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-}