@verbb/formie-vue 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0
+
+- Initial public release.

package/LICENSE.md

@@ -0,0 +1,40 @@
+Copyright © Verbb
+
+Permission is hereby granted to any person obtaining a copy of this software
+(the “Software”) to use, copy, modify, merge, publish and/or distribute copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+1. **Don’t plagiarize.** The above copyright notice and this license shall be
+   included in all copies or substantial portions of the Software.
+
+2. **Don’t use the same license on more than one project.** Each licensed copy
+   of the Software shall be actively installed in no more than one production
+   environment at a time.
+
+3. **Don’t mess with the licensing features.** Software features related to
+   licensing shall not be altered or circumvented in any way, including (but
+   not limited to) license validation, payment prompts, feature restrictions,
+   and update eligibility.
+
+4. **Pay up.** Payment shall be made immediately upon receipt of any notice,
+   prompt, reminder, or other message indicating that a payment is owed.
+
+5. **Follow the law.** All use of the Software shall not violate any applicable
+   law or regulation, nor infringe the rights of any other person or entity.
+
+Failure to comply with the foregoing conditions will automatically and
+immediately result in termination of the permission granted hereby. This
+license does not include any right to receive updates to the Software or
+technical support. Licensees bear all risk related to the quality and
+performance of the Software and any modifications made or obtained to it,
+including liability for actual and consequential harm, such as loss or
+corruption of data, and any necessary service, repair, or correction.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+LIABILITY, INCLUDING SPECIAL, INCIDENTAL AND CONSEQUENTIAL DAMAGES, WHETHER IN
+AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# @verbb/formie-vue
+
+Vue bindings for Formie's server-rendered and client-rendered front-end packages.
+
+## Install
+
+```bash
+npm install @verbb/formie-browser @verbb/formie-vue vue
+```
+
+## Usage
+
+```ts
+import { FormieForm, FormieClientForm, useFormieHtml } from '@verbb/formie-vue';
+import '@verbb/formie-browser/css/formie.css';
+```
+
+## Public Surface
+
+Use only the root package entry:
+
+- `@verbb/formie-vue`
+
+CSS continues to come from `@verbb/formie-browser`.

package/dist/definition-form.d.ts

