@effected/github 0.6.1 → 0.8.0

package/GitHubRepository.js

@@ -5,6 +5,47 @@ import { Context, Effect, Layer, Schema } from "effect";
 
 //#region src/GitHubRepository.ts
 /**
+* A {@link RepositoryPatch} from a draft, dropping every explicitly-`undefined`
+* field.
+*
+* @remarks
+* The supported spelling for "apply only what was configured" — the natural
+* shape for a sync action, and the one the checker cannot follow on its own.
+* Without it a consumer under the recommended tsconfig is quietly pushed toward
+* `as`, which is a real cost in a package whose stated design property is that
+* the route is the key and there are no casts.
+*
+* Dropping the key rather than sending `undefined` is what the wire needs:
+* `PATCH` treats an absent field as "leave it alone", while an explicit `null`
+* or `undefined` is a value.
+*
+* A key-by-key loop still defeats TypeScript's correlation between two indexed
+* accesses (`draft[key] = source[key]` over a union `key`), which no helper can
+* fix — build the draft as a literal where you can.
+*
+* @example
+* ```ts
+* import { repositoryPatch } from "@effected/github";
+*
+* // `config.has_issues` is `boolean | undefined`; absent fields drop out.
+* const patch = repositoryPatch({
+*   has_issues: config.has_issues,
+*   has_wiki: config.has_wiki,
+*   description: config.description,
+* });
+* ```
+*
+* @param draft - The fields to apply, any of which may be `undefined`.
+* @returns A patch carrying only the fields that were actually set.
+*
+* @public
+*/
+const repositoryPatch = (draft) => {
+	const out = {};
+	for (const [key, value] of Object.entries(draft)) if (value !== void 0) out[key] = value;
+	return out;
+};
+/**
 * Fields in the user-facing `security_and_analysis` block that GitHub accepts
 * as `{ status: "enabled" | "disabled" }`.
 *
@@ -234,4 +275,4 @@ const make = (client) => {
 };
 
 //#endregion
-export { GRAPHQL_ONLY_SETTINGS, GitHubRepository, SECURITY_ANALYSIS_STATUS_FIELDS, transformSecurityAndAnalysis };
+export { GRAPHQL_ONLY_SETTINGS, GitHubRepository, SECURITY_ANALYSIS_STATUS_FIELDS, repositoryPatch, transformSecurityAndAnalysis };

package/README.md

@@ -122,7 +122,7 @@ const program = Effect.gen(function* () {
 
 The existence check pages the issue's comments to the end and matches the marker in `upsert`'s exact spelling, so a comment either member writes stays findable by the other. It is a look-before-write: two runs racing on the same issue can both see no marker and both post, so treat the marker as the record rather than the check as a lock.
 
-Whether a run should comment at all usually turns on which issues a pull request closes, and that is a grammar rather than an API call. `IssueReferences` is that grammar as plain functions — no service, no layer, nothing but strings in — in the two dialects consumers actually write:
+Whether a run should comment at all usually turns on which issues a pull request closes, and that is a grammar rather than an API call. That grammar now lives in [`@effected/github-references`](https://www.npmjs.com/package/@effected/github-references), a pure package with no octokit behind it; this package re-exports the two dialects it used to own so existing code keeps compiling:
 
 ```ts
 import { harvestIssueReferences, parseBareLineReference } from "@effected/github";
@@ -140,6 +140,8 @@ console.log(parseBareLineReference("closes #12 for real"));
 
 `harvestIssueReferences` reads the **inline-in-prose** dialect: one of the nine closing keywords (`CLOSING_KEYWORDS`) followed by whitespace and `#<number>`, anywhere in the text, no colon — the spelling GitHub itself scans a pull request body for. Duplicates come back as written, because whether `fixes #1, fixes #1` means one intent or two is the caller's question. `parseBareLineReference` reads the **bare-line** dialect, where the whole trimmed line is the reference and the colon is optional — the shape a generated references block writes, one per line. Cross-repo (`owner/repo#12`) and full-URL references are out of scope.
 
+The re-export covers exactly six names — `CLOSING_KEYWORDS`, `ClosingKeyword`, `IssueReference`, `harvestIssueReferences`, `BareLineReference`, `parseBareLineReference` — and may be dropped at a later release. Import from `@effected/github-references` directly for new code; it also carries a third dialect this package does not re-export, the closing list (`Closes #247, #248 and #251`).
+
 ## Repository configuration
 
 Six services cover the half of a repository that is policy rather than content: `RepositorySecret`, `RepositoryVariable`, `Ruleset`, `DeploymentEnvironment`, `RepositorySecurity` and `CodeScanning`. They are shaped for a program applying the same configuration across a fleet, so every list read paginates to the end and a truncated page never becomes a wrong decision.
@@ -187,6 +189,19 @@ const program = Effect.gen(function* () {
 // GitHub would reject, which is what a person reading a dry run is checking for.
 ```
 
+`updateSettings` takes octokit's own generated params, and those spell an optional field as `has_issues?: boolean` rather than `has_issues?: boolean | undefined` — so under `exactOptionalPropertyTypes` a `Partial<T>` built from your own settings schema does not assign to it at all. `repositoryPatch` is the supported way out, and it exists so the answer is never a cast:
+
+```ts
+import { repositoryPatch } from "@effected/github";
+
+declare const config: { has_issues?: boolean | undefined; description?: string | undefined };
+
+const patch = repositoryPatch({ has_issues: config.has_issues, description: config.description });
+// a RepositoryPatch carrying only the fields that were actually set
+```
+
+Dropping the key is what the wire needs: `PATCH` reads an absent field as "leave it alone", while an explicit `null` is a value. `RepositoryPatchDraft` is the input type — the same fields, each allowed to be an explicit `undefined`. Build the draft as an object literal where you can: a key-by-key loop defeats TypeScript's correlation between two indexed accesses, which no helper can repair.
+
 `security_and_analysis` accepts both the bare `"enabled"` a human writes in a config file and the `{ status: "enabled" }` GitHub's own parameter type declares. A map touching neither GraphQL-only setting never reads the node id, so the common case stays one request. `ownerType` answers `"User"` or `"Organization"` for the repository in `Repo`, which is how a shared settings template drops the fields GitHub accepts only on an organization-owned repository before applying itself to a personal one.
 
 ## GitHub App authentication
@@ -266,6 +281,7 @@ const TestClient = GitHubClient.layerFixture(fixtures);
 - `GitHubClient` — the typed transport: `request`, `requestDecoded` (a mandatory-schema escape hatch for routes outside the generated map), `paginate` / `paginateStream`, `graphql`, and `rateLimit` (observation only — nothing here throttles on your behalf).
 - `Repo` / `RepoRef` — the `{ owner, repo }` coordinate, resolved per call through `R`, with `Repo.provide` for multi-repository programs.
 - `GitHubRepository` — the repository's settings as GitHub's own generated type, plus `defaultBranch`, `nodeId`, `ownerType` for gating organization-only fields, and `applySettings` reporting the keys it actually sent.
+- `repositoryPatch` / `RepositoryPatchDraft` — build an `updateSettings` patch from fields that may be `undefined`, under `exactOptionalPropertyTypes`, without a cast.
 - `GitHubError` / `GitHubGraphQLError` — one error per transport, `kind`-routed with `hasKind` for `Effect.catchIf`.
 - `RetryPolicy` — the client's one retry policy: full-jitter backoff, server-advised delays honored up to a ceiling.
 - `GitHubApp` — App JWT signing, installation token minting/revocation, app and installation identity, and `clientLayer` for an App-authenticated `GitHubClient`.
@@ -273,7 +289,7 @@ const TestClient = GitHubClient.layerFixture(fixtures);
 - `CheckRun` — `withCheckRun` concludes on every exit path; `CheckRunOutput.truncated()` cuts rendered output to GitHub's byte limits.
 - `PullRequest` / `PullRequestComment` — upserts for both, `listFiles` answering with the same full `CommitFile` records a commit read returns, `headSha`/`baseSha` on `PullRequestInfo`, plus `CommentMarker` for finding a sticky comment again.
 - `GitHubIssue` — issues and their comments, including `commentOnce` for a marked comment that is posted exactly once and never edited, and `linkedIssues` for what a pull request closes.
-- `IssueReferences` — GitHub's nine closing keywords as pure functions: `harvestIssueReferences` for references inline in prose, `parseBareLineReference` for one-per-line generated ones.
+- `harvestIssueReferences` / `parseBareLineReference` — a compatibility re-export of the two closing-reference dialects that moved to `@effected/github-references`, with `CLOSING_KEYWORDS` and their result types.
 - `GitHubRelease` — releases and asset uploads, including the one route (`uploadAsset`, with the endpoint's optional display label) outside GitHub's generated endpoint map.
 - `RepositorySecret` / `RepositoryVariable` — repository and environment secrets and variables, with the sealed-box encryption GitHub's secrets API demands kept in one module nothing else imports.
 - `Ruleset` / `DeploymentEnvironment` / `RepositorySecurity` / `CodeScanning` — the rest of the configuration tier: rulesets matched by name and scope, idempotent environment writes, the three security toggles GitHub keeps off the repository endpoint, and CodeQL default setup with the language detection that gates it.

package/index.d.ts

@@ -1,3 +1,4 @@
+import { BareLineReference, CLOSING_KEYWORDS, ClosingKeyword, IssueReference, harvestIssueReferences, parseBareLineReference } from "@effected/github-references";
 import { Config, Context, Duration, Effect, Layer, Option, Redacted, Result, Schedule, Schema, Scope, Stream } from "effect";
 import { PaginatingEndpoints } from "@octokit/plugin-paginate-rest";
 import { Endpoints, RequestHeaders } from "@octokit/types";
@@ -2276,6 +2277,59 @@ type RepositorySettings = Data<"GET /repos/{owner}/{repo}">;
  * @public
  */
 type RepositoryPatch = Omit<Params<"PATCH /repos/{owner}/{repo}">, "owner" | "repo">;
