asana 3.0.0 → 3.0.2

package/.github/workflows/publish.yaml

@@ -18,7 +18,7 @@ jobs:
           java-version: "17"
       - name: Setup environment variables
         run: |
-          echo "generator_version=3.0.46" >> "$GITHUB_ENV"
+          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"

package/.swagger-codegen/VERSION

@@ -1 +1 @@
-3.0.46
+3.0.52

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.0
+- Package version: 3.0.2
 
 ## 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.0/asana-min.js"></script>
+<script src="https://github.com/Asana/node-asana/releases/download/v3.0.2/asana-min.js"></script>
 ```
 
 Example usage (**NOTE**: be careful not to expose your access token):
@@ -721,29 +710,34 @@ let opts = {
 };
 const timeouts = 5000
 
+// Used to fetch for initial sync token
 const setSyncToken = async () => {
     await eventsApiInstance.getEvents(resource, opts).then((result) => {
-        console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
+        console.log(JSON.stringify(result.data, null, 2));
     }, (error) => {
         let syncToken = error.response.body.sync;
         opts['sync'] = syncToken;
-        console.log(syncToken);
     });
 }
 
 const getEvents = async () => {
-    console.log("Setting Sync Token");
+    console.log("Setting sync token");
     await setSyncToken();
-    // Fetch for new events every 5 seconds -> NOTE: the sync token has expired or reached 100 events you will need to implement logic to get the next set of events
-    console.log(`Fetching events every ${timeouts/1000} second(s) since sync ${opts['sync']}:`);
+    // Fetch for new events every 5 seconds
+    console.log(`Fetching events every ${timeouts/1000} second(s)`);
     while(true) {
         await eventsApiInstance.getEvents(resource, opts).then((result) => {
-            console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
+            // Print response
+            console.log(`Fetching events since sync: ${opts['sync']}`);
+            console.log(JSON.stringify(result.data, null, 2));
+
+            // Update the sync token with the new sync token provided in the response
+            opts['sync'] = result._response.sync;
         }, (error) => {
             if (error.status === 412) {
                 let syncToken = error.response.body.sync;
                 opts['sync'] = syncToken;
-                console.log(syncToken);
+                console.log(`412 error new sync token: ${syncToken}`);
             } else{
                 console.error(error.response.text);
             }
@@ -1006,6 +1000,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.0
+[release-url]: https://github.com/Asana/node-asana/releases/tag/v3.0.2
 [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();
+            });
+        });
+    });
+});

package/build-tests/api/TasksApi.js

@@ -0,0 +1,260 @@
+// NOTE: Because these tests are making live API calls, we decided to write these tests in a particular order to optimize speed and reduce API calls.
+// The down side to this approach is that these tests are tightly coupled.
+(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 TEXT_CUSTOM_FIELD_GID;
+    var USER_GID;
+    var WORKSPACE_GID;
+
+    var tasksApiInstance;
+    var task;
+    var tasks;
+
+    before(async function () {
+        require('dotenv').config()
+        TEXT_CUSTOM_FIELD_GID = process.env.TEXT_CUSTOM_FIELD_GID;
+        USER_GID = process.env.USER_GID;
+        WORKSPACE_GID = process.env.WORKSPACE_GID;
+
+        let client = Asana.ApiClient.instance;
+        let token = client.authentications["token"];
+        token.accessToken = process.env.PERSONAL_ACCESS_TOKEN;
+        tasksApiInstance = new Asana.TasksApi();
+    });
+
+    describe("TasksApi", function () {
+        describe("createTask", function () {
+            it("should have created task", async function () {
+                let body = {
+                    data: {
+                        assignee: USER_GID,
+                        name: "Task 1",
+                        notes: "Some description",
+                        workspace: WORKSPACE_GID,
+                    },
+                };
+                try {
+                    task = await tasksApiInstance.createTask(body, {});
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(task).to.be.ok();
+            });
+            it("should have a `name`", function () {
+                expect(task.data.name).to.be("Task 1");
+            });
+            it("should have a description/`notes`", function () {
+                expect(task.data.notes).to.be("Some description");
+            });
+        });
+        describe("updateTask", function () {
+            it("should have updated task", async function () {
+                let body = {
+                    data: {
+                        name: "Task 1 - Updated",
+                        notes: "Updated description",
+                    },
+                };
+                try {
+                    task = await tasksApiInstance.updateTask(
+                        body,
+                        task.data.gid,
+                        {}
+                    );
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(task).to.be.ok();
+            });
+            it("should have updated task `name`", function () {
+                expect(task.data.name).to.be("Task 1 - Updated");
+            });
+            it("should have updated task description/`notes`", function () {
+                expect(task.data.notes).to.be("Updated description");
+            });
+        });
+        describe("getTask", function () {
+            it("should return task", async function () {
+                let response;
+                try {
+                    response = await tasksApiInstance.getTask(
+                        task.data.gid,
+                        {}
+                    );
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(response).to.ok();
+            });
+        });
+        describe("getTask with `opt_fields`", function () {
+            describe("task for `html_notes` and `due_on` properties in `opt_fields`", function () {
+                it("should return task", async function () {
+                    let opts = {
+                        opt_fields: "html_notes,due_on",
+                    };
+                    try {
+                        task = await tasksApiInstance.getTask(
+                            task.data.gid,
+                            opts
+                        );
+                    } catch (error) {
+                        throw error.response.body;
+                    }
+                    expect(task).to.be.ok();
+                });
+                it("should have `html_notes`", function () {
+                    expect(task.data.html_notes).not.to.equal(null);
+                });
+                it("should have `due_on` with `null` value", function () {
+                    expect(task.data.due_on).to.be(null);
+                });
+            });
+        });
+        describe("getTasks", function () {
+            it("should return an array of tasks", async function () {
+                let tasksApiInstance = new Asana.TasksApi();
+                let opts = {
+                    limit: 100,
+                    assignee: USER_GID,
+                    workspace: WORKSPACE_GID,
+                };
+                try {
+                    tasks = await tasksApiInstance.getTasks(opts);
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(tasks).to.be.ok();
+                expect(tasks.data).to.be.an("array");
+            });
+        });
+        describe("getTasks with `opt_fields`", function () {
+            describe("ask for `workspace` and `due_on` properties in `opt_fields`", function () {
+                it("should return an array of tasks", async function () {
+                    let tasksApiInstance = new Asana.TasksApi();
+                    let opts = {
+                        assignee: USER_GID,
+                        workspace: WORKSPACE_GID,
+                        opt_fields: "workspace,due_on",
+                    };
+
+                    try {
+                        tasks = await tasksApiInstance.getTasks(opts);
+                    } catch (error) {
+                        throw error.response.body;
+                    }
+                    expect(tasks).to.be.ok();
+                    expect(tasks.data).to.be.an("array");
+                });
+                it("should have `workspace`", function () {
+                    expect(tasks.data[0].workspace).not.to.equal(null);
+                });
+                it("should have `due_on`", function () {
+                    expect("due_on" in tasks.data[0]).to.be(true);
+                });
+            });
+        });
+        describe("getTasks limit 1", function () {
+            it("should return an array with 1 task", async function () {
+                let tasksApiInstance = new Asana.TasksApi();
+                let opts = {
+                    limit: 1,
+                    assignee: USER_GID,
+                    workspace: WORKSPACE_GID,
+                };
+
+                try {
+                    tasks = await tasksApiInstance.getTasks(opts);
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(tasks.data.length).to.be(1);
+                expect(tasks.data).to.be.an("array");
+            });
+        });
+        describe("searchTasksForWorkspace", function () {
+            it("should return an array of tasks", async function () {
+                let opts = {
+                    text: "Task",
+                    completed: false,
+                };
+
+                try {
+                    tasks = await tasksApiInstance.searchTasksForWorkspace(
+                        WORKSPACE_GID,
+                        opts
+                    );
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(tasks).to.be.ok();
+                expect(tasks.data).to.be.an("array");
+            });
+        });
+        describe("searchTasksForWorkspace with custom field parameter - MATCH", function () {
+            it("should return an array with one task that has matching custom field value from search query", async function () {
+                let opts = {
+                    limit: 1,
+                    [`custom_fields.${TEXT_CUSTOM_FIELD_GID}.value`]:
+                        "custom_value",
+                };
+
+                try {
+                    tasks = await tasksApiInstance.searchTasksForWorkspace(
+                        WORKSPACE_GID,
+                        opts
+                    );
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(tasks).to.be.ok();
+                expect(tasks.data.length).to.be(1);
+            });
+        });
+        describe("searchTasksForWorkspace with custom field parameter - NO MATCH", function () {
+            it("should return an empty array", async function () {
+                let opts = {
+                    [`custom_fields.${TEXT_CUSTOM_FIELD_GID}.value`]:
+                        "inimw8I23M4FRTPfApu1",
+                };
+
+                try {
+                    tasks = await tasksApiInstance.searchTasksForWorkspace(
+                        WORKSPACE_GID,
+                        opts
+                    );
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(tasks.data).to.be.empty();
+            });
+        });
+        describe("deleteTask", function () {
+            it("should be deleted", async function () {
+                let response;
+                try {
+                    // NOTE: In the above tasks we are setting the global task variable in different tests. Make sure
+                    // that future tests don't overwrite the original task created with another task otherwise
+                    // that original task won't be deleted
+                    response = await tasksApiInstance.deleteTask(task.data.gid);
+                } catch (error) {
+                    throw error.response.body;
+                }
+                expect(response).to.be.ok();
+                expect(response.data).to.be.empty();
+            });
+        });
+    });
+});

package/codegen/swagger/src/main/java/com/asana/codegen/JavascriptClientCodegenGenerator.java

@@ -96,7 +96,7 @@ public class JavascriptClientCodegenGenerator extends JavaScriptClientCodegen {
         // Update example for requests that require body
         if (!languageSpecificPrimitives.contains(type)) {
             // type is a model class, e.g. User
-            p.example = "{\"data\": {\"param1\": \"value1\", \"param2\": \"value2\",}}";
+            p.example = "{\"data\": {\"<PARAM_1>\": \"<VALUE_1>\", \"<PARAM_2>\": \"<VALUE_2>\",}}";
             p.dataType = "Object";
         }
     }

package/codegen/templates/ApiClient.mustache

@@ -1,6 +1,5 @@
 {{>licenseInfo}}
 import superagent from "superagent";
-import querystring from "querystring";
 
 {{#emitJSDoc}}/**
 * @module {{#invokerPackage}}{{invokerPackage}}/{{/invokerPackage}}ApiClient
@@ -420,14 +419,23 @@ export class ApiClient {
         request.query(this.normalizeParams(queryParams));
 
         // set header parameters
-        headerParams['X-Asana-Client-Lib'] = querystring.stringify(
-            {
-                'version': "{{projectVersion}}",
-                'language': 'NodeJS',
-                'language_version': process.version,
-                'os': process.platform
-            }
-        );
+        if (typeof(navigator) === 'undefined' || typeof(window) === 'undefined') {
+            headerParams['X-Asana-Client-Lib'] = new URLSearchParams(
+                {
+                    'version': "{{projectVersion}}",
+                    'language': 'NodeJS',
+                    'language_version': process.version,
+                    'os': process.platform
+                }
+            ).toString();
+        } else {
+            headerParams['X-Asana-Client-Lib'] = new URLSearchParams(
+                {
+                    'version': "{{projectVersion}}",
+                    'language': 'BrowserJS'
+                }
+            ).toString();
+        }
         request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
 
         // set requestAgent if it is set by user
@@ -449,7 +457,7 @@ export class ApiClient {
         }
 
         if (contentType === 'application/x-www-form-urlencoded') {
-            request.send(querystring.stringify(this.normalizeParams(formParams)));
+            request.send(new URLSearchParams(this.normalizeParams(formParams)).toString());
         } else if (contentType == 'multipart/form-data') {
             var _formParams = this.normalizeParams(formParams);
             for (var key in _formParams) {

package/codegen/templates/README.mustache

@@ -1,16 +1,5 @@
 # {{projectName}} [![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: {{appVersion}}
 - Package version: {{projectVersion}}
 {{^hideGenerationTimestamp}}
@@ -516,29 +505,34 @@ let opts = {
 };
 const timeouts = 5000
 
+// Used to fetch for initial sync token
 const setSyncToken = async () => {
     await eventsApiInstance.getEvents(resource, opts).then((result) => {
-        console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
+        console.log(JSON.stringify(result.data, null, 2));
     }, (error) => {
         let syncToken = error.response.body.sync;
         opts['sync'] = syncToken;
-        console.log(syncToken);
     });
 }
 
 const getEvents = async () => {
-    console.log("Setting Sync Token");
+    console.log("Setting sync token");
     await setSyncToken();
-    // Fetch for new events every 5 seconds -> NOTE: the sync token has expired or reached 100 events you will need to implement logic to get the next set of events
-    console.log(`Fetching events every ${timeouts/1000} second(s) since sync ${opts['sync']}:`);
+    // Fetch for new events every 5 seconds
+    console.log(`Fetching events every ${timeouts/1000} second(s)`);
     while(true) {
         await eventsApiInstance.getEvents(resource, opts).then((result) => {
-            console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
+            // Print response
+            console.log(`Fetching events since sync: ${opts['sync']}`);
+            console.log(JSON.stringify(result.data, null, 2));
+
+            // Update the sync token with the new sync token provided in the response
+            opts['sync'] = result._response.sync;
         }, (error) => {
             if (error.status === 412) {
                 let syncToken = error.response.body.sync;
                 opts['sync'] = syncToken;
-                console.log(syncToken);
+                console.log(`412 error new sync token: ${syncToken}`);
             } else{
                 console.error(error.response.text);
             }