@qoretechnologies/reqraft 0.10.64 → 0.10.65-pr.137.g62fcecc

package/src/utils/lspClient.types.ts

@@ -1,211 +0,0 @@
-// Copyright 2026 Qore Technologies, s.r.o.
-//
-// Minimal LSP type subset used by `ReqraftLspClient` — intentionally narrow;
-// language-specific wrappers layer richer types on top.
-
-/** Zero-based line + UTF-16 character offset. */
-export interface ILspPosition {
-  line: number;
-  character: number;
-}
-
-/** Inclusive start, exclusive end — per LSP convention. */
-export interface ILspRange {
-  start: ILspPosition;
-  end: ILspPosition;
-}
-
-/**
- * Diagnostic delivered via `textDocument/publishDiagnostics` notifications
- * or returned synchronously from language-specific `<lang>/validate` methods.
- */
-export interface ILspDiagnostic {
-  range: ILspRange;
-  message: string;
-  /** LSP DiagnosticSeverity: 1 = Error, 2 = Warning, 3 = Information, 4 = Hint */
-  severity?: number;
-  code?: string | number;
-  source?: string;
-}
-
-/**
- * Completion item from `textDocument/completion`. `kind` follows the LSP
- * CompletionItemKind enum (1 = Text, 2 = Method, 3 = Function, …).
- *
- * When the server supplies a `textEdit`, that is the authoritative way to
- * apply the completion — the range tells the client exactly which span of
- * the document to replace (including any partial token the user already
- * typed). Falling back to `insertText` without using `textEdit` can lead to
- * the partial token being duplicated (e.g. typed `-` + inserted `--desc=`
- * becomes `---desc=`).
- */
-export interface ILspCompletionItem {
-  label: string;
-  kind?: number;
-  detail?: string;
-  insertText?: string;
-  /** 1 = PlainText, 2 = Snippet */
-  insertTextFormat?: number;
-  documentation?: ILspMarkupContent | string | null;
-  sortText?: string;
-  filterText?: string;
-  /**
-   * Authoritative edit instructions from the server. When present, the
-   * `range` is the span to replace (start/end as line/character positions
-   * in the plain-text projection of the document) and `newText` is what
-   * to put there. Consumers should prefer `textEdit` over `insertText`.
-   */
-  textEdit?: {
-    range: ILspRange;
-    newText: string;
-  };
-  /** Characters that auto-accept this completion when typed after it. */
-  commitCharacters?: string[];
-  /**
-   * Opaque server-supplied data carried with the item. Qonsole uses
-   * this to encode wizard launch metadata (`{action: 'start-wizard',
-   * name, start_path, ...}`) and per-kind hints (verb aliases, flag
-   * types, etc.). The client passes it back via `completionItem/resolve`
-   * if implemented; for now consumers (inserters, custom click
-   * handlers) read it directly.
-   */
-  data?: Record<string, unknown>;
-  /**
-   * Server-side warning copy attached to specific items — Qonsole
-   * uses this on mutating verbs ("Changes system state; execution
-   * may require confirmation."). Rendered as a right-aligned chip
-   * in the dropdown row.
-   */
-  warning?: string;
-  /**
-   * Command to execute on accept INSTEAD OF inserting `insertText`/
-   * `textEdit`. Used by Qonsole for wizard launch items
-   * (`{ command: 'qonsole.startWizard', arguments: [{...}] }`).
-   * Standard LSP shape; the client is responsible for executing it
-   * (the server rejects `workspace/executeCommand` for `qonsole.*`).
-   */
-  command?: {
-    title: string;
-    command: string;
-    arguments?: unknown[];
-  };
-}
-
-/** Rich-text content from hover / completion documentation. */
-export interface ILspMarkupContent {
-  kind: 'plaintext' | 'markdown';
-  value: string;
-}
-
-/**
- * Token legend advertised by the server in
- * `initialize → capabilities.semanticTokensProvider.legend`. Both
- * arrays are positional — a semantic token's encoded `tokenType` int
- * is an index into `tokenTypes`, and its encoded `tokenModifiers` int
- * is a bitmask over `tokenModifiers`. The standard LSP legend has 16
- * token types and 6 modifiers, but servers may extend either list.
- */
-export interface ILspSemanticTokensLegend {
-  tokenTypes: string[];
-  tokenModifiers: string[];
-}
-
-/**
- * Decoded semantic-token span (the int-array → human-friendly form
- * the editor consumes). `tokenType` / `tokenModifiers` are already
- * resolved against the server's legend.
- */
-export interface ILspSemanticToken {
-  /** 0-based line number in the document. */
-  line: number;
-  /** 0-based column (UTF-16) on that line. */
-  character: number;
-  /** Token length in characters. */
-  length: number;
-  /** Resolved type name (e.g. `"keyword"`, `"variable"`, `"string"`). */
-  tokenType: string;
-  /** Resolved modifier names from the bitmask. */
-  tokenModifiers: string[];
-}
-
-/**
- * One parameter inside a signature. `label` is either a substring of
- * the parent signature's `label` or a literal name string. `documentation`
- * carries optional markdown / plaintext explainer.
- */
-export interface ILspParameterInformation {
-  label: string | [number, number];
-  documentation?: ILspMarkupContent | string | null;
-}
-
-/**
- * A single function / operator signature. `parameters` lists the
- * positional parameters in order; the consumer highlights the one at
- * `activeParameter` from the parent `ILspSignatureHelp`.
- */
-export interface ILspSignatureInformation {
-  label: string;
-  documentation?: ILspMarkupContent | string | null;
-  parameters?: ILspParameterInformation[];
-  /** Per-signature active parameter override (LSP spec optional). */
-  activeParameter?: number;
-}
-
-/**
- * Response shape for `textDocument/signatureHelp`. Empty `signatures`
- * means "no help available at this position".
- */
-export interface ILspSignatureHelp {
-  signatures: ILspSignatureInformation[];
-  /** Index into `signatures` of the active overload. Default 0. */
-  activeSignature?: number;
-  /** Index into the active signature's `parameters`. Default 0. */
-  activeParameter?: number;
-}
-
-/**
- * Minimal projection of the server's `initialize` response
- * `capabilities` block — only the providers we currently read on the
- * client. Hooks gate themselves on the presence of the relevant
- * provider so an editor talking to a server that doesn't support a
- * feature degrades to no-op rather than erroring.
- */
-export interface ILspServerCapabilities {
-  completionProvider?: {
-    triggerCharacters?: string[];
-    resolveProvider?: boolean;
-  };
-  signatureHelpProvider?: {
-    triggerCharacters?: string[];
-    retriggerCharacters?: string[];
-  };
-  hoverProvider?: boolean | { workDoneProgress?: boolean };
-  semanticTokensProvider?: {
-    legend: ILspSemanticTokensLegend;
-    full?: boolean | object;
-    range?: boolean | object;
-  };
-  codeActionProvider?:
-    | boolean
-    | {
-        codeActionKinds?: string[];
-        resolveProvider?: boolean;
-      };
-  /** Allow unknown providers to pass through for forward compat. */
-  [key: string]: unknown;
-}
-
-/** Edit returned by `textDocument/formatting`. */
-export interface ILspTextEdit {
-  range: ILspRange;
-  newText: string;
-}
-
-/**
- * Document text payload for `didOpen` / `didChange`. Plain string is the
- * standard LSP shape; some Qorus-language servers (e.g. DPQL) also accept
- * a structured richtext envelope `{ type: 'richtext', value: [...] }` that
- * the server flattens server-side. Consumers that don't need the richtext
- * form should pass a string.
- */
-export type TLspDocumentText = string | { type: 'richtext'; value: unknown[] };

