feat(runtime): support auto-publish payload and standalone renderer validation

Author: EvanSchleret

src/runtime/api/client.ts

@@ -4,6 +4,7 @@ import type {
   FormForgeCategoryListQuery,
   FormForgeCategoryListResponse,
   FormForgeCategoryUpdateInput,
+  FormForgeBaseURLParamsInput,
   FormForgeClientConfig,
   FormForgeDraftResponse,
   FormForgeDraftSaveInput,
@@ -108,6 +109,18 @@ class FormForgeClientImpl implements FormForgeClient {
     return input
   }
 
+  private resolveBaseURLParams(input: FormForgeBaseURLParamsInput | undefined): Record<string, string | number | undefined> {
+    if (input === undefined) {
+      return {}
+    }
+
+    if (typeof input === 'function') {
+      return input()
+    }
+
+    return input
+  }
+
   private resolveNamedScope(name: string): FormForgeResolvedScope {
     const scopedRoutes = this.config.scopedRoutes ?? {}
     const routeDefinition: FormForgeScopedRouteDefinition | undefined = scopedRoutes[name]
@@ -117,10 +130,11 @@ class FormForgeClientImpl implements FormForgeClient {
     }
 
     const sourceParams = this.resolveScopeParams(this.config.scopeParams)
+    const baseURLParams = this.resolveBaseURLParams(this.config.baseURLParams)
     const params: Record<string, string | number> = {}
 
     for (const [scopeParam, sourceParam] of Object.entries(routeDefinition.paramsFromRoute)) {
-      const value = sourceParams[sourceParam]
+      const value = sourceParams[sourceParam] ?? baseURLParams[sourceParam]
 
       if (value === undefined || value === '') {
         throw new Error(`Missing scope param source "${sourceParam}" for named scope "${name}"`)

src/runtime/api/management.ts

@@ -104,6 +104,24 @@ function toJsonObject(input: FormForgeManagementCreateInput | FormForgeManagemen
   return JSON.parse(JSON.stringify(input)) as FormForgeJsonObject
 }
 
+function shouldAutoPublish(input: FormForgeManagementCreateInput | FormForgeManagementPatchInput): boolean {
+  return input.auto_publish === true || input.autoPublish === true
+}
+
+function toManagementMutationPayload(input: FormForgeManagementCreateInput | FormForgeManagementPatchInput): FormForgeJsonObject {
+  const payload = toJsonObject(input)
+
+  if ('autoPublish' in payload) {
+    delete payload.autoPublish
+  }
+
+  if (shouldAutoPublish(input)) {
+    payload.auto_publish = true
+  }
+
+  return payload
+}
+
 export async function createFormForgeForm(
   http: FormForgeHttpAdapter,
   input: FormForgeManagementCreateInput,
@@ -113,7 +131,7 @@ export async function createFormForgeForm(
     path: resolveEndpointPath(options.endpoint, '/forms', {}, options.scope),
     method: 'POST',
     headers: withMutationHeaders(options),
-    json: toJsonObject(input)
+    json: toManagementMutationPayload(input)
   })
 
   return normalizeManagementForm(pickFormForgeDataEnvelope(response.data)) ?? {}
@@ -150,7 +168,7 @@ export async function patchFormForgeForm(
     }, options.scope),
     method: 'PATCH',
     headers: withMutationHeaders(options),
-    json: toJsonObject(input)
+    json: toManagementMutationPayload(input)
   })
 
   return normalizeManagementForm(pickFormForgeDataEnvelope(response.data)) ?? {}

src/runtime/composables/useFormForgeBuilder.ts

@@ -40,6 +40,11 @@ export interface UseFormForgeBuilderOptions {
   clientConfig?: FormForgeClientConfig
 }
 
+export interface FormForgeBuilderSaveOptions {
+  idempotencyKey?: string
+  autoPublish?: boolean
+}
+
 export const FORM_FORGE_BUILDER_FIELD_TYPES: FormForgeFieldType[] = [
   'text',
   'textarea',
@@ -331,7 +336,7 @@ export function useFormForgeBuilder(options: UseFormForgeBuilderOptions = {}) {
     }
   }
 
-  function toManagementInput(): FormForgeManagementCreateInput {
+  function toManagementInput(autoPublish: boolean = false): FormForgeManagementCreateInput {
     normalizeFieldLocations()
 
     const pages = draft.value.pages as FormForgePageSchema[]
@@ -352,10 +357,21 @@ export function useFormForgeBuilder(options: UseFormForgeBuilderOptions = {}) {
       drafts: draft.value.drafts as FormForgeDraftSettings
     }
 
+    if (autoPublish) {
+      input.auto_publish = true
+    }
+
     return input
   }
 
-  async function save(idempotencyKey?: string): Promise<void> {
+  async function save(saveOptions: FormForgeBuilderSaveOptions | string = {}): Promise<void> {
+    const resolvedSaveOptions = typeof saveOptions === 'string'
+      ? { idempotencyKey: saveOptions, autoPublish: false }
+      : {
+          idempotencyKey: saveOptions.idempotencyKey,
+          autoPublish: saveOptions.autoPublish === true
+        }
+
     if (draft.value.title.trim() === '') {
       throw new Error('Title is required to save')
     }
@@ -364,7 +380,7 @@ export function useFormForgeBuilder(options: UseFormForgeBuilderOptions = {}) {
     error.value = null
 
     try {
-      const input: FormForgeManagementCreateInput = toManagementInput()
+      const input: FormForgeManagementCreateInput = toManagementInput(resolvedSaveOptions.autoPublish)
 
       const mutationIdentifier = resolveMutationIdentifier(draft.value)
 
@@ -376,7 +392,7 @@ export function useFormForgeBuilder(options: UseFormForgeBuilderOptions = {}) {
         }
 
         const created = await client.createForm(input, {
-          idempotencyKey,
+          idempotencyKey: resolvedSaveOptions.idempotencyKey,
           endpoint: options.endpoint,
           scope: options.scope
         })
@@ -394,7 +410,7 @@ export function useFormForgeBuilder(options: UseFormForgeBuilderOptions = {}) {
       } else {
         const patchInput: FormForgeManagementPatchInput = input
         const patched = await client.patchForm(mutationIdentifier, patchInput, {
-          idempotencyKey,
+          idempotencyKey: resolvedSaveOptions.idempotencyKey,
           endpoint: options.endpoint,
           scope: options.scope
         })

src/runtime/composables/useFormForgeClient.ts

@@ -1,6 +1,6 @@
 import { useNuxtApp, useRoute, useRuntimeConfig } from '#imports'
 import { createFormForgeClient } from '../api'
-import type { FormForgeClient, FormForgeClientConfig, FormForgeJsonObject } from '../types'
+import type { FormForgeClient, FormForgeClientConfig, FormForgeJsonObject, FormForgeScopedRouteMap } from '../types'
 
 interface FormForgeNuxtRouteBridge {
   _route?: {
@@ -55,7 +55,7 @@ function mergeRouteValues(
 }
 
 function templateSegmentKey(value: string): string | null {
-  const matched = value.match(/^\{([a-zA-Z0-9_]+)\}$/)
+  const matched = value.match(/^\{([a-zA-Z0-9_]+)(?::[^}]+)?\}$/)
   return matched?.[1] ?? null
 }
 
@@ -154,6 +154,25 @@ function withInferredMissingValues(
   return resolved
 }
 
+function inferScopeSourcesFromPath(
+  scopedRoutes: FormForgeScopedRouteMap | undefined,
+  currentPath: string | undefined
+): Record<string, string> {
+  const inferredSources: Record<string, string> = {}
+
+  for (const scopedRoute of Object.values(scopedRoutes ?? {})) {
+    const inferredScopeParams = inferParamsFromPath(scopedRoute.prefix, currentPath)
+    for (const [scopeParam, sourceParam] of Object.entries(scopedRoute.paramsFromRoute)) {
+      const inferredValue = inferredScopeParams[scopeParam]
+      if (inferredValue !== undefined && inferredValue !== '' && inferredSources[sourceParam] === undefined) {
+        inferredSources[sourceParam] = inferredValue
+      }
+    }
+  }
+
+  return inferredSources
+}
+
 export function useFormForgeClient(config: FormForgeClientConfig = {}): FormForgeClient {
   const nuxtApp = useNuxtApp() as ReturnType<typeof useNuxtApp> & FormForgeNuxtRouteBridge
   const route = useRoute()
@@ -183,8 +202,13 @@ export function useFormForgeClient(config: FormForgeClientConfig = {}): FormForg
         ...appRouteParams
       }
     )
-    const inferredFromPath = inferParamsFromPath(config.baseURL ?? (runtimePublicConfig as FormForgeClientConfig | undefined)?.baseURL, composableRoutePath || appRoutePath)
-    return withInferredMissingValues(mergedRouteValues, inferredFromPath)
+    const resolvedPath = composableRoutePath || appRoutePath
+    const resolvedBaseURL = config.baseURL ?? (runtimePublicConfig as FormForgeClientConfig | undefined)?.baseURL
+    const resolvedScopedRoutes = config.scopedRoutes ?? (runtimePublicConfig as FormForgeClientConfig | undefined)?.scopedRoutes
+    const inferredFromBaseURL = inferParamsFromPath(resolvedBaseURL, resolvedPath)
+    const withBaseURLValues = withInferredMissingValues(mergedRouteValues, inferredFromBaseURL)
+    const inferredFromScopes = inferScopeSourcesFromPath(resolvedScopedRoutes, resolvedPath)
+    return withInferredMissingValues(withBaseURLValues, inferredFromScopes)
   }
 
   const baseConfig = runtimePublicConfig as FormForgeClientConfig | undefined

src/runtime/plugin.ts

@@ -1,6 +1,6 @@
 import { defineNuxtPlugin, useRoute, useRuntimeConfig } from '#imports'
 import { createFormForgeClient } from './api'
-import type { FormForgeBeforeRequestContext, FormForgeClientConfig } from './types'
+import type { FormForgeBeforeRequestContext, FormForgeClientConfig, FormForgeScopedRouteMap } from './types'
 
 interface FormForgeNuxtAppHookBridge {
   callHook(name: 'formforge:beforeRequest', context: FormForgeBeforeRequestContext): Promise<void>
@@ -55,7 +55,7 @@ function mergeRouteValues(
 }
 
 function templateSegmentKey(value: string): string | null {
-  const matched = value.match(/^\{([a-zA-Z0-9_]+)\}$/)
+  const matched = value.match(/^\{([a-zA-Z0-9_]+)(?::[^}]+)?\}$/)
   return matched?.[1] ?? null
 }
 
@@ -154,6 +154,25 @@ function withInferredMissingValues(
   return resolved
 }
 
+function inferScopeSourcesFromPath(
+  scopedRoutes: FormForgeScopedRouteMap | undefined,
+  currentPath: string | undefined
+): Record<string, string> {
+  const inferredSources: Record<string, string> = {}
+
+  for (const scopedRoute of Object.values(scopedRoutes ?? {})) {
+    const inferredScopeParams = inferParamsFromPath(scopedRoute.prefix, currentPath)
+    for (const [scopeParam, sourceParam] of Object.entries(scopedRoute.paramsFromRoute)) {
+      const inferredValue = inferredScopeParams[scopeParam]
+      if (inferredValue !== undefined && inferredValue !== '' && inferredSources[sourceParam] === undefined) {
+        inferredSources[sourceParam] = inferredValue
+      }
+    }
+  }
+
+  return inferredSources
+}
+
 export default defineNuxtPlugin((nuxtApp) => {
   const runtimeConfig = useRuntimeConfig()
   const route = useRoute()
@@ -177,8 +196,11 @@ export default defineNuxtPlugin((nuxtApp) => {
         ...appRouteParams
       }
     )
-    const inferredFromPath = inferParamsFromPath(publicConfig?.baseURL, composableRoutePath || appRoutePath)
-    return withInferredMissingValues(mergedRouteValues, inferredFromPath)
+    const resolvedPath = composableRoutePath || appRoutePath
+    const inferredFromBaseURL = inferParamsFromPath(publicConfig?.baseURL, resolvedPath)
+    const withBaseURLValues = withInferredMissingValues(mergedRouteValues, inferredFromBaseURL)
+    const inferredFromScopes = inferScopeSourcesFromPath(publicConfig?.scopedRoutes, resolvedPath)
+    return withInferredMissingValues(withBaseURLValues, inferredFromScopes)
   }
 
   const runtimeBaseURLParams = publicConfig?.baseURLParams