@psrt/sdk 0.1.0 → 0.1.2

package/dist/index.d.cts

@@ -1,3 +1,69 @@
+/** Initializes PSRT. Call once at app startup before any other SDK API. */
+declare function initPsrt(): Promise<void>;
+
+declare const CompileStep: {
+    readonly RESOLVE: "resolve";
+    readonly BUILD_ASSETS: "buildAssets";
+    readonly ADAPT_STYLE: "adaptStyle";
+    readonly RENDER_FONTS: "renderFonts";
+    readonly RENDER_HEAD: "renderHead";
+    readonly RENDER_PAGE: "renderPage";
+    readonly RENDER_TEXT: "renderText";
+    readonly RENDER_MASK: "renderMask";
+    readonly RENDER_INLINE: "renderInline";
+    readonly FINALIZE: "finalize";
+};
+type CompileStep = (typeof CompileStep)[keyof typeof CompileStep];
+type CompileStepContext = {
+    step: typeof CompileStep.RESOLVE;
+    doc: PsrtDocument;
+} | {
+    step: typeof CompileStep.BUILD_ASSETS;
+    assetCount: number;
+    canvasSizes: Record<string, {
+        w: number;
+        h: number;
+    }>;
+} | {
+    step: typeof CompileStep.ADAPT_STYLE;
+    pageName: string;
+    blockIndex: number;
+    kind: 'text' | 'mask';
+} | {
+    step: typeof CompileStep.RENDER_FONTS;
+    fontCount: number;
+} | {
+    step: typeof CompileStep.RENDER_HEAD;
+    title: string;
+} | {
+    step: typeof CompileStep.RENDER_PAGE;
+    pageIndex: number;
+    pageName: string;
+    canvasW: number;
+    canvasH: number;
+} | {
+    step: typeof CompileStep.RENDER_TEXT;
+    pageName: string;
+    textIndex: number;
+    contentPreview: string;
+} | {
+    step: typeof CompileStep.RENDER_MASK;
+    pageName: string;
+    maskIndex: number;
+} | {
+    step: typeof CompileStep.RENDER_INLINE;
+    pageName: string;
+    textIndex: number;
+    htmlLength: number;
+} | {
+    step: typeof CompileStep.FINALIZE;
+    htmlLength: number;
+    pageCount: number;
+};
+type CompileStepObserver = (ctx: CompileStepContext) => void;
+type CompileStepObservers = Partial<Record<CompileStep, CompileStepObserver[]>>;
+declare function notifyObservers(observers: CompileStepObservers | undefined, ctx: CompileStepContext): void;
+
 /** JSON object or compact style string from PSRT. */
 type PsrtStyle = Record<string, unknown> | string;
 /** Canonical PSRT document representation. */
@@ -54,8 +120,17 @@ interface CompileOptions {
     /** Omit the HTML variant switcher script (Ctrl+L). */
     noScript?: boolean;
 }
-
-declare function initPsrt(wasmUrl?: string): Promise<void>;
+interface CompileToHtmlPureOptions extends CompileOptions {
+    observers?: CompileStepObservers;
+    /** Additional PSRT variants bundled into the same HTML (Ctrl+L to switch). */
+    variants?: PsrtVariant[];
+}
+/** One PSRT document bundled as an HTML variant alongside the primary doc. */
+interface PsrtVariant {
+    /** Label shown in the variant switcher hint (defaults to variant-N). */
+    label?: string;
+    doc: PsrtDocument;
+}
 
 /** Converts a .psrt string into a typed PsrtDocument. */
 declare function parse(psrtString: string): PsrtDocument;
@@ -64,8 +139,14 @@ declare function stringify(doc: PsrtDocument): string;
 /** Formats a document with editor cleanup rules. */
 declare function formatDocument(doc: PsrtDocument): string;
 
-/** Compiles the document to a self-contained HTML string. */
+/** Expands all @const@ placeholders in styles, content, and URLs. */
+declare function resolveDocumentPure(doc: PsrtDocument): PsrtDocument;
+
+/** Compiles the document to a self-contained HTML string (WASM). */
 declare function compileToHtml(doc: PsrtDocument | string, options?: CompileOptions): string;
+/** Compiles PsrtDocument to HTML using pure JavaScript (no WASM, no initPsrt). */
+declare function compileToHtmlPure(doc: PsrtDocument, options?: CompileToHtmlPureOptions): string;
+
 /** Compiles one page of the document to SVG. */
 declare function compileToSvg(doc: PsrtDocument | string, pageName: string, options?: CompileOptions): string;
 
@@ -176,4 +257,4 @@ declare function resolveDocument(doc: PsrtDocument): PsrtDocument;
 /** Like resolveDocument but throws on invalid style JSON after expansion. */
 declare function resolveDocumentStrict(doc: PsrtDocument): PsrtDocument;
 
