@speckle/shared/dist/esm/workspaces/helpers/features.js

Shared code between various Speckle JS packages

import { PaidWorkspacePlans, UnpaidWorkspacePlans } from './plans.js';
/**
 * WORKSPACE FEATURES
 */
export const WorkspacePlanFeatures = {
    // Core features pretty much available to everyone
    AutomateBeta: 'automateBeta',
    DomainDiscoverability: 'domainDiscoverability',
    // Optional/plan specific
    DomainSecurity: 'domainBasedSecurityPolicies',
    SSO: 'oidcSso',
    CustomDataRegion: 'workspaceDataRegionSpecificity',
    HideSpeckleBranding: 'hideSpeckleBranding',
    ExclusiveMembership: 'exclusiveMembership',
    EmbedPrivateProjects: 'embedPrivateProjects',
    AccIntegration: 'accIntegration',
    SavedViews: 'savedViews'
};
export const WorkspacePlanFeaturesMetadata = {
    [WorkspacePlanFeatures.AutomateBeta]: {
        displayName: 'Automate beta access',
        description: 'Run custom automations on every new model version'
    },
    [WorkspacePlanFeatures.DomainDiscoverability]: {
        displayName: 'Domain discoverability',
        description: 'Allow people to discover your workspace if they use a verified company email'
    },
    [WorkspacePlanFeatures.DomainSecurity]: {
        displayName: 'Domain protection',
        description: 'Require workspace members to use a verified company email'
    },
    [WorkspacePlanFeatures.SSO]: {
        displayName: 'Single Sign-On (SSO)',
        description: 'Require workspace members to authenticate with your SSO provider'
    },
    [WorkspacePlanFeatures.CustomDataRegion]: {
        displayName: 'Custom data residency',
        description: 'Store your data in EU, UK, North America, or Asia Pacific'
    },
    [WorkspacePlanFeatures.HideSpeckleBranding]: {
        displayName: 'Customised viewer',
        description: 'Hide the Speckle branding in embedded viewer'
    },
    [WorkspacePlanFeatures.ExclusiveMembership]: {
        displayName: 'Exclusive workspace membership',
        description: 'Members of exclusive workspaces cannot join or create other workspaces'
    },
    [WorkspacePlanFeatures.EmbedPrivateProjects]: {
        displayName: 'Embed private projects',
        description: 'Embed projects with visibility set to private or workspace'
    },
    [WorkspacePlanFeatures.AccIntegration]: {
        displayName: 'ACC connector',
        description: 'Configure automatic import of ACC assets into workspace projects'
    },
    [WorkspacePlanFeatures.SavedViews]: {
        displayName: 'Saved views',
        description: 'Create and share saved views of your models'
    }
};
const unlimited = {
    projectCount: null,
    modelCount: null,
    versionsHistory: null,
    commentHistory: null
};
const baseFeatures = [
    WorkspacePlanFeatures.AutomateBeta,
    WorkspacePlanFeatures.DomainDiscoverability,
    WorkspacePlanFeatures.EmbedPrivateProjects
];
export const WorkspacePaidPlanConfigs = (params) => ({
    [PaidWorkspacePlans.Team]: {
        plan: PaidWorkspacePlans.Team,
        features: [...baseFeatures],
        limits: {
            projectCount: 5,
            modelCount: 25,
            versionsHistory: { value: 30, unit: 'day' },
            commentHistory: { value: 30, unit: 'day' }
        }
    },
    [PaidWorkspacePlans.TeamUnlimited]: {
        plan: PaidWorkspacePlans.TeamUnlimited,
        features: [...baseFeatures],
        limits: {
            projectCount: null,
            modelCount: null,
            versionsHistory: { value: 30, unit: 'day' },
            commentHistory: { value: 30, unit: 'day' }
        }
    },
    [PaidWorkspacePlans.Pro]: {
        plan: PaidWorkspacePlans.Pro,
        features: [
            ...baseFeatures,
            WorkspacePlanFeatures.DomainSecurity,
            WorkspacePlanFeatures.SSO,
            WorkspacePlanFeatures.CustomDataRegion,
            WorkspacePlanFeatures.HideSpeckleBranding,
            ...(params.featureFlags?.FF_SAVED_VIEWS_ENABLED
                ? [WorkspacePlanFeatures.SavedViews]
                : [])
        ],
        limits: {
            projectCount: 10,
            modelCount: 50,
            versionsHistory: null,
            commentHistory: null
        }
    },
    [PaidWorkspacePlans.ProUnlimited]: {
        plan: PaidWorkspacePlans.ProUnlimited,
        features: [
            ...baseFeatures,
            WorkspacePlanFeatures.DomainSecurity,
            WorkspacePlanFeatures.SSO,
            WorkspacePlanFeatures.CustomDataRegion,
            WorkspacePlanFeatures.HideSpeckleBranding,
            ...(params.featureFlags?.FF_SAVED_VIEWS_ENABLED
                ? [WorkspacePlanFeatures.SavedViews]
                : [])
        ],
        limits: {
            projectCount: null,
            modelCount: null,
            versionsHistory: null,
            commentHistory: null
        }
    }
});
export const WorkspaceUnpaidPlanConfigs = (params) => ({
    [UnpaidWorkspacePlans.Enterprise]: {
        plan: UnpaidWorkspacePlans.Enterprise,
        features: [
            ...baseFeatures,
            WorkspacePlanFeatures.DomainSecurity,
            WorkspacePlanFeatures.SSO,
            WorkspacePlanFeatures.CustomDataRegion,
            WorkspacePlanFeatures.HideSpeckleBranding,
            WorkspacePlanFeatures.ExclusiveMembership,
            ...(params.featureFlags?.FF_ACC_INTEGRATION_ENABLED
                ? [WorkspacePlanFeatures.AccIntegration]
                : []),
            ...(params.featureFlags?.FF_SAVED_VIEWS_ENABLED
                ? [WorkspacePlanFeatures.SavedViews]
                : [])
        ],
        limits: unlimited
    },
    [UnpaidWorkspacePlans.Unlimited]: {
        plan: UnpaidWorkspacePlans.Unlimited,
        features: [
            ...baseFeatures,
            WorkspacePlanFeatures.DomainSecurity,
            WorkspacePlanFeatures.SSO,
            WorkspacePlanFeatures.CustomDataRegion,
            WorkspacePlanFeatures.HideSpeckleBranding,
            WorkspacePlanFeatures.ExclusiveMembership,
            ...(params.featureFlags?.FF_ACC_INTEGRATION_ENABLED
                ? [WorkspacePlanFeatures.AccIntegration]
                : []),
            ...(params.featureFlags?.FF_SAVED_VIEWS_ENABLED
                ? [WorkspacePlanFeatures.SavedViews]
                : [])
        ],
        limits: unlimited
    },
    [UnpaidWorkspacePlans.Academia]: {
        plan: UnpaidWorkspacePlans.Academia,
        features: [
            ...baseFeatures,
            WorkspacePlanFeatures.DomainSecurity,
            WorkspacePlanFeatures.SSO,
            WorkspacePlanFeatures.CustomDataRegion,
            WorkspacePlanFeatures.HideSpeckleBranding,
            ...(params.featureFlags?.FF_SAVED_VIEWS_ENABLED
                ? [WorkspacePlanFeatures.SavedViews]
                : [])
        ],
        limits: unlimited
    },
    [UnpaidWorkspacePlans.TeamUnlimitedInvoiced]: {
        ...WorkspacePaidPlanConfigs(params).teamUnlimited,
        plan: UnpaidWorkspacePlans.TeamUnlimitedInvoiced
    },
    [UnpaidWorkspacePlans.ProUnlimitedInvoiced]: {
        ...WorkspacePaidPlanConfigs(params).proUnlimited,
        plan: UnpaidWorkspacePlans.ProUnlimitedInvoiced
    },
    [UnpaidWorkspacePlans.Free]: {
        plan: UnpaidWorkspacePlans.Free,
        features: baseFeatures,
        limits: {
            projectCount: 1,
            modelCount: 5,
            versionsHistory: { value: 7, unit: 'day' },
            commentHistory: { value: 7, unit: 'day' }
        }
    }
});
export const WorkspacePlanConfigs = (params) => ({
    ...WorkspacePaidPlanConfigs(params),
    ...WorkspaceUnpaidPlanConfigs(params)
});
/**
 * Checks if a workspace exceeds its plan limits for projects and models
 */
