@softure-ai/ci-usage 0.0.0-stage → 0.1.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 (70) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/LICENSE +21 -0
  3. package/README.md +131 -2
  4. package/dist/billing.d.ts +37 -0
  5. package/dist/billing.d.ts.map +1 -0
  6. package/dist/billing.js +83 -0
  7. package/dist/billing.js.map +1 -0
  8. package/dist/cli/command.d.ts +33 -0
  9. package/dist/cli/command.d.ts.map +1 -0
  10. package/dist/cli/command.js +209 -0
  11. package/dist/cli/command.js.map +1 -0
  12. package/dist/cli/main.d.ts +3 -0
  13. package/dist/cli/main.d.ts.map +1 -0
  14. package/dist/cli/main.js +10 -0
  15. package/dist/cli/main.js.map +1 -0
  16. package/dist/collect.d.ts +51 -0
  17. package/dist/collect.d.ts.map +1 -0
  18. package/dist/collect.js +224 -0
  19. package/dist/collect.js.map +1 -0
  20. package/dist/github.d.ts +41 -0
  21. package/dist/github.d.ts.map +1 -0
  22. package/dist/github.js +91 -0
  23. package/dist/github.js.map +1 -0
  24. package/dist/index.d.ts +10 -0
  25. package/dist/index.d.ts.map +1 -0
  26. package/dist/index.js +11 -0
  27. package/dist/index.js.map +1 -0
  28. package/dist/messages/en.d.ts +51 -0
  29. package/dist/messages/en.d.ts.map +1 -0
  30. package/dist/messages/en.js +51 -0
  31. package/dist/messages/en.js.map +1 -0
  32. package/dist/messages/index.d.ts +11 -0
  33. package/dist/messages/index.d.ts.map +1 -0
  34. package/dist/messages/index.js +13 -0
  35. package/dist/messages/index.js.map +1 -0
  36. package/dist/prices.d.ts +32 -0
  37. package/dist/prices.d.ts.map +1 -0
  38. package/dist/prices.js +52 -0
  39. package/dist/prices.js.map +1 -0
  40. package/dist/publish.d.ts +29 -0
  41. package/dist/publish.d.ts.map +1 -0
  42. package/dist/publish.js +91 -0
  43. package/dist/publish.js.map +1 -0
  44. package/dist/report.d.ts +57 -0
  45. package/dist/report.d.ts.map +1 -0
  46. package/dist/report.js +168 -0
  47. package/dist/report.js.map +1 -0
  48. package/dist/runner.d.ts +28 -0
  49. package/dist/runner.d.ts.map +1 -0
  50. package/dist/runner.js +55 -0
  51. package/dist/runner.js.map +1 -0
  52. package/dist/usage.d.ts +67 -0
  53. package/dist/usage.d.ts.map +1 -0
  54. package/dist/usage.js +112 -0
  55. package/dist/usage.js.map +1 -0
  56. package/examples/ci-usage.yml +34 -0
  57. package/package.json +42 -4
  58. package/src/billing.ts +102 -0
  59. package/src/cli/command.ts +218 -0
  60. package/src/cli/main.ts +10 -0
  61. package/src/collect.ts +266 -0
  62. package/src/github.ts +113 -0
  63. package/src/index.ts +10 -0
  64. package/src/messages/en.ts +52 -0
  65. package/src/messages/index.ts +15 -0
  66. package/src/prices.ts +74 -0
  67. package/src/publish.ts +95 -0
  68. package/src/report.ts +215 -0
  69. package/src/runner.ts +64 -0
  70. package/src/usage.ts +192 -0
