@rise-maritime/keelson-js 0.4.6-pre.2

package/README.md

@@ -0,0 +1,141 @@
+# Keelson JavaScript SDK
+
+JavaScript SDK for [Keelson](https://github.com/RISE-Maritime/keelson): a modern, open protocol for maritime and sensor data. This package provides all the tools needed to encode, decode, and manage Keelson messages and envelopes in JavaScript/TypeScript environments.
+
+---
+
+## Installation
+
+```bash
+npm install keelson-js
+```
+
+---
+
+## SDK Usage
+
+### Envelope Management
+
+```js
+import { enclose, uncover } from 'keelson-js';
+
+// Wrap payload in envelope
+const envelope = enclose(payloadBytes, Date.now());
+
+// Unwrap envelope
+const [uncoveredAt, enclosedAt, payload] = uncover(envelope);
+```
+
+### Payload Encoding/Decoding
+
+```js
+import { encodePayloadFromTypeName, decodePayloadFromTypeName } from 'keelson-js';
+
+// Encode JS object to protobuf
+const bytes = encodePayloadFromTypeName('location_fix', jsObject);
+
+// Decode protobuf to JS object
+const obj = decodePayloadFromTypeName('location_fix', bytes);
+```
+
+---
+
+## Well-Known Subjects
+
+Keelson includes 180+ well-known subjects for maritime data types, e.g.:
+
+- `location_fix`, `heading_true_north_deg`, `roll_deg`, `engine_throttle_pct`, `image_raw`, `video_compressed`, ...
+
+See [`messages/subjects.yaml`](https://github.com/RISE-Maritime/keelson/blob/main/messages/subjects.yaml) for the full list.
+
+---
+
+## Naming Conventions
+
+- Functions: `snake_case`
+- Subjects: `snake_case`
+- Arguments/returns match SDK:
+  - `enclose(payload, enclosed_at?)` → `Envelope`
+  - `uncover(encodedEnvelope)` → `[uncovered_at, enclosed_at, payload]`
+  - `encodePayloadFromTypeName(typeName, payload)` → `Uint8Array`
+  - `decodePayloadFromTypeName(typeName, bytes)` → `object`
+
+---
+
+## Development Setup
+
+1. Generate protobuf messages:
+	```bash
+	chmod +x generate_javascript.sh
+	./generate_javascript.sh
+	```
+2. Run tests:
+	```bash
+	npm install --save-dev jest @types/jest ts-jest
+	npx jest
+	```
+
+---
+
+## Node-RED Nodes
+
+This package also provides Node-RED nodes for seamless integration with MQTT and Zenoh. To use in Node-RED:
+
+```bash
+cd ~/.node-red
+npm install keelson-js
+```
+Restart Node-RED. The Keelson nodes will appear in the palette under the "keelson" category.
+
+### Available Nodes
+
+- **keelson-enclose**: Wraps payload bytes in a Keelson Envelope protobuf message with a timestamp.
+- **keelson-uncover**: Extracts payload bytes and timestamps from a Keelson Envelope protobuf message.
+- **keelson-encode-payload**: Encodes a JavaScript object to protobuf bytes using a Keelson subject.
+- **keelson-decode-payload**: Decodes protobuf bytes to a JavaScript object using a Keelson subject.
+
+#### Node-RED Example Flows
+
+**Publishing a Keelson Message:**
+```
+[Inject] --> [Function: Create Data] --> [keelson-encode-payload] --> [keelson-enclose] --> [MQTT Out or zenoh-put]
+```
+Function node example:
+```js
+msg.payload = {
+	 latitude: 57.7089,
+	 longitude: 11.9746,
+	 altitude: 10.5
+};
+msg.topic = "vessel/@v0/123/pubsub/location_fix/gps";
+return msg;
+```
+
+**Subscribing to a Keelson Message:**
+```
+[MQTT In or zenoh-subscribe] --> [keelson-uncover] --> [keelson-decode-payload] --> [Debug]
+```
+
+
+#### Connectivity: Zenoh (Recommended) & MQTT
+
+- **Zenoh (Recommended):** Use [`@freol35241/nodered-contrib-zenoh`](https://github.com/freol35241/nodered-contrib-zenoh) for direct, native Zenoh protocol support. Buffers are handled natively by Zenoh nodes, and you get access to Zenoh features like queries and attachments without needing a bridge.
+- **MQTT (Alternative):** You can also use Node-RED MQTT nodes with [zenoh-plugin-mqtt](https://github.com/eclipse-zenoh/zenoh-plugin-mqtt) as a bridge to Zenoh networks. Buffers are handled natively by MQTT nodes.
+
+#### Subject Extraction from Topics
+
+`keelson-encode-payload` and `keelson-decode-payload` can extract the subject from `msg.topic` if it matches:
+```
+{base_path}/@v0/{entity_id}/pubsub/{subject}/{source_id}
+```
+E.g., from `vessel/@v0/123/pubsub/location_fix/gps`, the subject is `location_fix`.
+
+#### Passthrough Behavior
+
+All Keelson nodes pass through unused message properties, preserving metadata like timestamps, entity IDs, and custom fields.
+
+---
+
+## License
+
+Apache-2.0

package/dist/Envelope.d.ts

@@ -0,0 +1,37 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "core";
+export interface Envelope {
+    /** Timestamp when this envelope was enclosed */
+    enclosedAt: Date | undefined;
+    /** The payload should be a protobuf message specified in the payload folder */
+    payload: Uint8Array;
+}
+export interface KeyEnvelopePair {
+    /** Timestamp when this KeyEnvelopePair was created */
+    timestamp: Date | undefined;
+    /** The key associated with this KeyEnvelopePair */
+    key: string;
+    /** The key associated with this KeyEnvelopePair */
+    envelope: Uint8Array;
+}
+export declare const Envelope: MessageFns<Envelope>;
+export declare const KeyEnvelopePair: MessageFns<KeyEnvelopePair>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};

package/dist/Envelope.js

@@ -0,0 +1,212 @@
+"use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.6.1
+//   protoc               v6.30.2
+// source: Envelope.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyEnvelopePair = exports.Envelope = exports.protobufPackage = void 0;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+const timestamp_1 = require("./google/protobuf/timestamp");
+exports.protobufPackage = "core";
+function createBaseEnvelope() {
+    return { enclosedAt: undefined, payload: new Uint8Array(0) };
+}
+exports.Envelope = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.enclosedAt !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.enclosedAt), writer.uint32(10).fork()).join();
+        }
+        if (message.payload.length !== 0) {
+            writer.uint32(18).bytes(message.payload);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseEnvelope();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.enclosedAt = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.payload = reader.bytes();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            enclosedAt: isSet(object.enclosedAt) ? fromJsonTimestamp(object.enclosedAt) : undefined,
+            payload: isSet(object.payload) ? bytesFromBase64(object.payload) : new Uint8Array(0),
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.enclosedAt !== undefined) {
+            obj.enclosedAt = message.enclosedAt.toISOString();
+        }
+        if (message.payload.length !== 0) {
+            obj.payload = base64FromBytes(message.payload);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.Envelope.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseEnvelope();
+        message.enclosedAt = object.enclosedAt ?? undefined;
+        message.payload = object.payload ?? new Uint8Array(0);
+        return message;
+    },
+};
+function createBaseKeyEnvelopePair() {
+    return { timestamp: undefined, key: "", envelope: new Uint8Array(0) };
+}
+exports.KeyEnvelopePair = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.timestamp !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.timestamp), writer.uint32(10).fork()).join();
+        }
+        if (message.key !== "") {
+            writer.uint32(18).string(message.key);
+        }
+        if (message.envelope.length !== 0) {
+            writer.uint32(26).bytes(message.envelope);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseKeyEnvelopePair();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.timestamp = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.key = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.envelope = reader.bytes();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            timestamp: isSet(object.timestamp) ? fromJsonTimestamp(object.timestamp) : undefined,
+            key: isSet(object.key) ? globalThis.String(object.key) : "",
+            envelope: isSet(object.envelope) ? bytesFromBase64(object.envelope) : new Uint8Array(0),
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.timestamp !== undefined) {
+            obj.timestamp = message.timestamp.toISOString();
+        }
+        if (message.key !== "") {
+            obj.key = message.key;
+        }
+        if (message.envelope.length !== 0) {
+            obj.envelope = base64FromBytes(message.envelope);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.KeyEnvelopePair.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseKeyEnvelopePair();
+        message.timestamp = object.timestamp ?? undefined;
+        message.key = object.key ?? "";
+        message.envelope = object.envelope ?? new Uint8Array(0);
+        return message;
+    },
+};
+function bytesFromBase64(b64) {
+    if (globalThis.Buffer) {
+        return Uint8Array.from(globalThis.Buffer.from(b64, "base64"));
+    }
+    else {
+        const bin = globalThis.atob(b64);
+        const arr = new Uint8Array(bin.length);
+        for (let i = 0; i < bin.length; ++i) {
+            arr[i] = bin.charCodeAt(i);
+        }
+        return arr;
+    }
+}
+function base64FromBytes(arr) {
+    if (globalThis.Buffer) {
+        return globalThis.Buffer.from(arr).toString("base64");
+    }
+    else {
+        const bin = [];
+        arr.forEach((byte) => {
+            bin.push(globalThis.String.fromCharCode(byte));
+        });
+        return globalThis.btoa(bin.join(""));
+    }
+}
+function toTimestamp(date) {
+    const seconds = Math.trunc(date.getTime() / 1000);
+    const nanos = (date.getTime() % 1000) * 1000000;
+    return { seconds, nanos };
+}
+function fromTimestamp(t) {
+    let millis = (t.seconds || 0) * 1000;
+    millis += (t.nanos || 0) / 1000000;
+    return new globalThis.Date(millis);
+}
+function fromJsonTimestamp(o) {
+    if (o instanceof globalThis.Date) {
+        return o;
+    }
+    else if (typeof o === "string") {
+        return new globalThis.Date(o);
+    }
+    else {
+        return fromTimestamp(timestamp_1.Timestamp.fromJSON(o));
+    }
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/google/protobuf/timestamp.d.ts

@@ -0,0 +1,128 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "google.protobuf";
+/**
+ * A Timestamp represents a point in time independent of any time zone or local
+ * calendar, encoded as a count of seconds and fractions of seconds at
+ * nanosecond resolution. The count is relative to an epoch at UTC midnight on
+ * January 1, 1970, in the proleptic Gregorian calendar which extends the
+ * Gregorian calendar backwards to year one.
+ *
+ * All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+ * second table is needed for interpretation, using a [24-hour linear
+ * smear](https://developers.google.com/time/smear).
+ *
+ * The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+ * restricting to that range, we ensure that we can convert to and from [RFC
+ * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+ *
+ * # Examples
+ *
+ * Example 1: Compute Timestamp from POSIX `time()`.
+ *
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds(time(NULL));
+ *     timestamp.set_nanos(0);
+ *
+ * Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+ *
+ *     struct timeval tv;
+ *     gettimeofday(&tv, NULL);
+ *
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds(tv.tv_sec);
+ *     timestamp.set_nanos(tv.tv_usec * 1000);
+ *
+ * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+ *
+ *     FILETIME ft;
+ *     GetSystemTimeAsFileTime(&ft);
+ *     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+ *
+ *     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+ *     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+ *     Timestamp timestamp;
+ *     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+ *     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+ *
+ * Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+ *
+ *     long millis = System.currentTimeMillis();
+ *
+ *     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+ *         .setNanos((int) ((millis % 1000) * 1000000)).build();
+ *
+ * Example 5: Compute Timestamp from Java `Instant.now()`.
+ *
+ *     Instant now = Instant.now();
+ *
+ *     Timestamp timestamp =
+ *         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+ *             .setNanos(now.getNano()).build();
+ *
+ * Example 6: Compute Timestamp from current time in Python.
+ *
+ *     timestamp = Timestamp()
+ *     timestamp.GetCurrentTime()
+ *
+ * # JSON Mapping
+ *
+ * In JSON format, the Timestamp type is encoded as a string in the
+ * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+ * format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+ * where {year} is always expressed using four digits while {month}, {day},
+ * {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+ * seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+ * are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+ * is required. A proto3 JSON serializer should always use UTC (as indicated by
+ * "Z") when printing the Timestamp type and a proto3 JSON parser should be
+ * able to accept both UTC and other timezones (as indicated by an offset).
+ *
+ * For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+ * 01:30 UTC on January 15, 2017.
+ *
+ * In JavaScript, one can convert a Date object to this format using the
+ * standard
+ * [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+ * method. In Python, a standard `datetime.datetime` object can be converted
+ * to this format using
+ * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+ * the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+ * the Joda Time's [`ISODateTimeFormat.dateTime()`](
+ * http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
+ * ) to obtain a formatter capable of generating timestamps in this format.
+ */
+export interface Timestamp {
+    /**
+     * Represents seconds of UTC time since Unix epoch
+     * 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+     * 9999-12-31T23:59:59Z inclusive.
+     */
+    seconds: number;
+    /**
+     * Non-negative fractions of a second at nanosecond resolution. Negative
+     * second values with fractions must still have non-negative nanos values
+     * that count forward in time. Must be from 0 to 999,999,999
+     * inclusive.
+     */
+    nanos: number;
+}
+export declare const Timestamp: MessageFns<Timestamp>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};

