@gadgetinc/ggt 0.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Gadget Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,177 @@
+<div align="center">
+  <h1>ggt</h1>
+  The command-line interface for <a href="https://gadget.dev">Gadget</a>
+
+  <br>
+  <br>
+
+<i>Status: alpha -- please report any issues to the [issue tracker](https://github.com/gadget-inc/ggt/issues?q=is%3Aissue+is%3Aopen) here so we can fix them!</i>
+
+</div>
+
+## Intro
+
+`ggt` is the command line interface for the Gadget platform, providing additional functionality for working with your Gadget applications using your existing tools on your machine. `ggt` isn't required for building end-to-end Gadget apps but supports syncing files locally (and more soon) for your preferred coding experience.
+
+## Quick Start
+
+Run the following to sync a `my-app.gadget.app` application to the `~/gadget/my-app` on your local machine:
+
+```sh
+npx @gadgetinc/ggt sync --app my-app ~/gadget/my-app
+```
+
+With this running in the background, your local `~/gadget/my-app` folder will become two-way synced with your application's filesystem in Gadget's cloud. Changes you make locally will be immediately reflected by your application's API and actions if you re-run them.
+
+## Usage
+
+```sh-session
+$ npm install -g @gadgetinc/ggt
+$ ggt COMMAND
+running command...
+$ ggt --version
+@gadgetinc/ggt/0.0.0 darwin-arm64 node-v18.0.0
+$ ggt help [COMMAND]
+USAGE
+  $ ggt COMMAND
+...
+```
+
+## Commands
+
+  <!-- commands -->
+
+- [`ggt sync --app <name> [DIRECTORY]`](#ggt-sync---app-name-directory)
+- [`ggt help [COMMAND]`](#ggt-help-command)
+- [`ggt login`](#ggt-login)
+- [`ggt logout`](#ggt-logout)
+- [`ggt whoami`](#ggt-whoami)
+
+### `ggt sync --app <name> [DIRECTORY]`
+
+Sync your Gadget application's source code to and from your local filesystem.
+
+```
+USAGE
+  $ ggt sync --app <name> [DIRECTORY]
+
+ARGUMENTS
+  DIRECTORY  [default: .] The directory to sync files to. If the directory doesn't exist, it will be created.
+
+DESCRIPTION
+  Sync provides the ability to sync your Gadget application's source code to and from your local
+  filesystem. While `ggt sync` is running, local file changes are immediately reflected within
+  Gadget, while files that are changed remotely are immediately saved to your local filesystem.
+
+  Use cases for this include:
+    * Developing locally with your own editor like VSCode (https://code.visualstudio.com/)
+    * Storing your source code in a Git repository like GitHub (https://github.com/)
+
+  Sync includes the concept of a `.ignore` file. This file can contain a list of files and
+  directories that won't be sent to Gadget when syncing.
+
+  The following files and directories are always ignored:
+    * .gadget
+    * .ggt
+    * .git
+    * node_modules
+
+  Note:
+    * Sync does not support node_modules, so you will have to run `npm install` yourself.
+    * Since file changes are immediately reflected in Gadget, avoid the following while `ggt sync` is running:
+        * Deleting all your files
+        * Moving all your files to a different directory
+
+EXAMPLES
+  $ ggt sync --app my-app ~/gadget/my-app
+  Ready
+  Received
+  ← routes/GET.js
+  ← user/signUp/signIn.js
+  Sent
+  → routes/GET.js
+  ^C Stopping... (press Ctrl+C again to force)
+  Done
+
+  # These are equivalent
+
+    $ ggt sync -A my-app
+    $ ggt sync --app my-app
+    $ ggt sync --app my-app.gadget.app
+    $ ggt sync --app https://my-app.gadget.app
+    $ ggt sync --app https://my-app.gadget.app/edit
+```
+
+_See code: [src/commands/sync.ts](https://github.com/gadget-inc/ggt/blob/v0.0.0-alpha.0/src/commands/sync.ts)_
+
+### `ggt help [COMMAND]`
+
+Display help for ggt.
+
+```
+USAGE
+  $ ggt help [COMMAND]
+
+ARGUMENTS
+  COMMAND  The command to show help for.
+```
+
+_See code: [src/commands/help.ts](https://github.com/gadget-inc/ggt/blob/v0.0.0-alpha.0/src/commands/help.ts)_
+
+### `ggt login`
+
+Log in to your account.
+
+```
+USAGE
+  $ ggt login
+
+EXAMPLES
+  $ ggt login
+  Your browser has been opened. Please log in to your account.
+  Hello, Jane Doe (jane@example.com)
+```
+
+_See code: [src/commands/login.ts](https://github.com/gadget-inc/ggt/blob/v0.0.0-alpha.0/src/commands/login.ts)_
+
+### `ggt logout`
+
+Log out of your account.
+
+```
+USAGE
+  $ ggt logout
+
+EXAMPLES
+  $ ggt logout
+  Goodbye
+```
+
+_See code: [src/commands/logout.ts](https://github.com/gadget-inc/ggt/blob/v0.0.0-alpha.0/src/commands/logout.ts)_
+
+### `ggt whoami`
+
+Show the name and email address of the currently logged in user.
+
+```
+USAGE
+  $ ggt whoami
+
+EXAMPLES
+  $ ggt whoami
+  You are logged in as Jane Doe (jane@example.com)
+```
+
+_See code: [src/commands/whoami.ts](https://github.com/gadget-inc/ggt/blob/v0.0.0-alpha.0/src/commands/whoami.ts)_
+
+<!-- commandsstop -->
+
+## Global Flags
+
+### App
+
+The `--app` flag, shorthand `-A`, specifies the Gadget application the command applies to.
+
+### Debug
+
+The `--debug` flag, shorthand `-D`, enables verbose output for debugging purposes.

package/bin/dev

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+const path = require("path");
+
+process.env.NODE_ENV = "development";
+process.env.GGT_ENV = "development";
+
+// store files in the project's tmp directory
+// https://github.com/oclif/core/blob/main/src/config/config.ts#L171
+process.env["GGT_CONFIG_DIR"] = path.join(__dirname, "..", "tmp", "config");
+process.env["GGT_CACHE_DIR"] = path.join(__dirname, "..", "tmp", "cache");
+process.env["GGT_DATA_DIR"] = path.join(__dirname, "..", "tmp", "data");
+
+require("ts-node").register({ project: path.join(__dirname, "..", "tsconfig.json"), swc: true });
+
+const oclif = require("@oclif/core");
+
+process.on("unhandledRejection", oclif.Errors.handle);
+
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle);

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+const oclif = require("@oclif/core");
+
+process.on("unhandledRejection", oclif.Errors.handle);
+
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle);

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/commands/help.d.ts

@@ -0,0 +1,16 @@
+import { Command } from "@oclif/core";
+/**
+ * Copied from @oclif/plugin-help. Uses our own {@link Help} template class instead of the one from @oclif/core.
+ *
+ * @see https://github.com/oclif/plugin-help/blob/67b580570257b45e92d3a04d50bf2a432c59afe3/src/commands/help.ts
+ */
+export default class HelpCommand extends Command {
+    static strict: boolean;
+    static summary: string;
+    static args: {
+        name: string;
+        required: boolean;
+        description: string;
+    }[];
+    run(): Promise<void>;
+}

package/dist/commands/help.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const help_1 = tslib_1.__importDefault(require("../lib/help"));
+/**
+ * Copied from @oclif/plugin-help. Uses our own {@link Help} template class instead of the one from @oclif/core.
+ *
+ * @see https://github.com/oclif/plugin-help/blob/67b580570257b45e92d3a04d50bf2a432c59afe3/src/commands/help.ts
+ */
+class HelpCommand extends core_1.Command {
+    async run() {
+        const { argv } = await this.parse();
+        const help = new help_1.default(this.config, { all: true });
+        await help.showHelp(argv);
+    }
+}
+exports.default = HelpCommand;
+Object.defineProperty(HelpCommand, "strict", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: false
+});
+Object.defineProperty(HelpCommand, "summary", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: "Display help for ggt."
+});
+Object.defineProperty(HelpCommand, "args", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: [{ name: "command", required: false, description: "The command to show help for." }]
+});
+//# sourceMappingURL=help.js.map

package/dist/commands/help.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help.js","sourceRoot":"","sources":["../../src/commands/help.ts"],"names":[],"mappings":";;;AAAA,sCAAsC;AACtC,+DAA+B;AAE/B;;;;GAIG;AACH,MAAqB,WAAY,SAAQ,cAAO;IAO9C,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QAClD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;;AAXH,8BAYC;AAXC;;;;WAAyB,KAAK;GAAC;AAE/B;;;;WAA0B,uBAAuB;GAAC;AAElD;;;;WAAuB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,EAAE,+BAA+B,EAAE,CAAC;GAAC","sourcesContent":["import { Command } from \"@oclif/core\";\nimport Help from \"../lib/help\";\n\n/**\n * Copied from @oclif/plugin-help. Uses our own {@link Help} template class instead of the one from @oclif/core.\n *\n * @see https://github.com/oclif/plugin-help/blob/67b580570257b45e92d3a04d50bf2a432c59afe3/src/commands/help.ts\n */\nexport default class HelpCommand extends Command {\n  static override strict = false;\n\n  static override summary = \"Display help for ggt.\";\n\n  static override args = [{ name: \"command\", required: false, description: \"The command to show help for.\" }];\n\n  async run(): Promise<void> {\n    const { argv } = await this.parse();\n    const help = new Help(this.config, { all: true });\n    await help.showHelp(argv);\n  }\n}\n"]}

package/dist/commands/login.d.ts

@@ -0,0 +1,7 @@
+import { BaseCommand } from "../lib/base-command";
+export default class Login extends BaseCommand {
+    static summary: string;
+    static usage: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/login.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const ts_dedent_1 = tslib_1.__importDefault(require("ts-dedent"));
+const base_command_1 = require("../lib/base-command");
+class Login extends base_command_1.BaseCommand {
+    async run() {
+        await this.login();
+    }
+}
+exports.default = Login;
+Object.defineProperty(Login, "summary", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: "Log in to your account."
+});
+Object.defineProperty(Login, "usage", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: "login"
+});
+Object.defineProperty(Login, "examples", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: [
+        (0, ts_dedent_1.default) `
+      $ ggt login
+      Your browser has been opened. Please log in to your account.
+      Hello, Jane Doe (jane@example.com)
+    `,
+    ]
+});
+//# sourceMappingURL=login.js.map

package/dist/commands/login.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"login.js","sourceRoot":"","sources":["../../src/commands/login.ts"],"names":[],"mappings":";;;AAAA,kEAA+B;AAC/B,sDAAkD;AAElD,MAAqB,KAAM,SAAQ,0BAAW;IAa5C,KAAK,CAAC,GAAG;QACP,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;;AAfH,wBAgBC;AAfC;;;;WAA0B,yBAAyB;GAAC;AAEpD;;;;WAAwB,OAAO;GAAC;AAEhC;;;;WAA2B;QACzB,IAAA,mBAAM,EAAA;;;;KAIL;KACF;GAAC","sourcesContent":["import dedent from \"ts-dedent\";\nimport { BaseCommand } from \"../lib/base-command\";\n\nexport default class Login extends BaseCommand {\n  static override summary = \"Log in to your account.\";\n\n  static override usage = \"login\";\n\n  static override examples = [\n    dedent`\n      $ ggt login\n      Your browser has been opened. Please log in to your account.\n      Hello, Jane Doe (jane@example.com)\n    `,\n  ];\n\n  async run(): Promise<void> {\n    await this.login();\n  }\n}\n"]}

package/dist/commands/logout.d.ts

@@ -0,0 +1,7 @@
+import { BaseCommand } from "../lib/base-command";
+export default class Logout extends BaseCommand {
+    static summary: string;
+    static usage: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

package/dist/commands/logout.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const ts_dedent_1 = tslib_1.__importDefault(require("ts-dedent"));
+const base_command_1 = require("../lib/base-command");
+class Logout extends base_command_1.BaseCommand {
+    // eslint-disable-next-line @typescript-eslint/require-await
+    async run() {
+        if (this.logout()) {
+            this.log("Goodbye");
+        }
+        else {
+            this.log("You are not logged in");
+        }
+    }
+}
+exports.default = Logout;
+Object.defineProperty(Logout, "summary", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: "Log out of your account."
+});
+Object.defineProperty(Logout, "usage", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: "logout"
+});
+Object.defineProperty(Logout, "examples", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: [
+        (0, ts_dedent_1.default) `
+      $ ggt logout
+      Goodbye
+    `,
+    ]
+});
+//# sourceMappingURL=logout.js.map

