@elysiumjs/hephaestus 0.3.0 → 0.3.3

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @elysiumjs/hephaestus
 
+## 0.3.3
+
+### Patch Changes
+
+- [`04773f2`](https://github.com/na2axl/elysiumjs/commit/04773f2acd4ab1c762a80ee903715d90f1c08e21) Thanks [@na2axl](https://github.com/na2axl)! - Ship the type declarations. The packages pointed `types` at `dist/index.d.ts` but their build never wrote it, so TypeScript projects got no types for them.
+
+## 0.3.2
+
+### Patch Changes
+
+- Updated dependencies [[`68a0cdd`](https://github.com/na2axl/elysiumjs/commit/68a0cdd8b2e4a003d6e0af2d78985623cae40428), [`2c49acd`](https://github.com/na2axl/elysiumjs/commit/2c49acd3b552aa43765d70339fa216961499e1b5), [`76ba0ff`](https://github.com/na2axl/elysiumjs/commit/76ba0ff18f3c196cebc2189426328f67cb699f46), [`4ebf029`](https://github.com/na2axl/elysiumjs/commit/4ebf029611e6d753a4f1bfdbe247a75d954d9ded), [`bacce71`](https://github.com/na2axl/elysiumjs/commit/bacce7146f667a1a46bf474dc0344fb0111ae12a)]:
+  - @elysiumjs/core@0.10.0
+
+## 0.3.1
+
+### Patch Changes
+
+- Updated dependencies [[`5fef4a7`](https://github.com/na2axl/elysiumjs/commit/5fef4a7199f502fc4fe035299e7670739459a108)]:
+  - @elysiumjs/core@0.9.0
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/assets/embedder.d.ts

@@ -0,0 +1,38 @@
+import type { HephaestusConfig } from '../types';
+/**
+ * Manifest mapping asset paths to their base64 content and MIME type.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export interface AssetManifest {
+    [path: string]: {
+        content: string;
+        mimeType: string;
+    };
+}
+/**
+ * Embeds assets into a generated loader module for use in compiled binaries.
+ *
+ * For static assets known at development time, prefer Bun's native file embedding:
+ * ```typescript
+ * import icon from './icon.png' with { type: 'file' };
+ * const bytes = await Bun.file(icon).arrayBuffer();
+ * ```
+ *
+ * This class is for dynamic glob-based embedding from config.
+ *
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class AssetEmbedder {
+    private config;
+    constructor(config: HephaestusConfig);
+    /**
+     * Scans for assets matching the config patterns and generates a loader module.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @returns A string containing the generated asset loader module.
+     */
+    embed(): Promise<string>;
+    private buildManifest;
+    private isExcluded;
+    private generateLoader;
+    private getMimeType;
+}

package/dist/assets/index.d.ts

@@ -0,0 +1 @@
+export { type AssetManifest, AssetEmbedder } from './embedder';

package/dist/builder/binary.builder.d.ts

@@ -0,0 +1,32 @@
+import type { HephaestusConfig, PlatformTarget } from '../types';
+/**
+ * Result of a single binary compilation.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export interface BuildResult {
+    platform: PlatformTarget;
+    outputPath: string;
+    size: number;
+    duration: number;
+}
+/**
+ * Compiles Elysium projects into single-binary executables using Bun.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class BinaryBuilder {
+    private config;
+    constructor(config: HephaestusConfig);
+    /**
+     * Builds a single binary for a specific platform, or the current one if not specified.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param platform The target platform. Defaults to the current platform.
+     * @returns The build result with metrics.
+     */
+    build(platform?: PlatformTarget): Promise<BuildResult>;
+    /**
+     * Builds binaries for all configured platforms, or the current one if none are configured.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @returns An array of build results.
+     */
+    buildAll(): Promise<BuildResult[]>;
+}

package/dist/builder/index.d.ts

@@ -0,0 +1 @@
+export { type BuildResult, BinaryBuilder } from './binary.builder';

package/dist/commands/build.command.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@elysiumjs/core';
+/**
+ * Command used to build the project into a standalone binary.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class HephaestusBuildCommand extends Command {
+    static readonly command: string;
+    static readonly description: string;
+    static readonly dev: boolean;
+    private platform?;
+    private allPlatforms;
+    run(): Promise<void>;
+    private formatSize;
+}

package/dist/commands/docker.command.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@elysiumjs/core';
+/**
+ * Command used to generate a Dockerfile for the compiled binary.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class HephaestusDockerCommand extends Command {
+    static readonly command: string;
+    static readonly description: string;
+    static readonly dev: boolean;
+    private output;
+    run(): Promise<void>;
+}

package/dist/commands/docker.generator.d.ts

@@ -0,0 +1,20 @@
+import type { HephaestusConfig } from '../types';
+/**
+ * Generates a multi-stage Dockerfile for compiled Elysium binaries.
+ *
+ * The runtime stage uses Alpine (not Bun) because the compiled binary
+ * is self-contained. Healthcheck uses `wget` (available in Alpine base).
+ *
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class DockerGenerator {
+    private config;
+    constructor(config: HephaestusConfig);
+    /**
+     * Generates the Dockerfile and writes it to the output directory.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param outputDir The directory to write the Dockerfile to.
+     */
+    generate(outputDir: string): void;
+    private renderDockerfile;
+}

package/dist/commands/embed.command.d.ts

@@ -0,0 +1,11 @@
+import { Command } from '@elysiumjs/core';
+/**
+ * Command used to generate asset loader module from configured patterns.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class HephaestusEmbedCommand extends Command {
+    static readonly command: string;
+    static readonly description: string;
+    static readonly dev: boolean;
+    run(): Promise<void>;
+}

package/dist/commands/index.d.ts

@@ -0,0 +1,3 @@
+export * from './build.command';
+export * from './embed.command';
+export * from './docker.command';

package/dist/config/index.d.ts

@@ -0,0 +1 @@
+export { loadConfig } from './loader';

package/dist/config/loader.d.ts

@@ -0,0 +1,8 @@
+import type { HephaestusConfig } from '../types';
+/**
+ * Loads and validates the Hephaestus build configuration from the project root.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param cwd The working directory to search for config files.
+ * @returns The validated configuration.
+ */
+export declare function loadConfig(cwd?: string): Promise<HephaestusConfig>;

package/dist/hephaestus.module.d.ts

@@ -0,0 +1,7 @@
+import { Module } from '@elysiumjs/core';
+/**
+ * Exposes the Hephaestus build tooling commands.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class HephaestusModule extends Module {
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { HephaestusModule } from './hephaestus.module';
+export type { HephaestusConfig, PlatformTarget } from './types';
+export { HephaestusConfigSchema, PlatformTargetSchema } from './types';
+export type { BuildResult } from './builder';
+export { BinaryBuilder } from './builder';
+export type { AssetManifest } from './assets';
+export { AssetEmbedder } from './assets';
+export { DockerGenerator } from './commands/docker.generator';
+export { loadConfig } from './config';
+export { bunTarget, detectCurrentPlatform, getOutputName } from './platform';

package/dist/platform/index.d.ts

@@ -0,0 +1 @@
+export { bunTarget, detectCurrentPlatform, getOutputName } from './targets';

package/dist/platform/targets.d.ts

@@ -0,0 +1,22 @@
+import type { PlatformTarget } from '../types';
+/**
+ * Converts a Hephaestus platform target to a Bun target string.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param platform The Hephaestus platform target.
+ * @returns The Bun `--target` value.
+ */
+export declare function bunTarget(platform: PlatformTarget): string;
+/**
+ * Detects the current platform and returns the corresponding target.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @returns The detected platform target.
+ */
+export declare function detectCurrentPlatform(): PlatformTarget;
+/**
+ * Returns the output file name for a given platform.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param baseName The base binary name.
+ * @param platform The target platform.
+ * @returns The platform-specific output file name.
+ */
+export declare function getOutputName(baseName: string, platform: PlatformTarget): string;

package/dist/types.d.ts

@@ -0,0 +1,72 @@
+import { z } from 'zod';
+/**
+ * Supported compilation target platforms.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare const PlatformTargetSchema: z.ZodEnum<{
+    "darwin-arm64": "darwin-arm64";
+    "darwin-x64": "darwin-x64";
+    "linux-arm64": "linux-arm64";
+    "linux-x64": "linux-x64";
+    "linux-x64-baseline": "linux-x64-baseline";
+    "windows-x64": "windows-x64";
+}>;
+/**
+ * A supported compilation target platform.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type PlatformTarget = z.infer<typeof PlatformTargetSchema>;
+/**
+ * Hephaestus build configuration schema.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare const HephaestusConfigSchema: z.ZodObject<{
+    entry: z.ZodDefault<z.ZodString>;
+    output: z.ZodObject<{
+        name: z.ZodString;
+        dir: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>;
+    platforms: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        "darwin-arm64": "darwin-arm64";
+        "darwin-x64": "darwin-x64";
+        "linux-arm64": "linux-arm64";
+        "linux-x64": "linux-x64";
+        "linux-x64-baseline": "linux-x64-baseline";
+        "windows-x64": "windows-x64";
+    }>>>;
+    build: z.ZodPrefault<z.ZodObject<{
+        minify: z.ZodDefault<z.ZodBoolean>;
+        sourcemap: z.ZodDefault<z.ZodBoolean>;
+        bytecode: z.ZodDefault<z.ZodBoolean>;
+        split: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    assets: z.ZodPrefault<z.ZodObject<{
+        embed: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        exclude: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+    env: z.ZodPrefault<z.ZodObject<{
+        generateExample: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    docker: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+        buildImage: z.ZodDefault<z.ZodString>;
+        runtimeImage: z.ZodDefault<z.ZodString>;
+        expose: z.ZodDefault<z.ZodArray<z.ZodNumber>>;
+        healthcheck: z.ZodOptional<z.ZodObject<{
+            path: z.ZodDefault<z.ZodString>;
+            interval: z.ZodDefault<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    release: z.ZodOptional<z.ZodObject<{
+        include: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        compress: z.ZodDefault<z.ZodEnum<{
+            "tar.gz": "tar.gz";
+            zip: "zip";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Hephaestus build configuration.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type HephaestusConfig = z.infer<typeof HephaestusConfigSchema>;

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@elysiumjs/hephaestus",
-  "version": "0.3.0",
+  "version": "0.3.3",
   "license": "Apache-2.0",
   "description": "Compilation and bundling utilities for Elysium.js apps.",
   "private": false,
   "author": "Workbud Technologies Inc.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/workbud/elysium"
+    "url": "git+https://github.com/na2axl/elysiumjs.git",
+    "directory": "@elysiumjs/hephaestus"
   },
   "keywords": [
     "elysium",
@@ -19,12 +20,19 @@
     "compilation",
     "bun"
   ],
-  "homepage": "https://github.com/workbud/elysium",
-  "module": "index.ts",
+  "homepage": "https://github.com/na2axl/elysiumjs/tree/main/@elysiumjs/hephaestus#readme",
+  "bugs": {
+    "url": "https://github.com/na2axl/elysiumjs/issues"
+  },
+  "module": "dist/index.js",
   "type": "module",
   "sideEffects": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
   "scripts": {
     "format": "prettier --write \"./src/**/*.ts\"",
     "clean": "rimraf dist",
@@ -40,9 +48,9 @@
     "zod": "^4.6.7"
   },
   "devDependencies": {
-    "@elysiumjs/core": "0.8.0"
+    "@elysiumjs/core": "0.10.0"
   },
   "peerDependencies": {
-    "@elysiumjs/core": "^0.8.0"
+    "@elysiumjs/core": "^0.10.0"
   }
 }