@@ -0,0 +1,51 @@
1
+ import type { GithubClient } from "./github.js";
2
+ import type { JobRecord } from "./usage.js";
3
+ /** Finished runs read earlier, keyed by `<run id>:<attempt>`, so a repeated report reads only new runs. */
4
+ export interface RunCache {
5
+ version: 1;
6
+ runs: Record<string, {
7
+ updatedAt: string;
8
+ jobs: JobRecord[];
9
+ }>;
10
+ }
11
+ /** Reads a cache file's text; anything unreadable starts an empty cache (it is only an optimisation). */
12
+ export declare function parseRunCache(text: string | null): RunCache;
13
+ /** GitHub returns at most 1,000 runs for a filtered query. */
14
+ export declare const MAX_RUNS_PER_QUERY = 1000;
15
+ export interface CollectOptions {
16
+ client: GithubClient;
17
+ /** `owner/name`. */
18
+ repository: string;
19
+ from: Date;
20
+ to: Date;
21
+ cache: RunCache;
22
+ /** Past this time no further runs are read and the repository is marked partial; no budget when unset. */
23
+ deadline?: Date;
24
+ /** Replaces the clock in tests. */
25
+ now?: () => Date;
26
+ }
27
+ /** Runs whose jobs are read at the same time: far below GitHub's limit of 100 concurrent requests. */
28
+ export declare const JOB_CONCURRENCY = 8;
29
+ export interface CollectResult {
30
+ repository: string;
31
+ jobs: JobRecord[];
32
+ /** Why the numbers may be short; empty when the period is complete. Runs still running are counted apart. */
33
+ partial: string[];
34
+ runs: {
35
+ counted: number;
36
+ fromCache: number;
37
+ running: number;
38
+ skipped: number;
39
+ };
40
+ /** The cache to write back: the runs this collection saw, nothing older. */
41
+ cache: RunCache;
42
+ /** A failure that left the repository unread (no access, unknown repository). */
43
+ error: string | null;
44
+ }
45
+ /** UTC day slices of [from, to); the first and the last may be shorter. */
46
+ export declare function getSlices(from: Date, to: Date, stepMs?: number): {
47
+ from: Date;
48
+ to: Date;
49
+ }[];
50
+ export declare function collectRepository(options: CollectOptions): Promise<CollectResult>;
51
+ //# sourceMappingURL=collect.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collect.d.ts","sourceRoot":"","sources":["../src/collect.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAgC5C,2GAA2G;AAC3G,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,CAAC,CAAC;IACX,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,EAAE,CAAA;KAAE,CAAC,CAAC;CAChE;AAID,yGAAyG;AACzG,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,CAQ3D;AAED,8DAA8D;AAC9D,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAIvC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,YAAY,CAAC;IACrB,oBAAoB;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,EAAE,EAAE,IAAI,CAAC;IACT,KAAK,EAAE,QAAQ,CAAC;IAChB,0GAA0G;IAC1G,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,mCAAmC;IACnC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC;CAClB;AAED,sGAAsG;AACtG,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB,6GAA6G;IAC7G,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/E,4EAA4E;IAC5E,KAAK,EAAE,QAAQ,CAAC;IAChB,iFAAiF;IACjF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,2EAA2E;AAC3E,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,GAAE,MAAe,GAAG;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,EAAE,EAAE,IAAI,CAAA;CAAE,EAAE,CASnG;AAwFD,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAgFvF"}
@@ -0,0 +1,224 @@
1
+ // The jobs of every finished workflow run created in a period, read through the Actions API one day at a time.
2
+ import { z } from "zod";
3
+ const RUN = z.object({
4
+ id: z.number(),
5
+ name: z.string().nullable().optional(),
6
+ path: z.string(),
7
+ // A run in progress has no conclusion key at all in some answers.
8
+ status: z.string().nullable().optional(),
9
+ conclusion: z.string().nullable().optional(),
10
+ run_attempt: z.number().optional(),
11
+ updated_at: z.string(),
12
+ });
13
+ const RUNS_PAGE = z.object({ total_count: z.number(), workflow_runs: z.array(RUN) });
14
+ const JOB = z.object({
15
+ id: z.number(),
16
+ run_id: z.number(),
17
+ run_attempt: z.number().optional(),
18
+ name: z.string(),
19
+ workflow_name: z.string().nullable().optional(),
20
+ started_at: z.string().nullable().optional(),
21
+ completed_at: z.string().nullable().optional(),
22
+ labels: z.array(z.string()),
23
+ runner_group_name: z.string().nullable().optional(),
24
+ html_url: z.string().nullable().optional(),
25
+ });
26
+ const JOBS_PAGE = z.object({ total_count: z.number(), jobs: z.array(JOB) });
27
+ const CACHE = z.object({ version: z.literal(1), runs: z.record(z.string(), z.object({ updatedAt: z.string(), jobs: z.array(z.unknown()) })) });
28
+ /** Reads a cache file's text; anything unreadable starts an empty cache (it is only an optimisation). */
29
+ export function parseRunCache(text) {
30
+ if (text === null)
31
+ return { version: 1, runs: {} };
32
+ try {
33
+ const parsed = CACHE.safeParse(JSON.parse(text));
34
+ return parsed.success ? parsed.data : { version: 1, runs: {} };
35
+ }
36
+ catch {
37
+ return { version: 1, runs: {} };
38
+ }
39
+ }
40
+ /** GitHub returns at most 1,000 runs for a filtered query. */
41
+ export const MAX_RUNS_PER_QUERY = 1000;
42
+ const HOUR_MS = 3_600_000;
43
+ const DAY_MS = 24 * HOUR_MS;
44
+ /** Runs whose jobs are read at the same time: far below GitHub's limit of 100 concurrent requests. */
45
+ export const JOB_CONCURRENCY = 8;
46
+ /** UTC day slices of [from, to); the first and the last may be shorter. */
47
+ export function getSlices(from, to, stepMs = DAY_MS) {
48
+ const slices = [];
49
+ let start = from.getTime();
50
+ while (start < to.getTime()) {
51
+ const end = Math.min(to.getTime(), (Math.floor(start / stepMs) + 1) * stepMs);
52
+ slices.push({ from: new Date(start), to: new Date(end) });
53
+ start = end;
54
+ }
55
+ return slices;
56
+ }
57
+ /** GitHub's `created` range; the end is exclusive here, so one millisecond less, at second precision. */
58
+ function getCreatedRange(slice) {
59
+ const last = new Date(slice.to.getTime() - 1000);
60
+ const format = (date) => date.toISOString().replace(/\.\d{3}Z$/, "Z");
61
+ return `${format(slice.from)}..${format(last)}`;
62
+ }
63
+ function toJobRecord(job, run) {
64
+ return {
65
+ id: job.id,
66
+ runId: job.run_id,
67
+ runAttempt: job.run_attempt ?? 1,
68
+ name: job.name,
69
+ workflowName: job.workflow_name ?? run.name ?? run.path,
70
+ workflowPath: run.path,
71
+ startedAt: job.started_at ?? null,
72
+ completedAt: job.completed_at ?? null,
73
+ runUpdatedAt: run.updated_at,
74
+ labels: job.labels,
75
+ runnerGroupName: job.runner_group_name ?? null,
76
+ htmlUrl: job.html_url ?? "",
77
+ };
78
+ }
79
+ async function listRuns(client, repository, slice) {
80
+ const runs = [];
81
+ let total = 0;
82
+ let next = `/repos/${repository}/actions/runs`;
83
+ let query = { created: getCreatedRange(slice), per_page: "100", exclude_pull_requests: "true" };
84
+ while (next !== null) {
85
+ const result = await client.get(next, query);
86
+ if (!result.ok)
87
+ return result;
88
+ const page = RUNS_PAGE.safeParse(result.data);
89
+ if (!page.success)
90
+ return { ok: false, kind: "http", message: `GET /repos/${repository}/actions/runs answered an unexpected shape` };
91
+ total = page.data.total_count;
92
+ runs.push(...page.data.workflow_runs);
93
+ next = result.next;
94
+ query = undefined;
95
+ }
96
+ return { ok: true, value: { total, runs } };
97
+ }
98
+ async function listJobs(client, repository, run) {
99
+ const jobs = [];
100
+ let next = `/repos/${repository}/actions/runs/${String(run.id)}/jobs`;
101
+ let query = { filter: "all", per_page: "100" };
102
+ while (next !== null) {
103
+ const result = await client.get(next, query);
104
+ if (!result.ok)
105
+ return result;
106
+ const page = JOBS_PAGE.safeParse(result.data);
107
+ if (!page.success)
108
+ return { ok: false, kind: "http", message: `GET /repos/${repository}/actions/runs/${String(run.id)}/jobs answered an unexpected shape` };
109
+ jobs.push(...page.data.jobs.map((job) => toJobRecord(job, run)));
110
+ next = result.next;
111
+ query = undefined;
112
+ }
113
+ return { ok: true, value: jobs };
114
+ }
115
+ function formatTime(date) {
116
+ return date.toISOString().replace(/:\d{2}\.\d{3}Z$/, "Z");
117
+ }
118
+ /** Reads the runs of each slice, splitting a day into hours when it holds more runs than one query returns. */
119
+ async function listAllRuns(options, partial) {
120
+ const runs = [];
121
+ for (const day of getSlices(options.from, options.to)) {
122
+ const first = await listRuns(options.client, options.repository, day);
123
+ if (!first.ok)
124
+ return first;
125
+ if (first.value.total <= MAX_RUNS_PER_QUERY) {
126
+ runs.push(...first.value.runs);
127
+ continue;
128
+ }
129
+ for (const hour of getSlices(day.from, day.to, HOUR_MS)) {
130
+ const listed = await listRuns(options.client, options.repository, hour);
131
+ if (!listed.ok)
132
+ return listed;
133
+ if (listed.value.total > MAX_RUNS_PER_QUERY) {
134
+ partial.push(`${String(listed.value.total)} runs created between ${formatTime(hour.from)} and ${formatTime(hour.to)}: only ${String(MAX_RUNS_PER_QUERY)} counted`);
135
+ }
136
+ runs.push(...listed.value.runs);
137
+ }
138
+ }
139
+ return { ok: true, value: runs };
140
+ }
141
+ export async function collectRepository(options) {
142
+ const { client, repository } = options;
143
+ const partial = [];
144
+ const cache = { version: 1, runs: {} };
145
+ const jobs = [];
146
+ const counts = { counted: 0, fromCache: 0, running: 0, skipped: 0 };
147
+ const done = (error = null) => ({ repository, jobs, partial, runs: counts, cache, error });
148
+ const listed = await listAllRuns(options, partial);
149
+ if (!listed.ok) {
150
+ if (listed.kind === "budget") {
151
+ partial.push(`the run list stopped early: ${listed.message}`);
152
+ return done();
153
+ }
154
+ return done(listed.message);
155
+ }
156
+ // Oldest first, so a stop leaves a clean "counted up to" boundary: every run before it is counted, none after.
157
+ const runs = [...listed.value].sort((a, b) => a.id - b.id);
158
+ const now = options.now ?? (() => new Date());
159
+ const read = new Map();
160
+ const pending = [];
161
+ let stop = null;
162
+ for (const [index, run] of runs.entries()) {
163
+ if (run.status !== "completed" || run.conclusion === "skipped")
164
+ continue;
165
+ const key = `${String(run.id)}:${String(run.run_attempt ?? 1)}`;
166
+ if (options.cache.runs[key]?.updatedAt !== run.updated_at)
167
+ pending.push({ index, run, key });
168
+ }
169
+ for (let start = 0; start < pending.length && stop === null; start += JOB_CONCURRENCY) {
170
+ const batch = pending.slice(start, start + JOB_CONCURRENCY);
171
+ const first = batch[0];
172
+ if (first !== undefined && options.deadline !== undefined && now() >= options.deadline) {
173
+ stop = { index: first.index, note: `stopped at the time budget: ${String(runs.length - first.index)} of ${String(runs.length)} runs not counted` };
174
+ break;
175
+ }
176
+ const results = await Promise.all(batch.map((item) => listJobs(client, repository, item.run)));
177
+ for (const [offset, result] of results.entries()) {
178
+ const item = batch[offset];
179
+ if (item === undefined)
180
+ continue;
181
+ if (result.ok) {
182
+ read.set(item.index, result.value);
183
+ continue;
184
+ }
185
+ if (result.kind === "budget") {
186
+ stop = { index: item.index, note: `stopped at the rate limit: ${String(runs.length - item.index)} of ${String(runs.length)} runs not counted (${result.message})` };
187
+ break;
188
+ }
189
+ partial.push(`run ${String(item.run.id)} not counted: ${result.message}`);
190
+ }
191
+ }
192
+ for (const [index, run] of runs.entries()) {
193
+ if (stop !== null && index >= stop.index)
194
+ break;
195
+ if (run.status !== "completed") {
196
+ counts.running += 1;
197
+ continue;
198
+ }
199
+ if (run.conclusion === "skipped") {
200
+ counts.skipped += 1;
201
+ continue;
202
+ }
203
+ const key = `${String(run.id)}:${String(run.run_attempt ?? 1)}`;
204
+ const fresh = read.get(index);
205
+ if (fresh !== undefined) {
206
+ jobs.push(...fresh);
207
+ cache.runs[key] = { updatedAt: run.updated_at, jobs: fresh };
208
+ counts.counted += 1;
209
+ continue;
210
+ }
211
+ const cached = options.cache.runs[key];
212
+ if (cached?.updatedAt === run.updated_at) {
213
+ jobs.push(...cached.jobs);
214
+ cache.runs[key] = cached;
215
+ counts.counted += 1;
216
+ counts.fromCache += 1;
217
+ }
218
+ // Otherwise the read failed with an HTTP error, already noted in `partial`.
219
+ }
220
+ if (stop !== null)
221
+ partial.push(stop.note);
222
+ return done();
223
+ }
224
+ //# sourceMappingURL=collect.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"collect.js","sourceRoot":"","sources":["../src/collect.ts"],"names":[],"mappings":"AAAA,+GAA+G;AAC/G,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC;IACnB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,kEAAkE;IAClE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACxC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC5C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAErF,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC;IACnB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC5C,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC9C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACnD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAU5E,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAE/I,yGAAyG;AACzG,MAAM,UAAU,aAAa,CAAC,IAAmB;IAC/C,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IACnD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QACjD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAE,MAAM,CAAC,IAAiB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAC/E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAClC,CAAC;AACH,CAAC;AAED,8DAA8D;AAC9D,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC,MAAM,OAAO,GAAG,SAAS,CAAC;AAC1B,MAAM,MAAM,GAAG,EAAE,GAAG,OAAO,CAAC;AAe5B,sGAAsG;AACtG,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC;AAcjC,2EAA2E;AAC3E,MAAM,UAAU,SAAS,CAAC,IAAU,EAAE,EAAQ,EAAE,MAAM,GAAW,MAAM;IACrE,MAAM,MAAM,GAA+B,EAAE,CAAC;IAC9C,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC3B,OAAO,KAAK,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC;QAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC;QAC9E,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1D,KAAK,GAAG,GAAG,CAAC;IACd,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,yGAAyG;AACzG,SAAS,eAAe,CAAC,KAA+B;IACtD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,CAAC,IAAU,EAAU,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IACpF,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;AAClD,CAAC;AAED,SAAS,WAAW,CAAC,GAAwB,EAAE,GAAQ;IACrD,OAAO;QACL,EAAE,EAAE,GAAG,CAAC,EAAE;QACV,KAAK,EAAE,GAAG,CAAC,MAAM;QACjB,UAAU,EAAE,GAAG,CAAC,WAAW,IAAI,CAAC;QAChC,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,YAAY,EAAE,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI;QACvD,YAAY,EAAE,GAAG,CAAC,IAAI;QACtB,SAAS,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI;QACjC,WAAW,EAAE,GAAG,CAAC,YAAY,IAAI,IAAI;QACrC,YAAY,EAAE,GAAG,CAAC,UAAU;QAC5B,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,eAAe,EAAE,GAAG,CAAC,iBAAiB,IAAI,IAAI;QAC9C,OAAO,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE;KAC5B,CAAC;AACJ,CAAC;AAID,KAAK,UAAU,QAAQ,CAAC,MAAoB,EAAE,UAAkB,EAAE,KAA+B;IAC/F,MAAM,IAAI,GAAU,EAAE,CAAC;IACvB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,IAAI,GAAkB,UAAU,UAAU,eAAe,CAAC;IAC9D,IAAI,KAAK,GAAuC,EAAE,OAAO,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,CAAC;IACpI,OAAO,IAAI,KAAK,IAAI,EAAE,CAAC;QACrB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,OAAO,MAAM,CAAC;QAC9B,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,UAAU,4CAA4C,EAAE,CAAC;QACrI,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACtC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACnB,KAAK,GAAG,SAAS,CAAC;IACpB,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC;AAC9C,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,MAAoB,EAAE,UAAkB,EAAE,GAAQ;IACxE,MAAM,IAAI,GAAgB,EAAE,CAAC;IAC7B,IAAI,IAAI,GAAkB,UAAU,UAAU,iBAAiB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC;IACrF,IAAI,KAAK,GAAuC,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IACnF,OAAO,IAAI,KAAK,IAAI,EAAE,CAAC;QACrB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,OAAO,MAAM,CAAC;QAC9B,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,UAAU,iBAAiB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,oCAAoC,EAAE,CAAC;QAC5J,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QACjE,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACnB,KAAK,GAAG,SAAS,CAAC;IACpB,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,UAAU,CAAC,IAAU;IAC5B,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;AAC5D,CAAC;AAED,+GAA+G;AAC/G,KAAK,UAAU,WAAW,CAAC,OAAuB,EAAE,OAAiB;IACnE,MAAM,IAAI,GAAU,EAAE,CAAC;IACvB,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;QACtD,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,CAAC,EAAE;YAAE,OAAO,KAAK,CAAC;QAC5B,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,kBAAkB,EAAE,CAAC;YAC5C,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC/B,SAAS;QACX,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YACxE,IAAI,CAAC,MAAM,CAAC,EAAE;gBAAE,OAAO,MAAM,CAAC;YAC9B,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,kBAAkB,EAAE,CAAC;gBAC5C,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,yBAAyB,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;YACrK,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAuB;IAC7D,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACvC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,KAAK,GAAa,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IACjD,MAAM,IAAI,GAAgB,EAAE,CAAC;IAC7B,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;IACpE,MAAM,IAAI,GAAG,CAAC,KAAK,GAAkB,IAAI,EAAiB,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAEzH,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACnD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,+BAA+B,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;YAC9D,OAAO,IAAI,EAAE,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,+GAA+G;IAC/G,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAS,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IACpD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC5C,MAAM,OAAO,GAA+C,EAAE,CAAC;IAC/D,IAAI,IAAI,GAA2C,IAAI,CAAC;IACxD,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QAC1C,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS;YAAE,SAAS;QACzE,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,EAAE,CAAC;QAChE,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,SAAS,KAAK,GAAG,CAAC,UAAU;YAAE,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/F,CAAC;IACD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,KAAK,IAAI,eAAe,EAAE,CAAC;QACtF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,CAAC,CAAC;QAC5D,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,GAAG,EAAE,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACvF,IAAI,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,+BAA+B,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC;YACnJ,MAAM;QACR,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/F,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;YAC3B,IAAI,IAAI,KAAK,SAAS;gBAAE,SAAS;YACjC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;gBACnC,SAAS;YACX,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC7B,IAAI,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,8BAA8B,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;gBACpK,MAAM;YACR,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,iBAAiB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAED,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QAC1C,IAAI,IAAI,KAAK,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK;YAAE,MAAM;QAChD,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YAC/B,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;YACpB,SAAS;QACX,CAAC;QACD,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;YACpB,SAAS;QACX,CAAC;QACD,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,EAAE,CAAC;QAChE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC;YACpB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC7D,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;YACpB,SAAS;QACX,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,MAAM,EAAE,SAAS,KAAK,GAAG,CAAC,UAAU,EAAE,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAC1B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;YACzB,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;YACpB,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC;QACxB,CAAC;QACD,4EAA4E;IAC9E,CAAC;IACD,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3C,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC"}
@@ -0,0 +1,41 @@
1
+ export type FetchLike = (url: string, init: {
2
+ method: string;
3
+ headers: Record<string, string>;
4
+ body?: string;
5
+ }) => Promise<Response>;
6
+ export interface GithubClientOptions {
7
+ token: string;
8
+ fetch?: FetchLike;
9
+ baseUrl?: string;
10
+ /** Requests kept in reserve: the client stops reading when `x-ratelimit-remaining` reaches it. */
11
+ reserve?: number;
12
+ }
13
+ export type GithubResult<T> = {
14
+ ok: true;
15
+ data: T;
16
+ next: string | null;
17
+ } | {
18
+ ok: false;
19
+ kind: "budget";
20
+ message: string;
21
+ } | {
22
+ ok: false;
23
+ kind: "http";
24
+ status: number;
25
+ message: string;
26
+ };
27
+ export interface GithubClient {
28
+ get: (pathOrUrl: string, query?: Record<string, string>) => Promise<GithubResult<unknown>>;
29
+ /** A JSON POST or PATCH; writes ignore the reserve (they are few and the report depends on them). */
30
+ send: (method: "POST" | "PATCH", path: string, body: unknown) => Promise<GithubResult<unknown>>;
31
+ /** Requests sent so far. */
32
+ getRequestCount: () => number;
33
+ /** The last `x-ratelimit-remaining` seen, or null before the first answer. */
34
+ getRemaining: () => number | null;
35
+ }
36
+ export declare const DEFAULT_BASE_URL = "https://api.github.com";
37
+ export declare const DEFAULT_RESERVE = 50;
38
+ /** The `rel="next"` address of a Link header, or null. */
39
+ export declare function getNextLink(header: string | null): string | null;
40
+ export declare function createGithubClient(options: GithubClientOptions): GithubClient;
41
+ //# sourceMappingURL=github.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"github.d.ts","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAErI,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kGAAkG;IAClG,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,IACtB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAC1C;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAC9C;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjE,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3F,qGAAqG;IACrG,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,KAAK,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IAChG,4BAA4B;IAC5B,eAAe,EAAE,MAAM,MAAM,CAAC;IAC9B,8EAA8E;IAC9E,YAAY,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,eAAO,MAAM,gBAAgB,2BAA2B,CAAC;AACzD,eAAO,MAAM,eAAe,KAAK,CAAC;AAGlC,0DAA0D;AAC1D,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAShE;AAiBD,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,YAAY,CAqD7E"}
package/dist/github.js ADDED
@@ -0,0 +1,91 @@
1
+ // A small GitHub REST client on the built-in fetch: JSON GETs, Link pagination and a request budget read from the
2
+ // rate-limit headers, so a busy repository ends in a partial report instead of a failed or sleeping job.
3
+ export const DEFAULT_BASE_URL = "https://api.github.com";
4
+ export const DEFAULT_RESERVE = 50;
5
+ const API_VERSION = "2022-11-28";
6
+ /** The `rel="next"` address of a Link header, or null. */
7
+ export function getNextLink(header) {
8
+ if (header === null)
9
+ return null;
10
+ // Plain string parsing: the header comes from the network, so no backtracking pattern runs over it.
11
+ for (const part of header.split(",")) {
12
+ const [target, ...params] = part.split(";").map((piece) => piece.trim());
13
+ if (target === undefined || !target.startsWith("<") || !target.endsWith(">"))
14
+ continue;
15
+ if (params.some((param) => param.replace(/ /g, "") === 'rel="next"'))
16
+ return target.slice(1, -1);
17
+ }
18
+ return null;
19
+ }
20
+ function buildUrl(baseUrl, pathOrUrl, query) {
21
+ const url = new URL(pathOrUrl.startsWith("https://") ? pathOrUrl : `${baseUrl}${pathOrUrl}`);
22
+ for (const [key, value] of Object.entries(query ?? {}))
23
+ url.searchParams.set(key, value);
24
+ return url.toString();
25
+ }
26
+ async function readMessage(response) {
27
+ try {
28
+ const body = (await response.json());
29
+ return typeof body.message === "string" ? body.message : response.statusText;
30
+ }
31
+ catch {
32
+ return response.statusText;
33
+ }
34
+ }
35
+ export function createGithubClient(options) {
36
+ const fetchJson = options.fetch ?? ((url, init) => fetch(url, init));
37
+ const baseUrl = options.baseUrl ?? DEFAULT_BASE_URL;
38
+ const reserve = options.reserve ?? DEFAULT_RESERVE;
39
+ let requests = 0;
40
+ let remaining = null;
41
+ async function request(method, url, body) {
42
+ // The path, never the token, names the request in every message.
43
+ const name = `${method} ${new URL(url).pathname}`;
44
+ if (method === "GET" && remaining !== null && remaining <= reserve) {
45
+ return { ok: false, kind: "budget", message: `${name}: the rate limit is down to ${String(remaining)} requests (reserve ${String(reserve)})` };
46
+ }
47
+ requests += 1;
48
+ let response;
49
+ try {
50
+ response = await fetchJson(url, {
51
+ method,
52
+ headers: {
53
+ accept: "application/vnd.github+json",
54
+ authorization: `Bearer ${options.token}`,
55
+ "x-github-api-version": API_VERSION,
56
+ "user-agent": "softure-ci-usage",
57
+ ...(body === undefined ? {} : { "content-type": "application/json" }),
58
+ },
59
+ ...(body === undefined ? {} : { body: JSON.stringify(body) }),
60
+ });
61
+ }
62
+ catch (error) {
63
+ return { ok: false, kind: "http", status: 0, message: `${name} failed: ${error instanceof Error ? error.message : String(error)}` };
64
+ }
65
+ const header = response.headers.get("x-ratelimit-remaining");
66
+ if (header !== null && Number.isFinite(Number(header)))
67
+ remaining = Number(header);
68
+ if (!response.ok) {
69
+ const message = await readMessage(response);
70
+ const limited = (response.status === 403 || response.status === 429) && (remaining === 0 || response.headers.has("retry-after"));
71
+ if (limited)
72
+ return { ok: false, kind: "budget", message: `${name}: rate limited (${message})` };
73
+ return { ok: false, kind: "http", status: response.status, message: `${name} answered ${String(response.status)}: ${message}` };
74
+ }
75
+ let data;
76
+ try {
77
+ data = await response.json();
78
+ }
79
+ catch {
80
+ return { ok: false, kind: "http", status: response.status, message: `${name} answered with a body that is not JSON` };
81
+ }
82
+ return { ok: true, data, next: getNextLink(response.headers.get("link")) };
83
+ }
84
+ return {
85
+ get: (pathOrUrl, query) => request("GET", buildUrl(baseUrl, pathOrUrl, query), undefined),
86
+ send: (method, path, body) => request(method, buildUrl(baseUrl, path, undefined), body),
87
+ getRequestCount: () => requests,
88
+ getRemaining: () => remaining,
89
+ };
90
+ }
91
+ //# sourceMappingURL=github.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":"AAAA,kHAAkH;AAClH,yGAAyG;AA2BzG,MAAM,CAAC,MAAM,gBAAgB,GAAG,wBAAwB,CAAC;AACzD,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC;AAClC,MAAM,WAAW,GAAG,YAAY,CAAC;AAEjC,0DAA0D;AAC1D,MAAM,UAAU,WAAW,CAAC,MAAqB;IAC/C,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACjC,oGAAoG;IACpG,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QACzE,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,SAAS;QACvF,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,YAAY,CAAC;YAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnG,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe,EAAE,SAAiB,EAAE,KAAyC;IAC7F,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,SAAS,EAAE,CAAC,CAAC;IAC7F,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;QAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACzF,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;AACxB,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,QAAkB;IAC3C,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA0B,CAAC;QAC9D,OAAO,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;IAC/E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC7B,CAAC;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,OAA4B;IAC7D,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACrE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,gBAAgB,CAAC;IACpD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,eAAe,CAAC;IACnD,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,IAAI,SAAS,GAAkB,IAAI,CAAC;IAEpC,KAAK,UAAU,OAAO,CAAC,MAAgC,EAAE,GAAW,EAAE,IAAa;QACjF,iEAAiE;QACjE,MAAM,IAAI,GAAG,GAAG,MAAM,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QAClD,IAAI,MAAM,KAAK,KAAK,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YACnE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,+BAA+B,MAAM,CAAC,SAAS,CAAC,sBAAsB,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjJ,CAAC;QACD,QAAQ,IAAI,CAAC,CAAC;QACd,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE;gBAC9B,MAAM;gBACN,OAAO,EAAE;oBACP,MAAM,EAAE,6BAA6B;oBACrC,aAAa,EAAE,UAAU,OAAO,CAAC,KAAK,EAAE;oBACxC,sBAAsB,EAAE,WAAW;oBACnC,YAAY,EAAE,kBAAkB;oBAChC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC;iBACtE;gBACD,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;aAC9D,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,YAAY,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;QACtI,CAAC;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAAE,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACnF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;YACjI,IAAI,OAAO;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,mBAAmB,OAAO,GAAG,EAAE,CAAC;YACjG,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,aAAa,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,OAAO,EAAE,EAAE,CAAC;QAClI,CAAC;QACD,IAAI,IAAa,CAAC;QAClB,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,wCAAwC,EAAE,CAAC;QACxH,CAAC;QACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IAC7E,CAAC;IAED,OAAO;QACL,GAAG,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC;QACzF,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC;QACvF,eAAe,EAAE,GAAG,EAAE,CAAC,QAAQ;QAC/B,YAAY,EAAE,GAAG,EAAE,CAAC,SAAS;KAC9B,CAAC;AACJ,CAAC"}
@@ -0,0 +1,10 @@
1
+ export { getBillingUsage, parseBillingAccount, type BillingAccount, type BilledSku, type BillingResult } from "./billing.js";
2
+ export { collectRepository, getSlices, parseRunCache, MAX_RUNS_PER_QUERY, type CollectOptions, type CollectResult, type RunCache } from "./collect.js";
3
+ export { createGithubClient, getNextLink, DEFAULT_RESERVE, type FetchLike, type GithubClient, type GithubResult } from "./github.js";
4
+ export { ciUsageMessages, formatMessage, type CiUsageMessages } from "./messages/index.js";
5
+ export { DEFAULT_PRICES, getMinutePrice, parsePriceOverrides, type PriceOptions, type PriceTable } from "./prices.js";
6
+ export { buildComment, buildIssueBody, publishReport, ISSUE_LABEL, MAX_BODY, type PublishResult } from "./publish.js";
7
+ export { buildReport, renderMarkdown, JSON_FILE, MARKDOWN_FILE, REPORT_MARKER, SCHEMA_VERSION, type CiUsageReport, type RepositoryReport } from "./report.js";
8
+ export { classifyRunner, GITHUB_SKUS, type GithubSku, type Provider, type RunnerClass } from "./runner.js";
9
+ export { getJobMinutes, summarizeUsage, type Cost, type JobRecord, type JobUsage, type RepositoryUsage, type WorkflowUsage } from "./usage.js";
10
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,KAAK,cAAc,EAAE,KAAK,SAAS,EAAE,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7H,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,kBAAkB,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAC;AACvJ,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,SAAS,EAAE,KAAK,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AACrI,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AACtH,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AACtH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC9J,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,KAAK,SAAS,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAC3G,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,IAAI,EAAE,KAAK,SAAS,EAAE,KAAK,QAAQ,EAAE,KAAK,eAAe,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,11 @@
1
+ // @softure-ai/ci-usage: billable CI minutes and their estimated cost per repository, workflow and job.
2
+ export { getBillingUsage, parseBillingAccount } from "./billing.js";
3
+ export { collectRepository, getSlices, parseRunCache, MAX_RUNS_PER_QUERY } from "./collect.js";
4
+ export { createGithubClient, getNextLink, DEFAULT_RESERVE } from "./github.js";
5
+ export { ciUsageMessages, formatMessage } from "./messages/index.js";
6
+ export { DEFAULT_PRICES, getMinutePrice, parsePriceOverrides } from "./prices.js";
7
+ export { buildComment, buildIssueBody, publishReport, ISSUE_LABEL, MAX_BODY } from "./publish.js";
8
+ export { buildReport, renderMarkdown, JSON_FILE, MARKDOWN_FILE, REPORT_MARKER, SCHEMA_VERSION } from "./report.js";
9
+ export { classifyRunner, GITHUB_SKUS } from "./runner.js";
10
+ export { getJobMinutes, summarizeUsage } from "./usage.js";
11
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,uGAAuG;AACvG,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAA2D,MAAM,cAAc,CAAC;AAC7H,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,kBAAkB,EAA0D,MAAM,cAAc,CAAC;AACvJ,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,eAAe,EAAwD,MAAM,aAAa,CAAC;AACrI,OAAO,EAAE,eAAe,EAAE,aAAa,EAAwB,MAAM,qBAAqB,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAsC,MAAM,aAAa,CAAC;AACtH,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAsB,MAAM,cAAc,CAAC;AACtH,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAA6C,MAAM,aAAa,CAAC;AAC9J,OAAO,EAAE,cAAc,EAAE,WAAW,EAAmD,MAAM,aAAa,CAAC;AAC3G,OAAO,EAAE,aAAa,EAAE,cAAc,EAAsF,MAAM,YAAY,CAAC"}
@@ -0,0 +1,51 @@
1
+ /** Copy of the CI usage report (Markdown, the issue and its comments). English, the only built-in language. */
2
+ export declare const en: {
3
+ readonly title: "CI usage report";
4
+ /** `{from}` and `{to}` are UTC times, `{days}` the length of the period. */
5
+ readonly period: "Period: {from} to {to} UTC ({days} days). Generated {generated} UTC.";
6
+ readonly complete: "Status: complete.";
7
+ readonly partial: "Status: partial, some runs are not counted (see the notes of each repository).";
8
+ readonly howToRead: "Minutes are billable minutes: each job rounded up to a whole minute, reruns included. USD is the estimate at list price (public repositories pay nothing for standard GitHub runners; the plan's included minutes are not subtracted).";
9
+ readonly totalsHeading: "Totals";
10
+ readonly repository: "Repository";
11
+ readonly minutes: "Minutes";
12
+ readonly usd: "Est. USD";
13
+ readonly githubHosted: "GitHub-hosted";
14
+ readonly ubicloud: "Ubicloud";
15
+ readonly selfHosted: "Self-hosted";
16
+ readonly runs: "Runs";
17
+ readonly jobs: "Jobs";
18
+ readonly workflowsHeading: "Workflows";
19
+ readonly workflow: "Workflow";
20
+ readonly share: "Share";
21
+ readonly topJobsHeading: "Jobs that use the most minutes";
22
+ readonly job: "Job";
23
+ readonly runner: "Runner";
24
+ readonly count: "Count";
25
+ readonly p50: "p50 min";
26
+ readonly p95: "p95 min";
27
+ readonly longestHeading: "Longest single jobs";
28
+ /** One list item; `{url}` links the job. */
29
+ readonly longestItem: "[{minutes} min]({url}) {workflow} / {job} on `{runner}`";
30
+ readonly billingHeading: "Billed by GitHub";
31
+ readonly sku: "SKU";
32
+ readonly gross: "Gross USD";
33
+ readonly net: "Net USD";
34
+ readonly notesHeading: "Notes";
35
+ /** Runs still running when the report was made: counted next time. */
36
+ readonly running: "{count} runs were still running and are left out.";
37
+ readonly fromCache: "{count} of {total} runs came from the cache of earlier reports.";
38
+ readonly unknownPrice: "{minutes} minutes ran on runners without a known price (set the `prices` input to price them).";
39
+ readonly error: "Not read: {error}";
40
+ readonly noRuns: "No finished runs in the period.";
41
+ readonly unknown: "unknown";
42
+ /** Under the report; `{source}` lists the price pages, `{checkedOn}` the day they were read. */
43
+ readonly prices: "Prices: {source} (checked {checkedOn}){premium}.";
44
+ readonly premium: ", Ubicloud priced as premium";
45
+ readonly jsonSummary: "The report as JSON";
46
+ readonly jsonTooLong: "The JSON report is too long for this issue: it is in the run's artifact `ci-usage-report`.";
47
+ readonly issueIntro: "This issue is kept up to date by the ci-usage workflow (@softure-ai/ci-usage): its body is always the latest report, and every run adds a comment with its totals.";
48
+ /** The comment one run adds; `{url}` is the run. */
49
+ readonly comment: "{from} to {to} UTC: {minutes} minutes, {usd} USD estimated, {runs} runs. [Run]({url})";
50
+ };
51
+ //# sourceMappingURL=en.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"en.d.ts","sourceRoot":"","sources":["../../src/messages/en.ts"],"names":[],"mappings":"AAAA,+GAA+G;AAC/G,eAAO,MAAM,EAAE;aACb,KAAK,EAAE,iBAAiB;IACxB,4EAA4E;aAC5E,MAAM,EAAE,sEAAsE;aAC9E,QAAQ,EAAE,mBAAmB;aAC7B,OAAO,EAAE,gFAAgF;aACzF,SAAS,EACP,wOAAwO;aAC1O,aAAa,EAAE,QAAQ;aACvB,UAAU,EAAE,YAAY;aACxB,OAAO,EAAE,SAAS;aAClB,GAAG,EAAE,UAAU;aACf,YAAY,EAAE,eAAe;aAC7B,QAAQ,EAAE,UAAU;aACpB,UAAU,EAAE,aAAa;aACzB,IAAI,EAAE,MAAM;aACZ,IAAI,EAAE,MAAM;aACZ,gBAAgB,EAAE,WAAW;aAC7B,QAAQ,EAAE,UAAU;aACpB,KAAK,EAAE,OAAO;aACd,cAAc,EAAE,gCAAgC;aAChD,GAAG,EAAE,KAAK;aACV,MAAM,EAAE,QAAQ;aAChB,KAAK,EAAE,OAAO;aACd,GAAG,EAAE,SAAS;aACd,GAAG,EAAE,SAAS;aACd,cAAc,EAAE,qBAAqB;IACrC,4CAA4C;aAC5C,WAAW,EAAE,yDAAyD;aACtE,cAAc,EAAE,kBAAkB;aAClC,GAAG,EAAE,KAAK;aACV,KAAK,EAAE,WAAW;aAClB,GAAG,EAAE,SAAS;aACd,YAAY,EAAE,OAAO;IACrB,sEAAsE;aACtE,OAAO,EAAE,mDAAmD;aAC5D,SAAS,EAAE,iEAAiE;aAC5E,YAAY,EAAE,gGAAgG;aAC9G,KAAK,EAAE,mBAAmB;aAC1B,MAAM,EAAE,iCAAiC;aACzC,OAAO,EAAE,SAAS;IAClB,gGAAgG;aAChG,MAAM,EAAE,kDAAkD;aAC1D,OAAO,EAAE,8BAA8B;aACvC,WAAW,EAAE,oBAAoB;aACjC,WAAW,EAAE,4FAA4F;aACzG,UAAU,EACR,oKAAoK;IACtK,oDAAoD;aACpD,OAAO,EAAE,uFAAuF;CACxF,CAAC"}
@@ -0,0 +1,51 @@
1
+ /** Copy of the CI usage report (Markdown, the issue and its comments). English, the only built-in language. */
2
+ export const en = {
3
+ title: "CI usage report",
4
+ /** `{from}` and `{to}` are UTC times, `{days}` the length of the period. */
5
+ period: "Period: {from} to {to} UTC ({days} days). Generated {generated} UTC.",
6
+ complete: "Status: complete.",
7
+ partial: "Status: partial, some runs are not counted (see the notes of each repository).",
8
+ howToRead: "Minutes are billable minutes: each job rounded up to a whole minute, reruns included. USD is the estimate at list price (public repositories pay nothing for standard GitHub runners; the plan's included minutes are not subtracted).",
9
+ totalsHeading: "Totals",
10
+ repository: "Repository",
11
+ minutes: "Minutes",
12
+ usd: "Est. USD",
13
+ githubHosted: "GitHub-hosted",
14
+ ubicloud: "Ubicloud",
15
+ selfHosted: "Self-hosted",
16
+ runs: "Runs",
17
+ jobs: "Jobs",
18
+ workflowsHeading: "Workflows",
19
+ workflow: "Workflow",
20
+ share: "Share",
21
+ topJobsHeading: "Jobs that use the most minutes",
22
+ job: "Job",
23
+ runner: "Runner",
24
+ count: "Count",
25
+ p50: "p50 min",
26
+ p95: "p95 min",
27
+ longestHeading: "Longest single jobs",
28
+ /** One list item; `{url}` links the job. */
29
+ longestItem: "[{minutes} min]({url}) {workflow} / {job} on `{runner}`",
30
+ billingHeading: "Billed by GitHub",
31
+ sku: "SKU",
32
+ gross: "Gross USD",
33
+ net: "Net USD",
34
+ notesHeading: "Notes",
35
+ /** Runs still running when the report was made: counted next time. */
36
+ running: "{count} runs were still running and are left out.",
37
+ fromCache: "{count} of {total} runs came from the cache of earlier reports.",
38
+ unknownPrice: "{minutes} minutes ran on runners without a known price (set the `prices` input to price them).",
39
+ error: "Not read: {error}",
40
+ noRuns: "No finished runs in the period.",
41
+ unknown: "unknown",
42
+ /** Under the report; `{source}` lists the price pages, `{checkedOn}` the day they were read. */
43
+ prices: "Prices: {source} (checked {checkedOn}){premium}.",
44
+ premium: ", Ubicloud priced as premium",
45
+ jsonSummary: "The report as JSON",
46
+ jsonTooLong: "The JSON report is too long for this issue: it is in the run's artifact `ci-usage-report`.",
47
+ issueIntro: "This issue is kept up to date by the ci-usage workflow (@softure-ai/ci-usage): its body is always the latest report, and every run adds a comment with its totals.",
48
+ /** The comment one run adds; `{url}` is the run. */
49
+ comment: "{from} to {to} UTC: {minutes} minutes, {usd} USD estimated, {runs} runs. [Run]({url})",
50
+ };
51
+ //# sourceMappingURL=en.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"en.js","sourceRoot":"","sources":["../../src/messages/en.ts"],"names":[],"mappings":"AAAA,+GAA+G;AAC/G,MAAM,CAAC,MAAM,EAAE,GAAG;IAChB,KAAK,EAAE,iBAAiB;IACxB,4EAA4E;IAC5E,MAAM,EAAE,sEAAsE;IAC9E,QAAQ,EAAE,mBAAmB;IAC7B,OAAO,EAAE,gFAAgF;IACzF,SAAS,EACP,wOAAwO;IAC1O,aAAa,EAAE,QAAQ;IACvB,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,GAAG,EAAE,UAAU;IACf,YAAY,EAAE,eAAe;IAC7B,QAAQ,EAAE,UAAU;IACpB,UAAU,EAAE,aAAa;IACzB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,gBAAgB,EAAE,WAAW;IAC7B,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,cAAc,EAAE,gCAAgC;IAChD,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,SAAS;IACd,GAAG,EAAE,SAAS;IACd,cAAc,EAAE,qBAAqB;IACrC,4CAA4C;IAC5C,WAAW,EAAE,yDAAyD;IACtE,cAAc,EAAE,kBAAkB;IAClC,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,WAAW;IAClB,GAAG,EAAE,SAAS;IACd,YAAY,EAAE,OAAO;IACrB,sEAAsE;IACtE,OAAO,EAAE,mDAAmD;IAC5D,SAAS,EAAE,iEAAiE;IAC5E,YAAY,EAAE,gGAAgG;IAC9G,KAAK,EAAE,mBAAmB;IAC1B,MAAM,EAAE,iCAAiC;IACzC,OAAO,EAAE,SAAS;IAClB,gGAAgG;IAChG,MAAM,EAAE,kDAAkD;IAC1D,OAAO,EAAE,8BAA8B;IACvC,WAAW,EAAE,oBAAoB;IACjC,WAAW,EAAE,4FAA4F;IACzG,UAAU,EACR,oKAAoK;IACtK,oDAAoD;IACpD,OAAO,EAAE,uFAAuF;CACxF,CAAC"}
@@ -0,0 +1,11 @@
1
+ import { en } from "./en.js";
2
+ export type CiUsageMessages = {
3
+ [Key in keyof typeof en]: string;
4
+ };
5
+ /** The copy of the report; an app passes its own object of the same shape to change the wording. */
6
+ export declare const ciUsageMessages: {
7
+ en: CiUsageMessages;
8
+ };
9
+ /** Replaces every `{name}` in `template` with its value; an unknown placeholder is a bug, so it throws. */
10
+ export declare function formatMessage(template: string, values: Record<string, string | number>): string;
11
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/messages/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAE7B,MAAM,MAAM,eAAe,GAAG;KAAG,GAAG,IAAI,MAAM,OAAO,EAAE,GAAG,MAAM;CAAE,CAAC;AAEnE,oGAAoG;AACpG,eAAO,MAAM,eAAe,EAAE;IAAE,EAAE,EAAE,eAAe,CAAA;CAAW,CAAC;AAE/D,2GAA2G;AAC3G,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,MAAM,CAM/F"}
@@ -0,0 +1,13 @@
1
+ import { en } from "./en.js";
2
+ /** The copy of the report; an app passes its own object of the same shape to change the wording. */
3
+ export const ciUsageMessages = { en };
4
+ /** Replaces every `{name}` in `template` with its value; an unknown placeholder is a bug, so it throws. */
5
+ export function formatMessage(template, values) {
6
+ return template.replace(/\{([a-zA-Z]+)\}/g, (placeholder, name) => {
7
+ const value = values[name];
8
+ if (value === undefined)
9
+ throw new Error(`formatMessage: no value for ${placeholder} in "${template}".`);
10
+ return String(value);
11
+ });
12
+ }
13
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/messages/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAI7B,oGAAoG;AACpG,MAAM,CAAC,MAAM,eAAe,GAA4B,EAAE,EAAE,EAAE,CAAC;AAE/D,2GAA2G;AAC3G,MAAM,UAAU,aAAa,CAAC,QAAgB,EAAE,MAAuC;IACrF,OAAO,QAAQ,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,WAAW,EAAE,IAAY,EAAE,EAAE;QACxE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,WAAW,QAAQ,QAAQ,IAAI,CAAC,CAAC;QACzG,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC"}