Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

2.0 KB
Raw Blame
// Scope taxonomy for bearer credentials (API keys and OAuth access tokens).
// Pure data — no runtime dependencies — so both the server (enforcement,
// zod validation) and the client (scope picker) can share one source of truth.

// better-auth configId of the organization-owned API key configuration. Keys
// from this config authenticate as the organization itself; keys from any
// other config (including legacy NULL configIds) are user-owned. The server
// (bearerAuth, auth.ts) and the client (org key management) must agree on it.
export const ORG_API_KEY_CONFIG_ID = "org";

export const SCOPE_MATRIX = {
  analytics: ["read"],
  sessions: ["read"],
  events: ["read"],
  users: ["read", "write"],
  goals: ["read", "write"],
  funnels: ["read", "write"],
  dashboards: ["read", "write"],
  annotations: ["read", "write"],
  segments: ["read", "write"],
  flags: ["read", "write"],
  experiments: ["read", "write"],
  sites: ["read", "write"],
  gsc: ["read", "write"],
  org: ["read", "write"],
  replay: ["read", "write"],
  sql: ["read"],
  ingest: ["write"],
} as const;

export type ScopeResource = keyof typeof SCOPE_MATRIX;
export type ScopeAction = "read" | "write";
export type ScopeStatements = Partial<Record<ScopeResource, ScopeAction[]>>;
export interface ScopeRequirement {
  resource: ScopeResource;
  action: ScopeAction;
}

export const OIDC_STANDARD_SCOPES = ["openid", "profile", "email", "offline_access"] as const;

export const SCOPE_RESOURCES = Object.keys(SCOPE_MATRIX) as ScopeResource[];

/** Every valid "resource:action" string, e.g. "analytics:read", "goals:write". */
export const ALL_SCOPE_STRINGS: readonly string[] = SCOPE_RESOURCES.flatMap(resource =>
  (SCOPE_MATRIX[resource] as readonly string[]).map(action => `${resource}:${action}`)
);

export function isValidScopePair(resource: string, action: string): resource is ScopeResource {
  const actions = SCOPE_MATRIX[resource as ScopeResource] as readonly string[] | undefined;
  return !!actions && actions.includes(action);
}