@sudobility/screenwriter_types 0.1.1

package/dist/ai/index.js

@@ -0,0 +1,179 @@
+import { z } from 'zod';
+/**
+ * AI features (spec 06): script review and polish through ShapeShyft.
+ *
+ * Only the tasks implemented so far are in `AI_TASKS`; adding one means a registry row in
+ * `screenwriter_api/src/services/ai/tasks.ts`, a prompt builder, an output schema here and a fixture.
+ * Output schemas are written for structured output: every field is required (nullable, never optional)
+ * and objects are closed, so `z.toJSONSchema` gives the exact schema to store on the ShapeShyft endpoint.
+ */
+export const AI_TASKS = ['coverage', 'polish.dialogue'];
+export const aiTaskSchema = z.enum(AI_TASKS);
+/** ShapeShyft endpoint names (spec 06 2.1). `summarize-chunk` is stage 1 of a long coverage run. */
+export const AI_ENDPOINTS = [
+    'coverage-review',
+    'polish',
+    'summarize-chunk',
+];
+export const AI_JOB_STATUSES = [
+    'queued',
+    'running',
+    'succeeded',
+    'failed',
+    'cancelled',
+];
+/** Counted limits, declared once: schemas, validators and prompt text all read these. */
+export const AI_LIMITS = {
+    noteTitleMax: 80,
+    noteBodyMax: 1200,
+    noteAnchorsMax: 8,
+    strengthsMax: 8,
+    weaknessesMax: 12,
+    sceneNotesMax: 20,
+    loglineMax: 300,
+    summaryMax: 4000,
+    genreMax: 3,
+    verdictRationaleMax: 800,
+    polishSuggestionsMax: 200,
+    polishTextMax: 4000,
+    rationaleMax: 400,
+    chunkSummaryMax: 1200,
+    sceneSummaryMax: 280,
+    polishMaxScenes: 8,
+    instructionsMax: 500,
+};
+export const REVIEW_CATEGORIES = [
+    'premise',
+    'structure',
+    'character',
+    'dialogue',
+    'pacing',
+    'tone',
+    'theme',
+    'worldbuilding',
+    'format',
+    'marketability',
+    'clarity',
+    'continuity',
+];
+export const SEVERITIES = ['praise', 'minor', 'moderate', 'major'];
+export const COVERAGE_VERDICTS = ['recommend', 'consider', 'pass'];
+// ---- Model output (untrusted until validated; what the ShapeShyft endpoint returns) ----
+/** Where a note points. `elementId: null` means the whole scene. The server adds the content hash. */
+export const anchorRefSchema = z.object({
+    sceneId: z.string(),
+    elementId: z.string().nullable(),
+});
+export const noteSchema = z.object({
+    category: z.enum(REVIEW_CATEGORIES),
+    severity: z.enum(SEVERITIES),
+    title: z.string().min(1).max(AI_LIMITS.noteTitleMax),
+    body: z.string().min(1).max(AI_LIMITS.noteBodyMax),
+    anchors: z.array(anchorRefSchema).max(AI_LIMITS.noteAnchorsMax),
+});
+/** `coverage-review` output. */
+export const coverageResponseSchema = z.object({
+    logline: z.string().max(AI_LIMITS.loglineMax),
+    summary: z.string().max(AI_LIMITS.summaryMax),
+    genre: z.array(z.string()).max(AI_LIMITS.genreMax),
+    strengths: z.array(noteSchema).max(AI_LIMITS.strengthsMax),
+    weaknesses: z.array(noteSchema).max(AI_LIMITS.weaknessesMax),
+    /** Notes about specific scenes: each must anchor at least one scene. */
+    sceneNotes: z.array(noteSchema).max(AI_LIMITS.sceneNotesMax),
+    verdict: z.enum(COVERAGE_VERDICTS),
+    verdictRationale: z.string().max(AI_LIMITS.verdictRationaleMax),
+});
+/** `polish` output: one proposed replacement per element. */
+export const polishResponseSchema = z.object({
+    suggestions: z
+        .array(z.object({
+        elementId: z.string(),
+        after: z.string().max(AI_LIMITS.polishTextMax),
+        rationale: z.string().max(AI_LIMITS.rationaleMax),
+    }))
+        .max(AI_LIMITS.polishSuggestionsMax),
+});
+/** `summarize-chunk` output (stage 1 of a long-script coverage run). */
+export const chunkSummaryResponseSchema = z.object({
+    scenes: z.array(z.object({
+        sceneId: z.string(),
+        summary: z.string().max(AI_LIMITS.sceneSummaryMax),
+        intensity: z.number().int().min(1).max(5),
+    })),
+    chunkSummary: z.string().max(AI_LIMITS.chunkSummaryMax),
+});
+/** The five input fields every endpoint takes (spec 06 2.1). */
+export const aiEndpointInputSchema = z.object({
+    context: z.string(),
+    brief: z.string(),
+    max_output_tokens: z.number().int().positive(),
+    locale: z.string(),
+    script_language: z.string(),
+});
+/** Endpoint -> output schema. `bun run ai:schemas` in screenwriter_api prints these as JSON Schema. */
+export const AI_ENDPOINT_OUTPUT_SCHEMAS = {
+    'coverage-review': coverageResponseSchema,
+    polish: polishResponseSchema,
+    'summarize-chunk': chunkSummaryResponseSchema,
+};
+// ---- Jobs ----
+export const aiScopeSchema = z.object({
+    sceneIds: z.array(z.string().min(1)).max(200).optional(),
+    elementIds: z.array(z.string().min(1)).max(2000).optional(),
+});
+export const aiJobOptionsSchema = z.object({
+    /** Writer's own request, fenced separately from the script. Fixture failure markers only work in test mode. */
+    instructions: z.string().max(AI_LIMITS.instructionsMax).optional(),
+    intensity: z.enum(['light', 'medium', 'bold']).optional(),
+    locale: z.string().min(2).max(20).optional(),
+});
+/** `POST /documents/:did/ai/jobs` body. `polish.dialogue` needs a scope; `coverage` defaults to the whole script. */
+export const aiJobCreateSchema = z.object({
+    task: aiTaskSchema,
+    scope: aiScopeSchema.optional(),
+    options: aiJobOptionsSchema.optional(),
+});
+// ---- Suggestion sets (spec 06 7) ----
+export const SUGGESTION_STATUSES = [
+    'pending',
+    'accepted',
+    'rejected',
+    'stale',
+];
+export const SUGGESTION_SET_STATUSES = [
+    'pending',
+    'partiallyAccepted',
+    'accepted',
+    'rejected',
+    'stale',
+    'expired',
+];
+export const suggestionAcceptSchema = z.object({
+    suggestionIds: z.array(z.string().min(1)).min(1).max(200),
+});
+/** `reject` with no ids rejects every pending suggestion in the set. */
+export const suggestionRejectSchema = z.object({
+    suggestionIds: z.array(z.string().min(1)).min(1).max(200).optional(),
+});
+// ---- Consent (spec 06 §9.3: gate 3) ----
+/** Bumping this requires every user to re-accept before their next AI job. */
+export const AI_CONSENT_VERSION = 1;
+/** `POST /me/ai-consents`: `version` must equal `AI_CONSENT_VERSION`, else `VALIDATION`. */
+export const aiConsentAcceptSchema = z.object({ version: z.number().int() });
+export const aiEstimateRequestSchema = z.object({
+    task: aiTaskSchema,
+    scope: z
+        .object({
+        sceneIds: z.array(z.string()).optional(),
+        elementIds: z.array(z.string()).optional(),
+    })
+        .optional(),
+    options: z.record(z.string(), z.unknown()).optional(),
+});
+// ---- Suggestion decide (spec 06 §7.4): a combined, server-side accept/reject for API/MCP callers ----
+export const suggestionDecideSchema = z.object({
+    accept: z.union([z.array(z.string().min(1)), z.literal('allPending')]),
+    reject: z.union([z.array(z.string().min(1)), z.literal('allPending')]),
+    expectedHashes: z.record(z.string(), z.string()).optional(),
+    dryRun: z.boolean().optional(),
+});

