@nexus-code/remote-protocol 0.0.0-stage → 0.2.0

package/dist/relay.d.ts

@@ -0,0 +1,273 @@
+/**
+ * What the relay sees: the frames between a device and its account's room.
+ * A device sends sealed messages to another device of the account, or to
+ * all of them; the relay checks who sent it, stamps it, and passes it on.
+ * It cannot open what a message carries (see ./sealed.ts).
+ */
+import { z } from "zod";
+/** The version of the frames below; the relay refuses a device that speaks another. */
+export declare const RELAY_VERSION = 1;
+/** A device's id, as the server gave it when the device signed in. */
+export declare const DeviceIdSchema: z.ZodString;
+export type DeviceId = z.infer<typeof DeviceIdSchema>;
+/** Every other device of the account that is in the room. */
+export declare const ALL_DEVICES = "*";
+/** Unpadded base64url, as the sealed bytes travel. */
+export declare const Base64UrlSchema: z.ZodString;
+/**
+ * A sealed message, as the sender gives it to the relay. `to` is one device
+ * or ALL_DEVICES. `seq` counts the sender's messages since it connected,
+ * from 1, so the other side can tell one lost or repeated. `kid` is the
+ * account key's version the message was sealed with.
+ */
+export declare const OutgoingSchema: z.ZodObject<{
+    t: z.ZodLiteral<"send">;
+    to: z.ZodUnion<[z.ZodString, z.ZodLiteral<"*">]>;
+    seq: z.ZodNumber;
+    kid: z.ZodNumber;
+    nonce: z.ZodString;
+    box: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    t: "send";
+    to: string;
+    seq: number;
+    kid: number;
+    nonce: string;
+    box: string;
+}, {
+    t: "send";
+    to: string;
+    seq: number;
+    kid: number;
+    nonce: string;
+    box: string;
+}>;
+export type Outgoing = z.infer<typeof OutgoingSchema>;
+/** A sealed message as the relay delivers it, with the sender it vouches for. */
+export declare const DeliveredSchema: z.ZodObject<Omit<{
+    t: z.ZodLiteral<"send">;
+    to: z.ZodUnion<[z.ZodString, z.ZodLiteral<"*">]>;
+    seq: z.ZodNumber;
+    kid: z.ZodNumber;
+    nonce: z.ZodString;
+    box: z.ZodString;
+}, "t"> & {
+    t: z.ZodLiteral<"message">;
+    from: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    t: "message";
+    to: string;
+    seq: number;
+    kid: number;
+    nonce: string;
+    box: string;
+    from: string;
+}, {
+    t: "message";
+    to: string;
+    seq: number;
+    kid: number;
+    nonce: string;
+    box: string;
+    from: string;
+}>;
+export type Delivered = z.infer<typeof DeliveredSchema>;
+/** A device of the account, as the relay tells who is in the room. */
+export declare const RoomDeviceSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    /** darwin, win32, linux, ios, android, web. */
+    platform: z.ZodString;
+    online: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name: string;
+    platform: string;
+    online: boolean;
+}, {
+    id: string;
+    name: string;
+    platform: string;
+    online: boolean;
+}>;
+export type RoomDevice = z.infer<typeof RoomDeviceSchema>;
+/**
+ * Who is in the room: sent once a device joins, and again whenever a device
+ * comes or goes. `self` is the device it is sent to.
+ */
+export declare const PresenceSchema: z.ZodObject<{
+    t: z.ZodLiteral<"presence">;
+    self: z.ZodString;
+    devices: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        /** darwin, win32, linux, ios, android, web. */
+        platform: z.ZodString;
+        online: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        platform: string;
+        online: boolean;
+    }, {
+        id: string;
+        name: string;
+        platform: string;
+        online: boolean;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    t: "presence";
+    self: string;
+    devices: {
+        id: string;
+        name: string;
+        platform: string;
+        online: boolean;
+    }[];
+}, {
+    t: "presence";
+    self: string;
+    devices: {
+        id: string;
+        name: string;
+        platform: string;
+        online: boolean;
+    }[];
+}>;
+export type Presence = z.infer<typeof PresenceSchema>;
+/**
+ * The relay could not take a frame: it was malformed, too big, sent to a
+ * device not in the room, or the device's sign-in ended (then the relay
+ * closes the socket after it).
+ */
+export declare const RelayErrorSchema: z.ZodObject<{
+    t: z.ZodLiteral<"error">;
+    code: z.ZodEnum<["bad-frame", "too-big", "no-such-device", "unauthorized", "rate-limited"]>;
+    message: z.ZodString;
+    /** The seq of the frame it refuses, when it was a message. */
+    seq: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    code: "bad-frame" | "too-big" | "no-such-device" | "unauthorized" | "rate-limited";
+    message: string;
+    t: "error";
+    seq?: number | undefined;
+}, {
+    code: "bad-frame" | "too-big" | "no-such-device" | "unauthorized" | "rate-limited";
+    message: string;
+    t: "error";
+    seq?: number | undefined;
+}>;
+export type RelayError = z.infer<typeof RelayErrorSchema>;
+/** What a device sends the relay. */
+export declare const ClientFrameSchema: z.ZodObject<{
+    t: z.ZodLiteral<"send">;
+    to: z.ZodUnion<[z.ZodString, z.ZodLiteral<"*">]>;
+    seq: z.ZodNumber;
+    kid: z.ZodNumber;
+    nonce: z.ZodString;
+    box: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    t: "send";
+    to: string;
+    seq: number;
+    kid: number;
+    nonce: string;
+    box: string;
+}, {
+    t: "send";
+    to: string;
+    seq: number;
+    kid: number;
+    nonce: string;
+    box: string;
+}>;
+export type ClientFrame = z.infer<typeof ClientFrameSchema>;
+/** What the relay sends a device. */
+export declare const ServerFrameSchema: z.ZodDiscriminatedUnion<"t", [z.ZodObject<Omit<{
+    t: z.ZodLiteral<"send">;
+    to: z.ZodUnion<[z.ZodString, z.ZodLiteral<"*">]>;
+    seq: z.ZodNumber;
+    kid: z.ZodNumber;
+    nonce: z.ZodString;
+    box: z.ZodString;
+}, "t"> & {
+    t: z.ZodLiteral<"message">;
+    from: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    t: "message";
+    to: string;
+    seq: number;
+    kid: number;
+    nonce: string;
+    box: string;
+    from: string;
+}, {
+    t: "message";
+    to: string;
+    seq: number;
+    kid: number;
+    nonce: string;
+    box: string;
+    from: string;
+}>, z.ZodObject<{
+    t: z.ZodLiteral<"presence">;
+    self: z.ZodString;
+    devices: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        /** darwin, win32, linux, ios, android, web. */
+        platform: z.ZodString;
+        online: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        platform: string;
+        online: boolean;
+    }, {
+        id: string;
+        name: string;
+        platform: string;
+        online: boolean;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    t: "presence";
+    self: string;
+    devices: {
+        id: string;
+        name: string;
+        platform: string;
+        online: boolean;
+    }[];
+}, {
+    t: "presence";
+    self: string;
+    devices: {
+        id: string;
+        name: string;
+        platform: string;
+        online: boolean;
+    }[];
+}>, z.ZodObject<{
+    t: z.ZodLiteral<"error">;
+    code: z.ZodEnum<["bad-frame", "too-big", "no-such-device", "unauthorized", "rate-limited"]>;
+    message: z.ZodString;
+    /** The seq of the frame it refuses, when it was a message. */
+    seq: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    code: "bad-frame" | "too-big" | "no-such-device" | "unauthorized" | "rate-limited";
+    message: string;
+    t: "error";
+    seq?: number | undefined;
+}, {
+    code: "bad-frame" | "too-big" | "no-such-device" | "unauthorized" | "rate-limited";
+    message: string;
+    t: "error";
+    seq?: number | undefined;
+}>]>;
+export type ServerFrame = z.infer<typeof ServerFrameSchema>;
+/**
+ * Most bytes one frame may take as JSON. A chat's whole transcript goes in
+ * pages under it (see ./rpc.ts).
+ */
+export declare const MAX_FRAME_BYTES: number;
+//# sourceMappingURL=relay.d.ts.map

