@crxjs/vite-plugin 1.0.14 → 2.0.0-beta.10

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { ConfigEnv, Plugin, ViteDevServer, PluginOption } from 'vite';
-import { PluginContext, OutputBundle, OutputOptions } from 'rollup';
+import { ConfigEnv, Plugin, PluginOption } from 'vite';
 import { Options } from 'fast-glob';
+import { PluginContext, OutputBundle } from 'rollup';
 
 interface DeclarativeNetRequestResource {
     id: string;
@@ -202,14 +202,15 @@ declare const defineManifest: (manifest: ManifestV3Export) => ManifestV3Export;
  *
  * You don't need to define a match pattern for dynamic content script
  * resources, but if you want to do so, you can use the helper function
- * `defineDynamicResource` to define your web accessible resources in a TypeScript file:
+ * `defineDynamicResource` to define your web accessible resources in a
+ * TypeScript file:
  *
  * ```typescript
  * import { crx, defineManifest, defineDynamicResource }
  * const manifest = defineManifest({
  *   "web_accessible_resources": [
  *     defineDynamicResource({
- *       matches: ["https://google.com/*", "file:///*.mp3", "..."]
+ *       matches: ["https://example.com/*", "file:///*.mp3", "..."]
  *       use_dynamic_url?: true
  *     })
  *   ]
@@ -218,13 +219,25 @@ declare const defineManifest: (manifest: ManifestV3Export) => ManifestV3Export;
  */
 declare const defineDynamicResource: ({ matches, use_dynamic_url, }: Omit<WebAccessibleResourceByMatch, 'resources'>) => WebAccessibleResourceByMatch;
 
+declare type CrxDevAssetId = {
+    id: string;
+    type: 'asset';
+    source?: string | Uint8Array;
+};
+declare type CrxDevScriptId = {
+    id: string;
+    type: 'module' | 'iife';
+};
 interface CrxPlugin extends Plugin {
-    /** Runs during dev mode when the file writer has started and server is listening. */
-    fileWriterStart?: (server: ViteDevServer) => Promise<void> | void;
-    /** Runs during the transform hook for the manifest. */
+    /** Runs during the transform hook for the manifest. Filenames use input filenames. */
     transformCrxManifest?: (this: PluginContext, manifest: ManifestV3) => Promise<ManifestV3 | null | undefined> | ManifestV3 | null | undefined;
-    /** Runs during generateBundle, before manifest output. */
+    /** Runs during generateBundle, before manifest output. Filenames use output filenames. */
     renderCrxManifest?: (this: PluginContext, manifest: ManifestV3, bundle: OutputBundle) => Promise<ManifestV3 | null | undefined> | ManifestV3 | null | undefined;
+    /**
+     * Runs in the file writer on content scripts during development. `script.id`
+     * is Vite URL format.
+     */
+    renderCrxDevScript?: (code: string, script: CrxDevScriptId) => Promise<string | null | undefined> | string | null | undefined;
 }
 interface CrxOptions {
     contentScripts?: {
@@ -235,21 +248,21 @@ interface CrxOptions {
     fastGlobOptions?: Options;
 }
 
-declare const filesReady: () => Promise<{
-    type: 'writeBundle';
-    options: OutputOptions;
-    bundle: OutputBundle;
-    duration: number;
-    timestamp: number;
-}>;
-/** Trigger a rebuild from other plugins */
-declare const rebuildFiles: () => Promise<void>;
+/** Resolves when all existing files in scriptFiles are written. */
+declare function allFilesReady(): Promise<void>;
+
+declare type FileWriterId = {
+    type: CrxDevAssetId['type'] | CrxDevScriptId['type'] | 'loader';
+    id: string;
+};
+/** Resolves when file and dependencies are written. */
+declare function fileReady(script: FileWriterId): Promise<void>;
 
-declare const crx: ({ manifest, ...options }: {
+declare const crx: (options: {
     manifest: ManifestV3Export;
 } & CrxOptions) => PluginOption[];
-declare const chromeExtension: ({ manifest, ...options }: {
+declare const chromeExtension: (options: {
     manifest: ManifestV3Export;
 } & CrxOptions) => PluginOption[];
 
-export { CrxPlugin, ManifestV3Export, chromeExtension, crx, defineDynamicResource, defineManifest, filesReady, rebuildFiles };
+export { CrxPlugin, ManifestV3Export, allFilesReady, chromeExtension, crx, defineDynamicResource, defineManifest, fileReady as filesReady };