@stats-forge/github-stats-forge-core 0.0.1

package/build/common/config.d.ts

@@ -0,0 +1,53 @@
+import type { FetchLike } from './http.js';
+type Env = Record<string, string | undefined>;
+interface PersonalAccessToken {
+    /** Env variable the token came from — the retryer logs this name, never the value. */
+    name: string;
+    value: string;
+}
+/** Overrides for a {@link CardConfig}; the constructor defaults anything omitted. */
+interface CardConfigInit {
+    pats?: ReadonlyArray<PersonalAccessToken>;
+    usernameAllowlist?: ReadonlyArray<string> | undefined;
+    gistAllowlist?: ReadonlyArray<string> | undefined;
+    excludeRepositories?: ReadonlyArray<string>;
+    fetchMultiPageStars?: number;
+    fetch?: FetchLike;
+}
+/**
+ * Deployment-wide configuration for the card renderers.
+ *
+ * Immutable, and built by the host rather than read from the environment, so the
+ * library behaves identically under Node, in the browser and under vitest.
+ */
+export declare class CardConfig {
+    readonly pats: ReadonlyArray<PersonalAccessToken>;
+    /** Allowed usernames; `undefined` means no allowlist configured. */
+    readonly usernameAllowlist: ReadonlyArray<string> | undefined;
+    /** Allowed gist ids; `undefined` means no allowlist configured. */
+    readonly gistAllowlist: ReadonlyArray<string> | undefined;
+    readonly excludeRepositories: ReadonlyArray<string>;
+    /** Max pages of starred repos; `Infinity` means every page, `1` only the first. */
+    readonly fetchMultiPageStars: number;
+    /** Transport every fetcher sends through; defaults to `globalThis.fetch`. */
+    readonly fetch: FetchLike;
+    constructor(init?: CardConfigInit);
+    /**
+     * @param env Environment variables to read — the host passes `process.env` or an equivalent.
+     * @returns Config for this deployment.
+     */
+    static fromEnv(env: Env): CardConfig;
+    /**
+     * @param id Username or gist id being requested.
+     * @param kind Which allowlist applies.
+     * @returns Whether this deployment serves the id.
+     */
+    isAllowed(id: string, kind: 'username' | 'gist'): boolean;
+    /**
+     * @param overrides Fields to replace.
+     * @returns A copy with `overrides` applied — how a host swaps in a user's PAT per request.
+     */
+    with(overrides: CardConfigInit): CardConfig;
+}
+export type { PersonalAccessToken, CardConfigInit };
+//# sourceMappingURL=config.d.ts.map

package/build/common/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/common/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,KAAK,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;AAE9C,UAAU,mBAAmB;IAC3B,sFAAsF;IACtF,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,qFAAqF;AACrF,UAAU,cAAc;IACtB,IAAI,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAC1C,iBAAiB,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACtD,aAAa,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAClD,mBAAmB,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC5C,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AA8BD;;;;;GAKG;AACH,qBAAa,UAAU;IACrB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAClD,oEAAoE;IACpE,QAAQ,CAAC,iBAAiB,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC9D,mEAAmE;IACnE,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC1D,QAAQ,CAAC,mBAAmB,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACpD,mFAAmF;IACnF,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,6EAA6E;IAC7E,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;gBAEd,IAAI,GAAE,cAAmB;IASrC;;;OAGG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU;IAUpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IAKzD;;;OAGG;IACH,IAAI,CAAC,SAAS,EAAE,cAAc,GAAG,UAAU;CAW5C;AAED,YAAY,EAAE,mBAAmB,EAAE,cAAc,EAAE,CAAC"}

package/build/common/config.js

