@ocap/indexdb 1.28.8 → 1.29.0

package/lib/index.cjs

@@ -0,0 +1,96 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+let _ocap_util_lib_ready = require("@ocap/util/lib/ready");
+let node_crypto = require("node:crypto");
+node_crypto = require_rolldown_runtime.__toESM(node_crypto);
+let kareem = require("kareem");
+kareem = require_rolldown_runtime.__toESM(kareem);
+let lodash_omit = require("lodash/omit");
+lodash_omit = require_rolldown_runtime.__toESM(lodash_omit);
+
+//#region src/index.ts
+/**
+* Base class for index tables
+* Provides hook support (pre/post) and common operations
+* Subclasses must implement _insert, _get, _update, _reset, count
+*/
+var BaseIndex = class extends _ocap_util_lib_ready.Ready {
+	constructor(name, uniqIndex) {
+		super();
+		this.name = name || "";
+		this.ready = false;
+		this.readyCallbacks = [];
+		this.uniqIndex = uniqIndex || "id";
+		this.primaryKey = typeof uniqIndex === "string" ? uniqIndex : "id";
+		const hooks = new kareem.default();
+		Object.defineProperty(this, "pre", { value: (hookName, fn) => hooks.pre(hookName, fn) });
+		Object.defineProperty(this, "post", { value: (hookName, fn) => hooks.post(hookName, fn) });
+		[
+			"insert",
+			"get",
+			"update",
+			"reset"
+		].forEach((opName) => {
+			Object.defineProperty(this, opName, { value: async (...args) => {
+				hooks.execPreSync(opName, args);
+				const result = await this[`_${opName}`](...args);
+				hooks.execPostSync(opName, result);
+				if (["insert", "update"].includes(opName)) this.emit(opName, (0, lodash_omit.default)(result, "$loki"));
+				return result;
+			} });
+		});
+	}
+	/**
+	* Count documents matching query
+	* Must be implemented by subclasses
+	*/
+	count(_query) {
+		throw new Error("`count` must be implemented in sub indexdb");
+	}
+	/**
+	* Internal insert implementation
+	* Called by the public `insert` method after pre-hooks
+	*/
+	_insert(_doc) {
+		throw new Error("`_insert` must be implemented in sub indexdb");
+	}
+	/**
+	* Internal get implementation
+	* Called by the public `get` method after pre-hooks
+	*/
+	_get(_key) {
+		throw new Error("`_get` must be implemented in sub indexdb");
+	}
+	/**
+	* Internal update implementation
+	* Called by the public `update` method after pre-hooks
+	*/
+	_update(_key, _updates) {
+		throw new Error("`_update` must be implemented in sub indexdb");
+	}
+	/**
+	* Internal reset implementation
+	* Called by the public `reset` method after pre-hooks
+	*/
+	_reset() {
+		throw new Error("`_reset` must be implemented in sub indexdb");
+	}
+	/**
+	* Generate primary key from document or key object
+	* For composite keys, generates MD5 hash of joined values
+	* @param doc - String key or document/key object
+	* @returns Primary key string
+	*/
+	generatePrimaryKey(doc) {
+		if (typeof doc === "string") return doc;
+		if (Array.isArray(this.uniqIndex)) {
+			const key = this.uniqIndex.map((id) => doc[id]).map((item) => typeof item === "object" ? JSON.stringify(item) : item).join("-");
+			return node_crypto.default.createHash("md5").update(key).digest("hex");
+		}
+		return doc[this.uniqIndex];
+	}
+};
+var src_default = BaseIndex;
+
+//#endregion
+exports.default = src_default;

package/lib/index.d.cts

