@svadmin/core 0.49.1 → 0.50.0

package/README.md

@@ -0,0 +1,32 @@
+# Schema Form Validation
+
+Use the existing `useForm.validate` callback with a shared TypeBox schema:
+
+```ts
+import { Type, type Static } from '@sinclair/typebox';
+import { createSchemaFormValidator, useForm } from '@svadmin/core';
+
+const Input = Type.Object({
+  title: Type.String({ minLength: 1 }),
+  quantity: Type.Integer({ minimum: 1 }),
+});
+type Input = Static<typeof Input>;
+
+const form = useForm({
+  resource: 'items',
+  defaultValues: { title: '', quantity: 1 } satisfies Input,
+  validate: createSchemaFormValidator(Input, {
+    message: ({ path }) => path === '/quantity' ? 'Enter a positive integer' : 'Required',
+  }),
+});
+```
+
+Validation does not coerce or strip input. It returns `null` on success or the
+first error per field. JSON Pointer paths map to dotted fields (`items.0.name`);
+root errors map to `_form`. Use `field(pointer)` and `formField` when an
+application uses another naming convention. `references` supports TypeBox refs.
+Message callbacks receive only the path and error type, not submitted values.
+
+This adapter prevents invalid form submissions through normal `useForm`
+validation. Authorization, domain commands, and server validation remain the
+application's responsibility. Root errors require a form-level error display.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@svadmin/core",
-  "version": "0.49.1",
+  "version": "0.50.0",
   "author": "zuohuadong",
   "repository": {
     "type": "git",

package/src/form-hooks.svelte.ts

@@ -462,8 +462,8 @@ export function useForm<
     queryKey: adminContext.queryKeys(resource, options.dataProviderName).data.one(resource, currentId ?? '', {
       meta: queryMeta,
     }),
-    queryFn: async () => {
-      const result = await provider.getOne<BaseRecord>({ resource, id: currentId as string, meta: queryMeta });
+    queryFn: async ({ signal }) => {
+      const result = await provider.getOne<BaseRecord>({ resource, id: currentId as string, meta: queryMeta, signal });
       return result;
     },
     enabled: (queryOptions?.enabled ?? true) && (action === 'edit' || action === 'clone' || action === 'show') && currentId != null,

package/src/hooks.svelte.ts

@@ -68,8 +68,9 @@ export function useInfiniteList<TData extends BaseRecord = BaseRecord, TError =
       filters: options.filters,
       meta: options.meta,
     }),
