@antiphony/shared 0.1.0

package/dist/cjs/types/records.cjs

@@ -0,0 +1,407 @@
+'use strict';
+
+var zod = require('zod');
+
+// types/records.ts
+var BlobRefSchema = zod.z.object({
+  /** Discriminator for AT Protocol type system */
+  $type: zod.z.literal("blob"),
+  /** Content Identifier (CID) or URL pointing to the blob */
+  ref: zod.z.string(),
+  /** MIME type of the blob (e.g., 'audio/webm') */
+  mimeType: zod.z.string(),
+  /** Size of the blob in bytes */
+  size: zod.z.number()
+});
+
+// types/records.ts
+function httpsUrl() {
+  return zod.z.string().trim().url().refine((u) => /^https?:\/\//i.test(u), {
+    message: "URL must use the http or https scheme"
+  });
+}
+var FirestoreTimestampSchema = zod.z.union([
+  zod.z.custom((data) => {
+    return data && typeof data === "object" && (typeof data.toDate === "function" || "seconds" in data && "nanoseconds" in data);
+  }),
+  zod.z.string(),
+  zod.z.number(),
+  zod.z.date()
+]).transform((data, ctx) => {
+  let date;
+  if (data instanceof Date) {
+    date = data;
+  } else if (typeof data === "string") {
+    date = new Date(data);
+  } else if (typeof data === "number") {
+    date = new Date(data);
+  } else if (typeof data.toDate === "function") {
+    date = data.toDate();
+  } else {
+    const timestamp = data;
+    date = new Date(timestamp.seconds * 1e3 + timestamp.nanoseconds / 1e6);
+  }
+  if (Number.isNaN(date.getTime())) {
+    ctx.addIssue({
+      code: zod.z.ZodIssueCode.custom,
+      message: "FirestoreTimestamp coerced to Invalid Date"
+    });
+    return zod.z.NEVER;
+  }
+  return date;
+});
+var UserRecordSchema = zod.z.object({
+  /** Unique Firebase UID */
+  id: zod.z.string(),
+  /** Public handle (e.g. @brad). Optional for Lite Users. */
+  handle: zod.z.string().min(3).max(20).regex(/^[a-zA-Z0-9_]+$/).nullable().optional(),
+  /** User stated intent (e.g. "Podcaster", "Listener") */
+  usageIntent: zod.z.string().nullable().optional(),
+  /** 
+   * Domain for federated handle support. 
+   * Defaults to 'voxpop.com'.
+   */
+  domain: zod.z.string().default("voxpop.com"),
+  /**
+   * Display Name (e.g. "Brad Thorson"). Nullable: Firestore stores `null`
+   * when the user clears this field via the settings form, and the schema
+   * must match storage reality or `UserRecordSchema.parse` (in
+   * `getUserRecordByUid`) will throw.
+   */
+  displayName: zod.z.string().max(50).nullable().optional(),
+  /** Short bio/description — nullable for the same reason as displayName. */
+  bio: zod.z.string().max(160).nullable().optional(),
+  /** URL to avatar image — nullable for the same reason as displayName. */
+  avatarUrl: zod.z.string().url().nullable().optional(),
+  /** Optional personal website surfaced on the public profile. */
+  website: httpsUrl().nullable().optional(),
+  /** Up to 5 additional public links (label + URL) shown under the bio. */
+  links: zod.z.array(zod.z.object({
+    label: zod.z.string().min(1).max(40),
+    url: httpsUrl()
+  })).max(5).optional(),
+  /** When true and a Bluesky identity is linked, surfaces it on the public profile. */
+  showBlueskyPublicly: zod.z.boolean().optional(),
+  /** Server timestamp of creation */
+  createdAt: FirestoreTimestampSchema,
+  /** Individual account tier — free or creator_pro */
+  tier: zod.z.enum(["free", "creator_pro"]).default("free"),
+  /** Account status. Deactivated accounts retain data but are excluded from lookups. */
+  status: zod.z.enum(["active", "deactivated"]).default("active"),
+  /** Timestamp when the account was deactivated (soft deleted) */
+  deactivatedAt: FirestoreTimestampSchema.optional(),
+  /**
+   * Denormalized org memberships — { orgId: role } for fast lookup.
+   * Source of truth is organizations/{orgId}/members/{userId}.
+   * Kept in sync by Cloud Function trigger.
+   */
+  orgMemberships: zod.z.record(zod.z.string(), zod.z.enum(["owner", "admin", "member"])).optional()
+});
+var PromptRecordSchema = zod.z.object({
+  /** Unique Prompt ID */
+  id: zod.z.string(),
+  /** ID of the User who created this prompt. Always a user ID, never an org ID. @see UserRecord */
+  authorId: zod.z.string(),
+  /** Organization context this prompt belongs to (null = personal/no org) */
+  orgId: zod.z.string().nullable().optional(),
+  /** The main text of the question/prompt */
+  title: zod.z.string().min(3),
+  /** Optional extra context */
+  description: zod.z.string().nullable().optional(),
+  /** User who created this prompt (differs from authorId when org-owned) */
+  createdBy: zod.z.string().optional(),
+  /** URL to the recorded audio file (GCS) */
+  audioUrl: zod.z.string().url().or(zod.z.literal("")),
+  /** AT Protocol blob reference (future replacement for audioUrl) */
+  audio: BlobRefSchema.optional(),
+  /**
+   * AT Protocol URI returned by the publisher after a successful
+   * `repo.putRecord` against the author's PDS — e.g.
+   * `at://did:plc:abc123/com.voxpop.audio.prompt/3kj4...`. Optional,
+   * no migration: existing rows leave it unset. Format-validated so
+   * malformed strings surface at the schema-parse boundary rather than
+   * being silently stored.
+   */
+  atprotoUri: zod.z.string().regex(/^at:\/\/.+/).optional(),
+  /** Server timestamp of creation */
+  createdAt: FirestoreTimestampSchema,
+  /**
+   * Life-cycle status.
+   * - `live`: Visible and accepting replies.
+   * - `archived`: Visible but closed for new replies.
+   * - `deleted`: Soft deleted.
+   */
+  status: zod.z.enum(["live", "archived", "deleted"]).default("live"),
+  /** AI Enrichment Fields */
+  aiStatus: zod.z.enum(["pending", "complete", "error"]).optional(),
+  aiError: zod.z.string().optional(),
+  aiSummary: zod.z.string().optional(),
+  aiLabels: zod.z.array(zod.z.string()).optional(),
+  transcription: zod.z.string().optional(),
+  /** Pre-computed waveform peaks (normalized 0–1) for instant audio visualization */
+  waveformPeaks: zod.z.array(zod.z.number()).optional(),
+  /** Social Share Video Fields */
+  socialVideoUrl: zod.z.string().url().optional(),
+  socialVideoStoragePath: zod.z.string().optional(),
+  socialVideoStatus: zod.z.enum(["pending", "complete", "error"]).optional(),
+  socialVideoError: zod.z.string().optional(),
+  /** The audio URL/path used to generate the current video (for cache invalidation) */
+  socialVideoSourceAudio: zod.z.string().optional()
+});
+var ReplyRecordSchema = zod.z.object({
+  /** Unique Reply ID */
+  id: zod.z.string(),
+  /** The Prompt being replied to. @see PromptRecord */
+  promptId: zod.z.string(),
+  /** The User who replied. @see UserRecord */
+  authorId: zod.z.string(),
+  /** URL to the recorded audio file (GCS) */
+  audioUrl: zod.z.string().url(),
+  /** AT Protocol blob reference (future replacement for audioUrl) */
+  audio: BlobRefSchema.optional(),
+  /** Server timestamp of creation */
+  createdAt: FirestoreTimestampSchema,
+  /**
+   * Life-cycle status.
+   * - `live`: Visible and accepting replies.
+   * - `archived`: Visible but closed for new replies.
+   * - `deleted`: Soft deleted.
+   */
+  status: zod.z.enum(["live", "archived", "deleted"]).default("live"),
+  /**
+   * Pre-computed waveform peaks (normalized 0–1) for instant audio
+   * visualization. **Stays on canonical** (does NOT move to the
+   * enrichment doc) — produced by a plain ffmpeg pass at ingestion,
+   * not an AI step; a self-hoster without paid-tier AI still needs
+   * this on every reply for the audio player. See
+   * `specs/ai-enrichment-split.md` § 5.
+   */
+  waveformPeaks: zod.z.array(zod.z.number()).optional(),
+  /**
+   * Duration of the audio in seconds, computed server-side from
+   * ffmpeg. **Stays on canonical** (same reasoning as `waveformPeaks`
+   * above — ingestion ffmpeg output, not an AI enrichment). See
+   * `specs/ai-enrichment-split.md` § 5.
+   */
+  audioDurationSec: zod.z.number().optional()
+});
+var ReplyEnrichmentRecordSchema = zod.z.object({
+  id: zod.z.string(),
+  /** Private notes by the prompt author about this reply. */
+  notes: zod.z.string().optional(),
+  // === AI-enrichment fields (sole source of truth post Stage 4) ===
+  //
+  // These lifted off canonical in Stage 4 of `specs/ai-enrichment-split.md`.
+  // Writers (`functions/`) route AI updates here via the split-write
+  // helper in `functions/src/services/replyEnrichmentDualWrite.ts`;
+  // readers source them via the hydrator's enrichment branch (see
+  // `packages/core/services/hydration.ts`).
+  // --- AI core (Gemini-generated) ---
+  aiStatus: zod.z.enum(["pending", "complete", "error", "skipped_too_short"]).optional(),
+  aiError: zod.z.string().optional(),
+  aiSummary: zod.z.string().optional(),
+  aiLabels: zod.z.array(zod.z.string()).optional(),
+  transcription: zod.z.string().optional(),
+  sentiment: zod.z.enum(["Positive", "Negative", "Neutral"]).optional(),
+  /** Must match the widened enum in `ReplyRecordSchema.energyLevel`. */
+  energyLevel: zod.z.enum(["High", "Low", "Neutral"]).optional(),
+  engagementScore: zod.z.number().min(1).max(10).optional(),
+  // --- Voice isolation (ElevenLabs, paid tier) ---
+  /** Noise-reduced audio URL — replaces `audioUrl` for downstream players when present. PUBLIC. */
+  enhancedAudioUrl: zod.z.string().url().optional(),
+  /** Storage path companion to `enhancedAudioUrl` — private. */
+  enhancedStoragePath: zod.z.string().optional(),
+  // --- Social-share video (paid tier) ---
+  //
+  // All `socialVideo*` fields are creator-only. The URL points at the
+  // generated artifact (a video file the creator can download and post
+  // to social media); the reply detail page does NOT render it.
+  socialVideoUrl: zod.z.string().url().optional(),
+  socialVideoStoragePath: zod.z.string().optional(),
+  socialVideoStatus: zod.z.enum(["pending", "complete", "error"]).optional(),
+  socialVideoError: zod.z.string().optional(),
+  /** The audio URL/path used to generate the current video (for cache invalidation). */
+  socialVideoSourceAudio: zod.z.string().optional()
+});
+var PersonEnrichmentRecordSchema = zod.z.object({
+  /** Composite key `${viewerUid}_${targetUid}`. */
+  id: zod.z.string(),
+  /** Per-viewer CRM notes about the target. */
+  notes: zod.z.string().optional(),
+  /** Per-viewer freeform tags about the target. */
+  tags: zod.z.array(zod.z.string()).optional(),
+  // === Identity-merge: alias set ===
+  //
+  // Other identifiers the viewer has declared to be the SAME person as
+  // this entry's `targetUid`. vCard/URI-aligned: each entry is a
+  // scheme-prefixed identifier, so one field generalizes across networks
+  // AND across the future contact-sync import (which carries phone/email):
+  //   "uid:<firebaseUid>" | "did:plc:…" | "handle:bob.bsky.social"
+  //   | "tel:+15551234567" | "mailto:x@example.com"
+  // Mirrors vCard 4.0's `UID` + `CLIENTPIDMAP`/`PID` source-tracking
+  // (RFC 6350) — the standard answer to "the same person from multiple
+  // sources". See `specs/people-lexicon-prior-art.md`. The People
+  // read-path collapses any replier whose "uid:<uid>" appears here into
+  // this primary entry. Empty until the merge feature is used.
+  aliases: zod.z.array(zod.z.string()).optional(),
+  lastUpdated: FirestoreTimestampSchema.optional()
+});
+var SipEnrichmentSchema = zod.z.object({
+  sipUri: zod.z.string(),
+  sipUsername: zod.z.string(),
+  sipSecret: zod.z.string(),
+  provider: zod.z.enum(["twilio", "plivo", "internal"])
+});
+var CallForwardingConfigSchema = zod.z.object({
+  /** User's personal phone number (E.164) */
+  phoneNumber: zod.z.string(),
+  /** Line type from Twilio Lookup v2 */
+  lineType: zod.z.string().nullable(),
+  /** Carrier name from Twilio Lookup v2 */
+  carrier: zod.z.string().nullable(),
+  /** free = shared Twilio number (ForwardedFrom routing), paid = dedicated number */
+  tier: zod.z.enum(["free", "paid"]),
+  /** The VoxPop Twilio number calls forward to (E.164) */
+  voxpopNumber: zod.z.string(),
+  /** Twilio Phone Number SID (paid tier only) */
+  twilioNumberSid: zod.z.string().nullable().optional(),
+  /** Forwarding verification state */
+  verificationStatus: zod.z.enum(["pending", "verifying", "verified", "failed"]).default("pending"),
+  /** Last verification attempt timestamp */
+  lastVerificationAt: FirestoreTimestampSchema.optional(),
+  /** Number of verification attempts */
+  verificationAttempts: zod.z.number().default(0),
+  /** Reason for verification failure */
+  failureReason: zod.z.string().nullable().optional(),
+  /** Whether call forwarding is active */
+  enabled: zod.z.boolean().default(false),
+  createdAt: FirestoreTimestampSchema,
+  updatedAt: FirestoreTimestampSchema
+});
+var ConnectorTypeSchema = zod.z.enum(["telephony"]);
+var ConnectorStatusSchema = zod.z.object({
+  /** Coarse, generic lifecycle the control-plane UI can render without
+   * connector-specific knowledge. */
+  state: zod.z.enum(["unconfigured", "pending", "active", "error", "disabled"]).default("unconfigured"),
+  detail: zod.z.string().nullable().optional(),
+  /** Opaque, connector-specific status detail (e.g. telephony's
+   * `{ verificationStatus, verificationAttempts, failureReason }`). Connector-
+   * owned like the rest of `status` — never user-writable. Nullable so a doc
+   * that stored `data: null` round-trips without a parse error. */
+  data: zod.z.record(zod.z.unknown()).nullable().optional(),
+  updatedAt: FirestoreTimestampSchema.optional()
+});
+var ConnectorConfigRecordSchema = zod.z.object({
+  connectorType: ConnectorTypeSchema,
+  /** The owning user. Org-scoping (ownerId as an orgId) is a later step. */
+  ownerId: zod.z.string(),
+  /** Opaque, connector-specific blob. Core does not interpret this. */
+  settings: zod.z.record(zod.z.unknown()).default({}),
+  /** Reference into a secret store (e.g. Secret Manager key). Never a raw secret. */
+  secretRef: zod.z.string().nullable().optional(),
+  enabled: zod.z.boolean().default(false),
+  status: ConnectorStatusSchema.default({ state: "unconfigured" }),
+  createdAt: FirestoreTimestampSchema,
+  updatedAt: FirestoreTimestampSchema
+});
+var ScreeningRuleRecordSchema = zod.z.object({
+  id: zod.z.string(),
+  ownerId: zod.z.string(),
+  /** The caller number this rule matches (E.164). Format-enforced at the
+   *  record level so any writer (API, future contact-sync/callback) can't
+   *  persist a malformed number. */
+  e164: zod.z.string().regex(/^\+[1-9]\d{6,14}$/, "Must be an E.164 phone number"),
+  /** Display label, e.g. "Mom" / "Delta Airlines". null = unlabeled. */
+  label: zod.z.string().nullable().optional(),
+  /** `allow` = ring through; `screen` = async voicemail. */
+  action: zod.z.enum(["allow", "screen"]),
+  /** Provenance. `manual` = user-created; the others are future writers. */
+  source: zod.z.enum(["manual", "contact-sync", "callback"]),
+  /** null = permanent; a date = self-expiring exception. */
+  expiresAt: FirestoreTimestampSchema.nullable().optional(),
+  createdAt: FirestoreTimestampSchema
+});
+var OrganizationRecordSchema = zod.z.object({
+  id: zod.z.string(),
+  /** Display name of the organization */
+  name: zod.z.string().min(3).max(50),
+  /** 
+   * Unique handle for the organization (e.g. voxpop.com/@mypodcast).
+   * Used for public URLs.
+   */
+  slug: zod.z.string().min(3).max(30).regex(/^[a-z0-9-]+$/),
+  /** URL to avatar/logo */
+  avatarUrl: zod.z.string().url().optional(),
+  /** URL to the podcast RSS feed */
+  rssFeedUrl: zod.z.string().url().optional(),
+  /** External website URL */
+  websiteUrl: httpsUrl().optional(),
+  /** Description or tagline */
+  description: zod.z.string().optional(),
+  /** Owner ID (User ID) */
+  ownerId: zod.z.string(),
+  /** Server timestamp of creation */
+  createdAt: FirestoreTimestampSchema,
+  /** Verified domain (e.g., "acme.com") — enables auto-join, enterprise features */
+  domain: zod.z.string().nullable().optional(),
+  /** Whether the domain has been verified via DNS TXT record */
+  domainVerified: zod.z.boolean().default(false),
+  /** DNS verification token (stored server-side until verification completes) */
+  domainVerificationToken: zod.z.string().optional(),
+  /** Billing email — required for paid orgs, where invoices go */
+  billingEmail: zod.z.string().email().nullable().optional(),
+  /**
+   * Tier determines isolation and feature set. Orgs are meant to be paid
+   * (business or enterprise); free/pro exist on the enum for the individual track.
+   * Default is provisionally `business` (the entry paid tier) — it's assigned at
+   * creation with no subscription behind it yet, so it stays provisional until billing
+   * promotes/reconciles the org. See docs/tech-debt.md "Org tier billing reconciliation".
+   */
+  tier: zod.z.enum(["free", "pro", "business", "enterprise"]).default("business"),
+  /** Stripe Customer ID */
+  stripeCustomerId: zod.z.string().optional(),
+  /** Subscription Status */
+  subscriptionStatus: zod.z.enum(["active", "trialing", "past_due", "canceled", "unpaid"]).optional()
+});
+var OrganizationMemberRecordSchema = zod.z.object({
+  orgId: zod.z.string(),
+  userId: zod.z.string(),
+  /** Role in the organization */
+  role: zod.z.enum(["owner", "admin", "member"]),
+  /** Server timestamp of joining */
+  joinedAt: FirestoreTimestampSchema,
+  invitedBy: zod.z.string().optional()
+});
+var OrgInviteRecordSchema = zod.z.object({
+  id: zod.z.string(),
+  orgId: zod.z.string(),
+  /** Email the invite was sent to */
+  email: zod.z.string().email(),
+  /** Role to assign on acceptance */
+  role: zod.z.enum(["admin", "member"]),
+  /** User ID of who sent the invite */
+  invitedBy: zod.z.string(),
+  /** Invite lifecycle status */
+  status: zod.z.enum(["pending", "accepted", "expired", "revoked"]).default("pending"),
+  /** Server timestamp of creation */
+  createdAt: FirestoreTimestampSchema,
+  /** When this invite expires */
+  expiresAt: FirestoreTimestampSchema
+});
+
+exports.CallForwardingConfigSchema = CallForwardingConfigSchema;
+exports.ConnectorConfigRecordSchema = ConnectorConfigRecordSchema;
+exports.ConnectorStatusSchema = ConnectorStatusSchema;
+exports.ConnectorTypeSchema = ConnectorTypeSchema;
+exports.FirestoreTimestampSchema = FirestoreTimestampSchema;
+exports.OrgInviteRecordSchema = OrgInviteRecordSchema;
+exports.OrganizationMemberRecordSchema = OrganizationMemberRecordSchema;
+exports.OrganizationRecordSchema = OrganizationRecordSchema;
+exports.PersonEnrichmentRecordSchema = PersonEnrichmentRecordSchema;
+exports.PromptRecordSchema = PromptRecordSchema;
+exports.ReplyEnrichmentRecordSchema = ReplyEnrichmentRecordSchema;
+exports.ReplyRecordSchema = ReplyRecordSchema;
+exports.ScreeningRuleRecordSchema = ScreeningRuleRecordSchema;
+exports.SipEnrichmentSchema = SipEnrichmentSchema;
+exports.UserRecordSchema = UserRecordSchema;
+exports.httpsUrl = httpsUrl;