@gadgetinc/ggt 0.0.0-alpha.0

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,oCAAkC;AAAzB,2FAAA,GAAG,OAAA","sourcesContent":["export { run } from \"@oclif/core\";\n"]}

package/dist/lib/base-command.d.ts

@@ -0,0 +1,87 @@
+import type { Config } from "@oclif/core";
+import { Command } from "@oclif/core";
+import type { Got } from "got";
+import type { Notification } from "node-notifier";
+import type WindowsBalloon from "node-notifier/notifiers/balloon";
+import type Growl from "node-notifier/notifiers/growl";
+import type NotificationCenter from "node-notifier/notifiers/notificationcenter";
+import type NotifySend from "node-notifier/notifiers/notifysend";
+import type WindowsToaster from "node-notifier/notifiers/toaster";
+import { Client } from "./client";
+import type { App, User } from "./types";
+export declare const ENDPOINT: string;
+export declare abstract class BaseCommand extends Command {
+    /**
+     * Determines how high the command is listed in the README. The lower the number, the higher the command is listed. Equal numbers are
+     * sorted alphabetically.
+     */
+    static priority: number;
+    static globalFlags: {
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    /**
+     * Indicates whether the command is being run with the `-D/--debug` flag.
+     */
+    debugEnabled: boolean;
+    /**
+     * Determines whether the command requires the user to be logged in or not.
+     * If true and the user is not logged in, the user will be prompted to login before the command is run.
+     */
+    readonly requireUser: boolean;
+    /**
+     * Determines whether the command requires a Gadget app to be selected or not.
+     * If true and an app hasn't been selected, the user will be prompted to select an app before the command is run.
+     *
+     * Implies {@linkcode requireUser requireUser = true}.
+     */
+    readonly requireApp: boolean;
+    /**
+     * The HTTP client to use for all HTTP requests.
+     *
+     * If a request is made to Gadget, the session token will be added to the request's headers.
+     */
+    readonly http: Got;
+    /**
+     * The GraphQL client to use for all Gadget API requests.
+     *
+     * Will be `undefined` if the user is not logged in or if the user has not selected an app.
+     *
+     * @see {@linkcode requireApp requireApp}
+     */
+    client: Client;
+    private _session?;
+    constructor(argv: string[], config: Config);
+    get session(): string | undefined;
+    set session(value: string | undefined);
+    init(): Promise<void>;
+    /**
+     * Sends a native OS notification to the user.
+     *
+     * @see {@link https://www.npmjs.com/package/node-notifier node-notifier}
+     */
+    notify(notification: Notification | NotificationCenter.Notification | NotifySend.Notification | WindowsToaster.Notification | WindowsBalloon.Notification | Growl.Notification): void;
+    /**
+     * Opens the Gadget login page in the user's default browser and waits for the user to login.
+     */
+    login(): Promise<void>;
+    /**
+     * @returns Whether the user was logged in or not.
+     */
+    logout(): boolean;
+    /**
+     * @returns The current user, or undefined if the user is not logged in.
+     */
+    getCurrentUser(): Promise<User | undefined>;
+    /**
+     * @returns A list of Gadget apps that the user has access to.
+     */
+    getApps(): Promise<App[]>;
+    /**
+     * Overrides the default `catch` behavior so we can control how errors are printed to the user. This is called automatically by oclif when
+     * an error is thrown during the `init` or `run` methods.
+     */
+    catch(cause: Error & {
+        exitCode?: number;
+    }): never;
+}

package/dist/lib/base-command.js

@@ -0,0 +1,318 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCommand = exports.ENDPOINT = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const errors_1 = require("@oclif/core/lib/errors");
+const errors_2 = require("@oclif/errors");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const get_port_1 = tslib_1.__importDefault(require("get-port"));
+const got_1 = tslib_1.__importStar(require("got"));
+const http_1 = require("http");
+const inquirer_1 = require("inquirer");
+const node_notifier_1 = require("node-notifier");
+const open_1 = tslib_1.__importDefault(require("open"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const client_1 = require("./client");
+const env_1 = require("./env");
+const errors_3 = require("./errors");
+const fs_utils_1 = require("./fs-utils");
+exports.ENDPOINT = env_1.Env.productionLike ? "https://app.gadget.dev" : "https://app.ggt.dev:3000";
+class BaseCommand extends core_1.Command {
+    constructor(argv, config) {
+        super(argv, config);
+        /**
+         * Indicates whether the command is being run with the `-D/--debug` flag.
+         */
+        Object.defineProperty(this, "debugEnabled", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        /**
+         * Determines whether the command requires the user to be logged in or not.
+         * If true and the user is not logged in, the user will be prompted to login before the command is run.
+         */
+        Object.defineProperty(this, "requireUser", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        /**
+         * Determines whether the command requires a Gadget app to be selected or not.
+         * If true and an app hasn't been selected, the user will be prompted to select an app before the command is run.
+         *
+         * Implies {@linkcode requireUser requireUser = true}.
+         */
+        Object.defineProperty(this, "requireApp", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        /**
+         * The HTTP client to use for all HTTP requests.
+         *
+         * If a request is made to Gadget, the session token will be added to the request's headers.
+         */
+        Object.defineProperty(this, "http", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The GraphQL client to use for all Gadget API requests.
+         *
+         * Will be `undefined` if the user is not logged in or if the user has not selected an app.
+         *
+         * @see {@linkcode requireApp requireApp}
+         */
+        Object.defineProperty(this, "client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_session", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.http = got_1.default.extend({
+            hooks: {
+                beforeRequest: [
+                    (options) => {
+                        options.headers["user-agent"] = this.config.userAgent;
+                        if (options.url.origin === exports.ENDPOINT && this.session) {
+                            options.headers = { ...options.headers, cookie: `session=${encodeURIComponent(this.session)};` };
+                        }
+                    },
+                ],
+            },
+        });
+    }
+    get session() {
+        try {
+            return (this._session ??= fs_extra_1.default.readFileSync(path_1.default.join(this.config.configDir, "session.txt"), "utf-8"));
+        }
+        catch (error) {
+            (0, fs_utils_1.ignoreEnoent)(error);
+            return undefined;
+        }
+    }
+    set session(value) {
+        this._session = value;
+        if (value) {
+            fs_extra_1.default.outputFileSync(path_1.default.join(this.config.configDir, "session.txt"), value);
+        }
+        else {
+            fs_extra_1.default.removeSync(path_1.default.join(this.config.configDir, "session.txt"));
+        }
+    }
+    async init() {
+        await super.init();
+        const { flags, argv } = await this.parse({ flags: BaseCommand.globalFlags, strict: false });
+        // remove global flags from argv
+        this.argv = argv;
+        if (flags.debug) {
+            this.debugEnabled = true;
+            debug_1.default.enable(`${this.config.bin}:*`);
+        }
+        if (!this.requireUser && !this.requireApp) {
+            return;
+        }
+        if (!(await this.getCurrentUser())) {
+            const { login } = await (0, inquirer_1.prompt)({
+                type: "confirm",
+                name: "login",
+                message: "You must be logged in to use this command. Would you like to log in?",
+            });
+            if (!login) {
+                return this.exit(0);
+            }
+            await this.login();
+        }
+        if (!this.requireApp) {
+            return;
+        }
+        let app = flags.app;
+        if (!app) {
+            ({ app } = await (0, inquirer_1.prompt)({
+                type: "list",
+                name: "app",
+                message: "Please select the app to use with this command.",
+                choices: await this.getApps().then((apps) => apps.map((app) => app.slug)),
+            }));
+        }
+        this.client = new client_1.Client(app, {
+            ws: {
+                headers: {
+                    "user-agent": this.config.userAgent,
+                    cookie: `session=${encodeURIComponent(this.session)};`,
+                },
+            },
+        });
+    }
+    /**
+     * Sends a native OS notification to the user.
+     *
+     * @see {@link https://www.npmjs.com/package/node-notifier node-notifier}
+     */
+    notify(notification) {
+        (0, node_notifier_1.notify)({
+            title: "Gadget",
+            contentImage: path_1.default.join(this.config.root, "assets", "favicon-128@4x.png"),
+            icon: path_1.default.join(this.config.root, "assets", "favicon-128@4x.png"),
+            sound: true,
+            timeout: false,
+            ...notification,
+        }, (error) => {
+            if (error)
+                this.warn(error);
+        });
+    }
+    /**
+     * Opens the Gadget login page in the user's default browser and waits for the user to login.
+     */
+    async login() {
+        let server;
+        try {
+            const port = await (0, get_port_1.default)();
+            const receiveSession = new Promise((resolve, reject) => {
+                // eslint-disable-next-line @typescript-eslint/no-misused-promises
+                server = (0, http_1.createServer)(async (req, res) => {
+                    const redirectTo = new URL(`${exports.ENDPOINT}/auth/cli`);
+                    try {
+                        if (!req.url)
+                            throw new Error("missing url");
+                        const incomingUrl = new URL(req.url, `http://localhost:${port}`);
+                        const session = incomingUrl.searchParams.get("session");
+                        if (!session)
+                            throw new Error("missing session");
+                        this.session = session;
+                        const user = await this.getCurrentUser();
+                        if (!user)
+                            throw new Error("missing current user");
+                        if (user.name) {
+                            this.log(`Hello, ${user.name} (${user.email})`);
+                        }
+                        else {
+                            this.log(`Hello, ${user.email}`);
+                        }
+                        redirectTo.searchParams.set("success", "true");
+                        resolve();
+                    }
+                    catch (error) {
+                        this.session = undefined;
+                        redirectTo.searchParams.set("success", "false");
+                        reject(error);
+                    }
+                    finally {
+                        res.writeHead(303, { Location: redirectTo.toString() });
+                        res.end();
+                    }
+                });
+                server.listen(port);
+            });
+            const url = new URL(`${exports.ENDPOINT}/auth/login`);
+            url.searchParams.set("returnTo", `${exports.ENDPOINT}/auth/cli/callback?port=${port}`);
+            await (0, open_1.default)(url.toString());
+            this.log("Your browser has been opened. Please log in to your account.");
+            await receiveSession;
+        }
+        finally {
+            server?.close();
+        }
+    }
+    /**
+     * @returns Whether the user was logged in or not.
+     */
+    logout() {
+        if (!this.session)
+            return false;
+        this.session = undefined;
+        return true;
+    }
+    /**
+     * @returns The current user, or undefined if the user is not logged in.
+     */
+    async getCurrentUser() {
+        if (!this.session)
+            return undefined;
+        try {
+            return await this.http(`${exports.ENDPOINT}/auth/api/current-user`).json();
+        }
+        catch (error) {
+            if (error instanceof got_1.HTTPError && error.response.statusCode === 401) {
+                this.logout();
+                return undefined;
+            }
+            throw error;
+        }
+    }
+    /**
+     * @returns A list of Gadget apps that the user has access to.
+     */
+    async getApps() {
+        if (!this.session)
+            return [];
+        return await this.http(`${exports.ENDPOINT}/auth/api/apps`).json();
+    }
+    /**
+     * Overrides the default `catch` behavior so we can control how errors are printed to the user. This is called automatically by oclif when
+     * an error is thrown during the `init` or `run` methods.
+     */
+    catch(cause) {
+        const error = cause instanceof errors_3.BaseError ? cause : new errors_3.UnexpectedError(cause);
+        console.error(error.render(this.config));
+        // The original implementation of `catch` re-throws the error so that it's caught and printed by oclif's `handle` method. We still want
+        // to end up in oclif's `handle` method, but we don't want it to print the error again so we throw an ExitError instead. This will cause
+        // `handle` to not print the error, but still exit with the correct exit code.
+        //
+        //  catch: https://github.com/oclif/core/blob/12e31ff2288606e583e03bf774a3244f3136cd10/src/command.ts#L261
+        // handle: https://github.com/oclif/core/blob/12e31ff2288606e583e03bf774a3244f3136cd10/src/errors/handle.ts#L15
+        throw new errors_1.ExitError(process.exitCode ?? cause.exitCode ?? 1);
+    }
+}
+exports.BaseCommand = BaseCommand;
+/**
+ * Determines how high the command is listed in the README. The lower the number, the higher the command is listed. Equal numbers are
+ * sorted alphabetically.
+ */
+Object.defineProperty(BaseCommand, "priority", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: Infinity
+});
+Object.defineProperty(BaseCommand, "globalFlags", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: {
+        app: core_1.Flags.string({
+            char: "A",
+            summary: "The Gadget application this command applies to.",
+            helpGroup: "global",
+            helpValue: "name",
+            parse: (value) => {
+                const app = /^(https:\/\/)?(?<app>[\w-]+)(\..*)?/.exec(value)?.groups?.["app"];
+                if (!app)
+                    throw new errors_2.CLIError("Flag '-A, --app=<name>' is invalid");
+                return Promise.resolve(app);
+            },
+        }),
+        debug: core_1.Flags.boolean({
+            char: "D",
+            summary: "Whether to output debug information.",
+            helpGroup: "global",
+            default: false,
+        }),
+    }
+});
+//# sourceMappingURL=base-command.js.map

package/dist/lib/base-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-command.js","sourceRoot":"","sources":["../../src/lib/base-command.ts"],"names":[],"mappings":";;;;AACA,sCAA6C;AAC7C,mDAAmD;AACnD,0CAAyC;AACzC,0DAA0B;AAC1B,gEAA0B;AAC1B,gEAA+B;AAE/B,mDAAqC;AAErC,+BAAoC;AACpC,uCAAkC;AAElC,iDAAuC;AAMvC,wDAAwB;AACxB,wDAAwB;AACxB,qCAAkC;AAClC,+BAA4B;AAC5B,qCAAsE;AACtE,yCAA0C;AAG7B,QAAA,QAAQ,GAAG,SAAG,CAAC,cAAc,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,0BAA0B,CAAC;AAEnG,MAAsB,WAAY,SAAQ,cAAO;IAgE/C,YAAY,IAAc,EAAE,MAAc;QACxC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAtCtB;;WAEG;QACH;;;;mBAAe,KAAK;WAAC;QAErB;;;WAGG;QACH;;;;mBAAgC,KAAK;WAAC;QAEtC;;;;;WAKG;QACH;;;;mBAA+B,KAAK;WAAC;QAErC;;;;WAIG;QACH;;;;;WAAmB;QAEnB;;;;;;WAMG;QACH;;;;;WAAgB;QAEhB;;;;;WAA0B;QAKxB,IAAI,CAAC,IAAI,GAAG,aAAG,CAAC,MAAM,CAAC;YACrB,KAAK,EAAE;gBACL,aAAa,EAAE;oBACb,CAAC,OAAO,EAAE,EAAE;wBACV,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;wBACtD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,KAAK,gBAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;4BACnD,OAAO,CAAC,OAAO,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;yBAClG;oBACH,CAAC;iBACF;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAED,IAAI,OAAO;QACT,IAAI;YACF,OAAO,CAAC,IAAI,CAAC,QAAQ,KAAK,kBAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;SACtG;QAAC,OAAO,KAAK,EAAE;YACd,IAAA,uBAAY,EAAC,KAAK,CAAC,CAAC;YACpB,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAED,IAAI,OAAO,CAAC,KAAyB;QACnC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,KAAK,EAAE;YACT,kBAAE,CAAC,cAAc,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,KAAK,CAAC,CAAC;SAC3E;aAAM;YACL,kBAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;SAChE;IACH,CAAC;IAEQ,KAAK,CAAC,IAAI;QACjB,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAE5F,gCAAgC;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,IAAI,KAAK,CAAC,KAAK,EAAE;YACf,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;YACzB,eAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;SACtC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACzC,OAAO;SACR;QAED,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC,EAAE;YAClC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAA,iBAAM,EAAqB;gBACjD,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,sEAAsE;aAChF,CAAC,CAAC;YAEH,IAAI,CAAC,KAAK,EAAE;gBACV,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACrB;YAED,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;SACpB;QAED,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAO;SACR;QAED,IAAI,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,GAAG,EAAE;YACR,CAAC,EAAE,GAAG,EAAE,GAAG,MAAM,IAAA,iBAAM,EAAkB;gBACvC,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,KAAK;gBACX,OAAO,EAAE,iDAAiD;gBAC1D,OAAO,EAAE,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;aAC1E,CAAC,CAAC,CAAC;SACL;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,GAAG,EAAE;YAC5B,EAAE,EAAE;gBACF,OAAO,EAAE;oBACP,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS;oBACnC,MAAM,EAAE,WAAW,kBAAkB,CAAC,IAAI,CAAC,OAAiB,CAAC,GAAG;iBACjE;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,YAMsB;QAEtB,IAAA,sBAAM,EACJ;YACE,KAAK,EAAE,QAAQ;YACf,YAAY,EAAE,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,oBAAoB,CAAC;YACzE,IAAI,EAAE,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,oBAAoB,CAAC;YACjE,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,KAAK;YACd,GAAG,YAAY;SAChB,EACD,CAAC,KAAK,EAAE,EAAE;YACR,IAAI,KAAK;gBAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,MAA0B,CAAC;QAE/B,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,IAAA,kBAAO,GAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC3D,kEAAkE;gBAClE,MAAM,GAAG,IAAA,mBAAY,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;oBACvC,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,GAAG,gBAAQ,WAAW,CAAC,CAAC;oBAEnD,IAAI;wBACF,IAAI,CAAC,GAAG,CAAC,GAAG;4BAAE,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;wBAC7C,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,oBAAoB,IAAI,EAAE,CAAC,CAAC;wBAEjE,MAAM,OAAO,GAAG,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;wBACxD,IAAI,CAAC,OAAO;4BAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;wBAEjD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;wBAEvB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;wBACzC,IAAI,CAAC,IAAI;4BAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;wBAEnD,IAAI,IAAI,CAAC,IAAI,EAAE;4BACb,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;yBACjD;6BAAM;4BACL,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;yBAClC;wBAED,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;wBAC/C,OAAO,EAAE,CAAC;qBACX;oBAAC,OAAO,KAAK,EAAE;wBACd,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;wBACzB,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;wBAChD,MAAM,CAAC,KAAK,CAAC,CAAC;qBACf;4BAAS;wBACR,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;wBACxD,GAAG,CAAC,GAAG,EAAE,CAAC;qBACX;gBACH,CAAC,CAAC,CAAC;gBAEH,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;YAEH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,gBAAQ,aAAa,CAAC,CAAC;YAC9C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,gBAAQ,2BAA2B,IAAI,EAAE,CAAC,CAAC;YAC/E,MAAM,IAAA,cAAI,EAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;YAE3B,IAAI,CAAC,GAAG,CAAC,8DAA8D,CAAC,CAAC;YAEzE,MAAM,cAAc,CAAC;SACtB;gBAAS;YACR,MAAM,EAAE,KAAK,EAAE,CAAC;SACjB;IACH,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAEhC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QAEpC,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAQ,wBAAwB,CAAC,CAAC,IAAI,EAAQ,CAAC;SAC1E;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,KAAK,YAAY,eAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,UAAU,KAAK,GAAG,EAAE;gBACnE,IAAI,CAAC,MAAM,EAAE,CAAC;gBACd,OAAO,SAAS,CAAC;aAClB;YACD,MAAM,KAAK,CAAC;SACb;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,EAAE,CAAC;QAE7B,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,gBAAQ,gBAAgB,CAAC,CAAC,IAAI,EAAS,CAAC;IACpE,CAAC;IAED;;;OAGG;IACM,KAAK,CAAC,KAAoC;QACjD,MAAM,KAAK,GAAG,KAAK,YAAY,kBAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,wBAAY,CAAC,KAAK,CAAC,CAAC;QAC3E,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAEzC,uIAAuI;QACvI,wIAAwI;QACxI,8EAA8E;QAC9E,EAAE;QACF,0GAA0G;QAC1G,+GAA+G;QAC/G,MAAM,IAAI,kBAAS,CAAC,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;IAC/D,CAAC;;AAnSH,kCAoSC;AAnSC;;;GAGG;AACI;;;;WAAW,QAAQ;GAAC;AAE3B;;;;WAA8B;QAC5B,GAAG,EAAE,YAAK,CAAC,MAAM,CAAC;YAChB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,iDAAiD;YAC1D,SAAS,EAAE,QAAQ;YACnB,SAAS,EAAE,MAAM;YACjB,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;gBACf,MAAM,GAAG,GAAG,qCAAqC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;gBAC/E,IAAI,CAAC,GAAG;oBAAE,MAAM,IAAI,iBAAQ,CAAC,oCAAoC,CAAC,CAAC;gBACnE,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC9B,CAAC;SACF,CAAC;QACF,KAAK,EAAE,YAAK,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,sCAAsC;YAC/C,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,KAAK;SACf,CAAC;KACH;GAAC","sourcesContent":["import type { Config } from \"@oclif/core\";\nimport { Command, Flags } from \"@oclif/core\";\nimport { ExitError } from \"@oclif/core/lib/errors\";\nimport { CLIError } from \"@oclif/errors\";\nimport Debug from \"debug\";\nimport fs from \"fs-extra\";\nimport getPort from \"get-port\";\nimport type { Got } from \"got\";\nimport got, { HTTPError } from \"got\";\nimport type { Server } from \"http\";\nimport { createServer } from \"http\";\nimport { prompt } from \"inquirer\";\nimport type { Notification } from \"node-notifier\";\nimport { notify } from \"node-notifier\";\nimport type WindowsBalloon from \"node-notifier/notifiers/balloon\";\nimport type Growl from \"node-notifier/notifiers/growl\";\nimport type NotificationCenter from \"node-notifier/notifiers/notificationcenter\";\nimport type NotifySend from \"node-notifier/notifiers/notifysend\";\nimport type WindowsToaster from \"node-notifier/notifiers/toaster\";\nimport open from \"open\";\nimport path from \"path\";\nimport { Client } from \"./client\";\nimport { Env } from \"./env\";\nimport { BaseError, UnexpectedError as UnknownError } from \"./errors\";\nimport { ignoreEnoent } from \"./fs-utils\";\nimport type { App, User } from \"./types\";\n\nexport const ENDPOINT = Env.productionLike ? \"https://app.gadget.dev\" : \"https://app.ggt.dev:3000\";\n\nexport abstract class BaseCommand extends Command {\n  /**\n   * Determines how high the command is listed in the README. The lower the number, the higher the command is listed. Equal numbers are\n   * sorted alphabetically.\n   */\n  static priority = Infinity;\n\n  static override globalFlags = {\n    app: Flags.string({\n      char: \"A\",\n      summary: \"The Gadget application this command applies to.\",\n      helpGroup: \"global\",\n      helpValue: \"name\",\n      parse: (value) => {\n        const app = /^(https:\\/\\/)?(?<app>[\\w-]+)(\\..*)?/.exec(value)?.groups?.[\"app\"];\n        if (!app) throw new CLIError(\"Flag '-A, --app=<name>' is invalid\");\n        return Promise.resolve(app);\n      },\n    }),\n    debug: Flags.boolean({\n      char: \"D\",\n      summary: \"Whether to output debug information.\",\n      helpGroup: \"global\",\n      default: false,\n    }),\n  };\n\n  /**\n   * Indicates whether the command is being run with the `-D/--debug` flag.\n   */\n  debugEnabled = false;\n\n  /**\n   * Determines whether the command requires the user to be logged in or not.\n   * If true and the user is not logged in, the user will be prompted to login before the command is run.\n   */\n  readonly requireUser: boolean = false;\n\n  /**\n   * Determines whether the command requires a Gadget app to be selected or not.\n   * If true and an app hasn't been selected, the user will be prompted to select an app before the command is run.\n   *\n   * Implies {@linkcode requireUser requireUser = true}.\n   */\n  readonly requireApp: boolean = false;\n\n  /**\n   * The HTTP client to use for all HTTP requests.\n   *\n   * If a request is made to Gadget, the session token will be added to the request's headers.\n   */\n  readonly http: Got;\n\n  /**\n   * The GraphQL client to use for all Gadget API requests.\n   *\n   * Will be `undefined` if the user is not logged in or if the user has not selected an app.\n   *\n   * @see {@linkcode requireApp requireApp}\n   */\n  client!: Client;\n\n  private _session?: string;\n\n  constructor(argv: string[], config: Config) {\n    super(argv, config);\n\n    this.http = got.extend({\n      hooks: {\n        beforeRequest: [\n          (options) => {\n            options.headers[\"user-agent\"] = this.config.userAgent;\n            if (options.url.origin === ENDPOINT && this.session) {\n              options.headers = { ...options.headers, cookie: `session=${encodeURIComponent(this.session)};` };\n            }\n          },\n        ],\n      },\n    });\n  }\n\n  get session(): string | undefined {\n    try {\n      return (this._session ??= fs.readFileSync(path.join(this.config.configDir, \"session.txt\"), \"utf-8\"));\n    } catch (error) {\n      ignoreEnoent(error);\n      return undefined;\n    }\n  }\n\n  set session(value: string | undefined) {\n    this._session = value;\n    if (value) {\n      fs.outputFileSync(path.join(this.config.configDir, \"session.txt\"), value);\n    } else {\n      fs.removeSync(path.join(this.config.configDir, \"session.txt\"));\n    }\n  }\n\n  override async init(): Promise<void> {\n    await super.init();\n    const { flags, argv } = await this.parse({ flags: BaseCommand.globalFlags, strict: false });\n\n    // remove global flags from argv\n    this.argv = argv;\n\n    if (flags.debug) {\n      this.debugEnabled = true;\n      Debug.enable(`${this.config.bin}:*`);\n    }\n\n    if (!this.requireUser && !this.requireApp) {\n      return;\n    }\n\n    if (!(await this.getCurrentUser())) {\n      const { login } = await prompt<{ login: boolean }>({\n        type: \"confirm\",\n        name: \"login\",\n        message: \"You must be logged in to use this command. Would you like to log in?\",\n      });\n\n      if (!login) {\n        return this.exit(0);\n      }\n\n      await this.login();\n    }\n\n    if (!this.requireApp) {\n      return;\n    }\n\n    let app = flags.app;\n    if (!app) {\n      ({ app } = await prompt<{ app: string }>({\n        type: \"list\",\n        name: \"app\",\n        message: \"Please select the app to use with this command.\",\n        choices: await this.getApps().then((apps) => apps.map((app) => app.slug)),\n      }));\n    }\n\n    this.client = new Client(app, {\n      ws: {\n        headers: {\n          \"user-agent\": this.config.userAgent,\n          cookie: `session=${encodeURIComponent(this.session as string)};`,\n        },\n      },\n    });\n  }\n\n  /**\n   * Sends a native OS notification to the user.\n   *\n   * @see {@link https://www.npmjs.com/package/node-notifier node-notifier}\n   */\n  notify(\n    notification:\n      | Notification\n      | NotificationCenter.Notification\n      | NotifySend.Notification\n      | WindowsToaster.Notification\n      | WindowsBalloon.Notification\n      | Growl.Notification\n  ): void {\n    notify(\n      {\n        title: \"Gadget\",\n        contentImage: path.join(this.config.root, \"assets\", \"favicon-128@4x.png\"),\n        icon: path.join(this.config.root, \"assets\", \"favicon-128@4x.png\"),\n        sound: true,\n        timeout: false,\n        ...notification,\n      },\n      (error) => {\n        if (error) this.warn(error);\n      }\n    );\n  }\n\n  /**\n   * Opens the Gadget login page in the user's default browser and waits for the user to login.\n   */\n  async login(): Promise<void> {\n    let server: Server | undefined;\n\n    try {\n      const port = await getPort();\n      const receiveSession = new Promise<void>((resolve, reject) => {\n        // eslint-disable-next-line @typescript-eslint/no-misused-promises\n        server = createServer(async (req, res) => {\n          const redirectTo = new URL(`${ENDPOINT}/auth/cli`);\n\n          try {\n            if (!req.url) throw new Error(\"missing url\");\n            const incomingUrl = new URL(req.url, `http://localhost:${port}`);\n\n            const session = incomingUrl.searchParams.get(\"session\");\n            if (!session) throw new Error(\"missing session\");\n\n            this.session = session;\n\n            const user = await this.getCurrentUser();\n            if (!user) throw new Error(\"missing current user\");\n\n            if (user.name) {\n              this.log(`Hello, ${user.name} (${user.email})`);\n            } else {\n              this.log(`Hello, ${user.email}`);\n            }\n\n            redirectTo.searchParams.set(\"success\", \"true\");\n            resolve();\n          } catch (error) {\n            this.session = undefined;\n            redirectTo.searchParams.set(\"success\", \"false\");\n            reject(error);\n          } finally {\n            res.writeHead(303, { Location: redirectTo.toString() });\n            res.end();\n          }\n        });\n\n        server.listen(port);\n      });\n\n      const url = new URL(`${ENDPOINT}/auth/login`);\n      url.searchParams.set(\"returnTo\", `${ENDPOINT}/auth/cli/callback?port=${port}`);\n      await open(url.toString());\n\n      this.log(\"Your browser has been opened. Please log in to your account.\");\n\n      await receiveSession;\n    } finally {\n      server?.close();\n    }\n  }\n\n  /**\n   * @returns Whether the user was logged in or not.\n   */\n  logout(): boolean {\n    if (!this.session) return false;\n\n    this.session = undefined;\n    return true;\n  }\n\n  /**\n   * @returns The current user, or undefined if the user is not logged in.\n   */\n  async getCurrentUser(): Promise<User | undefined> {\n    if (!this.session) return undefined;\n\n    try {\n      return await this.http(`${ENDPOINT}/auth/api/current-user`).json<User>();\n    } catch (error) {\n      if (error instanceof HTTPError && error.response.statusCode === 401) {\n        this.logout();\n        return undefined;\n      }\n      throw error;\n    }\n  }\n\n  /**\n   * @returns A list of Gadget apps that the user has access to.\n   */\n  async getApps(): Promise<App[]> {\n    if (!this.session) return [];\n\n    return await this.http(`${ENDPOINT}/auth/api/apps`).json<App[]>();\n  }\n\n  /**\n   * Overrides the default `catch` behavior so we can control how errors are printed to the user. This is called automatically by oclif when\n   * an error is thrown during the `init` or `run` methods.\n   */\n  override catch(cause: Error & { exitCode?: number }): never {\n    const error = cause instanceof BaseError ? cause : new UnknownError(cause);\n    console.error(error.render(this.config));\n\n    // The original implementation of `catch` re-throws the error so that it's caught and printed by oclif's `handle` method. We still want\n    // to end up in oclif's `handle` method, but we don't want it to print the error again so we throw an ExitError instead. This will cause\n    // `handle` to not print the error, but still exit with the correct exit code.\n    //\n    //  catch: https://github.com/oclif/core/blob/12e31ff2288606e583e03bf774a3244f3136cd10/src/command.ts#L261\n    // handle: https://github.com/oclif/core/blob/12e31ff2288606e583e03bf774a3244f3136cd10/src/errors/handle.ts#L15\n    throw new ExitError(process.exitCode ?? cause.exitCode ?? 1);\n  }\n}\n"]}

package/dist/lib/client.d.ts

@@ -0,0 +1,39 @@
+import type { ClientOptions, ExecutionResult } from "graphql-ws";
+import type { JsonObject, SetOptional } from "type-fest";
+import WebSocket from "ws";
+import { ClientError } from "./errors";
+declare enum ConnectionStatus {
+    CONNECTED = 0,
+    DISCONNECTED = 1,
+    RECONNECTING = 2
+}
+export declare class Client {
+    status: ConnectionStatus;
+    private _client;
+    constructor(app: string, options?: Partial<ClientOptions> & {
+        ws?: Partial<WebSocket.ClientOptions>;
+    });
+    subscribe<Data extends JsonObject, Variables extends JsonObject, Extensions extends JsonObject = JsonObject>(payload: Payload<Data, Variables>, sink: SetOptional<Sink<Data, Extensions>, "complete">): () => void;
+    subscribeUnwrap<Data extends JsonObject, Variables extends JsonObject>(payload: Payload<Data, Variables>, sink: {
+        next: (data: Data) => void;
+        error: (error: ClientError) => void;
+    }): () => void;
+    query<Data extends JsonObject, Variables extends JsonObject, Extensions extends JsonObject = JsonObject>(payload: Payload<Data, Variables>): Promise<ExecutionResult<Data, Extensions>>;
+    queryUnwrap<Data extends JsonObject, Variables extends JsonObject>(payload: Payload<Data, Variables>): Promise<Data>;
+    dispose(): Promise<void>;
+}
+export declare type Query<Data extends JsonObject, Variables extends JsonObject = JsonObject, Extensions extends JsonObject = JsonObject> = string & {
+    __TData?: Data;
+    __TVariables?: Variables;
+    __TExtensions?: Extensions;
+};
+export interface Payload<Data extends JsonObject, Variables extends JsonObject> {
+    readonly query: Query<Data, Variables>;
+    readonly variables?: Variables | (() => Variables) | null;
+}
+export interface Sink<Data extends JsonObject, Extensions extends JsonObject> {
+    next(value: ExecutionResult<Data, Extensions>): void;
+    error(error: ClientError): void;
+    complete(): void;
+}
+export {};

package/dist/lib/client.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const tslib_1 = require("tslib");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const graphql_ws_1 = require("graphql-ws");
+const lodash_1 = require("lodash");
+const ws_1 = tslib_1.__importDefault(require("ws"));
+const env_1 = require("./env");
+const errors_1 = require("./errors");
+const debug = (0, debug_1.default)("ggt:client");
+var ConnectionStatus;
+(function (ConnectionStatus) {
+    ConnectionStatus[ConnectionStatus["CONNECTED"] = 0] = "CONNECTED";
+    ConnectionStatus[ConnectionStatus["DISCONNECTED"] = 1] = "DISCONNECTED";
+    ConnectionStatus[ConnectionStatus["RECONNECTING"] = 2] = "RECONNECTING";
+})(ConnectionStatus || (ConnectionStatus = {}));
+class Client {
+    constructor(app, options) {
+        // assume the client is going to connect
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ConnectionStatus.CONNECTED
+        });
+        Object.defineProperty(this, "_client", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this._client = (0, graphql_ws_1.createClient)({
+            url: `wss://${app}.${env_1.Env.productionLike ? "gadget.app" : "ggt.pub:3000"}/edit/api/graphql-ws`,
+            shouldRetry: () => true,
+            webSocketImpl: class extends ws_1.default {
+                constructor(address, protocols, wsOptions) {
+                    super(address, protocols, { ...wsOptions, ...options?.ws });
+                }
+            },
+            on: {
+                connecting: () => {
+                    switch (this.status) {
+                        case ConnectionStatus.DISCONNECTED:
+                            this.status = ConnectionStatus.RECONNECTING;
+                            debug("reconnecting...");
+                            break;
+                        case ConnectionStatus.RECONNECTING:
+                            debug("retrying...");
+                            break;
+                        default:
+                            debug("connecting...");
+                            break;
+                    }
+                },
+                connected: () => {
+                    if (this.status === ConnectionStatus.RECONNECTING) {
+                        debug("reconnected");
+                    }
+                    else {
+                        debug("connected");
+                    }
+                    // let the other on connected listeners see what status we're in
+                    setImmediate(() => (this.status = ConnectionStatus.CONNECTED));
+                },
+                closed: (e) => {
+                    const event = e;
+                    if (event.wasClean) {
+                        debug("connection closed");
+                        return;
+                    }
+                    if (this.status === ConnectionStatus.CONNECTED) {
+                        this.status = ConnectionStatus.DISCONNECTED;
+                        debug("disconnected");
+                    }
+                },
+                error: (error) => {
+                    if (this.status == ConnectionStatus.RECONNECTING) {
+                        debug("failed to reconnect %o", { error });
+                    }
+                    else {
+                        debug("connection error %o", { error });
+                    }
+                },
+                ...options?.on,
+            },
+            ...options,
+        });
+    }
+    subscribe(payload, sink) {
+        let subscribePayload;
+        let removeConnectedListener;
+        if ((0, lodash_1.isFunction)(payload.variables)) {
+            // the caller wants us to re-evaluate the variables every time graphql-ws re-subscribes after reconnecting
+            subscribePayload = { ...payload, variables: payload.variables() };
+            removeConnectedListener = this._client.on("connected", () => {
+                if (this.status == ConnectionStatus.RECONNECTING) {
+                    // subscribePayload.variables is supposed to be readonly (it's not) and payload.variables could been re-assigned (it won't)
+                    subscribePayload.variables = payload.variables();
+                    debug("re-sending query %s", subscribePayload.query);
+                }
+            });
+        }
+        else {
+            subscribePayload = payload;
+        }
+        debug("sending query %s", subscribePayload.query);
+        const unsubscribe = this._client.subscribe(subscribePayload, {
+            next: (result) => sink.next(result),
+            error: (error) => sink.error(new errors_1.ClientError(subscribePayload, error)),
+            complete: () => sink.complete?.() ?? lodash_1.noop,
+        });
+        return () => {
+            removeConnectedListener?.();
+            unsubscribe();
+        };
+    }
+    subscribeUnwrap(payload, sink) {
+        const unsubscribe = this.subscribe(payload, {
+            ...sink,
+            next: (result) => {
+                if (result.errors) {
+                    unsubscribe();
+                    sink.error(new errors_1.ClientError(payload, result.errors));
+                    return;
+                }
+                if (!result.data) {
+                    sink.error(new errors_1.ClientError(payload, "We received a response without data"));
+                    unsubscribe();
+                    return;
+                }
+                sink.next(result.data);
+            },
+        });
+        return unsubscribe;
+    }
+    query(payload) {
+        return new Promise((resolve, reject) => {
+            this.subscribe(payload, { next: resolve, error: reject });
+        });
+    }
+    async queryUnwrap(payload) {
+        const result = await this.query(payload);
+        if (result.errors)
+            throw new errors_1.ClientError(payload, result.errors);
+        if (!result.data)
+            throw new errors_1.ClientError(payload, "We received a response without data");
+        return result.data;
+    }
+    async dispose() {
+        await this._client.dispose();
+    }
+}
+exports.Client = Client;
+//# sourceMappingURL=client.js.map