Deploy to production

.eslintrc.json

@@ -16,7 +16,8 @@
     "no-unmodified-loop-condition": ["error"],
     "no-unreachable-loop": ["error"],
     "no-unused-private-class-members": ["error"],
-    "require-atomic-updates": ["error"]
+    "require-atomic-updates": ["error"],
+    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }]
   },
   "parser": "@typescript-eslint/parser",
   "plugins": [

.github/actions/invite-user/action.yml

@@ -0,0 +1,15 @@
+name: Invites User
+description: Invites a user to Shape Docs.
+inputs:
+  name:
+    description: The name of the user.
+    required: true
+  email:
+    description: The e-mail of the user to invite.
+    required: true
+  roles:
+    description: Comma-separated list of roles to assign to the user.
+    required: true  
+runs:
+  using: node20
+  main: dist/index.js

.github/actions/invite-user/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "invite-user",
+  "version": "1.0.0",
+  "description": "Invite a user to Shape Docs",
+  "main": "lib/index.js",
+  "author": "Shape",
+  "scripts": {
+    "build": "tsc && ncc build --minify",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@actions/core": "^1.10.0",
+    "@vercel/ncc": "^0.34.0",
+    "auth0": "^4.1.0",
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.2.2"
+  }
+}

.github/actions/invite-user/src/Action.ts

@@ -0,0 +1,87 @@
+import IStateStore from "./StateStore/IStateStore"
+import ILogger from "./Logger/ILogger"
+import IUserClient from "./UserClient/IUserClient"
+import IPasswordGenerator from "./PasswordGenerator/IPasswordGenerator"
+import IRoleNameParser from "./RoleNameParser/IRoleNameParser"
+
+export interface ActionOptions {
+  readonly name: string
+  readonly email: string
+  readonly roles: string
+}
+
+export interface ActionConfig {
+  readonly stateStore: IStateStore
+  readonly logger: ILogger
+  readonly userClient: IUserClient
+  readonly passwordGenerator: IPasswordGenerator
+  readonly roleNameParser: IRoleNameParser
+}
+
+export default class Action {
+  private readonly stateStore: IStateStore
+  private readonly logger: ILogger
+  private readonly userClient: IUserClient
+  private readonly passwordGenerator: IPasswordGenerator
+  private readonly roleNameParser: IRoleNameParser
+
+  constructor(config: ActionConfig) {
+    this.stateStore = config.stateStore
+    this.logger = config.logger
+    this.userClient = config.userClient
+    this.passwordGenerator = config.passwordGenerator
+    this.roleNameParser = config.roleNameParser
+  }
+
+  async run(options: ActionOptions) {
+    if (!this.stateStore.isPost) {
+      await this.runMain(options)
+      this.stateStore.isPost = true
+    }
+  }
+
+  private async runMain(options: ActionOptions) {
+    if (!options.name || options.name.length == 0) {
+      throw new Error("No name supplied.")
+    }
+    if (!options.email || options.email.length == 0) {
+      throw new Error("No e-mail supplied.")
+    }
+    if (!options.roles || options.roles.length == 0) {
+      throw new Error("No roles supplied.")
+    }
+    const roleNames = this.roleNameParser.parse(options.roles)
+    if (roleNames.length == 0) {
+      throw new Error("No roles supplied.")
+    }
+    const existingUser = await this.userClient.getUser({ email: options.email })
+    let user = existingUser
+    if (!existingUser) {
+      const password = this.passwordGenerator.generatePassword()
+      const newUser = await this.userClient.createUser({
+        name: options.name,
+        email: options.email,
+        password: password
+      })
+      user = newUser
+    }
+    if (!user) {
+      throw new Error("Could not get an existing user or create a new user.")
+    }
+    const roles = await this.userClient.createRoles({ roleNames })
+    if (roles.length == 0) {
+      throw new Error("Received an empty set of roles.")
+    }
+    const roleIDs = roles.map(e => e.id)
+    await this.userClient.assignRolesToUser({
+      userID: user.id,
+      roleIDs: roleIDs
+    })
+    if (!existingUser) {
+      await this.userClient.sendChangePasswordEmail({ email: user.email })
+      this.logger.log(`${options.name} (${user.email}) has been invited.`)
+    } else {
+      this.logger.log(`${options.name} (${user.email}) has been updated.`)
+    }
+  }
+}

.github/actions/invite-user/src/Logger/ILogger.ts

@@ -0,0 +1,4 @@
+export default interface ILogger {
+  log(message: string): void
+  error(message: string): void
+}

.github/actions/invite-user/src/Logger/Logger.ts

@@ -0,0 +1,12 @@
+import * as core from "@actions/core"
+import ILogger from "./ILogger"
+
+export default class Logger implements ILogger {
+  log(message: string) {
+    console.log(message)
+  }
+
+  error(message: string) {
+    core.setFailed(message)
+  }
+}

.github/actions/invite-user/src/PasswordGenerator/IPasswordGenerator.ts

@@ -0,0 +1,3 @@
+export default interface IPasswordGenerator {
+  generatePassword(): string
+}

.github/actions/invite-user/src/PasswordGenerator/PasswordGenerator.ts

@@ -0,0 +1,14 @@
+import IPasswordGenerator from "./IPasswordGenerator"
+
+export default class PasswordGenerator implements IPasswordGenerator {
+  generatePassword(): string {
+    let pass = ""
+    const str = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789@#$"
+    const length = 18
+    for (let i = 1; i <= length; i++) {
+      const char = Math.floor(Math.random() * str.length + 1)
+      pass += str.charAt(char)
+    }
+    return pass
+  }
+}

.github/actions/invite-user/src/RoleNameParser/IRoleNameParser.ts

@@ -0,0 +1,3 @@
+export default interface IRoleNameParser {
+  parse(roleNames: string): string[]
+}