feat: rename package and streamline docs

Author: EvanSchleret

README.md

@@ -2,7 +2,7 @@
 
 ## Supported versions
 
-At this stage, only the latest published version of `@formforge/client` is considered supported for security fixes.
+At this stage, only the latest published version of `@evanschleret/formforgeclient` is considered supported for security fixes.
 
 ## Reporting a vulnerability
 

SECURITY.md

@@ -1,5 +1,5 @@
 {
-  "name": "@formforge/client",
+  "name": "@evanschleret/formforgeclient",
   "version": "0.1.0",
   "description": "Nuxt module and runtime client for FormForge",
   "license": "MIT",
@@ -31,7 +31,7 @@
     "test": "vitest run"
   },
   "peerDependencies": {
-    "@nuxt/ui": "^4.0.0",
+    "@nuxt/ui": "^4.6.0",
     "nuxt": "^4.0.0"
   },
   "dependencies": {

bun.lock

@@ -23,7 +23,7 @@ export interface ModuleOptions {
 
 export default defineNuxtModule<ModuleOptions>({
   meta: {
-    name: '@formforge/client',
+    name: '@evanschleret/formforgeclient',
     configKey: 'formforgeClient',
     compatibility: {
       nuxt: '>=4.0.0'
@@ -107,7 +107,7 @@ export default defineNuxtModule<ModuleOptions>({
     const typeTemplate = addTypeTemplate({
       filename: 'types/formforge-client.d.ts',
       getContents: () => `
-import type { FormForgeBeforeRequestContext, FormForgeClient } from '@formforge/client/runtime'
+import type { FormForgeBeforeRequestContext, FormForgeClient } from '@evanschleret/formforgeclient/runtime'
 
 declare module '#app' {
   interface NuxtApp {

package.json

@@ -16,7 +16,12 @@ export interface FormForgeMutationOptions extends FormForgeRequestOptions {
   idempotencyKey?: string
 }
 
-export type FormForgeManagementRequestOptions = FormForgeRequestOptions
+export type FormForgeManagementFilterValue = string | number | boolean | undefined
+export type FormForgeManagementFilters = Record<string, FormForgeManagementFilterValue>
+
+export interface FormForgeManagementRequestOptions extends FormForgeRequestOptions {
+  filters?: FormForgeManagementFilters
+}
 
 function normalizeManagementForm(value: unknown): FormForgeManagementForm | null {
   if (!isFormForgeJsonObject(value as FormForgeJsonValue | null | undefined)) {
@@ -119,10 +124,13 @@ export async function fetchFormForgeForms(
   includeDeleted: boolean = false,
   options: FormForgeManagementRequestOptions = {}
 ): Promise<FormForgeManagementForm[]> {
+  const filters: FormForgeManagementFilters = options.filters ?? {}
+
   const response = await http<FormForgeJsonObject>({
     path: resolveEndpointPath(options.endpoint, '/forms', {}, options.scope),
     method: 'GET',
     query: {
+      ...filters,
       include_deleted: includeDeleted ? 1 : 0
     }
   })

src/module.ts

@@ -1,6 +1,6 @@
 import { computed, ref } from '#imports'
 import { useFormForgeClient } from './useFormForgeClient'
-import type { FormForgeManagementRequestOptions, FormForgeMutationOptions } from '../api/management'
+import type { FormForgeManagementFilters, FormForgeManagementRequestOptions, FormForgeMutationOptions } from '../api/management'
 import type {
   FormForgeBusinessErrorCode,
   FormForgeClient,
@@ -47,6 +47,7 @@ export function useFormForgeManagement(options: UseFormForgeManagementOptions =
   const lastListIncludeDeleted = ref<boolean>(false)
   const lastListEndpoint = ref<string | undefined>(options.endpoint)
   const lastListScope = ref<FormForgeScope | undefined>(options.scope)
+  const lastListFilters = ref<FormForgeManagementFilters>({})
   const fieldErrors = computed<Record<string, string[]>>(() => clientError.value?.fieldErrors ?? {})
   const businessErrorCode = computed<FormForgeBusinessErrorCode | undefined>(() => clientError.value?.businessCode)
   const hasCategoryValidationError = computed<boolean>(() => {
@@ -113,22 +114,26 @@ export function useFormForgeManagement(options: UseFormForgeManagementOptions =
     return withLoading(async () => {
       const endpoint = resolveRequestEndpoint(options.endpoint)
       const scope = resolveRequestScope(options.scope)
+      const filters = options.filters ?? {}
       const response = await client.listForms(includeDeleted, {
         endpoint,
-        scope
+        scope,
+        filters
       })
       forms.value = response
       lastListIncludeDeleted.value = includeDeleted
       lastListEndpoint.value = endpoint
       lastListScope.value = scope
+      lastListFilters.value = filters
       return response
     })
   }
 
   async function refreshForms(): Promise<FormForgeManagementForm[]> {
     return listForms(lastListIncludeDeleted.value, {
       endpoint: lastListEndpoint.value,
-      scope: lastListScope.value
+      scope: lastListScope.value,
+      filters: lastListFilters.value
     })
   }
 
@@ -199,6 +204,7 @@ export function useFormForgeManagement(options: UseFormForgeManagementOptions =
     lastListIncludeDeleted,
     lastListEndpoint,
     lastListScope,
+    lastListFilters,
     listForms,
     refreshForms,
     refresh: refreshForms,

src/runtime/api/management.ts

@@ -96,6 +96,33 @@ describe('fetchFormForgeForms', () => {
     expect(forms[0]?.category).toBe('events')
     expect(forms[0]?.category_item?.name).toBe('Events')
   })
+
+  it('forwards filters as query params', async () => {
+    const requests: FormForgeHttpRequest[] = []
+
+    const http: FormForgeHttpAdapter = async <TData>(request: FormForgeHttpRequest) => {
+      requests.push(request)
+
+      return {
+        status: 200,
+        headers: new Headers(),
+        data: {
+          data: []
+        } as TData
+      }
+    }
+
+    await fetchFormForgeForms(http, false, {
+      filters: {
+        category: 'survey',
+        search: 'contact'
+      }
+    })
+
+    expect(requests[0]?.query?.category).toBe('survey')
+    expect(requests[0]?.query?.search).toBe('contact')
+    expect(requests[0]?.query?.include_deleted).toBe(0)
+  })
 })
 
 describe('form create/patch category support', () => {