@openally/github.sdk 1.1.0 → 1.1.1

package/test/ApiEndpoint.spec.ts

@@ -1,362 +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";
-
-// CONSTANTS
-const kGithubOrigin = "https://api.github.com";
-
-describe("ApiEndpoint", () => {
-  let mockAgent: MockAgent;
-  let originalDispatcher: Dispatcher;
-
-  beforeEach(() => {
-    originalDispatcher = getGlobalDispatcher();
-    mockAgent = new MockAgent();
-    mockAgent.disableNetConnect();
-    setGlobalDispatcher(mockAgent);
-  });
-
-  afterEach(async() => {
-    await mockAgent.close();
-    setGlobalDispatcher(originalDispatcher);
-  });
-
-  describe("constructor", () => {
-    it("should accept a string endpoint", () => {
-      const endpoint = new ApiEndpoint("/users/foo/repos");
-
-      assert.ok(endpoint instanceof ApiEndpoint);
-    });
-
-    it("should accept a URL endpoint", () => {
-      const endpoint = new ApiEndpoint(new URL("https://api.github.com/users/foo/repos"));
-
-      assert.ok(endpoint instanceof ApiEndpoint);
-    });
-  });
-
-  describe("setBearerToken()", () => {
-    it("should return this for chaining", () => {
-      const endpoint = new ApiEndpoint("/users/foo/repos");
-
-      assert.strictEqual(endpoint.setBearerToken("mytoken"), endpoint);
-    });
-  });
-
-  describe("setAgent()", () => {
-    it("should return this for chaining", () => {
-      const endpoint = new ApiEndpoint("/users/foo/repos");
-
-      assert.strictEqual(endpoint.setAgent("my-agent/1.0"), endpoint);
-    });
-  });
-
-  describe("all()", () => {
-    it("should fetch a single page and return all items", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 1 }, { id: 2 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await new ApiEndpoint("/users/foo/repos").all();
-
-      assert.deepEqual(result, [{ id: 1 }, { id: 2 }]);
-    });
-
-    it("should return an empty array when the response is empty", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await new ApiEndpoint("/users/foo/repos").all();
-
-      assert.deepEqual(result, []);
-    });
-
-    it("should follow pagination using the link header", async() => {
-      const pool = mockAgent.get(kGithubOrigin);
-
-      pool
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 1 }]), {
-          headers: {
-            "content-type": "application/json",
-            link: '<https://api.github.com/users/foo/repos?page=2>; rel="next"'
-          }
-        });
-
-      pool
-        .intercept({ path: "/users/foo/repos?page=2", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 2 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await new ApiEndpoint("/users/foo/repos").all();
-
-      assert.deepEqual(result, [{ id: 1 }, { id: 2 }]);
-    });
-
-    it("should follow multiple pages until no next link", async() => {
-      const pool = mockAgent.get(kGithubOrigin);
-
-      pool
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 1 }]), {
-          headers: {
-            "content-type": "application/json",
-            link: '<https://api.github.com/users/foo/repos?page=2>; rel="next"'
-          }
-        });
-
-      pool
-        .intercept({ path: "/users/foo/repos?page=2", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 2 }]), {
-          headers: {
-            "content-type": "application/json",
-            link: '<https://api.github.com/users/foo/repos?page=3>; rel="next"'
-          }
-        });
-
-      pool
-        .intercept({ path: "/users/foo/repos?page=3", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 3 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await new ApiEndpoint("/users/foo/repos").all();
-
-      assert.deepEqual(result, [{ id: 1 }, { id: 2 }, { id: 3 }]);
-    });
-  });
-
-  describe("all() with thenable", () => {
-    it("should fetch a single page and return all items", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 1 }, { id: 2 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await new ApiEndpoint("/users/foo/repos");
-
-      assert.deepEqual(result, [{ id: 1 }, { id: 2 }]);
-    });
-  });
-
-  describe("iterate()", () => {
-    it("should yield items one at a time", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 1 }, { id: 2 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const items: unknown[] = [];
-      for await (const item of new ApiEndpoint("/users/foo/repos").iterate()) {
-        items.push(item);
-      }
-
-      assert.deepEqual(items, [{ id: 1 }, { id: 2 }]);
-    });
-
-    it("should yield items across paginated pages", async() => {
-      const pool = mockAgent.get(kGithubOrigin);
-
-      pool
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 1 }]), {
-          headers: {
-            "content-type": "application/json",
-            link: '<https://api.github.com/users/foo/repos?page=2>; rel="next"'
-          }
-        });
-
-      pool
-        .intercept({ path: "/users/foo/repos?page=2", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 2 }, { id: 3 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const items: unknown[] = [];
-      for await (const item of new ApiEndpoint("/users/foo/repos").iterate()) {
-        items.push(item);
-      }
-
-      assert.deepEqual(items, [{ id: 1 }, { id: 2 }, { id: 3 }]);
-    });
-  });
-
-  describe("Symbol.asyncIterator", () => {
-    it("should yield items one at a time", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 1 }, { id: 2 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const items: unknown[] = [];
-      for await (const item of new ApiEndpoint("/users/foo/repos")) {
-        items.push(item);
-      }
-
-      assert.deepEqual(items, [{ id: 1 }, { id: 2 }]);
-    });
-
-    it("should yield items across paginated pages", async() => {
-      const pool = mockAgent.get(kGithubOrigin);
-
-      pool
-        .intercept({ path: "/users/foo/repos", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 1 }]), {
-          headers: {
-            "content-type": "application/json",
-            link: '<https://api.github.com/users/foo/repos?page=2>; rel="next"'
-          }
-        });
-
-      pool
-        .intercept({ path: "/users/foo/repos?page=2", method: "GET" })
-        .reply(200, JSON.stringify([{ id: 2 }, { id: 3 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const items: unknown[] = [];
-      for await (const item of new ApiEndpoint("/users/foo/repos")) {
-        items.push(item);
-      }
-
-      assert.deepEqual(items, [{ id: 1 }, { id: 2 }, { id: 3 }]);
-    });
-  });
-
-  describe("headers", () => {
-    it("should send the default User-Agent header", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/users/foo/repos",
-          method: "GET",
-          headers: { "user-agent": "@openally/github.sdk/1.0.0" }
-        })
-        .reply(200, JSON.stringify([]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      // If header doesn't match, undici will throw — this is the assertion
-      await assert.doesNotReject(
-        new ApiEndpoint("/users/foo/repos").all()
-      );
-    });
-
-    it("should send a custom User-Agent when set via setAgent()", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/users/foo/repos",
-          method: "GET",
-          headers: { "user-agent": "custom-agent/2.0" }
-        })
-        .reply(200, JSON.stringify([]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      await assert.doesNotReject(
-        new ApiEndpoint("/users/foo/repos").setAgent("custom-agent/2.0").all()
-      );
-    });
-
-    it("should send the Authorization header when a token is provided", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/users/foo/repos",
-          method: "GET",
-          headers: { authorization: "token secret123" }
-        })
-        .reply(200, JSON.stringify([]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      await assert.doesNotReject(
-        new ApiEndpoint("/users/foo/repos", { token: "secret123" }).all()
-      );
-    });
-
-    it("should send the Authorization header when set via setBearerToken()", async() => {
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/users/foo/repos",
-          method: "GET",
-          headers: { authorization: "token runtime-token" }
-        })
-        .reply(200, JSON.stringify([]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      await assert.doesNotReject(
-        new ApiEndpoint("/users/foo/repos").setBearerToken("runtime-token").all()
-      );
-    });
-  });
-
-  describe("extractor", () => {
-    it("should apply the extractor to transform the raw response", async() => {
-      const workflows = [{ id: 10 }, { id: 20 }];
-
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/repos/foo/bar/actions/workflows", method: "GET" })
-        .reply(200, JSON.stringify({ total_count: 2, workflows }), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await new ApiEndpoint(
-        "/repos/foo/bar/actions/workflows",
-        { extractor: (raw) => raw.workflows }
-      ).all();
-
-      assert.deepEqual(result, workflows);
-    });
-
-    it("should apply the extractor on every page when paginating", async() => {
-      const pool = mockAgent.get(kGithubOrigin);
-
-      pool
-        .intercept({ path: "/repos/foo/bar/actions/workflows", method: "GET" })
-        .reply(200, JSON.stringify({ total_count: 3, workflows: [{ id: 10 }] }), {
-          headers: {
-            "content-type": "application/json",
-            link: '<https://api.github.com/repos/foo/bar/actions/workflows?page=2>; rel="next"'
-          }
-        });
-
-      pool
-        .intercept({ path: "/repos/foo/bar/actions/workflows?page=2", method: "GET" })
-        .reply(200, JSON.stringify({ total_count: 3, workflows: [{ id: 20 }, { id: 30 }] }), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await new ApiEndpoint(
-        "/repos/foo/bar/actions/workflows",
-        { extractor: (raw) => raw.workflows }
-      ).all();
-
-      assert.deepEqual(result, [{ id: 10 }, { id: 20 }, { id: 30 }]);
-    });
-  });
-});

