@gadgetinc/ggt 0.1.18 → 0.2.0

package/lib/commands/sync.d.ts

@@ -1,146 +0,0 @@
-import { FSWatcher } from "chokidar";
-import type { DebouncedFunc } from "lodash";
-import PQueue from "p-queue";
-import { BaseCommand } from "../utils/base-command";
-import type { Query } from "../utils/client";
-import { Client } from "../utils/client";
-import { FSIgnorer } from "../utils/fs-utils";
-import type { PublishFileSyncEventsMutation, PublishFileSyncEventsMutationVariables, RemoteFilesVersionQuery, RemoteFilesVersionQueryVariables, RemoteFileSyncEventsSubscription, RemoteFileSyncEventsSubscriptionVariables } from "../__generated__/graphql";
-export default class Sync extends BaseCommand<typeof Sync> {
-    static priority: number;
-    static summary: string;
-    static usage: string;
-    static description: string;
-    static args: {
-        directory: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
-    };
-    static flags: {
-        app: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        "file-push-delay": import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        "file-stability-threshold": import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        "file-poll-interval": import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-    };
-    static examples: string[];
-    requireUser: boolean;
-    /**
-     * The current status of the sync process.
-     */
-    status: SyncStatus;
-    /**
-     * The absolute path to the directory to sync files to.
-     */
-    dir: string;
-    /**
-     * A list of filepaths that have changed because of a remote file-sync event. This is used to avoid sending files that
-     * we recently received from a remote file-sync event.
-     */
-    recentRemoteChanges: Set<string>;
-    /**
-     * A FIFO async callback queue that ensures we process file-sync events in the order they occurred.
-     */
-    queue: PQueue<import("p-queue/dist/priority-queue").default, import("p-queue").DefaultAddOptions>;
-    /**
-     * A GraphQL client connected to the app's /edit/api/graphql-ws endpoint
-     */
-    client: Client;
-    /**
-     * Loads the .ignore file and provides methods for checking if a file should be ignored.
-     */
-    ignorer: FSIgnorer;
-    /**
-     * Watches the local filesystem for changes.
-     */
-    watcher: FSWatcher;
-    /**
-     * Holds information about the state of the local filesystem. It's persisted to `.gadget/sync.json`.
-     */
-    metadata: {
-        /**
-         * The app this filesystem is synced to.
-         */
-        app: string;
-        /**
-         * The last filesVersion that was successfully written to the filesystem. This is used to determine if the remote
-         * filesystem is ahead of the local one.
-         */
-        filesVersion: string;
-        /**
-         * The largest mtime that was seen on the local filesystem before `ggt sync` stopped. This is used to determine if
-         * the local filesystem has changed since the last sync.
-         *
-         * Note: This does not include the mtime of files that are ignored.
-         */
-        mtime: number;
-    };
-    /**
-     * A debounced function that enqueue's local file changes to be sent to Gadget.
-     */
-    publish: DebouncedFunc<() => void>;
-    /**
-     * Gracefully stops the sync.
-     */
-    stop: (error?: unknown) => Promise<void>;
-    /**
-     * Turns an absolute filepath into a relative one from {@linkcode dir}.
-     */
-    relative(to: string): string;
-    /**
-     * Combines path segments into an absolute filepath that starts at {@linkcode dir}.
-     */
-    absolute(...pathSegments: string[]): string;
-    /**
-     * Similar to {@linkcode relative} in that it turns a filepath into a relative one from {@linkcode dir}. However, it
-     * also changes any slashes to be posix/unix-like forward slashes, condenses repeated slashes into a single slash, and
-     * adds a trailing slash if the filepath is a directory.
-     *
-     * This is used when sending file-sync events to Gadget to ensure that the paths are consistent across platforms.
-     *
-     * @see https://www.npmjs.com/package/normalize-path
-     */
-    normalize(filepath: string, isDirectory: boolean): string;
-    /**
-     * Pretty-prints changed and deleted filepaths to the console.
-     *
-     * @param prefix The prefix to print before each line.
-     * @param changed The normalized paths that have changed.
-     * @param deleted The normalized paths that have been deleted.
-     * @param options.limit The maximum number of lines to print. Defaults to 10. If debug is enabled, this is ignored.
-     */
-    logPaths(prefix: string, changed: string[], deleted: string[], { limit }?: {
-        limit?: number | undefined;
-    }): void;
-    /**
-     * Initializes the sync process.
-     * - Ensures the directory exists.
-     * - Ensures the directory is empty or contains a `.gadget/sync.json` file.
-     * - Ensures an app is selected and that it matches the app the directory was previously synced to.
-     * - Ensures yarn v1 is installed.
-     * - Prompts the user how to resolve conflicts if the local filesystem has changed since the last sync.
-     */
-    init(): Promise<void>;
-    /**
-     * Runs the sync process until it is stopped or an error occurs.
-     */
-    run(): Promise<void>;
-    /**
-     * Enqueues a function that handles file-sync events onto the {@linkcode queue}.
-     *
-     * @param fn The function to enqueue.
-     */
-    private _enqueue;
-}
-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>;

