tachyon-protocol 0.3.5 → 1.0.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { EmptyObject } from 'type-fest';
+import { EmptyObject, KeysOfUnion } from 'type-fest';
 import { ValidateFunction } from 'ajv';
 
 declare const tachyonMeta: {
-    readonly version: "0.3.5";
+    readonly version: "1.0.0";
     readonly ids: {
         readonly autohost: {
             readonly slave: readonly ["request", "response"];
@@ -85,6 +85,22 @@ type EmptyRequestId<S extends ServiceId> = {
 type DataRequestId<S extends ServiceId> = {
     [K in EndpointId<S>]: RequestData<S, K> extends EmptyObject ? never : K;
 }[EndpointId<S>];
+type RequestType = {
+    [S in keyof Tachyon]: {
+        [E in keyof Tachyon[S]]: Tachyon[S][E] extends {
+            request: unknown;
+        } ? Tachyon[S][E]["request"] : never;
+    }[KeysOfUnion<Tachyon[S]>];
+}[KeysOfUnion<Tachyon>];
+type ResponseType = {
+    [S in keyof Tachyon]: {
+        [E in keyof Tachyon[S]]: Tachyon[S][E] extends {
+            response: unknown;
+        } ? Tachyon[S][E]["response"] : never;
+    }[KeysOfUnion<Tachyon[S]>];
+}[KeysOfUnion<Tachyon>];
+type RequestCommandId = Pick<RequestType, "commandId">;
+type ResponseCommandId = Pick<ResponseType, "commandId">;
 type GenericRequestCommand = {
     commandId: string;
     messageId: string;
@@ -105,7 +121,7 @@ declare function getValidator<T extends {
     commandId: string;
 }>(command: T): ValidateFunction<T>;
 
-export { Command, DataRequestId, EmptyRequestId, EndpointId, GenericRequestCommand, GenericResponseCommand, RequestCommand, RequestData, RequestEndpointId, ResponseCommand, ResponseData, ResponseEndpointId, ResponseOnlyEndpointId, ServiceId, SuccessResponseData, getValidator, tachyonMeta };
+export { Command, DataRequestId, EmptyRequestId, EndpointId, GenericRequestCommand, GenericResponseCommand, RequestCommand, RequestCommandId, RequestData, RequestEndpointId, RequestType, ResponseCommand, ResponseCommandId, ResponseData, ResponseEndpointId, ResponseOnlyEndpointId, ResponseType, ServiceId, SuccessResponseData, getValidator, tachyonMeta };
 
 export type AutohostSlaveResponse =
     | {
@@ -367,7 +383,7 @@ export type LobbyJoinedResponse =
                   userId: string;
                   username: string;
                   displayName: string;
-                  avatarUrl: string;
+                  avatarUrl: string | null;
                   clanId: string | null;
                   partyId: string | null;
                   roles: string[];
@@ -534,7 +550,7 @@ export type LobbyListResponse =
                       userId: string;
                       username: string;
                       displayName: string;
-                      avatarUrl: string;
+                      avatarUrl: string | null;
                       clanId: string | null;
                       partyId: string | null;
                       roles: string[];
@@ -778,7 +794,7 @@ export type LobbyUpdatedResponse =
                       userId: string;
                       username: string;
                       displayName: string;
-                      avatarUrl: string;
+                      avatarUrl: string | null;
                       clanId: string | null;
                       partyId: string | null;
                       roles: string[];
@@ -1087,7 +1103,7 @@ export type SystemConnectedResponse =
               userId: string;
               username: string;
               displayName: string;
-              avatarUrl: string;
+              avatarUrl: string | null;
               clanId: string | null;
               partyId: string | null;
               roles: string[];
@@ -1204,7 +1220,7 @@ export type UserSubscribeResponse =
                   userId: string;
                   username: string;
                   displayName: string;
-                  avatarUrl: string;
+                  avatarUrl: string | null;
                   clanId: string | null;
                   partyId: string | null;
                   roles: string[];
@@ -1297,7 +1313,7 @@ export type UserUpdatedResponse =
                   userId?: string;
                   username?: string;
                   displayName?: string;
-                  avatarUrl?: string;
+                  avatarUrl?: string | null;
                   clanId?: string | null;
                   partyId?: string | null;
                   roles?: string[];
@@ -1671,173 +1687,8 @@ export interface UserUnsubscribeRequest {
         userIds: string[];
     };
 }
-export type TachyonUnixTime = number | null;
-
-export interface TachyonBattleContender {
-    playerId: number;
-    teamId: number;
-    color: string;
-    bonus: number;
-    inGame: boolean;
-}
-
-export type TachyonBattlePlayer = {
-    playerId: number;
-    teamId: number;
-    color: string;
-    bonus: number;
-    inGame: boolean;
-} & {
-    isSpectator: false;
-    isBot: false;
-    ready: boolean;
-    sync: {
-        engine: number;
-        game: number;
-        map: number;
-    };
-};
-
-export interface TachyonBattleSpectator {
-    isSpectator: true;
-    isBot: false;
-}
-
-export interface TachyonBot {
-    playerId: number;
-    teamId: number;
-    color: string;
-    bonus: number;
-    inGame: boolean;
-    isSpectator: false;
-    isBot: true;
-    ownerId: string;
-    aiShortName: string;
-    name: string;
-    aiOptions: {
-        /**
-         * This interface was referenced by `undefined`'s JSON-Schema definition
-         * via the `patternProperty` "^(.*)$".
-         */
-        [k: string]: unknown;
-    };
-    faction: string;
-}
-
-export type TachyonBattleStatus =
-    | ({
-          battleId: string;
-      } & (
-          | ({
-                playerId: number;
-                teamId: number;
-                color: string;
-                bonus: number;
-                inGame: boolean;
-            } & {
-                isSpectator: false;
-                isBot: false;
-                ready: boolean;
-                sync: {
-                    engine: number;
-                    game: number;
-                    map: number;
-                };
-            })
-          | {
-                isSpectator: true;
-                isBot: false;
-            }
-      ))
-    | null;
-
-export type TachyonUserStatus = "offline" | "menu" | "playing" | "lobby";
-
-export interface TachyonUser {
-    userId: string;
-    username: string;
-    displayName: string;
-    avatarUrl: string;
-    clanId: string | null;
-    partyId: string | null;
-    roles: string[];
-    countryCode?: string;
-    status: "offline" | "menu" | "playing" | "lobby";
-    battleStatus:
-        | ({
-              battleId: string;
-          } & (
-              | ({
-                    playerId: number;
-                    teamId: number;
-                    color: string;
-                    bonus: number;
-                    inGame: boolean;
-                } & {
-                    isSpectator: false;
-                    isBot: false;
-                    ready: boolean;
-                    sync: {
-                        engine: number;
-                        game: number;
-                        map: number;
-                    };
-                })
-              | {
-                    isSpectator: true;
-                    isBot: false;
-                }
-          ))
-        | null;
-}
-
-export interface TachyonPrivateUser {
-    userId: string;
-    username: string;
-    displayName: string;
-    avatarUrl: string;
-    clanId: string | null;
-    partyId: string | null;
-    roles: string[];
-    countryCode?: string;
-    status: "offline" | "menu" | "playing" | "lobby";
-    battleStatus:
-        | ({
-              battleId: string;
-          } & (
-              | ({
-                    playerId: number;
-                    teamId: number;
-                    color: string;
-                    bonus: number;
-                    inGame: boolean;
-                } & {
-                    isSpectator: false;
-                    isBot: false;
-                    ready: boolean;
-                    sync: {
-                        engine: number;
-                        game: number;
-                        map: number;
-                    };
-                })
-              | {
-                    isSpectator: true;
-                    isBot: false;
-                }
-          ))
-        | null;
-    friendIds: string[];
-    outgoingFriendRequestIds: string[];
-    incomingFriendRequestIds: string[];
-    ignoreIds: string[];
-}
-
-export interface TachyonRect {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
+export interface TachyonAutohostStatus {
+    gameStartTime: number | null;
 }
 
 export interface TachyonBattle {
@@ -1894,7 +1745,7 @@ export interface TachyonBattle {
         userId: string;
         username: string;
         displayName: string;
-        avatarUrl: string;
+        avatarUrl: string | null;
         clanId: string | null;
         partyId: string | null;
         roles: string[];
@@ -1929,6 +1780,84 @@ export interface TachyonBattle {
     }[];
 }
 
+export interface TachyonBattleContender {
+    playerId: number;
+    teamId: number;
+    color: string;
+    bonus: number;
+    inGame: boolean;
+}
+
+export type TachyonBattlePlayer = {
+    playerId: number;
+    teamId: number;
+    color: string;
+    bonus: number;
+    inGame: boolean;
+} & {
+    isSpectator: false;
+    isBot: false;
+    ready: boolean;
+    sync: {
+        engine: number;
+        game: number;
+        map: number;
+    };
+};
+
+export interface TachyonBattleSpectator {
+    isSpectator: true;
+    isBot: false;
+}
+
+export type TachyonBattleStatus =
+    | ({
+          battleId: string;
+      } & (
+          | ({
+                playerId: number;
+                teamId: number;
+                color: string;
+                bonus: number;
+                inGame: boolean;
+            } & {
+                isSpectator: false;
+                isBot: false;
+                ready: boolean;
+                sync: {
+                    engine: number;
+                    game: number;
+                    map: number;
+                };
+            })
+          | {
+                isSpectator: true;
+                isBot: false;
+            }
+      ))
+    | null;
+
+export interface TachyonBot {
+    playerId: number;
+    teamId: number;
+    color: string;
+    bonus: number;
+    inGame: boolean;
+    isSpectator: false;
+    isBot: true;
+    ownerId: string;
+    aiShortName: string;
+    name: string;
+    aiOptions: {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^(.*)$".
+         */
+        [k: string]: unknown;
+    };
+    faction: string;
+}
+
 export type TachyonCustomBattle = {
     battleId: string;
     hostId: string;
@@ -1983,7 +1912,7 @@ export type TachyonCustomBattle = {
         userId: string;
         username: string;
         displayName: string;
-        avatarUrl: string;
+        avatarUrl: string | null;
         clanId: string | null;
         partyId: string | null;
         roles: string[];
@@ -2030,7 +1959,94 @@ export type TachyonCustomBattle = {
     };
 };
 
-export interface TachyonAutohostStatus {
-    gameStartTime: number | null;
+export interface TachyonPrivateUser {
+    userId: string;
+    username: string;
+    displayName: string;
+    avatarUrl: string | null;
+    clanId: string | null;
+    partyId: string | null;
+    roles: string[];
+    countryCode?: string;
+    status: "offline" | "menu" | "playing" | "lobby";
+    battleStatus:
+        | ({
+              battleId: string;
+          } & (
+              | ({
+                    playerId: number;
+                    teamId: number;
+                    color: string;
+                    bonus: number;
+                    inGame: boolean;
+                } & {
+                    isSpectator: false;
+                    isBot: false;
+                    ready: boolean;
+                    sync: {
+                        engine: number;
+                        game: number;
+                        map: number;
+                    };
+                })
+              | {
+                    isSpectator: true;
+                    isBot: false;
+                }
+          ))
+        | null;
+    friendIds: string[];
+    outgoingFriendRequestIds: string[];
+    incomingFriendRequestIds: string[];
+    ignoreIds: string[];
+}
+
+export interface TachyonRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
 }
 
+export type TachyonUnixTime = number | null;
+
+export interface TachyonUser {
+    userId: string;
+    username: string;
+    displayName: string;
+    avatarUrl: string | null;
+    clanId: string | null;
+    partyId: string | null;
+    roles: string[];
+    countryCode?: string;
+    status: "offline" | "menu" | "playing" | "lobby";
+    battleStatus:
+        | ({
+              battleId: string;
+          } & (
+              | ({
+                    playerId: number;
+                    teamId: number;
+                    color: string;
+                    bonus: number;
+                    inGame: boolean;
+                } & {
+                    isSpectator: false;
+                    isBot: false;
+                    ready: boolean;
+                    sync: {
+                        engine: number;
+                        game: number;
+                        map: number;
+                    };
+                })
+              | {
+                    isSpectator: true;
+                    isBot: false;
+                }
+          ))
+        | null;
+}
+
+export type TachyonUserStatus = "offline" | "menu" | "playing" | "lobby";
+

package/dist/index.js

@@ -1,4 +1,3 @@
-"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -8,10 +7,6 @@ var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __commonJS = (cb, mod) => function __require() {
   return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
 };
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -28,7 +23,6 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // node_modules/ajv/dist/compile/codegen/code.js
 var require_code = __commonJS({
@@ -2032,9 +2026,9 @@ var require_subschema = __commonJS({
 
 // node_modules/fast-deep-equal/index.js
 var require_fast_deep_equal = __commonJS({
-  "node_modules/fast-deep-equal/index.js"(exports, module2) {
+  "node_modules/fast-deep-equal/index.js"(exports, module) {
     "use strict";
-    module2.exports = function equal(a, b) {
+    module.exports = function equal(a, b) {
       if (a === b)
         return true;
       if (a && b && typeof a == "object" && typeof b == "object") {
@@ -2077,9 +2071,9 @@ var require_fast_deep_equal = __commonJS({
 
 // node_modules/json-schema-traverse/index.js
 var require_json_schema_traverse = __commonJS({
-  "node_modules/json-schema-traverse/index.js"(exports, module2) {
+  "node_modules/json-schema-traverse/index.js"(exports, module) {
     "use strict";
-    var traverse = module2.exports = function(schema, opts, cb) {
+    var traverse = module.exports = function(schema, opts, cb) {
       if (typeof opts == "function") {
         cb = opts;
         opts = {};
@@ -3085,8 +3079,8 @@ var require_compile = __commonJS({
 
 // node_modules/ajv/dist/refs/data.json
 var require_data = __commonJS({
-  "node_modules/ajv/dist/refs/data.json"(exports, module2) {
-    module2.exports = {
+  "node_modules/ajv/dist/refs/data.json"(exports, module) {
+    module.exports = {
       $id: "https://raw.githubusercontent.com/ajv-validator/ajv/master/lib/refs/data.json#",
       description: "Meta-schema for $data reference (JSON AnySchema extension proposal)",
       type: "object",
@@ -3104,10 +3098,10 @@ var require_data = __commonJS({
 
 // node_modules/uri-js/dist/es5/uri.all.js
 var require_uri_all = __commonJS({
-  "node_modules/uri-js/dist/es5/uri.all.js"(exports, module2) {
+  "node_modules/uri-js/dist/es5/uri.all.js"(exports, module) {
     "use strict";
     (function(global, factory) {
-      typeof exports === "object" && typeof module2 !== "undefined" ? factory(exports) : typeof define === "function" && define.amd ? define(["exports"], factory) : factory(global.URI = global.URI || {});
+      typeof exports === "object" && typeof module !== "undefined" ? factory(exports) : typeof define === "function" && define.amd ? define(["exports"], factory) : factory(global.URI = global.URI || {});
     })(exports, function(exports2) {
       "use strict";
       function merge() {
@@ -6561,8 +6555,8 @@ var require_discriminator = __commonJS({
 
 // node_modules/ajv/dist/refs/json-schema-draft-07.json
 var require_json_schema_draft_07 = __commonJS({
-  "node_modules/ajv/dist/refs/json-schema-draft-07.json"(exports, module2) {
-    module2.exports = {
+  "node_modules/ajv/dist/refs/json-schema-draft-07.json"(exports, module) {
+    module.exports = {
       $schema: "http://json-schema.org/draft-07/schema#",
       $id: "http://json-schema.org/draft-07/schema#",
       title: "Core schema meta-schema",
@@ -6718,7 +6712,7 @@ var require_json_schema_draft_07 = __commonJS({
 
 // node_modules/ajv/dist/ajv.js
 var require_ajv = __commonJS({
-  "node_modules/ajv/dist/ajv.js"(exports, module2) {
+  "node_modules/ajv/dist/ajv.js"(exports, module) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.MissingRefError = exports.ValidationError = exports.CodeGen = exports.Name = exports.nil = exports.stringify = exports.str = exports._ = exports.KeywordCxt = void 0;
@@ -6747,7 +6741,7 @@ var require_ajv = __commonJS({
         return this.opts.defaultMeta = super.defaultMeta() || (this.getSchema(META_SCHEMA_ID) ? META_SCHEMA_ID : void 0);
       }
     };
-    module2.exports = exports = Ajv2;
+    module.exports = exports = Ajv2;
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.default = Ajv2;
     var validate_1 = require_validate();
@@ -7025,7 +7019,7 @@ var require_limit = __commonJS({
 
 // node_modules/ajv-formats/dist/index.js
 var require_dist = __commonJS({
-  "node_modules/ajv-formats/dist/index.js"(exports, module2) {
+  "node_modules/ajv-formats/dist/index.js"(exports, module) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
     var formats_1 = require_formats();
@@ -7059,23 +7053,15 @@ var require_dist = __commonJS({
       for (const f of list)
         ajv2.addFormat(f, fs2[f]);
     }
-    module2.exports = exports = formatsPlugin;
+    module.exports = exports = formatsPlugin;
     Object.defineProperty(exports, "__esModule", { value: true });
     exports.default = formatsPlugin;
   }
 });
 
-// src/compiled.ts
-var compiled_exports = {};
-__export(compiled_exports, {
-  getValidator: () => getValidator,
-  tachyonMeta: () => tachyonMeta
-});
-module.exports = __toCommonJS(compiled_exports);
-
 // src/meta.ts
 var tachyonMeta = {
-  "version": "0.3.5",
+  "version": "1.0.0",
   "ids": {
     "autohost": {
       "slave": [
@@ -7198,25 +7184,27 @@ var tachyonMeta = {
 };
 
 // src/validator.ts
-var import_ajv = __toESM(require_ajv());
-var import_ajv_formats = __toESM(require_dist());
-var import_fs = __toESM(require("fs"));
-var import_path = __toESM(require("path"));
+var import_ajv = __toESM(require_ajv(), 1);
+var import_ajv_formats = __toESM(require_dist(), 1);
+import fs from "node:fs";
+import path, { dirname } from "node:path";
+import { fileURLToPath } from "url";
+var __filename = fileURLToPath(import.meta.url);
+var __dirname = dirname(__filename);
 var meta = tachyonMeta;
 var validators = /* @__PURE__ */ new Map();
-var ajv = new import_ajv.default();
+var ajv = new import_ajv.default.default();
 var initialised = false;
 function init() {
   initialised = true;
   import_ajv_formats.default.default(ajv);
-  ajv.addKeyword("requiresLogin");
-  ajv.addKeyword("requiresRole");
+  ajv.addKeyword("roles");
   for (const serviceId in meta.ids) {
     for (const endpointId in meta.ids[serviceId]) {
       for (const commandType of meta.ids[serviceId][endpointId]) {
         const commandId = `${serviceId}/${endpointId}/${commandType}`;
-        const commandSchemaStr = import_fs.default.readFileSync(
-          import_path.default.join(__dirname, `./${serviceId}/${endpointId}/${commandType}.json`),
+        const commandSchemaStr = fs.readFileSync(
+          path.join(__dirname, `./${serviceId}/${endpointId}/${commandType}.json`),
           { encoding: "utf-8" }
         );
         const commandSchema = JSON.parse(commandSchemaStr);
@@ -7242,11 +7230,10 @@ function getValidator(command) {
   }
   return validator;
 }
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   getValidator,
   tachyonMeta
-});
+};
 /*! Bundled license information:
 
 uri-js/dist/es5/uri.all.js:

package/dist/lobby/joined/response.json

@@ -251,8 +251,15 @@
                                         "type": "string"
                                     },
                                     "avatarUrl": {
-                                        "format": "uri",
-                                        "type": "string"
+                                        "anyOf": [
+                                            {
+                                                "format": "uri",
+                                                "type": "string"
+                                            },
+                                            {
+                                                "type": "null"
+                                            }
+                                        ]
                                     },
                                     "clanId": {
                                         "anyOf": [

package/dist/lobby/list/response.json

@@ -308,8 +308,15 @@
                                                             "type": "string"
                                                         },
                                                         "avatarUrl": {
-                                                            "format": "uri",
-                                                            "type": "string"
+                                                            "anyOf": [
+                                                                {
+                                                                    "format": "uri",
+                                                                    "type": "string"
+                                                                },
+                                                                {
+                                                                    "type": "null"
+                                                                }
+                                                            ]
                                                         },
                                                         "clanId": {
                                                             "anyOf": [

package/dist/lobby/updated/response.json

@@ -237,8 +237,15 @@
                                                             "type": "string"
                                                         },
                                                         "avatarUrl": {
-                                                            "format": "uri",
-                                                            "type": "string"
+                                                            "anyOf": [
+                                                                {
+                                                                    "format": "uri",
+                                                                    "type": "string"
+                                                                },
+                                                                {
+                                                                    "type": "null"
+                                                                }
+                                                            ]
                                                         },
                                                         "clanId": {
                                                             "anyOf": [

package/dist/system/connected/response.json

@@ -29,8 +29,15 @@
                             "type": "string"
                         },
                         "avatarUrl": {
-                            "format": "uri",
-                            "type": "string"
+                            "anyOf": [
+                                {
+                                    "format": "uri",
+                                    "type": "string"
+                                },
+                                {
+                                    "type": "null"
+                                }
+                            ]
                         },
                         "clanId": {
                             "anyOf": [

package/dist/user/subscribe/response.json

@@ -34,8 +34,15 @@
                                         "type": "string"
                                     },
                                     "avatarUrl": {
-                                        "format": "uri",
-                                        "type": "string"
+                                        "anyOf": [
+                                            {
+                                                "format": "uri",
+                                                "type": "string"
+                                            },
+                                            {
+                                                "type": "null"
+                                            }
+                                        ]
                                     },
                                     "clanId": {
                                         "anyOf": [

package/dist/user/updated/response.json

@@ -34,8 +34,15 @@
                                         "type": "string"
                                     },
                                     "avatarUrl": {
-                                        "format": "uri",
-                                        "type": "string"
+                                        "anyOf": [
+                                            {
+                                                "format": "uri",
+                                                "type": "string"
+                                            },
+                                            {
+                                                "type": "null"
+                                            }
+                                        ]
                                     },
                                     "clanId": {
                                         "anyOf": [

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "tachyon-protocol",
-  "version": "0.3.5",
+  "version": "1.0.0",
   "description": "",
+  "type": "module",
   "scripts": {
     "dev": "nodemon --watch src/** --ext ts --ignore src/meta.ts --exec npm run build",
-    "build": "ts-node src/index.ts",
+    "build": "npx tsx src/index.ts",
     "tidy": "npm run lint && npm run format",
     "lint": "eslint . --ext .ts --fix",
     "format": "prettier --write src/**/*.ts",