@difizen/libro-sql-cell 0.0.0-snapshot-20241017072317

package/es/module.js

@@ -0,0 +1,25 @@
+import { CellOptions, LibroModule } from '@difizen/libro-jupyter';
+import { LibroRenderMimeModule } from '@difizen/libro-rendermime';
+import { ManaModule } from '@difizen/mana-app';
+import { FormatterSqlMagicContribution } from "./libro-formatter-sql-magic-contribution.js";
+import { FormatterStringTransSqlContribution } from "./libro-formatter-sql-trans-contribution.js";
+import { LibroSQLCellColorRegistry } from "./libro-sql-cell-color-registry.js";
+import { SqlCellContribution } from "./libro-sql-cell-contribution.js";
+import { LibroSqlCellModel } from "./libro-sql-cell-model.js";
+import { LibroSqlCellModelFactory } from "./libro-sql-cell-protocol.js";
+import { SqlScript } from "./libro-sql-cell-script.js";
+import { LibroSqlCellView } from "./libro-sql-cell-view.js";
+export var LibroSqlCellModule = ManaModule.create().register(SqlCellContribution, LibroSqlCellView, LibroSqlCellModel, LibroSQLCellColorRegistry, FormatterSqlMagicContribution, FormatterStringTransSqlContribution, SqlScript, {
+  token: LibroSqlCellModelFactory,
+  useFactory: function useFactory(ctx) {
+    return function (options) {
+      var child = ctx.container.createChild();
+      child.register({
+        token: CellOptions,
+        useValue: options
+      });
+      var model = child.get(LibroSqlCellModel);
+      return model;
+    };
+  }
+}).dependOn(LibroModule, LibroRenderMimeModule);

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@difizen/libro-sql-cell",
+  "version": "0.0.0-snapshot-20241017072317",
+  "description": "",
+  "keywords": [
+    "libro",
+    "notebook"
+  ],
+  "repository": "git@github.com:difizen/libro.git",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "typings": "./es/index.d.ts",
+      "default": "./es/index.js"
+    },
+    "./mock": {
+      "typings": "./es/mock/index.d.ts",
+      "default": "./es/mock/index.js"
+    },
+    "./es/mock": {
+      "typings": "./es/mock/index.d.ts",
+      "default": "./es/mock/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "es/index.js",
+  "module": "es/index.js",
+  "typings": "es/index.d.ts",
+  "files": [
+    "es",
+    "src"
+  ],
+  "dependencies": {
+    "@difizen/libro-code-editor": "0.0.0-snapshot-20241017072317",
+    "@difizen/libro-jupyter": "0.0.0-snapshot-20241017072317",
+    "@difizen/libro-rendermime": "0.0.0-snapshot-20241017072317",
+    "@difizen/libro-common": "0.0.0-snapshot-20241017072317",
+    "@ant-design/icons": "^5.1.0",
+    "@difizen/mana-app": "latest",
+    "@difizen/mana-l10n": "latest"
+  },
+  "peerDependencies": {
+    "react": ">=16",
+    "antd": "^5.8.6"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.25",
+    "@types/uuid": "^9.0.2",
+    "@types/react-dom": "^18.2.4"
+  },
+  "scripts": {
+    "setup": "father build",
+    "build": "father build",
+    "test": ": Note: lint task is delegated to test:* scripts",
+    "test:vitest": "vitest run",
+    "test:jest": "jest",
+    "coverage": ": Note: lint task is delegated to coverage:* scripts",
+    "coverage:vitest": "vitest run --coverage",
+    "coverage:jest": "jest --coverage",
+    "lint": ": Note: lint task is delegated to lint:* scripts",
+    "lint:eslint": "eslint src",
+    "typecheck:tsc": "tsc --noEmit"
+  }
+}

package/src/index.less

