declastruct-github 1.0.0

package/dist/domain.objects/DeclaredGithubBranchProtection.d.ts

@@ -0,0 +1,108 @@
+import { DomainEntity, RefByUnique } from 'domain-objects';
+import { DeclaredGithubBranch } from './DeclaredGithubBranch';
+/**
+ * .what = a declarative structure which represents GitHub branch protection rules
+ * .why = enables declarative management of branch protection settings following declastruct patterns
+ */
+export interface DeclaredGithubBranchProtection {
+    /**
+     * .what = reference to the branch this protection applies to
+     * .note = 1:1 relationship - protection is part of branch, not separate resource
+     */
+    branch: RefByUnique<typeof DeclaredGithubBranch>;
+    /**
+     * .what = whether to enforce rules for administrators
+     */
+    enforceAdmins?: boolean;
+    /**
+     * .what = whether to allow branch deletion
+     */
+    allowsDeletions?: boolean;
+    /**
+     * .what = whether to allow force pushes
+     */
+    allowsForcePushes?: boolean;
+    /**
+     * .what = whether to require linear history (no merge commits)
+     */
+    requireLinearHistory?: boolean;
+    /**
+     * .what = whether to block branch creation matching this pattern
+     */
+    blockCreations?: boolean;
+    /**
+     * .what = whether to lock branch (read-only)
+     */
+    lockBranch?: boolean;
+    /**
+     * .what = whether to allow fork syncing
+     */
+    allowForkSyncing?: boolean;
+    /**
+     * .what = required status check settings
+     * .note = null if not configured
+     */
+    requiredStatusChecks?: {
+        /**
+         * .what = whether branch must be up to date before merging
+         */
+        strict: boolean;
+        /**
+         * .what = required status check context names
+         */
+        contexts: string[];
+    } | null;
+    /**
+     * .what = required pull request review settings
+     * .note = null if not configured
+     */
+    requiredPullRequestReviews?: {
+        /**
+         * .what = whether to dismiss stale reviews when new commits are pushed
+         */
+        dismissStaleReviews?: boolean;
+        /**
+         * .what = whether to require review from code owners
+         */
+        requireCodeOwnerReviews?: boolean;
+        /**
+         * .what = number of required approving reviews
+         */
+        requiredApprovingReviewCount?: number;
+        /**
+         * .what = who can dismiss pull request reviews
+         */
+        dismissalRestrictions?: {
+            users?: string[];
+            teams?: string[];
+            apps?: string[];
+        };
+    } | null;
+    /**
+     * .what = who can push to this branch
+     * .note = null if no restrictions
+     */
+    restrictions?: {
+        users?: string[];
+        teams?: string[];
+        apps?: string[];
+    } | null;
+    /**
+     * .what = whether to require signed commits
+     */
+    requiredSignatures?: boolean;
+    /**
+     * .what = whether to require conversation resolution before merging
+     */
+    requiredConversationResolution?: boolean;
+}
+export declare class DeclaredGithubBranchProtection extends DomainEntity<DeclaredGithubBranchProtection> implements DeclaredGithubBranchProtection {
+    static unique: readonly ["branch"];
+    static nested: {
+        branch: {
+            new (props: RefByUnique<typeof DeclaredGithubBranch, any, any, any>): RefByUnique<typeof DeclaredGithubBranch, any, any, any>;
+            build<TDobj extends import("domain-objects").Refable<TShape, TPrimary, TUnique>, TShape extends import("domain-objects/dist/reference/Refable").DomainObjectShape = any, TPrimary extends readonly string[] = any, TUnique extends readonly string[] = any>(props: RefByUnique<TDobj, TShape, TPrimary, TUnique>): RefByUnique<TDobj, TShape, TPrimary, TUnique>;
+            as<TDobj_1 extends import("domain-objects").Refable<TShape_1, TPrimary_1, TUnique_1>, TShape_1 extends import("domain-objects/dist/reference/Refable").DomainObjectShape = any, TPrimary_1 extends readonly string[] = any, TUnique_1 extends readonly string[] = any>(props: RefByUnique<TDobj_1, TShape_1, TPrimary_1, TUnique_1>): RefByUnique<TDobj_1, TShape_1, TPrimary_1, TUnique_1>;
+        };
+    };
+}

