@savvy-web/github-action-builder 0.7.4 → 0.7.5

package/index.js

@@ -1,134 +1,10 @@
-import { Effect, ManagedRuntime, Schema } from "effect";
-import { AppLayer, BuildService, ConfigService, ValidationService, ValidationResultSchema, BuildResultSchema, PersistLocalResultSchema, defineConfig, PersistLocalService } from "./948.js";
-const GitHubActionBuildResultSchema = Schema.Struct({
-    success: Schema.Boolean,
-    build: Schema.optional(BuildResultSchema),
-    validation: Schema.optional(ValidationResultSchema),
-    persistLocal: Schema.optional(PersistLocalResultSchema),
-    error: Schema.optional(Schema.String),
-    cause: Schema.optional(Schema.Unknown)
-});
-class GitHubAction {
-    runtime;
-    config = null;
-    cwd;
-    configSource;
-    skipValidation;
-    clean;
-    constructor(options = {}){
-        const layer = options.layer ?? AppLayer;
-        this.runtime = ManagedRuntime.make(layer);
-        this.configSource = options.config;
-        this.cwd = options.cwd ?? process.cwd();
-        this.skipValidation = options.skipValidation ?? false;
-        this.clean = options.clean ?? true;
-    }
-    static create(options = {}) {
-        return new GitHubAction(options);
-    }
-    async loadConfig() {
-        if (this.config) return this.config;
-        const configSource = this.configSource;
-        const cwd = this.cwd;
-        const program = Effect.gen(function*() {
-            const configService = yield* ConfigService;
-            if ("string" == typeof configSource) {
-                const result = yield* configService.load({
-                    cwd,
-                    configPath: configSource
-                });
-                return result.config;
-            }
-            if (configSource) return defineConfig(configSource);
-            const result = yield* configService.load({
-                cwd
-            });
-            return result.config;
-        });
-        const config = await this.runtime.runPromise(program);
-        this.config = config;
-        return config;
-    }
-    async validate(options = {}) {
-        const config = await this.loadConfig();
-        const cwd = this.cwd;
-        const program = Effect.gen(function*() {
-            const validationService = yield* ValidationService;
-            return yield* validationService.validate(config, {
-                cwd,
-                ...options
-            });
-        });
-        return this.runtime.runPromise(program);
-    }
-    async build() {
-        try {
-            const config = await this.loadConfig();
-            let validationResult;
-            if (!this.skipValidation) {
-                validationResult = await this.validate();
-                if (!validationResult.valid) return {
-                    success: false,
-                    validation: validationResult,
-                    error: "Validation failed"
-                };
-            }
-            const cwd = this.cwd;
-            const clean = this.clean;
-            const program = Effect.gen(function*() {
-                const buildService = yield* BuildService;
-                const buildOptions = {
-                    cwd,
-                    clean
-                };
-                return yield* buildService.build(config, buildOptions);
-            });
-            const buildResult = await this.runtime.runPromise(program);
-            if (!buildResult.success) {
-                if (validationResult) return {
-                    success: false,
-                    build: buildResult,
-                    validation: validationResult,
-                    error: buildResult.error ?? "Build failed"
-                };
-                return {
-                    success: false,
-                    build: buildResult,
-                    error: buildResult.error ?? "Build failed"
-                };
-            }
-            let persistLocalResult;
-            if (config.persistLocal.enabled) {
-                const persistProgram = Effect.gen(function*() {
-                    const persistLocalService = yield* PersistLocalService;
-                    return yield* persistLocalService.persist(config, {
-                        cwd
-                    });
-                });
-                persistLocalResult = await this.runtime.runPromise(persistProgram);
-            }
-            if (validationResult) return {
-                success: true,
-                build: buildResult,
-                validation: validationResult,
-                persistLocal: persistLocalResult
-            };
-            return {
-                success: true,
-                build: buildResult,
-                persistLocal: persistLocalResult
-            };
-        } catch (error) {
-            return {
-                success: false,
-                error: error instanceof Error ? error.message : "Unknown error",
-                cause: error
-            };
-        }
-    }
-    async dispose() {
-        await this.runtime.dispose();
-    }
-}
-export { ActionYmlMissing, ActionYmlMissingBase, ActionYmlPathError, ActionYmlPathErrorBase, ActionYmlResultSchema, ActionYmlSchemaError, ActionYmlSchemaErrorBase, ActionYmlSyntaxError, ActionYmlSyntaxErrorBase, AppLayer, BuildFailed, BuildFailedBase, BuildLayer, BuildOptionsSchema, BuildResultSchema, BuildRunnerOptionsSchema, BuildService, BundleFailed, BundleFailedBase, BundleResultSchema, BundleStatsSchema, CleanError, CleanErrorBase, ConfigInputSchema, ConfigInvalid, ConfigInvalidBase, ConfigLayer, ConfigLoadFailed, ConfigLoadFailedBase, ConfigNotFound, ConfigNotFoundBase, ConfigSchema, ConfigService, DetectEntriesResultSchema, DetectedEntrySchema, EntriesSchema, EntryFileMissing, EntryFileMissingBase, LoadConfigOptionsSchema, MainEntryMissing, MainEntryMissingBase, PersistLocalError, PersistLocalErrorBase, PersistLocalLayer, PersistLocalOptionsSchema, PersistLocalResultSchema, PersistLocalRunnerOptionsSchema, PersistLocalService, ValidateOptionsSchema, ValidationErrorSchema, ValidationFailed, ValidationFailedBase, ValidationLayer, ValidationOptionsSchema, ValidationResultSchema, ValidationService, ValidationWarningSchema, WriteError, WriteErrorBase, defineConfig } from "./948.js";
-export { GitHubAction, GitHubActionBuildResultSchema };
+import { ActionYmlMissing, ActionYmlMissingBase, ActionYmlPathError, ActionYmlPathErrorBase, ActionYmlSchemaError, ActionYmlSchemaErrorBase, ActionYmlSyntaxError, ActionYmlSyntaxErrorBase, BuildFailed, BuildFailedBase, BundleFailed, BundleFailedBase, CleanError, CleanErrorBase, ConfigInvalid, ConfigInvalidBase, ConfigLoadFailed, ConfigLoadFailedBase, ConfigNotFound, ConfigNotFoundBase, EntryFileMissing, EntryFileMissingBase, MainEntryMissing, MainEntryMissingBase, PersistLocalError, PersistLocalErrorBase, ValidationFailed, ValidationFailedBase, WriteError, WriteErrorBase } from "./errors.js";
+import { BuildResultSchema, BuildRunnerOptionsSchema, BuildService, BundleResultSchema, BundleStatsSchema } from "./services/build.js";
+import { BuildOptionsSchema, ConfigInputSchema, ConfigSchema, EntriesSchema, PersistLocalOptionsSchema, ValidationOptionsSchema, defineConfig } from "./schemas/config.js";
+import { ConfigService, DetectEntriesResultSchema, DetectedEntrySchema, LoadConfigOptionsSchema } from "./services/config.js";
+import { PersistLocalResultSchema, PersistLocalRunnerOptionsSchema, PersistLocalService } from "./services/persist-local.js";
+import { ActionYmlResultSchema, ValidateOptionsSchema, ValidationErrorSchema, ValidationResultSchema, ValidationService, ValidationWarningSchema } from "./services/validation.js";
+import { AppLayer, BuildLayer, ConfigLayer, PersistLocalLayer, ValidationLayer } from "./layers/app.js";
+import { GitHubAction, GitHubActionBuildResultSchema } from "./github-action.js";
+
+export { ActionYmlMissing, ActionYmlMissingBase, ActionYmlPathError, ActionYmlPathErrorBase, ActionYmlResultSchema, ActionYmlSchemaError, ActionYmlSchemaErrorBase, ActionYmlSyntaxError, ActionYmlSyntaxErrorBase, AppLayer, BuildFailed, BuildFailedBase, BuildLayer, BuildOptionsSchema, BuildResultSchema, BuildRunnerOptionsSchema, BuildService, BundleFailed, BundleFailedBase, BundleResultSchema, BundleStatsSchema, CleanError, CleanErrorBase, ConfigInputSchema, ConfigInvalid, ConfigInvalidBase, ConfigLayer, ConfigLoadFailed, ConfigLoadFailedBase, ConfigNotFound, ConfigNotFoundBase, ConfigSchema, ConfigService, DetectEntriesResultSchema, DetectedEntrySchema, EntriesSchema, EntryFileMissing, EntryFileMissingBase, GitHubAction, GitHubActionBuildResultSchema, LoadConfigOptionsSchema, MainEntryMissing, MainEntryMissingBase, PersistLocalError, PersistLocalErrorBase, PersistLocalLayer, PersistLocalOptionsSchema, PersistLocalResultSchema, PersistLocalRunnerOptionsSchema, PersistLocalService, ValidateOptionsSchema, ValidationErrorSchema, ValidationFailed, ValidationFailedBase, ValidationLayer, ValidationOptionsSchema, ValidationResultSchema, ValidationService, ValidationWarningSchema, WriteError, WriteErrorBase, defineConfig };