package/dist/api/envelope.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Response envelope, error vocabulary (spec 05 §12) and pagination shape.
+ * Platform-free: no clock is read here, so the envelope carries no timestamp.
+ */
+/** Every REST error code and its fixed HTTP status (spec 05 §12). */
+declare const ERROR_TABLE: readonly [readonly ["UNAUTHORIZED", 401], readonly ["REAUTH_REQUIRED", 401], readonly ["API_KEY_FORBIDDEN", 403], readonly ["FORBIDDEN", 403], readonly ["ROLE_ESCALATION", 403], readonly ["NOT_FOUND", 404], readonly ["PROJECT_NOT_FOUND", 404], readonly ["DOCUMENT_NOT_FOUND", 404], readonly ["SNAPSHOT_NOT_FOUND", 404], readonly ["TEMPLATE_NOT_FOUND", 404], readonly ["ITEM_NOT_FOUND", 404], readonly ["ANCHOR_NOT_FOUND", 404], readonly ["TARGET_NOT_FOUND", 404], readonly ["VALIDATION", 400], readonly ["COMMAND_INVALID", 422], readonly ["TEMPLATE_INVALID", 422], readonly ["CONFIRMATION_MISMATCH", 400], readonly ["EPOCH_MISMATCH", 409], readonly ["DOCUMENT_LOCKED", 423], readonly ["DOCUMENT_BUSY", 409], readonly ["JOB_ALREADY_RUNNING", 409], readonly ["JOB_FINISHED", 409], readonly ["JOB_NOT_FINISHED", 409], readonly ["LAST_OWNER", 409], readonly ["ALREADY_MEMBER", 409], readonly ["NOT_A_MEMBER", 409], readonly ["PERSONAL_WORKSPACE_IMMUTABLE", 409], readonly ["OWNS_TEAM_WORKSPACE", 409], readonly ["NOT_IN_TRASH", 409], readonly ["PARENT_IN_TRASH", 409], readonly ["FOLDER_DEPTH", 409], readonly ["FOLDER_CYCLE", 409], readonly ["MOVE_FORBIDDEN", 403], readonly ["BUILTIN_IMMUTABLE", 409], readonly ["LOCATOR_AMBIGUOUS", 409], readonly ["INVITATION_INVALID", 410], readonly ["INVITATION_EXPIRED", 410], readonly ["INVITATION_CLOSED", 410], readonly ["EMAIL_MISMATCH", 403], readonly ["SHARE_LINK_INVALID", 404], readonly ["SHARE_LINK_PASSWORD_REQUIRED", 401], readonly ["WATERMARK_REQUIRED", 403], readonly ["EDIT_WINDOW_CLOSED", 409], readonly ["ASSET_TOO_LARGE", 413], readonly ["IMPORT_TOO_LARGE", 413], readonly ["UNSUPPORTED_FORMAT", 400], readonly ["IMPORT_FAILED", 400], readonly ["IMPORT_INVALID", 422], readonly ["ASSET_TYPE_REJECTED", 415], readonly ["ASSET_CHECKSUM_MISMATCH", 422], readonly ["ASSET_NOT_READY", 409], readonly ["ASSET_IN_USE", 409], readonly ["UPLOAD_INCOMPLETE", 409], readonly ["UPLOAD_EXPIRED", 410], readonly ["STORAGE_QUOTA_EXCEEDED", 507], readonly ["STORAGE_UNAVAILABLE", 503], readonly ["IMPORT_FORMAT_UNSUPPORTED", 415], readonly ["EXPORT_FORMAT_UNSUPPORTED", 415], readonly ["COMPARE_TOO_LARGE", 413], readonly ["LIMIT_EXCEEDED", 409], readonly ["RATE_LIMITED", 429], readonly ["QUOTA_EXCEEDED", 429], readonly ["INSUFFICIENT_CREDITS", 402], readonly ["AI_UNAVAILABLE", 503], readonly ["AI_INPUT_TOO_LARGE", 413], readonly ["AI_GENERATION_FAILED", 502], readonly ["AI_OUTPUT_INVALID", 502], readonly ["CONFIG_MISSING", 503], readonly ["CLIENT_TOO_OLD", 426], readonly ["CONTENT_CHANGED", 409], readonly ["STYLE_NOT_IN_TEMPLATE", 422], readonly ["NOT_CONTIGUOUS", 422], readonly ["LOCKED_CONTENT", 409], readonly ["NAME_COLLISION", 409], readonly ["KIND_MISMATCH", 422], readonly ["OVERLAPPING_SHOTS", 422], readonly ["OVERLAPPING_NODE", 422], readonly ["SCENES_LOCKED", 409], readonly ["NOT_LOCKED", 409], readonly ["RANGE_OUT_OF_BOUNDS", 422], readonly ["INVALID_TARGET", 422], readonly ["INVALID_DUAL_DIALOGUE", 422], readonly ["FOUNTAIN_PARSE_ERROR", 422], readonly ["UNMAPPED_STYLES", 422], readonly ["RANGE_TOO_LARGE", 413], readonly ["PAYLOAD_TOO_LARGE", 413], readonly ["INVALID_REGEX", 400], readonly ["REPORT_OPTIONS_INVALID", 400], readonly ["REPORT_KIND_UNAVAILABLE", 501], readonly ["ENTITY_IN_USE", 409], readonly ["VARIANT_IN_USE", 409], readonly ["SNAPSHOT_NOT_IN_DOCUMENT", 404], readonly ["ITEM_NOT_IN_SNAPSHOT", 404], readonly ["INVALID_LOCATOR", 400], readonly ["LOCATOR_NOT_FOUND", 404], readonly ["ROLE_NOT_ALLOWED_FOR_TARGET", 422], readonly ["ID_CONFLICT", 409], readonly ["IDEMPOTENCY_KEY_REUSED", 409], readonly ["IDEMPOTENCY_IN_PROGRESS", 409], readonly ["DEVICE_REVOKED", 403], readonly ["MACRO_TRIGGER_TAKEN", 409], readonly ["STALE_WRITE", 409], readonly ["HANDOFF_INVALID", 410], readonly ["WATERMARK_NOT_FOUND", 404], readonly ["OCR_UNAVAILABLE", 503], readonly ["GRAMMAR_UNAVAILABLE", 503], readonly ["AI_CONSENT_REQUIRED", 403], readonly ["AI_DISABLED_FOR_WORKSPACE", 403], readonly ["AI_EXCLUDED_DOCUMENT", 403], readonly ["AI_KEY_NOT_PERMITTED", 403], readonly ["QUOTE_EXCEEDS_MAX", 402], readonly ["AI_CONTENT_REFUSED", 422], readonly ["SCOPE_TOO_LARGE", 413], readonly ["SUGGESTION_UNAVAILABLE", 409], readonly ["JOB_KIND_DISABLED", 501], readonly ["JOB_KIND_NOT_GENERIC", 400], readonly ["JOB_FAILED", 409], readonly ["JOB_TIMEOUT", 504], readonly ["LIKENESS_CONSENT_REQUIRED", 422], readonly ["CONTENT_REJECTED", 422], readonly ["INTERNAL", 500]];
+type ErrorTable = typeof ERROR_TABLE;
+export type ApiErrorCode = ErrorTable[number][0];
+export declare const API_ERROR_CODES: { readonly [C in ApiErrorCode]: C; };
+/** HTTP status per error code. */
+export declare const ERROR_STATUS: Record<ApiErrorCode, number>;
+export interface ApiSuccess<T> {
+    success: true;
+    data: T;
+}
+export interface ApiFailure {
+    success: false;
+    /** Human-readable message. */
+    error: string;
+    code: ApiErrorCode;
+    /** Code-specific details (e.g. `issues`, `index`, `ids`). */
+    details?: Record<string, unknown>;
+}
+export type ApiResponse<T> = ApiSuccess<T> | ApiFailure;
+export declare function successResponse<T>(data: T): ApiSuccess<T>;
+/** The only constructor for failure envelopes. */
+export declare function errorResponse(message: string, code: ApiErrorCode, details?: Record<string, unknown>): ApiFailure;
+/** Cursor page: `nextCursor` is null on the last page. */
+export interface Paginated<T> {
+    items: T[];
+    nextCursor: string | null;
+}
+export {};

