@embeddables/forms 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { EmbeddablesInstance } from "@embeddables/core";
+import { _ as FormSchema, a as SetResult, b as JsonValue, c as initForms, d as AnalyticsTrackResult, f as FieldConfig, g as FormFieldKey, h as FieldValidator, i as InitFormsOptions, l as AnalyticsInstance, m as FieldValidations, n as FormInstance, o as SubmitResult, p as FieldType, r as FormsClient, s as ValidateResult, t as FieldErrors, u as AnalyticsTrackEvent, v as FormValues, y as ProtocolFieldId } from "./form-CwUR8-8T.js";
 //#region src/errors.d.ts
 /**
  * Typed error hierarchy. Every failure this SDK raises on its own behalf is an
@@ -22,49 +22,15 @@ declare class ValidatorError extends FormsError {
   constructor(message: string, options?: ErrorOptions);
 }
 //#endregion
-//#region ../shared-types/dist/analytics-instance.types.d.ts
-/**
- * Hono-free analytics client surface other SDKs accept without depending on
- * `hono` or `@embeddables/analytics`. Precise ingest event types stay inferred
- * from the Worker in analytics-sdk; this module is the structural instance, not
- * the HTTP contract.
- *
- * `trackEvent` is a method (not a function property) so parameter checking
- * stays bivariant: a precise analytics-sdk client remains assignable here, and
- * callers without those types can still pass their payloads.
- */
-/** Loose event payload other SDKs pass to `trackEvent`. */
-interface AnalyticsTrackEvent {
-  event_name: string;
-  [key: string]: unknown;
-}
-/** Body `trackEvent` resolves with — identity plus ingest outcome. */
-interface AnalyticsTrackResult {
-  app_user_id: string;
-  accepted: number;
-  forwarded: boolean;
-}
-/**
- * Structural stand-in for `ReturnType<typeof initAnalytics>`. Other SDKs type
- * injected clients against this; analytics-sdk's `AnalyticsClient` must remain
- * assignable to it.
- */
-interface AnalyticsInstance<TEvent = AnalyticsTrackEvent> {
-  trackEvent(input: TEvent | readonly TEvent[]): Promise<AnalyticsTrackResult>;
-  /** Live identity: the composed core instance's current user. */
-  getAppUserId(): string | null;
-  getProjectId(): string;
+//#region src/storage/storage.d.ts
+/** Every form on the origin shares this one entry, indexed by form ID. */
+declare const FORM_DATA_KEY = "EMBEDDABLES-FORM-DATA";
+interface FormsStorage {
+  getItem(key: string): string | null;
+  setItem(key: string, value: string): void;
+  removeItem(key: string): void;
 }
 //#endregion
-//#region ../shared-types/dist/json.types.d.ts
-/**
- * Recursive JSON value, compatible with JSONB column values and public
- * portal entity payloads.
- */
-type JsonValue = string | number | boolean | null | JsonValue[] | {
-  [key: string]: JsonValue;
-};
-//#endregion
 //#region ../shared-types/dist/analytics-ingest.types.d.ts
 type FieldUpdatedType = 'text' | 'email' | 'number' | 'boolean' | 'select' | 'multiselect' | 'json';
 /**
@@ -103,139 +69,8 @@ type FormSubmittedEvent = FunnelStepFields & {
   form_key: string;
 };
 //#endregion
-//#region src/config.d.ts
-type FieldType = 'text' | 'email' | 'number' | 'boolean' | 'select' | 'multiselect' | 'json';
-/** Runtime `type` literal → the TypeScript type of that field's value. */
-interface ValueOfFieldType {
-  text: string;
-  email: string;
-  number: number;
-  boolean: boolean;
-  select: string;
-  multiselect: string[];
-  json: JsonValue;
-}
-type FieldValidator<TValue extends JsonValue = JsonValue> = (args: {
-  value: TValue;
-  values: Readonly<Record<string, JsonValue>>;
-}) => string | readonly string[] | null;
-interface FieldValidationsFor<TType extends FieldType> {
-  readonly required?: boolean;
-  readonly minLength?: number;
-  readonly maxLength?: number;
-  readonly min?: number;
-  readonly max?: number;
-  /** ECMAScript source without delimiters. */
-  readonly pattern?: string;
-  /** Flags for `pattern`. `g` and `y` are stripped before compilation. */
-  readonly patternFlags?: string;
-  readonly oneOf?: readonly JsonValue[];
-  /** `value` is bound to this field's declared `type`. */
-  readonly custom?: FieldValidator<ValueOfFieldType[TType]>;
-}
-interface FieldConfigFor<TType extends FieldType> {
-  readonly key: string;
-  readonly label: string;
-  readonly type: TType;
-  readonly validations?: FieldValidationsFor<TType>;
-  readonly registryFieldId?: string;
-  readonly protocolFieldId?: string;
-}
-type FieldConfig = { [T in FieldType]: FieldConfigFor<T>; }[FieldType];
-type FieldValidations = { [T in FieldType]: FieldValidationsFor<T>; }[FieldType];
-interface FormSchema {
-  readonly id: string;
-  readonly name?: string;
-  readonly fields: readonly FieldConfig[];
-}
-type FieldsOf<TSchema extends FormSchema> = TSchema['fields'][number];
-type FormFieldKey<TSchema extends FormSchema> = FieldsOf<TSchema>['key'];
-type FormValues<TSchema extends FormSchema> = { [F in FieldsOf<TSchema> as F['key']]: ValueOfFieldType[F['type']]; };
-//#endregion
-//#region src/analytics.d.ts
+//#region src/core/analytics.d.ts
 type FormsAnalyticsEvent = DataUpdatedEvent | FieldUpdatedEvent | FormSubmittedEvent;
 //#endregion
-//#region src/storage.d.ts
-/** Every form on the origin shares this one entry, indexed by form key. */
-declare const FORM_DATA_KEY = "EMBEDDABLES-FORM-DATA";
-interface FormsStorage {
-  getItem(key: string): string | null;
-  setItem(key: string, value: string): void;
-  removeItem(key: string): void;
-}
-//#endregion
-//#region src/form.d.ts
-/** Per-key validation errors. An empty object means the operation succeeded. */
-type FieldErrors<TSchema extends FormSchema> = Readonly<Partial<Record<FormFieldKey<TSchema>, readonly string[]>>>;
-interface SetResult<TSchema extends FormSchema> {
-  ok: boolean;
-  errors: FieldErrors<TSchema>;
-  /** Set when an `analyticsInstance` was configured and `trackEvent` rejected. Never thrown. */
-  trackError?: unknown;
-}
-interface SubmitResult<TSchema extends FormSchema> {
-  ok: boolean;
-  errors: FieldErrors<TSchema>;
-  values: Partial<FormValues<TSchema>>;
-  trackError?: unknown;
-}
-interface ValidateResult<TSchema extends FormSchema> {
-  ok: boolean;
-  errors: FieldErrors<TSchema>;
-  values: Partial<FormValues<TSchema>>;
-}
-interface FormInstance<TSchema extends FormSchema> {
-  readonly key: TSchema['id'];
-  /**
-   * Applies every key atomically: all or nothing, one write, one event.
-   * Validates and persists synchronously; the returned promise never rejects.
-   * Throws synchronously only if a custom validator throws or returns an
-   * illegal shape.
-   */
-  set(patch: Partial<FormValues<TSchema>>): Promise<SetResult<TSchema>>;
-  /** Typed by the field's declared `type`. Nothing verifies the stored value against it. */
-  get<K extends FormFieldKey<TSchema>>(key: K): FormValues<TSchema>[K] | undefined;
-  getAll(): Partial<FormValues<TSchema>>;
-  /**
-   * Validates every declared field, then emits one `form:submitted` event.
-   *
-   * Not idempotent: every call emits another event. The caller owns dedupe —
-   * disable the button, or guard on a route transition.
-   *
-   * Same synchronous-throw and never-reject contract as `set`.
-   */
-  submit(): Promise<SubmitResult<TSchema>>;
-  /**
-   * Runs validation without writing to storage or emitting analytics.
-   *
-   * With no argument, validates every declared field against stored values and
-   * replaces `errors()` wholesale. With a patch, validates only those keys
-   * against a merged snapshot and updates errors for those keys only.
-   *
-   * Same synchronous-throw and never-reject contract as `set` / `submit`.
-   */
-  validate(patch?: Partial<FormValues<TSchema>>): Promise<ValidateResult<TSchema>>;
-  errors(): FieldErrors<TSchema>;
-  clear(): void;
-}
-interface InitFormsOptions {
-  core: EmbeddablesInstance;
-  analyticsInstance?: AnalyticsInstance;
-  /** Overrides the default production backend URL for R2 persistence writes. */
-  baseUrl?: string;
-}
-interface FormsClient {
-  initForm<const TSchema extends FormSchema>(options: {
-    schema: TSchema;
-    customValidations?: { readonly [K in FormFieldKey<TSchema>]?: FieldValidator; };
-  }): FormInstance<TSchema>;
-}
-/**
- * Validates the core instance once, then returns a per-form `initForm`. Public
- * API — the Miro signature. Consumers pass only `core` and, optionally, an
- * analytics client.
- */
-declare function initForms(options: InitFormsOptions): FormsClient;
-//#endregion
-export { type AnalyticsInstance, type AnalyticsTrackEvent, type AnalyticsTrackResult, type DataUpdatedEvent, FORM_DATA_KEY, type FieldConfig, type FieldErrors, type FieldType, type FieldUpdatedEvent, type FieldUpdatedType, type FieldValidations, type FieldValidator, type FormFieldKey, type FormInstance, type FormSchema, type FormSubmittedEvent, type FormValues, type FormsAnalyticsEvent, type FormsClient, FormsError, type FormsStorage, type InitFormsOptions, type JsonValue, SchemaError, type SetResult, type SubmitResult, type ValidateResult, ValidatorError, initForms };
+export { type AnalyticsInstance, type AnalyticsTrackEvent, type AnalyticsTrackResult, type DataUpdatedEvent, FORM_DATA_KEY, type FieldConfig, type FieldErrors, type FieldType, type FieldUpdatedEvent, type FieldUpdatedType, type FieldValidations, type FieldValidator, type FormFieldKey, type FormInstance, type FormSchema, type FormSubmittedEvent, type FormValues, type FormsAnalyticsEvent, type FormsClient, FormsError, type FormsStorage, type InitFormsOptions, type JsonValue, type ProtocolFieldId, SchemaError, type SetResult, type SubmitResult, type ValidateResult, ValidatorError, initForms };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/errors.ts","../../shared-types/dist/analytics-instance.types.d.ts","../../shared-types/dist/json.types.d.ts","../../shared-types/dist/analytics-ingest.types.d.ts","../src/config.ts","../src/analytics.ts","../src/storage.ts","../src/form.ts"],"mappings":";;;;;;;;;;;;cAWa,mBAAmB;EAClB,YAAA,iBAAiB,UAAU;;;cAO5B,oBAAoB;EACnB,YAAA,iBAAiB,UAAU;;;cAO5B,uBAAuB;EACtB,YAAA,iBAAiB,UAAU;;;;;;;;;;;;;;;UCjBxB;EACb;GACC;;;UAGY;EACb;EACA;EACA;;;;;;;UAOa,kBAAkB,SAAS;EACxC,WAAW,OAAO,kBAAkB,WAAW,QAAQ;;EAEvD;EACA;;;;;;;;KC1BQ,+CAA+C;GACtD,cAAc;;;;KCCP;;;;;;;;KAQA,oBAAoB;KACpB;EACR;EACA;;KAsBQ,oBAAoB;EAC5B;;EAEA;EACA,YAAY;EACZ,cAAc;;EAEd;;EAEA;;KAEQ;EACR;EACA;;KAEQ,mBAAmB;EAC3B;EACA,MAAM,eAAe;;KAMb,qBAAqB;EAC7B;EACA;;;;KC9DQ;;UAMF;EACR;EACA;EACA;EACA;EACA;EACA;EACA,MAAM;;KAGI,eAAe,eAAe,YAAY,cAAc;EAClE,OAAO;EACP,QAAQ,SAAS,eAAe;;UAUxB,oBAAoB,cAAc;WACjC;WACA;WACA;WACA;WACA;;WAEA;;WAEA;WACA,iBAAiB;;WAEjB,SAAS,eAAe,iBAAiB;;UAG1C,eAAe,cAAc;WAC5B;WACA;WACA,MAAM;WACN,cAAc,oBAAoB;WAGlC;WACA;;KAUC,iBAAiB,KAAK,YAAY,eAAe,MAAK;KAEtD,sBAAsB,KAAK,YAAY,oBAAoB,MAAK;UAE3D;WACN;WACA;WACA,iBAAiB;;KAGvB,SAAS,gBAAgB,cAAc;KAEhC,aAAa,gBAAgB,cAAc,SAAS;KAEpD,WAAW,gBAAgB,iBACpC,KAAK,SAAS,YAAY,WAAW,iBAAiB;;;KClD7C,sBAAsB,mBAAmB,oBAAoB;;;;cCzB5D;UAEI;EACf,QAAQ;EACR,QAAQ,aAAa;EACrB,WAAW;;;;;KCeD,YAAY,gBAAgB,cAAc,SACpD,QAAQ,OAAO,aAAa;UAGb,UAAU,gBAAgB;EACzC;EACA,QAAQ,YAAY;;EAEpB;;UAGe,aAAa,gBAAgB;EAC5C;EACA,QAAQ,YAAY;EACpB,QAAQ,QAAQ,WAAW;EAC3B;;UAGe,eAAe,gBAAgB;EAC9C;EACA,QAAQ,YAAY;EACpB,QAAQ,QAAQ,WAAW;;UAGZ,aAAa,gBAAgB;WACnC,KAAK;;;;;;;EAOd,IAAI,OAAO,QAAQ,WAAW,YAAY,QAAQ,UAAU;;EAE5D,IAAI,UAAU,aAAa,UAAU,KAAK,IAAI,WAAW,SAAS;EAClE,UAAU,QAAQ,WAAW;;;;;;;;;EAS7B,UAAU,QAAQ,aAAa;;;;;;;;;;EAU/B,SAAS,QAAQ,QAAQ,WAAW,YAAY,QAAQ,eAAe;EACvE,UAAU,YAAY;EACtB;;UAgDe;EACf,MAAM;EACN,oBAAoB;;EAEpB;;UAGe;EACf,eAAe,gBAAgB,YAAY;IACzC,QAAQ;IACR,gCAAgC,KAAK,aAAa,YAAY;MAC5D,aAAa;;;;;;;iBAQH,UAAU,SAAS,mBAAmB"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/errors.ts","../src/storage/storage.ts","../../shared-types/dist/analytics-ingest.types.d.ts","../src/core/analytics.ts"],"mappings":";;;;;;;;;;;;cAWa,mBAAmB;EAClB,YAAA,iBAAiB,UAAU;;;cAO5B,oBAAoB;EACnB,YAAA,iBAAiB,UAAU;;;cAO5B,uBAAuB;EACtB,YAAA,iBAAiB,UAAU;;;;;cCvB5B;UAEI;EACf,QAAQ;EACR,QAAQ,aAAa;EACrB,WAAW;;;;KCJD;;;;;;;;KAQA,oBAAoB;KACpB;EACR;EACA;;KAsBQ,oBAAoB;EAC5B;;EAEA;EACA,YAAY;EACZ,cAAc;;EAEd;;EAEA;;KAEQ;EACR;EACA;;KAEQ,mBAAmB;EAC3B;EACA,MAAM,eAAe;;KAMb,qBAAqB;EAC7B;EACA;;;;KCpCQ,sBAAsB,mBAAmB,oBAAoB"}