declastruct-github 1.0.0

package/dist/domain.operations/branchProtection/getBranchProtection.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBranchProtection = void 0;
+const as_procedure_1 = require("as-procedure");
+const helpful_errors_1 = require("helpful-errors");
+const getGithubClient_1 = require("../../access/sdks/getGithubClient");
+const castToDeclaredGithubBranchProtection_1 = require("./castToDeclaredGithubBranchProtection");
+/**
+ * .what = gets a GitHub branch's protection rules
+ * .why = retrieves current protection state from GitHub API for declarative management
+ */
+exports.getBranchProtection = (0, as_procedure_1.asProcedure)(async (input, context) => {
+    // get cached GitHub client
+    const github = (0, getGithubClient_1.getGithubClient)({}, context);
+    // determine owner, repo, and branch name from input
+    const { branch } = (() => {
+        if (input.by.unique) {
+            return {
+                branch: input.by.unique.branch,
+            };
+        }
+        helpful_errors_1.UnexpectedCodePathError.throw('not referenced by unique. how not?', {
+            input,
+        });
+    })();
+    // execute the GitHub API call
+    try {
+        const branchRef = branch;
+        const response = await github.repos.getBranchProtection({
+            owner: branchRef.repo.owner,
+            repo: branchRef.repo.name,
+            branch: branchRef.name,
+        });
+        return (0, castToDeclaredGithubBranchProtection_1.castToDeclaredGithubBranchProtection)({
+            response: response.data,
+            branch,
+        });
+    }
+    catch (error) {
+        if (!(error instanceof Error))
+            throw error;
+        // return null for 404/not found (no protection exists)
+        if (error.message.includes('Not Found') ||
+            error.message.includes('Branch not protected') ||
+            error.message.includes('Branch not found'))
+            return null;
+        // throw helpful error for all other failures
+        throw new helpful_errors_1.HelpfulError('github.getBranchProtection error', {
+            cause: error,
+        });
+    }
+});
+//# sourceMappingURL=getBranchProtection.js.map

package/dist/domain.operations/branchProtection/getBranchProtection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBranchProtection.js","sourceRoot":"","sources":["../../../src/domain.operations/branchProtection/getBranchProtection.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C,mDAAuE;AAIvE,uEAAoE;AAGpE,iGAA8F;AAE9F;;;GAGG;AACU,QAAA,mBAAmB,GAAG,IAAA,0BAAW,EAC5C,KAAK,EACH,KAIC,EACD,OAA6C,EACgB,EAAE;IAC/D,2BAA2B;IAC3B,MAAM,MAAM,GAAG,IAAA,iCAAe,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE5C,oDAAoD;IACpD,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE;QACvB,IAAI,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM;aAC/B,CAAC;QACJ,CAAC;QAED,wCAAuB,CAAC,KAAK,CAAC,oCAAoC,EAAE;YAClE,KAAK;SACN,CAAC,CAAC;IACL,CAAC,CAAC,EAAE,CAAC;IAEL,8BAA8B;IAC9B,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,MAGjB,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC;YACtD,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK;YAC3B,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;YACzB,MAAM,EAAE,SAAS,CAAC,IAAI;SACvB,CAAC,CAAC;QACH,OAAO,IAAA,2EAAoC,EAAC;YAC1C,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;YAAE,MAAM,KAAK,CAAC;QAE3C,uDAAuD;QACvD,IACE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;YACnC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YAC9C,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAE1C,OAAO,IAAI,CAAC;QAEd,6CAA6C;QAC7C,MAAM,IAAI,6BAAY,CAAC,kCAAkC,EAAE;YACzD,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CACF,CAAC"}

package/dist/domain.operations/branchProtection/setBranchProtection.d.ts

