@sudobility/screenwriter_types 0.1.1 → 0.1.2

package/dist/packets/index.js

@@ -1,312 +0,0 @@
-/**
- * Production packets (spec 11 §7, spec 05 §6.22), slice B10. Schemas are the contract MCP and generators consume
- * (`scenePacketSchema` and friends); the API validates its own output against them in tests.
- * Asset lists are always empty until slice B11 (assets) lands.
- */
-import { z } from 'zod';
-export const PACKET_VERSION = 1;
-/**
- * `?snapshotId=&include=` shared by the four packet routes. `include` is a comma list added to the defaults (`assets` and
- * `script` are on by default; `neighbors` and `pages` are opt-in; `-script` and `-assets` switch a default off).
- */
-export const PACKET_INCLUDE_FLAGS = [
-    'assets',
-    'assetUrls',
-    'script',
-    'neighbors',
-    'pages',
-];
-export const packetQuerySchema = z.object({
-    snapshotId: z.string().min(1).optional(),
-    include: z
-        .preprocess((v) => typeof v === 'string'
-        ? v
-            .split(',')
-            .map((s) => s.trim())
-            .filter(Boolean)
-        : v, z.array(z.enum([
-        'assets',
-        'assetUrls=original',
-        'script',
-        'neighbors',
-        'pages',
-        '-assets',
-        '-script',
-    ])))
-        .optional(),
-});
-/** 2 MB JSON cap (spec 11 §7.1): beyond it script text is truncated per element with `truncated: true`. */
-export const PACKET_MAX_BYTES = 2 * 1024 * 1024;
-const envelope = (kind, body) => z.object({
-    packetVersion: z.literal(PACKET_VERSION),
-    kind: z.literal(kind),
-    documentId: z.string(),
-    documentTitle: z.string(),
-    snapshotId: z.string().nullable(),
-    templateId: z.string(),
-    language: z.string(),
-    generatedAt: z.string(),
-    /** `packetHash` of the packet without `generatedAt`, `hash` and signed-URL fields (spec 11 §4.2). */
-    hash: z.string(),
-    truncated: z.boolean().optional(),
-    body,
-});
-const assetSummary = z
-    .object({
-    assetId: z.string(),
-    role: z.string(),
-    kind: z.string(),
-    title: z.string(),
-})
-    .passthrough();
-const pages = z
-    .object({ start: z.string(), end: z.string(), eighths: z.number().int() })
-    .nullable();
-export const packetElementSchema = z.union([
-    z.object({
-        id: z.string(),
-        type: z.literal('character'),
-        text: z.string(),
-        speakerEntityId: z.string().nullable(),
-        extension: z.string().nullable(),
-    }),
-    z.object({
-        id: z.string(),
-        type: z.literal('parenthetical'),
-        text: z.string(),
-        speakerEntityId: z.string().nullable(),
-    }),
-    z.object({
-        id: z.string(),
-        type: z.literal('dialogue'),
-        text: z.string(),
-        speakerEntityId: z.string().nullable(),
-        dual: z.boolean(),
-        lineIndex: z.number().int(),
-    }),
-    // every other role: sceneHeading, action, transition, shot, normal, ...
-    z.object({
-        id: z.string(),
-        type: z
-            .string()
-            .refine((t) => !['character', 'parenthetical', 'dialogue'].includes(t)),
-        text: z.string(),
-    }),
-]);
-const shotSummary = z.object({
-    id: z.string(),
-    number: z.string().nullable(),
-    label: z.string().nullable(),
-    status: z.string(),
-    camera: z.record(z.string(), z.unknown()),
-    estimatedDurationMs: z.number().nullable(),
-    description: z.string().nullable(),
-    elementIds: z.array(z.string()),
-    contentHash: z.string(),
-    assets: z.array(assetSummary),
-});
-const sceneRef = z.object({
-    id: z.string(),
-    number: z.string().nullable(),
-    heading: z.string(),
-    synopsis: z.string(),
-});
-const sceneHeader = z.object({
-    id: z.string(),
-    number: z.string().nullable(),
-    ordinal: z.number().int(),
-    omitted: z.boolean(),
-    heading: z.object({
-        raw: z.string(),
-        intro: z.string().nullable(),
-        location: z.string().nullable(),
-        time: z.string().nullable(),
-    }),
-    locationEntityId: z.string().nullable(),
-    synopsis: z.string(),
-    color: z.string().nullable(),
-    pages,
-    estimatedDurationMs: z.number(),
-    folders: z.array(z.object({ id: z.string(), kind: z.string(), title: z.string() })),
-    contentHash: z.string(),
-    scriptDay: z.string().nullable(),
-});
-const locationBlock = z
-    .object({
-    entityId: z.string(),
-    name: z.string(),
-    fields: z.record(z.string(), z.unknown()),
-    description: z.string(),
-    assets: z.array(assetSummary),
-})
-    .nullable();
-export const scenePacketBodySchema = z.object({
-    scene: sceneHeader,
-    script: z.array(packetElementSchema),
-    cast: z.array(z.object({
-        entityId: z.string(),
-        name: z.string(),
-        speaking: z.boolean(),
-        lineCount: z.number().int(),
-        wordCount: z.number().int(),
-        firstAppearance: z.boolean(),
-        summary: z.string(),
-        fields: z.record(z.string(), z.unknown()),
-        traits: z.record(z.string(), z.union([z.string(), z.number()])),
-        assets: z.array(assetSummary),
-    })),
-    location: locationBlock,
-    elements: z.array(z.object({
-        entityId: z.string(),
-        kind: z.string(),
-        name: z.string(),
-        description: z.string(),
-        tagCount: z.number().int(),
-        assets: z.array(assetSummary),
-    })),
-    shots: z.array(shotSummary),
-    notes: z.array(z.object({
-        id: z.string(),
-        type: z.string(),
-        text: z.string(),
-        anchorElementId: z.string().nullable(),
-    })),
-    sceneAssets: z.array(assetSummary),
-    neighbors: z
-        .object({ previous: sceneRef.nullable(), next: sceneRef.nullable() })
-        .optional(),
-});
-export const scenePacketSchema = envelope('scene', scenePacketBodySchema);
-export const characterPacketBodySchema = z.object({
-    character: z.object({
-        id: z.string(),
-        name: z.string(),
-        aliases: z.array(z.string()),
-        description: z.string(),
-        fields: z.record(z.string(), z.unknown()),
-        traits: z.record(z.string(), z.union([z.string(), z.number()])),
-        attributes: z.record(z.string(), z.unknown()),
-        contentHash: z.string(),
-    }),
-    ages: z.array(z.object({
-        id: z.string(),
-        label: z.string(),
-        ageValue: z.number().nullable(),
-        description: z.string(),
-        skeleton: z.array(z.object({
-            section: z.string().nullable(),
-            label: z.string(),
-            answer: z.string(),
-        })),
-        appearances: z.array(z.object({
-            id: z.string(),
-            label: z.string(),
-            description: z.string(),
-            assetIds: z.array(z.string()),
-        })),
-        sceneCount: z.number().int(),
-    })),
-    skeleton: z.array(z.object({
-        section: z.string().nullable(),
-        label: z.string(),
-        answer: z.string(),
-    })),
-    stats: z.object({
-        sceneCount: z.number().int(),
-        speakingSceneCount: z.number().int(),
-        lineCount: z.number().int(),
-        wordCount: z.number().int(),
-        firstSceneId: z.string().nullable(),
-        lastSceneId: z.string().nullable(),
-    }),
-    scenes: z.array(z.object({
-        id: z.string(),
-        number: z.string().nullable(),
-        heading: z.string(),
-        speaking: z.boolean(),
-        lineCount: z.number().int(),
-        ageId: z.string().nullable(),
-        appearanceId: z.string().nullable(),
-    })),
-    sampleDialogue: z.array(z.object({ elementId: z.string(), sceneId: z.string(), text: z.string() })),
-    relationships: z.array(z.object({
-        entityId: z.string(),
-        name: z.string(),
-        sharedSceneCount: z.number().int(),
-    })),
-    props: z.array(z.object({ entityId: z.string(), name: z.string() })),
-    assets: z.array(assetSummary),
-});
-export const characterPacketSchema = envelope('character', characterPacketBodySchema);
-export const locationPacketBodySchema = z.object({
-    location: z.object({
-        id: z.string(),
-        name: z.string(),
-        aliases: z.array(z.string()),
-        description: z.string(),
-        fields: z.record(z.string(), z.unknown()),
-        parent: z.object({ id: z.string(), name: z.string() }).nullable(),
-        children: z.array(z.object({ id: z.string(), name: z.string() })),
-        contentHash: z.string(),
-    }),
-    versions: z.array(z.object({
-        id: z.string(),
-        label: z.string(),
-        description: z.string(),
-        setting: z.string().nullable(),
-        sceneCount: z.number().int(),
-    })),
-    scenes: z.array(z.object({
-        id: z.string(),
-        number: z.string().nullable(),
-        heading: z.string(),
-        time: z.string().nullable(),
-        pages,
-        cast: z.array(z.string()),
-        versionId: z.string().nullable(),
-    })),
-    totals: z.object({
-        sceneCount: z.number().int(),
-        eighths: z.number().int(),
-        timesOfDay: z.record(z.string(), z.number().int()),
-    }),
-    setElements: z.array(z.object({ entityId: z.string(), kind: z.string(), name: z.string() })),
-    assets: z.array(assetSummary),
-});
-export const locationPacketSchema = envelope('location', locationPacketBodySchema);
-export const shotPacketBodySchema = z.object({
-    shot: shotSummary.extend({
-        sceneId: z.string(),
-        range: z
-            .object({
-            startElementId: z.string(),
-            endElementId: z.string(),
-            text: z.string(),
-        })
-            .nullable(),
-    }),
-    scene: z.object({
-        id: z.string(),
-        number: z.string().nullable(),
-        heading: z.object({
-            raw: z.string(),
-            intro: z.string().nullable(),
-            location: z.string().nullable(),
-            time: z.string().nullable(),
-        }),
-        locationEntityId: z.string().nullable(),
-        contentHash: z.string(),
-    }),
-    script: z.array(packetElementSchema),
-    subjects: z.array(z.object({
-        entityId: z.string(),
-        kind: z.string(),
-        name: z.string(),
-        fields: z.record(z.string(), z.unknown()),
-        assets: z.array(assetSummary),
-    })),
-    location: locationBlock,
-    previousShot: shotSummary.nullable(),
-    nextShot: shotSummary.nullable(),
-});
-export const shotPacketSchema = envelope('shot', shotPacketBodySchema);

