@businessdash/sdk 0.9.60

package/src/vue/index.ts

@@ -0,0 +1,119 @@
+/**
+ * `@businessdash/sdk/vue` — Vue 3 binding surface for the headless
+ * `@businessdash/sdk/forms` core.
+ *
+ * Ship mode: SOURCE. `package.json` points this subpath straight at the `.ts` /
+ * `.vue` source; the consumer's Vite / Nuxt toolchain compiles it (with
+ * `@vitejs/plugin-vue`, which Nuxt enables by default). biab-dev does not
+ * pre-build the Vue binding, so there is no `.vue`-aware step in its own `tsc`
+ * pipeline — keeping the SDK build framework-agnostic.
+ *
+ * Exports:
+ *   - `BiabForm` — the drop-in `<BiabForm slug="…" />` component.
+ *   - `BiabProvider` — optional DI wrapper that `provide()`s a shared
+ *     `BiabClient` so nested `<BiabForm>`s don't each need a `:client` prop.
+ *   - `BIAB_CLIENT_KEY` / `provideBiabClient` / `useBiabClient` — the lower-level
+ *     injection primitives, for consumers who wire DI themselves.
+ *   - the core controller + validation/condition helpers and all form types,
+ *     re-exported so a Vue consumer imports everything from one entry point.
+ */
+
+import {
+	defineComponent,
+	inject,
+	provide,
+	type InjectionKey,
+	type PropType,
+} from "vue";
+
+import type { BiabClient } from "@businessdash/sdk";
+
+import BiabForm from "./BiabForm.vue";
+
+export { BiabForm };
+export default BiabForm;
+
+// ─── Client dependency injection ────────────────────────────────────────────────
+
+/**
+ * Injection key for a shared `BiabClient`. `<BiabForm>` reads this via `inject`
+ * when no `:client` prop is passed, so a single ancestor can provide the client
+ * for an entire subtree.
+ *
+ * NOTE: a `BiabClient` carries the bearer API key. Only provide it in a
+ * browser-safe context (e.g. a public/scoped key, or an app that runs the SDK
+ * exclusively server-side). For SSR setups that keep the key on the server
+ * (e.g. Nuxt), don't provide a client at all — pass `<BiabForm :schema>` +
+ * `:onSubmit` and post through your own server route instead.
+ */
+export const BIAB_CLIENT_KEY: InjectionKey<BiabClient> = Symbol("biab:client");
+
+/** Composable: `provide()` a `BiabClient` to the current component's subtree. */
+export function provideBiabClient(client: BiabClient): void {
+	provide(BIAB_CLIENT_KEY, client);
+}
+
+/** Composable: read the provided `BiabClient` (or `null` when none is set). */
+export function useBiabClient(): BiabClient | null {
+	return inject(BIAB_CLIENT_KEY, null);
+}
+
+/**
+ * `<BiabProvider :client="client">…</BiabProvider>` — optional convenience
+ * wrapper that provides a shared client to every nested `<BiabForm>`. Renders
+ * its default slot unchanged (no extra DOM wrapper).
+ */
+export const BiabProvider = defineComponent({
+	name: "BiabProvider",
+	props: {
+		client: { type: Object as PropType<BiabClient>, required: true },
+	},
+	setup(props, { slots }) {
+		provide(BIAB_CLIENT_KEY, props.client);
+		return () => slots.default?.();
+	},
+});
+
+// ─── Re-export the headless core so Vue consumers import from one place ──────────
+
+export {
+	concurrentRevealCount,
+	createFormController,
+	evalCondition,
+	findMissingRequired,
+	flattenValueFields,
+	isEmpty,
+	isFormFileValue,
+	seedInitialData,
+	toSubmissionPayload,
+	validateFormSubmission,
+	validateValue,
+} from "@businessdash/sdk/forms";
+
+export type { BiabClient } from "@businessdash/sdk";
+
+export type {
+	CreateFormControllerOptions,
+	FieldError,
+	FormActionPreview,
+	FormActionType,
+	FormConditionClause,
+	FormConditionRule,
+	FormController,
+	FormCoreField,
+	FormData,
+	FormFieldDef,
+	FormFileValue,
+	FormRenderSettings,
+	FormSchema,
+	FormSnapshot,
+	FormStatus,
+	FormSubmissionData,
+	FormSubmitFailureReason,
+	FormSubmitOptions,
+	FormSubmitResult,
+	FormValidationIssue,
+	FormValidationResult,
+	MissingField,
+	ResolvedFormSettings,
+} from "@businessdash/sdk/forms";