@patterkit/ops 0.16.0 → 0.16.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/dist/index.d.ts +97 -1
- package/dist/index.js +171 -47
- package/package.json +11 -5
- package/dist/script-fonts-AQNQOADI.js +0 -20
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Ian Thomas
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.d.ts
CHANGED
|
@@ -1040,6 +1040,102 @@ declare function scriptToDocx(doc: ScriptDoc): Promise<Buffer>;
|
|
|
1040
1040
|
/** Render the readable screenplay as a PDF. Resolves once PDFKit has flushed the whole document. */
|
|
1041
1041
|
declare function scriptToPdf(doc: ScriptDoc): Promise<Buffer>;
|
|
1042
1042
|
|
|
1043
|
+
var serif = [
|
|
1044
|
+
"@fontsource/newsreader/files/newsreader-latin-400-normal.woff",
|
|
1045
|
+
"@fontsource/newsreader/files/newsreader-latin-ext-400-normal.woff",
|
|
1046
|
+
"@fontsource/newsreader/files/newsreader-vietnamese-400-normal.woff"
|
|
1047
|
+
];
|
|
1048
|
+
var serifBold = [
|
|
1049
|
+
"@fontsource/newsreader/files/newsreader-latin-600-normal.woff",
|
|
1050
|
+
"@fontsource/newsreader/files/newsreader-latin-ext-600-normal.woff",
|
|
1051
|
+
"@fontsource/newsreader/files/newsreader-vietnamese-600-normal.woff"
|
|
1052
|
+
];
|
|
1053
|
+
var serifItalic = [
|
|
1054
|
+
"@fontsource/newsreader/files/newsreader-latin-400-italic.woff",
|
|
1055
|
+
"@fontsource/newsreader/files/newsreader-latin-ext-400-italic.woff",
|
|
1056
|
+
"@fontsource/newsreader/files/newsreader-vietnamese-400-italic.woff"
|
|
1057
|
+
];
|
|
1058
|
+
var serifBoldItalic = [
|
|
1059
|
+
"@fontsource/newsreader/files/newsreader-latin-600-italic.woff",
|
|
1060
|
+
"@fontsource/newsreader/files/newsreader-latin-ext-600-italic.woff",
|
|
1061
|
+
"@fontsource/newsreader/files/newsreader-vietnamese-600-italic.woff"
|
|
1062
|
+
];
|
|
1063
|
+
var sans = [
|
|
1064
|
+
"@fontsource/inter/files/inter-latin-400-normal.woff",
|
|
1065
|
+
"@fontsource/inter/files/inter-latin-ext-400-normal.woff",
|
|
1066
|
+
"@fontsource/inter/files/inter-greek-400-normal.woff",
|
|
1067
|
+
"@fontsource/inter/files/inter-greek-ext-400-normal.woff",
|
|
1068
|
+
"@fontsource/inter/files/inter-cyrillic-400-normal.woff",
|
|
1069
|
+
"@fontsource/inter/files/inter-cyrillic-ext-400-normal.woff",
|
|
1070
|
+
"@fontsource/inter/files/inter-vietnamese-400-normal.woff"
|
|
1071
|
+
];
|
|
1072
|
+
var sansBold = [
|
|
1073
|
+
"@fontsource/inter/files/inter-latin-600-normal.woff",
|
|
1074
|
+
"@fontsource/inter/files/inter-latin-ext-600-normal.woff",
|
|
1075
|
+
"@fontsource/inter/files/inter-greek-600-normal.woff",
|
|
1076
|
+
"@fontsource/inter/files/inter-greek-ext-600-normal.woff",
|
|
1077
|
+
"@fontsource/inter/files/inter-cyrillic-600-normal.woff",
|
|
1078
|
+
"@fontsource/inter/files/inter-cyrillic-ext-600-normal.woff",
|
|
1079
|
+
"@fontsource/inter/files/inter-vietnamese-600-normal.woff"
|
|
1080
|
+
];
|
|
1081
|
+
var mono = [
|
|
1082
|
+
"@ibm/plex-mono/fonts/complete/woff/IBMPlexMono-Regular.woff"
|
|
1083
|
+
];
|
|
1084
|
+
var fallback = [
|
|
1085
|
+
"@fontsource/noto-sans/files/noto-sans-latin-400-normal.woff",
|
|
1086
|
+
"@fontsource/noto-sans/files/noto-sans-latin-ext-400-normal.woff",
|
|
1087
|
+
"@fontsource/noto-sans/files/noto-sans-greek-400-normal.woff",
|
|
1088
|
+
"@fontsource/noto-sans/files/noto-sans-greek-ext-400-normal.woff",
|
|
1089
|
+
"@fontsource/noto-sans/files/noto-sans-cyrillic-400-normal.woff",
|
|
1090
|
+
"@fontsource/noto-sans/files/noto-sans-cyrillic-ext-400-normal.woff",
|
|
1091
|
+
"@fontsource/noto-sans/files/noto-sans-vietnamese-400-normal.woff",
|
|
1092
|
+
"@fontsource/noto-sans/files/noto-sans-devanagari-400-normal.woff",
|
|
1093
|
+
"@fontsource/noto-sans-math/files/noto-sans-math-latin-400-normal.woff"
|
|
1094
|
+
];
|
|
1095
|
+
var emoji = [
|
|
1096
|
+
"@fontsource/noto-emoji/files/noto-emoji-emoji-400-normal.woff",
|
|
1097
|
+
"@fontsource/noto-emoji/files/noto-emoji-0-400-normal.woff",
|
|
1098
|
+
"@fontsource/noto-emoji/files/noto-emoji-1-400-normal.woff",
|
|
1099
|
+
"@fontsource/noto-emoji/files/noto-emoji-2-400-normal.woff",
|
|
1100
|
+
"@fontsource/noto-emoji/files/noto-emoji-3-400-normal.woff",
|
|
1101
|
+
"@fontsource/noto-emoji/files/noto-emoji-4-400-normal.woff",
|
|
1102
|
+
"@fontsource/noto-emoji/files/noto-emoji-5-400-normal.woff",
|
|
1103
|
+
"@fontsource/noto-emoji/files/noto-emoji-6-400-normal.woff",
|
|
1104
|
+
"@fontsource/noto-emoji/files/noto-emoji-7-400-normal.woff",
|
|
1105
|
+
"@fontsource/noto-emoji/files/noto-emoji-8-400-normal.woff",
|
|
1106
|
+
"@fontsource/noto-emoji/files/noto-emoji-9-400-normal.woff",
|
|
1107
|
+
"@fontsource/noto-emoji/files/noto-emoji-10-400-normal.woff"
|
|
1108
|
+
];
|
|
1109
|
+
var FACES = {
|
|
1110
|
+
serif: serif,
|
|
1111
|
+
serifBold: serifBold,
|
|
1112
|
+
serifItalic: serifItalic,
|
|
1113
|
+
serifBoldItalic: serifBoldItalic,
|
|
1114
|
+
sans: sans,
|
|
1115
|
+
sansBold: sansBold,
|
|
1116
|
+
mono: mono,
|
|
1117
|
+
fallback: fallback,
|
|
1118
|
+
emoji: emoji
|
|
1119
|
+
};
|
|
1120
|
+
|
|
1121
|
+
/** A face the PDF export registers: the design's three roles, plus the two fallbacks every role shares. */
|
|
1122
|
+
type ScriptFace = keyof typeof FACES;
|
|
1123
|
+
/** Each face's files, as module paths (`<package>/<file>`), in the order a character tries them. */
|
|
1124
|
+
declare const SCRIPT_FONT_FILES: Readonly<Record<ScriptFace, readonly string[]>>;
|
|
1125
|
+
/** The packages the faces come from, each of which carries the licence its fonts travel under. */
|
|
1126
|
+
declare const SCRIPT_FONT_PACKAGES: readonly string[];
|
|
1127
|
+
/** Read the files from these paths, keyed by module path, instead of resolving them from node_modules;
|
|
1128
|
+
* and the licences from `licencePaths`, keyed by package. For a bundle that embeds the files itself
|
|
1129
|
+
* (the standalone CLI, Patterpad). */
|
|
1130
|
+
declare function useScriptFontFiles(paths: Readonly<Record<string, string>>, licencePaths?: Readonly<Record<string, string>>): void;
|
|
1131
|
+
/** Where a font package's licence file is in node_modules (LICENSE, LICENSE.txt or OFL.txt). */
|
|
1132
|
+
declare function scriptFontLicencePath(pkg: string): string;
|
|
1133
|
+
/** Each font package's licence text, for a listing of what the PDF export embeds and under what terms. */
|
|
1134
|
+
declare function scriptFontLicences(): {
|
|
1135
|
+
package: string;
|
|
1136
|
+
text: string;
|
|
1137
|
+
}[];
|
|
1138
|
+
|
|
1043
1139
|
type InitVcs = "git" | "perforce" | "plastic" | "svn";
|
|
1044
1140
|
/** Whether the compiled `.patterc` bundle is committed or built in CI (spec §11). */
|
|
1045
1141
|
type BundlePosture = "commit" | "ignore";
|
|
@@ -1645,4 +1741,4 @@ declare const REFUSE_MISSING_SHARE = 0.25;
|
|
|
1645
1741
|
/** Plan an import. Reads the handoff record named in the document from the project. */
|
|
1646
1742
|
declare function planEditableImport(loaded: LoadedProject, returned: ReturnedDoc, opts: ImportOptions): ImportPlan;
|
|
1647
1743
|
|
|
1648
|
-
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 };
|
|
1744
|
+
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, 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, scriptFontLicencePath, scriptFontLicences, scriptToDocx, scriptToPdf, serialiseHandoff, setCut, sidecarIssues, staleParts, useScriptFontFiles, vcsConfigWrites, voiceScriptToXlsx, worldSettingsScopes, xlsxToCatalog };
|