package/dist/domain.objects/DeclaredGithubBranchProtection.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeclaredGithubBranchProtection = void 0;
+const domain_objects_1 = require("domain-objects");
+class DeclaredGithubBranchProtection extends domain_objects_1.DomainEntity {
+}
+exports.DeclaredGithubBranchProtection = DeclaredGithubBranchProtection;
+DeclaredGithubBranchProtection.unique = ['branch'];
+DeclaredGithubBranchProtection.nested = {
+    branch: (domain_objects_1.RefByUnique),
+};
+//# sourceMappingURL=DeclaredGithubBranchProtection.js.map

package/dist/domain.objects/DeclaredGithubBranchProtection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclaredGithubBranchProtection.js","sourceRoot":"","sources":["../../src/domain.objects/DeclaredGithubBranchProtection.ts"],"names":[],"mappings":";;;AAAA,mDAA2D;AAqH3D,MAAa,8BACX,SAAQ,6BAA4C;;AADtD,wEAQC;AAJe,qCAAM,GAAG,CAAC,QAAQ,CAAU,CAAC;AAC7B,qCAAM,GAAG;IACrB,MAAM,EAAE,CAAA,4BAAwC,CAAA;CACjD,CAAC"}

package/dist/domain.objects/DeclaredGithubRepo.d.ts

@@ -0,0 +1,57 @@
+import { UniDateTime } from '@ehmpathy/uni-time';
+import { DomainEntity } from 'domain-objects';
+/**
+ * .what = a declarative structure which represents a GitHub repository
+ * .why = enables declarative management of GitHub repos following declastruct patterns
+ */
+export interface DeclaredGithubRepo {
+    /**
+     * .what = GitHub's internal repo ID
+     * .note = is @metadata -> may be undefined
+     */
+    id?: number;
+    /**
+     * .what = when the repo was created
+     * .note = is @metadata -> may be undefined
+     */
+    createdAt?: UniDateTime;
+    /**
+     * .what = when the repo was last updated
+     * .note = is @metadata -> may be undefined
+     */
+    updatedAt?: UniDateTime;
+    /**
+     * .what = organization or user name
+     */
+    owner: string;
+    /**
+     * .what = repository name
+     */
+    name: string;
+    /**
+     * .what = repository description
+     * .note = null if not set
+     */
+    description: string | null;
+    /**
+     * .what = homepage URL
+     * .note = null if not set
+     */
+    homepage: string | null;
+    /**
+     * .what = whether the repo is private
+     */
+    private: boolean;
+    /**
+     * .what = visibility setting
+     * .note = public, private, or internal (for enterprise)
+     */
+    visibility: 'public' | 'private' | 'internal';
+    /**
+     * .what = whether the repo is archived
+     */
+    archived: boolean;
+}
+export declare class DeclaredGithubRepo extends DomainEntity<DeclaredGithubRepo> implements DeclaredGithubRepo {
+    static unique: readonly ["owner", "name"];
+}

package/dist/domain.objects/DeclaredGithubRepo.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeclaredGithubRepo = void 0;
+const domain_objects_1 = require("domain-objects");
+class DeclaredGithubRepo extends domain_objects_1.DomainEntity {
+}
+exports.DeclaredGithubRepo = DeclaredGithubRepo;
+DeclaredGithubRepo.unique = ['owner', 'name'];
+//# sourceMappingURL=DeclaredGithubRepo.js.map

package/dist/domain.objects/DeclaredGithubRepo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclaredGithubRepo.js","sourceRoot":"","sources":["../../src/domain.objects/DeclaredGithubRepo.ts"],"names":[],"mappings":";;;AACA,mDAA8C;AAgE9C,MAAa,kBACX,SAAQ,6BAAgC;;AAD1C,gDAKC;AADe,yBAAM,GAAG,CAAC,OAAO,EAAE,MAAM,CAAU,CAAC"}

package/dist/domain.objects/DeclaredGithubRepoConfig.d.ts

