feat: Split console_session auth into `console_session_with_workspace…

…` and `console_session_without_workspace` (#232) Co-authored-by: Seam Bot <seambot@getseam.com>
seamapi · Dec 17, 2024 · 8114d87 · 8114d87
1 parent 61462ed
commit 8114d87
Show file tree

Hide file tree

Showing 73 changed files with 444 additions and 81 deletions.
diff --git a/src/lib/middleware/with-route-spec.ts b/src/lib/middleware/with-route-spec.ts
@@ -32,7 +32,12 @@ export const withRouteSpec = createWithRouteSpec({
       scheme: "bearer",
       bearerFormat: "API Token",
     },
-    console_session: {
+    console_session_with_workspace: {
+      type: "http",
+      scheme: "bearer",
+      bearerFormat: "Console Session Token",
+    },
+    console_session_without_workspace: {
       type: "http",
       scheme: "bearer",
       bearerFormat: "Console Session Token",
@@ -49,7 +54,12 @@ export const withRouteSpec = createWithRouteSpec({
     access_token: withAccessToken({ is_workspace_id_required: true }),
     pat_with_workspace: withAccessToken({ is_workspace_id_required: true }),
     pat_without_workspace: withAccessToken({ is_workspace_id_required: false }),
-    console_session: withSessionAuth({ is_workspace_id_required: true }),
+    console_session_with_workspace: withSessionAuth({
+      is_workspace_id_required: true,
+    }),
+    console_session_without_workspace: withSessionAuth({
+      is_workspace_id_required: false,
+    }),
     api_key: withApiKey,
     client_session: withClientSession,
   },

diff --git a/src/lib/middleware/with-session-auth.ts b/src/lib/middleware/with-session-auth.ts
@@ -24,8 +24,8 @@ export const withSessionAuth =
         AuthenticatedRequest["auth"],
         {
           type: RequiresWorkspaceId extends true
-            ? "user_session"
-            : "user_session_without_workspace"
+            ? "console_session_with_workspace"
+            : "console_session_without_workspace"
         }
       >
     },
@@ -101,20 +101,20 @@ export const withSessionAuth =
       ;(req.auth as Extract<
         AuthenticatedRequest["auth"],
         {
-          type: "user_session"
+          type: "console_session_with_workspace"
         }
       >) = {
-        type: "user_session",
+        type: "console_session_with_workspace",
         user_session_id: user_session.user_session_id,
         workspace_id,
         user_id,
       }
     } else {
       ;(req.auth as Extract<
         AuthenticatedRequest["auth"],
-        { type: "user_session_without_workspace" }
+        { type: "console_session_without_workspace" }
       >) = {
-        type: "user_session_without_workspace",
+        type: "console_session_without_workspace",
         user_session_id: user_session.user_session_id,
         user_id,
       }

diff --git a/src/pages/api/access_codes/create.ts b/src/pages/api/access_codes/create.ts
@@ -19,7 +19,12 @@ export const json_body = z.object({
 })
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["POST"],
   jsonBody: json_body
     .refine((value) => {

diff --git a/src/pages/api/access_codes/create_multiple.ts b/src/pages/api/access_codes/create_multiple.ts
@@ -21,7 +21,12 @@ const json_body = z
   )
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["POST"],
   jsonBody: json_body,
   jsonResponse: z.object({

diff --git a/src/pages/api/access_codes/delete.ts b/src/pages/api/access_codes/delete.ts
@@ -11,7 +11,12 @@ const json_body = z.object({
 })
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["POST", "DELETE"],
   jsonBody: json_body,
   jsonResponse: z.object({

diff --git a/src/pages/api/access_codes/generate_code.ts b/src/pages/api/access_codes/generate_code.ts
@@ -5,7 +5,12 @@ import { z } from "zod"
 import { withRouteSpec } from "lib/middleware/with-route-spec.ts"
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["GET", "POST"],
   commonParams: z.object({
     device_id: z.string(),

diff --git a/src/pages/api/access_codes/get.ts b/src/pages/api/access_codes/get.ts
@@ -41,7 +41,12 @@ export const commonParams = z
   })
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["GET", "POST"],
   commonParams,
   jsonResponse: z.object({

diff --git a/src/pages/api/access_codes/list.ts b/src/pages/api/access_codes/list.ts
@@ -5,7 +5,12 @@ import { access_code } from "lib/zod/index.ts"
 import { withRouteSpec } from "lib/middleware/with-route-spec.ts"
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["GET", "POST"],
   commonParams: z
     .object({

diff --git a/src/pages/api/access_codes/pull_backup_access_code.ts b/src/pages/api/access_codes/pull_backup_access_code.ts
@@ -6,7 +6,12 @@ import { access_code } from "lib/zod/index.ts"
 import { withRouteSpec } from "lib/middleware/with-route-spec.ts"
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["POST"],
   jsonBody: z.object({
     access_code_id: z.string(),

diff --git a/src/pages/api/access_codes/simulate/create_unmanaged_access_code.ts b/src/pages/api/access_codes/simulate/create_unmanaged_access_code.ts
@@ -6,7 +6,12 @@ import { access_code } from "lib/zod/index.ts"
 import { withRouteSpec } from "lib/middleware/with-route-spec.ts"
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["POST"],
   jsonBody: z.object({
     device_id: z.string(),

diff --git a/src/pages/api/access_codes/unmanaged/list.ts b/src/pages/api/access_codes/unmanaged/list.ts
@@ -5,7 +5,12 @@ import { access_code } from "lib/zod/index.ts"
 import { withRouteSpec } from "lib/middleware/with-route-spec.ts"
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["GET", "POST"],
   commonParams: z.object({
     device_id: z.string(),

diff --git a/src/pages/api/access_codes/unmanaged/update.ts b/src/pages/api/access_codes/unmanaged/update.ts
@@ -4,7 +4,12 @@ import { z } from "zod"
 import { withRouteSpec } from "lib/middleware/with-route-spec.ts"
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["POST", "PATCH"],
   commonParams: z.object({
     access_code_id: z.string(),

diff --git a/src/pages/api/access_codes/update.ts b/src/pages/api/access_codes/update.ts
@@ -37,7 +37,12 @@ const json_body = z
   }, "Both starts_at and ends_at must be provided if one is")
 
 export default withRouteSpec({
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   methods: ["POST"],
   jsonBody: json_body,
   jsonResponse: z.object({

diff --git a/src/pages/api/acs/entrances/get.ts b/src/pages/api/acs/entrances/get.ts
@@ -8,7 +8,12 @@ import { cloneWithoutUnderscoreKeys } from "lib/util/clone-without-underscore-ke
 
 export default withRouteSpec({
   methods: ["GET", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   commonParams: z.object({
     acs_entrance_id: z.string(),
   }),

diff --git a/src/pages/api/acs/entrances/grant_access.ts b/src/pages/api/acs/entrances/grant_access.ts
@@ -5,7 +5,12 @@ import { withRouteSpec } from "lib/middleware/index.ts"
 
 export default withRouteSpec({
   methods: ["POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   jsonBody: z.object({
     acs_entrance_id: z.string(),
     acs_user_id: z.string(),

diff --git a/src/pages/api/acs/entrances/list.ts b/src/pages/api/acs/entrances/list.ts
@@ -7,7 +7,12 @@ import { cloneWithoutUnderscoreKeys } from "lib/util/clone-without-underscore-ke
 
 export default withRouteSpec({
   methods: ["GET", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   commonParams: z.object({
     acs_system_id: z.string().optional(),
     acs_credential_id: z.string().optional(),

diff --git a/src/pages/api/acs/systems/get.ts b/src/pages/api/acs/systems/get.ts
@@ -6,7 +6,12 @@ import { acs_system } from "lib/zod/index.ts"
 
 export default withRouteSpec({
   methods: ["GET", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   commonParams: z.object({
     acs_system_id: z.string(),
   }),

diff --git a/src/pages/api/acs/systems/list.ts b/src/pages/api/acs/systems/list.ts
@@ -5,7 +5,12 @@ import { acs_system } from "lib/zod/index.ts"
 
 export default withRouteSpec({
   methods: ["GET", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   commonParams: z.object({
     connected_account_id: z.string().optional(),
   }),

diff --git a/src/pages/api/acs/users/add_to_access_group.ts b/src/pages/api/acs/users/add_to_access_group.ts
@@ -5,7 +5,12 @@ import { withRouteSpec } from "lib/middleware/index.ts"
 
 export default withRouteSpec({
   methods: ["PUT", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   jsonBody: z.object({
     acs_user_id: z.string(),
     acs_access_group_id: z.string(),

diff --git a/src/pages/api/acs/users/create.ts b/src/pages/api/acs/users/create.ts
@@ -6,7 +6,12 @@ import { acs_user } from "lib/zod/index.ts"
 
 export default withRouteSpec({
   methods: ["POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   jsonBody: z
     .object({
       acs_system_id: z.string(),

diff --git a/src/pages/api/acs/users/delete.ts b/src/pages/api/acs/users/delete.ts
@@ -5,7 +5,12 @@ import { withRouteSpec } from "lib/middleware/index.ts"
 
 export default withRouteSpec({
   methods: ["DELETE", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   commonParams: z.object({
     acs_user_id: z.string(),
   }),

diff --git a/src/pages/api/acs/users/get.ts b/src/pages/api/acs/users/get.ts
@@ -6,7 +6,12 @@ import { acs_user } from "lib/zod/index.ts"
 
 export default withRouteSpec({
   methods: ["GET", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   commonParams: z.object({
     acs_user_id: z.string(),
   }),

diff --git a/src/pages/api/acs/users/list.ts b/src/pages/api/acs/users/list.ts
@@ -5,7 +5,12 @@ import { acs_user, phone_number } from "lib/zod/index.ts"
 
 export default withRouteSpec({
   methods: ["GET", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   commonParams: z.object({
     user_identity_id: z.string().optional(),
     user_identity_phone_number: phone_number.optional(),

diff --git a/src/pages/api/acs/users/remove_from_access_group.ts b/src/pages/api/acs/users/remove_from_access_group.ts
@@ -5,7 +5,12 @@ import { withRouteSpec } from "lib/middleware/index.ts"
 
 export default withRouteSpec({
   methods: ["DELETE", "POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   jsonBody: z.object({
     acs_user_id: z.string(),
     acs_access_group_id: z.string(),

diff --git a/src/pages/api/acs/users/suspend.ts b/src/pages/api/acs/users/suspend.ts
@@ -5,7 +5,12 @@ import { withRouteSpec } from "lib/middleware/index.ts"
 
 export default withRouteSpec({
   methods: ["POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   jsonBody: z.object({
     acs_user_id: z.string(),
   }),

diff --git a/src/pages/api/acs/users/unsuspend.ts b/src/pages/api/acs/users/unsuspend.ts
@@ -5,7 +5,12 @@ import { withRouteSpec } from "lib/middleware/index.ts"
 
 export default withRouteSpec({
   methods: ["POST"],
-  auth: ["client_session", "pat_with_workspace", "console_session", "api_key"],
+  auth: [
+    "client_session",
+    "pat_with_workspace",
+    "console_session_with_workspace",
+    "api_key",
+  ],
   jsonBody: z.object({
     acs_user_id: z.string(),
   }),