@revideo/vite-plugin 0.2.2 → 0.2.4-alpha.894

package/lib/index.js

@@ -1,23 +1,41 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const main_1 = __importDefault(require("./main"));
+'use strict';
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m)
+      if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p))
+        __createBinding(exports, m, p);
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : {default: mod};
+  };
+Object.defineProperty(exports, '__esModule', {value: true});
+const main_1 = __importDefault(require('./main'));
 exports.default = main_1.default;
-__exportStar(require("./plugins"), exports);
-//# sourceMappingURL=index.js.map
+__exportStar(require('./plugins'), exports);
+//# sourceMappingURL=index.js.map

package/lib/main.d.ts

@@ -1,82 +1,89 @@
-import type { Plugin } from 'vite';
-import { CorsProxyPluginConfig } from './partials';
+import type {Plugin} from 'vite';
+import {CorsProxyPluginConfig} from './partials';
 export interface MotionCanvasPluginConfig {
-    /**
-     * The import path of the project file or an array of paths.
-     * Also supports globs.
-     *
-     * @remarks
-     * Each file must contain a default export exposing an instance of the
-     * {@link Project} class.
-     *
-     * @example
-     * ```ts
-     * motionCanvas({
-     *   project: [
-     *     './src/firstProject.ts',
-     *     './src/secondProject.ts',
-     *   ]
-     * })
-     * ```
-     *
-     * @defaultValue './src/project.ts'
-     */
-    project?: string | string[];
-    /**
-     * A directory path to which the animation will be rendered.
-     *
-     * @defaultValue './output'
-     */
-    output?: string;
-    /**
-     * Defines which assets should be buffered before being sent to the browser.
-     *
-     * @remarks
-     * Streaming larger assets directly from the drive may cause issues with other
-     * applications. For instance, if an audio file is being used in the project,
-     * Adobe Audition will perceive it as "being used by another application"
-     * and refuse to override it.
-     *
-     * Buffered assets are first loaded to the memory and then streamed from
-     * there. This leaves the original files open for modification with hot module
-     * replacement still working.
-     *
-     * @defaultValue /^$/
-     */
-    bufferedAssets?: RegExp | false;
-    /**
-     * The import path of the editor package.
-     *
-     * @remarks
-     * This path will be resolved using Node.js module resolution rules.
-     * It should lead to a directory containing the following files:
-     * - `editor.html` - The HTML template for the editor.
-     * - `styles.css` - The editor styles.
-     * - `main.js` - A module exporting necessary factory functions.
-     *
-     * `main.js` should export the following functions:
-     * - `editor` - Receives the project factory as its first argument and creates
-     *              the user interface.
-     * - `index` - Receives a list of all projects as its first argument and
-     *             creates the initial page for selecting a project.
-     *
-     * @defaultValue '\@revideo/ui'
-     */
-    editor?: string;
-    /**
-     * Configuration of the Proxy used for remote sources
-     *
-     * @remarks
-     * This passes configuration to Motion Canvas' proxy.
-     * Note that the proxy is disabled by default.
-     * You can either pass `true` and a config object
-     * to enable it.
-     **/
-    proxy?: boolean | CorsProxyPluginConfig;
-    /**
-     * Build the project to run in the editor.
-     */
-    buildForEditor?: boolean;
+  /**
+   * The import path of the project file or an array of paths.
+   * Also supports globs.
+   *
+   * @remarks
+   * Each file must contain a default export exposing an instance of the
+   * {@link Project} class.
+   *
+   * @example
+   * ```ts
+   * motionCanvas({
+   *   project: [
+   *     './src/firstProject.ts',
+   *     './src/secondProject.ts',
+   *   ]
+   * })
+   * ```
+   *
+   * @defaultValue './src/project.ts'
+   */
+  project?: string | string[];
+  /**
+   * A directory path to which the animation will be rendered.
+   *
+   * @defaultValue './output'
+   */
+  output?: string;
+  /**
+   * Defines which assets should be buffered before being sent to the browser.
+   *
+   * @remarks
+   * Streaming larger assets directly from the drive may cause issues with other
+   * applications. For instance, if an audio file is being used in the project,
+   * Adobe Audition will perceive it as "being used by another application"
+   * and refuse to override it.
+   *
+   * Buffered assets are first loaded to the memory and then streamed from
+   * there. This leaves the original files open for modification with hot module
+   * replacement still working.
+   *
+   * @defaultValue /^$/
+   */
+  bufferedAssets?: RegExp | false;
+  /**
+   * The import path of the editor package.
+   *
+   * @remarks
+   * This path will be resolved using Node.js module resolution rules.
+   * It should lead to a directory containing the following files:
+   * - `editor.html` - The HTML template for the editor.
+   * - `styles.css` - The editor styles.
+   * - `main.js` - A module exporting necessary factory functions.
+   *
+   * `main.js` should export the following functions:
+   * - `editor` - Receives the project factory as its first argument and creates
+   *              the user interface.
+   * - `index` - Receives a list of all projects as its first argument and
+   *             creates the initial page for selecting a project.
+   *
+   * @defaultValue '\@revideo/ui'
+   */
+  editor?: string;
+  /**
+   * Configuration of the Proxy used for remote sources
+   *
+   * @remarks
+   * This passes configuration to Motion Canvas' proxy.
+   * Note that the proxy is disabled by default.
+   * You can either pass `true` and a config object
+   * to enable it.
+   **/
+  proxy?: boolean | CorsProxyPluginConfig;
+  /**
+   * Build the project to run in the editor.
+   */
+  buildForEditor?: boolean;
 }