package/test/GithubClient.spec.ts

@@ -1,185 +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 { GithubClient } from "../src/class/GithubClient.ts";
-import { ApiEndpoint } from "../src/class/ApiEndpoint.ts";
-
-// CONSTANTS
-const kGithubOrigin = "https://api.github.com";
-
-describe("GithubClient", () => {
-  let mockAgent: MockAgent;
-  let originalDispatcher: Dispatcher;
-
-  beforeEach(() => {
-    originalDispatcher = getGlobalDispatcher();
-    mockAgent = new MockAgent();
-    mockAgent.disableNetConnect();
-    setGlobalDispatcher(mockAgent);
-  });
-
-  afterEach(async() => {
-    await mockAgent.close();
-    setGlobalDispatcher(originalDispatcher);
-  });
-
-  describe("constructor", () => {
-    it("should instantiate with no options", () => {
-      const client = new GithubClient();
-
-      assert.ok(client instanceof GithubClient);
-    });
-
-    it("should instantiate with a token", () => {
-      const client = new GithubClient({ token: "mytoken" });
-
-      assert.ok(client instanceof GithubClient);
-    });
-
-    it("should instantiate with a custom userAgent", () => {
-      const client = new GithubClient({ userAgent: "my-app/1.0" });
-
-      assert.ok(client instanceof GithubClient);
-    });
-
-    it("should expose a users proxy", () => {
-      const client = new GithubClient();
-
-      assert.ok(client.users !== undefined);
-    });
-
-    it("should expose a repos proxy", () => {
-      const client = new GithubClient();
-
-      assert.ok(client.repos !== undefined);
-    });
-  });
-
-  describe("client.users", () => {
-    it("should return ApiEndpoints for user sub-resources", () => {
-      const client = new GithubClient();
-
-      assert.ok(client.users.foo.repos() instanceof ApiEndpoint);
-      assert.ok(client.users.foo.orgs() instanceof ApiEndpoint);
-    });
-
-    it("should use the configured token when fetching user data", async() => {
-      const client = new GithubClient({ token: "clienttoken" });
-
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/users/octocat/repos",
-          method: "GET",
-          headers: { authorization: "token clienttoken" }
-        })
-        .reply(200, JSON.stringify([{ id: 1 }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await client.users.octocat.repos().all();
-
-      assert.deepEqual(result, [{ id: 1 }]);
-    });
-
-    it("should fetch user data without a token", async() => {
-      const client = new GithubClient();
-
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({ path: "/users/octocat/followers", method: "GET" })
-        .reply(200, JSON.stringify([{ login: "user1" }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await client.users.octocat.followers().all();
-
-      assert.deepEqual(result, [{ login: "user1" }]);
-    });
-  });
-
-  describe("client.repos", () => {
-    it("should return ApiEndpoints for repo sub-resources", () => {
-      const client = new GithubClient();
-
-      assert.ok(
-        client.repos.owner.myrepo.tags() instanceof ApiEndpoint
-      );
-      assert.ok(
-        client.repos.owner.myrepo.pulls() instanceof ApiEndpoint
-      );
-      assert.ok(
-        client.repos.owner.myrepo.workflows() instanceof ApiEndpoint
-      );
-    });
-
-    it("should use the configured token when fetching repo data", async() => {
-      const client = new GithubClient({ token: "repotoken" });
-
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/repos/octocat/hello-world/tags",
-          method: "GET",
-          headers: { authorization: "token repotoken" }
-        })
-        .reply(200, JSON.stringify([{ name: "v1.0.0" }]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await client.repos.octocat["hello-world"]
-        .tags()
-        .all();
-
-      assert.deepEqual(result, [{ name: "v1.0.0" }]);
-    });
-
-    it("should use the configured userAgent when fetching", async() => {
-      const client = new GithubClient({ userAgent: "my-app/1.0" });
-
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/repos/octocat/hello-world/tags",
-          method: "GET",
-          headers: { "user-agent": "my-app/1.0" }
-        })
-        .reply(200, JSON.stringify([]), {
-          headers: { "content-type": "application/json" }
-        });
-
-      await assert.doesNotReject(
-        client.repos.octocat["hello-world"].tags().all()
-      );
-    });
-
-    it("should fetch workflows with the envelope extractor", async() => {
-      const client = new GithubClient();
-      const workflows = [{ id: 7, name: "CI" }];
-
-      mockAgent
-        .get(kGithubOrigin)
-        .intercept({
-          path: "/repos/octocat/hello-world/actions/workflows",
-          method: "GET"
-        })
-        .reply(200, JSON.stringify({ total_count: 1, workflows }), {
-          headers: { "content-type": "application/json" }
-        });
-
-      const result = await client.repos.octocat["hello-world"]
-        .workflows()
-        .all();
-
-      assert.deepEqual(
-        result,
-        workflows
-      );
-    });
-  });
-});

package/test/HttpLinkParser.spec.ts

@@ -1,78 +0,0 @@
-// Import Node.js Dependencies
-import { describe, it } from "node:test";
-import assert from "node:assert/strict";
-
-// Import Internal Dependencies
-import { HttpLinkParser } from "../src/class/HttpLinkParser.ts";
-
-describe("HttpLinkParser", () => {
-  describe("parse()", () => {
-    it("should return a Map instance", () => {
-      const result = HttpLinkParser.parse("");
-
-      assert.ok(result instanceof Map);
-    });
-
-    it("should return an empty map for an empty string", () => {
-      const result = HttpLinkParser.parse("");
-
-      assert.equal(result.size, 0);
-    });
-
-    it("should return an empty map for a malformed header", () => {
-      const result = HttpLinkParser.parse("not a link header");
-
-      assert.equal(result.size, 0);
-    });
-
-    it("should parse a single link relation", () => {
-      const header = '<https://api.github.com/repos/foo/bar/tags?page=2>; rel="next"';
-      const result = HttpLinkParser.parse(header);
-
-      assert.equal(result.size, 1);
-      assert.equal(result.get("next"), "https://api.github.com/repos/foo/bar/tags?page=2");
-    });
-
-    it("should parse multiple link relations", () => {
-      const header = [
-        '<https://api.github.com/repos/foo/bar/tags?page=2>; rel="next"',
-        '<https://api.github.com/repos/foo/bar/tags?page=5>; rel="last"'
-      ].join(", ");
-      const result = HttpLinkParser.parse(header);
-
-      assert.equal(result.size, 2);
-      assert.equal(result.get("next"), "https://api.github.com/repos/foo/bar/tags?page=2");
-      assert.equal(result.get("last"), "https://api.github.com/repos/foo/bar/tags?page=5");
-    });
-
-    it("should parse all four standard link relations", () => {
-      const header = [
-        '<https://api.github.com/repos/foo/bar/tags?page=2>; rel="next"',
-        '<https://api.github.com/repos/foo/bar/tags?page=5>; rel="last"',
-        '<https://api.github.com/repos/foo/bar/tags?page=1>; rel="first"',
-        '<https://api.github.com/repos/foo/bar/tags?page=1>; rel="prev"'
-      ].join(", ");
-      const result = HttpLinkParser.parse(header);
-
-      assert.equal(result.size, 4);
-      assert.ok(result.has("next"));
-      assert.ok(result.has("last"));
-      assert.ok(result.has("first"));
-      assert.ok(result.has("prev"));
-    });
-
-    it("should ignore parts that have no URL match", () => {
-      const header = 'no-url; rel="next"';
-      const result = HttpLinkParser.parse(header);
-
-      assert.equal(result.size, 0);
-    });
-
-    it("should ignore parts that have no rel match", () => {
-      const header = "<https://api.github.com/repos/foo/bar/tags?page=2>";
-      const result = HttpLinkParser.parse(header);
-
-      assert.equal(result.size, 0);
-    });
-  });
-});

package/test/createApiProxy.spec.ts

@@ -1,58 +0,0 @@
-/* eslint-disable no-unused-expressions */
-// Import Node.js Dependencies
-import { describe, it } from "node:test";
-import assert from "node:assert/strict";
-
-// Import Internal Dependencies
-import { createApiProxy } from "../src/class/createApiProxy.ts";
-
-describe("createApiProxy", () => {
-  it("should call the factory with the accessed property key", () => {
-    const proxy = createApiProxy((key) => key.toUpperCase());
-
-    assert.equal(proxy.hello, "HELLO");
-    assert.equal(proxy.world, "WORLD");
-  });
-
-  it("should call the factory on each property access", () => {
-    let callCount = 0;
-    const proxy = createApiProxy((key) => {
-      callCount++;
-
-      return key;
-    });
-
-    proxy.a;
-    proxy.b;
-    proxy.a;
-
-    assert.equal(callCount, 3);
-  });
-
-  it("should return different values for different keys", () => {
-    const proxy = createApiProxy((key) => {
-      return { name: key };
-    });
-
-    assert.notDeepEqual(proxy.foo, proxy.bar);
-    assert.equal(proxy.foo.name, "foo");
-    assert.equal(proxy.bar.name, "bar");
-  });
-
-  it("should support nested proxies", () => {
-    const proxy = createApiProxy(
-      (owner: string) => createApiProxy(
-        (repo: string) => `${owner}/${repo}`
-      )
-    );
-
-    assert.equal(proxy.myorg.myrepo, "myorg/myrepo");
-    assert.equal(proxy.another.sdk, "another/sdk");
-  });
-
-  it("should return a plain object (no prototype)", () => {
-    const proxy = createApiProxy((key) => key);
-
-    assert.equal(Object.getPrototypeOf(proxy), null);
-  });
-});