package/dist/relay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relay.d.ts","sourceRoot":"","sources":["../src/relay.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,uFAAuF;AACvF,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,sEAAsE;AACtE,eAAO,MAAM,cAAc,aAA4B,CAAC;AACxD,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,6DAA6D;AAC7D,eAAO,MAAM,WAAW,MAAM,CAAC;AAE/B,sDAAsD;AACtD,eAAO,MAAM,eAAe,aAAuC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;EAOzB,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,iFAAiF;AACjF,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;EAG1B,CAAC;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAExD,sEAAsE;AACtE,eAAO,MAAM,gBAAgB;;;IAG3B,+CAA+C;;;;;;;;;;;;;EAG/C,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;;QAVzB,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAc/C,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;;;;IAI3B,8DAA8D;;;;;;;;;;;;EAE9D,CAAC;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,qCAAqC;AACrC,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;EAAiB,CAAC;AAChD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,qCAAqC;AACrC,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QApC5B,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA0B/C,8DAA8D;;;;;;;;;;;;IAc9D,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,eAAe,QAAc,CAAC"}

package/dist/relay.js

@@ -0,0 +1,77 @@
+/**
+ * What the relay sees: the frames between a device and its account's room.
+ * A device sends sealed messages to another device of the account, or to
+ * all of them; the relay checks who sent it, stamps it, and passes it on.
+ * It cannot open what a message carries (see ./sealed.ts).
+ */
+import { z } from "zod";
+/** The version of the frames below; the relay refuses a device that speaks another. */
+export const RELAY_VERSION = 1;
+/** A device's id, as the server gave it when the device signed in. */
+export const DeviceIdSchema = z.string().min(1).max(64);
+/** Every other device of the account that is in the room. */
+export const ALL_DEVICES = "*";
+/** Unpadded base64url, as the sealed bytes travel. */
+export const Base64UrlSchema = z.string().regex(/^[A-Za-z0-9_-]*$/);
+/**
+ * A sealed message, as the sender gives it to the relay. `to` is one device
+ * or ALL_DEVICES. `seq` counts the sender's messages since it connected,
+ * from 1, so the other side can tell one lost or repeated. `kid` is the
+ * account key's version the message was sealed with.
+ */
+export const OutgoingSchema = z.object({
+    t: z.literal("send"),
+    to: z.union([DeviceIdSchema, z.literal(ALL_DEVICES)]),
+    seq: z.number().int().positive(),
+    kid: z.number().int().nonnegative(),
+    nonce: Base64UrlSchema,
+    box: Base64UrlSchema,
+});
+/** A sealed message as the relay delivers it, with the sender it vouches for. */
+export const DeliveredSchema = OutgoingSchema.omit({ t: true }).extend({
+    t: z.literal("message"),
+    from: DeviceIdSchema,
+});
+/** A device of the account, as the relay tells who is in the room. */
+export const RoomDeviceSchema = z.object({
+    id: DeviceIdSchema,
+    name: z.string(),
+    /** darwin, win32, linux, ios, android, web. */
+    platform: z.string(),
+    online: z.boolean(),
+});
+/**
+ * Who is in the room: sent once a device joins, and again whenever a device
+ * comes or goes. `self` is the device it is sent to.
+ */
+export const PresenceSchema = z.object({
+    t: z.literal("presence"),
+    self: DeviceIdSchema,
+    devices: z.array(RoomDeviceSchema),
+});
+/**
+ * The relay could not take a frame: it was malformed, too big, sent to a
+ * device not in the room, or the device's sign-in ended (then the relay
+ * closes the socket after it).
+ */
+export const RelayErrorSchema = z.object({
+    t: z.literal("error"),
+    code: z.enum(["bad-frame", "too-big", "no-such-device", "unauthorized", "rate-limited"]),
+    message: z.string(),
+    /** The seq of the frame it refuses, when it was a message. */
+    seq: z.number().int().positive().optional(),
+});
+/** What a device sends the relay. */
+export const ClientFrameSchema = OutgoingSchema;
+/** What the relay sends a device. */
+export const ServerFrameSchema = z.discriminatedUnion("t", [
+    DeliveredSchema,
+    PresenceSchema,
+    RelayErrorSchema,
+]);
+/**
+ * Most bytes one frame may take as JSON. A chat's whole transcript goes in
+ * pages under it (see ./rpc.ts).
+ */
+export const MAX_FRAME_BYTES = 1024 * 1024;
+//# sourceMappingURL=relay.js.map

package/dist/relay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relay.js","sourceRoot":"","sources":["../src/relay.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,uFAAuF;AACvF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAE/B,sEAAsE;AACtE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAGxD,6DAA6D;AAC7D,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,CAAC;AAE/B,sDAAsD;AACtD,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACpB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IACrD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;IACnC,KAAK,EAAE,eAAe;IACtB,GAAG,EAAE,eAAe;CACrB,CAAC,CAAC;AAGH,iFAAiF;AACjF,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;IACrE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IACvB,IAAI,EAAE,cAAc;CACrB,CAAC,CAAC;AAGH,sEAAsE;AACtE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,EAAE,EAAE,cAAc;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;CACpB,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IACxB,IAAI,EAAE,cAAc;IACpB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CACnC,CAAC,CAAC;AAGH;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACrB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,gBAAgB,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;IACxF,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,8DAA8D;IAC9D,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAGH,qCAAqC;AACrC,MAAM,CAAC,MAAM,iBAAiB,GAAG,cAAc,CAAC;AAGhD,qCAAqC;AACrC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;IACzD,eAAe;IACf,cAAc;IACd,gBAAgB;CACjB,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,GAAG,IAAI,CAAC"}