@kumwe/studio-rich-text 0.1.0-alpha.6 → 0.1.0-rc.1

package/README.md

@@ -1,9 +1,22 @@
 # `@kumwe/studio-rich-text`
 
-Status: pre-Gate-A foundation alpha. Its profile and extension surface remain subject to contract review.
+Status: integration-candidate implementation. Gate claims still require the evidence ledger.
 
-A bounded Tiptap/ProseMirror adapter for rich-text leaf fields. It supplies a deliberate extension
-set and validates portable JSON documents; it is not a second page-layout model.
+A bounded Studio-owned rich-text authoring boundary backed internally by Editor.js `2.31.6`. It supplies a
+deliberate Studio tool profile for structured-content leaf fields; it is not a second page-layout model.
+Consumers use `StudioRichTextEditorFactory`, named Studio profiles, and canonical
+`StudioRichTextDocument` values. Editor.js output and plugin configuration are deliberately not public API or
+persisted state.
 
-Hosts remain responsible for sanitation at trust boundaries and for rendering the stored JSON with
-their own server-side presenter.
+Editor.js remains the private default surface. Strict style-CSP/Trusted-Types hosts can instead pass
+Studio's `StudioStrictCspRichTextSurfaceAdapter` to the factory, or select the corresponding Studio
+registry policy through `@kumwe/studio`. The sink-free surface retains the same first-party structured
+blocks, semantic inline formatting, read-only rules, and canonical JSON; it does not inject styles or
+write HTML strings.
+
+The package also provides deterministic Markdown import/export and policy-sanitized HTML import.
+HTML import can only narrow the fixed portable tag ceiling; it never persists HTML, event handlers,
+styles, URLs, scripts, or editor-native data. Dynamic host bindings are displayed read-only.
+
+Hosts remain responsible for authoritative validation and for rendering canonical JSON with their
+own escaping server-side presenter.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,19 @@
+# Third-party notices
+
+<!-- Generated by scripts/generate-third-party-notices.mjs. Do not edit by hand. -->
+
+Package: `@kumwe/studio-rich-text`
+
+Production closure SHA-256: `7b581c7b8fcb6a7436a017215ef59840857990b2ae30d9d798c3e81d04b2750b`
+
+The following packages are present in this package's lock-derived production dependency closure.
+They retain their own copyright and license terms.
+
+| Package | Version | Declared license | License text SHA-256 | Evidence source |
+| --- | --- | --- | --- | --- |
+| @editorjs/caret | 1.1.0 | MIT | [`5955c6e9d1de490608d7a41b4cfff00e769867ddb5fac2999b8efc874500e3a1`](third-party-licenses/editorjs__caret-1.1.0.txt) | [curated upstream source](https://github.com/editor-js/utils/blob/023b992f3ed56d32f7a907914e851d3cfdf78036/LICENSE) |
+| @editorjs/dom | 1.1.0 | MIT | [`5955c6e9d1de490608d7a41b4cfff00e769867ddb5fac2999b8efc874500e3a1`](third-party-licenses/editorjs__dom-1.1.0.txt) | [curated upstream source](https://github.com/editor-js/utils/blob/023b992f3ed56d32f7a907914e851d3cfdf78036/LICENSE) |
+| @editorjs/editorjs | 2.31.6 | Apache-2.0 | [`b946f387bbb7de6843c0db34f87a8956f229d220b3bf81b16b8425788cacf3ed`](third-party-licenses/editorjs__editorjs-2.31.6.txt) | [curated upstream source](https://github.com/codex-team/editor.js/blob/v2.31.6/LICENSE) |
+| @editorjs/helpers | 1.2.2 | MIT | [`5955c6e9d1de490608d7a41b4cfff00e769867ddb5fac2999b8efc874500e3a1`](third-party-licenses/editorjs__helpers-1.2.2.txt) | [curated upstream source](https://github.com/editor-js/utils/blob/023b992f3ed56d32f7a907914e851d3cfdf78036/LICENSE) |
+| codex-notifier | 1.1.2 | MIT | [`698022d282ae51ef05451e18cda80381aa74c6a8bb19b4ee4565b1926d36e08a`](third-party-licenses/codex-notifier-1.1.2.txt) | [curated upstream source](https://github.com/codex-team/js-notifier/blob/d000792c90bbde682d438b3554f3b9c8f6ddcb95/LICENSE) |
+| codex-tooltip | 1.0.6 | MIT | [`4350bad7723eb798e1b61d8bb006dbdba611d64257b711f81bc9dc737e82b69f`](third-party-licenses/codex-tooltip-1.0.6.txt) | [curated upstream source](https://github.com/codex-team/codex.tooltips/blob/c1d3798621189ede6aaa66765acd5901b5310275/LICENSE) |

package/dist/first-party-tools.d.ts

@@ -0,0 +1,173 @@
+import type { StudioRichTextDocument, StudioRichTextNode } from './index.js';
+export type StudioEditorJsToolName = 'callout' | 'checklist' | 'code' | 'delimiter' | 'header' | 'list' | 'paragraph' | 'quote' | 'table';
+export declare const STUDIO_EDITOR_JS_TOOL_NAMES: readonly StudioEditorJsToolName[];
+export interface StudioEditorJsBlock {
+    data: {
+        node: StudioRichTextNode;
+    };
+    type: StudioEditorJsToolName;
+}
+interface ToolOptions {
+    data?: {
+        node?: StudioRichTextNode;
+    };
+    readOnly?: boolean;
+}
+interface ToolClass {
+    new (options: ToolOptions): {
+        render(): HTMLElement;
+        save(): {
+            node: StudioRichTextNode;
+        };
+    };
+    readonly isReadOnlySupported: boolean;
+    readonly toolbox: {
+        icon: string;
+        title: string;
+    };
+}
+export declare function studioEditorJsTools(): Readonly<Record<StudioEditorJsToolName, ToolClass>>;
+export declare function toStudioEditorJsBlocks(document: StudioRichTextDocument): StudioEditorJsBlock[];
+export declare function fromStudioEditorJsBlocks(value: unknown): StudioRichTextDocument;
+declare abstract class InlineToolBase {
+    static readonly isReadOnlySupported: boolean;
+    protected readonly node: StudioRichTextNode;
+    protected readonly readOnly: boolean;
+    protected field?: HTMLElement;
+    constructor(options: ToolOptions, fallback: StudioRichTextNode);
+    protected renderInline(label: string, content: readonly StudioRichTextNode[]): HTMLElement;
+    protected saveInline(original: readonly StudioRichTextNode[]): StudioRichTextNode[];
+    abstract render(): HTMLElement;
+    abstract save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioParagraphTool extends InlineToolBase {
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "¶";
+        readonly title: "Paragraph";
+    };
+    constructor(options: ToolOptions);
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioHeaderTool extends InlineToolBase {
+    #private;
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "H";
+        readonly title: "Heading";
+    };
+    constructor(options: ToolOptions);
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioQuoteTool extends InlineToolBase {
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "“";
+        readonly title: "Quote";
+    };
+    constructor(options: ToolOptions);
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioDelimiterTool {
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "—";
+        readonly title: "Separator";
+    };
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioCalloutTool extends InlineToolBase {
+    #private;
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "!";
+        readonly title: "Callout";
+    };
+    constructor(options: ToolOptions);
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioCodeTool {
+    #private;
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "</>";
+        readonly title: "Code";
+    };
+    constructor(options: ToolOptions);
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioListTool {
+    #private;
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "•";
+        readonly title: "List";
+    };
+    constructor(options: ToolOptions);
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioChecklistTool {
+    #private;
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "☑";
+        readonly title: "Checklist";
+    };
+    constructor(options: ToolOptions);
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+export declare class StudioTableTool {
+    #private;
+    static readonly isReadOnlySupported: boolean;
+    static readonly toolbox: {
+        readonly icon: "▦";
+        readonly title: "Table";
+    };
+    constructor(options: ToolOptions);
+    render(): HTMLElement;
+    save(): {
+        node: StudioRichTextNode;
+    };
+}
+/** Editor.js inline tool for a bounded semantic highlight tone. */
+export declare class StudioMarkerTool {
+    #private;
+    static readonly isInline: boolean;
+    static readonly sanitize: {
+        readonly mark: {
+            readonly 'data-studio-tone': true;
+        };
+    };
+    checkState(selection: Selection): boolean;
+    render(): HTMLElement;
+    renderActions(): HTMLElement;
+    surround(range: Range): void;
+}
+export {};
+//# sourceMappingURL=first-party-tools.d.ts.map

package/dist/first-party-tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"first-party-tools.d.ts","sourceRoot":"","sources":["../src/first-party-tools.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAsB,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEjG,MAAM,MAAM,sBAAsB,GAC9B,SAAS,GACT,WAAW,GACX,MAAM,GACN,WAAW,GACX,QAAQ,GACR,MAAM,GACN,WAAW,GACX,OAAO,GACP,OAAO,CAAC;AAEZ,eAAO,MAAM,2BAA2B,EAAE,SAAS,sBAAsB,EAU9D,CAAC;AAEZ,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE,CAAC;IACnC,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,UAAU,WAAW;IACnB,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,kBAAkB,CAAA;KAAE,CAAC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,UAAU,SAAS;IACjB,KAAK,OAAO,EAAE,WAAW,GAAG;QAC1B,MAAM,IAAI,WAAW,CAAC;QACtB,IAAI,IAAI;YAAE,IAAI,EAAE,kBAAkB,CAAA;SAAE,CAAC;KACtC,CAAC;IACF,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAC;IACtC,QAAQ,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;CACnD;AAED,wBAAgB,mBAAmB,IAAI,QAAQ,CAAC,MAAM,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC,CAYzF;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,sBAAsB,GAAG,mBAAmB,EAAE,CAK9F;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,sBAAsB,CAoB/E;AA4BD,uBAAe,cAAc;IAC3B,gBAAuB,mBAAmB,EAAE,OAAO,CAAQ;IAC3D,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAC5C,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IACrC,SAAS,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC;gBAEX,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,kBAAkB;IAKrE,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,kBAAkB,EAAE,GAAG,WAAW;IAc1F,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,SAAS,kBAAkB,EAAE,GAAG,kBAAkB,EAAE;aAMnE,MAAM,IAAI,WAAW;aACrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CACrD;AAED,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,gBAAgC,mBAAmB,EAAE,OAAO,CAAQ;IACpE,gBAAuB,OAAO;;;MAA8C;gBAEzD,OAAO,EAAE,WAAW;IAIhC,MAAM,IAAI,WAAW;IAIrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CAM5C;AAED,qBAAa,gBAAiB,SAAQ,cAAc;;IAClD,gBAAgC,mBAAmB,EAAE,OAAO,CAAQ;IACpE,gBAAuB,OAAO;;;MAA4C;gBAGvD,OAAO,EAAE,WAAW;IAIhC,MAAM,IAAI,WAAW;IAuBrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CAQ5C;AAED,qBAAa,eAAgB,SAAQ,cAAc;IACjD,gBAAgC,mBAAmB,EAAE,OAAO,CAAQ;IACpE,gBAAuB,OAAO;;;MAA0C;gBAErD,OAAO,EAAE,WAAW;IAIhC,MAAM,IAAI,WAAW;IAIrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CAM5C;AAED,qBAAa,mBAAmB;IAC9B,gBAAuB,mBAAmB,EAAE,OAAO,CAAQ;IAC3D,gBAAuB,OAAO;;;MAA8C;IAErE,MAAM,IAAI,WAAW;IAMrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CAG5C;AAED,qBAAa,iBAAkB,SAAQ,cAAc;;IACnD,gBAAgC,mBAAmB,EAAE,OAAO,CAAQ;IACpE,gBAAuB,OAAO;;;MAA4C;gBAGvD,OAAO,EAAE,WAAW;IAQhC,MAAM,IAAI,WAAW;IAerB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CAO5C;AAED,qBAAa,cAAc;;IACzB,gBAAuB,mBAAmB,EAAE,OAAO,CAAQ;IAC3D,gBAAuB,OAAO;;;MAA2C;gBAMtD,OAAO,EAAE,WAAW;IAOhC,MAAM,IAAI,WAAW;IAkBrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CAY5C;AAYD,qBAAa,cAAc;;IACzB,gBAAuB,mBAAmB,EAAE,OAAO,CAAQ;IAC3D,gBAAuB,OAAO;;;MAAyC;gBAMpD,OAAO,EAAE,WAAW;IAYhC,MAAM,IAAI,WAAW;IAMrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CA0L5C;AASD,qBAAa,mBAAmB;;IAC9B,gBAAuB,mBAAmB,EAAE,OAAO,CAAQ;IAC3D,gBAAuB,OAAO;;;MAA8C;gBAOzD,OAAO,EAAE,WAAW;IA4BhC,MAAM,IAAI,WAAW;IAMrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CAkG5C;AAED,qBAAa,eAAe;;IAC1B,gBAAuB,mBAAmB,EAAE,OAAO,CAAQ;IAC3D,gBAAuB,OAAO;;;MAA0C;gBASrD,OAAO,EAAE,WAAW;IA6BhC,MAAM,IAAI,WAAW;IAMrB,IAAI,IAAI;QAAE,IAAI,EAAE,kBAAkB,CAAA;KAAE;CAoG5C;AAOD,mEAAmE;AACnE,qBAAa,gBAAgB;;IAC3B,gBAAuB,QAAQ,EAAE,OAAO,CAAQ;IAChD,gBAAuB,QAAQ;;;;MAAmD;IAI3E,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAOzC,MAAM,IAAI,WAAW;IAUrB,aAAa,IAAI,WAAW;IAa5B,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;CAcpC"}