package/src/utils/queryUnlessCancelled.ts

@@ -1,28 +0,0 @@
-import { IReqraftFetchResponse, IReqraftQueryConfig, isQueryCancelled, query } from './fetch';
-
-/**
- * `query`, answering `undefined` when the request was abandoned (see
- * `isQueryCancelled`) instead of rejecting.
- *
- * For a component that fires a request from an effect and only wants to know
- * what the server said: an abandoned request has nothing to say, and left to
- * reject it escaped the effect as an unhandled rejection - which a story runner
- * reports as the story failing. Every other rejection still rejects.
- *
- * In a module of its own rather than beside `query`, so that it calls `query`
- * through the module's export: a test that mocks `../utils/fetch` reaches the
- * request this makes as well.
- */
-export async function queryUnlessCancelled<T>(
-  config: IReqraftQueryConfig
-): Promise<IReqraftFetchResponse<T> | undefined> {
-  try {
-    return await query<T>(config);
-  } catch (error) {
-    if (isQueryCancelled(error)) {
-      return undefined;
-    }
-
-    throw error;
-  }
-}

package/src/utils/websocket.ts

@@ -1,293 +0,0 @@
-import { forEach } from 'lodash';
-import { nanoid } from 'nanoid';
-import { fetchConfig, query } from './fetch';
-
-export interface IReqraftWebSocketConfig {
-  url: string;
-  pooled?: boolean;
-  reconnect?: boolean;
-  reconnectInterval?: number;
-  maxReconnectTries?: number;
-  useHeartbeat?: boolean;
-  onOpen?: (ev?: Event) => void;
-  onMessage?: (ev: MessageEvent) => void;
-  onClose?: (ev?: CloseEvent) => void;
-  onError?: (ev?: Event) => void;
-  onReconnecting?: (reconnectNumber?: number) => void;
-  onReconnectFailed?: () => void;
-  tokenOverride?: string;
-}
-
-/**
- * The URL a socket for `path` dials on `instance`: `http(s)` becomes `ws(s)`,
- * and the token, when there is one, rides in the query. The single definition —
- * story mocks build their URLs with it too, so they cannot drift from it.
- */
-export const buildReqraftSocketUrl = (instance: string, path: string, token?: string): string => {
-  let wsUrl = instance.replace('http', 'ws');
-
-  if (wsUrl.endsWith('/')) {
-    wsUrl = wsUrl.slice(0, -1);
-  }
-
-  return `${wsUrl}/${path}${token ? `?token=${token}` : ''}`;
-};
-
-export class ReqraftWebSocketsManager {
-  public static defaultConfig: IReqraftWebSocketConfig = {
-    reconnect: true,
-    url: '',
-    maxReconnectTries: 10,
-    reconnectInterval: 5000,
-    useHeartbeat: true,
-  };
-  public static connections: Record<
-    string,
-    { socket: WebSocket; using: number; heartbeat?: NodeJS.Timeout }
-  > = {};
-
-  public static closeAll() {
-    forEach(this.connections, (connection) => {
-      connection.socket.close(4999);
-      delete this.connections[connection.socket.url];
-    });
-  }
-
-  public static addHandler(
-    url: string,
-    event: keyof WebSocketEventMap,
-    handler: (ev: Event | MessageEvent | CloseEvent) => void
-  ) {
-    this.connections[url]?.socket.addEventListener(event, handler);
-
-    return () => {
-      this.connections[url]?.socket.removeEventListener(event, handler);
-    };
-  }
-
-  public static removeHandler(
-    url: string,
-    event: keyof WebSocketEventMap,
-    handler: (ev: Event | MessageEvent | CloseEvent) => void
-  ) {
-    this.connections[url]?.socket.removeEventListener(event, handler);
-  }
-}
-
-export class ReqraftWebSocket {
-  public isConnected: boolean;
-  public reconnectTries: number = 0;
-  public reconnectInterval: NodeJS.Timeout;
-  public options: IReqraftWebSocketConfig;
-  public readonly handlers: Record<
-    string,
-    { type: keyof WebSocketEventMap; event: (ev: Event) => void }
-  > = {};
-  public socket: WebSocket;
-  private _poolKey: string;
-
-  constructor(config: IReqraftWebSocketConfig) {
-    this.isConnected = true;
-    this.reconnectTries = 0;
-    this.reconnectInterval = null;
-    this.options = { ...ReqraftWebSocketsManager.defaultConfig, ...config };
-    this._poolKey =
-      this.options.pooled === false ? `${this.options.url}::${nanoid()}` : this.options.url;
-
-    this.connect();
-  }
-
-  public addHandler(
-    event: keyof WebSocketEventMap,
-    handler: (ev: Event | MessageEvent | CloseEvent) => void
-  ) {
-    const id = nanoid();
-
-    this.handlers[id] = { type: event, event: handler };
-
-    ReqraftWebSocketsManager.addHandler(this._poolKey, event, handler);
-
-    return id;
-  }
-
-  public removeHandler(id: string) {
-    if (!this.handlers[id]) return;
-
-    ReqraftWebSocketsManager.removeHandler(
-      this._poolKey,
-      this.handlers[id].type,
-      this.handlers[id].event
-    );
-
-    delete this.handlers[id];
-  }
-
-  private getSocketUrl() {
-    return buildReqraftSocketUrl(
-      fetchConfig.instance,
-      this.options.url,
-      this.options.tokenOverride || fetchConfig.instanceToken
-    );
-  }
-
-  public connect() {
-    if (!ReqraftWebSocketsManager.connections[this._poolKey]) {
-      this.socket = new WebSocket(this.getSocketUrl());
-      this.socket.onopen = (ev) => {
-        this.reconnectTries = 0;
-        this.isConnected = true;
-
-        clearInterval(this.reconnectInterval);
-
-        this.reconnectInterval = undefined;
-
-        if (this.options.useHeartbeat) {
-          this.startHeartbeat();
-        }
-
-        this.options?.onOpen?.(ev);
-      };
-
-      ReqraftWebSocketsManager.connections[this._poolKey] = {
-        socket: this.socket,
-        using: 0,
-      };
-    } else {
-      this.socket = ReqraftWebSocketsManager.connections[this._poolKey].socket;
-      this.options?.onOpen?.(null);
-    }
-
-    // Increment the number of parts using this connection
-    ReqraftWebSocketsManager.connections[this._poolKey].using++;
-
-    if (this.options?.onMessage) {
-      this.addHandler('message', (event) => {
-        if ((<MessageEvent>event).data === 'pong') {
-          return;
-        }
-
-        this.options?.onMessage?.(<MessageEvent>event);
-      });
-    }
-
-    this.addHandler('close', (event) => {
-      this.options?.onClose?.(<CloseEvent>event);
-      this.stopHeartbeat();
-      this.removeAllHandlers();
-
-      delete ReqraftWebSocketsManager.connections[this._poolKey];
-
-      // Start the reconnect process
-      this.maybeReconnect((<CloseEvent>event).code);
-    });
-
-    this.addHandler('error', (event) => {
-      this.options?.onError?.(event);
-    });
-  }
-
-  public send(data: string) {
-    this.socket.send(data);
-  }
-
-  public async checkServerStatus() {
-    // If this results in a 401, the server will redirect automatically
-    await query({ url: '/system/pid', cache: false });
-  }
-
-  private async tryReconnect() {
-    this.reconnectTries++;
-    this.options?.onReconnecting?.(this.reconnectTries);
-
-    // The probe is ADVISORY: its only job is to let a dead session redirect on a
-    // 401 before we retry. It must never gate the reconnect itself.
-    //
-    // `query()` rejects on a network error, and a network error is the normal
-    // state while reconnecting — the server being unreachable is why we are
-    // here. Awaiting it unguarded meant the throw skipped `connect()`, so the
-    // socket never closed again, so `maybeReconnect()` was never called again:
-    // the state machine stopped silently, mid-way, with no further attempts and
-    // no `onReconnectFailed`. A caller waiting to be told the reconnect gave up
-    // waits forever, and the UI sits on CONNECTING.
-    //
-    // It surfaced as a CI-only story failure because a dev machine answers
-    // `/system/pid` (so the probe resolves and the chain advances) while CI has
-    // no server behind it — the same difference that makes it a REAL bug, since
-    // production has no server behind it either at exactly this moment.
-    try {
-      await this.checkServerStatus();
-    } catch (error) {
-      // deliberately ignored — see above
-    }
-
-    this.connect();
-  }
-
-  public maybeReconnect(closeCode: number) {
-    if (this.options.reconnect && closeCode !== 4999) {
-      // If this is the first reconnect try
-      if (this.reconnectTries === 0) {
-        this.tryReconnect();
-
-        return;
-      }
-
-      // If we haven't reached the max number of reconnect tries
-      if (this.reconnectTries < this.options.maxReconnectTries) {
-        this.reconnectInterval = setTimeout(
-          this.tryReconnect.bind(this),
-          this.options.reconnectInterval
-        );
-
-        return;
-      }
-
-      // Reconnect failed
-      this.isConnected = false;
-      this.reconnectInterval = undefined;
-      this.reconnectTries = 0;
-
-      this.options.onReconnectFailed?.();
-    }
-  }
-
-  public remove() {
-    if (!ReqraftWebSocketsManager.connections[this._poolKey]) return;
-    // Decrement the number of parts using this connection
-    ReqraftWebSocketsManager.connections[this._poolKey].using--;
-    // If this is the last part using the connection, close it
-    if (ReqraftWebSocketsManager.connections[this._poolKey].using === 0) {
-      this.close();
-      return;
-    }
-
-    // Remove all handlers
-    this.removeAllHandlers();
-  }
-
-  public close() {
-    this.socket.close(4999);
-  }
-
-  public removeAllHandlers() {
-    forEach(this.handlers, (_handler, id) => {
-      this.removeHandler(id);
-    });
-  }
-
-  private startHeartbeat() {
-    // Start the heartbeat
-    clearInterval(ReqraftWebSocketsManager.connections[this._poolKey].heartbeat);
-    ReqraftWebSocketsManager.connections[this._poolKey].heartbeat = null;
-    ReqraftWebSocketsManager.connections[this._poolKey].heartbeat = setInterval(() => {
-      this.socket.send('ping');
-    }, 3000);
-  }
-
-  private stopHeartbeat() {
-    if (!ReqraftWebSocketsManager.connections[this._poolKey]) return;
-
-    clearInterval(ReqraftWebSocketsManager.connections[this._poolKey].heartbeat);
-    ReqraftWebSocketsManager.connections[this._poolKey].heartbeat = null;
-  }
-}

