@latticexyz/utils 0.9.0

package/src/proxy.ts

@@ -0,0 +1,101 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IComputedValue, IObservableValue, reaction } from "mobx";
+import DeepProxy from "proxy-deep";
+import { deferred } from "./deferred";
+import { isFunction, isObject } from "./guards";
+import { Cached } from "./types";
+
+function deepAccess(target: Record<string, unknown>, path: string[]): any {
+  if (path.length === 0) return target;
+  if (path.length === 1) return target[path[0]];
+  const [next, ...rest] = path;
+  const nextTarget = target[next];
+  if (!isObject(nextTarget)) throw new Error("Path does not exist on the target");
+  return deepAccess(nextTarget, rest);
+}
+
+/**
+ * Caches any function calls to the target until the target is ready.
+ * @param target T extends Cachable
+ * @returns Cached<T>
+ */
+export function cacheUntilReady<T extends Record<string, any>>(
+  target: IObservableValue<T | undefined> | IComputedValue<T | undefined>
+): Cached<T> {
+  // The call queue contains the path and arguments of calls to the
+  // proxiedTarget while the target was not available yet.
+  // It also contains resolve and reject methods to fulfil the promise
+  // returned when calling the proxiedTarget once the target becomes available.
+  const callQueue: {
+    path: string[];
+    args?: any[];
+    resolve: (result: any) => void;
+    reject: (e: Error) => void;
+  }[] = [];
+
+  // The proxiedTarget proxies all calls to the target.
+  // If a function is called on the proxiedTarget while the target is not
+  // available, a promise is returned and the call will be stored in the callQueue
+  // until the target becomes available and the promise is fulfilled.
+  const proxiedTarget = new DeepProxy(
+    {},
+    {
+      get(_t, prop) {
+        const targetReady = target.get();
+        if (targetReady) {
+          // If the target is ready, relay all calls directly to the target
+          // (Except for the "proxied" key, which indicates whether the object is currently proxied)
+          if (prop === "proxied") return false;
+          return Reflect.get(targetReady, prop);
+        } else {
+          // Note: if the target is not available, accessing a property returns another proxy,
+          // not a Promise. It is possible to check whether a value is currently proxied using the proxied key.
+          if (prop === "proxied") return true;
+          if (prop === "name") return "ProxiedTarget";
+          if (prop === "toJSON") return () => ({ proxied: true });
+          return this.nest(() => void 0);
+        }
+      },
+      apply(_, thisArg, args) {
+        const targetReady = target.get();
+        if (targetReady) {
+          // If the target is ready, relay all calls directly to the target
+          const targetFunc = deepAccess(targetReady, this.path);
+          if (!isFunction(targetFunc)) throw new Error("Target is not callable");
+          return Reflect.apply(targetFunc, thisArg, args);
+        } else {
+          // Otherwise store the call and relay it to the target later once it's ready.
+          // The return value of this call is a promise, that gets resolved once the target is ready.
+          const [resolve, reject, promise] = deferred();
+          callQueue.push({ path: this.path, args, resolve, reject });
+          return promise;
+        }
+      },
+    }
+  );
+
+  reaction(
+    () => target.get(),
+    (targetReady) => {
+      if (!targetReady) return;
+      // Move all entries from callQueue to queuedCalls
+      const queuedCalls = callQueue.splice(0);
+      for (const { path, args, resolve, reject } of queuedCalls) {
+        const target = deepAccess(targetReady, path);
+        if (args && isFunction(target)) {
+          (async () => {
+            try {
+              resolve(await target(...args));
+            } catch (e: any) {
+              reject(e);
+            }
+          })();
+        } else {
+          resolve(target);
+        }
+      }
+    }
+  );
+
+  return proxiedTarget as Cached<T>;
+}

package/src/random.ts