+/**
+ * A {@link RepositoryPatch} under construction, where an absent field may be
+ * spelled as an explicit `undefined`.
+ *
+ * @remarks
+ * The shape you actually have when you are applying only what a user
+ * configured. Octokit's generated params spell an optional field as
+ * `has_issues?: boolean`, **not** `has_issues?: boolean | undefined`, so under
+ * `exactOptionalPropertyTypes` — on in this repo and in the silk tsconfig base
+ * — a `Partial<T>` built from your own settings schema does not assign to
+ * `RepositoryPatch` at all. This type does, and {@link repositoryPatch} turns
+ * it into one.
+ *
+ * @public
+ */
+type RepositoryPatchDraft = { readonly [K in keyof RepositoryPatch]?: RepositoryPatch[K] | undefined; };
+/**
+ * A {@link RepositoryPatch} from a draft, dropping every explicitly-`undefined`
+ * field.
+ *
+ * @remarks
+ * The supported spelling for "apply only what was configured" — the natural
+ * shape for a sync action, and the one the checker cannot follow on its own.
+ * Without it a consumer under the recommended tsconfig is quietly pushed toward
+ * `as`, which is a real cost in a package whose stated design property is that
+ * the route is the key and there are no casts.
+ *
+ * Dropping the key rather than sending `undefined` is what the wire needs:
+ * `PATCH` treats an absent field as "leave it alone", while an explicit `null`
+ * or `undefined` is a value.
+ *
+ * A key-by-key loop still defeats TypeScript's correlation between two indexed
+ * accesses (`draft[key] = source[key]` over a union `key`), which no helper can
+ * fix — build the draft as a literal where you can.
+ *
+ * @example
+ * ```ts
+ * import { repositoryPatch } from "@effected/github";
+ *
+ * // `config.has_issues` is `boolean | undefined`; absent fields drop out.
+ * const patch = repositoryPatch({
+ *   has_issues: config.has_issues,
+ *   has_wiki: config.has_wiki,
+ *   description: config.description,
+ * });
+ * ```
+ *
+ * @param draft - The fields to apply, any of which may be `undefined`.
+ * @returns A patch carrying only the fields that were actually set.
+ *
+ * @public
+ */
+declare const repositoryPatch: (draft: RepositoryPatchDraft) => RepositoryPatch;
 /**
  * Whether an account is a user or an organization.
  *
@@ -2549,108 +2603,6 @@ declare class GitTag extends GitTag_base {
   static readonly layerTest: (overrides?: Partial<GitTagShape>) => Layer.Layer<GitTag>;
 }
 //#endregion
-//#region src/IssueReferences.d.ts
-/**
- * GitHub's closing-keyword issue-reference grammar, as pure functions.
- *
- * @remarks
- * GitHub links an issue to a pull request when the PR's description carries
- * `<keyword> #<number>` for one of nine documented keywords. Consumers speak
- * that grammar in two distinct dialects, and this module models exactly those
- * two — no service, no layer, nothing but strings in and values out:
- *
- * - **Inline-in-prose** ({@link harvestIssueReferences}): a reference may appear anywhere in
- *   running text — `"fixes #12 and closes #13"` — with mandatory whitespace
- *   and **no colon**, because that is the spelling GitHub itself scans PR
- *   bodies for. This is the dialect a release pipeline harvests from commit
- *   subjects and PR descriptions.
- * - **Bare-line** ({@link parseBareLineReference}): the whole line, after trimming, *is*
- *   the reference — `"Closes: #12"` — with an **optional colon**, because a
- *   generated references region writes one reference per line and a colon
- *   reads better there. GitHub does not require the colon; the region format
- *   allows it, so the parser must too. The dialects differ because their
- *   producers do: prose is written by humans for GitHub's scanner, the region
- *   is written by tooling for humans.
- *
- * Deliberately out of scope this round: cross-repo references
- * (`owner/repo#N`) and full-URL references
- * (`https://github.com/owner/repo/issues/N`). Both are real GitHub spellings;
- * neither dialect's consumers emit them yet, and guessing at their shape here
- * would freeze an API nobody has driven.
- */
-/**
- * The nine closing keywords GitHub documents, lowercased.
- *
- * @public
- */
-declare const CLOSING_KEYWORDS: readonly ["close", "closes", "closed", "fix", "fixes", "fixed", "resolve", "resolves", "resolved"];
-/**
- * One of the nine documented closing keywords, in canonical lowercase form.
- *
- * @public
- */
-type ClosingKeyword = (typeof CLOSING_KEYWORDS)[number];
-/**
- * One closing reference found in prose by {@link harvestIssueReferences}.
- *
- * @public
- */
-interface IssueReference {
-  /** The referenced issue number. */
-  readonly issueNumber: number;
-  /** The matched keyword, lowercased to its canonical form. */
-  readonly keyword: ClosingKeyword;
-  /** Offset of the first character of the whole match (`keyword` through digits). */
-  readonly start: number;
-  /** Offset one past the last character of the whole match. */
-  readonly end: number;
-}
-/**
- * The closing reference a bare line carries, per {@link parseBareLineReference}.
- *
- * @remarks
- * No offsets: in the bare-line dialect the whole line is the reference, so
- * positions within it locate nothing a caller acts on.
- *
- * @public
- */
-interface BareLineReference {
-  /** The referenced issue number. */
-  readonly issueNumber: number;
-  /** The matched keyword, lowercased to its canonical form. */
-  readonly keyword: ClosingKeyword;
-}
-/**
- * Every inline closing reference in `text`, in document order.
- *
- * @remarks
- * The **inline-in-prose** dialect: case-insensitive `<keyword> #<number>`
- * anywhere in the text, whitespace mandatory, colon not accepted — a colon
- * spelling belongs to the bare-line dialect and {@link parseBareLineReference}.
- * Duplicates are preserved: whether `fixes #1, fixes #1` means one reference
- * or two is the caller's business, not a parser's.
- *
- * A match whose digits exceed `Number.MAX_SAFE_INTEGER` is skipped, not
- * misparsed — see the module remarks for the scope boundary.
- *
- * @public
- */
-declare const harvestIssueReferences: (text: string) => ReadonlyArray<IssueReference>;
-/**
- * The reference a whole line carries, or `Option.none()`.
- *
- * @remarks
- * The **bare-line** dialect: after trimming, the entire line must be
- * `<keyword>[:] #<number>` — keyword case-insensitive, colon optional,
- * whitespace before the `#` mandatory. Trailing prose, a missing keyword, or
- * anything else at all is a rejection, never a partial parse; a line carries
- * one reference or none. Digits past `Number.MAX_SAFE_INTEGER` reject too,
- * for the same reason {@link harvestIssueReferences} skips them.
- *
- * @public
- */
-declare const parseBareLineReference: (line: string) => Option.Option<BareLineReference>;
-//#endregion
 //#region src/PullRequest.d.ts
 /** How a pull request is merged. @public */
 declare const MergeMethod: Schema.Literals<readonly ["merge", "squash", "rebase"]>;
