@openally/github.sdk 1.0.0

package/.all-contributorsrc

@@ -0,0 +1,16 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [],
+  "contributorsPerLine": 7,
+  "projectName": "github.sdk",
+  "projectOwner": "OpenAlly",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": true,
+  "commitType": "docs",
+  "commitConvention": "angular"
+}

package/.editorconfig

@@ -0,0 +1,14 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/.github/dependabot.yml

@@ -0,0 +1,25 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    cooldown:
+      default-days: 5
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: npm
+    directory: /
+    versioning-strategy: widen
+    schedule:
+      interval: weekly
+    cooldown:
+      default-days: 5
+    groups:
+      dependencies:
+        dependency-type: "production"
+      development-dependencies:
+        dependency-type: "development"

package/.github/workflows/codeql.yml

@@ -0,0 +1,78 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: ["main"]
+  schedule:
+    - cron: "0 0 * * 1"
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["typescript"]
+        # CodeQL supports [ $supported-codeql-languages ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
+        with:
+          egress-policy: audit
+
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+      # - run: |
+      #   echo "Run, Build Application using script"
+      #   ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+        with:
+          category: "/language:${{matrix.language}}"

package/.github/workflows/node.js.yml

@@ -0,0 +1,52 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [24.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - name: Harden Runner
+      uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
+      with:
+        egress-policy: audit
+
+    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install --ignore-scripts
+    - run: npm run build --if-present
+    - run: npm test
+  automerge:
+    if: >
+      github.event_name == 'pull_request' && github.event.pull_request.user.login == 'dependabot[bot]'
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Merge Dependabot PR
+        uses: fastify/github-action-merge-dependabot@1b2ed42db8f9d81a46bac83adedfc03eb5149dff # v3.11.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
+        with:
+          node-version: '24.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      # Ensure npm 11.5.1 or later is installed
+      - name: Update npm
+        run: npm install -g npm@latest
+      - run: npm install --ignore-scripts
+      - run: npm run build --if-present
+      - run: npm test
+      - run: npm publish

package/.github/workflows/scorecards.yml

@@ -0,0 +1,76 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '20 7 * * 2'
+  push:
+    branches: ["main"]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      contents: read
+      actions: read
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
+        with:
+          egress-policy: audit
+
+      - name: "Checkout code"
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecards on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard.
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+        with:
+          sarif_file: results.sarif

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OpenAlly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+<p align="center"><h1 align="center">
+  Github.SDK
+</h1></p>
+
+<p align="center">
+  Opiniated Node.js Github SDK
+</p>
+
+<p align="center">
+    <a href="https://github.com/OpenAlly/github.sdk">
+      <img src="https://img.shields.io/github/package-json/v/OpenAlly/github.sdk?style=for-the-badge" alt="npm version">
+    </a>
+    <a href="https://github.com/OpenAlly/github.sdk">
+      <img src="https://img.shields.io/github/license/OpenAlly/github.sdk?style=for-the-badge" alt="license">
+    </a>
+    <a href="https://api.securityscorecards.dev/projects/github.com/OpenAlly/github.sdk">
+      <img src="https://api.securityscorecards.dev/projects/github.com/OpenAlly/github.sdk/badge?style=for-the-badge" alt="ossf scorecard">
+    </a>
+    <a href="https://github.com/OpenAlly/github.sdk/actions?query=workflow%3A%22Node.js+CI%22">
+      <img src="https://img.shields.io/github/actions/workflow/status/OpenAlly/github.sdk/node.js.yml?style=for-the-badge" alt="github ci workflow">
+    </a>
+    <a href="https://github.com/OpenAlly/github.sdk">
+      <img src="https://img.shields.io/github/languages/code-size/OpenAlly/github.sdk?style=for-the-badge" alt="size">
+    </a>
+</p>
+
+## 🚧 Requirements
+
+- [Node.js](https://nodejs.org/en/) version 24 or higher
+
+## 🚀 Getting Started
+
+This package is available in the Node Package Repository and can be easily installed with [npm](https://doc.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com)
+
+```bash
+$ npm i @openally/github.sdk
+# or
+$ yarn add @openally/github.sdk
+```
+
+## 👀 Usage
+
+```ts
+import { GithubClient } from "@openally/github.sdk";
+
+const github = new GithubClient({
+  token: process.env.GITHUB_TOKEN
+});
+
+for await (const pr of github.repos.nodejs.node.pulls().iterate()) {
+  console.log(pr.title);
+}
+
+const tags = await github.repos.OpenAlly["github.sdk"].tags().all();
+
+const userRepos = await github.users.torvalds.repos().all();
+```
+
+## 📚 API
+
+- [ApiEndpoint](./docs/api/ApiEndpoint.md)
+- [GithubClient](./docs/api/GithubClient.md)
+
+Available GitHub APIs: 
+
+- [repos](./docs/api/repos.md)
+- [users](./docs/api/users.md)
+
+---
+
+Proxy provides access to GitHub repository endpoints.
+
+```ts
+import { repos } from "@openally/github.sdk";
+```
+
+Via GithubClient (recommended for authenticated use)
+
+```ts
+import { GithubClient } from "@openally/github.sdk";
+
+const { repos } = new GithubClient({
+  token: process.env.GITHUB_TOKEN
+});
+```
+
+## Contributors ✨
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+## License
+MIT

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Reporting Security Issues
+
+To report a security issue, please [publish a private security advisory](https://github.com/OpenAlly/github.sdk/security/advisories) with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue.
+
+Our vulnerability management team will respond within one week. If the issue is confirmed as a vulnerability, we will open a Security Advisory and acknowledge your contributions as part of it. This project follows a 90 day disclosure timeline.

package/docs/api/ApiEndpoint.md

@@ -0,0 +1,37 @@
+# ApiEndpoint
+
+Every endpoint method returns an `ApiEndpoint<T>` instance. It transparently handles pagination, authentication, and data extraction.
+
+```ts
+import { repos } from "@openally/github.sdk";
+
+const endpoint = repos.nodejs.node.pulls()
+  .setBearerToken(process.env.GITHUB_TOKEN)
+  .setAgent("my-app/1.0.0");
+
+// Stream items one by one across all pages
+for await (const pr of endpoint.iterate()) {
+  console.log(pr.title);
+}
+
+// Or collect everything at once
+const allPRs = await endpoint.all();
+```
+
+## Methods
+
+### `.setBearerToken(token: string): this`
+
+Attaches a GitHub personal access token as a `Bearer` authorization header. Returns the instance for chaining.
+
+### `.setAgent(userAgent: string): this`
+
+Overrides the `User-Agent` request header. Returns the instance for chaining.
+
+### `.iterate(): AsyncIterableIterator<T>`
+
+Asynchronously iterates over all items across all pages. Pagination is handled transparently via GitHub's `Link` response header — you never need to manage page numbers or cursors manually.
+
+### `.all(): Promise<T[]>`
+
+Collects all pages and resolves with a flat array of every item.

package/docs/api/GithubClient.md

@@ -0,0 +1,50 @@
+# GithubClient
+
+`GithubClient` is the recommended entry point when you need a shared token or `User-Agent` applied to every request without configuring each endpoint individually.
+
+```ts
+import { GithubClient } from "@openally/github.sdk";
+
+const github = new GithubClient({
+  token: process.env.GITHUB_TOKEN,
+  userAgent: "my-app/1.0.0"
+});
+
+// Iterate over all open pull requests
+for await (const pr of github.repos.OpenAlly["github.sdk"].pulls().iterate()) {
+  console.log(pr.title);
+}
+
+// Collect all tags at once
+const tags = await github.repos.OpenAlly["github.sdk"].tags().all();
+
+// List all repositories for a user
+const userRepos = await github.users.torvalds.repos().all();
+```
+
+## Constructor
+
+```ts
+new GithubClient(options?: GithubClientOptions)
+```
+
+```ts
+interface GithubClientOptions {
+  /**
+   * GitHub personal access token sent as a Bearer authorization header.
+   * Required for private resources and to increase the API rate limit.
+   */
+  token?: string;
+
+  /**
+   * Value for the User-Agent request header.
+   * @default "@openally/github.sdk/1.0.0"
+   */
+  userAgent?: string;
+}
+```
+
+## Properties
+
+- **`repos`** — `ReposProxy` — see [repos](./repos.md)
+- **`users`** — `UsersProxy` — see [users](./users.md)

package/docs/api/repos.md

@@ -0,0 +1,97 @@
+# repos
+
+The `repos` proxy provides access to GitHub repository endpoints.
+
+```ts
+import { repos } from "@openally/github.sdk";
+
+// Collect all tags
+const tags = await repos.OpenAlly["github.sdk"].tags().all();
+
+// Stream pull requests page by page
+for await (const pr of repos.nodejs.node.pulls().iterate()) {
+  console.log(pr.number, pr.title);
+}
+
+// Stream workflow runs for a specific workflow file
+for await (const run of repos.nodejs.node.workflowRuns("ci.yml").iterate()) {
+  console.log(run.id, run.status);
+}
+
+// Collect all jobs for a specific run
+const jobs = await repos.nodejs.node.runJobs(12345678).all();
+```
+
+## Access pattern
+
+```ts
+repos[owner][repo].<method>()
+```
+
+All methods return an [`ApiEndpoint<T>`](./ApiEndpoint.md) instance.
+
+## Methods
+
+### `.tags()`
+
+Returns `ApiEndpoint<Tag>`.
+
+Lists all tags for the repository.
+
+> GitHub docs: [List repository tags](https://docs.github.com/en/rest/repos/repos#list-repository-tags)
+
+### `.pulls()`
+
+Returns `ApiEndpoint<PullRequest>`.
+
+Lists pull requests.
+
+> GitHub docs: [List pull requests](https://docs.github.com/en/rest/pulls/pulls#list-pull-requests)
+
+### `.issues()`
+
+Returns `ApiEndpoint<Issue>`.
+
+Lists repository issues.
+
+> GitHub docs: [List repository issues](https://docs.github.com/en/rest/issues/issues#list-repository-issues)
+
+### `.commits()`
+
+Returns `ApiEndpoint<Commit>`.
+
+Lists commits.
+
+> GitHub docs: [List commits](https://docs.github.com/en/rest/commits/commits#list-commits)
+
+### `.workflows()`
+
+Returns `ApiEndpoint<Workflow>`.
+
+Lists all GitHub Actions workflows defined in the repository.
+
+> GitHub docs: [List repository workflows](https://docs.github.com/en/rest/actions/workflows#list-repository-workflows)
+
+### `.workflowRuns(workflowId: string | number)`
+
+Returns `ApiEndpoint<WorkflowRun>`.
+
+Lists runs for a specific workflow, identified by filename (e.g. `"ci.yml"`) or numeric ID.
+
+> GitHub docs: [List workflow runs for a workflow](https://docs.github.com/en/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow)
+
+### `.runJobs(runId: number)`
+
+Returns `ApiEndpoint<Job>`.
+
+Lists all jobs for a given workflow run.
+
+> GitHub docs: [List jobs for a workflow run](https://docs.github.com/en/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run)
+
+### `.runArtifacts(runId: number)`
+
+Returns `ApiEndpoint<Artifact>`.
+
+Lists all artifacts produced by a given workflow run.
+
+> GitHub docs: [List workflow run artifacts](https://docs.github.com/en/rest/actions/artifacts#list-workflow-run-artifacts)