@difizen/libro-lab 0.3.0 → 0.3.2

package/es/lab-app.js

@@ -14,7 +14,8 @@ function _initializerWarningHelper(descriptor, context) { throw new Error('Decor
 import { LibroService, LibroJupyterConfiguration, ServerConnection, ServerManager } from '@difizen/libro-jupyter';
 import { terminalDefaultSlot } from '@difizen/libro-terminal';
 import { ConfigurationService, FileTreeViewFactory, URI, ApplicationContribution, SlotViewManager, ViewManager, inject, singleton } from '@difizen/mana-app';
-import { LibroLabConfiguration } from "./config/index.js";
+import { LibroLabConfiguration, LibroLabGuideViewEnabled } from "./config/index.js";
+import { GuideView } from "./guide/index.js";
 import { KernelAndTerminalPanelView } from "./kernel-and-terminal-panel/index.js";
 import { LibroLabLayoutSlots } from "./layout/index.js";
 import { LayoutService } from "./layout/layout-service.js";
@@ -45,11 +46,11 @@ export var LibroLabApp = (_dec = singleton({
   _createClass(LibroLabApp, [{
     key: "onStart",
     value: function () {
-      var _onStart = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
+      var _onStart = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
         var _this = this;
         var _i, _leftPanelConfigs, _leftPanelConfigs$_i, configKey, viewClass, isEnabled, view;
-        return _regeneratorRuntime().wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
             case 0:
               localStorage.setItem(ShouldPreventStoreViewKey, 'true');
               this.configurationService.set(LibroJupyterConfiguration['OpenSlot'], LibroLabLayoutSlots.content);
@@ -57,40 +58,63 @@ export var LibroLabApp = (_dec = singleton({
               _i = 0, _leftPanelConfigs = leftPanelConfigs;
             case 4:
               if (!(_i < _leftPanelConfigs.length)) {
-                _context.next = 17;
+                _context2.next = 17;
                 break;
               }
               _leftPanelConfigs$_i = _leftPanelConfigs[_i], configKey = _leftPanelConfigs$_i.configKey, viewClass = _leftPanelConfigs$_i.viewClass;
-              _context.next = 8;
+              _context2.next = 8;
               return this.configurationService.get(LibroLabConfiguration[configKey]);
             case 8:
-              isEnabled = _context.sent;
+              isEnabled = _context2.sent;
               if (!isEnabled) {
-                _context.next = 14;
+                _context2.next = 14;
                 break;
               }
-              _context.next = 12;
+              _context2.next = 12;
               return this.viewManager.getOrCreateView(viewClass);
             case 12:
-              view = _context.sent;
+              view = _context2.sent;
               this.slotViewManager.addView(view, LibroLabLayoutSlots.navigator);
             case 14:
               _i++;
-              _context.next = 4;
+              _context2.next = 4;
               break;
             case 17:
-              this.serverManager.ready.then(function () {
-                _this.layoutService.setAreaVisible(LibroLabLayoutSlots.navigator, true);
-                _this.layoutService.setAreaVisible(LibroLabLayoutSlots.alert, false);
-                _this.layoutService.serverSatus = 'success';
-                _this.initialWorkspace();
-                return;
-              }).catch(console.error);
+              this.serverManager.ready.then( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee() {
+                var isGuideEnabled, _view;
+                return _regeneratorRuntime().wrap(function _callee$(_context) {
+                  while (1) switch (_context.prev = _context.next) {
+                    case 0:
+                      _this.layoutService.setAreaVisible(LibroLabLayoutSlots.navigator, true);
+                      _this.layoutService.setAreaVisible(LibroLabLayoutSlots.alert, false);
+                      _this.layoutService.serverSatus = 'success';
+                      _this.initialWorkspace();
+                      _context.next = 6;
+                      return _this.configurationService.get(LibroLabGuideViewEnabled);
+                    case 6:
+                      isGuideEnabled = _context.sent;
+                      if (!isGuideEnabled) {
+                        _context.next = 12;
+                        break;
+                      }
+                      _context.next = 10;
+                      return _this.viewManager.getOrCreateView(GuideView);
+                    case 10:
+                      _view = _context.sent;
+                      _this.slotViewManager.addView(_view, LibroLabLayoutSlots.content);
+                    case 12:
+                      return _context.abrupt("return");
+                    case 13:
+                    case "end":
+                      return _context.stop();
+                  }
+                }, _callee);
+              }))).catch(console.error);
             case 18:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
-        }, _callee, this);
+        }, _callee2, this);
       }));
       function onStart() {
         return _onStart.apply(this, arguments);
@@ -100,24 +124,24 @@ export var LibroLabApp = (_dec = singleton({
   }, {
     key: "initialWorkspace",
     value: function () {
-      var _initialWorkspace = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+      var _initialWorkspace = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3() {
         var view;
-        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
             case 0:
-              _context2.next = 2;
+              _context3.next = 2;
               return this.viewManager.getOrCreateView(FileTreeViewFactory);
             case 2:
-              view = _context2.sent;
+              view = _context3.sent;
               if (view) {
                 view.model.rootVisible = false;
                 view.model.location = new URI('/');
               }
             case 4:
             case "end":
-              return _context2.stop();
+              return _context3.stop();
           }
-        }, _callee2, this);
+        }, _callee3, this);
       }));
       function initialWorkspace() {
         return _initialWorkspace.apply(this, arguments);

package/es/module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../src/module.tsx"],"names":[],"mappings":"AAQA,OAAO,EACL,UAAU,EAKX,MAAM,mBAAmB,CAAC;AAoB3B,OAAO,cAAc,CAAC;AAMtB,eAAO,MAAM,cAAc,YA+FxB,CAAC"}
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../src/module.tsx"],"names":[],"mappings":"AAQA,OAAO,EACL,UAAU,EAKX,MAAM,mBAAmB,CAAC;AAsB3B,OAAO,cAAc,CAAC;AAMtB,eAAO,MAAM,cAAc,YAiGxB,CAAC"}

package/es/module.js

@@ -12,6 +12,8 @@ import { LibroLabHeaderMenuModule } from "./command/module.js";
 import { LabConfigAppContribution } from "./config/config-contribution.js";
 import { CodeEditorViewerModule } from "./editor-viewer/index.js";
 import { GithubLinkView } from "./github-link/index.js";
+import { LibroGuidebookContentContribution } from "./guide/content-contribution.js";
+import { GuideView } from "./guide/guide-view.js";
 import { ImageViewerModule } from "./image-viewer/index.js";
 // import { KernelManagerView } from './kernel-manager/index.js';
 import { LibroKernelAndTerminalPanelModule } from "./kernel-and-terminal-panel/module.js";
@@ -86,4 +88,4 @@ createSlotPreference({
     reveal: true,
     order: 'welcome'
   }
-}), EntryPointView).dependOn(LibroJupyterModule, CommonWidgetsModule, LibroLabLayoutModule, LibroLabHeaderMenuModule, LibroLabTocModule, LibroKernelAndTerminalPanelModule, LibroPromptCellModule, LibroSqlCellModule, TerminalModule, ImageViewerModule, CodeEditorViewerModule, LibroAINativeModule, LibroAppModule);
+}), LibroGuidebookContentContribution, GuideView, EntryPointView).dependOn(LibroJupyterModule, CommonWidgetsModule, LibroLabLayoutModule, LibroLabHeaderMenuModule, LibroLabTocModule, LibroKernelAndTerminalPanelModule, LibroPromptCellModule, LibroSqlCellModule, TerminalModule, ImageViewerModule, CodeEditorViewerModule, LibroAINativeModule, LibroAppModule);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@difizen/libro-lab",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "",
   "keywords": [
     "libro",
@@ -34,19 +34,19 @@
   ],
   "dependencies": {
     "@ant-design/icons": "^5.1.0",
-    "@difizen/libro-core": "^0.3.0",
-    "@difizen/libro-jupyter": "^0.3.0",
-    "@difizen/libro-kernel": "^0.3.0",
-    "@difizen/libro-prompt-cell": "^0.3.0",
-    "@difizen/libro-sql-cell": "^0.3.0",
-    "@difizen/libro-terminal": "^0.3.0",
-    "@difizen/libro-toc": "^0.3.0",
-    "@difizen/libro-app": "^0.3.0",
-    "@difizen/libro-cofine-editor-core": "^0.3.0",
-    "@difizen/libro-language-client": "^0.3.0",
-    "@difizen/libro-widget": "^0.3.0",
-    "@difizen/libro-l10n": "^0.3.0",
-    "@difizen/libro-ai-native": "^0.3.0",
+    "@difizen/libro-core": "^0.3.2",
+    "@difizen/libro-jupyter": "^0.3.2",
+    "@difizen/libro-kernel": "^0.3.2",
+    "@difizen/libro-prompt-cell": "^0.3.2",
+    "@difizen/libro-sql-cell": "^0.3.2",
+    "@difizen/libro-terminal": "^0.3.2",
+    "@difizen/libro-toc": "^0.3.2",
+    "@difizen/libro-app": "^0.3.2",
+    "@difizen/libro-cofine-editor-core": "^0.3.2",
+    "@difizen/libro-language-client": "^0.3.2",
+    "@difizen/libro-widget": "^0.3.2",
+    "@difizen/libro-l10n": "^0.3.2",
+    "@difizen/libro-ai-native": "^0.3.2",
     "@difizen/mana-app": "latest",
     "@difizen/mana-l10n": "latest",
     "@difizen/mana-common": "latest",

package/src/command/lab-command.ts

@@ -3,6 +3,10 @@ export const LabCommands = {
     id: 'libro-lab-header-menu-help-about',
     label: '关于',
   },
+  Guide: {
+    id: 'libro-lab-header-menu-help-guide',
+    label: '使用指南',
+  },
   Save: {
     id: 'libro-lab-save',
     label: '保存',

package/src/command/lab-menu-contribution.tsx

@@ -5,8 +5,8 @@ import {
   NotebookCommands,
 } from '@difizen/libro-jupyter';
 import { TerminalCommands, TerminalManager } from '@difizen/libro-terminal';
-import type { MenuRegistry } from '@difizen/mana-app';
-import type { KeybindingRegistry } from '@difizen/mana-app';
+import type { KeybindingRegistry, MenuRegistry } from '@difizen/mana-app';
+import { SlotViewManager } from '@difizen/mana-app';
 import { KeybindingContribution } from '@difizen/mana-app';
 import { Saveable } from '@difizen/mana-app';
 import {
@@ -20,6 +20,7 @@ import {
 } from '@difizen/mana-app';
 import { l10n } from '@difizen/mana-l10n';
 
+import { GuideView } from '../guide/index.js';
 import { LibroLabLayoutSlots } from '../layout/index.js';
 import { LayoutService } from '../layout/layout-service.js';
 
@@ -43,6 +44,7 @@ export class LabMenu
   @inject(LayoutService) protected layoutService: LayoutService;
   @inject(TerminalManager) terminalManager: TerminalManager;
   @inject(ViewManager) viewManager: ViewManager;
+  @inject(SlotViewManager) slotManager: SlotViewManager;
 
   registerKeybindings(keybindings: KeybindingRegistry) {
     keybindings.registerKeybinding({
@@ -75,6 +77,11 @@ export class LabMenu
       command: LabCommands.About.id,
       label: () => <div>{l10n.t(LabCommands.About.label)}</div>,
     });
+    menu.registerMenuAction(LabMenus.HELP, {
+      id: LabCommands.Guide.id,
+      command: LabCommands.Guide.id,
+      label: () => <div>{l10n.t(LabCommands.Guide.label)}</div>,
+    });
     menu.registerMenuAction(LabMenus.FILE, {
       id: LabCommands.Save.id,
       command: LabCommands.Save.id,
@@ -261,6 +268,12 @@ export class LabMenu
         //TODO: 关于
       },
     });
+    commands.registerCommand(LabCommands.Guide, {
+      execute: async () => {
+        const view = await this.viewManager.getOrCreateView(GuideView);
+        this.slotManager.addView(view, LibroLabLayoutSlots.content);
+      },
+    });
     commands.registerCommand(LabCommands.Save);
     commands.registerHandler(LabCommands.Save.id, {
       execute: async () => {

package/src/config/config.ts

@@ -23,7 +23,19 @@ export const LibroLabTocPanelEnabled: ConfigurationNode<boolean> = {
   },
 };
 
+export const LibroLabGuideViewEnabled: ConfigurationNode<boolean> = {
+  id: 'libro.lab.guide.view.enabled',
+  description: 'whether enable guide view ',
+  title: l10n.t('是否激活使用指南'),
+  type: 'checkbox',
+  defaultValue: false,
+  schema: {
+    type: 'boolean',
+  },
+};
+
 export const LibroLabConfiguration = {
   LibroLabKernelAndTerminalPanelEnabled: LibroLabKernelAndTerminalPanelEnabled,
   LibroLabTocPanelEnabled: LibroLabTocPanelEnabled,
+  LibroLabGuideViewEnabled: LibroLabGuideViewEnabled,
 };

package/src/guide/content-contribution.ts

@@ -0,0 +1,50 @@
+import type { NotebookModel, NotebookOption } from '@difizen/libro-core';
+import { ContentContribution } from '@difizen/libro-core';
+import type {
+  IContentsModel,
+  INotebookContent,
+  LibroJupyterModel,
+} from '@difizen/libro-jupyter';
+import { URI } from '@difizen/mana-app';
+import { singleton } from '@difizen/mana-app';
+import { l10n, L10nLang } from '@difizen/mana-l10n';
+
+import contentJson from './libro_guide_book.json';
+import contentZhJson from './libro_guide_book_zh.json';
+
+@singleton({ contrib: ContentContribution })
+export class LibroGuidebookContentContribution implements ContentContribution {
+  canHandle = (options: NotebookOption) => {
+    if (options['loadType'] === 'libro-guide-book') {
+      return 50;
+    }
+    return 1;
+  };
+  async loadContent(options: NotebookOption, model: NotebookModel) {
+    const jupyterModel = model as LibroJupyterModel;
+    const fireUri = new URI(options['resource']);
+    const filePath = fireUri.path.toString();
+    let notebookContent: INotebookContent = {
+      cells: [],
+      metadata: {},
+      nbformat: 4,
+      nbformat_minor: 5,
+    };
+    notebookContent = l10n.getLang() === L10nLang.zhCN ? contentZhJson : contentJson;
+    const currentFileContents: IContentsModel = {
+      name: 'Guide book',
+      path: filePath,
+      type: 'notebook',
+      writable: true,
+      created: 'libro',
+      last_modified: 'libro',
+      content: notebookContent,
+    };
+    currentFileContents.content.nbformat_minor = 5;
+    jupyterModel.currentFileContents = currentFileContents;
+    jupyterModel.filePath = currentFileContents.path;
+    jupyterModel.lastModified = jupyterModel.currentFileContents.last_modified;
+
+    return jupyterModel.currentFileContents.content;
+  }
+}

package/src/guide/guide-view.tsx

@@ -0,0 +1,77 @@
+import type { LibroView } from '@difizen/libro-jupyter';
+import { LibroService } from '@difizen/libro-jupyter';
+import {
+  Deferred,
+  inject,
+  prop,
+  singleton,
+  useInject,
+  view,
+  ViewInstance,
+  ViewRender,
+} from '@difizen/mana-app';
+import { BaseView } from '@difizen/mana-app';
+import { l10n, L10nLang } from '@difizen/mana-l10n';
+import { forwardRef } from 'react';
+import './index.less';
+
+import { Logo } from '../common/icon.js';
+
+export const GuideComponent = forwardRef(function WelcomeComponent() {
+  const instance = useInject<GuideView>(ViewInstance);
+
+  if (!instance.libroView) {
+    return null;
+  }
+  return <ViewRender view={instance.libroView} key={instance.filePath} />;
+});
+
+@singleton()
+@view('guide-view')
+export class GuideView extends BaseView {
+  override view = GuideComponent;
+
+  @prop()
+  libroView?: LibroView;
+
+  @prop() filePath?: string;
+
+  @inject(LibroService) protected libroService: LibroService;
+
+  protected defer = new Deferred<void>();
+
+  get ready() {
+    return this.defer.promise;
+  }
+
+  constructor() {
+    super();
+    this.title.icon = <Logo></Logo>;
+    this.title.label = () => <div>{l10n.t('使用指南')}</div>;
+    this.title.closable = true;
+    this.filePath =
+      l10n.getLang() === L10nLang.zhCN
+        ? 'libro_guide_book_zh.json'
+        : 'libro_guide_book.json';
+  }
+
+  override async onViewMount(): Promise<void> {
+    this.getOrCreateLibroView();
+  }
+
+  protected async getOrCreateLibroView() {
+    const libroView = await this.libroService.getOrCreateView({
+      id: this.filePath,
+      resource: this.filePath,
+      loadType: 'libro-guide-book',
+    });
+    if (!libroView) {
+      return;
+    }
+    this.libroView = libroView;
+    await this.libroView.initialized;
+    this.libroView.model.savable = false;
+    this.libroView.focus();
+    this.defer.resolve();
+  }
+}

package/src/guide/index.less

@@ -0,0 +1,8 @@
+.libro-lab-content-layout-main {
+  .mana-tab-icon {
+    svg {
+      display: inline-block;
+      width: 14px;
+    }
+  }
+}

package/src/guide/index.ts

@@ -0,0 +1,2 @@
+export * from './content-contribution.js';
+export * from './guide-view.js';