@@ -0,0 +1,87 @@
+import { defaultFetch } from './http.js';
+/**
+ * @param value Comma-separated string.
+ * @returns Parsed string values.
+ */
+const parseCsv = (value) => value ? value.split(',') : undefined;
+/**
+ * @param value Raw `FETCH_MULTI_PAGE_STARS` value.
+ * @returns Page limit: `"true"` means every page, a positive number caps the pages, anything else means one.
+ */
+const parseFetchMultiPageStars = (value) => {
+    if (value === 'true') {
+        return Infinity;
+    }
+    const limit = Number(value);
+    return limit > 0 ? limit : 1;
+};
+/**
+ * @param env Environment variables to inspect.
+ * @returns Personal access tokens found in the environment.
+ */
+const parsePATsFromEnv = (env) => Object.keys(env)
+    .filter((key) => /PAT_\d*$/.exec(key))
+    .map((name) => ({ name, value: env[name] ?? '' }));
+/**
+ * Deployment-wide configuration for the card renderers.
+ *
+ * Immutable, and built by the host rather than read from the environment, so the
+ * library behaves identically under Node, in the browser and under vitest.
+ */
+export class CardConfig {
+    pats;
+    /** Allowed usernames; `undefined` means no allowlist configured. */
+    usernameAllowlist;
+    /** Allowed gist ids; `undefined` means no allowlist configured. */
+    gistAllowlist;
+    excludeRepositories;
+    /** Max pages of starred repos; `Infinity` means every page, `1` only the first. */
+    fetchMultiPageStars;
+    /** Transport every fetcher sends through; defaults to `globalThis.fetch`. */
+    fetch;
+    constructor(init = {}) {
+        this.pats = init.pats ?? [];
+        this.usernameAllowlist = init.usernameAllowlist;
+        this.gistAllowlist = init.gistAllowlist;
+        this.excludeRepositories = init.excludeRepositories ?? [];
+        this.fetchMultiPageStars = init.fetchMultiPageStars ?? 1;
+        this.fetch = init.fetch ?? defaultFetch;
+    }
+    /**
+     * @param env Environment variables to read — the host passes `process.env` or an equivalent.
+     * @returns Config for this deployment.
+     */
+    static fromEnv(env) {
+        return new CardConfig({
+            pats: parsePATsFromEnv(env),
+            usernameAllowlist: parseCsv(env['WHITELIST']),
+            gistAllowlist: parseCsv(env['GIST_WHITELIST']),
+            excludeRepositories: parseCsv(env['EXCLUDE_REPO']) ?? [],
+            fetchMultiPageStars: parseFetchMultiPageStars(env['FETCH_MULTI_PAGE_STARS']),
+        });
+    }
+    /**
+     * @param id Username or gist id being requested.
+     * @param kind Which allowlist applies.
+     * @returns Whether this deployment serves the id.
+     */
+    isAllowed(id, kind) {
+        const list = kind === 'gist' ? this.gistAllowlist : this.usernameAllowlist;
+        return list === undefined || list.includes(id);
+    }
+    /**
+     * @param overrides Fields to replace.
+     * @returns A copy with `overrides` applied — how a host swaps in a user's PAT per request.
+     */
+    with(overrides) {
+        return new CardConfig({
+            pats: this.pats,
+            usernameAllowlist: this.usernameAllowlist,
+            gistAllowlist: this.gistAllowlist,
+            excludeRepositories: this.excludeRepositories,
+            fetchMultiPageStars: this.fetchMultiPageStars,
+            fetch: this.fetch,
+            ...overrides,
+        });
+    }
+}

package/build/common/constants.d.ts

@@ -0,0 +1,7 @@
+import type { RepositoryAffiliation } from '../graphql/generated/common.js';
+/**
+ * Valid owner affiliations for GitHub API queries.
+ */
+declare const OWNER_AFFILIATIONS: Array<RepositoryAffiliation>;
+export { OWNER_AFFILIATIONS };
+//# sourceMappingURL=constants.d.ts.map

package/build/common/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/common/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AAE5E;;GAEG;AACH,QAAA,MAAM,kBAAkB,EAAE,KAAK,CAAC,qBAAqB,CAIpD,CAAC;AAEF,OAAO,EAAE,kBAAkB,EAAE,CAAC"}

package/build/common/constants.js