@@ -0,0 +1,12 @@
+import { HasMetadata, PickOne } from 'type-fns';
+import { VisualogicContext } from 'visualogic';
+import { ContextGithubApi } from '../../domain.objects/ContextGithubApi';
+import { DeclaredGithubBranchProtection } from '../../domain.objects/DeclaredGithubBranchProtection';
+/**
+ * .what = sets a GitHub branch's protection rules: upsert or finsert
+ * .why = enables declarative updates of branch protection following declastruct patterns
+ */
+export declare const setBranchProtection: (input: PickOne<{
+    finsert: DeclaredGithubBranchProtection;
+    upsert: DeclaredGithubBranchProtection;
+}>, context: ContextGithubApi & VisualogicContext) => Promise<HasMetadata<DeclaredGithubBranchProtection>>;

package/dist/domain.operations/branchProtection/setBranchProtection.integration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/domain.operations/branchProtection/setBranchProtection.integration.test.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getSampleGithubContext_1 = require("../../.test/assets/getSampleGithubContext");
+const getSampleRepo_1 = require("../../.test/assets/getSampleRepo");
+const getBranchProtection_1 = require("./getBranchProtection");
+const setBranchProtection_1 = require("./setBranchProtection");
+const log = console;
+describe('setBranchProtection', () => {
+    const context = { log, ...(0, getSampleGithubContext_1.getSampleGithubContext)() };
+    describe('live tests', () => {
+        it('should update branch protection rules', async () => {
+            const sampleRepo = (0, getSampleRepo_1.getSampleRepo)({
+                owner: 'ehmpathy',
+                name: 'declastruct-github-demo',
+            });
+            // Get current protection (if any)
+            const currentProtection = await (0, getBranchProtection_1.getBranchProtection)({
+                by: {
+                    unique: {
+                        branch: {
+                            repo: {
+                                owner: sampleRepo.owner,
+                                name: sampleRepo.name,
+                            },
+                            name: 'main',
+                        },
+                    },
+                },
+            }, context);
+            console.log('Current protection:', currentProtection);
+            // Update protection with upsert
+            const result = await (0, setBranchProtection_1.setBranchProtection)({
+                upsert: {
+                    branch: {
+                        repo: { owner: sampleRepo.owner, name: sampleRepo.name },
+                        name: 'main',
+                    },
+                    enforceAdmins: false,
+                    allowsDeletions: false,
+                    allowsForcePushes: false,
+                    requireLinearHistory: false,
+                    requiredStatusChecks: null,
+                    requiredPullRequestReviews: {
+                        requiredApprovingReviewCount: 1,
+                    },
+                    restrictions: null,
+                },
+            }, context);
+            expect(result).toBeDefined();
+            expect(result.branch.repo.owner).toBe(sampleRepo.owner);
+            expect(result.branch.repo.name).toBe(sampleRepo.name);
+            expect(result.branch.name).toBe('main');
+        });
+        it('should return existing protection for finsert', async () => {
+            const sampleRepo = (0, getSampleRepo_1.getSampleRepo)({
+                owner: 'ehmpathy',
+                name: 'declastruct-github-demo',
+            });
+            // Get current protection
+            const currentProtection = await (0, getBranchProtection_1.getBranchProtection)({
+                by: {
+                    unique: {
+                        branch: {
+                            repo: {
+                                owner: sampleRepo.owner,
+                                name: sampleRepo.name,
+                            },
+                            name: 'main',
+                        },
+                    },
+                },
+            }, context);
+            // Only run finsert test if protection exists
+            if (currentProtection) {
+                // Finsert should return existing protection without making changes
+                const result = await (0, setBranchProtection_1.setBranchProtection)({
+                    finsert: {
+                        branch: {
+                            repo: { owner: sampleRepo.owner, name: sampleRepo.name },
+                            name: 'main',
+                        },
+                        enforceAdmins: true,
+                        allowsDeletions: true,
+                        allowsForcePushes: true,
+                        requireLinearHistory: true,
+                    },
+                }, context);
+                expect(result).toBeDefined();
+                expect(result.branch.name).toBe('main');
+                // Should match current protection, not the finsert values
+                expect(result).toEqual(currentProtection);
+            }
+        });
+    });
+});
+//# sourceMappingURL=setBranchProtection.integration.test.js.map