@@ -3380,5 +3332,5 @@ declare class WorkflowDispatch extends WorkflowDispatch_base {
   static readonly layerTest: (overrides?: Partial<WorkflowDispatchShape>) => Layer.Layer<WorkflowDispatch>;
 }
 //#endregion
-export { Annotation, AnnotationLevel, type AppCredentials, AppIdentity, type AppliedSettings, ArtifactMetadata, type ArtifactMetadataShape, Attestation, AttestationListEntry, AttestationRecord, type AttestationShape, type BareLineReference, BotIdentity, type BranchOutcome, CLOSING_KEYWORDS, CheckConclusion, CheckRun, CheckRunOutput, CheckRunRef, type CheckRunShape, type ClosingKeyword, CodeScanning, type CodeScanningSetup, type CodeScanningShape, CommentMarker, CommentOnceResult, CommentRecord, CommitComparison, CommitFile, CommitRef, CommitSummary, type ConcludeCheckRun, DeploymentEnvironment, type DeploymentEnvironmentInfo, type DeploymentEnvironmentShape, ExtraPermission, FileChange, FileContent, FileDeletion, FileMode, FileStatus, GRAPHQL_ONLY_SETTINGS, GitBranch, type GitBranchShape, GitCommit, type GitCommitShape, GitHubApp, GitHubAppError, type GitHubAppOptions, type GitHubAppShape, GitHubClient, type GitHubClientOptions, type GitHubClientShape, GitHubCommit, type GitHubCommitShape, GitHubContent, type GitHubContentShape, GitHubError, GitHubErrorKind, type GitHubFixtures, GitHubGraphQLError, GitHubIssue, type GitHubIssueShape, GitHubRelease, type GitHubReleaseShape, GitHubRepository, type GitHubRepositoryShape, GitTag, type GitTagShape, GraphQLDocument, GraphQLErrorEntry, Installation, InstallationToken, InvalidRepoRefError, IssueInfo, type IssueReference, type LatestSemverOptions, LinkedIssue, MergeMethod, type OwnerType, PageOptions, PermissionGap, PermissionLevel, PermissionResult, type PollOptions, PullRequest, PullRequestComment, type PullRequestCommentShape, PullRequestInfo, type PullRequestShape, RateLimitSnapshot, type RecordedCall, ReleaseAsset, ReleaseInfo, Repo, RepoRef, type RepositoryPatch, RepositorySecret, type RepositorySecretShape, RepositorySecurity, type RepositorySecurityShape, type RepositorySettings, RepositoryVariable, type RepositoryVariableShape, type Data as RestData, type RequestExtras as RestExtras, type Item as RestItem, type PaginatingRoute as RestPaginatingRoute, type Params as RestParams, type Response as RestResponse, type Route as RestRoute, RetryPolicy, type RetryableFailure, Ruleset, type RulesetInfo, type RulesetPayload, type RulesetShape, SECURITY_ANALYSIS_STATUS_FIELDS, type SecretInfo, type SecretScope, SemverTag, StorageRecordInput, TagRef, TokenPermissionError, TokenPermissions, type TokenRequest, type UpsertedPullRequest, type VariableInfo, type VersionFromTag, WorkflowDispatch, type WorkflowDispatchShape, type WorkflowInfo, WorkflowRunStatus, harvestIssueReferences, parseBareLineReference, transformSecurityAndAnalysis, versionFromTag };
+export { Annotation, AnnotationLevel, type AppCredentials, AppIdentity, type AppliedSettings, ArtifactMetadata, type ArtifactMetadataShape, Attestation, AttestationListEntry, AttestationRecord, type AttestationShape, type BareLineReference, BotIdentity, type BranchOutcome, CLOSING_KEYWORDS, CheckConclusion, CheckRun, CheckRunOutput, CheckRunRef, type CheckRunShape, type ClosingKeyword, CodeScanning, type CodeScanningSetup, type CodeScanningShape, CommentMarker, CommentOnceResult, CommentRecord, CommitComparison, CommitFile, CommitRef, CommitSummary, type ConcludeCheckRun, DeploymentEnvironment, type DeploymentEnvironmentInfo, type DeploymentEnvironmentShape, ExtraPermission, FileChange, FileContent, FileDeletion, FileMode, FileStatus, GRAPHQL_ONLY_SETTINGS, GitBranch, type GitBranchShape, GitCommit, type GitCommitShape, GitHubApp, GitHubAppError, type GitHubAppOptions, type GitHubAppShape, GitHubClient, type GitHubClientOptions, type GitHubClientShape, GitHubCommit, type GitHubCommitShape, GitHubContent, type GitHubContentShape, GitHubError, GitHubErrorKind, type GitHubFixtures, GitHubGraphQLError, GitHubIssue, type GitHubIssueShape, GitHubRelease, type GitHubReleaseShape, GitHubRepository, type GitHubRepositoryShape, GitTag, type GitTagShape, GraphQLDocument, GraphQLErrorEntry, Installation, InstallationToken, InvalidRepoRefError, IssueInfo, type IssueReference, type LatestSemverOptions, LinkedIssue, MergeMethod, type OwnerType, PageOptions, PermissionGap, PermissionLevel, PermissionResult, type PollOptions, PullRequest, PullRequestComment, type PullRequestCommentShape, PullRequestInfo, type PullRequestShape, RateLimitSnapshot, type RecordedCall, ReleaseAsset, ReleaseInfo, Repo, RepoRef, type RepositoryPatch, type RepositoryPatchDraft, RepositorySecret, type RepositorySecretShape, RepositorySecurity, type RepositorySecurityShape, type RepositorySettings, RepositoryVariable, type RepositoryVariableShape, type Data as RestData, type RequestExtras as RestExtras, type Item as RestItem, type PaginatingRoute as RestPaginatingRoute, type Params as RestParams, type Response as RestResponse, type Route as RestRoute, RetryPolicy, type RetryableFailure, Ruleset, type RulesetInfo, type RulesetPayload, type RulesetShape, SECURITY_ANALYSIS_STATUS_FIELDS, type SecretInfo, type SecretScope, SemverTag, StorageRecordInput, TagRef, TokenPermissionError, TokenPermissions, type TokenRequest, type UpsertedPullRequest, type VariableInfo, type VersionFromTag, WorkflowDispatch, type WorkflowDispatchShape, type WorkflowInfo, WorkflowRunStatus, harvestIssueReferences, parseBareLineReference, repositoryPatch, transformSecurityAndAnalysis, versionFromTag };
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -16,9 +16,8 @@ import { GitHubContent } from "./GitHubContent.js";
 import { CommentMarker, CommentRecord, PullRequestComment } from "./PullRequestComment.js";
 import { CommentOnceResult, GitHubIssue, IssueInfo, LinkedIssue } from "./GitHubIssue.js";
 import { GitHubRelease, ReleaseAsset, ReleaseInfo } from "./GitHubRelease.js";
