@vuu-ui/vuu-data-remote 3.0.0-beta.3 → 3.1.0-beta.1

package/esm/VuuDataSource.js

@@ -1,687 +0,0 @@
-import { logger, BaseDataSource, debounce, constrainRange, throttle, uuid, combineFilters, Range, isSelectSuccessWithRowCount, isConfigChanged, itemsOrOrderChanged, isRpcSuccess, StaleUpdateError, isViewportMenusAction, isVisualLinksAction } from '@vuu-ui/vuu-utils';
-import ConnectionManager from './ConnectionManager.js';
-import { isDataSourceConfigMessage } from './data-source.js';
-
-var __defProp = Object.defineProperty;
-var __typeError = (msg) => {
-  throw TypeError(msg);
-};
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
-var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
-var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), member.set(obj, value), value);
-var _allColumns, _autosubscribeColumns, _pendingVisualLink, _links, _maxRangeEnd, _maxRangeWidth, _menu, _optimize, _selectedRowsCount, _sessionDataSource, _sessionTableMessageColumn, _status, _tableSchema;
-const { info, infoEnabled } = logger("VuuDataSource");
-const combineColumnsWithAutosubscribeColumns = (columns, autosubscribeColumns = []) => {
-  if (autosubscribeColumns.length === 0) {
-    return columns;
-  } else {
-    const out = columns.slice();
-    autosubscribeColumns.forEach((name) => {
-      if (!out.includes(name)) {
-        out.push(name);
-      }
-    });
-    return out;
-  }
-};
-const _VuuDataSource = class _VuuDataSource extends BaseDataSource {
-  constructor({
-    sessionTableMessageColumn,
-    ...props
-  }) {
-    super(props);
-    __publicField(this, "bufferSize");
-    __publicField(this, "server", null);
-    __publicField(this, "rangeRequest");
-    /**
-     * this is the combined set of regular columns and autosubscribe columns
-     */
-    __privateAdd(this, _allColumns);
-    __privateAdd(this, _autosubscribeColumns, []);
-    __privateAdd(this, _pendingVisualLink);
-    __privateAdd(this, _links);
-    __privateAdd(this, _maxRangeEnd, Number.MAX_SAFE_INTEGER);
-    __privateAdd(this, _maxRangeWidth, Number.MAX_SAFE_INTEGER);
-    __privateAdd(this, _menu);
-    __privateAdd(this, _optimize, "throttle");
-    __privateAdd(this, _selectedRowsCount, 0);
-    __privateAdd(this, _sessionDataSource);
-    __privateAdd(this, _sessionTableMessageColumn);
-    __privateAdd(this, _status, "initialising");
-    __privateAdd(this, _tableSchema);
-    __publicField(this, "table");
-    __publicField(this, "handleMessageFromServer", (message) => {
-      if (message.type === "subscribed") {
-        __privateSet(this, _status, "subscribed");
-        this.tableSchema = message.tableSchema;
-        if (message.tableSchema.rangeLimits) {
-          __privateSet(this, _maxRangeEnd, message.tableSchema.rangeLimits.maxRangeEnd);
-          __privateSet(this, _maxRangeWidth, message.tableSchema.rangeLimits.maxRangeWidth);
-        }
-        this._clientCallback?.(message);
-        if (__privateGet(this, _pendingVisualLink)) {
-          this.visualLink = __privateGet(this, _pendingVisualLink);
-          __privateSet(this, _pendingVisualLink, void 0);
-        }
-        this.emit("subscribed", message);
-      } else if (message.type === "disabled") {
-        __privateSet(this, _status, "disabled");
-      } else if (message.type === "enabled") {
-        __privateSet(this, _status, "subscribed");
-        this.emit("enabled", this.viewport);
-      } else if (isDataSourceConfigMessage(message)) {
-        return;
-      } else if (message.type === "debounce-begin") {
-        this.optimize = "debounce";
-      } else {
-        if (message.type === "viewport-update") {
-          if (message.size !== void 0 && message.size !== this.size) {
-            this.size = message.size;
-            this.emit("resize", message.size, __privateGet(this, _maxRangeEnd));
-          }
-          if (Array.isArray(message.rows) && message.rows.length > 0 && __privateGet(this, _sessionDataSource)) {
-            this.emit("remote-update-during-local-edit", message.rows);
-            console.log(
-              `updates incoming whilst edit in progress ${this.viewport}`
-            );
-            console.table(message.rows);
-            return;
-          }
-        } else if (message.type === "viewport-clear") {
-          this.size = 0;
-          this.emit("resize", 0);
-        }
-        if (this.isAwaitingConfirmationOfConfigChange) {
-          this.confirmConfigChange();
-        }
-        if (isViewportMenusAction(message)) {
-          __privateSet(this, _menu, message.menu);
-        } else if (isVisualLinksAction(message)) {
-          __privateSet(this, _links, message.links);
-        } else {
-          if (infoEnabled && message.type === "viewport-update") {
-            info(
-              `handleMessageFromServer<viewport-update> range (${message.range?.from}:${message.range?.to}) rows ${message.rows?.at(0)?.[0]} - ${message.rows?.at(-1)?.[0]}`
-            );
-          }
-          this._clientCallback?.(message);
-        }
-        if (this.optimize === "debounce") {
-          this.revertDebounce();
-        }
-      }
-    });
-    __publicField(this, "handleSessionMessageFromServer", (msg) => {
-      if (msg.type === "subscribed") {
-        console.log(`[VuuDataSource subscribed to session table]`);
-      } else if (msg.type === "viewport-update") {
-        if (msg.size !== void 0 && msg.size !== this.size) {
-          this.size = msg.size;
-          this.emit("resize", msg.size);
-        }
-        this._clientCallback?.(msg);
-      }
-    });
-    __publicField(this, "revertDebounce", debounce(() => {
-      this.optimize = "throttle";
-    }, 100));
-    __publicField(this, "rawRangeRequest", (range) => {
-      if (this.viewport && this.server) {
-        this.server.send({
-          viewport: this.viewport,
-          type: "setViewRange",
-          range: constrainRange(range, __privateGet(this, _maxRangeEnd), __privateGet(this, _maxRangeWidth))
-        });
-      }
-    });
-    __publicField(this, "debounceRangeRequest", debounce((range) => {
-      if (this.viewport && this.server) {
-        this.server.send({
-          viewport: this.viewport,
-          type: "setViewRange",
-          range: constrainRange(range, __privateGet(this, _maxRangeEnd), __privateGet(this, _maxRangeWidth))
-        });
-      }
-    }, 50));
-    __publicField(this, "throttleRangeRequest", throttle((range) => {
-      if (this.viewport && this.server) {
-        this.server.send({
-          viewport: this.viewport,
-          type: "setViewRange",
-          range: constrainRange(range, __privateGet(this, _maxRangeEnd), __privateGet(this, _maxRangeWidth))
-        });
-      }
-    }, 80));
-    const { bufferSize = 100, table, visualLink } = props;
-    if (!table)
-      throw Error("RemoteDataSource constructor called without table");
-    this.bufferSize = bufferSize;
-    this.table = table;
-    __privateSet(this, _pendingVisualLink, visualLink);
-    __privateSet(this, _sessionTableMessageColumn, sessionTableMessageColumn);
-    this.rangeRequest = this.rawRangeRequest;
-    if (props.autosubscribeColumns) {
-      __privateSet(this, _autosubscribeColumns, props.autosubscribeColumns);
-      __privateSet(this, _allColumns, combineColumnsWithAutosubscribeColumns(
-        super.columns,
-        props.autosubscribeColumns
-      ));
-    }
-  }
-  async subscribe(subscribeProps, callback) {
-    super.subscribe(subscribeProps, callback);
-    const { viewport = this.viewport || (this.viewport = uuid()) } = subscribeProps;
-    if (__privateGet(this, _status) === "disabled" || __privateGet(this, _status) === "disabling" || __privateGet(this, _status) === "enabling") {
-      this.enable(callback);
-      return;
-    }
-    if (__privateGet(this, _status) !== "initialising" && __privateGet(this, _status) !== "unsubscribed") {
-      throw Error(
-        `[VuuDataSource] invalid status ${__privateGet(this, _status)} for subscribe`
-      );
-    }
-    __privateSet(this, _status, "subscribing");
-    this.server = await ConnectionManager.serverAPI;
-    const { bufferSize } = this;
-    const { columns, ...dataSourceConfig } = combineFilters(this.config);
-    this.server?.subscribe(
-      {
-        ...dataSourceConfig,
-        bufferSize,
-        columns: this.columns,
-        range: this._range.withBuffer,
-        table: this.table,
-        title: this._title,
-        viewport
-      },
-      this.handleMessageFromServer
-    );
-  }
-  unsubscribe() {
-    if (__privateGet(this, _status) !== "unsubscribed") {
-      info?.(`unsubscribe #${this.viewport}`);
-      if (this.viewport) {
-        this.server?.unsubscribe(this.viewport);
-        this.emit("unsubscribed", this.viewport);
-      }
-      this.server?.destroy(this.viewport);
-      this.server = null;
-      this.removeAllListeners();
-      __privateSet(this, _status, "unsubscribed");
-      this.viewport = "";
-      this.range = Range(0, 0);
-    }
-  }
-  suspend(escalateToDisable = this._defaultSuspenseProps.escalateToDisable, escalateDelay = this._defaultSuspenseProps.escalateDelay) {
-    if (__privateGet(this, _status) !== "unsubscribed") {
-      info?.(`suspend #${this.viewport}, current status ${__privateGet(this, _status)}`);
-      if (this.viewport) {
-        __privateSet(this, _status, "suspended");
-        this.server?.send({
-          escalateDelay,
-          escalateToDisable,
-          type: "suspend",
-          viewport: this.viewport
-        });
-        this.emit("suspended", this.viewport);
-      }
-    }
-  }
-  /**
-   * Tell the server we wish to resume receiving messages. Server will send a
-   * snapshot of rows currently in cache. This can be used to update with
-   * latest data, e.g after an edit session during which we might have ignored
-   * some updates.
-   */
-  sendResumeMessage() {
-    this.server?.send({
-      type: "resume",
-      viewport: this.viewport
-    });
-  }
-  resume(callback) {
-    const isDisabled = __privateGet(this, _status).startsWith("disabl");
-    const isSuspended = __privateGet(this, _status) === "suspended";
-    info?.(`resume #${this.viewport}, current status ${__privateGet(this, _status)}`);
-    if (callback) {
-      this._clientCallback = callback;
-    }
-    if (this.viewport) {
-      if (isDisabled) {
-        this.enable();
-      } else if (isSuspended) {
-        this.sendResumeMessage();
-        __privateSet(this, _status, "subscribed");
-        this.emit("resumed", this.viewport);
-        if (__privateGet(this, _selectedRowsCount) > 0) {
-          this.emit("row-selection", __privateGet(this, _selectedRowsCount));
-        }
-      }
-    }
-  }
-  freeze() {
-    super.freeze();
-    if (this.viewport) {
-      this.server?.send({
-        viewport: this.viewport,
-        type: "FREEZE_VP"
-      });
-    }
-  }
-  unfreeze() {
-    super.unfreeze();
-    if (this.viewport) {
-      this.server?.send({
-        viewport: this.viewport,
-        type: "UNFREEZE_VP"
-      });
-    }
-  }
-  disable() {
-    info?.(`disable #${this.viewport}, current status ${__privateGet(this, _status)}`);
-    if (this.viewport) {
-      __privateSet(this, _status, "disabling");
-      this.server?.send({
-        viewport: this.viewport,
-        type: "disable"
-      });
-      this.emit("disabled", this.viewport);
-    }
-  }
-  enable(callback) {
-    info?.(`enable #${this.viewport}, current status ${__privateGet(this, _status)}`);
-    if (this.viewport && (__privateGet(this, _status) === "disabled" || __privateGet(this, _status) === "disabling")) {
-      __privateSet(this, _status, "enabling");
-      if (callback) {
-        this._clientCallback = callback;
-      }
-      this.server?.send({
-        viewport: this.viewport,
-        type: "enable"
-      });
-      this.emit("enabled", this.viewport);
-    }
-  }
-  async select(selectRequest) {
-    if (this.viewport && this.server) {
-      const response = await this.server.select({
-        ...selectRequest,
-        vpId: this.viewport
-      });
-      if (isSelectSuccessWithRowCount(response)) {
-        __privateSet(this, _selectedRowsCount, response.selectedRowCount);
-        this.emit("row-selection", response.selectedRowCount);
-      } else {
-        console.warn(`select error`);
-      }
-    }
-  }
-  openTreeNode(keyOrIndex) {
-    if (this.viewport) {
-      const [key, index] = typeof keyOrIndex === "string" ? [keyOrIndex] : [void 0, keyOrIndex];
-      this.server?.send({
-        index,
-        key,
-        type: "openTreeNode",
-        viewport: this.viewport
-      });
-    }
-  }
-  closeTreeNode(keyOrIndex) {
-    if (this.viewport) {
-      const [key, index] = typeof keyOrIndex === "string" ? [keyOrIndex] : [void 0, keyOrIndex];
-      this.server?.send({
-        index,
-        key,
-        type: "closeTreeNode",
-        viewport: this.viewport
-      });
-    }
-  }
-  //TODO is this going to be confusing - the lack of symmetry between set and get columns
-  // when there are autoSubscribe columns ?
-  // alternative would be an allColumns prop, but every datasource would then have to add it.
-  get columns() {
-    return __privateGet(this, _allColumns) ?? super.columns;
-  }
-  set columns(columns) {
-    super.columns = columns;
-    if (__privateGet(this, _autosubscribeColumns).length) {
-      __privateSet(this, _allColumns, combineColumnsWithAutosubscribeColumns(
-        columns,
-        __privateGet(this, _autosubscribeColumns)
-      ));
-    }
-  }
-  get tableSchema() {
-    return __privateGet(this, _tableSchema);
-  }
-  set tableSchema(tableSchema) {
-    __privateSet(this, _tableSchema, tableSchema);
-  }
-  get links() {
-    return __privateGet(this, _links);
-  }
-  get maxRangeEnd() {
-    return __privateGet(this, _maxRangeEnd);
-  }
-  get menu() {
-    return __privateGet(this, _menu);
-  }
-  get status() {
-    return __privateGet(this, _status);
-  }
-  get optimize() {
-    return __privateGet(this, _optimize);
-  }
-  set optimize(optimize) {
-    if (optimize !== __privateGet(this, _optimize)) {
-      __privateSet(this, _optimize, optimize);
-      switch (optimize) {
-        case "none":
-          this.rangeRequest = this.rawRangeRequest;
-          break;
-        case "debounce":
-          this.rangeRequest = this.debounceRangeRequest;
-          break;
-        case "throttle":
-          this.rangeRequest = this.throttleRangeRequest;
-          break;
-      }
-      this.emit("optimize", optimize);
-    }
-  }
-  get selectedRowsCount() {
-    return __privateGet(this, _selectedRowsCount);
-  }
-  get config() {
-    return super.config;
-  }
-  set config(config) {
-    const { noChanges, columnsChanged } = isConfigChanged(this.config, config);
-    if (!noChanges) {
-      super.config = config;
-      const { columns, ...dataSourceConfig } = combineFilters(this.config);
-      const serverConfig = {
-        ...dataSourceConfig,
-        columns: combineColumnsWithAutosubscribeColumns(
-          columns,
-          __privateGet(this, _autosubscribeColumns)
-        )
-      };
-      if (columnsChanged && __privateGet(this, _autosubscribeColumns).length) {
-        __privateSet(this, _allColumns, combineColumnsWithAutosubscribeColumns(
-          columns,
-          __privateGet(this, _autosubscribeColumns)
-        ));
-      }
-      this.server?.send({
-        viewport: this.viewport,
-        type: "config",
-        config: serverConfig
-      });
-    }
-  }
-  set impendingConfig(config) {
-    if (config !== this.config) {
-      super.impendingConfig = config;
-      this.server?.send({
-        viewport: this.viewport,
-        type: "config",
-        config: combineFilters(this.config)
-      });
-    }
-  }
-  get groupBy() {
-    return this._configWithVisualLink.groupBy;
-  }
-  set groupBy(groupBy) {
-    if (itemsOrOrderChanged(this.groupBy, groupBy)) {
-      const wasGrouped = this.groupBy.length > 0;
-      this.impendingConfig = {
-        ...this._configWithVisualLink,
-        groupBy
-      };
-      if (!wasGrouped && groupBy.length > 0 && this.viewport) {
-        this._clientCallback?.({
-          clientViewportId: this.viewport,
-          mode: "batch",
-          type: "viewport-update",
-          size: 0,
-          rows: []
-        });
-      }
-    }
-  }
-  get range() {
-    return super.range;
-  }
-  set range(range) {
-    super.range = range;
-    if (__privateGet(this, _sessionDataSource)) {
-      __privateGet(this, _sessionDataSource).range = range;
-    }
-  }
-  get title() {
-    return super.title || `${this.table.module} ${this.table.table}`;
-  }
-  set title(title) {
-    super.title = title;
-    if (this.viewport && title) {
-      this.server?.send({
-        type: "setTitle",
-        title,
-        viewport: this.viewport
-      });
-    }
-  }
-  get visualLink() {
-    return this._configWithVisualLink.visualLink;
-  }
-  set visualLink(visualLink) {
-    this._configWithVisualLink = {
-      ...this._configWithVisualLink,
-      visualLink
-    };
-    if (visualLink) {
-      const {
-        parentClientVpId,
-        link: { fromColumn, toColumn }
-      } = visualLink;
-      if (this.viewport) {
-        this.server?.rpcCall({
-          childColumnName: fromColumn,
-          childVpId: this.viewport,
-          parentColumnName: toColumn,
-          parentVpId: parentClientVpId,
-          type: "CREATE_VISUAL_LINK"
-        }).then((response) => {
-          this.emit("visual-link-created", response);
-        });
-      }
-    } else {
-      if (this.viewport) {
-        this.server?.rpcCall({
-          type: "REMOVE_VISUAL_LINK",
-          childVpId: this.viewport
-        }).then(() => {
-          this.emit("visual-link-removed");
-        });
-      }
-    }
-    this.emit("config", this._configWithVisualLink, this.range);
-  }
-  async remoteProcedureCall() {
-    return Promise.reject();
-  }
-  async createSessionDataSource(copyOption) {
-    const rpcResponse = await this?.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "createSessionTable",
-      params: { copyOption }
-    });
-    if (isRpcSuccess(rpcResponse)) {
-      const { table: sessionTable } = rpcResponse.data;
-      return new _VuuDataSource({
-        ...this.config,
-        table: sessionTable,
-        viewport: sessionTable.table
-      });
-    } else {
-      throw Error(
-        `[VuuDataSource] createSessionDataSource ${rpcResponse?.errorMessage}`
-      );
-    }
-  }
-  async beginEditSession(editSessionMode = "all-rows") {
-    const rpcResponse = await this?.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "beginEditSession",
-      params: {
-        editSessionMode
-      }
-    });
-    if (isRpcSuccess(rpcResponse)) {
-      const { table: sessionTable } = rpcResponse.data;
-      const columns = __privateGet(this, _sessionTableMessageColumn) ? this.columns.concat(__privateGet(this, _sessionTableMessageColumn)) : this.columns;
-      __privateSet(this, _sessionDataSource, new _VuuDataSource({
-        ...this.config,
-        columns,
-        table: sessionTable,
-        viewport: sessionTable.table
-      }));
-      __privateGet(this, _sessionDataSource).subscribe(
-        {
-          range: this.range
-        },
-        this.handleSessionMessageFromServer
-      );
-    } else {
-      throw Error(
-        `[VuuDataSource] beginEditSession ${rpcResponse.errorMessage}`
-      );
-    }
-  }
-  async editCell(key, column, data) {
-    const rpcHost = __privateGet(this, _sessionDataSource) ?? this;
-    return rpcHost.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "editCell",
-      params: {
-        column,
-        data,
-        key
-      }
-    });
-  }
-  async endEditSession(saveChanges = false, force = false) {
-    const type = "RPC_REQUEST";
-    const rpcName = "endEditSession";
-    const sessionDataSource = __privateGet(this, _sessionDataSource);
-    const rpcHost = sessionDataSource ?? this;
-    if (sessionDataSource) {
-      __privateSet(this, _sessionDataSource, void 0);
-    }
-    const rpcResponse = await rpcHost.rpcRequest?.(
-      saveChanges ? { type, rpcName, params: { save: true, force } } : { type, rpcName, params: {} }
-    );
-    if (isRpcSuccess(rpcResponse)) {
-      if (sessionDataSource) {
-        sessionDataSource?.unsubscribe();
-      }
-    } else {
-      if (rpcResponse?.errorMessage === "stale update") {
-        __privateSet(this, _sessionDataSource, sessionDataSource);
-        throw new StaleUpdateError(rpcResponse.errorMessage);
-      } else {
-        throw Error("unknown error");
-      }
-    }
-    this.sendResumeMessage();
-  }
-  async rpcRequest(rpcRequest) {
-    if (this.viewport && this.server) {
-      return this.server?.rpcCall({
-        ...rpcRequest,
-        context: { type: "VIEWPORT_CONTEXT", viewPortId: this.viewport }
-      });
-    } else {
-      throw Error(`rpcCall server or viewport are undefined`);
-    }
-  }
-  async menuRpcCall(rpcRequest) {
-    if (this.viewport) {
-      return this.server?.rpcCall({
-        ...rpcRequest,
-        vpId: this.viewport
-      });
-    }
-  }
-  insertRow() {
-    return Promise.resolve("not supported");
-  }
-  async deleteRow(key, mode = "hard") {
-    const rpcHost = __privateGet(this, _sessionDataSource) ?? this;
-    const response = await rpcHost.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "deleteRow",
-      params: { key, mode }
-    });
-    if (isRpcSuccess(response)) {
-      return true;
-    }
-    return response?.errorMessage ?? "deleteRow failed";
-  }
-  async deleteSelectedRows(mode = "soft") {
-    const rpcHost = __privateGet(this, _sessionDataSource) ?? this;
-    const response = await rpcHost.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "deleteSelectedRows",
-      params: { mode }
-    });
-    return response ?? {
-      type: "ERROR_RESULT",
-      errorMessage: "deleteSelectedRows failed"
-    };
-  }
-  async addRow(rowData = {}) {
-    const response = await this.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "addRow",
-      params: { data: rowData }
-    });
-    if (isRpcSuccess(response)) {
-      return true;
-    }
-    return response?.errorMessage ?? "addRow failed";
-  }
-  async undoRowChange(key) {
-    const rpcHost = __privateGet(this, _sessionDataSource) ?? this;
-    const response = await rpcHost.rpcRequest?.({
-      type: "RPC_REQUEST",
-      rpcName: "undoRowChange",
-      params: { key }
-    });
-    return response ?? { type: "ERROR_RESULT", errorMessage: "undoRowChange failed" };
-  }
-};
-_allColumns = new WeakMap();
-_autosubscribeColumns = new WeakMap();
-_pendingVisualLink = new WeakMap();
-_links = new WeakMap();
-_maxRangeEnd = new WeakMap();
-_maxRangeWidth = new WeakMap();
-_menu = new WeakMap();
-_optimize = new WeakMap();
-_selectedRowsCount = new WeakMap();
-_sessionDataSource = new WeakMap();
-_sessionTableMessageColumn = new WeakMap();
-_status = new WeakMap();
-_tableSchema = new WeakMap();
-let VuuDataSource = _VuuDataSource;
-
-export { VuuDataSource };
-//# sourceMappingURL=VuuDataSource.js.map