orshot 0.1.0

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

@@ -0,0 +1,23 @@
+# 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 publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,174 @@
+# Orshot Node.js API SDK
+
+View on npmjs: https://www.npmjs.com/package/orshot
+
+## Installation
+
+Using `npm`
+```
+npm install --save orshot
+```
+
+Using `yarn`
+```
+yarn add orshot
+```
+
+## Usage
+
+If you don't have your API key, get one from [orshot.com](https://orshot.com)
+
+### Import
+
+```
+const { Orshot } = require('orshot');
+```
+
+With `ES6`
+
+```
+import { Orshot } from "orshot";
+```
+
+### Initialise
+
+```js
+const orshot = new Orshot("Your API key");
+```
+
+### Generate image
+
+```js
+const response = await Orshot.renderFromTemplate({templateId, modifications, responseType: "base64", responseFormat: "png"});
+console.log(response);
+```
+
+## Example
+
+### `Base64` response format
+
+```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);
+```
+
+API Response
+```
+{
+  data: {
+    content: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABLAAAAJ2CAYAAABPQHtcAAAAAXNSR0IArs4c6QAAIABJREFUeJzs3XmYJXdZL/Bvna37dM90FghLCBAQkC1BCBAMShLFBJAgKnofroBeFUUF5LrhiihXcV8BQRYVUUAlIewIGPbFmLCFLWwCYZEtzPR+trp/TM/......',
+    format: 'png',
+    type: 'base64',
+    responseTime: 3375.72
+  }
+}
+```
+
+### `URL` response format
+
+```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
+  }
+}
+```
+
+### `Binary` response format
+
+```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);
+```
+
+This example writes the binary image to the file `og.png` in the current directory.
+
+## renderFromTemplate
+
+Use this function to render an image/pdf. Render template takes in 4 options passed as an object
+
+```
+{
+  templateId,
+  modifications,
+  responseType,
+  responseFormat
+}
+```
+
+| 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`). |
+
+For available templates and their modifications refer [Orshot Templates Page](https://orshot.com/templates)
+
+## Local development and testing
+
+Run these from the project
+
+`npm run build`
+
+`npm run link`
+
+Create a test directory and add `index.js` file
+
+Write simple code to generate an image from a template.
+
+From the `test` directory, run `npm link orshot`
+
+You can now run `node index.js` to test if the sdk code works as expected.

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "orshot",
+  "version": "0.1.0",
+  "description": "Orshot API SDK for node.js",
+  "homepage": "https://github.com/rishimohan/orshot-nodejs-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/rishimohan/orshot-nodejs-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rishimohan/orshot-nodejs-sdk.git"
+  },
+  "license": "ISC",
+  "author": "Rishi Mohan <iamrishi.ms@gmail.com>",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,5 @@
+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";

package/src/index.ts

@@ -0,0 +1,72 @@
+import { TemplateRenderOptions } from "./types";
+import { DEFAULT_RESPONSE_TYPE, DEFAULT_RESPONSE_FORMAT, 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;
+    }
+  }
+}
+
+export default Orshot;

package/src/types.ts

@@ -0,0 +1,9 @@
+export type ResponseType = "base64" | "binary" | "url";
+export type ResponseFormat = "png" | "webp" | "pdf" | "jpg" | "jpeg" ;
+
+export type TemplateRenderOptions = {
+  templateId: string;
+  modifications: any;
+  responseType?: ResponseType;
+  responseFormat?: ResponseFormat;
+};

package/tsconfig.json

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