@@ -0,0 +1,9 @@
+/**
+ * Valid owner affiliations for GitHub API queries.
+ */
+const OWNER_AFFILIATIONS = [
+    'OWNER',
+    'COLLABORATOR',
+    'ORGANIZATION_MEMBER',
+];
+export { OWNER_AFFILIATIONS };

package/build/common/date.d.ts

@@ -0,0 +1,29 @@
+/** A span between two dates, as GitHub's range arguments take it. */
+interface GitHubDateRange {
+    /** Start of the range, inclusive. */
+    from: Date;
+    /** End of the range, inclusive. */
+    to: Date;
+}
+/**
+ * Format a date as a GitHub `DateTime` scalar.
+ * Seconds precision, no milliseconds.
+ *
+ * @param date Date to format.
+ * @returns e.g. `2024-01-01T00:00:00Z`.
+ */
+declare const toGitHubDateTime: (date: Date) => string;
+/**
+ * The full UTC span of a calendar year, both ends inclusive.
+ *
+ * The end matters to callers that would otherwise leave a range open:
+ * GitHub's `contributionsCollection` defaults `to` to one year after `from`,
+ * which pulls the next 1st of January into the year.
+ *
+ * @param year Four-digit year.
+ * @returns The range covering it.
+ */
+declare const getGitHubYearRange: (year: number) => GitHubDateRange;
+export { getGitHubYearRange, toGitHubDateTime };
+export type { GitHubDateRange };
+//# sourceMappingURL=date.d.ts.map

package/build/common/date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/common/date.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,UAAU,eAAe;IACvB,qCAAqC;IACrC,IAAI,EAAE,IAAI,CAAC;IACX,mCAAmC;IACnC,EAAE,EAAE,IAAI,CAAC;CACV;AAED;;;;;;GAMG;AACH,QAAA,MAAM,gBAAgB,GAAI,MAAM,IAAI,KAAG,MAA+C,CAAC;AAEvF;;;;;;;;;GASG;AACH,QAAA,MAAM,kBAAkB,GAAI,MAAM,MAAM,KAAG,eAGzC,CAAC;AAEH,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,CAAC;AAChD,YAAY,EAAE,eAAe,EAAE,CAAC"}

package/build/common/date.js

@@ -0,0 +1,23 @@
+/**
+ * Format a date as a GitHub `DateTime` scalar.
+ * Seconds precision, no milliseconds.
+ *
+ * @param date Date to format.
+ * @returns e.g. `2024-01-01T00:00:00Z`.
+ */
+const toGitHubDateTime = (date) => `${date.toISOString().slice(0, 19)}Z`;
+/**
+ * The full UTC span of a calendar year, both ends inclusive.
+ *
+ * The end matters to callers that would otherwise leave a range open:
+ * GitHub's `contributionsCollection` defaults `to` to one year after `from`,
+ * which pulls the next 1st of January into the year.
+ *
+ * @param year Four-digit year.
+ * @returns The range covering it.
+ */
+const getGitHubYearRange = (year) => ({
+    from: new Date(Date.UTC(year, 0, 1)),
+    to: new Date(Date.UTC(year, 11, 31, 23, 59, 59)),
+});
+export { getGitHubYearRange, toGitHubDateTime };

package/build/common/error.d.ts

