@remotion/preload 4.0.0-webhook.27 → 4.1.0-alpha1

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2022 JonnyBurger
+Copyright (c) 2023 JonnyBurger
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/dist/index.d.ts

@@ -1,3 +1,5 @@
 export { preloadAudio } from './preload-audio';
+export { preloadFont } from './preload-font';
+export { preloadImage } from './preload-image';
 export { preloadVideo } from './preload-video';
 export { resolveRedirect } from './resolve-redirect';

package/dist/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveRedirect = exports.preloadVideo = exports.preloadAudio = void 0;
+exports.resolveRedirect = exports.preloadVideo = exports.preloadImage = exports.preloadFont = exports.preloadAudio = void 0;
 var preload_audio_1 = require("./preload-audio");
 Object.defineProperty(exports, "preloadAudio", { enumerable: true, get: function () { return preload_audio_1.preloadAudio; } });
+var preload_font_1 = require("./preload-font");
+Object.defineProperty(exports, "preloadFont", { enumerable: true, get: function () { return preload_font_1.preloadFont; } });
+var preload_image_1 = require("./preload-image");
+Object.defineProperty(exports, "preloadImage", { enumerable: true, get: function () { return preload_image_1.preloadImage; } });
 var preload_video_1 = require("./preload-video");
 Object.defineProperty(exports, "preloadVideo", { enumerable: true, get: function () { return preload_video_1.preloadVideo; } });
 var resolve_redirect_1 = require("./resolve-redirect");

package/dist/preload-asset.d.ts

@@ -0,0 +1,3 @@
+declare const typesAllowed: readonly ["video", "audio", "image", "font"];
+export declare const preloadAsset: (src: string, elemType: (typeof typesAllowed)[number]) => (() => void);
+export {};

