asana 3.0.1 → 3.0.3

package/.github/workflows/publish.yaml

@@ -6,26 +6,47 @@ on:
       version:
         required: true
 
+defaults:
+  run:
+    shell: bash
+
+permissions:
+  contents: read
+  id-token: write
+
+env:
+  GENERATOR_VERSION: 3.0.54
+  GENERATOR_NAME: swagger-codegen-cli.jar
+  JAR_ASANA: codegen/swagger/target/AsanaClientCodegen-swagger-codegen-1.0.0.jar
+  ACTUAL_LANG: com.asana.codegen.JavascriptClientCodegenGenerator
+  NAME: asana
+
 jobs:
   generate-javascript-library:
     name: Generate JavaScript client library
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-java@v3
+      - name: Authenticate to AWS
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-region: us-east-1
+          role-to-assume: arn:aws:iam::403483446840:role/autogen_role_beta_github_actions_release_asana_client_libraries
+      - name: Get GitHub app token
+        uses: asana/get-github-app-token@v1
+        id: get-token
+        with:
+          github-app-name: asana-publish-client-libraries
+      - name: Checkout repo files and set the git token
+        uses: actions/checkout@v4
+        with:
+          token: ${{ steps.get-token.outputs.app-token }}
+      - uses: actions/setup-java@v4
         with:
           distribution: "temurin"
           java-version: "17"
-      - name: Setup environment variables
-        run: |
-          echo "generator_version=3.0.52" >> "$GITHUB_ENV"
-          echo "generator_name=swagger-codegen-cli.jar" >> "$GITHUB_ENV"
-          echo "jar_asana=codegen/swagger/target/AsanaClientCodegen-swagger-codegen-1.0.0.jar" >> "$GITHUB_ENV"
-          echo "actual_lang=com.asana.codegen.JavascriptClientCodegenGenerator" >> "$GITHUB_ENV"
-          echo "name=asana" >> "$GITHUB_ENV"
       - name: Download generator
         run: |
-          wget -q -O $generator_name https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/${{ env.generator_version }}/swagger-codegen-cli-${{ env.generator_version }}.jar
+          wget -q -O $GENERATOR_NAME https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/${{ env.GENERATOR_VERSION }}/swagger-codegen-cli-${{ env.GENERATOR_VERSION }}.jar
       - name: Build custom code
         run: |
           pushd codegen/swagger >/dev/null
@@ -33,34 +54,48 @@ jobs:
           popd >/dev/null
       - name: Generate library
         run: >-
-          java -cp "${{ env.jar_asana }}:${{ env.generator_name }}"
+          java -cp "${{ env.JAR_ASANA }}:${{ env.GENERATOR_NAME }}"
           io.swagger.codegen.v3.cli.SwaggerCodegen
           generate
           --input-spec https://raw.githubusercontent.com/Asana/openapi/master/defs/asana_sdk_oas.yaml
           --template-dir "codegen/templates"
-          --lang "${{ env.actual_lang }}"
-          -DpackageName=${{ env.name }}
-          --additional-properties "projectVersion=${{ inputs.version }},projectName=${{ env.name }},packageName=${{ env.name }},usePromises=true,useES6=true"
+          --lang "${{ env.ACTUAL_LANG }}"
+          -DpackageName=${{ env.NAME }}
+          --additional-properties "projectVersion=${{ inputs.version }},projectName=${{ env.NAME }},packageName=${{ env.NAME }},usePromises=true,useES6=true"
       - name: Clean up generator
-        run: rm -rf codegen/swagger/target ${{ env.generator_name }} 
+        run: rm -rf codegen/swagger/target ${{ env.GENERATOR_NAME }}
       - name: Push changes to master branch
-        uses: EndBug/add-and-commit@v9
-        with:
-          message: 'Updated JavaScript SDK: v${{ inputs.version }}'
-          committer_name: GitHub Actions
-          committer_email: actions@github.com
-          tag: 'v${{ inputs.version }} --force'
-          tag_push: '--force'
-  build-n-publish-to-npmjs:
+        run: |
+          git config user.name asana-publish-client-libraries[bot]
+          git config user.email 159857493+asana-publish-client-libraries[bot]@users.noreply.github.com
+          git add .
+          git commit -m 'Updated JavaScript SDK: v${{ inputs.version }}'
+          git push origin master
+          git pull
+          git tag 'v${{ inputs.version }}' --force
+          git push origin --tags --force
+  publish-to-npmjs:
     needs: generate-javascript-library
     name: Build and publish 📦 to npmjs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Authenticate to AWS
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-region: us-east-1
+          role-to-assume: arn:aws:iam::403483446840:role/autogen_role_beta_github_actions_release_asana_client_libraries
+      - name: Load secrets
+        uses: aws-actions/aws-secretsmanager-get-secrets@v1
+        with:
+          secret-ids: NPM_API,prod/github_actions_release_asana_client_libraries/npm_api_key
+          # npm_api_key secret is stored as {key:"***..."}.
+          # GitHub Actions environment variable name is NPM_API so to access "key" from the json we can use NPM_API_KEY
+          parse-json-secrets: true
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: master
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: "18.x"
           registry-url: "https://registry.npmjs.com"