package/layers/app.js

@@ -0,0 +1,83 @@
+import { BuildServiceLive } from "../services/build-live.js";
+import { ConfigServiceLive } from "../services/config-live.js";
+import { PersistLocalServiceLive } from "../services/persist-local-live.js";
+import { ValidationServiceLive } from "../services/validation-live.js";
+import { Layer } from "effect";
+
+//#region src/layers/app.ts
+/**
+* Application Layer composition.
+*
+* @remarks
+* Composes all service layers into a single application layer for use
+* with Effect programs. These layers provide the runtime implementations
+* of the service interfaces.
+*/
+/**
+* Layer providing ConfigService (no dependencies).
+*
+* @remarks
+* Use this layer when you only need configuration management.
+*
+* @public
+*/
+const ConfigLayer = ConfigServiceLive;
+/**
+* Layer providing ValidationService (depends on ConfigService).
+*
+* @remarks
+* Includes ConfigService automatically.
+*
+* @public
+*/
+const ValidationLayer = ValidationServiceLive.pipe(Layer.provide(ConfigServiceLive));
+/**
+* Layer providing BuildService (depends on ConfigService).
+*
+* @remarks
+* Includes ConfigService automatically.
+*
+* @public
+*/
+const BuildLayer = BuildServiceLive.pipe(Layer.provide(ConfigServiceLive));
+/**
+* Layer providing PersistLocalService (no dependencies).
+*
+* @remarks
+* Use this layer when you only need persist-local functionality.
+*
+* @public
+*/
+const PersistLocalLayer = PersistLocalServiceLive;
+/**
+* Combined layer providing all services.
+*
+* @remarks
+* This layer composes ConfigService, ValidationService, BuildService,
+* and PersistLocalService.
+* Use this when you need access to all services in your Effect program.
+*
+* @example Using AppLayer with Effect
+* ```typescript
+* import { Effect } from "effect";
+* import { AppLayer, BuildService, ConfigService } from "@savvy-web/github-action-builder";
+*
+* const program = Effect.gen(function* () {
+*   const configService = yield* ConfigService;
+*   const buildService = yield* BuildService;
+*
+*   const { config } = yield* configService.load();
+*   const result = yield* buildService.build(config);
+*
+*   return result;
+* });
+*
+* Effect.runPromise(program.pipe(Effect.provide(AppLayer)));
+* ```
+*
+* @public
+*/
+const AppLayer = Layer.mergeAll(ConfigServiceLive, ValidationLayer, BuildLayer, PersistLocalLayer);
+
+//#endregion
+export { AppLayer, BuildLayer, ConfigLayer, PersistLocalLayer, ValidationLayer };