@@ -0,0 +1,87 @@
+/**
+ * @file One error type for everything a card render can fail on.
+ *
+ * A failure carries a `code` a host can branch on, the two lines the error card
+ * draws, and — through the code — whether repeating the request could help.
+ * The fetchers throw this rather than a bare `Error`, so a host is told what failed.
+ * Anything else that escapes is wrapped as `upstream` by `from`, which is retryable —
+ * so a permanent failure has to throw a `CardError` to be reported as one.
+ */
+/** A general message to ask user to try again later. */
+declare const TRY_AGAIN_LATER = "Please try again later";
+/** Why a request failed. */
+type ErrorCode = 
+/** The query is wrong: a param is malformed, unsafe, or not renderable. */
+'invalid_param'
+/** The query is missing a param the endpoint cannot render without. */
+ | 'missing_param'
+/** The user, repository or gist does not exist. */
+ | 'not_found'
+/** The deployment has no usable GitHub token. */
+ | 'no_tokens'
+/** Every token is rate limited. */
+ | 'rate_limited'
+/** GitHub or WakaTime answered with something unusable. */
+ | 'upstream';
+/** The second line the error card draws, per code. */
+declare const SECONDARY_ERROR_MESSAGES: Partial<Record<ErrorCode, string>>;
+/** What a failure is, once it reaches the api layer. */
+interface CardErrorInit {
+    /** Why it failed. */
+    code: ErrorCode;
+    /** Second line of the error card; the code's own message when omitted. */
+    secondaryMessage?: string | undefined;
+    /** The first param at fault, when the failure names one. */
+    param?: string | undefined;
+}
+/** Everything this package throws. */
+declare class CardError extends Error {
+    readonly code: ErrorCode;
+    readonly secondaryMessage: string | undefined;
+    readonly param: string | undefined;
+    /**
+     * @param message First line of the error card.
+     * @param init Why it failed, and what to draw under the message.
+     */
+    constructor(message: string, init: CardErrorInit);
+    /** Whether repeating the request could produce a different answer. */
+    get retryable(): boolean;
+    /**
+     * A param the endpoint cannot render with.
+     *
+     * @param param Name of the param.
+     * @param secondaryMessage What is wrong with it.
+     * @returns The error.
+     */
+    static invalidParam(param: string, secondaryMessage: string): CardError;
+    /**
+     * A param the endpoint cannot render without.
+     *
+     * @param params Names of the missing params.
+     *        `param` carries the first; the message names them all.
+     * @param secondaryMessage Where to pass them, when the endpoint can say.
+     * @returns The error.
+     */
+    static missingParam(params: Array<string>, secondaryMessage?: string): CardError;
+    /**
+     * Anything thrown that is not already a `CardError`:
+     * an upstream failure, since the query itself got this far.
+     *
+     * @param err Whatever was thrown.
+     * @returns The error, unchanged when it already was one.
+     */
+    static from(err: unknown): CardError;
+}
+/** The affiliation values `role` accepts, named in the rejection. */
+declare const INVALID_AFFILIATION: string;
+/** The user exists but has no public WakaTime profile. */
+declare const WAKATIME_USER_NOT_FOUND = "Make sure you have a public WakaTime profile";
+/** A GitHub username that resolves to nothing, or to an organization. */
+declare const USER_NOT_FOUND = "Make sure the provided username is not an organization";
+/** A repository the token cannot see, because it is missing or private. */
+declare const REPO_NOT_FOUND = "Make sure the provided username and repository are correct";
+/** A gist id that resolves to nothing. */
+declare const GIST_NOT_FOUND = "Make sure the provided gist ID is correct";
+export type { ErrorCode };
+export { CardError, GIST_NOT_FOUND, INVALID_AFFILIATION, REPO_NOT_FOUND, SECONDARY_ERROR_MESSAGES, TRY_AGAIN_LATER, USER_NOT_FOUND, WAKATIME_USER_NOT_FOUND, };
+//# sourceMappingURL=error.d.ts.map

package/build/common/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/common/error.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AAEH,wDAAwD;AACxD,QAAA,MAAM,eAAe,2BAA2B,CAAC;AAEjD,4BAA4B;AAC5B,KAAK,SAAS;AACZ,2EAA2E;AACzE,eAAe;AACjB,uEAAuE;GACrE,eAAe;AACjB,mDAAmD;GACjD,WAAW;AACb,iDAAiD;GAC/C,WAAW;AACb,mCAAmC;GACjC,cAAc;AAChB,2DAA2D;GACzD,UAAU,CAAC;AAef,sDAAsD;AACtD,QAAA,MAAM,wBAAwB,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAKhE,CAAC;AAEF,wDAAwD;AACxD,UAAU,aAAa;IACrB,qBAAqB;IACrB,IAAI,EAAE,SAAS,CAAC;IAChB,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,4DAA4D;IAC5D,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,sCAAsC;AACtC,cAAM,SAAU,SAAQ,KAAK;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;;OAGG;gBACS,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa;IAQhD,sEAAsE;IACtE,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;;;;;OAMG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,SAAS;IAQvE;;;;;;;OAOG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS;IAShF;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS;CASrC;AAED,qEAAqE;AACrE,QAAA,MAAM,mBAAmB,QAEtB,CAAC;AAEJ,0DAA0D;AAC1D,QAAA,MAAM,uBAAuB,iDAAiD,CAAC;AAE/E,yEAAyE;AACzE,QAAA,MAAM,cAAc,2DAA2D,CAAC;AAEhF,2EAA2E;AAC3E,QAAA,MAAM,cAAc,+DAA+D,CAAC;AAEpF,0CAA0C;AAC1C,QAAA,MAAM,cAAc,8CAA8C,CAAC;AAEnE,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B,OAAO,EACL,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,wBAAwB,EACxB,eAAe,EACf,cAAc,EACd,uBAAuB,GACxB,CAAC"}

