@pipedream/navan 0.0.1 → 0.2.0

package/actions/create-user/create-user.mjs

@@ -0,0 +1,159 @@
+import app from "../../navan.app.mjs";
+
+export default {
+  key: "navan-create-user",
+  name: "Create User",
+  description: "Creates a new user in the system. [See the documentation](https://u.pcloud.link/publink/show?code=XZ7Bww5ZoKb93VNf7ISOdR5UzVo6JzBLs7AX)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    userName: {
+      propDefinition: [
+        app,
+        "userName",
+      ],
+    },
+    firstName: {
+      propDefinition: [
+        app,
+        "firstName",
+      ],
+    },
+    lastName: {
+      propDefinition: [
+        app,
+        "lastName",
+      ],
+    },
+    active: {
+      propDefinition: [
+        app,
+        "active",
+      ],
+    },
+    title: {
+      propDefinition: [
+        app,
+        "title",
+      ],
+    },
+    employeeNumber: {
+      propDefinition: [
+        app,
+        "employeeNumber",
+      ],
+    },
+    department: {
+      propDefinition: [
+        app,
+        "department",
+      ],
+    },
+    costCenter: {
+      propDefinition: [
+        app,
+        "costCenter",
+      ],
+    },
+    division: {
+      propDefinition: [
+        app,
+        "division",
+      ],
+    },
+    region: {
+      propDefinition: [
+        app,
+        "region",
+      ],
+    },
+    travelPolicy: {
+      propDefinition: [
+        app,
+        "travelPolicy",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      userName,
+      firstName,
+      lastName,
+      active,
+      title,
+      employeeNumber,
+      department,
+      costCenter,
+      division,
+      region,
+      travelPolicy,
+    } = this;
+
+    const data = {
+      schemas: [
+        "urn:ietf:params:scim:schemas:core:2.0:User",
+      ],
+      userName,
+      name: {
+        givenName: firstName,
+        familyName: lastName,
+      },
+      active,
+      title,
+      emails: [
+        {
+          value: userName,
+          type: "work",
+          primary: true,
+        },
+      ],
+    };
+
+    const enterpriseExtension = {};
+    if (employeeNumber) {
+      enterpriseExtension.employeeNumber = employeeNumber;
+    }
+    if (department) {
+      enterpriseExtension.department = department;
+    }
+    if (costCenter) {
+      enterpriseExtension.costCenter = costCenter;
+    }
+    if (division) {
+      enterpriseExtension.division = division;
+    }
+
+    if (Object.keys(enterpriseExtension).length > 0) {
+      data.schemas.push("urn:ietf:params:scim:schemas:extension:enterprise:2.0:User");
+      data["urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"] = enterpriseExtension;
+    }
+
+    const navanExtension = {};
+    if (region) {
+      navanExtension.region = region;
+    }
+    if (travelPolicy) {
+      navanExtension.travelPolicy = travelPolicy;
+    }
+
+    if (Object.keys(navanExtension).length > 0) {
+      data.schemas.push("urn:ietf:params:scim:schemas:extension:navan:2.0:User");
+      data["urn:ietf:params:scim:schemas:extension:navan:2.0:User"] = navanExtension;
+    }
+
+    const response = await app.createUser({
+      $,
+      data,
+    });
+
+    $.export("$summary", `Successfully created user \`${response.userName}\``);
+    return response;
+  },
+};

package/actions/get-user/get-user.mjs

@@ -0,0 +1,36 @@
+import app from "../../navan.app.mjs";
+
+export default {
+  key: "navan-get-user",
+  name: "Get User",
+  description: "Retrieves a specific user by their unique identifier. [See the documentation](https://u.pcloud.link/publink/show?code=XZ7Bww5ZoKb93VNf7ISOdR5UzVo6JzBLs7AX)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    userId: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app, userId,
+    } = this;
+
+    const response = await app.getUser({
+      $,
+      userId,
+    });
+
+    $.export("$summary", `Successfully retrieved user with ID \`${response.id}\``);
+    return response;
+  },
+};

package/actions/list-user-id-options/list-user-id-options.mjs

