@pipedream/printnode 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The PrintNode API on Pipedream allows you to integrate cloud printing capabilities into workflows. It supports automating print jobs, managing printers, and querying printer status. With Pipedream's ability to connect to hundreds of apps, you can trigger print jobs from emails, forms, databases, or custom events. The API's functions can be weaved into broader business processes to streamline document handling.
+
+# Example Use Cases
+
+- **Print Shipping Labels on New Orders**: Automatically print shipping labels when new orders come in from an eCommerce platform like Shopify. When an order is placed, Pipedream triggers a workflow that sends the order's shipping label to a designated printer via PrintNode.
+
+- **Print Invoices on Payment Confirmation**: Set up a workflow where invoices are automatically printed when payment is confirmed through payment processors like Stripe or PayPal. Once the payment succeeds, a PDF invoice is generated and sent to PrintNode for printing.
+
+- **Daily Printout of Sales Reports**: Schedule a daily workflow that queries your sales database, generates a report, and prints it using PrintNode. This could be connected to apps like Google Sheets or Airtable where your sales data is updated.

package/actions/get-printer/get-printer.mjs

@@ -0,0 +1,26 @@
+import printnode from "../../printnode.app.mjs";
+
+export default {
+  key: "printnode-get-printer",
+  name: "Get Printer",
+  description: "Retrieves data about a specific printer. [See the documentation](https://www.printnode.com/en/docs/api/curl#printers)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    printnode,
+    printerId: {
+      propDefinition: [
+        printnode,
+        "printerId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const printerData = await this.printnode.getPrinter({
+      $,
+      printerId: this.printerId,
+    });
+    $.export("$summary", `Retrieved data for printer (ID: ${this.printerId})`);
+    return printerData;
+  },
+};

package/actions/list-print-jobs/list-print-jobs.mjs

@@ -0,0 +1,20 @@
+import printnode from "../../printnode.app.mjs";
+
+export default {
+  key: "printnode-list-print-jobs",
+  name: "List Print Jobs",
+  description: "Returns a list of all print jobs that have been submitted. [See the documentation](https://www.printnode.com/en/docs/api/curl#printjob-viewing)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    printnode,
+  },
+  async run({ $ }) {
+    const response = await this.printnode.listPrintJobs({
+      $,
+    });
+
+    $.export("$summary", "Successfully retrieved print jobs");
+    return response;
+  },
+};

package/actions/send-print-job/send-print-job.mjs

