@pipedream/quaderno 0.0.1 → 0.0.3

package/actions/common/invoice.mjs

@@ -0,0 +1,163 @@
+import app from "../../quaderno.app.mjs";
+import constants from "../../common/constants.mjs";
+
+const { SEP } = constants;
+
+export default {
+  props: {
+    app,
+    firstName: {
+      description: "The customer's first name who will be billed.",
+      propDefinition: [
+        app,
+        "firstName",
+      ],
+    },
+    lastName: {
+      description: "The customer's last name who will be billed.",
+      propDefinition: [
+        app,
+        "lastName",
+      ],
+    },
+    dueDate: {
+      propDefinition: [
+        app,
+        "dueDate",
+      ],
+    },
+    currency: {
+      propDefinition: [
+        app,
+        "currency",
+      ],
+    },
+    recurringPeriod: {
+      propDefinition: [
+        app,
+        "recurringPeriod",
+      ],
+    },
+    recurringFrequency: {
+      propDefinition: [
+        app,
+        "recurringFrequency",
+      ],
+    },
+    country: {
+      propDefinition: [
+        app,
+        "country",
+      ],
+    },
+    postalCode: {
+      propDefinition: [
+        app,
+        "postalCode",
+      ],
+    },
+    region: {
+      propDefinition: [
+        app,
+        "region",
+      ],
+    },
+    streetLine1: {
+      propDefinition: [
+        app,
+        "streetLine1",
+      ],
+    },
+    subject: {
+      propDefinition: [
+        app,
+        "subject",
+      ],
+    },
+    howManyItems: {
+      propDefinition: [
+        app,
+        "howManyItems",
+      ],
+    },
+  },
+  additionalProps() {
+    return Array.from({
+      length: this.howManyItems,
+    }).reduce((props, _, idx) => {
+      const counter = idx + 1;
+      const item = `item${counter}`;
+      const label = `Item ${counter}:`;
+      const description = `${item}${SEP}description`;
+      const discountRate = `${item}${SEP}discountRate`;
+      const productCode = `${item}${SEP}productCode`;
+      const quantity = `${item}${SEP}quantity`;
+      const totalAmount = `${item}${SEP}totalAmount`;
+      const unitPrice = `${item}${SEP}unitPrice`;
+      return {
+        ...props,
+        [description]: {
+          type: "string",
+          label: `${label} Description`,
+          description: "The description of the item.",
+          optional: true,
+        },
+        [discountRate]: {
+          type: "string",
+          label: `${label} Discount Rate`,
+          description: "Discount percent out of 100, if applicable.",
+          optional: true,
+        },
+        [productCode]: {
+          type: "string",
+          label: `${label} Product Code`,
+          description: "The SKU of the Quaderno **Product** being invoiced. Use this attribute if you want to track your sales per product.",
+          optional: true,
+        },
+        [quantity]: {
+          type: "integer",
+          label: `${label} Quantity`,
+          description: "The quantity of the item.",
+          optional: true,
+          default: 1,
+        },
+        [totalAmount]: {
+          type: "string",
+          label: `${label} Total Amount`,
+          description: "The total amount to be charged after discounts and taxes. Required if **Unit Price** is not passed.",
+          optional: true,
+        },
+        [unitPrice]: {
+          type: "string",
+          label: `${label} Unit Price`,
+          description: "The unit price of the item before any discount or tax is applied. Required if **Total Amount** is not passed.",
+          optional: true,
+        },
+      };
+    }, {});
+  },
+  methods: {
+    getItems(length) {
+      return Array.from({
+        length,
+      }).map((_, idx) => {
+        const counter = idx + 1;
+        const item = `item${counter}`;
+        const description = this[`${item}${SEP}description`];
+        const discountRate = this[`${item}${SEP}discountRate`];
+        const productCode = this[`${item}${SEP}productCode`];
+        const quantity = this[`${item}${SEP}quantity`];
+        const totalAmount = this[`${item}${SEP}totalAmount`];
+        const unitPrice = this[`${item}${SEP}unitPrice`];
+        return {
+          description,
+          discount_rate: discountRate,
+          product_code: productCode,
+          quantity,
+          total_amount: totalAmount,
+          unit_price: unitPrice,
+        };
+      });
+    },
+  },
+};

