@rise-maritime/keelson-js 0.6.0-alpha.232.dev.1 → 0.6.0-alpha.255.dev.1

package/dist/payloads/ChecklistProcedure.d.ts

@@ -0,0 +1,81 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+/**
+ * The definition of a checklist procedure: its items and their text.
+ *
+ * ChecklistEvent and ChecklistState carry only item *ids* and status, so without this message a
+ * consumer that has not been seeded out of band cannot render a checklist at all — it knows an item
+ * was completed but not what the item said. Published to a key backed by the router's
+ * storage_manager so a joining client can `get` the library rather than being shipped a copy.
+ *
+ * This is the shared definition only. Per-operator state (favourites, last used, local reminders)
+ * stays with the client.
+ */
+export interface ChecklistProcedure {
+    $type: "keelson.ChecklistProcedure";
+    procedureId: string;
+    title: string;
+    description: string;
+    /** Free-form grouping used for filtering, e.g. navigation, handover, emergency, maintenance. */
+    category: string;
+    /**
+     * Version of this definition, e.g. "2.4.1". Advisory: the wire has no upgrade protocol, and a
+     * client applies whatever the storage last held.
+     */
+    version: string;
+    estimatedMinutes: number;
+    items: ChecklistProcedure_Item[];
+    updatedAt: Date | undefined;
+    updatedBy: string;
+}
+export interface ChecklistProcedure_Item {
+    $type: "keelson.ChecklistProcedure.Item";
+    itemId: string;
+    /**
+     * Position in the list as presented, 1-based. Explicit rather than implied by field order so a
+     * renumbering is a visible change to the definition.
+     */
+    number: number;
+    title: string;
+    description: string;
+    /** A procedure is not complete while a required item is outstanding. */
+    isRequired: boolean;
+    /**
+     * The task this item is a sub-task of; empty for a top-level task.
+     *
+     * A parent POINTER rather than a nested `repeated Item children`, deliberately: ChecklistState
+     * and ChecklistEvent both key progress by a flat item_id, and a pointer leaves both untouched.
+     * A consumer that does not understand nesting still renders every task and still records every
+     * completion — it loses the grouping, not the data.
+     *
+     * ONE LEVEL. An item that names a parent must not itself be named as a parent by another item.
+     * Deeper trees are not forbidden by the wire, but no producer should emit them until this
+     * comment says otherwise.
+     *
+     * A parent's own status is DERIVED from its children and is not carried anywhere: a parent has
+     * no ItemState of its own to complete, so the record cannot say a parent is done while one of
+     * its children is outstanding.
+     */
+    parentItemId: string;
+}
+export declare const ChecklistProcedure: MessageFns<ChecklistProcedure, "keelson.ChecklistProcedure">;
+export declare const ChecklistProcedure_Item: MessageFns<ChecklistProcedure_Item, "keelson.ChecklistProcedure.Item">;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+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 Exclude<keyof T, "$type">]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+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> | "$type">]: never;
+};
+interface MessageFns<T, V extends string> {
+    readonly $type: V;
+    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/payloads/ChecklistProcedure.js

@@ -0,0 +1,364 @@
+"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: ChecklistProcedure.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChecklistProcedure_Item = exports.ChecklistProcedure = void 0;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+const timestamp_1 = require("./google/protobuf/timestamp");
+const typeRegistry_1 = require("./typeRegistry");
+function createBaseChecklistProcedure() {
+    return {
+        $type: "keelson.ChecklistProcedure",
+        procedureId: "",
+        title: "",
+        description: "",
+        category: "",
+        version: "",
+        estimatedMinutes: 0,
+        items: [],
+        updatedAt: undefined,
+        updatedBy: "",
+    };
+}
+exports.ChecklistProcedure = {
+    $type: "keelson.ChecklistProcedure",
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.procedureId !== "") {
+            writer.uint32(10).string(message.procedureId);
+        }
+        if (message.title !== "") {
+            writer.uint32(18).string(message.title);
+        }
+        if (message.description !== "") {
+            writer.uint32(26).string(message.description);
+        }
+        if (message.category !== "") {
+            writer.uint32(34).string(message.category);
+        }
+        if (message.version !== "") {
+            writer.uint32(42).string(message.version);
+        }
+        if (message.estimatedMinutes !== 0) {
+            writer.uint32(48).int32(message.estimatedMinutes);
+        }
+        for (const v of message.items) {
+            exports.ChecklistProcedure_Item.encode(v, writer.uint32(58).fork()).join();
+        }
+        if (message.updatedAt !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.updatedAt), writer.uint32(66).fork()).join();
+        }
+        if (message.updatedBy !== "") {
+            writer.uint32(74).string(message.updatedBy);
+        }
+        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 = createBaseChecklistProcedure();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.procedureId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.title = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.description = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.category = reader.string();
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.version = reader.string();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 48) {
+                        break;
+                    }
+                    message.estimatedMinutes = reader.int32();
+                    continue;
+                }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.items.push(exports.ChecklistProcedure_Item.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 8: {
+                    if (tag !== 66) {
+                        break;
+                    }
+                    message.updatedAt = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+                }
+                case 9: {
+                    if (tag !== 74) {
+                        break;
+                    }
+                    message.updatedBy = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            $type: exports.ChecklistProcedure.$type,
+            procedureId: isSet(object.procedureId) ? globalThis.String(object.procedureId) : "",
+            title: isSet(object.title) ? globalThis.String(object.title) : "",
+            description: isSet(object.description) ? globalThis.String(object.description) : "",
+            category: isSet(object.category) ? globalThis.String(object.category) : "",
+            version: isSet(object.version) ? globalThis.String(object.version) : "",
+            estimatedMinutes: isSet(object.estimatedMinutes) ? globalThis.Number(object.estimatedMinutes) : 0,
+            items: globalThis.Array.isArray(object?.items)
+                ? object.items.map((e) => exports.ChecklistProcedure_Item.fromJSON(e))
+                : [],
+            updatedAt: isSet(object.updatedAt) ? fromJsonTimestamp(object.updatedAt) : undefined,
+            updatedBy: isSet(object.updatedBy) ? globalThis.String(object.updatedBy) : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.procedureId !== "") {
+            obj.procedureId = message.procedureId;
+        }
+        if (message.title !== "") {
+            obj.title = message.title;
+        }
+        if (message.description !== "") {
+            obj.description = message.description;
+        }
+        if (message.category !== "") {
+            obj.category = message.category;
+        }
+        if (message.version !== "") {
+            obj.version = message.version;
+        }
+        if (message.estimatedMinutes !== 0) {
+            obj.estimatedMinutes = Math.round(message.estimatedMinutes);
+        }
+        if (message.items?.length) {
+            obj.items = message.items.map((e) => exports.ChecklistProcedure_Item.toJSON(e));
+        }
+        if (message.updatedAt !== undefined) {
+            obj.updatedAt = message.updatedAt.toISOString();
+        }
+        if (message.updatedBy !== "") {
+            obj.updatedBy = message.updatedBy;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.ChecklistProcedure.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseChecklistProcedure();
+        message.procedureId = object.procedureId ?? "";
+        message.title = object.title ?? "";
+        message.description = object.description ?? "";
+        message.category = object.category ?? "";
+        message.version = object.version ?? "";
+        message.estimatedMinutes = object.estimatedMinutes ?? 0;
+        message.items = object.items?.map((e) => exports.ChecklistProcedure_Item.fromPartial(e)) || [];
+        message.updatedAt = object.updatedAt ?? undefined;
+        message.updatedBy = object.updatedBy ?? "";
+        return message;
+    },
+};
+typeRegistry_1.messageTypeRegistry.set(exports.ChecklistProcedure.$type, exports.ChecklistProcedure);
+function createBaseChecklistProcedure_Item() {
+    return {
+        $type: "keelson.ChecklistProcedure.Item",
+        itemId: "",
+        number: 0,
+        title: "",
+        description: "",
+        isRequired: false,
+        parentItemId: "",
+    };
+}
+exports.ChecklistProcedure_Item = {
+    $type: "keelson.ChecklistProcedure.Item",
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.itemId !== "") {
+            writer.uint32(10).string(message.itemId);
+        }
+        if (message.number !== 0) {
+            writer.uint32(16).int32(message.number);
+        }
+        if (message.title !== "") {
+            writer.uint32(26).string(message.title);
+        }
+        if (message.description !== "") {
+            writer.uint32(34).string(message.description);
+        }
+        if (message.isRequired !== false) {
+            writer.uint32(40).bool(message.isRequired);
+        }
+        if (message.parentItemId !== "") {
+            writer.uint32(50).string(message.parentItemId);
+        }
+        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 = createBaseChecklistProcedure_Item();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.itemId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.number = reader.int32();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.title = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.description = reader.string();
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.isRequired = reader.bool();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.parentItemId = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            $type: exports.ChecklistProcedure_Item.$type,
+            itemId: isSet(object.itemId) ? globalThis.String(object.itemId) : "",
+            number: isSet(object.number) ? globalThis.Number(object.number) : 0,
+            title: isSet(object.title) ? globalThis.String(object.title) : "",
+            description: isSet(object.description) ? globalThis.String(object.description) : "",
+            isRequired: isSet(object.isRequired) ? globalThis.Boolean(object.isRequired) : false,
+            parentItemId: isSet(object.parentItemId) ? globalThis.String(object.parentItemId) : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.itemId !== "") {
+            obj.itemId = message.itemId;
+        }
+        if (message.number !== 0) {
+            obj.number = Math.round(message.number);
+        }
+        if (message.title !== "") {
+            obj.title = message.title;
+        }
+        if (message.description !== "") {
+            obj.description = message.description;
+        }
+        if (message.isRequired !== false) {
+            obj.isRequired = message.isRequired;
+        }
+        if (message.parentItemId !== "") {
+            obj.parentItemId = message.parentItemId;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.ChecklistProcedure_Item.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseChecklistProcedure_Item();
+        message.itemId = object.itemId ?? "";
+        message.number = object.number ?? 0;
+        message.title = object.title ?? "";
+        message.description = object.description ?? "";
+        message.isRequired = object.isRequired ?? false;
+        message.parentItemId = object.parentItemId ?? "";
+        return message;
+    },
+};
+typeRegistry_1.messageTypeRegistry.set(exports.ChecklistProcedure_Item.$type, exports.ChecklistProcedure_Item);
+function toTimestamp(date) {
+    const seconds = Math.trunc(date.getTime() / 1000);
+    const nanos = (date.getTime() % 1000) * 1000000;
+    return { $type: "google.protobuf.Timestamp", 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;
+}