@@ -0,0 +1,100 @@
+import { DomainEntity, RefByUnique } from 'domain-objects';
+import { DeclaredGithubRepo } from './DeclaredGithubRepo';
+/**
+ * .what = a declarative structure which represents a GitHub repository's configuration
+ * .why = enables declarative management of GitHub repo config settings following declastruct patterns
+ */
+export interface DeclaredGithubRepoConfig {
+    /**
+     * .what = reference to the repository this configuration belongs to
+     * .note = 1:1 relationship - config is part of repo, not separate resource
+     */
+    repo: RefByUnique<typeof DeclaredGithubRepo>;
+    /**
+     * .what = name of the default branch
+     * .note = e.g., 'main', 'master', 'develop'
+     */
+    defaultBranch?: string;
+    /**
+     * .what = whether issues are enabled
+     */
+    hasIssues?: boolean;
+    /**
+     * .what = whether projects are enabled
+     */
+    hasProjects?: boolean;
+    /**
+     * .what = whether wiki is enabled
+     */
+    hasWiki?: boolean;
+    /**
+     * .what = whether downloads are enabled
+     */
+    hasDownloads?: boolean;
+    /**
+     * .what = whether this is a template repository
+     */
+    isTemplate?: boolean;
+    /**
+     * .what = whether squash merging is allowed
+     */
+    allowSquashMerge?: boolean;
+    /**
+     * .what = whether merge commits are allowed
+     */
+    allowMergeCommit?: boolean;
+    /**
+     * .what = whether rebase merging is allowed
+     */
+    allowRebaseMerge?: boolean;
+    /**
+     * .what = whether auto-merge is allowed
+     * .note = may be undefined
+     */
+    allowAutoMerge?: boolean;
+    /**
+     * .what = whether to delete head branches after PRs are merged
+     * .note = may be undefined
+     */
+    deleteBranchOnMerge?: boolean;
+    /**
+     * .what = whether to allow updating branches with latest base branch
+     * .note = may be undefined
+     */
+    allowUpdateBranch?: boolean;
+    /**
+     * .what = default commit title for squash merges
+     * .note = may be undefined
+     */
+    squashMergeCommitTitle?: 'PR_TITLE' | 'COMMIT_OR_PR_TITLE';
+    /**
+     * .what = default commit message for squash merges
+     * .note = may be undefined
+     */
+    squashMergeCommitMessage?: 'PR_BODY' | 'COMMIT_MESSAGES' | 'BLANK';
+    /**
+     * .what = default commit title for merge commits
+     * .note = may be undefined
+     */
+    mergeCommitTitle?: 'PR_TITLE' | 'MERGE_MESSAGE';
+    /**
+     * .what = default commit message for merge commits
+     * .note = may be undefined
+     */
+    mergeCommitMessage?: 'PR_TITLE' | 'PR_BODY' | 'BLANK';
+    /**
+     * .what = whether web commit signoff is required
+     * .note = may be undefined
+     */
+    webCommitSignoffRequired?: boolean;
+}
+export declare class DeclaredGithubRepoConfig extends DomainEntity<DeclaredGithubRepoConfig> implements DeclaredGithubRepoConfig {
+    static unique: readonly ["repo"];
+    static nested: {
+        repo: {
+            new (props: RefByUnique<typeof DeclaredGithubRepo, any, any, any>): RefByUnique<typeof DeclaredGithubRepo, any, any, any>;
+            build<TDobj extends import("domain-objects").Refable<TShape, TPrimary, TUnique>, TShape extends import("domain-objects/dist/reference/Refable").DomainObjectShape = any, TPrimary extends readonly string[] = any, TUnique extends readonly string[] = any>(props: RefByUnique<TDobj, TShape, TPrimary, TUnique>): RefByUnique<TDobj, TShape, TPrimary, TUnique>;
+            as<TDobj_1 extends import("domain-objects").Refable<TShape_1, TPrimary_1, TUnique_1>, TShape_1 extends import("domain-objects/dist/reference/Refable").DomainObjectShape = any, TPrimary_1 extends readonly string[] = any, TUnique_1 extends readonly string[] = any>(props: RefByUnique<TDobj_1, TShape_1, TPrimary_1, TUnique_1>): RefByUnique<TDobj_1, TShape_1, TPrimary_1, TUnique_1>;
+        };
+    };
+}

