@dxos/protocols 0.1.0

package/dist/src/proto/gen/dxos/config.d.ts

@@ -0,0 +1,849 @@
+import substitutions from "../../substitutions";
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/config.proto}
+ */
+export interface Config {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    version?: number;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    package?: Package;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    runtime?: Runtime;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/config.proto}
+ */
+export interface Package {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    license?: string;
+    repos?: Repo[];
+    modules?: Module[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/config.proto}
+ */
+export interface Repo {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    name?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    url?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    version?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/config.proto}
+ */
+export interface Module {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    name?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    type?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    displayName?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    description?: string;
+    tags?: string[];
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    bundle?: Uint8Array;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    build?: Module.Build;
+    repos?: Repo[];
+    /**
+     * The data will be validated based on the type when being published.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    record?: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
+}
+export declare namespace Module {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/config.proto}
+     */
+    interface Build {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        command?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        outdir?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        version?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        tag?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/config.proto}
+ */
+export interface Runtime {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    client?: Runtime.Client;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    app?: Runtime.App;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    cli?: Runtime.CLI;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    props?: Runtime.Props;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    services?: Runtime.Services;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    system?: Runtime.System;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    kube?: Runtime.Kube;
+}
+export declare namespace Runtime {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/config.proto}
+     */
+    interface Client {
+        /**
+         * Options:
+         *   - (env) = "DEBUG"
+         *   - proto3_optional = true
+         */
+        debug?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        storage?: Runtime.Client.Storage;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        enableSnapshots?: boolean;
+        /**
+         * Milliseconds
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        snapshotInterval?: number;
+        /**
+         * Milliseconds
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        invitationExpiration?: number;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        mode?: Runtime.Client.Mode;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        remoteSource?: string;
+    }
+    namespace Client {
+        /**
+         * Whether the client services are local with ClientServiceHost or remote and need to be accessed via ClientServiceProxy. Defaults to AUTOMATIC.
+         *
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        enum Mode {
+            AUTOMATIC = 0,
+            LOCAL = 1,
+            REMOTE = 2
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Storage {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            persistent?: boolean;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            keyStorage?: Runtime.Client.Storage.StorageDriver;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            storageType?: Runtime.Client.Storage.StorageDriver;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            path?: string;
+        }
+        namespace Storage {
+            /**
+             * Defined in:
+             *   {@link file://./../../dxos/config.proto}
+             */
+            enum StorageDriver {
+                RAM = 0,
+                IDB = 1,
+                CHROME = 2,
+                FIREFOX = 3,
+                NODE = 4,
+                LEVELJS = 11,
+                JSONDOWN = 12
+            }
+        }
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/config.proto}
+     */
+    interface App {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        org?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        theme?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        website?: string;
+        /**
+         * Options:
+         *   - (env) = "PUBLIC_URL"
+         *   - proto3_optional = true
+         */
+        publicUrl?: string;
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/config.proto}
+     */
+    interface CLI {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        nodePath?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        app?: Runtime.CLI.AppServe;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        console?: Runtime.CLI.Package;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        mdns?: Runtime.CLI.Package;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        signal?: Runtime.CLI.Package;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        npmClient?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        channel?: string;
+    }
+    namespace CLI {
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface AppServe {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            serve?: Runtime.CLI.AppServe.Serve;
+        }
+        namespace AppServe {
+            /**
+             * Defined in:
+             *   {@link file://./../../dxos/config.proto}
+             */
+            interface Serve {
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                config?: string;
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                loginApp?: string;
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                keyPhrase?: string;
+            }
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Package {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            package?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            channel?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            bin?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            config?: string;
+        }
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/config.proto}
+     */
+    interface Props {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        title?: string;
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/config.proto}
+     */
+    interface System {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        debug?: string;
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/config.proto}
+     */
+    interface Kube {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        host?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        port?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        autoupdate?: Runtime.Kube.Autoupdate;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        https?: Runtime.Kube.Https;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        p2p?: Runtime.Kube.P2P;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        confhost?: string;
+        env?: string[];
+        alias?: string[];
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        monitoring?: Runtime.Kube.Monitoring;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        trace?: Runtime.Kube.Trace;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        telemetry?: Runtime.Kube.Telemetry;
+    }
+    namespace Kube {
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Autoupdate {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            enabled?: boolean;
+            /**
+             * Seconds
+             *
+             * Options:
+             *   - proto3_optional = true
+             */
+            interval?: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Https {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            enabled?: boolean;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            port?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            email?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            certfile?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            keyfile?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            dnsprovider?: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface P2P {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            privateKey?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            port?: string;
+            bootstrap?: string[];
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Monitoring {
+            enabled: boolean;
+            endpoint: string;
+            /**
+             * Seconds
+             */
+            interval: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Trace {
+            disabled: boolean;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Telemetry {
+            disabled: boolean;
+        }
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/config.proto}
+     */
+    interface Services {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        kube?: Runtime.Services.Kube;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        app?: Runtime.Services.AppServer;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        dxns?: Runtime.Services.Dxns;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        ipfs?: Runtime.Services.Ipfs;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        signal?: Runtime.Services.Signal;
+        ice?: Runtime.Services.Ice[];
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        machine?: Runtime.Services.Machine;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        bot?: Runtime.Services.BotFactory;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        publisher?: Runtime.Services.Publisher;
+    }
+    namespace Services {
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Kube {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            endpoints?: Runtime.Services.Kube.Endpoints;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            publicUrl?: string;
+        }
+        namespace Kube {
+            /**
+             * Defined in:
+             *   {@link file://./../../dxos/config.proto}
+             */
+            interface Endpoints {
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                logs?: string;
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                services?: string;
+                /**
+                 * Options:
+                 *   - proto3_optional = true
+                 */
+                cert?: string;
+            }
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface AppServer {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            prefix?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            server?: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Dxns {
+            /**
+             * DXNS endpoint.
+             *
+             * Options:
+             *   - proto3_optional = true
+             */
+            server?: string;
+            /**
+             * Substrate account URI. This is a secret.
+             * KUBEs do not serve this with the config but we store it in profile.yml.
+             *
+             * TODO(dmaretskyi): Deprecate this and move it to keyring.
+             *
+             * Options:
+             *   - proto3_optional = true
+             */
+            accountUri?: string;
+            /**
+             * Public Polkadot Address.
+             *
+             * Options:
+             *   - proto3_optional = true
+             */
+            address?: string;
+            /**
+             * Public address of a DXNS Account.
+             *
+             * Options:
+             *   - proto3_optional = true
+             */
+            account?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            faucet?: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Ipfs {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            server?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            gateway?: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Signal {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            server?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            api?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            status?: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Ice {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            urls?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            username?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            credential?: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Machine {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            doAccessToken?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            githubAccessToken?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            githubUsername?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            dnsDomain?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            npmAccessToken?: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface BotFactory {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            topic?: string;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            persistent?: boolean;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            retryAttempts?: number;
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            retryInterval?: number;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../dxos/config.proto}
+         */
+        interface Publisher {
+            /**
+             * Options:
+             *   - proto3_optional = true
+             */
+            server?: string;
+        }
+    }
+}
+//# sourceMappingURL=config.d.ts.map