@openally/github.sdk 1.1.0 → 1.1.1

package/test/rawFile.spec.ts

@@ -1,382 +0,0 @@
-// Import Node.js Dependencies
-import { describe, it, beforeEach, afterEach } from "node:test";
-import assert from "node:assert/strict";
-
-// Import Third-party Dependencies
-import { MockAgent, setGlobalDispatcher, getGlobalDispatcher, type Dispatcher } from "undici";
-
-// Import Internal Dependencies
-import { fetchRawFile } from "../src/api/rawFile.ts";
-import { GithubClient } from "../src/class/GithubClient.ts";
-
-// CONSTANTS
-const kRawGithubOrigin = "https://raw.githubusercontent.com";
-
-describe("fetchRawFile()", () => {
-  let mockAgent: MockAgent;
-  let originalDispatcher: Dispatcher;
-
-  beforeEach(() => {
-    originalDispatcher = getGlobalDispatcher();
-    mockAgent = new MockAgent();
-    mockAgent.disableNetConnect();
-    setGlobalDispatcher(mockAgent);
-  });
-
-  afterEach(async() => {
-    await mockAgent.close();
-    setGlobalDispatcher(originalDispatcher);
-  });
-
-  describe("raw text (no parser)", () => {
-    it("should return the raw file content as a string", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/README.md", method: "GET" })
-        .reply(200, "# Hello World\n");
-
-      const result = await fetchRawFile("octocat/hello-world", "README.md");
-
-      assert.equal(result, "# Hello World\n");
-    });
-
-    it("should default to ref HEAD", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/README.md", method: "GET" })
-        .reply(200, "content");
-
-      await assert.doesNotReject(
-        fetchRawFile("octocat/hello-world", "README.md")
-      );
-    });
-
-    it("should use the provided ref", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/main/README.md", method: "GET" })
-        .reply(200, "content on main");
-
-      const result = await fetchRawFile("octocat/hello-world", "README.md", { ref: "main" });
-
-      assert.equal(result, "content on main");
-    });
-
-    it("should support file paths with directory segments", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/src/index.ts", method: "GET" })
-        .reply(200, "export {};\n");
-
-      const result = await fetchRawFile("octocat/hello-world", "src/index.ts");
-
-      assert.equal(result, "export {};\n");
-    });
-  });
-
-  describe("parser: \"json\"", () => {
-    it("should parse and return the file content as a JSON object", async() => {
-      const pkg = { name: "hello-world", version: "1.0.0" };
-
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/package.json", method: "GET" })
-        .reply(200, JSON.stringify(pkg));
-
-      const result = await fetchRawFile<{ name: string; version: string; }>(
-        "octocat/hello-world",
-        "package.json",
-        { parser: "json" }
-      );
-
-      assert.deepEqual(result, pkg);
-    });
-
-    it("should return unknown by default when parser is \"json\"", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/data.json", method: "GET" })
-        .reply(200, JSON.stringify([1, 2, 3]));
-
-      const result = await fetchRawFile("octocat/hello-world", "data.json", { parser: "json" });
-
-      assert.deepEqual(result, [1, 2, 3]);
-    });
-  });
-
-  describe("custom parser function", () => {
-    it("should apply a custom parser to the raw content", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/VERSION", method: "GET" })
-        .reply(200, "2.3.1\n");
-
-      const result = await fetchRawFile(
-        "octocat/hello-world",
-        "VERSION",
-        { parser: (content) => content.trim() }
-      );
-
-      assert.equal(result, "2.3.1");
-    });
-
-    it("should pass the raw string content to the parser", async() => {
-      const rawContent = "key=value\nfoo=bar\n";
-      const captured: string[] = [];
-
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/.env", method: "GET" })
-        .reply(200, rawContent);
-
-      await fetchRawFile(
-        "octocat/hello-world",
-        ".env",
-        {
-          parser: (content) => {
-            captured.push(content);
-
-            return content;
-          }
-        }
-      );
-
-      assert.equal(captured[0], rawContent);
-    });
-  });
-
-  describe("headers", () => {
-    it("should send the default User-Agent header", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({
-          path: "/octocat/hello-world/HEAD/README.md",
-          method: "GET",
-          headers: { "user-agent": "@openally/github.sdk/1.0.0" }
-        })
-        .reply(200, "content");
-
-      await assert.doesNotReject(
-        fetchRawFile("octocat/hello-world", "README.md")
-      );
-    });
-
-    it("should send a custom User-Agent when provided", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({
-          path: "/octocat/hello-world/HEAD/README.md",
-          method: "GET",
-          headers: { "user-agent": "my-app/2.0" }
-        })
-        .reply(200, "content");
-
-      await assert.doesNotReject(
-        fetchRawFile("octocat/hello-world", "README.md", { userAgent: "my-app/2.0" })
-      );
-    });
-
-    it("should send the Authorization header when a token is provided", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({
-          path: "/octocat/hello-world/HEAD/README.md",
-          method: "GET",
-          headers: { authorization: "token secret123" }
-        })
-        .reply(200, "content");
-
-      await assert.doesNotReject(
-        fetchRawFile("octocat/hello-world", "README.md", { token: "secret123" })
-      );
-    });
-
-    it("should succeed without an Authorization header when no token is provided", async() => {
-      // undici's MockAgent will reject the request if the intercepted headers
-      // do not match — here we assert no `authorization` key is present by
-      // confirming the request succeeds against an interceptor that has no
-      // header constraint at all (the positive case with a token is separately tested).
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/README.md", method: "GET" })
-        .reply(200, "content");
-
-      await assert.doesNotReject(
-        fetchRawFile("octocat/hello-world", "README.md")
-      );
-    });
-  });
-
-  describe("error handling", () => {
-    it("should throw on a 404 response", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/missing.txt", method: "GET" })
-        .reply(404, "Not Found");
-
-      await assert.rejects(
-        fetchRawFile("octocat/hello-world", "missing.txt"),
-        (err: Error) => {
-          assert.ok(err.message.includes("404"));
-
-          return true;
-        }
-      );
-    });
-
-    it("should throw on a 500 response", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/README.md", method: "GET" })
-        .reply(500, "Internal Server Error");
-
-      await assert.rejects(
-        fetchRawFile("octocat/hello-world", "README.md"),
-        (err: Error) => {
-          assert.ok(err.message.includes("500"));
-
-          return true;
-        }
-      );
-    });
-
-    it("should include the repository, ref, and file path in the error message", async() => {
-      mockAgent
-        .get(kRawGithubOrigin)
-        .intercept({ path: "/octocat/hello-world/HEAD/missing.txt", method: "GET" })
-        .reply(404, "Not Found");
-
-      await assert.rejects(
-        fetchRawFile("octocat/hello-world", "missing.txt"),
-        (err: Error) => {
-          assert.ok(err.message.includes("missing.txt"));
-          assert.ok(err.message.includes("octocat/hello-world"));
-          assert.ok(err.message.includes("HEAD"));
-
-          return true;
-        }
-      );
-    });
-  });
-});
-
-describe("GithubClient.fetchRawFile()", () => {
-  let mockAgent: MockAgent;
-  let originalDispatcher: Dispatcher;
-
-  beforeEach(() => {
-    originalDispatcher = getGlobalDispatcher();
-    mockAgent = new MockAgent();
-    mockAgent.disableNetConnect();
-    setGlobalDispatcher(mockAgent);
-  });
-
-  afterEach(async() => {
-    await mockAgent.close();
-    setGlobalDispatcher(originalDispatcher);
-  });
-
-  it("should fetch raw content using the client's token", async() => {
-    const client = new GithubClient({ token: "clienttoken" });
-
-    mockAgent
-      .get(kRawGithubOrigin)
-      .intercept({
-        path: "/octocat/hello-world/HEAD/README.md",
-        method: "GET",
-        headers: { authorization: "token clienttoken" }
-      })
-      .reply(200, "# Hello");
-
-    await assert.doesNotReject(
-      client.fetchRawFile("octocat/hello-world", "README.md")
-    );
-  });
-
-  it("should fetch raw content using the client's userAgent", async() => {
-    const client = new GithubClient({ userAgent: "my-client/1.0" });
-
-    mockAgent
-      .get(kRawGithubOrigin)
-      .intercept({
-        path: "/octocat/hello-world/HEAD/README.md",
-        method: "GET",
-        headers: { "user-agent": "my-client/1.0" }
-      })
-      .reply(200, "# Hello");
-
-    await assert.doesNotReject(
-      client.fetchRawFile("octocat/hello-world", "README.md")
-    );
-  });
-
-  it("should parse JSON when parser is \"json\"", async() => {
-    const client = new GithubClient();
-    const pkg = { name: "hello-world", version: "1.0.0" };
-
-    mockAgent
-      .get(kRawGithubOrigin)
-      .intercept({ path: "/octocat/hello-world/HEAD/package.json", method: "GET" })
-      .reply(200, JSON.stringify(pkg));
-
-    const result = await client.fetchRawFile<{ name: string; version: string; }>(
-      "octocat/hello-world",
-      "package.json",
-      { parser: "json" }
-    );
-
-    assert.deepEqual(result, pkg);
-  });
-
-  it("should apply a custom parser function", async() => {
-    const client = new GithubClient();
-
-    mockAgent
-      .get(kRawGithubOrigin)
-      .intercept({ path: "/octocat/hello-world/main/VERSION", method: "GET" })
-      .reply(200, "3.0.0\n");
-
-    const result = await client.fetchRawFile(
-      "octocat/hello-world",
-      "VERSION",
-      { ref: "main", parser: (s) => s.trim() }
-    );
-
-    assert.equal(result, "3.0.0");
-  });
-
-  it("should use the ref option when provided", async() => {
-    const client = new GithubClient();
-
-    mockAgent
-      .get(kRawGithubOrigin)
-      .intercept({ path: "/octocat/hello-world/v2.0.0/CHANGELOG.md", method: "GET" })
-      .reply(200, "## v2.0.0\n");
-
-    const result = await client.fetchRawFile(
-      "octocat/hello-world",
-      "CHANGELOG.md",
-      { ref: "v2.0.0" }
-    );
-
-    assert.equal(result, "## v2.0.0\n");
-  });
-
-  it("should throw when the file is not found", async() => {
-    const client = new GithubClient();
-
-    mockAgent
-      .get(kRawGithubOrigin)
-      .intercept({ path: "/octocat/hello-world/HEAD/missing.txt", method: "GET" })
-      .reply(404, "Not Found");
-
-    await assert.rejects(
-      client.fetchRawFile("octocat/hello-world", "missing.txt"),
-      (err: Error) => {
-        assert.ok(err.message.includes("404"));
-
-        return true;
-      }
-    );
-  });
-});