package/dist/domain.objects/DeclaredGithubRepoConfig.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeclaredGithubRepoConfig = void 0;
+const domain_objects_1 = require("domain-objects");
+class DeclaredGithubRepoConfig extends domain_objects_1.DomainEntity {
+}
+exports.DeclaredGithubRepoConfig = DeclaredGithubRepoConfig;
+DeclaredGithubRepoConfig.unique = ['repo'];
+DeclaredGithubRepoConfig.nested = {
+    repo: (domain_objects_1.RefByUnique),
+};
+//# sourceMappingURL=DeclaredGithubRepoConfig.js.map

package/dist/domain.objects/DeclaredGithubRepoConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclaredGithubRepoConfig.js","sourceRoot":"","sources":["../../src/domain.objects/DeclaredGithubRepoConfig.ts"],"names":[],"mappings":";;;AAAA,mDAA2D;AA8G3D,MAAa,wBACX,SAAQ,6BAAsC;;AADhD,4DAQC;AAJe,+BAAM,GAAG,CAAC,MAAM,CAAU,CAAC;AAC3B,+BAAM,GAAG;IACrB,IAAI,EAAE,CAAA,4BAAsC,CAAA;CAC7C,CAAC"}

package/dist/domain.objects/DeclastructGithubProvider.d.ts

@@ -0,0 +1,17 @@
+import { DeclastructDao, DeclastructProvider } from 'declastruct';
+import type { ContextLogTrail } from 'simple-log-methods';
+import { ContextGithubApi } from './ContextGithubApi';
+import { DeclaredGithubBranch } from './DeclaredGithubBranch';
+import { DeclaredGithubBranchProtection } from './DeclaredGithubBranchProtection';
+import { DeclaredGithubRepo } from './DeclaredGithubRepo';
+import { DeclaredGithubRepoConfig } from './DeclaredGithubRepoConfig';
+/**
+ * .what = the declastruct provider for github resources
+ * .why = provides type safety and reusability for the github provider
+ */
+export type DeclastructGithubProvider = DeclastructProvider<{
+    DeclaredGithubRepo: DeclastructDao<DeclaredGithubRepo, typeof DeclaredGithubRepo, ContextGithubApi & ContextLogTrail>;
+    DeclaredGithubBranch: DeclastructDao<DeclaredGithubBranch, typeof DeclaredGithubBranch, ContextGithubApi & ContextLogTrail>;
+    DeclaredGithubRepoConfig: DeclastructDao<DeclaredGithubRepoConfig, typeof DeclaredGithubRepoConfig, ContextGithubApi & ContextLogTrail>;
+    DeclaredGithubBranchProtection: DeclastructDao<DeclaredGithubBranchProtection, typeof DeclaredGithubBranchProtection, ContextGithubApi & ContextLogTrail>;
+}, ContextGithubApi & ContextLogTrail>;

package/dist/domain.objects/DeclastructGithubProvider.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeclastructGithubProvider.js.map

package/dist/domain.objects/DeclastructGithubProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeclastructGithubProvider.js","sourceRoot":"","sources":["../../src/domain.objects/DeclastructGithubProvider.ts"],"names":[],"mappings":""}

package/dist/domain.operations/branch/castToDeclaredGithubBranch.d.ts

@@ -0,0 +1,15 @@
+import { Endpoints } from '@octokit/types';
+import { RefByUnique } from 'domain-objects';
+import { HasMetadata } from 'type-fns';
+import { DeclaredGithubBranch } from '../../domain.objects/DeclaredGithubBranch';
+import { DeclaredGithubRepo } from '../../domain.objects/DeclaredGithubRepo';
+type GithubBranchResponse = Endpoints['GET /repos/{owner}/{repo}/branches/{branch}']['response']['data'] | Endpoints['GET /repos/{owner}/{repo}/branches']['response']['data'][number];
+/**
+ * .what = casts GitHub API branch response to DeclaredGithubBranch
+ * .why = transforms external API shape to our domain model with type safety and validation
+ */
+export declare const castToDeclaredGithubBranch: (input: {
+    branch: GithubBranchResponse;
+    repo: RefByUnique<typeof DeclaredGithubRepo>;
+}) => HasMetadata<DeclaredGithubBranch>;
+export {};