package/dist/api/envelope.js

@@ -0,0 +1,140 @@
+/**
+ * Response envelope, error vocabulary (spec 05 §12) and pagination shape.
+ * Platform-free: no clock is read here, so the envelope carries no timestamp.
+ */
+/** Every REST error code and its fixed HTTP status (spec 05 §12). */
+const ERROR_TABLE = [
+    ['UNAUTHORIZED', 401],
+    ['REAUTH_REQUIRED', 401],
+    ['API_KEY_FORBIDDEN', 403],
+    ['FORBIDDEN', 403],
+    ['ROLE_ESCALATION', 403],
+    ['NOT_FOUND', 404],
+    ['PROJECT_NOT_FOUND', 404],
+    ['DOCUMENT_NOT_FOUND', 404],
+    ['SNAPSHOT_NOT_FOUND', 404],
+    ['TEMPLATE_NOT_FOUND', 404],
+    ['ITEM_NOT_FOUND', 404],
+    ['ANCHOR_NOT_FOUND', 404],
+    ['TARGET_NOT_FOUND', 404],
+    ['VALIDATION', 400],
+    ['COMMAND_INVALID', 422],
+    ['TEMPLATE_INVALID', 422],
+    ['CONFIRMATION_MISMATCH', 400],
+    ['EPOCH_MISMATCH', 409],
+    ['DOCUMENT_LOCKED', 423],
+    ['DOCUMENT_BUSY', 409],
+    ['JOB_ALREADY_RUNNING', 409],
+    ['JOB_FINISHED', 409],
+    ['JOB_NOT_FINISHED', 409],
+    ['LAST_OWNER', 409],
+    ['ALREADY_MEMBER', 409],
+    ['NOT_A_MEMBER', 409],
+    ['PERSONAL_WORKSPACE_IMMUTABLE', 409],
+    ['OWNS_TEAM_WORKSPACE', 409],
+    ['NOT_IN_TRASH', 409],
+    ['PARENT_IN_TRASH', 409],
+    ['FOLDER_DEPTH', 409],
+    ['FOLDER_CYCLE', 409],
+    ['MOVE_FORBIDDEN', 403],
+    ['BUILTIN_IMMUTABLE', 409],
+    ['LOCATOR_AMBIGUOUS', 409],
+    ['INVITATION_INVALID', 410],
+    ['INVITATION_EXPIRED', 410],
+    ['INVITATION_CLOSED', 410],
+    ['EMAIL_MISMATCH', 403],
+    ['SHARE_LINK_INVALID', 404],
+    ['SHARE_LINK_PASSWORD_REQUIRED', 401],
+    ['WATERMARK_REQUIRED', 403],
+    ['EDIT_WINDOW_CLOSED', 409],
+    ['ASSET_TOO_LARGE', 413],
+    ['IMPORT_TOO_LARGE', 413],
+    ['UNSUPPORTED_FORMAT', 400],
+    ['IMPORT_FAILED', 400],
+    ['IMPORT_INVALID', 422],
+    ['ASSET_TYPE_REJECTED', 415],
+    ['ASSET_CHECKSUM_MISMATCH', 422],
+    ['ASSET_NOT_READY', 409],
+    ['ASSET_IN_USE', 409],
+    ['UPLOAD_INCOMPLETE', 409],
+    ['UPLOAD_EXPIRED', 410],
+    ['STORAGE_QUOTA_EXCEEDED', 507],
+    ['STORAGE_UNAVAILABLE', 503],
+    ['IMPORT_FORMAT_UNSUPPORTED', 415],
+    ['EXPORT_FORMAT_UNSUPPORTED', 415],
+    ['COMPARE_TOO_LARGE', 413],
+    ['LIMIT_EXCEEDED', 409],
+    ['RATE_LIMITED', 429],
+    ['QUOTA_EXCEEDED', 429],
+    ['INSUFFICIENT_CREDITS', 402],
+    ['AI_UNAVAILABLE', 503],
+    ['AI_INPUT_TOO_LARGE', 413],
+    ['AI_GENERATION_FAILED', 502],
+    ['AI_OUTPUT_INVALID', 502],
+    ['CONFIG_MISSING', 503],
+    ['CLIENT_TOO_OLD', 426],
+    ['CONTENT_CHANGED', 409],
+    ['STYLE_NOT_IN_TEMPLATE', 422],
+    ['NOT_CONTIGUOUS', 422],
+    ['LOCKED_CONTENT', 409],
+    ['NAME_COLLISION', 409],
+    ['KIND_MISMATCH', 422],
+    ['OVERLAPPING_SHOTS', 422],
+    ['OVERLAPPING_NODE', 422],
+    ['SCENES_LOCKED', 409],
+    ['NOT_LOCKED', 409],
+    ['RANGE_OUT_OF_BOUNDS', 422],
+    ['INVALID_TARGET', 422],
+    ['INVALID_DUAL_DIALOGUE', 422],
+    ['FOUNTAIN_PARSE_ERROR', 422],
+    ['UNMAPPED_STYLES', 422],
+    ['RANGE_TOO_LARGE', 413],
+    ['PAYLOAD_TOO_LARGE', 413],
+    ['INVALID_REGEX', 400],
+    ['REPORT_OPTIONS_INVALID', 400],
+    ['REPORT_KIND_UNAVAILABLE', 501],
+    ['ENTITY_IN_USE', 409],
+    ['VARIANT_IN_USE', 409],
+    ['SNAPSHOT_NOT_IN_DOCUMENT', 404],
+    ['ITEM_NOT_IN_SNAPSHOT', 404],
+    ['INVALID_LOCATOR', 400],
+    ['LOCATOR_NOT_FOUND', 404],
+    ['ROLE_NOT_ALLOWED_FOR_TARGET', 422],
+    ['ID_CONFLICT', 409],
+    ['IDEMPOTENCY_KEY_REUSED', 409],
+    ['IDEMPOTENCY_IN_PROGRESS', 409],
+    ['DEVICE_REVOKED', 403],
+    ['MACRO_TRIGGER_TAKEN', 409],
+    ['STALE_WRITE', 409],
+    ['HANDOFF_INVALID', 410],
+    ['WATERMARK_NOT_FOUND', 404],
+    ['OCR_UNAVAILABLE', 503],
+    ['GRAMMAR_UNAVAILABLE', 503],
+    ['AI_CONSENT_REQUIRED', 403],
+    ['AI_DISABLED_FOR_WORKSPACE', 403],
+    ['AI_EXCLUDED_DOCUMENT', 403],
+    ['AI_KEY_NOT_PERMITTED', 403],
+    ['QUOTE_EXCEEDS_MAX', 402],
+    ['AI_CONTENT_REFUSED', 422],
+    ['SCOPE_TOO_LARGE', 413],
+    ['SUGGESTION_UNAVAILABLE', 409],
+    ['JOB_KIND_DISABLED', 501],
+    ['JOB_KIND_NOT_GENERIC', 400],
+    ['JOB_FAILED', 409],
+    ['JOB_TIMEOUT', 504],
+    ['LIKENESS_CONSENT_REQUIRED', 422],
+    ['CONTENT_REJECTED', 422],
+    ['INTERNAL', 500],
+];
+export const API_ERROR_CODES = Object.fromEntries(ERROR_TABLE.map(([code]) => [code, code]));
+/** HTTP status per error code. */
+export const ERROR_STATUS = Object.fromEntries(ERROR_TABLE);
+export function successResponse(data) {
+    return { success: true, data };
+}
+/** The only constructor for failure envelopes. */
+export function errorResponse(message, code, details) {
+    return details === undefined
+        ? { success: false, error: message, code }
+        : { success: false, error: message, code, details };
+}

