Added orgHelper and url safe version of org's name

orgHelper provides a nicer abstraction on top of organizations.

We also added a url safe version of the org name for path checking.

Author: andrew-propelauth

package-lock.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "https://github.com/PropelAuth/javascript"
   },
-  "version": "1.2.1",
+  "version": "1.2.2",
   "keywords": [
     "auth",
     "user",
@@ -29,7 +29,8 @@
     "prettier-plugin-organize-imports": "^2.3.3",
     "rollup": "^2.46.0",
     "rollup-plugin-terser": "^7.0.2",
-    "typescript": "^4.2.4"
+    "typescript": "^4.2.4",
+    "uuid": "^8.3.2"
   },
   "browserslist": [
     "> 0.2%",

package.json

@@ -0,0 +1,107 @@
+/**
+ * @jest-environment jsdom
+ */
+import { v4 as uuidv4 } from "uuid"
+import { getOrgHelper, ORG_SELECTION_LOCAL_STORAGE_KEY } from "./OrgHelper"
+
+beforeEach(() => {
+    const localStorageMock = (function () {
+        let store = {}
+        return {
+            getItem: function (key) {
+                return store[key]
+            },
+            setItem: function (key, value) {
+                store[key] = value.toString()
+            },
+            clear: function () {
+                store = {}
+            },
+            removeItem: function (key) {
+                delete store[key]
+            },
+        }
+    })()
+    Object.defineProperty(window, "localStorage", { value: localStorageMock })
+})
+
+afterEach(() => {
+    localStorage.clear()
+})
+
+it("getter methods work", async () => {
+    const orgs = createOrgs(10)
+    const orgIdToOrgMemberInfo = createOrgIdToOrgMemberInfo(orgs)
+    const orgHelper = getOrgHelper(orgIdToOrgMemberInfo)
+
+    // Positive cases
+    for (let org of orgs) {
+        expect(orgHelper.getOrg(org.orgId)).toStrictEqual(org)
+        expect(orgHelper.getOrgByName(org.orgName)).toStrictEqual(org)
+        expect(orgHelper.getOrgByName(org.urlSafeOrgName)).toStrictEqual(org)
+    }
+    expect(orgHelper.getOrgs().sort()).toEqual(orgs.sort())
+    expect(orgHelper.getOrgIds().sort()).toEqual(orgs.map((org) => org.orgId).sort())
+
+    // Negative cases
+    const inheritedProperties = getAllProperties({})
+    for (let notOrg of inheritedProperties) {
+        expect(orgHelper.getOrg(notOrg)).toBeFalsy()
+        expect(orgHelper.getOrgByName(notOrg)).toBeFalsy()
+    }
+    for (let i = 0; i < 100; i++) {
+        expect(orgHelper.getOrg(uuidv4())).toBeFalsy()
+        expect(orgHelper.getOrgByName(uuidv4())).toBeFalsy()
+    }
+})
+
+function createOrgIdToOrgMemberInfo(orgs) {
+    let orgIdToOrgMemberInfo = {}
+    for (let org of orgs) {
+        orgIdToOrgMemberInfo[org.orgId] = org
+    }
+    return orgIdToOrgMemberInfo
+}
+
+function createOrgs(numOrgs) {
+    let orgs = []
+    for (let i = 0; i < numOrgs; i++) {
+        orgs.push(createOrg())
+    }
+    return orgs
+}
+
+function createOrg() {
+    const orgName = randomString()
+    const urlSafeOrgName = orgName.toLowerCase()
+    return {
+        orgId: uuidv4(),
+        orgName,
+        urlSafeOrgName,
+        userRole: choose(["Owner", "Admin", "Member"]),
+    }
+}
+
+function randomString() {
+    return (Math.random() + 1).toString(36).substring(3)
+}
+
+function choose(choices) {
+    const index = Math.floor(Math.random() * choices.length)
+    return choices[index]
+}
+
+// https://stackoverflow.com/questions/8024149/is-it-possible-to-get-the-non-enumerable-inherited-property-names-of-an-object
+function getAllProperties(obj) {
+    let allProps = [],
+        curr = obj
+    do {
+        const props = Object.getOwnPropertyNames(curr)
+        props.forEach(function (prop) {
+            if (allProps.indexOf(prop) === -1) {
+                allProps.push(prop)
+            }
+        })
+    } while ((curr = Object.getPrototypeOf(curr)))
+    return allProps
+}

src/OrgHelper.test.js

@@ -0,0 +1,36 @@
+import {OrgIdToOrgMemberInfo, OrgMemberInfo} from "./org";
+
+export type OrgHelper = {
+    getOrgs: () => OrgMemberInfo[]
+    getOrgIds: () => string[]
+    getOrg: (orgId: string) => OrgMemberInfo | undefined
+    getOrgByName: (orgName: string) => OrgMemberInfo | undefined
+}
+
+export function getOrgHelper(
+    orgIdToOrgMemberInfo: OrgIdToOrgMemberInfo,
+): OrgHelper {
+    return {
+        getOrg(orgId: string): OrgMemberInfo | undefined {
+            if (orgIdToOrgMemberInfo.hasOwnProperty(orgId)) {
+                return orgIdToOrgMemberInfo[orgId]
+            } else {
+                return undefined
+            }
+        },
+        getOrgIds(): string[] {
+            return Object.keys(orgIdToOrgMemberInfo)
+        },
+        getOrgs(): OrgMemberInfo[] {
+            return Object.values(orgIdToOrgMemberInfo)
+        },
+        getOrgByName(orgName: string): OrgMemberInfo | undefined {
+            for (const orgMemberInfo of Object.values(orgIdToOrgMemberInfo)) {
+                if (orgMemberInfo.orgName === orgName || orgMemberInfo.urlSafeOrgName === orgName) {
+                    return orgMemberInfo
+                }
+            }
+            return undefined
+        },
+    }
+}

src/OrgHelper.ts

@@ -1,4 +1,5 @@
 import { OrgIdToOrgMemberInfo, UserRole } from "./org"
+import {getOrgHelper, OrgHelper} from "./OrgHelper";
 
 export type User = {
     userId: string
@@ -19,6 +20,12 @@ export type User = {
 export type AuthenticationInfo = {
     accessToken: string
     expiresAtSeconds: number
+    orgHelper: OrgHelper,
+
+    /**
+     * You should prefer orgHelper to orgIdToOrgMemberInfo.
+     * orgHelper provides useful abstractions over this mapping
+     */
     orgIdToOrgMemberInfo?: OrgIdToOrgMemberInfo
     user: User
 }
@@ -121,6 +128,8 @@ export function parseJsonConvertingSnakeToCamel(str: string): AuthenticationInfo
             this.orgId = value
         } else if (key === "org_name") {
             this.orgName = value
+        } else if (key === "url_safe_org_name") {
+            this.urlSafeOrgName = value
         } else if (key === "user_role") {
             this.userRole = toUserRole(value)
         } else if (key === "access_token") {
@@ -129,6 +138,7 @@ export function parseJsonConvertingSnakeToCamel(str: string): AuthenticationInfo
             this.expiresAtSeconds = value
         } else if (key === "org_id_to_org_member_info") {
             this.orgIdToOrgMemberInfo = value
+            this.orgHelper = getOrgHelper(value)
         } else if (key === "user_id") {
             this.userId = value
         } else if (key === "email_confirmed") {

src/api.ts

@@ -113,33 +113,39 @@ test("client parses org information correctly", async () => {
         "922c5c21-be96-484f-9383-ee532dd79d02": {
             org_id: "922c5c21-be96-484f-9383-ee532dd79d02",
             org_name: "ninetwotwo",
+            url_safe_org_name: "ninetwotwo",
             user_role: "Owner",
         },
         "fcdb21f0-b1b6-426f-b83c-6cf4b903d737": {
             org_id: "fcdb21f0-b1b6-426f-b83c-6cf4b903d737",
             org_name: "effcdee",
+            url_safe_org_name: "effcdee",
             user_role: "Admin",
         },
         "da5903d3-5696-4e4b-920b-bc429b2f75ab": {
             org_id: "da5903d3-5696-4e4b-920b-bc429b2f75ab",
             org_name: "deeafive",
+            url_safe_org_name: "deeafive",
             user_role: "Member",
         },
     }
     const typeScriptOrgIdToOrgMemberInfo: OrgIdToOrgMemberInfo = {
         "922c5c21-be96-484f-9383-ee532dd79d02": {
             orgId: "922c5c21-be96-484f-9383-ee532dd79d02",
             orgName: "ninetwotwo",
+            urlSafeOrgName: "ninetwotwo",
             userRole: UserRole.Owner,
         },
         "fcdb21f0-b1b6-426f-b83c-6cf4b903d737": {
             orgId: "fcdb21f0-b1b6-426f-b83c-6cf4b903d737",
             orgName: "effcdee",
+            urlSafeOrgName: "effcdee",
             userRole: UserRole.Admin,
         },
         "da5903d3-5696-4e4b-920b-bc429b2f75ab": {
             orgId: "da5903d3-5696-4e4b-920b-bc429b2f75ab",
             orgName: "deeafive",
+            urlSafeOrgName: "deeafive",
             userRole: UserRole.Member,
         }
     }
@@ -149,6 +155,7 @@ test("client parses org information correctly", async () => {
 
     const authenticationInfo = await client.getAuthenticationInfoOrNull()
     expect(authenticationInfo?.orgIdToOrgMemberInfo).toStrictEqual(typeScriptOrgIdToOrgMemberInfo)
+    expect(authenticationInfo?.orgHelper.getOrgs()).toStrictEqual(Object.values(typeScriptOrgIdToOrgMemberInfo))
     expectCorrectEndpointWasHit(mockHttp, "https://www.example.com/api/v1/refresh_token")
 })
 
@@ -449,6 +456,7 @@ interface ApiUser {
 export type ApiOrgMemberInfo = {
     org_id: string
     org_name: string
+    url_safe_org_name: string
     user_role: string
 }
 export type ApiOrgIdToOrgMemberInfo = {

src/index.test.ts

@@ -1,6 +1,7 @@
 export type OrgMemberInfo = {
     orgId: string
     orgName: string
+    urlSafeOrgName: string
     userRole: UserRole
 }
 export type OrgIdToOrgMemberInfo = {