@@ -0,0 +1,17 @@
+/**
+ *
+ * @param to Upper bound (included)
+ * @param from Lower bound (included). Default 0.
+ * @returns A random integer between from and to.
+ */
+export function random(to: number, from = 0): number {
+  return Math.floor(Math.random() * (to - from + 1)) + from;
+}
+
+/**
+ * @param array Array to pick a random element from.
+ * @returns Random element from the given array.
+ */
+export function pickRandom<T>(array: [T, ...T[]]): T {
+  return array[random(array.length - 1)];
+}

package/src/rx.spec.ts

@@ -0,0 +1,45 @@
+import { Subject } from "rxjs";
+import { awaitStreamValue, streamToComputed } from "./rx";
+import { sleep } from "./sleep";
+
+describe("streamToComputed", () => {
+  it("should return a computed value that corresponds to the last stream value", () => {
+    const stream = new Subject<number>();
+    const comp = streamToComputed(stream);
+    expect(comp.get()).toBeUndefined();
+
+    stream.next(1);
+    expect(comp.get()).toBe(1);
+
+    stream.next(2);
+    expect(comp.get()).toBe(2);
+
+    stream.next(3);
+    stream.next(4);
+    expect(comp.get()).toBe(4);
+  });
+});
+
+describe("awaitStreamValue", () => {
+  it("should return a promise that resolves once the requested stream value is emitted", async () => {
+    const stream = new Subject<number>();
+    const promise = awaitStreamValue(stream, (v) => v === 1);
+
+    let isFulfilled = false;
+    (async () => {
+      await promise;
+      isFulfilled = true;
+    })();
+
+    await sleep(100);
+    expect(isFulfilled).toBe(false);
+
+    stream.next(2);
+    await sleep(100);
+    expect(isFulfilled).toBe(false);
+
+    stream.next(1);
+    await sleep(100);
+    expect(isFulfilled).toBe(true);
+  });
+});

package/src/rx.ts