@@ -0,0 +1,120 @@
+// The prefix to use on all css classes from ant.
+@ant-prefix: ant;
+
+.libro-sql-cell-header {
+  height: 36px;
+  border-bottom: 1px solid var(--mana-libro-code-border-color);
+  display: flex;
+
+  span {
+    cursor: pointer;
+  }
+}
+
+.libro-sql-source {
+  padding: 0 16px;
+  border-right: 1px solid var(--mana-libro-cell-border-color);
+}
+
+.libro-sql-variable-name-input {
+  width: 120px !important;
+  height: 32px;
+  margin-left: 6px;
+  color: var(--mana-libro-cell-header-content);
+  border: 1px solid var(--mana-libro-cell-border-color) !important;
+  background: var(--mana-libro-popover-background-color);
+  border-radius: 6px !important;
+  box-shadow: unset !important;
+  &.@{ant-prefix}-input-status-warning {
+    border-color: #faad14 !important;
+  }
+}
+
+.libro-sql-variable-name-title {
+  padding-left: 16px;
+  color: var(--mana-libro-cell-header-title);
+  font-weight: 400;
+  font-size: 14px;
+  font-family: SFProText;
+  line-height: 36px;
+  letter-spacing: 0;
+}
+
+.libro-sql-source-content,
+.libro-sql-variable-content {
+  padding-left: 3px;
+  color: var(--mana-libro-cell-header-content);
+  font-weight: 400;
+  font-size: 14px;
+  font-family: SFProText;
+  line-height: 36px;
+  letter-spacing: 0;
+}
+
+.libro-sql-variable-content {
+  padding-left: 18px;
+}
+
+.libro-sql-variable-name {
+  display: flex;
+  margin-left: 8px;
+  align-items: center;
+
+  svg {
+    margin-left: 4px;
+  }
+}
+
+.libro-sql-input-save,
+.libro-sql-input-cancel {
+  width: 28px;
+  height: 20px;
+  color: #1890ff;
+  font-weight: 400;
+  font-size: 14px;
+  letter-spacing: 0;
+}
+
+.libro-sql-input-save {
+  margin-left: 8px;
+}
+
+.libro-sql-edit-icon {
+  color: #bdc0c4 !important;
+
+  &:hover {
+    color: #1590ff !important;
+  }
+}
+
+.libro-sql-popover-container {
+  padding-top: 10px !important;
+  .@{ant-prefix}-popover-inner {
+    border-radius: 8px;
+  }
+  .@{ant-prefix}-popover-inner-content {
+    height: 100% !important;
+    text-align: right;
+  }
+
+  .@{ant-prefix}-popover-content {
+    transform: translateX(-18px) !important;
+  }
+}
+
+.libro-sql-input-warning-text {
+  display: flex;
+  align-items: center;
+  margin-top: 4px;
+  color: #faad14;
+  font-weight: 400;
+  font-size: 14px;
+}
+
+.libro-sql-input-button {
+  margin-top: 12px;
+}
+
+.libro-sql-variable-name-popover {
+  vertical-align: middle;
+}

package/src/index.spec.ts

@@ -0,0 +1,9 @@
+import assert from 'assert';
+
+import 'reflect-metadata';
+
+describe('libro-sql-cell', () => {
+  it('#import', () => {
+    assert(true);
+  });
+});

package/src/index.ts

@@ -0,0 +1 @@
+export * from './module.js';

package/src/libro-formatter-sql-magic-contribution.ts

@@ -0,0 +1,66 @@
+/** @format */
+
+import { concatMultilineString } from '@difizen/libro-common';
+import { FormatterContribution } from '@difizen/libro-jupyter';
+import type {
+  DefaultEncodedFormatter,
+  DefaultDecodedFormatter,
+} from '@difizen/libro-jupyter';
+import { singleton } from '@difizen/mana-app';
+
+export interface SqlDecodedFormatter extends DefaultDecodedFormatter {
+  result_variable?: string;
+  db_id?: string;
+}
+
+@singleton({ contrib: FormatterContribution })
+export class FormatterSqlMagicContribution
+  implements FormatterContribution<SqlDecodedFormatter>
+{
+  formatter = 'formatter-sql-magic';
+  formatterOptions?: object;
+
+  canHandle = (libroFormatter: string) => {
+    return libroFormatter === this.formatter ? 100 : 1;
+  };
+  encode = (source: SqlDecodedFormatter) => {
+    const sqlJson = {
+      result_variable: source.result_variable,
+      db_id: source.db_id,
+      sql_script: source.value,
+    };
+    const sqlEncodedValue = `%%sql \n${JSON.stringify(sqlJson)}`;
+    return {
+      source: sqlEncodedValue,
+      metadata: {
+        libroFormatter: this.formatter,
+      },
+    };
+  };
+  decode = (formatterValue: DefaultEncodedFormatter) => {
+    const value = concatMultilineString(formatterValue.source);
+    if (value.startsWith('%%sql \n')) {
+      const run = value.split('%%sql \n')[1];
+      try {
+        const runValue = JSON.parse(run);
+        const result_variable: string = runValue.result_variable;
+        const db_id: string = runValue.db_id;
+        const codeValue: string = runValue.sql_script;
+        return {
+          result_variable,
+          value: codeValue,
+          db_id,
+        };
+      } catch (e) {
+        console.warn('🚀 ~ e:', e);
+      }
+    }
+    return {
+      value: '',
+    };
+  };
+
+  validate = (source: SqlDecodedFormatter): source is SqlDecodedFormatter => {
+    return 'result_variable' in source && 'sql_script' in source && 'db_id' in source;
+  };
+}