package/lib/commands/whoami.d.ts

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

package/lib/index.d.ts

@@ -1 +0,0 @@
-export { run } from "@oclif/core";

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

@@ -1,64 +0,0 @@
-import type { Config, Interfaces } from "@oclif/core";
-import { Command } from "@oclif/core";
-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";
-export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)["baseFlags"] & T["flags"]>;
-export type Args<T extends typeof Command> = Interfaces.InferredArgs<T["args"]>;
-/**
- * BaseCommand is the base class for all commands in the Gadget CLI.
- */
-export declare abstract class BaseCommand<T extends typeof Command> 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;
-    /**
-     * Flags that are available to all commands.
-     *
-     * Short form should be capitalized.
-     */
-    static baseFlags: {
-        debug: Interfaces.BooleanFlag<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 underlying command is
-     * initialized and run.
-     */
-    readonly requireUser: boolean;
-    /**
-     * The parsed flags for the command.
-     */
-    flags: Flags<T>;
-    /**
-     * The parsed arguments for the command.
-     */
-    args: Args<T>;
-    constructor(argv: string[], config: Config);
-    /**
-     * Indicates whether the command is being run with the `-D/--debug` flag.
-     */
-    get debugEnabled(): boolean;
-    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>;
-    /**
-     * 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): Promise<never>;
-}

package/lib/utils/client.d.ts

@@ -1,42 +0,0 @@
-import type { ExecutionResult } from "graphql-ws";
-import type { JsonObject, SetOptional } from "type-fest";
-import { ClientError } from "./errors";
-declare enum ConnectionStatus {
-    CONNECTED = 0,
-    DISCONNECTED = 1,
-    RECONNECTING = 2
-}
-/**
- * Client is a GraphQL client connected to a Gadget application's /edit/api/graphql-ws endpoint.
- *
- * NOTE: In order to use the Client, the user must be logged in and an app must have been selected (`context.app` and
- * `context.session` must be set).
- */
-export declare class Client {
-    status: ConnectionStatus;
-    private _client;
-    constructor();
-    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 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/lib/utils/context.d.ts

@@ -1,57 +0,0 @@
-import type { Config } from "@oclif/core";
-export declare class Context {
-    /**
-     * A reference to oclif's {@linkcode Config}.
-     *
-     * By default, oclif's {@linkcode Config} is only available as an instance property on a Command, but we want to be
-     * able to access it from anywhere. To do this, we created this global variable that references the Config. It is set
-     * by the init function in the BaseCommand.
-     */
-    config: Config;
-    env: Env;
-    app?: App;
-    domains: {
-        app: string;
-        services: string;
-    };
-    private _session?;
-    private _user?;
-    private _availableApps;
-    private _request;
-    constructor();
-    get session(): string | undefined;
-    set session(value: string | undefined);
-    /**
-     * @returns The current user, or undefined if the user is not logged in.
-     */
-    getUser(): Promise<User | undefined>;
-    /**
-     * @returns The list of Gadget applications the current user has access to.
-     */
-    getAvailableApps(): Promise<App[]>;
-    setApp(appOrSlug?: App | string): Promise<void>;
-    clear(): void;
-}
-/**
- * Captures the name and nature of the environment
- */
-declare class Env {
-    get value(): string;
-    get productionLike(): boolean;
-    get developmentLike(): boolean;
-    get testLike(): boolean;
-    get developmentOrTestLike(): boolean;
-}
-export interface User {
-    id: string | number;
-    email: string;
-    name?: string;
-}
-export interface App {
-    id: string | number;
-    slug: string;
-    primaryDomain: string;
-    hasSplitEnvironments: boolean;
-}
-export declare const context: Context;
-export {};

package/lib/utils/errors.d.ts

@@ -1,100 +0,0 @@
-import type { GraphQLError } from "graphql";
-import type { CloseEvent, ErrorEvent } from "ws";
-import type Sync from "../commands/sync";
-import type { Payload } from "./client";
-/**
- * Base class for all errors.
- *
- * Inspired by gadget's GadgetError and oclif's PrettyPrintableError.
- */
-export declare abstract class BaseError extends Error {
-    /**
-     * A GGT_CLI_SOMETHING human/machine readable unique identifier for this error.
-     */
-    code: string;
-    /**
-     * The Sentry event ID for this error.
-     */
-    sentryEventId: `${string}-${string}-${string}-${string}-${string}`;
-    /**
-     * The underlying *thing* that caused this error.
-     */
-    cause?: any;
-    /**
-     * Assume the stack trace exists.
-     */
-    stack: string;
-    /**
-     * Indicates whether this error is considered a bug or not.
-     */
-    abstract isBug: IsBug;
-    constructor(code: string, message: string);
-    capture(): Promise<void>;
-    /**
-     * Turns this error into a user-friendly message that explains what went wrong and how to fix it. A good write up of what an error should
-     * look like can be found here: {@link https://clig.dev/#errors}
-     */
-    render(): string;
-    protected header(): string;
-    protected footer(): string;
-    protected abstract body(): string;
-}
-/**
- * Universal Error object to json blob serializer.
- * Wraps `serialize-error` with some handy stuff, like special support for Got HTTP errors
- */
-export declare function serializeError(error: Error | string | unknown): Record<string, any>;
-export declare enum IsBug {
-    YES = "yes",
-    NO = "no",
-    MAYBE = "maybe"
-}
-/**
- * Our "catch all" error. If this error is thrown, we almost certainly have a bug.
- *
- * Whenever possible, we should use a more specific error so that we can provide more useful information.
- */
-export declare class UnexpectedError extends BaseError {
-    cause: Error;
-    isBug: IsBug;
-    constructor(cause: Error);
-    protected body(): string;
-}
-export declare class ClientError extends BaseError {
-    readonly payload: Payload<any, any>;
-    cause: string | Error | readonly GraphQLError[] | CloseEvent | ErrorEvent;
-    isBug: IsBug;
-    constructor(payload: Payload<any, any>, cause: string | Error | readonly GraphQLError[] | CloseEvent | ErrorEvent);
-    body(): string;
-}
-export declare class YarnNotFoundError extends BaseError {
-    isBug: IsBug;
-    constructor();
-    protected body(): string;
-}
-export declare class FlagError<T extends {
-    name: string;
-    char?: string;
-} = {
-    name: string;
-    char?: string;
-}> extends BaseError {
-    #private;
-    readonly flag: T;
-    readonly description: string;
-    isBug: IsBug;
-    constructor(flag: T, description: string);
-    protected header(): string;
-    protected body(): string;
-}
-export declare class InvalidSyncFileError extends BaseError {
-    readonly cause: unknown;
-    readonly sync: Sync;
-    readonly app: string | undefined;
-    isBug: IsBug;
-    constructor(cause: unknown, sync: Sync, app: string | undefined);
-    protected body(): string;
-}
-export declare class InvalidSyncAppFlagError extends FlagError {
-    constructor(sync: Sync);
-}

package/lib/utils/flags.d.ts

@@ -1 +0,0 @@
-export declare const app: import("@oclif/core/lib/interfaces/parser").FlagDefinition<string, Record<string, unknown>>;

package/lib/utils/fs-utils.d.ts

@@ -1,21 +0,0 @@
-export declare class FSIgnorer {
-    private readonly _rootDir;
-    private readonly _alwaysIgnore;
-    readonly filepath: string;
-    private _ignorer;
-    constructor(_rootDir: string, _alwaysIgnore: string[]);
-    ignores(filepath: string): boolean;
-    reload(): void;
-}
-export interface WalkDirOptions {
-    ignorer?: FSIgnorer;
-}
-export declare function walkDir(dir: string, options?: WalkDirOptions): AsyncGenerator<string>;
-export declare function walkDirSync(dir: string, options?: WalkDirOptions): Generator<string>;
-export declare function isEmptyDirSync(dir: string, opts?: {
-    ignoreEnoent: boolean;
-}): boolean;
-export declare function isEmptyDir(dir: string, opts?: {
-    ignoreEnoent: boolean;
-}): Promise<boolean>;
-export declare function ignoreEnoent(error: any): void;

package/lib/utils/help.d.ts

@@ -1,19 +0,0 @@
-import type { Command } from "@oclif/core";
-import { CommandHelp as OclifCommandHelp, Help as OclifHelp } from "@oclif/core";
-export default class Help extends OclifHelp {
-    CommandHelpClass: typeof CommandHelp;
-}
-declare class CommandHelp extends OclifCommandHelp {
-    /**
-     * By default, oclif tries to format the description so that it fit's within the terminal window. However, if the description is already
-     * formatted with `dedent`, then the description gets mangled and the help output is not pretty.
-     *
-     * This overrides the default behavior to just use the description as-is if it already exists.
-     */
-    protected description(): string | undefined;
-    /**
-     * Same as above, but for examples.
-     */
-    protected examples(examples: string | string[] | Command.Example[] | undefined): string | undefined;
-}
-export {};

package/lib/utils/promise.d.ts

@@ -1,35 +0,0 @@
-/**
- * Long lived references to Promises stress the garbage collector in JS. Instead of caching resolved Promises, we cache
- * these little data objects instead which reference the resolution or rejection of the Promise, allowing the Promise
- * object to be free'd.
- */
-export declare class PromiseWrapper<T> {
-    resolution?: T;
-    rejection?: any;
-    pendingPromise?: Promise<T>;
-    constructor(promise: Promise<T>);
-    unwrap(): Promise<T>;
-}
-/**
- * A promise that can be resolved or rejected from outside its callback.
- *
- * This is typically used when you want to await a promise that is resolved or rejected from outside the current scope,
- * such as from an event handler.
- *
- * @example
- * const signal = new PromiseSignal();
- * process.on("SIGINT", () => {
- *  signal.resolve();
- * });
- * await signal;
- */
-export declare class PromiseSignal<T = void> implements Promise<T> {
-    readonly [Symbol.toStringTag]: string;
-    resolve: (value: T | PromiseLike<T>) => void;
-    reject: (reason?: any) => void;
-    private _promise;
-    constructor();
-    then<R = T, E = never>(onfulfilled?: (value: T) => R | PromiseLike<R>, onrejected?: (reason: any) => E | PromiseLike<E>): Promise<R | E>;
-    catch<E = never>(onrejected?: (reason: any) => E | PromiseLike<E>): Promise<T | E>;
-    finally(onfinally?: () => void): Promise<T>;
-}

package/lib/utils/sleep.d.ts

@@ -1,5 +0,0 @@
-export declare function sleep(ms?: number): Promise<void>;
-export declare function sleepUntil(fn: () => boolean, { interval, timeout }?: {
-    interval?: number | undefined;
-    timeout?: number | undefined;
-}): Promise<void>;