package/build/common/error.js

@@ -0,0 +1,108 @@
+import { OWNER_AFFILIATIONS } from './constants.js';
+/**
+ * @file One error type for everything a card render can fail on.
+ *
+ * A failure carries a `code` a host can branch on, the two lines the error card
+ * draws, and — through the code — whether repeating the request could help.
+ * The fetchers throw this rather than a bare `Error`, so a host is told what failed.
+ * Anything else that escapes is wrapped as `upstream` by `from`, which is retryable —
+ * so a permanent failure has to throw a `CardError` to be reported as one.
+ */
+/** A general message to ask user to try again later. */
+const TRY_AGAIN_LATER = 'Please try again later';
+/**
+ * Whether repeating the request could produce a different answer.
+ * A host reads this to decide between caching the failure and retrying it.
+ */
+const RETRYABLE = {
+    invalid_param: false,
+    missing_param: false,
+    not_found: false,
+    no_tokens: false,
+    rate_limited: true,
+    upstream: true,
+};
+/** The second line the error card draws, per code. */
+const SECONDARY_ERROR_MESSAGES = {
+    rate_limited: 'You can deploy own instance or wait until public will be no longer limited',
+    no_tokens: 'Please add an env variable called PAT_1 with your GitHub API token in your deployment environment',
+    upstream: TRY_AGAIN_LATER,
+};
+/** Everything this package throws. */
+class CardError extends Error {
+    code;
+    secondaryMessage;
+    param;
+    /**
+     * @param message First line of the error card.
+     * @param init Why it failed, and what to draw under the message.
+     */
+    constructor(message, init) {
+        super(message);
+        this.name = 'CardError';
+        this.code = init.code;
+        this.param = init.param;
+        this.secondaryMessage = init.secondaryMessage ?? SECONDARY_ERROR_MESSAGES[init.code];
+    }
+    /** Whether repeating the request could produce a different answer. */
+    get retryable() {
+        return RETRYABLE[this.code];
+    }
+    /**
+     * A param the endpoint cannot render with.
+     *
+     * @param param Name of the param.
+     * @param secondaryMessage What is wrong with it.
+     * @returns The error.
+     */
+    static invalidParam(param, secondaryMessage) {
+        return new CardError('Something went wrong', {
+            code: 'invalid_param',
+            secondaryMessage,
+            param,
+        });
+    }
+    /**
+     * A param the endpoint cannot render without.
+     *
+     * @param params Names of the missing params.
+     *        `param` carries the first; the message names them all.
+     * @param secondaryMessage Where to pass them, when the endpoint can say.
+     * @returns The error.
+     */
+    static missingParam(params, secondaryMessage) {
+        const named = params.map((param) => `"${param}"`).join(', ');
+        return new CardError(`Missing params ${named} make sure you pass the parameters in URL`, {
+            code: 'missing_param',
+            secondaryMessage,
+            param: params[0],
+        });
+    }
+    /**
+     * Anything thrown that is not already a `CardError`:
+     * an upstream failure, since the query itself got this far.
+     *
+     * @param err Whatever was thrown.
+     * @returns The error, unchanged when it already was one.
+     */
+    static from(err) {
+        if (err instanceof CardError) {
+            return err;
+        }
+        if (err instanceof Error) {
+            return new CardError(err.message, { code: 'upstream' });
+        }
+        return new CardError('An unknown error occurred', { code: 'upstream' });
+    }
+}
+/** The affiliation values `role` accepts, named in the rejection. */
+const INVALID_AFFILIATION = `Invalid owner affiliations. Valid values are: ${OWNER_AFFILIATIONS.join(', ')}`;
+/** The user exists but has no public WakaTime profile. */
+const WAKATIME_USER_NOT_FOUND = 'Make sure you have a public WakaTime profile';
+/** A GitHub username that resolves to nothing, or to an organization. */
+const USER_NOT_FOUND = 'Make sure the provided username is not an organization';
+/** A repository the token cannot see, because it is missing or private. */
+const REPO_NOT_FOUND = 'Make sure the provided username and repository are correct';
+/** A gist id that resolves to nothing. */
+const GIST_NOT_FOUND = 'Make sure the provided gist ID is correct';
+export { CardError, GIST_NOT_FOUND, INVALID_AFFILIATION, REPO_NOT_FOUND, SECONDARY_ERROR_MESSAGES, TRY_AGAIN_LATER, USER_NOT_FOUND, WAKATIME_USER_NOT_FOUND, };

