@shivaedev/github 0.0.0-stage → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +239 -2
  3. package/dist/GitHub.d.ts +93 -0
  4. package/dist/GitHub.d.ts.map +1 -0
  5. package/dist/GitHub.js +53 -0
  6. package/dist/GitHub.js.map +1 -0
  7. package/dist/GitHubConfig.d.ts +6 -0
  8. package/dist/GitHubConfig.d.ts.map +1 -0
  9. package/dist/GitHubConfig.js +5 -0
  10. package/dist/GitHubConfig.js.map +1 -0
  11. package/dist/GitHubToken.d.ts +9 -0
  12. package/dist/GitHubToken.d.ts.map +1 -0
  13. package/dist/GitHubToken.js +8 -0
  14. package/dist/GitHubToken.js.map +1 -0
  15. package/dist/TokenRefresh.d.ts +5 -0
  16. package/dist/TokenRefresh.d.ts.map +1 -0
  17. package/dist/TokenRefresh.js +5 -0
  18. package/dist/TokenRefresh.js.map +1 -0
  19. package/dist/appJwt.d.ts +8 -0
  20. package/dist/appJwt.d.ts.map +1 -0
  21. package/dist/appJwt.js +16 -0
  22. package/dist/appJwt.js.map +1 -0
  23. package/dist/artifacts.d.ts +16 -0
  24. package/dist/artifacts.d.ts.map +1 -0
  25. package/dist/artifacts.js +31 -0
  26. package/dist/artifacts.js.map +1 -0
  27. package/dist/authenticatedRequest.d.ts +8 -0
  28. package/dist/authenticatedRequest.d.ts.map +1 -0
  29. package/dist/authenticatedRequest.js +42 -0
  30. package/dist/authenticatedRequest.js.map +1 -0
  31. package/dist/cache.d.ts +12 -0
  32. package/dist/cache.d.ts.map +1 -0
  33. package/dist/cache.js +17 -0
  34. package/dist/cache.js.map +1 -0
  35. package/dist/checkRuns.d.ts +104 -0
  36. package/dist/checkRuns.d.ts.map +1 -0
  37. package/dist/checkRuns.js +42 -0
  38. package/dist/checkRuns.js.map +1 -0
  39. package/dist/errors.d.ts +44 -0
  40. package/dist/errors.d.ts.map +1 -0
  41. package/dist/errors.js +35 -0
  42. package/dist/errors.js.map +1 -0
  43. package/dist/githubApp.d.ts +24 -0
  44. package/dist/githubApp.d.ts.map +1 -0
  45. package/dist/githubApp.js +55 -0
  46. package/dist/githubApp.js.map +1 -0
  47. package/dist/json.d.ts +7 -0
  48. package/dist/json.d.ts.map +1 -0
  49. package/dist/json.js +14 -0
  50. package/dist/json.js.map +1 -0
  51. package/dist/markdown.d.ts +4 -0
  52. package/dist/markdown.d.ts.map +1 -0
  53. package/dist/markdown.js +24 -0
  54. package/dist/markdown.js.map +1 -0
  55. package/dist/markdownRows.d.ts +6 -0
  56. package/dist/markdownRows.d.ts.map +1 -0
  57. package/dist/markdownRows.js +26 -0
  58. package/dist/markdownRows.js.map +1 -0
  59. package/dist/rateLimits.d.ts +20 -0
  60. package/dist/rateLimits.d.ts.map +1 -0
  61. package/dist/rateLimits.js +43 -0
  62. package/dist/rateLimits.js.map +1 -0
  63. package/dist/representations.d.ts +18 -0
  64. package/dist/representations.d.ts.map +1 -0
  65. package/dist/representations.js +28 -0
  66. package/dist/representations.js.map +1 -0
  67. package/dist/requests.d.ts +10 -0
  68. package/dist/requests.d.ts.map +1 -0
  69. package/dist/requests.js +34 -0
  70. package/dist/requests.js.map +1 -0
  71. package/dist/status.d.ts +7 -0
  72. package/dist/status.d.ts.map +1 -0
  73. package/dist/status.js +57 -0
  74. package/dist/status.js.map +1 -0
  75. package/dist/stickyComments.d.ts +46 -0
  76. package/dist/stickyComments.d.ts.map +1 -0
  77. package/dist/stickyComments.js +37 -0
  78. package/dist/stickyComments.js.map +1 -0
  79. package/dist/verifyWebhook.d.ts +4 -0
  80. package/dist/verifyWebhook.d.ts.map +1 -0
  81. package/dist/verifyWebhook.js +14 -0
  82. package/dist/verifyWebhook.js.map +1 -0
  83. package/package.json +74 -3
  84. package/src/GitHub.ts +68 -0
  85. package/src/GitHubConfig.ts +5 -0
  86. package/src/GitHubToken.ts +16 -0
  87. package/src/TokenRefresh.ts +7 -0
  88. package/src/appJwt.ts +21 -0
  89. package/src/artifacts.ts +57 -0
  90. package/src/authenticatedRequest.ts +55 -0
  91. package/src/cache.ts +25 -0
  92. package/src/checkRuns.ts +48 -0
  93. package/src/errors.ts +34 -0
  94. package/src/githubApp.ts +87 -0
  95. package/src/json.ts +16 -0
  96. package/src/markdown.ts +25 -0
  97. package/src/markdownRows.ts +30 -0
  98. package/src/rateLimits.ts +56 -0
  99. package/src/representations.ts +57 -0
  100. package/src/requests.ts +44 -0
  101. package/src/status.ts +64 -0
  102. package/src/stickyComments.ts +49 -0
  103. package/src/verifyWebhook.ts +19 -0
