@input/pen-types 0.1.0

package/dist/index.mjs

@@ -0,0 +1,394 @@
+// src/types/ops.ts
+var MUTATION_GROUP_METADATA_KEY = "mutation-group";
+
+// src/types/stream.ts
+var PEN_STREAM_PROTOCOL_VERSION = 1;
+
+// src/types/schema.ts
+function isNestedContent(content) {
+  return Array.isArray(content);
+}
+
+// src/types/editor.ts
+var HOOK_PRIORITY_AUTH = 100;
+var HOOK_PRIORITY_SUGGEST = 200;
+var HOOK_PRIORITY_INPUT_RULE = 300;
+var HOOK_PRIORITY_DEFAULT = 500;
+
+// src/types/tools.ts
+function isScopedSelectionTarget(target) {
+  return target.kind === "scoped-range";
+}
+function isAsyncIterable(value) {
+  return value != null && typeof value === "object" && Symbol.asyncIterator in value;
+}
+
+// src/types/aiRequest.ts
+var AI_REQUEST_REFUSED_CODE = "ai-request-refused";
+var AI_EGRESS_INVENTORY_CODE = "ai-egress-inventory";
+
+// src/types/a11y.ts
+function isA11yLabelledBy(value) {
+  return typeof value === "object" && value !== null && "labelledBy" in value;
+}
+
+// src/types/messages.ts
+var DEFAULT_MESSAGE_CATALOG = {
+  "pen.a11y.blockConverted": "Converted to {blockType}",
+  "pen.a11y.undoApplied": "Undid {hint}",
+  "pen.a11y.redoApplied": "Redid {hint}",
+  "pen.a11y.blockSelectionEntered": {
+    one: "{count} block selected",
+    other: "{count} blocks selected"
+  },
+  "pen.a11y.blockSelectionChanged": {
+    one: "{count} block selected",
+    other: "{count} blocks selected"
+  },
+  "pen.a11y.cellSelectionChanged": "{rows} by {columns} cells selected",
+  "pen.a11y.suggestionAppeared": "Suggestion appeared",
+  "pen.a11y.suggestionAccepted": "Suggestion accepted",
+  "pen.a11y.suggestionRejected": "Suggestion rejected",
+  "pen.a11y.streamingStarted": "Streaming started",
+  "pen.a11y.streamingFinished": "Streaming finished",
+  "pen.a11y.findMatches": {
+    one: "{count} match",
+    other: "{count} matches"
+  },
+  "pen.a11y.atomSelected": "{atomType} selected",
+  "pen.a11y.collaboratorJoined": "{name} joined",
+  "pen.a11y.collaboratorEditing": "{name} is editing",
+  "pen.selection.blocksSelected": {
+    one: "{count} block selected",
+    other: "{count} blocks selected"
+  },
+  "pen.ai.review.accept": "Accept",
+  "pen.schema.paragraph.title": "Paragraph",
+  "pen.schema.paragraph.description": "Plain text paragraph",
+  "pen.schema.paragraph.placeholder": "Text",
+  "pen.schema.heading.title": "Heading",
+  "pen.schema.heading.placeholder": "Heading",
+  "pen.display.group.basic": "Basic",
+  "pen.display.group.lists": "Lists",
+  "pen.display.group.other": "Other",
+  "pen.schema.document.emptyPlaceholder": "Start writing...",
+  "pen.editor.label": "Editor",
+  "pen.toolbar.formatting": "Formatting",
+  "pen.drag.reorderBlock": "Drag to reorder block",
+  "pen.blockHandle.reorder": "Reorder block",
+  "pen.blockHandle.moveUp": "Move up",
+  "pen.blockHandle.moveDown": "Move down",
+  "pen.search.input.placeholder": "Search...",
+  "pen.search.input.label": "Find in document",
+  "pen.search.replace.placeholder": "Replace...",
+  "pen.search.replace.label": "Replace with",
+  "pen.search.results.label": "Search results",
+  "pen.search.results.none": "No matches",
+  "pen.search.results.count": {
+    one: "{current} of {count} matches",
+    other: "{current} of {count} matches"
+  },
+  "pen.search.next": "Next match",
+  "pen.search.previous": "Previous match",
+  "pen.search.replaceMatch": "Replace match",
+  "pen.search.replaceAll": "Replace all matches",
+  "pen.search.toggle.caseSensitive": "Toggle case-sensitive search",
+  "pen.search.toggle.regex": "Toggle regular expression search",
+  "pen.search.toggle.wholeWord": "Toggle whole-word search",
+  "pen.slash.input.placeholder": "Search blocks...",
+  "pen.slash.list.label": "Slash menu",
+  "pen.suggestion.list.label": "Suggestions",
+  "pen.table.addColumn": "Add column",
+  "pen.table.addRow": "Add row",
+  "pen.table.columnPlaceholder": "Column {index}",
+  "pen.table.columnMenu.label": "{title} column",
+  "pen.table.columnMenu.type": "Type",
+  "pen.table.columnMenu.insertLeft": "\u2190 Insert left",
+  "pen.table.columnMenu.insertRight": "Insert right \u2192",
+  "pen.table.columnMenu.delete": "Delete column",
+  "pen.table.columnType.text": "Text",
+  "pen.table.columnType.number": "Number",
+  "pen.table.columnType.select": "Select",
+  "pen.table.columnType.checkbox": "Checkbox",
+  "pen.table.columnType.date": "Date",
+  "pen.table.columnType.url": "URL",
+  "pen.table.columnType.email": "Email",
+  "pen.toggle.collapse": "Collapse toggle",
+  "pen.toggle.expand": "Expand toggle",
+  "pen.toggle.empty": "Empty toggle. Click to add a block.",
+  "pen.checklist.toggle": "Toggle checkbox",
+  "pen.ai.suggestion.previous": "Previous suggestion",
+  "pen.ai.suggestion.next": "Next suggestion",
+  "pen.ai.suggestion.count": {
+    one: "{current} of {count}",
+    other: "{current} of {count}"
+  },
+  "pen.ai.suggestion.groupPrevious": "Previous suggestion group",
+  "pen.ai.suggestion.groupNext": "Next suggestion group",
+  "pen.ai.prompt.placeholder": "Edit selection",
+  "pen.ai.turn.pending": {
+    one: "{count} pending",
+    other: "{count} pending"
+  },
+  "pen.ai.turn.working": "Working",
+  "pen.ai.turn.accepted": "Accepted",
+  "pen.ai.turn.rejected": "Rejected",
+  "pen.ai.turn.error": "Error",
+  "pen.ai.turn.done": "Done",
+  "pen.ai.review.reject": "Reject",
+  "pen.ai.session.inlineEdit": "Inline edit",
+  "pen.ai.session.selectedRange": "Selected range",
+  "pen.ai.session.selectedText": "Selected text",
+  "pen.ai.session.targetActive": "AI target is active",
+  "pen.ai.session.targetPinned": "Pinned to the original selection",
+  "pen.ai.session.followUp": "Add follow-up",
+  "pen.ai.session.runEdit": "Run edit",
+  "pen.ai.commandMenu.placeholder": "Search AI commands",
+  "pen.ai.commandMenu.label": "AI command menu",
+  "pen.ai.command.rewrite": "Rewrite",
+  "pen.ai.command.rewrite.description": "Rewrite the selected text",
+  "pen.ai.command.continue": "Continue writing",
+  "pen.ai.command.continue.description": "Continue writing from the current position",
+  "pen.ai.command.summarize": "Summarize",
+  "pen.ai.command.summarize.description": "Summarize the selected text",
+  "pen.ai.command.fixGrammar": "Fix grammar",
+  "pen.ai.command.fixGrammar.description": "Fix grammar and spelling",
+  "pen.ai.command.simplify": "Simplify",
+  "pen.ai.command.simplify.description": "Make the text simpler and more concise",
+  "pen.ai.command.expand": "Expand",
+  "pen.ai.command.expand.description": "Expand the text with more detail",
+  "pen.ai.command.translate": "Translate",
+  "pen.ai.command.translate.description": "Translate to another language",
+  "pen.ai.shortcut.undoInline": "Undo AI inline turn",
+  "pen.ai.shortcut.redoInline": "Redo AI inline turn",
+  "pen.ai.suggestion.keep": "Keep",
+  "pen.ai.suggestion.undo": "Undo",
+  "pen.ai.suggestion.heading": "Suggestion",
+  "pen.ai.suggestion.applyHint": "Apply to accept this edit.",
+  "pen.ai.suggestion.dismiss": "Dismiss",
+  "pen.ai.suggestion.apply": "Apply",
+  "pen.ai.suggestion.kind.spelling": "Spelling",
+  "pen.ai.suggestion.kind.grammar": "Grammar",
+  "pen.ai.suggestion.kind.clarity": "Clarity",
+  "pen.ai.suggestion.kind.rephrase": "Rephrase",
+  "pen.ai.suggestion.kind.other": "Suggestion",
+  "pen.ai.review.section.content": "Content changes",
+  "pen.ai.review.section.block": "Block changes",
+  "pen.ai.review.section.row": "Row changes",
+  "pen.ai.review.section.cell": "Cell changes",
+  "pen.ai.review.section.schema": "Schema changes",
+  "pen.ai.review.section.view": "View changes",
+  "pen.ai.review.kind.added": "Added",
+  "pen.ai.review.kind.removed": "Removed",
+  "pen.ai.review.kind.updated": "Updated",
+  "pen.ai.review.kind.moved": "Moved",
+  "pen.ai.review.subgroup.content.added": "Content additions",
+  "pen.ai.review.subgroup.content.removed": "Content removals",
+  "pen.ai.review.subgroup.content.updated": "Content updates",
+  "pen.ai.review.subgroup.content.moved": "Content moves",
+  "pen.ai.review.subgroup.block.added": "Block additions",
+  "pen.ai.review.subgroup.block.removed": "Block removals",
+  "pen.ai.review.subgroup.block.updated": "Block updates",
+  "pen.ai.review.subgroup.block.moved": "Block moves",
+  "pen.ai.review.subgroup.row.added": "Row additions",
+  "pen.ai.review.subgroup.row.removed": "Row removals",
+  "pen.ai.review.subgroup.row.updated": "Row updates",
+  "pen.ai.review.subgroup.row.moved": "Row moves",
+  "pen.ai.review.subgroup.cell.added": "Cell additions",
+  "pen.ai.review.subgroup.cell.removed": "Cell removals",
+  "pen.ai.review.subgroup.cell.updated": "Cell updates",
+  "pen.ai.review.subgroup.cell.moved": "Cell moves",
+  "pen.ai.review.subgroup.schema.added": "Schema additions",
+  "pen.ai.review.subgroup.schema.removed": "Schema removals",
+  "pen.ai.review.subgroup.schema.updated": "Schema updates",
+  "pen.ai.review.subgroup.schema.moved": "Schema moves",
+  "pen.ai.review.subgroup.view.added": "View additions",
+  "pen.ai.review.subgroup.view.removed": "View removals",
+  "pen.ai.review.subgroup.view.updated": "View updates",
+  "pen.ai.review.subgroup.view.moved": "View moves",
+  "pen.ai.review.action.insert": "Insert",
+  "pen.ai.review.action.delete": "Delete",
+  "pen.ai.review.action.move": "Move",
+  "pen.ai.review.action.convert": "Convert",
+  "pen.ai.review.action.change": "Change",
+  "pen.ai.review.blockSuggestion.insert": "Insert {blockType}",
+  "pen.ai.review.blockSuggestion.delete": "Delete {blockType}",
+  "pen.ai.review.blockSuggestion.move": "Move {blockType}",
+  "pen.ai.review.blockSuggestion.convert": "Convert {blockType}",
+  "pen.ai.review.blockType.fallback": "block",
+  "pen.ai.review.acceptGroup": "Accept group",
+  "pen.ai.review.rejectGroup": "Reject group",
+  "pen.ai.review.acceptSubgroup": "Accept subgroup",
+  "pen.ai.review.rejectSubgroup": "Reject subgroup",
+  "pen.ai.review.expand": "Expand",
+  "pen.ai.review.collapse": "Collapse",
+  "pen.ai.review.structuralSuggestion": "(structural suggestion)",
+  "pen.ai.review.noPendingChanges": "No pending changes.",
+  "pen.ai.session.close": "Close"
+};
+function isMessageKey(value) {
+  return Object.prototype.hasOwnProperty.call(DEFAULT_MESSAGE_CATALOG, value);
+}
+function isPluralMessage(value) {
+  return typeof value === "object" && value !== null && typeof value.other === "string";
+}
+
+// src/types/format.ts
+var PEN_DOCUMENT_FORMAT = 3;
+var PEN_FORMAT_METADATA_KEY = "penFormat";
+var DOCUMENT_PROFILE_METADATA_KEY = "documentProfile";
+var MIGRATION_LEDGER_METADATA_KEY = "penMigrations";
+var RESERVED_METADATA_KEYS = Object.freeze([
+  PEN_FORMAT_METADATA_KEY,
+  DOCUMENT_PROFILE_METADATA_KEY,
+  MIGRATION_LEDGER_METADATA_KEY
+]);
+var IMPLICIT_V1_FORMAT_STAMP = Object.freeze({
+  format: 1,
+  minReader: 1,
+  writer: "unknown"
+});
+
+// src/constants/decorations.ts
+var INLINE_COMPLETION_VISIBLE_BLOCK_ATTRIBUTE = "data-pen-inline-completion-visible";
+
+// src/constants/reviewSurface.ts
+var REVIEW_SURFACE_CLASSES = Object.freeze({
+  /** Inserted text in a proposed edit. */
+  suggestionInsert: "pen-suggestion-insert",
+  /** Deleted text in a proposed edit, including in-flight originals. */
+  suggestionDelete: "pen-suggestion-delete",
+  /** Text still arriving, shown before anything is written. */
+  preview: "pen-ai-review-preview",
+  /** Selection context kept visible around an edit under review. */
+  context: "pen-ai-review-context",
+  /** The range an edit under review affects. */
+  affectedRange: "pen-ai-affected-range",
+  /** A block carrying a proposed structural change. */
+  blockSuggestion: "pen-block-suggestion"
+});
+var REVIEW_SURFACE_BLOCK_SUGGESTION_CLASSES = Object.freeze({
+  "insert-block": "pen-block-suggestion-insert-block",
+  "delete-block": "pen-block-suggestion-delete-block",
+  "move-block": "pen-block-suggestion-move-block",
+  "convert-block": "pen-block-suggestion-convert-block",
+  "split-block": "pen-block-suggestion-split-block",
+  "format-text": "pen-block-suggestion-format-text"
+});
+var REVIEW_SURFACE_CUSTOM_PROPERTIES = Object.freeze({
+  insertColor: "--pen-ai-review-insert-color",
+  insertBackground: "--pen-ai-review-insert-background",
+  deleteColor: "--pen-ai-review-delete-color",
+  contextBackground: "--pen-ai-review-context-background",
+  contextBoxShadow: "--pen-ai-review-context-box-shadow",
+  borderRadius: "--pen-ai-review-border-radius",
+  inlinePaddingBlock: "--pen-ai-review-inline-padding-block",
+  inlineMarginBlock: "--pen-ai-review-inline-margin-block"
+});
+
+// src/types/decorations.ts
+var DECORATION_OMIT_FROM_RENDER_ATTRIBUTE = "data-pen-omit-from-render";
+
+// src/types/clipboard.ts
+var PEN_CLIPBOARD_PAYLOAD_VERSION = 1;
+var PEN_CLIPBOARD_JSON_MIME = "application/x-pen-blocks+json";
+var PEN_CLIPBOARD_JSON_MIME_LEGACY = "application/x-pen-blocks";
+
+// src/utils/generateId.ts
+var HEX_DIGITS = "0123456789abcdef";
+var UUID_DASH_POSITIONS = /* @__PURE__ */ new Set([3, 5, 7, 9]);
+function formatUuidV4(bytes) {
+  bytes[6] = bytes[6] & 15 | 64;
+  bytes[8] = bytes[8] & 63 | 128;
+  let id = "";
+  for (let index = 0; index < 16; index++) {
+    const byte = bytes[index];
+    id += HEX_DIGITS[byte >> 4] + HEX_DIGITS[byte & 15];
+    if (UUID_DASH_POSITIONS.has(index)) {
+      id += "-";
+    }
+  }
+  return id;
+}
+function generateId() {
+  const webCrypto = typeof crypto === "undefined" ? void 0 : crypto;
+  if (typeof webCrypto?.randomUUID === "function") {
+    return webCrypto.randomUUID();
+  }
+  if (typeof webCrypto?.getRandomValues === "function") {
+    return formatUuidV4(webCrypto.getRandomValues(new Uint8Array(16)));
+  }
+  const bytes = new Uint8Array(16);
+  for (let index = 0; index < bytes.length; index++) {
+    bytes[index] = Math.floor(Math.random() * 256);
+  }
+  return formatUuidV4(bytes);
+}
+
+// src/constants/slots.ts
+var FIELD_EDITOR_SLOT_KEY = "field-editor";
+var COLLECT_KEY_BINDINGS_SLOT_KEY = "core:collect-key-bindings";
+var AWAIT_EXTENSION_LIFECYCLE_SLOT_KEY = "core:await-extension-lifecycle";
+var INPUT_RULES_ENGINE_SLOT_KEY = "input-rules:engine";
+var UNDO_HISTORY_RESTORE_SLOT_KEY = "undo:history-restore";
+var UNDO_HISTORY_METADATA_CONTROLLER_SLOT_KEY = "undo:history-metadata-controller";
+var INLINE_COMPLETION_SLOT = "ai:inline-completion";
+var AI_CONTROLLER_SLOT = "ai:controller";
+var AI_INLINE_HISTORY_SLOT = "ai:inline-history";
+var AI_REVIEW_CONTROLLER_SLOT = "ai:review";
+var AI_AUTOCOMPLETE_CONTROLLER_SLOT = "ai-autocomplete:controller";
+var AI_SUGGESTIONS_CONTROLLER_SLOT = "ai-suggestions:controller";
+var SEARCH_CONTROLLER_SLOT = "search:controller";
+var MULTIPLAYER_CONTROLLER_SLOT = "multiplayer:controller";
+var SNAPSHOTS_CONTROLLER_SLOT = "snapshots:controller";
+var ANNOUNCER_SLOT_KEY = "pen.announcer";
+var HISTORY_ORIGIN_TAG = "__pen_history__";
+export {
+  AI_AUTOCOMPLETE_CONTROLLER_SLOT,
+  AI_CONTROLLER_SLOT,
+  AI_EGRESS_INVENTORY_CODE,
+  AI_INLINE_HISTORY_SLOT,
+  AI_REQUEST_REFUSED_CODE,
+  AI_REVIEW_CONTROLLER_SLOT,
+  AI_SUGGESTIONS_CONTROLLER_SLOT,
+  ANNOUNCER_SLOT_KEY,
+  AWAIT_EXTENSION_LIFECYCLE_SLOT_KEY,
+  COLLECT_KEY_BINDINGS_SLOT_KEY,
+  DECORATION_OMIT_FROM_RENDER_ATTRIBUTE,
+  DEFAULT_MESSAGE_CATALOG,
+  DOCUMENT_PROFILE_METADATA_KEY,
+  FIELD_EDITOR_SLOT_KEY,
+  HISTORY_ORIGIN_TAG,
+  HOOK_PRIORITY_AUTH,
+  HOOK_PRIORITY_DEFAULT,
+  HOOK_PRIORITY_INPUT_RULE,
+  HOOK_PRIORITY_SUGGEST,
+  IMPLICIT_V1_FORMAT_STAMP,
+  INLINE_COMPLETION_SLOT,
+  INLINE_COMPLETION_VISIBLE_BLOCK_ATTRIBUTE,
+  INPUT_RULES_ENGINE_SLOT_KEY,
+  MIGRATION_LEDGER_METADATA_KEY,
+  MULTIPLAYER_CONTROLLER_SLOT,
+  MUTATION_GROUP_METADATA_KEY,
+  PEN_CLIPBOARD_JSON_MIME,
+  PEN_CLIPBOARD_JSON_MIME_LEGACY,
+  PEN_CLIPBOARD_PAYLOAD_VERSION,
+  PEN_DOCUMENT_FORMAT,
+  PEN_FORMAT_METADATA_KEY,
+  PEN_STREAM_PROTOCOL_VERSION,
+  RESERVED_METADATA_KEYS,
+  REVIEW_SURFACE_BLOCK_SUGGESTION_CLASSES,
+  REVIEW_SURFACE_CLASSES,
+  REVIEW_SURFACE_CUSTOM_PROPERTIES,
+  SEARCH_CONTROLLER_SLOT,
+  SNAPSHOTS_CONTROLLER_SLOT,
+  UNDO_HISTORY_METADATA_CONTROLLER_SLOT_KEY,
+  UNDO_HISTORY_RESTORE_SLOT_KEY,
+  generateId,
+  isA11yLabelledBy,
+  isAsyncIterable,
+  isMessageKey,
+  isNestedContent,
+  isPluralMessage,
+  isScopedSelectionTarget
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@input/pen-types",
+  "version": "0.1.0",
+  "description": "Type definitions and lightweight runtime helpers for Pen",
+  "license": "MIT",
+  "homepage": "https://github.com/input-systems/pen#readme",
+  "bugs": {
+    "url": "https://github.com/input-systems/pen/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/input-systems/pen.git",
+    "directory": "packages/types"
+  },
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "sideEffects": false,
+  "devDependencies": {
+    "tsup": "^8.4.0",
+    "typescript": "^5.7.3",
+    "vitest": "^3.2.7"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "clean": "rm -rf dist *.tsbuildinfo"
+  }
+}