@printstack/print-studio 0.0.0-stage → 0.1.0

package/parser/worker/worker-protocol.d.ts

@@ -0,0 +1,55 @@
+import { RenderProgress } from '../../core/render/render-task';
+import { PrintDocument } from '../../core/types';
+import { Translations } from '../../locales/types';
+import { HtmlParseOptions } from '../html/html-parser';
+export interface RenderWorkerRequest {
+    id: number;
+    locale: {
+        fallback: string;
+        fallbackMessages: Translations;
+        messages: Translations;
+        name: string;
+    };
+    task: {
+        document: PrintDocument;
+        input?: Record<string, unknown>;
+        kind: 'html' | 'prepare';
+        options?: HtmlParseOptions;
+    };
+}
+export interface RenderWorkerFailure {
+    code?: string;
+    kind: 'domain' | 'error';
+    message: string;
+    stack?: string;
+    userMessage?: string;
+}
+export interface RenderWorkerCheckpoint {
+    checkpoint: number;
+    id: number;
+    progress?: RenderProgress;
+}
+export interface RenderWorkerContinue {
+    id: number;
+    resume: number;
+}
+export type RenderWorkerOutput = {
+    document: PrintDocument;
+    kind: 'prepare';
+    warnings: string[];
+} | {
+    html: string;
+    kind: 'html';
+    warnings: string[];
+};
+export type RenderWorkerResponse = {
+    error: RenderWorkerFailure;
+    id: number;
+    ok: false;
+} | {
+    id: number;
+    ok: true;
+    output: RenderWorkerOutput;
+};
+export declare function serializeRenderError(error: unknown): RenderWorkerFailure;
+export declare function restoreRenderError(failure: RenderWorkerFailure): Error;

package/plugins/pen/editing-geometry.d.ts

@@ -0,0 +1,10 @@
+import { Point } from '../../core/geometry';
+import { ElementNode } from '../../core/types';
+import { ElementPatch } from '../../studio-types';
+import { PenAnchor } from './geometry';
+export type PenControl = keyof PenAnchor;
+export declare function penPointToPage(node: ElementNode, point: Point): Point;
+export declare function penPointFromPage(node: ElementNode, point: Point): Point;
+export declare function movePenControl(anchor: PenAnchor, control: PenControl, point: Point, independent: boolean): PenAnchor;
+/** 重新定界时保持已有缩放和旋转，让未修改的锚点在页面上保持原位。 */
+export declare function createPenEditPatch(node: ElementNode, anchors: PenAnchor[]): ElementPatch;

package/plugins/pen/element.d.ts

@@ -0,0 +1,4 @@
+import { ElementDefinition } from '../../core/element-registry';
+export declare const PEN_ELEMENT_TYPE = "pen-path";
+export declare const PEN_TOOL_ID = "element:pen-path";
+export declare function createPenElement(): ElementDefinition;

package/plugins/pen/geometry.d.ts

@@ -0,0 +1,19 @@
+import { Point } from '../../core/geometry';
+import { ElementNode } from '../../core/types';
+export interface PenAnchor {
+    incoming: Point;
+    outgoing: Point;
+    point: Point;
+}
+export interface PenPath {
+    anchors: PenAnchor[];
+    closed: boolean;
+    viewHeight: number;
+    viewWidth: number;
+}
+export declare function createAnchor(point: Point): PenAnchor;
+export declare function penPathData(anchors: PenAnchor[], closed?: boolean): string;
+export declare function readPenPath(props: Record<string, unknown>): PenPath;
+/** 按实际路径定界，控制手柄可以位于局部定界框外。 */
+export declare function createPenPatch(anchors: PenAnchor[], closed: boolean): Pick<ElementNode, 'height' | 'props' | 'rotation' | 'width' | 'x' | 'y'>;
+export declare function penStrokeWidth(props: Record<string, unknown>): number;

package/plugins/pen/index.d.ts

@@ -0,0 +1,3 @@
+export { createPenElement } from './element';
+export { penToolPlugin } from './pen-plugin';
+export { penPluginResources } from './resources';

package/plugins/pen/locale.d.ts

@@ -0,0 +1,3 @@
+import { default as messages } from './locales/zh-CN.json';
+export declare const penLocale: import('../../locales/plugin-locales').PluginLocale;
+export declare function penTrans(key: keyof typeof messages): string;

package/plugins/pen/locales/zh-CN.json.d.ts