package/dist/domain.operations/branch/castToDeclaredGithubBranch.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.castToDeclaredGithubBranch = void 0;
+const domain_objects_1 = require("domain-objects");
+const helpful_errors_1 = require("helpful-errors");
+const type_fns_1 = require("type-fns");
+const DeclaredGithubBranch_1 = require("../../domain.objects/DeclaredGithubBranch");
+const DeclaredGithubRepo_1 = require("../../domain.objects/DeclaredGithubRepo");
+/**
+ * .what = extracts required value from object or throws
+ * .why = ensures type safety and fail-fast behavior for missing required fields
+ */
+const getOrThrow = (obj, key) => {
+    const value = obj[key];
+    // if its not undefined, return it
+    if ((0, type_fns_1.isNotUndefined)(value))
+        return value;
+    // otherwise, fail fast
+    helpful_errors_1.UnexpectedCodePathError.throw(`${String(key)} not found on response`, {
+        input: obj,
+        key,
+    });
+};
+/**
+ * .what = casts GitHub API branch response to DeclaredGithubBranch
+ * .why = transforms external API shape to our domain model with type safety and validation
+ */
+const castToDeclaredGithubBranch = (input) => {
+    return DeclaredGithubBranch_1.DeclaredGithubBranch.as({
+        name: getOrThrow(input.branch, 'name'),
+        repo: input.repo instanceof DeclaredGithubRepo_1.DeclaredGithubRepo
+            ? (0, domain_objects_1.refByUnique)(input.repo)
+            : input.repo,
+        commit: { sha: getOrThrow(getOrThrow(input.branch, 'commit'), 'sha') },
+        protected: input.branch.protected,
+    });
+};
+exports.castToDeclaredGithubBranch = castToDeclaredGithubBranch;
+//# sourceMappingURL=castToDeclaredGithubBranch.js.map

package/dist/domain.operations/branch/castToDeclaredGithubBranch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"castToDeclaredGithubBranch.js","sourceRoot":"","sources":["../../../src/domain.operations/branch/castToDeclaredGithubBranch.ts"],"names":[],"mappings":";;;AACA,mDAA0D;AAC1D,mDAAyD;AACzD,uCAAqE;AAErE,oFAAiF;AACjF,gFAA6E;AAE7E;;;GAGG;AACH,MAAM,UAAU,GAAG,CACjB,GAAM,EACN,GAAM,EACc,EAAE;IACtB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;IAEvB,kCAAkC;IAClC,IAAI,IAAA,yBAAc,EAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAExC,uBAAuB;IACvB,wCAAuB,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE;QACpE,KAAK,EAAE,GAAG;QACV,GAAG;KACJ,CAAC,CAAC;AACL,CAAC,CAAC;AAMF;;;GAGG;AACI,MAAM,0BAA0B,GAAG,CAAC,KAG1C,EAAqC,EAAE;IACtC,OAAO,2CAAoB,CAAC,EAAE,CAAC;QAC7B,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC;QACtC,IAAI,EACF,KAAK,CAAC,IAAI,YAAY,uCAAkB;YACtC,CAAC,CAAC,IAAA,4BAAW,EAA4B,KAAK,CAAC,IAAI,CAAC;YACpD,CAAC,CAAC,KAAK,CAAC,IAAI;QAChB,MAAM,EAAE,EAAE,GAAG,EAAE,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,EAAE;QACtE,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS;KAClC,CAAsC,CAAC;AAC1C,CAAC,CAAC;AAbW,QAAA,0BAA0B,8BAarC"}

package/dist/domain.operations/branch/getBranch.d.ts

@@ -0,0 +1,14 @@
+import { RefByUnique } from 'domain-objects';
+import { HasMetadata, PickOne } from 'type-fns';
+import { VisualogicContext } from 'visualogic';
+import { ContextGithubApi } from '../../domain.objects/ContextGithubApi';
+import { DeclaredGithubBranch } from '../../domain.objects/DeclaredGithubBranch';
+/**
+ * .what = gets a GitHub branch
+ * .why = retrieves current state of a branch from GitHub API for declarative management
+ */
+export declare const getBranch: (input: {
+    by: PickOne<{
+        unique: RefByUnique<typeof DeclaredGithubBranch>;
+    }>;
+}, context: ContextGithubApi & VisualogicContext) => Promise<HasMetadata<DeclaredGithubBranch> | null>;

