Add Patch Zapier project

- Add authentication
- Add project trigger
- Add order creates

Author: Tate

.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: "./tsconfig.json",
+  },
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+  ],
+  rules: {
+    "@typescript-eslint/prefer-nullish-coalescing": "error",
+    "@typescript-eslint/no-unnecessary-condition": "error",
+    "@typescript-eslint/prefer-optional-chain": "error",
+  },
+};

.gitignore

@@ -0,0 +1,65 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# output
+lib
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# environment variables file
+.env
+.environment
+
+# next.js build output
+.next

.nvmrc

@@ -0,0 +1 @@
+12.18.3

.zapierapprc

@@ -0,0 +1,4 @@
+{
+  "id": 116761,
+  "key": "App116761"
+}

README.md

@@ -0,0 +1,47 @@
+# Patch Zapier App
+
+## First time setup
+
+### Dependencies
+
+You'll need to have `yarn` installed.
+
+All Zapier CLI apps are run using Node.js v12. The current node version for the project can be found in `.nvmrc`. You can use `nvm` to manage your node version, or the tool of your choice.
+
+The rest of the project dependencies can be installed by running `yarn install`.
+
+## Developer commands
+
+There are a number of helpful scripts in `package.json`.
+
+Run tests
+`yarn test`
+
+Run typescript in watch mode:
+`yarn watch`
+
+## Docs
+
+[Zapier](https://github.com/zapier/zapier-platform/blob/master/packages/cli/README.md.)
+[The Zapier CLI Tutorial](https://platform.zapier.com/cli_tutorials/getting-started)is a good resource to understand Zapier app architecture and key concepts.
+
+## Zapier CLI
+
+The zapier cli can be run via `yarn zapier`. Some helpful recipes:
+
+### Validate
+
+Run Zapier validations:
+`yarn build && yarn zapier validate`
+
+### Logs
+
+All HTTP requests
+`yarn zapier logs --type=http --detailed`
+
+Details log information:
+`yarn zapier logs --type=http --detailed`
+
+### Manual deployment
+
+`yarn build && yarn zapier push`

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib').default;

package.json

@@ -0,0 +1,45 @@
+{
+  "private": true,
+  "name": "patch",
+  "description": "",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "clean": "rimraf ./lib ./build",
+    "lint:fix": "yarn lint:package && yarn lint:ts --fix && prettier --write ./src",
+    "lint:fix:md": "prettier --write *.md",
+    "lint:package": "prettier-package-json --write ./package.json",
+    "lint:ts": "eslint './src/**/*.ts'",
+    "test": "npm run build && jest --testTimeout 10000 --rootDir ./lib/test",
+    "watch": "npm run clean && tsc --watch"
+  },
+  "dependencies": {
+    "zapier-platform-core": "10.1.1"
+  },
+  "devDependencies": {
+    "@types/jest": "^25.2.1",
+    "@types/node": "^13.13.5",
+    "@typescript-eslint/eslint-plugin": "^4.1.0",
+    "@typescript-eslint/parser": "^4.1.0",
+    "eslint": "^7.8.1",
+    "husky": "^4.3.0",
+    "jest": "^25.5.3",
+    "lint-staged": "^10.3.0",
+    "prettier": "^2.1.1",
+    "prettier-package-json": "^2.1.3",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.0.2",
+    "zapier-platform-cli": "^10.1.1"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "package.json": "yarn lint:package",
+    "*.md": "yarn lint:fix:md",
+    "*.{ts,tsx}": "yarn lint:fix"
+  }
+}

src/creates/index.ts

@@ -0,0 +1 @@
+export * from "./order";

src/creates/order.ts

@@ -0,0 +1,50 @@
+import { Bundle, ZObject } from "zapier-platform-core";
+import { PatchResponse } from "../types";
+
+type CreateData = {
+  mass_g: number;
+  project_id?: string;
+  metadata?: Record<string, string>;
+};
+
+const perform = async (
+  z: ZObject,
+  bundle: Bundle<CreateData>
+): Promise<unknown> => {
+  const { mass_g, project_id, metadata } = bundle.inputData;
+  const { data } = await z.request({
+    method: "POST",
+    url: "https://api.usepatch.com/v1/orders",
+    body: { mass_g, project_id, metadata },
+  });
+  return (data as PatchResponse).data;
+};
+
+export const OrderCreate = {
+  key: "order",
+  noun: "order",
+
+  display: {
+    label: "Create Order",
+    description: "Creates a new order.",
+  },
+
+  operation: {
+    perform,
+    inputFields: [
+      { key: "mass_g", label: "Mass (grams)", required: true, type: "integer" },
+      // will call the trigger with a key of project
+      {
+        key: "project_id",
+        label: "Project",
+        dynamic: "project.id.name",
+      },
+      { key: "metadata", dict: true },
+    ],
+    sample: {
+      mass_g: 100,
+      project_id: "pro_test_1234",
+      metadata: { user: "john doe" },
+    },
+  },
+};

src/index.ts

@@ -0,0 +1,41 @@
+import { Bundle, HttpRequestOptions, ZObject } from "zapier-platform-core";
+import { ProjectTrigger } from "./triggers";
+import { OrderCreate } from "./creates";
+import { version as platformVersion } from "zapier-platform-core";
+const { version } = require("../package.json"); // eslint-disable-line
+
+const addApiKeyHeader = (
+  req: HttpRequestOptions,
+  _z: ZObject,
+  bundle: Bundle
+): HttpRequestOptions => {
+  req.headers ??= {};
+  req.headers["Authorization"] = `Bearer ${bundle.authData.apiKey}`;
+  return req;
+};
+
+export default {
+  version, // eslint-disable-line
+  platformVersion,
+  beforeRequest: [addApiKeyHeader],
+  authentication: {
+    type: "custom",
+    fields: [{ key: "apiKey", type: "string" }],
+    test: async (z: ZObject): Promise<void> => {
+      const response = await z.request("https://api.usepatch.com/v1/orders", {
+        json: { page: 1 },
+      });
+      if (response.status !== 200) {
+        throw new Error("Invalid API Key");
+      }
+    },
+  },
+
+  triggers: {
+    [ProjectTrigger.key]: ProjectTrigger,
+  },
+
+  creates: {
+    [OrderCreate.key]: OrderCreate,
+  },
+};