@patterkit/ops 0.16.1 → 0.17.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ian Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -426,6 +426,7 @@ type PlayEvent =
     direction?: string;
     qualifier?: string;
     qualifierName?: string;
+    speakerLabel?: string;
     padAfter?: number;
     gameData?: GameData;
 } | {
@@ -785,7 +786,8 @@ declare function renderReportText(data: ReportData): string[];
 declare function runReportXlsx(data: ReportData): Promise<Buffer>;
 
 /** One localisable string. `id` is the beat id (or `cast:<NAME>` for a display name, `qualifier:<gameId>` for a
- *  speaker qualifier's name). */
+ *  speaker qualifier's name, `speaker:pattern` for the speaker pattern, `speaker:<NAME>:<gameId>` for a
+ *  character's own label with a qualifier). */
 interface LocEntry {
     id: string;
     /** Owning scene id, or `@project` for project-level strings (display names). */
@@ -822,6 +824,15 @@ interface ApplyStats {
     /** Loc shard files touched. */
     files: number;
 }
+/**
+ * The source text of every project-level string the project defines, by id: each cast display name
+ * (`cast:<NAME>`), each qualifier's name (`qualifier:<gameId>`), the speaker pattern (`speaker:pattern`), and
+ * each character's own label with a qualifier (`speaker:<NAME>:<gameId>`). A string's source is the default
+ * locale's `@project` shard value where it has one, else what the project file authors. Not filtered by what
+ * the lines use: the export picks from it, and a settings save compares it before and after to know which
+ * translations a change makes stale.
+ */
+declare function projectStringSources(project: ProjectFile, sourceTable: Record<string, string>): Record<string, string>;
 /**
  * Build the format-neutral localisation catalog. With no `locale` (or the default locale) it is a
  * TEMPLATE: every `translation` is "". Otherwise translations come from that locale's shards.
@@ -829,6 +840,8 @@ interface ApplyStats {
 declare function extractLoc(loaded: LoadedProject, opts?: {
     locale?: string;
 }): LocCatalog;
+/** The authoring shard path for a scene (mirrors the flow stem), or `_project.patterx` for `@project`. */
+declare function authoringPath(loaded: LoadedProject, scene: string): string;
 /**
  * Write a catalog's translations back. Throws, writing nothing, when the catalogue names a locale the
  * project does not declare or a scene it does not have. Produces the loc-shard writes (one per scene touched) and stamps
@@ -1040,6 +1053,102 @@ declare function scriptToDocx(doc: ScriptDoc): Promise<Buffer>;
 /** Render the readable screenplay as a PDF. Resolves once PDFKit has flushed the whole document. */
 declare function scriptToPdf(doc: ScriptDoc): Promise<Buffer>;
 
+var serif = [
+	"@fontsource/newsreader/files/newsreader-latin-400-normal.woff",
+	"@fontsource/newsreader/files/newsreader-latin-ext-400-normal.woff",
+	"@fontsource/newsreader/files/newsreader-vietnamese-400-normal.woff"
+];
+var serifBold = [
+	"@fontsource/newsreader/files/newsreader-latin-600-normal.woff",
+	"@fontsource/newsreader/files/newsreader-latin-ext-600-normal.woff",
+	"@fontsource/newsreader/files/newsreader-vietnamese-600-normal.woff"
+];
+var serifItalic = [
+	"@fontsource/newsreader/files/newsreader-latin-400-italic.woff",
+	"@fontsource/newsreader/files/newsreader-latin-ext-400-italic.woff",
+	"@fontsource/newsreader/files/newsreader-vietnamese-400-italic.woff"
+];
+var serifBoldItalic = [
+	"@fontsource/newsreader/files/newsreader-latin-600-italic.woff",
+	"@fontsource/newsreader/files/newsreader-latin-ext-600-italic.woff",
+	"@fontsource/newsreader/files/newsreader-vietnamese-600-italic.woff"
+];
+var sans = [
+	"@fontsource/inter/files/inter-latin-400-normal.woff",
+	"@fontsource/inter/files/inter-latin-ext-400-normal.woff",
+	"@fontsource/inter/files/inter-greek-400-normal.woff",
+	"@fontsource/inter/files/inter-greek-ext-400-normal.woff",
+	"@fontsource/inter/files/inter-cyrillic-400-normal.woff",
+	"@fontsource/inter/files/inter-cyrillic-ext-400-normal.woff",
+	"@fontsource/inter/files/inter-vietnamese-400-normal.woff"
+];
+var sansBold = [
+	"@fontsource/inter/files/inter-latin-600-normal.woff",
+	"@fontsource/inter/files/inter-latin-ext-600-normal.woff",
+	"@fontsource/inter/files/inter-greek-600-normal.woff",
+	"@fontsource/inter/files/inter-greek-ext-600-normal.woff",
+	"@fontsource/inter/files/inter-cyrillic-600-normal.woff",
+	"@fontsource/inter/files/inter-cyrillic-ext-600-normal.woff",
+	"@fontsource/inter/files/inter-vietnamese-600-normal.woff"
+];
+var mono = [
+	"@ibm/plex-mono/fonts/complete/woff/IBMPlexMono-Regular.woff"
+];
+var fallback = [
+	"@fontsource/noto-sans/files/noto-sans-latin-400-normal.woff",
+	"@fontsource/noto-sans/files/noto-sans-latin-ext-400-normal.woff",
+	"@fontsource/noto-sans/files/noto-sans-greek-400-normal.woff",
+	"@fontsource/noto-sans/files/noto-sans-greek-ext-400-normal.woff",
+	"@fontsource/noto-sans/files/noto-sans-cyrillic-400-normal.woff",
+	"@fontsource/noto-sans/files/noto-sans-cyrillic-ext-400-normal.woff",
+	"@fontsource/noto-sans/files/noto-sans-vietnamese-400-normal.woff",
+	"@fontsource/noto-sans/files/noto-sans-devanagari-400-normal.woff",
+	"@fontsource/noto-sans-math/files/noto-sans-math-latin-400-normal.woff"
+];
+var emoji = [
+	"@fontsource/noto-emoji/files/noto-emoji-emoji-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-0-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-1-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-2-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-3-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-4-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-5-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-6-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-7-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-8-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-9-400-normal.woff",
+	"@fontsource/noto-emoji/files/noto-emoji-10-400-normal.woff"
+];
+var FACES = {
+	serif: serif,
+	serifBold: serifBold,
+	serifItalic: serifItalic,
+	serifBoldItalic: serifBoldItalic,
+	sans: sans,
+	sansBold: sansBold,
+	mono: mono,
+	fallback: fallback,
+	emoji: emoji
+};
+
+/** A face the PDF export registers: the design's three roles, plus the two fallbacks every role shares. */
+type ScriptFace = keyof typeof FACES;
+/** Each face's files, as module paths (`<package>/<file>`), in the order a character tries them. */
+declare const SCRIPT_FONT_FILES: Readonly<Record<ScriptFace, readonly string[]>>;
+/** The packages the faces come from, each of which carries the licence its fonts travel under. */
+declare const SCRIPT_FONT_PACKAGES: readonly string[];
+/** Read the files from these paths, keyed by module path, instead of resolving them from node_modules;
+ *  and the licences from `licencePaths`, keyed by package. For a bundle that embeds the files itself
+ *  (the standalone CLI, Patterpad). */
+declare function useScriptFontFiles(paths: Readonly<Record<string, string>>, licencePaths?: Readonly<Record<string, string>>): void;
+/** Where a font package's licence file is in node_modules (LICENSE, LICENSE.txt or OFL.txt). */
+declare function scriptFontLicencePath(pkg: string): string;
+/** Each font package's licence text, for a listing of what the PDF export embeds and under what terms. */
+declare function scriptFontLicences(): {
+    package: string;
+    text: string;
+}[];
+
 type InitVcs = "git" | "perforce" | "plastic" | "svn";
 /** Whether the compiled `.patterc` bundle is committed or built in CI (spec §11). */
 type BundlePosture = "commit" | "ignore";
@@ -1645,4 +1754,4 @@ declare const REFUSE_MISSING_SHARE = 0.25;
 /** Plan an import. Reads the handoff record named in the document from the project. */
 declare function planEditableImport(loaded: LoadedProject, returned: ReturnedDoc, opts: ImportOptions): ImportPlan;
 
-export { AUDIO_MANIFEST_FILE, AUDIO_MANIFEST_SCHEMA, AUTHORING_HANDLED, type ApplyStats, type AudioEntry, type AudioRung, type AudioSnapshot, type BuildPlan, type BundlePosture, CONFLICT_SIDECAR, type CharacterReport, type Conflict, type ConflictKind, type ContentError, type CoverageAsyncHooks, type CoverageBeat, type CoverageHooks, type CoverageOptions, type CoverageOrder, type CoverageReport, type DecisionPlan, type DecisionResult, type DocumentManifest, type EditableScript, type EditableScriptOptions, type ExportOptions, type FormatResult, GAME_SCOPES_OWNER, type GameScopes, type GameScopesIssue, HANDOFF_DIR, type HandoffIssue, type HygieneIssue, type ImportOptions, type ImportPlan, type ImportProblem, type ImportReport, type InitOptions, type InitResult, type InitVcs, type LoadedProject, type LocCatalog, type LocEntry, type LocaleReport, type MergeFileType, type MergeResult, type MergedShard, NotAPackError, type OpenSuggestion, PATTER_SCOPES_FILE, PATTER_SCOPES_OWNER, type PinPlan, type PinnedName, type PlannedWrite, type PlayEvent, type PlayOptions, type PlayOutcome, type PlayResult, type ProvenanceCheck, RARE_REACH_PCT, REFUSE_MISSING_SHARE, type Random, type ReadBox, type ReadComment, type ReadItem, type ReadMarker, type ReadParagraph, type ReadText, type ReplaceHit, type ReplaceOptions, type ReplacePlan, type ReportData, type ReportTotals, type ResolveEntry, type ReturnedDoc, SHARD_EXTENSIONS, type SceneReport, type ScriptDoc, type ScriptElement, type SearchFocus, type SuggestionDecision, type TrackedChange, type UnpackMergeResult, type UnpackResult, UnsafeEntryError, UnsupportedMergeError, type ValidateResult, type VoiceLine, type VoiceScript, type VoicedCounts, type WebExport, type WrittenCounts, applyLoc, applySceneOrder, applySuggestionDecisions, applyWrites, audioFolderRungs, audioFoldersActive, audioManifest, audioManifestWrite, besideBundlePath, bundleOutputPath, catalogToJson, catalogToPo, catalogToXlsx, classesForChannel, compileLoaded, cueLabel, currentBundlePosture, defaultBundlePath, defaultGameScopesDir, detectMergeType, discoverGameScopes, drivableScopes, exportBlockers, exportEditableScript, extractLoc, findProjectFile, formatMarker, gameScopeTokens, gameScopesCatalogue, gameScopesSnapshot, handoffPath, handoffWrite, hostScopeTokens, issueMarkerCodes, jsonToCatalog, leastReachedFirst, listOpenSuggestions, listProjectTags, loadProject, loadProjectLanding, markerLength, newHandoffId, parseHandoff, patterScopesFile, patterScopesStale, patterScopesWrite, pickAudio, planBuild, planEditableImport, planPins, planReturnedWorld, planShareScopes, planWorldSave, poToCatalog, previewRegistry, proposeCoverageDrivers, qualifierNamer, reachabilityIssues, readEditableDocx, readGameScopes, readHandoff, readHandoffs, readMarker, renderCoverageText, renderPlay, renderReportText, resolveDocumentation, resolveStart, runCoverage, runCoverageAsync, runExport, runExportFull, runExportHtml, runExportWeb, runFormat, runInit, runMerge, runPack, runPlay, runPropertyUsage, runReplace, runReport, runReportXlsx, runResolve, runScriptDoc, runSearch, runStatusBrowse, runTagBrowse, runUnpack, runUnpackMerge, runValidate, runVoiceScript, scanAudio, scanAudioStatus, sceneIdForShard, scriptToDocx, scriptToPdf, serialiseHandoff, setCut, sidecarIssues, staleParts, vcsConfigWrites, voiceScriptToXlsx, worldSettingsScopes, xlsxToCatalog };
+export { AUDIO_MANIFEST_FILE, AUDIO_MANIFEST_SCHEMA, AUTHORING_HANDLED, type ApplyStats, type AudioEntry, type AudioRung, type AudioSnapshot, type BuildPlan, type BundlePosture, CONFLICT_SIDECAR, type CharacterReport, type Conflict, type ConflictKind, type ContentError, type CoverageAsyncHooks, type CoverageBeat, type CoverageHooks, type CoverageOptions, type CoverageOrder, type CoverageReport, type DecisionPlan, type DecisionResult, type DocumentManifest, type EditableScript, type EditableScriptOptions, type ExportOptions, type FormatResult, GAME_SCOPES_OWNER, type GameScopes, type GameScopesIssue, HANDOFF_DIR, type HandoffIssue, type HygieneIssue, type ImportOptions, type ImportPlan, type ImportProblem, type ImportReport, type InitOptions, type InitResult, type InitVcs, type LoadedProject, type LocCatalog, type LocEntry, type LocaleReport, type MergeFileType, type MergeResult, type MergedShard, NotAPackError, type OpenSuggestion, PATTER_SCOPES_FILE, PATTER_SCOPES_OWNER, type PinPlan, type PinnedName, type PlannedWrite, type PlayEvent, type PlayOptions, type PlayOutcome, type PlayResult, type ProvenanceCheck, RARE_REACH_PCT, REFUSE_MISSING_SHARE, type Random, type ReadBox, type ReadComment, type ReadItem, type ReadMarker, type ReadParagraph, type ReadText, type ReplaceHit, type ReplaceOptions, type ReplacePlan, type ReportData, type ReportTotals, type ResolveEntry, type ReturnedDoc, SCRIPT_FONT_FILES, SCRIPT_FONT_PACKAGES, SHARD_EXTENSIONS, type SceneReport, type ScriptDoc, type ScriptElement, type ScriptFace, type SearchFocus, type SuggestionDecision, type TrackedChange, type UnpackMergeResult, type UnpackResult, UnsafeEntryError, UnsupportedMergeError, type ValidateResult, type VoiceLine, type VoiceScript, type VoicedCounts, type WebExport, type WrittenCounts, applyLoc, applySceneOrder, applySuggestionDecisions, applyWrites, audioFolderRungs, audioFoldersActive, audioManifest, audioManifestWrite, authoringPath, besideBundlePath, bundleOutputPath, catalogToJson, catalogToPo, catalogToXlsx, classesForChannel, compileLoaded, cueLabel, currentBundlePosture, defaultBundlePath, defaultGameScopesDir, detectMergeType, discoverGameScopes, drivableScopes, exportBlockers, exportEditableScript, extractLoc, findProjectFile, formatMarker, gameScopeTokens, gameScopesCatalogue, gameScopesSnapshot, handoffPath, handoffWrite, hostScopeTokens, issueMarkerCodes, jsonToCatalog, leastReachedFirst, listOpenSuggestions, listProjectTags, loadProject, loadProjectLanding, markerLength, newHandoffId, parseHandoff, patterScopesFile, patterScopesStale, patterScopesWrite, pickAudio, planBuild, planEditableImport, planPins, planReturnedWorld, planShareScopes, planWorldSave, poToCatalog, previewRegistry, projectStringSources, proposeCoverageDrivers, qualifierNamer, reachabilityIssues, readEditableDocx, readGameScopes, readHandoff, readHandoffs, readMarker, renderCoverageText, renderPlay, renderReportText, resolveDocumentation, resolveStart, runCoverage, runCoverageAsync, runExport, runExportFull, runExportHtml, runExportWeb, runFormat, runInit, runMerge, runPack, runPlay, runPropertyUsage, runReplace, runReport, runReportXlsx, runResolve, runScriptDoc, runSearch, runStatusBrowse, runTagBrowse, runUnpack, runUnpackMerge, runValidate, runVoiceScript, scanAudio, scanAudioStatus, sceneIdForShard, scriptFontLicencePath, scriptFontLicences, scriptToDocx, scriptToPdf, serialiseHandoff, setCut, sidecarIssues, staleParts, useScriptFontFiles, vcsConfigWrites, voiceScriptToXlsx, worldSettingsScopes, xlsxToCatalog };