package/dist/domain.operations/branch/getBranch.integration.test.d.ts

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

package/dist/domain.operations/branch/getBranch.integration.test.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_fns_1 = require("test-fns");
+const getSampleGithubContext_1 = require("../../.test/assets/getSampleGithubContext");
+const getSampleRepo_1 = require("../../.test/assets/getSampleRepo");
+const getBranch_1 = require("./getBranch");
+const log = console;
+describe('getBranch', () => {
+    const context = { log, ...(0, getSampleGithubContext_1.getSampleGithubContext)() };
+    (0, test_fns_1.given)('a live example repo with a main branch', () => {
+        (0, test_fns_1.then)('we should be able to get the branch state', async () => {
+            const sampleRepo = (0, getSampleRepo_1.getSampleRepo)({
+                owner: 'ehmpathy',
+                name: 'declastruct-github-demo',
+            });
+            const branch = await (0, getBranch_1.getBranch)({
+                by: {
+                    unique: {
+                        repo: {
+                            owner: sampleRepo.owner,
+                            name: sampleRepo.name,
+                        },
+                        name: 'main',
+                    },
+                },
+            }, context);
+            console.log(branch);
+            expect(branch).toBeDefined();
+            expect(branch?.name).toBe('main');
+            expect(branch?.repo).toEqual({
+                owner: sampleRepo.owner,
+                name: sampleRepo.name,
+            });
+            expect(branch?.commit?.sha).toBeDefined();
+            expect(typeof branch?.protected).toBe('boolean');
+        });
+    });
+    (0, test_fns_1.given)('a branch that does not exist', () => {
+        (0, test_fns_1.then)('it should return null', async () => {
+            const sampleRepo = (0, getSampleRepo_1.getSampleRepo)({
+                owner: 'ehmpathy',
+                name: 'declastruct-github-demo',
+            });
+            const branch = await (0, getBranch_1.getBranch)({
+                by: {
+                    unique: {
+                        repo: {
+                            owner: sampleRepo.owner,
+                            name: sampleRepo.name,
+                        },
+                        name: 'branch-that-does-not-exist-99999',
+                    },
+                },
+            }, context);
+            expect(branch).toBeNull();
+        });
+    });
+});
+//# sourceMappingURL=getBranch.integration.test.js.map

