@openfn/language-asana 5.0.0 → 5.0.2

package/ast.json

@@ -376,9 +376,24 @@
           },
           {
             "title": "example",
-            "description": "searchTask(\"Test Search Task\", {\n  resource_subtype: \"default_task\",\n  sort_by: \"modified_at\"\n});",
+            "description": "searchTask(\"Test Search Task\", {\n  sort_by: \"modified_at\"\n});",
             "caption": "Search for a task by name"
           },
+          {
+            "title": "example",
+            "description": "searchTask(\"\", {\n  \"custom_fields.12345.value\": $.data.custom_field_value,\n});",
+            "caption": "Search for a task by custom field only"
+          },
+          {
+            "title": "example",
+            "description": "searchTask(\"Test Search Task\", {\n  \"custom_fields.12345.is_set\": true,\n});",
+            "caption": "Search for a task by name and custom field"
+          },
+          {
+            "title": "example",
+            "description": "searchTask(\"Test Search Task\", {\n  resource_subtype: \"milestone\",\n});",
+            "caption": "Search for a milestone by name"
+          },
           {
             "title": "function",
             "description": null,
@@ -405,6 +420,19 @@
             },
             "name": "query"
           },
+          {
+            "title": "param",
+            "description": "The resource subtype to search for. Must be either `\"default_task\"` or `\"milestone\"`. Defaults to `\"default_task\"`.",
+            "type": {
+              "type": "OptionalType",
+              "expression": {
+                "type": "NameExpression",
+                "name": "string"
+              }
+            },
+            "name": "query.resource_subtype",
+            "default": "default_task"
+          },
           {
             "title": "param",
             "description": "(Optional) options argument.",
@@ -634,7 +662,7 @@
         "operation"
       ],
       "docs": {
-        "description": "A custom operation that will only execute the function if the condition returns true",
+        "description": "Execute a function only when the condition returns true",
         "tags": [
           {
             "title": "public",

package/dist/index.cjs

@@ -255,6 +255,7 @@ function searchTask(task, query = {}, options = {}) {
       options
     );
     const { workspaceGid = state.configuration.workspaceGid } = resolvedOptions;
+    const { resource_subtype = "default_task", ...restQuery } = resolvedQuery;
     if (!workspaceGid)
       throw new Error("You need to specify Workspace GID");
     const response = await request(
@@ -262,8 +263,9 @@ function searchTask(task, query = {}, options = {}) {
       `workspaces/${workspaceGid}/tasks/search`,
       {
         query: {
+          resource_subtype,
           text: resolvedTask,
-          ...resolvedQuery
+          ...restQuery
         }
       }
     );

package/dist/index.js

@@ -235,6 +235,7 @@ function searchTask(task, query = {}, options = {}) {
       options
     );
     const { workspaceGid = state.configuration.workspaceGid } = resolvedOptions;
+    const { resource_subtype = "default_task", ...restQuery } = resolvedQuery;
     if (!workspaceGid)
       throw new Error("You need to specify Workspace GID");
     const response = await request(
@@ -242,8 +243,9 @@ function searchTask(task, query = {}, options = {}) {
       `workspaces/${workspaceGid}/tasks/search`,
       {
         query: {
+          resource_subtype,
           text: resolvedTask,
-          ...resolvedQuery
+          ...restQuery
         }
       }
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-asana",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "label": "Asana",
   "description": "OpenFn adaptor for accessing objects in Asana",
   "homepage": "https://docs.openfn.org",
@@ -25,7 +25,7 @@
     "configuration-schema.json"
   ],
   "dependencies": {
-    "@openfn/language-common": "3.0.2"
+    "@openfn/language-common": "3.0.3"
   },
   "devDependencies": {
     "assertion-error": "2.0.0",

package/types/Adaptor.d.ts

@@ -114,17 +114,31 @@ export function upsertTask(projectGid: string, params: {
  * @public
  * @example <caption>Search for a task by name</caption>
  * searchTask("Test Search Task", {
- *   resource_subtype: "default_task",
  *   sort_by: "modified_at"
  * });
+ * @example <caption>Search for a task by custom field only</caption>
+ * searchTask("", {
+ *   "custom_fields.12345.value": $.data.custom_field_value,
+ * });
+ * @example <caption>Search for a task by name and custom field</caption>
+ * searchTask("Test Search Task", {
+ *   "custom_fields.12345.is_set": true,
+ * });
+ * @example <caption>Search for a milestone by name</caption>
+ * searchTask("Test Search Task", {
+ *   resource_subtype: "milestone",
+ * });
  * @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 {string} [query.resource_subtype = default_task] - The resource subtype to search for. Must be either `"default_task"` or `"milestone"`. Defaults to `"default_task"`.
  * @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?: {
+export function searchTask(task: string, query?: {
+    resource_subtype?: string;
+}, options?: {
     workspaceGid?: string;
 }): Operation;
 /**