@@ -0,0 +1,58 @@
+import { IIndexTable, IndexTableHookFn, Promisable } from "@ocap/types";
+import { Ready } from "@ocap/util/lib/ready";
+
+//#region src/index.d.ts
+type UniqueIndex = string | string[];
+/**
+ * Base class for index tables
+ * Provides hook support (pre/post) and common operations
+ * Subclasses must implement _insert, _get, _update, _reset, count
+ */
+declare class BaseIndex<T = unknown> extends Ready implements IIndexTable<T> {
+  readonly name: string;
+  readonly primaryKey: string;
+  readonly uniqIndex: UniqueIndex;
+  ready: boolean;
+  readyCallbacks: Array<() => void>;
+  pre: (hookName: string, fn: IndexTableHookFn) => void;
+  post: (hookName: string, fn: IndexTableHookFn) => void;
+  insert: (doc: T | Record<string, unknown>) => Promise<T>;
+  get: (key: string | Record<string, unknown>) => Promise<T | null>;
+  update: (key: string | Record<string, unknown>, updates: Partial<T>) => Promise<T>;
+  reset: () => Promise<void>;
+  constructor(name?: string, uniqIndex?: UniqueIndex);
+  /**
+   * Count documents matching query
+   * Must be implemented by subclasses
+   */
+  count(_query?: unknown): Promisable<number>;
+  /**
+   * Internal insert implementation
+   * Called by the public `insert` method after pre-hooks
+   */
+  _insert(_doc: T | Record<string, unknown>): Promisable<T>;
+  /**
+   * Internal get implementation
+   * Called by the public `get` method after pre-hooks
+   */
+  _get(_key: string | Record<string, unknown>): Promisable<T | null>;
+  /**
+   * Internal update implementation
+   * Called by the public `update` method after pre-hooks
+   */
+  _update(_key: string | Record<string, unknown>, _updates: Partial<T>): Promisable<T>;
+  /**
+   * Internal reset implementation
+   * Called by the public `reset` method after pre-hooks
+   */
+  _reset(): Promisable<void>;
+  /**
+   * Generate primary key from document or key object
+   * For composite keys, generates MD5 hash of joined values
+   * @param doc - String key or document/key object
+   * @returns Primary key string
+   */
+  generatePrimaryKey(doc: string | Record<string, unknown>): string;
+}
+//#endregion
+export { BaseIndex as default };

package/lib/main.cjs

@@ -0,0 +1,25 @@
+const require_db = require('./db.cjs');
+const require_index = require('./index.cjs');
+const require_util = require('./util.cjs');
+
+exports.BaseIndex = require_index.default;
+exports.BaseIndexDB = require_db.default;
+exports.createIndexedAccount = require_util.createIndexedAccount;
+exports.createIndexedAsset = require_util.createIndexedAsset;
+exports.createIndexedDelegation = require_util.createIndexedDelegation;
+exports.createIndexedFactory = require_util.createIndexedFactory;
+exports.createIndexedRollup = require_util.createIndexedRollup;
+exports.createIndexedRollupBlock = require_util.createIndexedRollupBlock;
+exports.createIndexedStake = require_util.createIndexedStake;
+exports.createIndexedToken = require_util.createIndexedToken;
+exports.createIndexedTokenDistribution = require_util.createIndexedTokenDistribution;
+exports.createIndexedTokenFactory = require_util.createIndexedTokenFactory;
+exports.createIndexedTransaction = require_util.createIndexedTransaction;
+exports.formatDelegationAfterRead = require_util.formatDelegationAfterRead;
+exports.formatNextPagination = require_util.formatNextPagination;
+exports.formatPagination = require_util.formatPagination;
+exports.formatTokenMeta = require_util.formatTokenMeta;
+exports.formatTxAfterRead = require_util.formatTxAfterRead;
+exports.formatTxBeforeInsert = require_util.formatTxBeforeInsert;
+exports.isDefaultTokenChanged = require_util.isDefaultTokenChanged;
+exports.parseDateTime = require_util.parseDateTime;

package/lib/main.d.cts

@@ -0,0 +1,4 @@
+import BaseIndexDB from "./db.cjs";
+import BaseIndex from "./index.cjs";
+import { DelegationContext, FactoryContext, FormatPaginationParams, FormattedPagination, IndexDBForTx, PagingInput, RollupBlockContext, RollupContext, TokenFactoryContext, TokenStateInfo, TokenWithBalance, TxData, createIndexedAccount, createIndexedAsset, createIndexedDelegation, createIndexedFactory, createIndexedRollup, createIndexedRollupBlock, createIndexedStake, createIndexedToken, createIndexedTokenDistribution, createIndexedTokenFactory, createIndexedTransaction, formatDelegationAfterRead, formatNextPagination, formatPagination, formatTokenMeta, formatTxAfterRead, formatTxBeforeInsert, isDefaultTokenChanged, parseDateTime } from "./util.cjs";
+export { BaseIndex, BaseIndexDB, DelegationContext, FactoryContext, FormatPaginationParams, FormattedPagination, IndexDBForTx, PagingInput, RollupBlockContext, RollupContext, TokenFactoryContext, TokenStateInfo, TokenWithBalance, TxData, createIndexedAccount, createIndexedAsset, createIndexedDelegation, createIndexedFactory, createIndexedRollup, createIndexedRollupBlock, createIndexedStake, createIndexedToken, createIndexedTokenDistribution, createIndexedTokenFactory, createIndexedTransaction, formatDelegationAfterRead, formatNextPagination, formatPagination, formatTokenMeta, formatTxAfterRead, formatTxBeforeInsert, isDefaultTokenChanged, parseDateTime };