@opensumi/ide-editor 3.2.5-next-1725353631.0 → 3.2.5-next-1725358238.0

package/src/browser/notebook.service.ts

@@ -0,0 +1,19 @@
+import { Injectable } from '@opensumi/di';
+import { Emitter, Event, UriComponents, WithEventBus } from '@opensumi/ide-core-browser';
+
+import type { INotebookModelAddedData, INotebookService, NotebookDataDto, NotebookDocumentChangeDto } from './types';
+
+@Injectable()
+export class NotebookService extends WithEventBus implements INotebookService {
+  createNotebook: (data?: NotebookDataDto) => Promise<{ uri: UriComponents }>;
+  openNotebook: (uriComponents: UriComponents) => Promise<{ uri: UriComponents }>;
+  saveNotebook: (uriComponents: UriComponents) => Promise<boolean>;
+  protected _onDidOpenNotebookDocument = new Emitter<INotebookModelAddedData>();
+  onDidOpenNotebookDocument: Event<INotebookModelAddedData> = this._onDidOpenNotebookDocument.event;
+  protected _onDidCloseNotebookDocument = new Emitter<UriComponents>();
+  onDidCloseNotebookDocument: Event<UriComponents> = this._onDidCloseNotebookDocument.event;
+  protected _onDidSaveNotebookDocument = new Emitter<UriComponents>();
+  onDidSaveNotebookDocument: Event<UriComponents> = this._onDidSaveNotebookDocument.event;
+  protected _onDidChangeNotebookDocument = new Emitter<NotebookDocumentChangeDto>();
+  onDidChangeNotebookDocument: Event<NotebookDocumentChangeDto> = this._onDidChangeNotebookDocument.event;
+}

package/src/browser/tab.view.tsx

