@lightdash/common 0.1937.0 → 0.1937.1

package/dist/esm/authorization/roleToScopeMapping.js

@@ -0,0 +1,157 @@
+import { ProjectMemberRole } from '../types/projectMemberRole';
+/**
+ * Utility functions to convert project member roles to equivalent scope sets
+ * for testing migration compatibility between role-based and scope-based authorization
+ */
+/**
+ * Base scopes for each role level (without inheritance)
+ */
+const BASE_ROLE_SCOPES = {
+    [ProjectMemberRole.VIEWER]: [
+        // Basic viewing permissions
+        'view:Dashboard',
+        'view:SavedChart',
+        'view:Space',
+        'view:Project',
+        'view:PinnedItems',
+        'view:DashboardComments',
+        'view:Tags',
+        'view:Job', // For viewing job status created by user
+        'manage:ExportCsv',
+        // Enterprise scopes (when available)
+        'view:MetricsTree',
+        'view:SpotlightTableConfig',
+        'view:AiAgentThread',
+    ],
+    [ProjectMemberRole.INTERACTIVE_VIEWER]: [
+        // Additional interactive viewer permissions
+        'view:UnderlyingData',
+        'view:SemanticViewer',
+        'manage:Explore',
+        'manage:ChangeCsvResults',
+        'create:ScheduledDeliveries',
+        'create:DashboardComments',
+        'create:Job',
+        // Space-level content management (requires space admin/editor role)
+        'manage:Dashboard', // Via space access
+        'manage:SavedChart', // Via space access
+        'manage:Space', // Via space access (admin role)
+        // Enterprise scopes
+        'view:AiAgent',
+        'create:AiAgentThread',
+    ],
+    [ProjectMemberRole.EDITOR]: [
+        // Editor-specific permissions
+        'create:Space',
+        'manage:Space', // For non-private spaces (requires manage:Project)
+        'manage:Job',
+        'manage:PinnedItems',
+        'manage:ScheduledDeliveries',
+        'manage:DashboardComments',
+        'manage:Tags',
+        // Enterprise scopes
+        'manage:MetricsTree',
+        'manage:AiAgentThread', // User's own threads
+    ],
+    [ProjectMemberRole.DEVELOPER]: [
+        // Developer-specific permissions
+        'manage:VirtualView',
+        'manage:CustomSql',
+        'manage:SqlRunner',
+        'manage:Validation',
+        'manage:CompileProject',
+        'create:Project', // Preview projects
+        'delete:Project', // Preview projects created by user
+        'update:Project',
+        'view:JobStatus', // All jobs in project
+        // Enterprise scopes
+        'manage:SpotlightTableConfig',
+        'manage:ContentAsCode',
+        'manage:AiAgent',
+        'manage:AiAgentThread', // User's own threads
+    ],
+    [ProjectMemberRole.ADMIN]: [
+        // Admin-specific permissions
+        'delete:Project', // Any project
+        'view:Analytics',
+        'manage:Dashboard', // All dashboards
+        'manage:Project', // Required for managing non-private spaces
+        'manage:SavedChart', // All saved charts
+        'view:AiAgentThread', // All threads in project
+        'manage:AiAgentThread', // All threads in project
+    ],
+};
+/**
+ * Role hierarchy for inheritance
+ */
+const ROLE_HIERARCHY = [
+    ProjectMemberRole.VIEWER,
+    ProjectMemberRole.INTERACTIVE_VIEWER,
+    ProjectMemberRole.EDITOR,
+    ProjectMemberRole.DEVELOPER,
+    ProjectMemberRole.ADMIN,
+];
+/**
+ * Maps project member roles to their equivalent scopes based on projectMemberAbility.ts analysis
+ * Each role inherits permissions from the roles below it in the hierarchy
+ */
+export const PROJECT_ROLE_TO_SCOPES_MAP = (() => {
+    const result = {};
+    for (const role of ROLE_HIERARCHY) {
+        const roleIndex = ROLE_HIERARCHY.indexOf(role);
+        const inheritedScopes = new Set();
+        // Add scopes from all lower-level roles
+        for (let i = 0; i <= roleIndex; i += 1) {
+            const currentRole = ROLE_HIERARCHY[i];
+            BASE_ROLE_SCOPES[currentRole].forEach((scope) => inheritedScopes.add(scope));
+        }
+        result[role] = Array.from(inheritedScopes);
+    }
+    return result;
+})();
+/**
+ * Gets the scopes required for a specific project member role
+ */
+export const getScopesForRole = (role) => [
+    ...PROJECT_ROLE_TO_SCOPES_MAP[role],
+];
+/**
+ * Gets only the non-enterprise scopes for a role (filters out enterprise-only features)
+ */
+export const getNonEnterpriseScopesForRole = (role) => {
+    const enterpriseScopes = new Set([
+        'view:MetricsTree',
+        'manage:MetricsTree',
+        'view:SpotlightTableConfig',
+        'manage:SpotlightTableConfig',
+        'view:AiAgent',
+        'view:AiAgentThread',
+        'create:AiAgentThread',
+        'manage:AiAgent',
+        'manage:AiAgentThread',
+        'manage:ContentAsCode',
+        'manage:PersonalAccessToken',
+    ]);
+    return PROJECT_ROLE_TO_SCOPES_MAP[role].filter((scope) => !enterpriseScopes.has(scope));
+};
+/**
+ * Gets the incremental scopes added by a specific role (not inherited from lower roles)
+ */
+export const getIncrementalScopesForRole = (role) => {
+    const roleOrder = [
+        ProjectMemberRole.VIEWER,
+        ProjectMemberRole.INTERACTIVE_VIEWER,
+        ProjectMemberRole.EDITOR,
+        ProjectMemberRole.DEVELOPER,
+        ProjectMemberRole.ADMIN,
+    ];
+    const roleIndex = roleOrder.indexOf(role);
+    if (roleIndex === 0) {
+        return getScopesForRole(role);
+    }
+    const previousRole = roleOrder[roleIndex - 1];
+    const currentScopes = new Set(getScopesForRole(role));
+    const previousScopes = new Set(getScopesForRole(previousRole));
+    return Array.from(currentScopes).filter((scope) => !previousScopes.has(scope));
+};
+//# sourceMappingURL=roleToScopeMapping.js.map