-declare const _default: ({ project, output, bufferedAssets, editor, proxy, buildForEditor, }?: MotionCanvasPluginConfig) => Plugin[];
+declare const _default: ({
+  project,
+  output,
+  bufferedAssets,
+  editor,
+  proxy,
+  buildForEditor,
+}?: MotionCanvasPluginConfig) => Plugin[];
 export default _default;

package/lib/main.js

@@ -1,38 +1,53 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+'use strict';
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : {default: mod};
+  };
+Object.defineProperty(exports, '__esModule', {value: true});
+const path_1 = __importDefault(require('path'));
+const partials_1 = require('./partials');
+const plugins_1 = require('./plugins');
+const utils_1 = require('./utils');
+exports.default = ({
+  project = './src/project.ts',
+  output = './output',
+  bufferedAssets = /^$/,
+  editor = '@revideo/ui',
+  proxy,
+  buildForEditor,
+} = {}) => {
+  const plugins = [];
+  const outputPath = path_1.default.resolve(output);
+  const projects = (0, utils_1.getProjects)(project);
+  return [
+    {
+      name: 'revideo',
+      async configResolved(resolvedConfig) {
+        plugins.push(
+          ...resolvedConfig.plugins
+            .filter(plugins_1.isPlugin)
+            .map(plugin => plugin[plugins_1.PLUGIN_OPTIONS]),
+        );
+        await Promise.all(
+          plugins.map(plugin =>
+            plugin.config?.({
+              output: outputPath,
+              projects: projects.list,
+            }),
+          ),
+        );
+      },
+    },
+    (0, partials_1.metaPlugin)(),
+    (0, partials_1.settingsPlugin)(),
+    (0, partials_1.scenesPlugin)(),
+    (0, partials_1.exporterPlugin)({outputPath}),
+    (0, partials_1.editorPlugin)({editor, projects}),
+    (0, partials_1.projectsPlugin)({projects, plugins, buildForEditor}),
+    (0, partials_1.assetsPlugin)({bufferedAssets}),
+    (0, partials_1.webglPlugin)(),
+    (0, partials_1.corsProxyPlugin)(proxy),
+  ];
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const partials_1 = require("./partials");
-const plugins_1 = require("./plugins");
-const utils_1 = require("./utils");
-exports.default = ({ project = './src/project.ts', output = './output', bufferedAssets = /^$/, editor = '@revideo/ui', proxy, buildForEditor, } = {}) => {
-    const plugins = [];
-    const outputPath = path_1.default.resolve(output);
-    const projects = (0, utils_1.getProjects)(project);
-    return [
-        {
-            name: 'revideo',
-            async configResolved(resolvedConfig) {
-                plugins.push(...resolvedConfig.plugins
-                    .filter(plugins_1.isPlugin)
-                    .map(plugin => plugin[plugins_1.PLUGIN_OPTIONS]));
-                await Promise.all(plugins.map(plugin => plugin.config?.({
-                    output: outputPath,
-                    projects: projects.list,
-                })));
-            },
-        },
-        (0, partials_1.metaPlugin)(),
-        (0, partials_1.settingsPlugin)(),
-        (0, partials_1.scenesPlugin)(),
-        (0, partials_1.exporterPlugin)({ outputPath }),
-        (0, partials_1.editorPlugin)({ editor, projects }),
-        (0, partials_1.projectsPlugin)({ projects, plugins, buildForEditor }),
-        (0, partials_1.assetsPlugin)({ bufferedAssets }),
-        (0, partials_1.webglPlugin)(),
-        (0, partials_1.corsProxyPlugin)(proxy),
-    ];
-};
-//# sourceMappingURL=main.js.map
+//# sourceMappingURL=main.js.map

package/lib/openInExplorer.js

@@ -1,45 +1,44 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+'use strict';
+Object.defineProperty(exports, '__esModule', {value: true});
 exports.openInExplorer = void 0;
-const child_process_1 = require("child_process");
-const os_1 = require("os");
+const child_process_1 = require('child_process');
+const os_1 = require('os');
 function openInExplorer(file) {
-    let command = null;
-    let args = [file];
-    const os = (0, os_1.platform)();
-    switch (os) {
-        case 'win32':
-            command = 'explorer';
-            break;
-        case 'linux':
-            if (isRunningOnWSL()) {
-                command = 'bash';
-                args = ['-c', `cd ${file} && explorer.exe .`];
-            }
-            else {
-                command = 'xdg-open';
-            }
-            break;
-        case 'darwin':
-            command = 'open';
-            break;
-    }
-    if (command) {
-        (0, child_process_1.spawn)(command, args, { detached: true }).unref();
-    }
-    else {
-        console.warn(`Unsupported OS: ${os}`);
-    }
+  let command = null;
+  let args = [file];
+  const os = (0, os_1.platform)();
+  switch (os) {
+    case 'win32':
+      command = 'explorer';
+      break;
+    case 'linux':
+      if (isRunningOnWSL()) {
+        command = 'bash';
+        args = ['-c', `cd ${file} && explorer.exe .`];
+      } else {
+        command = 'xdg-open';
+      }
+      break;
+    case 'darwin':
+      command = 'open';
+      break;
+  }
+  if (command) {
+    (0, child_process_1.spawn)(command, args, {detached: true}).unref();
+  } else {
+    console.warn(`Unsupported OS: ${os}`);
+  }
 }
 exports.openInExplorer = openInExplorer;
 function isRunningOnWSL() {
-    try {
-        const uname = (0, child_process_1.execSync)('uname -a').toString().toLowerCase();
-        return uname.includes('microsoft');
-    }
-    catch (error) {
-        console.error(`exec error: ${error}`);
-        return false;
-    }
+  try {
+    const uname = (0, child_process_1.execSync)('uname -a')
+      .toString()
+      .toLowerCase();
+    return uname.includes('microsoft');
+  } catch (error) {
+    console.error(`exec error: ${error}`);
+    return false;
+  }
 }
-//# sourceMappingURL=openInExplorer.js.map
+//# sourceMappingURL=openInExplorer.js.map

package/lib/partials/assets.d.ts

@@ -1,6 +1,8 @@
-import { Plugin } from 'vite';
+import {Plugin} from 'vite';
 interface AssetsPluginConfig {
-    bufferedAssets: RegExp | false;
+  bufferedAssets: RegExp | false;
 }
-export declare function assetsPlugin({ bufferedAssets }: AssetsPluginConfig): Plugin;
+export declare function assetsPlugin({
+  bufferedAssets,
+}: AssetsPluginConfig): Plugin;
 export {};

package/lib/partials/assets.js

@@ -1,51 +1,54 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
+'use strict';
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : {default: mod};
+  };
+Object.defineProperty(exports, '__esModule', {value: true});
 exports.assetsPlugin = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const stream_1 = require("stream");
