New Components - prodatakey

components/prodatakey/actions/open-and-close-device/open-and-close-device.mjs

@@ -0,0 +1,61 @@
+import prodatakey from "../../prodatakey.app.mjs";
+
+export default {
+  key: "prodatakey-open-and-close-device",
+  name: "Open and Close Device",
+  description: "Opens and closes a device in the ProdataKey system. [See the documentation](https://developer.pdk.io/web/2.0/rest/devices#open-and-close-a-device)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    prodatakey,
+    organizationId: {
+      propDefinition: [
+        prodatakey,
+        "organizationId",
+      ],
+    },
+    cloudNodeId: {
+      propDefinition: [
+        prodatakey,
+        "cloudNodeId",
+        ({ organizationId }) => ({
+          organizationId,
+        }),
+      ],
+    },
+    deviceId: {
+      propDefinition: [
+        prodatakey,
+        "deviceId",
+        ({
+          organizationId, cloudNodeId,
+        }) => ({
+          organizationId,
+          cloudNodeId,
+        }),
+      ],
+    },
+    dwell: {
+      type: "integer",
+      label: "Dwell",
+      description: "The amount of time (in tenths of a second) the device will remain open before closing. This value will override the dwell time configured in pdk.io.",
+      min: 1,
+      max: 5400,
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.prodatakey.openAndCloseDevice({
+      $,
+      organizationId: this.organizationId,
+      cloudNodeId: this.cloudNodeId,
+      deviceId: this.deviceId,
+      data: {
+        dwell: this.dwell,
+      },
+    });
+
+    $.export("$summary", `Successfully sent command to device with ID: ${this.deviceId}`);
+    return response;
+  },
+};

components/prodatakey/actions/retrieve-credential/retrieve-credential.mjs

