@eduardbar/drift 1.2.0 → 1.3.0

package/dist/saas.d.ts

@@ -4,14 +4,26 @@ export interface SaasPolicy {
     maxRunsPerWorkspacePerMonth: number;
     maxReposPerWorkspace: number;
     retentionDays: number;
+    strictActorEnforcement: boolean;
+    maxWorkspacesPerOrganizationByPlan: Record<SaasPlan, number>;
 }
+export type SaasRole = 'owner' | 'member' | 'viewer';
+export type SaasPlan = 'free' | 'sponsor' | 'team' | 'business';
 export interface SaasUser {
     id: string;
     createdAt: string;
     lastSeenAt: string;
 }
+export interface SaasOrganization {
+    id: string;
+    plan: SaasPlan;
+    createdAt: string;
+    lastSeenAt: string;
+    workspaceIds: string[];
+}
 export interface SaasWorkspace {
     id: string;
+    organizationId: string;
     createdAt: string;
     lastSeenAt: string;
     userIds: string[];
@@ -19,17 +31,39 @@ export interface SaasWorkspace {
 }
 export interface SaasRepo {
     id: string;
+    organizationId: string;
     workspaceId: string;
     name: string;
     createdAt: string;
     lastSeenAt: string;
 }
+export interface SaasMembership {
+    id: string;
+    organizationId: string;
+    workspaceId: string;
+    userId: string;
+    role: SaasRole;
+    createdAt: string;
+    lastSeenAt: string;
+}
+export interface SaasPlanChange {
+    id: string;
+    organizationId: string;
+    fromPlan: SaasPlan;
+    toPlan: SaasPlan;
+    changedAt: string;
+    changedByUserId: string;
+    reason?: string;
+}
 export interface SaasSnapshot {
     id: string;
     createdAt: string;
     scannedAt: string;
+    organizationId: string;
     workspaceId: string;
     userId: string;
+    role: SaasRole;
+    plan: SaasPlan;
     repoId: string;
     repoName: string;
     targetPath: string;
@@ -46,9 +80,60 @@ export interface SaasStore {
     version: number;
     policy: SaasPolicy;
     users: Record<string, SaasUser>;
+    organizations: Record<string, SaasOrganization>;
     workspaces: Record<string, SaasWorkspace>;
+    memberships: Record<string, SaasMembership>;
     repos: Record<string, SaasRepo>;
     snapshots: SaasSnapshot[];
+    planChanges: SaasPlanChange[];
+}
+export type SaasOperation = 'snapshot:write' | 'snapshot:read' | 'summary:read' | 'billing:write' | 'billing:read';
+export interface SaasPermissionContext {
+    operation: SaasOperation;
+    organizationId: string;
+    workspaceId?: string;
+    actorUserId?: string;
+}
+export interface SaasPermissionResult {
+    actorRole?: SaasRole;
+    requiredRole: SaasRole;
+}
+export interface SaasEffectiveLimits {
+    plan: SaasPlan;
+    maxWorkspaces: number;
+    maxReposPerWorkspace: number;
+    maxRunsPerWorkspacePerMonth: number;
+    retentionDays: number;
+}
+export interface SaasOrganizationUsageSnapshot {
+    organizationId: string;
+    plan: SaasPlan;
+    capturedAt: string;
+    workspaceCount: number;
+    repoCount: number;
+    runCount: number;
+    runCountThisMonth: number;
+}
+export interface ChangeOrganizationPlanOptions {
+    organizationId: string;
+    actorUserId: string;
+    newPlan: SaasPlan;
+    reason?: string;
+    storeFile?: string;
+    policy?: SaasPolicyOverrides;
+}
+export interface SaasUsageQueryOptions {
+    organizationId: string;
+    month?: string;
+    storeFile?: string;
+    policy?: SaasPolicyOverrides;
+    actorUserId?: string;
+}
+export interface SaasPlanChangeQueryOptions {
+    organizationId: string;
+    storeFile?: string;
+    policy?: SaasPolicyOverrides;
+    actorUserId?: string;
 }
 export interface SaasSummary {
     policy: SaasPolicy;
@@ -61,23 +146,74 @@ export interface SaasSummary {
     thresholdReached: boolean;
     freeUsersRemaining: number;
 }
+export interface SaasPolicyOverrides {
+    freeUserThreshold?: number;
+    maxRunsPerWorkspacePerMonth?: number;
+    maxReposPerWorkspace?: number;
+    retentionDays?: number;
+    strictActorEnforcement?: boolean;
+    maxWorkspacesPerOrganizationByPlan?: Partial<Record<SaasPlan, number>>;
+}
+export interface SaasQueryOptions {
+    storeFile?: string;
+    policy?: SaasPolicyOverrides;
+    organizationId?: string;
+    workspaceId?: string;
+    actorUserId?: string;
+}
 export interface IngestOptions {
+    organizationId?: string;
     workspaceId: string;
     userId: string;
+    role?: SaasRole;
+    plan?: SaasPlan;
     repoName?: string;
+    actorUserId?: string;
     storeFile?: string;
-    policy?: Partial<SaasPolicy>;
+    policy?: SaasPolicyOverrides;
+}
+export declare class SaasPermissionError extends Error {
+    readonly code = "SAAS_PERMISSION_DENIED";
+    readonly operation: SaasOperation;
+    readonly organizationId: string;
+    readonly workspaceId?: string;
+    readonly actorUserId?: string;
+    readonly requiredRole: SaasRole;
+    readonly actorRole?: SaasRole;
+    constructor(context: SaasPermissionContext, requiredRole: SaasRole, actorRole?: SaasRole);
+}
+export declare class SaasActorRequiredError extends Error {
+    readonly code = "SAAS_ACTOR_REQUIRED";
+    readonly operation: SaasOperation;
+    readonly organizationId: string;
+    readonly workspaceId?: string;
+    constructor(context: SaasPermissionContext);
 }
 export declare const DEFAULT_SAAS_POLICY: SaasPolicy;
-export declare function resolveSaasPolicy(policy?: Partial<SaasPolicy> | DriftConfig['saas']): SaasPolicy;
+export declare function resolveSaasPolicy(policy?: SaasPolicyOverrides | DriftConfig['saas']): SaasPolicy;
 export declare function defaultSaasStorePath(root?: string): string;
-export declare function ingestSnapshotFromReport(report: DriftReport, options: IngestOptions): SaasSnapshot;
-export declare function getSaasSummary(options?: {
+export declare function getRequiredRoleForOperation(operation: SaasOperation): SaasRole;
+export declare function assertSaasPermission(context: SaasPermissionContext & {
     storeFile?: string;
-    policy?: Partial<SaasPolicy>;
-}): SaasSummary;
+    policy?: SaasPolicyOverrides;
+}): SaasPermissionResult;
+export declare function getSaasEffectiveLimits(input: {
+    plan: SaasPlan;
+    policy?: SaasPolicyOverrides;
+}): SaasEffectiveLimits;
+export declare function getOrganizationEffectiveLimits(options: {
+    organizationId: string;
+    storeFile?: string;
+    policy?: SaasPolicyOverrides;
+}): SaasEffectiveLimits;
+export declare function changeOrganizationPlan(options: ChangeOrganizationPlanOptions): SaasPlanChange;
+export declare function listOrganizationPlanChanges(options: SaasPlanChangeQueryOptions): SaasPlanChange[];
+export declare function getOrganizationUsageSnapshot(options: SaasUsageQueryOptions): SaasOrganizationUsageSnapshot;
+export declare function ingestSnapshotFromReport(report: DriftReport, options: IngestOptions): SaasSnapshot;
+export declare function listSaasSnapshots(options?: SaasQueryOptions): SaasSnapshot[];
+export declare function getSaasSummary(options?: SaasQueryOptions): SaasSummary;
 export declare function generateSaasDashboardHtml(options?: {
     storeFile?: string;
-    policy?: Partial<SaasPolicy>;
+    policy?: SaasPolicyOverrides;
 }): string;
 //# sourceMappingURL=saas.d.ts.map