-import { GRAPHQL_ONLY_SETTINGS, GitHubRepository, SECURITY_ANALYSIS_STATUS_FIELDS, transformSecurityAndAnalysis } from "./GitHubRepository.js";
+import { GRAPHQL_ONLY_SETTINGS, GitHubRepository, SECURITY_ANALYSIS_STATUS_FIELDS, repositoryPatch, transformSecurityAndAnalysis } from "./GitHubRepository.js";
 import { GitTag, SemverTag, TagRef, versionFromTag } from "./GitTag.js";
-import { CLOSING_KEYWORDS, harvestIssueReferences, parseBareLineReference } from "./IssueReferences.js";
 import { PageOptions } from "./Rest.js";
 import { MergeMethod, PullRequest, PullRequestInfo } from "./PullRequest.js";
 import { RepositorySecret } from "./RepositorySecret.js";
@@ -27,5 +26,6 @@ import { RepositoryVariable } from "./RepositoryVariable.js";
 import { Ruleset } from "./Ruleset.js";
 import { ExtraPermission, PermissionGap, PermissionLevel, PermissionResult, TokenPermissionError, TokenPermissions } from "./TokenPermissions.js";
 import { WorkflowDispatch, WorkflowRunStatus } from "./WorkflowDispatch.js";
+import { CLOSING_KEYWORDS, harvestIssueReferences, parseBareLineReference } from "@effected/github-references";
 
