@examind/block-types 0.1.18

package/README.md

@@ -0,0 +1,40 @@
+# @examind/block-types
+
+TypeScript type definitions shared between `@examind/block-editor` and `@examind/block-sdk`.
+
+## Purpose
+
+- Defines shared types across Examind block editor packages
+- Extracts necessary type definitions from Lexical
+- Allows `@examind/block-sdk` to avoid a direct dependency on Lexical
+- Zero runtime payload (declaration files only)
+
+## Usage
+
+```typescript
+import type {
+  LexicalEditor,
+  LexicalNode,
+} from '@examind/block-types';
+```
+
+## Development
+
+This package contains only TypeScript declaration files (`.d.ts`), with no compilation step required.
+
+```bash
+# Copy types from Lexical
+pnpm copy-types
+```
+
+## Integration
+
+In consuming packages:
+
+```json
+{
+  "devDependencies": {
+    "@examind/block-types": "workspace:*"
+  }
+}
+```

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@examind/block-types",
+  "version": "0.1.18",
+  "@comment version": [
+    "Don't specify package version here. It will be injected by publish workflow."
+  ],
+  "description": "TypeScript type definitions for Lexical editor state",
+  "types": "types/index.ts",
+  "files": [
+    "types/**/*.ts"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "5.7.2"
+  },
+  "scripts": {
+    "copy-types": "node scripts/copy-types.js"
+  }
+}

package/types/examind/index.d.ts

@@ -0,0 +1,12 @@
+export * from './nodes/EssayQuestionNode';
+export * from './nodes/FillInTheBlankQuestionNode';
+export * from './nodes/FillInTheBlankSpaceNode';
+export * from './nodes/FinancialStatementQuestionNode';
+export * from './nodes/HorizontalRuleNode';
+export * from './nodes/ImageNode';
+export * from './nodes/JournalEntryQuestionNode';
+export * from './nodes/MatchingQuestionNode';
+export * from './nodes/MultipleOptionQuestionNode';
+export * from './nodes/ShortAnswerQuestionNode';
+export * from './nodes/SimulationQuestionNode';
+export * from './nodes/VariableNode';

package/types/examind/nodes/EssayQuestionNode.ts

