@solspace/freeform-vue 0.1.17

package/dist/renderers/resolve.d.ts

@@ -0,0 +1,3 @@
+import type { ManifestFieldDefinition } from "@solspace/freeform-core";
+import type { FreeformVueTheme, RendererOverrides, VueFieldRenderer } from "../types.js";
+export declare function resolveFieldRenderer(field: ManifestFieldDefinition, userRenderers?: RendererOverrides, theme?: FreeformVueTheme): VueFieldRenderer;

package/dist/theme/defaultTheme.d.ts

@@ -0,0 +1,3 @@
+import type { FreeformVueTheme } from "../types.js";
+export declare const defaultTheme: FreeformVueTheme;
+export declare function createTheme(overrides?: Partial<FreeformVueTheme>): FreeformVueTheme;

package/dist/theme/mergeClassNames.d.ts

@@ -0,0 +1,3 @@
+import type { ClassNameStrategy } from "../types.js";
+export declare function joinClassNames(...parts: Array<string | undefined | false | null>): string | undefined;
+export declare function mergeClassNames(strategy: ClassNameStrategy, base: string | undefined, extra: string | undefined): string | undefined;

package/dist/theme/resolveThemeClassNames.d.ts

@@ -0,0 +1,7 @@
+import type { ManifestFieldDefinition } from "@solspace/freeform-core";
+import type { FreeformThemeClassNames, FreeformVueTheme } from "../types.js";
+/**
+ * Global classNames, then overlays for field type / frontend renderer / extension.
+ * Error styles append `inputError` onto the control (`optionInput` for choice fields).
+ */
+export declare function resolveThemeClassNames(theme: FreeformVueTheme, field: ManifestFieldDefinition, hasErrors?: boolean): FreeformThemeClassNames;

package/dist/theme/toBemModifier.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Convert Freeform handles / type tokens to BEM modifier segments.
+ * Example: firstName → first-name, multiple-select → multiple-select
+ */
+export declare function toBemModifier(value: string): string;

package/dist/types.d.ts