package/src/libro-formatter-sql-trans-contribution.ts

@@ -0,0 +1,22 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { FormatterTransContribution } from '@difizen/libro-jupyter';
+import type { DefaultDecodedFormatter } from '@difizen/libro-jupyter';
+import { singleton } from '@difizen/mana-app';
+
+import type { SqlDecodedFormatter } from './libro-formatter-sql-magic-contribution.js';
+
+@singleton({ contrib: FormatterTransContribution })
+export class FormatterStringTransSqlContribution
+  implements FormatterTransContribution<DefaultDecodedFormatter, SqlDecodedFormatter>
+{
+  origin = 'formatter-string';
+  target = 'formatter-sql-magic';
+  priority = 100;
+
+  decodedValueTrans = (source: DefaultDecodedFormatter) => {
+    return {
+      ...source,
+      result_variable: source['result_variable'] || 'df_from_trans',
+    };
+  };
+}

package/src/libro-sql-cell-color-registry.ts

@@ -0,0 +1,35 @@
+import type { ColorRegistry } from '@difizen/mana-app';
+import { Color, ColorContribution, singleton } from '@difizen/mana-app';
+
+@singleton({ contrib: ColorContribution })
+export class LibroSQLCellColorRegistry implements ColorContribution {
+  registerColors(colors: ColorRegistry): void {
+    colors.register(
+      {
+        id: 'libro.sql.tab',
+        defaults: { dark: '#B2B2B3', light: Color.rgba(0, 10, 26, 0.68) },
+        description: '',
+      },
+      {
+        id: 'libro.sql.tab.background',
+        defaults: { dark: '#1C1C1D', light: '#FAFAFB' },
+        description: '',
+      },
+      {
+        id: 'libro.sql.button.border',
+        defaults: { dark: '#505559', light: Color.rgba(0, 10, 26, 0.1) },
+        description: '',
+      },
+      {
+        id: 'libro.sql.button.background',
+        defaults: { dark: '#2F3032', light: '#FFFFFF' },
+        description: '',
+      },
+      {
+        id: 'libro.sql.button.text.color',
+        defaults: { dark: '#BDC0C4', light: Color.rgba(0, 10, 26, 0.68) },
+        description: '',
+      },
+    );
+  }
+}

package/src/libro-sql-cell-contribution.ts

@@ -0,0 +1,46 @@
+import type { LanguageSpecRegistry } from '@difizen/libro-code-editor';
+import { LanguageSpecContribution } from '@difizen/libro-code-editor';
+import type { CellMeta, CellModel, CellOptions } from '@difizen/libro-jupyter';
+import { CellModelContribution, CellViewContribution } from '@difizen/libro-jupyter';
+import { inject } from '@difizen/mana-app';
+import { singleton } from '@difizen/mana-app';
+
+import { LibroSqlCellModelFactory } from './libro-sql-cell-protocol.js';
+import { LibroSqlCellView } from './libro-sql-cell-view.js';
+
+@singleton({
+  contrib: [CellModelContribution, CellViewContribution, LanguageSpecContribution],
+})
+export class SqlCellContribution
+  implements CellModelContribution, CellViewContribution, LanguageSpecContribution
+{
+  @inject(LibroSqlCellModelFactory)
+  sqlCellModelFactory: LibroSqlCellModelFactory;
+
+  cellMeta: CellMeta = {
+    type: 'sql',
+    name: 'SQL',
+    order: 'e',
+    nbformatType: 'code',
+  };
+
+  canHandle(options: CellOptions, libroType?: string): number {
+    return libroType === this.cellMeta.type ? 2000 : -1;
+  }
+
+  async createModel(options: CellOptions): Promise<CellModel> {
+    const model = this.sqlCellModelFactory(options);
+    return model;
+  }
+
+  view = LibroSqlCellView;
+
+  registerLanguageSpec = (register: LanguageSpecRegistry) => {
+    register.registerLanguageSpec({
+      name: 'SQL',
+      language: 'sql-odps',
+      mime: 'application/vnd.libro.sql+json',
+      ext: ['.sql'],
+    });
+  };
+}

package/src/libro-sql-cell-model.ts

