@dtkt/protoform 0.0.0-stage → 0.1.0

package/dist/message.d.ts

@@ -0,0 +1,61 @@
+import { DescField, DescMessage, Message as ProtoMessage, MessageInitShape, MessageValidType } from '@bufbuild/protobuf';
+import { ReflectMessage } from '@bufbuild/protobuf/reflect';
+import { ValidationResult, Validator, Violation } from '@bufbuild/protovalidate';
+import { Element } from './element';
+import { Field } from './field';
+import { FormStore } from './store';
+export type MessageOptions = {
+    /** The message that contains this one; changes and validation bubble up to it. */
+    owner?: Message;
+    /** Location of this message inside the root message, e.g. `items[0]`. */
+    path?: string;
+    /** Called after this message changes (before the owner is notified). */
+    onChange?: () => void;
+    store?: FormStore;
+};
+export declare class Message {
+    readonly value: ReflectMessage;
+    readonly path: string;
+    readonly store: FormStore;
+    protected readonly owner?: Message;
+    private readonly onChange?;
+    constructor(desc: DescMessage, init?: MessageInitShape<DescMessage>, options?: MessageOptions);
+    /** Fields in declaration order; each oneof group is a single `OneOfField`. */
+    fields(): Field[];
+    fieldPath(desc: Pick<DescField, "name">): string;
+    /** Violations reported for this message as a whole. */
+    get errors(): Violation[];
+    errorMessages(): string[];
+    errorMessagesAt(path: string): string[];
+    /**
+     * Validates the whole message tree (delegating to the root message) and
+     * records the violations so fields can display them.
+     */
+    validate(validator?: Validator): ValidationResult<MessageValidType<DescMessage>, ProtoMessage>;
+    get(): ProtoMessage;
+    /** Replaces the contents of this message with `value`. */
+    set(value: ProtoMessage): void;
+    /** Resets every field to its zero value. */
+    clear(): void;
+    /** Signals that this message changed; subscribed UI re-renders. */
+    notify(): void;
+    protected attach(): void;
+    protected reset(): void;
+}
+export type MessageFieldDesc = Extract<DescField, {
+    fieldKind: "message";
+}>;
+export declare class MessageField extends Message implements Field {
+    readonly parent: Message;
+    readonly desc: MessageFieldDesc;
+    readonly elem: Element;
+    constructor(parent: Message, desc: MessageFieldDesc);
+    isSet(): boolean;
+    /** Marks the field as present, creating an empty message if it was unset. */
+    ensure(): void;
+    /** Unsets the field. */
+    clear(): void;
+    toString(): string;
+    parse(value: string): void;
+    protected attach(): void;
+}

package/dist/oneof.d.ts

@@ -0,0 +1,27 @@
+import { DescField, DescOneof } from '@bufbuild/protobuf';
+import { Violation } from '@bufbuild/protovalidate';
+import { Element } from './element';
+import { Field } from './field';
+import { Message } from './message';
+/** A oneof group: at most one of its member fields is set at a time. */
+export declare class OneOfField implements Field {
+    readonly parent: Message;
+    readonly oneOf: DescOneof;
+    readonly elem: Element;
+    readonly path: string;
+    constructor(parent: Message, oneOf: DescOneof);
+    /** The selected member, or the first member when nothing is selected. */
+    get desc(): DescField;
+    get errors(): Violation[];
+    errorMessages(): string[];
+    /** All members, e.g. to offer them as choices. */
+    fields(): Field[];
+    /** The selected member, if any. */
+    active(): Field | undefined;
+    isSet(): boolean;
+    /** Selects the member named `name` (resetting it), or unsets the group if `undefined`. */
+    select(name: string | undefined): void;
+    clear(): void;
+    toString(): string;
+    parse(value: string): void;
+}

package/dist/path.d.ts

@@ -0,0 +1,8 @@
+import { DescField } from '@bufbuild/protobuf';
+import { Path } from '@bufbuild/protobuf/reflect';
+/** Joins a parent path and a field into a path such as `items[0].name`. */
+export declare function fieldPath(base: string, desc: Pick<DescField, "name">): string;
+export declare function indexPath(base: string, index: number): string;
+export declare function keyPath(base: string, key: string | number | bigint | boolean): string;
+/** Converts a protovalidate violation path into the same notation as `fieldPath`. */
+export declare function pathToString(path: Path): string;