@@ -0,0 +1,50 @@
+import prodatakey from "../../prodatakey.app.mjs";
+
+export default {
+  key: "prodatakey-retrieve-credential",
+  name: "Retrieve Credential",
+  description: "Retrieve a specific credential using the system ID, holder ID, and credential ID. [See the documentation](https://developer.pdk.io/web/2.0/rest/credentials)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    prodatakey,
+    organizationId: {
+      propDefinition: [
+        prodatakey,
+        "organizationId",
+      ],
+    },
+    holderId: {
+      propDefinition: [
+        prodatakey,
+        "holderId",
+        ({ organizationId }) => ({
+          organizationId,
+        }),
+      ],
+    },
+    credentialId: {
+      propDefinition: [
+        prodatakey,
+        "credentialId",
+        ({
+          organizationId, holderId,
+        }) => ({
+          organizationId,
+          holderId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.prodatakey.retrieveCredential({
+      $,
+      organizationId: this.organizationId,
+      holderId: this.holderId,
+      credentialId: this.credentialId,
+    });
+
+    $.export("$summary", `Successfully retrieved credential with ID ${response.id}`);
+    return response;
+  },
+};

components/prodatakey/actions/retrieve-organization/retrieve-organization.mjs

@@ -0,0 +1,27 @@
+import prodatakey from "../../prodatakey.app.mjs";
+
+export default {
+  key: "prodatakey-retrieve-organization",
+  name: "Retrieve Organization",
+  description: "Retrieve an existing organization. [See the documentation](https://developer.pdk.io/web/2.0/rest/organizations#retrieve-an-organization)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    prodatakey,
+    organizationId: {
+      propDefinition: [
+        prodatakey,
+        "organizationId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.prodatakey.retrieveOrganization({
+      $,
+      organizationId: this.organizationId,
+    });
+
+    $.export("$summary", `Successfully retrieved organization: ${response.name}`);
+    return response;
+  },
+};

components/prodatakey/common/constants.mjs

@@ -0,0 +1,127 @@
+export const EVENT_OPTIONS =
+[
+  {
+    label: "Triggers when a controller's relay circuits stabilize.",
+    value: "device.alarm.circuitbreaker.off",
+  },
+  {
+    label: "Triggers when a controller's relay circuits become unstable (e.g. due to loose wires).",
+    value: "device.alarm.circuitbreaker.on",
+  },
+  {
+    label: "Triggers when a device equipped with a door position sensor (DPS) is forced open.",
+    value: "device.alarm.forced",
+  },
+  {
+    label: "Triggers when a forced alarm has cleared.",
+    value: "device.alarm.forced.cleared",
+  },
+  {
+    label: "Triggers when prop alarms are cleared for all devices.",
+    value: "device.alarm.propped.alloff",
+  },
+  {
+    label: "Triggers when a prop alarm has cleared for a device.",
+    value: "device.alarm.propped.off",
+  },
+  {
+    label: "Triggers when a device equipped with a door position sensor (DPS) is propped open.",
+    value: "device.alarm.propped.on",
+  },
+  {
+    label: "Triggers when auto open is deactivated.",
+    value: "device.autoopen.off",
+  },
+  {
+    label: "Triggers when auto open is activated.",
+    value: "device.autoopen.on",
+  },
+  {
+    label: "Triggers when an auto open override is deactivated.",
+    value: "device.autoopen.override.off",
+  },
+  {
+    label: "Triggers when an auto open override is activated.",
+    value: "device.autoopen.override.on",
+  },
+  {
+    label: "Triggers when do not disturb (DND) is deactivated.",
+    value: "device.forceclose.off",
+  },
+  {
+    label: "Triggers when do not disturb (DND) is activated.",
+    value: "device.forceclose.on",
+  },
+  {
+    label: "Triggers when force unlock is deactivated.",
+    value: "device.forceopen.off",
+  },
+  {
+    label: "Triggers when force unlock is activated.",
+    value: "device.forceopen.on",
+  },
+  {
+    label: "Triggers when a door position sensor (DPS) changes to a closed state.",
+    value: "device.input.dps.closed",
+  },
+  {
+    label: "Triggers when a door position sensor (DPS) changes to an open state.",
+    value: "device.input.dps.opened",
+  },
+  {
+    label: "Triggers when a device is locked.",
+    value: "device.input.relay.off",
+  },
+  {
+    label: "Triggers when a device is unlocked.",
+    value: "device.input.relay.on",
+  },
+  {
+    label: "Triggers when the request to exit (REX) is deactivated.",
+    value: "device.input.rex.off",
+  },
+  {
+    label: "Triggers when the request to exit (REX) is activated.",
+    value: "device.input.rex.on",
+  },
+  {
+    label: "Triggers when a credential scan is emulated on a device (e.g. when opening a device using a software button).",
+    value: "device.input.virtualread",
+  },
+  {
+    label: "Triggers when a holder is recognized and granted access.",
+    value: "device.request.allowed",
+  },
+  {
+    label: "Triggers when a holder is recognized but denied access.",
+    value: "device.request.denied",
+  },
+  {
+    label: "Triggers when a holder enters a duress PIN.",
+    value: "device.request.duress",
+  },
+  {
+    label: "Triggers when access is granted using an emergency card. Since emergency cards can be used while a system is offline, these events may be delayed.",
+    value: "device.request.ecard.allowed",
+  },
+  {
+    label: "Triggers when access is denied using an emergency card. Since emergency cards can be used while a system is offline, these events may be delayed.",
+    value: "device.request.ecard.denied",
+  },
+  {
+    label: "Triggers when a holder is recognized.",
+    value: "device.request.found",
+  },
+  {
+    label: "Triggers when a credential is denied due to facility code filtering.",
+    value: "device.request.filtered",
+  },
+  {
+    label: "Triggers when a holder is granted access after multiple sequential scans. This behavior may be used to configure other actions, such as activating or deactivating an alarm system.",
+    value: "device.request.multiallowed",
+  },
+  {
+    label: "Triggers when a credential is presented but the holder is not recognized.",
+    value: "device.request.unknown",
+  },
+];

components/prodatakey/package.json

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