export const workspaceExceedsPlanLimit = (params) => {
    const { plan, projectCount, modelCount, featureFlags } = params;
    if (!plan)
        return false;
    const planConfig = WorkspacePlanConfigs({ featureFlags })[plan];
    if (!planConfig)
        return false;
    const limits = planConfig.limits;
    if (!limits.projectCount || !limits.modelCount)
        return false;
    if (!projectCount || !modelCount)
        return false;
    return projectCount > limits.projectCount || modelCount > limits.modelCount;
};
/**
 * Checks if a workspace reached its plan limits for projects and models
 */
export const workspaceReachedPlanLimit = (params) => {
    const { plan, projectCount, modelCount, featureFlags } = params;
    if (!plan)
        return false;
    const planConfig = WorkspacePlanConfigs({ featureFlags })[plan];
    if (!planConfig)
        return false;
    const limits = planConfig.limits;
    if (!limits.projectCount || !limits.modelCount)
        return false;
    return projectCount === limits.projectCount || modelCount === limits.modelCount;
};
export const workspacePlanHasAccessToFeature = ({ plan, feature, featureFlags }) => {
    const planConfig = WorkspacePlanConfigs({ featureFlags })[plan];
    const hasAccess = planConfig.features.includes(feature);
    return hasAccess;
};
//# sourceMappingURL=features.js.map