versioncam 0.4.0 → 0.5.0

package/dist/cloud/credentials.js

@@ -0,0 +1,126 @@
+import { chmodSync, existsSync, mkdirSync, readFileSync, renameSync, rmSync, writeFileSync, } from "node:fs";
+import { homedir, userInfo } from "node:os";
+import { dirname, isAbsolute, join } from "node:path";
+/**
+ * `$XDG_CONFIG_HOME/versioncam/credentials.json`, else
+ * `~/.config/versioncam/credentials.json`. A relative `XDG_CONFIG_HOME` is
+ * ignored, as the XDG specification says it must be: it would put the token
+ * wherever the command happened to run.
+ */
+export function credentialsPath(env) {
+    const xdg = env.XDG_CONFIG_HOME;
+    const config = xdg && isAbsolute(xdg) ? xdg : join(env.HOME || accountHome(), ".config");
+    return join(config, "versioncam", "credentials.json");
+}
+/**
+ * The account's home directory, for an environment with no HOME. Not
+ * `homedir()`, which reads this process's HOME, and that one a repository's
+ * `.env` could have set when the shell did not.
+ */
+function accountHome() {
+    try {
+        return userInfo().homedir;
+    }
+    catch {
+        // No entry for this user, as in some containers.
+        return homedir();
+    }
+}
+/**
+ * The key a sign-in is kept under: the API's origin. Staging and production
+ * sit side by side, and `VERSIONCAM_API` chooses between them without
+ * signing out of the other.
+ */
+export function apiOrigin(api) {
+    return new URL(api).origin;
+}
+export function readCredential(env, api) {
+    return readAll(credentialsPath(env))[apiOrigin(api)] ?? null;
+}
+/** Keep a sign-in, replacing this API's last one. Returns the file's path. */
+export function saveCredential(env, api, credential) {
+    const path = credentialsPath(env);
+    const all = readAll(path);
+    all[apiOrigin(api)] = credential;
+    writeAll(path, all);
+    return path;
+}
+/** Forget this API's sign-in; the file goes when nothing is left in it. */
+export function removeCredential(env, api) {
+    const path = credentialsPath(env);
+    const all = readAll(path);
+    const origin = apiOrigin(api);
+    if (!(origin in all))
+        return false;
+    delete all[origin];
+    writeAll(path, all);
+    return true;
+}
+/**
+ * Every sign-in in the file. One that cannot be read counts as none: it
+ * could not sign anything in, and signing in again writes a good one over
+ * it rather than refusing until someone finds the file by hand.
+ */
+function readAll(path) {
+    if (!existsSync(path))
+        return {};
+    let parsed;
+    try {
+        parsed = JSON.parse(readFileSync(path, "utf8"));
+    }
+    catch {
+        return {};
+    }
+    if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
+        return {};
+    }
+    const all = {};
+    for (const [origin, value] of Object.entries(parsed)) {
+        // Only what this file writes, an origin a key: anything else, such as
+        // a `__proto__` key, is not a sign-in and must not become a property.
+        if (!isOrigin(origin))
+            continue;
+        const entry = value;
+        if (typeof entry?.token === "string" &&
+            typeof entry.login === "string" &&
+            typeof entry.expiresAt === "string") {
+            all[origin] = {
+                token: entry.token,
+                login: entry.login,
+                expiresAt: entry.expiresAt,
+            };
+        }
+    }
+    return all;
+}
+function isOrigin(key) {
+    try {
+        return new URL(key).origin === key;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Write the file whole, through a file beside it that is created 0600 and
+ * renamed over it: no moment exists at which the token is in a file anyone
+ * else may read, or in half a file. The modes are set again after creating,
+ * because a directory that was already there keeps the mode it had, and a
+ * file's creation mode is only what the umask lets through.
+ */
+function writeAll(path, all) {
+    const dir = dirname(path);
+    mkdirSync(dir, { recursive: true, mode: 0o700 });
+    chmodSync(dir, 0o700);
+    if (Object.keys(all).length === 0) {
+        rmSync(path, { force: true });
+        return;
+    }
+    const temporary = `${path}.${process.pid}.tmp`;
+    writeFileSync(temporary, `${JSON.stringify(all, null, 2)}\n`, {
+        mode: 0o600,
+    });
+    chmodSync(temporary, 0o600);
+    renameSync(temporary, path);
+}
+//# sourceMappingURL=credentials.js.map

package/dist/cloud/credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../src/cloud/credentials.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,UAAU,EACV,MAAM,EACN,aAAa,GACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAqBtD;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,GAAsB;IACpD,MAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC;IAChC,MAAM,MAAM,GACV,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC;IAC5E,OAAO,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,kBAAkB,CAAC,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW;IAClB,IAAI,CAAC;QACH,OAAO,QAAQ,EAAE,CAAC,OAAO,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,iDAAiD;QACjD,OAAO,OAAO,EAAE,CAAC;IACnB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,GAAsB,EACtB,GAAW;IAEX,OAAO,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC;AAC/D,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,cAAc,CAC5B,GAAsB,EACtB,GAAW,EACX,UAAsB;IAEtB,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACpB,OAAO,IAAI,CAAC;AACd,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,gBAAgB,CAAC,GAAsB,EAAE,GAAW;IAClE,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,CAAC,CAAC,MAAM,IAAI,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC;IACnB,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACpB,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,SAAS,OAAO,CAAC,IAAY;IAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnE,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,GAAG,GAA+B,EAAE,CAAC;IAC3C,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACrD,sEAAsE;QACtE,sEAAsE;QACtE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,SAAS;QAChC,MAAM,KAAK,GAAG,KAAmC,CAAC;QAClD,IACE,OAAO,KAAK,EAAE,KAAK,KAAK,QAAQ;YAChC,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;YAC/B,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,EACnC,CAAC;YACD,GAAG,CAAC,MAAM,CAAC,GAAG;gBACZ,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,SAAS,EAAE,KAAK,CAAC,SAAS;aAC3B,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,QAAQ,CAAC,GAAW;IAC3B,IAAI,CAAC;QACH,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,GAAG,CAAC;IACrC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,QAAQ,CAAC,IAAY,EAAE,GAA+B;IAC7D,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACjD,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtB,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9B,OAAO;IACT,CAAC;IACD,MAAM,SAAS,GAAG,GAAG,IAAI,IAAI,OAAO,CAAC,GAAG,MAAM,CAAC;IAC/C,aAAa,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QAC5D,IAAI,EAAE,KAAK;KACZ,CAAC,CAAC;IACH,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAC5B,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC"}

package/dist/cloud/protocol.d.ts

@@ -0,0 +1,220 @@
+/**
+ * The management API's wire, as the command line reads it: what `versioncam
+ * cloud` sends to version.cam's api host, and what comes back.
+ *
+ * Written from the contract the service and the command line were built
+ * against at the same time, and kept free of Node like
+ * `../publish/protocol.ts`, so that the service can one day import it as it
+ * imports that one, and a field added on one side becomes a type error on the
+ * other.
+ *
+ * Every route is JSON in and out, on the api host, and reads no cookie. A
+ * route that needs a person takes `Authorization: Bearer vcu_…`, the token
+ * `versioncam cloud login` was given.
+ */
+/** Who can see a project's clips: the dashboard's three words. */
+export type Visibility = "public" | "unlisted" | "private";
+/**
+ * Every refusal: a code for the command line to act on, and a sentence for
+ * the person. A few carry one more field: `plan` the upgrade page's address,
+ * `rate_limited` how many seconds to wait.
+ */
+export type CloudErrorBody = {
+    error: string;
+    message: string;
+    upgrade?: string;
+    retry_after?: number;
+};
+/** `POST /v1/cli/device`: the start of a sign-in, in RFC 8628's shape. */
+export type DeviceAuthorization = {
+    device_code: string;
+    user_code: string;
+    verification_uri: string;
+    verification_uri_complete: string;
+    expires_in: number;
+    interval: number;
+};
+/** `POST /v1/cli/token`, once the person approved: the token, shown once. */
+export type DeviceToken = {
+    token: string;
+    login: string;
+    expires_at: string;
+};
+/**
+ * The four answers a token request gives before it gives a token, each a 400
+ * with `error` set to it. The first two say to keep asking; the last two end
+ * the sign-in.
+ */
+export type DevicePending = "authorization_pending" | "slow_down" | "expired_token" | "access_denied";
+/** `GET /v1/me`: who the token is, and every project they may see. */
+export type Me = {
+    login: string;
+    accounts: {
+        login: string;
+        /** Null when the dashboard would not show this person the account's plan. */
+        plan: {
+            name: string;
+            title: string;
+        } | null;
+        projects: {
+            project: string;
+            visibility: Visibility;
+            clips: number;
+            broken: number;
+        }[];
+    }[];
+};
+/** What plays at a clip's living address: the newest version that passed. */
+export type Plays = {
+    version: string;
+    commit: string;
+    recordedAt: string;
+};
+/** Who said "I know, keep the old one", and when. */
+export type Acknowledgment = {
+    by: string;
+    at: string;
+};
+/** One clip in a project's status. */
+export type ClipStatus = {
+    clip: string;
+    title: string;
+    status: "current" | "broken";
+    brokenSince: string | null;
+    acknowledged: Acknowledgment | null;
+    plays: Plays | null;
+    checkedAt: string | null;
+    /** The living address; signed for an hour on a private project. */
+    url: string;
+};
+/** `GET /v1/projects/:owner/:repo`. */
+export type ProjectStatus = {
+    project: string;
+    /** The project's page on the dashboard. */
+    manage: string;
+    visibility: Visibility;
+    /** "Tell viewers when a clip is broken". */
+    showBroken: boolean;
+    permission: "admin" | "read";
+    plan: {
+        name: string;
+        title: string;
+        alerts: boolean;
+    };
+    /** Who is told when a clip breaks: for someone who may change the project, else null. */
+    alerts: {
+        email: string | null;
+        emailConfirmed: boolean;
+        slack: boolean;
+        issues: boolean;
+    } | null;
+    /** This month's. */
+    usage: {
+        publishes: number;
+        renderSeconds: number;
+        storageBytes: number;
+    };
+    clips: ClipStatus[];
+};
+/** Where a clip's check stopped, the last time it failed on the default branch. */
+export type ClipFailure = {
+    since: string;
+    commit: string;
+    step: {
+        index: number;
+        call: string;
+    } | null;
+    message: string;
+    /** The page when the run gave up; signed for an hour on a private project. */
+    picture: string | null;
+};
+/** `GET /v1/projects/:owner/:repo/clips/:clip`. */
+export type ClipDetail = {
+    clip: string;
+    title: string;
+    status: "current" | "broken";
+    /** The living address; signed for an hour on a private project. */
+    url: string;
+    /**
+     * What the clip's page offers to paste, or null while nothing of the clip
+     * has passed on the default branch, when there is nothing to embed.
+     * `video` is null when the version has no MP4.
+     */
+    embed: {
+        script: string;
+        iframe: string;
+        video: string | null;
+        markdown: string;
+    } | null;
+    /** Signed for an hour on a private project, the GIF's too; null as `embed` is. */
+    files: {
+        mp4: string | null;
+        webm: string | null;
+        poster: string | null;
+        sheet: string | null;
+        gif: string | null;
+    } | null;
+    failure: ClipFailure | null;
+};
+/** `GET /v1/accounts/:login/plan`. */
+export type AccountPlan = {
+    account: string;
+    plan: {
+        name: string;
+        title: string;
+        source: "free" | "beta" | "subscription" | "override";
+        until: string | null;
+        quantity: number | null;
+    };
+    upgrade: string;
+    /** The billing page, for someone who may bill the account; else null. */
+    billing: string | null;
+};
+/** `POST …/clips/:clip/ack`. */
+export type Acknowledged = {
+    acknowledged: Acknowledgment;
+};
+/**
+ * A change to one setting, exactly one of these fields. Each is what the
+ * dashboard's settings form takes for the same setting; `retentionDays: null`
+ * keeps every version the plan allows, as the form's empty field does.
+ */
+export type ChangeRequest = {
+    visibility: Visibility;
+} | {
+    retentionDays: number | null;
+} | {
+    showBroken: boolean;
+} | {
+    alertEmail: string | null;
+} | {
+    slackWebhook: string | null;
+} | {
+    staleIssues: boolean;
+};
+/** `POST …/changes`: the change waits for the person to approve it. */
+export type ChangePending = {
+    change: string;
+    user_code: string;
+    verification_uri: string;
+    verification_uri_complete: string;
+    expires_in: number;
+    /** The change in a sentence, as the approval page shows it. */
+    describe: string;
+};
+/** `GET …/changes/:change`. */
+export type ChangeState = {
+    state: "pending" | "applied" | "denied" | "expired";
+};
+/** Paths, relative to the API's origin. Names are escaped: a clip id may hold a dot. */
+export declare const CLOUD_PATHS: {
+    readonly device: "/v1/cli/device";
+    readonly token: "/v1/cli/token";
+    readonly me: "/v1/me";
+    readonly project: (project: string) => string;
+    readonly clip: (project: string, clip: string) => string;
+    readonly ack: (project: string, clip: string) => string;
+    readonly changes: (project: string) => string;
+    readonly change: (project: string, change: string) => string;
+    readonly plan: (account: string) => string;
+};

package/dist/cloud/protocol.js

@@ -0,0 +1,32 @@
+/**
+ * The management API's wire, as the command line reads it: what `versioncam
+ * cloud` sends to version.cam's api host, and what comes back.
+ *
+ * Written from the contract the service and the command line were built
+ * against at the same time, and kept free of Node like
+ * `../publish/protocol.ts`, so that the service can one day import it as it
+ * imports that one, and a field added on one side becomes a type error on the
+ * other.
+ *
+ * Every route is JSON in and out, on the api host, and reads no cookie. A
+ * route that needs a person takes `Authorization: Bearer vcu_…`, the token
+ * `versioncam cloud login` was given.
+ */
+/** Paths, relative to the API's origin. Names are escaped: a clip id may hold a dot. */
+export const CLOUD_PATHS = {
+    device: "/v1/cli/device",
+    token: "/v1/cli/token",
+    me: "/v1/me",
+    project: (project) => `/v1/projects/${projectPath(project)}`,
+    clip: (project, clip) => `/v1/projects/${projectPath(project)}/clips/${encodeURIComponent(clip)}`,
+    ack: (project, clip) => `/v1/projects/${projectPath(project)}/clips/${encodeURIComponent(clip)}/ack`,
+    changes: (project) => `/v1/projects/${projectPath(project)}/changes`,
+    change: (project, change) => `/v1/projects/${projectPath(project)}/changes/${encodeURIComponent(change)}`,
+    plan: (account) => `/v1/accounts/${encodeURIComponent(account)}/plan`,
+};
+/** `owner/repo` as two path segments, each escaped on its own. */
+function projectPath(project) {
+    const [owner, repo] = project.split("/");
+    return `${encodeURIComponent(owner)}/${encodeURIComponent(repo)}`;
+}
+//# sourceMappingURL=protocol.js.map

package/dist/cloud/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../src/cloud/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAyLH,wFAAwF;AACxF,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,MAAM,EAAE,gBAAgB;IACxB,KAAK,EAAE,eAAe;IACtB,EAAE,EAAE,QAAQ;IACZ,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,gBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE;IACpE,IAAI,EAAE,CAAC,OAAe,EAAE,IAAY,EAAE,EAAE,CACtC,gBAAgB,WAAW,CAAC,OAAO,CAAC,UAAU,kBAAkB,CAAC,IAAI,CAAC,EAAE;IAC1E,GAAG,EAAE,CAAC,OAAe,EAAE,IAAY,EAAE,EAAE,CACrC,gBAAgB,WAAW,CAAC,OAAO,CAAC,UAAU,kBAAkB,CAAC,IAAI,CAAC,MAAM;IAC9E,OAAO,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,gBAAgB,WAAW,CAAC,OAAO,CAAC,UAAU;IAC5E,MAAM,EAAE,CAAC,OAAe,EAAE,MAAc,EAAE,EAAE,CAC1C,gBAAgB,WAAW,CAAC,OAAO,CAAC,YAAY,kBAAkB,CAAC,MAAM,CAAC,EAAE;IAC9E,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,gBAAgB,kBAAkB,CAAC,OAAO,CAAC,OAAO;CACrE,CAAC;AAEX,kEAAkE;AAClE,SAAS,WAAW,CAAC,OAAe;IAClC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACzC,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;AACpE,CAAC"}

package/dist/cloud/repository.d.ts

@@ -0,0 +1,21 @@
+/** `owner/repo` if `text` is one, else null. */
+export declare function projectName(text: string): string | null;
+/** An account's name as GitHub allows it, else null. */
+export declare function accountName(text: string): string | null;
+/**
+ * The `owner/repo` a GitHub remote points at, from any of the forms GitHub
+ * hands out or git accepts for it: `https://github.com/owner/repo.git`, with
+ * a user or a token before the host or without the `.git`;
+ * `git@github.com:owner/repo.git`; `ssh://git@github.com/owner/repo.git`,
+ * with a port or on `ssh.github.com`. Any other host is null: version.cam
+ * knows projects on github.com only.
+ */
+export declare function githubRepository(remote: string): string | null;
+/**
+ * The repository of `git remote get-url origin` in `cwd`, or null: not a
+ * clone, no `origin`, no git, or an origin that is not on GitHub. `get-url`
+ * rather than the config's raw value, because it applies a `url.insteadOf`
+ * rewrite the way a fetch would. `env` is git's environment, the command's
+ * own unless a test isolates git from the machine's configuration.
+ */
+export declare function originRepository(cwd: string, env?: NodeJS.ProcessEnv): string | null;

package/dist/cloud/repository.js

@@ -0,0 +1,97 @@
+import { execFileSync } from "node:child_process";
+/**
+ * Which project a command is about, when nobody says: the GitHub repository
+ * this directory is a clone of. A project on version.cam is a repository's
+ * `owner/repo`, so its `origin` remote names it, from wherever in the clone
+ * the command runs.
+ */
+/** GitHub's own rule for an account: letters, digits and hyphens, at most 39. */
+const OWNER = /^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})$/;
+/** And for a repository: letters, digits, dots, hyphens and underscores, never `.` or `..`. */
+const REPO = /^(?!\.{1,2}$)[A-Za-z0-9._-]{1,100}$/;
+/**
+ * GitHub's hosts for git: the site itself, and `ssh.github.com`, which
+ * GitHub documents for SSH over port 443 where port 22 is closed.
+ */
+const GITHUB_HOSTS = new Set([
+    "github.com",
+    "www.github.com",
+    "ssh.github.com",
+]);
+/** `owner/repo` if `text` is one, else null. */
+export function projectName(text) {
+    const parts = text.split("/");
+    if (parts.length !== 2)
+        return null;
+    const [owner, repo] = parts;
+    return OWNER.test(owner) && REPO.test(repo) ? `${owner}/${repo}` : null;
+}
+/** An account's name as GitHub allows it, else null. */
+export function accountName(text) {
+    return OWNER.test(text) ? text : null;
+}
+/**
+ * The `owner/repo` a GitHub remote points at, from any of the forms GitHub
+ * hands out or git accepts for it: `https://github.com/owner/repo.git`, with
+ * a user or a token before the host or without the `.git`;
+ * `git@github.com:owner/repo.git`; `ssh://git@github.com/owner/repo.git`,
+ * with a port or on `ssh.github.com`. Any other host is null: version.cam
+ * knows projects on github.com only.
+ */
+export function githubRepository(remote) {
+    const url = remote.trim();
+    let host;
+    let path;
+    // The short SSH form, `user@host:path`, has no scheme, and git reads a
+    // colon before any slash as the end of the host.
+    const scp = /^(?:[^@/\s]+@)?([^:/\s]+):(?!\/)(\S+)$/.exec(url);
+    if (scp && !/^[A-Za-z][A-Za-z0-9+.-]*:\/\//.test(url)) {
+        host = scp[1];
+        path = scp[2];
+    }
+    else {
+        let parsed;
+        try {
+            parsed = new URL(url);
+        }
+        catch {
+            return null;
+        }
+        if (!["https:", "http:", "ssh:", "git:", "git+ssh:"].includes(parsed.protocol)) {
+            return null;
+        }
+        host = parsed.hostname;
+        // Not decoded: no name GitHub allows needs escaping, so an escape in
+        // the path is a name it would not allow, and the check below says no.
+        path = parsed.pathname;
+    }
+    if (!GITHUB_HOSTS.has(host.toLowerCase()))
+        return null;
+    return projectName(path
+        .replace(/^\/+/, "")
+        .replace(/\/+$/, "")
+        .replace(/\.git$/, ""));
+}
+/**
+ * The repository of `git remote get-url origin` in `cwd`, or null: not a
+ * clone, no `origin`, no git, or an origin that is not on GitHub. `get-url`
+ * rather than the config's raw value, because it applies a `url.insteadOf`
+ * rewrite the way a fetch would. `env` is git's environment, the command's
+ * own unless a test isolates git from the machine's configuration.
+ */
+export function originRepository(cwd, env = process.env) {
+    let remote;
+    try {
+        remote = execFileSync("git", ["remote", "get-url", "origin"], {
+            cwd,
+            env,
+            encoding: "utf8",
+            stdio: ["ignore", "pipe", "ignore"],
+        });
+    }
+    catch {
+        return null;
+    }
+    return githubRepository(remote);
+}
+//# sourceMappingURL=repository.js.map