@@ -0,0 +1,184 @@
+import type { FieldValue, FreeformExtension, FreeformManifest, ManifestCaptchaSecurity, ManifestFieldDefinition, SubmitIntent, SubmitResponse } from "@solspace/freeform-core";
+import type { Component, VNode } from "vue";
+export { PACKAGE_VERSION } from "./version.js";
+export declare const CLIENT_NAME = "@solspace/freeform-vue";
+export type FreeformThemeClassNames = {
+    form?: string;
+    page?: string;
+    row?: string;
+    field?: string;
+    fieldRequired?: string;
+    fieldHidden?: string;
+    fieldHasErrors?: string;
+    label?: string;
+    instructions?: string;
+    input?: string;
+    inputError?: string;
+    optionLabel?: string;
+    optionInput?: string;
+    content?: string;
+    errors?: string;
+    error?: string;
+    buttons?: string;
+    button?: string;
+    submitButton?: string;
+    nextButton?: string;
+    backButton?: string;
+    saveButton?: string;
+    success?: string;
+};
+export type ClassNameStrategy = "merge" | "replace";
+export type VueFieldRendererProps = {
+    field: ManifestFieldDefinition;
+    form: FreeformRuntime;
+    value: FieldValue;
+    errors: string[];
+    input: Record<string, unknown>;
+    classNames: FreeformThemeClassNames;
+    allowRawHtml?: boolean;
+    renderLabel: () => VNode | null;
+    renderInstructions: () => VNode | null;
+    renderErrors: () => VNode | null;
+};
+export type VueFieldRenderer = Component<VueFieldRendererProps>;
+export type RendererOverrides = {
+    handles?: Record<string, VueFieldRenderer>;
+    frontend?: Record<string, VueFieldRenderer>;
+    types?: Record<string, VueFieldRenderer>;
+};
+export type FreeformVueTheme = {
+    name: string;
+    framework: "vue";
+    classNameStrategy?: ClassNameStrategy;
+    classNames?: FreeformThemeClassNames;
+    classNamesByType?: Record<string, Partial<FreeformThemeClassNames>>;
+    renderers?: RendererOverrides & {
+        components?: Partial<FreeformThemeComponents>;
+    };
+    defaults?: {
+        renderLabels?: boolean;
+        renderInstructions?: boolean;
+        renderErrors?: boolean;
+        requiredIndicator?: string;
+        colorScheme?: "light" | "dark" | "system";
+    };
+};
+export type FreeformThemeComponents = {
+    Form: Component<FreeformComponentProps>;
+    Page: Component<FreeformPageProps>;
+    Row: Component<FreeformRowProps>;
+    FieldWrapper: Component<FreeformFieldWrapperProps>;
+    Label: Component<FreeformLabelProps>;
+    Instructions: Component<FreeformInstructionsProps>;
+    Errors: Component<FreeformErrorsProps>;
+    ButtonRow: Component<FreeformButtonRowProps>;
+    SubmitButton: Component<FreeformButtonProps>;
+    NextButton: Component<FreeformButtonProps>;
+    BackButton: Component<FreeformButtonProps>;
+    SaveButton: Component<FreeformButtonProps>;
+    SuccessMessage: Component<{
+        message: string;
+        class?: string;
+    }>;
+    UnsupportedField: Component<VueFieldRendererProps>;
+};
+export type FreeformComponentProps = {
+    form: FreeformRuntime;
+    class?: string;
+    onSubmit: (event: Event) => void;
+};
+export type FreeformPageProps = {
+    form: FreeformRuntime;
+    pageIndex: number;
+    class?: string;
+};
+export type FreeformRowProps = {
+    class?: string;
+};
+export type FreeformFieldWrapperProps = {
+    field: ManifestFieldDefinition;
+    form: FreeformRuntime;
+    class?: string;
+};
+export type FreeformLabelProps = {
+    field: ManifestFieldDefinition;
+    class?: string;
+    requiredIndicator?: string;
+};
+export type FreeformInstructionsProps = {
+    field: ManifestFieldDefinition;
+    class?: string;
+};
+export type FreeformErrorsProps = {
+    errors: string[];
+    class?: string;
+    errorClass?: string;
+};
+export type FreeformButtonRowProps = {
+    class?: string;
+};
+export type FreeformButtonProps = {
+    label: string;
+    class?: string;
+    disabled?: boolean;
+    type?: "button" | "submit";
+    onClick?: () => void;
+};
+export type FreeformRuntime = {
+    manifest: FreeformManifest;
+    values: Record<string, FieldValue>;
+    touched: Record<string, boolean>;
+    fieldErrors: Record<string, string[]>;
+    formErrors: string[];
+    pageErrors: string[];
+    currentPageIndex: number;
+    isSubmitting: boolean;
+    isComplete: boolean;
+    successMessage: string | null;
+    setValue: (handle: string, value: FieldValue) => void;
+    getValue: (handle: string) => FieldValue;
+    isFieldVisible: (handle: string) => boolean;
+    isFieldEnabled: (handle: string) => boolean;
+    getFieldProps: (handle: string) => Record<string, unknown>;
+    submit: (intent?: SubmitIntent) => Promise<SubmitResponse | undefined>;
+    validate: () => Promise<SubmitResponse | undefined>;
+    goNext: () => Promise<SubmitResponse | undefined>;
+    goBack: () => Promise<SubmitResponse | undefined>;
+    saveDraft: () => Promise<SubmitResponse | undefined>;
+    reset: () => void;
+    handleSubmit: (event?: Event) => Promise<void>;
+    mountFieldExtension: (handle: string, element: HTMLElement) => () => void;
+    mountCaptcha: (captcha: ManifestCaptchaSecurity, element: HTMLElement) => () => void;
+};
+export type UseFreeformOptions = {
+    handle?: string;
+    profile?: string;
+    properties?: Record<string, string | number | boolean>;
+    baseUrl: string;
+    manifest?: FreeformManifest;
+    initialValues?: Record<string, FieldValue>;
+    draftToken?: string | null;
+    draftKey?: string | null;
+    clientVersion?: string;
+    fetch?: typeof globalThis.fetch;
+    credentials?: RequestCredentials;
+    theme?: FreeformVueTheme;
+    renderers?: RendererOverrides;
+    extensions?: FreeformExtension[];
+    allowRawHtml?: boolean;
+    onSuccess?: (response: SubmitResponse) => void;
+    onError?: (response: SubmitResponse) => void;
+    onManifestLoaded?: (manifest: FreeformManifest) => void;
+};
+export type UseFreeformResult = {
+    loading: boolean;
+    error: Error | null;
+    manifest: FreeformManifest | null;
+    theme: FreeformVueTheme;
+    renderers: RendererOverrides;
+    allowRawHtml: boolean;
+} & Omit<FreeformRuntime, "manifest">;
+export type FreeformProps = UseFreeformOptions & {
+    class?: string;
+    loadingMessage?: string;
+};

package/dist/utils/securityMeta.d.ts

@@ -0,0 +1,2 @@
+import type { FreeformManifest, SubmitMeta } from "@solspace/freeform-core";
+export declare function buildSecurityMeta(manifest: FreeformManifest): SubmitMeta;

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+/** Kept in sync with package.json by `pnpm frontend:bump`. */
+export declare const PACKAGE_VERSION = "0.1.17";

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@solspace/freeform-vue",
+  "version": "0.1.17",
+  "description": "Vue components and composables for Solspace Freeform headless forms",
+  "private": false,
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "vue-tsc -p tsconfig.build.json --declaration --emitDeclarationOnly && vite build",
+    "dev": "vite build --watch",
+    "test": "vitest run --config vitest.config.ts",
+    "lint": "biome check src"
+  },
+  "peerDependencies": {
+    "@solspace/freeform-core": "^0.1.0",
+    "vue": "^3.5.0"
+  },
+  "devDependencies": {
+    "@solspace/freeform-core": "workspace:*",
+    "@vitejs/plugin-vue": "^6.0.1",
+    "@vitejs/plugin-vue-jsx": "^5.1.1",
+    "@vue/test-utils": "^2.4.6",
+    "jsdom": "29.1.1",
+    "typescript": "^5.8.3",
+    "vite": "^8.1.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "4.1.9",
+    "vue": "^3.5.22",
+    "vue-tsc": "^3.0.7"
+  },
+  "keywords": [
+    "freeform",
+    "craft-cms",
+    "headless",
+    "vue"
+  ],
+  "author": "Solspace Inc.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  }
+}