@evanschleret/formforgeclient 1.1.3 → 1.2.0

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": ">=4.0.0"
   },
-  "version": "1.1.3",
+  "version": "1.2.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/runtime/api/categories.d.ts

@@ -2,6 +2,7 @@ import type { FormForgeCategory, FormForgeCategoryCreateInput, FormForgeCategory
 import type { FormForgeMutationOptions } from './management.js';
 import { type FormForgeRequestOptions } from './request.js';
 export declare function fetchFormForgeCategories(http: FormForgeHttpAdapter, query?: FormForgeCategoryListQuery, options?: FormForgeRequestOptions): Promise<FormForgeCategoryListResponse>;
+export declare function fetchFormForgeCategoryRoute(http: FormForgeHttpAdapter, routeKey: string, query?: FormForgeCategoryListQuery, options?: FormForgeRequestOptions): Promise<FormForgeCategoryListResponse>;
 export declare function fetchFormForgeCategory(http: FormForgeHttpAdapter, categoryKey: string, options?: FormForgeRequestOptions): Promise<FormForgeCategory>;
 export declare function createFormForgeCategory(http: FormForgeHttpAdapter, input: FormForgeCategoryCreateInput, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;
 export declare function patchFormForgeCategory(http: FormForgeHttpAdapter, categoryKey: string, input: FormForgeCategoryUpdateInput, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;

package/dist/runtime/api/categories.js

@@ -42,6 +42,17 @@ export async function fetchFormForgeCategories(http, query = {}, options = {}) {
   });
   return normalizeFormForgeCategoryListResponse(response.data);
 }
+export async function fetchFormForgeCategoryRoute(http, routeKey, query = {}, options = {}) {
+  const resolvedQuery = {
+    per_page: query.per_page
+  };
+  const response = await http({
+    path: resolveEndpointPath(options.endpoint, `/category-routes/${routeKey}`, { routeKey }, options.scope),
+    method: "GET",
+    query: resolvedQuery
+  });
+  return normalizeFormForgeCategoryListResponse(response.data);
+}
 export async function fetchFormForgeCategory(http, categoryKey, options = {}) {
   const response = await http({
     path: resolveEndpointPath(options.endpoint, `/categories/${categoryKey}`, {

package/dist/runtime/api/client.d.ts

@@ -28,6 +28,7 @@ export interface FormForgeClient {
     getResponse(key: string, submissionId: string, options?: FormForgeResponsesRequestOptions): Promise<FormForgeJsonObject>;
     deleteResponse(key: string, submissionId: string, options?: FormForgeResponsesRequestOptions): Promise<FormForgeJsonObject>;
     listForms(includeDeleted?: boolean, options?: FormForgeManagementRequestOptions): Promise<FormForgeManagementForm[]>;
+    listFormRoute(routeKey: string, options?: FormForgeManagementRequestOptions): Promise<FormForgeManagementForm[]>;
     createForm(input: FormForgeManagementCreateInput, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
     patchForm(key: string, input: FormForgeManagementPatchInput, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
     publishForm(key: string, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
@@ -36,6 +37,7 @@ export interface FormForgeClient {
     getRevisions(key: string, includeDeleted?: boolean, options?: FormForgeManagementRequestOptions): Promise<FormForgeRevisionSummary[]>;
     getDiff(key: string, fromVersion: number, toVersion: number, options?: FormForgeManagementRequestOptions): Promise<FormForgeDiffResponse>;
     listCategories(query?: FormForgeCategoryListQuery, options?: FormForgeCategoryRequestOptions): Promise<FormForgeCategoryListResponse>;
+    listCategoryRoute(routeKey: string, query?: FormForgeCategoryListQuery, options?: FormForgeCategoryRequestOptions): Promise<FormForgeCategoryListResponse>;
     getCategory(categoryKey: string, options?: FormForgeCategoryRequestOptions): Promise<FormForgeCategory>;
     createCategory(input: FormForgeCategoryCreateInput, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;
     patchCategory(categoryKey: string, input: FormForgeCategoryUpdateInput, options?: FormForgeMutationOptions): Promise<FormForgeCategory>;

package/dist/runtime/api/client.js

@@ -1,7 +1,7 @@
 import { createFormForgeHttpAdapter } from "./http.js";
 import { deleteCurrentFormForgeDraft, fetchCurrentFormForgeDraft, saveFormForgeDraft } from "./drafts.js";
-import { fetchFormForgeDiff, fetchFormForgeForms, fetchFormForgeRevisions, createFormForgeForm, deleteFormForgeForm, patchFormForgeForm, publishFormForgeForm, unpublishFormForgeForm } from "./management.js";
-import { createFormForgeCategory, deleteFormForgeCategory, fetchFormForgeCategories, fetchFormForgeCategory, patchFormForgeCategory } from "./categories.js";
+import { fetchFormForgeDiff, fetchFormForgeFormRoute, fetchFormForgeForms, fetchFormForgeRevisions, createFormForgeForm, deleteFormForgeForm, patchFormForgeForm, publishFormForgeForm, unpublishFormForgeForm } from "./management.js";
+import { createFormForgeCategory, deleteFormForgeCategory, fetchFormForgeCategories, fetchFormForgeCategory, fetchFormForgeCategoryRoute, patchFormForgeCategory } from "./categories.js";
 import { fetchFormForgeSchema, fetchFormForgeSchemaVersion, fetchFormForgeSchemaVersions, resolveFormForgeSchema } from "./schema.js";
 import { deleteFormForgeResponse, fetchFormForgeResponse, fetchFormForgeResponses } from "./responses.js";
 import { submitFormForgeJson, submitFormForgeMultipart } from "./submission.js";
@@ -116,6 +116,9 @@ class FormForgeClientImpl {
   async listForms(includeDeleted = false, options = {}) {
     return fetchFormForgeForms(this.http, includeDeleted, this.withRequestScope(options));
   }
+  async listFormRoute(routeKey, options = {}) {
+    return fetchFormForgeFormRoute(this.http, routeKey, this.withRequestScope(options));
+  }
   async createForm(input, options = {}) {
     return createFormForgeForm(this.http, input, this.withRequestScope(options));
   }
@@ -140,6 +143,9 @@ class FormForgeClientImpl {
   async listCategories(query = {}, options = {}) {
     return fetchFormForgeCategories(this.http, query, this.withRequestScope(options));
   }
+  async listCategoryRoute(routeKey, query = {}, options = {}) {
+    return fetchFormForgeCategoryRoute(this.http, routeKey, query, this.withRequestScope(options));
+  }
   async getCategory(categoryKey, options = {}) {
     return fetchFormForgeCategory(this.http, categoryKey, this.withRequestScope(options));
   }

package/dist/runtime/api/index.d.ts

@@ -2,7 +2,8 @@ export { createFormForgeClient } from './client.js';
 export { resolveFormForgeSchema, fetchFormForgeSchema, fetchFormForgeSchemaVersion, fetchFormForgeSchemaVersions } from './schema.js';
 export { saveFormForgeDraft, fetchCurrentFormForgeDraft, deleteCurrentFormForgeDraft } from './drafts.js';
 export { fetchFormForgeResponses, fetchFormForgeResponse, deleteFormForgeResponse } from './responses.js';
-export { fetchFormForgeCategories, fetchFormForgeCategory, createFormForgeCategory, patchFormForgeCategory, deleteFormForgeCategory } from './categories.js';
+export { fetchFormForgeFormRoute } from './management.js';
+export { fetchFormForgeCategories, fetchFormForgeCategoryRoute, fetchFormForgeCategory, createFormForgeCategory, patchFormForgeCategory, deleteFormForgeCategory } from './categories.js';
 export type { FormForgeClient, FormForgeSubmitRequestOptions, FormForgeSubmitMultipartOptions } from './client.js';
 export type { FormForgeMutationOptions, FormForgeManagementRequestOptions } from './management.js';
 export type { FormForgeRequestOptions } from './request.js';

package/dist/runtime/api/index.js

@@ -2,8 +2,10 @@ export { createFormForgeClient } from "./client.js";
 export { resolveFormForgeSchema, fetchFormForgeSchema, fetchFormForgeSchemaVersion, fetchFormForgeSchemaVersions } from "./schema.js";
 export { saveFormForgeDraft, fetchCurrentFormForgeDraft, deleteCurrentFormForgeDraft } from "./drafts.js";
 export { fetchFormForgeResponses, fetchFormForgeResponse, deleteFormForgeResponse } from "./responses.js";
+export { fetchFormForgeFormRoute } from "./management.js";
 export {
   fetchFormForgeCategories,
+  fetchFormForgeCategoryRoute,
   fetchFormForgeCategory,
   createFormForgeCategory,
   patchFormForgeCategory,

package/dist/runtime/api/management.d.ts

@@ -10,6 +10,7 @@ export interface FormForgeManagementRequestOptions extends FormForgeRequestOptio
 }
 export declare function createFormForgeForm(http: FormForgeHttpAdapter, input: FormForgeManagementCreateInput, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
 export declare function fetchFormForgeForms(http: FormForgeHttpAdapter, includeDeleted?: boolean, options?: FormForgeManagementRequestOptions): Promise<FormForgeManagementForm[]>;
+export declare function fetchFormForgeFormRoute(http: FormForgeHttpAdapter, routeKey: string, options?: FormForgeManagementRequestOptions): Promise<FormForgeManagementForm[]>;
 export declare function patchFormForgeForm(http: FormForgeHttpAdapter, key: string, input: FormForgeManagementPatchInput, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
 export declare function publishFormForgeForm(http: FormForgeHttpAdapter, key: string, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;
 export declare function unpublishFormForgeForm(http: FormForgeHttpAdapter, key: string, options?: FormForgeMutationOptions): Promise<FormForgeManagementForm>;

package/dist/runtime/api/management.js

@@ -92,6 +92,15 @@ export async function fetchFormForgeForms(http, includeDeleted = false, options
   });
   return normalizeFormsList(response.data);
 }
+export async function fetchFormForgeFormRoute(http, routeKey, options = {}) {
+  const filters = options.filters ?? {};
+  const response = await http({
+    path: resolveEndpointPath(options.endpoint, `/form-routes/${routeKey}`, { routeKey }, options.scope),
+    method: "GET",
+    query: filters
+  });
+  return normalizeFormsList(response.data);
+}
 export async function patchFormForgeForm(http, key, input, options = {}) {
   const response = await http({
     path: resolveEndpointPath(options.endpoint, `/forms/${key}`, {

package/dist/runtime/composables/useFormForgeCategory.d.ts

@@ -4,6 +4,7 @@ import type { FormForgeMutationOptions } from '../api/management.js';
 export interface UseFormForgeCategoryOptions {
     immediate?: boolean;
     initialQuery?: FormForgeCategoryListQuery;
+    categoryRouteKey?: string;
     endpoint?: string;
     scope?: FormForgeScope;
     client?: FormForgeClient;
@@ -34,6 +35,7 @@ export declare function useFormForgeCategory(options?: UseFormForgeCategoryOptio
     lastListScope: any;
     lastCategoryKey: any;
     listCategories: (query?: FormForgeCategoryListQuery, requestOptions?: FormForgeCategoryRequestOptions) => Promise<FormForgeCategoryListResponse>;
+    listCategoryRoute: (routeKey: string, query?: FormForgeCategoryListQuery, requestOptions?: FormForgeCategoryRequestOptions) => Promise<FormForgeCategoryListResponse>;
     getCategory: (categoryKey: string, requestOptions?: FormForgeCategoryRequestOptions) => Promise<FormForgeCategory>;
     createCategory: (input: FormForgeCategoryCreateInput, options?: FormForgeMutationOptions) => Promise<FormForgeCategory>;
     patchCategory: (categoryKey: string, input: FormForgeCategoryUpdateInput, options?: FormForgeMutationOptions) => Promise<FormForgeCategory>;

package/dist/runtime/composables/useFormForgeCategory.js

@@ -83,6 +83,28 @@ export function useFormForgeCategory(options = {}) {
       return response;
     });
   }
+  async function listCategoryRoute(routeKey, query = {}, requestOptions = {}) {
+    return withLoading(async () => {
+      const resolvedQuery = {
+        ...lastListQuery.value,
+        ...query
+      };
+      const endpoint = resolveEndpoint(requestOptions);
+      const scope = resolveScope(requestOptions);
+      const response = await client.listCategoryRoute(routeKey, resolvedQuery, {
+        endpoint,
+        scope
+      });
+      list.value = response.data;
+      lastMeta.value = response.meta;
+      lastLinks.value = response.links;
+      lastListQuery.value = resolvedQuery;
+      lastListEndpoint.value = endpoint;
+      lastListScope.value = scope;
+      lastMode.value = "list";
+      return response;
+    });
+  }
   async function getCategory(categoryKey, requestOptions = {}) {
     return withLoading(async () => {
       const response = await client.getCategory(categoryKey, {
@@ -159,10 +181,14 @@ export function useFormForgeCategory(options = {}) {
     });
   }
   if (immediateLoad) {
-    listCategories(options.initialQuery, {
+    const loader = typeof options.categoryRouteKey === "string" && options.categoryRouteKey !== "" ? listCategoryRoute(options.categoryRouteKey, options.initialQuery, {
       endpoint: options.endpoint,
       scope: options.scope
-    }).catch(() => {
+    }) : listCategories(options.initialQuery, {
+      endpoint: options.endpoint,
+      scope: options.scope
+    });
+    loader.catch(() => {
     });
   }
   return {
@@ -182,6 +208,7 @@ export function useFormForgeCategory(options = {}) {
     lastListScope,
     lastCategoryKey,
     listCategories,
+    listCategoryRoute,
     getCategory,
     createCategory,
     patchCategory,

package/dist/runtime/composables/useFormForgeManagement.d.ts

@@ -26,6 +26,7 @@ export declare function useFormForgeManagement(options?: UseFormForgeManagementO
     lastListScope: any;
     lastListFilters: any;
     listForms: (includeDeleted?: boolean, options?: FormForgeManagementRequestOptions) => Promise<FormForgeManagementForm[]>;
+    listFormRoute: (routeKey: string, options?: FormForgeManagementRequestOptions) => Promise<FormForgeManagementForm[]>;
     refreshForms: () => Promise<FormForgeManagementForm[]>;
     refresh: () => Promise<FormForgeManagementForm[]>;
     createForm: (input: FormForgeManagementCreateInput, options?: UseFormForgeManagementMutationOptions) => Promise<FormForgeManagementForm>;

package/dist/runtime/composables/useFormForgeManagement.js

@@ -83,6 +83,23 @@ export function useFormForgeManagement(options = {}) {
       return response;
     });
   }
+  async function listFormRoute(routeKey, options2 = {}) {
+    return withLoading(async () => {
+      const endpoint = resolveRequestEndpoint(options2.endpoint);
+      const scope = resolveRequestScope(options2.scope);
+      const filters = options2.filters ?? {};
+      const response = await client.listFormRoute(routeKey, {
+        endpoint,
+        scope,
+        filters
+      });
+      forms.value = response;
+      lastListEndpoint.value = endpoint;
+      lastListScope.value = scope;
+      lastListFilters.value = filters;
+      return response;
+    });
+  }
   async function refreshForms() {
     return listForms(lastListIncludeDeleted.value, {
       endpoint: lastListEndpoint.value,
@@ -140,6 +157,7 @@ export function useFormForgeManagement(options = {}) {
     lastListScope,
     lastListFilters,
     listForms,
+    listFormRoute,
     refreshForms,
     refresh: refreshForms,
     createForm,

package/dist/runtime/renderers/default/FormForgeBuilder.d.vue.ts

@@ -5,6 +5,8 @@ interface Props {
     endpoint?: string;
     loadFormKey?: string;
     loadFormVersion?: string;
+    formRouteKey?: string;
+    categoryRouteKey?: string;
     locale?: string;
     modelValue?: Partial<FormForgeBuilderDraft>;
     autosave?: boolean;
@@ -31,10 +33,12 @@ declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {},
     readonly: boolean;
     locale: string;
     endpoint: string;
+    categoryRouteKey: string;
     formUuid: string;
     formKey: string;
     loadFormKey: string;
     loadFormVersion: string;
+    formRouteKey: string;
     modelValue: Partial<FormForgeBuilderDraft>;
     autosave: boolean;
     autosaveDelay: number;

package/dist/runtime/renderers/default/FormForgeBuilder.vue

@@ -19,6 +19,8 @@ const props = defineProps({
   endpoint: { type: String, required: false, default: void 0 },
   loadFormKey: { type: String, required: false, default: void 0 },
   loadFormVersion: { type: String, required: false, default: void 0 },
+  formRouteKey: { type: String, required: false, default: void 0 },
+  categoryRouteKey: { type: String, required: false, default: void 0 },
   locale: { type: String, required: false, default: void 0 },
   modelValue: { type: Object, required: false, default: void 0 },
   autosave: { type: Boolean, required: false, default: true },
@@ -56,7 +58,8 @@ const categoryManager = useFormForgeCategory({
   initialQuery: {
     per_page: 200
   },
-  endpoint: props.endpoint
+  endpoint: props.endpoint,
+  categoryRouteKey: props.categoryRouteKey
 });
 const categoryOptions = useFormForgeCategoryOptions({
   source: categoryManager,
@@ -472,6 +475,17 @@ async function loadFormIntoBuilder(key, version) {
     }
   }
 }
+async function loadFormRouteIntoBuilder(routeKey, version) {
+  const forms = await builder.client.listFormRoute(routeKey, {
+    endpoint: props.endpoint
+  });
+  const first = forms[0];
+  const key = typeof first?.key === "string" ? first.key : "";
+  if (key === "") {
+    return;
+  }
+  await loadFormIntoBuilder(key, version);
+}
 function addField(page, type) {
   builder.addField(page.page_key, type);
   builder.normalizeFieldLocations();
@@ -674,7 +688,8 @@ async function openCategoryCreateModal() {
     });
     const result = await createCategoryModal.open({
       locale: props.locale,
-      endpoint: props.endpoint
+      endpoint: props.endpoint,
+      categoryRouteKey: props.categoryRouteKey
     });
     if (!isFormForgeCategory(result)) {
       return;
@@ -741,6 +756,17 @@ watch(() => [props.loadFormKey, props.loadFormVersion], ([key, version]) => {
 }, {
   immediate: true
 });
+watch(() => [props.formRouteKey, props.loadFormKey, props.loadFormVersion], ([routeKey, loadKey, version]) => {
+  if (typeof loadKey === "string" && loadKey !== "") {
+    return;
+  }
+  if (typeof routeKey !== "string" || routeKey === "") {
+    return;
+  }
+  loadFormRouteIntoBuilder(routeKey, version);
+}, {
+  immediate: true
+});
 watch(() => safePages.value, (pages) => {
   syncSelectionWithDraft(pages);
   nextTick(() => {

package/dist/runtime/renderers/default/FormForgeBuilder.vue.d.ts

@@ -5,6 +5,8 @@ interface Props {
     endpoint?: string;
     loadFormKey?: string;
     loadFormVersion?: string;
+    formRouteKey?: string;
+    categoryRouteKey?: string;
     locale?: string;
     modelValue?: Partial<FormForgeBuilderDraft>;
     autosave?: boolean;
@@ -31,10 +33,12 @@ declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {},
     readonly: boolean;
     locale: string;
     endpoint: string;
+    categoryRouteKey: string;
     formUuid: string;
     formKey: string;
     loadFormKey: string;
     loadFormVersion: string;
+    formRouteKey: string;
     modelValue: Partial<FormForgeBuilderDraft>;
     autosave: boolean;
     autosaveDelay: number;

package/dist/runtime/renderers/default/FormForgeCategoryCreateModal.d.vue.ts

@@ -2,6 +2,7 @@ import type { FormForgeCategory } from '../../types/index.js';
 interface Props {
     locale?: string;
     endpoint?: string;
+    categoryRouteKey?: string;
 }
 declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
     close: (value: FormForgeCategory | null) => any;
@@ -10,6 +11,7 @@ declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {},
 }>, {
     locale: string;
     endpoint: string;
+    categoryRouteKey: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/dist/runtime/renderers/default/FormForgeCategoryCreateModal.vue

@@ -4,7 +4,8 @@ import { useFormForgeCategory } from "../../composables/useFormForgeCategory";
 import { useFormForgeI18n } from "../../composables/useFormForgeI18n";
 const props = defineProps({
   locale: { type: String, required: false, default: void 0 },
-  endpoint: { type: String, required: false, default: void 0 }
+  endpoint: { type: String, required: false, default: void 0 },
+  categoryRouteKey: { type: String, required: false, default: void 0 }
 });
 const emit = defineEmits(["close"]);
 const { t } = useFormForgeI18n({
@@ -12,7 +13,8 @@ const { t } = useFormForgeI18n({
 });
 const categoryManager = useFormForgeCategory({
   immediate: false,
-  endpoint: props.endpoint
+  endpoint: props.endpoint,
+  categoryRouteKey: props.categoryRouteKey
 });
 const name = ref("");
 const description = ref("");

package/dist/runtime/renderers/default/FormForgeCategoryCreateModal.vue.d.ts

@@ -2,6 +2,7 @@ import type { FormForgeCategory } from '../../types/index.js';
 interface Props {
     locale?: string;
     endpoint?: string;
+    categoryRouteKey?: string;
 }
 declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
     close: (value: FormForgeCategory | null) => any;
@@ -10,6 +11,7 @@ declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {},
 }>, {
     locale: string;
     endpoint: string;
+    categoryRouteKey: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanschleret/formforgeclient",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Nuxt module and runtime client for FormForge",
   "license": "MIT",
   "type": "module",