@opentray/esbuild-plugin 0.1.0 → 0.11.0

package/dist/index.d.mts

@@ -0,0 +1,48 @@
+import { OpenTrayArtifactInput, OpenTrayPackageManifest, OpenTrayPackageResult, OpenTrayPackagingApp } from "@opentray/packaging";
+
+//#region src/index.d.ts
+interface OpenTrayEsbuildPluginOptions {
+  readonly app: OpenTrayPackagingApp;
+  readonly runtimeHost: OpenTrayArtifactInput;
+  readonly nativeArtifacts?: Readonly<Record<string, OpenTrayArtifactInput>>;
+  readonly companionAssets?: Readonly<Record<string, OpenTrayArtifactInput>>;
+  readonly entry?: string;
+  readonly manifestPath?: string;
+  /**
+   * Explicit outDir override. When omitted, resolved from the esbuild
+   * `outdir`/`outfile` option or defaults to `dist`.
+   */
+  readonly outDir?: string;
+  /**
+   * Explicit mode override. Defaults to `production`.
+   */
+  readonly mode?: string;
+}
+/**
+ * Structural view of the esbuild initial options the adapter consumes. Only the
+ * staging-relevant fields are declared, so esbuild never has to be imported.
+ */
+interface EsbuildInitialOptionsLike {
+  readonly outdir?: string;
+  readonly outfile?: string;
+  readonly entryPoints?: readonly string[] | Readonly<Record<string, string>>;
+  readonly absWorkingDir?: string;
+}
+interface EsbuildBuildLike {
+  readonly initialOptions: EsbuildInitialOptionsLike;
+  onEnd(callback: (result: unknown) => Promise<void> | void): void;
+}
+interface EsbuildPlugin {
+  readonly name: string;
+  readonly setup: (build: EsbuildBuildLike) => void;
+}
+interface OpenTrayEsbuildPlugin extends EsbuildPlugin {
+  readonly name: "opentray-packaging";
+  /** Returns the last staging result. Only populated after `onEnd` runs. */
+  readonly getLastResult: () => OpenTrayPackageResult | undefined;
+}
+declare const openTrayEsbuildPlugin: (options: OpenTrayEsbuildPluginOptions) => OpenTrayEsbuildPlugin;
+declare const resolveEsbuildEntry: (initialOptions: EsbuildInitialOptionsLike) => string;
+//#endregion
+export { EsbuildBuildLike, EsbuildInitialOptionsLike, EsbuildPlugin, OpenTrayEsbuildPlugin, OpenTrayEsbuildPluginOptions, type OpenTrayPackageManifest, type OpenTrayPackageResult, openTrayEsbuildPlugin, resolveEsbuildEntry };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;UAUiB,4BAAA;EAAA,SACN,GAAA,EAAK,oBAAA;EAAA,SACL,WAAA,EAAa,qBAAA;EAAA,SACb,eAAA,GAAkB,QAAA,CAAS,MAAA,SAAe,qBAAA;EAAA,SAC1C,eAAA,GAAkB,QAAA,CAAS,MAAA,SAAe,qBAAA;EAAA,SAC1C,KAAA;EAAA,SACA,YAAA;EAH0C;;;;EAAA,SAQ1C,MAAA;EAPkB;;;EAAA,SAWlB,IAAA;AAAA;;;;;UAOM,yBAAA;EAAA,SACN,MAAA;EAAA,SACA,OAAA;EAAA,SACA,WAAA,uBAAkC,QAAQ,CAAC,MAAA;EAAA,SAC3C,aAAA;AAAA;AAAA,UAGM,gBAAA;EAAA,SACN,cAAA,EAAgB,yBAAA;EACzB,KAAA,CAAM,QAAA,GAAW,MAAA,cAAoB,OAAO;AAAA;AAAA,UAG7B,aAAA;EAAA,SACN,IAAA;EAAA,SACA,KAAA,GAAQ,KAAA,EAAO,gBAAgB;AAAA;AAAA,UAGzB,qBAAA,SAA8B,aAAa;EAAA,SACjD,IAAA;EAjBA;EAAA,SAmBA,aAAA,QAAqB,qBAAA;AAAA;AAAA,cAGnB,qBAAA,GACX,OAAA,EAAS,4BAAA,KACR,qBA+BF;AAAA,cAmBY,mBAAA,GAAuB,cAAyC,EAAzB,yBAAyB"}