package/dist/domain.operations/branchProtection/setBranchProtection.integration.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setBranchProtection.integration.test.js","sourceRoot":"","sources":["../../../src/domain.operations/branchProtection/setBranchProtection.integration.test.ts"],"names":[],"mappings":";;AAAA,sFAAmF;AACnF,oEAAiE;AACjE,+DAA4D;AAC5D,+DAA4D;AAE5D,MAAM,GAAG,GAAG,OAAO,CAAC;AAEpB,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,GAAG,IAAA,+CAAsB,GAAE,EAAE,CAAC;IAErD,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,UAAU,GAAG,IAAA,6BAAa,EAAC;gBAC/B,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,yBAAyB;aAChC,CAAC,CAAC;YAEH,kCAAkC;YAClC,MAAM,iBAAiB,GAAG,MAAM,IAAA,yCAAmB,EACjD;gBACE,EAAE,EAAE;oBACF,MAAM,EAAE;wBACN,MAAM,EAAE;4BACN,IAAI,EAAE;gCACJ,KAAK,EAAE,UAAU,CAAC,KAAK;gCACvB,IAAI,EAAE,UAAU,CAAC,IAAI;6BACtB;4BACD,IAAI,EAAE,MAAM;yBACb;qBACF;iBACF;aACF,EACD,OAAO,CACR,CAAC;YAEF,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,CAAC;YAEtD,gCAAgC;YAChC,MAAM,MAAM,GAAG,MAAM,IAAA,yCAAmB,EACtC;gBACE,MAAM,EAAE;oBACN,MAAM,EAAE;wBACN,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE;wBACxD,IAAI,EAAE,MAAM;qBACb;oBACD,aAAa,EAAE,KAAK;oBACpB,eAAe,EAAE,KAAK;oBACtB,iBAAiB,EAAE,KAAK;oBACxB,oBAAoB,EAAE,KAAK;oBAC3B,oBAAoB,EAAE,IAAI;oBAC1B,0BAA0B,EAAE;wBAC1B,4BAA4B,EAAE,CAAC;qBAChC;oBACD,YAAY,EAAE,IAAI;iBACnB;aACF,EACD,OAAO,CACR,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACxD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC7D,MAAM,UAAU,GAAG,IAAA,6BAAa,EAAC;gBAC/B,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,yBAAyB;aAChC,CAAC,CAAC;YAEH,yBAAyB;YACzB,MAAM,iBAAiB,GAAG,MAAM,IAAA,yCAAmB,EACjD;gBACE,EAAE,EAAE;oBACF,MAAM,EAAE;wBACN,MAAM,EAAE;4BACN,IAAI,EAAE;gCACJ,KAAK,EAAE,UAAU,CAAC,KAAK;gCACvB,IAAI,EAAE,UAAU,CAAC,IAAI;6BACtB;4BACD,IAAI,EAAE,MAAM;yBACb;qBACF;iBACF;aACF,EACD,OAAO,CACR,CAAC;YAEF,6CAA6C;YAC7C,IAAI,iBAAiB,EAAE,CAAC;gBACtB,mEAAmE;gBACnE,MAAM,MAAM,GAAG,MAAM,IAAA,yCAAmB,EACtC;oBACE,OAAO,EAAE;wBACP,MAAM,EAAE;4BACN,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE;4BACxD,IAAI,EAAE,MAAM;yBACb;wBACD,aAAa,EAAE,IAAI;wBACnB,eAAe,EAAE,IAAI;wBACrB,iBAAiB,EAAE,IAAI;wBACvB,oBAAoB,EAAE,IAAI;qBAC3B;iBACF,EACD,OAAO,CACR,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;gBAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACxC,0DAA0D;gBAC1D,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/domain.operations/branchProtection/setBranchProtection.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setBranchProtection = void 0;
+const as_procedure_1 = require("as-procedure");
+const helpful_errors_1 = require("helpful-errors");
+const getGithubClient_1 = require("../../access/sdks/getGithubClient");
+const castToDeclaredGithubBranchProtection_1 = require("./castToDeclaredGithubBranchProtection");
+const getBranchProtection_1 = require("./getBranchProtection");
+/**
+ * .what = sets a GitHub branch's protection rules: upsert or finsert
+ * .why = enables declarative updates of branch protection following declastruct patterns
+ */
+exports.setBranchProtection = (0, as_procedure_1.asProcedure)(async (input, context) => {
+    const desired = input.finsert ?? input.upsert;
+    // get cached GitHub client
+    const github = (0, getGithubClient_1.getGithubClient)({}, context);
+    // check whether it already exists
+    const before = await (0, getBranchProtection_1.getBranchProtection)({
+        by: {
+            unique: {
+                branch: desired.branch,
+            },
+        },
+    }, context);
+    // if it's a finsert and had a before, then return that
+    if (before && input.finsert)
+        return before;
+    // update the branch protection (always use update since protection is part of branch, not a separate resource)
+    try {
+        const branchRef = desired.branch;
+        const updated = await github.repos.updateBranchProtection({
+            owner: branchRef.repo.owner,
+            repo: branchRef.repo.name,
+            branch: branchRef.name,
+            enforce_admins: desired.enforceAdmins ?? null,
+            allow_deletions: desired.allowsDeletions,
+            allow_force_pushes: desired.allowsForcePushes,
+            required_linear_history: desired.requireLinearHistory,
+            block_creations: desired.blockCreations,
+            lock_branch: desired.lockBranch,
+            allow_fork_syncing: desired.allowForkSyncing,
+            required_status_checks: desired.requiredStatusChecks
+                ? {
+                    strict: desired.requiredStatusChecks.strict,
+                    contexts: desired.requiredStatusChecks.contexts,
+                }
+                : null,
+            required_pull_request_reviews: desired.requiredPullRequestReviews
+                ? {
+                    dismiss_stale_reviews: desired.requiredPullRequestReviews.dismissStaleReviews ?? false,
+                    require_code_owner_reviews: desired.requiredPullRequestReviews.requireCodeOwnerReviews ??
+                        false,
+                    required_approving_review_count: desired.requiredPullRequestReviews
+                        .requiredApprovingReviewCount ?? 1,
+                    dismissal_restrictions: desired.requiredPullRequestReviews
+                        .dismissalRestrictions
+                        ? {
+                            users: desired.requiredPullRequestReviews.dismissalRestrictions
+                                .users,
+                            teams: desired.requiredPullRequestReviews.dismissalRestrictions
+                                .teams,
+                            apps: desired.requiredPullRequestReviews
+                                .dismissalRestrictions.apps,
+                        }
+                        : undefined,
+                }
+                : null,
+            restrictions: desired.restrictions
+                ? {
+                    users: desired.restrictions.users ?? [],
+                    teams: desired.restrictions.teams ?? [],
+                    apps: desired.restrictions.apps ?? [],
+                }
+                : null,
+            required_conversation_resolution: desired.requiredConversationResolution,
+        });
+        return (0, castToDeclaredGithubBranchProtection_1.castToDeclaredGithubBranchProtection)({
+            response: updated.data,
+            branch: desired.branch,
+        });
+    }
+    catch (error) {
+        if (!(error instanceof Error))
+            throw error;
+        throw new helpful_errors_1.HelpfulError('github.setBranchProtection.update error', {
+            cause: error,
+        });
+    }
+});
+//# sourceMappingURL=setBranchProtection.js.map