package/actions/create-contact/create-contact.mjs

@@ -0,0 +1,143 @@
+import constants from "../../common/constants.mjs";
+import app from "../../quaderno.app.mjs";
+
+export default {
+  key: "quaderno-create-contact",
+  name: "Create Contact",
+  description: "Add a new contact to Quaderno. [See the Documentation](https://developers.quaderno.io/api/#tag/Contacts/operation/createContact).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    app,
+    kind: {
+      type: "string",
+      label: "Kind",
+      description: "The type of contact. Can be `person` or `company`",
+      options: Object.values(constants.CONTACT_TYPE),
+      default: constants.CONTACT_TYPE.PERSON,
+      reloadProps: true,
+    },
+    country: {
+      propDefinition: [
+        app,
+        "country",
+      ],
+    },
+    city: {
+      propDefinition: [
+        app,
+        "city",
+      ],
+    },
+    region: {
+      propDefinition: [
+        app,
+        "region",
+      ],
+    },
+    streetLine1: {
+      propDefinition: [
+        app,
+        "streetLine1",
+      ],
+    },
+    email: {
+      propDefinition: [
+        app,
+        "email",
+      ],
+    },
+    phone1: {
+      propDefinition: [
+        app,
+        "phone1",
+      ],
+    },
+    postalCode: {
+      propDefinition: [
+        app,
+        "postalCode",
+      ],
+    },
+    fullName: {
+      propDefinition: [
+        app,
+        "fullName",
+      ],
+    },
+  },
+  async additionalProps() {
+    if (this.kind === constants.CONTACT_TYPE.PERSON) {
+      return {
+        firstName: {
+          type: "string",
+          label: "First Name",
+          description: "The contact's first name.",
+        },
+        lastName: {
+          type: "string",
+          label: "Last Name",
+          description: "The contact's last name.",
+          optional: true,
+        },
+      };
+    }
+    return {
+      firstName: {
+        type: "string",
+        label: "Bussiness Name",
+        description: "The contact's bussiness name.",
+      },
+      department: {
+        type: "string",
+        label: "Department",
+        description: "If the contact is a `company`, this is the deparment.",
+        optional: true,
+      },
+      contactPerson: {
+        type: "string",
+        label: "Contact Person",
+        description: "If the contact is a `company`, this is its contact person.",
+        optional: true,
+      },
+    };
+  },
+  methods: {
+    createContact(args = {}) {
+      return this.app.post({
+        path: "/contacts",
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      kind, country, city, region, streetLine1, contactPerson,
+      department, email, phone1, postalCode, fullName, firstName,
+      lastName,
+    } = this;
+
+    const response = await this.createContact({
+      step,
+      data: {
+        kind,
+        country,
+        city,
+        region,
+        street_line_1: streetLine1,
+        contact_person: contactPerson,
+        department,
+        email,
+        phone_1: phone1,
+        postal_code: postalCode,
+        full_name: fullName,
+        first_name: firstName,
+        last_name: lastName,
+      },
+    });
+
+    step.export("$summary", `Successfully created contact with ID ${response.id}`);
+
+    return response;
+  },
+};

package/actions/create-invoice/create-invoice.mjs

@@ -0,0 +1,57 @@
+import common from "../common/invoice.mjs";
+
+export default {
+  ...common,
+  key: "quaderno-create-invoice",
+  name: "Create Invoice",
+  description: "Generate a new invoice in Quaderno. [See the Documentation](https://developers.quaderno.io/api/#tag/Invoices/operation/createInvoice).",
+  type: "action",
+  version: "0.0.1",
+  methods: {
+    ...common.methods,
+    createInvoice(args = {}) {
+      return this.app.post({
+        path: "/invoices",
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      firstName,
+      lastName,
+      dueDate,
+      currency,
+      recurringPeriod,
+      recurringFrequency,
+      country,
+      postalCode,
+      region,
+      streetLine1,
+      howManyItems,
+    } = this;
+
+    const response = await this.createInvoice({
+      step,
+      data: {
+        contact: {
+          first_name: firstName,
+          last_name: lastName,
+        },
+        due_date: dueDate,
+        currency,
+        recurring_period: recurringPeriod,
+        recurring_frequency: recurringFrequency,
+        country,
+        postal_code: postalCode,
+        region,
+        street_line_1: streetLine1,
+        items_attributes: this.getItems(howManyItems),
+      },
+    });
+
+    step.export("$summary", `Successfully created invoice with ID ${response.id}`);
+
+    return response;
+  },
+};

package/actions/update-invoice/update-invoice.mjs

@@ -0,0 +1,78 @@
+import common from "../common/invoice.mjs";
+
+export default {
+  ...common,
+  key: "quaderno-update-invoice",
+  name: "Update Invoice",
+  description: "Modify an existing invoice's details in Quaderno. [See the Documentation](https://developers.quaderno.io/api/#tag/Invoices/operation/updateInvoice).",
+  type: "action",
+  version: "0.0.1",
+  props: {
+    ...common.props,
+    invoiceId: {
+      propDefinition: [
+        common.props.app,
+        "invoiceId",
+      ],
+    },
+    howManyItems: {
+      optional: true,
+      propDefinition: [
+        common.props.app,
+        "howManyItems",
+      ],
+      description: "The items here will be ADDED to the existing invoice items",
+    },
+  },
+  methods: {
+    ...common.methods,
+    updateInvoice({
+      invoiceId, ...args
+    } = {}) {
+      return this.app.put({
+        path: `/invoices/${invoiceId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      invoiceId,
+      firstName,
+      lastName,
+      dueDate,
+      currency,
+      recurringPeriod,
+      recurringFrequency,
+      country,
+      postalCode,
+      region,
+      streetLine1,
+      howManyItems,
+    } = this;
+
+    const response = await this.updateInvoice({
+      step,
+      invoiceId,
+      data: {
+        contact: {
+          first_name: firstName,
+          last_name: lastName,
+        },
+        due_date: dueDate,
+        currency,
+        recurring_period: recurringPeriod,
+        recurring_frequency: recurringFrequency,
+        country,
+        postal_code: postalCode,
+        region,
+        street_line_1: streetLine1,
+        items_attributes: this.getItems(howManyItems),
+      },
+    });
+
+    step.export("$summary", `Successfully updated invoice with ID ${response.id}`);
+
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,40 @@
+const DOMAIN_PLACEHOLDER = "{domain}";
+const ACCOUNT_PLACEHOLDER = "{account_name}";
+const BASE_URL = `https://${ACCOUNT_PLACEHOLDER}.${DOMAIN_PLACEHOLDER}`;
+const VERSION_PATH = "/api";
+const LAST_CREATED_AT = "lastCreatedAt";
+const DEFAULT_MAX = 600;
+
+const API_VERSION = "20220325";
+
+const CONTACT_TYPE = {
+  PERSON: "person",
+  COMPANY: "company",
+};
+
+const PERIOD = {
+  DAYS: "days",
+  WEEKS: "weeks",
+  MONTHS: "months",
+  YEARS: "years",
+};
+
+const SEP = "_";
+
+const WEBHOOK_ID = "webhookId";
+const AUTH_KEY = "authKey";
+
+export default {
+  BASE_URL,
+  VERSION_PATH,
+  DEFAULT_MAX,
+  LAST_CREATED_AT,
+  API_VERSION,
+  DOMAIN_PLACEHOLDER,
+  ACCOUNT_PLACEHOLDER,
+  CONTACT_TYPE,
+  PERIOD,
+  SEP,
+  WEBHOOK_ID,
+  AUTH_KEY,
+};

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "@pipedream/quaderno",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Pipedream Quaderno Components",
-  "main": "dist/app/quaderno.app.mjs",
+  "main": "quaderno.app.mjs",
   "keywords": [
     "pipedream",
     "quaderno"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/quaderno",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "license": "MIT",
+  "dependencies": {
+    "@pipedream/platform": "^1.4.1"
+  },
   "publishConfig": {
     "access": "public"
   }

package/quaderno.app.mjs

@@ -0,0 +1,187 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
+export default {
+  type: "app",
+  app: "quaderno",
+  propDefinitions: {
+    invoiceId: {
+      type: "string",
+      label: "Invoice ID",
+      description: "The ID of the invoice to retrieve.",
+      async options() {
+        const invoices = await this.listInvoices();
+        return invoices.map(({
+          id, contact,
+        }) => ({
+          value: String(id),
+          label: contact?.full_name
+            ? `${id} (${contact.full_name})`
+            : id,
+        }));
+      },
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "The contact's first name.",
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "The contact's last name.",
+      optional: true,
+    },
+    country: {
+      type: "string",
+      label: "Country",
+      description: "2-letter [ISO country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).",
+      optional: true,
+    },
+    city: {
+      type: "string",
+      label: "City",
+      description: "City/District/Suburb/Town/Village.",
+      optional: true,
+    },
+    region: {
+      type: "string",
+      label: "Region",
+      description: "State/Province/Region.",
+      optional: true,
+    },
+    streetLine1: {
+      type: "string",
+      label: "Street Line 1",
+      description: "Address line 1 (Street address/PO Box).",
+      optional: true,
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The contact's email address.",
+      optional: true,
+    },
+    phone1: {
+      type: "string",
+      label: "Phone Number",
+      description: "The contact's phone number.",
+      optional: true,
+    },
+    postalCode: {
+      type: "string",
+      label: "Postal Code",
+      description: "ZIP or postal code.",
+      optional: true,
+    },
+    fullName: {
+      type: "string",
+      label: "Full Name",
+      description: "The contact's full name.",
+      optional: true,
+    },
+    dueDate: {
+      type: "string",
+      label: "Due Date",
+      description: "The date on which payment for this invoice is due. Must be in `YYYY-MM-DD` format.",
+      optional: true,
+    },
+    currency: {
+      type: "string",
+      label: "Currency",
+      description: "Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217), in uppercase.",
+      optional: true,
+    },
+    recurringPeriod: {
+      type: "string",
+      label: "Recurring Period",
+      description: "The period of time between each invoice. Can be `days`, `weeks`, `months`, `years`.",
+      optional: true,
+      options: Object.values(constants.PERIOD),
+    },
+    recurringFrequency: {
+      type: "integer",
+      label: "Recurring Frequency",
+      description: "The number of periods between each invoice.",
+      optional: true,
+    },
+    subject: {
+      type: "string",
+      label: "Subject",
+      description: "The subject of the invoice.",
+      optional: true,
+    },
+    howManyItems: {
+      type: "integer",
+      label: "How Many Items",
+      description: "The number of line items to add to the invoice.",
+      reloadProps: true,
+      default: 1,
+    },
+  },
+  methods: {
+    getBaseUrl() {
+      const baseUrl = `${constants.BASE_URL}${constants.VERSION_PATH}`;
+      return baseUrl.replace(constants.ACCOUNT_PLACEHOLDER, this.$auth.account_name)
+        .replace(constants.DOMAIN_PLACEHOLDER, this.$auth.domain);
+    },
+    getUrl(path, url) {
+      return url || `${this.getBaseUrl()}${path}`;
+    },
+    getAuth() {
+      return {
+        username: this.$auth.api_key,
+      };
+    },
+    getHeaders(headers) {
+      return {
+        "Content-Type": "application/json",
+        "Accept": `application/json; api_version=${constants.API_VERSION}`,
+        ...headers,
+      };
+    },
+    makeRequest({
+      step = this, path, headers, url, ...args
+    } = {}) {
+
+      const config = {
+        auth: this.getAuth(),
+        headers: this.getHeaders(headers),
+        url: this.getUrl(path, url),
+        ...args,
+      };
+
+      return axios(step, config);
+    },
+    post(args = {}) {
+      return this.makeRequest({
+        method: "post",
+        ...args,
+      });
+    },
+    put(args = {}) {
+      return this.makeRequest({
+        method: "put",
+        ...args,
+      });
+    },
+    delete(args = {}) {
+      return this.makeRequest({
+        method: "delete",
+        ...args,
+      });
+    },
+    listInvoices(args = {}) {
+      return this.makeRequest({
+        path: "/invoices",
+        ...args,
+      });
+    },
+    listPayments(args = {}) {
+      return this.makeRequest({
+        path: "/payments",
+        ...args,
+      });
+    },
+  },
+};

package/sources/common/base.mjs

@@ -0,0 +1,14 @@
+import { ConfigurationError } from "@pipedream/platform";
+import app from "../../quaderno.app.mjs";
+
+export default {
+  props: {
+    app,
+    db: "$.service.db",
+  },
+  methods: {
+    generateMeta() {
+      throw new ConfigurationError("generateMeta is not implemented");
+    },
+  },
+};

package/sources/common/events.mjs

@@ -0,0 +1,25 @@
+// Docs: https://developers.quaderno.io/guides/webhooks/#events
+export default {
+  ACCOUNT_UPDATED: "account.updated",
+  ACCOUNT_APPLICATION_DEAUTHORIZED: "account.application.deauthorized",
+  CHECKOUT_SUCCEEDED: "checkout.succeeded",
+  CHECKOUT_FAILED: "checkout.failed",
+  CHECKOUT_ABANDONED: "checkout.abandoned",
+  CONTACT_CREATED: "contact.created",
+  CONTACT_UPDATED: "contact.updated",
+  CONTACT_DELETED: "contact.deleted",
+  CREDIT_CREATED: "credit.created",
+  CREDIT_UPDATED: "credit.updated",
+  EXPENSE_CREATED: "expense.created",
+  EXPENSE_UPDATED: "expense.updated",
+  EXPENSE_DELETED: "expense.deleted",
+  INVOICE_CREATED: "invoice.created",
+  INVOICE_UPDATED: "invoice.updated",
+  PAYMENT_CREATED: "payment.created",
+  PAYMENT_DELETED: "payment.deleted",
+  REPORTING_REQUEST_SUCCEDED: "reporting.request.suceeded",
+  REPORTING_REQUEST_FAILED: "reporting.request.failed",
+  THRESHOLD_WARNING: "threshold.warning",
+  THRESHOLD_EXCEEDED: "threshold.exceeded",
+  THRESHOLD_EU_100K: "threshold.eu.100k",
+};

package/sources/common/webhook.mjs

@@ -0,0 +1,103 @@
+import { createHmac } from "crypto";
+import { ConfigurationError } from "@pipedream/platform";
+import common from "./base.mjs";
+import constants from "../../common/constants.mjs";
+
+export default {
+  ...common,
+  props: {
+    ...common.props,
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+  },
+  hooks: {
+    async activate() {
+      const response =
+        await this.createWebhook({
+          data: {
+            url: this.http.endpoint,
+            events_types: this.getEventName(),
+          },
+        });
+
+      this.setWebhookId(response.id);
+      this.setAuthKey(response.auth_key);
+    },
+    async deactivate() {
+      const webhookId = this.getWebhookId();
+      if (webhookId) {
+        await this.deleteWebhook({
+          webhookId,
+        });
+      }
+    },
+  },
+  methods: {
+    ...common.methods,
+    setWebhookId(value) {
+      this.db.set(constants.WEBHOOK_ID, value);
+    },
+    getWebhookId() {
+      return this.db.get(constants.WEBHOOK_ID);
+    },
+    setAuthKey(value) {
+      this.db.set(constants.AUTH_KEY, value);
+    },
+    getAuthKey() {
+      return this.db.get(constants.AUTH_KEY);
+    },
+    getEventName() {
+      throw new ConfigurationError("getEventName is not implemented");
+    },
+    createWebhook(args = {}) {
+      return this.app.post({
+        path: "/webhooks",
+        ...args,
+      });
+    },
+    deleteWebhook({
+      webhookId, ...args
+    } = {}) {
+      return this.app.delete({
+        path: `/webhooks/${webhookId}`,
+        ...args,
+      });
+    },
+    isSignatureValid(signature, data, skip = true) {
+      // skip signature validation for now. Due to the following issue:
+      // https://github.com/quaderno/quaderno-api/issues/54
+      if (skip) {
+        return true;
+      }
+      const authKey = this.getAuthKey();
+      const computedSignature = createHmac("sha1", authKey)
+        .update(data)
+        .digest("base64");
+
+      return computedSignature === signature;
+    },
+    processEvent(event) {
+      this.$emit(event, this.generateMeta(event.data?.object || event));
+    },
+  },
+  async run({
+    method, url, body, headers, bodyRaw,
+  }) {
+    if (method === "HEAD") {
+      return this.http.respond({
+        status: 200,
+      });
+    }
+
+    const signature = headers["x-quaderno-signature"];
+    const data = `${url}${bodyRaw}`;
+
+    if (!this.isSignatureValid(signature, data)) {
+      throw new Error("Invalid signature");
+    }
+
+    this.processEvent(body);
+  },
+};

package/sources/invoice-created/invoice-created.mjs

@@ -0,0 +1,34 @@
+import common from "../common/webhook.mjs";
+import events from "../common/events.mjs";
+
+export default {
+  ...common,
+  key: "quaderno-invoice-created",
+  name: "New Invoice Created",
+  description: "Emit new event when a new invoice is generated in Quaderno. [See the Documentation](https://developers.quaderno.io/api/#tag/Webhooks/operation/createWebhook).",
+  type: "source",
+  version: "0.0.1",
+  dedupe: "unique",
+  hooks: {
+    async deploy() {
+      const invoices = await this.app.listInvoices();
+      invoices.reverse().forEach(this.processEvent);
+    },
+    ...common.hooks,
+  },
+  methods: {
+    ...common.methods,
+    getEventName() {
+      return [
+        events.INVOICE_CREATED,
+      ];
+    },
+    generateMeta(resource) {
+      return {
+        id: resource.id,
+        summary: `New Invoice: ${resource.id}`,
+        ts: Date.now(),
+      };
+    },
+  },
+};

package/sources/payment-received/payment-received.mjs

@@ -0,0 +1,27 @@
+import common from "../common/webhook.mjs";
+import events from "../common/events.mjs";
+
+export default {
+  ...common,
+  key: "quaderno-payment-received",
+  name: "New Payment Received",
+  description: "Emit new event when a payment is successfully processed in Quaderno. [See the Documentation](https://developers.quaderno.io/api/#tag/Webhooks/operation/createWebhook).",
+  type: "source",
+  version: "0.0.1",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventName() {
+      return [
+        events.PAYMENT_CREATED,
+      ];
+    },
+    generateMeta(resource) {
+      return {
+        id: resource.id,
+        summary: `New Payment: ${resource.id}`,
+        ts: Date.now(),
+      };
+    },
+  },
+};