@sachitv/avro-typescript 0.4.0

package/esm/schemas/complex/record_type.d.ts

@@ -0,0 +1,165 @@
+import type { ReadableTapLike, WritableTapLike } from "../../serialization/tap.js";
+import { NamedType } from "./named_type.js";
+import { Resolver } from "../resolver.js";
+import { type JSONType, Type } from "../type.js";
+import { type ErrorHook } from "../error.js";
+import { type ResolvedNames } from "./resolve_names.js";
+/**
+ * Specifies the sort order for record fields.
+ */
+export type RecordFieldOrder = "ascending" | "descending" | "ignore";
+/**
+ * Parameters for defining a record field.
+ */
+export interface RecordFieldParams {
+    /** The name of the field. */
+    name: string;
+    /** The type of the field. */
+    type: Type;
+    /** Optional aliases for the field. */
+    aliases?: string[];
+    /** Optional ordering for the field. */
+    order?: RecordFieldOrder;
+    /** Optional default value for the field. */
+    default?: unknown;
+}
+/**
+ * Parameters for creating a RecordType.
+ */
+export interface RecordTypeParams extends ResolvedNames {
+    /**
+     * Fields can be provided eagerly as an array or lazily via a thunk (a
+     * parameterless function returning the array). The lazy form lets schema
+     * factories register the record under its name before constructing field
+     * types, enabling recursive references to the record.
+     */
+    fields: RecordFieldParams[] | (() => RecordFieldParams[]);
+}
+/**
+ * Represents a field in an Avro record type.
+ */
+export declare class RecordField {
+    #private;
+    /**
+     * Constructs a new RecordField instance.
+     */
+    constructor(params: RecordFieldParams);
+    /**
+     * Gets the name of the field.
+     */
+    getName(): string;
+    /**
+     * Gets the type of the field.
+     */
+    getType(): Type;
+    /**
+     * Gets the aliases of the field.
+     */
+    getAliases(): string[];
+    /**
+     * Gets the order of the field.
+     */
+    getOrder(): RecordFieldOrder;
+    /**
+     * Returns true if the field has a default value.
+     */
+    hasDefault(): boolean;
+    /**
+     * Gets the default value for the field.
+     * @returns The default value.
+     * @throws Error if the field has no default.
+     */
+    getDefault(): unknown;
+    /**
+     * Checks if the given name matches the field name or any of its aliases.
+     * @param name The name to check.
+     * @returns True if the name matches, false otherwise.
+     */
+    nameMatches(name: string): boolean;
+}
+/**
+ * Avro `record` type supporting ordered fields, aliases, and schema evolution.
+ */
+export declare class RecordType extends NamedType<Record<string, unknown>> {
+    #private;
+    /**
+     * Creates a new RecordType.
+     * @param params The record type parameters.
+     */
+    constructor(params: RecordTypeParams);
+    /**
+     * Gets the fields of the record.
+     */
+    getFields(): ReadonlyArray<RecordField>;
+    /**
+     * Gets a specific field by name.
+     */
+    getField(name: string): RecordField | undefined;
+    /**
+     * Checks if the given value conforms to this record type.
+     * @param value The value to check.
+     * @param errorHook Optional error hook for validation errors.
+     * @param path The current path in the schema for error reporting.
+     * @returns True if the value is valid, false otherwise.
+     */
+    check(value: unknown, errorHook?: ErrorHook, path?: string[]): boolean;
+    /**
+     * Writes the given record value to the tap.
+     * @param tap The writable tap to write to.
+     * @param value The record value to write.
+     */
+    write(tap: WritableTapLike, value: Record<string, unknown>): Promise<void>;
+    /**
+     * Reads a record value from the tap.
+     * @param tap The readable tap to read from.
+     * @returns The read record value.
+     */
+    read(tap: ReadableTapLike): Promise<Record<string, unknown>>;
+    /**
+     * Skips a record value in the tap.
+     * @param tap The readable tap to skip in.
+     */
+    skip(tap: ReadableTapLike): Promise<void>;
+    /**
+     * Converts the given record value to a buffer.
+     * @param value The record value to convert.
+     * @returns The buffer representation of the value.
+     */
+    toBuffer(value: Record<string, unknown>): Promise<ArrayBuffer>;
+    /**
+     * Clones a record value, ensuring it conforms to the schema.
+     * @param value The value to clone.
+     * @returns The cloned record value.
+     */
+    cloneFromValue(value: unknown): Record<string, unknown>;
+    /**
+     * Compares two record values for ordering.
+     * @param val1 The first record value.
+     * @param val2 The second record value.
+     * @returns A negative number if val1 < val2, zero if equal, positive if val1 > val2.
+     */
+    compare(val1: Record<string, unknown>, val2: Record<string, unknown>): number;
+    /**
+     * Generates a random record value conforming to this schema.
+     * @returns A random record value.
+     */
+    random(): Record<string, unknown>;
+    /**
+     * Converts this record type to its JSON schema representation.
+     * @returns The JSON representation of the record type.
+     */
+    toJSON(): JSONType;
+    /**
+     * Matches two record values from the taps for comparison.
+     * @param tap1 The first readable tap.
+     * @param tap2 The second readable tap.
+     * @returns A comparison result.
+     */
+    match(tap1: ReadableTapLike, tap2: ReadableTapLike): Promise<number>;
+    /**
+     * Creates a resolver for schema evolution from the writer type to this reader type.
+     * @param writerType The writer type to resolve from.
+     * @returns A resolver for reading writer data with this schema.
+     */
+    createResolver(writerType: Type): Resolver;
+}