@openfn/language-asana 2.0.0 → 2.1.0

package/README.md

@@ -8,11 +8,23 @@ Language Pack for connecting with Asana.
 
 ```json
 {
-  "baseUrl": "https://app.asana.com/api/1.0",
-  "token": "shhhhh"
+  "apiVersion": "1.0",
+  "token": "shhhhhhhh"
 }
 ```
 
+### How to create an API token
+
+Using Asana's API requires having an API token. To generate that token, head to
+the [Asana developer console](https://app.asana.com/0/developer-console) and
+enter the **Personal access tokens** section.
+
+There you can click on **+New access token**. A prompt will be opened allowing
+you to give the token a name and then create it.
+
+_Note: Treat your PAT like you would with a password. Do not share it or display
+it online._
+
 ### Sample expression
 
 ## Find a single task of a given project using the task id.
@@ -53,9 +65,9 @@ createTask({
 
 ## Update a task or create a new one
 
-You can use a field name literal as `externalId` to match a specific task. If the task
-does not exist, a new one will be created.
-The first parameter in this function should be the `project_id`.
+You can use a field name literal as `externalId` to match a specific task. If
+the task does not exist, a new one will be created. The first parameter in this
+function should be the `project_id`.
 
 ```js
 upsertTask('12344', {
@@ -70,8 +82,11 @@ upsertTask('12344', {
 
 ## Development
 
-Clone the repo, run `npm install`.
+Clone the [adaptors monorepo](https://github.com/OpenFn/adaptors). Follow the
+`Getting Started` guide inside to get set up.
+
+Run tests using `pnpm run test` or `pnpm run test:watch`
 
-Run tests using `npm run test` or `npm run test:watch`
+Build the project using `pnpm build`.
 
-Build the project using `npm run build`.
+To just build the docs run `pnpm build docs`

package/configuration-schema.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "apiVersion": {
+      "title": "API Version",
+      "type": "string",
+      "description": "The API version"
+    },
+    "token": {
+      "title": "Token",
+      "type": "string",
+      "description": "The API token"
+    }
+  },
+  "type": "object",
+  "additionalProperties": true,
+  "required": ["apiVersion", "token"]
+}

package/dist/index.cjs

@@ -0,0 +1,196 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.js
+var src_exports = {};
+__export(src_exports, {
+  Adaptor: () => Adaptor_exports,
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  alterState: () => import_language_common2.alterState,
+  createTask: () => createTask,
+  dataPath: () => import_language_common2.dataPath,
+  dataValue: () => import_language_common2.dataValue,
+  dateFns: () => import_language_common2.dateFns,
+  each: () => import_language_common2.each,
+  execute: () => execute,
+  field: () => import_language_common2.field,
+  fields: () => import_language_common2.fields,
+  fn: () => import_language_common2.fn,
+  getTask: () => getTask,
+  getTasks: () => getTasks,
+  http: () => import_language_common2.http,
+  lastReferenceValue: () => import_language_common2.lastReferenceValue,
+  merge: () => import_language_common2.merge,
+  sourceValue: () => import_language_common2.sourceValue,
+  updateTask: () => updateTask,
+  upsertTask: () => upsertTask
+});
+var import_language_common = require("@openfn/language-common");
+var import_language_common2 = require("@openfn/language-common");
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return (0, import_language_common.execute)(...operations)({
+      ...initialState,
+      ...state
+    });
+  };
+}
+function getTask(task_gid, params, callback) {
+  return (state) => {
+    task_gid = (0, import_language_common.expandReferences)(task_gid)(state);
+    const { opt_fields } = (0, import_language_common.expandReferences)(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/tasks/${task_gid}`;
+    const config = {
+      url,
+      headers: { Authorization: `Bearer ${token}` },
+      params: {
+        opt_fields
+      }
+    };
+    return import_language_common.http.get(config)(state).then((response) => {
+      const nextState = {
+        ...(0, import_language_common.composeNextState)(state, response.data),
+        response
+      };
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    });
+  };
+}
+function getTasks(project_gid, params, callback) {
+  return (state) => {
+    project_gid = (0, import_language_common.expandReferences)(project_gid)(state);
+    const { opt_fields } = (0, import_language_common.expandReferences)(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/projects/${project_gid}/tasks`;
+    const config = {
+      url,
+      headers: { Authorization: `Bearer ${token}` },
+      params: {
+        opt_fields
+      }
+    };
+    return import_language_common.http.get(config)(state).then((response) => {
+      const nextState = {
+        ...(0, import_language_common.composeNextState)(state, response.data),
+        response
+      };
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    });
+  };
+}
+function updateTask(task_gid, params, callback) {
+  return (state) => {
+    task_gid = (0, import_language_common.expandReferences)(task_gid)(state);
+    params = (0, import_language_common.expandReferences)(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/tasks/${task_gid}/`;
+    const config = {
+      url,
+      data: { data: params },
+      headers: { Authorization: `Bearer ${token}` }
+    };
+    return import_language_common.http.put(config)(state).then((response) => {
+      const nextState = {
+        ...(0, import_language_common.composeNextState)(state, response.data),
+        response
+      };
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    }).catch((e) => {
+      console.log("Asana says:", e.response.data);
+      throw e;
+    });
+  };
+}
+function createTask(params, callback) {
+  return (state) => {
+    params = (0, import_language_common.expandReferences)(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/tasks/`;
+    const config = {
+      url,
+      data: { data: params },
+      headers: { Authorization: `Bearer ${token}` }
+    };
+    return import_language_common.http.post(config)(state).then((response) => {
+      const nextState = {
+        ...(0, import_language_common.composeNextState)(state, response.data),
+        response
+      };
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    }).catch((e) => {
+      console.log("Asana says:", e.response.data);
+      throw e;
+    });
+  };
+}
+function upsertTask(project_gid, params, callback) {
+  return (state) => {
+    project_gid = (0, import_language_common.expandReferences)(project_gid)(state);
+    const { externalId, data } = (0, import_language_common.expandReferences)(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/projects/${project_gid}/tasks`;
+    const config = {
+      url,
+      headers: { Authorization: `Bearer ${token}` },
+      params: {
+        opt_fields: `${externalId}`
+      }
+    };
+    return import_language_common.http.get(config)(state).then((response) => {
+      const matchingTask = response.data.data.find(
+        (task) => task[externalId] === data[externalId]
+      );
+      if (matchingTask) {
+        console.log("Matching task found. Performing update.");
+        console.log("Data to update", data);
+        delete data.projects;
+        delete data.workspace;
+        return updateTask(matchingTask.gid, data, callback)(state);
+      } else {
+        console.log("No matching task found. Performing create.");
+        return createTask(data, callback)(state);
+      }
+    });
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Adaptor
+});

package/dist/index.js

@@ -0,0 +1,194 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/Adaptor.js
+var Adaptor_exports = {};
+__export(Adaptor_exports, {
+  alterState: () => alterState,
+  createTask: () => createTask,
+  dataPath: () => dataPath,
+  dataValue: () => dataValue,
+  dateFns: () => dateFns,
+  each: () => each,
+  execute: () => execute,
+  field: () => field,
+  fields: () => fields,
+  fn: () => fn,
+  getTask: () => getTask,
+  getTasks: () => getTasks,
+  http: () => http2,
+  lastReferenceValue: () => lastReferenceValue,
+  merge: () => merge,
+  sourceValue: () => sourceValue,
+  updateTask: () => updateTask,
+  upsertTask: () => upsertTask
+});
+import {
+  execute as commonExecute,
+  composeNextState,
+  expandReferences,
+  http
+} from "@openfn/language-common";
+import {
+  alterState,
+  dataPath,
+  dataValue,
+  dateFns,
+  each,
+  field,
+  fields,
+  fn,
+  http as http2,
+  lastReferenceValue,
+  merge,
+  sourceValue
+} from "@openfn/language-common";
+function execute(...operations) {
+  const initialState = {
+    references: [],
+    data: null
+  };
+  return (state) => {
+    return commonExecute(...operations)({
+      ...initialState,
+      ...state
+    });
+  };
+}
+function getTask(task_gid, params, callback) {
+  return (state) => {
+    task_gid = expandReferences(task_gid)(state);
+    const { opt_fields } = expandReferences(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/tasks/${task_gid}`;
+    const config = {
+      url,
+      headers: { Authorization: `Bearer ${token}` },
+      params: {
+        opt_fields
+      }
+    };
+    return http.get(config)(state).then((response) => {
+      const nextState = {
+        ...composeNextState(state, response.data),
+        response
+      };
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    });
+  };
+}
+function getTasks(project_gid, params, callback) {
+  return (state) => {
+    project_gid = expandReferences(project_gid)(state);
+    const { opt_fields } = expandReferences(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/projects/${project_gid}/tasks`;
+    const config = {
+      url,
+      headers: { Authorization: `Bearer ${token}` },
+      params: {
+        opt_fields
+      }
+    };
+    return http.get(config)(state).then((response) => {
+      const nextState = {
+        ...composeNextState(state, response.data),
+        response
+      };
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    });
+  };
+}
+function updateTask(task_gid, params, callback) {
+  return (state) => {
+    task_gid = expandReferences(task_gid)(state);
+    params = expandReferences(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/tasks/${task_gid}/`;
+    const config = {
+      url,
+      data: { data: params },
+      headers: { Authorization: `Bearer ${token}` }
+    };
+    return http.put(config)(state).then((response) => {
+      const nextState = {
+        ...composeNextState(state, response.data),
+        response
+      };
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    }).catch((e) => {
+      console.log("Asana says:", e.response.data);
+      throw e;
+    });
+  };
+}
+function createTask(params, callback) {
+  return (state) => {
+    params = expandReferences(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/tasks/`;
+    const config = {
+      url,
+      data: { data: params },
+      headers: { Authorization: `Bearer ${token}` }
+    };
+    return http.post(config)(state).then((response) => {
+      const nextState = {
+        ...composeNextState(state, response.data),
+        response
+      };
+      if (callback)
+        return callback(nextState);
+      return nextState;
+    }).catch((e) => {
+      console.log("Asana says:", e.response.data);
+      throw e;
+    });
+  };
+}
+function upsertTask(project_gid, params, callback) {
+  return (state) => {
+    project_gid = expandReferences(project_gid)(state);
+    const { externalId, data } = expandReferences(params)(state);
+    const { apiVersion, token } = state.configuration;
+    const url = `https://app.asana.com/api/${apiVersion}/projects/${project_gid}/tasks`;
+    const config = {
+      url,
+      headers: { Authorization: `Bearer ${token}` },
+      params: {
+        opt_fields: `${externalId}`
+      }
+    };
+    return http.get(config)(state).then((response) => {
+      const matchingTask = response.data.data.find(
+        (task) => task[externalId] === data[externalId]
+      );
+      if (matchingTask) {
+        console.log("Matching task found. Performing update.");
+        console.log("Data to update", data);
+        delete data.projects;
+        delete data.workspace;
+        return updateTask(matchingTask.gid, data, callback)(state);
+      } else {
+        console.log("No matching task found. Performing create.");
+        return createTask(data, callback)(state);
+      }
+    });
+  };
+}
+
+// src/index.js
+var src_default = Adaptor_exports;
+export {
+  Adaptor_exports as Adaptor,
+  src_default as default
+};

package/package.json

@@ -1,48 +1,43 @@
 {
   "name": "@openfn/language-asana",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "An adaptor to access objects in Asana",
   "homepage": "https://docs.openfn.org",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/OpenFn/language-asana.git"
-  },
-  "main": "lib/index.js",
-  "scripts": {
-    "ast": "simple-ast --adaptor ./src/Adaptor.js --output ast.json",
-    "build": "node_modules/.bin/babel src -d lib && npm run ast",
-    "postversion": "git push && git push --tags",
-    "test": "mocha --require @babel/register",
-    "test:watch": "mocha -w --require @babel/register",
-    "version": "npm run build && git add -A lib ast.json"
+    "url": "https://github.com/openfn/adaptors.git"
   },
+  "main": "dist/index.cjs",
   "author": "Open Function Group",
   "license": "LGPLv3",
   "files": [
-    "lib/",
-    "ast.json"
+    "dist/",
+    "types/",
+    "ast.json",
+    "configuration-schema.json"
   ],
-  "directories": {
-    "lib": "./lib"
-  },
   "dependencies": {
     "@openfn/language-common": "^1.6.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.12.10",
-    "@babel/core": "^7.9.0",
-    "@babel/preset-env": "^7.9.5",
-    "@babel/register": "^7.9.0",
-    "@openfn/simple-ast": "^0.3.2",
-    "assertion-error": "^1.0.1",
-    "chai": "^4.2.0",
-    "deep-eql": "^4.0.0",
-    "jsdoc": "^3.6.6",
-    "mocha": "^7.1.0",
-    "nock": "^13.0.5",
-    "sinon": "^9.2.3"
+    "@openfn/simple-ast": "0.3.2",
+    "assertion-error": "1.1.0",
+    "chai": "4.3.6",
+    "deep-eql": "4.1.1",
+    "mocha": "7.2.0",
+    "nock": "13.2.9",
+    "sinon": "9.2.4",
+    "esno": "0.16.3",
+    "rimraf": "3.0.2",
+    "@openfn/buildtools": "^1.0.0"
   },
-  "bundledDependencies": [
-    "@openfn/language-common"
-  ]
-}
+  "type": "module",
+  "types": "types/index.d.ts",
+  "scripts": {
+    "build": "pnpm clean && build-adaptor asana",
+    "test": "mocha --experimental-specifier-resolution=node --no-warnings",
+    "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings",
+    "clean": "rm -rf dist types docs",
+    "pack": "pnpm pack --pack-destination ../../dist"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Execute a sequence of operations.
+ * Wraps `language-common/execute`, and prepends initial state for http.
+ * @example
+ * execute(
+ *   create('foo'),
+ *   delete('bar')
+ * )(state)
+ * @function
+ * @param {Operations} operations - Operations to be performed.
+ * @returns {Operation}
+ */
+declare function execute(...operations: Operations): Operation;
+/**
+ * Get a single task of a given project.
+ * @public
+ * @example
+ * getTask("task_gid",
+ *  {
+ *    opt_fields: "name,notes,assignee"
+ *  })
+ * @function
+ * @param {string} task_gid - Globally unique identifier for the task
+ * @param {object} params - Query params to include.
+ * @param {function} callback - (Optional) callback function
+ * @returns {Operation}
+ */
+declare function getTask(task_gid: string, params: object, callback: Function): Operation;
+/**
+ * Get the list of tasks for a given project.
+ * @public
+ * @example
+ * getTasks("project_gid",
+ *  {
+ *    opt_fields: "name,notes,assignee"
+ *  })
+ * @function
+ * @param {string} project_gid - Globally unique identifier for the project
+ * @param {object} params - Query params to include.
+ * @param {function} callback - (Optional) callback function
+ * @returns {Operation}
+ */
+declare function getTasks(project_gid: string, params: object, callback: Function): Operation;
+/**
+ * Update a specific task.
+ * @public
+ * @example
+ * updateTask("task_gid",
+ *  {
+ *    name: 'test', "approval_status": "pending", "assignee": "12345"
+ *  }
+ * )
+ * @function
+ * @param {string} task_gid - Globally unique identifier for the task
+ * @param {object} params - Body parameters
+ * @param {function} callback - (Optional) callback function
+ * @returns {Operation}
+ */
+declare function updateTask(task_gid: string, params: object, callback: Function): Operation;
+/**
+ * Create a task.
+ * @public
+ * @example
+ * createTask(
+ *  {
+ *    name: 'test', "approval_status": "pending", "assignee": "12345"
+ *  }
+ * )
+ * @function
+ * @param {object} params - Body parameters
+ * @param {function} callback - (Optional) callback function
+ * @returns {Operation}
+ */
+declare function createTask(params: object, callback: Function): Operation;
+/**
+ * Update or create a task.
+ * @public
+ * @example
+ * upsertTask(
+ *  "1201382240880",
+ *  {
+ *    "externalId": "name",
+ *    "data": {
+ *      name: 'test', "approval_status": "pending", "assignee": "12345"
+ *    }
+ *
+ *  }
+ * )
+ * @function
+ * @param {string} project_gid - Globally unique identifier for the project
+ * @param {object} params - an object with an externalId and some task data.
+ * @param {function} callback - (Optional) callback function
+ * @returns {Operation}
+ */
+declare function upsertTask(project_gid: string, params: object, callback: Function): Operation;
+
+declare const Adaptor_execute: typeof execute;
+declare const Adaptor_getTask: typeof getTask;
+declare const Adaptor_getTasks: typeof getTasks;
+declare const Adaptor_updateTask: typeof updateTask;
+declare const Adaptor_createTask: typeof createTask;
+declare const Adaptor_upsertTask: typeof upsertTask;
+declare namespace Adaptor {
+  export {
+    Adaptor_execute as execute,
+    Adaptor_getTask as getTask,
+    Adaptor_getTasks as getTasks,
+    Adaptor_updateTask as updateTask,
+    Adaptor_createTask as createTask,
+    Adaptor_upsertTask as upsertTask,
+  };
+}
+
+export { Adaptor, Adaptor as default };