@@ -72,17 +107,27 @@ jobs:
           npm install
           npm publish
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-  publish-to-github:
-    needs: build-n-publish-to-npmjs
-    name: Publish to GitHub Releases
+          NODE_AUTH_TOKEN: ${{ env.NPM_API_KEY }}
+  publish-to-github-releases:
+    needs: publish-to-npmjs
+    name: Build and publish to GitHub Releases
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Authenticate to AWS
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-region: us-east-1
+          role-to-assume: arn:aws:iam::403483446840:role/autogen_role_beta_github_actions_release_asana_client_libraries
+      - name: Get GitHub app token
+        uses: asana/get-github-app-token@v1
+        id: get-token
+        with:
+          github-app-name: asana-publish-client-libraries
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: master
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: "18.x"
           registry-url: "https://registry.npmjs.com"
@@ -99,11 +144,6 @@ jobs:
           browserify dist/index.js -s Asana | uglifyjs > dist/asana-min.js
           browserify dist/index.js -s Asana > dist/asana.js
       - name: Publish to GitHub Releases
-        uses: softprops/action-gh-release@v1
+        run: gh release create v${{ inputs.version }} dist/asana.js dist/asana-min.js
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: v${{ inputs.version }}
-          files: |
-            dist/asana.js
-            dist/asana-min.js
+          GH_TOKEN: ${{ steps.get-token.outputs.app-token }}

package/.swagger-codegen/VERSION

@@ -1 +1 @@
-3.0.52
+3.0.54

package/README.md

@@ -1,18 +1,7 @@
 # asana [![GitHub release][release-image]][release-url] [![NPM Version][npm-image]][npm-url]
 
-> **Important**
-> Version 3.X.X is the newest release of our Node client library and currently in public beta. This means that while it has the latest Asana features, we're still putting on the final touches to ensure it's as stable and reliable as possible.
->
->🛠️ **Looking Ahead**
->
-> This version will receive updates going forward, and it’s on track to reach full stability soon. Your input is invaluable in this process! If you spot any issues, have suggestions, or need help, don’t hesitate to reach out. You can open a GitHub issue or submit your feedback directly to us.
-> 
->📖 **Get Started with Examples and Resources**
->
-> For now, if you’re in search of a version that has stood the test of time and is proven to be stable, we recommend using version 1.0.2. You can easily install it using:  `npm install asana@1.0.2` and following v1 samples and documentation.
-
 - API version: 1.0
-- Package version: 3.0.1
+- Package version: 3.0.3
 
 ## Installation
 
@@ -29,7 +18,7 @@ npm install asana --save
 Include the latest release directly from GitHub:
 
 ```html
-<script src="https://github.com/Asana/node-asana/releases/download/v3.0.1/asana-min.js"></script>
+<script src="https://github.com/Asana/node-asana/releases/download/v3.0.3/asana-min.js"></script>
 ```
 
 Example usage (**NOTE**: be careful not to expose your access token):
