@reallyme/codec 0.1.9

package/dist/proto/generated/reallyme/codec/v1/codec_pb.d.ts

@@ -0,0 +1,492 @@
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+/**
+ * Describes the file reallyme/codec/v1/codec.proto.
+ */
+export declare const file_reallyme_codec_v1_codec: GenFile;
+/**
+ * CodecError is the public, non-PII error envelope for codec boundary failures.
+ * The oneof keeps base encoding, PEM, multiformat, and canonicalization
+ * failures distinct while the shared CodecErrorReason enum provides stable
+ * cross-language reason codes.
+ *
+ * @generated from message reallyme.codec.v1.CodecError
+ */
+export type CodecError = Message<"reallyme.codec.v1.CodecError"> & {
+    /**
+     * @generated from oneof reallyme.codec.v1.CodecError.error
+     */
+    error: {
+        /**
+         * @generated from field: reallyme.codec.v1.CodecBaseEncodingError base_encoding = 1;
+         */
+        value: CodecBaseEncodingError;
+        case: "baseEncoding";
+    } | {
+        /**
+         * @generated from field: reallyme.codec.v1.CodecPemError pem = 2;
+         */
+        value: CodecPemError;
+        case: "pem";
+    } | {
+        /**
+         * @generated from field: reallyme.codec.v1.CodecMultiformatError multiformat = 3;
+         */
+        value: CodecMultiformatError;
+        case: "multiformat";
+    } | {
+        /**
+         * @generated from field: reallyme.codec.v1.CodecCanonicalizationError canonicalization = 4;
+         */
+        value: CodecCanonicalizationError;
+        case: "canonicalization";
+    } | {
+        case: undefined;
+        value?: undefined;
+    };
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecError.
+ * Use `create(CodecErrorSchema)` to create a new message.
+ */
+export declare const CodecErrorSchema: GenMessage<CodecError>;
+/**
+ * CodecMulticodecSpec is the protobuf form of a multicodec table entry.
+ *
+ * @generated from message reallyme.codec.v1.CodecMulticodecSpec
+ */
+export type CodecMulticodecSpec = Message<"reallyme.codec.v1.CodecMulticodecSpec"> & {
+    /**
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     * Raw multicodec varint bytes for callers that need the numeric code
+     * encoding independent of any payload.
+     *
+     * @generated from field: bytes code = 2;
+     */
+    code: Uint8Array;
+    /**
+     * Prefix bytes to match or prepend on encoded values. For currently
+     * supported codecs this is identical to code, but it is kept separate so
+     * consumers can use semantic field names without deriving one from the
+     * other.
+     *
+     * @generated from field: bytes prefix = 3;
+     */
+    prefix: Uint8Array;
+    /**
+     * @generated from field: reallyme.codec.v1.CodecTag tag = 4;
+     */
+    tag: CodecTag;
+    /**
+     * @generated from field: reallyme.codec.v1.CodecKeyMaterialKind key_material_kind = 5;
+     */
+    keyMaterialKind: CodecKeyMaterialKind;
+    /**
+     * @generated from field: uint32 fixed_length = 6;
+     */
+    fixedLength: number;
+    /**
+     * @generated from field: bool variable_length = 7;
+     */
+    variableLength: boolean;
+    /**
+     * @generated from field: string algorithm_name = 8;
+     */
+    algorithmName: string;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecMulticodecSpec.
+ * Use `create(CodecMulticodecSpecSchema)` to create a new message.
+ */
+export declare const CodecMulticodecSpecSchema: GenMessage<CodecMulticodecSpec>;
+/**
+ * CodecMulticodecLookupResult is returned when bytes are matched against the
+ * supported multicodec prefix table.
+ *
+ * @generated from message reallyme.codec.v1.CodecMulticodecLookupResult
+ */
+export type CodecMulticodecLookupResult = Message<"reallyme.codec.v1.CodecMulticodecLookupResult"> & {
+    /**
+     * @generated from field: string name = 1;
+     */
+    name: string;
+    /**
+     * @generated from field: uint32 prefix_length = 2;
+     */
+    prefixLength: number;
+    /**
+     * @generated from field: reallyme.codec.v1.CodecMulticodecSpec metadata = 3;
+     */
+    metadata?: CodecMulticodecSpec | undefined;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecMulticodecLookupResult.
+ * Use `create(CodecMulticodecLookupResultSchema)` to create a new message.
+ */
+export declare const CodecMulticodecLookupResultSchema: GenMessage<CodecMulticodecLookupResult>;
+/**
+ * CodecMulticodecTableResult contains the supported multicodec entries.
+ *
+ * @generated from message reallyme.codec.v1.CodecMulticodecTableResult
+ */
+export type CodecMulticodecTableResult = Message<"reallyme.codec.v1.CodecMulticodecTableResult"> & {
+    /**
+     * @generated from field: repeated reallyme.codec.v1.CodecMulticodecSpec entries = 1;
+     */
+    entries: CodecMulticodecSpec[];
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecMulticodecTableResult.
+ * Use `create(CodecMulticodecTableResultSchema)` to create a new message.
+ */
+export declare const CodecMulticodecTableResultSchema: GenMessage<CodecMulticodecTableResult>;
+/**
+ * CodecMultikeyParseResult is the binary/protobuf form of multikey parsing.
+ *
+ * @generated from message reallyme.codec.v1.CodecMultikeyParseResult
+ */
+export type CodecMultikeyParseResult = Message<"reallyme.codec.v1.CodecMultikeyParseResult"> & {
+    /**
+     * @generated from field: string codec_name = 1;
+     */
+    codecName: string;
+    /**
+     * @generated from field: string algorithm_name = 2;
+     */
+    algorithmName: string;
+    /**
+     * @generated from field: bytes public_key = 3;
+     */
+    publicKey: Uint8Array;
+    /**
+     * @generated from field: uint32 expected_public_key_length = 4;
+     */
+    expectedPublicKeyLength: number;
+    /**
+     * @generated from field: bool variable_public_key_length = 5;
+     */
+    variablePublicKeyLength: boolean;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecMultikeyParseResult.
+ * Use `create(CodecMultikeyParseResultSchema)` to create a new message.
+ */
+export declare const CodecMultikeyParseResultSchema: GenMessage<CodecMultikeyParseResult>;
+/**
+ * CodecDagCborVerifyCidResult contains the deterministic CID verification
+ * result without requiring callers to parse fixed-shape JSON.
+ *
+ * @generated from message reallyme.codec.v1.CodecDagCborVerifyCidResult
+ */
+export type CodecDagCborVerifyCidResult = Message<"reallyme.codec.v1.CodecDagCborVerifyCidResult"> & {
+    /**
+     * @generated from field: bool valid = 1;
+     */
+    valid: boolean;
+    /**
+     * @generated from field: string expected_cid = 2;
+     */
+    expectedCid: string;
+    /**
+     * @generated from field: string actual_cid = 3;
+     */
+    actualCid: string;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecDagCborVerifyCidResult.
+ * Use `create(CodecDagCborVerifyCidResultSchema)` to create a new message.
+ */
+export declare const CodecDagCborVerifyCidResultSchema: GenMessage<CodecDagCborVerifyCidResult>;
+/**
+ * CodecPemDecodeResult is the binary/protobuf form of PEM armor decoding.
+ *
+ * @generated from message reallyme.codec.v1.CodecPemDecodeResult
+ */
+export type CodecPemDecodeResult = Message<"reallyme.codec.v1.CodecPemDecodeResult"> & {
+    /**
+     * @generated from field: string label = 1;
+     */
+    label: string;
+    /**
+     * DER may contain private-key material. Receivers that request protobuf PEM
+     * decode results are responsible for copying it into their language's
+     * sensitive-buffer owner and wiping intermediate protobuf containers as soon
+     * as practical.
+     *
+     * @generated from field: bytes der = 2;
+     */
+    der: Uint8Array;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecPemDecodeResult.
+ * Use `create(CodecPemDecodeResultSchema)` to create a new message.
+ */
+export declare const CodecPemDecodeResultSchema: GenMessage<CodecPemDecodeResult>;
+/**
+ * CodecBaseEncodingError describes base64, base64url, hex, and generic byte
+ * encoding failures.
+ *
+ * @generated from message reallyme.codec.v1.CodecBaseEncodingError
+ */
+export type CodecBaseEncodingError = Message<"reallyme.codec.v1.CodecBaseEncodingError"> & {
+    /**
+     * Reason must be one of the CODEC_ERROR_REASON_BASE_* values.
+     *
+     * @generated from field: reallyme.codec.v1.CodecErrorReason reason = 1;
+     */
+    reason: CodecErrorReason;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecBaseEncodingError.
+ * Use `create(CodecBaseEncodingErrorSchema)` to create a new message.
+ */
+export declare const CodecBaseEncodingErrorSchema: GenMessage<CodecBaseEncodingError>;
+/**
+ * CodecPemError describes RFC 7468-style PEM armor boundary and body failures.
+ *
+ * @generated from message reallyme.codec.v1.CodecPemError
+ */
+export type CodecPemError = Message<"reallyme.codec.v1.CodecPemError"> & {
+    /**
+     * Reason must be one of the CODEC_ERROR_REASON_PEM_* values.
+     *
+     * @generated from field: reallyme.codec.v1.CodecErrorReason reason = 1;
+     */
+    reason: CodecErrorReason;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecPemError.
+ * Use `create(CodecPemErrorSchema)` to create a new message.
+ */
+export declare const CodecPemErrorSchema: GenMessage<CodecPemError>;
+/**
+ * CodecMultiformatError describes multibase, multicodec, and multikey
+ * envelope failures.
+ *
+ * @generated from message reallyme.codec.v1.CodecMultiformatError
+ */
+export type CodecMultiformatError = Message<"reallyme.codec.v1.CodecMultiformatError"> & {
+    /**
+     * Reason must be one of the CODEC_ERROR_REASON_MULTIFORMAT_* values.
+     *
+     * @generated from field: reallyme.codec.v1.CodecErrorReason reason = 1;
+     */
+    reason: CodecErrorReason;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecMultiformatError.
+ * Use `create(CodecMultiformatErrorSchema)` to create a new message.
+ */
+export declare const CodecMultiformatErrorSchema: GenMessage<CodecMultiformatError>;
+/**
+ * CodecCanonicalizationError describes CBOR, DAG-CBOR, JCS, and JSON
+ * canonicalization failures.
+ *
+ * @generated from message reallyme.codec.v1.CodecCanonicalizationError
+ */
+export type CodecCanonicalizationError = Message<"reallyme.codec.v1.CodecCanonicalizationError"> & {
+    /**
+     * Reason must be one of the CODEC_ERROR_REASON_CANONICAL_* values.
+     *
+     * @generated from field: reallyme.codec.v1.CodecErrorReason reason = 1;
+     */
+    reason: CodecErrorReason;
+};
+/**
+ * Describes the message reallyme.codec.v1.CodecCanonicalizationError.
+ * Use `create(CodecCanonicalizationErrorSchema)` to create a new message.
+ */
+export declare const CodecCanonicalizationErrorSchema: GenMessage<CodecCanonicalizationError>;
+/**
+ * CodecKeyMaterialKind classifies the material described by a multicodec
+ * table entry. The enum is intentionally small and owned by this package so
+ * SDKs do not pass ad hoc strings across FFI or RPC boundaries.
+ *
+ * @generated from enum reallyme.codec.v1.CodecKeyMaterialKind
+ */
+export declare enum CodecKeyMaterialKind {
+    /**
+     * @generated from enum value: CODEC_KEY_MATERIAL_KIND_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: CODEC_KEY_MATERIAL_KIND_PUBLIC_KEY = 1;
+     */
+    PUBLIC_KEY = 1,
+    /**
+     * @generated from enum value: CODEC_KEY_MATERIAL_KIND_PRIVATE_KEY = 2;
+     */
+    PRIVATE_KEY = 2,
+    /**
+     * @generated from enum value: CODEC_KEY_MATERIAL_KIND_SYMMETRIC_KEY = 3;
+     */
+    SYMMETRIC_KEY = 3,
+    /**
+     * @generated from enum value: CODEC_KEY_MATERIAL_KIND_NOT_KEY = 4;
+     */
+    NOT_KEY = 4
+}
+/**
+ * Describes the enum reallyme.codec.v1.CodecKeyMaterialKind.
+ */
+export declare const CodecKeyMaterialKindSchema: GenEnum<CodecKeyMaterialKind>;
+/**
+ * CodecTag classifies the protocol role of a multicodec table entry.
+ *
+ * @generated from enum reallyme.codec.v1.CodecTag
+ */
+export declare enum CodecTag {
+    /**
+     * @generated from enum value: CODEC_TAG_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * @generated from enum value: CODEC_TAG_ENCRYPTION = 1;
+     */
+    ENCRYPTION = 1,
+    /**
+     * @generated from enum value: CODEC_TAG_KEY = 2;
+     */
+    KEY = 2,
+    /**
+     * @generated from enum value: CODEC_TAG_HASH = 3;
+     */
+    HASH = 3,
+    /**
+     * @generated from enum value: CODEC_TAG_MULTIHASH = 4;
+     */
+    MULTIHASH = 4,
+    /**
+     * @generated from enum value: CODEC_TAG_MULTIKEY = 5;
+     */
+    MULTIKEY = 5
+}
+/**
+ * Describes the enum reallyme.codec.v1.CodecTag.
+ */
+export declare const CodecTagSchema: GenEnum<CodecTag>;
+/**
+ * CodecErrorReason is the component-owned reason-code enum for reallyme/codec.
+ * Values are stable public boundary codes; local parser errors must map into
+ * one of these before crossing RPC, SDK, FFI, storage, audit, or telemetry
+ * boundaries. Numeric ranges are intentionally split by codec subpart:
+ *   100-199: base encodings
+ *   200-299: PEM armor
+ *   300-399: multiformats and key envelopes
+ *   400-499: CBOR/JCS/JSON canonicalization
+ *
+ * @generated from enum reallyme.codec.v1.CodecErrorReason
+ */
+export declare enum CodecErrorReason {
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Base encodings and generic byte-envelope limits.
+     *
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_UNSUPPORTED_CODEC = 100;
+     */
+    BASE_UNSUPPORTED_CODEC = 100,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_INVALID_ENCODING = 101;
+     */
+    BASE_INVALID_ENCODING = 101,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_INVALID_LENGTH = 102;
+     */
+    BASE_INVALID_LENGTH = 102,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_INPUT_TOO_LARGE = 103;
+     */
+    BASE_INPUT_TOO_LARGE = 103,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_OUTPUT_TOO_LARGE = 104;
+     */
+    BASE_OUTPUT_TOO_LARGE = 104,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_INVALID_BASE64 = 110;
+     */
+    BASE_INVALID_BASE64 = 110,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_INVALID_BASE64URL = 111;
+     */
+    BASE_INVALID_BASE64URL = 111,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_INVALID_HEX = 120;
+     */
+    BASE_INVALID_HEX = 120,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_BASE_NON_CANONICAL_HEX = 121;
+     */
+    BASE_NON_CANONICAL_HEX = 121,
+    /**
+     * PEM armor.
+     *
+     * @generated from enum value: CODEC_ERROR_REASON_PEM_INVALID_BOUNDARY = 200;
+     */
+    PEM_INVALID_BOUNDARY = 200,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_PEM_LABEL_MISMATCH = 201;
+     */
+    PEM_LABEL_MISMATCH = 201,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_PEM_UNSUPPORTED_LABEL = 202;
+     */
+    PEM_UNSUPPORTED_LABEL = 202,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_PEM_INVALID_BODY = 203;
+     */
+    PEM_INVALID_BODY = 203,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_PEM_DER_TOO_LARGE = 204;
+     */
+    PEM_DER_TOO_LARGE = 204,
+    /**
+     * Multiformats and key envelopes.
+     *
+     * @generated from enum value: CODEC_ERROR_REASON_MULTIFORMAT_INVALID_MULTIBASE_PREFIX = 300;
+     */
+    MULTIFORMAT_INVALID_MULTIBASE_PREFIX = 300,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_MULTIFORMAT_INVALID_MULTICODEC_PREFIX = 301;
+     */
+    MULTIFORMAT_INVALID_MULTICODEC_PREFIX = 301,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_MULTIFORMAT_UNKNOWN_MULTICODEC = 302;
+     */
+    MULTIFORMAT_UNKNOWN_MULTICODEC = 302,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_MULTIFORMAT_INVALID_MULTIKEY = 303;
+     */
+    MULTIFORMAT_INVALID_MULTIKEY = 303,
+    /**
+     * CBOR, DAG-CBOR, JCS, and JSON canonicalization.
+     *
+     * @generated from enum value: CODEC_ERROR_REASON_CANONICAL_INVALID_CBOR = 400;
+     */
+    CANONICAL_INVALID_CBOR = 400,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_CANONICAL_NON_CANONICAL_CBOR = 401;
+     */
+    CANONICAL_NON_CANONICAL_CBOR = 401,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_CANONICAL_INVALID_JSON = 402;
+     */
+    CANONICAL_INVALID_JSON = 402,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_CANONICAL_NON_CANONICAL_JSON = 403;
+     */
+    CANONICAL_NON_CANONICAL_JSON = 403,
+    /**
+     * @generated from enum value: CODEC_ERROR_REASON_CANONICAL_INTERNAL = 404;
+     */
+    CANONICAL_INTERNAL = 404
+}
+/**
+ * Describes the enum reallyme.codec.v1.CodecErrorReason.
+ */
+export declare const CodecErrorReasonSchema: GenEnum<CodecErrorReason>;