@aspruyt/xfg 4.0.0 → 4.0.1

package/dist/settings/repo-settings/processor.d.ts

@@ -2,40 +2,19 @@ import type { RepoConfig } from "../../config/index.js";
 import type { RepoInfo } from "../../shared/repo-detector.js";
 import type { IRepoSettingsStrategy } from "./types.js";
 import { RepoSettingsPlanResult } from "./formatter.js";
-export interface IRepoSettingsProcessor {
-    process(repoConfig: RepoConfig, repoInfo: RepoInfo, options: RepoSettingsProcessorOptions): Promise<RepoSettingsProcessorResult>;
-}
-export interface RepoSettingsProcessorOptions {
-    dryRun?: boolean;
-    token?: string;
-}
-export interface RepoSettingsProcessorResult {
-    success: boolean;
-    repoName: string;
-    message: string;
-    skipped?: boolean;
-    dryRun?: boolean;
-    changes?: {
-        adds: number;
-        changes: number;
-    };
+import { type BaseProcessorOptions, type BaseProcessorResult, type ISettingsProcessor, type ChangeCounts } from "../base-processor.js";
+export type IRepoSettingsProcessor = ISettingsProcessor<RepoSettingsProcessorOptions, RepoSettingsProcessorResult>;
+export type RepoSettingsProcessorOptions = BaseProcessorOptions;
+export interface RepoSettingsProcessorResult extends BaseProcessorResult {
+    changes?: ChangeCounts;
     warnings?: string[];
     planOutput?: RepoSettingsPlanResult;
 }
 export declare class RepoSettingsProcessor implements IRepoSettingsProcessor {
     private readonly strategy;
-    private readonly tokenManager;
     constructor(strategy?: IRepoSettingsStrategy);
     process(repoConfig: RepoConfig, repoInfo: RepoInfo, options: RepoSettingsProcessorOptions): Promise<RepoSettingsProcessorResult>;
+    private processSettings;
     private applyChanges;
-    /**
-     * Validates that desired security settings are compatible with the repo's
-     * visibility and owner type. Returns error messages for incompatible settings.
-     */
     private validateSecuritySettings;
-    /**
-     * Resolves a GitHub App installation token for the given repo.
-     * Returns undefined if no token manager or token resolution fails.
-     */
-    private getInstallationToken;
 }

package/dist/settings/repo-settings/processor.js

@@ -1,108 +1,75 @@
-import { isGitHubRepo, getRepoDisplayName, } from "../../shared/repo-detector.js";
 import { GitHubRepoSettingsStrategy } from "./github-repo-settings-strategy.js";
 import { diffRepoSettings, hasChanges } from "./diff.js";
 import { formatRepoSettingsPlan } from "./formatter.js";
-import { hasGitHubAppCredentials } from "../../vcs/index.js";
-import { GitHubAppTokenManager } from "../../vcs/github-app-token-manager.js";
+import { withGitHubGuards, buildDryRunResult, buildApplyResult, } from "../base-processor.js";
 export class RepoSettingsProcessor {
     strategy;
-    tokenManager;
     constructor(strategy) {
         this.strategy = strategy ?? new GitHubRepoSettingsStrategy();
-        if (hasGitHubAppCredentials()) {
-            this.tokenManager = new GitHubAppTokenManager(process.env.XFG_GITHUB_APP_ID, process.env.XFG_GITHUB_APP_PRIVATE_KEY);
-        }
-        else {
-            this.tokenManager = null;
-        }
     }
     async process(repoConfig, repoInfo, options) {
-        const repoName = getRepoDisplayName(repoInfo);
-        const { dryRun, token } = options;
-        // Check if this is a GitHub repo
-        if (!isGitHubRepo(repoInfo)) {
+        return withGitHubGuards(repoConfig, repoInfo, options, {
+            hasDesiredSettings: (rc) => {
+                const s = rc.settings?.repo;
+                return !!s && Object.keys(s).length > 0;
+            },
+            emptySettingsMessage: "No repo settings configured",
+            processSettings: (githubRepo, rc, opts, token, repoName) => this.processSettings(githubRepo, rc, opts, token, repoName),
+        });
+    }
+    async processSettings(githubRepo, repoConfig, options, effectiveToken, repoName) {
+        const { dryRun } = options;
+        const desiredSettings = repoConfig.settings.repo;
+        const strategyOptions = { token: effectiveToken, host: githubRepo.host };
+        // Fetch current settings
+        const currentSettings = await this.strategy.getSettings(githubRepo, strategyOptions);
+        // Validate security settings compatibility
+        const securityErrors = this.validateSecuritySettings(desiredSettings, currentSettings);
+        if (securityErrors.length > 0) {
             return {
-                success: true,
+                success: false,
                 repoName,
-                message: `Skipped: ${repoName} is not a GitHub repository`,
-                skipped: true,
+                message: `Failed: ${securityErrors.join("; ")}`,
             };
         }
-        const githubRepo = repoInfo;
-        const desiredSettings = repoConfig.settings?.repo;
-        // If no repo settings configured, skip
-        if (!desiredSettings || Object.keys(desiredSettings).length === 0) {
+        // Compute diff
+        const changes = diffRepoSettings(currentSettings, desiredSettings);
+        if (!hasChanges(changes)) {
+            const unchangedCount = changes.filter((c) => c.action === "unchanged").length;
             return {
                 success: true,
                 repoName,
-                message: "No repo settings configured",
-                skipped: true,
+                message: "No changes needed",
+                changes: { create: 0, update: 0, delete: 0, unchanged: unchangedCount },
             };
         }
-        try {
-            // Resolve App token if available, fall back to provided token
-            const effectiveToken = token ?? (await this.getInstallationToken(githubRepo));
-            const strategyOptions = { token: effectiveToken, host: githubRepo.host };
-            // Fetch current settings
-            const currentSettings = await this.strategy.getSettings(githubRepo, strategyOptions);
-            // Validate security settings compatibility
-            const securityErrors = this.validateSecuritySettings(desiredSettings, currentSettings);
-            if (securityErrors.length > 0) {
-                return {
-                    success: false,
-                    repoName,
-                    message: `Failed: ${securityErrors.join("; ")}`,
-                };
-            }
-            // Compute diff
-            const changes = diffRepoSettings(currentSettings, desiredSettings);
-            if (!hasChanges(changes)) {
-                return {
-                    success: true,
-                    repoName,
-                    message: "No changes needed",
-                    changes: { adds: 0, changes: 0 },
-                };
-            }
-            // Format plan output
-            const planOutput = formatRepoSettingsPlan(changes);
-            // Dry run mode - report planned changes without applying
-            if (dryRun) {
-                return {
-                    success: true,
-                    repoName,
-                    message: `[DRY RUN] ${planOutput.adds} to add, ${planOutput.changes} to change`,
-                    dryRun: true,
-                    changes: { adds: planOutput.adds, changes: planOutput.changes },
-                    warnings: planOutput.warnings,
-                    planOutput,
-                };
-            }
-            // Apply changes - only send settings that actually changed
-            const changedSettings = changes.reduce((acc, change) => {
-                if (change.action !== "unchanged") {
-                    acc[change.property] = change.newValue;
-                }
-                return acc;
-            }, {});
-            await this.applyChanges(githubRepo, changedSettings, strategyOptions);
-            return {
-                success: true,
-                repoName,
-                message: `Applied: ${planOutput.adds} added, ${planOutput.changes} changed`,
-                changes: { adds: planOutput.adds, changes: planOutput.changes },
+        // Format plan output
+        const planOutput = formatRepoSettingsPlan(changes);
+        const changeCounts = {
+            create: planOutput.creates,
+            update: planOutput.updates,
+            delete: 0,
+            unchanged: changes.filter((c) => c.action === "unchanged").length,
+        };
+        if (dryRun) {
+            return buildDryRunResult(repoName, changeCounts, {
                 warnings: planOutput.warnings,
                 planOutput,
-            };
-        }
-        catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            return {
-                success: false,
-                repoName,
-                message: `Failed: ${message}`,
-            };
+            });
         }
+        // Apply changes - only send settings that actually changed
+        const changedSettings = changes.reduce((acc, change) => {
+            if (change.action !== "unchanged") {
+                acc[change.property] = change.newValue;
+            }
+            return acc;
+        }, {});
+        await this.applyChanges(githubRepo, changedSettings, strategyOptions);
+        const appliedCount = Object.keys(changedSettings).length;
+        return buildApplyResult(repoName, changeCounts, appliedCount, {
+            warnings: planOutput.warnings,
+            planOutput,
+        });
     }
     async applyChanges(repoInfo, settings, options) {
         // Extract settings that need separate API calls
@@ -126,10 +93,6 @@ export class RepoSettingsProcessor {
             await this.strategy.setAutomatedSecurityFixes(repoInfo, automatedSecurityFixes, options);
         }
     }
-    /**
-     * Validates that desired security settings are compatible with the repo's
-     * visibility and owner type. Returns error messages for incompatible settings.
-     */
     validateSecuritySettings(desiredSettings, currentSettings) {
         const errors = [];
         const isPublic = currentSettings.visibility === "public";
@@ -155,20 +118,4 @@ export class RepoSettingsProcessor {
         }
         return errors;
     }
-    /**
-     * Resolves a GitHub App installation token for the given repo.
-     * Returns undefined if no token manager or token resolution fails.
-     */
-    async getInstallationToken(repoInfo) {
-        if (!this.tokenManager) {
-            return undefined;
-        }
-        try {
-            const token = await this.tokenManager.getTokenForRepo(repoInfo);
-            return token ?? undefined;
-        }
-        catch {
-            return undefined;
-        }
-    }
 }

package/dist/settings/repo-settings/types.d.ts

@@ -1,13 +1,11 @@
 import type { RepoInfo } from "../../shared/repo-detector.js";
 import type { GitHubRepoSettings } from "../../config/index.js";
-export interface RepoSettingsStrategyOptions {
-    token?: string;
-    host?: string;
-}
+import type { GhApiOptions } from "../../shared/gh-api-utils.js";
 /**
  * Current repository settings from GitHub API (snake_case).
  */
 export interface CurrentRepoSettings {
+    description?: string;
     has_issues?: boolean;
     has_projects?: boolean;
     has_wiki?: boolean;
@@ -48,23 +46,23 @@ export interface IRepoSettingsStrategy {
     /**
      * Gets current repository settings.
      */
-    getSettings(repoInfo: RepoInfo, options?: RepoSettingsStrategyOptions): Promise<CurrentRepoSettings>;
+    getSettings(repoInfo: RepoInfo, options?: GhApiOptions): Promise<CurrentRepoSettings>;
     /**
      * Updates repository settings.
      */
-    updateSettings(repoInfo: RepoInfo, settings: GitHubRepoSettings, options?: RepoSettingsStrategyOptions): Promise<void>;
+    updateSettings(repoInfo: RepoInfo, settings: GitHubRepoSettings, options?: GhApiOptions): Promise<void>;
     /**
      * Enables or disables vulnerability alerts.
      */
-    setVulnerabilityAlerts(repoInfo: RepoInfo, enable: boolean, options?: RepoSettingsStrategyOptions): Promise<void>;
+    setVulnerabilityAlerts(repoInfo: RepoInfo, enable: boolean, options?: GhApiOptions): Promise<void>;
     /**
      * Enables or disables automated security fixes.
      */
-    setAutomatedSecurityFixes(repoInfo: RepoInfo, enable: boolean, options?: RepoSettingsStrategyOptions): Promise<void>;
+    setAutomatedSecurityFixes(repoInfo: RepoInfo, enable: boolean, options?: GhApiOptions): Promise<void>;
     /**
      * Enables or disables private vulnerability reporting.
      */
-    setPrivateVulnerabilityReporting(repoInfo: RepoInfo, enable: boolean, options?: RepoSettingsStrategyOptions): Promise<void>;
+    setPrivateVulnerabilityReporting(repoInfo: RepoInfo, enable: boolean, options?: GhApiOptions): Promise<void>;
 }
 /**
  * Type guard to check if an object implements IRepoSettingsStrategy.

package/dist/settings/rulesets/diff-algorithm.d.ts

@@ -12,7 +12,3 @@ export declare function isArrayOfObjects(arr: unknown[]): boolean;
  * Recursively compute property-level diffs between two objects.
  */
 export declare function computePropertyDiffs(current: Record<string, unknown>, desired: Record<string, unknown>, parentPath?: string[]): PropertyDiff[];
-/**
- * Diff two arrays of objects by matching items on `type` field (or by index).
- */
-export declare function diffObjectArrays(currentArr: unknown[], desiredArr: unknown[], parentPath: string[]): PropertyDiff[];

package/dist/settings/rulesets/diff-algorithm.js

@@ -1,7 +1,4 @@
 // src/settings/rulesets/diff-algorithm.ts
-// =============================================================================
-// Helpers
-// =============================================================================
 export function isObject(val) {
     return val !== null && typeof val === "object" && !Array.isArray(val);
 }
@@ -29,9 +26,6 @@ export function deepEqual(a, b) {
 export function isArrayOfObjects(arr) {
     return arr.length > 0 && arr.every((item) => isObject(item));
 }
-// =============================================================================
-// Property Diff Algorithm
-// =============================================================================
 /**
  * Recursively compute property-level diffs between two objects.
  */
@@ -76,13 +70,10 @@ export function computePropertyDiffs(current, desired, parentPath = []) {
     }
     return diffs;
 }
-// =============================================================================
-// Array Diffing
-// =============================================================================
 /**
  * Diff two arrays of objects by matching items on `type` field (or by index).
  */
-export function diffObjectArrays(currentArr, desiredArr, parentPath) {
+function diffObjectArrays(currentArr, desiredArr, parentPath) {
     const diffs = [];
     const hasType = desiredArr.every((item) => isObject(item) && "type" in item);
     if (hasType) {

package/dist/settings/rulesets/diff.d.ts

@@ -1,5 +1,5 @@
 import { type Ruleset } from "../../config/index.js";
-import type { GitHubRuleset } from "./github-ruleset-strategy.js";
+import type { GitHubRuleset } from "./types.js";
 export type RulesetAction = "create" | "update" | "delete" | "unchanged";
 export interface RulesetChange {
     action: RulesetAction;

package/dist/settings/rulesets/diff.js

@@ -1,13 +1,6 @@
 import { RULESET_COMPARABLE_FIELDS } from "../../config/index.js";
-// =============================================================================
-// Normalization (for comparison)
-// =============================================================================
-/**
- * Converts camelCase to snake_case for comparison.
- */
-function camelToSnake(str) {
-    return str.replace(/([A-Z])/g, "_$1").toLowerCase();
-}
+import { isPlainObject } from "../../shared/type-guards.js";
+import { camelToSnake } from "../../shared/string-utils.js";
 /**
  * Normalizes a value recursively, converting keys to a consistent format (snake_case).
  * This allows comparing GitHub API responses (snake_case) with config (camelCase).
@@ -91,9 +84,6 @@ function deepEqual(a, b) {
     }
     return false;
 }
-// =============================================================================
-// Desired-Side Projection
-// =============================================================================
 /**
  * Projects `current` onto the shape of `desired`.
  * Only keeps keys/structure present in `desired`, filtering out API noise.
@@ -116,9 +106,6 @@ export function projectToDesiredShape(current, desired) {
     // Scalars — return current as-is
     return current;
 }
-function isPlainObject(val) {
-    return val !== null && typeof val === "object" && !Array.isArray(val);
-}
 function projectObjects(current, desired) {
     const result = {};
     for (const key of Object.keys(desired)) {
@@ -193,9 +180,6 @@ function matchByIndex(current, desired) {
     }
     return result;
 }
-// =============================================================================
-// Diff Algorithm
-// =============================================================================
 /**
  * Compares current rulesets (from GitHub) with desired rulesets (from config).
  *
@@ -265,9 +249,6 @@ export function diffRulesets(current, desired, deleteOrphaned) {
     };
     return changes.sort((a, b) => actionOrder[a.action] - actionOrder[b.action]);
 }
-// =============================================================================
-// Formatting
-// =============================================================================
 /**
  * Formats a ruleset change for display.
  */

package/dist/settings/rulesets/formatter.d.ts

@@ -1,8 +1,6 @@
 import { type RulesetChange, type RulesetAction } from "./diff.js";
 import type { Ruleset } from "../../config/index.js";
-import { type PropertyDiff } from "./index.js";
-export type { DiffAction, PropertyDiff } from "./index.js";
-export { computePropertyDiffs } from "./index.js";
+import { type PropertyDiff } from "./diff-algorithm.js";
 export interface RulesetPlanEntry {
     name: string;
     action: RulesetAction;

package/dist/settings/rulesets/formatter.js

@@ -1,7 +1,6 @@
 import chalk from "chalk";
 import { projectToDesiredShape, normalizeRuleset, } from "./diff.js";
-import { computePropertyDiffs, isObject, } from "./index.js";
-export { computePropertyDiffs } from "./index.js";
+import { computePropertyDiffs, isObject, } from "./diff-algorithm.js";
 /**
  * Build a tree structure from flat property diffs.
  */
@@ -187,9 +186,6 @@ export function formatPropertyTree(diffs) {
     const tree = buildTree(diffs);
     return renderTree(tree);
 }
-// =============================================================================
-// Ruleset Plan Formatter
-// =============================================================================
 /**
  * Format a full ruleset config as tree lines (for create action).
  */
@@ -253,7 +249,6 @@ export function formatRulesetPlan(changes) {
     updates = updateChanges.length;
     deletes = deleteChanges.length;
     unchanged = unchangedChanges.length;
-    // Format creates
     if (createChanges.length > 0) {
         lines.push(chalk.bold("  Create:"));
         for (const change of createChanges) {
@@ -273,7 +268,6 @@ export function formatRulesetPlan(changes) {
             lines.push(""); // Blank line between rulesets
         }
     }
-    // Format updates
     if (updateChanges.length > 0) {
         lines.push(chalk.bold("  Update:"));
         for (const change of updateChanges) {
@@ -303,7 +297,6 @@ export function formatRulesetPlan(changes) {
             lines.push(""); // Blank line between rulesets
         }
     }
-    // Format deletes
     if (deleteChanges.length > 0) {
         lines.push(chalk.bold("  Delete:"));
         for (const change of deleteChanges) {

package/dist/settings/rulesets/github-ruleset-strategy.d.ts

@@ -1,41 +1,13 @@
 import { ICommandExecutor } from "../../shared/command-executor.js";
 import { RepoInfo } from "../../shared/repo-detector.js";
+import { type GhApiOptions } from "../../shared/gh-api-utils.js";
 import type { Ruleset } from "../../config/index.js";
-import type { IRulesetStrategy } from "./types.js";
-/**
- * GitHub Ruleset response from API (snake_case).
- */
-export interface GitHubRuleset {
-    id: number;
-    name: string;
-    target: "branch" | "tag";
-    enforcement: "active" | "disabled" | "evaluate";
-    bypass_actors?: GitHubBypassActor[];
-    conditions?: GitHubRulesetConditions;
-    rules?: GitHubRule[];
-    source_type?: string;
-    source?: string;
-}
-export interface GitHubBypassActor {
-    actor_id: number;
-    actor_type: "Team" | "User" | "Integration";
-    bypass_mode?: "always" | "pull_request";
-}
-export interface GitHubRulesetConditions {
-    ref_name?: {
-        include?: string[];
-        exclude?: string[];
-    };
-}
-export interface GitHubRule {
-    type: string;
-    parameters?: Record<string, unknown>;
-}
+import type { IRulesetStrategy, GitHubRuleset, GitHubBypassActor, GitHubRulesetConditions, GitHubRule } from "./types.js";
 /**
  * Converts camelCase config ruleset to snake_case GitHub API format.
  */
 export declare function configToGitHub(name: string, ruleset: Ruleset): GitHubRulesetPayload;
-export interface GitHubRulesetPayload {
+interface GitHubRulesetPayload {
     name: string;
     target: "branch" | "tag";
     enforcement: "active" | "disabled" | "evaluate";
@@ -43,11 +15,7 @@ export interface GitHubRulesetPayload {
     conditions?: GitHubRulesetConditions;
     rules?: GitHubRule[];
 }
-export interface RulesetStrategyOptions {
-    token?: string;
-    host?: string;
-}
-export interface GitHubRulesetStrategyOptions {
+interface GitHubRulesetStrategyOptions {
     retries?: number;
 }
 /**
@@ -55,35 +23,27 @@ export interface GitHubRulesetStrategyOptions {
  * Uses `gh api` CLI for authentication and API calls.
  */
 export declare class GitHubRulesetStrategy implements IRulesetStrategy {
-    private executor;
-    private retries;
+    private api;
     constructor(executor?: ICommandExecutor, options?: GitHubRulesetStrategyOptions);
     /**
      * Lists all rulesets for a repository.
      */
-    list(repoInfo: RepoInfo, options?: RulesetStrategyOptions): Promise<GitHubRuleset[]>;
+    list(repoInfo: RepoInfo, options?: GhApiOptions): Promise<GitHubRuleset[]>;
     /**
      * Gets a single ruleset by ID.
      */
-    get(repoInfo: RepoInfo, rulesetId: number, options?: RulesetStrategyOptions): Promise<GitHubRuleset>;
+    get(repoInfo: RepoInfo, rulesetId: number, options?: GhApiOptions): Promise<GitHubRuleset>;
     /**
      * Creates a new ruleset.
      */
-    create(repoInfo: RepoInfo, name: string, ruleset: Ruleset, options?: RulesetStrategyOptions): Promise<GitHubRuleset>;
+    create(repoInfo: RepoInfo, name: string, ruleset: Ruleset, options?: GhApiOptions): Promise<GitHubRuleset>;
     /**
      * Updates an existing ruleset.
      */
-    update(repoInfo: RepoInfo, rulesetId: number, name: string, ruleset: Ruleset, options?: RulesetStrategyOptions): Promise<GitHubRuleset>;
+    update(repoInfo: RepoInfo, rulesetId: number, name: string, ruleset: Ruleset, options?: GhApiOptions): Promise<GitHubRuleset>;
     /**
      * Deletes a ruleset.
      */
-    delete(repoInfo: RepoInfo, rulesetId: number, options?: RulesetStrategyOptions): Promise<void>;
-    /**
-     * Validates that the repo is a GitHub repository.
-     */
-    private validateGitHub;
-    /**
-     * Executes a GitHub API call using the gh CLI.
-     */
-    private ghApi;
+    delete(repoInfo: RepoInfo, rulesetId: number, options?: GhApiOptions): Promise<void>;
 }
+export {};