-    queryFn: async ({ pageParam = 1 }) => {
+    queryFn: async ({ pageParam = 1, signal }) => {
       const result = await provider.getList<TData>({
+        signal,
         resource,
         pagination: { current: pageParam as number, pageSize: options.pagination?.pageSize ?? 10 },
         sorters: options.sorters,
@@ -179,7 +180,7 @@ export function useSelect<TData extends BaseRecord = BaseRecord, TOption = { lab
       pagination,
       meta,
     }),
-    queryFn: () => provider.getList<TData>({ resource, sorters, filters: allFilters, pagination: { current: 1, pageSize: effectivePageSize }, meta }),
+    queryFn: ({ signal }) => provider.getList<TData>({ resource, sorters, filters: allFilters, pagination: { current: 1, pageSize: effectivePageSize }, meta, signal }),
     enabled: options.queryOptions?.enabled ?? true,
     staleTime: options.queryOptions?.staleTime ?? adminOptions.reactQuery?.staleTime,
     };
@@ -195,9 +196,9 @@ export function useSelect<TData extends BaseRecord = BaseRecord, TOption = { lab
             ids: defaultValueIds,
             meta,
           }),
-          queryFn: async () => {
-            if (provider.getMany) return provider.getMany<TData>({ resource, ids: defaultValueIds, meta });
-            const results = await Promise.all(defaultValueIds.map(id => provider.getOne<TData>({ resource, id, meta })));
+          queryFn: async ({ signal }) => {
+            if (provider.getMany) return provider.getMany<TData>({ resource, ids: defaultValueIds, meta, signal });
+            const results = await Promise.all(defaultValueIds.map(id => provider.getOne<TData>({ resource, id, meta, signal })));
             return { data: results.map(r => r.data) };
           },
           enabled: (options.defaultValueQueryOptions?.enabled ?? true) && defaultValueIds.length > 0,
@@ -297,9 +298,10 @@ export function useCustom<TData = unknown, TError = HttpError>(options: UseCusto
       options.method,
       { config: options.config, meta: options.meta },
     ),
-    queryFn: async () => {
+    queryFn: async ({ signal }) => {
       if (!provider.custom) throw new Error('DataProvider does not support custom method');
       return provider.custom<TData>({
+        signal,
         url: options.url,
         method: options.method,
         payload: options.config?.payload,

package/src/index.ts

@@ -230,3 +230,5 @@ export type {
 // HTTP fetch utilities
 export { createFetchWithInterceptor, fetchWithInterceptor } from './http';
 export type { FetchWithInterceptor, FetchWithInterceptorOptions } from './http';
+export { createSchemaFormValidator } from './schema-form';
+export type { SchemaFormIssue, SchemaFormOptions } from './schema-form';

package/src/query-hooks.svelte.ts

@@ -115,7 +115,8 @@ export function useList<TData extends BaseRecord = BaseRecord, TError = HttpErro
         filters,
         meta,
       }),
-      queryFn: async () => provider.getList<TData>({
+      queryFn: async ({ signal }) => provider.getList<TData>({
+        signal,
         resource,
         pagination,
         sorters,
@@ -215,9 +216,10 @@ export function useOne<TData extends BaseRecord = BaseRecord, TError = HttpError
       queryKey: adminContext.queryKeys(resource, opts.dataProviderName).data.one(resource, id ?? '', {
         meta: cloneQueryKeyPart(opts.meta),
       }),
-      queryFn: async () => {
+      queryFn: async ({ signal }) => {
         if (id == null) throw new Error('useOne requires an id');
         const result = await provider.getOne<TData>({
+          signal,
           resource,
           id,
           meta: opts.meta,
@@ -335,12 +337,12 @@ export function useMany<TData extends BaseRecord = BaseRecord, TError = HttpErro
         ids: cloneQueryKeyPart(ids),
         meta: cloneQueryKeyPart(meta),
       }),
-      queryFn: async () => {
+      queryFn: async ({ signal }) => {
         if (!ids.length) return { data: [] };
         if (provider.getMany) {
-          return provider.getMany<TData>({ resource, ids, meta });
+          return provider.getMany<TData>({ resource, ids, meta, signal });
         }
-        const results = await Promise.all(ids.map(id => provider.getOne<TData>({ resource, id, meta })));
+        const results = await Promise.all(ids.map(id => provider.getOne<TData>({ resource, id, meta, signal })));
         return { data: results.map(r => r.data) };
       },
       enabled: (queryOptions?.enabled ?? true) && ids.length > 0,

package/src/schema-form.ts

@@ -0,0 +1,31 @@
+import type { TSchema } from '@sinclair/typebox';
+import { Value } from '@sinclair/typebox/value';
+
+export interface SchemaFormIssue {
+  /** JSON Pointer from the schema validator; never includes submitted values. */
+  path: string;
+  type: number;
+}
+
+export interface SchemaFormOptions {
+  references?: TSchema[];
+  message?: (issue: SchemaFormIssue) => string;
+  field?: (pointer: string) => string;
+  formField?: string;
+}
+
+/** Adapter for useForm.validate. It validates without coercing or clearing input. */
+export function createSchemaFormValidator(schema: TSchema, options: SchemaFormOptions = {}) {
+  return (values: unknown): Record<string, string> | null => {
+    const errors: Record<string, string> = Object.create(null);
+    for (const error of Value.Errors(schema, options.references ?? [], values)) {
+      const field = options.field?.(error.path) ?? (error.path
+        ? error.path.slice(1).split('/').map((part) => part.replace(/~1/g, '/').replace(/~0/g, '~')).join('.')
+        : options.formField ?? '_form');
+      if (!Object.hasOwn(errors, field)) {
+        errors[field] = options.message?.({ path: error.path, type: error.type }) ?? 'Invalid value';
+      }
+    }
+    return Object.keys(errors).length ? errors : null;
+  };
+}

package/src/types.ts

@@ -103,6 +103,8 @@ export interface LogicalFilter {
 }
 
 export interface GetListParams {
+  /** Query-owned cancellation signal. Never include it in a cache key or URL. */
+  signal?: AbortSignal;
   resource: string;
   pagination?: Pagination;
   sorters?: Sort[];
@@ -117,6 +119,7 @@ export interface GetListResult<TData extends BaseRecord = BaseRecord> {
 }
 
 export interface GetOneParams {
+  signal?: AbortSignal;
   resource: string;
   id: string | number;
   meta?: Record<string, unknown>;
@@ -127,6 +130,7 @@ export interface GetOneResult<TData extends BaseRecord = BaseRecord> {
 }
 
 export interface GetManyParams {
+  signal?: AbortSignal;
   resource: string;
   ids: (string | number)[];
   meta?: Record<string, unknown>;
@@ -201,6 +205,7 @@ export interface DeleteManyResult<TData extends BaseRecord = BaseRecord> {
 }
 
 export interface CustomParams<TVariables = unknown> {
+  signal?: AbortSignal;
   url: string;
   method: 'get' | 'post' | 'put' | 'patch' | 'delete';
   payload?: TVariables;