package/dist/esm/authorization/roleToScopeMapping.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roleToScopeMapping.js","sourceRoot":"","sources":["../../../src/authorization/roleToScopeMapping.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAE/D;;;GAGG;AAEH;;GAEG;AACH,MAAM,gBAAgB,GAAG;IACrB,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE;QACxB,4BAA4B;QAC5B,gBAAgB;QAChB,iBAAiB;QACjB,YAAY;QACZ,cAAc;QACd,kBAAkB;QAClB,wBAAwB;QACxB,WAAW;QACX,UAAU,EAAE,yCAAyC;QACrD,kBAAkB;QAElB,qCAAqC;QACrC,kBAAkB;QAClB,2BAA2B;QAC3B,oBAAoB;KACvB;IAED,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,EAAE;QACpC,4CAA4C;QAC5C,qBAAqB;QACrB,qBAAqB;QACrB,gBAAgB;QAChB,yBAAyB;QACzB,4BAA4B;QAC5B,0BAA0B;QAC1B,YAAY;QAEZ,oEAAoE;QACpE,kBAAkB,EAAE,mBAAmB;QACvC,mBAAmB,EAAE,mBAAmB;QACxC,cAAc,EAAE,gCAAgC;QAEhD,oBAAoB;QACpB,cAAc;QACd,sBAAsB;KACzB;IAED,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE;QACxB,8BAA8B;QAC9B,cAAc;QACd,cAAc,EAAE,mDAAmD;QACnE,YAAY;QACZ,oBAAoB;QACpB,4BAA4B;QAC5B,0BAA0B;QAC1B,aAAa;QAEb,oBAAoB;QACpB,oBAAoB;QACpB,sBAAsB,EAAE,qBAAqB;KAChD;IAED,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE;QAC3B,iCAAiC;QACjC,oBAAoB;QACpB,kBAAkB;QAClB,kBAAkB;QAClB,mBAAmB;QACnB,uBAAuB;QACvB,gBAAgB,EAAE,mBAAmB;QACrC,gBAAgB,EAAE,mCAAmC;QACrD,gBAAgB;QAChB,gBAAgB,EAAE,sBAAsB;QAExC,oBAAoB;QACpB,6BAA6B;QAC7B,sBAAsB;QACtB,gBAAgB;QAChB,sBAAsB,EAAE,qBAAqB;KAChD;IAED,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE;QACvB,6BAA6B;QAC7B,gBAAgB,EAAE,cAAc;QAChC,gBAAgB;QAChB,kBAAkB,EAAE,iBAAiB;QACrC,gBAAgB,EAAE,2CAA2C;QAC7D,mBAAmB,EAAE,mBAAmB;QACxC,oBAAoB,EAAE,yBAAyB;QAC/C,sBAAsB,EAAE,yBAAyB;KACpD;CACK,CAAC;AAEX;;GAEG;AACH,MAAM,cAAc,GAAG;IACnB,iBAAiB,CAAC,MAAM;IACxB,iBAAiB,CAAC,kBAAkB;IACpC,iBAAiB,CAAC,MAAM;IACxB,iBAAiB,CAAC,SAAS;IAC3B,iBAAiB,CAAC,KAAK;CACjB,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GACnC,CAAC,GAAG,EAAE;IACF,MAAM,MAAM,GAAG,EAAyC,CAAC;IAEzD,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,eAAe,GAAG,IAAI,GAAG,EAAU,CAAC;QAE1C,wCAAwC;QACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,WAAW,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;YACtC,gBAAgB,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAC5C,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAC7B,CAAC;QACN,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC,EAAE,CAAC;AAET;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAuB,EAAY,EAAE,CAAC;IACnE,GAAG,0BAA0B,CAAC,IAAI,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CACzC,IAAuB,EACf,EAAE;IACV,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC;QAC7B,kBAAkB;QAClB,oBAAoB;QACpB,2BAA2B;QAC3B,6BAA6B;QAC7B,cAAc;QACd,oBAAoB;QACpB,sBAAsB;QACtB,gBAAgB;QAChB,sBAAsB;QACtB,sBAAsB;QACtB,4BAA4B;KAC/B,CAAC,CAAC;IAEH,OAAO,0BAA0B,CAAC,IAAI,CAAC,CAAC,MAAM,CAC1C,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,CAC1C,CAAC;AACN,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACvC,IAAuB,EACf,EAAE;IACV,MAAM,SAAS,GAAG;QACd,iBAAiB,CAAC,MAAM;QACxB,iBAAiB,CAAC,kBAAkB;QACpC,iBAAiB,CAAC,MAAM;QACxB,iBAAiB,CAAC,SAAS;QAC3B,iBAAiB,CAAC,KAAK;KAC1B,CAAC;IAEF,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QAClB,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,YAAY,GAAG,SAAS,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IAC9C,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IACtD,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;IAE/D,OAAO,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CACnC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CACxC,CAAC;AACN,CAAC,CAAC"}

package/dist/esm/authorization/roleToScopeMapping.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=roleToScopeMapping.test.d.ts.map

package/dist/esm/authorization/roleToScopeMapping.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roleToScopeMapping.test.d.ts","sourceRoot":"","sources":["../../../src/authorization/roleToScopeMapping.test.ts"],"names":[],"mappings":""}