Interface: GithubNamespace

Defined in: github/src/builders/github-namespace-contract.ts:15

Public DSL builder namespace for @paraharness/github (github.*).

Exposes declarative factories for GitHub Issues trackers (github.issues), webhook event streams (github.webhookStream), and pull-request domain steps (github.createOrUpdatePr).

Methods

createOrUpdatePr()

createOrUpdatePr<TIn, TOut, THandle>(id, options): GithubCreateOrUpdatePrBuilder<TIn, TOut, THandle>;

Defined in: github/src/builders/github-namespace-contract.ts:61

Creates a fluent GithubCreateOrUpdatePrBuilder domain step for opening or updating a pull request.

Projects the head branch, optional base branch, title, and body from the step input payload.

Type Parameters

Type Parameter	Default type	Description
TIn	unknown	Validated step input payload type.
TOut	unknown	Validated step output payload type.
THandle	unknown	Runtime handle type of the enclosing isolation scope.

Parameters

Parameter	Type	Description
id	string	Unique step node identifier.
options	GithubCreateOrUpdatePrOptions<TIn, TOut>	Repository, token, and PR field projections.

Returns

GithubCreateOrUpdatePrBuilder<TIn, TOut, THandle>

Fluent pull-request step builder.

---

issues()

issues<TExternal, TExternalState>(options): GithubIssuesTrackerNode<TExternal, TExternalState>;

Defined in: github/src/builders/github-namespace-contract.ts:28

Creates a passive GithubIssuesTrackerNode polling open issues from a GitHub repository.

Supports optional label filtering and bidirectional issue state synchronization via TrackerAdapter.

Type Parameters

Type Parameter	Default type	Description
TExternal	GithubIssueRecord	External issue record type (defaults to GithubIssueRecord).
TExternalState extends string	string	External tracker state string union.

Parameters

Parameter	Type	Description
options	GithubIssuesOptions	Repository slug, token, and optional label filters.

Returns

GithubIssuesTrackerNode<TExternal, TExternalState>

Frozen GitHub Issues tracker AST node.

---

webhookStream()

webhookStream<TEvent>(options): GithubWebhookStreamNode<TEvent>;

Defined in: github/src/builders/github-namespace-contract.ts:43

Creates a passive GithubWebhookStreamNode listening for signed GitHub webhook events.

Defaults port to 3000 and path to '/webhooks/github' when omitted in options.

Type Parameters

Type Parameter	Default type	Description
TEvent	GithubWebhookEvent	Webhook event payload type (defaults to GithubWebhookEvent).

Parameters

Parameter	Type	Description
options	GithubWebhookStreamOptions	Webhook listener port, path, secret, and subscribed events.

Returns

GithubWebhookStreamNode<TEvent>

Frozen GitHub webhook stream source AST node.