package/dist/api/pagination.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+/** `limit` 1-200 (default 50); `cursor` is an opaque base64url string. */
+export declare const cursorQuerySchema: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    cursor: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type CursorQuery = z.infer<typeof cursorQuerySchema>;

package/dist/api/pagination.js

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+/** `limit` 1-200 (default 50); `cursor` is an opaque base64url string. */
+export const cursorQuerySchema = z.object({
+    limit: z.coerce.number().int().min(1).max(200).default(50),
+    cursor: z
+        .string()
+        .regex(/^[A-Za-z0-9_-]+$/)
+        .optional(),
+});

package/dist/api/routes.d.ts

@@ -0,0 +1,273 @@
+/**
+ * Route table for slices B1-B5 (spec 05 §6). Paths are relative to API_BASE_PATH.
+ * `auth` uses the spec legend: U user, K key (r/rw scope), L link, P public.
+ * `permission` is the spec 05 §5.2 permission checked on the resolved object.
+ */
+export declare const API_BASE_PATH = "/api/v1";
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+export interface RouteSpec {
+    method: HttpMethod;
+    path: string;
+    auth: string;
+    permission: string | null;
+}
+export declare const API_ROUTES: {
+    readonly health: RouteSpec;
+    readonly meGet: RouteSpec;
+    readonly mePatch: RouteSpec;
+    readonly workspacesList: RouteSpec;
+    readonly workspaceGet: RouteSpec;
+    readonly projectsList: RouteSpec;
+    readonly projectCreate: RouteSpec;
+    readonly projectGet: RouteSpec;
+    readonly projectUpdate: RouteSpec;
+    readonly projectTrash: RouteSpec;
+    readonly projectRestore: RouteSpec;
+    readonly documentsList: RouteSpec;
+    readonly documentCreate: RouteSpec;
+    readonly documentGet: RouteSpec;
+    readonly documentUpdate: RouteSpec;
+    readonly documentTrash: RouteSpec;
+    readonly documentRestore: RouteSpec;
+    readonly documentState: RouteSpec;
+    readonly documentContent: RouteSpec;
+    readonly templatesList: RouteSpec;
+    readonly templateGet: RouteSpec;
+    readonly sync: RouteSpec;
+    readonly versionsList: RouteSpec;
+    readonly versionState: RouteSpec;
+    readonly versionRestore: RouteSpec;
+    readonly versionSnapshot: RouteSpec;
+    readonly snapshotsList: RouteSpec;
+    readonly snapshotCreate: RouteSpec;
+    readonly snapshotGet: RouteSpec;
+    readonly snapshotState: RouteSpec;
+    readonly snapshotContent: RouteSpec;
+    readonly snapshotOpen: RouteSpec;
+    readonly snapshotFork: RouteSpec;
+    readonly elementHistory: RouteSpec;
+    readonly documentPresence: RouteSpec;
+    readonly versionRestoreAsCopy: RouteSpec;
+    readonly snapshotPrefs: RouteSpec;
+    readonly snapshotNotesList: RouteSpec;
+    readonly snapshotNoteCreate: RouteSpec;
+    readonly snapshotCommentsList: RouteSpec;
+    readonly snapshotCommentCreate: RouteSpec;
+    readonly snapshotCommentCopyToLive: RouteSpec;
+    readonly snapshotCommentResolve: RouteSpec;
+    readonly documentCompare: RouteSpec;
+    readonly documentImport: RouteSpec;
+    readonly documentExport: RouteSpec;
+    readonly formatsList: RouteSpec;
+    readonly commands: RouteSpec;
+    readonly outline: RouteSpec;
+    readonly scene: RouteSpec;
+    readonly scenesBatch: RouteSpec;
+    readonly elementsBatch: RouteSpec;
+    readonly apiKeysList: RouteSpec;
+    readonly apiKeyCreate: RouteSpec;
+    readonly apiKeyUpdate: RouteSpec;
+    readonly apiKeyRevoke: RouteSpec;
+    readonly aiStatus: RouteSpec;
+    readonly aiJobCreate: RouteSpec;
+    readonly aiJobsList: RouteSpec;
+    readonly aiJobGet: RouteSpec;
+    readonly aiJobCancel: RouteSpec;
+    readonly aiSuggestionSetsList: RouteSpec;
+    readonly aiSuggestionSetGet: RouteSpec;
+    readonly aiSuggestionSetAccept: RouteSpec;
+    readonly aiSuggestionSetReject: RouteSpec;
+    readonly workspaceCreate: RouteSpec;
+    readonly workspaceUpdate: RouteSpec;
+    readonly workspaceDelete: RouteSpec;
+    readonly workspaceTransfer: RouteSpec;
+    readonly workspaceLeave: RouteSpec;
+    readonly workspaceUsage: RouteSpec;
+    readonly workspaceAudit: RouteSpec;
+    readonly membersList: RouteSpec;
+    readonly memberUpdate: RouteSpec;
+    readonly memberRemove: RouteSpec;
+    readonly invitationCreateWorkspace: RouteSpec;
+    readonly invitationCreateProject: RouteSpec;
+    readonly invitationCreateDocument: RouteSpec;
+    readonly workspaceInvitationsList: RouteSpec;
+    readonly myInvitations: RouteSpec;
+    readonly invitationRenew: RouteSpec;
+    readonly invitationCancel: RouteSpec;
+    readonly invitationAccept: RouteSpec;
+    readonly invitationDecline: RouteSpec;
+    readonly sharedWithMe: RouteSpec;
+    readonly documentLock: RouteSpec;
+    readonly documentUnlock: RouteSpec;
+    readonly documentUnlockSession: RouteSpec;
+    readonly shareLinkCreateDocument: RouteSpec;
+    readonly shareLinkCreateProject: RouteSpec;
+    readonly shareLinkCreateSnapshot: RouteSpec;
+    readonly shareLinksListDocument: RouteSpec;
+    readonly shareLinksListProject: RouteSpec;
+    readonly shareLinkUpdate: RouteSpec;
+    readonly shareLinkRevoke: RouteSpec;
+    readonly grantsListDocument: RouteSpec;
+    readonly grantsListProject: RouteSpec;
+    readonly grantUpdate: RouteSpec;
+    readonly grantRemove: RouteSpec;
+    readonly publicShareResolve: RouteSpec;
+    readonly shareUnlock: RouteSpec;
+    readonly shareState: RouteSpec;
+    readonly jobsList: RouteSpec;
+    readonly jobGet: RouteSpec;
+    readonly jobCreate: RouteSpec;
+    readonly jobCancel: RouteSpec;
+    readonly jobOutputs: RouteSpec;
+    readonly jobRecipients: RouteSpec;
+    readonly jobWebhook: RouteSpec;
+    readonly entitiesList: RouteSpec;
+    readonly entityGet: RouteSpec;
+    readonly entityUsage: RouteSpec;
+    readonly entityDialogue: RouteSpec;
+    readonly tagCategoriesList: RouteSpec;
+    readonly tagsList: RouteSpec;
+    readonly notesList: RouteSpec;
+    readonly beatsList: RouteSpec;
+    readonly binList: RouteSpec;
+    readonly revisionsGet: RouteSpec;
+    readonly changesList: RouteSpec;
+    readonly alternatesGet: RouteSpec;
+    readonly titlePageGet: RouteSpec;
+    readonly statsGet: RouteSpec;
+    readonly fountainGet: RouteSpec;
+    readonly sceneShotsList: RouteSpec;
+    readonly resolveBatch: RouteSpec;
+    readonly resolveOne: RouteSpec;
+    readonly documentSearch: RouteSpec;
+    readonly workspaceSearch: RouteSpec;
+    readonly search: RouteSpec;
+    readonly reportKinds: RouteSpec;
+    readonly reportGet: RouteSpec;
+    readonly reportCreate: RouteSpec;
+    readonly packetScene: RouteSpec;
+    readonly packetCharacter: RouteSpec;
+    readonly packetLocation: RouteSpec;
+    readonly packetShot: RouteSpec;
+    readonly meDictionaryGet: RouteSpec;
+    readonly meDictionaryUpdate: RouteSpec;
+    readonly mePreferencesGet: RouteSpec;
+    readonly mePreferencesSet: RouteSpec;
+    readonly meMacrosList: RouteSpec;
+    readonly meMacroCreate: RouteSpec;
+    readonly meMacroUpdate: RouteSpec;
+    readonly meMacroDelete: RouteSpec;
+    readonly meWritingStats: RouteSpec;
+    readonly meWritingSessionCreate: RouteSpec;
+    readonly meWritingGoalsGet: RouteSpec;
+    readonly meWritingGoalsSet: RouteSpec;
+    readonly meExport: RouteSpec;
+    readonly meDelete: RouteSpec;
+    readonly meRestore: RouteSpec;
+    readonly documentMyStateGet: RouteSpec;
+    readonly documentMyStateSet: RouteSpec;
+    readonly documentStar: RouteSpec;
+    readonly documentUnstar: RouteSpec;
+    readonly workspaceDocuments: RouteSpec;
+    readonly workspaceTrash: RouteSpec;
+    readonly workspaceTrashEmpty: RouteSpec;
+    readonly projectPurge: RouteSpec;
+    readonly projectDuplicate: RouteSpec;
+    readonly projectFolderCreate: RouteSpec;
+    readonly projectFolderUpdate: RouteSpec;
+    readonly projectFolderDelete: RouteSpec;
+    readonly documentMove: RouteSpec;
+    readonly documentPurge: RouteSpec;
+    readonly documentDuplicate: RouteSpec;
+    readonly documentApplyTemplate: RouteSpec;
+    readonly templateCreate: RouteSpec;
+    readonly templateVersionCreate: RouteSpec;
+    readonly templateUpdate: RouteSpec;
+    readonly templateDelete: RouteSpec;
+    readonly templateImport: RouteSpec;
+    readonly templateExport: RouteSpec;
+    readonly projectBinList: RouteSpec;
+    readonly projectBinCreate: RouteSpec;
+    readonly projectBinDelete: RouteSpec;
+    readonly workspaceDefaultsGet: RouteSpec;
+    readonly workspaceDefaultsSet: RouteSpec;
+    readonly workspaceContactsList: RouteSpec;
+    readonly workspaceContactsCreate: RouteSpec;
+    readonly workspaceContactUpdate: RouteSpec;
+    readonly workspaceContactDelete: RouteSpec;
+    readonly uploadState: RouteSpec;
+    readonly importCreate: RouteSpec;
+    readonly importStart: RouteSpec;
+    readonly documentImportOver: RouteSpec;
+    readonly documentExportCreate: RouteSpec;
+    readonly documentExportCombined: RouteSpec;
+    readonly watermarkLookup: RouteSpec;
+    readonly assetUploadCreate: RouteSpec;
+    readonly assetUploadGet: RouteSpec;
+    readonly assetUploadParts: RouteSpec;
+    readonly assetUploadComplete: RouteSpec;
+    readonly assetUploadAbort: RouteSpec;
+    readonly assetsList: RouteSpec;
+    readonly assetGet: RouteSpec;
+    readonly assetUrl: RouteSpec;
+    readonly assetUpdate: RouteSpec;
+    readonly assetDelete: RouteSpec;
+    readonly assetRestore: RouteSpec;
+    readonly assetLinkCreate: RouteSpec;
+    readonly documentAssetLinks: RouteSpec;
+    readonly assetLinkUpdate: RouteSpec;
+    readonly assetLinkDelete: RouteSpec;
+    readonly documentStaleness: RouteSpec;
+    readonly assetLinkStaleness: RouteSpec;
+    readonly meNotificationPrefsGet: RouteSpec;
+    readonly meNotificationPrefsSet: RouteSpec;
+    readonly documentMentionsWithoutAccess: RouteSpec;
+    readonly documentChatList: RouteSpec;
+    readonly documentChatCreate: RouteSpec;
+    readonly chatMessageUpdate: RouteSpec;
+    readonly chatMessageDelete: RouteSpec;
+    readonly documentActivity: RouteSpec;
+    readonly workspaceActivity: RouteSpec;
+    readonly notificationsList: RouteSpec;
+    readonly notificationsRead: RouteSpec;
+    readonly notificationDelete: RouteSpec;
+    readonly notificationsStream: RouteSpec;
+    readonly devicesList: RouteSpec;
+    readonly deviceCreate: RouteSpec;
+    readonly deviceUpdate: RouteSpec;
+    readonly deviceRevoke: RouteSpec;
+    readonly devicePushTokenSet: RouteSpec;
+    readonly devicePushTokenDelete: RouteSpec;
+    readonly meAiConsentGet: RouteSpec;
+    readonly meAiConsentAccept: RouteSpec;
+    readonly meAiActivity: RouteSpec;
+    readonly workspaceAiActivity: RouteSpec;
+    readonly aiEstimate: RouteSpec;
+    readonly aiReportsList: RouteSpec;
+    readonly aiReportGet: RouteSpec;
+    readonly aiReportNoteConvert: RouteSpec;
+    readonly aiSuggestionSetDecide: RouteSpec;
+    readonly consumablesBalance: RouteSpec;
+    readonly consumablesPurchases: RouteSpec;
+    readonly consumablesUsages: RouteSpec;
+    readonly consumablesProducts: RouteSpec;
+    readonly consumablesWebhook: RouteSpec;
+    readonly purchaseHandoffCreate: RouteSpec;
+    readonly publicTemplatesList: RouteSpec;
+    readonly publicTemplateGet: RouteSpec;
+    readonly publicConfig: RouteSpec;
+    readonly publicNamesDb: RouteSpec;
+    readonly publicHealthDeep: RouteSpec;
+    readonly publicWatermarkedGet: RouteSpec;
+    readonly purchaseHandoffRedeem: RouteSpec;
+    readonly telemetryCreate: RouteSpec;
+    readonly adminUsersLookup: RouteSpec;
+    readonly adminUserRestore: RouteSpec;
+    readonly adminUserPurge: RouteSpec;
+    readonly adminJobsList: RouteSpec;
+    readonly adminJobRetry: RouteSpec;
+    readonly adminJobRefund: RouteSpec;
+    readonly adminJobKindUpdate: RouteSpec;
+    readonly adminDocumentMeta: RouteSpec;
+};
+export type ApiRouteName = keyof typeof API_ROUTES;