package/dist/cloud/repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.js","sourceRoot":"","sources":["../../src/cloud/repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;;;GAKG;AAEH,iFAAiF;AACjF,MAAM,KAAK,GAAG,qCAAqC,CAAC;AACpD,+FAA+F;AAC/F,MAAM,IAAI,GAAG,qCAAqC,CAAC;AAEnD;;;GAGG;AACH,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC;IAC3B,YAAY;IACZ,gBAAgB;IAChB,gBAAgB;CACjB,CAAC,CAAC;AAEH,gDAAgD;AAChD,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC;IAC5B,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC1E,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AACxC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAI,IAAY,CAAC;IACjB,IAAI,IAAY,CAAC;IACjB,uEAAuE;IACvE,iDAAiD;IACjD,MAAM,GAAG,GAAG,wCAAwC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC/D,IAAI,GAAG,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACtD,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,IAAI,MAAW,CAAC;QAChB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IACE,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC1E,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC;QACvB,qEAAqE;QACrE,sEAAsE;QACtE,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;IACD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,IAAI,CAAC;IACvD,OAAO,WAAW,CAChB,IAAI;SACD,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACnB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CACzB,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,GAAW,EACX,MAAyB,OAAO,CAAC,GAAG;IAEpC,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE;YAC5D,GAAG;YACH,GAAG;YACH,QAAQ,EAAE,MAAM;YAChB,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC;SACpC,CAAC,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAClC,CAAC"}