package/build/common/fmt.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Retrieves num with suffix k(thousands) precise to given decimal places.
+ *
+ * @param num The number to format.
+ * @param precision The number of decimal places to include.
+ * @returns The formatted number.
+ */
+declare const kFormatter: (num: number, precision?: number) => string | number;
+/**
+ * Convert bytes to a human-readable string representation.
+ *
+ * @param bytes The number of bytes to convert.
+ * @returns The human-readable representation of bytes.
+ * @throws {Error} If bytes is negative or too large.
+ */
+declare const formatBytes: (bytes: number) => string;
+/**
+ * Split text over multiple lines based on the card width.
+ *
+ * @param text Text to split.
+ * @param width Available wrap width in px.
+ * @param fontSize Font size in px.
+ * @param maxLines Maximum number of lines.
+ * @returns Array of lines.
+ */
+declare const wrapTextMultiline: (text: string, width: number, fontSize: number, maxLines?: number) => Array<string>;
+export { kFormatter, formatBytes, wrapTextMultiline };
+//# sourceMappingURL=fmt.d.ts.map

package/build/common/fmt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fmt.d.ts","sourceRoot":"","sources":["../../src/common/fmt.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,QAAA,MAAM,UAAU,GAAI,KAAK,MAAM,EAAE,YAAY,MAAM,KAAG,MAAM,GAAG,MAa9D,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,MAmBpC,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,iBAAiB,GACrB,MAAM,MAAM,EACZ,OAAO,MAAM,EACb,UAAU,MAAM,EAChB,iBAAY,KACX,KAAK,CAAC,MAAM,CAgBd,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC"}

package/build/common/fmt.js