package/dist/domain.operations/branchProtection/setBranchProtection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setBranchProtection.js","sourceRoot":"","sources":["../../../src/domain.operations/branchProtection/setBranchProtection.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,mDAA8C;AAI9C,uEAAoE;AAGpE,iGAGgD;AAChD,+DAA4D;AAE5D;;;GAGG;AACU,QAAA,mBAAmB,GAAG,IAAA,0BAAW,EAC5C,KAAK,EACH,KAGE,EACF,OAA6C,EACS,EAAE;IACxD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,MAAM,CAAC;IAE9C,2BAA2B;IAC3B,MAAM,MAAM,GAAG,IAAA,iCAAe,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE5C,kCAAkC;IAClC,MAAM,MAAM,GAAG,MAAM,IAAA,yCAAmB,EACtC;QACE,EAAE,EAAE;YACF,MAAM,EAAE;gBACN,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB;SACF;KACF,EACD,OAAO,CACR,CAAC;IAEF,uDAAuD;IACvD,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO;QAAE,OAAO,MAAM,CAAC;IAE3C,+GAA+G;IAC/G,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,OAAO,CAAC,MAGzB,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC;YACxD,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,KAAK;YAC3B,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;YACzB,MAAM,EAAE,SAAS,CAAC,IAAI;YACtB,cAAc,EAAE,OAAO,CAAC,aAAa,IAAI,IAAI;YAC7C,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,kBAAkB,EAAE,OAAO,CAAC,iBAAiB;YAC7C,uBAAuB,EAAE,OAAO,CAAC,oBAAoB;YACrD,eAAe,EAAE,OAAO,CAAC,cAAc;YACvC,WAAW,EAAE,OAAO,CAAC,UAAU;YAC/B,kBAAkB,EAAE,OAAO,CAAC,gBAAgB;YAC5C,sBAAsB,EAAE,OAAO,CAAC,oBAAoB;gBAClD,CAAC,CAAC;oBACE,MAAM,EAAE,OAAO,CAAC,oBAAoB,CAAC,MAAM;oBAC3C,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,QAAQ;iBAChD;gBACH,CAAC,CAAC,IAAI;YACR,6BAA6B,EAAE,OAAO,CAAC,0BAA0B;gBAC/D,CAAC,CAAC;oBACE,qBAAqB,EACnB,OAAO,CAAC,0BAA0B,CAAC,mBAAmB,IAAI,KAAK;oBACjE,0BAA0B,EACxB,OAAO,CAAC,0BAA0B,CAAC,uBAAuB;wBAC1D,KAAK;oBACP,+BAA+B,EAC7B,OAAO,CAAC,0BAA0B;yBAC/B,4BAA4B,IAAI,CAAC;oBACtC,sBAAsB,EAAE,OAAO,CAAC,0BAA0B;yBACvD,qBAAqB;wBACtB,CAAC,CAAC;4BACE,KAAK,EACH,OAAO,CAAC,0BAA0B,CAAC,qBAAqB;iCACrD,KAAK;4BACV,KAAK,EACH,OAAO,CAAC,0BAA0B,CAAC,qBAAqB;iCACrD,KAAK;4BACV,IAAI,EAAE,OAAO,CAAC,0BAA0B;iCACrC,qBAAqB,CAAC,IAAI;yBAC9B;wBACH,CAAC,CAAC,SAAS;iBACd;gBACH,CAAC,CAAC,IAAI;YACR,YAAY,EAAE,OAAO,CAAC,YAAY;gBAChC,CAAC,CAAC;oBACE,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;oBACvC,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;oBACvC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE;iBACtC;gBACH,CAAC,CAAC,IAAI;YACR,gCAAgC,EAC9B,OAAO,CAAC,8BAA8B;SACzC,CAAC,CAAC;QAEH,OAAO,IAAA,2EAAoC,EAAC;YAC1C,QAAQ,EAAE,OAAO,CAAC,IAAsC;YACxD,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;YAAE,MAAM,KAAK,CAAC;QAC3C,MAAM,IAAI,6BAAY,CAAC,yCAAyC,EAAE;YAChE,KAAK,EAAE,KAAK;SACb,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CACF,CAAC"}