package/dist/cloud/wait.d.ts

@@ -0,0 +1,43 @@
+import { type CloudClient } from "./client.js";
+import type { ChangePending, ChangeState, DeviceAuthorization, DeviceToken } from "./protocol.js";
+/**
+ * Waiting for a person: a sign-in or a change, approved in a browser while
+ * the command asks, now and then, whether it has been.
+ *
+ * Time comes from a clock the caller hands over, so a test can wait ten
+ * minutes in no time at all and see every interval the command chose.
+ */
+export type Clock = {
+    /** Milliseconds, as `Date.now()`. */
+    now(): number;
+    sleep(ms: number): Promise<void>;
+};
+export declare const realClock: Clock;
+/** The longest a command waits: as long as a code lives, ten minutes. */
+export declare const WAIT_LIMIT_MS: number;
+/**
+ * How long to wait for a code that lives `expiresIn` seconds: as long as it
+ * does, never past ten minutes, and ten minutes when the answer did not say.
+ */
+export declare function waitLimit(expiresIn: number | undefined): number;
+/** How often a change is asked after, which the service's answer does not say. */
+export declare const CHANGE_INTERVAL_MS = 5000;
+export type SignIn = {
+    kind: "token";
+    token: DeviceToken;
+} | {
+    kind: "denied";
+} | {
+    kind: "expired";
+} | {
+    kind: "timeout";
+};
+/**
+ * Ask for the token at the service's interval, as RFC 8628 has a device do,
+ * until it comes, the person denies it, or the code expires. Never longer
+ * than the code lives, nor than ten minutes.
+ */
+export declare function waitForToken(client: CloudClient, device: DeviceAuthorization, clock: Clock): Promise<SignIn>;
+export type ChangeOutcome = Exclude<ChangeState["state"], "pending"> | "timeout";
+/** Ask after a change every five seconds until it is applied, denied or expired. */
+export declare function waitForChange(client: CloudClient, project: string, pending: ChangePending, clock: Clock): Promise<ChangeOutcome>;

