@openally/github.sdk 1.0.0 → 1.1.1

package/.editorconfig

@@ -1,14 +0,0 @@
-# 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

@@ -1,25 +0,0 @@
-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

@@ -1,78 +0,0 @@
-# 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

@@ -1,52 +0,0 @@
-# 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

@@ -1,29 +0,0 @@
-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

@@ -1,76 +0,0 @@
-# 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/SECURITY.md

@@ -1,5 +0,0 @@
-# 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

@@ -1,37 +0,0 @@
-# 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

@@ -1,50 +0,0 @@
-# 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

@@ -1,97 +0,0 @@
-# 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)

package/docs/api/users.md

@@ -1,76 +0,0 @@
-# users
-
-The `users` proxy provides access to GitHub user endpoints.
-
-```ts
-import { users } from "@openally/github.sdk";
-
-// Collect all repositories for a user
-const repos = await users.torvalds.repos().all();
-
-// Stream followers one by one
-for await (const follower of users.torvalds.followers().iterate()) {
-  console.log(follower.login);
-}
-
-// Collect all starred repositories
-const starred = await users.torvalds.starred().all();
-```
-
-## Access pattern
-
-```ts
-users[username].<method>()
-```
-
-All methods return an [`ApiEndpoint<T>`](./ApiEndpoint.md) instance.
-
-## Methods
-
-### `.orgs()`
-
-Returns `ApiEndpoint<UserOrg>`.
-
-Lists all organizations the user belongs to.
-
-> GitHub docs: [List organizations for a user](https://docs.github.com/en/rest/orgs/orgs#list-organizations-for-a-user)
-
-### `.repos()`
-
-Returns `ApiEndpoint<UserRepo>`.
-
-Lists all public repositories for the user.
-
-> GitHub docs: [List repositories for a user](https://docs.github.com/en/rest/repos/repos#list-repositories-for-a-user)
-
-### `.gists()`
-
-Returns `ApiEndpoint<UserGist>`.
-
-Lists all public gists for the user.
-
-> GitHub docs: [List gists for a user](https://docs.github.com/en/rest/gists/gists#list-gists-for-a-user)
-
-### `.followers()`
-
-Returns `ApiEndpoint<UserFollower>`.
-
-Lists all followers of the user.
-
-> GitHub docs: [List followers of a user](https://docs.github.com/en/rest/users/followers#list-followers-of-a-user)
-
-### `.following()`
-
-Returns `ApiEndpoint<UserFollowing>`.
-
-Lists all users the user follows.
-
-> GitHub docs: [List the people a user follows](https://docs.github.com/en/rest/users/followers#list-the-people-a-user-follows)
-
-### `.starred()`
-
-Returns `ApiEndpoint<UserStarred>`.
-
-Lists all repositories starred by the user.
-
-> GitHub docs: [List repositories starred by a user](https://docs.github.com/en/rest/activity/starring#list-repositories-starred-by-a-user)

package/eslint.config.mjs

@@ -1,3 +0,0 @@
-import { typescriptConfig } from "@openally/config.eslint";
-
-export default typescriptConfig();

package/src/api/repos.ts

@@ -1,74 +0,0 @@
-// Import Internal Dependencies
-import { ApiEndpoint } from "../class/ApiEndpoint.ts";
-import { createApiProxy } from "../class/createApiProxy.ts";
-import type {
-  Tag,
-  PullRequest,
-  Issue,
-  Commit,
-  Workflow,
-  WorkflowRun,
-  Job,
-  Artifact,
-  WorkflowsResponse,
-  WorkflowRunsResponse,
-  JobsResponse,
-  ArtifactsResponse,
-  RequestConfig
-} from "../types.ts";
-
-type RepoEndpointMethods = {
-  tags: () => ApiEndpoint<Tag>;
-  pulls: () => ApiEndpoint<PullRequest>;
-  issues: () => ApiEndpoint<Issue>;
-  commits: () => ApiEndpoint<Commit>;
-  workflows: () => ApiEndpoint<Workflow>;
-  workflowRuns: (workflowId: string | number) => ApiEndpoint<WorkflowRun>;
-  runJobs: (runId: number) => ApiEndpoint<Job>;
-  runArtifacts: (runId: number) => ApiEndpoint<Artifact>;
-};
-
-export type ReposProxy = {
-  [owner: string]: {
-    [repo: string]: RepoEndpointMethods;
-  };
-};
-
-function createRepoProxy(
-  owner: string,
-  repo: string,
-  config: RequestConfig = {}
-): RepoEndpointMethods {
-  return {
-    tags: () => new ApiEndpoint<Tag>(`/repos/${owner}/${repo}/tags`, config),
-    pulls: () => new ApiEndpoint<PullRequest>(`/repos/${owner}/${repo}/pulls`, config),
-    issues: () => new ApiEndpoint<Issue>(`/repos/${owner}/${repo}/issues`, config),
-    commits: () => new ApiEndpoint<Commit>(`/repos/${owner}/${repo}/commits`, config),
-    workflows: () => new ApiEndpoint<Workflow>(
-      `/repos/${owner}/${repo}/actions/workflows`,
-      { ...config, extractor: (raw: WorkflowsResponse) => raw.workflows }
-    ),
-    workflowRuns: (workflowId: string | number) => new ApiEndpoint<WorkflowRun>(
-      `/repos/${owner}/${repo}/actions/workflows/${workflowId}/runs`,
-      { ...config, extractor: (raw: WorkflowRunsResponse) => raw.workflow_runs }
-    ),
-    runJobs: (runId: number) => new ApiEndpoint<Job>(
-      `/repos/${owner}/${repo}/actions/runs/${runId}/jobs`,
-      { ...config, extractor: (raw: JobsResponse) => raw.jobs }
-    ),
-    runArtifacts: (runId: number) => new ApiEndpoint<Artifact>(
-      `/repos/${owner}/${repo}/actions/runs/${runId}/artifacts`,
-      { ...config, extractor: (raw: ArtifactsResponse) => raw.artifacts }
-    )
-  };
-}
-
-export function createReposProxy(config: RequestConfig = {}): ReposProxy {
-  return createApiProxy(
-    (owner) => createApiProxy(
-      (repo) => createRepoProxy(owner, repo, config)
-    )
-  ) as ReposProxy;
-}
-
-export const repos = createReposProxy();

package/src/api/users.ts

@@ -1,47 +0,0 @@
-// Import Internal Dependencies
-import { ApiEndpoint } from "../class/ApiEndpoint.ts";
-import { createApiProxy } from "../class/createApiProxy.ts";
-import type {
-  UserOrg,
-  UserRepo,
-  UserGist,
-  UserFollower,
-  UserFollowing,
-  UserStarred,
-  RequestConfig
-} from "../types.ts";
-
-// CONSTANTS
-const kUserEndpointResponseMap = {
-  orgs: {} as UserOrg,
-  repos: {} as UserRepo,
-  gists: {} as UserGist,
-  followers: {} as UserFollower,
-  following: {} as UserFollowing,
-  starred: {} as UserStarred
-};
-
-type UserEndpoint = keyof typeof kUserEndpointResponseMap;
-type UserEndpointMethods = {
-  [K in UserEndpoint]: () => ApiEndpoint<typeof kUserEndpointResponseMap[K]>;
-};
-export type UsersProxy = {
-  [username: string]: UserEndpointMethods;
-};
-
-function createUserProxy(
-  username: string,
-  config: RequestConfig = {}
-): UserEndpointMethods {
-  return Object.fromEntries(
-    (Object.keys(kUserEndpointResponseMap) as UserEndpoint[]).map(
-      (endpoint) => [endpoint, () => new ApiEndpoint(`/users/${username}/${endpoint}`, config)]
-    )
-  ) as UserEndpointMethods;
-}
-
-export function createUsersProxy(config: RequestConfig = {}): UsersProxy {
-  return createApiProxy((username) => createUserProxy(username, config)) as UsersProxy;
-}
-
-export const users = createUsersProxy();