-export { type CompileOptions, type Document, type MaskPositionFields, type Page, type PositionFields, type PsrtDocument, type PsrtMask, type PsrtPage, type PsrtStyle, type PsrtText, type TextBlock, Transformer, type WebPreviewStyle, adaptEntriesForWeb, addConst, addFont, addMask, addPage, addText, compileToHtml, compileToSvg, findMaskByIndex, findPage, findPageIndex, findTextByIndex, formatDocument, formatPageDocumentJSON, initPsrt, mergePageDocumentPSRT, mergeStyle, movePage, nudgeTextPosition, parse, parseTextIndex, removeConst, removeFont, removeMask, removeMaskStyleKey, removePage, removePageStyleKey, removeStyleKey, removeText, removeTextStyleKey, renamePage, reorderTextByDelta, reorderTextRelative, reorderTextTo, resolveDocument, resolveDocumentStrict, revertConstReferences, setMaskPosition, setMaskStyle, setPagePath, setPageStyle, setStyleKey, setTextContent, setTextPosition, setTextStyle, stringify, substituteConstReferences, transform };
+export { type CompileOptions, CompileStep, type CompileStepContext, type CompileStepObserver, type CompileStepObservers, type CompileToHtmlPureOptions, type Document, type MaskPositionFields, type Page, type PositionFields, type PsrtDocument, type PsrtMask, type PsrtPage, type PsrtStyle, type PsrtText, type PsrtVariant, type TextBlock, Transformer, type WebPreviewStyle, adaptEntriesForWeb, addConst, addFont, addMask, addPage, addText, compileToHtml, compileToHtmlPure, compileToSvg, findMaskByIndex, findPage, findPageIndex, findTextByIndex, formatDocument, formatPageDocumentJSON, initPsrt, mergePageDocumentPSRT, mergeStyle, movePage, notifyObservers, nudgeTextPosition, parse, parseTextIndex, removeConst, removeFont, removeMask, removeMaskStyleKey, removePage, removePageStyleKey, removeStyleKey, removeText, removeTextStyleKey, renamePage, reorderTextByDelta, reorderTextRelative, reorderTextTo, resolveDocument, resolveDocumentPure, resolveDocumentStrict, revertConstReferences, setMaskPosition, setMaskStyle, setPagePath, setPageStyle, setStyleKey, setTextContent, setTextPosition, setTextStyle, stringify, substituteConstReferences, transform };

package/dist/index.d.ts

@@ -1,3 +1,69 @@
+/** Initializes PSRT. Call once at app startup before any other SDK API. */
+declare function initPsrt(): Promise<void>;
+
+declare const CompileStep: {
+    readonly RESOLVE: "resolve";
+    readonly BUILD_ASSETS: "buildAssets";
+    readonly ADAPT_STYLE: "adaptStyle";
+    readonly RENDER_FONTS: "renderFonts";
+    readonly RENDER_HEAD: "renderHead";
+    readonly RENDER_PAGE: "renderPage";
+    readonly RENDER_TEXT: "renderText";
+    readonly RENDER_MASK: "renderMask";
+    readonly RENDER_INLINE: "renderInline";
+    readonly FINALIZE: "finalize";
+};
+type CompileStep = (typeof CompileStep)[keyof typeof CompileStep];
+type CompileStepContext = {
+    step: typeof CompileStep.RESOLVE;
+    doc: PsrtDocument;
+} | {
+    step: typeof CompileStep.BUILD_ASSETS;
+    assetCount: number;
+    canvasSizes: Record<string, {
+        w: number;
+        h: number;
+    }>;
+} | {
+    step: typeof CompileStep.ADAPT_STYLE;
+    pageName: string;
+    blockIndex: number;
+    kind: 'text' | 'mask';
+} | {
+    step: typeof CompileStep.RENDER_FONTS;
+    fontCount: number;
+} | {
+    step: typeof CompileStep.RENDER_HEAD;
+    title: string;
+} | {
+    step: typeof CompileStep.RENDER_PAGE;
+    pageIndex: number;
+    pageName: string;
+    canvasW: number;
+    canvasH: number;
+} | {
+    step: typeof CompileStep.RENDER_TEXT;
+    pageName: string;
+    textIndex: number;
+    contentPreview: string;
+} | {
+    step: typeof CompileStep.RENDER_MASK;
+    pageName: string;
+    maskIndex: number;
+} | {
+    step: typeof CompileStep.RENDER_INLINE;
+    pageName: string;
+    textIndex: number;
+    htmlLength: number;
+} | {
+    step: typeof CompileStep.FINALIZE;
+    htmlLength: number;
+    pageCount: number;
+};
+type CompileStepObserver = (ctx: CompileStepContext) => void;
+type CompileStepObservers = Partial<Record<CompileStep, CompileStepObserver[]>>;
+declare function notifyObservers(observers: CompileStepObservers | undefined, ctx: CompileStepContext): void;
+
 /** JSON object or compact style string from PSRT. */
 type PsrtStyle = Record<string, unknown> | string;
 /** Canonical PSRT document representation. */