@@ -243,6 +232,7 @@ Class | Method | HTTP request | Description
 *Asana.MembershipsApi* | [**deleteMembership**](docs/MembershipsApi.md#deleteMembership) | **DELETE** /memberships/{membership_gid} | Delete a membership
 *Asana.MembershipsApi* | [**getMembership**](docs/MembershipsApi.md#getMembership) | **GET** /memberships/{membership_gid} | Get a membership
 *Asana.MembershipsApi* | [**getMemberships**](docs/MembershipsApi.md#getMemberships) | **GET** /memberships | Get multiple memberships
+*Asana.MembershipsApi* | [**updateMembership**](docs/MembershipsApi.md#updateMembership) | **PUT** /memberships/{membership_gid} | Update a membership
 *Asana.OrganizationExportsApi* | [**createOrganizationExport**](docs/OrganizationExportsApi.md#createOrganizationExport) | **POST** /organization_exports | Create an organization export request
 *Asana.OrganizationExportsApi* | [**getOrganizationExport**](docs/OrganizationExportsApi.md#getOrganizationExport) | **GET** /organization_exports/{organization_export_gid} | Get details on an org export request
 *Asana.PortfolioMembershipsApi* | [**getPortfolioMembership**](docs/PortfolioMembershipsApi.md#getPortfolioMembership) | **GET** /portfolio_memberships/{portfolio_membership_gid} | Get a portfolio membership
@@ -319,6 +309,7 @@ Class | Method | HTTP request | Description
 *Asana.TagsApi* | [**getTagsForTask**](docs/TagsApi.md#getTagsForTask) | **GET** /tasks/{task_gid}/tags | Get a task&#x27;s tags
 *Asana.TagsApi* | [**getTagsForWorkspace**](docs/TagsApi.md#getTagsForWorkspace) | **GET** /workspaces/{workspace_gid}/tags | Get tags in a workspace
 *Asana.TagsApi* | [**updateTag**](docs/TagsApi.md#updateTag) | **PUT** /tags/{tag_gid} | Update a tag
+*Asana.TaskTemplatesApi* | [**deleteTaskTemplate**](docs/TaskTemplatesApi.md#deleteTaskTemplate) | **DELETE** /task_templates/{task_template_gid} | Delete a task template
 *Asana.TaskTemplatesApi* | [**getTaskTemplate**](docs/TaskTemplatesApi.md#getTaskTemplate) | **GET** /task_templates/{task_template_gid} | Get a task template
 *Asana.TaskTemplatesApi* | [**getTaskTemplates**](docs/TaskTemplatesApi.md#getTaskTemplates) | **GET** /task_templates | Get multiple task templates
 *Asana.TaskTemplatesApi* | [**instantiateTask**](docs/TaskTemplatesApi.md#instantiateTask) | **POST** /task_templates/{task_template_gid}/instantiateTask | Instantiate a task from a task template
@@ -335,6 +326,7 @@ Class | Method | HTTP request | Description
 *Asana.TasksApi* | [**getDependentsForTask**](docs/TasksApi.md#getDependentsForTask) | **GET** /tasks/{task_gid}/dependents | Get dependents from a task
 *Asana.TasksApi* | [**getSubtasksForTask**](docs/TasksApi.md#getSubtasksForTask) | **GET** /tasks/{task_gid}/subtasks | Get subtasks from a task
 *Asana.TasksApi* | [**getTask**](docs/TasksApi.md#getTask) | **GET** /tasks/{task_gid} | Get a task
+*Asana.TasksApi* | [**getTaskForCustomID**](docs/TasksApi.md#getTaskForCustomID) | **GET** /workspaces/{workspace_gid}/tasks/custom_id/{custom_id} | Get a task for a given custom ID
 *Asana.TasksApi* | [**getTasks**](docs/TasksApi.md#getTasks) | **GET** /tasks | Get multiple tasks
 *Asana.TasksApi* | [**getTasksForProject**](docs/TasksApi.md#getTasksForProject) | **GET** /projects/{project_gid}/tasks | Get tasks from a project
 *Asana.TasksApi* | [**getTasksForSection**](docs/TasksApi.md#getTasksForSection) | **GET** /sections/{section_gid}/tasks | Get tasks from a section
@@ -597,22 +589,25 @@ token.accessToken = '<YOUR_ACCESS_TOKEN>';
 
 let tasksApiInstance = new Asana.TasksApi();
 let opts = {
-    "project": "<YOUR_PROJECT_GID>"
-    "limit": 100
+    "project": "<YOUR_PROJECT_GID>",
+    "limit": 100,
 };
 
 async function getAllTasks(opts) {
-    let tasks = await tasksApiInstance.getTasks(opts).then(async (firstPage) => {
-        let res = []
-        res = res.concat(firstPage.data);
-        // Get the next page
-        let nextPage = await firstPage.nextPage();
-        // Keep fetching for the next page until there are no more results
-        while(nextPage.data) {
-            res = res.concat(nextPage.data);
-            nextPage = await nextPage.nextPage();
+    let tasks = await tasksApiInstance.getTasks(opts).then(async (response) => {
+        let result = [];
+        let page = response;
+        while(true) {
+            // Add items on page to list of results
+            result = result.concat(page.data);
+            // Fetch the next page
+            page = await page.nextPage();
+            // If the there is no data in the next page break from the loop
+            if (!page.data) {
+                break;
+            }
         }
-        return res;
+        return result;
     }, (error) => {
         console.error(error.response.body);
     });
@@ -621,6 +616,79 @@ async function getAllTasks(opts) {
 }
 
 getAllTasks(opts);
+
+```
+
+Sample output:
+```bash
+Tasks: [
+    {
+      "gid": "123",
+      "name": "task 1",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "456",
+      "name": "task 2",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "789",
+      "name": "task 3",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "101112",
+      "name": "task 4",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "131415",
+      "name": "task 5",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "161718",
+      "name": "task 6",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "192021",
+      "name": "task 7",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "222324",
+      "name": "task 8",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "252627",
+      "name": "task 9",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "282930",
+      "name": "task 10",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+    {
+      "gid": "313233",
+      "name": "task 11",
+      "resource_type": "task",
+      "resource_subtype": "default_task"
+    },
+]
 ```
 
 EX: Pagination do something per page
@@ -634,28 +702,55 @@ token.accessToken = '<YOUR_ACCESS_TOKEN>';
 let tasksApiInstance = new Asana.TasksApi();
 let opts = {
     'project': "<YOUR_PROJECT_GID>",
-    'limit': 10
+    "limit": 5,
 };
 
-pageIndex = 1;
-
-tasksApiInstance.getTasks(opts).then(async (firstPage) => {
-    // Do something with the first <LIMIT> results. EX: print out results
-    console.log(`Page ${pageIndex}: ` + JSON.stringify(firstPage.data, null, 2));
+let pageIndex = 1;
 
-    // Get the next page
-    let nextPage = await firstPage.nextPage();
-    // Keep fetching for the next page until there are no more results
-    while(nextPage.data) {
-        // Do something with the next <LIMIT> results. EX: print out results
+tasksApiInstance.getTasks(opts).then(async (response) => {
+    let page = response;
+    while(true) {
+        // Do something with the page results
+        // EX: print the name of the tasks on that page
+        console.log(`Page ${pageIndex}: `);
+        page.data.forEach(task => {
+            console.log(`    ${task.name}`);
+        });
         pageIndex += 1;
-        console.log(`Page ${pageIndex}: ` + JSON.stringify(nextPage.data, null, 2));
-        // Get the next page
-        nextPage = await nextPage.nextPage();
+
+        page = await page.nextPage();
+        // If the there is no data in the next page break from the loop
+        if (!page.data) {
+            break;
+        }
     }
 }, (error) => {
     console.error(error.response.body);
 });
+
+```
+
+Sample output:
+
+```bash
+Page 1:
+    task 1
+    task 2
+    task 3
+    task 4
+    task 5
+Page 2:
+    task 6
+    task 7
+    task 8
+    task 9
+    task 10
+Page 3:
+    task 11
+    task 12
+    task 13
+    task 14
+    task 15
 ```
 
 ### Turning off Pagination
@@ -1011,6 +1106,6 @@ client.callApi(
 ```
 
 [release-image]: https://img.shields.io/github/release/asana/node-asana.svg
-[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.0.1
+[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.0.3
 [npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square
 [npm-url]: https://www.npmjs.org/package/asana

package/build-tests/README.md

@@ -0,0 +1,19 @@
+# Test Build
+
+This directory contains tests that are meant to be ran locally
+
+1. Install dependencies: `npm i`
+
+2. Setup Environment Variables. Create a `.env` file within the root of the project directory with the following information
+
+```
+PERSONAL_ACCESS_TOKEN=<YOUR_ASANA_PERSONAL_ACCESS_TOKEN>
+TEAM_GID=<YOUR_TEAM_GID>
+TEXT_CUSTOM_FIELD_GID=<YOUR_TEXT_CUSTOM_FIELD_GID> -> NOTE: make sure that there is at least one task that has this custom field and the value of the custom field on that task is `custom_value`
+USER_GID=<YOUR_USER_GID>
+WORKSPACE_GID=<YOUR_WORKSPACE_GID>
+```
+
+3. Run tests: `npm run testbuild`
+
+TIP: to debug, add `debugger;` to the location of the test code you want to debug and re-run `npm run testbuild`

package/build-tests/api/ProjectsApi.js

@@ -0,0 +1,178 @@
+(function (root, factory) {
+    if (typeof define === "function" && define.amd) {
+        // AMD.
+        define(["expect.js", "../../src/index"], factory);
+    } else if (typeof module === "object" && module.exports) {
+        // CommonJS-like environments that support module.exports, like Node.
+        factory(require("expect.js"), require("../../src/index"));
+    } else {
+        // Browser globals (root is window)
+        factory(root.expect, root.Asana);
+    }
+})(this, function (expect, Asana) {
+    "use strict";
+
+    var TEAM_GID;
+    var WORKSPACE_GID;
+
+    var projectsApiInstance;
+    var project;
+    var projects;
+
+    before(async function () {
+        require('dotenv').config()
+        TEAM_GID = process.env.TEAM_GID;
+        WORKSPACE_GID = process.env.WORKSPACE_GID;
+
+        let client = Asana.ApiClient.instance;
+        let token = client.authentications["token"];
+        token.accessToken = process.env.PERSONAL_ACCESS_TOKEN;
+
+        projectsApiInstance = new Asana.ProjectsApi();
+    });
+
+    describe("ProjectsApi", function () {
+        describe("createProject", function () {
+            it("should have created project", async function () {
+                let body = {
+                    data: {
+                        name: "Project 1",
+                        notes: "Some description",
+                        team: TEAM_GID,
+                    },
+                };
+
+                try {
+                    project = await projectsApiInstance.createProject(body, {});
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(project).to.be.ok();
+            });
+            it("should have a `name`", function () {
+                expect(project.data.name).to.be("Project 1");
+            });
+            it("should have a description/`notes`", function () {
+                expect(project.data.notes).to.be("Some description");
+            });
+        });
+        describe("updateProject", function () {
+            it("should have updated project", async function () {
+                let body = {
+                    data: {
+                        name: "Project 1 - Updated",
+                        notes: "Updated description",
+                    },
+                };
+
+                try {
+                    project = await projectsApiInstance.updateProject(
+                        body,
+                        project.data.gid,
+                        {}
+                    );
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(project).to.be.ok();
+            });
+            it("should have updated project `name`", function () {
+                expect(project.data.name).to.be("Project 1 - Updated");
+            });
+            it("should have updated project description/`notes`", function () {
+                expect(project.data.notes).to.be("Updated description");
+            });
+        });
+        describe("getProject", function () {
+            it("should return project", async function () {
+                let response;
+                try {
+                    response = await projectsApiInstance.getProject(
+                        project.data.gid,
+                        {}
+                    );
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(response).to.ok();
+            });
+        });
+        describe("getProject with `opt_fields`", function () {
+            describe("ask for `html_notes` and `due_on` properties in `opt_fields`", function () {
+                it("should return project", async function () {
+                    let opts = {
+                        opt_fields: "html_notes,due_on",
+                    };
+
+                    try {
+                        project = await projectsApiInstance.getProject(
+                            project.data.gid,
+                            opts
+                        );
+                    } catch (error) {
+                        throw error.response.body;
+                    }
+                    expect(project).to.ok();
+                });
+                it("should have `html_notes`", async function () {
+                    expect(project.data.html_notes).not.to.equal(null);
+                });
+                it("should have `due_on` with `null` value", async function () {
+                    expect(project.data.due_on).to.be(null);
+                });
+            });
+        });
+        describe("getProjects", function () {
+            it("should return an array of projects", async function () {
+                let opts = {
+                    limit: 100,
+                    workspace: WORKSPACE_GID,
+                };
+                try {
+                    projects = await projectsApiInstance.getProjects(opts);
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(projects).to.be.ok();
+                expect(projects.data).to.be.an("array");
+            });
+        });
+        describe("getProjects with `opt_fields`", function () {
+            describe("ask for `color` and `completed` properties in `opt_fields`", function () {
+                it("should return an array of projects", async function () {
+                    let opts = {
+                        workspace: WORKSPACE_GID,
+                        opt_fields: "color,completed",
+                    };
+
+                    try {
+                        projects = await projectsApiInstance.getProjects(opts);
+                    } catch (error) {
+                        throw error.response.body;
+                    }
+                    expect(projects).to.be.ok();
+                    expect(projects.data).to.be.an("array");
+                });
+                it("should have `workspace`", function () {
+                    expect("color" in projects.data[0]).to.be(true);
+                });
+                it("should have `completed`", function () {
+                    expect("completed" in projects.data[0]).to.be(true);
+                });
+            });
+        });
+        describe("deleteProject", function () {
+            it("should be deleted", async function () {
+                let response;
+                try {
+                    response = await projectsApiInstance.deleteProject(
+                        project.data.gid
+                    );
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(response.data).to.be.empty();
+            });
+        });
+    });
+});