@evanschleret/formforgeclient 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +94 -0
- package/dist/module.cjs +112 -0
- package/dist/module.d.cts +20 -0
- package/dist/module.d.mts +20 -0
- package/dist/module.d.ts +20 -0
- package/dist/module.json +12 -0
- package/dist/module.mjs +109 -0
- package/dist/runtime/api/categories.d.ts +9 -0
- package/dist/runtime/api/categories.js +83 -0
- package/dist/runtime/api/client.d.ts +45 -0
- package/dist/runtime/api/client.js +148 -0
- package/dist/runtime/api/drafts.d.ts +6 -0
- package/dist/runtime/api/drafts.js +77 -0
- package/dist/runtime/api/http.d.ts +3 -0
- package/dist/runtime/api/http.js +138 -0
- package/dist/runtime/api/index.d.ts +9 -0
- package/dist/runtime/api/index.js +11 -0
- package/dist/runtime/api/management.d.ts +19 -0
- package/dist/runtime/api/management.js +180 -0
- package/dist/runtime/api/request.d.ts +8 -0
- package/dist/runtime/api/request.js +52 -0
- package/dist/runtime/api/responses.d.ts +6 -0
- package/dist/runtime/api/responses.js +61 -0
- package/dist/runtime/api/schema.d.ts +7 -0
- package/dist/runtime/api/schema.js +56 -0
- package/dist/runtime/api/submission.d.ts +11 -0
- package/dist/runtime/api/submission.js +47 -0
- package/dist/runtime/api/upload.d.ts +8 -0
- package/dist/runtime/api/upload.js +37 -0
- package/dist/runtime/composables/index.d.ts +31 -0
- package/dist/runtime/composables/index.js +16 -0
- package/dist/runtime/composables/useFormForgeApi.d.ts +3 -0
- package/dist/runtime/composables/useFormForgeApi.js +4 -0
- package/dist/runtime/composables/useFormForgeBuilder.d.ts +57 -0
- package/dist/runtime/composables/useFormForgeBuilder.js +515 -0
- package/dist/runtime/composables/useFormForgeCategory.d.ts +61 -0
- package/dist/runtime/composables/useFormForgeCategory.js +248 -0
- package/dist/runtime/composables/useFormForgeClient.d.ts +3 -0
- package/dist/runtime/composables/useFormForgeClient.js +200 -0
- package/dist/runtime/composables/useFormForgeDrafts.d.ts +20 -0
- package/dist/runtime/composables/useFormForgeDrafts.js +78 -0
- package/dist/runtime/composables/useFormForgeForm.d.ts +26 -0
- package/dist/runtime/composables/useFormForgeForm.js +114 -0
- package/dist/runtime/composables/useFormForgeGetForm.d.ts +22 -0
- package/dist/runtime/composables/useFormForgeGetForm.js +36 -0
- package/dist/runtime/composables/useFormForgeI18n.d.ts +250 -0
- package/dist/runtime/composables/useFormForgeI18n.js +324 -0
- package/dist/runtime/composables/useFormForgeManagement.d.ts +40 -0
- package/dist/runtime/composables/useFormForgeManagement.js +153 -0
- package/dist/runtime/composables/useFormForgeResolver.d.ts +28 -0
- package/dist/runtime/composables/useFormForgeResolver.js +88 -0
- package/dist/runtime/composables/useFormForgeResponses.d.ts +45 -0
- package/dist/runtime/composables/useFormForgeResponses.js +206 -0
- package/dist/runtime/composables/useFormForgeSchema.d.ts +24 -0
- package/dist/runtime/composables/useFormForgeSchema.js +69 -0
- package/dist/runtime/composables/useFormForgeSubmission.d.ts +12 -0
- package/dist/runtime/composables/useFormForgeSubmission.js +4 -0
- package/dist/runtime/composables/useFormForgeSubmit.d.ts +29 -0
- package/dist/runtime/composables/useFormForgeSubmit.js +291 -0
- package/dist/runtime/composables/useFormForgeUploads.d.ts +21 -0
- package/dist/runtime/composables/useFormForgeUploads.js +37 -0
- package/dist/runtime/composables/useFormForgeWizard.d.ts +20 -0
- package/dist/runtime/composables/useFormForgeWizard.js +83 -0
- package/dist/runtime/index.d.ts +11 -0
- package/dist/runtime/index.js +14 -0
- package/dist/runtime/plugin.d.ts +3 -0
- package/dist/runtime/plugin.js +175 -0
- package/dist/runtime/renderers/default/FormForgeBuilder.d.vue.ts +40 -0
- package/dist/runtime/renderers/default/FormForgeBuilder.vue +1159 -0
- package/dist/runtime/renderers/default/FormForgeBuilder.vue.d.ts +40 -0
- package/dist/runtime/renderers/default/FormForgeCategoryCreateModal.d.vue.ts +16 -0
- package/dist/runtime/renderers/default/FormForgeCategoryCreateModal.vue +129 -0
- package/dist/runtime/renderers/default/FormForgeCategoryCreateModal.vue.d.ts +16 -0
- package/dist/runtime/renderers/default/FormForgeRenderer.d.vue.ts +72 -0
- package/dist/runtime/renderers/default/FormForgeRenderer.vue +1188 -0
- package/dist/runtime/renderers/default/FormForgeRenderer.vue.d.ts +72 -0
- package/dist/runtime/renderers/default/FormForgeResponse.d.vue.ts +18 -0
- package/dist/runtime/renderers/default/FormForgeResponse.vue +744 -0
- package/dist/runtime/renderers/default/FormForgeResponse.vue.d.ts +18 -0
- package/dist/runtime/renderers/default/index.d.ts +5 -0
- package/dist/runtime/renderers/default/index.js +4 -0
- package/dist/runtime/renderers/index.d.ts +2 -0
- package/dist/runtime/renderers/index.js +1 -0
- package/dist/runtime/types/api.d.ts +129 -0
- package/dist/runtime/types/api.js +0 -0
- package/dist/runtime/types/category.d.ts +42 -0
- package/dist/runtime/types/category.js +0 -0
- package/dist/runtime/types/errors.d.ts +16 -0
- package/dist/runtime/types/errors.js +0 -0
- package/dist/runtime/types/index.d.ts +8 -0
- package/dist/runtime/types/index.js +0 -0
- package/dist/runtime/types/json.d.ts +6 -0
- package/dist/runtime/types/json.js +0 -0
- package/dist/runtime/types/management.d.ts +46 -0
- package/dist/runtime/types/management.js +0 -0
- package/dist/runtime/types/nuxt.d.ts +13 -0
- package/dist/runtime/types/nuxt.js +1 -0
- package/dist/runtime/types/schema.d.ts +93 -0
- package/dist/runtime/types/schema.js +0 -0
- package/dist/runtime/utils/category.d.ts +5 -0
- package/dist/runtime/utils/category.js +101 -0
- package/dist/runtime/utils/form-data.d.ts +8 -0
- package/dist/runtime/utils/form-data.js +64 -0
- package/dist/runtime/utils/object.d.ts +8 -0
- package/dist/runtime/utils/object.js +43 -0
- package/dist/runtime/utils/schema.d.ts +3 -0
- package/dist/runtime/utils/schema.js +309 -0
- package/dist/runtime/utils/submission.d.ts +4 -0
- package/dist/runtime/utils/submission.js +45 -0
- package/dist/runtime/validation/errors.d.ts +5 -0
- package/dist/runtime/validation/errors.js +130 -0
- package/dist/runtime/validation/zod.d.ts +6 -0
- package/dist/runtime/validation/zod.js +203 -0
- package/dist/runtime.cjs +16 -0
- package/dist/runtime.d.cts +1 -0
- package/dist/runtime.d.mts +1 -0
- package/dist/runtime.d.ts +1 -0
- package/dist/runtime.mjs +1 -0
- package/dist/types.d.mts +3 -0
- package/package.json +60 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Evan Schleret
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src=".github/assets/banner.png" alt="FormForge banner" width="100%" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">FormForge Client</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
Nuxt 4 client and Nuxt UI v4 renderer for FormForge.
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
<p align="center">
|
|
12
|
+
<a href="https://github.com/EvanSchleret/FormForgeClient/actions/workflows/ci.yml"><img src="https://github.com/EvanSchleret/FormForgeClient/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
|
|
13
|
+
<a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-22c55e" alt="MIT License" /></a>
|
|
14
|
+
<img src="https://img.shields.io/badge/Nuxt-4.x-00DC82" alt="Nuxt 4.x" />
|
|
15
|
+
<img src="https://img.shields.io/badge/Nuxt_UI-4.x-0EA5E9" alt="Nuxt UI 4.x" />
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
## Documentation
|
|
19
|
+
|
|
20
|
+
Full documentation is available at:
|
|
21
|
+
|
|
22
|
+
- [formforge.schleret.ch](https://formforge.schleret.ch)
|
|
23
|
+
|
|
24
|
+
Use this README as a quick start only.
|
|
25
|
+
|
|
26
|
+
## Requirements
|
|
27
|
+
|
|
28
|
+
- Nuxt `4.x`
|
|
29
|
+
- `@nuxt/ui` `4.x`
|
|
30
|
+
- Node.js `>=20` or Bun `>=1.3`
|
|
31
|
+
|
|
32
|
+
## Install
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
bun add @evanschleret/formforgeclient
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Minimal setup
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
// nuxt.config.ts
|
|
42
|
+
export default defineNuxtConfig({
|
|
43
|
+
modules: ['@nuxt/ui', '@evanschleret/formforgeclient'],
|
|
44
|
+
formforgeClient: {
|
|
45
|
+
baseURL: '/api/formforge/v1',
|
|
46
|
+
credentials: 'include'
|
|
47
|
+
}
|
|
48
|
+
})
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Minimal renderer usage
|
|
52
|
+
|
|
53
|
+
```vue
|
|
54
|
+
<script setup lang="ts">
|
|
55
|
+
const route = useRoute()
|
|
56
|
+
</script>
|
|
57
|
+
|
|
58
|
+
<template>
|
|
59
|
+
<FormForgeRenderer :form-key="String(route.params.form)" />
|
|
60
|
+
</template>
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Scoped routes quick example
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
// nuxt.config.ts
|
|
67
|
+
export default defineNuxtConfig({
|
|
68
|
+
formforgeClient: {
|
|
69
|
+
baseURL: '/api/formforge/v1',
|
|
70
|
+
scopedRoutes: {
|
|
71
|
+
team: {
|
|
72
|
+
prefix: 'teams/{team}',
|
|
73
|
+
paramsFromRoute: {
|
|
74
|
+
team: 'team'
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
defaultScope: 'team'
|
|
79
|
+
}
|
|
80
|
+
})
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
const management = useFormForgeManagement()
|
|
85
|
+
|
|
86
|
+
const forms = await management.listForms(false)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Useful links
|
|
90
|
+
|
|
91
|
+
- Backend package: [evanschleret/formforge](https://github.com/EvanSchleret/formforge)
|
|
92
|
+
- Security policy: [SECURITY.md](SECURITY.md)
|
|
93
|
+
- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
94
|
+
- License: [LICENSE](LICENSE)
|
package/dist/module.cjs
ADDED
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const kit = require('@nuxt/kit');
|
|
4
|
+
|
|
5
|
+
var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
|
|
6
|
+
const module$1 = kit.defineNuxtModule({
|
|
7
|
+
meta: {
|
|
8
|
+
name: "@evanschleret/formforgeclient",
|
|
9
|
+
configKey: "formforgeClient",
|
|
10
|
+
compatibility: {
|
|
11
|
+
nuxt: ">=4.0.0"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
defaults: {
|
|
15
|
+
baseURL: "/api/formforge/v1",
|
|
16
|
+
scopedRoutes: {},
|
|
17
|
+
defaultScope: void 0,
|
|
18
|
+
scopeParams: {},
|
|
19
|
+
credentials: "include",
|
|
20
|
+
headers: {},
|
|
21
|
+
uploadMode: "staged",
|
|
22
|
+
datetimeMode: "offset",
|
|
23
|
+
locale: "en",
|
|
24
|
+
autoImports: true
|
|
25
|
+
},
|
|
26
|
+
setup(options, nuxt) {
|
|
27
|
+
const resolver = kit.createResolver((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('module.cjs', document.baseURI).href)));
|
|
28
|
+
const runtimeConfig = nuxt.options.runtimeConfig.public.formforge;
|
|
29
|
+
nuxt.options.runtimeConfig.public.formforge = {
|
|
30
|
+
...runtimeConfig,
|
|
31
|
+
baseURL: options.baseURL,
|
|
32
|
+
baseURLParams: options.baseURLParams,
|
|
33
|
+
scopedRoutes: options.scopedRoutes,
|
|
34
|
+
defaultScope: options.defaultScope,
|
|
35
|
+
scopeParams: options.scopeParams,
|
|
36
|
+
credentials: options.credentials,
|
|
37
|
+
headers: options.headers,
|
|
38
|
+
uploadMode: options.uploadMode,
|
|
39
|
+
datetimeMode: options.datetimeMode,
|
|
40
|
+
locale: options.locale
|
|
41
|
+
};
|
|
42
|
+
kit.addPlugin(resolver.resolve("./runtime/plugin"));
|
|
43
|
+
kit.addComponent({
|
|
44
|
+
name: "FormForgeRenderer",
|
|
45
|
+
filePath: resolver.resolve("./runtime/renderers/default/FormForgeRenderer.vue")
|
|
46
|
+
});
|
|
47
|
+
kit.addComponent({
|
|
48
|
+
name: "FormForgeBuilder",
|
|
49
|
+
filePath: resolver.resolve("./runtime/renderers/default/FormForgeBuilder.vue")
|
|
50
|
+
});
|
|
51
|
+
kit.addComponent({
|
|
52
|
+
name: "FormForgeResponse",
|
|
53
|
+
filePath: resolver.resolve("./runtime/renderers/default/FormForgeResponse.vue")
|
|
54
|
+
});
|
|
55
|
+
kit.addComponent({
|
|
56
|
+
name: "FormForgeCategoryCreateModal",
|
|
57
|
+
filePath: resolver.resolve("./runtime/renderers/default/FormForgeCategoryCreateModal.vue")
|
|
58
|
+
});
|
|
59
|
+
if (options.autoImports === true) {
|
|
60
|
+
kit.addImports([
|
|
61
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeApi"), name: "useFormForgeApi" },
|
|
62
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeClient"), name: "useFormForgeClient" },
|
|
63
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeSchema"), name: "useFormForgeSchema" },
|
|
64
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeGetForm"), name: "useFormForgeGetForm" },
|
|
65
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeI18n"), name: "useFormForgeI18n" },
|
|
66
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeResolver"), name: "useFormForgeResolver" },
|
|
67
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeDrafts"), name: "useFormForgeDrafts" },
|
|
68
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeUploads"), name: "useFormForgeUploads" },
|
|
69
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeForm"), name: "useFormForgeForm" },
|
|
70
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeSubmit"), name: "useFormForgeSubmit" },
|
|
71
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeSubmission"), name: "useFormForgeSubmission" },
|
|
72
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeResponses"), name: "useFormForgeResponses" },
|
|
73
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeCategory"), name: "useFormForgeCategory" },
|
|
74
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeCategory"), name: "useFormForgeCategoryOptions" },
|
|
75
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeManagement"), name: "useFormForgeManagement" },
|
|
76
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeWizard"), name: "useFormForgeWizard" },
|
|
77
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeBuilder"), name: "useFormForgeBuilder" }
|
|
78
|
+
]);
|
|
79
|
+
}
|
|
80
|
+
const typeTemplate = kit.addTypeTemplate({
|
|
81
|
+
filename: "types/formforge-client.d.ts",
|
|
82
|
+
getContents: () => `
|
|
83
|
+
import type { FormForgeBeforeRequestContext, FormForgeClient } from '@evanschleret/formforgeclient/runtime'
|
|
84
|
+
|
|
85
|
+
declare module '#app' {
|
|
86
|
+
interface NuxtApp {
|
|
87
|
+
$formforge: FormForgeClient
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
interface RuntimeNuxtHooks {
|
|
91
|
+
'formforge:beforeRequest': (context: FormForgeBeforeRequestContext) => void | Promise<void>
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
declare module 'vue' {
|
|
96
|
+
interface ComponentCustomProperties {
|
|
97
|
+
$formforge: FormForgeClient
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export {}
|
|
102
|
+
`
|
|
103
|
+
});
|
|
104
|
+
nuxt.hook("prepare:types", ({ references }) => {
|
|
105
|
+
references.push({
|
|
106
|
+
path: typeTemplate.dst
|
|
107
|
+
});
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
module.exports = module$1;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import * as _nuxt_schema from '@nuxt/schema';
|
|
2
|
+
import { FormForgeScopedRouteMap, FormForgeScopeParams, FormForgeUploadMode, FormForgeDatetimeMode } from '../dist/runtime/types/index.js';
|
|
3
|
+
|
|
4
|
+
interface ModuleOptions {
|
|
5
|
+
baseURL?: string;
|
|
6
|
+
baseURLParams?: Record<string, string | number | undefined>;
|
|
7
|
+
scopedRoutes?: FormForgeScopedRouteMap;
|
|
8
|
+
defaultScope?: string;
|
|
9
|
+
scopeParams?: FormForgeScopeParams;
|
|
10
|
+
credentials?: RequestCredentials;
|
|
11
|
+
headers?: Record<string, string>;
|
|
12
|
+
uploadMode?: FormForgeUploadMode;
|
|
13
|
+
datetimeMode?: FormForgeDatetimeMode;
|
|
14
|
+
locale?: string;
|
|
15
|
+
autoImports?: boolean;
|
|
16
|
+
}
|
|
17
|
+
declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
|
|
18
|
+
|
|
19
|
+
export = _default;
|
|
20
|
+
export type { ModuleOptions };
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import * as _nuxt_schema from '@nuxt/schema';
|
|
2
|
+
import { FormForgeScopedRouteMap, FormForgeScopeParams, FormForgeUploadMode, FormForgeDatetimeMode } from '../dist/runtime/types/index.js';
|
|
3
|
+
|
|
4
|
+
interface ModuleOptions {
|
|
5
|
+
baseURL?: string;
|
|
6
|
+
baseURLParams?: Record<string, string | number | undefined>;
|
|
7
|
+
scopedRoutes?: FormForgeScopedRouteMap;
|
|
8
|
+
defaultScope?: string;
|
|
9
|
+
scopeParams?: FormForgeScopeParams;
|
|
10
|
+
credentials?: RequestCredentials;
|
|
11
|
+
headers?: Record<string, string>;
|
|
12
|
+
uploadMode?: FormForgeUploadMode;
|
|
13
|
+
datetimeMode?: FormForgeDatetimeMode;
|
|
14
|
+
locale?: string;
|
|
15
|
+
autoImports?: boolean;
|
|
16
|
+
}
|
|
17
|
+
declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
|
|
18
|
+
|
|
19
|
+
export { _default as default };
|
|
20
|
+
export type { ModuleOptions };
|
package/dist/module.d.ts
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import * as _nuxt_schema from '@nuxt/schema';
|
|
2
|
+
import { FormForgeScopedRouteMap, FormForgeScopeParams, FormForgeUploadMode, FormForgeDatetimeMode } from '../dist/runtime/types/index.js';
|
|
3
|
+
|
|
4
|
+
interface ModuleOptions {
|
|
5
|
+
baseURL?: string;
|
|
6
|
+
baseURLParams?: Record<string, string | number | undefined>;
|
|
7
|
+
scopedRoutes?: FormForgeScopedRouteMap;
|
|
8
|
+
defaultScope?: string;
|
|
9
|
+
scopeParams?: FormForgeScopeParams;
|
|
10
|
+
credentials?: RequestCredentials;
|
|
11
|
+
headers?: Record<string, string>;
|
|
12
|
+
uploadMode?: FormForgeUploadMode;
|
|
13
|
+
datetimeMode?: FormForgeDatetimeMode;
|
|
14
|
+
locale?: string;
|
|
15
|
+
autoImports?: boolean;
|
|
16
|
+
}
|
|
17
|
+
declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
|
|
18
|
+
|
|
19
|
+
export = _default;
|
|
20
|
+
export type { ModuleOptions };
|
package/dist/module.json
ADDED
package/dist/module.mjs
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { defineNuxtModule, createResolver, addPlugin, addComponent, addImports, addTypeTemplate } from '@nuxt/kit';
|
|
2
|
+
|
|
3
|
+
const module$1 = defineNuxtModule({
|
|
4
|
+
meta: {
|
|
5
|
+
name: "@evanschleret/formforgeclient",
|
|
6
|
+
configKey: "formforgeClient",
|
|
7
|
+
compatibility: {
|
|
8
|
+
nuxt: ">=4.0.0"
|
|
9
|
+
}
|
|
10
|
+
},
|
|
11
|
+
defaults: {
|
|
12
|
+
baseURL: "/api/formforge/v1",
|
|
13
|
+
scopedRoutes: {},
|
|
14
|
+
defaultScope: void 0,
|
|
15
|
+
scopeParams: {},
|
|
16
|
+
credentials: "include",
|
|
17
|
+
headers: {},
|
|
18
|
+
uploadMode: "staged",
|
|
19
|
+
datetimeMode: "offset",
|
|
20
|
+
locale: "en",
|
|
21
|
+
autoImports: true
|
|
22
|
+
},
|
|
23
|
+
setup(options, nuxt) {
|
|
24
|
+
const resolver = createResolver(import.meta.url);
|
|
25
|
+
const runtimeConfig = nuxt.options.runtimeConfig.public.formforge;
|
|
26
|
+
nuxt.options.runtimeConfig.public.formforge = {
|
|
27
|
+
...runtimeConfig,
|
|
28
|
+
baseURL: options.baseURL,
|
|
29
|
+
baseURLParams: options.baseURLParams,
|
|
30
|
+
scopedRoutes: options.scopedRoutes,
|
|
31
|
+
defaultScope: options.defaultScope,
|
|
32
|
+
scopeParams: options.scopeParams,
|
|
33
|
+
credentials: options.credentials,
|
|
34
|
+
headers: options.headers,
|
|
35
|
+
uploadMode: options.uploadMode,
|
|
36
|
+
datetimeMode: options.datetimeMode,
|
|
37
|
+
locale: options.locale
|
|
38
|
+
};
|
|
39
|
+
addPlugin(resolver.resolve("./runtime/plugin"));
|
|
40
|
+
addComponent({
|
|
41
|
+
name: "FormForgeRenderer",
|
|
42
|
+
filePath: resolver.resolve("./runtime/renderers/default/FormForgeRenderer.vue")
|
|
43
|
+
});
|
|
44
|
+
addComponent({
|
|
45
|
+
name: "FormForgeBuilder",
|
|
46
|
+
filePath: resolver.resolve("./runtime/renderers/default/FormForgeBuilder.vue")
|
|
47
|
+
});
|
|
48
|
+
addComponent({
|
|
49
|
+
name: "FormForgeResponse",
|
|
50
|
+
filePath: resolver.resolve("./runtime/renderers/default/FormForgeResponse.vue")
|
|
51
|
+
});
|
|
52
|
+
addComponent({
|
|
53
|
+
name: "FormForgeCategoryCreateModal",
|
|
54
|
+
filePath: resolver.resolve("./runtime/renderers/default/FormForgeCategoryCreateModal.vue")
|
|
55
|
+
});
|
|
56
|
+
if (options.autoImports === true) {
|
|
57
|
+
addImports([
|
|
58
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeApi"), name: "useFormForgeApi" },
|
|
59
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeClient"), name: "useFormForgeClient" },
|
|
60
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeSchema"), name: "useFormForgeSchema" },
|
|
61
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeGetForm"), name: "useFormForgeGetForm" },
|
|
62
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeI18n"), name: "useFormForgeI18n" },
|
|
63
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeResolver"), name: "useFormForgeResolver" },
|
|
64
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeDrafts"), name: "useFormForgeDrafts" },
|
|
65
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeUploads"), name: "useFormForgeUploads" },
|
|
66
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeForm"), name: "useFormForgeForm" },
|
|
67
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeSubmit"), name: "useFormForgeSubmit" },
|
|
68
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeSubmission"), name: "useFormForgeSubmission" },
|
|
69
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeResponses"), name: "useFormForgeResponses" },
|
|
70
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeCategory"), name: "useFormForgeCategory" },
|
|
71
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeCategory"), name: "useFormForgeCategoryOptions" },
|
|
72
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeManagement"), name: "useFormForgeManagement" },
|
|
73
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeWizard"), name: "useFormForgeWizard" },
|
|
74
|
+
{ from: resolver.resolve("./runtime/composables/useFormForgeBuilder"), name: "useFormForgeBuilder" }
|
|
75
|
+
]);
|
|
76
|
+
}
|
|
77
|
+
const typeTemplate = addTypeTemplate({
|
|
78
|
+
filename: "types/formforge-client.d.ts",
|
|
79
|
+
getContents: () => `
|
|
80
|
+
import type { FormForgeBeforeRequestContext, FormForgeClient } from '@evanschleret/formforgeclient/runtime'
|
|
81
|
+
|
|
82
|
+
declare module '#app' {
|
|
83
|
+
interface NuxtApp {
|
|
84
|
+
$formforge: FormForgeClient
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
interface RuntimeNuxtHooks {
|
|
88
|
+
'formforge:beforeRequest': (context: FormForgeBeforeRequestContext) => void | Promise<void>
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
declare module 'vue' {
|
|
93
|
+
interface ComponentCustomProperties {
|
|
94
|
+
$formforge: FormForgeClient
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export {}
|
|
99
|
+
`
|
|
100
|
+
});
|
|
101
|
+
nuxt.hook("prepare:types", ({ references }) => {
|
|
102
|
+
references.push({
|
|
103
|
+
path: typeTemplate.dst
|
|
104
|
+
});
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
export { module$1 as default };
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { FormForgeCategory, FormForgeCategoryCreateInput, FormForgeCategoryListQuery, FormForgeCategoryListResponse, FormForgeCategoryUpdateInput, FormForgeHttpAdapter } from '../types/index.js';
|
|
2
|
+
import type { FormForgeMutationOptions } from './management.js';
|
|
3
|
+
import { type FormForgeRequestOptions } from './request.js';
|
|
4
|
+
export declare function fetchFormForgeCategories(http: FormForgeHttpAdapter, query?: FormForgeCategoryListQuery, options?: FormForgeRequestOptions): Promise<FormForgeCategoryListResponse>;
|
|
5
|
+
export declare function fetchFormForgeCategory(http: FormForgeHttpAdapter, categoryKey: string, options?: FormForgeRequestOptions): Promise<FormForgeCategory>;
|
|
6
|
+
export declare function createFormForgeCategory(http: FormForgeHttpAdapter, input: FormForgeCategoryCreateInput, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;
|
|
7
|
+
export declare function patchFormForgeCategory(http: FormForgeHttpAdapter, categoryKey: string, input: FormForgeCategoryUpdateInput, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;
|
|
8
|
+
export declare function deleteFormForgeCategory(http: FormForgeHttpAdapter, categoryKey: string, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;
|
|
9
|
+
//# sourceMappingURL=categories.d.ts.map
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { normalizeFormForgeCategory, normalizeFormForgeCategoryListResponse } from "../utils/category.js";
|
|
2
|
+
import { pickFormForgeDataEnvelope } from "../utils/object.js";
|
|
3
|
+
import { resolveEndpointPath } from "./request.js";
|
|
4
|
+
function withMutationHeaders(options = {}) {
|
|
5
|
+
if (options.idempotencyKey === void 0 || options.idempotencyKey === "") {
|
|
6
|
+
return {};
|
|
7
|
+
}
|
|
8
|
+
return {
|
|
9
|
+
"Idempotency-Key": options.idempotencyKey
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
function toJsonObject(input) {
|
|
13
|
+
return JSON.parse(JSON.stringify(input));
|
|
14
|
+
}
|
|
15
|
+
function normalizeSingleCategory(payload) {
|
|
16
|
+
const dataEnvelope = pickFormForgeDataEnvelope(payload);
|
|
17
|
+
const normalized = normalizeFormForgeCategory(dataEnvelope);
|
|
18
|
+
if (normalized !== null) {
|
|
19
|
+
return normalized;
|
|
20
|
+
}
|
|
21
|
+
return {
|
|
22
|
+
id: 0,
|
|
23
|
+
key: "",
|
|
24
|
+
name: "",
|
|
25
|
+
description: null,
|
|
26
|
+
is_active: false,
|
|
27
|
+
meta: {},
|
|
28
|
+
created_at: null,
|
|
29
|
+
updated_at: null
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
export async function fetchFormForgeCategories(http, query = {}, options = {}) {
|
|
33
|
+
const resolvedQuery = {
|
|
34
|
+
per_page: query.per_page,
|
|
35
|
+
search: query.search,
|
|
36
|
+
is_active: query.is_active === void 0 ? void 0 : query.is_active ? 1 : 0
|
|
37
|
+
};
|
|
38
|
+
const response = await http({
|
|
39
|
+
path: resolveEndpointPath(options.endpoint, "/categories", {}, options.scope),
|
|
40
|
+
method: "GET",
|
|
41
|
+
query: resolvedQuery
|
|
42
|
+
});
|
|
43
|
+
return normalizeFormForgeCategoryListResponse(response.data);
|
|
44
|
+
}
|
|
45
|
+
export async function fetchFormForgeCategory(http, categoryKey, options = {}) {
|
|
46
|
+
const response = await http({
|
|
47
|
+
path: resolveEndpointPath(options.endpoint, `/categories/${categoryKey}`, {
|
|
48
|
+
categoryKey
|
|
49
|
+
}, options.scope),
|
|
50
|
+
method: "GET"
|
|
51
|
+
});
|
|
52
|
+
return normalizeSingleCategory(response.data);
|
|
53
|
+
}
|
|
54
|
+
export async function createFormForgeCategory(http, input, options = {}) {
|
|
55
|
+
const response = await http({
|
|
56
|
+
path: resolveEndpointPath(options.endpoint, "/categories", {}, options.scope),
|
|
57
|
+
method: "POST",
|
|
58
|
+
headers: withMutationHeaders(options),
|
|
59
|
+
json: toJsonObject(input)
|
|
60
|
+
});
|
|
61
|
+
return normalizeSingleCategory(response.data);
|
|
62
|
+
}
|
|
63
|
+
export async function patchFormForgeCategory(http, categoryKey, input, options = {}) {
|
|
64
|
+
const response = await http({
|
|
65
|
+
path: resolveEndpointPath(options.endpoint, `/categories/${categoryKey}`, {
|
|
66
|
+
categoryKey
|
|
67
|
+
}, options.scope),
|
|
68
|
+
method: "PATCH",
|
|
69
|
+
headers: withMutationHeaders(options),
|
|
70
|
+
json: toJsonObject(input)
|
|
71
|
+
});
|
|
72
|
+
return normalizeSingleCategory(response.data);
|
|
73
|
+
}
|
|
74
|
+
export async function deleteFormForgeCategory(http, categoryKey, options = {}) {
|
|
75
|
+
const response = await http({
|
|
76
|
+
path: resolveEndpointPath(options.endpoint, `/categories/${categoryKey}`, {
|
|
77
|
+
categoryKey
|
|
78
|
+
}, options.scope),
|
|
79
|
+
method: "DELETE",
|
|
80
|
+
headers: withMutationHeaders(options)
|
|
81
|
+
});
|
|
82
|
+
return normalizeSingleCategory(response.data);
|
|
83
|
+
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import type { FormForgeCategory, FormForgeCategoryCreateInput, FormForgeCategoryListQuery, FormForgeCategoryListResponse, FormForgeCategoryUpdateInput, FormForgeClientConfig, FormForgeDraftResponse, FormForgeDraftSaveInput, FormForgeDiffResponse, FormForgeFormSchema, FormForgeJsonObject, FormForgeManagementCreateInput, FormForgeManagementForm, FormForgeManagementPatchInput, FormForgeResolveInput, FormForgeResponsesListResponse, FormForgeRevisionSummary, FormForgeSchemaVersionsResponse, FormForgeStageUploadInput, FormForgeStagedUploadResponse, FormForgeSubmitInput, FormForgeSubmissionResponse } from '../types/index.js';
|
|
2
|
+
import { type FormForgeManagementRequestOptions, type FormForgeMutationOptions } from './management.js';
|
|
3
|
+
import type { FormForgeRequestOptions } from './request.js';
|
|
4
|
+
export interface FormForgeSubmitRequestOptions extends FormForgeRequestOptions {
|
|
5
|
+
version?: string;
|
|
6
|
+
}
|
|
7
|
+
export interface FormForgeSubmitMultipartOptions extends FormForgeRequestOptions {
|
|
8
|
+
version?: string;
|
|
9
|
+
test?: boolean;
|
|
10
|
+
}
|
|
11
|
+
export type FormForgeSchemaRequestOptions = FormForgeRequestOptions;
|
|
12
|
+
export type FormForgeDraftRequestOptions = FormForgeRequestOptions;
|
|
13
|
+
export type FormForgeResponsesRequestOptions = FormForgeRequestOptions;
|
|
14
|
+
export type FormForgeCategoryRequestOptions = FormForgeRequestOptions;
|
|
15
|
+
export interface FormForgeClient {
|
|
16
|
+
config: Readonly<FormForgeClientConfig>;
|
|
17
|
+
getForm(key: string, options?: FormForgeSchemaRequestOptions): Promise<FormForgeFormSchema>;
|
|
18
|
+
getFormVersions(key: string, options?: FormForgeSchemaRequestOptions): Promise<FormForgeSchemaVersionsResponse>;
|
|
19
|
+
getFormVersion(key: string, version: string, options?: FormForgeSchemaRequestOptions): Promise<FormForgeFormSchema>;
|
|
20
|
+
resolveForm(key: string, input?: FormForgeResolveInput, options?: FormForgeSubmitRequestOptions): Promise<FormForgeFormSchema>;
|
|
21
|
+
submitForm(key: string, input: FormForgeSubmitInput, options?: FormForgeSubmitRequestOptions): Promise<FormForgeSubmissionResponse>;
|
|
22
|
+
submitFormMultipart(key: string, formData: FormData, options?: FormForgeSubmitMultipartOptions): Promise<FormForgeSubmissionResponse>;
|
|
23
|
+
stageUpload(key: string, input: FormForgeStageUploadInput, options?: FormForgeSubmitRequestOptions): Promise<FormForgeStagedUploadResponse>;
|
|
24
|
+
saveDraft(key: string, input: FormForgeDraftSaveInput, options?: FormForgeDraftRequestOptions): Promise<FormForgeDraftResponse>;
|
|
25
|
+
getCurrentDraft(key: string, options?: FormForgeDraftRequestOptions): Promise<FormForgeDraftResponse>;
|
|
26
|
+
deleteCurrentDraft(key: string, options?: FormForgeDraftRequestOptions): Promise<FormForgeDraftResponse>;
|
|
27
|
+
listResponses(key: string, query?: Record<string, string | number | boolean | undefined>, options?: FormForgeResponsesRequestOptions): Promise<FormForgeResponsesListResponse>;
|
|
28
|
+
getResponse(key: string, submissionId: string, options?: FormForgeResponsesRequestOptions): Promise<FormForgeJsonObject>;
|
|
29
|
+
deleteResponse(key: string, submissionId: string, options?: FormForgeResponsesRequestOptions): Promise<FormForgeJsonObject>;
|
|
30
|
+
listForms(includeDeleted?: boolean, options?: FormForgeManagementRequestOptions): Promise<FormForgeManagementForm[]>;
|
|
31
|
+
createForm(input: FormForgeManagementCreateInput, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
|
|
32
|
+
patchForm(key: string, input: FormForgeManagementPatchInput, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
|
|
33
|
+
publishForm(key: string, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
|
|
34
|
+
unpublishForm(key: string, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
|
|
35
|
+
deleteForm(key: string, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
|
|
36
|
+
getRevisions(key: string, includeDeleted?: boolean, options?: FormForgeManagementRequestOptions): Promise<FormForgeRevisionSummary[]>;
|
|
37
|
+
getDiff(key: string, fromVersion: number, toVersion: number, options?: FormForgeManagementRequestOptions): Promise<FormForgeDiffResponse>;
|
|
38
|
+
listCategories(query?: FormForgeCategoryListQuery, options?: FormForgeCategoryRequestOptions): Promise<FormForgeCategoryListResponse>;
|
|
39
|
+
getCategory(categoryKey: string, options?: FormForgeCategoryRequestOptions): Promise<FormForgeCategory>;
|
|
40
|
+
createCategory(input: FormForgeCategoryCreateInput, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;
|
|
41
|
+
patchCategory(categoryKey: string, input: FormForgeCategoryUpdateInput, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;
|
|
42
|
+
deleteCategory(categoryKey: string, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;
|
|
43
|
+
}
|
|
44
|
+
export declare function createFormForgeClient(config?: FormForgeClientConfig): FormForgeClient;
|
|
45
|
+
//# sourceMappingURL=client.d.ts.map
|