@@ -0,0 +1,33 @@
+import navan from "../../navan.app.mjs";
+
+export default {
+  key: "navan-list-user-id-options",
+  name: "List User ID Options",
+  description: "Retrieves available options for the User ID field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    navan,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await navan.propDefinitions.userId.options.call(this.navan, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/actions/list-users/list-users.mjs

@@ -0,0 +1,55 @@
+import app from "../../navan.app.mjs";
+
+export default {
+  key: "navan-list-users",
+  name: "List Users",
+  description: "Retrieves a paginated list of all users in the company. [See the documentation](https://u.pcloud.link/publink/show?code=XZ7Bww5ZoKb93VNf7ISOdR5UzVo6JzBLs7AX)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: true,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    startIndex: {
+      type: "integer",
+      label: "Start Index",
+      description: "0-based index of first result. Default is 0.",
+      optional: true,
+    },
+    count: {
+      type: "integer",
+      label: "Count",
+      description: "Number of resources to return per page. Default is `10`.",
+      optional: true,
+    },
+    filter: {
+      type: "string",
+      label: "Filter",
+      description: "SCIM filter expression. Supported filters like `userName eq \"email@example.com\"`",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      startIndex,
+      count,
+      filter,
+    } = this;
+
+    const response = await app.listUsers({
+      $,
+      params: {
+        startIndex,
+        count,
+        filter,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved ${response.Resources?.length || 0} user(s) out of ${response.totalResults} total`);
+    return response;
+  },
+};

package/actions/replace-user/replace-user.mjs

@@ -0,0 +1,170 @@
+import app from "../../navan.app.mjs";
+
+export default {
+  key: "navan-replace-user",
+  name: "Replace User",
+  description: "Replaces an entire user resource (full update). [See the documentation](https://u.pcloud.link/publink/show?code=XZ7Bww5ZoKb93VNf7ISOdR5UzVo6JzBLs7AX)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: true,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    userId: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+    },
+    userName: {
+      propDefinition: [
+        app,
+        "userName",
+      ],
+    },
+    firstName: {
+      propDefinition: [
+        app,
+        "firstName",
+      ],
+    },
+    lastName: {
+      propDefinition: [
+        app,
+        "lastName",
+      ],
+    },
+    active: {
+      propDefinition: [
+        app,
+        "active",
+      ],
+    },
+    title: {
+      propDefinition: [
+        app,
+        "title",
+      ],
+    },
+    employeeNumber: {
+      propDefinition: [
+        app,
+        "employeeNumber",
+      ],
+    },
+    department: {
+      propDefinition: [
+        app,
+        "department",
+      ],
+    },
+    costCenter: {
+      propDefinition: [
+        app,
+        "costCenter",
+      ],
+    },
+    division: {
+      propDefinition: [
+        app,
+        "division",
+      ],
+    },
+    region: {
+      propDefinition: [
+        app,
+        "region",
+      ],
+    },
+    travelPolicy: {
+      propDefinition: [
+        app,
+        "travelPolicy",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      userId,
+      userName,
+      firstName,
+      lastName,
+      active,
+      title,
+      employeeNumber,
+      department,
+      costCenter,
+      division,
+      region,
+      travelPolicy,
+    } = this;
+
+    const data = {
+      schemas: [
+        "urn:ietf:params:scim:schemas:core:2.0:User",
+      ],
+      userName,
+      name: {
+        givenName: firstName,
+        familyName: lastName,
+      },
+      emails: [
+        {
+          value: userName,
+          type: "work",
+          primary: true,
+        },
+      ],
+      active,
+    };
+
+    if (title) {
+      data.title = title;
+    }
+
+    const enterpriseExtension = {};
+    if (employeeNumber) {
+      enterpriseExtension.employeeNumber = employeeNumber;
+    }
+    if (department) {
+      enterpriseExtension.department = department;
+    }
+    if (costCenter) {
+      enterpriseExtension.costCenter = costCenter;
+    }
+    if (division) {
+      enterpriseExtension.division = division;
+    }
+
+    if (Object.keys(enterpriseExtension).length > 0) {
+      data.schemas.push("urn:ietf:params:scim:schemas:extension:enterprise:2.0:User");
+      data["urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"] = enterpriseExtension;
+    }
+
+    const navanExtension = {};
+    if (region) {
+      navanExtension.region = region;
+    }
+    if (travelPolicy) {
+      navanExtension.travelPolicy = travelPolicy;
+    }
+
+    if (Object.keys(navanExtension).length > 0) {
+      data.schemas.push("urn:ietf:params:scim:schemas:extension:navan:2.0:User");
+      data["urn:ietf:params:scim:schemas:extension:navan:2.0:User"] = navanExtension;
+    }
+
+    const response = await app.replaceUser({
+      $,
+      userId,
+      data,
+    });
+
+    $.export("$summary", `Successfully replaced user \`${response.userName}\``);
+    return response;
+  },
+};

package/actions/update-user/update-user.mjs

@@ -0,0 +1,167 @@
+import app from "../../navan.app.mjs";
+
+export default {
+  key: "navan-update-user",
+  name: "Update User",
+  description: "Performs partial updates to a user using SCIM patch operations. [See the documentation](https://u.pcloud.link/publink/show?code=XZ7Bww5ZoKb93VNf7ISOdR5UzVo6JzBLs7AX)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    readOnlyHint: false,
+    destructiveHint: false,
+    openWorldHint: true,
+  },
+  props: {
+    app,
+    userId: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+    },
+    firstName: {
+      propDefinition: [
+        app,
+        "firstName",
+      ],
+      optional: true,
+    },
+    lastName: {
+      propDefinition: [
+        app,
+        "lastName",
+      ],
+      optional: true,
+    },
+    active: {
+      propDefinition: [
+        app,
+        "active",
+      ],
+    },
+    title: {
+      propDefinition: [
+        app,
+        "title",
+      ],
+    },
+    employeeNumber: {
+      propDefinition: [
+        app,
+        "employeeNumber",
+      ],
+    },
+    department: {
+      propDefinition: [
+        app,
+        "department",
+      ],
+    },
+    costCenter: {
+      propDefinition: [
+        app,
+        "costCenter",
+      ],
+    },
+    division: {
+      propDefinition: [
+        app,
+        "division",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      userId,
+      firstName,
+      lastName,
+      active,
+      title,
+      employeeNumber,
+      department,
+      costCenter,
+      division,
+    } = this;
+
+    const operations = [];
+
+    if (firstName) {
+      operations.push({
+        op: "replace",
+        path: "name.givenName",
+        value: firstName,
+      });
+    }
+
+    if (lastName) {
+      operations.push({
+        op: "replace",
+        path: "name.familyName",
+        value: lastName,
+      });
+    }
+
+    if (active) {
+      operations.push({
+        op: "replace",
+        path: "active",
+        value: active,
+      });
+    }
+
+    if (title) {
+      operations.push({
+        op: "replace",
+        path: "title",
+        value: title,
+      });
+    }
+
+    if (employeeNumber) {
+      operations.push({
+        op: "replace",
+        path: "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber",
+        value: employeeNumber,
+      });
+    }
+
+    if (department) {
+      operations.push({
+        op: "replace",
+        path: "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department",
+        value: department,
+      });
+    }
+
+    if (costCenter) {
+      operations.push({
+        op: "replace",
+        path: "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter",
+        value: costCenter,
+      });
+    }
+
+    if (division) {
+      operations.push({
+        op: "replace",
+        path: "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division",
+        value: division,
+      });
+    }
+
+    const response = await app.updateUser({
+      $,
+      userId,
+      data: {
+        schemas: [
+          "urn:ietf:params:scim:api:messages:2.0:PatchOp",
+        ],
+        Operations: operations,
+      },
+    });
+
+    $.export("$summary", `Successfully updated user \`${response.userName}\``);
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,5 @@
+const DEFAULT_LIMIT = 10;
+
+export default {
+  DEFAULT_LIMIT,
+};

package/navan.app.mjs

@@ -1,11 +1,148 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "navan",
-  propDefinitions: {},
+  propDefinitions: {
+    userId: {
+      type: "string",
+      label: "User ID",
+      description: "The unique identifier (UUID) of the user",
+      async options({ page }) {
+        const { Resources } = await this.listUsers({
+          params: {
+            startIndex: page * constants.DEFAULT_LIMIT,
+            count: constants.DEFAULT_LIMIT,
+          },
+        });
+        return Resources?.map(({
+          id: value, userName: label,
+        }) => ({
+          label,
+          value,
+        })) || [];
+      },
+    },
+    userName: {
+      type: "string",
+      label: "Email",
+      description: "User's email address",
+    },
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "User's first name",
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "User's last name",
+    },
+    active: {
+      type: "boolean",
+      label: "Active",
+      description: "User status",
+      optional: true,
+    },
+    title: {
+      type: "string",
+      label: "Job Title",
+      description: "User's job title",
+      optional: true,
+    },
+    employeeNumber: {
+      type: "string",
+      label: "Employee Number",
+      description: "Employee ID",
+      optional: true,
+    },
+    department: {
+      type: "string",
+      label: "Department",
+      description: "Department name",
+      optional: true,
+    },
+    costCenter: {
+      type: "string",
+      label: "Cost Center",
+      description: "Cost center identifier",
+      optional: true,
+    },
+    division: {
+      type: "string",
+      label: "Division",
+      description: "Subsidiary in Navan",
+      optional: true,
+    },
+    region: {
+      type: "string",
+      label: "Region",
+      description: "Geographic region",
+      optional: true,
+    },
+    travelPolicy: {
+      type: "string",
+      label: "Travel Policy",
+      description: "Travel policy assignment",
+      optional: true,
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    getUrl(path) {
+      return `${this.$auth.api_url}${path}`;
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: this.getUrl(path),
+        headers: {
+          "Authorization": `Bearer ${this.$auth.scim_token}`,
+          "Content-Type": "application/json",
+          "Accept": "application/json",
+        },
+        ...opts,
+      });
+    },
+    listUsers(opts = {}) {
+      return this._makeRequest({
+        path: "/Users",
+        ...opts,
+      });
+    },
+    getUser({
+      userId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/Users/${userId}`,
+        ...opts,
+      });
+    },
+    createUser(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/Users",
+        ...opts,
+      });
+    },
+    updateUser({
+      userId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "PATCH",
+        path: `/Users/${userId}`,
+        ...opts,
+      });
+    },
+    replaceUser({
+      userId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "PUT",
+        path: `/Users/${userId}`,
+        ...opts,
+      });
     },
   },
-};
+};

package/package.json

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