package/dist/domain.operations/branchProtection/setBranchProtection.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/domain.operations/branchProtection/setBranchProtection.test.js

@@ -0,0 +1,173 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const castModule = __importStar(require("./castToDeclaredGithubBranchProtection"));
+const getBranchProtectionModule = __importStar(require("./getBranchProtection"));
+// create mock functions first
+const mockUpdateBranchProtection = jest.fn();
+jest.mock('../../access/sdks/getGithubClient', () => ({
+    getGithubClient: jest.fn(() => ({
+        repos: {
+            updateBranchProtection: mockUpdateBranchProtection,
+        },
+    })),
+}));
+jest.mock('./castToDeclaredGithubBranchProtection');
+jest.mock('./getBranchProtection');
+const { setBranchProtection } = require('./setBranchProtection');
+const context = {
+    github: { token: 'test-token' },
+    log: console,
+};
+const protectionSample = {
+    branch: {
+        repo: { owner: 'test-owner', name: 'test-repo' },
+        name: 'main',
+    },
+    enforceAdmins: true,
+    allowsDeletions: false,
+    allowsForcePushes: false,
+    requireLinearHistory: true,
+    requiredStatusChecks: {
+        strict: true,
+        contexts: ['ci/test'],
+    },
+    requiredPullRequestReviews: {
+        requiredApprovingReviewCount: 1,
+        dismissStaleReviews: true,
+    },
+    restrictions: null,
+};
+describe('setBranchProtection', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    it('returns early for finsert if protection already exists (before)', async () => {
+        const before = { ...protectionSample };
+        getBranchProtectionModule.getBranchProtection.mockResolvedValue(before);
+        const result = await setBranchProtection({ finsert: protectionSample }, context);
+        expect(result).toBe(before);
+        expect(getBranchProtectionModule.getBranchProtection).toHaveBeenCalled();
+        expect(mockUpdateBranchProtection).not.toHaveBeenCalled();
+    });
+    it('updates protection if upsert and protection exists (before)', async () => {
+        const before = { ...protectionSample };
+        getBranchProtectionModule.getBranchProtection.mockResolvedValue(before);
+        const updatedProtectionResponse = {
+            enforce_admins: { enabled: true },
+            allow_deletions: { enabled: false },
+            allow_force_pushes: { enabled: false },
+            required_linear_history: { enabled: true },
+            required_status_checks: {
+                strict: true,
+                contexts: ['ci/test'],
+            },
+            required_pull_request_reviews: {
+                required_approving_review_count: 1,
+                dismiss_stale_reviews: true,
+            },
+        };
+        mockUpdateBranchProtection.mockResolvedValue({
+            data: updatedProtectionResponse,
+        });
+        castModule.castToDeclaredGithubBranchProtection.mockReturnValue(protectionSample);
+        const result = await setBranchProtection({ upsert: protectionSample }, context);
+        expect(getBranchProtectionModule.getBranchProtection).toHaveBeenCalled();
+        expect(mockUpdateBranchProtection).toHaveBeenCalledWith({
+            owner: 'test-owner',
+            repo: 'test-repo',
+            branch: 'main',
+            enforce_admins: true,
+            allow_deletions: false,
+            allow_force_pushes: false,
+            required_linear_history: true,
+            block_creations: undefined,
+            lock_branch: undefined,
+            allow_fork_syncing: undefined,
+            required_status_checks: {
+                strict: true,
+                contexts: ['ci/test'],
+            },
+            required_pull_request_reviews: {
+                dismiss_stale_reviews: true,
+                require_code_owner_reviews: false,
+                required_approving_review_count: 1,
+                dismissal_restrictions: undefined,
+            },
+            restrictions: null,
+            required_conversation_resolution: undefined,
+        });
+        expect(result.branch.name).toEqual('main');
+    });
+    it('creates (updates) protection if protection does not exist (before = null)', async () => {
+        getBranchProtectionModule.getBranchProtection.mockResolvedValue(null);
+        const updatedProtectionResponse = {
+            enforce_admins: { enabled: true },
+            allow_deletions: { enabled: false },
+            allow_force_pushes: { enabled: false },
+            required_linear_history: { enabled: true },
+            required_status_checks: {
+                strict: true,
+                contexts: ['ci/test'],
+            },
+            required_pull_request_reviews: {
+                required_approving_review_count: 1,
+                dismiss_stale_reviews: true,
+            },
+        };
+        mockUpdateBranchProtection.mockResolvedValue({
+            data: updatedProtectionResponse,
+        });
+        castModule.castToDeclaredGithubBranchProtection.mockReturnValue(protectionSample);
+        const result = await setBranchProtection({ finsert: protectionSample }, context);
+        expect(getBranchProtectionModule.getBranchProtection).toHaveBeenCalled();
+        expect(mockUpdateBranchProtection).toHaveBeenCalledWith({
+            owner: 'test-owner',
+            repo: 'test-repo',
+            branch: 'main',
+            enforce_admins: true,
+            allow_deletions: false,
+            allow_force_pushes: false,
+            required_linear_history: true,
+            block_creations: undefined,
+            lock_branch: undefined,
+            allow_fork_syncing: undefined,
+            required_status_checks: {
+                strict: true,
+                contexts: ['ci/test'],
+            },
+            required_pull_request_reviews: {
+                dismiss_stale_reviews: true,
+                require_code_owner_reviews: false,
+                required_approving_review_count: 1,
+                dismissal_restrictions: undefined,
+            },
+            restrictions: null,
+            required_conversation_resolution: undefined,
+        });
+        expect(result.branch.name).toEqual('main');
+    });
+});
+//# sourceMappingURL=setBranchProtection.test.js.map

