@latticexyz/utils 0.9.0

package/CHANGELOG.md

@@ -0,0 +1,187 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [0.9.0](https://github.com/latticexyz/mud/compare/v0.8.1...v0.9.0) (2022-09-13)
+
+### Bug Fixes
+
+- **network:** align hex entity id formatting ([#140](https://github.com/latticexyz/mud/issues/140)) ([93b1bd6](https://github.com/latticexyz/mud/commit/93b1bd6688780dc185a1c7e353954e2c5c85f648))
+
+## [0.8.1](https://github.com/latticexyz/mud/compare/v0.8.0...v0.8.1) (2022-08-22)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+# [0.8.0](https://github.com/latticexyz/mud/compare/v0.7.0...v0.8.0) (2022-08-22)
+
+### Features
+
+- add mud.dev ([#133](https://github.com/latticexyz/mud/issues/133)) ([302588c](https://github.com/latticexyz/mud/commit/302588cbbab2803396b894bc006d13e6ac943da9))
+
+# [0.7.0](https://github.com/latticexyz/mud/compare/v0.6.0...v0.7.0) (2022-08-19)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+# [0.6.0](https://github.com/latticexyz/mud/compare/v0.5.1...v0.6.0) (2022-08-15)
+
+### Code Refactoring
+
+- sync worker (+ integrated snapshot service) ([#125](https://github.com/latticexyz/mud/issues/125)) ([6173b59](https://github.com/latticexyz/mud/commit/6173b596713b0dad73d14288ece3ac66ca3972d3))
+
+### BREAKING CHANGES
+
+- sync worker update stream returns component id instead of component key
+
+- test(network): add tests for sync utils and SyncWorker logic
+
+- chore: remove logs and improve comments
+
+- chore: add logs
+
+Co-authored-by: andrii dobroshynski <24281657+andriidski@users.noreply.github.com>
+
+## [0.5.1](https://github.com/latticexyz/mud/compare/v0.5.0...v0.5.1) (2022-08-05)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+# [0.5.0](https://github.com/latticexyz/mud/compare/v0.4.3...v0.5.0) (2022-08-05)
+
+### Bug Fixes
+
+- optimism, cancel action if gas check fails, add noise utils, fix ecs-browser entry point ([#119](https://github.com/latticexyz/mud/issues/119)) ([f35d3c3](https://github.com/latticexyz/mud/commit/f35d3c3cc7fc9385a215dfda6762a2a825c9fd6d))
+
+### Features
+
+- logging library with support for topics/filters ([#123](https://github.com/latticexyz/mud/issues/123)) ([4eac3c6](https://github.com/latticexyz/mud/commit/4eac3c6f45cf300c683397d68e405001d31d8dda))
+
+## [0.4.3](https://github.com/latticexyz/mud/compare/v0.4.2...v0.4.3) (2022-07-30)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.4.2](https://github.com/latticexyz/mud/compare/v0.4.1...v0.4.2) (2022-07-29)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.4.1](https://github.com/latticexyz/mud/compare/v0.4.0...v0.4.1) (2022-07-29)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+# [0.4.0](https://github.com/latticexyz/mud/compare/v0.3.2...v0.4.0) (2022-07-29)
+
+### Bug Fixes
+
+- **cli:** extract encoded arguments from signature ([#116](https://github.com/latticexyz/mud/issues/116)) ([f630319](https://github.com/latticexyz/mud/commit/f6303194c5d7147a64542e43669fddebf3abad1a))
+
+### Features
+
+- add 3d components ([d230339](https://github.com/latticexyz/mud/commit/d230339bdf3fbfaf4596de759a25fb616a7ab572))
+
+## [0.3.2](https://github.com/latticexyz/mud/compare/v0.3.1...v0.3.2) (2022-07-26)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.3.1](https://github.com/latticexyz/mud/compare/v0.3.0...v0.3.1) (2022-07-26)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+# [0.3.0](https://github.com/latticexyz/mud/compare/v0.2.0...v0.3.0) (2022-07-26)
+
+### Features
+
+- mudwar prototype (nyc sprint 2) ([#59](https://github.com/latticexyz/mud/issues/59)) ([a3db20e](https://github.com/latticexyz/mud/commit/a3db20e14c641b8b456775ee191eca6f016d47f5)), closes [#58](https://github.com/latticexyz/mud/issues/58) [#61](https://github.com/latticexyz/mud/issues/61) [#64](https://github.com/latticexyz/mud/issues/64) [#62](https://github.com/latticexyz/mud/issues/62) [#66](https://github.com/latticexyz/mud/issues/66) [#69](https://github.com/latticexyz/mud/issues/69) [#72](https://github.com/latticexyz/mud/issues/72) [#73](https://github.com/latticexyz/mud/issues/73) [#74](https://github.com/latticexyz/mud/issues/74) [#76](https://github.com/latticexyz/mud/issues/76) [#75](https://github.com/latticexyz/mud/issues/75) [#77](https://github.com/latticexyz/mud/issues/77) [#78](https://github.com/latticexyz/mud/issues/78) [#79](https://github.com/latticexyz/mud/issues/79) [#80](https://github.com/latticexyz/mud/issues/80) [#82](https://github.com/latticexyz/mud/issues/82) [#86](https://github.com/latticexyz/mud/issues/86) [#83](https://github.com/latticexyz/mud/issues/83) [#81](https://github.com/latticexyz/mud/issues/81) [#85](https://github.com/latticexyz/mud/issues/85) [#84](https://github.com/latticexyz/mud/issues/84) [#87](https://github.com/latticexyz/mud/issues/87) [#91](https://github.com/latticexyz/mud/issues/91) [#88](https://github.com/latticexyz/mud/issues/88) [#90](https://github.com/latticexyz/mud/issues/90) [#92](https://github.com/latticexyz/mud/issues/92) [#93](https://github.com/latticexyz/mud/issues/93) [#89](https://github.com/latticexyz/mud/issues/89) [#94](https://github.com/latticexyz/mud/issues/94) [#95](https://github.com/latticexyz/mud/issues/95) [#98](https://github.com/latticexyz/mud/issues/98) [#100](https://github.com/latticexyz/mud/issues/100) [#97](https://github.com/latticexyz/mud/issues/97) [#101](https://github.com/latticexyz/mud/issues/101) [#105](https://github.com/latticexyz/mud/issues/105) [#106](https://github.com/latticexyz/mud/issues/106)
+
+# [0.2.0](https://github.com/latticexyz/mud/compare/v0.1.8...v0.2.0) (2022-07-05)
+
+### Features
+
+- add webworker architecture for contract/client sync, add cache webworker ([#10](https://github.com/latticexyz/mud/issues/10)) ([4ef9f90](https://github.com/latticexyz/mud/commit/4ef9f909d1d3c10f6bea888b2c32b1d1df04185a)), closes [#14](https://github.com/latticexyz/mud/issues/14)
+- on-chain maps (nyc sprint 1) ([#38](https://github.com/latticexyz/mud/issues/38)) ([089c46d](https://github.com/latticexyz/mud/commit/089c46d7c0e112d1670e3bcd01a35f08ee21d593)), closes [#17](https://github.com/latticexyz/mud/issues/17) [#20](https://github.com/latticexyz/mud/issues/20) [#18](https://github.com/latticexyz/mud/issues/18) [#25](https://github.com/latticexyz/mud/issues/25) [#26](https://github.com/latticexyz/mud/issues/26) [#27](https://github.com/latticexyz/mud/issues/27) [#28](https://github.com/latticexyz/mud/issues/28) [#29](https://github.com/latticexyz/mud/issues/29) [#30](https://github.com/latticexyz/mud/issues/30) [#31](https://github.com/latticexyz/mud/issues/31) [#33](https://github.com/latticexyz/mud/issues/33) [#32](https://github.com/latticexyz/mud/issues/32) [#34](https://github.com/latticexyz/mud/issues/34) [#35](https://github.com/latticexyz/mud/issues/35) [#36](https://github.com/latticexyz/mud/issues/36) [#37](https://github.com/latticexyz/mud/issues/37) [#39](https://github.com/latticexyz/mud/issues/39) [#40](https://github.com/latticexyz/mud/issues/40) [#41](https://github.com/latticexyz/mud/issues/41) [#42](https://github.com/latticexyz/mud/issues/42) [#43](https://github.com/latticexyz/mud/issues/43) [#44](https://github.com/latticexyz/mud/issues/44) [#45](https://github.com/latticexyz/mud/issues/45) [#46](https://github.com/latticexyz/mud/issues/46) [#48](https://github.com/latticexyz/mud/issues/48) [#49](https://github.com/latticexyz/mud/issues/49) [#50](https://github.com/latticexyz/mud/issues/50)
+
+### BREAKING CHANGES
+
+- Components have to implement a getSchema() function
+
+- feat(network): make Sync worker return a stream of ECS events (prev contract events)
+
+- feat(ri-contracts): integrate solecs change (add getSchema to components)
+
+- feat(ri-client): integrate network package changes
+
+- feat(network): store ECS state in cache
+
+- feat(network): load state from cache
+
+- feat(utils): add more utils for iterables
+
+- refactor(network): clean up
+
+- feat(network): generalize component value decoder function, add tests
+
+- fix(network): make it possible to subscribe to ecsStream from sync worker multiple times
+
+- fix(network): start sync from provided initial block number
+
+- feat(network): move storing ecs to indexDB to its own Cache worker
+
+- feat(network): create separate cache for every World contract address
+
+- fix(network): fix issues discovered during live review
+
+- chore: remove unused import
+
+- Update packages/network/src/createBlockNumberStream.ts
+
+Co-authored-by: ludens <ludens@lattice.xyz>
+
+- feat(network): add clock syncInterval as config parameter
+
+- feat(utils): emit values through componentToStream and observableToStream only if non-null
+
+- feat(network): add chain id to cache id, disable loading from cache on hardhat
+
+- fix(contracts): change Position and EntityType schema to int32/uint32 to fit in js number
+
+- docs(client): fix typos in comments
+
+- fix(network): fix tests
+
+- fix(scripting): integrate new network package into ri scripting
+
+- fix(network): fix sending multiple requests for component schema if many events get reduced
+
+## [0.1.8](https://github.com/latticexyz/mud/compare/v0.1.7...v0.1.8) (2022-05-25)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.1.7](https://github.com/latticexyz/mud/compare/v0.1.6...v0.1.7) (2022-05-25)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.1.6](https://github.com/latticexyz/mud/compare/v0.1.5...v0.1.6) (2022-05-25)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.1.4](https://github.com/latticexyz/mud/compare/v0.1.3...v0.1.4) (2022-05-24)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.1.3](https://github.com/latticexyz/mud/compare/v0.1.2...v0.1.3) (2022-05-23)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.1.2](https://github.com/latticexyz/mud/compare/v0.1.1...v0.1.2) (2022-05-23)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+## [0.1.1](https://github.com/latticexyz/mud/compare/v0.1.0...v0.1.1) (2022-05-23)
+
+**Note:** Version bump only for package @latticexyz/utils
+
+# 0.1.0 (2022-05-23)
+
+### Features
+
+- **@mud/utils:** add @mud/utils package ([fc721cc](https://github.com/latticexyz/mud/commit/fc721cc564b20150c3b13883cb3edb773f48e312))
+- **@mud/utils:** add keccak256 hash function that accepts string inputs ([ca1a4e0](https://github.com/latticexyz/mud/commit/ca1a4e0cc7452724e703a6530c2e56112c307b66))
+- **@mud/utils:** add stretch rxjs operator to add a minimum delay between events in a rxjs stream ([3a1673f](https://github.com/latticexyz/mud/commit/3a1673f5fba548f94afd5580a7e32007a6edd57f))

package/README.md

@@ -0,0 +1,3 @@
+# @latticexyz/utils
+
+Useful utilities for everyday use

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+export default  {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@latticexyz/utils",
+  "license": "MIT",
+  "version": "0.9.0",
+  "type": "module",
+  "main": "src/index.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/latticexyz/mud.git",
+    "directory": "packages/utils"
+  },
+  "scripts": {
+    "lint": "eslint . --ext .ts",
+    "test": "jest",
+    "build": "rimraf dist && rollup -c rollup.config.js",
+    "link": "yarn link",
+    "docs": "typedoc src"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-typescript": "^8.3.1",
+    "@types/jest": "^27.4.1",
+    "ethers": "^5.6.6",
+    "jest": "^27.5.1",
+    "mobx": "^6.5.0",
+    "proxy-deep": "^3.1.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.69.0",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rxjs": "^7.5.5",
+    "ts-jest": "^27.1.3",
+    "tslib": "^2.3.1",
+    "typedoc": "^0.23.10",
+    "typescript": "^4.5.5"
+  },
+  "peerDependencies": {
+    "ethers": "^5.6.6",
+    "mobx": "^6.5.0",
+    "proxy-deep": "^3.1.1",
+    "rxjs": "^7.5.5"
+  },
+  "gitHead": "40718ea9955e61196942d040189adec464500446"
+}

package/rollup.config.js

@@ -0,0 +1,16 @@
+import typescript from "@rollup/plugin-typescript";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+import commonjs from "rollup-plugin-commonjs";
+import peerDepsExternal from "rollup-plugin-peer-deps-external";
+
+import { defineConfig } from "rollup";
+
+export default defineConfig({
+  input: "./src/index.ts",
+  treeshake: true,
+  output: {
+    dir: "dist",
+    sourcemap: true,
+  },
+  plugins: [nodeResolve(), typescript(), commonjs(), peerDepsExternal()],
+});

package/src/CoordMap.spec.ts

@@ -0,0 +1,57 @@
+import { coordToKey, keyToCoord } from "./CoordMap";
+
+describe("CoordMap", () => {
+  describe("coordToKey", () => {
+    it("should be the inverse of keyToCoord", () => {
+      const MAX = 2 ** 15 - 1;
+      const coords = [
+        { x: 1, y: 2 },
+        { x: -1, y: 2 },
+        { x: 1, y: -2 },
+        { x: 0, y: 0 },
+        { x: -1, y: -2 },
+        { x: MAX, y: MAX },
+        { x: -1 * MAX, y: MAX },
+        { x: MAX, y: -1 * MAX },
+        { x: -1 * MAX, y: -1 * MAX },
+      ];
+
+      for (const coord of coords) {
+        const key = coordToKey(coord);
+        expect(keyToCoord(key)).toEqual(coord);
+      }
+    });
+  });
+
+  describe("keyToCoord", () => {
+    it("should be the inverse of coordToKey", () => {
+      const keys = [
+        "11111111111111110000000000000000",
+        "11011101110111011000101001001000",
+        "01101101101110110001010101111001",
+        "11010101111011010010010010001001",
+        "00111111111111110111000001001100",
+        "01101110001111010110010010001001",
+        "10101110011011010010010001010101",
+        "01011011101011010101100100101000",
+        "11011110111101111000010000100011",
+        "10110111011011010101101010001001",
+        "00110111011101110001000100010000",
+        "10110101101101010001001010001001",
+        "01100011010101111010010100110010",
+        "11111111111111111111111111111111",
+        "00000000000000000000000000000000",
+      ];
+
+      for (const key of keys) {
+        const numKey = parseInt(key, 2) >> 0;
+        const coord = keyToCoord(numKey);
+        expect(coordToKey(coord)).toEqual(numKey);
+      }
+    });
+
+    it("should work with {x: 0, y: 0}", () => {
+      expect(keyToCoord(0)).toEqual({ x: 0, y: 0 });
+    });
+  });
+});

package/src/CoordMap.ts

@@ -0,0 +1,106 @@
+import { Coord } from "./types";
+import { transformIterator } from "./iterable";
+
+const LOWER_HALF_MASK = 2 ** 16 - 1;
+const MAX_SUPPORTED = 2 ** 15 - 1;
+
+export function subtract(from: CoordMap<boolean>, subtract: CoordMap<boolean>): CoordMap<boolean> {
+  const result = new CoordMap<boolean>();
+
+  for (const coord of from.coords()) {
+    if (subtract.get(coord)) continue;
+    result.set(coord, true);
+  }
+
+  return result;
+}
+
+export function coordToKey(coord: Coord) {
+  const key = (coord.x << 16) | (coord.y & LOWER_HALF_MASK);
+  return key;
+
+  // Old version using strings:
+  // return `${coord.x}/${coord.y}`;
+}
+
+export function keyToCoord(key: number): Coord {
+  const x = key >> 16;
+  const y = (key << 16) >> 16;
+  return { x, y };
+
+  // Old version using strings:
+  // const fragments = key.split("/");
+  // return { x: Number(fragments[0]), y: Number(fragments[1]) };
+}
+
+export class CoordMap<T> {
+  map: Map<number, T>;
+  defaultValue?: T;
+
+  constructor(props?: { defaultValue?: T }) {
+    this.map = new Map<number, T>();
+    this.defaultValue = props?.defaultValue;
+  }
+
+  static from<T>(coordMapLike: { map: Map<number, T>; defaultValue?: T }): CoordMap<T> {
+    const coordMap = new CoordMap<T>();
+    coordMap.map = coordMapLike.map;
+    coordMap.defaultValue = coordMapLike.defaultValue;
+    return coordMap;
+  }
+
+  set(coord: Coord, value: T) {
+    if (
+      coord.x > MAX_SUPPORTED ||
+      coord.x < -1 * MAX_SUPPORTED ||
+      coord.y > MAX_SUPPORTED ||
+      coord.y < -1 * MAX_SUPPORTED
+    ) {
+      throw new Error(`CoordMap only supports coords up to ${MAX_SUPPORTED}`);
+    }
+    return this.map.set(coordToKey(coord), value);
+  }
+
+  get(coord: Coord) {
+    return this.map.get(coordToKey(coord)) ?? this.defaultValue;
+  }
+
+  keys() {
+    return this.map.keys();
+  }
+
+  coords(): IterableIterator<Coord> {
+    return transformIterator(this.map.keys(), (key) => keyToCoord(key));
+  }
+
+  entries() {
+    return this.map.entries();
+  }
+
+  toArray(): [Coord, T][] {
+    const entries = Array.from(this.map.entries());
+    return entries.map(([key, value]) => [keyToCoord(key), value]);
+  }
+
+  values() {
+    return this.map.values();
+  }
+
+  delete(coord: Coord) {
+    return this.map.delete(coordToKey(coord));
+  }
+
+  has(coord: Coord): boolean {
+    return this.map.has(coordToKey(coord));
+  }
+
+  clear() {
+    for (const key of this.map.keys()) {
+      this.map.delete(key);
+    }
+  }
+
+  get size(): number {
+    return this.map.size;
+  }
+}

package/src/area.ts

@@ -0,0 +1,15 @@
+import { Area, Coord } from "./types";
+
+export function areaContains(area: Area, coord: Coord) {
+  return coord.x >= area.x && coord.y >= area.y && coord.x < area.x + area.width && coord.y < area.y + area.height;
+}
+
+export function coordsOf(area: Area) {
+  const coords: Coord[] = [];
+  for (let dx = 0; dx < area.width; dx++) {
+    for (let dy = 0; dy < area.height; dy++) {
+      coords.push({ x: area.x + dx, y: area.y + dy });
+    }
+  }
+  return coords;
+}

package/src/arrays.ts

@@ -0,0 +1,19 @@
+/**
+ * TypeScript type guard to assert the type of a non-empty array
+ * @param array Any array to check for non-emptiness
+ * @returns True if the empty is non-empty, else false. TypeScript accepts the array as non-empty after the assertion.
+ */
+export function isNotEmpty<T>(array: T[]): array is [T, ...T[]] {
+  if (array.length === 0) return false;
+  return true;
+}
+
+/**
+ * Filters undefined values from an array and lets TypeScript know the resulting array
+ * does not have undefined values
+ * @param array Array potentially including undefined values
+ * @returns Array without undefined values
+ */
+export function filterNullishValues<T>(array: (T | undefined)[]): T[] {
+  return array.filter((value) => value != null) as T[];
+}

package/src/console.ts

@@ -0,0 +1,62 @@
+const TOPICS_KEY = "mud-logger-topics";
+
+export function enableLogger() {
+  const windowConsole = window.console;
+  let filtersActive = Boolean(localStorage.getItem(TOPICS_KEY));
+
+  const topicsString = localStorage.getItem(TOPICS_KEY);
+  let topics: string[] = topicsString ? JSON.parse(topicsString) : [];
+
+  function log(...logs: string[]) {
+    if (filtersActive) return;
+    windowConsole.log(...logs);
+  }
+
+  function logWithTopic(topic: string, ...logs: string[]) {
+    if (!filtersActive || topics.includes(topic)) {
+      windowConsole.log(`--- BETTER CONSOLE / TOPIC ${topic} ---`);
+      windowConsole.log(...logs);
+    }
+  }
+
+  function enableFilters() {
+    localStorage.setItem(TOPICS_KEY, JSON.stringify([]));
+    filtersActive = true;
+  }
+
+  function disableFilters() {
+    localStorage.removeItem(TOPICS_KEY);
+    filtersActive = false;
+  }
+
+  function addTopic(topic: string) {
+    topics.push(topic);
+    localStorage.setItem(TOPICS_KEY, JSON.stringify(topics));
+  }
+
+  function removeTopic(topic: string) {
+    topics = topics.filter((t) => t !== topic);
+    localStorage.setItem(TOPICS_KEY, JSON.stringify(topics));
+  }
+
+  function resetTopics() {
+    topics = [];
+    localStorage.setItem(TOPICS_KEY, JSON.stringify(topics));
+  }
+
+  const logger = {
+    ...windowConsole,
+    log,
+    logWithTopic,
+    enableFilters,
+    disableFilters,
+    addTopic,
+    removeTopic,
+    resetTopics,
+  };
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  (window as any).logger = logger;
+  window.console = logger;
+  return logger;
+}

package/src/cubic.spec.ts

@@ -0,0 +1,14 @@
+import { cubicNoiseSample2, cubicNoiseConfig } from "./cubic";
+
+describe("Cubic", () => {
+  it("computes noise", () => {
+    const coords: [number, number][] = [];
+    for (let i = 0; i < 100; i++) {
+      coords.push([Math.floor((Math.random() - 0.5) * 1000), Math.floor((Math.random() - 0.5) * 1000)]);
+    }
+
+    const noises = coords.map((c) => cubicNoiseSample2(cubicNoiseConfig(1000, 64, 16, 256, 256), c[0], c[1]));
+    console.log("coords", JSON.stringify(coords));
+    console.log("noises", JSON.stringify(noises));
+  });
+});

package/src/cubic.ts

@@ -0,0 +1,109 @@
+const RND_A = 134775813;
+const RND_B = 1103515245;
+const ACCURACY = 1000;
+
+export function randomize(seed: number, x: number, y: number) {
+  return (((((x ^ y) * RND_A) ^ (seed + x)) * (((RND_B * x) << 16) ^ (RND_B * y - RND_A))) >>> 0) / 4294967295;
+}
+
+export function tile(coordinate: number, period: number) {
+  if (coordinate < 0) while (coordinate < 0) coordinate += period;
+  return coordinate % period;
+}
+
+export function interpolate(a: number, b: number, c: number, d: number, x: number, s: number, scale: number) {
+  const p = d - c - (a - b);
+  return (b * Math.pow(s, 3) + x * (c * Math.pow(s, 2) + a * s * (-s + x) + x * (-(b + p) * s + p * x))) * scale;
+
+  // return (x) * ((x ) * ((x ) * p + (a - b - p)) + (c - a)) + b;
+}
+
+/**
+ * Config a cubic noise.
+ * @param {Number} seed A seed in the range [0, 1].
+ * @param {Number} [periodX] The number of units after which the x coordinate repeats.
+ * @param {Number} [periodY] The number of units after which the y coordinate repeats.
+ * @returns {Object} A configuration object used by noise functions.
+ */
+export function cubicNoiseConfig(
+  seed: number,
+  octave: number,
+  scale: number,
+  periodX = Number.MAX_SAFE_INTEGER,
+  periodY = Number.MAX_SAFE_INTEGER
+) {
+  return {
+    seed: Math.floor(seed * Number.MAX_SAFE_INTEGER),
+    periodX: periodX,
+    periodY: periodY,
+    octave,
+    scale,
+  };
+}
+
+/**
+ * Sample 1D cubic noise.
+ * @param {Object} config A valid noise configuration.
+ * @param {Number} x The X position to sample at.
+ * @returns {Number} A noise value in the range [0, 1].
+ */
+export function cubicNoiseSample1(config: ReturnType<typeof cubicNoiseConfig>, x: number) {
+  const xi = Math.floor(x);
+  const lerp = x - xi;
+
+  return (
+    interpolate(
+      randomize(config.seed, tile(xi - 1, config.periodX), 0),
+      randomize(config.seed, tile(xi, config.periodX), 0),
+      randomize(config.seed, tile(xi + 1, config.periodX), 0),
+      randomize(config.seed, tile(xi + 2, config.periodX), 0),
+      lerp,
+      1,
+      1
+    ) *
+      0.666666 +
+    0.166666
+  );
+}
+
+/**
+ * Sample 2D cubic noise.
+ * @param {Object} config A valid noise configuration.
+ * @param {Number} x The X position to sample at.
+ * @param {Number} y The Y position to sample at.
+ * @returns {Number} A noise value in the range [0, 1].
+ */
+export function cubicNoiseSample2(
+  { octave, periodX, periodY, seed, scale }: ReturnType<typeof cubicNoiseConfig>,
+  x: number,
+  y: number
+) {
+  const xi = Math.floor(x / octave);
+  const lerpX = Math.floor((x * ACCURACY) / octave) - xi * ACCURACY;
+  const yi = Math.floor(y / octave);
+  const lerpY = Math.floor((y * ACCURACY) / octave) - yi * ACCURACY;
+  const x0 = tile(xi - 1, periodX);
+  const x1 = tile(xi, periodX);
+  const x2 = tile(xi + 1, periodX);
+  const x3 = tile(xi + 2, periodX);
+
+  const xSamples = new Array(4);
+
+  for (let i = 0; i < 4; ++i) {
+    const y = tile(yi - 1 + i, periodY);
+
+    xSamples[i] = interpolate(
+      randomize(seed, x0, y),
+      randomize(seed, x1, y),
+      randomize(seed, x2, y),
+      randomize(seed, x3, y),
+      lerpX,
+      ACCURACY,
+      1
+    );
+  }
+
+  return Math.floor(
+    interpolate(xSamples[0], xSamples[1], xSamples[2], xSamples[3], lerpY, ACCURACY, scale) / Math.pow(ACCURACY, 6)
+  );
+}

package/src/deferred.ts

@@ -0,0 +1,14 @@
+/**
+ * A convenient way to create a promise with resolve and reject functions.
+ * @returns Tuple with resolve function, reject function and promise.
+ */
+export function deferred<T>(): [(t: T) => void, (t: Error) => void, Promise<T>] {
+  let resolve: ((t: T) => void) | null = null;
+  let reject: ((t: Error) => void) | null = null;
+  const promise = new Promise<T>((r, rj) => {
+    resolve = (t: T) => r(t);
+    reject = (e: Error) => rj(e);
+  });
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  return [resolve as any, reject as any, promise];
+}