@remotion/noise 4.0.0-retry.9 → 4.1.0-alpha1

package/LICENSE.md

@@ -7,7 +7,7 @@ Depending on the type of your legal entity, you are granted permission to use Re
 
 ## Free license
 
-Copyright © 2022 [Remotion](https://www.remotion.dev/)
+Copyright © 2023 [Remotion](https://www.remotion.dev/)
 
 ### Eligibility
 

package/dist/{index.d.ts → cjs/index.d.ts}

@@ -1,6 +1,6 @@
 /**
  * @description Creates 2D noise.
- * @link https://remotion.dev/docs/noise/noise-2d
+ * @see [Documentation](https://www.remotion.dev/docs/noise/noise-2d)
  * @param {string | number} seed Seed value for deterministic results
  * @param {number} x First dimensional value
  * @param {number} y Second dimensional value
@@ -9,7 +9,7 @@
 export declare const noise2D: (seed: string | number, x: number, y: number) => number;
 /**
  * @description Creates 3D noise.
- * @link https://remotion.dev/docs/noise/noise-3d
+ * @see [Documentation](https://remotion.dev/docs/noise/noise-3d)
  * @param {string | number} seed Seed value for deterministic results
  * @param {number} x First dimensional value
  * @param {number} y Second dimensional value
@@ -19,7 +19,7 @@ export declare const noise2D: (seed: string | number, x: number, y: number) => n
 export declare const noise3D: (seed: string | number, x: number, y: number, z: number) => number;
 /**
  * @description Creates 4D noise.
- * @link https://remotion.dev/docs/noise/noise-4d
+ * @see [Documentation](https://remotion.dev/docs/noise/noise-4d)
  * @param {string | number} seed Seed value for deterministic results
  * @param {number} x First dimensional value
  * @param {number} y Second dimensional value

package/dist/{index.js → cjs/index.js}

@@ -47,7 +47,7 @@ const generate4DNoise = (seed) => {
 };
 /**
  * @description Creates 2D noise.
- * @link https://remotion.dev/docs/noise/noise-2d
+ * @see [Documentation](https://www.remotion.dev/docs/noise/noise-2d)
  * @param {string | number} seed Seed value for deterministic results
  * @param {number} x First dimensional value
  * @param {number} y Second dimensional value
@@ -59,7 +59,7 @@ const noise2D = (seed, x, y) => {
 exports.noise2D = noise2D;
 /**
  * @description Creates 3D noise.
- * @link https://remotion.dev/docs/noise/noise-3d
+ * @see [Documentation](https://remotion.dev/docs/noise/noise-3d)
  * @param {string | number} seed Seed value for deterministic results
  * @param {number} x First dimensional value
  * @param {number} y Second dimensional value
@@ -70,7 +70,7 @@ const noise3D = (seed, x, y, z) => generate3DNoise((0, remotion_1.random)(seed))
 exports.noise3D = noise3D;
 /**
  * @description Creates 4D noise.
- * @link https://remotion.dev/docs/noise/noise-4d
+ * @see [Documentation](https://remotion.dev/docs/noise/noise-4d)
  * @param {string | number} seed Seed value for deterministic results
  * @param {number} x First dimensional value
  * @param {number} y Second dimensional value

package/dist/cjs/test/noise-cache.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/test/noise-cache.test.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const index_1 = require("../index");
+// Make Node.JS 14 pass
+if (typeof performance === 'undefined') {
+    (0, vitest_1.test)('Pass', () => {
+        (0, vitest_1.expect)(1).toBe(1);
+    });
+}
+else {
+    (0, vitest_1.test)('Noise should be deterministic', () => {
+        const noise1 = (0, index_1.noise2D)(1, 0, 0);
+        const noise2 = (0, index_1.noise2D)(1, 0, 0);
+        (0, vitest_1.expect)(noise1).toBe(noise2);
+        (0, vitest_1.expect)(noise1).toBe(0);
+        (0, vitest_1.expect)((0, index_1.noise2D)('my-seed', 0.5, 0.5)).toBe(0.3071565136272162);
+        (0, vitest_1.expect)((0, index_1.noise3D)('my-seed', 0.7, 0.5, 0.5)).toBe(0.6402128434567901);
+        (0, vitest_1.expect)((0, index_1.noise4D)('my-seed', 0.7, 0.5, 0.5, 0.9)).toBe(0.2714290963058814);
+    }, { retry: 2 });
+    (0, vitest_1.test)('Noise should be cached', () => {
+        const start = performance.now();
+        (0, index_1.noise2D)('new-seed', 0.5, 0.5);
+        const end = performance.now();
+        const time = end - start;
+        const start2 = performance.now();
+        (0, index_1.noise2D)('new-seed', 0.5, 0.5);
+        const end2 = performance.now();
+        const time2 = end2 - start2;
+        (0, vitest_1.expect)(time2 * 10).toBeLessThan(time);
+    }, { retry: 2 });
+    (0, vitest_1.test)('Should only keep 10 cache entries', () => {
+        const start = performance.now();
+        (0, index_1.noise2D)('seed-1', 0.5, 0.5);
+        const end = performance.now();
+        const time = end - start;
+        (0, index_1.noise2D)('seed-2', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-3', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-4', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-5', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-6', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-7', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-8', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-9', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-10', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-11', 0.5, 0.5);
+        (0, index_1.noise2D)('seed-12', 0.5, 0.5);
+        const start2 = performance.now();
+        (0, index_1.noise2D)('seed-1', 0.5, 0.5);
+        const end2 = performance.now();
+        const time2 = end2 - start2;
+        (0, vitest_1.expect)(time2 * 4).toBeGreaterThan(time);
+    }, {
+        retry: 2,
+    });
+    (0, vitest_1.test)('Should only keep 10 cache entries (3D)', () => {
+        const start = performance.now();
+        (0, index_1.noise3D)('seed-1', 0.5, 0.5, 0.8);
+        const end = performance.now();
+        const time = end - start;
+        (0, index_1.noise3D)('seed-2', 0.5, 0.5, 0.8);
+        (0, index_1.noise3D)('seed-3', 0.5, 0.5, 0.8);
+        (0, index_1.noise3D)('seed-4', 0.5, 0.5, 0.8);
+        (0, index_1.noise3D)('seed-5', 0.5, 0.5, 0.8);
+        (0, index_1.noise3D)('seed-6', 0.5, 0.5, 0.8);
+        (0, index_1.noise3D)('seed-7', 0.5, 0.5, 0.8);
+        (0, index_1.noise3D)('seed-8', 0.5, 0.5, 0.8);
+        (0, index_1.noise3D)('seed-9', 0.5, 0.5, 0.8);
+        (0, index_1.noise3D)('seed-10', 0.5, 0, 0.85);
+        (0, index_1.noise3D)('seed-11', 0.5, 0, 0.85);
+        (0, index_1.noise3D)('seed-12', 0.5, 0, 0.85);
+        const start2 = performance.now();
+        (0, index_1.noise3D)('seed-1', 0.5, 0.5, 0.8);
+        const end2 = performance.now();
+        const time2 = end2 - start2;
+        (0, vitest_1.expect)(time2 * 4).toBeGreaterThan(time);
+    }, { retry: 2 });
+    (0, vitest_1.test)('Should only keep 10 cache entries (4D)', () => {
+        const start = performance.now();
+        (0, index_1.noise4D)('seed-1', 0.5, 0.5, 0.8, 9);
+        const end = performance.now();
+        const time = end - start;
+        (0, index_1.noise4D)('seed-2', 0.5, 0.5, 0.8, 9);
+        (0, index_1.noise4D)('seed-3', 0.5, 0.5, 0.8, 9);
+        (0, index_1.noise4D)('seed-4', 0.5, 0.5, 0.8, 9);
+        (0, index_1.noise4D)('seed-5', 0.5, 0.5, 0.8, 9);
+        (0, index_1.noise4D)('seed-6', 0.5, 0.5, 0.8, 9);
+        (0, index_1.noise4D)('seed-7', 0.5, 0.5, 0.8, 9);
+        (0, index_1.noise4D)('seed-8', 0.5, 0.5, 0.8, 9);
+        (0, index_1.noise4D)('seed-9', 0.5, 0.5, 0.8, 9);
+        (0, index_1.noise4D)('seed-10', 0.5, 0, 0.85, 9);
+        (0, index_1.noise4D)('seed-11', 0.5, 0, 0.85, 9);
+        (0, index_1.noise4D)('seed-12', 0.5, 0, 0.85, 9);
+        const start2 = performance.now();
+        (0, index_1.noise4D)('seed-1', 0.5, 0.5, 0.8, 9);
+        const end2 = performance.now();
+        const time2 = end2 - start2;
+        (0, vitest_1.expect)(time2 * 4).toBeGreaterThan(time);
+    }, {
+        retry: 2,
+    });
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @description Creates 2D noise.
+ * @see [Documentation](https://www.remotion.dev/docs/noise/noise-2d)
+ * @param {string | number} seed Seed value for deterministic results
+ * @param {number} x First dimensional value
+ * @param {number} y Second dimensional value
+ * @returns {number} Between -1 and 1
+ */
+export declare const noise2D: (seed: string | number, x: number, y: number) => number;
+/**
+ * @description Creates 3D noise.
+ * @see [Documentation](https://remotion.dev/docs/noise/noise-3d)
+ * @param {string | number} seed Seed value for deterministic results
+ * @param {number} x First dimensional value
+ * @param {number} y Second dimensional value
+ * @param {number} z Third dimensional value
+ * @returns {number} Between -1 and 1
+ */
+export declare const noise3D: (seed: string | number, x: number, y: number, z: number) => number;
+/**
+ * @description Creates 4D noise.
+ * @see [Documentation](https://remotion.dev/docs/noise/noise-4d)
+ * @param {string | number} seed Seed value for deterministic results
+ * @param {number} x First dimensional value
+ * @param {number} y Second dimensional value
+ * @param {number} z Third dimensional value
+ * @param {number} w Fourth dimensional value
+ * @returns {number} Between -1 and 1
+ */
+export declare const noise4D: (seed: string | number, x: number, y: number, z: number, w: number) => number;

package/dist/esm/index.mjs

@@ -0,0 +1,81 @@
+import { random } from 'remotion';
+import { createNoise2D, createNoise3D, createNoise4D } from 'simplex-noise';
+
+const seedCache2d = new Map();
+const seedCache3d = new Map();
+const seedCache4d = new Map();
+const generate2DNoise = (seed) => {
+    const cached = seedCache2d.get(seed);
+    if (cached) {
+        return cached;
+    }
+    // If the cache is getting to big, remove entries based on FIFO principle
+    if (seedCache2d.size > 10) {
+        seedCache2d.delete(seedCache2d.keys().next().value);
+    }
+    const noise = createNoise2D(() => random(seed));
+    seedCache2d.set(seed, noise);
+    return noise;
+};
+const generate3DNoise = (seed) => {
+    const cached = seedCache3d.get(seed);
+    if (cached) {
+        return cached;
+    }
+    // If the cache is getting to big, remove entries based on FIFO principle
+    if (seedCache3d.size > 10) {
+        seedCache3d.delete(seedCache3d.keys().next().value);
+    }
+    const noise = createNoise3D(() => random(seed));
+    seedCache3d.set(seed, noise);
+    return noise;
+};
+const generate4DNoise = (seed) => {
+    const cached = seedCache4d.get(seed);
+    if (cached) {
+        return cached;
+    }
+    // If the cache is getting to big, remove entries based on FIFO principle
+    if (seedCache4d.size > 10) {
+        seedCache4d.delete(seedCache4d.keys().next().value);
+    }
+    const noise = createNoise4D(() => random(seed));
+    seedCache4d.set(seed, noise);
+    return noise;
+};
+/**
+ * @description Creates 2D noise.
+ * @see [Documentation](https://www.remotion.dev/docs/noise/noise-2d)
+ * @param {string | number} seed Seed value for deterministic results
+ * @param {number} x First dimensional value
+ * @param {number} y Second dimensional value
+ * @returns {number} Between -1 and 1
+ */
+const noise2D = (seed, x, y) => {
+    return generate2DNoise(seed)(x, y);
+};
+/**
+ * @description Creates 3D noise.
+ * @see [Documentation](https://remotion.dev/docs/noise/noise-3d)
+ * @param {string | number} seed Seed value for deterministic results
+ * @param {number} x First dimensional value
+ * @param {number} y Second dimensional value
+ * @param {number} z Third dimensional value
+ * @returns {number} Between -1 and 1
+ */
+const noise3D = (seed, x, y, z) => generate3DNoise(random(seed))(x, y, z);
+/**
+ * @description Creates 4D noise.
+ * @see [Documentation](https://remotion.dev/docs/noise/noise-4d)
+ * @param {string | number} seed Seed value for deterministic results
+ * @param {number} x First dimensional value
+ * @param {number} y Second dimensional value
+ * @param {number} z Third dimensional value
+ * @param {number} w Fourth dimensional value
+ * @returns {number} Between -1 and 1
+ */
+const noise4D = (seed, x, y, z, w
+// eslint-disable-next-line max-params
+) => generate4DNoise(random(seed))(x, y, z, w);
+
+export { noise2D, noise3D, noise4D };

package/dist/esm/test/noise-cache.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,48 +1,60 @@
 {
-	"name": "@remotion/noise",
-	"version": "4.0.0-retry.9+5c2247718",
-	"description": "Noise effect for Remotion",
-	"main": "dist/index.js",
-	"types": "dist/index.d.ts",
-	"sideEffects": false,
-	"scripts": {
-		"lint": "eslint src --ext ts,tsx",
-		"watch": "tsc -w",
-		"build": "tsc -d",
-		"test": "vitest --run"
-	},
-	"author": "Yehor Misiats (https://github.com/satelllte)",
-	"maintainers": [
-		"Jonny Burger <jonny@remotion.dev>",
-		"Yehor Misiats (https://github.com/satelllte)"
-	],
-	"contributors": [],
-	"license": "MIT",
-	"repository": {
-		"url": "https://github.com/remotion-dev/remotion"
-	},
-	"bugs": {
-		"url": "https://github.com/remotion-dev/remotion/issues"
-	},
-	"dependencies": {
-		"remotion": "4.0.0-retry.9+5c2247718",
-		"simplex-noise": "4.0.1"
-	},
-	"devDependencies": {
-		"@jonny/eslint-config": "^3.0.266",
-		"@types/node": "^16.7.5",
-		"eslint": "8.25.0",
-		"prettier": "^2.7.1",
-		"prettier-plugin-organize-imports": "^2.3.4",
-		"typescript": "^4.7.0",
-		"vitest": "0.24.3"
-	},
-	"keywords": [
-		"remotion",
-		"noise"
-	],
-	"publishConfig": {
-		"access": "public"
-	},
-	"gitHead": "5c22477180ffb35d5e437524df156da722cda837"
-}
+  "name": "@remotion/noise",
+  "version": "4.1.0-alpha1",
+  "description": "Noise effect for Remotion",
+  "main": "dist/cjs/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "module": "dist/esm/index.mjs",
+  "sideEffects": false,
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/cjs/index.d.ts",
+      "module": "./dist/esm/index.mjs",
+      "import": "./dist/esm/index.mjs",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "author": "Yehor Misiats (https://github.com/satelllte)",
+  "maintainers": [
+    "Jonny Burger <jonny@remotion.dev>",
+    "Yehor Misiats (https://github.com/satelllte)"
+  ],
+  "contributors": [],
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/remotion-dev/remotion"
+  },
+  "bugs": {
+    "url": "https://github.com/remotion-dev/remotion/issues"
+  },
+  "dependencies": {
+    "simplex-noise": "4.0.1",
+    "remotion": "4.1.0-alpha1"
+  },
+  "devDependencies": {
+    "@jonny/eslint-config": "^3.0.266",
+    "@rollup/plugin-typescript": "^8.2.0",
+    "@types/node": "18.14.6",
+    "eslint": "8.42.0",
+    "prettier": "^2.7.1",
+    "prettier-plugin-organize-imports": "^2.3.4",
+    "rollup": "^2.70.1",
+    "typescript": "4.9.5",
+    "vitest": "0.31.1"
+  },
+  "keywords": [
+    "remotion",
+    "noise"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "formatting": "prettier src --check",
+    "lint": "eslint src --ext ts,tsx",
+    "watch": "tsc -w",
+    "build": "rollup --config rollup.config.js && tsc -d",
+    "test": "vitest --run"
+  }
+}

package/.prettierrc.js

@@ -1,14 +0,0 @@
-module.exports = {
-	singleQuote: true,
-	bracketSpacing: false,
-	useTabs: true,
-	overrides: [
-		{
-			files: ['*.yml'],
-			options: {
-				singleQuote: false,
-			},
-		},
-	],
-	plugins: [require.resolve('prettier-plugin-organize-imports')],
-};

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-	"extends": "../tsconfig.settings.json",
-	"compilerOptions": {
-		"composite": true,
-		"rootDir": "src",
-		"outDir": "dist",
-		"skipLibCheck": true
-	},
-	"include": ["src"],
-	"references": [
-		{
-			"path": "../core"
-		}
-	]
-}