package/dist/projects/index.js

@@ -1,75 +0,0 @@
-import { z } from 'zod';
-import { DOCUMENT_KINDS } from '@sudobility/writing_core';
-export { DOCUMENT_KINDS };
-export const documentKindSchema = z.enum(DOCUMENT_KINDS);
-export const SORT_OPTIONS = ['updated', 'name', 'created'];
-/** Spec 05 §6.26: a `series` project orders its episodes by `(season, episode)` (F-COL-006). */
-export const PROJECT_KINDS = ['feature', 'series', 'play', 'other'];
-export const projectKindSchema = z.enum(PROJECT_KINDS);
-/** Document labels (F-COL-006): at most 20 per document, each 1-40 characters. */
-export const DOCUMENT_LABELS_MAX = 20;
-export const DOCUMENT_LABEL_MAX_CHARS = 40;
-export const documentLabelsSchema = z
-    .array(z.string().trim().min(1).max(DOCUMENT_LABEL_MAX_CHARS))
-    .max(DOCUMENT_LABELS_MAX);
-export const projectCreateSchema = z.object({
-    name: z.string().trim().min(1).max(200),
-    description: z.string().max(2000).optional(),
-    coverAssetId: z.string().optional(),
-    color: z.string().max(32).optional(),
-    kind: projectKindSchema.optional(),
-    logline: z.string().max(2000).optional(),
-});
-export const projectUpdateSchema = z.object({
-    name: z.string().trim().min(1).max(200).optional(),
-    description: z.string().max(2000).nullable().optional(),
-    coverAssetId: z.string().nullable().optional(),
-    color: z.string().max(32).nullable().optional(),
-    kind: projectKindSchema.optional(),
-    logline: z.string().max(2000).nullable().optional(),
-    workspaceId: z.string().optional(),
-});
-export const projectListQuerySchema = z.object({
-    trashed: z
-        .enum(['true', 'false'])
-        .transform((v) => v === 'true')
-        .optional(),
-    q: z.string().optional(),
-    sort: z.enum(SORT_OPTIONS).optional(),
-});
-// ─── Documents (spec 05 §6.7) ───────────────────────────────────────────────
-export const documentCreateSchema = z.object({
-    /** Client-generated `doc_...`; creation is idempotent on it. */
-    id: z.string().startsWith('doc_').optional(),
-    title: z.string().trim().min(1).max(200),
-    kind: documentKindSchema,
-    folderId: z.string().optional(),
-    templateId: z.string().optional(),
-    templateVersion: z.number().int().positive().optional(),
-    language: z.string().max(16).optional(),
-    labels: documentLabelsSchema.optional(),
-    season: z.number().int().min(0).max(9999).optional(),
-    episode: z.number().int().min(0).max(99999).optional(),
-});
-export const documentUpdateSchema = z.object({
-    title: z.string().trim().min(1).max(200).optional(),
-    folderId: z.string().nullable().optional(),
-    position: z.number().optional(),
-    color: z.string().max(32).nullable().optional(),
-    language: z.string().max(16).optional(),
-    logline: z.string().max(2000).nullable().optional(),
-    excludeFromAi: z.boolean().optional(),
-    labels: documentLabelsSchema.optional(),
-    season: z.number().int().min(0).max(9999).nullable().optional(),
-    episode: z.number().int().min(0).max(99999).nullable().optional(),
-});
-export const documentListQuerySchema = z.object({
-    trashed: z
-        .enum(['true', 'false'])
-        .transform((v) => v === 'true')
-        .optional(),
-    folderId: z.string().optional(),
-    kind: documentKindSchema.optional(),
-    /** `episode` = `(season, episode)` with unnumbered documents last; the default for a `series` project. */
-    order: z.enum(['position', 'episode']).optional(),
-});

