@dxos/protocols 0.1.0

package/proto/dxos/mesh/bridge.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "bridge.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/mesh/bridge.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/mesh/bridge.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/mesh/bridge');

package/proto/dxos/mesh/broadcast.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/mesh/broadcast';

package/proto/dxos/mesh/broadcast.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "broadcast.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/mesh/broadcast.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/mesh/broadcast.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/mesh/broadcast');

package/proto/dxos/mesh/messaging.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/mesh/messaging';

package/proto/dxos/mesh/messaging.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "messaging.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/mesh/messaging.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/mesh/messaging.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/mesh/messaging');

package/proto/dxos/mesh/presence.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/mesh/presence';

package/proto/dxos/mesh/presence.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "presence.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/mesh/presence.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/mesh/presence.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/mesh/presence');

package/proto/dxos/mesh/protocol.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/mesh/protocol';

package/proto/dxos/mesh/protocol.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "protocol.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/mesh/protocol.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/mesh/protocol.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/mesh/protocol');

package/proto/dxos/mesh/replicator.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/mesh/replicator';

package/proto/dxos/mesh/replicator.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "replicator.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/mesh/replicator.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/mesh/replicator.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/mesh/replicator');

package/proto/dxos/mesh/signal.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/mesh/signal';

package/proto/dxos/mesh/signal.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "signal.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/mesh/signal.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/mesh/signal.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/mesh/signal');

package/proto/dxos/mesh/swarm.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/mesh/swarm';

package/proto/dxos/mesh/swarm.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "swarm.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/mesh/swarm.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/mesh/swarm.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/mesh/swarm');

package/proto/dxos/registry.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../dist/src/proto/gen/dxos/registry';

package/proto/dxos/registry.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "registry.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../src/proto/dxos/registry.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/registry.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../dist/src/proto/gen/dxos/registry');

package/proto/dxos/rpc.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../dist/src/proto/gen/dxos/rpc';

package/proto/dxos/rpc.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "rpc.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../src/proto/dxos/rpc.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/rpc.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../dist/src/proto/gen/dxos/rpc');

package/proto/dxos/service/publisher.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/service/publisher';

package/proto/dxos/service/publisher.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "publisher.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/service/publisher.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/service/publisher.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/service/publisher');

package/proto/dxos/service/scheduler.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/dxos/service/scheduler';

package/proto/dxos/service/scheduler.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "scheduler.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/dxos/service/scheduler.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/service/scheduler.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/dxos/service/scheduler');

package/proto/dxos/type.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../dist/src/proto/gen/dxos/type';

package/proto/dxos/type.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "type.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../src/proto/dxos/type.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/dxos/type.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../dist/src/proto/gen/dxos/type');

package/proto/example/testing/data.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/example/testing/data';

package/proto/example/testing/data.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "data.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/example/testing/data.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/example/testing/data.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/example/testing/data');

package/proto/example/testing/rpc.d.ts

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+export * from '../../../dist/src/proto/gen/example/testing/rpc';

package/proto/example/testing/rpc.d.ts.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "file": "rpc.d.ts",
+  "sourceRoot": "",
+  "sources": [
+    "../../../src/proto/example/testing/rpc.proto"
+  ],
+  "names": [],
+  "mappings": "AAIA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC"
+}

package/proto/example/testing/rpc.js

@@ -0,0 +1,2 @@
+// Generated file: do not edit.
+module.exports = require('../../../dist/src/proto/gen/example/testing/rpc');

package/src/codec.test.ts

@@ -0,0 +1,24 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { schema } from './proto';
+
+describe('Codec', function () {
+  it('encodes and decodes messages', async function () {
+    const codec = 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);
+
+    expect(key).to.eq('key-1');
+    expect(value).to.eq('value-1');
+  });
+});

package/src/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+export * from './proto';
+export * from './testing';
+export * from './types';

package/src/proto/dxos/bot.proto

