@aurora-interactive/sensei-productivity 1.0.0

package/package.json

@@ -0,0 +1,122 @@
+{
+  "name": "@aurora-interactive/sensei-productivity",
+  "version": "1.0.0",
+  "author": "Speakeasy",
+  "type": "module",
+  "tshy": {
+    "sourceDialects": [
+      "@aurora-interactive/sensei-productivity/source"
+    ],
+    "exports": {
+      ".": "./src/index.ts",
+      "./package.json": "./package.json",
+      "./types": "./src/types/index.ts",
+      "./models/errors": "./src/models/errors/index.ts",
+      "./models": "./src/models/index.ts",
+      "./models/operations": "./src/models/operations/index.ts",
+      "./*.js": "./src/*.ts",
+      "./*": "./src/*.ts"
+    }
+  },
+  "sideEffects": false,
+  "scripts": {
+    "lint": "eslint --cache --max-warnings=0 src",
+    "build": "tshy",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {},
+  "devDependencies": {
+    "@eslint/js": "^9.26.0",
+    "eslint": "^9.26.0",
+    "globals": "^15.14.0",
+    "tshy": "^2.0.0",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.26.0"
+  },
+  "dependencies": {
+    "zod": "^3.25.65 || ^4.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "@aurora-interactive/sensei-productivity/source": "./src/index.ts",
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json",
+    "./types": {
+      "import": {
+        "@aurora-interactive/sensei-productivity/source": "./src/types/index.ts",
+        "types": "./dist/esm/types/index.d.ts",
+        "default": "./dist/esm/types/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/types/index.d.ts",
+        "default": "./dist/commonjs/types/index.js"
+      }
+    },
+    "./models/errors": {
+      "import": {
+        "@aurora-interactive/sensei-productivity/source": "./src/models/errors/index.ts",
+        "types": "./dist/esm/models/errors/index.d.ts",
+        "default": "./dist/esm/models/errors/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/models/errors/index.d.ts",
+        "default": "./dist/commonjs/models/errors/index.js"
+      }
+    },
+    "./models": {
+      "import": {
+        "@aurora-interactive/sensei-productivity/source": "./src/models/index.ts",
+        "types": "./dist/esm/models/index.d.ts",
+        "default": "./dist/esm/models/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/models/index.d.ts",
+        "default": "./dist/commonjs/models/index.js"
+      }
+    },
+    "./models/operations": {
+      "import": {
+        "@aurora-interactive/sensei-productivity/source": "./src/models/operations/index.ts",
+        "types": "./dist/esm/models/operations/index.d.ts",
+        "default": "./dist/esm/models/operations/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/models/operations/index.d.ts",
+        "default": "./dist/commonjs/models/operations/index.js"
+      }
+    },
+    "./*.js": {
+      "import": {
+        "@aurora-interactive/sensei-productivity/source": "./src/*.ts",
+        "types": "./dist/esm/*.d.ts",
+        "default": "./dist/esm/*.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/*.d.ts",
+        "default": "./dist/commonjs/*.js"
+      }
+    },
+    "./*": {
+      "import": {
+        "@aurora-interactive/sensei-productivity/source": "./src/*.ts",
+        "types": "./dist/esm/*.d.ts",
+        "default": "./dist/esm/*.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/*.d.ts",
+        "default": "./dist/commonjs/*.js"
+      }
+    }
+  },
+  "main": "./dist/commonjs/index.js",
+  "types": "./dist/commonjs/index.d.ts",
+  "module": "./dist/esm/index.js"
+}

package/rest-api/cypress/e2e/category-endpoints.cy.ts

@@ -0,0 +1,192 @@
+describe('Category Endpoints Unit Tests', () => {
+    afterEach(() => {
+        cy.task('reseedCategoriesTable');
+    });
+
+    // list all categories
+    it('Listing all categories should fail due to invalid access token', () => {
+        cy.request({
+            url: "categories",
+            failOnStatusCode: false,
+            headers: {
+                "Authorization": "Bearer invalidBearer"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(401, "Listing all categories should have failed with HTTP 401; got different code instead!");
+        })
+    });
+
+    it('Listing all categories should succeed', () => {
+        cy.request({
+            url: "categories",
+            headers: {
+                "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(200, "Listing all categories should have succeeded; got non-success code instead!");
+            expect(response.body).to.be.an("array");
+        })
+    });
+
+    // create a category
+    it('Creating a category should fail due to invalid access token', () => {
+        cy.request({
+            url: "categories",
+            method: "post",
+            failOnStatusCode: false,
+            headers: {
+                "Authorization": "Bearer invalidBearer"
+            },
+            body: {
+                categoryName: "example category"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(401, "Creating a category should have failed with HTTP 401; got different code instead!");
+        })
+    });
+
+    it('Creating a category should fail due to invalid data input', () => {
+        cy.request({
+            url: "categories",
+            method: "post",
+            failOnStatusCode: false,
+            headers: {
+                "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+            },
+            body: {}
+        }).then(response => {
+            expect(response.status).to.equal(400, "Creating a category should have failed with HTTP 400; got different code instead!");
+        })
+    });
+
+    it('Creating a category should succeed', () => {
+        cy.request({
+            url: "categories",
+            method: "post",
+            headers: {
+                "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+            },
+            body: {
+                categoryName: "example category",
+                categoryWeight: 256,
+                categoryDescription: "sample description"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(201, "Creating a category should have should have succeeded; got non-success code instead!");
+        })
+    });
+
+    // update a category
+    it('Updating a category should fail due to invalid data input', () => {
+        cy.request({
+            url: "categories/1",
+            method: "patch",
+            failOnStatusCode: false,
+            headers: {
+                "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+            },
+            body: {}
+        }).then(response => {
+            expect(response.status).to.equal(400, "Updating a category should have failed with HTTP 400; got different code instead!");
+        })
+    });
+
+    it('Updating a category should fail due to invalid bearer token', () => {
+        cy.request({
+            url: "categories/1",
+            method: "patch",
+            failOnStatusCode: false,
+            headers: {
+                "Authorization": "Bearer invalidBearer"
+            },
+            body: {
+                categoryName: "example category",
+                categoryWeight: 256,
+                categoryDescription: "sample description"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(401, "Updating a category should have failed with HTTP 401; got different code instead!");
+        })
+    });
+
+    it('Updating a category should fail due to invalid category ID', () => {
+        cy.request({
+            url: "categories/99",
+            method: "patch",
+            failOnStatusCode: false,
+            headers: {
+                "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+            },
+            body: {
+                categoryName: "example category",
+                categoryWeight: 256,
+                categoryDescription: "sample description"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(404, "Updating a category should have failed with HTTP 404; got different code instead!");
+        })
+    });
+
+    it('Updating a category should succeed', () => {
+        cy.request({
+            url: "categories/1",
+            method: "patch",
+            headers: {
+                "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+            },
+            body: {
+                categoryName: "example category",
+                categoryWeight: 256,
+                categoryDescription: "sample description"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(200, "Updating a category should have failed with HTTP 404; got different code instead!");
+            expect(response.body).to.be.an("object");
+            expect(response.body).to.deep.include({
+                categoryId: 1,
+                categoryName: 'example category',
+                categoryWeight: 256,
+                categoryDescription: 'sample description',
+            });
+        })
+    });
+
+    // delete a category
+    it('Deleting a category should fail due to invalid category ID', () => {
+        cy.request({
+            url: "categories/99",
+            method: "delete",
+            failOnStatusCode: false,
+            headers: {
+                "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(404, "Deleting a category should have failed with HTTP 404; got different code instead!");
+        })
+    });
+
+    it('Deleting a category should fail due to invalid bearer token', () => {
+        cy.request({
+            url: "categories/99",
+            method: "delete",
+            failOnStatusCode: false,
+            headers: {
+                "Authorization": "Bearer invalidBearer"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(401, "Deleting a category should have failed with HTTP 401; got different code instead!");
+        })
+    });
+
+    it('Deleting a category should succeed', () => {
+        cy.request({
+            url: "categories/1",
+            method: "delete",
+            headers: {
+                "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+            }
+        }).then(response => {
+            expect(response.status).to.equal(200, "Deleting a category should succeed; got non-success code instead!");
+        })
+    });
+});

package/rest-api/cypress/e2e/school-endpoints.cy.ts

@@ -0,0 +1,32 @@
+describe('School Endpoints Unit Tests', () => {
+    // get entire schools list
+    it('Getting all schools with user counts succeeds', () => {
+        cy.request("schools").then(response => {
+            expect(response.status).to.equal(200, "Getting list of all schools with user counts should have succeeded; got non-success code instead!");
+            expect(response.body).to.be.an("array");
+        })
+    });
+
+    // get school by school ID
+    it('Getting school by ID fails with invalid school ID', () => {
+        cy.request({
+            url: "schools/99",
+            failOnStatusCode: false
+        }).then(response => {
+            expect(response.status).to.equal(404, "Getting school by ID should have failed with HTTP 404; got different code instead!");
+        })
+    });
+
+    it('Getting school by ID succeeds', () => {
+        cy.request("schools/1").then(response => {
+            expect(response.status).to.equal(200, "Getting school by ID should have succeeded; got non-success code instead!");
+            expect(response.body).to.be.an("object");
+            expect(response.body).to.deep.include({
+                schoolId: 1,
+                schoolName: 'Case Western Reserve University',
+                schoolNameShorthand: 'CWRU',
+                userCount: 1,
+            });
+        })
+    });
+});

package/rest-api/cypress/e2e/user-endpoints.cy.ts

@@ -0,0 +1,287 @@
+describe('User Endpoints Unit Tests', () => {
+  afterEach(() => {
+    cy.task('reseedUsersTable');
+  });
+
+  // Login
+  it('Login fails with non-existent credentials', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "POST",
+      body: {},
+      url: "login"
+    }).then(response => {
+      expect(response.status).to.equal(400, "Login should have failed with HTTP 400; different code was found instead!");
+    });
+  })
+
+  it('Login fails with valid username but wrong password', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "POST",
+      body: {
+        username: "UnitTester",
+        password: "invalidPassword123"
+      },
+      url: "login"
+    }).then(response => {
+      expect(response.status).to.equal(400, "Login should have failed with HTTP 400; different code was found instead!");
+    });
+  })
+
+  it('Login fails with invalid credentials', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "POST",
+      body: {
+        username: "invalidValue123",
+        password: "invalidValue123"
+      },
+      url: "login"
+    }).then(response => {
+      expect(response.status).to.equal(400, "Login should have failed with HTTP 400; different code was found instead!");
+    });
+  })
+
+  it('Login succeeds with test user credentials', () => {
+    cy.request("POST", "login", { username: "UnitTester", password: "unitTester" }).then(response => {
+      expect(response.status).to.equal(200, "Login should have succeeded; failed on login status return code check!");
+      expect(response.body).to.haveOwnProperty(
+        "accessToken",
+        "9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252",
+        "Expected login to have succeeded; failed on access token value check!"
+      );
+    });
+  })
+
+  // Signup
+  it('Signup fails due to empty data input', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "POST",
+      body: {},
+      url: "signup"
+    }).then(response => {
+      expect(response.status).to.equal(400, "Signup should have failed with HTTP 400; different code was found instead!");
+    });
+  })
+
+  it('Signup fails due to insufficient data input', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "POST",
+      body: {
+        "email": "test123",
+        "password": "test123"
+      },
+      url: "signup"
+    }).then(response => {
+      expect(response.status).to.equal(400, "Signup should have failed with HTTP 400; different code was found instead!");
+    });
+  })
+
+  it('Signup fails due to invalid school input', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "POST",
+      body: {
+        "firstName": "Unit",
+        "lastName": "Test Jr.",
+        "email": "test123@example.com",
+        "school": "InvalidSchool",
+        "username": "test123",
+        "password": "pass123",
+      },
+      url: "signup"
+    }).then(response => {
+      expect(response.status).to.equal(400, "Signup should have failed with HTTP 400; different code was found instead!");
+    });
+  })
+
+  it('Signup succeeds after supplying all necessary data', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "POST",
+      body: {
+        "firstName": "Unit",
+        "lastName": "Test Jr.",
+        "email": "test123@example.com",
+        "school": "Case Western Reserve University",
+        "username": "test123",
+        "password": "pass123",
+      },
+      url: "signup"
+    }).then(response => {
+      expect(response.status).to.equal(200, "Signup should have failed with HTTP 400; different code was found instead!");
+      expect(response.body.accessToken.length).to.equal(128, "Access Token should always be 128 characters long; different size was found instead!");
+    });
+  })
+
+  // get user profile (private)
+  it('Getting private user profile fails due to invalid bearer token', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "get",
+      headers: {
+        "Authorization": "Bearer invalidBearer"
+      },
+      url: "users/me"
+    }).then(response => {
+      expect(response.status).to.equal(401, "Getting user profile should have failed with HTTP 401; different code was found instead!");
+    });
+  })
+
+  it('Getting private user profile succeeds with valid bearer token', () => {
+    cy.request({
+      failOnStatusCode: false,
+      method: "get",
+      headers: {
+        // keep in mind this isn't a sensitive secret; just the test user with no perms :)
+        "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+      },
+      url: "users/me"
+    }).then(response => {
+      expect(response.status).to.equal(200, "Getting user profile should have succeeded; non-success code was found instead!");
+      expect(response.body).to.be.an("object");
+      expect(response.body).to.deep.include({
+        userId: 2,
+        firstName: 'Unit',
+        lastName: 'Test',
+        username: 'UnitTester',
+        email: 'unitTester@example.com',
+        schoolId: 1,
+        schoolName: 'Case Western Reserve University',
+      });
+    });
+  })
+
+  // get user profile (public)
+  it('Getting public user profile fails with invalid user ID', () => {
+    cy.request({
+      url: "users/99",
+      method: "get",
+      failOnStatusCode: false
+    }).then(response => {
+      expect(response.status).to.equal(404, "Getting user profile should have failed with HTTP 404; different code was found instead!");
+    });
+  })
+
+  it('Getting public user profile succeeds with valid user ID', () => {
+    cy.request("users/2").then(response => {
+      expect(response.status).to.equal(200, "Getting user profile should have succeeded; non-success code was found instead!");
+      expect(response.body).to.be.an("object");
+      expect(response.body).to.deep.include({
+        userId: 2,
+        firstName: 'Unit',
+        lastName: 'Test',
+        username: 'UnitTester',
+        email: 'unitTester@example.com',
+        schoolId: 1,
+        schoolName: 'Case Western Reserve University',
+      });
+    });
+  })
+
+  // update user's [own] profile
+  it('Updating user\'s profile should fail due to invalid bearer token', () => {
+    cy.request({
+      method: "patch",
+      url: "users/2",
+      headers: {
+        "Authorization": "Bearer invalidBearer"
+      },
+      body: {"username": "Updated"},
+      failOnStatusCode: false
+    }).then(response => {
+      expect(response.status).to.equal(401, "Updating own user profile should have failed with HTTP 401; different code was found instead!");
+    });
+  })
+
+  it('Updating user\'s profile should fail due to invalid user ID', () => {
+    cy.request({
+      method: "patch",
+      url: "users/99",
+      headers: {
+        "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+      },
+      body: {"username": "Updated"},
+      failOnStatusCode: false
+    }).then(response => {
+      expect(response.status).to.equal(404, "Updating own user profile should have failed with HTTP 400; different code was found instead!");
+    });
+  })
+
+  it('Updating user\'s profile should fail due to empty body', () => {
+    cy.request({
+      method: "patch",
+      url: "users/2",
+      headers: {
+        "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+      },
+      body: {},
+      failOnStatusCode: false
+    }).then(response => {
+      expect(response.status).to.equal(400, "Updating own user profile should have failed with HTTP 400; different code was found instead!");
+    });
+  })
+
+  it('Updating user\'s profile should succeed', () => {
+    cy.request({
+      method: "patch",
+      url: "users/2",
+      headers: {
+        "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+      },
+      body: {
+        "username": "Updated",
+        "firstName": "updated",
+        "lastName": "updated"
+      }
+    }).then(response => {
+      expect(response.status).to.equal(200, "Updating own user profile should have succeeded; non-success code was found instead!");
+      expect(response.body).to.be.an("object");
+    });
+  })
+
+  // soft delete [own] user account
+  it('Deleting user\'s profile should fail due to invalid bearer token', () => {
+    cy.request({
+      method: "delete",
+      url: "users/2",
+      headers: {
+        "Authorization": "Bearer invalidToken"
+      },
+      body: {},
+      failOnStatusCode: false
+    }).then(response => {
+      expect(response.status).to.equal(401, "Deleting own user profile should have failed with HTTP 401; different was found instead!");
+    });
+  })
+
+  it('Deleting user\'s profile should fail due to invalid userId', () => {
+    cy.request({
+      method: "delete",
+      url: "users/99",
+      headers: {
+        "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+      },
+      body: {},
+      failOnStatusCode: false
+    }).then(response => {
+      expect(response.status).to.equal(404, "Deleting own user profile should have failed with HTTP 400; different was found instead!");
+    });
+  })
+
+  it('Deleting user\'s profile should succeed', () => {
+    cy.request({
+      method: "delete",
+      url: "users/2",
+      headers: {
+        "Authorization": "Bearer 9d2272fd048bfeedda522935244fc4450fb61a9da6f7b7cea529c6c11033e9efee6b140b6e4b372f0c81a07a6e040be5150f506922e8a5c47719f7be2c707252"
+      },
+      body: {}
+    }).then(response => {
+      expect(response.status).to.equal(200, "Deleting own user profile should succeeded; non-success code was found instead!");
+    });
+  })
+});

package/rest-api/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

package/rest-api/cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }