@usine/github/polling

Classes

ChangedIssue

An issue number and update time reported by repository change detection.

Extends

• Schema.Class

Constructors

Constructor

new ChangedIssue(…args): ChangedIssue

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

ChangedIssue

Properties

number

readonly number: number

updatedAt

readonly updatedAt: Utc

---

ChangedPullRequest

A pull request number and update time reported by repository change detection.

Extends

• Schema.Class

Constructors

Constructor

new ChangedPullRequest(…args): ChangedPullRequest

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

ChangedPullRequest

Properties

number

readonly number: number

updatedAt

readonly updatedAt: Utc

---

GitHubPolling

Finds changed GitHub Items and fetches the snapshots used to select work for Loops.

Extends

• Context.ServiceClass

Properties

Service

readonly Service: object

The service’s operations: what yield* GitHubPolling returns.

changes

readonly changes: (repository, cursor) => Effect.Effect<ChangeDetection, GitHubAppError>

Finds issue and PR updates since the saved cursor; persist the returned cursor after processing the detected Items.

Parameters

Parameter	Type
repository	RepositoryName
cursor	PollCursor

Returns

Effect.Effect<ChangeDetection, GitHubAppError>

labels

readonly labels: (repository, entityTag) => Effect.Effect<RepositoryLabelCatalog | RepositoryLabelsNotModified, GitHubAppError>

Reads the repository’s label catalog, or confirms the catalog named by entityTag is unchanged.

Parameters

Parameter	Type
repository	RepositoryName
entityTag	Option.Option<EntityTag>

Returns

Effect.Effect<RepositoryLabelCatalog | RepositoryLabelsNotModified, GitHubAppError>

snapshot

readonly snapshot: (repository, item) => Effect.Effect<PayloadSnapshot, GitHubAppError>

Fetches an Item’s selection and prompt payload together with its timestamp-independent content hash.

Parameters

Parameter	Type
repository	RepositoryName
item	ChangedItem

Returns

Effect.Effect<PayloadSnapshot, GitHubAppError>

layer

readonly static layer: Layer<GitHubPolling, never, Crypto | HttpClient | GitHubApp>

---

IssueSnapshot

An issue’s observed payload and the content identity used to decide whether it represents new work.

Extends

• Schema.Class

Constructors

Constructor

new IssueSnapshot(…args): IssueSnapshot

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

IssueSnapshot

Properties

contentHash

readonly contentHash: string & Brand<"GitHubContentHash">

payload

readonly payload: object

assignees

readonly assignees: object

assignees.nodes

readonly nodes: readonly object[]

assignees.totalCount

readonly totalCount: number

author

readonly author: { login: string; } | null

body

readonly body: string

closedAt

readonly closedAt: string | null

closedByPullRequestsReferences

readonly closedByPullRequestsReferences: object

closedByPullRequestsReferences.nodes

readonly nodes: readonly object[]

closedByPullRequestsReferences.totalCount

readonly totalCount: number

comments

readonly comments: object

comments.nodes

readonly nodes: readonly object[]

comments.totalCount

readonly totalCount: number

createdAt

readonly createdAt: string

issueType

readonly issueType: { name: string; } | null

labels

readonly labels: object

labels.nodes

readonly nodes: readonly object[]

labels.totalCount

readonly totalCount: number

milestone

readonly milestone: { title: string; } | null

number

readonly number: number

state

readonly state: string

stateReason

readonly stateReason: string | null

title

readonly title: string

updatedAt

readonly updatedAt: string

url

readonly url: string

---

PollCursor

REST cursor for efficiency only. Losing it is safe because Event dedup is permanent (ADR 0007).

Extends

• Schema.Class

Constructors

Constructor

new PollCursor(…args): PollCursor

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

PollCursor

Properties

entityTag

readonly entityTag: Option<string & Brand<"GitHubEntityTag">>

watermark

readonly watermark: Option<Utc>

empty

readonly static empty: PollCursor

---

PullRequestSnapshot

A pull request’s observed payload and the content identity used to decide whether it represents new work.

Extends

• Schema.Class

Constructors

Constructor

new PullRequestSnapshot(…args): PullRequestSnapshot

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

PullRequestSnapshot

Properties

contentHash

readonly contentHash: string & Brand<"GitHubContentHash">

payload

readonly payload: object

additions

readonly additions: number

author

readonly author: { login: string; } | null

baseRefName

readonly baseRefName: string

body

readonly body: string

changedFiles

readonly changedFiles: number

closingIssuesReferences

readonly closingIssuesReferences: object

closingIssuesReferences.nodes

readonly nodes: readonly object[]

closingIssuesReferences.totalCount

readonly totalCount: number

comments

readonly comments: object

comments.nodes

readonly nodes: readonly object[]

comments.totalCount

readonly totalCount: number

createdAt

readonly createdAt: string

deletions

readonly deletions: number

headRefName

readonly headRefName: string

headRefOid

readonly headRefOid: string

isDraft

readonly isDraft: boolean

labels

readonly labels: object

labels.nodes

readonly nodes: readonly object[]

labels.totalCount

readonly totalCount: number

mergeable

readonly mergeable: string

merged

readonly merged: boolean

mergedAt

readonly mergedAt: string | null

mergeStateStatus

readonly mergeStateStatus: string

number

readonly number: number

reviewDecision

readonly reviewDecision: string | null

reviewRequests

readonly reviewRequests: object

reviewRequests.nodes

readonly nodes: readonly object[]

reviewRequests.totalCount

readonly totalCount: number

reviews

readonly reviews: object

reviews.nodes

readonly nodes: readonly object[]

reviews.totalCount

readonly totalCount: number

reviewThreads

readonly reviewThreads: object

reviewThreads.nodes

readonly nodes: readonly object[]

reviewThreads.totalCount

readonly totalCount: number

state

readonly state: string

statusCheckRollup

readonly statusCheckRollup: { state: string; } | null

title

readonly title: string

updatedAt

readonly updatedAt: string

url

readonly url: string

---

RepositoryChanges

Changed Items, the next cursor, and whether the page cap left more Items to fetch.

Extends

• Schema.Class

Constructors

Constructor

new RepositoryChanges(…args): RepositoryChanges

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

RepositoryChanges

Properties

backlog

readonly backlog: boolean

True when the page cap ended the walk early. The rest arrives next cycle.

backoffUntil

readonly backoffUntil: Option<Utc>

Request backoff from rate pressure or Retry-After; excludes the normal polling interval.

cursor

readonly cursor: PollCursor

items

readonly items: readonly (ChangedIssue | ChangedPullRequest)[]

nextPollAt

readonly nextPollAt: Option<Utc>

---

RepositoryLabel

One repository label as GitHub defines it. The name routes lanes, and color and description are presentation only.

Extends

• Schema.Class

Constructors

Constructor

new RepositoryLabel(…args): RepositoryLabel

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

RepositoryLabel

Properties

color

readonly color: string & Brand<"GitHubRepositoryLabelColor">

description

readonly description: Option<string>

name

readonly name: string & Brand<"GitHubRepositoryLabelName">

---

RepositoryLabelCatalog

A complete label catalog with the ETag of its canonical REST URL.

Extends

• Schema.Class

Constructors

Constructor

new RepositoryLabelCatalog(…args): RepositoryLabelCatalog

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

RepositoryLabelCatalog

Properties

entityTag

readonly entityTag: Option<string & Brand<"GitHubEntityTag">>

labels

readonly labels: readonly RepositoryLabel[]

---

RepositoryLabelsNotModified

GitHub confirmed the catalog named by its ETag has not changed.

Extends

• Schema.Class

Constructors

Constructor

new RepositoryLabelsNotModified(…args): RepositoryLabelsNotModified

Parameters

Parameter	Type
…args	[props?: object, options?: MakeOptions]

Returns

RepositoryLabelsNotModified

---

RepositoryNotModified

GitHub confirmed that the repository cursor still describes its current state.

Extends

• Schema.Class

Constructors

Constructor

new RepositoryNotModified(…args): RepositoryNotModified

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

RepositoryNotModified

Properties

backoffUntil

readonly backoffUntil: Option<Utc>

Request backoff from rate pressure or Retry-After; excludes the normal polling interval.

cursor

readonly cursor: PollCursor

nextPollAt

readonly nextPollAt: Option<Utc>

Type Aliases

ChangeDetection

ChangeDetection = typeof ChangeDetection.Type

The result of checking repository changes, including the earliest next poll time.

---

ChangedItem

ChangedItem = typeof ChangedItem.Type

An issue or pull request whose payload needs to be fetched after change detection.

---

ContentHash

ContentHash = typeof ContentHash.Type

Identifies an Item’s payload content for Event deduplication; timestamp-only changes keep the same hash.

---

EntityTag

EntityTag = typeof EntityTag.Type

GitHub’s opaque HTTP validator for a conditional repository or label-catalog request.

---

IssuePayload

IssuePayload = typeof IssuePayload.Type

The issue payload slice that if: expressions and prompt interpolation range over.

---

PayloadSnapshot

PayloadSnapshot = typeof PayloadSnapshot.Type

The fetched Item state shared by selection, prompt rendering, and Event deduplication.

---

PullRequestPayload

PullRequestPayload = typeof PullRequestPayload.Type

The pull-request payload slice that if: expressions and prompt interpolation range over.

---

RepositoryLabelColor

RepositoryLabelColor = typeof RepositoryLabelColor.Type

GitHub stores label colors as six hex digits without the leading hash.

---

RepositoryLabelDetection

RepositoryLabelDetection = typeof RepositoryLabelDetection.Type

A complete label catalog or confirmation that the cached catalog is unchanged.

---

RepositoryLabelName

RepositoryLabelName = typeof RepositoryLabelName.Type

A repository label name as returned by GitHub, preserved without case conversion.

Variables

ChangeDetection

const ChangeDetection: Schema.Union<readonly [typeof RepositoryNotModified, typeof RepositoryChanges]>