package/vite.config.ts

@@ -1,58 +0,0 @@
-import react from '@vitejs/plugin-react';
-import { defineConfig, loadEnv } from 'vite';
-
-// The old webpack `env` block injected these into process.env. Vite doesn't
-// define `process` in the browser, so source/stories that read
-// process.env.REACT_APP_QORUS_* (and NODE_ENV/CI) get `undefined` and the live
-// editor stories then 401.
-//
-// Source the values from BOTH .env files AND the shell: the Storybook webpack
-// builder used to auto-load `.env`/`.env.local` (see .gitignore), so a token
-// kept in a gitignored `.env.local` worked without retyping it each launch.
-// `loadEnv(mode, cwd, '')` reads all keys (empty prefix, not just VITE_); the
-// shell still wins (e.g. `REACT_APP_QORUS_TOKEN=… yarn storybook`).
-//
-// NOTE: keep this a module-level call + a plain OBJECT export. vitest.config.ts
-// does `mergeConfig(viteConfig, …)`, which throws "Cannot merge config in form
-// of callback" if this file exports the `defineConfig(() => …)` function form.
-const fileEnv = loadEnv(process.env.NODE_ENV || 'development', process.cwd(), '');
-// Resolve a value from the shell, then .env files. Accepts fallback keys so a
-// globally-exported `QORUS_TOKEN` (the CI secret name, and what's commonly set
-// in the shell) is picked up even though the app reads `REACT_APP_QORUS_TOKEN`.
-// Locally nothing ever bridged the two; CI bridges them in the workflow yaml.
-const env = (...keys: string[]) => {
-  for (const key of keys) {
-    if (process.env[key]) return process.env[key] as string;
-    if (fileEnv[key]) return fileEnv[key];
-  }
-  return '';
-};
-
-export default defineConfig({
-  plugins: [react()],
-  resolve: {
-    // Ensure a single React instance across stories, the renderer and
-    // styled-components. Webpack deduped automatically; Vite needs this to
-    // avoid "A React Element from an older version of React was rendered".
-    dedupe: ['react', 'react-dom', 'react/jsx-runtime'],
-  },
-  // The Storybook Vite builder picks up this define, and the Vitest browser
-  // project merges this config — so both paths get the token.
-  define: {
-    // Map Node's `global` to the browser's globalThis. Some deps reference it —
-    // e.g. storybook-addon-mock's faker does `global.XMLHttpRequest`, which would
-    // throw "global is not defined" in the Vitest/Storybook browser otherwise.
-    global: 'globalThis',
-    'process.env.NODE_ENV': JSON.stringify(process.env.NODE_ENV || 'storybook'),
-    'process.env.CI': JSON.stringify(env('CI')),
-    // Fall back to the unprefixed QORUS_TOKEN / QORUS_INSTANCE — the globally
-    // exported vars (qorus-ide reads the same QORUS_TOKEN). So a global
-    // QORUS_TOKEN now reaches Storybook without setting REACT_APP_QORUS_TOKEN.
-    'process.env.REACT_APP_QORUS_TOKEN': JSON.stringify(
-      env('REACT_APP_QORUS_TOKEN', 'QORUS_TOKEN')
-    ),
-    'process.env.REACT_APP_QORUS_INSTANCE': JSON.stringify(
-      env('REACT_APP_QORUS_INSTANCE', 'QORUS_INSTANCE')
-    ),
-  },
-});

