@joe-broadhead/messaging 0.0.0-stage → 0.7.1

package/dist/types/core/schema/errors.d.ts

@@ -0,0 +1,142 @@
+import { z } from "zod";
+/** The closed set of Messaging error codes. Every emitted code must be documented in docs/spec/messaging-v1.md. */
+export declare const ErrorCode: z.ZodEnum<{
+    expired: "expired";
+    invalid_request: "invalid_request";
+    not_member: "not_member";
+    bad_signature: "bad_signature";
+    unknown_session: "unknown_session";
+    ambiguous_address: "ambiguous_address";
+    no_recipients: "no_recipients";
+    unknown_address: "unknown_address";
+    refused: "refused";
+    declined: "declined";
+    request_required: "request_required";
+    rate_limited: "rate_limited";
+    loop_guard: "loop_guard";
+    too_large: "too_large";
+    secret_refused: "secret_refused";
+    duplicate: "duplicate";
+    relay_unavailable: "relay_unavailable";
+    not_found: "not_found";
+    invalid_state: "invalid_state";
+    forbidden: "forbidden";
+    guarded_turn: "guarded_turn";
+    roster_conflict: "roster_conflict";
+    invite_invalid: "invite_invalid";
+    no_identity: "no_identity";
+    binding_invalid: "binding_invalid";
+    jelly_unavailable: "jelly_unavailable";
+    log_conflict: "log_conflict";
+    conv_conflict: "conv_conflict";
+    stale_epoch: "stale_epoch";
+    device_limit: "device_limit";
+    admission_required: "admission_required";
+    admission_invalid: "admission_invalid";
+    directory_inconsistent: "directory_inconsistent";
+    unknown_device: "unknown_device";
+    directory_unavailable: "directory_unavailable";
+    login_unsupported: "login_unsupported";
+    login_denied: "login_denied";
+    grant_required: "grant_required";
+    grant_invalid: "grant_invalid";
+    ticket_required: "ticket_required";
+    ticket_invalid: "ticket_invalid";
+    daemon_unavailable: "daemon_unavailable";
+    daemon_mismatch: "daemon_mismatch";
+    store_refused: "store_refused";
+    internal: "internal";
+}>;
+export type ErrorCode = z.infer<typeof ErrorCode>;
+/**
+ * The exit status of a messagingd or messaging-relay that refuses its store and changes nothing (spec §8.8): `EX_CONFIG`
+ * of sysexits(3), for either reason. messagingd also prints one stderr line,
+ * `messagingd: store_refused: <reason>: <why and how to start over>`. A client matches this status, the code and the
+ * reason, never the wording.
+ */
+export declare const STORE_REFUSED_EXIT = 78;
+/**
+ * Why a store is refused (spec §8.8):
+ * - `pre-reset`: it records no store generation, or another one. Starting over (moving the home aside) is the remedy.
+ * - `newer`: its `min_reader` is above this reader's schema: a newer messagingd wrote it. Upgrading is the remedy;
+ *   moving the home aside would set a newer home aside.
+ */
+export declare const StoreRefusedReason: z.ZodEnum<{
+    "pre-reset": "pre-reset";
+    newer: "newer";
+}>;
+export type StoreRefusedReason = z.infer<typeof StoreRefusedReason>;
+export declare const ErrorBody: z.ZodObject<{
+    code: z.ZodEnum<{
+        expired: "expired";
+        invalid_request: "invalid_request";
+        not_member: "not_member";
+        bad_signature: "bad_signature";
+        unknown_session: "unknown_session";
+        ambiguous_address: "ambiguous_address";
+        no_recipients: "no_recipients";
+        unknown_address: "unknown_address";
+        refused: "refused";
+        declined: "declined";
+        request_required: "request_required";
+        rate_limited: "rate_limited";
+        loop_guard: "loop_guard";
+        too_large: "too_large";
+        secret_refused: "secret_refused";
+        duplicate: "duplicate";
+        relay_unavailable: "relay_unavailable";
+        not_found: "not_found";
+        invalid_state: "invalid_state";
+        forbidden: "forbidden";
+        guarded_turn: "guarded_turn";
+        roster_conflict: "roster_conflict";
+        invite_invalid: "invite_invalid";
+        no_identity: "no_identity";
+        binding_invalid: "binding_invalid";
+        jelly_unavailable: "jelly_unavailable";
+        log_conflict: "log_conflict";
+        conv_conflict: "conv_conflict";
+        stale_epoch: "stale_epoch";
+        device_limit: "device_limit";
+        admission_required: "admission_required";
+        admission_invalid: "admission_invalid";
+        directory_inconsistent: "directory_inconsistent";
+        unknown_device: "unknown_device";
+        directory_unavailable: "directory_unavailable";
+        login_unsupported: "login_unsupported";
+        login_denied: "login_denied";
+        grant_required: "grant_required";
+        grant_invalid: "grant_invalid";
+        ticket_required: "ticket_required";
+        ticket_invalid: "ticket_invalid";
+        daemon_unavailable: "daemon_unavailable";
+        daemon_mismatch: "daemon_mismatch";
+        store_refused: "store_refused";
+        internal: "internal";
+    }>;
+    message: z.ZodString;
+}, z.core.$strip>;
+export type ErrorBody = z.infer<typeof ErrorBody>;
+/** Error carrying a Messaging code. Messages must never contain bodies, keys or secrets. */
+export declare class MessagingError extends Error {
+    readonly code: ErrorCode;
+    constructor(code: ErrorCode, message: string, options?: {
+        cause?: unknown;
+    });
+    toBody(): ErrorBody;
+}
+/** `store_refused`, with its reason as a field: clients branch on `reason`, never on the message. */
+export declare class StoreRefusedError extends MessagingError {
+    readonly reason: StoreRefusedReason;
+    constructor(reason: StoreRefusedReason, message: string, options?: {
+        cause?: unknown;
+    });
+}
+/** The stderr line of a messagingd that refuses its store: `messagingd: store_refused: <reason>: <text>`. */
+export declare function storeRefusedLine(reason: StoreRefusedReason, text: string): string;
+/**
+ * The reason on a messagingd refusal line, or undefined for any other line. Reads the tokens only; the text after
+ * them may change between releases.
+ */
+export declare function storeRefusedReason(line: string): StoreRefusedReason | undefined;
+export declare function isMessagingError(value: unknown): value is MessagingError;

package/dist/types/core/schema/index.d.ts

@@ -0,0 +1,16 @@
+export * from "./common.js";
+export * from "./errors.js";
+export * from "./realm.js";
+export * from "./jelly.js";
+export * from "./directory.js";
+export * as A2A from "./a2a.js";
+export * from "./envelope.js";
+export * from "./delegation.js";
+export * from "./consent.js";
+export * from "./roster.js";
+export * from "./relay.js";
+export * from "./directory-frames.js";
+export * from "./ipc.js";
+export * from "./ipc/device.js";
+export * from "./ipc/consent.js";
+export * from "./conversation.js";