@@ -0,0 +1,68 @@
+import { encodeHTML } from './html.js';
+import { splitWrappedText } from './render.js';
+/**
+ * Retrieves num with suffix k(thousands) precise to given decimal places.
+ *
+ * @param num The number to format.
+ * @param precision The number of decimal places to include.
+ * @returns The formatted number.
+ */
+const kFormatter = (num, precision) => {
+    const abs = Math.abs(num);
+    const sign = Math.sign(num);
+    if (typeof precision === 'number' && !isNaN(precision)) {
+        return (sign * (abs / 1000)).toFixed(precision) + 'k';
+    }
+    if (abs < 1000) {
+        return sign * abs;
+    }
+    return `${sign * parseFloat((abs / 1000).toFixed(1))}k`;
+};
+/**
+ * Convert bytes to a human-readable string representation.
+ *
+ * @param bytes The number of bytes to convert.
+ * @returns The human-readable representation of bytes.
+ * @throws {Error} If bytes is negative or too large.
+ */
+const formatBytes = (bytes) => {
+    if (bytes < 0) {
+        throw new Error('Bytes must be a non-negative number');
+    }
+    if (bytes === 0) {
+        return '0 B';
+    }
+    const sizes = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB'];
+    const base = 1024;
+    const i = Math.floor(Math.log(bytes) / Math.log(base));
+    const unit = sizes[i];
+    if (unit === undefined) {
+        throw new Error('Bytes is too large to convert to a human-readable string');
+    }
+    return `${(bytes / Math.pow(base, i)).toFixed(1)} ${unit}`;
+};
+/**
+ * Split text over multiple lines based on the card width.
+ *
+ * @param text Text to split.
+ * @param width Available wrap width in px.
+ * @param fontSize Font size in px.
+ * @param maxLines Maximum number of lines.
+ * @returns Array of lines.
+ */
+const wrapTextMultiline = (text, width, fontSize, maxLines = 3) => {
+    const wrapped = splitWrappedText(text, fontSize, width);
+    const lines = wrapped.map((line) => encodeHTML(line.trim())).slice(0, maxLines); // Only consider maxLines lines
+    // Add "..." to the last line if the text exceeds maxLines
+    if (wrapped.length > maxLines) {
+        const lastIndex = maxLines - 1;
+        const lastLine = lines[lastIndex];
+        if (lastLine !== undefined) {
+            lines[lastIndex] = `${lastLine}...`;
+        }
+    }
+    // Remove empty lines if text fits in less than maxLines lines
+    const multiLineText = lines.filter(Boolean);
+    return multiLineText;
+};
+export { kFormatter, formatBytes, wrapTextMultiline };

package/build/common/html.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Encode string as HTML.
+ *
+ * @see https://stackoverflow.com/a/48073476/10629172
+ */
+declare const encodeHTML: (str: string) => string;
+export { encodeHTML };
+//# sourceMappingURL=html.d.ts.map

package/build/common/html.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.d.ts","sourceRoot":"","sources":["../../src/common/html.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,QAAA,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,MASjC,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/build/common/html.js

@@ -0,0 +1,14 @@
+/**
+ * Encode string as HTML.
+ *
+ * @see https://stackoverflow.com/a/48073476/10629172
+ */
+const encodeHTML = (str) => {
+    return (str
+        .replace(/[\u00A0-\u9999<>&"'](?!#)/gim, (i) => {
+        return `&#${i.charCodeAt(0)};`;
+    })
+        // eslint-disable-next-line no-control-regex
+        .replace(/\u0008/gim, ''));
+};
+export { encodeHTML };

package/build/common/http.d.ts

@@ -0,0 +1,53 @@
+import type { GraphQLDocument } from '../graphql/graphqlDocument.js';
+/**
+ * The slice of `fetch` this library calls.
+ * A host substitutes it through `CardConfig` to mock, cache or proxy every request core makes.
+ */
+type FetchLike = (input: string, init?: RequestInit) => Promise<Response>;
+/**
+ * Resolves the global `fetch` at call time rather than capturing it on import,
+ * so a host that patches the global afterwards is still picked up.
+ */
+declare const defaultFetch: FetchLike;
+/**
+ * A response, parsed.
+ * A non-2xx is a value here rather than a throw:
+ * the retryer reads the body of a rejected request to tell a spent token from a rate limit.
+ */
+interface HttpResponse<TData> {
+    status: number;
+    /** Reason phrase, which HTTP/2 omits — only ever used to annotate an error. */
+    statusText: string;
+    data: TData;
+}
+/** What the retryer hands a fetcher on each attempt. */
+interface FetcherContext {
+    /** Transport to send the request with. */
+    fetch: FetchLike;
+    /** Attempt index, from 0. Tests read it to fake a rate limit on the first token. */
+    retries: number;
+}
+/**
+ * @param fetchImpl Transport to send the request with.
+ * @param url Absolute URL to request.
+ * @param init Request init forwarded to the transport.
+ * @returns The response; a JSON body parsed, anything else left as text.
+ */
+declare const httpRequest: <TData>(fetchImpl: FetchLike, url: string, init?: RequestInit) => Promise<HttpResponse<TData>>;
+/** Response of a GraphQL call: the envelope the GitHub API wraps results in. */
+type GraphQLResponse<TResult> = HttpResponse<{
+    data: TResult;
+    errors?: Array<{
+        type?: string;
+        message?: string;
+    }>;
+}>;
+/**
+ * @param document Generated query document.
+ * @param scheme `Authorization` scheme for the token.
+ * @returns A fetcher `retryer` can drive.
+ */
+declare const createGraphQLFetcher: <TResult, TVariables>(document: GraphQLDocument<TResult, TVariables>, scheme: "bearer" | "token") => (variables: TVariables, token: string, { fetch }: FetcherContext) => Promise<GraphQLResponse<TResult>>;
+export { createGraphQLFetcher, defaultFetch, httpRequest };
+export type { FetcherContext, FetchLike, GraphQLResponse, HttpResponse };
+//# sourceMappingURL=http.d.ts.map