@@ -0,0 +1,124 @@
+import {
+  concatMap,
+  delay,
+  filter,
+  first,
+  mergeMap,
+  Observable,
+  of,
+  OperatorFunction,
+  pipe,
+  ReplaySubject,
+  scan,
+  Timestamp,
+  timestamp,
+} from "rxjs";
+import { computed, IComputedValue, IObservableValue, observable, reaction, runInAction, toJS } from "mobx";
+import { deferred } from "./deferred";
+import { awaitValue } from "./mobx";
+
+export function filterNullish<T>(): OperatorFunction<T, NonNullable<T>> {
+  return pipe<Observable<T>, Observable<NonNullable<T>>>(
+    filter<T>((x: T) => x != null) as OperatorFunction<T, NonNullable<T>>
+  );
+}
+
+export function awaitPromise<T extends Promise<unknown>>(): OperatorFunction<T, Awaited<T>> {
+  return pipe(concatMap((x: T) => x)) as OperatorFunction<T, Awaited<T>>;
+}
+
+/**
+ * RxJS operator to stretch out an event stream by a given delay per event
+ * @param spacingDelayMs Delay between each event in ms
+ * @returns stream of events with at least spacingDelayMs spaceing between event
+ */
+export function stretch<T>(spacingDelayMs: number) {
+  return pipe(
+    timestamp<T>(),
+    scan((acc: (Timestamp<T> & { delay: number }) | null, curr: Timestamp<T>) => {
+      // calculate delay needed to offset next emission
+      let delay = 0;
+      if (acc !== null) {
+        const timeDelta = curr.timestamp - acc.timestamp;
+        delay = timeDelta > spacingDelayMs ? 0 : spacingDelayMs - timeDelta;
+      }
+
+      return {
+        timestamp: curr.timestamp,
+        delay: delay,
+        value: curr.value,
+      };
+    }, null),
+    filterNullish(),
+    mergeMap((i) => of(i.value).pipe(delay(i.delay)), 1)
+  );
+}
+
+export function observableToComputed<T>(obs: IObservableValue<T>): IComputedValue<T> {
+  return computed(() => obs.get());
+}
+
+export function computedToStream<T>(comp: IComputedValue<T> | IObservableValue<T>): Observable<T> {
+  const stream = new ReplaySubject<T>(1);
+  reaction(
+    () => comp.get(),
+    (value) => {
+      if (value != null) stream.next(value);
+    },
+    { fireImmediately: true }
+  );
+  return stream;
+}
+
+export function observableToStream<T>(obs: T): Observable<T> {
+  const stream = new ReplaySubject<T>(1);
+  reaction(
+    () => toJS(obs),
+    (value) => {
+      if (value != null) stream.next(value);
+    },
+    { fireImmediately: true }
+  );
+  return stream;
+}
+
+export function streamToComputed<T>(stream$: Observable<T>): IComputedValue<T | undefined> {
+  const value = observable.box<T | undefined>();
+  stream$.subscribe((val) => runInAction(() => value.set(val)));
+  return computed(() => value.get());
+}
+
+export async function streamToDefinedComputed<T>(stream$: Observable<T>): Promise<IComputedValue<T>> {
+  const value = observable.box<T>();
+  stream$.subscribe((val) => runInAction(() => value.set(val)));
+  const computedValue = computed(() => value.get());
+  await awaitValue(computedValue);
+  return computedValue as IComputedValue<T>;
+}
+
+/**
+ *
+ * @param stream$ RxJS observable to check for the given value
+ * @param predicate Predicate to check
+ * @returns A promise that resolves with the requested value once the predicate is true
+ */
+export async function awaitStreamValue<T>(
+  stream$: Observable<T>,
+  predicate: (value: T) => boolean = (value) => value != null
+): Promise<T> {
+  const [resolve, , promise] = deferred<T>();
+  stream$.pipe(first(predicate)).subscribe(resolve);
+  return promise;
+}
+
+/**
+ * Turns a stream into an updating object for easy access outside of rxjs
+ * @param stream$ Stream to turn into a wrapped value
+ * @returns Object with `current` key corresponding to last stream value
+ */
+export async function streamToWrappedValue<T>(stream$: Observable<T>): Promise<{ current: T }> {
+  const value: { current?: T } = {};
+  stream$.subscribe((v) => (value.current = v));
+  value.current = await awaitStreamValue(stream$);
+  return value as { current: T };
+}

package/src/sleep.ts

@@ -0,0 +1,3 @@
+export function sleep<T>(timeout: number, returns?: T): Promise<T> {
+  return new Promise<T>((resolve) => setTimeout(() => resolve(returns as T), timeout));
+}

package/src/types.ts

@@ -0,0 +1,48 @@
+import { enableLogger } from "./console";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export type Func<A extends any[], R> = (...args: A) => R;
+export type AsyncFunc<A extends any[], R> = R extends Promise<unknown> ? (...args: A) => R : (...args: A) => Promise<R>;
+
+export type CachedValue<V, Proxied extends boolean> = Proxied extends true
+  ? V extends Func<infer A, infer B>
+    ? AsyncFunc<A, B>
+    : V extends Record<string, any>
+    ? Cached<V> & { proxied: true }
+    : { proxied: true }
+  : V extends Func<infer A, infer B>
+  ? Func<A, B>
+  : V extends Record<string, any>
+  ? V
+  : V & { proxied: false };
+
+export type Cached<C> =
+  | ({ proxied: false } & { [key in keyof C]: CachedValue<C[key], false> })
+  | ({ proxied: true } & { [key in keyof C]: CachedValue<C[key], true> });
+
+/**
+ * @deprecated Use Awaited<T> instead
+ */
+export type PromiseValue<T> = Awaited<T>;
+
+export type ValueOf<T extends object> = T[keyof T];
+
+export type Area = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+
+export type Coord = {
+  x: number;
+  y: number;
+};
+
+export type VoxelCoord = {
+  x: number;
+  y: number;
+  z: number;
+};
+
+export type Logger = ReturnType<typeof enableLogger>;

package/src/uuid.ts