-export { Annotation, AnnotationLevel, AppIdentity, ArtifactMetadata, Attestation, AttestationListEntry, AttestationRecord, BotIdentity, CLOSING_KEYWORDS, CheckConclusion, CheckRun, CheckRunOutput, CheckRunRef, CodeScanning, CommentMarker, CommentOnceResult, CommentRecord, CommitComparison, CommitFile, CommitRef, CommitSummary, DeploymentEnvironment, ExtraPermission, FileChange, FileContent, FileDeletion, FileMode, FileStatus, GRAPHQL_ONLY_SETTINGS, GitBranch, GitCommit, GitHubApp, GitHubAppError, GitHubClient, GitHubCommit, GitHubContent, GitHubError, GitHubErrorKind, GitHubGraphQLError, GitHubIssue, GitHubRelease, GitHubRepository, GitTag, GraphQLDocument, GraphQLErrorEntry, Installation, InstallationToken, InvalidRepoRefError, IssueInfo, LinkedIssue, MergeMethod, PageOptions, PermissionGap, PermissionLevel, PermissionResult, PullRequest, PullRequestComment, PullRequestInfo, RateLimitSnapshot, ReleaseAsset, ReleaseInfo, Repo, RepoRef, RepositorySecret, RepositorySecurity, RepositoryVariable, RetryPolicy, Ruleset, SECURITY_ANALYSIS_STATUS_FIELDS, SemverTag, StorageRecordInput, TagRef, TokenPermissionError, TokenPermissions, WorkflowDispatch, WorkflowRunStatus, harvestIssueReferences, parseBareLineReference, transformSecurityAndAnalysis, versionFromTag };
+export { Annotation, AnnotationLevel, AppIdentity, ArtifactMetadata, Attestation, AttestationListEntry, AttestationRecord, BotIdentity, CLOSING_KEYWORDS, CheckConclusion, CheckRun, CheckRunOutput, CheckRunRef, CodeScanning, CommentMarker, CommentOnceResult, CommentRecord, CommitComparison, CommitFile, CommitRef, CommitSummary, DeploymentEnvironment, ExtraPermission, FileChange, FileContent, FileDeletion, FileMode, FileStatus, GRAPHQL_ONLY_SETTINGS, GitBranch, GitCommit, GitHubApp, GitHubAppError, GitHubClient, GitHubCommit, GitHubContent, GitHubError, GitHubErrorKind, GitHubGraphQLError, GitHubIssue, GitHubRelease, GitHubRepository, GitTag, GraphQLDocument, GraphQLErrorEntry, Installation, InstallationToken, InvalidRepoRefError, IssueInfo, LinkedIssue, MergeMethod, PageOptions, PermissionGap, PermissionLevel, PermissionResult, PullRequest, PullRequestComment, PullRequestInfo, RateLimitSnapshot, ReleaseAsset, ReleaseInfo, Repo, RepoRef, RepositorySecret, RepositorySecurity, RepositoryVariable, RetryPolicy, Ruleset, SECURITY_ANALYSIS_STATUS_FIELDS, SemverTag, StorageRecordInput, TagRef, TokenPermissionError, TokenPermissions, WorkflowDispatch, WorkflowRunStatus, harvestIssueReferences, parseBareLineReference, repositoryPatch, transformSecurityAndAnalysis, versionFromTag };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/github",
-	"version": "0.6.1",
+	"version": "0.8.0",
 	"private": false,
 	"description": "Typed GitHub REST and GraphQL services over the octokit core request surface, with app auth and resource helpers.",
 	"keywords": [
@@ -38,6 +38,7 @@
 		"./package.json": "./package.json"
 	},
 	"dependencies": {
+		"@effected/github-references": "^0.1.0",
 		"@effected/semver": "^0.5.0",
 		"@octokit/core": "^7.0.6",
 		"@octokit/plugin-paginate-rest": "^15.0.0",

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.58.12"
+      "packageVersion": "7.59.0"
     }
   ]
 }