@@ -0,0 +1,151 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
+
+import "dxos/client.proto";
+import "dxos/config.proto";
+import "dxos/halo/invitations.proto";
+import "dxos/keys.proto";
+
+package dxos.bot;
+
+// TODO(burdon): Rename.
+message BotPackageSpecifier {
+  oneof kind {
+    /// DXN of the bot in the DXNS registry.
+    string name = 1;
+    string ipfs_cid = 2;
+    string local_path = 3;
+  }
+}
+
+message Bot {
+  enum Status { // TODO(burdon): Rename to state.
+    /// Bot is stopped.
+    STOPPED = 0;
+    /// Starting bot process.
+    STARTING = 1;
+    /// Bot is running.
+    RUNNING = 2;
+    /// Bot is stopping.
+    STOPPING = 3;
+    /// Bot is being spawned. Bot factory is downloading the bot bundle and initializing resources.
+    SPAWNING = 4;
+  }
+
+  string id = 1;
+  optional Status status = 2; // TODO: Rename to state.
+
+  /// The state that the bot aims to be in. Can be only either RUNNING or STOPPED.
+  optional Status desired_state = 55;
+  optional int32 attempts_to_achieve_desired_state = 56;
+
+  optional BotPackageSpecifier package_specifier = 3;
+  optional google.protobuf.Timestamp last_start = 4;
+  optional dxos.keys.PublicKey party_key = 5;
+
+  message Runtime {
+    optional int32 exit_code = 1;
+    optional string exit_signal = 2;
+    optional string error = 3;
+  }
+
+  optional Runtime runtime = 6;
+  optional BotReport report = 7;
+}
+
+message GetBotsResponse {
+  repeated Bot bots = 1;
+}
+
+message SpawnBotRequest {
+  optional BotPackageSpecifier package = 1;
+
+  /// Invitation for the bot to join the target party.
+  optional dxos.halo.invitations.InvitationDescriptor invitation = 2;
+
+  /// Key of the party bot is invited to.
+  optional dxos.keys.PublicKey party_key = 3;
+}
+
+message SendCommandRequest {
+  optional string bot_id = 1;
+
+  optional bytes command = 2;
+}
+
+message SendCommandResponse {
+  optional bytes response = 1;
+}
+
+message GetLogsResponse {
+  bytes chunk = 1;
+}
+
+message GetLogsRequest {
+  string bot_id = 1;
+}
+
+message BotReport {
+  /// Details of the party the bot was spawned for.
+  optional dxos.client.PartyDetails party_details = 1;
+}
+
+/// Service that is used by clients to communicate with bot factory.
+service BotFactoryService {
+  rpc GetBots(google.protobuf.Empty) returns (GetBotsResponse);
+
+  rpc SpawnBot(SpawnBotRequest) returns (Bot);
+
+  // TODO(dmaretskyi): Invitations.
+
+  rpc Start(Bot) returns (Bot);
+  rpc Stop(Bot) returns (Bot);
+  rpc Remove(Bot) returns (google.protobuf.Empty);
+  rpc GetLogs(GetLogsRequest) returns (stream GetLogsResponse);
+
+  // TODO(dmaretskyi): querying metrics/state.
+
+  rpc SendCommand(SendCommandRequest) returns (SendCommandResponse);
+
+  rpc RemoveAll(google.protobuf.Empty) returns (google.protobuf.Empty);
+}
+
+message InitializeRequest {
+  /// Bot runtime configuration.
+  optional dxos.config.Config config = 1;
+
+  /// Invitation for the bot to join the target party.
+  optional dxos.halo.invitations.InvitationDescriptor invitation = 2;
+
+  /// ID of the bot.
+  optional string id = 3;
+}
+
+message StartRequest {
+  /// Bot runtime configuration.
+  dxos.config.Config config = 1;
+}
+
+/// Service that is used by bots communicating with bot factory.
+service BotService {
+  /// Initialize Client, create profile, and join a party.
+  rpc Initialize(InitializeRequest) returns (google.protobuf.Empty);
+
+  /// Start an initialized bot.
+  rpc Start(StartRequest) returns (google.protobuf.Empty);
+
+  /// Custom commands sent to the bot factory.
+  rpc Command(SendCommandRequest) returns (SendCommandResponse);
+
+  /// Stop the bot.
+  rpc Stop(google.protobuf.Empty) returns (google.protobuf.Empty);
+
+  /// Send periodic reports of the bot's state.
+  rpc StartReporting(google.protobuf.Empty) returns (stream BotReport);
+}