@openfn/language-asana 3.2.0 → 4.0.0

package/ast.json

@@ -304,6 +304,143 @@
         ]
       },
       "valid": true
+    },
+    {
+      "name": "createTaskStory",
+      "params": [
+        "taskGid",
+        "params",
+        "callback"
+      ],
+      "docs": {
+        "description": "Options provided to the createTaskStory request",
+        "tags": [
+          {
+            "title": "typedef",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Object"
+            },
+            "name": "StoryOptions"
+          },
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "property",
+            "description": "The plain text of the comment to add. Cannot be used with html_text.",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "text"
+          },
+          {
+            "title": "property",
+            "description": "Opt In. HTML formatted text for a comment. This will not include the name of the creator.",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "html_text"
+          },
+          {
+            "title": "property",
+            "description": "Default to `false`. Whether the story should be pinned on the resource.",
+            "type": {
+              "type": "NameExpression",
+              "name": "boolean"
+            },
+            "name": "is_pinned"
+          },
+          {
+            "title": "property",
+            "description": "The name of the sticker in this story. `null` if there is no sticker.",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "sticker_name"
+          },
+          {
+            "title": "property",
+            "description": "Opt In. This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.",
+            "type": {
+              "type": "NameExpression",
+              "name": "array"
+            },
+            "name": "opt_fields"
+          },
+          {
+            "title": "property",
+            "description": "Defaults to `false`. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.",
+            "type": {
+              "type": "NameExpression",
+              "name": "boolean"
+            },
+            "name": "opt_pretty"
+          }
+        ]
+      },
+      "valid": false
+    },
+    {
+      "name": "request",
+      "params": [
+        "path",
+        "params",
+        "callback"
+      ],
+      "docs": {
+        "description": "Options provided to the Asana API request",
+        "tags": [
+          {
+            "title": "typedef",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Object"
+            },
+            "name": "RequestOptions"
+          },
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "property",
+            "description": "Body data to append to the request.",
+            "type": {
+              "type": "NameExpression",
+              "name": "object"
+            },
+            "name": "body"
+          },
+          {
+            "title": "property",
+            "description": "An object of query parameters to be encoded into the URL.",
+            "type": {
+              "type": "NameExpression",
+              "name": "object"
+            },
+            "name": "query"
+          },
+          {
+            "title": "property",
+            "description": "The HTTP method to use. Defaults to `GET`",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "method"
+          }
+        ]
+      },
+      "valid": false
     }
   ],
   "exports": [],
@@ -321,23 +458,76 @@
             "description": null,
             "type": null
           },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
           {
             "title": "example",
             "description": "fn(state => {\n  // do some things to state\n  return state;\n});"
           },