package/test/repos.spec.ts

@@ -1,221 +0,0 @@
-// Import Node.js Dependencies
-import { describe, it, beforeEach, afterEach } from "node:test";
-import assert from "node:assert/strict";
-
-// Import Third-party Dependencies
-import { MockAgent, setGlobalDispatcher, getGlobalDispatcher, type Dispatcher } from "undici";
-
-// Import Internal Dependencies
-import { ApiEndpoint } from "../src/class/ApiEndpoint.ts";
-import { repos, createReposProxy } from "../src/api/repos.ts";
-
-// CONSTANTS
-const kGithubOrigin = "https://api.github.com";
-
-describe("Repos API", () => {
-  let mockAgent: MockAgent;
-  let originalDispatcher: Dispatcher;
-
-  beforeEach(() => {
-    originalDispatcher = getGlobalDispatcher();
-    mockAgent = new MockAgent();
-    mockAgent.disableNetConnect();
-    setGlobalDispatcher(mockAgent);
-  });
-
-  afterEach(async() => {
-    await mockAgent.close();
-    setGlobalDispatcher(originalDispatcher);
-  });
-
-  describe("createReposProxy()", () => {
-    it("should return an ApiEndpoint for each simple repo endpoint", () => {
-      const proxy = createReposProxy();
-      const methods = proxy.owner.myrepo;
-
-      assert.ok(methods.tags() instanceof ApiEndpoint);
-      assert.ok(methods.pulls() instanceof ApiEndpoint);
-      assert.ok(methods.issues() instanceof ApiEndpoint);
-      assert.ok(methods.commits() instanceof ApiEndpoint);
-      assert.ok(methods.workflows() instanceof ApiEndpoint);
-    });
-
-    it("should return an ApiEndpoint from workflowRuns() with a string workflow id", () => {
-      const endpoint = createReposProxy().owner.myrepo.workflowRuns("ci.yml");
-
-      assert.ok(endpoint instanceof ApiEndpoint);
-    });
-
-    it("should return an ApiEndpoint from workflowRuns() with a numeric workflow id", () => {
-      const endpoint = createReposProxy().owner.myrepo.workflowRuns(42);
-
-      assert.ok(endpoint instanceof ApiEndpoint);
-    });
-
-    it("should return an ApiEndpoint from runJobs()", () => {
-      const endpoint = createReposProxy().owner.myrepo.runJobs(123);
-
-      assert.ok(endpoint instanceof ApiEndpoint);
-    });
-
-    it("should return an ApiEndpoint from runArtifacts()", () => {
-      const endpoint = createReposProxy().owner.myrepo.runArtifacts(456);
-
-      assert.ok(endpoint instanceof ApiEndpoint);
-    });
-
-    it("should create a new ApiEndpoint on each method call", () => {
-      const proxy = createReposProxy();
-
-      assert.notStrictEqual(proxy.owner.myrepo.tags(), proxy.owner.myrepo.tags());
-    });
-
-    it("should pass the token from config to ApiEndpoints", async() => {
-      const proxy = createReposProxy({ token: "repotoken" });
-
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/repos/owner/myrepo/tags",
-          method: "GET",
-          headers: { authorization: "token repotoken" }
-        })
-        .reply(200, JSON.stringify([]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      await assert.doesNotReject(proxy.owner.myrepo.tags().all());
-    });
-  });
-
-  describe("repos (default export)", () => {
-    it("should fetch tags for a repo", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/repos/octocat/hello-world/tags", method: "GET" })
-        .reply(200, JSON.stringify([{ name: "v1.0.0" }, { name: "v1.1.0" }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].tags().all();
-
-      assert.deepEqual(result, [{ name: "v1.0.0" }, { name: "v1.1.0" }]);
-    });
-
-    it("should fetch pull requests for a repo", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/repos/octocat/hello-world/pulls", method: "GET" })
-        .reply(200, JSON.stringify([{ number: 1, title: "Fix bug" }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].pulls().all();
-
-      assert.deepEqual(result, [{ number: 1, title: "Fix bug" }]);
-    });
-
-    it("should fetch issues for a repo", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/repos/octocat/hello-world/issues", method: "GET" })
-        .reply(200, JSON.stringify([{ number: 5, title: "Bug report" }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].issues().all();
-
-      assert.deepEqual(result, [{ number: 5, title: "Bug report" }]);
-    });
-
-    it("should fetch commits for a repo", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/repos/octocat/hello-world/commits", method: "GET" })
-        .reply(200, JSON.stringify([{ sha: "abc123" }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].commits().all();
-
-      assert.deepEqual(result, [{ sha: "abc123" }]);
-    });
-
-    it("should fetch workflows using the extractor", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/repos/octocat/hello-world/actions/workflows", method: "GET" })
-        .reply(200, JSON.stringify({ total_count: 1, workflows: [{ id: 1, name: "CI" }] }), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].workflows().all();
-
-      assert.deepEqual(result, [{ id: 1, name: "CI" }]);
-    });
-
-    it("should fetch workflow runs by string workflow id using the extractor", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/repos/octocat/hello-world/actions/workflows/ci.yml/runs",
-          method: "GET"
-        })
-        .reply(200, JSON.stringify({ total_count: 1, workflow_runs: [{ id: 100, status: "completed" }] }), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].workflowRuns("ci.yml").all();
-
-      assert.deepEqual(result, [{ id: 100, status: "completed" }]);
-    });
-
-    it("should fetch workflow runs by numeric workflow id using the extractor", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/repos/octocat/hello-world/actions/workflows/42/runs",
-          method: "GET"
-        })
-        .reply(200, JSON.stringify({ total_count: 2, workflow_runs: [{ id: 200 }, { id: 201 }] }), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].workflowRuns(42).all();
-
-      assert.deepEqual(result, [{ id: 200 }, { id: 201 }]);
-    });
-
-    it("should fetch run jobs using the extractor", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/repos/octocat/hello-world/actions/runs/999/jobs",
-          method: "GET"
-        })
-        .reply(200, JSON.stringify({ total_count: 1, jobs: [{ id: 10, name: "build" }] }), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].runJobs(999).all();
-
-      assert.deepEqual(result, [{ id: 10, name: "build" }]);
-    });
-
-    it("should fetch run artifacts using the extractor", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/repos/octocat/hello-world/actions/runs/999/artifacts",
-          method: "GET"
-        })
-        .reply(200, JSON.stringify({ total_count: 1, artifacts: [{ id: 55, name: "build-output" }] }), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await repos.octocat["hello-world"].runArtifacts(999).all();
-
-      assert.deepEqual(result, [{ id: 55, name: "build-output" }]);
-    });
-  });
-});

package/test/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "..",
-    "types": ["node"],
-    "lib": ["DOM", "ES2022", "ES2023", "ES2024", "ESNext"]
-  },
-  "include": [
-    "."
-  ]
-}