@@ -0,0 +1,43 @@
1
+ import { Clock, DateTime, Effect } from "effect";
2
+ export function rateLimits() {
3
+ const observations = new Map();
4
+ const blocked = new Map();
5
+ const failures = new Map();
6
+ const resources = new Map();
7
+ function resource(path) {
8
+ return resources.get(path) ?? (path.startsWith("/search/") ? "search" : "core");
9
+ }
10
+ return {
11
+ blocked,
12
+ failures,
13
+ observations,
14
+ observe(response) {
15
+ const headers = response.headers;
16
+ const path = new URL(response.request.url).pathname;
17
+ const name = headers["x-ratelimit-resource"] ?? resource(path);
18
+ resources.set(path, name);
19
+ const values = ["limit", "remaining", "used", "reset"].map((key) => headers[`x-ratelimit-${key}`]);
20
+ if (values.every((value) => value !== undefined && Number.isFinite(Number(value)))) {
21
+ observations.set(name, {
22
+ limit: Number(headers["x-ratelimit-limit"]),
23
+ remaining: Number(headers["x-ratelimit-remaining"]),
24
+ reset: DateTime.makeUnsafe(Number(headers["x-ratelimit-reset"]) * 1000),
25
+ resource: name,
26
+ used: Number(headers["x-ratelimit-used"]),
27
+ });
28
+ }
29
+ return name;
30
+ },
31
+ resource,
32
+ };
33
+ }
34
+ export const failRateLimited = Effect.fnUntraced(function* (path, error, remaining) {
35
+ const fields = { path, remaining, resource: error.resource, retryAt: DateTime.formatIso(error.retryAt) };
36
+ yield* Effect.logWarning("GitHub rate limited", fields);
37
+ const span = yield* Effect.currentSpan.pipe(Effect.option);
38
+ if (span._tag === "Some") {
39
+ span.value.event("GitHub.rateLimited", yield* Clock.currentTimeNanos, fields);
40
+ }
41
+ return yield* error;
42
+ });
43
+ //# sourceMappingURL=rateLimits.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rateLimits.js","sourceRoot":"","sources":["../src/rateLimits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAYjD,MAAM,UAAU,UAAU;IACzB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAgC,CAAC;IAC7D,MAAM,OAAO,GAAG,IAAI,GAAG,EAA6B,CAAC;IACrD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC5C,SAAS,QAAQ,CAAC,IAAY;QAC7B,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACjF,CAAC;IACD,OAAO;QACN,OAAO;QACP,QAAQ;QACR,YAAY;QACZ,OAAO,CAAC,QAA+C;YACtD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC;YACjC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;YACpD,MAAM,IAAI,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC/D,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1B,MAAM,MAAM,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,eAAe,GAAG,EAAE,CAAC,CAAC,CAAC;YACnG,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACpF,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE;oBACtB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;oBAC3C,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;oBACnD,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,GAAG,IAAI,CAAC;oBACvE,QAAQ,EAAE,IAAI;oBACd,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;iBACzC,CAAC,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC;QACb,CAAC;QACD,QAAQ;KACR,CAAC;AACH,CAAC;AAID,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAY,EAAE,KAAwB,EAAE,SAA6B;IAChI,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;IACzG,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3D,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,KAAK,CAAC;AACrB,CAAC,CAAC,CAAC"}
@@ -0,0 +1,18 @@
1
+ import { Effect, Stream } from "effect";
2
+ import { HttpClientRequest } from "effect/http";
3
+ import type { ServiceUnavailable } from "@shivaedev/errors/taxonomy.ts";
4
+ import type { requests } from "#requests.ts";
5
+ export declare function representations(apiUrl: string, request: ReturnType<typeof requests>, resource: (path: string) => string, responseByteLimit?: number): {
6
+ get: (path: string, accept?: string) => HttpClientRequest.HttpClientRequest;
7
+ list: (path: string, beforeRequest?: (resource: string) => Effect.Effect<void, ServiceUnavailable>, byteLimit?: number) => Effect.Effect<Stream.Stream<{
8
+ decode: <TSchema extends import("effect/Schema").Constraint>(schema: TSchema) => Effect.Effect<TSchema["Type"], import("effect/Schema").SchemaError, TSchema["DecodingServices"]>;
9
+ }, import("./errors.ts").GitHubAppError | import("./errors.ts").GitHubConversationLocked | import("./errors.ts").GitHubPermissionDenied | import("./errors.ts").GitHubRateLimited | import("./errors.ts").GitHubTransportError | import("effect/Cause").NoSuchElementError | import("@shivaedev/http/errors.ts").PaginationLinkError | import("@shivaedev/http/errors.ts").ResponseBodyTooLarge | ServiceUnavailable | import("@shivaedev/http/errors.ts").RemoteStatusError, never>, never, never>;
10
+ read: (path: string, byteLimit?: number) => Effect.Effect<{
11
+ decode: <TSchema extends import("effect/Schema").Constraint>(schema: TSchema) => Effect.Effect<TSchema["Type"], import("effect/Schema").SchemaError, TSchema["DecodingServices"]>;
12
+ }, import("./errors.ts").GitHubAppError | import("./errors.ts").GitHubConversationLocked | import("./errors.ts").GitHubPermissionDenied | import("./errors.ts").GitHubRateLimited | import("./errors.ts").GitHubTransportError | import("@shivaedev/http/errors.ts").ResponseBodyTooLarge | import("@shivaedev/http/errors.ts").RemoteStatusError, never>;
13
+ write: (method: "POST" | "PATCH", path: string, body: unknown, byteLimit?: number) => Effect.Effect<{
14
+ decode: <TSchema extends import("effect/Schema").Constraint>(schema: TSchema) => Effect.Effect<TSchema["Type"], import("effect/Schema").SchemaError, TSchema["DecodingServices"]>;
15
+ }, import("./errors.ts").GitHubAppError | import("./errors.ts").GitHubConversationLocked | import("./errors.ts").GitHubPermissionDenied | import("./errors.ts").GitHubRateLimited | import("./errors.ts").GitHubTransportError | import("effect/http/HttpBody").HttpBodyError | import("@shivaedev/http/errors.ts").ResponseBodyTooLarge | import("@shivaedev/http/errors.ts").RemoteStatusError, never>;
16
+ };
17
+ export type Representations = Omit<ReturnType<typeof representations>, "get">;
18
+ //# sourceMappingURL=representations.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"representations.d.ts","sourceRoot":"","sources":["../src/representations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAc,iBAAiB,EAA2B,MAAM,aAAa,CAAC;AACrF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAIxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE7C,wBAAgB,eAAe,CAC9B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,EACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,EAClC,iBAAiB,SAAc;gBAEZ,MAAM;iBAOlB,MAAM,kBACI,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC;;;iBAL5C,MAAM;;;oBA6BH,MAAM,GAAG,OAAO,QAAQ,MAAM,QAAQ,OAAO;;;EAQlF;AAED,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,eAAe,CAAC,EAAE,KAAK,CAAC,CAAC"}
@@ -0,0 +1,28 @@
1
+ import { Effect, Stream } from "effect";
2
+ import { HttpClient, HttpClientRequest } from "effect/http";
3
+ import { paginate } from "@shivaedev/http/paginate.ts";
4
+ import { jsonResponse } from "#json.ts";
5
+ export function representations(apiUrl, request, resource, responseByteLimit = 1024 * 1024) {
6
+ function get(path, accept = "application/vnd.github+json") {
7
+ return HttpClientRequest.get(new URL(path, apiUrl).href, { headers: { Accept: accept } });
8
+ }
9
+ function readRepresentation(path, byteLimit = responseByteLimit) {
10
+ return Effect.map(request(get(path), byteLimit), jsonResponse);
11
+ }
12
+ function listRepresentations(path, beforeRequest, byteLimit = responseByteLimit) {
13
+ const entries = new WeakMap();
14
+ function fetchPage(input) {
15
+ return (beforeRequest?.(resource(new URL(input.url).pathname)) ?? Effect.void).pipe(Effect.andThen(request(input, byteLimit)), Effect.map((entry) => {
16
+ entries.set(entry.response, entry);
17
+ return entry.response;
18
+ }));
19
+ }
20
+ const client = HttpClient.makeWith((effect) => Effect.flatMap(effect, fetchPage), Effect.succeed);
21
+ return Effect.succeed(paginate(client, get(path)).pipe(Stream.mapEffect((response) => Effect.fromNullishOr(entries.get(response))), Stream.map(jsonResponse)));
22
+ }
23
+ function writeRepresentation(method, path, body, byteLimit = responseByteLimit) {
24
+ return HttpClientRequest.make(method)(new URL(path, apiUrl).href, { headers: { Accept: "application/vnd.github+json" } }).pipe(HttpClientRequest.bodyJson(body), Effect.flatMap((input) => request(input, byteLimit)), Effect.map(jsonResponse));
25
+ }
26
+ return { get, list: listRepresentations, read: readRepresentation, write: writeRepresentation };
27
+ }
28
+ //# sourceMappingURL=representations.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"representations.js","sourceRoot":"","sources":["../src/representations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAA2B,MAAM,aAAa,CAAC;AAErF,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAGxC,MAAM,UAAU,eAAe,CAC9B,MAAc,EACd,OAAoC,EACpC,QAAkC,EAClC,iBAAiB,GAAG,IAAI,GAAG,IAAI;IAE/B,SAAS,GAAG,CAAC,IAAY,EAAE,MAAM,GAAG,6BAA6B;QAChE,OAAO,iBAAiB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;IAC3F,CAAC;IACD,SAAS,kBAAkB,CAAC,IAAY,EAAE,SAAS,GAAG,iBAAiB;QACtE,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,EAAE,YAAY,CAAC,CAAC;IAChE,CAAC;IACD,SAAS,mBAAmB,CAC3B,IAAY,EACZ,aAA6E,EAC7E,SAAS,GAAG,iBAAiB;QAE7B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAyD,CAAC;QACrF,SAAS,SAAS,CAAC,KAA0C;YAC5D,OAAO,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAClF,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,EACzC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACnC,OAAO,KAAK,CAAC,QAAQ,CAAC;YACvB,CAAC,CAAC,CACF,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CACjC,CAAC,MAA0D,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,EACjG,MAAM,CAAC,OAAO,CACd,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CACpB,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAC/B,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAC3E,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CACxB,CACD,CAAC;IACH,CAAC;IACD,SAAS,mBAAmB,CAAC,MAAwB,EAAE,IAAY,EAAE,IAAa,EAAE,SAAS,GAAG,iBAAiB;QAChH,OAAO,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,6BAA6B,EAAE,EAAE,CAAC,CAAC,IAAI,CAC7H,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAChC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,EACpD,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CACxB,CAAC;IACH,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC;AACjG,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { Effect } from "effect";
2
+ import { type HttpClient, HttpClientRequest } from "effect/http";
3
+ import { ResponseBodyTooLarge } from "@shivaedev/http/errors.ts";
4
+ import { type CachedResponse } from "./cache.ts";
5
+ import { GitHubTransportError } from "./errors.ts";
6
+ import type { GitHubToken } from "./GitHubToken.ts";
7
+ import type { RateLimits } from "./rateLimits.ts";
8
+ import type { TokenRefresh } from "./TokenRefresh.ts";
9
+ export declare function requests(client: HttpClient.HttpClient, token: GitHubToken["Service"], rates: RateLimits, refresh?: typeof TokenRefresh.Service): (input: HttpClientRequest.HttpClientRequest, limit: number) => Effect.Effect<CachedResponse, import("./errors.ts").GitHubAppError | import("./errors.ts").GitHubConversationLocked | import("./errors.ts").GitHubPermissionDenied | import("./errors.ts").GitHubRateLimited | GitHubTransportError | ResponseBodyTooLarge | import("@shivaedev/http/errors.ts").RemoteStatusError, never>;
10
+ //# sourceMappingURL=requests.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../src/requests.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,KAAK,UAAU,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,EAAE,KAAK,cAAc,EAAiB,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,wBAAgB,QAAQ,CACvB,MAAM,EAAE,UAAU,CAAC,UAAU,EAC7B,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,EAC7B,KAAK,EAAE,UAAU,EACjB,OAAO,GAAE,OAAO,YAAY,CAAC,OAAmB,6XA2BhD"}
@@ -0,0 +1,34 @@
1
+ import { Effect } from "effect";
2
+ import { HttpClientRequest } from "effect/http";
3
+ import { readBoundedBody } from "@shivaedev/http/body.ts";
4
+ import { ResponseBodyTooLarge } from "@shivaedev/http/errors.ts";
5
+ import { authenticatedRequest } from "./authenticatedRequest.js";
6
+ import { responseCache } from "./cache.js";
7
+ import { GitHubTransportError } from "./errors.js";
8
+ import { isUnchanged } from "./status.js";
9
+ export function requests(client, token, rates, refresh = undefined) {
10
+ const cache = responseCache();
11
+ const send = authenticatedRequest(client, token, rates, refresh);
12
+ return Effect.fn("GitHub.request")(function* (input, limit) {
13
+ const key = `${input.url} ${input.headers.accept}`;
14
+ const cached = input.method === "GET" ? cache.get(key) : undefined;
15
+ let request = HttpClientRequest.removeHeader(input, "if-none-match");
16
+ if (cached?.response.headers.etag !== undefined) {
17
+ request = HttpClientRequest.setHeader(request, "If-None-Match", cached.response.headers.etag);
18
+ }
19
+ const response = yield* send(request, cached === undefined ? undefined : "revalidate");
20
+ if (isUnchanged(response) && cached !== undefined) {
21
+ if (cached.bytes.byteLength > limit) {
22
+ return yield* new ResponseBodyTooLarge({ limit });
23
+ }
24
+ return cached;
25
+ }
26
+ const bytes = yield* readBoundedBody(response, limit).pipe(Effect.catchTag("HttpClientError", () => Effect.fail(new GitHubTransportError({ path: new URL(input.url).pathname }))));
27
+ const entry = { bytes, decoded: new Map(), response };
28
+ if (input.method === "GET" && response.headers.etag !== undefined) {
29
+ cache.set(key, entry);
30
+ }
31
+ return entry;
32
+ });
33
+ }
34
+ //# sourceMappingURL=requests.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"requests.js","sourceRoot":"","sources":["../src/requests.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAmB,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAuB,aAAa,EAAE,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAGnD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG1C,MAAM,UAAU,QAAQ,CACvB,MAA6B,EAC7B,KAA6B,EAC7B,KAAiB,EACjB,OAAO,GAAgC,SAAS;IAEhD,MAAM,KAAK,GAAG,aAAa,EAAE,CAAC;IAC9B,MAAM,IAAI,GAAG,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,QAAQ,CAAC,EAAE,KAA0C,EAAE,KAAa;QACtG,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACnD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnE,IAAI,OAAO,GAAG,iBAAiB,CAAC,YAAY,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;QACrE,IAAI,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACjD,OAAO,GAAG,iBAAiB,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/F,CAAC;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;QACvF,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACnD,IAAI,MAAM,CAAC,KAAK,CAAC,UAAU,GAAG,KAAK,EAAE,CAAC;gBACrC,OAAO,KAAK,CAAC,CAAC,IAAI,oBAAoB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YACnD,CAAC;YACD,OAAO,MAAM,CAAC;QACf,CAAC;QACD,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CACzD,MAAM,CAAC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CACtH,CAAC;QACF,MAAM,KAAK,GAAmB,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC;QACtE,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACnE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,KAAK,CAAC;IACd,CAAC,CAAC,CAAC;AACJ,CAAC"}
@@ -0,0 +1,7 @@
1
+ import { Effect } from "effect";
2
+ import { type HttpClientResponse } from "effect/http";
3
+ import { GitHubConversationLocked, GitHubPermissionDenied, GitHubRateLimited } from "#errors.ts";
4
+ export declare function isUnauthorized(response: HttpClientResponse.HttpClientResponse): boolean;
5
+ export declare function isUnchanged(response: HttpClientResponse.HttpClientResponse): boolean;
6
+ export declare const checkStatus: (response: HttpClientResponse.HttpClientResponse, resource: string, failures?: any) => Effect.Effect<HttpClientResponse.HttpClientResponse, GitHubConversationLocked | GitHubPermissionDenied | GitHubRateLimited | import("effect/http/HttpClientError").HttpClientError | import("@shivaedev/http/errors.ts").ResponseBodyTooLarge | import("@shivaedev/http/errors.ts").RemoteStatusError, never>;
7
+ //# sourceMappingURL=status.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../src/status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,MAAM,EAAkB,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAc,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAIlE,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEjG,wBAAgB,cAAc,CAAC,QAAQ,EAAE,kBAAkB,CAAC,kBAAkB,WAE7E;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,kBAAkB,CAAC,kBAAkB,WAE1E;AAED,eAAO,MAAM,WAAW,sYAetB,CAAC"}
package/dist/status.js ADDED
@@ -0,0 +1,57 @@
1
+ import { DateTime, Effect, Option, Schema } from "effect";
2
+ import { HttpClient } from "effect/http";
3
+ import { readBoundedText } from "@shivaedev/http/body.ts";
4
+ import { filterStatus } from "@shivaedev/http/filterStatus.ts";
5
+ import { parseRetryAfter } from "@shivaedev/http/parseRetryAfter.ts";
6
+ import { GitHubConversationLocked, GitHubPermissionDenied, GitHubRateLimited } from "#errors.ts";
7
+ export function isUnauthorized(response) {
8
+ return response.status === 401;
9
+ }
10
+ export function isUnchanged(response) {
11
+ return response.status === 304;
12
+ }
13
+ export const checkStatus = Effect.fnUntraced(function* (response, resource, failures = 0) {
14
+ const { status, headers } = response;
15
+ if (status === 403 || status === 429) {
16
+ const limitedByHeaders = status === 429 || headers["x-ratelimit-remaining"] === "0" || headers["retry-after"] !== undefined;
17
+ const message = !limitedByHeaders && status === 403 ? yield* responseMessage(response) : undefined;
18
+ const limitedByMessage = message !== undefined && /rate limit/iu.test(message);
19
+ if (limitedByHeaders || limitedByMessage) {
20
+ return yield* refuseRateLimit(response, resource, failures);
21
+ }
22
+ const refusal = githubRefusal(message, new URL(response.request.url).pathname);
23
+ if (refusal !== undefined) {
24
+ return yield* refusal;
25
+ }
26
+ }
27
+ return yield* filterStatus(HttpClient.makeWith(() => Effect.succeed(response), Effect.succeed)).execute(response.request);
28
+ });
29
+ const Message = Schema.fromJsonString(Schema.Struct({ message: Schema.String }));
30
+ const responseMessage = Effect.fnUntraced(function* (response) {
31
+ const text = yield* readBoundedText(response, 64 * 1024);
32
+ const body = Schema.decodeUnknownOption(Message)(text);
33
+ return Option.isSome(body) ? body.value.message : undefined;
34
+ });
35
+ function githubRefusal(message, path) {
36
+ if (message === undefined) {
37
+ return undefined;
38
+ }
39
+ if (/^Resource not accessible by integration$/iu.test(message)) {
40
+ return new GitHubPermissionDenied({ path });
41
+ }
42
+ if (/\bconversation (?:is|has been) locked\b/iu.test(message)) {
43
+ return new GitHubConversationLocked({ path });
44
+ }
45
+ return undefined;
46
+ }
47
+ const refuseRateLimit = Effect.fnUntraced(function* (response, resource, failures) {
48
+ const { headers } = response;
49
+ const now = yield* DateTime.now;
50
+ const reset = Number(headers["x-ratelimit-reset"] ?? 0) * 1000;
51
+ const fallback = headers["x-ratelimit-remaining"] === "0" && reset > DateTime.toEpochMillis(now)
52
+ ? reset
53
+ : DateTime.toEpochMillis(now) + Math.min(15 * 60_000, 60_000 * 2 ** failures);
54
+ const retryAt = parseRetryAfter(headers["retry-after"], now) ?? DateTime.makeUnsafe(fallback);
55
+ return yield* new GitHubRateLimited({ resource, retryAt });
56
+ });
57
+ //# sourceMappingURL=status.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"status.js","sourceRoot":"","sources":["../src/status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,UAAU,EAA2B,MAAM,aAAa,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEjG,MAAM,UAAU,cAAc,CAAC,QAA+C;IAC7E,OAAO,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,QAA+C;IAC1E,OAAO,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC;AAChC,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,QAA+C,EAAE,QAAgB,EAAE,QAAQ,GAAG,CAAC;IACtI,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;IACrC,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACtC,MAAM,gBAAgB,GAAG,MAAM,KAAK,GAAG,IAAI,OAAO,CAAC,uBAAuB,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,aAAa,CAAC,KAAK,SAAS,CAAC;QAC5H,MAAM,OAAO,GAAG,CAAC,gBAAgB,IAAI,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACnG,MAAM,gBAAgB,GAAG,OAAO,KAAK,SAAS,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/E,IAAI,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;YAC1C,OAAO,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC7D,CAAC;QACD,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC/E,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC;QACvB,CAAC;IACF,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC3H,CAAC,CAAC,CAAC;AAEH,MAAM,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAEjF,MAAM,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,QAA+C;IACnG,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACvD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7D,CAAC,CAAC,CAAC;AAEH,SAAS,aAAa,CAAC,OAA2B,EAAE,IAAY;IAC/D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,4CAA4C,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAChE,OAAO,IAAI,sBAAsB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,2CAA2C,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,wBAAwB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,MAAM,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,QAA+C,EAAE,QAAgB,EAAE,QAAgB;IACvI,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;IAC7B,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;IAChC,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;IAC/D,MAAM,QAAQ,GACb,OAAO,CAAC,uBAAuB,CAAC,KAAK,GAAG,IAAI,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC;QAC9E,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC;IAChF,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,GAAG,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC9F,OAAO,KAAK,CAAC,CAAC,IAAI,iBAAiB,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AAC5D,CAAC,CAAC,CAAC"}
@@ -0,0 +1,46 @@
1
+ import { Effect, Schema } from "effect";
2
+ import type { Representations } from "#representations.ts";
3
+ export declare const PullRequestComment: Schema.encodeKeys<Schema.Struct<{
4
+ readonly body: Schema.String;
5
+ readonly id: Schema.Number;
6
+ readonly performedViaGithubApp: Schema.optional<Schema.NullOr<Schema.Struct<{
7
+ readonly id: Schema.Number;
8
+ }>>>;
9
+ readonly user: Schema.NullOr<Schema.Struct<{
10
+ readonly login: Schema.String;
11
+ readonly type: Schema.optional<Schema.String>;
12
+ }>>;
13
+ }>, {
14
+ readonly performedViaGithubApp: "performed_via_github_app";
15
+ }>;
16
+ export declare const StickyComment: Schema.Struct<{
17
+ readonly appId: Schema.optional<Schema.Number>;
18
+ readonly author: Schema.optional<Schema.String>;
19
+ readonly body: Schema.String;
20
+ readonly marker: Schema.String;
21
+ readonly number: Schema.Number;
22
+ readonly owner: Schema.String;
23
+ readonly repo: Schema.String;
24
+ }>;
25
+ export declare function stickyComments(client: Representations): {
26
+ upsertStickyComment: (input: {
27
+ readonly appId?: number | undefined;
28
+ readonly author?: string | undefined;
29
+ readonly body: string;
30
+ readonly marker: string;
31
+ readonly number: number;
32
+ readonly owner: string;
33
+ readonly repo: string;
34
+ }) => Effect.Effect<{
35
+ readonly body: string;
36
+ readonly id: number;
37
+ readonly performedViaGithubApp?: {
38
+ readonly id: number;
39
+ } | null | undefined;
40
+ readonly user: {
41
+ readonly login: string;
42
+ readonly type?: string | undefined;
43
+ } | null;
44
+ }, import("./errors.ts").GitHubAppError | import("./errors.ts").GitHubConversationLocked | import("./errors.ts").GitHubPermissionDenied | import("./errors.ts").GitHubRateLimited | import("./errors.ts").GitHubTransportError | import("effect/http/HttpBody").HttpBodyError | import("effect/Cause").NoSuchElementError | import("@shivaedev/http/errors.ts").PaginationLinkError | import("@shivaedev/http/errors.ts").ResponseBodyTooLarge | Schema.SchemaError | import("@shivaedev/errors/taxonomy.ts").ServiceUnavailable | import("@shivaedev/http/errors.ts").RemoteStatusError, never>;
45
+ };
46
+ //# sourceMappingURL=stickyComments.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stickyComments.d.ts","sourceRoot":"","sources":["../src/stickyComments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAU,MAAM,EAAU,MAAM,QAAQ,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAKkD,CAAC;AAElF,eAAO,MAAM,aAAa;;;;;;;;EAQxB,CAAC;AAIH,wBAAgB,cAAc,CAAC,MAAM,EAAE,eAAe;IAEpD,mBAAmB;;;;;;;;;;;;;;;;;;;EAwBpB"}
@@ -0,0 +1,37 @@
1
+ import { Effect, Option, Schema, Stream } from "effect";
2
+ export const PullRequestComment = Schema.Struct({
3
+ body: Schema.String,
4
+ id: Schema.Number,
5
+ performedViaGithubApp: Schema.optional(Schema.NullOr(Schema.Struct({ id: Schema.Number }))),
6
+ user: Schema.NullOr(Schema.Struct({ login: Schema.String, type: Schema.optional(Schema.String) })),
7
+ }).pipe(Schema.encodeKeys({ performedViaGithubApp: "performed_via_github_app" }));
8
+ export const StickyComment = Schema.Struct({
9
+ appId: Schema.optional(Schema.Number),
10
+ author: Schema.optional(Schema.String),
11
+ body: Schema.String,
12
+ marker: Schema.String,
13
+ number: Schema.Number,
14
+ owner: Schema.String,
15
+ repo: Schema.String,
16
+ });
17
+ const CommentBody = Schema.Struct({ body: Schema.String });
18
+ export function stickyComments(client) {
19
+ return {
20
+ upsertStickyComment: Effect.fn("GitHub.upsertStickyComment")(function* (input) {
21
+ const { owner, repo, number, marker, body, author, appId } = yield* Schema.decodeUnknownEffect(StickyComment)(input);
22
+ const hiddenMarker = `<!-- ${marker} -->`;
23
+ const root = `/repos/${owner}/${repo}/issues`;
24
+ const pages = yield* client.list(`${root}/${number}/comments`);
25
+ const existing = yield* pages.pipe(Stream.mapEffect((page) => page.decode(Schema.Array(PullRequestComment))), Stream.flatMap(Stream.fromIterable), Stream.filter((comment) => (author === undefined || comment.user?.login === author)
26
+ && (appId === undefined
27
+ ? comment.body.includes(hiddenMarker)
28
+ : comment.body.startsWith(hiddenMarker) && comment.performedViaGithubApp?.id === appId && comment.user?.type === "Bot")), Stream.runHead);
29
+ const payload = yield* Schema.encodeEffect(CommentBody)({ body: `${hiddenMarker}\n${body}` });
30
+ const response = yield* Option.isSome(existing)
31
+ ? client.write("PATCH", `${root}/comments/${existing.value.id}`, payload)
32
+ : client.write("POST", `${root}/${number}/comments`, payload);
33
+ return yield* response.decode(PullRequestComment);
34
+ }),
35
+ };
36
+ }
37
+ //# sourceMappingURL=stickyComments.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"stickyComments.js","sourceRoot":"","sources":["../src/stickyComments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGxD,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,EAAE,EAAE,MAAM,CAAC,MAAM;IACjB,qBAAqB,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3F,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;CAClG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,CAAC,CAAC,CAAC;AAElF,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1C,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,MAAM,EAAE,MAAM,CAAC,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM;IACpB,IAAI,EAAE,MAAM,CAAC,MAAM;CACnB,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AAE3D,MAAM,UAAU,cAAc,CAAC,MAAuB;IACrD,OAAO;QACN,mBAAmB,EAAE,MAAM,CAAC,EAAE,CAAC,4BAA4B,CAAC,CAAC,QAAQ,CAAC,EAAE,KAAgC;YACvG,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,CAAC;YACrH,MAAM,YAAY,GAAG,QAAQ,MAAM,MAAM,CAAC;YAC1C,MAAM,IAAI,GAAG,UAAU,KAAK,IAAI,IAAI,SAAS,CAAC;YAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,MAAM,WAAW,CAAC,CAAC;YAC/D,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,CACjC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,EACzE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,EACnC,MAAM,CAAC,MAAM,CACZ,CAAC,OAAO,EAAE,EAAE,CACX,CAAC,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,KAAK,MAAM,CAAC;mBACrD,CAAC,KAAK,KAAK,SAAS;oBACtB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;oBACrC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,qBAAqB,EAAE,EAAE,KAAK,KAAK,IAAI,OAAO,CAAC,IAAI,EAAE,IAAI,KAAK,KAAK,CAAC,CACzH,EACD,MAAM,CAAC,OAAO,CACd,CAAC;YACF,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,YAAY,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC;YAC9F,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;gBAC9C,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,aAAa,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC;gBACzE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,IAAI,MAAM,WAAW,EAAE,OAAO,CAAC,CAAC;YAC/D,OAAO,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QACnD,CAAC,CAAC;KACF,CAAC;AACH,CAAC"}
@@ -0,0 +1,4 @@
1
+ import { Effect, Redacted, Schema } from "effect";
2
+ import { GitHubWebhookSignatureError } from "./errors.ts";
3
+ export declare const verifyWebhook: <TSchema extends Schema.Constraint>(body: Uint8Array<ArrayBufferLike>, signature: string | undefined, secret: Redacted.Redacted<string>, schema: TSchema) => Effect.Effect<TSchema["Type"], GitHubWebhookSignatureError | Schema.SchemaError, TSchema["DecodingServices"]>;
4
+ //# sourceMappingURL=verifyWebhook.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"verifyWebhook.d.ts","sourceRoot":"","sources":["../src/verifyWebhook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE1D,eAAO,MAAM,aAAa,GAAgC,OAAO,SAAS,MAAM,CAAC,UAAU,wOAczF,CAAC"}
@@ -0,0 +1,14 @@
1
+ import { createHmac, timingSafeEqual } from "node:crypto";
2
+ import { Effect, Redacted, Schema } from "effect";
3
+ import { GitHubWebhookSignatureError } from "./errors.js";
4
+ export const verifyWebhook = Effect.fnUntraced(function* (body, signature, secret, schema) {
5
+ if (signature === undefined || !/^sha256=[0-9a-f]{64}$/u.test(signature)) {
6
+ return yield* new GitHubWebhookSignatureError();
7
+ }
8
+ const expected = createHmac("sha256", Redacted.value(secret)).update(body).digest();
9
+ if (!timingSafeEqual(expected, Buffer.from(signature.slice(7), "hex"))) {
10
+ return yield* new GitHubWebhookSignatureError();
11
+ }
12
+ return yield* Schema.decodeUnknownEffect(Schema.fromJsonString(schema))(new TextDecoder().decode(body));
13
+ });
14
+ //# sourceMappingURL=verifyWebhook.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"verifyWebhook.js","sourceRoot":"","sources":["../src/verifyWebhook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAC;AAE1D,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EACvD,IAAgB,EAChB,SAA6B,EAC7B,MAAiC,EACjC,MAAe;IAEf,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1E,OAAO,KAAK,CAAC,CAAC,IAAI,2BAA2B,EAAE,CAAC;IACjD,CAAC;IACD,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;IACpF,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;QACxE,OAAO,KAAK,CAAC,CAAC,IAAI,2BAA2B,EAAE,CAAC;IACjD,CAAC;IACD,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AACzG,CAAC,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,77 @@
1
1
  {
2
2
  "name": "@shivaedev/github",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "0.5.1",
4
+ "description": "Typed GitHub REST requests, conditional reads and resource budgets for Effect applications",
5
+ "keywords": [
6
+ "effect"
7
+ ],
8
+ "homepage": "https://github.com/ShivaeDev/platform/tree/main/packages/github#readme",
9
+ "bugs": {
10
+ "url": "https://github.com/ShivaeDev/platform/issues"
11
+ },
12
+ "repository": {
13
+ "type": "git",
14
+ "url": "git+https://github.com/ShivaeDev/platform.git",
15
+ "directory": "packages/github"
16
+ },
17
+ "license": "MIT",
18
+ "sideEffects": false,
19
+ "type": "module",
20
+ "imports": {
21
+ "#test/*": "./src/test-support/*",
22
+ "#*.ts": {
23
+ "source": "./src/*.ts",
24
+ "types": "./dist/*.d.ts",
25
+ "default": "./dist/*.js"
26
+ }
27
+ },
28
+ "exports": {
29
+ "./*.ts": {
30
+ "source": "./src/*.ts",
31
+ "types": "./dist/*.d.ts",
32
+ "default": "./dist/*.js"
33
+ },
34
+ "./package.json": "./package.json"
35
+ },
36
+ "files": [
37
+ "dist",
38
+ "src",
39
+ "!src/**/*.test.ts",
40
+ "!src/**/*.spec.ts",
41
+ "!src/**/test-support",
42
+ "README.md"
43
+ ],
44
+ "dependencies": {
45
+ "@shivaedev/errors": "0.0.0",
46
+ "@shivaedev/http": "0.0.0",
47
+ "@shivaedev/service": "0.4.1"
48
+ },
49
+ "devDependencies": {
50
+ "@effect/platform-node": "4.0.5",
51
+ "@effect/platform-node-shared": "4.0.5",
52
+ "@effect/vitest": "4.0.5",
53
+ "@shivaedev/quality": "0.41.1",
54
+ "@shivaedev/test": "0.9.0",
55
+ "@shivaedev/test-story": "0.20.1",
56
+ "@types/node": "24.19.2",
57
+ "effect": "4.0.5",
58
+ "typescript": "7.0.2",
59
+ "vitest": "5.0.5"
60
+ },
61
+ "peerDependencies": {
62
+ "effect": "4.0.5"
63
+ },
64
+ "engines": {
65
+ "node": ">=24"
66
+ },
67
+ "publishConfig": {
68
+ "access": "public",
69
+ "provenance": true
70
+ },
71
+ "scripts": {
72
+ "build": "node --eval \"import('node:fs').then(({ rmSync }) => rmSync('dist', { force: true, recursive: true }))\" && tsc --project tsconfig.build.json",
73
+ "ready": "pnpm typecheck && pnpm test && pnpm build",
74
+ "test": "vitest run",
75
+ "typecheck": "tsc --noEmit"
76
+ }
6
77
  }