package/package.json

@@ -1,92 +1,76 @@
 {
-  "name": "@savvy-web/github-action-builder",
-  "version": "0.7.4",
-  "private": false,
-  "description": "A zero-config build tool for creating GitHub Actions from TypeScript. Bundles with rsbuild, validates action.yml against GitHub's schema, and outputs production-ready Node.js 24 actions.",
-  "keywords": [
-    "github-actions",
-    "github",
-    "actions",
-    "rsbuild",
-    "rspack",
-    "bundler",
-    "typescript",
-    "node24",
-    "cli",
-    "build-tool",
-    "action-builder",
-    "effect-ts",
-    "esm"
-  ],
-  "homepage": "https://github.com/savvy-web/systems/tree/main/packages/github-action-builder",
-  "bugs": {
-    "url": "https://github.com/savvy-web/systems/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/savvy-web/systems.git",
-    "directory": "packages/github-action-builder"
-  },
-  "license": "MIT",
-  "author": {
-    "name": "C. Spencer Beggs",
-    "email": "spencer@savvyweb.systems",
-    "url": "https://savvyweb.systems"
-  },
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js"
-    },
-    "./tsconfig/action.json": "./tsconfig/action.json"
-  },
-  "bin": {
-    "github-action-builder": "bin/github-action-builder.js"
-  },
-  "dependencies": {
-    "@effect/cli": "^0.75.1",
-    "@effect/platform": "^0.96.1",
-    "@effect/platform-node": "^0.106.0",
-    "@effect/printer": "^0.49.0",
-    "@effect/printer-ansi": "^0.49.0",
-    "@effect/typeclass": "^0.40.0",
-    "@rsbuild/core": "^2.0.9",
-    "effect": "^3.21.2",
-    "jiti": "^2.7.0",
-    "picocolors": "^1.1.1",
-    "yaml-effect": "^0.6.0"
-  },
-  "peerDependencies": {
-    "@types/node": "^25.9.0",
-    "@typescript/native-preview": "^7.0.0-dev.20260513.1",
-    "typescript": "^6.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@types/node": {
-      "optional": false
-    },
-    "@typescript/native-preview": {
-      "optional": false
-    },
-    "typescript": {
-      "optional": false
-    }
-  },
-  "files": [
-    "!github-action-builder.api.json",
-    "!tsconfig.json",
-    "!tsdoc.json",
-    "231.js",
-    "612.js",
-    "948.js",
-    "LICENSE",
-    "README.md",
-    "bin/github-action-builder.js",
-    "index.d.ts",
-    "index.js",
-    "package.json",
-    "tsconfig/action.json",
-    "tsdoc-metadata.json"
-  ]
+	"name": "@savvy-web/github-action-builder",
+	"version": "0.7.5",
+	"private": false,
+	"description": "A zero-config build tool for creating GitHub Actions from TypeScript. Bundles with rsbuild, validates action.yml against GitHub's schema, and outputs production-ready Node.js 24 actions.",
+	"keywords": [
+		"github-actions",
+		"github",
+		"actions",
+		"rsbuild",
+		"rspack",
+		"bundler",
+		"typescript",
+		"node24",
+		"cli",
+		"build-tool",
+		"action-builder",
+		"effect-ts",
+		"esm"
+	],
+	"homepage": "https://github.com/savvy-web/systems/tree/main/packages/github-action-builder",
+	"bugs": {
+		"url": "https://github.com/savvy-web/systems/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/savvy-web/systems.git",
+		"directory": "packages/github-action-builder"
+	},
+	"license": "MIT",
+	"author": {
+		"name": "C. Spencer Beggs",
+		"email": "spencer@savvyweb.systems",
+		"url": "https://savvyweb.systems"
+	},
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"import": "./index.js"
+		},
+		"./tsconfig/action.json": "./public/tsconfig/action.json"
+	},
+	"bin": {
+		"github-action-builder": "bin/github-action-builder.js"
+	},
+	"dependencies": {
+		"@effect/cli": "^0.75.1",
+		"@effect/platform": "^0.96.1",
+		"@effect/platform-node": "^0.106.0",
+		"@effect/printer": "^0.49.0",
+		"@effect/printer-ansi": "^0.49.0",
+		"@effect/typeclass": "^0.40.0",
+		"@rsbuild/core": "^2.0.9",
+		"effect": "^3.21.2",
+		"jiti": "^2.7.0",
+		"picocolors": "^1.1.1",
+		"yaml-effect": "^0.6.0"
+	},
+	"peerDependencies": {
+		"@types/node": "^25.9.0",
+		"@typescript/native-preview": "^7.0.0-dev.20260513.1",
+		"typescript": "^6.0.0"
+	},
+	"peerDependenciesMeta": {
+		"@types/node": {
+			"optional": false
+		},
+		"@typescript/native-preview": {
+			"optional": false
+		},
+		"typescript": {
+			"optional": false
+		}
+	}
 }

