@openfn/language-asana 4.2.2 → 4.3.0

package/ast.json

@@ -359,6 +359,88 @@
       },
       "valid": false
     },
+    {
+      "name": "searchTask",
+      "params": [
+        "task",
+        "query",
+        "options"
+      ],
+      "docs": {
+        "description": "Search for tasks in a workspace by task name.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "searchTask(\"Test Search Task\", {\n  resource_subtype: \"default_task\",\n  sort_by: \"modified_at\"\n});",
+            "caption": "Search for a task by name"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "The text or name of the task to search for.",
+            "type": {
+              "type": "NameExpression",
+              "name": "string"
+            },
+            "name": "task"
+          },
+          {
+            "title": "param",
+            "description": "Query params. See {@link https://developers.asana.com/reference/searchtasksforworkspace Docs} for a list of valid parameters.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "object"
+              }
+            },
+            "name": "query"
+          },
+          {
+            "title": "param",
+            "description": "(Optional) options argument.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "object"
+              }
+            },
+            "name": "options"
+          },
+          {
+            "title": "param",
+            "description": "The workspace to search in. Defaults to the workspace specified in the configuration.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "string"
+              }
+            },
+            "name": "options.workspaceGid"
+          },
+          {
+            "title": "returns",
+            "description": "An operation that, when executed, returns the search results in state.data.",
+            "type": {
+              "type": "NameExpression",
+              "name": "Operation"
+            }
+          }
+        ]
+      },
+      "valid": false
+    },
     {
       "name": "createTaskStory",
       "params": [

package/configuration-schema.json

@@ -17,11 +17,20 @@
       "examples": [
         "sample-tokenyWSJdXBACMLLWMNGgADFA"
       ]
+    },
+    "workspaceGid": {
+      "title": "Workspace GID",
+      "type": "string",
+      "description": "Globally unique identifier for the workspace or organization.",
+      "examples": [
+        "12345"
+      ]
     }
   },
   "type": "object",
   "additionalProperties": true,
   "required": [
-    "token"
+    "token",
+    "workspaceGid"
   ]
 }

package/dist/index.cjs

@@ -40,6 +40,7 @@ __export(src_exports, {
   lastReferenceValue: () => import_language_common3.lastReferenceValue,
   merge: () => import_language_common3.merge,
   request: () => request2,
+  searchTask: () => searchTask,
   sourceValue: () => import_language_common3.sourceValue,
   updateTask: () => updateTask,
   upsertTask: () => upsertTask
@@ -69,6 +70,7 @@ __export(Adaptor_exports, {
   lastReferenceValue: () => import_language_common3.lastReferenceValue,
   merge: () => import_language_common3.merge,
   request: () => request2,
+  searchTask: () => searchTask,
   sourceValue: () => import_language_common3.sourceValue,
   updateTask: () => updateTask,
   upsertTask: () => upsertTask
@@ -246,6 +248,30 @@ function upsertTask(projectGid, params, callback) {
     });
   };
 }
+function searchTask(task, query = {}, options = {}) {
+  return async (state) => {
+    const [resolvedTask, resolvedQuery, resolvedOptions] = (0, import_util2.expandReferences)(
+      state,
+      task,
+      query,
+      options
+    );
+    const { workspaceGid = state.configuration.workspaceGid } = resolvedOptions;
+    if (!workspaceGid)
+      throw new Error("You need to specify Workspace GID");
+    const response = await request(
+      state,
+      `workspaces/${workspaceGid}/tasks/search`,
+      {
+        query: {
+          text: resolvedTask,
+          ...resolvedQuery
+        }
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
 function createTaskStory(taskGid, params, callback) {
   return async (state) => {
     const [
@@ -315,6 +341,7 @@ var src_default = Adaptor_exports;
   lastReferenceValue,
   merge,
   request,
+  searchTask,
   sourceValue,
   updateTask,
   upsertTask

package/dist/index.js

@@ -27,6 +27,7 @@ __export(Adaptor_exports, {
   lastReferenceValue: () => lastReferenceValue,
   merge: () => merge,
   request: () => request2,
+  searchTask: () => searchTask,
   sourceValue: () => sourceValue,
   updateTask: () => updateTask,
   upsertTask: () => upsertTask
@@ -227,6 +228,30 @@ function upsertTask(projectGid, params, callback) {
     });
   };
 }
+function searchTask(task, query = {}, options = {}) {
+  return async (state) => {
+    const [resolvedTask, resolvedQuery, resolvedOptions] = expandReferences(
+      state,
+      task,
+      query,
+      options
+    );
+    const { workspaceGid = state.configuration.workspaceGid } = resolvedOptions;
+    if (!workspaceGid)
+      throw new Error("You need to specify Workspace GID");
+    const response = await request(
+      state,
+      `workspaces/${workspaceGid}/tasks/search`,
+      {
+        query: {
+          text: resolvedTask,
+          ...resolvedQuery
+        }
+      }
+    );
+    return prepareNextState(state, response);
+  };
+}
 function createTaskStory(taskGid, params, callback) {
   return async (state) => {
     const [
@@ -296,6 +321,7 @@ export {
   lastReferenceValue,
   merge,
   request2 as request,
+  searchTask,
   sourceValue,
   updateTask,
   upsertTask

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-asana",
-  "version": "4.2.2",
+  "version": "4.3.0",
   "label": "Asana",
   "description": "OpenFn adaptor for accessing objects in Asana",
   "homepage": "https://docs.openfn.org",

package/types/Adaptor.d.ts

@@ -109,6 +109,24 @@ export function upsertTask(projectGid: string, params: {
     externalId: string;
     data: object;
 }, callback: Function): Operation;
+/**
+ * Search for tasks in a workspace by task name.
+ * @public
+ * @example <caption>Search for a task by name</caption>
+ * searchTask("Test Search Task", {
+ *   resource_subtype: "default_task",
+ *   sort_by: "modified_at"
+ * });
+ * @function
+ * @param {string} task - The text or name of the task to search for.
+ * @param {object} [query] - Query params. See {@link https://developers.asana.com/reference/searchtasksforworkspace Docs} for a list of valid parameters.
+ * @param {object} [options] - (Optional) options argument.
+ * @param {string} [options.workspaceGid] - The workspace to search in. Defaults to the workspace specified in the configuration.
+ * @returns {Operation} An operation that, when executed, returns the search results in state.data.
+ */
+export function searchTask(task: string, query?: object, options?: {
+    workspaceGid?: string;
+}): Operation;
 /**
  * Options provided to the createTaskStory request
  * @typedef {Object} StoryOptions