@ms-cloudpack/bundler-types - npm Package Compare versions

Comparing version 0.24.5 to 0.25.0

lib/BundleResult.d.ts

 import type { BundleMessage } from './BundleMessage.js';
 export interface BundleOutputFile {
     /**
-     * The absolute path to the output file, with forward slashes.
+     * The relative path to the output file (starting from `BundleResult#outputPath`),
+     * with forward slashes.
      */
     outputPath: string;
     /**
-     * The relative path to the entry file.
+     * The relative path to the entry file (starting from `BundleResult#inputPath`),
+     * with forward slashes.
      */
@@ -16,16 +18,8 @@ entryPoint?: string;
 }
-export interface BundleResult {
+/**
+ * Result returned by a bundler plugin (`BundlerPlugin#bundle()`).
+ * Excludes properties that can be filled in automatically.
+ */
+export interface BundlerPluginResult {
     /**
-     * The name of the bundler used.
-     */
-    bundlerName?: string;
-    /**
-     * The absolute input path of the entries.
-     */
-    inputPath: string;
-    /**
-     * The entry file paths map used to create the bundle output. See `BundleOptions.entries`.
-     */
-    entries?: Record<string, string>;
-    /**
      * The absolute output path of the bundle.
@@ -47,9 +41,9 @@ */
     /**
-     * The raw input options passed along into the bundler, for debugging purposes. May be missing if
-     * something prevented executing the bundler.
+     * The raw input options passed along into the bundler, for debugging purposes.
+     * May be missing if something prevented executing the bundler.
      */
     rawInput?: Record<string, unknown>;
     /**
-     * The raw output emitted from the bundler, for debugging purposes. May be missing if something
-     * prevented the bundler from returning output.
+     * The raw output emitted from the bundler, for debugging purposes.
+     * May be missing if something prevented the bundler from returning output.
      */
@@ -60,3 +54,3 @@ rawOutput?: Record<string, unknown>;
      */
-    rebuild?: () => Promise<BundleResult>;
+    rebuild?: () => Promise<BundlerPluginResult>;
     /**
@@ -67,2 +61,23 @@ * If incremental bundling is specified, provide a way to shut down the incremental build job.
 }
+/**
+ * Final bundle result as returned by `bundle()` in `@ms-cloudpack/bundler`.
+ */
+export interface BundleResult extends Omit<BundlerPluginResult, 'rebuild' | 'rawInput' | 'rawOutput'> {
+    /**
+     * The name of the bundler used. Will be set unless there was an error with the options.
+     */
+    bundlerName?: string;
+    /**
+     * The absolute input path of the entries.
+     */
+    inputPath: string;
+    /**
+     * The entry file paths map used to create the bundle output. See `BundleOptions.entries`.
+     */
+    entries?: Record<string, string>;
+    /**
+     * If incremental bundling is specified, provide a way to rebuild the project.
+     */
+    rebuild?: () => Promise<BundleResult>;
+}
 //# sourceMappingURL=BundleResult.d.ts.map

lib/index.d.ts

@@ -6,5 +6,5 @@ export type { BundleContext } from './BundleContext.js';
 export type { BundleOptions } from './BundleOptions.js';
-export type { BundleOutputFile, BundleResult } from './BundleResult.js';
-export type { Bundler } from './Bundler.js';
+export type { BundleOutputFile, BundleResult, BundlerPluginResult } from './BundleResult.js';
+export type { BundlerPlugin } from './BundlerPlugin.js';
 export type { GetPackageDefinitionOptions, PackageDefinitionTransform, PackageDefinitionsCache, PackageImporterContext, } from './PackageDefinitionsCache.js';
 //# sourceMappingURL=index.d.ts.map

package.json

 {
   "name": "@ms-cloudpack/bundler-types",
-  "version": "0.24.5",
+  "version": "0.25.0",
   "description": "TypeScript types for implementing a bundler abstraction. We keep these separate from the bundler package to eliminate circular package dependencies and ensure no major bumps happen with the contract.",
@@ -5,0 +5,0 @@ "license": "MIT",

No alert changes

Improved metrics

Total package byte prevSize

26765

increased by7.36%

Lines of code

249

increased by6.41%

No dependency changes