@lincyaw/kernel 1.0.0-rc.5 → 1.0.0-rc.50
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/README.md +1 -1
- package/package.json +4 -2
- package/src/contracts/authoring-actions.ts +3 -3
- package/src/contracts/authoring-clients.ts +58 -1
- package/src/contracts/capture.ts +148 -0
- package/src/contracts/document-voice.ts +35 -2
- package/src/contracts/document.ts +14 -1
- package/src/contracts/plugin.ts +1 -3
- package/src/contracts/preview.ts +3 -3
- package/src/contracts/projects.ts +4 -1
- package/src/contracts/speech-settings.ts +13 -0
- package/src/contracts/speech.ts +16 -0
- package/src/contracts/voiceover-execution.ts +25 -1
- package/src/contracts/workspace-changes.ts +27 -0
- package/src/contracts/workspace-review.ts +39 -0
- package/src/contracts/workspace-source.ts +38 -0
- package/src/contracts/workspace.ts +2 -0
- package/src/contracts.ts +4 -0
- package/src/document-authoring-actions.ts +23 -4
- package/src/document-caption-scale.ts +17 -0
- package/src/document-comments.ts +30 -37
- package/src/document-components.ts +4 -12
- package/src/document-narrations.ts +57 -0
- package/src/document-operations.ts +15 -1
- package/src/document-pages.ts +8 -1
- package/src/document-places.ts +92 -0
- package/src/document-schema.ts +3 -3
- package/src/document.ts +13 -1
- package/src/embed.ts +26 -0
- package/src/escape-html.ts +4 -0
- package/src/html.ts +1 -4
- package/src/index.ts +15 -6
- package/src/ir.ts +23 -48
- package/src/lower-myst.ts +3 -12
- package/src/myst-marks.ts +15 -0
- package/src/node/authoring-actions.ts +3 -1
- package/src/node/document-voice.ts +6 -2
- package/src/node/fonts.ts +6 -3
- package/src/node/index.ts +8 -3
- package/src/node/operator-speech.ts +4 -0
- package/src/node/packages.ts +25 -0
- package/src/node/service-state.ts +52 -0
- package/src/node/workspace-changes.ts +7 -0
- package/src/node/workspace-review.ts +9 -0
- package/src/node/workspace-source.ts +10 -0
- package/src/preview-events.ts +6 -4
- package/src/preview-frame-connect.ts +1105 -0
- package/src/preview-frame.ts +30 -1120
- package/src/random-uuid.ts +8 -0
- package/src/stale-module.ts +15 -0
package/src/document.ts
CHANGED
|
@@ -3,6 +3,8 @@ import { DOCUMENT_JSON_SCHEMA } from './document-schema.ts'
|
|
|
3
3
|
import { isRecord } from './errors.ts'
|
|
4
4
|
import { captionSourceFingerprint, captionTimingProblem, stepCaptionText } from './document-caption-timings.ts'
|
|
5
5
|
import { validateDocumentParameters } from './parameters.ts'
|
|
6
|
+
import { isDocumentPlaceAnchor } from './contracts/document.ts'
|
|
7
|
+
import { documentBlockSection } from './document-places.ts'
|
|
6
8
|
import type { DocumentIssue, DocumentValidation, RichTextNode, TeachingDocument } from './contracts/document.ts'
|
|
7
9
|
|
|
8
10
|
export { DOCUMENT_JSON_SCHEMA } from './document-schema.ts'
|
|
@@ -240,7 +242,17 @@ export function validateDocument(value: unknown): DocumentValidation {
|
|
|
240
242
|
const path = at('/comments', id)
|
|
241
243
|
if (id !== thread.id) issue(`${path}/id`, 'id.key', 'A thread ID must match its map key.')
|
|
242
244
|
identify(thread.id, `${path}/id`)
|
|
243
|
-
|
|
245
|
+
const anchor = thread.anchor
|
|
246
|
+
if (anchor && isDocumentPlaceAnchor(anchor)) {
|
|
247
|
+
if (!Object.hasOwn(doc.blocks, anchor.blockId)) issue(`${path}/anchor/blockId`, 'comment.target', 'A place comment must name an existing block.')
|
|
248
|
+
else if (anchor.stepId !== undefined) {
|
|
249
|
+
const step = Object.hasOwn(doc.steps, anchor.stepId) ? doc.steps[anchor.stepId] : undefined
|
|
250
|
+
const section = step ? doc.sections[step.sectionId] : undefined
|
|
251
|
+
if (!step || !section || !section.stepOrder.includes(anchor.stepId) || step.sectionId !== documentBlockSection(doc, anchor.blockId)) issue(`${path}/anchor/stepId`, 'comment.target', 'A place comment must name a step of the block\'s own section.')
|
|
252
|
+
}
|
|
253
|
+
} else if (anchor) {
|
|
254
|
+
for (const edge of ['from', 'to'] as const) if (!textTargets.has(anchor[edge].blockId)) issue(`${path}/anchor/${edge}/blockId`, 'comment.target', 'A comment anchor must name a stable rich-text node or section title.')
|
|
255
|
+
}
|
|
244
256
|
for (const [index, comment] of thread.comments.entries()) {
|
|
245
257
|
identify(comment.id, `${path}/comments/${index}/id`)
|
|
246
258
|
comment.content?.forEach((node, child) => rich(node, `${path}/comments/${index}/content/${child}`, new Set()))
|
package/src/embed.ts
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* What a page tells the page that embeds it in a frame, as `postMessage` to its parent: whether its current slide is
|
|
3
|
+
* drawn (no component is still loading) and the state of its lecture. An embedding page (a site's home page playing a
|
|
4
|
+
* document's presentation) keeps its own cover until `drawn`, and offers Play when the lecture is `waiting`.
|
|
5
|
+
*/
|
|
6
|
+
export const EMBED_MESSAGE = 'presmium:state'
|
|
7
|
+
|
|
8
|
+
export type EmbeddedLecture = 'loading' | 'waiting' | 'playing' | 'paused' | 'failed'
|
|
9
|
+
|
|
10
|
+
export interface EmbedState {
|
|
11
|
+
type: typeof EMBED_MESSAGE
|
|
12
|
+
drawn: boolean
|
|
13
|
+
section?: string
|
|
14
|
+
step?: number
|
|
15
|
+
/** Absent when the page plays no lecture. `waiting`: the browser refused autoplay; the reader's Play starts it. */
|
|
16
|
+
lecture?: EmbeddedLecture
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
let last: EmbedState = { type: EMBED_MESSAGE, drawn: false }
|
|
20
|
+
|
|
21
|
+
/** Sends the page's state, merged with what was sent before, to the embedding page; nothing when not in a frame. */
|
|
22
|
+
export function notifyEmbedder(change: Partial<Omit<EmbedState, 'type'>>): void {
|
|
23
|
+
if (typeof window === 'undefined' || window.parent === window) return
|
|
24
|
+
last = { ...last, ...change }
|
|
25
|
+
window.parent.postMessage(last, '*')
|
|
26
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/** Text as it reads in HTML, in an element or an attribute's value; apart from `html.ts`, so that escaping loads no HTML parser. */
|
|
2
|
+
export function escapeHtml(text: string): string {
|
|
3
|
+
return text.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"')
|
|
4
|
+
}
|
package/src/html.ts
CHANGED
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
import { parseFragment } from 'parse5'
|
|
2
2
|
import type { DefaultTreeAdapterMap } from 'parse5'
|
|
3
|
-
|
|
4
|
-
export function escapeHtml(text: string): string {
|
|
5
|
-
return text.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"')
|
|
6
|
-
}
|
|
3
|
+
import { escapeHtml } from './escape-html.ts'
|
|
7
4
|
|
|
8
5
|
export interface HtmlAttribute {
|
|
9
6
|
name: string
|
package/src/index.ts
CHANGED
|
@@ -1,13 +1,16 @@
|
|
|
1
1
|
export * from './contracts.ts'
|
|
2
|
+
export { randomUUID } from './random-uuid.ts'
|
|
2
3
|
export { applyDocumentOperations } from './document-operations.ts'
|
|
4
|
+
export { replaceStepNarrations, replaceStepNarrationText } from './document-narrations.ts'
|
|
3
5
|
export { validateDocumentChange, DOCUMENT_CHANGE_JSON_SCHEMA } from './authoring.ts'
|
|
4
6
|
export { allocateDocumentPage, createDocumentPage, documentPageDefaults, DOCUMENT_PAGE_DEFAULT_TIMING, duplicateDocumentPage, moveDocumentPage, pageContents, pageDeletion, pageDeletionImpact, removeDocumentPage, renameDocumentPage } from './document-pages.ts'
|
|
5
7
|
export { documentOutline, documentPart, DocumentReadError } from './document-reads.ts'
|
|
6
8
|
export { changeDocumentVoice, documentVoiceStepIds, previewDocumentVoiceChange, resolveDocumentStepVoice } from './document-voices.ts'
|
|
7
9
|
export { DOCUMENT_COLOR_NAMES, documentColorToken, documentColorValue } from './document-colors.ts'
|
|
8
10
|
export type { DocumentColorKind, DocumentColorName } from './document-colors.ts'
|
|
9
|
-
export { applyDocumentCommentAction, isDocumentTextLink, documentCommentTargets, validateDocumentCommentAnchor, DocumentCommentError } from './document-comments.ts'
|
|
10
|
-
export {
|
|
11
|
+
export { applyDocumentCommentAction, degradeDocumentCommentAnchor, isDocumentTextLink, documentCommentTargets, validateDocumentCommentAnchor, DocumentCommentError } from './document-comments.ts'
|
|
12
|
+
export { documentAnchorKey, documentAnchorOrder, documentBlockSection, walkDocumentPlaces } from './document-places.ts'
|
|
13
|
+
export { applyDocumentAuthoringAction, enableDocumentProduction } from './document-authoring-actions.ts'
|
|
11
14
|
export { applyDocumentComponentAction, effectiveComponentParameters, createDocumentParameterChanges, documentComponentSection, DocumentComponentError } from './document-components.ts'
|
|
12
15
|
export type { DocumentStepVoice, DocumentVoiceImpact, DocumentVoiceOptions, DocumentVoiceScope } from './document-voices.ts'
|
|
13
16
|
export { prepareTranscriptionAdoption } from './transcription-adoption.ts'
|
|
@@ -25,12 +28,14 @@ export { errorMessage, isRecord, PreviewPreparing } from './errors.ts'
|
|
|
25
28
|
export { createEventBus } from './events.ts'
|
|
26
29
|
export { CREDENTIAL_VARIABLE, environmentExecutor, failedRun, languageId } from './execution.ts'
|
|
27
30
|
export { gitConfigArgs, gitEnvironment } from './git.ts'
|
|
28
|
-
export { escapeHtml
|
|
31
|
+
export { escapeHtml } from './escape-html.ts'
|
|
32
|
+
export { htmlAttributes, mapHtmlUrls, URL_ATTRIBUTES } from './html.ts'
|
|
29
33
|
export type { HtmlAttribute } from './html.ts'
|
|
30
34
|
export { hostName, localRequestRefusal } from './requests.ts'
|
|
31
35
|
export type { RequestHeaders } from './requests.ts'
|
|
32
36
|
export { fingerprint, fnv1a64 } from './fingerprint.ts'
|
|
33
37
|
export { applyDocumentCaptionTiming, captionSourceFingerprint, captionTimingProblem, stepCaptionText, narrationCaptionText, CAPTION_TIMING_MAX_SEGMENTS, DocumentCaptionTimingError } from './document-caption-timings.ts'
|
|
38
|
+
export { captionScale, changeDocumentCaptionScale } from './document-caption-scale.ts'
|
|
34
39
|
export type { DocumentCaptionTimingAction } from './document-caption-timings.ts'
|
|
35
40
|
export { backSection, followedPlace } from './follow.ts'
|
|
36
41
|
export type { FollowAnchor } from './follow.ts'
|
|
@@ -39,9 +44,13 @@ export type { KernelOptions } from './kernel.ts'
|
|
|
39
44
|
export { deckLocale, localeOf } from './locale.ts'
|
|
40
45
|
export { ANCHOR_LOCK_PATH, AnchorLock } from './lock.ts'
|
|
41
46
|
export { prefixedLogger } from './logging.ts'
|
|
42
|
-
export { lowerMyst
|
|
47
|
+
export { lowerMyst } from './lower-myst.ts'
|
|
43
48
|
export type { LinkedType, LoweredMarkdown, LowerOptions } from './lower-myst.ts'
|
|
44
|
-
export {
|
|
49
|
+
export { isPreviewActive, isPreviewEmbedded, previewAppearance, reportPreview, siteFrameAncestors } from './preview-frame.ts'
|
|
50
|
+
export { connectPreviewFrame } from './preview-frame-connect.ts'
|
|
51
|
+
export { reportStaleModule, STALE_MODULE_EVENT, STALE_MODULE_PATTERN } from './stale-module.ts'
|
|
52
|
+
export { EMBED_MESSAGE, notifyEmbedder } from './embed.ts'
|
|
53
|
+
export type { EmbeddedLecture, EmbedState } from './embed.ts'
|
|
45
54
|
export { keyBelongsToTarget, watchFocusSource } from './keyboard.ts'
|
|
46
55
|
export type { PreviewFrame, PreviewPage, PreviewProblem, PreviewTextEdit, PreviewTextHandle } from './preview-frame.ts'
|
|
47
56
|
export { previewEditBinding } from './preview-edit.ts'
|
|
@@ -65,7 +74,7 @@ export type { StepKeys } from './step-keys.ts'
|
|
|
65
74
|
export { parseDuration } from './durations.ts'
|
|
66
75
|
export { stepStateAt } from './steps.ts'
|
|
67
76
|
export { ABSOLUTE_URL, NON_FILE_URL, urlSlug } from './urls.ts'
|
|
68
|
-
export { isButton } from './
|
|
77
|
+
export { isButton, roleMark } from './myst-marks.ts'
|
|
69
78
|
export { componentProps, findComponentRenderer, hasRendererExtension, WEB_RENDERER_PACKAGE, withPublishedAssets } from './renderer-components.ts'
|
|
70
79
|
export { htmlAsText, isProseRun } from './run-outputs.ts'
|
|
71
80
|
export { safeDecodeURIComponent } from './uri-decoding.ts'
|
package/src/ir.ts
CHANGED
|
@@ -168,46 +168,7 @@ export interface ComponentNode {
|
|
|
168
168
|
layer?: 'overlay'
|
|
169
169
|
durations?: number[]
|
|
170
170
|
/** The authored code that defines this component instance, when supplied by its plugin. */
|
|
171
|
-
definition?: { file: string, language: string, exportName?: string }
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
export type DirectiveOptionType = 'string' | 'number' | 'boolean' | 'list'
|
|
175
|
-
|
|
176
|
-
export interface DirectiveInput {
|
|
177
|
-
name: string
|
|
178
|
-
arg?: string
|
|
179
|
-
options: Record<string, unknown>
|
|
180
|
-
body: string
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
export interface DirectiveContext {
|
|
184
|
-
file: string
|
|
185
|
-
deckDir: string
|
|
186
|
-
workspaceRoot: string
|
|
187
|
-
lang?: string
|
|
188
|
-
config: Record<string, unknown>
|
|
189
|
-
source: SourcePos
|
|
190
|
-
parse(markdown: string): MdastNode
|
|
191
|
-
report(finding: Finding): void
|
|
192
|
-
watch(...files: string[]): void
|
|
193
|
-
}
|
|
194
|
-
|
|
195
|
-
export interface DirectiveResult {
|
|
196
|
-
node: IRNode
|
|
197
|
-
role?: BlockRole
|
|
198
|
-
span?: number
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
export interface RoleInput {
|
|
202
|
-
name: string
|
|
203
|
-
value: string
|
|
204
|
-
options: Record<string, unknown>
|
|
205
|
-
}
|
|
206
|
-
|
|
207
|
-
export interface RoleSpec {
|
|
208
|
-
name: string
|
|
209
|
-
options?: Record<string, DirectiveOptionType>
|
|
210
|
-
children?(input: RoleInput, ctx: DirectiveContext): MdastNode[]
|
|
171
|
+
definition?: { file: string, language: string, exportName?: string, kind?: string }
|
|
211
172
|
}
|
|
212
173
|
|
|
213
174
|
export interface PresmiumRoleNode extends MdastNode {
|
|
@@ -218,14 +179,6 @@ export interface PresmiumRoleNode extends MdastNode {
|
|
|
218
179
|
children: MdastNode[]
|
|
219
180
|
}
|
|
220
181
|
|
|
221
|
-
export interface DirectiveSpec {
|
|
222
|
-
name: string
|
|
223
|
-
arg?: boolean | 'anchor'
|
|
224
|
-
body?: boolean
|
|
225
|
-
options?: Record<string, DirectiveOptionType>
|
|
226
|
-
toIR(input: DirectiveInput, ctx: DirectiveContext): DirectiveResult | Promise<DirectiveResult>
|
|
227
|
-
}
|
|
228
|
-
|
|
229
182
|
export interface RunCache {
|
|
230
183
|
get(key: string): RecordedRun | undefined
|
|
231
184
|
set(key: string, run: RecordedRun): void
|
|
@@ -318,6 +271,11 @@ export interface Renderer {
|
|
|
318
271
|
dev?(doc: IRDocument, ctx: RenderContext): Promise<RenderDevServer>
|
|
319
272
|
buildSite?(site: SiteSpec, ctx: RenderContext): Promise<RenderOutput>
|
|
320
273
|
devSite?(site: SiteSpec, ctx: RenderContext, compile: (dir: string) => Promise<IRDocument>): Promise<SiteDevServer>
|
|
274
|
+
/**
|
|
275
|
+
* What would fail in its output of the whole document (every form's blocks), found ahead of a build: run with the
|
|
276
|
+
* document's checks (`presmium check`). The web renderer's: the document's own code that does not bundle.
|
|
277
|
+
*/
|
|
278
|
+
check?(doc: IRDocument, ctx: RenderContext): Promise<Finding[]>
|
|
321
279
|
}
|
|
322
280
|
|
|
323
281
|
export interface SiteDocument {
|
|
@@ -326,11 +284,23 @@ export interface SiteDocument {
|
|
|
326
284
|
description?: string
|
|
327
285
|
lang?: string
|
|
328
286
|
tags?: string[]
|
|
287
|
+
/** Whether it has a presentation, before its IR is compiled (`DocumentSummary.slides`). */
|
|
288
|
+
slides?: boolean
|
|
329
289
|
doc?: IRDocument
|
|
330
290
|
translations?: { lang: string, doc: IRDocument }[]
|
|
331
291
|
nodeVitePlugins?: NodeVitePlugin[]
|
|
332
292
|
}
|
|
333
293
|
|
|
294
|
+
/**
|
|
295
|
+
* A built site keeps its viewer apps below its path, each at `<APP_DIR>/<key>/` by its content. A presentation built as
|
|
296
|
+
* part of a site (renderer option `appBase`, the site's path) names its app there, so the site's pages and all its
|
|
297
|
+
* presentations load one app.
|
|
298
|
+
*/
|
|
299
|
+
export const APP_DIR = '_app'
|
|
300
|
+
|
|
301
|
+
/** A site serves a document's presentation (`renderers.slides`) below the document's pages, at `<document>/<SLIDES_DIR>/`. */
|
|
302
|
+
export const SLIDES_DIR = 'slides'
|
|
303
|
+
|
|
334
304
|
export interface SiteSpec {
|
|
335
305
|
title: string
|
|
336
306
|
documents: SiteDocument[]
|
|
@@ -352,6 +322,11 @@ export interface SiteDevServer {
|
|
|
352
322
|
* With `wait`, a build still running after the wait rejects with `PreviewPreparing`; a failed build with its reason.
|
|
353
323
|
*/
|
|
354
324
|
app?(dir: string, wait?: boolean): Promise<string | undefined>
|
|
325
|
+
/**
|
|
326
|
+
* The files of document `dir`'s own code that the bundle its pages load now leaves out, since they do not bundle:
|
|
327
|
+
* each module that imports one fails alone when the document shows it (`app` rejects when the whole does not bundle).
|
|
328
|
+
*/
|
|
329
|
+
codeFindings?(dir: string): Finding[]
|
|
355
330
|
close(): Promise<void>
|
|
356
331
|
}
|
|
357
332
|
|
package/src/lower-myst.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import { escapeHtml as escape
|
|
1
|
+
import { escapeHtml as escape } from './escape-html.ts'
|
|
2
|
+
import { mapHtmlUrls } from './html.ts'
|
|
3
|
+
import { isButton, roleMark } from './myst-marks.ts'
|
|
2
4
|
import type { MdastNode } from './ir.ts'
|
|
3
5
|
|
|
4
6
|
export type LinkedType = 'image' | 'link' | 'definition'
|
|
@@ -198,11 +200,6 @@ function cardsAs(options: LowerOptions): 'element' | 'headings' {
|
|
|
198
200
|
return options.cards ?? (options.iframes === 'element' ? 'element' : 'headings')
|
|
199
201
|
}
|
|
200
202
|
|
|
201
|
-
/** Whether a MyST node has the class `button`, which renders a link or span as a button. */
|
|
202
|
-
export function isButton(node: MdastNode): boolean {
|
|
203
|
-
return typeof node.class === 'string' && node.class.split(/\s+/).includes('button')
|
|
204
|
-
}
|
|
205
|
-
|
|
206
203
|
function layout(node: MdastNode, ctx: Lowering): MdastNode[] {
|
|
207
204
|
const all = (nodes: MdastNode[] = []) => nodes.flatMap(child => lower(child, ctx))
|
|
208
205
|
const element = cardsAs(ctx.options) === 'element'
|
|
@@ -248,12 +245,6 @@ function layout(node: MdastNode, ctx: Lowering): MdastNode[] {
|
|
|
248
245
|
return all(items)
|
|
249
246
|
}
|
|
250
247
|
|
|
251
|
-
export function roleMark(node: MdastNode): string {
|
|
252
|
-
const options = typeof node.options === 'object' && node.options !== null ? node.options as Record<string, unknown> : {}
|
|
253
|
-
const value = typeof options.value === 'string' ? options.value.trim() : ''
|
|
254
|
-
return `〔${String(node.name ?? '')}${value ? ` ${value}` : ''}〕`
|
|
255
|
-
}
|
|
256
|
-
|
|
257
248
|
function footnoteNumber(node: MdastNode): string {
|
|
258
249
|
return String(node.enumerator ?? node.label ?? node.identifier)
|
|
259
250
|
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { MdastNode } from './ir.ts'
|
|
2
|
+
|
|
3
|
+
// What a viewer reads from MyST nodes as they are, apart from their lowering (`lower-myst.ts`), which rewrites HTML.
|
|
4
|
+
|
|
5
|
+
/** Whether a MyST node has the class `button`, which renders a link or span as a button. */
|
|
6
|
+
export function isButton(node: MdastNode): boolean {
|
|
7
|
+
return typeof node.class === 'string' && node.class.split(/\s+/).includes('button')
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
/** The mark a role without content shows: its name and value. */
|
|
11
|
+
export function roleMark(node: MdastNode): string {
|
|
12
|
+
const options = typeof node.options === 'object' && node.options !== null ? node.options as Record<string, unknown> : {}
|
|
13
|
+
const value = typeof options.value === 'string' ? options.value.trim() : ''
|
|
14
|
+
return `〔${String(node.name ?? '')}${value ? ` ${value}` : ''}〕`
|
|
15
|
+
}
|
|
@@ -24,7 +24,7 @@ export const DOCUMENT_AUTHORING_ACTION_SCHEMA: Schema = {
|
|
|
24
24
|
...object({ id, source: DOCUMENT_PAGE_DUPLICATION_SCHEMA.properties.source as unknown as Schema, action: { $ref: '#/$defs/AuthoringAction' } }),
|
|
25
25
|
$defs: { ...(structuredClone(DOCUMENT_JSON_SCHEMA) as Exclude<Schema, boolean>).$defs,
|
|
26
26
|
AuthoringAction: { oneOf: [
|
|
27
|
-
action('comment.create', { content, anchor: { oneOf: [{ type: 'null' }, object({ from: { $ref: '#/$defs/TextPoint' }, to: { $ref: '#/$defs/TextPoint' } })] }, metadata, commentMetadata: metadata }, ['content', 'anchor']),
|
|
27
|
+
action('comment.create', { content, anchor: { oneOf: [{ type: 'null' }, object({ from: { $ref: '#/$defs/TextPoint' }, to: { $ref: '#/$defs/TextPoint' } }), object({ blockId: id, stepId: id }, ['blockId'])] }, metadata, commentMetadata: metadata }, ['content', 'anchor']),
|
|
28
28
|
action('comment.reply', { threadId: id, content, metadata }, ['threadId', 'content']),
|
|
29
29
|
action('comment.update', { threadId: id, commentId: id, content, metadata }, ['threadId', 'commentId', 'content']),
|
|
30
30
|
action('comment.react', { threadId: id, commentId: id, emoji: { type: 'string', minLength: 1, maxLength: 32 }, active: { type: 'boolean' } }),
|
|
@@ -33,6 +33,8 @@ export const DOCUMENT_AUTHORING_ACTION_SCHEMA: Schema = {
|
|
|
33
33
|
action('voice.set', { scope, source: voice, replaceOverrides: { type: 'boolean' } }, ['scope', 'source']),
|
|
34
34
|
action('caption.timing.set', { stepId: id, value: { $ref: '#/$defs/CaptionTiming' } }),
|
|
35
35
|
action('caption.timing.reset', { stepId: id }),
|
|
36
|
+
action('caption.scale.set', { scale: { type: 'number' } }),
|
|
37
|
+
action('production.enable', {}),
|
|
36
38
|
action('component.parameters.patch', { blockId: id, changes }),
|
|
37
39
|
action('component.step-parameters.patch', { blockId: id, stepId: id, changes }),
|
|
38
40
|
action('component.step-parameters.reset', { blockId: id, stepId: id }),
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import { Validator } from '@cfworker/json-schema'
|
|
2
2
|
import type { Schema } from '@cfworker/json-schema'
|
|
3
|
-
import { DOCUMENT_VOICE_CATALOG_SCHEMA } from '../contracts/document-voice.ts'
|
|
4
|
-
import type { DocumentVoiceCatalogQuery } from '../contracts/document-voice.ts'
|
|
3
|
+
import { DOCUMENT_VOICE_CATALOG_SCHEMA, DOCUMENT_VOICE_CLONE_SCHEMA, DOCUMENT_VOICE_CLONE_QUERY_SCHEMA } from '../contracts/document-voice.ts'
|
|
4
|
+
import type { DocumentVoiceCatalogQuery, DocumentVoiceCloneRequest, DocumentVoiceCloneQuery } from '../contracts/document-voice.ts'
|
|
5
5
|
|
|
6
6
|
const validator = new Validator(structuredClone(DOCUMENT_VOICE_CATALOG_SCHEMA) as unknown as Schema, '2020-12', false)
|
|
7
7
|
export const validateDocumentVoiceCatalogQuery = (value: unknown): value is DocumentVoiceCatalogQuery => validator.validate(value).valid
|
|
8
|
+
const clone = new Validator(structuredClone(DOCUMENT_VOICE_CLONE_SCHEMA), '2020-12', false)
|
|
9
|
+
const cloneQuery = new Validator(structuredClone(DOCUMENT_VOICE_CLONE_QUERY_SCHEMA), '2020-12', false)
|
|
10
|
+
export const validateDocumentVoiceClone = (value: unknown): value is DocumentVoiceCloneRequest => clone.validate(value).valid
|
|
11
|
+
export const validateDocumentVoiceCloneQuery = (value: unknown): value is DocumentVoiceCloneQuery => cloneQuery.validate(value).valid
|
package/src/node/fonts.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { readFileSync } from 'node:fs'
|
|
1
|
+
import { readFileSync, realpathSync } from 'node:fs'
|
|
2
2
|
import { createRequire, findPackageJSON } from 'node:module'
|
|
3
3
|
|
|
4
4
|
export const FONT_LICENSE = 'presmium/fonts/LICENSE'
|
|
@@ -10,8 +10,11 @@ const FONT_COPYRIGHTS: Record<string, string> = {
|
|
|
10
10
|
}
|
|
11
11
|
|
|
12
12
|
export function fontLicense(from: string | URL): string {
|
|
13
|
-
const
|
|
14
|
-
if (!
|
|
13
|
+
const found = findPackageJSON('@lincyaw/host', from)
|
|
14
|
+
if (!found) throw new Error('@lincyaw/host is not installed')
|
|
15
|
+
// findPackageJSON keeps the symlinked path; the fonts are host's own dependencies, which an isolated store (pnpm's
|
|
16
|
+
// global store) puts beside the real package, so they are resolved from there.
|
|
17
|
+
const manifest = realpathSync(found)
|
|
15
18
|
const { dependencies = {} } = JSON.parse(readFileSync(manifest, 'utf8')) as { dependencies?: Record<string, string> }
|
|
16
19
|
const require = createRequire(manifest)
|
|
17
20
|
const files = Object.keys(dependencies).filter(name => name.startsWith('@fontsource/')).sort().map((name) => {
|
package/src/node/index.ts
CHANGED
|
@@ -5,12 +5,12 @@ export { validateDocumentOutlineQuery, validateDocumentPartQuery } from './docum
|
|
|
5
5
|
export { DOCUMENT_AUTHORING_ACTION_SCHEMA, DOCUMENT_AUTHORING_ACTION_APPLY_SCHEMA, DOCUMENT_AUTHORING_ACTION_IMPACT_SCHEMA, validateDocumentAuthoringAction, validateDocumentAuthoringActionReference, validateDocumentAuthoringActionImpact } from './authoring-actions.ts'
|
|
6
6
|
export { validateDocumentTranscriptionRequest } from './transcription.ts'
|
|
7
7
|
export { validateDocumentRecordingAdoption, validateDocumentAudioInspect, validateDocumentWorkspaceAudioImport, validateDocumentWorkspaceAudioInspect, validateDocumentMediaClipValidation, validateDocumentMediaClipEdit, validateDocumentProductionPlanQuery } from './document-audio.ts'
|
|
8
|
-
export { validateDocumentVoiceCatalogQuery } from './document-voice.ts'
|
|
8
|
+
export { validateDocumentVoiceCatalogQuery, validateDocumentVoiceClone, validateDocumentVoiceCloneQuery } from './document-voice.ts'
|
|
9
9
|
export { createVoiceoverOwner, VoiceoverOperationError, validateVoiceoverStart, validateVoiceoverStatus, validateVoiceoverJobQuery, validateVoicePreviewCheck, validateVoicePreviewStart } from './voiceover.ts'
|
|
10
10
|
export { createVoiceoverRoutes } from './voiceover-routes.ts'
|
|
11
11
|
export { validateTranscriptionAdoptionDraft, validateTranscriptionAdoptionApply } from './transcription-adoption.ts'
|
|
12
12
|
export { FONT_LICENSE, fontLicense } from './fonts.ts'
|
|
13
|
-
export { findPackageBin, importSpecifier, literalGlob, packageOf, playwrightChromium, TYPESCRIPT_IMPORT } from './packages.ts'
|
|
13
|
+
export { findPackageBin, importSpecifier, literalGlob, packageExport, packageOf, playwrightChromium, TYPESCRIPT_IMPORT } from './packages.ts'
|
|
14
14
|
export { ffmpegInstallCommand, findFfmpeg } from './ffmpeg.ts'
|
|
15
15
|
export type { Ffmpeg } from './ffmpeg.ts'
|
|
16
16
|
export { bracketIPv6, lanAddresses } from './network.ts'
|
|
@@ -26,4 +26,9 @@ export { validateAuthoringClientRequest, validateAuthoringClientQuery, validateA
|
|
|
26
26
|
export { validateProjectPlan, validateProjectApply } from './projects.ts'
|
|
27
27
|
export { validateDocumentWorkspaceImageInspect, validateDocumentWorkspaceImageImport } from './document-image.ts'
|
|
28
28
|
export { systemLocale } from './locale.ts'
|
|
29
|
-
export { OperatorSpeechSettings, operatorSpeechSecrets, SpeechSettingsError } from './operator-speech.ts'
|
|
29
|
+
export { OperatorSpeechSettings, operatorSpeechSecrets, SpeechSettingsError, validateSpeechSettingsChange } from './operator-speech.ts'
|
|
30
|
+
export { devStateFile, readServiceState, removeServiceState, serveStateDir } from './service-state.ts'
|
|
31
|
+
export type { ServiceState } from './service-state.ts'
|
|
32
|
+
export { validateWorkspaceReviewQuery, validateWorkspaceReviewChange } from './workspace-review.ts'
|
|
33
|
+
export { validateSourceList, validateSourceRead, validateSourceEdit } from './workspace-source.ts'
|
|
34
|
+
export { validateChangesQuery, validateWorkspaceChangesRequest } from './workspace-changes.ts'
|
|
@@ -2,10 +2,14 @@ import { createRequire } from 'node:module'
|
|
|
2
2
|
import { randomUUID } from 'node:crypto'
|
|
3
3
|
import { constants, closeSync, fstatSync, lstatSync, mkdirSync, openSync, readFileSync, renameSync, rmSync, writeFileSync } from 'node:fs'
|
|
4
4
|
import { dirname, join } from 'node:path'
|
|
5
|
+
import { Validator } from '@cfworker/json-schema'
|
|
6
|
+
import { SPEECH_SETTINGS_CHANGE_SCHEMA } from '../contracts/speech-settings.ts'
|
|
5
7
|
import type { SpeechSettingsAnswer, SpeechSettingsChange } from '../contracts/speech-settings.ts'
|
|
6
8
|
|
|
7
9
|
const KEY = 'PRESMIUM_SPEECH_VOLCENGINE_KEY', APPID = 'PRESMIUM_SPEECH_VOLCENGINE_APPID'
|
|
8
10
|
const MAX_BYTES = 16384
|
|
11
|
+
const settingsChangeValidator = new Validator(structuredClone(SPEECH_SETTINGS_CHANGE_SCHEMA), '2020-12', false)
|
|
12
|
+
export const validateSpeechSettingsChange = (value: unknown): value is SpeechSettingsChange => settingsChangeValidator.validate(value).valid
|
|
9
13
|
const lockfile = createRequire(import.meta.url)('proper-lockfile') as { lock(file: string, options: { realpath: boolean, retries: number }): Promise<() => Promise<void>> }
|
|
10
14
|
interface Stored { version: 1, revision: string, key?: string, appId?: string }
|
|
11
15
|
const empty = (): Stored => ({ version: 1, revision: 'none' })
|
package/src/node/packages.ts
CHANGED
|
@@ -2,6 +2,31 @@ import { existsSync, readFileSync } from 'node:fs'
|
|
|
2
2
|
import { createRequire, findPackageJSON } from 'node:module'
|
|
3
3
|
import { dirname, isAbsolute, join, relative, sep } from 'node:path'
|
|
4
4
|
import { pathToFileURL } from 'node:url'
|
|
5
|
+
import { exports as resolveExports } from 'resolve.exports'
|
|
6
|
+
|
|
7
|
+
/** Resolve a public package export with Node or browser conditions, retaining package-relative target validation. */
|
|
8
|
+
export function packageExport(pkg: { name?: unknown, exports?: unknown }, dir: string, subpath: string, options: { browser?: boolean } = {}): string | undefined {
|
|
9
|
+
let targets: string[] | void
|
|
10
|
+
try {
|
|
11
|
+
targets = resolveExports(pkg as Parameters<typeof resolveExports>[0], subpath, options)
|
|
12
|
+
} catch {
|
|
13
|
+
return undefined
|
|
14
|
+
}
|
|
15
|
+
if (!targets?.length) return undefined
|
|
16
|
+
const base = pathToFileURL(`${dir}/`)
|
|
17
|
+
for (const target of targets) {
|
|
18
|
+
const path = target.split(/[?#]/, 1)[0]!
|
|
19
|
+
if (!path.startsWith('./') || /%2f|%5c/i.test(path)) continue
|
|
20
|
+
try {
|
|
21
|
+
const segments = path.slice(2).split(/[\\/]/).map(decodeURIComponent)
|
|
22
|
+
if (segments.some(segment => /^(?:\.{1,2}|node_modules)$/i.test(segment))) continue
|
|
23
|
+
if (new URL(target, base).href.startsWith(base.href)) return target
|
|
24
|
+
} catch {
|
|
25
|
+
// An export array may contain another valid package-relative target.
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
throw new Error(`${subpath} has no valid package-relative target`)
|
|
29
|
+
}
|
|
5
30
|
|
|
6
31
|
export const TYPESCRIPT_IMPORT: readonly string[] = ['--import', new URL('./strip-types.mjs', import.meta.url).href]
|
|
7
32
|
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { createHash } from 'node:crypto'
|
|
2
|
+
import { readFileSync, rmSync } from 'node:fs'
|
|
3
|
+
import { homedir } from 'node:os'
|
|
4
|
+
import { join } from 'node:path'
|
|
5
|
+
import { isRecord } from '../errors.ts'
|
|
6
|
+
|
|
7
|
+
/** What a running Presmium server records for local clients: its address, its MCP endpoint and token, its process. */
|
|
8
|
+
export interface ServiceState {
|
|
9
|
+
url: string
|
|
10
|
+
mcp: string
|
|
11
|
+
token: string
|
|
12
|
+
pid: number
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/** The state directory of the workspace service (`presmium serve`, and the one `presmium studio` starts) of `root`. */
|
|
16
|
+
export function serveStateDir(root: string, env: NodeJS.ProcessEnv = process.env): string {
|
|
17
|
+
const base = env.XDG_CACHE_HOME || join(homedir(), '.cache')
|
|
18
|
+
return join(base, 'presmium', 'serve', createHash('sha256').update(root).digest('hex').slice(0, 16))
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
/** The state file `presmium dev` writes beside the document it previews. */
|
|
22
|
+
export function devStateFile(deckDir: string): string {
|
|
23
|
+
return join(deckDir, '.presmium', 'server.json')
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
const alive = (pid: number): boolean => {
|
|
27
|
+
try {
|
|
28
|
+
process.kill(pid, 0)
|
|
29
|
+
return true
|
|
30
|
+
} catch (error) {
|
|
31
|
+
return (error as NodeJS.ErrnoException).code === 'EPERM'
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/** The state of the server that wrote `file`, while that process runs. */
|
|
36
|
+
export function readServiceState(file: string): ServiceState | undefined {
|
|
37
|
+
try {
|
|
38
|
+
const state: unknown = JSON.parse(readFileSync(file, 'utf8'))
|
|
39
|
+
if (!isRecord(state) || typeof state.url !== 'string' || typeof state.mcp !== 'string' || typeof state.token !== 'string' || typeof state.pid !== 'number') return undefined
|
|
40
|
+
return alive(state.pid) ? { url: state.url, mcp: state.mcp, token: state.token, pid: state.pid } : undefined
|
|
41
|
+
} catch {
|
|
42
|
+
return undefined
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/** Removes `file` when it is still this process's: a server that stopped leaves no address behind. */
|
|
47
|
+
export function removeServiceState(file: string, pid = process.pid): void {
|
|
48
|
+
try {
|
|
49
|
+
const state: unknown = JSON.parse(readFileSync(file, 'utf8'))
|
|
50
|
+
if (isRecord(state) && state.pid === pid) rmSync(file, { force: true })
|
|
51
|
+
} catch {}
|
|
52
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Validator } from '@cfworker/json-schema'
|
|
2
|
+
import type { Schema } from '@cfworker/json-schema'
|
|
3
|
+
import { CHANGES_QUERY_SCHEMA, CHANGES_REQUEST_SCHEMA } from '../contracts/workspace-changes.ts'
|
|
4
|
+
import type { ChangesQuery, WorkspaceChangesRequest } from '../contracts/workspace-changes.ts'
|
|
5
|
+
const query = new Validator(CHANGES_QUERY_SCHEMA as unknown as Schema), change = new Validator(CHANGES_REQUEST_SCHEMA as unknown as Schema)
|
|
6
|
+
export const validateChangesQuery = (value: unknown): value is ChangesQuery => query.validate(value).valid
|
|
7
|
+
export const validateWorkspaceChangesRequest = (value: unknown): value is WorkspaceChangesRequest => change.validate(value).valid
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Validator } from '@cfworker/json-schema'
|
|
2
|
+
import type { Schema } from '@cfworker/json-schema'
|
|
3
|
+
import { WORKSPACE_REVIEW_CHANGE_SCHEMA, WORKSPACE_REVIEW_QUERY_SCHEMA } from '../contracts/workspace-review.ts'
|
|
4
|
+
import type { WorkspaceReviewChange, WorkspaceReviewQuery } from '../contracts/workspace-review.ts'
|
|
5
|
+
|
|
6
|
+
const query = new Validator(WORKSPACE_REVIEW_QUERY_SCHEMA as unknown as Schema)
|
|
7
|
+
const change = new Validator(WORKSPACE_REVIEW_CHANGE_SCHEMA as unknown as Schema)
|
|
8
|
+
export const validateWorkspaceReviewQuery = (value: unknown): value is WorkspaceReviewQuery => query.validate(value).valid
|
|
9
|
+
export const validateWorkspaceReviewChange = (value: unknown): value is WorkspaceReviewChange => change.validate(value).valid
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { Validator } from '@cfworker/json-schema'
|
|
2
|
+
import type { Schema } from '@cfworker/json-schema'
|
|
3
|
+
import { SOURCE_EDIT_SCHEMA, SOURCE_LIST_SCHEMA, SOURCE_READ_SCHEMA } from '../contracts/workspace-source.ts'
|
|
4
|
+
import type { SourceEdit, SourceListQuery, SourceReadQuery } from '../contracts/workspace-source.ts'
|
|
5
|
+
const list = new Validator(SOURCE_LIST_SCHEMA as unknown as Schema)
|
|
6
|
+
const read = new Validator(SOURCE_READ_SCHEMA as unknown as Schema)
|
|
7
|
+
const edit = new Validator(SOURCE_EDIT_SCHEMA as unknown as Schema)
|
|
8
|
+
export const validateSourceList = (value: unknown): value is SourceListQuery => list.validate(value).valid
|
|
9
|
+
export const validateSourceRead = (value: unknown): value is SourceReadQuery => read.validate(value).valid
|
|
10
|
+
export const validateSourceEdit = (value: unknown): value is SourceEdit => edit.validate(value).valid
|
package/src/preview-events.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { PREVIEW_EVENTS_PARAM, previewEnvelope } from './contracts/preview.ts'
|
|
2
2
|
import type { PreviewCommand, PreviewEventSubscription, PreviewEventTarget, PreviewEventMessage } from './contracts/preview.ts'
|
|
3
|
-
import { previewNonce } from './preview-frame.ts'
|
|
3
|
+
import { parentOrigins, previewNonce } from './preview-frame.ts'
|
|
4
|
+
import { randomUUID } from './random-uuid.ts'
|
|
4
5
|
|
|
5
6
|
/** Uses the existing preview-ready handshake, origin fence and nonce; never opens a network connection. */
|
|
6
7
|
export interface PreviewEvents {
|
|
@@ -14,11 +15,12 @@ export function createPreviewEvents(origins: readonly string[], document: string
|
|
|
14
15
|
if (typeof window === 'undefined' || window.parent === window || !origins.length || new URL(location.href).searchParams.get(PREVIEW_EVENTS_PARAM) !== 'shared') return
|
|
15
16
|
const nonce = previewNonce()
|
|
16
17
|
if (!nonce) return
|
|
17
|
-
const connection =
|
|
18
|
+
const connection = randomUUID()
|
|
18
19
|
const readers = new Map<string, { target: PreviewEventTarget, received(message: PreviewEventMessage): void }>()
|
|
19
20
|
let ready = false, stopped = false, parked = false
|
|
21
|
+
const targets = parentOrigins(origins)
|
|
20
22
|
const post = (message: Parameters<typeof previewEnvelope>[1]) => {
|
|
21
|
-
if (!stopped) for (const origin of
|
|
23
|
+
if (!stopped) for (const origin of targets) window.parent.postMessage(previewEnvelope(nonce, message), origin)
|
|
22
24
|
}
|
|
23
25
|
const subscribe = (id: string, target: PreviewEventTarget) => post({ type: 'events-subscribe', connection, id, target })
|
|
24
26
|
const park = () => {
|
|
@@ -35,7 +37,7 @@ export function createPreviewEvents(origins: readonly string[], document: string
|
|
|
35
37
|
connection,
|
|
36
38
|
subscribe(target, received) {
|
|
37
39
|
if (stopped || target.document !== document) return () => {}
|
|
38
|
-
const id =
|
|
40
|
+
const id = randomUUID()
|
|
39
41
|
readers.set(id, { target, received })
|
|
40
42
|
if (ready && !parked) subscribe(id, target)
|
|
41
43
|
return () => { if (readers.delete(id)) post({ type: 'events-unsubscribe', connection, id }) }
|