package/dist/index.mjs

@@ -0,0 +1,51 @@
+import { dirname, resolve } from "node:path";
+import { stageOpenTrayPackage } from "@opentray/packaging";
+//#region src/index.ts
+const openTrayEsbuildPlugin = (options) => {
+	let lastResult;
+	const plugin = {
+		name: "opentray-packaging",
+		setup(build) {
+			build.onEnd(async () => {
+				lastResult = await stageOpenTrayPackage({
+					app: options.app,
+					outDir: resolveEsbuildOutDir(options, build.initialOptions),
+					entry: options.entry ?? resolveEsbuildEntry(build.initialOptions),
+					adapter: {
+						name: "esbuild",
+						mode: options.mode ?? "production"
+					},
+					runtimeHost: options.runtimeHost,
+					...options.nativeArtifacts === void 0 ? {} : { nativeArtifacts: options.nativeArtifacts },
+					...options.companionAssets === void 0 ? {} : { companionAssets: options.companionAssets },
+					...options.manifestPath === void 0 ? {} : { manifestPath: options.manifestPath }
+				});
+			});
+		},
+		getLastResult: () => lastResult
+	};
+	Object.defineProperty(plugin, "getLastResult", { enumerable: false });
+	return plugin;
+};
+const resolveEsbuildOutDir = (options, initialOptions) => {
+	const cwd = initialOptions.absWorkingDir ?? process.cwd();
+	if (options.outDir !== void 0) return resolve(cwd, options.outDir);
+	if (initialOptions.outdir !== void 0 && initialOptions.outdir.length > 0) return resolve(cwd, initialOptions.outdir);
+	if (initialOptions.outfile !== void 0 && initialOptions.outfile.length > 0) return resolve(cwd, dirname(initialOptions.outfile));
+	return resolve(process.cwd(), "dist");
+};
+const resolveEsbuildEntry = (initialOptions) => {
+	const entryPoints = initialOptions.entryPoints;
+	if (entryPoints === void 0) throw new Error("OpenTray esbuild packaging requires esbuild entryPoints or an explicit entry option");
+	if (Array.isArray(entryPoints)) {
+		if (entryPoints.length === 0) throw new Error("OpenTray esbuild packaging requires esbuild entryPoints or an explicit entry option");
+		return entryPoints[0];
+	}
+	const first = Object.values(entryPoints)[0];
+	if (first === void 0) throw new Error("OpenTray esbuild packaging requires esbuild entryPoints or an explicit entry option");
+	return first;
+};
+//#endregion
+export { openTrayEsbuildPlugin, resolveEsbuildEntry };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { dirname, resolve } from \"node:path\";\n\nimport {\n  stageOpenTrayPackage,\n  type OpenTrayArtifactInput,\n  type OpenTrayPackagingApp,\n  type OpenTrayPackageManifest,\n  type OpenTrayPackageResult,\n} from \"@opentray/packaging\";\n\nexport interface OpenTrayEsbuildPluginOptions {\n  readonly app: OpenTrayPackagingApp;\n  readonly runtimeHost: OpenTrayArtifactInput;\n  readonly nativeArtifacts?: Readonly<Record<string, OpenTrayArtifactInput>>;\n  readonly companionAssets?: Readonly<Record<string, OpenTrayArtifactInput>>;\n  readonly entry?: string;\n  readonly manifestPath?: string;\n  /**\n   * Explicit outDir override. When omitted, resolved from the esbuild\n   * `outdir`/`outfile` option or defaults to `dist`.\n   */\n  readonly outDir?: string;\n  /**\n   * Explicit mode override. Defaults to `production`.\n   */\n  readonly mode?: string;\n}\n\n/**\n * Structural view of the esbuild initial options the adapter consumes. Only the\n * staging-relevant fields are declared, so esbuild never has to be imported.\n */\nexport interface EsbuildInitialOptionsLike {\n  readonly outdir?: string;\n  readonly outfile?: string;\n  readonly entryPoints?: readonly string[] | Readonly<Record<string, string>>;\n  readonly absWorkingDir?: string;\n}\n\nexport interface EsbuildBuildLike {\n  readonly initialOptions: EsbuildInitialOptionsLike;\n  onEnd(callback: (result: unknown) => Promise<void> | void): void;\n}\n\nexport interface EsbuildPlugin {\n  readonly name: string;\n  readonly setup: (build: EsbuildBuildLike) => void;\n}\n\nexport interface OpenTrayEsbuildPlugin extends EsbuildPlugin {\n  readonly name: \"opentray-packaging\";\n  /** Returns the last staging result. Only populated after `onEnd` runs. */\n  readonly getLastResult: () => OpenTrayPackageResult | undefined;\n}\n\nexport const openTrayEsbuildPlugin = (\n  options: OpenTrayEsbuildPluginOptions,\n): OpenTrayEsbuildPlugin => {\n  let lastResult: OpenTrayPackageResult | undefined;\n\n  // esbuild validates the enumerable own keys of a plugin object and rejects\n  // anything beyond { name, setup }. Keep `getLastResult` non-enumerable so the\n  // adapter can still expose the staging result to programmatic callers without\n  // tripping esbuild's plugin validation.\n  const plugin: OpenTrayEsbuildPlugin = {\n    name: \"opentray-packaging\",\n    setup(build) {\n      build.onEnd(async () => {\n        lastResult = await stageOpenTrayPackage({\n          app: options.app,\n          outDir: resolveEsbuildOutDir(options, build.initialOptions),\n          entry: options.entry ?? resolveEsbuildEntry(build.initialOptions),\n          adapter: { name: \"esbuild\", mode: options.mode ?? \"production\" },\n          runtimeHost: options.runtimeHost,\n          ...(options.nativeArtifacts === undefined\n            ? {}\n            : { nativeArtifacts: options.nativeArtifacts }),\n          ...(options.companionAssets === undefined\n            ? {}\n            : { companionAssets: options.companionAssets }),\n          ...(options.manifestPath === undefined ? {} : { manifestPath: options.manifestPath }),\n        });\n      });\n    },\n    getLastResult: () => lastResult,\n  };\n  Object.defineProperty(plugin, \"getLastResult\", { enumerable: false });\n  return plugin;\n};\n\nconst resolveEsbuildOutDir = (\n  options: OpenTrayEsbuildPluginOptions,\n  initialOptions: EsbuildInitialOptionsLike,\n): string => {\n  const cwd = initialOptions.absWorkingDir ?? process.cwd();\n  if (options.outDir !== undefined) {\n    return resolve(cwd, options.outDir);\n  }\n  if (initialOptions.outdir !== undefined && initialOptions.outdir.length > 0) {\n    return resolve(cwd, initialOptions.outdir);\n  }\n  if (initialOptions.outfile !== undefined && initialOptions.outfile.length > 0) {\n    return resolve(cwd, dirname(initialOptions.outfile));\n  }\n  return resolve(process.cwd(), \"dist\");\n};\n\nexport const resolveEsbuildEntry = (initialOptions: EsbuildInitialOptionsLike): string => {\n  const entryPoints = initialOptions.entryPoints;\n  if (entryPoints === undefined) {\n    throw new Error(\n      \"OpenTray esbuild packaging requires esbuild entryPoints or an explicit entry option\",\n    );\n  }\n  if (Array.isArray(entryPoints)) {\n    if (entryPoints.length === 0) {\n      throw new Error(\n        \"OpenTray esbuild packaging requires esbuild entryPoints or an explicit entry option\",\n      );\n    }\n    return entryPoints[0] as string;\n  }\n  const first = Object.values(entryPoints)[0];\n  if (first === undefined) {\n    throw new Error(\n      \"OpenTray esbuild packaging requires esbuild entryPoints or an explicit entry option\",\n    );\n  }\n  return first;\n};\n\nexport type { OpenTrayPackageManifest, OpenTrayPackageResult };\n"],"mappings":";;;AAuDA,MAAa,yBACX,YAC0B;CAC1B,IAAI;CAMJ,MAAM,SAAgC;EACpC,MAAM;EACN,MAAM,OAAO;GACX,MAAM,MAAM,YAAY;IACtB,aAAa,MAAM,qBAAqB;KACtC,KAAK,QAAQ;KACb,QAAQ,qBAAqB,SAAS,MAAM,cAAc;KAC1D,OAAO,QAAQ,SAAS,oBAAoB,MAAM,cAAc;KAChE,SAAS;MAAE,MAAM;MAAW,MAAM,QAAQ,QAAQ;KAAa;KAC/D,aAAa,QAAQ;KACrB,GAAI,QAAQ,oBAAoB,KAAA,IAC5B,CAAC,IACD,EAAE,iBAAiB,QAAQ,gBAAgB;KAC/C,GAAI,QAAQ,oBAAoB,KAAA,IAC5B,CAAC,IACD,EAAE,iBAAiB,QAAQ,gBAAgB;KAC/C,GAAI,QAAQ,iBAAiB,KAAA,IAAY,CAAC,IAAI,EAAE,cAAc,QAAQ,aAAa;IACrF,CAAC;GACH,CAAC;EACH;EACA,qBAAqB;CACvB;CACA,OAAO,eAAe,QAAQ,iBAAiB,EAAE,YAAY,MAAM,CAAC;CACpE,OAAO;AACT;AAEA,MAAM,wBACJ,SACA,mBACW;CACX,MAAM,MAAM,eAAe,iBAAiB,QAAQ,IAAI;CACxD,IAAI,QAAQ,WAAW,KAAA,GACrB,OAAO,QAAQ,KAAK,QAAQ,MAAM;CAEpC,IAAI,eAAe,WAAW,KAAA,KAAa,eAAe,OAAO,SAAS,GACxE,OAAO,QAAQ,KAAK,eAAe,MAAM;CAE3C,IAAI,eAAe,YAAY,KAAA,KAAa,eAAe,QAAQ,SAAS,GAC1E,OAAO,QAAQ,KAAK,QAAQ,eAAe,OAAO,CAAC;CAErD,OAAO,QAAQ,QAAQ,IAAI,GAAG,MAAM;AACtC;AAEA,MAAa,uBAAuB,mBAAsD;CACxF,MAAM,cAAc,eAAe;CACnC,IAAI,gBAAgB,KAAA,GAClB,MAAM,IAAI,MACR,qFACF;CAEF,IAAI,MAAM,QAAQ,WAAW,GAAG;EAC9B,IAAI,YAAY,WAAW,GACzB,MAAM,IAAI,MACR,qFACF;EAEF,OAAO,YAAY;CACrB;CACA,MAAM,QAAQ,OAAO,OAAO,WAAW,EAAE;CACzC,IAAI,UAAU,KAAA,GACZ,MAAM,IAAI,MACR,qFACF;CAEF,OAAO;AACT"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentray/esbuild-plugin",
-  "version": "0.1.0",
+  "version": "0.11.0",
   "description": "esbuild adapter for the OpenTray runtime artifact packaging contract.",
   "type": "module",
   "license": "MIT",
@@ -21,7 +21,7 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@opentray/packaging": "0.1.0"
+    "@opentray/packaging": "0.11.0"
   },
   "peerDependencies": {
     "esbuild": ">=0.20"