+          {
+            "title": "param",
+            "description": "is the function",
+            "type": {
+              "type": "NameExpression",
+              "name": "Function"
+            },
+            "name": "func"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": true
+    },
+    {
+      "name": "fnIf",
+      "params": [
+        "condition",
+        "operation"
+      ],
+      "docs": {
+        "description": "A custom operation that will only execute the function if the condition returns true",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
           {
             "title": "function",
             "description": null,
             "name": null
           },
+          {
+            "title": "example",
+            "description": "fnIf((state) => state?.data?.name, get(\"https://example.com\"));"
+          },
           {
             "title": "param",
-            "description": "is the function",
+            "description": "The condition that returns true",
             "type": {
               "type": "NameExpression",
-              "name": "Function"
+              "name": "Boolean"
             },
-            "name": "func"
+            "name": "condition"
+          },
+          {
+            "title": "param",
+            "description": "The operation needed to be executed.",
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            },
+            "name": "operation"
           },
           {
             "title": "returns",
@@ -364,15 +554,15 @@
             "description": null,
             "type": null
           },
-          {
-            "title": "example",
-            "description": "sourceValue('$.key')"
-          },
           {
             "title": "function",
             "description": null,
             "name": null
           },
+          {
+            "title": "example",
+            "description": "sourceValue('$.key')"
+          },
           {
             "title": "param",
             "description": "JSONPath referencing a point in `state`.",
@@ -407,15 +597,15 @@
             "description": null,
             "type": null
           },
-          {
-            "title": "example",
-            "description": "dataPath('key')"
-          },
           {
             "title": "function",
             "description": null,
             "name": null
           },
+          {
+            "title": "example",
+            "description": "dataPath('key')"
+          },
           {
             "title": "param",
             "description": "JSONPath referencing a point in `data`.",
@@ -450,15 +640,15 @@
             "description": null,
             "type": null
           },
-          {
-            "title": "example",
-            "description": "dataValue('key')"
-          },
           {
             "title": "function",
             "description": null,
             "name": null
           },
+          {
+            "title": "example",
+            "description": "dataValue('key')"
+          },
           {
             "title": "param",
             "description": "JSONPath referencing a point in `data`.",
@@ -493,15 +683,15 @@
             "description": null,
             "type": null
           },
-          {
-            "title": "example",
-            "description": "lastReferenceValue('key')"
-          },
           {
             "title": "function",
             "description": null,
             "name": null
           },
+          {
+            "title": "example",
+            "description": "lastReferenceValue('key')"
+          },
           {
             "title": "param",
             "description": "JSONPath referencing a point in `references`.",
@@ -537,15 +727,15 @@
             "description": null,
             "type": null
           },
-          {
-            "title": "example",
-            "description": "each(\"$.[*]\",\n  create(\"SObject\",\n    field(\"FirstName\", sourceValue(\"$.firstName\"))\n  )\n)"
-          },
           {
             "title": "function",
             "description": null,
             "name": null
           },
+          {
+            "title": "example",
+            "description": "each(\"$.[*]\",\n  create(\"SObject\",\n    field(\"FirstName\", sourceValue(\"$.firstName\"))\n  )\n)"
+          },
           {
             "title": "param",
             "description": "JSONPath referencing a point in `state`.",
@@ -590,15 +780,15 @@
             "description": null,
             "type": null
           },
-          {
-            "title": "example",
-            "description": "field('destination_field_name__c', 'value')"
-          },
           {
             "title": "function",
             "description": null,
             "name": null
           },
+          {
+            "title": "example",
+            "description": "field('destination_field_name__c', 'value')"
+          },
           {
             "title": "param",
             "description": "Name of the field",
@@ -642,15 +832,15 @@
             "description": null,
             "type": null
           },
-          {
-            "title": "example",
-            "description": "fields(list_of_fields)"
-          },
           {
             "title": "function",
             "description": null,
             "name": null
           },
+          {
+            "title": "example",
+            "description": "fields(list_of_fields)"
+          },
           {
             "title": "param",
             "description": "a list of fields",
@@ -695,6 +885,11 @@
             "description": null,
             "name": null
           },
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
           {
             "title": "param",
             "description": null,
@@ -732,13 +927,18 @@
         "options"
       ],
       "docs": {
-        "description": "Sets a cursor property on state.\nSupports natural language dates like `now`, `today`, `yesterday`, `n hours ago`, `n days ago`, and `start`,\nwhich will be converted relative to the environment (ie, the Lightning or CLI locale). Custom timezones \nare not yet supported.\nSee the usage guide at @{link https://docs.openfn.org/documentation/jobs/job-writing-guide#using-cursors}",
+        "description": "Sets a cursor property on state.\nSupports natural language dates like `now`, `today`, `yesterday`, `n hours ago`, `n days ago`, and `start`,\nwhich will be converted relative to the environment (ie, the Lightning or CLI locale). Custom timezones\nare not yet supported.\nYou can provide a formatter to customise the final cursor value, which is useful for normalising\ndifferent inputs. The custom formatter runs after natural language date conversion.\nSee the usage guide at {@link https://docs.openfn.org/documentation/jobs/job-writing-guide#using-cursors}",
         "tags": [
           {
             "title": "public",
             "description": null,
             "type": null
           },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
           {
             "title": "example",
             "description": "cursor($.cursor, { defaultValue: 'today' })",
@@ -749,11 +949,6 @@
             "description": "cursor(22)",
             "caption": "Use a pagination cursor"
           },
-          {
-            "title": "function",
-            "description": null,
-            "name": null
-          },
           {
             "title": "param",
             "description": "the cursor value. Usually an ISO date, natural language date, or page number",
@@ -790,6 +985,15 @@
             },
             "name": "options.defaultValue"
           },
+          {
+            "title": "param",
+            "description": "custom formatter for the final cursor value",
+            "type": {
+              "type": "NameExpression",
+              "name": "Function"
+            },
+            "name": "options.format"
+          },
           {
             "title": "returns",
             "description": null,

package/dist/index.cjs

@@ -32,6 +32,7 @@ __export(src_exports, {
   field: () => import_language_common3.field,
   fields: () => import_language_common3.fields,
   fn: () => import_language_common3.fn,
+  fnIf: () => import_language_common3.fnIf,
   getTask: () => getTask,
   getTasks: () => getTasks,
   http: () => import_language_common3.http,
@@ -59,6 +60,7 @@ __export(Adaptor_exports, {
   field: () => import_language_common3.field,
   fields: () => import_language_common3.fields,
   fn: () => import_language_common3.fn,
+  fnIf: () => import_language_common3.fnIf,
   getTask: () => getTask,
   getTasks: () => getTasks,
   http: () => import_language_common3.http,
@@ -100,8 +102,10 @@ function request(state, path, params, callback = (s) => s) {
       response: responseWithoutBody
     };
   }).then(callback).catch((err) => {
-    console.log("Asana says:");
-    (0, import_util.logResponse)(err);
+    if (err.code !== "BASE_URL_MISMATCH") {
+      console.log("Asana says:");
+      (0, import_util.logResponse)(err);
+    }
     throw err;
   });
 }
@@ -230,9 +234,14 @@ function createTaskStory(taskGid, params, callback) {
     );
   };
 }
-function request2(path, params, callback) {
+function request2(path, params = {}, callback) {
   return (state) => {
-    const [resolvedPath, { body = {}, query = {}, method = "GET" }] = (0, import_util2.expandReferences)(state, path, params);
+    const [resolvedPath, resolvedParams] = (0, import_util2.expandReferences)(
+      state,
+      path,
+      params
+    );
+    const { body = {}, query = {}, method = "GET" } = resolvedParams;
     return request(
       state,
       resolvedPath,
@@ -258,6 +267,7 @@ var src_default = Adaptor_exports;
   field,
   fields,
   fn,
+  fnIf,
   getTask,
   getTasks,
   http,

package/dist/index.js

@@ -19,6 +19,7 @@ __export(Adaptor_exports, {
   field: () => field,
   fields: () => fields,
   fn: () => fn,
+  fnIf: () => fnIf,
   getTask: () => getTask,
   getTasks: () => getTasks,
   http: () => http,
@@ -63,8 +64,10 @@ function request(state, path, params, callback = (s) => s) {
       response: responseWithoutBody
     };
   }).then(callback).catch((err) => {
-    console.log("Asana says:");
-    logResponse(err);
+    if (err.code !== "BASE_URL_MISMATCH") {
+      console.log("Asana says:");
+      logResponse(err);
+    }
     throw err;
   });
 }
@@ -80,6 +83,7 @@ import {
   field,
   fields,
   fn,
+  fnIf,
   http,
   lastReferenceValue,
   merge,
@@ -207,9 +211,14 @@ function createTaskStory(taskGid, params, callback) {
     );
   };
 }
-function request2(path, params, callback) {
+function request2(path, params = {}, callback) {
   return (state) => {
-    const [resolvedPath, { body = {}, query = {}, method = "GET" }] = expandReferences(state, path, params);
+    const [resolvedPath, resolvedParams] = expandReferences(
+      state,
+      path,
+      params
+    );
+    const { body = {}, query = {}, method = "GET" } = resolvedParams;
     return request(
       state,
       resolvedPath,
@@ -235,6 +244,7 @@ export {
   field,
   fields,
   fn,
+  fnIf,
   getTask,
   getTasks,
   http,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-asana",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "An adaptor to access objects in Asana",
   "homepage": "https://docs.openfn.org",
   "repository": {
@@ -23,7 +23,7 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "^1.13.0"
+    "@openfn/language-common": "2.0.0"
   },
   "devDependencies": {
     "@openfn/simple-ast": "0.4.1",

package/types/Adaptor.d.ts

@@ -94,6 +94,7 @@ export function upsertTask(projectGid: string, params: object, callback: Functio
 /**
  * Options provided to the createTaskStory request
  * @typedef {Object} StoryOptions
+ * @public
  * @property {string} text - The plain text of the comment to add. Cannot be used with html_text.
  * @property {string} html_text - Opt In. HTML formatted text for a comment. This will not include the name of the creator.
  * @property {boolean} is_pinned - Default to `false`. Whether the story should be pinned on the resource.
@@ -122,21 +123,28 @@ export function createTaskStory(taskGid: string, params: StoryOptions, callback:
 /**
  * Options provided to the Asana API request
  * @typedef {Object} RequestOptions
+ * @public
  * @property {object} body - Body data to append to the request.
  * @property {object} query - An object of query parameters to be encoded into the URL.
  * @property {string} method - The HTTP method to use. Defaults to `GET`
  */
 /**
- * Make a request in Asana API
+ * Make a HTTP request against the Asana API.
  * @public
- * @example
- * request("/asanaEndpoint", {
+ * @example Get a task by id
+ * request("/tasks/1234");
+ * @example Query for tasks in a given project
+ * request("/tasks", {
+ *   query: { project: "abc" },
+ * });
+ * @example Create a new task
+ * request("/tasks", {
  *   method: "POST",
- *   query: { foo: "bar", a: 1 },
+ *   body: { data: { name: "do the thing", completed: false } },
  * });
  * @function
- * @param {string} path - Path to resource
- * @param {RequestOptions} params - Query, body and method parameters
+ * @param {string} path - Path to resource (excluding api/version)
+ * @param {RequestOptions} params - (Optional) Query, body and method parameters
  * @param {function} callback - (Optional) Callback function
  * @returns {Operation}
  */
@@ -144,47 +152,9 @@ export function request(path: string, params: RequestOptions, callback: Function
 /**
  * Options provided to the createTaskStory request
  */
-export type StoryOptions = {
-    /**
-     * - The plain text of the comment to add. Cannot be used with html_text.
-     */
-    text: string;
-    /**
-     * - Opt In. HTML formatted text for a comment. This will not include the name of the creator.
-     */
-    html_text: string;
-    /**
-     * - Default to `false`. Whether the story should be pinned on the resource.
-     */
-    is_pinned: boolean;
-    /**
-     * - The name of the sticker in this story. `null` if there is no sticker.
-     */
-    sticker_name: string;
-    /**
-     * - Opt In. This endpoint returns a compact resource, which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.
-     */
-    opt_fields: any[];
-    /**
-     * - Defaults to `false`. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
-     */
-    opt_pretty: boolean;
-};
+export type StoryOptions = any;
 /**
  * Options provided to the Asana API request
  */
-export type RequestOptions = {
-    /**
-     * - Body data to append to the request.
-     */
-    body: object;
-    /**
-     * - An object of query parameters to be encoded into the URL.
-     */
-    query: object;
-    /**
-     * - The HTTP method to use. Defaults to `GET`
-     */
-    method: string;
-};
-export { alterState, cursor, dataPath, dataValue, dateFns, each, field, fields, fn, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";
+export type RequestOptions = any;
+export { alterState, cursor, dataPath, dataValue, dateFns, each, field, fields, fn, fnIf, http, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";