Add OrderTrigger and opt in to pagination

Author: Tate

package.json

@@ -5,14 +5,15 @@
   "version": "1.0.0",
   "main": "index.js",
   "scripts": {
-    "build": "npm run clean && tsc",
+    "build": "yarn run clean && yarn tsc",
     "clean": "rimraf ./lib ./build",
-    "lint:fix": "yarn lint:package && yarn lint:ts --fix && prettier --write ./src",
+    "lint:fix": "yarn lint:package && yarn lint:ts --fix && prettier --write ./src && yarn typecheck",
     "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"
+    "test": "yarn run build && jest --testTimeout 10000 --rootDir ./lib/test",
+    "typecheck": "yarn tsc --noEmit",
+    "watch": "yarn run clean && yarn tsc --watch"
   },
   "dependencies": {
     "zapier-platform-core": "10.1.1"

src/creates/order.ts

@@ -1,5 +1,5 @@
 import { Bundle, ZObject } from "zapier-platform-core";
-import { PatchResponse } from "../types";
+import { ZapierCreate, PatchResponse } from "../types";
 
 type CreateData = {
   mass_g: number;
@@ -20,15 +20,13 @@ const perform = async (
   return (data as PatchResponse).data;
 };
 
-export const OrderCreate = {
+export const OrderCreate: ZapierCreate<CreateData> = {
   key: "order",
   noun: "order",
-
   display: {
     label: "Create Order",
     description: "Creates a new order.",
   },
-
   operation: {
     perform,
     inputFields: [

src/index.ts

@@ -1,5 +1,5 @@
 import { Bundle, HttpRequestOptions, ZObject } from "zapier-platform-core";
-import { ProjectTrigger } from "./triggers";
+import { OrderTrigger, ProjectTrigger } from "./triggers";
 import { OrderCreate } from "./creates";
 import { version as platformVersion } from "zapier-platform-core";
 const { version } = require("../package.json"); // eslint-disable-line
@@ -33,6 +33,7 @@ export default {
 
   triggers: {
     [ProjectTrigger.key]: ProjectTrigger,
+    [OrderTrigger.key]: OrderTrigger,
   },
 
   creates: {

src/triggers/index.ts

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

src/triggers/order.ts

@@ -0,0 +1,50 @@
+import { Bundle, ZObject } from "zapier-platform-core";
+import { PatchResponse, ZapierTrigger } from "../types";
+
+const perform = async (z: ZObject, bundle: Bundle): Promise<unknown> => {
+  // zapier starts with page 0
+  const page = bundle.meta.page + 1;
+  const { data } = await z.request("https://api.usepatch.com/v1/orders", {
+    json: { page },
+  });
+  return (data as PatchResponse).data;
+};
+
+export const OrderTrigger: ZapierTrigger = {
+  key: "order",
+  noun: "order",
+  display: {
+    label: "New Order",
+    description: "Triggers when a new order is created.",
+  },
+  operation: {
+    type: "polling",
+    canPaginate: true,
+    perform,
+    sample: {
+      id: "ord_test_16d8054a8f8502d81a830252d58024bb",
+      allocation_state: "allocated",
+      allocations: [
+        {
+          id: "all_test_be33c362135078d77cce3e8ab242dac1",
+          mass_g: 34,
+          offset: {
+            id: "off_test_a6a8c407b8f3e9f783f9aa41fb833d1a",
+            developer: "Carbo Culture",
+            production: false,
+            serial_number: null,
+            vintage_year: 2020,
+          },
+          production: false,
+        },
+      ],
+      mass_g: 34,
+      metadata: {
+        foo: "bar",
+      },
+      price_cents_usd: "1.0",
+      production: false,
+      state: "placed",
+    },
+  },
+};

src/triggers/project.ts

@@ -1,23 +1,25 @@
-import { ZObject } from "zapier-platform-core";
-import { PatchResponse } from "../types";
+import { Bundle, ZObject } from "zapier-platform-core";
+import { PatchResponse, ZapierTrigger } from "../types";
 
-const perform = async (z: ZObject): Promise<unknown> => {
+const perform = async (z: ZObject, bundle: Bundle): Promise<unknown> => {
+  // zapier starts with page 0
+  const page = bundle.meta.page + 1;
   const { data } = await z.request("https://api.usepatch.com/v1/projects", {
-    json: { page: 1 },
+    json: { page },
   });
   return (data as PatchResponse).data;
 };
 
-export const ProjectTrigger = {
+export const ProjectTrigger: ZapierTrigger = {
   key: "project",
   noun: "project",
-
   display: {
     label: "New Project",
     description: "Triggers when a new project is created.",
   },
-
   operation: {
+    type: "polling",
+    canPaginate: true,
     perform,
     sample: {
       id: "pro_test_2e049bbfe8c998ca82025d776f8289ff",

src/types.ts

@@ -1 +1,35 @@
+import { Bundle, ZObject } from "zapier-platform-core";
+
 export type PatchResponse = { data: unknown };
+
+type DefaultBundleConfig = Record<string, unknown>;
+
+type ZapierBase<BundleConfig> = {
+  key: string;
+  noun: string;
+  display: {
+    label: string;
+    description: string;
+  };
+  operation: {
+    perform: (z: ZObject, bundle: Bundle<BundleConfig>) => Promise<unknown>;
+    sample: Record<string, unknown>;
+  };
+};
+
+export type ZapierTrigger<BundleConfig = DefaultBundleConfig> = ZapierBase<
+  BundleConfig
+> & {
+  operation: {
+    type: "polling";
+    canPaginate: true;
+  };
+};
+
+export type ZapierCreate<BundleConfig = DefaultBundleConfig> = ZapierBase<
+  BundleConfig
+> & {
+  operation: {
+    inputFields: Array<Record<string, unknown>>;
+  };
+};