@rtif-sdk/test-kit 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Cory Robinson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# @rtif-sdk/test-kit
+
+Shared test utilities, document builders, and assertions for testing RTIF editors and plugins.
+
+## Install
+
+```bash
+npm install --save-dev @rtif-sdk/test-kit
+```
+
+## Usage
+
+### Document builders
+
+```typescript
+import { doc, block, span } from '@rtif-sdk/test-kit';
+
+const testDoc = doc(
+  block('b1', 'text', span('Hello '), span('world', { bold: true })),
+  block('b2', 'text', span('')),
+);
+```
+
+### Assertions
+
+```typescript
+import { expectDocEqual, expectBlockCount, expectSpanText } from '@rtif-sdk/test-kit';
+
+expectDocEqual(result, expected);
+expectBlockCount(result, 2);
+expectSpanText(result, 0, 0, 'Hello ');
+```
+
+### Fixtures
+
+```typescript
+import { emptyDoc, singleBlockDoc, multiBlockDoc } from '@rtif-sdk/test-kit';
+
+const empty = emptyDoc();           // single empty block
+const single = singleBlockDoc();    // one block with text
+const multi = multiBlockDoc();      // multiple blocks
+```
+
+## Peer Dependencies
+
+- `vitest` ^4
+
+## License
+
+MIT

package/dist/assertions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Custom test assertions for RTIF documents and selections.
+ */
+import type { Document, Selection } from '@rtif-sdk/core';
+/**
+ * Assert that two documents are structurally equal (ignoring block IDs).
+ */
+export declare function assertDocEqual(_actual: Document, _expected: Document): void;
+/**
+ * Assert that two selections are equal.
+ */
+export declare function assertSelectionEqual(actual: Selection, expected: Selection): void;
+//# sourceMappingURL=assertions.d.ts.map

package/dist/assertions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertions.d.ts","sourceRoot":"","sources":["../src/assertions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE1D;;GAEG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI,CAG3E;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,GAAG,IAAI,CAUjF"}

package/dist/assertions.js

@@ -0,0 +1,21 @@
+/**
+ * Custom test assertions for RTIF documents and selections.
+ */
+/**
+ * Assert that two documents are structurally equal (ignoring block IDs).
+ */
+export function assertDocEqual(_actual, _expected) {
+    // TODO: Implement deep structural comparison
+    throw new Error('assertDocEqual() not yet implemented');
+}
+/**
+ * Assert that two selections are equal.
+ */
+export function assertSelectionEqual(actual, expected) {
+    if (actual.anchor.offset !== expected.anchor.offset ||
+        actual.focus.offset !== expected.focus.offset) {
+        throw new Error(`Selection mismatch: got (${actual.anchor.offset}, ${actual.focus.offset}), ` +
+            `expected (${expected.anchor.offset}, ${expected.focus.offset})`);
+    }
+}
+//# sourceMappingURL=assertions.js.map

package/dist/assertions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assertions.js","sourceRoot":"","sources":["../src/assertions.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,OAAiB,EAAE,SAAmB;IACnE,6CAA6C;IAC7C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;AAC1D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAiB,EAAE,QAAmB;IACzE,IACE,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,MAAM;QAC/C,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,KAAK,CAAC,MAAM,EAC7C,CAAC;QACD,MAAM,IAAI,KAAK,CACb,4BAA4B,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK;YAC3E,aAAa,QAAQ,CAAC,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CACnE,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/builders.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Fluent document builders for tests.
+ * See SPEC.md Appendix C for usage examples.
+ */
+import type { Document, Selection } from '@rtif-sdk/core';
+/** Builder for constructing test documents fluently */
+export declare class DocumentBuilder {
+    private blocks;
+    private nextId;
+    /**
+     * Add a block with plain text, or text with marks.
+     *
+     * Usage:
+     *   doc().block("Hello")
+     *   doc().block("Hello ", { bold: "world" })
+     */
+    block(text: string, _marks?: Record<string, string>): this;
+    /** Build the final Document */
+    build(): Document;
+}
+/** Create a new DocumentBuilder */
+export declare function doc(): DocumentBuilder;
+/** Create a Selection from anchor and focus offsets */
+export declare function sel(anchor: number, focus: number): Selection;
+//# sourceMappingURL=builders.d.ts.map

