@talismn/util 0.4.1 → 0.5.0

package/dist/declarations/src/getSharedObservable.d.ts

@@ -0,0 +1,13 @@
+import { Observable } from "rxjs";
+/**
+ * When using react-rxjs hooks and state observables, the options are used as weak map keys.
+ * This means that if the options object is recreated on each render, the observable will be recreated as well.
+ * This utility function allows you to create a shared observable based on a namespace and arguments that, so react-rxjs can reuse the same observables
+ *
+ * @param namespace
+ * @param args
+ * @param createObservable
+ * @param serializer
+ * @returns
+ */
+export declare const getSharedObservable: <Args, Output, ObsOutput = Observable<Output>>(namespace: string, args: Args, createObservable: (args: Args) => ObsOutput, serializer?: (args: Args) => string) => ObsOutput;

package/dist/declarations/src/index.d.ts

@@ -28,3 +28,7 @@ export * from "./isAddressEqual";
 export * from "./isAscii";
 export * from "./isNotNil";
 export * from "./isTruthy";
+export * from "./isAbortError";
+export * from "./getSharedObservable";
+export * from "./keepAlive";
+export * from "./isHexString";

package/dist/declarations/src/isAbortError.d.ts

@@ -0,0 +1 @@
+export declare const isAbortError: (error: unknown) => boolean;

package/dist/declarations/src/isHexString.d.ts

@@ -0,0 +1,3 @@
+export type HexString = `0x${string}`;
+export declare const REGEX_HEX_STRING: RegExp;
+export declare const isHexString: (value: unknown) => value is HexString;

package/dist/declarations/src/keepAlive.d.ts

@@ -0,0 +1,17 @@
+import type { OperatorFunction } from "rxjs";
+/**
+ * An RxJS operator that keeps the source observable alive for a specified duration
+ * after all subscribers have unsubscribed. This prevents expensive re-subscriptions
+ * when subscribers come and go frequently.
+ *
+ * @param keepAliveMs - Duration in milliseconds to keep the source alive after last unsubscription
+ * @returns MonoTypeOperatorFunction that can be used in pipe()
+ *
+ * @example
+ * ```typescript
+ * const data$ = expensive_api_call$.pipe(
+ *   keepAlive(3000) // Keep alive for 3 seconds
+ * );
+ * ```
+ */
+export declare const keepAlive: <T>(timeout: number) => OperatorFunction<T, T>;

package/dist/talismn-util.cjs.dev.js

@@ -282,13 +282,13 @@ const validateHexString = str => {
   throw new Error("Expected a hex string");
 };
 