The result of checking repository changes, including the earliest next poll time.

---

ChangedItem

const ChangedItem: Schema.Union<readonly [typeof ChangedIssue, typeof ChangedPullRequest]>

An issue or pull request whose payload needs to be fetched after change detection.

---

ContentHash

const ContentHash: Schema.brand<Schema.String, "GitHubContentHash">

Identifies an Item’s payload content for Event deduplication; timestamp-only changes keep the same hash.

---

EntityTag

const EntityTag: Schema.brand<Schema.NonEmptyString, "GitHubEntityTag">

GitHub’s opaque HTTP validator for a conditional repository or label-catalog request.

---

IssuePayload

const IssuePayload: Schema.Struct<{ assignees: Schema.Struct<{ nodes: Schema.$Array<Schema.Struct<{ login: Schema.NonEmptyString; }>>; totalCount: Schema.Int; }>; author: Schema.NullOr<Schema.Struct<{ login: Schema.NonEmptyString; }>>; body: Schema.String; closedAt: Schema.NullOr<Schema.String>; closedByPullRequestsReferences: Schema.decodeTo<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>, Schema.NullOr<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>>, never, never>; comments: Schema.Struct<{ nodes: Schema.$Array<Schema.Struct<{ author: Schema.NullOr<Schema.Struct<{ login: Schema.NonEmptyString; }>>; body: Schema.String; createdAt: Schema.String; }>>; totalCount: Schema.Int; }>; createdAt: Schema.String; issueType: Schema.NullOr<Schema.Struct<{ name: Schema.String; }>>; labels: Schema.decodeTo<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>, Schema.NullOr<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>>, never, never>; milestone: Schema.NullOr<Schema.Struct<{ title: Schema.String; }>>; number: Schema.Int; state: Schema.String; stateReason: Schema.NullOr<Schema.String>; title: Schema.String; updatedAt: Schema.String; url: Schema.NonEmptyString; }>

The issue payload slice that if: expressions and prompt interpolation range over.

---

PayloadSnapshot

const PayloadSnapshot: Schema.Union<readonly [typeof IssueSnapshot, typeof PullRequestSnapshot]>

The fetched Item state shared by selection, prompt rendering, and Event deduplication.

---

PullRequestPayload

const PullRequestPayload: Schema.Struct<{ additions: Schema.Int; author: Schema.NullOr<Schema.Struct<{ login: Schema.NonEmptyString; }>>; baseRefName: Schema.String; body: Schema.String; changedFiles: Schema.Int; closingIssuesReferences: Schema.decodeTo<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>, Schema.NullOr<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>>, never, never>; comments: Schema.Struct<{ nodes: Schema.$Array<Schema.Struct<{ author: Schema.NullOr<Schema.Struct<{ login: Schema.NonEmptyString; }>>; body: Schema.String; createdAt: Schema.String; }>>; totalCount: Schema.Int; }>; createdAt: Schema.String; deletions: Schema.Int; headRefName: Schema.String; headRefOid: Schema.NonEmptyString; isDraft: Schema.Boolean; labels: Schema.decodeTo<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>, Schema.NullOr<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>>, never, never>; mergeable: Schema.withDecodingDefaultKey<Schema.String, never>; merged: Schema.Boolean; mergedAt: Schema.NullOr<Schema.String>; mergeStateStatus: Schema.withDecodingDefaultKey<Schema.String, never>; number: Schema.Int; reviewDecision: Schema.NullOr<Schema.String>; reviewRequests: Schema.decodeTo<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>, Schema.NullOr<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>>, never, never>; reviews: Schema.decodeTo<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>, Schema.NullOr<Schema.Codec<{ nodes: readonly object[]; totalCount: number; }, { nodes: readonly object[]; totalCount: number; }, never, never>>, never, never>; reviewThreads: Schema.Struct<{ nodes: Schema.$Array<Schema.Struct<{ comments: Schema.Struct<{ nodes: Schema.$Array<Schema.Struct<…>>; totalCount: Schema.Int; }>; isOutdated: Schema.Boolean; isResolved: Schema.Boolean; path: Schema.String; }>>; totalCount: Schema.Int; }>; state: Schema.String; statusCheckRollup: Schema.NullOr<Schema.Struct<{ state: Schema.String; }>>; title: Schema.String; updatedAt: Schema.String; url: Schema.NonEmptyString; }>

The pull-request payload slice that if: expressions and prompt interpolation range over.

---

RepositoryLabelColor

const RepositoryLabelColor: Schema.brand<Schema.String, "GitHubRepositoryLabelColor">

GitHub stores label colors as six hex digits without the leading hash.

---

RepositoryLabelDetection

const RepositoryLabelDetection: Schema.Union<readonly [typeof RepositoryLabelCatalog, typeof RepositoryLabelsNotModified]>

A complete label catalog or confirmation that the cached catalog is unchanged.

---

RepositoryLabelName

const RepositoryLabelName: Schema.brand<Schema.NonEmptyString, "GitHubRepositoryLabelName">

A repository label name as returned by GitHub, preserved without case conversion.