package/dist/preload-asset.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preloadAsset = void 0;
+const resolve_redirect_1 = require("./resolve-redirect");
+const typesAllowed = ['video', 'audio', 'image', 'font'];
+const preloadAsset = (src, elemType) => {
+    const apiName = `preload${elemType.charAt(0).toUpperCase() + elemType.slice(1)}`;
+    if (typeof document === 'undefined') {
+        console.warn(apiName + '() was called outside the browser. Doing nothing.');
+        return () => undefined;
+    }
+    if (!typesAllowed.includes(elemType)) {
+        console.warn(apiName + '() Error, elemType not supported. Doing nothing.', elemType);
+        return () => undefined;
+    }
+    const resolved = (0, resolve_redirect_1.resolveRedirect)(src);
+    let cancelled = false;
+    if (navigator.userAgent.match(/Firefox\//) ||
+        elemType === 'image' ||
+        elemType === 'font') {
+        const link = document.createElement('link');
+        link.rel = 'preload';
+        link.as = elemType;
+        resolved
+            .then((realUrl) => {
+            if (!cancelled) {
+                link.href = realUrl;
+                document.head.appendChild(link);
+            }
+        })
+            .catch((err) => {
+            console.log(`Failed to preload asset`, err);
+        });
+        return () => {
+            cancelled = true;
+            link.remove();
+        };
+    }
+    const elem = document.createElement(elemType);
+    elem.preload = 'auto';
+    elem.controls = true;
+    elem.style.display = 'none';
+    resolved
+        .then((realUrl) => {
+        if (!cancelled) {
+            elem.src = realUrl;
+            document.body.appendChild(elem);
+        }
+    })
+        .catch((err) => {
+        console.log('Failed to preload asset', err);
+    });
+    return () => {
+        cancelled = true;
+        elem.remove();
+    };
+};
+exports.preloadAsset = preloadAsset;

package/dist/preload-audio.d.ts

@@ -1 +1,5 @@
+/**
+ * @description Preloads audio in the DOM so that when a audio tag is mounted, it can play immediately.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/preload-audio)
+ */
 export declare const preloadAudio: (src: string) => (() => void);

package/dist/preload-audio.js

@@ -1,50 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.preloadAudio = void 0;
-const resolve_redirect_1 = require("./resolve-redirect");
+const preload_asset_1 = require("./preload-asset");
+/**
+ * @description Preloads audio in the DOM so that when a audio tag is mounted, it can play immediately.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/preload-audio)
+ */
 const preloadAudio = (src) => {
-    if (typeof document === 'undefined') {
-        console.warn('preloadAudio() was called outside the browser. Doing nothing.');
-        return () => undefined;
-    }
-    const resolved = (0, resolve_redirect_1.resolveRedirect)(src);
-    let cancelled = false;
-    if (navigator.userAgent.match(/Firefox\//)) {
-        const link = document.createElement('link');
-        link.rel = 'preload';
-        link.as = 'audio';
-        resolved
-            .then((realUrl) => {
-            if (!cancelled) {
-                link.href = realUrl;
-                document.head.appendChild(link);
-            }
-        })
-            .catch((err) => {
-            console.log(`Failed to preload audio`, err);
-        });
-        return () => {
-            cancelled = true;
-            link.remove();
-        };
-    }
-    const vid = document.createElement('audio');
-    vid.preload = 'auto';
-    vid.controls = true;
-    vid.style.display = 'none';
-    resolved
-        .then((realUrl) => {
-        if (!cancelled) {
-            vid.src = realUrl;
-            document.body.appendChild(vid);
-        }
-    })
-        .catch((err) => {
-        console.log('Failed to preload audio', err);
-    });
-    return () => {
-        cancelled = true;
-        vid.remove();
-    };
+    return (0, preload_asset_1.preloadAsset)(src, 'audio');
 };
 exports.preloadAudio = preloadAudio;

package/dist/preload-font.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @description Preloads a font so that when an <Img> tag is mounted, it can display immediately.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/preload-font)
+ */
+export declare const preloadFont: (src: string) => (() => void);

package/dist/preload-font.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preloadFont = void 0;
+const preload_asset_1 = require("./preload-asset");
+/**
+ * @description Preloads a font so that when an <Img> tag is mounted, it can display immediately.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/preload-font)
+ */
+const preloadFont = (src) => {
+    return (0, preload_asset_1.preloadAsset)(src, 'font');
+};
+exports.preloadFont = preloadFont;

package/dist/preload-image.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @description Preloads an image so that when an <Img> tag is mounted, it can display immediately.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/preload-image)
+ */
+export declare const preloadImage: (src: string) => (() => void);

package/dist/preload-image.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.preloadImage = void 0;
+const preload_asset_1 = require("./preload-asset");
+/**
+ * @description Preloads an image so that when an <Img> tag is mounted, it can display immediately.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/preload-image)
+ */
+const preloadImage = (src) => {
+    return (0, preload_asset_1.preloadAsset)(src, 'image');
+};
+exports.preloadImage = preloadImage;

package/dist/preload-video.d.ts

@@ -1 +1,5 @@
+/**
+ * @description Preloads a video in the DOM so that when a video tag is mounted, it can play immediately.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/preload-video)
+ */
 export declare const preloadVideo: (src: string) => (() => void);

package/dist/preload-video.js