package/dist/builders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builders.d.ts","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAS,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEjE,uDAAuD;AACvD,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,MAAM,CAAK;IAEnB;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAW1D,+BAA+B;IAC/B,KAAK,IAAI,QAAQ;CAUlB;AAED,mCAAmC;AACnC,wBAAgB,GAAG,IAAI,eAAe,CAErC;AAED,uDAAuD;AACvD,wBAAgB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,CAK5D"}

package/dist/builders.js

@@ -0,0 +1,49 @@
+/**
+ * Fluent document builders for tests.
+ * See SPEC.md Appendix C for usage examples.
+ */
+/** Builder for constructing test documents fluently */
+export class DocumentBuilder {
+    blocks = [];
+    nextId = 1;
+    /**
+     * Add a block with plain text, or text with marks.
+     *
+     * Usage:
+     *   doc().block("Hello")
+     *   doc().block("Hello ", { bold: "world" })
+     */
+    block(text, _marks) {
+        // TODO: Implement mark parsing from the shorthand format
+        // For now, creates a simple single-span block
+        this.blocks.push({
+            id: `b${this.nextId++}`,
+            type: 'text',
+            spans: [{ text }],
+        });
+        return this;
+    }
+    /** Build the final Document */
+    build() {
+        if (this.blocks.length === 0) {
+            this.blocks.push({
+                id: 'b1',
+                type: 'text',
+                spans: [{ text: '' }],
+            });
+        }
+        return { version: 1, blocks: this.blocks };
+    }
+}
+/** Create a new DocumentBuilder */
+export function doc() {
+    return new DocumentBuilder();
+}
+/** Create a Selection from anchor and focus offsets */
+export function sel(anchor, focus) {
+    return {
+        anchor: { offset: anchor },
+        focus: { offset: focus },
+    };
+}
+//# sourceMappingURL=builders.js.map

package/dist/builders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builders.js","sourceRoot":"","sources":["../src/builders.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,uDAAuD;AACvD,MAAM,OAAO,eAAe;IAClB,MAAM,GAAY,EAAE,CAAC;IACrB,MAAM,GAAG,CAAC,CAAC;IAEnB;;;;;;OAMG;IACH,KAAK,CAAC,IAAY,EAAE,MAA+B;QACjD,yDAAyD;QACzD,8CAA8C;QAC9C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACf,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YACvB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;SAClB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IAC/B,KAAK;QACH,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACf,EAAE,EAAE,IAAI;gBACR,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;aACtB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IAC7C,CAAC;CACF;AAED,mCAAmC;AACnC,MAAM,UAAU,GAAG;IACjB,OAAO,IAAI,eAAe,EAAE,CAAC;AAC/B,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,KAAa;IAC/C,OAAO;QACL,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;QAC1B,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;KACzB,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { doc, sel, DocumentBuilder } from './builders.js';
+export { assertDocEqual, assertSelectionEqual } from './assertions.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { doc, sel, DocumentBuilder } from './builders.js';
+export { assertDocEqual, assertSelectionEqual } from './assertions.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC"}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@rtif-sdk/test-kit",
+  "version": "1.0.0",
+  "description": "RTIF shared test utilities, builders, and assertions",
+  "author": "coryrobinson42@gmail.com",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "sideEffects": false,
+  "engines": { "node": ">=20.0.0" },
+  "keywords": ["rtif", "test-utilities", "rich-text", "editor-testing"],
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@rtif-sdk/core": "^1.0.0"
+  },
+  "peerDependencies": {
+    "vitest": "^4"
+  },
+  "license": "MIT"
+}