@@ -0,0 +1,18 @@
+declare const _default: {
+  "tool": "钢笔",
+  "path": "钢笔路径",
+  "stroke": "描边颜色",
+  "strokeWidth": "描边宽度",
+  "closed": "闭合路径",
+  "fill": "填充颜色",
+  "finish": "完成路径",
+  "cancel": "取消路径",
+  "removeAnchor": "删除最后一个锚点",
+  "finishEdit": "完成锚点拖动",
+  "cancelEdit": "取消锚点拖动",
+  "editHelp": "拖动方形锚点移动节点，拖动圆形控制柄调整曲线；Alt 拖动锚点拉出控制柄，Alt 拖动控制柄独立调整，Esc 取消当前拖动。",
+  "help": "单击添加锚点，按住拖动创建曲线；点击起点闭合，双击或 Enter 完成，Backspace 回退，Esc 取消。"
+}
+;
+
+export default _default;

package/plugins/pen/pen-edit-surface.vue.d.ts

@@ -0,0 +1,10 @@
+import { ElementNode } from '../../core/types';
+import { PluginContext } from '../../designer/plugins/plugin-context';
+type __VLS_Props = {
+    context: PluginContext;
+    node: ElementNode;
+    surface: HTMLElement;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/plugins/pen/pen-overlay.vue.d.ts

@@ -0,0 +1,7 @@
+import { PluginContext } from '../../designer/plugins/plugin-context';
+type __VLS_Props = {
+    context: PluginContext;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/plugins/pen/pen-plugin.d.ts

@@ -0,0 +1,4 @@
+import { DesignerPlugin, PluginDefinition } from '../../designer/plugins/types';
+export declare const penToolPlugin: PluginDefinition;
+/** 默认装配遵循宿主已有的 UI 插件作用域，单独安装的实例保留所有权。 */
+export declare const penToolPreset: DesignerPlugin;

package/plugins/pen/pen-preview.vue.d.ts

@@ -0,0 +1,8 @@
+import { ElementNode } from '../../core/types';
+type __VLS_Props = {
+    node: ElementNode;
+    pxPerMm: number;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/plugins/pen/pen-surface.vue.d.ts

@@ -0,0 +1,9 @@
+import { PluginContext } from '../../designer/plugins/plugin-context';
+type __VLS_Props = {
+    context: PluginContext;
+    pageId: string;
+    surface: HTMLElement;
+};
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/plugins/pen/resources.d.ts

@@ -0,0 +1,2 @@
+import { PluginResources } from '../../designer/plugins/types';
+export declare const penPluginResources: PluginResources;

package/plugins/saas/client.d.ts

@@ -0,0 +1,3 @@
+import { SaasClient, SaasClientOptions } from './types';
+export { SaasHttpError } from './errors';
+export declare function createSaasHttpClient(options?: SaasClientOptions): SaasClient;

package/plugins/saas/errors.d.ts

@@ -0,0 +1,5 @@
+import { DesignerException } from '../../core/errors';
+export declare class SaasHttpError extends DesignerException {
+    readonly status: number;
+    constructor(status: number, message: string);
+}

package/plugins/saas/index.d.ts

@@ -0,0 +1,5 @@
+export { SaasHttpError } from './client';
+export { createSaasClient } from './integration';
+export { createSaasPlugin, createSaasTemplateProvider } from './plugin';
+export type { SaasPluginOptions } from './plugin';
+export type * from './types';

package/plugins/saas/integration.d.ts

@@ -0,0 +1,2 @@
+import { SaasClientOptions, SaasIntegration } from './types';
+export declare function createSaasClient(options?: SaasClientOptions): SaasIntegration;

package/plugins/saas/plugin.d.ts

@@ -0,0 +1,17 @@
+import { PrintDocument } from '../../core/types';
+import { PluginDefinition } from '../../designer/plugins/types';
+import { TemplateLibraryProvider } from '../../designer/template-library/types';
+import { SaasClient, SaasWorkspaceRecord } from './types';
+export declare function createSaasTemplateProvider(client: SaasClient): TemplateLibraryProvider;
+export interface SaasPluginOptions {
+    exports?: boolean;
+    initialRevision?: number;
+    initialSnapshot?: PrintDocument;
+    logout?: boolean;
+    preferences?: boolean;
+    saveDelayMs?: number;
+    templates?: boolean;
+    workspace?: boolean;
+}
+export declare function createSaasPlugin(client: SaasClient, options?: SaasPluginOptions): PluginDefinition;
+export declare function createSaasServicePlugin(client: SaasClient, options?: SaasPluginOptions, preparedWorkspace?: null | SaasWorkspaceRecord): PluginDefinition;

package/plugins/saas/preferences.d.ts

@@ -0,0 +1,5 @@
+import { PreferenceStorage } from '../../studio-types';
+import { SaasClient } from './types';
+export declare function createSaasPreferenceStorage(client: SaasClient, initial: Record<string, string>, onError: (error: unknown) => void): PreferenceStorage & {
+    dispose(): void;
+};

package/plugins/saas/types.d.ts

@@ -0,0 +1,96 @@
+import { PrintDocument } from '../../core/types';
+import { DesignerPluginFactory, PluginDefinition } from '../../designer/plugins/types';
+import { PrintStudioOptions } from '../../studio-types';
+import { SaasPluginOptions } from './plugin';
+export interface SaasWorkspaceRecord {
+    document: PrintDocument;
+    revision: number;
+    updatedAt: number;
+}
+export interface SaasWorkspaceSave {
+    revision: number;
+    updatedAt: number;
+}
+export interface SaasFeatures {
+    exports: boolean;
+    templates: boolean;
+    workspace: boolean;
+}
+export interface SaasConfiguration {
+    features: SaasFeatures;
+    mode: string;
+}
+export interface SaasSession {
+    user: unknown;
+}
+export interface SaasTemplateRecord {
+    createdAt: number;
+    document?: PrintDocument;
+    id: string;
+    name: string;
+    revision: number;
+    updatedAt: number;
+}
+export interface SaasExportJob {
+    createdAt: number;
+    error?: string;
+    expiresAt: number;
+    format: 'html' | 'pdf';
+    id: string;
+    status: 'cancelled' | 'completed' | 'failed' | 'queued' | 'running';
+    updatedAt: number;
+    warnings: string[];
+}
+export interface SaasClient {
+    cancelExport(id: string): Promise<void>;
+    createTemplate(document: PrintDocument): Promise<SaasTemplateRecord>;
+    deleteTemplate(id: string, revision: number): Promise<void>;
+    downloadExport(id: string): Promise<Blob>;
+    getConfig(): Promise<SaasConfiguration>;
+    getExport(id: string): Promise<SaasExportJob>;
+    getPreferences(): Promise<Record<string, string>>;
+    getSession(): Promise<SaasSession>;
+    getTemplate(id: string): Promise<SaasTemplateRecord>;
+    getWorkspace(): Promise<null | SaasWorkspaceRecord>;
+    listTemplates(): Promise<SaasTemplateRecord[]>;
+    logout(): Promise<void>;
+    saveWorkspace(revision: number, document: PrintDocument): Promise<SaasWorkspaceSave>;
+    setPreference(key: string, value: string): Promise<void>;
+    submitExport(format: 'html' | 'pdf', document: PrintDocument, input?: Record<string, unknown>): Promise<SaasExportJob>;
+    updateTemplate(id: string, revision: number, document: PrintDocument): Promise<SaasTemplateRecord>;
+}
+export interface SaasPaths {
+    config: string;
+    exports: string;
+    preferences: string;
+    session: string;
+    templates: string;
+    workspace: string;
+}
+export interface SaasHooks {
+    onLogout?: () => Promise<void> | void;
+    onUnauthorized?: (error: unknown) => Promise<void> | void;
+}
+export interface SaasClientOptions {
+    api?: Partial<SaasClient>;
+    baseUrl?: string;
+    credentials?: RequestCredentials;
+    fetcher?: typeof fetch;
+    headers?: (() => HeadersInit | Promise<HeadersInit>) | HeadersInit;
+    hooks?: SaasHooks;
+    paths?: Partial<SaasPaths>;
+}
+export interface SaasPreparationOptions extends Omit<SaasPluginOptions, 'initialRevision' | 'initialSnapshot'> {
+    authenticate?: boolean;
+    discoverFeatures?: boolean;
+    onError?: (error: unknown) => void;
+    preferences?: boolean;
+}
+export interface PreparedSaas {
+    designerOptions: Pick<PrintStudioOptions, 'initialDocument' | 'persistPreferences' | 'preferenceStorage' | 'storage' | 'strictInitialDocument'>;
+    dispose(): void;
+    plugin: PluginDefinition;
+}
+export interface SaasIntegration extends DesignerPluginFactory<SaasPluginOptions>, SaasClient {
+    prepare(options?: SaasPreparationOptions): Promise<PreparedSaas>;
+}