@@ -0,0 +1,115 @@
+import type {
+  ICellMetadata,
+  ICodeCell,
+  ICodeCellMetadata,
+} from '@difizen/libro-common';
+import type { ExecutionCount } from '@difizen/libro-common';
+import { CellOptions, LibroCellModel } from '@difizen/libro-jupyter';
+import type { ExecutableCellModel } from '@difizen/libro-jupyter';
+import type { Event as ManaEvent } from '@difizen/mana-app';
+import { Emitter, inject, prop, transient, ViewManager } from '@difizen/mana-app';
+
+import type { SqlDecodedFormatter } from './libro-formatter-sql-magic-contribution.js';
+
+export interface SqlCellMetadata extends ICodeCellMetadata {
+  resultVariable: string;
+}
+@transient()
+export class LibroSqlCellModel extends LibroCellModel implements ExecutableCellModel {
+  @prop()
+  resultVariable: string | undefined;
+  @prop()
+  dbId: string | undefined;
+  @prop()
+  executeCount: ExecutionCount;
+  @prop()
+  executing: boolean;
+  @prop()
+  hasOutputHidden: boolean;
+  @prop()
+  hasOutputsScrolled: boolean;
+
+  @prop()
+  kernelExecuting = false;
+
+  @prop()
+  hasExecutedSuccess = false;
+  @prop()
+  hasExecutedError = false;
+  @prop()
+  override metadata: Partial<SqlCellMetadata | ICellMetadata>;
+
+  declare _decodeObject: SqlDecodedFormatter;
+
+  // Emitter Msg
+  msgChangeEmitter: Emitter<any>;
+
+  get msgChange(): ManaEvent<any> {
+    return this.msgChangeEmitter.event;
+  }
+
+  viewManager: ViewManager;
+
+  constructor(
+    @inject(CellOptions) options: CellOptions,
+    @inject(ViewManager) viewManager: ViewManager,
+  ) {
+    super(options);
+    this.viewManager = viewManager;
+    this.executing = false;
+    this.msgChangeEmitter = new Emitter<any>();
+    this.executeCount = (options.cell as ICodeCell).execution_count || null;
+    this.mimeType = 'application/vnd.libro.sql+json';
+    this.hasOutputHidden = false;
+    this.hasOutputsScrolled = false;
+    this.libroFormatType = 'formatter-sql-magic';
+    this.metadata = {
+      ...options?.cell?.metadata,
+      libroFormatter: this.libroFormatType,
+    };
+  }
+
+  override toJSON(): Omit<ICodeCell, 'outputs'> {
+    // const outputs = this.outputArea?.toJSON() ?? this.outputs;
+    return {
+      id: this.id,
+      cell_type: this.type,
+      source: this.source,
+      metadata: this.metadata,
+      execution_count: this.executeCount,
+      // outputs: this.outputs,
+    };
+  }
+
+  override set decodeObject(data: SqlDecodedFormatter) {
+    this.value = data.value;
+    this.resultVariable = data.result_variable;
+    this.dbId = data.db_id;
+    this._decodeObject = data;
+  }
+
+  override get decodeObject() {
+    return {
+      ...this._decodeObject,
+      value: this.value,
+      result_variable: this.resultVariable || this._decodeObject.result_variable,
+      db_id: this.dbId || this._decodeObject.db_id,
+    };
+  }
+
+  clearExecution = () => {
+    this.executeCount = null;
+    this.executing = false;
+    this.kernelExecuting = false;
+    this.metadata['execution'] = {};
+  };
+
+  override dispose() {
+    super.dispose();
+    this.msgChangeEmitter.dispose();
+  }
+
+  getSource() {
+    return this.value;
+  }
+}

package/src/libro-sql-cell-protocol.ts

@@ -0,0 +1,20 @@
+import type { CellOptions, CellView } from '@difizen/libro-jupyter';
+
+import type { LibroSqlCellModel } from './libro-sql-cell-model.js';
+
+export type LibroSqlCellModelFactory = (options: CellOptions) => LibroSqlCellModel;
+export const LibroSqlCellModelFactory = Symbol('LibroSqlCellModelFactory');
+
+export interface VisAnalysis {
+  addAnalysisCell: (cellView: CellView, dfName?: string) => void;
+}
+
+export interface DatabaseConfig {
+  db_type: string;
+  id: string;
+  username: string;
+  password: string;
+  host: string;
+  port: number;
+  database: string;
+}

package/src/libro-sql-cell-script.ts

@@ -0,0 +1,6 @@
+import { singleton } from '@difizen/mana-app';
+
+@singleton()
+export class SqlScript {
+  public readonly getDbConfig: string = `from libro_sql.database import db\nimport json\njson.dumps(db.to_dbs_array())`;
+}