feat: add resourceTypeSlug to permissions, environment and organization roles

src/authorization/authorization.spec.ts

@@ -49,6 +49,7 @@ describe('Authorization', () => {
         slug: 'admin',
         name: 'Admin',
         description: 'Full administrative access',
+        resourceTypeSlug: 'organization',
         type: 'EnvironmentRole',
       });
       expect(role.permissions).toEqual(
@@ -60,6 +61,25 @@ describe('Authorization', () => {
       );
     });
 
+    it('creates an environment role with resourceTypeSlug', async () => {
+      fetchOnce(environmentRoleFixture, { status: 201 });
+
+      const role = await workos.authorization.createEnvironmentRole({
+        slug: 'admin',
+        name: 'Admin',
+        description: 'Full administrative access',
+        resourceTypeSlug: 'organization',
+      });
+
+      expect(fetchBody()).toEqual({
+        slug: 'admin',
+        name: 'Admin',
+        description: 'Full administrative access',
+        resource_type_slug: 'organization',
+      });
+      expect(role.resourceTypeSlug).toEqual('organization');
+    });
+
     it('creates an environment role without description', async () => {
       fetchOnce(
         { ...environmentRoleFixture, description: null },
@@ -96,13 +116,15 @@ describe('Authorization', () => {
             id: 'role_01HXYZ123ABC456DEF789GHI',
             slug: 'admin',
             name: 'Admin',
+            resourceTypeSlug: 'organization',
             type: 'EnvironmentRole',
           }),
           expect.objectContaining({
             object: 'role',
             id: 'role_01HXYZ123ABC456DEF789GHJ',
             slug: 'member',
             name: 'Member',
+            resourceTypeSlug: 'organization',
             type: 'EnvironmentRole',
           }),
         ]),
@@ -123,6 +145,7 @@ describe('Authorization', () => {
         slug: 'admin',
         name: 'Admin',
         description: 'Full administrative access',
+        resourceTypeSlug: 'organization',
         type: 'EnvironmentRole',
       });
     });
@@ -264,6 +287,7 @@ describe('Authorization', () => {
         id: 'role_01HXYZ123ABC456DEF789ORG',
         slug: 'org-admin',
         name: 'Org Admin',
+        resourceTypeSlug: 'organization',
         type: 'OrganizationRole',
       });
     });
@@ -285,14 +309,17 @@ describe('Authorization', () => {
         expect.arrayContaining([
           expect.objectContaining({
             slug: 'admin',
+            resourceTypeSlug: 'organization',
             type: 'EnvironmentRole',
           }),
           expect.objectContaining({
             slug: 'org-admin',
+            resourceTypeSlug: 'organization',
             type: 'OrganizationRole',
           }),
           expect.objectContaining({
             slug: 'org-member',
+            resourceTypeSlug: 'organization',
             type: 'OrganizationRole',
           }),
         ]),
@@ -315,6 +342,7 @@ describe('Authorization', () => {
       expect(role).toMatchObject({
         object: 'role',
         slug: 'org-admin',
+        resourceTypeSlug: 'organization',
         type: 'OrganizationRole',
       });
     });
@@ -454,10 +482,30 @@ describe('Authorization', () => {
         slug: 'users:read',
         name: 'Read Users',
         description: 'Allows reading user data',
+        resourceTypeSlug: 'organization',
         system: false,
       });
     });
 
+    it('creates a permission with resourceTypeSlug', async () => {
+      fetchOnce(permissionFixture, { status: 201 });
+
+      const permission = await workos.authorization.createPermission({
+        slug: 'users:read',
+        name: 'Read Users',
+        description: 'Allows reading user data',
+        resourceTypeSlug: 'organization',
+      });
+
+      expect(fetchBody()).toEqual({
+        slug: 'users:read',
+        name: 'Read Users',
+        description: 'Allows reading user data',
+        resource_type_slug: 'organization',
+      });
+      expect(permission.resourceTypeSlug).toEqual('organization');
+    });
+
     it('creates a permission without description', async () => {
       fetchOnce({ ...permissionFixture, description: null }, { status: 201 });
 
@@ -491,12 +539,14 @@ describe('Authorization', () => {
             id: 'perm_01HXYZ123ABC456DEF789GHI',
             slug: 'users:read',
             name: 'Read Users',
+            resourceTypeSlug: 'organization',
           }),
           expect.objectContaining({
             object: 'permission',
             id: 'perm_01HXYZ123ABC456DEF789GHJ',
             slug: 'users:write',
             name: 'Write Users',
+            resourceTypeSlug: 'organization',
           }),
         ]),
       );