@@ -1,50 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.preloadVideo = void 0;
-const resolve_redirect_1 = require("./resolve-redirect");
+const preload_asset_1 = require("./preload-asset");
+/**
+ * @description Preloads a video in the DOM so that when a video tag is mounted, it can play immediately.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/preload-video)
+ */
 const preloadVideo = (src) => {
-    if (typeof document === 'undefined') {
-        console.warn('preloadVideo() was called outside the browser. Doing nothing.');
-        return () => undefined;
-    }
-    const resolved = (0, resolve_redirect_1.resolveRedirect)(src);
-    let cancelled = false;
-    if (navigator.userAgent.match(/Firefox\//)) {
-        const link = document.createElement('link');
-        link.rel = 'preload';
-        link.as = 'video';
-        resolved
-            .then((realUrl) => {
-            if (!cancelled) {
-                link.href = realUrl;
-                document.head.appendChild(link);
-            }
-        })
-            .catch((err) => {
-            console.log(`Failed to preload video`, err);
-        });
-        return () => {
-            cancelled = true;
-            link.remove();
-        };
-    }
-    const vid = document.createElement('video');
-    vid.preload = 'auto';
-    vid.controls = true;
-    vid.style.display = 'none';
-    resolved
-        .then((realUrl) => {
-        if (!cancelled) {
-            vid.src = realUrl;
-            document.body.appendChild(vid);
-        }
-    })
-        .catch((err) => {
-        console.log('Failed to preload video', err);
-    });
-    return () => {
-        cancelled = true;
-        vid.remove();
-    };
+    return (0, preload_asset_1.preloadAsset)(src, 'video');
 };
 exports.preloadVideo = preloadVideo;

package/dist/resolve-redirect.d.ts

@@ -1 +1,5 @@
+/**
+ * @description Follows the redirects of a URL (most commonly a remote video or audio) until the final URL is resolved and returns that.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/resolve-redirect)
+ */
 export declare const resolveRedirect: (videoOrAudio: string) => Promise<string>;

package/dist/resolve-redirect.js

@@ -1,4 +1,8 @@
 "use strict";
+/**
+ * @description Follows the redirects of a URL (most commonly a remote video or audio) until the final URL is resolved and returns that.
+ * @see [Documentation](https://www.remotion.dev/docs/preload/resolve-redirect)
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveRedirect = void 0;
 const resolveRedirect = async (videoOrAudio) => {

package/package.json

@@ -1,39 +1,39 @@
 {
-	"name": "@remotion/preload",
-	"version": "4.0.0-webhook.27+eb81308ee",
-	"description": "Utility functions for preloading assets in HTML5",
-	"main": "dist/index.js",
-	"types": "dist/index.d.ts",
-	"sideEffects": false,
-	"scripts": {
-		"lint": "eslint src --ext ts,tsx",
-		"watch": "tsc -w",
-		"build": "tsc -d"
-	},
-	"author": "Jonny Burger",
-	"contributors": [],
-	"license": "MIT",
-	"repository": {
-		"url": "https://github.com/remotion-dev/remotion"
-	},
-	"bugs": {
-		"url": "https://github.com/remotion-dev/remotion/issues"
-	},
-	"devDependencies": {
-		"@jonny/eslint-config": "3.0.266",
-		"eslint": "8.13.0",
-		"prettier": "^2.0.5",
-		"prettier-plugin-organize-imports": "^2.3.4",
-		"typescript": "^4.5.5"
-	},
-	"keywords": [
-		"remotion",
-		"preload",
-		"html5",
-		"video"
-	],
-	"publishConfig": {
-		"access": "public"
-	},
-	"gitHead": "eb81308ee07a402f4a8dd9ff24306bb07dd78175"
-}
+  "name": "@remotion/preload",
+  "version": "4.1.0-alpha1",
+  "description": "Utility functions for preloading assets in HTML5",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "author": "Jonny Burger",
+  "contributors": [],
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/remotion-dev/remotion"
+  },
+  "bugs": {
+    "url": "https://github.com/remotion-dev/remotion/issues"
+  },
+  "devDependencies": {
+    "@jonny/eslint-config": "3.0.266",
+    "eslint": "8.42.0",
+    "prettier": "^2.7.1",
+    "prettier-plugin-organize-imports": "^2.3.4",
+    "typescript": "4.9.5"
+  },
+  "keywords": [
+    "remotion",
+    "preload",
+    "html5",
+    "video"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "formatting": "prettier src --check",
+    "lint": "eslint src --ext ts,tsx",
+    "watch": "tsc -w",
+    "build": "tsc -d"
+  }
+}

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,14 +0,0 @@
-{
-	"extends": "../tsconfig.settings.json",
-	"compilerOptions": {
-		"composite": true,
-		"rootDir": "src",
-		"outDir": "dist",
-		"skipLibCheck": true
-	},
-	"references": [
-		{
-			"path": "../core"
-		}
-	]
-}