@@ -54,8 +120,17 @@ interface CompileOptions {
     /** Omit the HTML variant switcher script (Ctrl+L). */
     noScript?: boolean;
 }
-
-declare function initPsrt(wasmUrl?: string): Promise<void>;
+interface CompileToHtmlPureOptions extends CompileOptions {
+    observers?: CompileStepObservers;
+    /** Additional PSRT variants bundled into the same HTML (Ctrl+L to switch). */
+    variants?: PsrtVariant[];
+}
+/** One PSRT document bundled as an HTML variant alongside the primary doc. */
+interface PsrtVariant {
+    /** Label shown in the variant switcher hint (defaults to variant-N). */
+    label?: string;
+    doc: PsrtDocument;
+}
 
 /** Converts a .psrt string into a typed PsrtDocument. */
 declare function parse(psrtString: string): PsrtDocument;
@@ -64,8 +139,14 @@ declare function stringify(doc: PsrtDocument): string;
 /** Formats a document with editor cleanup rules. */
 declare function formatDocument(doc: PsrtDocument): string;
 
-/** Compiles the document to a self-contained HTML string. */
+/** Expands all @const@ placeholders in styles, content, and URLs. */
+declare function resolveDocumentPure(doc: PsrtDocument): PsrtDocument;
+
+/** Compiles the document to a self-contained HTML string (WASM). */
 declare function compileToHtml(doc: PsrtDocument | string, options?: CompileOptions): string;
+/** Compiles PsrtDocument to HTML using pure JavaScript (no WASM, no initPsrt). */
+declare function compileToHtmlPure(doc: PsrtDocument, options?: CompileToHtmlPureOptions): string;
+
 /** Compiles one page of the document to SVG. */
 declare function compileToSvg(doc: PsrtDocument | string, pageName: string, options?: CompileOptions): string;
 
@@ -176,4 +257,4 @@ declare function resolveDocument(doc: PsrtDocument): PsrtDocument;
 /** Like resolveDocument but throws on invalid style JSON after expansion. */
 declare function resolveDocumentStrict(doc: PsrtDocument): PsrtDocument;
 
-export { type CompileOptions, type Document, type MaskPositionFields, type Page, type PositionFields, type PsrtDocument, type PsrtMask, type PsrtPage, type PsrtStyle, type PsrtText, type TextBlock, Transformer, type WebPreviewStyle, adaptEntriesForWeb, addConst, addFont, addMask, addPage, addText, compileToHtml, compileToSvg, findMaskByIndex, findPage, findPageIndex, findTextByIndex, formatDocument, formatPageDocumentJSON, initPsrt, mergePageDocumentPSRT, mergeStyle, movePage, nudgeTextPosition, parse, parseTextIndex, removeConst, removeFont, removeMask, removeMaskStyleKey, removePage, removePageStyleKey, removeStyleKey, removeText, removeTextStyleKey, renamePage, reorderTextByDelta, reorderTextRelative, reorderTextTo, resolveDocument, resolveDocumentStrict, revertConstReferences, setMaskPosition, setMaskStyle, setPagePath, setPageStyle, setStyleKey, setTextContent, setTextPosition, setTextStyle, stringify, substituteConstReferences, transform };
+export { type CompileOptions, CompileStep, type CompileStepContext, type CompileStepObserver, type CompileStepObservers, type CompileToHtmlPureOptions, type Document, type MaskPositionFields, type Page, type PositionFields, type PsrtDocument, type PsrtMask, type PsrtPage, type PsrtStyle, type PsrtText, type PsrtVariant, type TextBlock, Transformer, type WebPreviewStyle, adaptEntriesForWeb, addConst, addFont, addMask, addPage, addText, compileToHtml, compileToHtmlPure, compileToSvg, findMaskByIndex, findPage, findPageIndex, findTextByIndex, formatDocument, formatPageDocumentJSON, initPsrt, mergePageDocumentPSRT, mergeStyle, movePage, notifyObservers, nudgeTextPosition, parse, parseTextIndex, removeConst, removeFont, removeMask, removeMaskStyleKey, removePage, removePageStyleKey, removeStyleKey, removeText, removeTextStyleKey, renamePage, reorderTextByDelta, reorderTextRelative, reorderTextTo, resolveDocument, resolveDocumentPure, resolveDocumentStrict, revertConstReferences, setMaskPosition, setMaskStyle, setPagePath, setPageStyle, setStyleKey, setTextContent, setTextPosition, setTextStyle, stringify, substituteConstReferences, transform };