package/dist/public/index.js

@@ -1,25 +0,0 @@
-import { z } from 'zod';
-/** `POST /public/purchases/handoff/redeem`: exchanges a handoff token for a Firebase custom token (same uid), so the web page signs in without a password. */
-export const purchaseHandoffRedeemSchema = z.object({
-    token: z.string().min(1),
-});
-// ---- Telemetry (spec 05 §6.24) ----
-export const telemetryEventSchema = z.object({
-    name: z.string().min(1).max(120),
-    ts: z.string(),
-    /** Allow-listed, flat properties only: no script text, no free-form nesting. */
-    properties: z
-        .record(z.string(), z.union([z.string().max(500), z.number(), z.boolean(), z.null()]))
-        .optional(),
-});
-export const clientErrorReportSchema = z.object({
-    message: z.string().min(1).max(2000),
-    stack: z.string().max(8000).optional(),
-    context: z
-        .record(z.string(), z.union([z.string().max(500), z.number(), z.boolean(), z.null()]))
-        .optional(),
-});
-export const telemetryRequestSchema = z.object({
-    events: z.array(telemetryEventSchema).max(100),
-    errors: z.array(clientErrorReportSchema).max(20).optional(),
-});

package/dist/reads/index.js

@@ -1,118 +0,0 @@
-/**
- * Projection-backed reads (spec 05 §6.7.1, §6.7.2, §6.12, §6.14, §6.15, §6.17), slice B10.
- * The Y.Doc is canonical; these are the shapes the API returns for entities, tags, notes, beats, the Bin,
- * revisions, tracked changes, alternates, title page, statistics, shots, locators and search.
- */
-import { z } from 'zod';
-import { cursorQuerySchema } from '../api/pagination.js';
-// ─── ?source= ───────────────────────────────────────────────────────────────
-/** Query encoding of a `SourceRef` (spec 05 §6.7.1): `live`, `snapshot:<snapshotId>` or `version:<versionId>`. */
-export const sourceParamSchema = z
-    .string()
-    .regex(/^(live|snapshot:[A-Za-z0-9_-]+|version:[A-Za-z0-9_-]+)$/, 'source must be live, snapshot:<id> or version:<id>');
-/** JSON-body source on a document route: the document is implied by the route (spec 03 `SourceRef` without `documentId`). */
-export const docSourceSchema = z.discriminatedUnion('kind', [
-    z.object({ kind: z.literal('live') }),
-    z.object({ kind: z.literal('snapshot'), snapshotId: z.string().min(1) }),
-    z.object({ kind: z.literal('version'), versionId: z.string().min(1) }),
-]);
-export const sourceQuerySchema = z.object({
-    source: sourceParamSchema.optional(),
-});
-export function sourceParamOf(ref) {
-    if (!ref || ref.kind === 'live')
-        return undefined;
-    return ref.kind === 'snapshot'
-        ? `snapshot:${ref.snapshotId}`
-        : `version:${ref.versionId}`;
-}
-// ─── Entities (spec 05 §6.12) ───────────────────────────────────────────────
-export const entityListQuerySchema = cursorQuerySchema.extend({
-    kind: z.string().min(1).optional(),
-    q: z.string().min(1).max(200).optional(),
-    source: sourceParamSchema.optional(),
-});
-export const entityUsageQuerySchema = z.object({
-    variantId: z.string().min(1).optional(),
-    source: sourceParamSchema.optional(),
-});
-export const entityDialogueQuerySchema = z.object({
-    sceneIds: z.string().optional(),
-    source: sourceParamSchema.optional(),
-});
-export const tagsQuerySchema = z.object({
-    sceneId: z.string().optional(),
-    categoryId: z.string().optional(),
-    entityId: z.string().optional(),
-    source: sourceParamSchema.optional(),
-});
-export const notesQuerySchema = z.object({
-    sceneId: z.string().optional(),
-    type: z.string().optional(),
-    status: z.enum(['open', 'resolved']).optional(),
-    source: sourceParamSchema.optional(),
-});
-export const changesQuerySchema = z.object({
-    authorId: z.string().optional(),
-    sceneId: z.string().optional(),
-    source: sourceParamSchema.optional(),
-});
-export const fountainQuerySchema = z.object({
-    sceneIds: z.string().optional(),
-    fromSceneId: z.string().optional(),
-    source: sourceParamSchema.optional(),
-});
-/** `GET /documents/:did/fountain` truncates at this many bytes and sets `X-Next-From-Scene`. */
-export const FOUNTAIN_MAX_BYTES = 1_000_000;
-// ─── Locators (spec 11 §1.3, spec 05 §6.7.2) ────────────────────────────────
-export const LOCATOR_KINDS = [
-    'scene',
-    'element',
-    'shot',
-    'entity',
-    'page',
-];
-export const RESOLVE_BATCH_MAX = 200;
-export const resolveBatchSchema = z.object({
-    locators: z.array(z.string().min(1).max(500)).min(1).max(RESOLVE_BATCH_MAX),
-    snapshotId: z.string().min(1).optional(),
-});
-/** `GET /documents/:did/resolve?ref=&snapshotId=`. */
-export const resolveOneQuerySchema = z.object({
-    ref: z.string().min(1).max(500),
-    snapshotId: z.string().min(1).optional(),
-});
-// ─── Search (spec 05 §6.17) ─────────────────────────────────────────────────
-export const SEARCH_HIT_TYPES = [
-    'document',
-    'scene',
-    'element',
-    'entity',
-    'note',
-    'asset',
-];
-const csv = (v) => typeof v === 'string'
-    ? v
-        .split(',')
-        .map((s) => s.trim())
-        .filter(Boolean)
-    : v;
-export const searchQuerySchema = cursorQuerySchema.extend({
-    q: z.string().min(1).max(200),
-    workspaceId: z.string().min(1).optional(),
-    projectId: z.string().min(1).optional(),
-    documentId: z.string().min(1).optional(),
-    types: z.preprocess(csv, z.array(z.enum(SEARCH_HIT_TYPES)).min(1)).optional(),
-    styleIds: z.preprocess(csv, z.array(z.string()).min(1)).optional(),
-    characterId: z.string().min(1).optional(),
-    language: z.string().min(2).max(35).optional(),
-});
-/** `GET /documents/:did/search` (in-document find, spec 05 §6.7.1). */
-export const documentSearchQuerySchema = z.object({
-    q: z.string().min(1).max(500),
-    mode: z.enum(['text', 'regex']).default('text'),
-    styles: z.preprocess(csv, z.array(z.string()).min(1)).optional(),
-    characters: z.preprocess(csv, z.array(z.string()).min(1)).optional(),
-    limit: z.coerce.number().int().min(1).max(100).default(50),
-    source: sourceParamSchema.optional(),
-});