@savvy-web/mcp 1.3.3 → 1.3.4

package/public/content/packages/github-action-builder/api/class/persistlocalerror.md

@@ -0,0 +1,39 @@
+---
+id: packages/github-action-builder/api/class/persistlocalerror
+title: "PersistLocalError — github-action-builder class"
+summary: "Error when persisting build output to local action directory fails."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# PersistLocalError
+
+Error when persisting build output to local action directory fails.
+
+```ts
+class PersistLocalError extends PersistLocalErrorBase<{
+  readonly path: string;
+  readonly cause: unknown;
+}>
+```
+
+## Members
+
+### cause
+
+```ts
+readonly cause: unknown;
+```
+
+The underlying error or error message.
+
+### path
+
+```ts
+readonly path: string;
+```
+
+The path involved in the failure.

package/public/content/packages/github-action-builder/api/class/validationfailed.md

@@ -0,0 +1,48 @@
+---
+id: packages/github-action-builder/api/class/validationfailed
+title: "ValidationFailed — github-action-builder class"
+summary: "Error when validation fails in strict mode (CI environment)."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# ValidationFailed
+
+Error when validation fails in strict mode (CI environment).
+
+```ts
+class ValidationFailed extends ValidationFailedBase<{
+  readonly errorCount: number;
+  readonly warningCount: number;
+  readonly message: string;
+}>
+```
+
+## Members
+
+### errorCount
+
+```ts
+readonly errorCount: number;
+```
+
+Number of errors encountered.
+
+### message
+
+```ts
+readonly message: string;
+```
+
+Formatted validation result message.
+
+### warningCount
+
+```ts
+readonly warningCount: number;
+```
+
+Number of warnings encountered.

package/public/content/packages/github-action-builder/api/class/workerentryinvalidname.md

@@ -0,0 +1,37 @@
+---
+id: packages/github-action-builder/api/class/workerentryinvalidname
+title: "WorkerEntryInvalidName — github-action-builder class"
+summary: "Error when a worker entry name is reserved or path-unsafe."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# WorkerEntryInvalidName
+
+Error when a worker entry name is reserved or path-unsafe.
+
+```ts
+class WorkerEntryInvalidName extends WorkerEntryInvalidNameBase<{
+  readonly workerName: string; /** Why the name was rejected. */
+  readonly reason: string;
+}>
+```
+
+## Members
+
+### reason
+
+```ts
+readonly reason: string;
+```
+
+### workerName
+
+```ts
+readonly workerName: string;
+```
+
+The offending worker name (config key).

package/public/content/packages/github-action-builder/api/class/workerentrymissing.md

@@ -0,0 +1,44 @@
+---
+id: packages/github-action-builder/api/class/workerentrymissing
+title: "WorkerEntryMissing — github-action-builder class"
+summary: "Error when a worker entry source file is not found."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# WorkerEntryMissing
+
+Error when a worker entry source file is not found.
+
+```ts
+class WorkerEntryMissing extends WorkerEntryMissingBase<{
+  readonly workerName: string; /** The expected path for the worker entry. */
+  readonly expectedPath: string; /** The working directory that was searched. */
+  readonly cwd: string;
+}>
+```
+
+## Members
+
+### cwd
+
+```ts
+readonly cwd: string;
+```
+
+### expectedPath
+
+```ts
+readonly expectedPath: string;
+```
+
+### workerName
+
+```ts
+readonly workerName: string;
+```
+
+The worker name (config key).

package/public/content/packages/github-action-builder/api/class/writeerror.md

@@ -0,0 +1,39 @@
+---
+id: packages/github-action-builder/api/class/writeerror
+title: "WriteError — github-action-builder class"
+summary: "Error when writing output files fails."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# WriteError
+
+Error when writing output files fails.
+
+```ts
+class WriteError extends WriteErrorBase<{
+  readonly path: string;
+  readonly cause: unknown;
+}>
+```
+
+## Members
+
+### cause
+
+```ts
+readonly cause: unknown;
+```
+
+The underlying error or error message.
+
+### path
+
+```ts
+readonly path: string;
+```
+
+The path that failed to write.

package/public/content/packages/github-action-builder/api/function/defineconfig.md

@@ -0,0 +1,68 @@
+---
+id: packages/github-action-builder/api/function/defineconfig
+title: "defineConfig — github-action-builder function"
+summary: "Define a configuration with full TypeScript support."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# defineConfig
+
+Define a configuration with full TypeScript support.
+
+```ts
+function defineConfig(config?: Partial<ConfigInput>): Config;
+```
+
+## Parameters
+
+- `config` `Partial<ConfigInput>` — Partial configuration object
+
+## Returns
+
+Fully resolved configuration with defaults applied
+
+## Examples
+
+```typescript
+// action.config.ts
+import { defineConfig } from "@savvy-web/github-action-builder";
+
+export default defineConfig({
+  entries: {
+    main: "src/main.ts",
+  },
+  build: {
+    minify: true,
+  },
+});
+
+```
+
+```typescript
+// action.config.ts
+import { defineConfig } from "@savvy-web/github-action-builder";
+
+export default defineConfig({
+  entries: {
+    main: "src/action.ts",
+    pre: "src/setup.ts",
+    post: "src/cleanup.ts",
+  },
+  build: {
+    minify: true,
+    sourceMap: true,
+    externals: ["@aws-sdk/client-s3"],
+    ignore: ["libxmljs2"],
+  },
+  validation: {
+    requireActionYml: true,
+    maxBundleSize: "10mb",
+    strict: true,
+  },
+});
+
+```