package/dist/domain.operations/branch/getBranch.integration.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBranch.integration.test.js","sourceRoot":"","sources":["../../../src/domain.operations/branch/getBranch.integration.test.ts"],"names":[],"mappings":";;AAAA,uCAAuC;AAEvC,sFAAmF;AACnF,oEAAiE;AACjE,2CAAwC;AAExC,MAAM,GAAG,GAAG,OAAO,CAAC;AAEpB,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,GAAG,IAAA,+CAAsB,GAAE,EAAE,CAAC;IAErD,IAAA,gBAAK,EAAC,wCAAwC,EAAE,GAAG,EAAE;QACnD,IAAA,eAAI,EAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,UAAU,GAAG,IAAA,6BAAa,EAAC;gBAC/B,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,yBAAyB;aAChC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAS,EAC5B;gBACE,EAAE,EAAE;oBACF,MAAM,EAAE;wBACN,IAAI,EAAE;4BACJ,KAAK,EAAE,UAAU,CAAC,KAAK;4BACvB,IAAI,EAAE,UAAU,CAAC,IAAI;yBACtB;wBACD,IAAI,EAAE,MAAM;qBACb;iBACF;aACF,EACD,OAAO,CACR,CAAC;YAEF,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAClC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC3B,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,IAAI,EAAE,UAAU,CAAC,IAAI;aACtB,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,CAAC,OAAO,MAAM,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,gBAAK,EAAC,8BAA8B,EAAE,GAAG,EAAE;QACzC,IAAA,eAAI,EAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACvC,MAAM,UAAU,GAAG,IAAA,6BAAa,EAAC;gBAC/B,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,yBAAyB;aAChC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,IAAA,qBAAS,EAC5B;gBACE,EAAE,EAAE;oBACF,MAAM,EAAE;wBACN,IAAI,EAAE;4BACJ,KAAK,EAAE,UAAU,CAAC,KAAK;4BACvB,IAAI,EAAE,UAAU,CAAC,IAAI;yBACtB;wBACD,IAAI,EAAE,kCAAkC;qBACzC;iBACF;aACF,EACD,OAAO,CACR,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/domain.operations/branch/getBranch.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBranch = void 0;
+const as_procedure_1 = require("as-procedure");
+const helpful_errors_1 = require("helpful-errors");
+const getGithubClient_1 = require("../../access/sdks/getGithubClient");
+const castToDeclaredGithubBranch_1 = require("./castToDeclaredGithubBranch");
+/**
+ * .what = gets a GitHub branch
+ * .why = retrieves current state of a branch from GitHub API for declarative management
+ */
+exports.getBranch = (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 { repo, branch } = (() => {
+        if (input.by.unique) {
+            return {
+                repo: input.by.unique.repo,
+                branch: input.by.unique.name,
+            };
+        }
+        helpful_errors_1.UnexpectedCodePathError.throw('not referenced by unique. how not?', {
+            input,
+        });
+    })();
+    // execute the GitHub API call
+    try {
+        const response = await github.repos.getBranch({
+            owner: repo.owner,
+            repo: repo.name,
+            branch,
+        });
+        return (0, castToDeclaredGithubBranch_1.castToDeclaredGithubBranch)({
+            branch: response.data,
+            repo: input.by.unique.repo,
+        });
+    }
+    catch (error) {
+        if (!(error instanceof Error))
+            throw error;
+        // return null for 404/not found
+        if (error.message.includes('Not Found') ||
+            error.message.includes('Branch not found'))
+            return null;
+        // throw helpful error for all other failures
+        throw new helpful_errors_1.HelpfulError('github.getBranch error', { cause: error });
+    }
+});
+//# sourceMappingURL=getBranch.js.map

package/dist/domain.operations/branch/getBranch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBranch.js","sourceRoot":"","sources":["../../../src/domain.operations/branch/getBranch.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE3C,mDAAuE;AAIvE,uEAAoE;AAGpE,6EAA0E;AAE1E;;;GAGG;AACU,QAAA,SAAS,GAAG,IAAA,0BAAW,EAClC,KAAK,EACH,KAIC,EACD,OAA6C,EACM,EAAE;IACrD,2BAA2B;IAC3B,MAAM,MAAM,GAAG,IAAA,iCAAe,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE5C,oDAAoD;IACpD,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE;QAC7B,IAAI,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO;gBACL,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI;gBAC1B,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI;aAC7B,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,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;YAC5C,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM;SACP,CAAC,CAAC;QACH,OAAO,IAAA,uDAA0B,EAAC;YAChC,MAAM,EAAE,QAAQ,CAAC,IAAI;YACrB,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI;SAC3B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;YAAE,MAAM,KAAK,CAAC;QAE3C,gCAAgC;QAChC,IACE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;YACnC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAE1C,OAAO,IAAI,CAAC;QAEd,6CAA6C;QAC7C,MAAM,IAAI,6BAAY,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACrE,CAAC;AACH,CAAC,CACF,CAAC"}

package/dist/domain.operations/branch/getBranchCommitShaByRepoDefault.d.ts

@@ -0,0 +1,11 @@
+import { RefByUnique } from 'domain-objects';
+import { VisualogicContext } from 'visualogic';
+import { ContextGithubApi } from '../../domain.objects/ContextGithubApi';
+import { DeclaredGithubRepo } from '../../domain.objects/DeclaredGithubRepo';
+/**
+ * .what = gets the commit SHA of a repository's default branch
+ * .why = enables creating branches from the default branch when no commit SHA is specified
+ */
+export declare const getBranchCommitShaByRepoDefault: (input: {
+    repo: RefByUnique<typeof DeclaredGithubRepo>;
+}, context: ContextGithubApi & VisualogicContext) => Promise<string>;