package/dist/commands/logout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logout.js","sourceRoot":"","sources":["../../src/commands/logout.ts"],"names":[],"mappings":";;;AAAA,kEAA+B;AAC/B,sDAAkD;AAElD,MAAqB,MAAO,SAAQ,0BAAW;IAY7C,4DAA4D;IAC5D,KAAK,CAAC,GAAG;QACP,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YACjB,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SACrB;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;SACnC;IACH,CAAC;;AAnBH,yBAoBC;AAnBC;;;;WAA0B,0BAA0B;GAAC;AAErD;;;;WAAwB,QAAQ;GAAC;AAEjC;;;;WAA2B;QACzB,IAAA,mBAAM,EAAA;;;KAGL;KACF;GAAC","sourcesContent":["import dedent from \"ts-dedent\";\nimport { BaseCommand } from \"../lib/base-command\";\n\nexport default class Logout extends BaseCommand {\n  static override summary = \"Log out of your account.\";\n\n  static override usage = \"logout\";\n\n  static override examples = [\n    dedent`\n      $ ggt logout\n      Goodbye\n    `,\n  ];\n\n  // eslint-disable-next-line @typescript-eslint/require-await\n  async run(): Promise<void> {\n    if (this.logout()) {\n      this.log(\"Goodbye\");\n    } else {\n      this.log(\"You are not logged in\");\n    }\n  }\n}\n"]}