@@ -0,0 +1,70 @@
+/**
+ * UUID.core.js - UUID.js for Minimalists
+ *
+ * @file
+ * @author  LiosK
+ * @version v4.2.0
+ * @license Apache License 2.0: Copyright (c) 2010-2018 LiosK
+ * @url https://github.com/LiosK/UUID.js/blob/master/src/uuid.core.js
+ */
+
+/**
+ * @class
+ * @classdesc {@link UUID} object.
+ * @hideconstructor
+ */
+
+// Core Component {{{
+
+/**
+ * Generates a version 4 UUID as a hexadecimal string.
+ * @returns {string} Hexadecimal UUID string.
+ */
+export const uuid = function () {
+  const rand = _getRandomInt,
+    hex = _hexAligner;
+  return (
+    hex(rand(32), 8) + // time_low
+    "-" +
+    hex(rand(16), 4) + // time_mid
+    "-" +
+    hex(0x4000 | rand(12), 4) + // time_hi_and_version
+    "-" +
+    hex(0x8000 | rand(14), 4) + // clock_seq_hi_and_reserved clock_seq_low
+    "-" +
+    hex(rand(48), 12)
+  ); // node
+};
+
+/**
+ * Returns an unsigned x-bit random integer.
+ * @private
+ * @param {number} x Unsigned integer ranging from 0 to 53, inclusive.
+ * @returns {number} Unsigned x-bit random integer (0 <= f(x) < 2^x).
+ */
+const _getRandomInt = function (x: number) {
+  if (x < 0 || x > 53) {
+    return NaN;
+  }
+  const n = 0 | (Math.random() * 0x40000000); // 1 << 30
+  return x > 30 ? n + (0 | (Math.random() * (1 << (x - 30)))) * 0x40000000 : n >>> (30 - x);
+};
+
+/**
+ * Converts an integer to a zero-filled hexadecimal string.
+ * @private
+ * @param {number} num
+ * @param {number} length
+ * @returns {string}
+ */
+const _hexAligner = function (num: number, length: number) {
+  let str = num.toString(16),
+    i = length - str.length,
+    z = "0";
+  for (; i > 0; i >>>= 1, z += z) {
+    if (i & 1) {
+      str = z + str;
+    }
+  }
+  return str;
+};

package/src/worker.ts

@@ -0,0 +1,16 @@
+import { fromEvent, map, Observable } from "rxjs";
+
+export interface DoWork<I, O> {
+  work(input$: Observable<I>): Observable<O>;
+}
+
+export function fromWorker<I, O>(worker: Worker, input$: Observable<I>): Observable<O> {
+  input$.subscribe((event) => worker.postMessage(event));
+  return fromEvent<MessageEvent<O>>(worker, "message").pipe(map((e) => e.data));
+}
+
+export function runWorker<I, O>(worker: DoWork<I, O>) {
+  const input$ = fromEvent<MessageEvent<I>>(self, "message");
+  const output$ = worker.work(input$.pipe(map((event) => event.data)));
+  output$.subscribe((event) => self.postMessage(event));
+}

package/tsconfig.json

@@ -0,0 +1,102 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2019" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "esnext" /* Specify what module code is generated. */,
+    "rootDir": "./src" /* Specify the root folder within your source files. */,
+    "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files */
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true /* Only output d.ts files and not JavaScript files. */,
+    "sourceMap": true /* Create source map files for emitted JavaScript files. */,
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "dist" /* Specify an output folder for all emitted files. */,
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    "isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  },
+  "exclude": ["dist", "**/*.spec.ts"]
+}

package/typedoc.json

@@ -0,0 +1,9 @@
+{
+  "cleanOutputDir": true,
+  "hideGenerator": true,
+  "customCss": "../mud.dev/src/typedoc/typedoc.css",
+  "plugin": ["../mud.dev/src/typedoc/typedoc.js"],
+  "darkHighlightTheme": "nord",
+  "lightHighlightTheme": "nord",
+  "out": "docs"
+}