package/dist/domain.operations/branch/getBranchCommitShaByRepoDefault.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBranchCommitShaByRepoDefault = void 0;
+const helpful_errors_1 = require("helpful-errors");
+const getGithubClient_1 = require("../../access/sdks/getGithubClient");
+const getBranch_1 = require("./getBranch");
+/**
+ * .what = gets the commit SHA of a repository's default branch
+ * .why = enables creating branches from the default branch when no commit SHA is specified
+ */
+const getBranchCommitShaByRepoDefault = async (input, context) => {
+    // get cached GitHub client
+    const github = (0, getGithubClient_1.getGithubClient)({}, context);
+    // get the repository to find its default branch
+    const repoResponse = await github.repos.get({
+        owner: input.repo.owner,
+        repo: input.repo.name,
+    });
+    const defaultBranch = repoResponse.data.default_branch;
+    // get the default branch to find its commit SHA
+    const defaultBranchData = await (0, getBranch_1.getBranch)({
+        by: {
+            unique: {
+                repo: input.repo,
+                name: defaultBranch,
+            },
+        },
+    }, context);
+    if (!defaultBranchData?.commit?.sha) {
+        helpful_errors_1.UnexpectedCodePathError.throw('default branch has no commit', {
+            defaultBranch,
+        });
+    }
+    return defaultBranchData.commit.sha;
+};
+exports.getBranchCommitShaByRepoDefault = getBranchCommitShaByRepoDefault;
+//# sourceMappingURL=getBranchCommitShaByRepoDefault.js.map

package/dist/domain.operations/branch/getBranchCommitShaByRepoDefault.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBranchCommitShaByRepoDefault.js","sourceRoot":"","sources":["../../../src/domain.operations/branch/getBranchCommitShaByRepoDefault.ts"],"names":[],"mappings":";;;AACA,mDAAyD;AAGzD,uEAAoE;AAGpE,2CAAwC;AAExC;;;GAGG;AACI,MAAM,+BAA+B,GAAG,KAAK,EAClD,KAEC,EACD,OAA6C,EAC5B,EAAE;IACnB,2BAA2B;IAC3B,MAAM,MAAM,GAAG,IAAA,iCAAe,EAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAE5C,gDAAgD;IAChD,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;QAC1C,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK;QACvB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI;KACtB,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC;IAEvD,gDAAgD;IAChD,MAAM,iBAAiB,GAAG,MAAM,IAAA,qBAAS,EACvC;QACE,EAAE,EAAE;YACF,MAAM,EAAE;gBACN,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,IAAI,EAAE,aAAa;aACpB;SACF;KACF,EACD,OAAO,CACR,CAAC;IAEF,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;QACpC,wCAAuB,CAAC,KAAK,CAAC,8BAA8B,EAAE;YAC5D,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED,OAAO,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC;AACtC,CAAC,CAAC;AArCW,QAAA,+BAA+B,mCAqC1C"}

package/dist/domain.operations/branch/getBranches.d.ts

@@ -0,0 +1,23 @@
+import { RefByUnique } from 'domain-objects';
+import { HasMetadata } from 'type-fns';
+import { VisualogicContext } from 'visualogic';
+import { ContextGithubApi } from '../../domain.objects/ContextGithubApi';
+import { DeclaredGithubBranch } from '../../domain.objects/DeclaredGithubBranch';
+import { DeclaredGithubRepo } from '../../domain.objects/DeclaredGithubRepo';
+/**
+ * .what = lists GitHub branches for a repository
+ * .why = retrieves multiple branches from GitHub API for declarative management
+ */
+export declare const getBranches: (input: {
+    where: {
+        repo: RefByUnique<typeof DeclaredGithubRepo>;
+    };
+    page?: {
+        range?: {
+            until: {
+                page: number;
+            };
+        };
+        limit?: number;
+    };
+}, context: ContextGithubApi & VisualogicContext) => Promise<HasMetadata<DeclaredGithubBranch>[]>;

package/dist/domain.operations/branch/getBranches.integration.test.d.ts

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