package/dist/domain.operations/branchProtection/setBranchProtection.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setBranchProtection.test.js","sourceRoot":"","sources":["../../../src/domain.operations/branchProtection/setBranchProtection.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAIA,mFAAqE;AACrE,iFAAmE;AAEnE,8BAA8B;AAC9B,MAAM,0BAA0B,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AAE7C,IAAI,CAAC,IAAI,CAAC,mCAAmC,EAAE,GAAG,EAAE,CAAC,CAAC;IACpD,eAAe,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;QAC9B,KAAK,EAAE;YACL,sBAAsB,EAAE,0BAA0B;SACnD;KACF,CAAC,CAAC;CACJ,CAAC,CAAC,CAAC;AAEJ,IAAI,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;AACpD,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;AAEnC,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAEjE,MAAM,OAAO,GAAyC;IACpD,MAAM,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE;IAC/B,GAAG,EAAE,OAAO;CACb,CAAC;AAEF,MAAM,gBAAgB,GAAmC;IACvD,MAAM,EAAE;QACN,IAAI,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE;QAChD,IAAI,EAAE,MAAM;KACb;IACD,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,KAAK;IACtB,iBAAiB,EAAE,KAAK;IACxB,oBAAoB,EAAE,IAAI;IAC1B,oBAAoB,EAAE;QACpB,MAAM,EAAE,IAAI;QACZ,QAAQ,EAAE,CAAC,SAAS,CAAC;KACtB;IACD,0BAA0B,EAAE;QAC1B,4BAA4B,EAAE,CAAC;QAC/B,mBAAmB,EAAE,IAAI;KAC1B;IACD,YAAY,EAAE,IAAI;CACnB,CAAC;AAEF,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,MAAM,GAAG,EAAE,GAAG,gBAAgB,EAAE,CAAC;QAErC,yBAAyB,CAAC,mBAC3B,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAE5B,MAAM,MAAM,GAAG,MAAM,mBAAmB,CACtC,EAAE,OAAO,EAAE,gBAAgB,EAAE,EAC7B,OAAO,CACR,CAAC;QAEF,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACzE,MAAM,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,MAAM,GAAG,EAAE,GAAG,gBAAgB,EAAE,CAAC;QAErC,yBAAyB,CAAC,mBAC3B,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAE5B,MAAM,yBAAyB,GAAG;YAChC,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;YACjC,eAAe,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;YACnC,kBAAkB,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;YACtC,uBAAuB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;YAC1C,sBAAsB,EAAE;gBACtB,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,CAAC,SAAS,CAAC;aACtB;YACD,6BAA6B,EAAE;gBAC7B,+BAA+B,EAAE,CAAC;gBAClC,qBAAqB,EAAE,IAAI;aAC5B;SACF,CAAC;QAEF,0BAA0B,CAAC,iBAAiB,CAAC;YAC3C,IAAI,EAAE,yBAAyB;SAChC,CAAC,CAAC;QAED,UAAU,CAAC,oCACZ,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAEpC,MAAM,MAAM,GAAG,MAAM,mBAAmB,CACtC,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAC5B,OAAO,CACR,CAAC;QAEF,MAAM,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACzE,MAAM,CAAC,0BAA0B,CAAC,CAAC,oBAAoB,CAAC;YACtD,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,MAAM;YACd,cAAc,EAAE,IAAI;YACpB,eAAe,EAAE,KAAK;YACtB,kBAAkB,EAAE,KAAK;YACzB,uBAAuB,EAAE,IAAI;YAC7B,eAAe,EAAE,SAAS;YAC1B,WAAW,EAAE,SAAS;YACtB,kBAAkB,EAAE,SAAS;YAC7B,sBAAsB,EAAE;gBACtB,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,CAAC,SAAS,CAAC;aACtB;YACD,6BAA6B,EAAE;gBAC7B,qBAAqB,EAAE,IAAI;gBAC3B,0BAA0B,EAAE,KAAK;gBACjC,+BAA+B,EAAE,CAAC;gBAClC,sBAAsB,EAAE,SAAS;aAClC;YACD,YAAY,EAAE,IAAI;YAClB,gCAAgC,EAAE,SAAS;SAC5C,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;QAEvF,yBAAyB,CAAC,mBAC3B,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAE1B,MAAM,yBAAyB,GAAG;YAChC,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;YACjC,eAAe,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;YACnC,kBAAkB,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;YACtC,uBAAuB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;YAC1C,sBAAsB,EAAE;gBACtB,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,CAAC,SAAS,CAAC;aACtB;YACD,6BAA6B,EAAE;gBAC7B,+BAA+B,EAAE,CAAC;gBAClC,qBAAqB,EAAE,IAAI;aAC5B;SACF,CAAC;QAEF,0BAA0B,CAAC,iBAAiB,CAAC;YAC3C,IAAI,EAAE,yBAAyB;SAChC,CAAC,CAAC;QAED,UAAU,CAAC,oCACZ,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAEpC,MAAM,MAAM,GAAG,MAAM,mBAAmB,CACtC,EAAE,OAAO,EAAE,gBAAgB,EAAE,EAC7B,OAAO,CACR,CAAC;QAEF,MAAM,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACzE,MAAM,CAAC,0BAA0B,CAAC,CAAC,oBAAoB,CAAC;YACtD,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,WAAW;YACjB,MAAM,EAAE,MAAM;YACd,cAAc,EAAE,IAAI;YACpB,eAAe,EAAE,KAAK;YACtB,kBAAkB,EAAE,KAAK;YACzB,uBAAuB,EAAE,IAAI;YAC7B,eAAe,EAAE,SAAS;YAC1B,WAAW,EAAE,SAAS;YACtB,kBAAkB,EAAE,SAAS;YAC7B,sBAAsB,EAAE;gBACtB,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,CAAC,SAAS,CAAC;aACtB;YACD,6BAA6B,EAAE;gBAC7B,qBAAqB,EAAE,IAAI;gBAC3B,0BAA0B,EAAE,KAAK;gBACjC,+BAA+B,EAAE,CAAC;gBAClC,sBAAsB,EAAE,SAAS;aAClC;YACD,YAAY,EAAE,IAAI;YAClB,gCAAgC,EAAE,SAAS;SAC5C,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/domain.operations/provider/getDeclastructGithubProvider.d.ts

@@ -0,0 +1,11 @@
+import type { ContextLogTrail } from 'simple-log-methods';
+import { DeclastructGithubProvider } from '../../domain.objects/DeclastructGithubProvider';
+/**
+ * .what = creates a declastruct provider for github resources
+ * .why = enables github resource management via declastruct framework
+ */
+export declare const getDeclastructGithubProvider: (input: {
+    credentials: {
+        token: string;
+    };
+}, context: ContextLogTrail) => DeclastructGithubProvider;

package/dist/domain.operations/provider/getDeclastructGithubProvider.integration.test.d.ts

@@ -0,0 +1 @@
+export {};