orshot 0.1.0 → 0.1.2

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

@@ -18,6 +18,7 @@ jobs:
           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/README.md

@@ -43,6 +43,13 @@ const response = await Orshot.renderFromTemplate({templateId, modifications, res
 console.log(response);
 ```
 
+### Generate signed URL
+
+```js
+const response = await Orshot.renderFromTemplate({templateId, modifications, expiresAt: 1744276943, renderType: "images", responseFormat: "png"});
+console.log(response);
+```
+
 ## Example
 
 ### `Base64` response format
@@ -135,6 +142,26 @@ createWriteStream("og.png").write(buffer);
 
 This example writes the binary image to the file `og.png` in the current directory.
 
+### Signed URL
+
+```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, expiresAt: 1744276943, renderType: "images", responseFormat: "png"});
+console.log(response);
+```
+
 ## renderFromTemplate
 
 Use this function to render an image/pdf. Render template takes in 4 options passed as an object
@@ -157,13 +184,36 @@ Use this function to render an image/pdf. Render template takes in 4 options pas
 
 For available templates and their modifications refer [Orshot Templates Page](https://orshot.com/templates)
 
+## generateSignedUrl
+
+Use this function to generate signed URL.
+
+```
+{
+  templateId,
+  modifications,
+  renderType,
+  responseFormat,
+  expiresAt
+}
+```
+
+| 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`). |
+
+
 ## Local development and testing
 
 Run these from the project
 
 `npm run build`
 
-`npm run link`
+`npm link`
 
 Create a test directory and add `index.js` file
 
@@ -172,3 +222,7 @@ 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.
+
+## Publish package to NPM
+
+Create a new release from GitHub. This will trigger a GitHub action which will publish the package to NPM.

package/dist/constants.d.ts

@@ -0,0 +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_FORMAT = "png";
+export declare const DEFAULT_RENDER_TYPE = "images";

package/dist/constants.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_RENDER_TYPE = exports.DEFAULT_RESPONSE_FORMAT = exports.DEFAULT_RESPONSE_TYPE = exports.ORSHOT_API_VERSION = exports.ORSHOT_API_BASE_URL = exports.ORSHOT_SOURCE = void 0;
+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_FORMAT = "png";
+exports.DEFAULT_RENDER_TYPE = "images";
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +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"}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { TemplateRenderOptions, SignedUrlOptions } from "./types";
+export declare class Orshot {
+    private readonly apiKey;
+    constructor(apiKey: string);
+    getBaseUrl(version?: string): string;
+    getHeaders(): {
+        'Content-Type': string;
+        Authorization: string;
+    };
+    renderFromTemplate(renderOptions: TemplateRenderOptions): Promise<any>;
+    generateSignedUrl(signedUrlOptions: SignedUrlOptions): Promise<any>;
+}
+export default Orshot;

package/dist/index.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Orshot = void 0;
+const constants_1 = require("./constants");
+class Orshot {
+    apiKey;
+    constructor(apiKey) {
+        if (!apiKey) {
+            throw new Error("API Key is required.");
+        }
+        this.apiKey = apiKey;
+    }
+    getBaseUrl(version) {
+        const baseUrl = constants_1.ORSHOT_API_BASE_URL;
+        let apiVersion = constants_1.ORSHOT_API_VERSION;
+        if (version) {
+            apiVersion = version;
+        }
+        return `${baseUrl}/${apiVersion}`;
+    }
+    getHeaders() {
+        return {
+            'Content-Type': 'application/json',
+            'Authorization': `Bearer ${this.apiKey}`
+        };
+    }
+    async renderFromTemplate(renderOptions) {
+        let { templateId, modifications, responseType, responseFormat } = renderOptions;
+        if (!responseType) {
+            responseType = constants_1.DEFAULT_RESPONSE_TYPE;
+        }
+        if (!responseFormat) {
+            responseFormat = constants_1.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: constants_1.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;
+        }
+    }
+    async generateSignedUrl(signedUrlOptions) {
+        let { templateId, modifications, renderType, responseFormat, expiresAt } = signedUrlOptions;
+        if (!renderType) {
+            renderType = constants_1.DEFAULT_RENDER_TYPE;
+        }
+        if (!responseFormat) {
+            responseFormat = constants_1.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: constants_1.ORSHOT_SOURCE,
+                expiresAt: expiresAt
+            }),
+        });
+        if (!response.ok) {
+            throw new Error("Failed to fetch image: " + response.status);
+        }
+        const jsonData = await response.json();
+        return jsonData;
+    }
+}
+exports.Orshot = Orshot;
+exports.default = Orshot;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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"}

package/dist/types.d.ts

@@ -0,0 +1,16 @@
+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/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "orshot",
-  "version": "0.1.0",
-  "description": "Orshot API SDK for node.js",
-  "homepage": "https://github.com/rishimohan/orshot-nodejs-sdk#readme",
+  "version": "0.1.2",
+  "description": "Orshot API SDK for Node.js",
+  "homepage": "https://orshot.com",
   "bugs": {
     "url": "https://github.com/rishimohan/orshot-nodejs-sdk/issues"
   },

package/src/constants.ts

@@ -2,4 +2,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";
+export const DEFAULT_RESPONSE_FORMAT = "png";
+export const DEFAULT_RENDER_TYPE = "images";

package/src/index.ts

@@ -1,5 +1,5 @@
-import { TemplateRenderOptions } from "./types";
-import { DEFAULT_RESPONSE_TYPE, DEFAULT_RESPONSE_FORMAT, ORSHOT_API_BASE_URL, ORSHOT_API_VERSION, ORSHOT_SOURCE } from "./constants";
+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;
@@ -67,6 +67,40 @@ export class Orshot {
       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,5 +1,6 @@
 export type ResponseType = "base64" | "binary" | "url";
 export type ResponseFormat = "png" | "webp" | "pdf" | "jpg" | "jpeg" ;
+export type RenderType = "images" | "pdfs";
 
 export type TemplateRenderOptions = {
   templateId: string;
@@ -7,3 +8,11 @@ export type TemplateRenderOptions = {
   responseType?: ResponseType;
   responseFormat?: ResponseFormat;
 };
+
+export type SignedUrlOptions = {
+  templateId: string;
+  modifications: any;
+  renderType?: RenderType;
+  responseFormat?: ResponseFormat;
+  expiresAt: number;
+};