package/schemas/action-yml.js

@@ -0,0 +1,110 @@
+import { Schema } from "effect";
+
+//#region src/schemas/action-yml.ts
+/**
+* GitHub Action action.yml schema validation using Effect Schema.
+*
+* @remarks
+* Validates structure according to GitHub's action.yml specification.
+* Based on the official JSON Schema from SchemaStore.
+*
+* @see {@link https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions | GitHub Actions metadata syntax}
+* @see {@link https://github.com/SchemaStore/schemastore/blob/master/src/schemas/json/github-action.json | Official JSON Schema}
+*
+* @internal
+*/
+/**
+* Valid Feather icons for GitHub Action branding.
+*
+* @remarks
+* Complete list from the official GitHub Actions schema.
+*
+* @internal
+*/
+const BrandingIcon = Schema.Literal("activity", "airplay", "alert-circle", "alert-octagon", "alert-triangle", "align-center", "align-justify", "align-left", "align-right", "anchor", "aperture", "archive", "arrow-down-circle", "arrow-down-left", "arrow-down-right", "arrow-down", "arrow-left-circle", "arrow-left", "arrow-right-circle", "arrow-right", "arrow-up-circle", "arrow-up-left", "arrow-up-right", "arrow-up", "at-sign", "award", "bar-chart-2", "bar-chart", "battery-charging", "battery", "bell-off", "bell", "bluetooth", "bold", "book-open", "book", "bookmark", "box", "briefcase", "calendar", "camera-off", "camera", "cast", "check-circle", "check-square", "check", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "chevrons-down", "chevrons-left", "chevrons-right", "chevrons-up", "circle", "clipboard", "clock", "cloud-drizzle", "cloud-lightning", "cloud-off", "cloud-rain", "cloud-snow", "cloud", "code", "command", "compass", "copy", "corner-down-left", "corner-down-right", "corner-left-down", "corner-left-up", "corner-right-down", "corner-right-up", "corner-up-left", "corner-up-right", "cpu", "credit-card", "crop", "crosshair", "database", "delete", "disc", "dollar-sign", "download-cloud", "download", "droplet", "edit-2", "edit-3", "edit", "external-link", "eye-off", "eye", "fast-forward", "feather", "file-minus", "file-plus", "file-text", "file", "film", "filter", "flag", "folder-minus", "folder-plus", "folder", "gift", "git-branch", "git-commit", "git-merge", "git-pull-request", "globe", "grid", "hard-drive", "hash", "headphones", "heart", "help-circle", "home", "image", "inbox", "info", "italic", "layers", "layout", "life-buoy", "link-2", "link", "list", "loader", "lock", "log-in", "log-out", "mail", "map-pin", "map", "maximize-2", "maximize", "menu", "message-circle", "message-square", "mic-off", "mic", "minimize-2", "minimize", "minus-circle", "minus-square", "minus", "monitor", "moon", "more-horizontal", "more-vertical", "move", "music", "navigation-2", "navigation", "octagon", "package", "paperclip", "pause-circle", "pause", "percent", "phone-call", "phone-forwarded", "phone-incoming", "phone-missed", "phone-off", "phone-outgoing", "phone", "pie-chart", "play-circle", "play", "plus-circle", "plus-square", "plus", "pocket", "power", "printer", "radio", "refresh-ccw", "refresh-cw", "repeat", "rewind", "rotate-ccw", "rotate-cw", "rss", "save", "scissors", "search", "send", "server", "settings", "share-2", "share", "shield-off", "shield", "shopping-bag", "shopping-cart", "shuffle", "sidebar", "skip-back", "skip-forward", "slash", "sliders", "smartphone", "speaker", "square", "star", "stop-circle", "sun", "sunrise", "sunset", "table", "tablet", "tag", "target", "terminal", "thermometer", "thumbs-down", "thumbs-up", "toggle-left", "toggle-right", "trash-2", "trash", "trending-down", "trending-up", "triangle", "truck", "tv", "type", "umbrella", "underline", "unlock", "upload-cloud", "upload", "user-check", "user-minus", "user-plus", "user-x", "user", "users", "video-off", "video", "voicemail", "volume-1", "volume-2", "volume-x", "volume", "watch", "wifi-off", "wifi", "wind", "x-circle", "x-square", "x", "zap-off", "zap", "zoom-in", "zoom-out");
+/**
+* Schema for action input definition.
+*
+* @remarks
+* According to the official schema, `description` is required.
+*
+* @internal
+*/
+const ActionInput = Schema.Struct({
+	description: Schema.String,
+	required: Schema.optional(Schema.Boolean),
+	default: Schema.optional(Schema.String),
+	deprecationMessage: Schema.optional(Schema.String)
+});
+/**
+* Schema for action output definition (Docker/JavaScript actions).
+*
+* @remarks
+* According to the official schema, `description` is required.
+*
+* @internal
+*/
+const ActionOutput = Schema.Struct({ description: Schema.String });
+/**
+* Schema for Node.js action runs configuration.
+*
+* @remarks
+* This tool builds Node.js 24 actions exclusively. The `using` field
+* is fixed to `node24`.
+*
+* @internal
+*/
+const Runs = Schema.Struct({
+	using: Schema.Literal("node24"),
+	main: Schema.String,
+	pre: Schema.optional(Schema.String),
+	"pre-if": Schema.optional(Schema.String),
+	post: Schema.optional(Schema.String),
+	"post-if": Schema.optional(Schema.String)
+});
+/**
+* Valid branding colors for GitHub Marketplace.
+*
+* @remarks
+* Complete list from the official schema.
+*
+* @internal
+*/
+const BrandingColor = Schema.Literal("white", "black", "yellow", "blue", "green", "orange", "red", "purple", "gray-dark");
+/**
+* Schema for branding configuration.
+* @internal
+*/
+const Branding = Schema.Struct({
+	icon: Schema.optional(BrandingIcon),
+	color: Schema.optional(BrandingColor)
+});
+/**
+* Complete action.yml schema.
+*
+* @remarks
+* This schema validates the structure of action.yml files according to
+* GitHub's metadata syntax specification. Note that the official schema
+* uses `patternProperties` for inputs/outputs key validation which cannot
+* be directly represented in Effect Schema.
+*
+* @internal
+*/
+const ActionYml = Schema.Struct({
+	name: Schema.String,
+	description: Schema.String,
+	author: Schema.optional(Schema.String),
+	inputs: Schema.optional(Schema.Record({
+		key: Schema.String,
+		value: ActionInput
+	})),
+	outputs: Schema.optional(Schema.Record({
+		key: Schema.String,
+		value: ActionOutput
+	})),
+	runs: Runs,
+	branding: Schema.optional(Branding)
+});
+
+//#endregion
+export { ActionYml };