@@ -0,0 +1,243 @@
+import { type FrontendFieldDefinition, type FrontendFormDefinition, type FrontendFormEnvelope, type FrontendFormSession, type FrontendFormInstance, type FrontendFormState, type FrontendSubmitResult } from '@verbb/formie-core';
+import { type Component, type ComputedRef, type PropType, type ShallowRef, type VNode } from 'vue';
+export type FormieDefinitionSource = {
+    transport: 'rest';
+    endpoint: string;
+    formHandle: string;
+    siteId?: number;
+} | {
+    transport: 'graphql';
+    endpoint: string;
+    formHandle: string;
+    siteId?: number;
+} | {
+    definition: FrontendFormEnvelope;
+    transport: {
+        type: 'rest';
+        endpoint: string;
+        formHandle: string;
+        siteId?: number;
+    };
+} | {
+    definition: FrontendFormEnvelope;
+    transport: {
+        type: 'graphql';
+        endpoint: string;
+        formHandle: string;
+        siteId?: number;
+    };
+};
+export type FormieVueEvent = {
+    name: string;
+    payload: unknown;
+};
+export type FormieFormComponentProps = {
+    definition: FrontendFormDefinition;
+    session: FrontendFormSession;
+    state: FrontendFormState;
+    className?: string;
+    onSubmit: () => void;
+};
+export type FormiePageComponentProps = {
+    page: FrontendFormDefinition['pages'][number];
+    state: FrontendFormState;
+};
+export type FormieFieldProps = {
+    field: FrontendFieldDefinition;
+    errors: string[];
+};
+export type FormieErrorSummaryProps = {
+    errors: string[];
+};
+export type FormieFieldComponentProps = {
+    field: FrontendFieldDefinition;
+    value: unknown;
+    errors: string[];
+    errorKey: string;
+    disabled: boolean;
+    hidden: boolean;
+    setValue: (value: unknown) => void;
+};
+export type FormieSlotComponentProps = {
+    slotKey: string;
+    attributes?: Record<string, unknown>;
+};
+export type FormieVueComponents = {
+    Form?: Component;
+    Page?: Component;
+    Field?: Component;
+    ErrorSummary?: Component;
+};
+export declare const DefinitionFormView: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    readonly source: {
+        readonly type: PropType<FormieDefinitionSource>;
+        readonly required: true;
+    };
+    readonly components: {
+        readonly type: PropType<FormieVueComponents>;
+        readonly default: () => {};
+    };
+    readonly fieldComponents: {
+        readonly type: PropType<Partial<Record<string, Component>>>;
+        readonly default: () => {};
+    };
+    readonly slots: {
+        readonly type: PropType<Partial<Record<string, Component>>>;
+        readonly default: () => {};
+    };
+    readonly className: {
+        readonly type: StringConstructor;
+        readonly default: any;
+    };
+    readonly onMount: {
+        readonly type: PropType<(instance: FrontendFormInstance) => void>;
+        readonly default: any;
+    };
+    readonly onReady: {
+        readonly type: PropType<(instance: FrontendFormInstance) => void>;
+        readonly default: any;
+    };
+    readonly onUnmount: {
+        readonly type: PropType<() => void>;
+        readonly default: any;
+    };
+    readonly onResult: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onSuccess: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onError: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onSubmitResult: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onSubmitSuccess: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onSubmitError: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onEvent: {
+        readonly type: PropType<(event: FormieVueEvent) => void>;
+        readonly default: any;
+    };
+}>, () => VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("error" | "mount" | "ready" | "unmount" | "result" | "success" | "submit-result" | "submit-success" | "submit-error" | "event")[], "error" | "mount" | "ready" | "unmount" | "result" | "success" | "submit-result" | "submit-success" | "submit-error" | "event", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    readonly source: {
+        readonly type: PropType<FormieDefinitionSource>;
+        readonly required: true;
+    };
+    readonly components: {
+        readonly type: PropType<FormieVueComponents>;
+        readonly default: () => {};
+    };
+    readonly fieldComponents: {
+        readonly type: PropType<Partial<Record<string, Component>>>;
+        readonly default: () => {};
+    };
+    readonly slots: {
+        readonly type: PropType<Partial<Record<string, Component>>>;
+        readonly default: () => {};
+    };
+    readonly className: {
+        readonly type: StringConstructor;
+        readonly default: any;
+    };
+    readonly onMount: {
+        readonly type: PropType<(instance: FrontendFormInstance) => void>;
+        readonly default: any;
+    };
+    readonly onReady: {
+        readonly type: PropType<(instance: FrontendFormInstance) => void>;
+        readonly default: any;
+    };
+    readonly onUnmount: {
+        readonly type: PropType<() => void>;
+        readonly default: any;
+    };
+    readonly onResult: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onSuccess: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onError: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onSubmitResult: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onSubmitSuccess: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onSubmitError: {
+        readonly type: PropType<(result: FrontendSubmitResult) => void>;
+        readonly default: any;
+    };
+    readonly onEvent: {
+        readonly type: PropType<(event: FormieVueEvent) => void>;
+        readonly default: any;
+    };
+}>> & Readonly<{
+    onError?: (...args: any[]) => any;
+    onMount?: (...args: any[]) => any;
+    onReady?: (...args: any[]) => any;
+    onUnmount?: (...args: any[]) => any;
+    onResult?: (...args: any[]) => any;
+    onSuccess?: (...args: any[]) => any;
+    onEvent?: (...args: any[]) => any;
+    "onSubmit-result"?: (...args: any[]) => any;
+    "onSubmit-success"?: (...args: any[]) => any;
+    "onSubmit-error"?: (...args: any[]) => any;
+}>, {
+    readonly onError: (result: FrontendSubmitResult) => void;
+    readonly components: FormieVueComponents;
+    readonly slots: Partial<Record<string, Component>>;
+    readonly className: string;
+    readonly fieldComponents: Partial<Record<string, Component>>;
+    readonly onMount: (instance: FrontendFormInstance) => void;
+    readonly onReady: (instance: FrontendFormInstance) => void;
+    readonly onUnmount: () => void;
+    readonly onResult: (result: FrontendSubmitResult) => void;
+    readonly onSuccess: (result: FrontendSubmitResult) => void;
+    readonly onSubmitResult: (result: FrontendSubmitResult) => void;
+    readonly onSubmitSuccess: (result: FrontendSubmitResult) => void;
+    readonly onSubmitError: (result: FrontendSubmitResult) => void;
+    readonly onEvent: (event: FormieVueEvent) => void;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export declare function useFormie(): {
+    definition: ComputedRef<FrontendFormDefinition>;
+    session: ComputedRef<FrontendFormSession>;
+    state: ShallowRef<FrontendFormState>;
+    instance: ShallowRef<FrontendFormInstance>;
+};
+export declare function useFormieField(fieldId: string): {
+    field: ComputedRef<FrontendFieldDefinition>;
+    value: ComputedRef<unknown>;
+    errors: ComputedRef<string[]>;
+    hidden: ComputedRef<boolean>;
+    disabled: ComputedRef<boolean>;
+    setValue(value: unknown): void;
+};
+export declare function useFormiePage(pageId: string): {
+    page: ComputedRef<import("@verbb/formie-core").FrontendPageDefinition>;
+    isCurrent: ComputedRef<boolean>;
+    hidden: ComputedRef<boolean>;
+};
+export declare function useFormieInstance(): ShallowRef<FrontendFormInstance>;
+export declare function useFormieSlot(key: string): ComputedRef<Component>;
+//# sourceMappingURL=definition-form.d.ts.map

package/dist/definition-form.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition-form.d.ts","sourceRoot":"","sources":["../src/definition-form.ts"],"names":[],"mappings":"AAAA,OAAO,EAcH,KAAK,uBAAuB,EAE5B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EAC5B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAWH,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,QAAQ,EAEb,KAAK,UAAU,EACf,KAAK,KAAK,EACb,MAAM,KAAK,CAAC;AAGb,MAAM,MAAM,sBAAsB,GAC5B;IACE,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,GACC;IACE,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,GACC;IACE,UAAU,EAAE,oBAAoB,CAAC;IACjC,SAAS,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACL,GACC;IACE,UAAU,EAAE,oBAAoB,CAAC;IACjC,SAAS,EAAE;QACP,IAAI,EAAE,SAAS,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACL,CAAC;AAEN,MAAM,MAAM,cAAc,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACnC,UAAU,EAAE,sBAAsB,CAAC;IACnC,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,EAAE,iBAAiB,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACnC,IAAI,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9C,KAAK,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC3B,KAAK,EAAE,uBAAuB,CAAC;IAC/B,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACpC,KAAK,EAAE,uBAAuB,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAC9B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,YAAY,CAAC,EAAE,SAAS,CAAC;CAC5B,CAAC;AAyqCF,eAAO,MAAM,kBAAkB;;uBAzEP,QAAQ,CAAC,sBAAsB,CAAC;;;;uBAIhC,QAAQ,CAAC,mBAAmB,CAAC;;;;uBAI7B,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;;;;uBAI5C,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;;;;;;;;uBAQ1C,QAAQ,CAAC,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIlD,QAAQ,CAAC,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIlD,QAAQ,CAAC,MAAM,IAAI,CAAC;;;;uBAIpB,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;;;;;;;uBAxD3C,QAAQ,CAAC,sBAAsB,CAAC;;;;uBAIhC,QAAQ,CAAC,mBAAmB,CAAC;;;;uBAI7B,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;;;;uBAI5C,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;;;;;;;;uBAQ1C,QAAQ,CAAC,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIlD,QAAQ,CAAC,CAAC,QAAQ,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIlD,QAAQ,CAAC,MAAM,IAAI,CAAC;;;;uBAIpB,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAC;;;;uBAIhD,QAAQ,CAAC,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;;;;;;;;;;;;;;;+BAhBvB,oBAAoB,KAAK,IAAI;;;;;iCApB3B,oBAAoB,KAAK,IAAI;iCAI7B,oBAAoB,KAAK,IAAI;8BAIlC,IAAI;gCAID,oBAAoB,KAAK,IAAI;iCAI7B,oBAAoB,KAAK,IAAI;sCAQ7B,oBAAoB,KAAK,IAAI;uCAI7B,oBAAoB,KAAK,IAAI;qCAI7B,oBAAoB,KAAK,IAAI;8BAI9B,cAAc,KAAK,IAAI;4EA+IhE,CAAC;AAEH,wBAAgB,SAAS;;;;;EASxB;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM;;;;;;oBAmBtB,OAAO;EAQ9B;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM;;;;EAU3C;AAED,wBAAgB,iBAAiB,qCAEhC;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,0BAIxC"}