@@ -0,0 +1,91 @@
+import printnode from "../../printnode.app.mjs";
+import { getFileStream } from "@pipedream/platform";
+
+export default {
+  key: "printnode-send-print-job",
+  name: "Send Print Job",
+  description: "Sends a print job to a specified printer. [See the documentation](https://www.printnode.com/en/docs/api/curl#creating-print-jobs)",
+  version: "1.0.0",
+  type: "action",
+  props: {
+    printnode,
+    printerId: {
+      propDefinition: [
+        printnode,
+        "printerId",
+      ],
+    },
+    contentType: {
+      propDefinition: [
+        printnode,
+        "contentType",
+      ],
+    },
+    filePath: {
+      type: "string",
+      label: "File Path or URL",
+      description: "The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)",
+    },
+    title: {
+      type: "string",
+      label: "Title",
+      description: "A title to give the print job. This is the name which will appear in the operating system's print queue.",
+      optional: true,
+    },
+    source: {
+      type: "string",
+      label: "Source",
+      description: "A text description of how the print job was created or where the print job originated.",
+      optional: true,
+    },
+    options: {
+      type: "object",
+      label: "Options",
+      description: "An object describing various options which can be set for this print job. [See the documentation for more information](https://www.printnode.com/en/docs/api/curl#printjob-options).",
+      optional: true,
+    },
+    expireAfter: {
+      type: "integer",
+      label: "Expire After",
+      description: "The maximum number of seconds PrintNode should retain this print job in the event that the print job cannot be printed immediately.",
+      optional: true,
+    },
+    qty: {
+      type: "integer",
+      label: "Quantity",
+      description: "A positive integer specifying the number of times this print job should be delivered to the print queue.",
+      optional: true,
+      default: 1,
+    },
+    authentication: {
+      type: "object",
+      label: "Authentication",
+      description: "If access to the file URL requires HTTP Basic or Digest Authentication, specify the username and password information here. [See the documentation for more information](https://www.printnode.com/en/docs/api/curl#printjob-creating).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      printnode, contentType, filePath, ...props
+    } = this;
+
+    const stream = await getFileStream(filePath);
+    const chunks = [];
+    for await (const chunk of stream) {
+      chunks.push(chunk);
+    }
+    const content = Buffer.concat(chunks).toString("base64");
+
+    const response = await printnode.createPrintJob({
+      $,
+      data: {
+        contentType,
+        content,
+        ...props,
+      },
+    });
+
+    $.export("$summary", `Successfully sent print job to printer with ID ${this.printerId}`);
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,10 @@
+export const PRINT_CONTENT_OPTIONS = [
+  {
+    label: "PDF (File)",
+    value: "pdf_base64",
+  },
+  {
+    label: "Raw Document (File)",
+    value: "raw_base64",
+  },
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/printnode",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream PrintNode Components",
   "main": "printnode.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.0"
   }
 }

package/printnode.app.mjs

@@ -1,11 +1,85 @@
+import { axios } from "@pipedream/platform";
+import { PRINT_CONTENT_OPTIONS } from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "printnode",
-  propDefinitions: {},
+  propDefinitions: {
+    printerId: {
+      type: "integer",
+      label: "Printer ID",
+      description: "Select a Printer or provide a custom Printer ID.",
+      async options() {
+        const printers = await this.listPrinters();
+        return printers?.map?.(({
+          id, name,
+        }) => ({
+          label: name,
+          value: id,
+        }));
+      },
+    },
+    contentType: {
+      type: "string",
+      label: "Content Type",
+      description: "The type of content you are sending. [See the documentation for more information](https://www.printnode.com/en/docs/api/curl#create-printjob-content)",
+      options: PRINT_CONTENT_OPTIONS,
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.printnode.com";
+    },
+    async _makeRequest({
+      $ = this, ...otherOpts
+    }) {
+      return axios($, {
+        ...otherOpts,
+        baseURL: this._baseUrl(),
+        auth: {
+          username: this.$auth.api_key,
+          password: "",
+        },
+      });
+    },
+    async createPrintJob(args) {
+      return this._makeRequest({
+        method: "POST",
+        url: "/printjobs",
+        ...args,
+      });
+    },
+    async getPrinter({
+      printerId, ...args
+    }) {
+      return this._makeRequest({
+        url: `/printers/${printerId}`,
+        ...args,
+      });
+    },
+    async listPrinters() {
+      return this._makeRequest({
+        url: "/printers",
+      });
+    },
+    async listPrintJobs(args) {
+      return this._makeRequest({
+        url: "/printjobs",
+        ...args,
+      });
+    },
+    async createWebhook(args) {
+      return this._makeRequest({
+        method: "POST",
+        url: "/webhook",
+        ...args,
+      });
+    },
+    async deleteWebhook(webhookId) {
+      return this._makeRequest({
+        method: "DELETE",
+        url: `/webhook/${webhookId}`,
+      });
     },
   },
-};
+};

package/sources/new-event-instant/new-event-instant.mjs

@@ -0,0 +1,68 @@
+import printnode from "../../printnode.app.mjs";
+
+export default {
+  key: "printnode-new-event-instant",
+  name: "New Event Instant",
+  description:
+    "Emit new event when a new printnode event is created. [See the documentation](https://www.printnode.com/en/docs/api/curl)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    printnode,
+    db: "$.service.db",
+    http: "$.interface.http",
+    eventTypes: {
+      type: "string[]",
+      label: "Event Types",
+      description: "The types of events you want to receive. If not specified, all available events will be emitted. [See the documentation for more information](https://www.printnode.com/en/docs/api/curl#webhooks).",
+      optional: true,
+      options: [
+        "computer state",
+        "print job state",
+      ],
+    },
+  },
+  methods: {
+    _getSecret() {
+      return this.db.get("secret");
+    },
+    _setSecret(value) {
+      this.db.set("secret", value);
+    },
+    _getWebhookId() {
+      return this.db.get("webhookId");
+    },
+    _setWebhookId(value) {
+      this.db.set("webhookId", value);
+    },
+  },
+  hooks: {
+    async activate() {
+      const secret = `pd-${Date.now()}`;
+      this._setSecret(secret);
+      const { 0: { webhookId } } = await this.printnode.createWebhook({
+        data: {
+          url: this.http.endpoint,
+          secret,
+          messages: this.eventTypes ?? [
+            "*",
+          ],
+        },
+      });
+      this._setWebhookId(webhookId);
+    },
+    async deactivate() {
+      const id = this._getWebhookId();
+      await this.printnode.deleteWebhook(id);
+    },
+  },
+  async run({ body }) {
+    const ts = Date.now();
+    this.$emit(body, {
+      id: body.id ?? ts,
+      summary: `New event ${body.id ?? body.message ?? ""}`,
+      ts,
+    });
+  },
+};