summaryrefslogtreecommitdiff
path: root/packages/core/src/ide/ideContext.ts
blob: bc7383a1225641c7deb0b22b211b6c6fbcae0bdb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/**
 * @license
 * Copyright 2025 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

import { z } from 'zod';

/**
 * Zod schema for validating a cursor position.
 */
export const CursorSchema = z.object({
  line: z.number(),
  character: z.number(),
});
export type Cursor = z.infer<typeof CursorSchema>;

/**
 * Zod schema for validating an active file context from the IDE.
 */
export const OpenFilesSchema = z.object({
  activeFile: z.string(),
  selectedText: z.string().optional(),
  cursor: CursorSchema.optional(),
  recentOpenFiles: z
    .array(
      z.object({
        filePath: z.string(),
        timestamp: z.number(),
      }),
    )
    .optional(),
});
export type OpenFiles = z.infer<typeof OpenFilesSchema>;

/**
 * Zod schema for validating the 'ide/openFilesChanged' notification from the IDE.
 */
export const OpenFilesNotificationSchema = z.object({
  method: z.literal('ide/openFilesChanged'),
  params: OpenFilesSchema,
});

type OpenFilesSubscriber = (openFiles: OpenFiles | undefined) => void;

/**
 * Creates a new store for managing the IDE's active file context.
 * This factory function encapsulates the state and logic, allowing for the creation
 * of isolated instances, which is particularly useful for testing.
 *
 * @returns An object with methods to interact with the active file context.
 */
export function createIdeContextStore() {
  let openFilesContext: OpenFiles | undefined = undefined;
  const subscribers = new Set<OpenFilesSubscriber>();

  /**
   * Notifies all registered subscribers about the current active file context.
   */
  function notifySubscribers(): void {
    for (const subscriber of subscribers) {
      subscriber(openFilesContext);
    }
  }

  /**
   * Sets the active file context and notifies all registered subscribers of the change.
   * @param newOpenFiles The new active file context from the IDE.
   */
  function setOpenFilesContext(newOpenFiles: OpenFiles): void {
    openFilesContext = newOpenFiles;
    notifySubscribers();
  }

  /**
   * Clears the active file context and notifies all registered subscribers of the change.
   */
  function clearOpenFilesContext(): void {
    openFilesContext = undefined;
    notifySubscribers();
  }

  /**
   * Retrieves the current active file context.
   * @returns The `OpenFiles` object if a file is active; otherwise, `undefined`.
   */
  function getOpenFilesContext(): OpenFiles | undefined {
    return openFilesContext;
  }

  /**
   * Subscribes to changes in the active file context.
   *
   * When the active file context changes, the provided `subscriber` function will be called.
   * Note: The subscriber is not called with the current value upon subscription.
   *
   * @param subscriber The function to be called when the active file context changes.
   * @returns A function that, when called, will unsubscribe the provided subscriber.
   */
  function subscribeToOpenFiles(subscriber: OpenFilesSubscriber): () => void {
    subscribers.add(subscriber);
    return () => {
      subscribers.delete(subscriber);
    };
  }

  return {
    setOpenFilesContext,
    getOpenFilesContext,
    subscribeToOpenFiles,
    clearOpenFilesContext,
  };
}

/**
 * The default, shared instance of the IDE context store for the application.
 */
export const ideContext = createIdeContextStore();