@dxos/protocols 0.1.0

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

@@ -0,0 +1,303 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../substitutions";
+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 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/bot.proto}
+ */
+export interface BotPackageSpecifier {
+    /**
+     * DXN of the bot in the DXNS registry.
+     */
+    name?: string;
+    ipfsCid?: string;
+    localPath?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface Bot {
+    id: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    status?: Bot.Status;
+    /**
+     * The state that the bot aims to be in. Can be only either RUNNING or STOPPED.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    desiredState?: Bot.Status;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    attemptsToAchieveDesiredState?: number;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    packageSpecifier?: BotPackageSpecifier;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    lastStart?: ReturnType<(typeof substitutions)["google.protobuf.Timestamp"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    partyKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    runtime?: Bot.Runtime;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    report?: BotReport;
+}
+export namespace Bot {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/bot.proto}
+     */
+    export enum Status {
+        STOPPED = 0,
+        STARTING = 1,
+        RUNNING = 2,
+        STOPPING = 3,
+        SPAWNING = 4
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/bot.proto}
+     */
+    export interface Runtime {
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        exitCode?: number;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        exitSignal?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        error?: string;
+    }
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface GetBotsResponse {
+    bots?: Bot[];
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface SpawnBotRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    package?: BotPackageSpecifier;
+    /**
+     * Invitation for the bot to join the target party.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    invitation?: dxos_halo_invitations.InvitationDescriptor;
+    /**
+     * Key of the party bot is invited to.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    partyKey?: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface SendCommandRequest {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    botId?: string;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    command?: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface SendCommandResponse {
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    response?: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface GetLogsResponse {
+    chunk: Uint8Array;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface GetLogsRequest {
+    botId: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface BotReport {
+    /**
+     * Details of the party the bot was spawned for.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    partyDetails?: dxos_client.PartyDetails;
+}
+/**
+ * Service that is used by clients to communicate with bot factory.
+ *
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface BotFactoryService {
+    getBots: (request: void) => Promise<GetBotsResponse>;
+    spawnBot: (request: SpawnBotRequest) => Promise<Bot>;
+    start: (request: Bot) => Promise<Bot>;
+    stop: (request: Bot) => Promise<Bot>;
+    remove: (request: Bot) => Promise<void>;
+    getLogs: (request: GetLogsRequest) => Stream<GetLogsResponse>;
+    sendCommand: (request: SendCommandRequest) => Promise<SendCommandResponse>;
+    removeAll: (request: void) => Promise<void>;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface InitializeRequest {
+    /**
+     * Bot runtime configuration.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    config?: dxos_config.Config;
+    /**
+     * Invitation for the bot to join the target party.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    invitation?: dxos_halo_invitations.InvitationDescriptor;
+    /**
+     * ID of the bot.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    id?: string;
+}
+/**
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface StartRequest {
+    /**
+     * Bot runtime configuration.
+     */
+    config: dxos_config.Config;
+}
+/**
+ * Service that is used by bots communicating with bot factory.
+ *
+ * Defined in:
+ *   {@link file://./../../dxos/bot.proto}
+ */
+export interface BotService {
+    /**
+     * Initialize Client, create profile, and join a party.
+     */
+    initialize: (request: InitializeRequest) => Promise<void>;
+    /**
+     * Start an initialized bot.
+     */
+    start: (request: StartRequest) => Promise<void>;
+    /**
+     * Custom commands sent to the bot factory.
+     */
+    command: (request: SendCommandRequest) => Promise<SendCommandResponse>;
+    /**
+     * Stop the bot.
+     */
+    stop: (request: void) => Promise<void>;
+    /**
+     * Send periodic reports of the bot's state.
+     */
+    startReporting: (request: void) => Stream<BotReport>;
+}