-const CACHE = new Map();
+const CACHE$1 = new Map();
 
 // Normalize an address in a way that it can be compared to other addresses that have also been normalized
 const normalizeAddress = address => {
   try {
-    if (!CACHE.has(address)) CACHE.set(address, encodeAnyAddress(address));
-    return CACHE.get(address);
+    if (!CACHE$1.has(address)) CACHE$1.set(address, encodeAnyAddress(address));
+    return CACHE$1.get(address);
   } catch (cause) {
     throw new Error(`Unable to normalize address: ${address}`, {
       cause
@@ -316,9 +316,78 @@ const isNotNil = value => value !== null && value !== undefined;
 
 const isTruthy = value => Boolean(value);
 
+const isAbortError = error => {
+  return error instanceof Error && error.name === "AbortError";
+};
+
+const CACHE = new Map();
+
+/**
+ * When using react-rxjs hooks and state observables, the options are used as weak map keys.
+ * This means that if the options object is recreated on each render, the observable will be recreated as well.
+ * This utility function allows you to create a shared observable based on a namespace and arguments that, so react-rxjs can reuse the same observables
+ *
+ * @param namespace
+ * @param args
+ * @param createObservable
+ * @param serializer
+ * @returns
+ */
+const getSharedObservable = (namespace, args, createObservable, serializer = args => JSON.stringify(args)) => {
+  const cacheKey = `${namespace}:${serializer(args)}`;
+  if (CACHE.has(cacheKey)) return CACHE.get(cacheKey);
+  const obs = createObservable(args);
+  const sharedObs = obs.pipe(rxjs.shareReplay({
+    bufferSize: 1,
+    refCount: true
+  }));
+  CACHE.set(cacheKey, sharedObs);
+  return sharedObs;
+};
+
+/**
+ * An RxJS operator that keeps the source observable alive for a specified duration
+ * after all subscribers have unsubscribed. This prevents expensive re-subscriptions
+ * when subscribers come and go frequently.
+ *
+ * @param keepAliveMs - Duration in milliseconds to keep the source alive after last unsubscription
+ * @returns MonoTypeOperatorFunction that can be used in pipe()
+ *
+ * @example
+ * ```typescript
+ * const data$ = expensive_api_call$.pipe(
+ *   keepAlive(3000) // Keep alive for 3 seconds
+ * );
+ * ```
+ */
+const keepAlive = timeout => {
+  let release;
+  return source => source.pipe(rxjs.tap({
+    subscribe: () => {
+      release = keepSourceSubscribed(source, timeout);
+    },
+    unsubscribe: () => {
+      release?.();
+    }
+  }), rxjs.shareReplay({
+    refCount: true,
+    bufferSize: 1
+  }));
+};
+const keepSourceSubscribed = (observable, ms) => {
+  const sub = observable.subscribe();
+  return () => setTimeout(() => sub.unsubscribe(), ms);
+};
+
+const REGEX_HEX_STRING = /^0x[0-9a-fA-F]*$/;
+const isHexString = value => {
+  return typeof value === "string" && REGEX_HEX_STRING.test(value);
+};
+
 exports.BigMath = BigMath;
 exports.Deferred = Deferred;
 exports.MAX_DECIMALS_FORMAT = MAX_DECIMALS_FORMAT;
+exports.REGEX_HEX_STRING = REGEX_HEX_STRING;
 exports.addTrailingSlash = addTrailingSlash;
 exports.blake2Concat = blake2Concat;
 exports.classNames = classNames;
@@ -329,16 +398,20 @@ exports.encodeAnyAddress = encodeAnyAddress;
 exports.firstThenDebounce = firstThenDebounce;
 exports.formatDecimals = formatDecimals;
 exports.formatPrice = formatPrice;
+exports.getSharedObservable = getSharedObservable;
 exports.hasOwnProperty = hasOwnProperty;
+exports.isAbortError = isAbortError;
 exports.isAddressEqual = isAddressEqual;
 exports.isArrayOf = isArrayOf;
 exports.isAscii = isAscii;
 exports.isBigInt = isBigInt;
 exports.isBooleanTrue = isBooleanTrue;
 exports.isEthereumAddress = isEthereumAddress;
+exports.isHexString = isHexString;
 exports.isNotNil = isNotNil;
 exports.isTruthy = isTruthy;
 exports.isValidSubstrateAddress = isValidSubstrateAddress;
+exports.keepAlive = keepAlive;
 exports.normalizeAddress = normalizeAddress;
 exports.planckToTokens = planckToTokens;
 exports.sleep = sleep;

package/dist/talismn-util.cjs.prod.js

@@ -282,13 +282,13 @@ const validateHexString = str => {
   throw new Error("Expected a hex string");
 };
 
-const CACHE = new Map();
+const CACHE$1 = new Map();
 
 // Normalize an address in a way that it can be compared to other addresses that have also been normalized
 const normalizeAddress = address => {
   try {
-    if (!CACHE.has(address)) CACHE.set(address, encodeAnyAddress(address));
-    return CACHE.get(address);
+    if (!CACHE$1.has(address)) CACHE$1.set(address, encodeAnyAddress(address));
+    return CACHE$1.get(address);
   } catch (cause) {
     throw new Error(`Unable to normalize address: ${address}`, {
       cause
@@ -316,9 +316,78 @@ const isNotNil = value => value !== null && value !== undefined;
 
 const isTruthy = value => Boolean(value);
 
+const isAbortError = error => {
+  return error instanceof Error && error.name === "AbortError";
+};
+
+const CACHE = new Map();
+
+/**
+ * When using react-rxjs hooks and state observables, the options are used as weak map keys.
+ * This means that if the options object is recreated on each render, the observable will be recreated as well.
+ * This utility function allows you to create a shared observable based on a namespace and arguments that, so react-rxjs can reuse the same observables
+ *
+ * @param namespace
+ * @param args
+ * @param createObservable
+ * @param serializer
+ * @returns
+ */
+const getSharedObservable = (namespace, args, createObservable, serializer = args => JSON.stringify(args)) => {
+  const cacheKey = `${namespace}:${serializer(args)}`;
+  if (CACHE.has(cacheKey)) return CACHE.get(cacheKey);
+  const obs = createObservable(args);
+  const sharedObs = obs.pipe(rxjs.shareReplay({
+    bufferSize: 1,
+    refCount: true
+  }));
+  CACHE.set(cacheKey, sharedObs);
+  return sharedObs;
+};
+
+/**
+ * An RxJS operator that keeps the source observable alive for a specified duration
+ * after all subscribers have unsubscribed. This prevents expensive re-subscriptions
+ * when subscribers come and go frequently.
+ *
+ * @param keepAliveMs - Duration in milliseconds to keep the source alive after last unsubscription
+ * @returns MonoTypeOperatorFunction that can be used in pipe()
+ *
+ * @example
+ * ```typescript
+ * const data$ = expensive_api_call$.pipe(
+ *   keepAlive(3000) // Keep alive for 3 seconds
+ * );
+ * ```
+ */
+const keepAlive = timeout => {
+  let release;
+  return source => source.pipe(rxjs.tap({
+    subscribe: () => {
+      release = keepSourceSubscribed(source, timeout);
+    },
+    unsubscribe: () => {
+      release?.();
+    }
+  }), rxjs.shareReplay({
+    refCount: true,
+    bufferSize: 1
+  }));
+};
+const keepSourceSubscribed = (observable, ms) => {
+  const sub = observable.subscribe();
+  return () => setTimeout(() => sub.unsubscribe(), ms);
+};
+
+const REGEX_HEX_STRING = /^0x[0-9a-fA-F]*$/;
+const isHexString = value => {
+  return typeof value === "string" && REGEX_HEX_STRING.test(value);
+};
+
 exports.BigMath = BigMath;
 exports.Deferred = Deferred;
 exports.MAX_DECIMALS_FORMAT = MAX_DECIMALS_FORMAT;
+exports.REGEX_HEX_STRING = REGEX_HEX_STRING;
 exports.addTrailingSlash = addTrailingSlash;
 exports.blake2Concat = blake2Concat;
 exports.classNames = classNames;
@@ -329,16 +398,20 @@ exports.encodeAnyAddress = encodeAnyAddress;
 exports.firstThenDebounce = firstThenDebounce;
 exports.formatDecimals = formatDecimals;
 exports.formatPrice = formatPrice;
+exports.getSharedObservable = getSharedObservable;
 exports.hasOwnProperty = hasOwnProperty;
+exports.isAbortError = isAbortError;
 exports.isAddressEqual = isAddressEqual;
 exports.isArrayOf = isArrayOf;
 exports.isAscii = isAscii;
 exports.isBigInt = isBigInt;
 exports.isBooleanTrue = isBooleanTrue;
 exports.isEthereumAddress = isEthereumAddress;
+exports.isHexString = isHexString;
 exports.isNotNil = isNotNil;
 exports.isTruthy = isTruthy;
 exports.isValidSubstrateAddress = isValidSubstrateAddress;
+exports.keepAlive = keepAlive;
 exports.normalizeAddress = normalizeAddress;
 exports.planckToTokens = planckToTokens;
 exports.sleep = sleep;

package/dist/talismn-util.esm.js

@@ -2,7 +2,7 @@ import { u8aToHex, u8aConcat, u8aToU8a, hexToU8a } from '@polkadot/util';
 import { blake2AsU8a, isEthereumAddress as isEthereumAddress$1, ethereumEncode, decodeAddress as decodeAddress$1, base58Decode, checkAddressChecksum, xxhashAsU8a } from '@polkadot/util-crypto';
 import { twMerge } from 'tailwind-merge';
 import { encodeAddress, decodeAddress } from '@polkadot/keyring';
-import { concat, take, skip, debounceTime } from 'rxjs';
+import { concat, take, skip, debounceTime, shareReplay, tap } from 'rxjs';
 import BigNumber from 'bignumber.js';
 
 const addTrailingSlash = url => {
@@ -276,13 +276,13 @@ const validateHexString = str => {
   throw new Error("Expected a hex string");
 };
 
-const CACHE = new Map();
+const CACHE$1 = new Map();
 
 // Normalize an address in a way that it can be compared to other addresses that have also been normalized
 const normalizeAddress = address => {
   try {
-    if (!CACHE.has(address)) CACHE.set(address, encodeAnyAddress(address));
-    return CACHE.get(address);
+    if (!CACHE$1.has(address)) CACHE$1.set(address, encodeAnyAddress(address));
+    return CACHE$1.get(address);
   } catch (cause) {
     throw new Error(`Unable to normalize address: ${address}`, {
       cause
@@ -310,4 +310,72 @@ const isNotNil = value => value !== null && value !== undefined;
 
 const isTruthy = value => Boolean(value);
 
-export { BigMath, Deferred, MAX_DECIMALS_FORMAT, addTrailingSlash, blake2Concat, classNames, convertAddress, decodeAnyAddress, decodeSs58Format, encodeAnyAddress, firstThenDebounce, formatDecimals, formatPrice, hasOwnProperty, isAddressEqual, isArrayOf, isAscii, isBigInt, isBooleanTrue, isEthereumAddress, isNotNil, isTruthy, isValidSubstrateAddress, normalizeAddress, planckToTokens, sleep, throwAfter, tokensToPlanck, twox64Concat, validateHexString };
+const isAbortError = error => {
+  return error instanceof Error && error.name === "AbortError";
+};
+
+const CACHE = new Map();
+
+/**
+ * When using react-rxjs hooks and state observables, the options are used as weak map keys.
+ * This means that if the options object is recreated on each render, the observable will be recreated as well.
+ * This utility function allows you to create a shared observable based on a namespace and arguments that, so react-rxjs can reuse the same observables
+ *
+ * @param namespace
+ * @param args
+ * @param createObservable
+ * @param serializer
+ * @returns
+ */
+const getSharedObservable = (namespace, args, createObservable, serializer = args => JSON.stringify(args)) => {
+  const cacheKey = `${namespace}:${serializer(args)}`;
+  if (CACHE.has(cacheKey)) return CACHE.get(cacheKey);
+  const obs = createObservable(args);
+  const sharedObs = obs.pipe(shareReplay({
+    bufferSize: 1,
+    refCount: true
+  }));
+  CACHE.set(cacheKey, sharedObs);
+  return sharedObs;
+};
+
+/**
+ * An RxJS operator that keeps the source observable alive for a specified duration
+ * after all subscribers have unsubscribed. This prevents expensive re-subscriptions
+ * when subscribers come and go frequently.
+ *
+ * @param keepAliveMs - Duration in milliseconds to keep the source alive after last unsubscription
+ * @returns MonoTypeOperatorFunction that can be used in pipe()
+ *
+ * @example
+ * ```typescript
+ * const data$ = expensive_api_call$.pipe(
+ *   keepAlive(3000) // Keep alive for 3 seconds
+ * );
+ * ```
+ */
+const keepAlive = timeout => {
+  let release;
+  return source => source.pipe(tap({
+    subscribe: () => {
+      release = keepSourceSubscribed(source, timeout);
+    },
+    unsubscribe: () => {
+      release?.();
+    }
+  }), shareReplay({
+    refCount: true,
+    bufferSize: 1
+  }));
+};
+const keepSourceSubscribed = (observable, ms) => {
+  const sub = observable.subscribe();
+  return () => setTimeout(() => sub.unsubscribe(), ms);
+};
+
+const REGEX_HEX_STRING = /^0x[0-9a-fA-F]*$/;
+const isHexString = value => {
+  return typeof value === "string" && REGEX_HEX_STRING.test(value);
+};
+
+export { BigMath, Deferred, MAX_DECIMALS_FORMAT, REGEX_HEX_STRING, addTrailingSlash, blake2Concat, classNames, convertAddress, decodeAnyAddress, decodeSs58Format, encodeAnyAddress, firstThenDebounce, formatDecimals, formatPrice, getSharedObservable, hasOwnProperty, isAbortError, isAddressEqual, isArrayOf, isAscii, isBigInt, isBooleanTrue, isEthereumAddress, isHexString, isNotNil, isTruthy, isValidSubstrateAddress, keepAlive, normalizeAddress, planckToTokens, sleep, throwAfter, tokensToPlanck, twox64Concat, validateHexString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/util",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -26,16 +26,16 @@
     "tailwind-merge": "^2.5.4"
   },
   "devDependencies": {
-    "@polkadot/keyring": "13.4.3",
-    "@polkadot/util": "13.4.3",
-    "@polkadot/util-crypto": "13.4.3",
+    "@polkadot/keyring": "13.5.1",
+    "@polkadot/util": "13.5.1",
+    "@polkadot/util-crypto": "13.5.1",
     "@types/jest": "^29.5.14",
     "eslint": "^8.57.1",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.3",
-    "@talismn/eslint-config": "0.0.3",
-    "@talismn/tsconfig": "0.0.2"
+    "@talismn/tsconfig": "0.0.2",
+    "@talismn/eslint-config": "0.0.3"
   },
   "peerDependencies": {
     "@polkadot/keyring": "*",