@@ -536,6 +586,7 @@ describe('Authorization', () => {
         slug: 'users:read',
         name: 'Read Users',
         description: 'Allows reading user data',
+        resourceTypeSlug: 'organization',
         system: false,
       });
     });

src/authorization/fixtures/environment-role-member.json

@@ -5,6 +5,7 @@
   "slug": "member",
   "description": null,
   "permissions": ["posts:read"],
+  "resource_type_slug": "organization",
   "type": "EnvironmentRole",
   "created_at": "2024-01-15T10:00:00.000Z",
   "updated_at": "2024-01-15T10:00:00.000Z"

src/authorization/fixtures/environment-role.json

@@ -5,6 +5,7 @@
   "slug": "admin",
   "description": "Full administrative access",
   "permissions": ["users:read", "users:write", "settings:manage"],
+  "resource_type_slug": "organization",
   "type": "EnvironmentRole",
   "created_at": "2024-01-15T09:30:00.000Z",
   "updated_at": "2024-01-15T09:30:00.000Z"

src/authorization/fixtures/list-environment-roles.json

@@ -8,6 +8,7 @@
       "slug": "admin",
       "description": "Full administrative access",
       "permissions": ["users:read", "users:write", "settings:manage"],
+      "resource_type_slug": "organization",
       "type": "EnvironmentRole",
       "created_at": "2024-01-15T09:30:00.000Z",
       "updated_at": "2024-01-15T09:30:00.000Z"
@@ -19,6 +20,7 @@
       "slug": "member",
       "description": null,
       "permissions": ["posts:read"],
+      "resource_type_slug": "organization",
       "type": "EnvironmentRole",
       "created_at": "2024-01-15T10:00:00.000Z",
       "updated_at": "2024-01-15T10:00:00.000Z"

src/authorization/fixtures/list-organization-roles.json

@@ -8,6 +8,7 @@
       "slug": "admin",
       "description": "Environment-level admin role",
       "permissions": ["users:read", "users:write"],
+      "resource_type_slug": "organization",
       "type": "EnvironmentRole",
       "created_at": "2024-01-15T08:00:00.000Z",
       "updated_at": "2024-01-15T08:00:00.000Z"
@@ -19,6 +20,7 @@
       "slug": "org-admin",
       "description": "Organization administrator",
       "permissions": ["org:manage", "members:invite"],
+      "resource_type_slug": "organization",
       "type": "OrganizationRole",
       "created_at": "2024-01-15T09:30:00.000Z",
       "updated_at": "2024-01-15T09:30:00.000Z"
@@ -30,6 +32,7 @@
       "slug": "org-member",
       "description": null,
       "permissions": ["projects:read"],
+      "resource_type_slug": "organization",
       "type": "OrganizationRole",
       "created_at": "2024-01-15T10:00:00.000Z",
       "updated_at": "2024-01-15T10:00:00.000Z"

src/authorization/fixtures/list-permissions.json

@@ -7,6 +7,7 @@
       "slug": "users:read",
       "name": "Read Users",
       "description": "Allows reading user data",
+      "resource_type_slug": "organization",
       "system": false,
       "created_at": "2024-01-15T08:00:00.000Z",
       "updated_at": "2024-01-15T08:00:00.000Z"
@@ -17,6 +18,7 @@
       "slug": "users:write",
       "name": "Write Users",
       "description": null,
+      "resource_type_slug": "organization",
       "system": true,
       "created_at": "2024-01-15T09:00:00.000Z",
       "updated_at": "2024-01-15T09:00:00.000Z"

src/authorization/fixtures/organization-role.json

@@ -5,6 +5,7 @@
   "slug": "org-admin",
   "description": "Organization administrator",
   "permissions": ["org:manage", "members:invite"],
+  "resource_type_slug": "organization",
   "type": "OrganizationRole",
   "created_at": "2024-01-15T09:30:00.000Z",
   "updated_at": "2024-01-15T09:30:00.000Z"

src/authorization/fixtures/permission.json

@@ -4,6 +4,7 @@
   "slug": "users:read",
   "name": "Read Users",
   "description": "Allows reading user data",
+  "resource_type_slug": "organization",
   "system": false,
   "created_at": "2024-01-15T08:00:00.000Z",
   "updated_at": "2024-01-15T08:00:00.000Z"