package/build/common/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/common/http.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAIrE;;;GAGG;AACH,KAAK,SAAS,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAE1E;;;GAGG;AACH,QAAA,MAAM,YAAY,EAAE,SAA+C,CAAC;AAEpE;;;;GAIG;AACH,UAAU,YAAY,CAAC,KAAK;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,+EAA+E;IAC/E,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,KAAK,CAAC;CACb;AAED,wDAAwD;AACxD,UAAU,cAAc;IACtB,0CAA0C;IAC1C,KAAK,EAAE,SAAS,CAAC;IACjB,oFAAoF;IACpF,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,QAAA,MAAM,WAAW,GAAU,KAAK,EAC9B,WAAW,SAAS,EACpB,KAAK,MAAM,EACX,OAAO,WAAW,KACjB,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAiB7B,CAAC;AAEF,gFAAgF;AAChF,KAAK,eAAe,CAAC,OAAO,IAAI,YAAY,CAAC;IAC3C,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrD,CAAC,CAAC;AAEH;;;;GAIG;AACH,QAAA,MAAM,oBAAoB,GAAI,OAAO,EAAE,UAAU,EAC/C,UAAU,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,EAC9C,QAAQ,QAAQ,GAAG,OAAO,MAGxB,WAAW,UAAU,EACrB,OAAO,MAAM,EACb,WAAW,cAAc,KACxB,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAUpC,CAAC;AAEF,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC;AAC3D,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,CAAC"}

package/build/common/http.js

@@ -0,0 +1,47 @@
+const GITHUB_GRAPHQL_API = 'https://api.github.com/graphql';
+/**
+ * Resolves the global `fetch` at call time rather than capturing it on import,
+ * so a host that patches the global afterwards is still picked up.
+ */
+const defaultFetch = (input, init) => fetch(input, init);
+/**
+ * @param fetchImpl Transport to send the request with.
+ * @param url Absolute URL to request.
+ * @param init Request init forwarded to the transport.
+ * @returns The response; a JSON body parsed, anything else left as text.
+ */
+const httpRequest = async (fetchImpl, url, init) => {
+    const response = await fetchImpl(url, init);
+    const body = await response.text();
+    let data;
+    try {
+        data = JSON.parse(body);
+    }
+    catch {
+        // an empty or non-JSON body reads as text, so callers still get a defined `data`
+        data = body;
+    }
+    return {
+        status: response.status,
+        statusText: response.statusText,
+        data: data,
+    };
+};
+/**
+ * @param document Generated query document.
+ * @param scheme `Authorization` scheme for the token.
+ * @returns A fetcher `retryer` can drive.
+ */
+const createGraphQLFetcher = (document, scheme) => {
+    return (variables, token, { fetch }) => {
+        return httpRequest(fetch, GITHUB_GRAPHQL_API, {
+            method: 'POST',
+            headers: {
+                Authorization: `${scheme} ${token}`,
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify({ query: document.text, variables }),
+        });
+    };
+};
+export { createGraphQLFetcher, defaultFetch, httpRequest };