package/dist/google/protobuf/timestamp.js

@@ -0,0 +1,92 @@
+"use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.6.1
+//   protoc               v6.30.2
+// source: google/protobuf/timestamp.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Timestamp = exports.protobufPackage = void 0;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+exports.protobufPackage = "google.protobuf";
+function createBaseTimestamp() {
+    return { seconds: 0, nanos: 0 };
+}
+exports.Timestamp = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.seconds !== 0) {
+            writer.uint32(8).int64(message.seconds);
+        }
+        if (message.nanos !== 0) {
+            writer.uint32(16).int32(message.nanos);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseTimestamp();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.seconds = longToNumber(reader.int64());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.nanos = reader.int32();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            seconds: isSet(object.seconds) ? globalThis.Number(object.seconds) : 0,
+            nanos: isSet(object.nanos) ? globalThis.Number(object.nanos) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.seconds !== 0) {
+            obj.seconds = Math.round(message.seconds);
+        }
+        if (message.nanos !== 0) {
+            obj.nanos = Math.round(message.nanos);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.Timestamp.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseTimestamp();
+        message.seconds = object.seconds ?? 0;
+        message.nanos = object.nanos ?? 0;
+        return message;
+    },
+};
+function longToNumber(int64) {
+    const num = globalThis.Number(int64.toString());
+    if (num > globalThis.Number.MAX_SAFE_INTEGER) {
+        throw new globalThis.Error("Value is larger than Number.MAX_SAFE_INTEGER");
+    }
+    if (num < globalThis.Number.MIN_SAFE_INTEGER) {
+        throw new globalThis.Error("Value is smaller than Number.MIN_SAFE_INTEGER");
+    }
+    return num;
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { Envelope } from './Envelope';
+import { MessageType } from './payloads/typeRegistry';
+import './payloads';
+export declare function construct_pubSub_key(base_path: string, entityId: string, subject: string, sourceId: string): string;
+export declare function construct_rpc_key(base_path: string, entityId: string, procedure: string, sourceId: string): string;
+export declare function parse_pubsub_key(key: string): Record<string, string>;
+export declare function parse_rpc_key(key: string): Record<string, string>;
+export declare function get_subject_from_pubsub_key(key: string): string;
+export declare function enclose(payload: Uint8Array, enclosed_at?: Date): Envelope;
+export declare function uncover(encodedEnvelope: Uint8Array): [Date, Date | undefined, Uint8Array] | undefined;
+export declare function isSubjectWellKnown(subject: string): boolean;
+export declare function getSubjectSchema(subject: string): string | undefined;
+export declare function getProtobufClassFromTypeName(typeName: string): MessageType<import("./payloads/typeRegistry").UnknownMessage> | undefined;
+export declare function decodePayloadFromTypeName(typeName: string, payload: Uint8Array): import("./payloads/typeRegistry").UnknownMessage | undefined;
+export declare function encodePayloadFromTypeName(typeName: string, payload: any): Uint8Array | undefined;
+export declare function encloseFromTypeName(typeName: string, payloadValue: any): Envelope | undefined;