src/authorization/interfaces/create-environment-role-options.interface.ts

@@ -2,10 +2,12 @@ export interface CreateEnvironmentRoleOptions {
   slug: string;
   name: string;
   description?: string;
+  resourceTypeSlug?: string;
 }
 
 export interface SerializedCreateEnvironmentRoleOptions {
   slug: string;
   name: string;
   description?: string;
+  resource_type_slug?: string;
 }

src/authorization/interfaces/create-permission-options.interface.ts

@@ -2,10 +2,12 @@ export interface CreatePermissionOptions {
   slug: string;
   name: string;
   description?: string;
+  resourceTypeSlug?: string;
 }
 
 export interface SerializedCreatePermissionOptions {
   slug: string;
   name: string;
   description?: string;
+  resource_type_slug?: string;
 }

src/authorization/interfaces/environment-role.interface.ts

@@ -5,6 +5,7 @@ export interface EnvironmentRole {
   slug: string;
   description: string | null;
   permissions: string[];
+  resourceTypeSlug: string;
   type: 'EnvironmentRole';
   createdAt: string;
   updatedAt: string;
@@ -17,6 +18,7 @@ export interface EnvironmentRoleResponse {
   slug: string;
   description: string | null;
   permissions: string[];
+  resource_type_slug: string;
   type: 'EnvironmentRole';
   created_at: string;
   updated_at: string;

src/authorization/interfaces/organization-role.interface.ts

@@ -5,6 +5,7 @@ export interface OrganizationRole {
   slug: string;
   description: string | null;
   permissions: string[];
+  resourceTypeSlug: string;
   type: 'OrganizationRole';
   createdAt: string;
   updatedAt: string;

src/authorization/interfaces/permission.interface.ts

@@ -4,6 +4,7 @@ export interface Permission {
   slug: string;
   name: string;
   description: string | null;
+  resourceTypeSlug: string;
   system: boolean;
   createdAt: string;
   updatedAt: string;
@@ -15,6 +16,7 @@ export interface PermissionResponse {
   slug: string;
   name: string;
   description: string | null;
+  resource_type_slug: string;
   system: boolean;
   created_at: string;
   updated_at: string;

src/authorization/serializers/create-environment-role-options.serializer.ts

@@ -9,4 +9,5 @@ export const serializeCreateEnvironmentRoleOptions = (
   slug: options.slug,
   name: options.name,
   description: options.description,
+  resource_type_slug: options.resourceTypeSlug,
 });

src/authorization/serializers/create-permission-options.serializer.ts

@@ -9,4 +9,5 @@ export const serializeCreatePermissionOptions = (
   slug: options.slug,
   name: options.name,
   description: options.description,
+  resource_type_slug: options.resourceTypeSlug,
 });

src/authorization/serializers/environment-role.serializer.ts

@@ -12,6 +12,7 @@ export const deserializeEnvironmentRole = (
   slug: role.slug,
   description: role.description,
   permissions: role.permissions,
+  resourceTypeSlug: role.resource_type_slug,
   type: role.type,
   createdAt: role.created_at,
   updatedAt: role.updated_at,

src/authorization/serializers/organization-role.serializer.ts

@@ -13,6 +13,7 @@ export const deserializeRole = (role: OrganizationRoleResponse): Role => ({
   slug: role.slug,
   description: role.description,
   permissions: role.permissions,
+  resourceTypeSlug: role.resource_type_slug,
   type: role.type,
   createdAt: role.created_at,
   updatedAt: role.updated_at,
@@ -27,6 +28,7 @@ export const deserializeOrganizationRole = (
   slug: role.slug,
   description: role.description,
   permissions: role.permissions,
+  resourceTypeSlug: role.resource_type_slug,
   type: 'OrganizationRole',
   createdAt: role.created_at,
   updatedAt: role.updated_at,

src/authorization/serializers/permission.serializer.ts

@@ -11,6 +11,7 @@ export const deserializePermission = (
   slug: permission.slug,
   name: permission.name,
   description: permission.description,
+  resourceTypeSlug: permission.resource_type_slug,
   system: permission.system,
   createdAt: permission.created_at,
   updatedAt: permission.updated_at,

src/roles/interfaces/role.interface.ts

@@ -59,6 +59,7 @@ export interface OrganizationRoleResponse {
   slug: string;
   description: string | null;
   permissions: string[];
+  resource_type_slug: string;
   type: 'EnvironmentRole' | 'OrganizationRole';
   created_at: string;
   updated_at: string;