package/dist/commands/sync.d.ts

@@ -0,0 +1,64 @@
+import type { OptionFlag } from "@oclif/core/lib/interfaces";
+import { FSWatcher } from "chokidar";
+import type { DebouncedFunc } from "lodash";
+import PQueue from "p-queue";
+import { BaseCommand } from "../lib/base-command";
+import type { Query } from "../lib/client";
+import { Ignorer } from "../lib/fs-utils";
+import type { PublishFileSyncEventsMutation, PublishFileSyncEventsMutationVariables, RemoteFilesVersionQuery, RemoteFilesVersionQueryVariables, RemoteFileSyncEventsSubscription, RemoteFileSyncEventsSubscriptionVariables } from "../__generated__/graphql";
+export default class Sync extends BaseCommand {
+    static priority: number;
+    static summary: string;
+    static usage: string;
+    static description: string;
+    static args: {
+        name: string;
+        description: string;
+        default: string;
+    }[];
+    static flags: {
+        "file-push-delay": OptionFlag<number>;
+        "file-stability-threshold": OptionFlag<number>;
+        "file-poll-interval": OptionFlag<number>;
+    };
+    static examples: string[];
+    readonly requireApp = true;
+    status: SyncStatus;
+    dir: string;
+    recentWrites: Set<unknown>;
+    filePushDelay: number;
+    queue: PQueue<import("p-queue/dist/priority-queue").default, import("p-queue").DefaultAddOptions>;
+    ignorer: Ignorer;
+    watcher: FSWatcher;
+    metadata: {
+        lastWritten: {
+            filesVersion: string;
+            mtime: number;
+        };
+    };
+    publish: DebouncedFunc<() => void>;
+    stop: (error?: unknown) => Promise<void>;
+    relative(to: string): string;
+    absolute(...pathSegments: string[]): string;
+    normalize(filepath: string): string;
+    logPaths(filepaths: string[], { limit, sep }?: {
+        limit?: number | undefined;
+        sep?: string | undefined;
+    }): void;
+    init(): Promise<void>;
+    run(): Promise<void>;
+}
+export declare enum SyncStatus {
+    STARTING = 0,
+    RUNNING = 1,
+    STOPPING = 2,
+    STOPPED = 3
+}
+export declare enum Action {
+    CANCEL = "Cancel (Ctrl+C)",
+    MERGE = "Merge local files with remote ones",
+    RESET = "Reset local files to remote ones"
+}
+export declare const REMOTE_FILE_SYNC_EVENTS_SUBSCRIPTION: Query<RemoteFileSyncEventsSubscription, RemoteFileSyncEventsSubscriptionVariables>;
+export declare const REMOTE_FILES_VERSION_QUERY: Query<RemoteFilesVersionQuery, RemoteFilesVersionQueryVariables>;
+export declare const PUBLISH_FILE_SYNC_EVENTS_MUTATION: Query<PublishFileSyncEventsMutation, PublishFileSyncEventsMutationVariables>;