@@ -567,6 +567,11 @@ export const EditorActions = forwardRef<HTMLDivElement, IEditorActionsProps>(
     const [hasFocus, setHasFocus] = useState<boolean>(editorService.currentEditorGroup === group);
     const [args, setArgs] = useState<[URI, IEditorGroup, MaybeNull<URI>] | undefined>(acquireArgs());
 
+    /**
+     * 集成场景下可以不展示任何菜单，可以用以下代码取消菜单注册
+     * registry.unregisterMenuId(MenuId.EditorTitle);
+     * registry.unregisterMenuId(MenuId.EditorTitleRun);
+     */
     const noActions = menu.getMergedMenuNodes().length === 0;
 
     useEffect(() => {

package/src/browser/untitled-resource.ts

@@ -171,8 +171,8 @@ export class UntitledSchemeResourceProvider extends WithEventBus implements IRes
   }
 
   async shouldCloseResourceWithoutConfirm(resource: IResource) {
-    const documentModelRef = this.documentModelService.getModelReference(resource.uri, 'close-resource-check');
-    if (documentModelRef && documentModelRef.instance.dirty) {
+    const documentModelRef = this.documentModelService.getModelDescription(resource.uri, 'close-resource-check');
+    if (documentModelRef && documentModelRef.dirty) {
       return true;
     }
     return false;
@@ -195,16 +195,14 @@ export class UntitledSchemeResourceProvider extends WithEventBus implements IRes
       documentModelRef.dispose();
       return false;
     } else {
+      documentModelRef.dispose();
       return true;
     }
   }
 
   async shouldCloseResource(resource: IResource) {
-    const documentModelRef = this.documentModelService.getModelReference(resource.uri, 'close-resource-check');
-    if (!documentModelRef || !documentModelRef.instance.dirty) {
-      if (documentModelRef) {
-        documentModelRef.dispose();
-      }
+    const documentModelRef = this.documentModelService.getModelDescription(resource.uri, 'close-resource-check');
+    if (!documentModelRef || !documentModelRef.dirty) {
       return true;
     }
     // 询问用户是否保存

package/src/browser/workbench-editor.service.ts

@@ -44,6 +44,7 @@ import {
   debounce,
   formatLocalize,
   getDebugLogger,
+  isDefined,
   isUndefinedOrNull,
   localize,
   makeRandomHexString,
@@ -435,10 +436,9 @@ export class WorkbenchEditorServiceImpl extends WithEventBus implements Workbenc
     // contextKeys
     const getLanguageFromModel = (uri: URI) => {
       let result: string | null = null;
-      const modelRef = this.documentModelManager.getModelReference(uri, 'resourceContextKey');
+      const modelRef = this.documentModelManager.getModelDescription(uri, 'resourceContextKey');
       if (modelRef) {
-        result = modelRef.instance.languageId;
-        modelRef.dispose();
+        result = modelRef.languageId;
       }
       return result;
     };
@@ -717,12 +717,10 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
   /**
    * 当前打开的所有resource
    */
-  // @observable.shallow
   resources: IResource[] = [];
 
   resourceStatus: Map<IResource, Promise<void>> = new Map();
 
-  // @observable.ref
   _currentResource: IResource | null;
 
   _currentOpenType: IEditorOpenType | null;
@@ -894,12 +892,9 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
     if (!this._resourceContext) {
       const getLanguageFromModel = (uri: URI) => {
         let result: string | null = null;
-        const modelRef = this.documentModelManager.getModelReference(uri, 'resourceContextKey');
+        const modelRef = this.documentModelManager.getModelDescription(uri, 'resourceContextKey');
         if (modelRef) {
-          if (modelRef) {
-            result = modelRef.instance.languageId;
-          }
-          modelRef.dispose();
+          result = modelRef.languageId;
         }
         return result;
       };
@@ -1414,6 +1409,9 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
           if (options && options.label) {
             resource.name = options.label;
           }
+          if (options && isDefined(options.supportsRevive)) {
+            resource.supportsRevive = options.supportsRevive;
+          }
           let replaceResource: IResource | null = null;
           if (options && options.index !== undefined && options.index < this.resources.length) {
             replaceResource = this.resources[options.index];
@@ -2305,9 +2303,7 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
     // 否则使用 document 进行保存 (如果有)
     const docRef = this.documentModelManager.getModelReference(resource.uri);
     if (docRef) {
-      if (docRef.instance.dirty) {
-        await docRef.instance.save(undefined, reason);
-      }
+      await docRef.instance.save(undefined, reason);
       docRef.dispose();
     }
   }
@@ -2340,11 +2336,9 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
 
   hasDirty(): boolean {
     for (const r of this.resources) {
-      const docRef = this.documentModelManager.getModelReference(r.uri);
+      const docRef = this.documentModelManager.getModelDescription(r.uri);
       if (docRef) {
-        const isDirty = docRef.instance.dirty;
-        docRef.dispose();
-        if (isDirty) {
+        if (docRef.dirty) {
           return true;
         }
       }
@@ -2358,15 +2352,13 @@ export class EditorGroup extends WithEventBus implements IGridEditorGroup {
   calcDirtyCount(countedUris: Set<string> = new Set<string>()): number {
     let count = 0;
     for (const r of this.resources) {
-      const docRef = this.documentModelManager.getModelReference(r.uri, 'calc-dirty-count');
+      const docRef = this.documentModelManager.getModelDescription(r.uri, 'calc-dirty-count');
       if (countedUris.has(r.uri.toString())) {
         continue;
       }
       countedUris.add(r.uri.toString());
       if (docRef) {
-        const isDirty = docRef.instance.dirty;
-        docRef.dispose();
-        if (isDirty) {
+        if (docRef.dirty) {
           count += 1;
         }
       }

package/src/common/editor.ts

@@ -29,10 +29,66 @@ import type { ITextModel, ITextModelUpdateOptions } from '@opensumi/monaco-edito
 
 export { ShowLightbulbIconMode } from '@opensumi/ide-monaco';
 
+export interface IEditorDocumentDescription {
+  /**
+   * 文档URI
+   */
+  readonly uri: URI;
+
+  /**
+   * A unique identifier associated with this model.
+   */
+  readonly id: string;
+
+  /**
+   * 编码
+   */
+  readonly encoding: string;
+
+  /**
+   * 行末结束
+   */
+  readonly eol: EOL;
+
+  /**
+   * 语言Id
+   */
+  readonly languageId: string;
+
+  /**
+   * 是否被修改过
+   */
+  readonly dirty: boolean;
+
+  /**
+   * 能否修改
+   */
+  readonly readonly: boolean;
+
+  /**
+   * 能否保存
+   */
+  readonly savable: boolean;
+
+  /**
+   * 是否永远都显示 dirty
+   */
+  readonly alwaysDirty: boolean;
+
+  /**
+   * 即便是 dirty 也要被 dispose
+   */
+  readonly disposeEvenDirty: boolean;
+
+  /**
+   * 是否关闭自动保存功能
+   */
+  readonly closeAutoSave: boolean;
+}
+
 /**
  * editorDocumentModel is a wrapped concept for monaco's textModel
  */
-
 export interface IEditorDocumentModel extends IDisposable {
   /**
    * 文档URI
@@ -636,6 +692,8 @@ export interface IResourceOpenOptions {
    * 当关闭时指定 force 参数，用来跳过 shouldClose 等逻辑
    */
   forceClose?: boolean;
+
+  supportsRevive?: boolean;
 }
 
 export interface IResourceOpenResult {

package/src/common/index.ts

@@ -1,7 +1,8 @@
+export * from './components';
 export * from './doc-cache';
 export * from './editor';
-export * from './resource';
 export * from './language';
-export * from './utils';
 export * from './language-status';
-export * from './components';
+export * from './notebook';
+export * from './resource';
+export * from './utils';

package/src/common/language.ts

@@ -201,6 +201,7 @@ export interface LanguageFilter {
   scheme?: string;
   pattern?: string | IRelativePattern;
   hasAccessToAllModels?: boolean;
+  notebookType?: string;
 }
 
 export type LanguageSelector = string | LanguageFilter | (string | LanguageFilter)[];

package/src/common/notebook.ts

@@ -0,0 +1,196 @@
+import { Event, IRange, UriComponents } from '@opensumi/ide-core-common';
+
+export enum NotebookCellsChangeType {
+  ModelChange = 1,
+  Move = 2,
+  ChangeCellLanguage = 5,
+  Initialize = 6,
+  ChangeCellMetadata = 7,
+  Output = 8,
+  OutputItem = 9,
+  ChangeCellContent = 10,
+  ChangeDocumentMetadata = 11,
+  ChangeCellInternalMetadata = 12,
+  ChangeCellMime = 13,
+  Unknown = 100,
+}
+
+export type NotebookCellTextModelSplice<T> = [start: number, deleteCount: number, newItems: T[]];
+
+/**
+ * [start, end]
+ */
+export interface ICellRange {
+  /**
+   * zero based index
+   */
+  start: number;
+
+  /**
+   * zero based index
+   */
+  end: number;
+}
+
+export enum CellKind {
+  Markup = 1,
+  Code = 2,
+}
+
+export interface NotebookCellMetadata {
+  /**
+   * custom metadata
+   */
+  [key: string]: unknown;
+}
+
+export interface ICellExecutionError {
+  message: string;
+  stack: string | undefined;
+  uri: UriComponents;
+  location: IRange | undefined;
+}
+
+export type NotebookDocumentMetadata = Record<string, unknown>;
+export interface NotebookCellInternalMetadata {
+  executionId?: string;
+  executionOrder?: number;
+  lastRunSuccess?: boolean;
+  runStartTime?: number;
+  runStartTimeAdjustment?: number;
+  runEndTime?: number;
+  renderDuration?: { [key: string]: number };
+  error?: ICellExecutionError;
+}
+
+export interface NotebookOutputItemDto {
+  readonly mime: string;
+  readonly valueBytes: Buffer;
+}
+
+export interface NotebookOutputDto {
+  items: NotebookOutputItemDto[];
+  outputId: string;
+  metadata?: Record<string, any>;
+}
+
+export interface NotebookCellDto {
+  handle: number;
+  uri: UriComponents;
+  eol: string;
+  source: string[];
+  language: string;
+  mime?: string;
+  cellKind: CellKind;
+  outputs: NotebookOutputDto[];
+  metadata?: NotebookCellMetadata;
+  internalMetadata?: NotebookCellInternalMetadata;
+}
+
+export interface NotebookCellDataDto {
+  source: string;
+  language: string;
+  mime: string | undefined;
+  cellKind: CellKind;
+  outputs: NotebookOutputDto[];
+  metadata?: NotebookCellMetadata;
+  internalMetadata?: NotebookCellInternalMetadata;
+}
+
+export interface NotebookDataDto {
+  readonly cells: NotebookCellDataDto[];
+  readonly metadata: NotebookDocumentMetadata;
+}
+
+export interface NotebookCellsChangeLanguageEvent {
+  readonly kind: NotebookCellsChangeType.ChangeCellLanguage;
+  readonly index: number;
+  readonly language: string;
+}
+
+export interface NotebookCellsChangeMimeEvent {
+  readonly kind: NotebookCellsChangeType.ChangeCellMime;
+  readonly index: number;
+  readonly mime: string | undefined;
+}
+
+export interface NotebookCellsChangeMetadataEvent {
+  readonly kind: NotebookCellsChangeType.ChangeCellMetadata;
+  readonly index: number;
+  readonly metadata: NotebookCellMetadata;
+}
+
+export interface NotebookCellsChangeInternalMetadataEvent {
+  readonly kind: NotebookCellsChangeType.ChangeCellInternalMetadata;
+  readonly index: number;
+  readonly internalMetadata: NotebookCellInternalMetadata;
+}
+
+export interface NotebookCellContentChangeEvent {
+  readonly kind: NotebookCellsChangeType.ChangeCellContent;
+  readonly index: number;
+}
+
+export type NotebookRawContentEventDto =
+  | {
+      readonly kind: NotebookCellsChangeType.ModelChange;
+      readonly changes: NotebookCellTextModelSplice<NotebookCellDto>[];
+    }
+  | {
+      readonly kind: NotebookCellsChangeType.Move;
+      readonly index: number;
+      readonly length: number;
+      readonly newIdx: number;
+    }
+  | {
+      readonly kind: NotebookCellsChangeType.Output;
+      readonly index: number;
+      readonly outputs: NotebookOutputDto[];
+    }
+  | {
+      readonly kind: NotebookCellsChangeType.OutputItem;
+      readonly index: number;
+      readonly outputId: string;
+      readonly outputItems: NotebookOutputItemDto[];
+      readonly append: boolean;
+    }
+  | NotebookCellsChangeLanguageEvent
+  | NotebookCellsChangeMimeEvent
+  | NotebookCellsChangeMetadataEvent
+  | NotebookCellsChangeInternalMetadataEvent
+  | NotebookCellContentChangeEvent;
+
+export interface NotebookCellsChangedEventDto {
+  readonly rawEvents: NotebookRawContentEventDto[];
+  readonly versionId: number;
+}
+
+export interface INotebookModelAddedData {
+  uri: UriComponents;
+  versionId: number;
+  cells: NotebookCellDto[];
+  viewType: string;
+  metadata?: NotebookDocumentMetadata;
+}
+
+export interface NotebookDocumentChangeDto {
+  uri: UriComponents;
+  event: NotebookCellsChangedEventDto;
+  isDirty: boolean;
+  metadata?: NotebookDocumentMetadata;
+}
+
+export const INotebookService = Symbol('INotebookService');
+
+export interface INotebookService {
+  createNotebook: (data?: NotebookDataDto) => Promise<{ uri: UriComponents }>;
+  openNotebook: (uriComponents: UriComponents) => Promise<{ uri: UriComponents }>;
+  saveNotebook: (uriComponents: UriComponents) => Promise<boolean>;
+
+  onDidOpenNotebookDocument: Event<INotebookModelAddedData>;
+  onDidCloseNotebookDocument: Event<UriComponents>;
+  onDidSaveNotebookDocument: Event<UriComponents>;
+  onDidChangeNotebookDocument: Event<NotebookDocumentChangeDto>;
+}
+
+export const notebookCellScheme = 'vscode-notebook-cell';