organization.zod.ts

// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.

import { z } from 'zod';

/**
 * Organization Schema (Multi-Tenant Architecture)
 * 
 * Defines the standard organization/workspace model for ObjectStack.
 * Supports B2B SaaS scenarios where users belong to multiple teams/workspaces.
 * 
 * This aligns with better-auth's organization plugin capabilities.
 */

/**
 * Organization Schema
 * Represents a team, workspace, or tenant in a multi-tenant application
 */
import { lazySchema } from '../shared/lazy-schema';
export const OrganizationSchema = lazySchema(() => z.object({
  /**
   * Unique organization identifier
   */
  id: z.string().describe('Unique organization identifier'),
  
  /**
   * Organization name (display name)
   */
  name: z.string().describe('Organization display name'),
  
  /**
   * Organization slug (URL-friendly identifier)
   * Must be unique across all organizations
   */
  slug: z.string()
    .regex(/^[a-z0-9_-]+$/)
    .describe('Unique URL-friendly slug (lowercase alphanumeric, hyphens, underscores)'),
  
  /**
   * Organization logo URL
   */
  logo: z.string().url().optional().describe('Organization logo URL'),
  
  /**
   * Custom metadata for the organization
   * Can store additional configuration, settings, or custom fields
   */
  metadata: z.record(z.string(), z.unknown()).optional().describe('Custom metadata'),
  
  /**
   * Organization creation timestamp
   */
  createdAt: z.string().datetime().describe('Organization creation timestamp'),
  
  /**
   * Last update timestamp
   */
  updatedAt: z.string().datetime().describe('Last update timestamp'),
}));

export type Organization = z.infer<typeof OrganizationSchema>;

/**
 * Organization Member Schema
 * Links users to organizations with specific roles
 */
export const MemberSchema = lazySchema(() => z.object({
  /**
   * Unique member identifier
   */
  id: z.string().describe('Unique member identifier'),
  
  /**
   * Organization ID this membership belongs to
   */
  organizationId: z.string().describe('Organization ID'),
  
  /**
   * User ID of the member
   */
  userId: z.string().describe('User ID'),
  
  /**
   * Member's role within the organization
   * Common roles: 'owner', 'admin', 'member', 'guest'
   * Can be customized per application
   */
  role: z.string().describe('Member role (e.g., owner, admin, member, guest)'),
  
  /**
   * Member creation timestamp
   */
  createdAt: z.string().datetime().describe('Member creation timestamp'),
  
  /**
   * Last update timestamp
   */
  updatedAt: z.string().datetime().describe('Last update timestamp'),
}));

export type Member = z.infer<typeof MemberSchema>;

/**
 * Invitation Status Enum
 */
export const InvitationStatus = z.enum(['pending', 'accepted', 'rejected', 'expired']);

export type InvitationStatus = z.infer<typeof InvitationStatus>;

/**
 * Organization Invitation Schema
 * Represents an invitation to join an organization
 */
export const InvitationSchema = lazySchema(() => z.object({
  /**
   * Unique invitation identifier
   */
  id: z.string().describe('Unique invitation identifier'),
  
  /**
   * Organization ID the invitation is for
   */
  organizationId: z.string().describe('Organization ID'),
  
  /**
   * Email address of the invitee
   */
  email: z.string().email().describe('Invitee email address'),
  
  /**
   * Role the invitee will receive upon accepting
   * Common roles: 'admin', 'member', 'guest'
   */
  role: z.string().describe('Role to assign upon acceptance'),
  
  /**
   * Invitation status
   */
  status: InvitationStatus.default('pending').describe('Invitation status'),
  
  /**
   * Invitation expiration timestamp
   */
  expiresAt: z.string().datetime().describe('Invitation expiry timestamp'),
  
  /**
   * User ID of the person who sent the invitation
   */
  inviterId: z.string().describe('User ID of the inviter'),
  
  /**
   * Invitation creation timestamp
   */
  createdAt: z.string().datetime().describe('Invitation creation timestamp'),
  
  /**
   * Last update timestamp
   */
  updatedAt: z.string().datetime().describe('Last update timestamp'),
}));

export type Invitation = z.infer<typeof InvitationSchema>;