package/public/content/packages/github-action-builder/api/interface/buildservice.md

@@ -0,0 +1,83 @@
+---
+id: packages/github-action-builder/api/interface/buildservice
+title: "BuildService — github-action-builder interface"
+summary: "BuildService interface for build and bundling capabilities."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# BuildService
+
+[BuildService](silk://packages/github-action-builder/api/variable/buildservice) interface for build and bundling capabilities.
+
+```ts
+interface BuildService
+```
+
+## Members
+
+### build
+
+```ts
+readonly build: (config: Config, options?: BuildRunnerOptions) => Effect.Effect<BuildResult, BuildError |
+  MainEntryMissing | WorkerEntryMissing | WorkerEntryInvalidName>;
+```
+
+Build all entries from the configuration.
+
+### bundle
+
+```ts
+readonly bundle: (entry: DetectedEntry, config: Config) => Effect.Effect<BundleResult, BuildError>;
+```
+
+Bundle a single entry point.
+
+### clean
+
+```ts
+readonly clean: (outputDir: string) => Effect.Effect<void, BuildError>;
+```
+
+Clean the output directory.
+
+### formatBytes
+
+```ts
+readonly formatBytes: (bytes: number) => string;
+```
+
+Format bytes as human-readable string.
+
+### formatResult
+
+```ts
+readonly formatResult: (result: BuildResult) => string;
+```
+
+Format build result for display.
+
+## Examples
+
+```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);
+
+  if (result.success) {
+    console.log("Build complete:", result.entries.length, "entries");
+  }
+});
+
+Effect.runPromise(program.pipe(Effect.provide(AppLayer)));
+
+```

package/public/content/packages/github-action-builder/api/interface/configservice.md

@@ -0,0 +1,66 @@
+---
+id: packages/github-action-builder/api/interface/configservice
+title: "ConfigService — github-action-builder interface"
+summary: "ConfigService interface for configuration management capabilities."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# ConfigService
+
+[ConfigService](silk://packages/github-action-builder/api/variable/configservice) interface for configuration management capabilities.
+
+```ts
+interface ConfigService
+```
+
+## Members
+
+### detectEntries
+
+```ts
+readonly detectEntries: (cwd: string, entries?: {
+    main?: string;
+    pre?: string;
+    post?: string;
+    workers?: Record<string, string>;
+  }) => Effect.Effect<DetectEntriesResult, MainEntryMissing |
+  WorkerEntryMissing | WorkerEntryInvalidName>;
+```
+
+Detect entry points in the project.
+
+### load
+
+```ts
+readonly load: (options?: LoadConfigOptions) => Effect.Effect<LoadConfigResult, ConfigError>;
+```
+
+Load configuration from file or use defaults.
+
+### resolve
+
+```ts
+readonly resolve: (input?: Partial<ConfigInput>) => Effect.Effect<Config, ConfigError>;
+```
+
+Resolve partial configuration input to full configuration.
+
+## Examples
+
+```typescript
+import { Effect } from "effect";
+import { AppLayer, ConfigService } from "@savvy-web/github-action-builder";
+
+const program = Effect.gen(function* () {
+  const configService = yield* ConfigService;
+  const result = yield* configService.load({ cwd: process.cwd() });
+  console.log("Loaded config:", result.config);
+});
+
+Effect.runPromise(program.pipe(Effect.provide(AppLayer)));
+
+```

package/public/content/packages/github-action-builder/api/interface/githubactionoptions.md

@@ -0,0 +1,60 @@
+---
+id: packages/github-action-builder/api/interface/githubactionoptions
+title: "GitHubActionOptions — github-action-builder interface"
+summary: "Options for creating a GitHubAction builder instance."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# GitHubActionOptions
+
+Options for creating a [GitHubAction](silk://packages/github-action-builder/api/class/githubaction) builder instance.
+
+```ts
+interface GitHubActionOptions
+```
+
+## Members
+
+### clean
+
+```ts
+clean?: boolean;
+```
+
+Clean output directory before building.
+
+### config
+
+```ts
+config?: Partial<ConfigInput> | string;
+```
+
+Configuration object or path to config file.
+
+### cwd
+
+```ts
+cwd?: string;
+```
+
+Working directory for the build.
+
+### layer
+
+```ts
+layer?: Layer.Layer<ConfigService | ValidationService | BuildService | PersistLocalService>;
+```
+
+Custom Effect Layer to use instead of the default [AppLayer](silk://packages/github-action-builder/api/variable/applayer).
+
+### skipValidation
+
+```ts
+skipValidation?: boolean;
+```
+
+Skip validation before building.

package/public/content/packages/github-action-builder/api/interface/loadconfigresult.md

@@ -0,0 +1,44 @@
+---
+id: packages/github-action-builder/api/interface/loadconfigresult
+title: "LoadConfigResult — github-action-builder interface"
+summary: "Result of configuration loading."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# LoadConfigResult
+
+Result of configuration loading.
+
+```ts
+interface LoadConfigResult
+```
+
+## Members
+
+### config
+
+```ts
+config: Config;
+```
+
+The resolved configuration.
+
+### configPath
+
+```ts
+configPath?: string;
+```
+
+Path to the config file that was loaded, if any.
+
+### usingDefaults
+
+```ts
+usingDefaults: boolean;
+```
+
+Whether defaults were used (no config file found).

package/public/content/packages/github-action-builder/api/interface/persistlocalservice.md

@@ -0,0 +1,37 @@
+---
+id: packages/github-action-builder/api/interface/persistlocalservice
+title: "PersistLocalService — github-action-builder interface"
+summary: "PersistLocalService interface for copying build output locally."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# PersistLocalService
+
+[PersistLocalService](silk://packages/github-action-builder/api/variable/persistlocalservice) interface for copying build output locally.
+
+```ts
+interface PersistLocalService
+```
+
+## Members
+
+### formatResult
+
+```ts
+readonly formatResult: (result: PersistLocalResult) => string;
+```
+
+Format persist result for display.
+
+### persist
+
+```ts
+readonly persist: (config: Config, options?: PersistLocalRunnerOptions) => Effect.Effect<PersistLocalResult, PersistLocalError |
+  ActionYmlPathError>;
+```
+
+Persist build output to the local action directory.

package/public/content/packages/github-action-builder/api/interface/validationservice.md

@@ -0,0 +1,82 @@
+---
+id: packages/github-action-builder/api/interface/validationservice
+title: "ValidationService — github-action-builder interface"
+summary: "ValidationService interface for validation capabilities."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# ValidationService
+
+[ValidationService](silk://packages/github-action-builder/api/variable/validationservice) interface for validation capabilities.
+
+```ts
+interface ValidationService
+```
+
+## Members
+
+### formatResult
+
+```ts
+readonly formatResult: (result: ValidationResult) => string;
+```
+
+Format validation result for display.
+
+### isCI
+
+```ts
+readonly isCI: () => Effect.Effect<boolean>;
+```
+
+Check if running in CI environment.
+
+### isStrict
+
+```ts
+readonly isStrict: (configStrict?: boolean) => Effect.Effect<boolean>;
+```
+
+Check if strict mode is enabled.
+
+### validate
+
+```ts
+readonly validate: (config: Config, options?: ValidateOptions) => Effect.Effect<ValidationResult, ValidationError>;
+```
+
+Validate configuration and project structure.
+
+### validateActionYml
+
+```ts
+readonly validateActionYml: (path: string) => Effect.Effect<ActionYmlResult, ValidationError>;
+```
+
+Validate action.yml file.
+
+## Examples
+
+```typescript
+import { Effect } from "effect";
+import { AppLayer, ConfigService, ValidationService } from "@savvy-web/github-action-builder";
+
+const program = Effect.gen(function* () {
+  const configService = yield* ConfigService;
+  const validationService = yield* ValidationService;
+
+  const { config } = yield* configService.load();
+  const result = yield* validationService.validate(config);
+
+  if (!result.valid) {
+    console.error("Validation failed:", result.errors);
+  }
+});
+
+Effect.runPromise(program.pipe(Effect.provide(AppLayer)));
+
+```

package/public/content/packages/github-action-builder/api/type/actionymlresult.md

@@ -0,0 +1,18 @@
+---
+id: packages/github-action-builder/api/type/actionymlresult
+title: "ActionYmlResult — github-action-builder type"
+summary: "Result of action.yml validation."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# ActionYmlResult
+
+Result of action.yml validation.
+
+```ts
+type ActionYmlResult = typeof ActionYmlResultSchema.Type;
+```

package/public/content/packages/github-action-builder/api/type/apperror.md

@@ -0,0 +1,18 @@
+---
+id: packages/github-action-builder/api/type/apperror
+title: "AppError — github-action-builder type"
+summary: "Union of all possible errors in the GitHub Action Builder."
+tier: packages
+source: generated
+tags: [github-action-builder, api]
+priority: 0.3
+related: []
+---
+
+# AppError
+
+Union of all possible errors in the GitHub Action Builder.
+
+```ts
+type AppError = ConfigError | ValidationError | BuildError | PersistError;
+```