package/IssueReferences.js

@@ -1,126 +0,0 @@
-import { Option } from "effect";
-
-//#region src/IssueReferences.ts
-/**
-* GitHub's closing-keyword issue-reference grammar, as pure functions.
-*
-* @remarks
-* GitHub links an issue to a pull request when the PR's description carries
-* `<keyword> #<number>` for one of nine documented keywords. Consumers speak
-* that grammar in two distinct dialects, and this module models exactly those
-* two — no service, no layer, nothing but strings in and values out:
-*
-* - **Inline-in-prose** ({@link harvestIssueReferences}): a reference may appear anywhere in
-*   running text — `"fixes #12 and closes #13"` — with mandatory whitespace
-*   and **no colon**, because that is the spelling GitHub itself scans PR
-*   bodies for. This is the dialect a release pipeline harvests from commit
-*   subjects and PR descriptions.
-* - **Bare-line** ({@link parseBareLineReference}): the whole line, after trimming, *is*
-*   the reference — `"Closes: #12"` — with an **optional colon**, because a
-*   generated references region writes one reference per line and a colon
-*   reads better there. GitHub does not require the colon; the region format
-*   allows it, so the parser must too. The dialects differ because their
-*   producers do: prose is written by humans for GitHub's scanner, the region
-*   is written by tooling for humans.
-*
-* Deliberately out of scope this round: cross-repo references
-* (`owner/repo#N`) and full-URL references
-* (`https://github.com/owner/repo/issues/N`). Both are real GitHub spellings;
-* neither dialect's consumers emit them yet, and guessing at their shape here
-* would freeze an API nobody has driven.
-*/
-/**
-* The nine closing keywords GitHub documents, lowercased.
-*
-* @public
-*/
-const CLOSING_KEYWORDS = [
-	"close",
-	"closes",
-	"closed",
-	"fix",
-	"fixes",
-	"fixed",
-	"resolve",
-	"resolves",
-	"resolved"
-];
-/**
-* Both patterns derive from {@link CLOSING_KEYWORDS} so the constant and the
-* grammar cannot drift. Alternation order is safe: the regex engine backtracks
-* through alternatives, so `close` matching inside `closes` fails at the
-* mandatory `#`-introducer and retries the longer keyword.
-*/
-const KEYWORDS = CLOSING_KEYWORDS.join("|");
-/** Inline-in-prose: mandatory whitespace, no colon. */
-const INLINE_PATTERN = new RegExp(`\\b(${KEYWORDS})\\s+#(\\d+)`, "gi");
-/**
-* Bare-line: optional colon, then mandatory same-line whitespace. `[ \t]`
-* rather than `\s`, so an embedded newline cannot smuggle two lines past a
-* parser whose contract is one.
-*/
-const BARE_LINE_PATTERN = new RegExp(`^(${KEYWORDS}):?[ \\t]+#(\\d+)$`, "i");
-/**
-* `#<digits>` parsed to a number — or `undefined` when the digits exceed
-* `Number.MAX_SAFE_INTEGER`, because a silently rounded issue number is worse
-* than a skipped match. Callers skip such matches; they do not fail.
-*/
-const safeIssueNumber = (digits) => {
-	const value = Number(digits);
-	return Number.isSafeInteger(value) ? value : void 0;
-};
-/**
-* Every inline closing reference in `text`, in document order.
-*
-* @remarks
-* The **inline-in-prose** dialect: case-insensitive `<keyword> #<number>`
-* anywhere in the text, whitespace mandatory, colon not accepted — a colon
-* spelling belongs to the bare-line dialect and {@link parseBareLineReference}.
-* Duplicates are preserved: whether `fixes #1, fixes #1` means one reference
-* or two is the caller's business, not a parser's.
-*
-* A match whose digits exceed `Number.MAX_SAFE_INTEGER` is skipped, not
-* misparsed — see the module remarks for the scope boundary.
-*
-* @public
-*/
-const harvestIssueReferences = (text) => {
-	const references = [];
-	for (const match of text.matchAll(INLINE_PATTERN)) {
-		const issueNumber = safeIssueNumber(match[2] ?? "");
-		if (issueNumber === void 0) continue;
-		references.push({
-			issueNumber,
-			keyword: (match[1] ?? "").toLowerCase(),
-			start: match.index,
-			end: match.index + match[0].length
-		});
-	}
-	return references;
-};
-/**
-* The reference a whole line carries, or `Option.none()`.
-*
-* @remarks
-* The **bare-line** dialect: after trimming, the entire line must be
-* `<keyword>[:] #<number>` — keyword case-insensitive, colon optional,
-* whitespace before the `#` mandatory. Trailing prose, a missing keyword, or
-* anything else at all is a rejection, never a partial parse; a line carries
-* one reference or none. Digits past `Number.MAX_SAFE_INTEGER` reject too,
-* for the same reason {@link harvestIssueReferences} skips them.
-*
-* @public
-*/
-const parseBareLineReference = (line) => {
-	const match = BARE_LINE_PATTERN.exec(line.trim());
-	if (match === null) return Option.none();
-	const issueNumber = safeIssueNumber(match[2] ?? "");
-	if (issueNumber === void 0) return Option.none();
-	return Option.some({
-		issueNumber,
-		keyword: (match[1] ?? "").toLowerCase()
-	});
-};
-
-//#endregion
-export { CLOSING_KEYWORDS, harvestIssueReferences, parseBareLineReference };