+const fs_1 = __importDefault(require('fs'));
+const path_1 = __importDefault(require('path'));
+const stream_1 = require('stream');
 const AUDIO_EXTENSION_REGEX = /\.(mp3|wav|ogg|aac|flac)(?:$|\?)/;
 const AUDIO_HMR_DELAY = 1000;
-function assetsPlugin({ bufferedAssets }) {
-    let config;
-    return {
-        name: 'revideo:assets',
-        configResolved(resolvedConfig) {
-            config = resolvedConfig;
-        },
-        configureServer(server) {
-            server.middlewares.use((req, res, next) => {
-                if (req.url && bufferedAssets && bufferedAssets.test(req.url)) {
-                    const file = fs_1.default.readFileSync(path_1.default.resolve(config.root, req.url.slice(1)));
-                    stream_1.Readable.from(file).pipe(res);
-                    return;
-                }
-                next();
-            });
-        },
-        async handleHotUpdate(ctx) {
-            const urls = [];
-            const modules = [];
-            for (const module of ctx.modules) {
-                urls.push(module.url);
-                if (!AUDIO_EXTENSION_REGEX.test(module.url)) {
-                    modules.push(module);
-                }
-                else {
-                    await new Promise(resolve => {
-                        setTimeout(resolve, AUDIO_HMR_DELAY);
-                    });
-                }
-            }
-            if (urls.length > 0) {
-                ctx.server.ws.send('revideo:assets', { urls });
-            }
-            return modules;
-        },
-    };
+function assetsPlugin({bufferedAssets}) {
+  let config;
+  return {
+    name: 'revideo:assets',
+    configResolved(resolvedConfig) {
+      config = resolvedConfig;
+    },
+    configureServer(server) {
+      server.middlewares.use((req, res, next) => {
+        if (req.url && bufferedAssets && bufferedAssets.test(req.url)) {
+          const file = fs_1.default.readFileSync(
+            path_1.default.resolve(config.root, req.url.slice(1)),
+          );
+          stream_1.Readable.from(file).pipe(res);
+          return;
+        }
+        next();
+      });
+    },
+    async handleHotUpdate(ctx) {
+      const urls = [];
+      const modules = [];
+      for (const module of ctx.modules) {
+        urls.push(module.url);
+        if (!AUDIO_EXTENSION_REGEX.test(module.url)) {
+          modules.push(module);
+        } else {
+          await new Promise(resolve => {
+            setTimeout(resolve, AUDIO_HMR_DELAY);
+          });
+        }
+      }
+      if (urls.length > 0) {
+        ctx.server.ws.send('revideo:assets', {urls});
+      }
+      return modules;
+    },
+  };
 }
 exports.assetsPlugin = assetsPlugin;
-//# sourceMappingURL=assets.js.map
+//# sourceMappingURL=assets.js.map

package/lib/partials/corsProxy.d.ts

@@ -1,28 +1,28 @@
-import { Plugin } from 'vite';
+import {Plugin} from 'vite';
 /**
  * Configuration used by the Proxy plugin
  */
 export interface CorsProxyPluginConfig {
-    /**
-     * Set which types of resources are allowed by default.
-     *
-     * @remarks
-     * Catchall on the right side is supported.
-     * Pass an empty Array to allow all types of resources, although this is not
-     * recommended.
-     *
-     * @defaultValue ["image/*", "video/*"]
-     */
-    allowedMimeTypes?: string[];
-    /**
-     * Set which hosts are allowed
-     *
-     * @remarks
-     * Note that the host is everything to the left of the first `/`, and to the
-     * right of the protocol `https://`. AllowList is not used by default,
-     * although you should consider setting up just the relevant hosts.
-     */
-    allowListHosts?: string[];
+  /**
+   * Set which types of resources are allowed by default.
+   *
+   * @remarks
+   * Catchall on the right side is supported.
+   * Pass an empty Array to allow all types of resources, although this is not
+   * recommended.
+   *
+   * @defaultValue ["image/*", "video/*"]
+   */
+  allowedMimeTypes?: string[];
+  /**
+   * Set which hosts are allowed
+   *
+   * @remarks
+   * Note that the host is everything to the left of the first `/`, and to the
+   * right of the protocol `https://`. AllowList is not used by default,
+   * although you should consider setting up just the relevant hosts.
+   */
+  allowListHosts?: string[];
 }
 /**
  * This module provides the proxy located at
@@ -40,4 +40,6 @@ export interface CorsProxyPluginConfig {
  * this way all remote resources are served from the
  * same host as the main app.
  */
-export declare function corsProxyPlugin(config?: CorsProxyPluginConfig | boolean): Plugin;
+export declare function corsProxyPlugin(
+  config?: CorsProxyPluginConfig | boolean,
+): Plugin;