package/dist/cloud/wait.js

@@ -0,0 +1,110 @@
+import { CloudError, transient } from "./client.js";
+export const realClock = {
+    now: () => Date.now(),
+    sleep: (ms) => new Promise((resolve) => setTimeout(resolve, ms)),
+};
+/** The longest a command waits: as long as a code lives, ten minutes. */
+export const WAIT_LIMIT_MS = 10 * 60 * 1000;
+/**
+ * How long to wait for a code that lives `expiresIn` seconds: as long as it
+ * does, never past ten minutes, and ten minutes when the answer did not say.
+ */
+export function waitLimit(expiresIn) {
+    return Math.min((expiresIn || 600) * 1000, WAIT_LIMIT_MS);
+}
+/** How often a change is asked after, which the service's answer does not say. */
+export const CHANGE_INTERVAL_MS = 5000;
+/** RFC 8628, 3.5: each `slow_down` adds five seconds, to this wait and every later one. */
+const SLOW_DOWN_MS = 5000;
+/**
+ * Ask every `intervalMs` until an answer ends it, or until the next question
+ * would come after `limitMs`; null then. The first question waits an
+ * interval too: nobody has approved anything in the moment since the code
+ * was printed.
+ *
+ * A question that got no answer, or was turned away for coming too often, or
+ * met a failing service, is asked again at the next turn rather than ending
+ * the wait: the person may be approving it at that moment, and a sign-in
+ * given up on is a code they approve for nothing.
+ *
+ * But a wait whose last question failed ends with that failure, thrown,
+ * not with null. Null says nobody approved in time, which only an answer
+ * can say; a service that kept failing (its `internal` is a bug) may have
+ * been approved while it failed, and the person should hear what happened.
+ */
+async function poll(ask, intervalMs, limitMs, clock) {
+    const deadline = clock.now() + limitMs;
+    let interval = intervalMs;
+    let wait = interval;
+    let failed = null;
+    while (clock.now() + wait <= deadline) {
+        await clock.sleep(wait);
+        wait = interval;
+        let step;
+        try {
+            step = await ask();
+        }
+        catch (error) {
+            if (!transient(error))
+                throw error;
+            failed = error;
+            wait = Math.max(interval, (error.retryAfter ?? 0) * 1000);
+            continue;
+        }
+        failed = null;
+        if (step === "again")
+            continue;
+        if (step === "slower") {
+            interval += SLOW_DOWN_MS;
+            wait = interval;
+            continue;
+        }
+        return step.done;
+    }
+    if (failed)
+        throw failed;
+    return null;
+}
+/**
+ * Ask for the token at the service's interval, as RFC 8628 has a device do,
+ * until it comes, the person denies it, or the code expires. Never longer
+ * than the code lives, nor than ten minutes.
+ */
+export async function waitForToken(client, device, clock) {
+    // RFC 8628 has a device wait five seconds when the answer gave no interval.
+    const interval = Math.max(1, device.interval || 5) * 1000;
+    const outcome = await poll(async () => {
+        try {
+            return {
+                done: {
+                    kind: "token",
+                    token: await client.token(device.device_code),
+                },
+            };
+        }
+        catch (error) {
+            if (!(error instanceof CloudError))
+                throw error;
+            if (error.code === "authorization_pending")
+                return "again";
+            if (error.code === "slow_down")
+                return "slower";
+            if (error.code === "access_denied")
+                return { done: { kind: "denied" } };
+            if (error.code === "expired_token") {
+                return { done: { kind: "expired" } };
+            }
+            throw error;
+        }
+    }, interval, waitLimit(device.expires_in), clock);
+    return outcome ?? { kind: "timeout" };
+}
+/** Ask after a change every five seconds until it is applied, denied or expired. */
+export async function waitForChange(client, project, pending, clock) {
+    const outcome = await poll(async () => {
+        const { state } = await client.changeState(project, pending.change);
+        return state === "pending" ? "again" : { done: state };
+    }, CHANGE_INTERVAL_MS, waitLimit(pending.expires_in), clock);
+    return outcome ?? "timeout";
+}
+//# sourceMappingURL=wait.js.map