@@ -0,0 +1,16 @@
+import {
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type SerializedEssayQuestionNode = Spread<
+  {
+    id: string;
+    points: number;
+    maxWords: number;
+    hideChat: boolean;
+    aiSystemMessage: string | null;
+    aiChatModel: string | null;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/FillInTheBlankQuestionNode.ts

@@ -0,0 +1,14 @@
+import {
+  type SerializedEditor,
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type SerializedFillInTheBlankQuestionNode = Spread<
+  {
+    id: string;
+    pointsPerSpace: number;
+    content: SerializedEditor;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/FillInTheBlankSpaceNode.ts

@@ -0,0 +1,21 @@
+import {
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type FillInTheBlankSpaceType = 'Text' | 'Number' | 'Dropdown';
+
+export type SerializedFillInTheBlankSpaceNode = Spread<
+  {
+    id: string;
+    spaceName: string;
+    matches: string;
+    caseSensitive?: boolean;
+    errorsAllowed?: number;
+    minDecimals?: number;
+    errorTolerance?: number;
+    distractors?: string;
+    spaceType: FillInTheBlankSpaceType;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/FinancialStatementQuestionNode.ts

@@ -0,0 +1,46 @@
+import {
+  type SerializedEditor,
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type FinancialStatementRowType = 'Heading' | 'Line';
+
+export type SerializableFinancialStatementHeading = {
+  type: FinancialStatementRowType;
+  id: string;
+  depth: number;
+  entry: string;
+  isHint: boolean;
+};
+
+export type SerializableFinancialStatementLine = {
+  type: FinancialStatementRowType;
+  id: string;
+  depth: number;
+  entry: string;
+  amount: SerializedEditor;
+  isEntryHint: boolean;
+  isAmountHint: boolean;
+  role: 'line-item' | 'subtotal' | 'total' | null;
+};
+
+export type SerializableFinancialStatementRow =
+  | SerializableFinancialStatementHeading
+  | SerializableFinancialStatementLine;
+export type SerializableFinancialStatementDistractor = {
+  id: string;
+  entry: string;
+};
+
+export type SerializedFinancialStatementQuestionNode = Spread<
+  {
+    id: string;
+    points: number;
+    header: SerializedEditor;
+    columnHeaders: Array<string>;
+    rows: Array<SerializableFinancialStatementRow>;
+    distractors: Array<SerializableFinancialStatementDistractor>;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/HorizontalRuleNode.ts

@@ -0,0 +1,3 @@
+import { type SerializedLexicalNode } from '../../lexical';
+
+export type SerializedHorizontalRuleNode = SerializedLexicalNode;

package/types/examind/nodes/ImageNode.ts

@@ -0,0 +1,18 @@
+import {
+  type SerializedEditor,
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type SerializedImageNode = Spread<
+  {
+    altText: string;
+    caption: SerializedEditor;
+    showCaption: boolean;
+    src: string;
+    width: string;
+    align: string;
+    showBorder: boolean;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/JournalEntryQuestionNode.ts

@@ -0,0 +1,32 @@
+import {
+  type SerializedEditor,
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+const JournalTypes = [
+  'default',
+  'noEntryRequiredCorrect',
+  'noEntryRequiredDistractor',
+] as const;
+
+export type JournalType = (typeof JournalTypes)[number];
+
+export type SerializedJournalEntryQuestionItem = {
+  id: string;
+  correct: boolean;
+  account: SerializedEditor;
+  debit?: SerializedEditor;
+  credit?: SerializedEditor;
+};
+
+export type SerializedJournalEntryQuestionNode = Spread<
+  {
+    id: string;
+    journalType: JournalType;
+    points: number;
+    errorTolerance?: number;
+    lineItems: Array<SerializedJournalEntryQuestionItem>;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/MatchingQuestionNode.ts

@@ -0,0 +1,21 @@
+import {
+  type SerializedEditor,
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type SerializedQuestionItem = {
+  id: string;
+  correct: boolean;
+  itemPremiseContent?: SerializedEditor;
+  itemOptionContent: SerializedEditor;
+};
+
+export type SerializedMatchingQuestionNode = Spread<
+  {
+    id: string;
+    pointsPerMatch: number;
+    items: Array<SerializedQuestionItem>;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/MultipleOptionQuestionNode.ts

@@ -0,0 +1,29 @@
+import {
+  type SerializedEditor,
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type QuestionType = 'multiple-choice' | 'multiple-answers';
+export type GradingType = 'partialCreditWithPenalty' | 'exactMatch';
+
+export type SerializedMultipleOptionQuestionItem = {
+  id: string;
+  correct?: boolean;
+  content: SerializedEditor;
+};
+
+export type SerializedMultipleOptionQuestionNode = Spread<
+  {
+    id: string;
+    questionType: QuestionType;
+    points: number;
+    choices?: number;
+    correctChoices?: number;
+    incorrectChoices?: number;
+    grading?: GradingType;
+    noneOfTheAbove?: boolean;
+    options: Array<SerializedMultipleOptionQuestionItem>;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/ShortAnswerQuestionNode.ts

@@ -0,0 +1,15 @@
+import {
+  type SerializedEditor,
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type SerializedShortAnswerQuestionNode = Spread<
+  {
+    id: string;
+    points: number;
+    maxWords: number;
+    notes: SerializedEditor;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/SimulationQuestionNode.ts

@@ -0,0 +1,15 @@
+import {
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type SerializedSimulationQuestionNode = Spread<
+  {
+    id: string;
+    points: number;
+    aiSystemMessage: string | null;
+    aiChatModel: string | null;
+    step2Instructions: string | null;
+  },
+  SerializedLexicalNode
+>;

package/types/examind/nodes/VariableNode.ts

@@ -0,0 +1,24 @@
+import {
+  type SerializedLexicalNode,
+  type Spread,
+} from '../../lexical';
+
+export type VariableFormatsType = readonly [
+  '0',
+  '0,0',
+  '0,0.0',
+  '0,0.00',
+  '(0,0)',
+  '(0,0.00)',
+];
+
+export type SerializedVariableNode = Spread<
+  {
+    variableName: string;
+    variableFormat?: VariableFormatsType[number];
+    isBold?: boolean;
+    isItalic?: boolean;
+    isUnderline?: boolean;
+  },
+  SerializedLexicalNode
+>;

package/types/index.ts

@@ -0,0 +1,2 @@
+export * from './examind';
+export * from './lexical';

package/types/lexical/LexicalCommands.ts

@@ -0,0 +1,159 @@
+// THIS FILE IS AUTO-GENERATED
+// To regenerate, run: pnpm build (from the root of the project)
+
+// Type definitions based on Lexical
+// Original copyright: Meta Platforms, Inc. and affiliates.
+
+import type { LexicalCommand } from './LexicalEditor';
+import type { LexicalNode } from './LexicalNode';
+import type { BaseSelection } from './LexicalSelection';
+import type { ElementFormatType } from './nodes/LexicalElementNode';
+import type { TextFormatType } from './nodes/LexicalTextNode';
+export type PasteCommandType = ClipboardEvent | InputEvent | KeyboardEvent;
+export declare function createCommand<T>(type?: string): LexicalCommand<T>;
+export declare const SELECTION_CHANGE_COMMAND: LexicalCommand<void>;
+export declare const SELECTION_INSERT_CLIPBOARD_NODES_COMMAND: LexicalCommand<{
+    nodes: Array<LexicalNode>;
+    selection: BaseSelection;
+}>;
+export declare const CLICK_COMMAND: LexicalCommand<MouseEvent>;
+/**
+ * Dispatched to delete a character, the payload will be `true` if the deletion
+ * is backwards (backspace or delete on macOS) and `false` if forwards
+ * (delete or Fn+Delete on macOS).
+ */
+export declare const DELETE_CHARACTER_COMMAND: LexicalCommand<boolean>;
+/**
+ * Dispatched to insert a line break. With a false payload the
+ * cursor moves to the new line (Shift+Enter), with a true payload the cursor
+ * does not move (Ctrl+O on macOS).
+ */
+export declare const INSERT_LINE_BREAK_COMMAND: LexicalCommand<boolean>;
+export declare const INSERT_PARAGRAPH_COMMAND: LexicalCommand<void>;
+export declare const CONTROLLED_TEXT_INSERTION_COMMAND: LexicalCommand<InputEvent | string>;
+export declare const PASTE_COMMAND: LexicalCommand<PasteCommandType>;
+export declare const REMOVE_TEXT_COMMAND: LexicalCommand<InputEvent | null>;
+/**
+ * Dispatched to delete a word, the payload will be `true` if the deletion is
+ * backwards (Ctrl+Backspace or Opt+Delete on macOS), and `false` if
+ * forwards (Ctrl+Delete or Fn+Opt+Delete on macOS).
+ */
+export declare const DELETE_WORD_COMMAND: LexicalCommand<boolean>;
+/**
+ * Dispatched to delete a line, the payload will be `true` if the deletion is
+ * backwards (Cmd+Delete on macOS), and `false` if forwards
+ * (Fn+Cmd+Delete on macOS).
+ */
+export declare const DELETE_LINE_COMMAND: LexicalCommand<boolean>;
+/**
+ * Dispatched to format the selected text.
+ */
+export declare const FORMAT_TEXT_COMMAND: LexicalCommand<TextFormatType>;
+/**
+ * Dispatched on undo (Cmd+Z on macOS, Ctrl+Z elsewhere).
+ */
+export declare const UNDO_COMMAND: LexicalCommand<void>;
+/**
+ * Dispatched on redo (Shift+Cmd+Z on macOS, Shift+Ctrl+Z or Ctrl+Y elsewhere).
+ */
+export declare const REDO_COMMAND: LexicalCommand<void>;
+/**
+ * Dispatched when any key is pressed.
+ */
+export declare const KEY_DOWN_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched when the `'ArrowRight'` key is pressed.
+ * The shift modifier key may also be down.
+ */
+export declare const KEY_ARROW_RIGHT_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched when the move to end keyboard shortcut is pressed,
+ * (Cmd+Right on macOS; Ctrl+Right elsewhere).
+ */
+export declare const MOVE_TO_END: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched when the `'ArrowLeft'` key is pressed.
+ * The shift modifier key may also be down.
+ */
+export declare const KEY_ARROW_LEFT_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched when the move to start keyboard shortcut is pressed,
+ * (Cmd+Left on macOS; Ctrl+Left elsewhere).
+ */
+export declare const MOVE_TO_START: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched when the `'ArrowUp'` key is pressed.
+ * The shift and/or alt (option) modifier keys may also be down.
+ */
+export declare const KEY_ARROW_UP_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched when the `'ArrowUp'` key is pressed.
+ * The shift and/or alt (option) modifier keys may also be down.
+ */
+export declare const KEY_ARROW_DOWN_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched when the enter key is pressed, may also be called with a null
+ * payload when the intent is to insert a newline. The shift modifier key
+ * must be down, any other modifier keys may also be down.
+ */
+export declare const KEY_ENTER_COMMAND: LexicalCommand<KeyboardEvent | null>;
+/**
+ * Dispatched whenever the space (`' '`) key is pressed, any modifier
+ * keys may be down.
+ */
+export declare const KEY_SPACE_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched whenever the `'Backspace'` key is pressed, the shift
+ * modifier key may be down.
+ */
+export declare const KEY_BACKSPACE_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched whenever the `'Escape'` key is pressed, any modifier
+ * keys may be down.
+ */
+export declare const KEY_ESCAPE_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched whenever the `'Delete'` key is pressed (Fn+Delete on macOS).
+ */
+export declare const KEY_DELETE_COMMAND: LexicalCommand<KeyboardEvent>;
+/**
+ * Dispatched whenever the `'Tab'` key is pressed. The shift modifier key
+ * may be down.
+ */
+export declare const KEY_TAB_COMMAND: LexicalCommand<KeyboardEvent>;
+export declare const INSERT_TAB_COMMAND: LexicalCommand<void>;
+export declare const INDENT_CONTENT_COMMAND: LexicalCommand<void>;
+export declare const OUTDENT_CONTENT_COMMAND: LexicalCommand<void>;
+export declare const DROP_COMMAND: LexicalCommand<DragEvent>;
+export declare const FORMAT_ELEMENT_COMMAND: LexicalCommand<ElementFormatType>;
+export declare const DRAGSTART_COMMAND: LexicalCommand<DragEvent>;
+export declare const DRAGOVER_COMMAND: LexicalCommand<DragEvent>;
+export declare const DRAGEND_COMMAND: LexicalCommand<DragEvent>;
+/**
+ * Dispatched on a copy event, either via the clipboard or a KeyboardEvent
+ * (Cmd+C on macOS, Ctrl+C elsewhere).
+ */
+export declare const COPY_COMMAND: LexicalCommand<ClipboardEvent | KeyboardEvent | null>;
+/**
+ * Dispatched on a cut event, either via the clipboard or a KeyboardEvent
+ * (Cmd+X on macOS, Ctrl+X elsewhere).
+ */
+export declare const CUT_COMMAND: LexicalCommand<ClipboardEvent | KeyboardEvent | null>;
+/**
+ * Dispatched on the select all keyboard shortcut
+ * (Cmd+A on macOS, Ctrl+A elsehwere).
+ */
+export declare const SELECT_ALL_COMMAND: LexicalCommand<KeyboardEvent>;
+export declare const CLEAR_EDITOR_COMMAND: LexicalCommand<void>;
+export declare const CLEAR_HISTORY_COMMAND: LexicalCommand<void>;
+export declare const CAN_REDO_COMMAND: LexicalCommand<boolean>;
+export declare const CAN_UNDO_COMMAND: LexicalCommand<boolean>;
+export declare const FOCUS_COMMAND: LexicalCommand<FocusEvent>;
+export declare const BLUR_COMMAND: LexicalCommand<FocusEvent>;
+/**
+ * @deprecated in v0.31.0, use KEY_DOWN_COMMAND and check for modifiers
+ * directly.
+ *
+ * Dispatched after any KeyboardEvent when modifiers are pressed
+ */
+export declare const KEY_MODIFIER_COMMAND: LexicalCommand<KeyboardEvent>;

package/types/lexical/LexicalConstants.ts

@@ -0,0 +1,51 @@
+// THIS FILE IS AUTO-GENERATED
+// To regenerate, run: pnpm build (from the root of the project)
+
+// Type definitions based on Lexical
+// Original copyright: Meta Platforms, Inc. and affiliates.
+
+import type { ElementFormatType } from './nodes/LexicalElementNode';
+import type { TextDetailType, TextFormatType, TextModeType } from './nodes/LexicalTextNode';
+export declare const DOM_ELEMENT_TYPE = 1;
+export declare const DOM_TEXT_TYPE = 3;
+export declare const DOM_DOCUMENT_TYPE = 9;
+export declare const DOM_DOCUMENT_FRAGMENT_TYPE = 11;
+export declare const NO_DIRTY_NODES = 0;
+export declare const HAS_DIRTY_NODES = 1;
+export declare const FULL_RECONCILE = 2;
+export declare const IS_NORMAL = 0;
+export declare const IS_TOKEN = 1;
+export declare const IS_SEGMENTED = 2;
+export declare const IS_BOLD = 1;
+export declare const IS_ITALIC: number;
+export declare const IS_STRIKETHROUGH: number;
+export declare const IS_UNDERLINE: number;
+export declare const IS_CODE: number;
+export declare const IS_SUBSCRIPT: number;
+export declare const IS_SUPERSCRIPT: number;
+export declare const IS_HIGHLIGHT: number;
+export declare const IS_LOWERCASE: number;
+export declare const IS_UPPERCASE: number;
+export declare const IS_CAPITALIZE: number;
+export declare const IS_ALL_FORMATTING: number;
+export declare const IS_DIRECTIONLESS = 1;
+export declare const IS_UNMERGEABLE: number;
+export declare const IS_ALIGN_LEFT = 1;
+export declare const IS_ALIGN_CENTER = 2;
+export declare const IS_ALIGN_RIGHT = 3;
+export declare const IS_ALIGN_JUSTIFY = 4;
+export declare const IS_ALIGN_START = 5;
+export declare const IS_ALIGN_END = 6;
+export declare const NON_BREAKING_SPACE = "\u00A0";
+export declare const COMPOSITION_SUFFIX: string;
+export declare const DOUBLE_LINE_BREAK = "\n\n";
+export declare const COMPOSITION_START_CHAR: string;
+export declare const RTL_REGEX: RegExp;
+export declare const LTR_REGEX: RegExp;
+export declare const TEXT_TYPE_TO_FORMAT: Record<TextFormatType | string, number>;
+export declare const DETAIL_TYPE_TO_DETAIL: Record<TextDetailType | string, number>;
+export declare const ELEMENT_TYPE_TO_FORMAT: Record<Exclude<ElementFormatType, ''>, number>;
+export declare const ELEMENT_FORMAT_TO_TYPE: Record<number, ElementFormatType>;
+export declare const TEXT_MODE_TO_TYPE: Record<TextModeType, 0 | 1 | 2>;
+export declare const TEXT_TYPE_TO_MODE: Record<number, TextModeType>;
+export declare const NODE_STATE_KEY = "$";