package/src/GitHub.ts ADDED
@@ -0,0 +1,68 @@
1
+ import { Effect, Schema, Stream } from "effect";
2
+ import { HttpClient } from "effect/http";
3
+ import { defineService } from "@shivaedev/service/defineService.ts";
4
+ import { artifacts } from "#artifacts.ts";
5
+ import { checkRuns } from "#checkRuns.ts";
6
+ import { GitHubConfig } from "#GitHubConfig.ts";
7
+ import { GitHubToken } from "#GitHubToken.ts";
8
+ import { rateLimits } from "#rateLimits.ts";
9
+ import { representations } from "#representations.ts";
10
+ import { requests } from "#requests.ts";
11
+ import { stickyComments } from "#stickyComments.ts";
12
+ import { TokenRefresh } from "#TokenRefresh.ts";
13
+
14
+ export const GitHub = defineService({
15
+ id: "@shivaedev/github/GitHub",
16
+ initialize: Effect.gen(function* () {
17
+ const config = yield* GitHubConfig;
18
+ const rates = rateLimits();
19
+ const client = yield* HttpClient.HttpClient;
20
+ const token = yield* GitHubToken;
21
+ const refresh = yield* TokenRefresh;
22
+ return {
23
+ apiUrl: config.apiUrl,
24
+ archive: artifacts(config.apiUrl, client, token, rates, refresh),
25
+ rates,
26
+ request: requests(client, token, rates, refresh),
27
+ responseByteLimit: config.responseByteLimit,
28
+ };
29
+ }),
30
+ methods: ({ apiUrl, archive, rates, request, responseByteLimit }) => {
31
+ const { get, ...client } = representations(apiUrl, request, rates.resource, responseByteLimit);
32
+ return {
33
+ bytes: (path: string, accept: string, limit: number) => Effect.map(request(get(path, accept), limit), (entry) => entry.bytes),
34
+ ...client,
35
+ ...archive,
36
+ ...stickyComments(client),
37
+ ...checkRuns(client),
38
+ observations: () => Effect.sync(() => [...rates.observations.values()]),
39
+ resource: (path: string) => Effect.sync(() => rates.resource(new URL(path, apiUrl).pathname)),
40
+ text: (path: string, accept: string, limit: number) =>
41
+ Effect.map(request(get(path, accept), limit), (entry) => new TextDecoder().decode(entry.bytes)),
42
+ };
43
+ },
44
+ requires: [HttpClient.HttpClient, GitHubToken],
45
+ });
46
+
47
+ export function read<TSchema extends Schema.Constraint>(path: string, schema: TSchema, responseByteLimit?: number) {
48
+ return Effect.flatMap(GitHub, (github) => Effect.flatMap(github.read(path, responseByteLimit), (response) => response.decode(schema)));
49
+ }
50
+
51
+ export function list<TSchema extends Schema.Constraint>(path: string, schema: TSchema, responseByteLimit?: number) {
52
+ return Stream.unwrap(Effect.flatMap(GitHub, (github) => github.list(path, undefined, responseByteLimit))).pipe(
53
+ Stream.mapEffect((response) => response.decode(Schema.Array(schema))),
54
+ Stream.flatMap(Stream.fromIterable),
55
+ );
56
+ }
57
+
58
+ export function write<TSchema extends Schema.Constraint>(
59
+ method: "POST" | "PATCH",
60
+ path: string,
61
+ body: unknown,
62
+ schema: TSchema,
63
+ responseByteLimit?: number,
64
+ ) {
65
+ return Effect.flatMap(GitHub, (github) =>
66
+ Effect.flatMap(github.write(method, path, body, responseByteLimit), (response) => response.decode(schema)),
67
+ );
68
+ }
@@ -0,0 +1,5 @@
1
+ import { Context } from "effect";
2
+
3
+ export const GitHubConfig = Context.Reference<{ readonly apiUrl: string; readonly responseByteLimit?: number }>("@shivaedev/github/GitHubConfig", {
4
+ defaultValue: () => ({ apiUrl: "https://api.github.com" }),
5
+ });
@@ -0,0 +1,16 @@
1
+ import { Config, Context, Effect, Layer, type Option, type Redacted } from "effect";
2
+ import type { GitHubAppError } from "./errors.ts";
3
+
4
+ type Token = Option.Option<Redacted.Redacted<string>>;
5
+
6
+ export class GitHubToken extends Context.Service<GitHubToken, Token | Effect.Effect<Token, GitHubAppError>>()("@shivaedev/github/GitHubToken") {
7
+ static readonly fromEnv = Layer.effect(GitHubToken)(
8
+ Effect.gen(function* () {
9
+ const token = yield* Config.Redacted("GH_TOKEN").pipe(
10
+ Config.orElse(() => Config.Redacted("GITHUB_TOKEN")),
11
+ Config.option,
12
+ );
13
+ return token;
14
+ }),
15
+ );
16
+ }
@@ -0,0 +1,7 @@
1
+ import { Context, type Effect, type Option, type Redacted } from "effect";
2
+
3
+ type Refresh = (rejected: Option.Option<Redacted.Redacted<string>>) => Effect.Effect<unknown>;
4
+
5
+ export const TokenRefresh = Context.Reference<Refresh | undefined>("@shivaedev/github/TokenRefresh", {
6
+ defaultValue: () => undefined,
7
+ });
package/src/appJwt.ts ADDED
@@ -0,0 +1,21 @@
1
+ import { sign } from "node:crypto";
2
+ import { Clock, Effect, Redacted } from "effect";
3
+ import { GitHubAppError } from "#errors.ts";
4
+
5
+ export interface AppCredentials {
6
+ readonly appId: string;
7
+ readonly privateKey: Redacted.Redacted<string>;
8
+ }
9
+
10
+ export const appJwt = Effect.fnUntraced(function* (options: AppCredentials) {
11
+ const now = Math.floor((yield* Clock.currentTimeMillis) / 1000);
12
+ return yield* Effect.try({
13
+ catch: () => new GitHubAppError({ stage: "sign" }),
14
+ try: () => {
15
+ const header = Buffer.from(JSON.stringify({ alg: "RS256", typ: "JWT" })).toString("base64url");
16
+ const payload = Buffer.from(JSON.stringify({ exp: now + 600, iat: now - 60, iss: options.appId })).toString("base64url");
17
+ const input = `${header}.${payload}`;
18
+ return Redacted.make(`${input}.${sign("RSA-SHA256", Buffer.from(input), Redacted.value(options.privateKey)).toString("base64url")}`);
19
+ },
20
+ });
21
+ });