@dxos/protocols 0.1.0

package/src/proto/gen/dxos/service/scheduler.ts

@@ -0,0 +1,337 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../../substitutions";
+import * as dxos_bot from "../bot";
+import * as dxos_client from "../client";
+import * as dxos_config from "../config";
+import * as dxos_devtools_host from "../devtools/host";
+import * as dxos_devtools_swarmLog from "../devtools/swarmLog";
+import * as dxos_echo_feed from "../echo/feed";
+import * as dxos_echo_metadata from "../echo/metadata";
+import * as dxos_echo_model_messenger from "../echo/model/messenger";
+import * as dxos_echo_model_object from "../echo/model/object";
+import * as dxos_echo_model_text from "../echo/model/text";
+import * as dxos_echo_service from "../echo/service";
+import * as dxos_echo_snapshot from "../echo/snapshot";
+import * as dxos_echo_timeframe from "../echo/timeframe";
+import * as dxos_halo_credentials from "../halo/credentials";
+import * as dxos_halo_credentials_auth from "../halo/credentials/auth";
+import * as dxos_halo_credentials_greet from "../halo/credentials/greet";
+import * as dxos_halo_credentials_identity from "../halo/credentials/identity";
+import * as dxos_halo_credentials_party from "../halo/credentials/party";
+import * as dxos_halo_invitations from "../halo/invitations";
+import * as dxos_halo_keyring from "../halo/keyring";
+import * as dxos_halo_keys from "../halo/keys";
+import * as dxos_halo_signed from "../halo/signed";
+import * as dxos_iframe from "../iframe";
+import * as dxos_keys from "../keys";
+import * as dxos_mesh_bridge from "../mesh/bridge";
+import * as dxos_mesh_broadcast from "../mesh/broadcast";
+import * as dxos_mesh_messaging from "../mesh/messaging";
+import * as dxos_mesh_presence from "../mesh/presence";
+import * as dxos_mesh_protocol from "../mesh/protocol";
+import * as dxos_mesh_replicator from "../mesh/replicator";
+import * as dxos_mesh_signal from "../mesh/signal";
+import * as dxos_mesh_swarm from "../mesh/swarm";
+import * as dxos_registry from "../registry";
+import * as dxos_rpc from "../rpc";
+import * as dxos_service_publisher from "./publisher";
+import * as dxos_type from "../type";
+import * as example_testing_data from "../../example/testing/data";
+import * as example_testing_rpc from "../../example/testing/rpc";
+import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export enum State {
+    INVALID = 0,
+    STOPPED = 1,
+    STARTING = 2,
+    RUNNING = 3,
+    FAILING = 4
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface Bot {
+    /**
+     * Scheduler
+     */
+    id: Uint8Array;
+    /**
+     * Current state.
+     */
+    state: State;
+    /**
+     * Desired state.
+     */
+    desiredState: State;
+    /**
+     * Omitted when returned from the Query RPC.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    spec?: Bot.Spec;
+    /**
+     * Omitted when returned from the Query RPC.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    stats?: Bot.Stats;
+    /**
+     * Identity key of the bot profile.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    identityKey?: Uint8Array;
+}
+export namespace Bot {
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/service/scheduler.proto}
+     */
+    export interface Spec {
+        /**
+         * URL to the bot executable. KUBEs support file:// and ipfs:// urls.
+         */
+        executable: string;
+        echo: Bot.Spec.Echo;
+    }
+    export namespace Spec {
+        /**
+         * Defined in:
+         *   {@link file://./../../../dxos/service/scheduler.proto}
+         */
+        export interface Echo {
+            partyKey: Uint8Array;
+            invitation: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
+        }
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../../dxos/service/scheduler.proto}
+     */
+    export interface Stats {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        pid?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        executableDownloaded?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        created?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        started?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        stopped?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        lastPingTime?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        exitCode?: number;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        errorMessage?: string;
+        cpuUsage: Bot.Stats.CPUUsage;
+        memoryUsage: Bot.Stats.MemoryUsage;
+        diskUsage: Bot.Stats.DiskUsage;
+        networkUsage: Bot.Stats.NetworkUsage;
+        echo: Bot.Stats.Echo;
+    }
+    export namespace Stats {
+        /**
+         * Defined in:
+         *   {@link file://./../../../dxos/service/scheduler.proto}
+         */
+        export interface NetworkUsage {
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../../dxos/service/scheduler.proto}
+         */
+        export interface CPUUsage {
+            cores: number;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../../dxos/service/scheduler.proto}
+         */
+        export interface MemoryUsage {
+            bytes: string;
+        }
+        /**
+         * Defined in:
+         *   {@link file://./../../../dxos/service/scheduler.proto}
+         */
+        export interface DiskUsage {
+            bytes: string;
+        }
+        /**
+         * Echo stats.
+         *
+         * Defined in:
+         *   {@link file://./../../../dxos/service/scheduler.proto}
+         */
+        export interface Echo {
+        }
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface QueryResponse {
+    services?: Bot[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface ServiceRequest {
+    serviceId: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface Request {
+    serviceId: Uint8Array;
+    payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface Reply {
+    payload: ReturnType<(typeof substitutions)["google.protobuf.Any"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface CreateRequest {
+    spec: Bot.Spec;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    desiredState?: State;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface Progress {
+    state: Bot;
+}
+/**
+ * Exposed by bot controller to clients. Allows creation and management of bots.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface BotController {
+    /**
+     * Enumerate all services.
+     */
+    query: (request: void) => Promise<QueryResponse>;
+    /**
+     * Query information about a specific service
+     */
+    describe: (request: ServiceRequest) => Promise<Bot>;
+    /**
+     * Create a new service.
+     */
+    create: (request: CreateRequest) => Stream<Progress>;
+    /**
+     * Remove a service with its identity and persistent storage.
+     */
+    remove: (request: ServiceRequest) => Promise<void>;
+    /**
+     * Start the bot.
+     */
+    start: (request: ServiceRequest) => Stream<Progress>;
+    /**
+     * Start the bot.
+     */
+    stop: (request: ServiceRequest) => Stream<Progress>;
+    /**
+     * Start the bot.
+     */
+    restart: (request: ServiceRequest) => Stream<Progress>;
+    /**
+     * Issue an RPC request to the bot instance.
+     */
+    call: (request: Request) => Stream<Reply>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface BotConfig {
+    spec: Bot.Spec.Echo;
+    clientConfig: dxos_config.Config;
+}
+/**
+ * Internal service exposed by bot to the bot controller.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface BotService {
+    /**
+     * Issue an RPC request to the bot instance.
+     */
+    call: (request: Request) => Stream<Reply>;
+    /**
+     * Called by the bot controller to verify that the bot is functional.
+     */
+    healthcheck: (request: void) => Promise<void>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface Report {
+    /**
+     * Identity key of the bot profile.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    identityKey?: Uint8Array;
+}
+/**
+ * Internal service exposed by bot controller to the bot.
+ *
+ * Defined in:
+ *   {@link file://./../../../dxos/service/scheduler.proto}
+ */
+export interface BotHost {
+    getConfig: (request: void) => Promise<BotConfig>;
+    sendReport: (request: Report) => Promise<void>;
+}

package/src/proto/gen/dxos/type.ts

@@ -0,0 +1,206 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../substitutions";
+import * as dxos_bot from "./bot";
+import * as dxos_client from "./client";
+import * as dxos_config from "./config";
+import * as dxos_devtools_host from "./devtools/host";
+import * as dxos_devtools_swarmLog from "./devtools/swarmLog";
+import * as dxos_echo_feed from "./echo/feed";
+import * as dxos_echo_metadata from "./echo/metadata";
+import * as dxos_echo_model_messenger from "./echo/model/messenger";
+import * as dxos_echo_model_object from "./echo/model/object";
+import * as dxos_echo_model_text from "./echo/model/text";
+import * as dxos_echo_service from "./echo/service";
+import * as dxos_echo_snapshot from "./echo/snapshot";
+import * as dxos_echo_timeframe from "./echo/timeframe";
+import * as dxos_halo_credentials from "./halo/credentials";
+import * as dxos_halo_credentials_auth from "./halo/credentials/auth";
+import * as dxos_halo_credentials_greet from "./halo/credentials/greet";
+import * as dxos_halo_credentials_identity from "./halo/credentials/identity";
+import * as dxos_halo_credentials_party from "./halo/credentials/party";
+import * as dxos_halo_invitations from "./halo/invitations";
+import * as dxos_halo_keyring from "./halo/keyring";
+import * as dxos_halo_keys from "./halo/keys";
+import * as dxos_halo_signed from "./halo/signed";
+import * as dxos_iframe from "./iframe";
+import * as dxos_keys from "./keys";
+import * as dxos_mesh_bridge from "./mesh/bridge";
+import * as dxos_mesh_broadcast from "./mesh/broadcast";
+import * as dxos_mesh_messaging from "./mesh/messaging";
+import * as dxos_mesh_presence from "./mesh/presence";
+import * as dxos_mesh_protocol from "./mesh/protocol";
+import * as dxos_mesh_replicator from "./mesh/replicator";
+import * as dxos_mesh_signal from "./mesh/signal";
+import * as dxos_mesh_swarm from "./mesh/swarm";
+import * as dxos_registry from "./registry";
+import * as dxos_rpc from "./rpc";
+import * as dxos_service_publisher from "./service/publisher";
+import * as dxos_service_scheduler from "./service/scheduler";
+import * as example_testing_data from "../example/testing/data";
+import * as example_testing_rpc from "../example/testing/rpc";
+import * as google_protobuf from "../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface Repo {
+    name: string;
+    url: string;
+    version: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface App {
+    /**
+     * Optional **semver 2.0** compliant record version.
+     * Should conform to the semver regex (see https://semver.org/).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    version?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    license?: string;
+    repos?: Repo[];
+    /**
+     * App bundle content Id in the CID v0 format (https://docs.ipfs.io/concepts/content-addressing/#identifier-formats).
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    bundle?: Uint8Array;
+    web?: App.Web;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    extension?: dxos_registry.Record.Extension;
+}
+export namespace App {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/type.proto}
+     */
+    export interface Web {
+        /**
+         * Relative path in resource to entrypoint, defaults to index.html.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        indexFile?: string;
+        /**
+         * Relative path in resource to entrypoint, defaults to main.js.
+         *
+         * Options:
+         *   - proto3_optional = true
+         */
+        entryPoint?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface Bot {
+    /**
+     * Optional **semver 2.0** compliant record version.
+     * Should conform to the semver regex (see https://semver.org/).
+     */
+    version: string;
+    license: string;
+    repos?: Repo[];
+    /**
+     * Bot bundle content Id in the CID v0 format (https://docs.ipfs.io/concepts/content-addressing/#identifier-formats).
+     */
+    bundle: Uint8Array;
+    /**
+     * This would be the path to the bot executable in bot-factory's file-system.
+     */
+    localPath: string;
+    extension: dxos_registry.Record.Extension;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface StateMachine {
+    /**
+     * Set of protobuf messages encoded in JSON.
+     */
+    mutationProtobufDefs: string;
+    /**
+     * Set of protobuf messages encoded in JSON.
+     */
+    snapshotProtobufDefs: string;
+    codeIpfsCid: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface File {
+    contentType: string;
+    fileName: string;
+    /**
+     * File content Id in the CID v0 format (https://docs.ipfs.io/concepts/content-addressing/#identifier-formats).
+     */
+    bundle: Uint8Array;
+    extension: dxos_registry.Record.Extension;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface KUBE {
+    url: string;
+    extension: dxos_registry.Record.Extension;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface Service {
+    type: string;
+    kube: Uint8Array;
+    extension: dxos_registry.Record.Extension;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface IPFS {
+    protocol: string;
+    addresses?: string[];
+    extension: dxos_registry.Record.Extension;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface BotFactory {
+    topic: string;
+    extension: dxos_registry.Record.Extension;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface Signal {
+    bootstrap: string;
+    url: string;
+    extension: dxos_registry.Record.Extension;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/type.proto}
+ */
+export interface AppServer {
+    url: string;
+    extension: dxos_registry.Record.Extension;
+}

package/src/proto/gen/example/testing/data.ts

@@ -0,0 +1,63 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../../substitutions";
+import * as dxos_bot from "../../dxos/bot";
+import * as dxos_client from "../../dxos/client";
+import * as dxos_config from "../../dxos/config";
+import * as dxos_devtools_host from "../../dxos/devtools/host";
+import * as dxos_devtools_swarmLog from "../../dxos/devtools/swarmLog";
+import * as dxos_echo_feed from "../../dxos/echo/feed";
+import * as dxos_echo_metadata from "../../dxos/echo/metadata";
+import * as dxos_echo_model_messenger from "../../dxos/echo/model/messenger";
+import * as dxos_echo_model_object from "../../dxos/echo/model/object";
+import * as dxos_echo_model_text from "../../dxos/echo/model/text";
+import * as dxos_echo_service from "../../dxos/echo/service";
+import * as dxos_echo_snapshot from "../../dxos/echo/snapshot";
+import * as dxos_echo_timeframe from "../../dxos/echo/timeframe";
+import * as dxos_halo_credentials from "../../dxos/halo/credentials";
+import * as dxos_halo_credentials_auth from "../../dxos/halo/credentials/auth";
+import * as dxos_halo_credentials_greet from "../../dxos/halo/credentials/greet";
+import * as dxos_halo_credentials_identity from "../../dxos/halo/credentials/identity";
+import * as dxos_halo_credentials_party from "../../dxos/halo/credentials/party";
+import * as dxos_halo_invitations from "../../dxos/halo/invitations";
+import * as dxos_halo_keyring from "../../dxos/halo/keyring";
+import * as dxos_halo_keys from "../../dxos/halo/keys";
+import * as dxos_halo_signed from "../../dxos/halo/signed";
+import * as dxos_iframe from "../../dxos/iframe";
+import * as dxos_keys from "../../dxos/keys";
+import * as dxos_mesh_bridge from "../../dxos/mesh/bridge";
+import * as dxos_mesh_broadcast from "../../dxos/mesh/broadcast";
+import * as dxos_mesh_messaging from "../../dxos/mesh/messaging";
+import * as dxos_mesh_presence from "../../dxos/mesh/presence";
+import * as dxos_mesh_protocol from "../../dxos/mesh/protocol";
+import * as dxos_mesh_replicator from "../../dxos/mesh/replicator";
+import * as dxos_mesh_signal from "../../dxos/mesh/signal";
+import * as dxos_mesh_swarm from "../../dxos/mesh/swarm";
+import * as dxos_registry from "../../dxos/registry";
+import * as dxos_rpc from "../../dxos/rpc";
+import * as dxos_service_publisher from "../../dxos/service/publisher";
+import * as dxos_service_scheduler from "../../dxos/service/scheduler";
+import * as dxos_type from "../../dxos/type";
+import * as example_testing_rpc from "./rpc";
+import * as google_protobuf from "../../google/protobuf";
+/**
+ * Defined in:
+ *   {@link file://./../../../example/testing/data.proto}
+ */
+export interface TestItemMutation {
+    key: string;
+    value: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../example/testing/data.proto}
+ */
+export interface TestListMutation {
+    data: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../../example/testing/data.proto}
+ */
+export interface TestItemSnapshot {
+    keys?: TestItemMutation[];
+}