package/vitest.config.ts

@@ -1,69 +0,0 @@
-import { qlipVitestPlugin } from '@qoretechnologies/qlip';
-import { storybookTest } from '@storybook/addon-vitest/vitest-plugin';
-import { playwright } from '@vitest/browser-playwright';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { defineConfig, mergeConfig } from 'vitest/config';
-import viteConfig from './vite.config';
-
-const dirname = path.dirname(fileURLToPath(import.meta.url));
-
-// qlip uploads only when a token is provided (CI). Local runs still capture
-// snapshots via the plugin's `auto` mode but skip the upload step.
-const qlipUploadToken = process.env.QLIP_UPLOAD_TOKEN;
-
-export default mergeConfig(
-  viteConfig,
-  defineConfig({
-    test: {
-      projects: [
-        // Component/interaction tests: run every story in a real browser via
-        // Playwright. Replaces the former @storybook/test-runner.
-        {
-          extends: true,
-          plugins: [
-            qlipVitestPlugin({
-              auto: true,
-              captureOnError: true,
-              disableAnimations: true,
-              pauseAnimationsAtEnd: true,
-              viewport: { width: 1920, height: 1080 },
-              ...(qlipUploadToken ? { upload: { uploadToken: qlipUploadToken } } : {}),
-            }),
-            storybookTest({
-              configDir: path.join(dirname, '.storybook'),
-              storybookScript: 'yarn storybook --no-open',
-            }),
-          ],
-          test: {
-            name: 'storybook',
-            browser: {
-              enabled: true,
-              provider: playwright({}),
-              headless: true,
-              // Match the Chromatic snapshot viewport (preview.tsx sets [1440]).
-              viewport: { width: 1440, height: 900 },
-              instances: [{ browser: 'chromium' }],
-            },
-            setupFiles: ['./.storybook/vitest.setup.ts'],
-            // Some interaction stories deliberately render slow content (LSP /
-            // websocket editors) and the shared play helpers wait up to ~17s.
-            testTimeout: 30000,
-          },
-        },
-        // Unit tests: the former Jest suite, now on Vitest + jsdom.
-        {
-          extends: true,
-          test: {
-            name: 'unit',
-            globals: true,
-            environment: 'jsdom',
-            include: ['__tests__/**/*.test.{ts,tsx}'],
-            setupFiles: ['./__tests__/setup.ts'],
-            testTimeout: 30000,
-          },
-        },
-      ],
-    },
-  })
-);