@dxos/protocols 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 DXOS.org
+
+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,11 @@
+# Protocols
+
+System-wide protocol buffer definitions.
+
+## Typescript Protobuf Defs
+
+Generate by running script:
+
+```bash
+pnpm -w nx prebuild protocols
+```

package/dist/src/codec.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=codec.test.d.ts.map

package/dist/src/codec.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec.test.d.ts","sourceRoot":"","sources":["../../src/codec.test.ts"],"names":[],"mappings":""}

package/dist/src/codec.test.js

@@ -0,0 +1,21 @@
+"use strict";
+//
+// Copyright 2022 DXOS.org
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const proto_1 = require("./proto");
+describe('Codec', function () {
+    it('encodes and decodes messages', async function () {
+        const codec = proto_1.schema.getCodecForType('example.testing.data.TestItemMutation');
+        // TODO(burdon): Test substitutions.
+        const buffer = codec.encode({
+            key: 'key-1',
+            value: 'value-1'
+        });
+        const { key, value } = codec.decode(buffer);
+        (0, chai_1.expect)(key).to.eq('key-1');
+        (0, chai_1.expect)(value).to.eq('value-1');
+    });
+});
+//# sourceMappingURL=codec.test.js.map

package/dist/src/codec.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec.test.js","sourceRoot":"","sources":["../../src/codec.test.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;AAEF,+BAA8B;AAE9B,mCAAiC;AAEjC,QAAQ,CAAC,OAAO,EAAE;IAChB,EAAE,CAAC,8BAA8B,EAAE,KAAK;QACtC,MAAM,KAAK,GAAG,cAAM,CAAC,eAAe,CAAC,uCAAuC,CAAC,CAAC;QAE9E,oCAAoC;QACpC,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YAC1B,GAAG,EAAE,OAAO;YACZ,KAAK,EAAE,SAAS;SACjB,CAAC,CAAC;QAEH,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAE5C,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QAC3B,IAAA,aAAM,EAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './proto';
+export * from './testing';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,23 @@
+"use strict";
+//
+// Copyright 2021 DXOS.org
+//
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./proto"), exports);
+__exportStar(require("./testing"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,EAAE;AACF,0BAA0B;AAC1B,EAAE;;;;;;;;;;;;;;;;AAEF,0CAAwB;AACxB,4CAA0B;AAC1B,0CAAwB"}

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

@@ -0,0 +1,268 @@
+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_halo_invitations from "./halo/invitations";
+/**
+ * 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 declare namespace Bot {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/bot.proto}
+     */
+    enum Status {
+        STOPPED = 0,
+        STARTING = 1,
+        RUNNING = 2,
+        STOPPING = 3,
+        SPAWNING = 4
+    }
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/bot.proto}
+     */
+    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>;
+}
+//# sourceMappingURL=bot.d.ts.map

package/dist/src/proto/gen/dxos/bot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot.d.ts","sourceRoot":"","sources":["../../../../../src/proto/gen/dxos/bot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,WAAW,MAAM,UAAU,CAAC;AACxC,OAAO,KAAK,WAAW,MAAM,UAAU,CAAC;AAgBxC,OAAO,KAAK,qBAAqB,MAAM,oBAAoB,CAAC;AAsB5D;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AACD;;;GAGG;AACH,MAAM,WAAW,GAAG;IAChB,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC;IAC1B;;;OAGG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IACvC;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC,CAAC,OAAO,aAAa,CAAC,CAAC,2BAA2B,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtF;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC,OAAO,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/E;;;OAGG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IACtB;;;OAGG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;CACtB;AACD,yBAAiB,GAAG,CAAC;IACjB;;;OAGG;IACH,KAAY,MAAM;QACd,OAAO,IAAI;QACX,QAAQ,IAAI;QACZ,OAAO,IAAI;QACX,QAAQ,IAAI;QACZ,QAAQ,IAAI;KACf;IACD;;;OAGG;IACH,UAAiB,OAAO;QACpB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAClB;CACJ;AACD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;CAChB;AACD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B;;;OAGG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,CAAC;IACxD;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAC,OAAO,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;CAClF;AACD;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;CACxB;AACD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,UAAU,CAAC;CACzB;AACD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,UAAU,CAAC;CACrB;AACD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,MAAM,CAAC;CACjB;AACD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC;CAC3C;AACD;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,OAAO,CAAC,eAAe,CAAC,CAAC;IACrD,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACrD,KAAK,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,MAAM,CAAC,eAAe,CAAC,CAAC;IAC9D,WAAW,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC3E,SAAS,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C;AACD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,CAAC;IACxD;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACf;AACD;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC;CAC9B;AACD;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACvB;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D;;OAEG;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD;;OAEG;IACH,OAAO,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACvE;;OAEG;IACH,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC;;OAEG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,MAAM,CAAC,SAAS,CAAC,CAAC;CACxD"}

package/dist/src/proto/gen/dxos/bot.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bot = void 0;
+var Bot;
+(function (Bot) {
+    /**
+     * Defined in:
+     *   {@link file://./../../dxos/bot.proto}
+     */
+    let Status;
+    (function (Status) {
+        Status[Status["STOPPED"] = 0] = "STOPPED";
+        Status[Status["STARTING"] = 1] = "STARTING";
+        Status[Status["RUNNING"] = 2] = "RUNNING";
+        Status[Status["STOPPING"] = 3] = "STOPPING";
+        Status[Status["SPAWNING"] = 4] = "SPAWNING";
+    })(Status = Bot.Status || (Bot.Status = {}));
+})(Bot = exports.Bot || (exports.Bot = {}));
+//# sourceMappingURL=bot.js.map

package/dist/src/proto/gen/dxos/bot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot.js","sourceRoot":"","sources":["../../../../../src/proto/gen/dxos/bot.ts"],"names":[],"mappings":";;;AAsGA,IAAiB,GAAG,CAiCnB;AAjCD,WAAiB,GAAG;IAChB;;;OAGG;IACH,IAAY,MAMX;IAND,WAAY,MAAM;QACd,yCAAW,CAAA;QACX,2CAAY,CAAA;QACZ,yCAAW,CAAA;QACX,2CAAY,CAAA;QACZ,2CAAY,CAAA;IAChB,CAAC,EANW,MAAM,GAAN,UAAM,KAAN,UAAM,QAMjB;AAsBL,CAAC,EAjCgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAiCnB"}