@svadmin/core 0.50.0 → 0.52.0

package/src/delete-many-hooks.svelte.ts

@@ -0,0 +1,402 @@
+import { createMutation, useQueryClient } from '@tanstack/svelte-query';
+import { captureAdminContext } from './context.svelte';
+import { captureQueryProvider } from './query-snapshot';
+import { snapshotDeleteManyParams, parseDeleteManyParams, decodeDeleteManyReceipt, type ContractDeleteManyParams } from './delete-many-contract';
+import { contractKey, parseContractId, parseContractRecord, parseContractDeleteInput,
+  type ContractSchemas, type ContractId, type ContractRecord, type ResourceContract } from './resource-contract';
+import { snapshotPlainData } from './plain-data';
+import { decodeBaseRecord } from './record-decoder';
+import { definedOptions } from './defined-options';
+import { replaceReactiveUnionMembers } from './reactive-projection';
+import { invalidateOwnedQueries, readOwnedDataQuery } from './query-invalidation';
+import { createQueryResultView } from './query-session.svelte';
+import { createOvertimeTracker, type OvertimeOptions } from './hook-utils.svelte';
+import { getAdminOptions } from './options.svelte';
+import { captureAuthLiveScope, clearAuthQueries, handleAuthError } from './auth-hooks.svelte';
+import { auditWithProvider } from './audit';
+import { DeleteManyPartialError, HttpError } from './types';
+import { useTranslation } from './i18n.svelte';
+import { toast } from './toast.svelte';
+
+export interface ContractDeleteManyOptions<S extends ContractSchemas> {
+  resource: ResourceContract<S>;
+  enabled?: boolean;
+  overtimeOptions?: OvertimeOptions;
+}
+export type { ContractDeleteManyParams } from './delete-many-contract';
+type Result<S extends ContractSchemas> = { data: ContractRecord<S>[] };
+type Failure = HttpError | DeleteManyPartialError;
+export interface Callbacks<S extends ContractSchemas> {
+  onSuccess?: (data: Result<S>) => void | Promise<void>;
+  onError?: (error: Failure) => void | Promise<void>;
+  onSettled?: (data: Result<S> | undefined, error: Failure | null) => void | Promise<void>;
+}
+function observe(callback: () => void | Promise<void>): void {
+  try { void Promise.resolve(callback()).catch(() => {}); }
+  catch { /* Observer failures cannot invalidate a completed write. */ }
+}
+function failure(cause: unknown, dispatched = false): HttpError {
+  let code: unknown;
+  let status: unknown;
+  try {
+    if (typeof cause === 'object' && cause !== null) {
+      code = Object.getOwnPropertyDescriptor(cause, 'code')?.value;
+      status = Object.getOwnPropertyDescriptor(cause, 'statusCode')?.value;
+    }
+  } catch { /* Treat hostile error reflection as a generic failure. */ }
+  const input = code === 'INVALID_RESOURCE_INPUT' && !dispatched;
+  const response = code === 'INVALID_PROVIDER_RESPONSE';
+  return new HttpError(input ? 'Invalid batch deletion input' : response ? 'Invalid provider response' : 'Batch deletion failed',
+    input ? 422 : response ? 502 : status === 401 || status === 403 ? status : 500, undefined, {
+      code: input ? 'INVALID_RESOURCE_INPUT' : response ? 'INVALID_PROVIDER_RESPONSE' : 'DELETE_MANY_FAILED',
+      details: { writeMayHaveSucceeded: dispatched },
+    });
+}
+function copyFailure(error: Failure): Failure {
+  return error instanceof DeleteManyPartialError
+    ? new DeleteManyPartialError(error.succeededIds, error.failedIds, error.causes.map(cause => failure(cause, true)))
+    : new HttpError(error.message, error.statusCode, undefined, {
+      ...definedOptions({ code: error.code }), details: snapshotPlainData(error.details ?? {}),
+    });
+}
+
+/** Checked batch progress and destructive cleanup belong to one resource and auth revision. */
+export function useContractDeleteMany<S extends ContractSchemas>(options: ContractDeleteManyOptions<S>) {
+  contractKey(options.resource);
+  const context = captureAdminContext();
+  const client = useQueryClient();
+  const adminOptions = getAdminOptions();
+  const i18n = useTranslation();
+  let mounted = true;
+  function captureOrigin() {
+    const auth = context.authProvider;
+    return {
+      auth, authScope: captureAuthLiveScope(auth), router: context.routerProvider,
+      tenant: context.tenantCacheKey?.__svadminTenant, contract: options.resource,
+    };
+  }
+  function originCurrent(origin: ReturnType<typeof captureOrigin>): boolean {
+    try {
+      return mounted && options.enabled !== false && origin.auth === context.authProvider &&
+        origin.authScope.isCurrent() && origin.router === context.routerProvider &&
+        origin.tenant === context.tenantCacheKey?.__svadminTenant && origin.contract === options.resource;
+    } catch { return false; }
+  }
+  function captureScope(input: ReturnType<typeof snapshotDeleteManyParams>) {
+    const origin = captureOrigin();
+    const contract = origin.contract;
+    const captured = captureQueryProvider(context, {
+      resource: contract.name, ...definedOptions({ meta: input.meta, dataProviderName: input.dataProviderName }),
+    });
+    const name = context.resolveDataProviderName(contract.name, input.dataProviderName);
+    const raw = context.providers?.[name];
+    if (!raw) throw new HttpError('Data provider unavailable', 400);
+    return {
+      ...origin, ...captured, deleteOne: raw.deleteOne.bind(raw), deleteMany: raw.deleteMany?.bind(raw),
+      matcher: { ...context.queryKeyMatcher(contract.name, input.dataProviderName), contract: contractKey(contract) },
+      notification: context.notificationProvider, audit: context.auditLogProvider, live: context.liveProvider,
+      key: JSON.stringify([contractKey(contract), name, captured.source, context.tenantCacheKey?.__svadminTenant, captured.meta]),
+    };
+  }
+  function capture(params: ContractDeleteManyParams<S>) {
+    const input = snapshotDeleteManyParams(params);
+    const scope = captureScope(input);
+    const ids = input.ids.map(id => parseContractId(scope.contract, id));
+    const variables = parseContractDeleteInput(scope.contract, input.variables);
+    if (options.enabled !== undefined && typeof options.enabled !== 'boolean') throw new HttpError('Invalid enabled value', 422, undefined, { code: 'INVALID_RESOURCE_INPUT' });
+    return { ...scope, input, ids, variables, signature: JSON.stringify([scope.key, scope.authScope.cacheKey, ids, variables]) };
+  }
+  type Scope = ReturnType<typeof capture>;
+  function notify(scope: Scope, current: () => boolean, type: 'success' | 'error', message: string): void {
+    observe(() => {
+      if (!current()) return;
+      if (scope.notification) return scope.notification.open({ type, message });
+      if (type === 'success') toast.success(message);
+      else toast.error(message);
+    });
+  }
+  type Progress = { attempted: ContractId<S>[]; succeeded: ContractId<S>[]; failed: ContractId<S>[] };
+  const newProgress = (): Progress => ({ attempted: [], succeeded: [], failed: [] });
+  type Invocation = {
+    scope: Scope | undefined;
+    origin: ReturnType<typeof captureOrigin>;
+    token: object;
+    callbacks: Callbacks<S>;
+    readScope(): Scope;
+    readProgress(): Progress;
+  };
+  let latest = $state.raw<Scope>();
+  let latestToken: object | undefined;
+  let active: { scope: Scope; promise: Promise<Result<S>>; token: object; progress: Progress } | undefined;
+  function targetCurrent(scope: Scope): boolean {
+    if (!mounted || options.enabled === false) return false;
+    try {
+      return captureScope(scope.input).key === scope.key &&
+        context.authProvider === scope.auth && context.routerProvider === scope.router;
+    } catch { return false; }
+  }
+  const sessionCurrent = (scope: Scope) => {
+    try { return context.authProvider === scope.auth && scope.authScope.isCurrent(); }
+    catch { return false; }
+  };
+  const isCurrent = (scope: Scope) => targetCurrent(scope) && sessionCurrent(scope);
+  function cancelled(scope: Scope | undefined, progress: Progress): HttpError {
+    return new HttpError('Batch deletion scope changed', 409, undefined, {
+      code: 'DELETE_MANY_CANCELLED', details: {
+        writeMayHaveSucceeded: progress.attempted.length > 0,
+        attemptedIds: [...progress.attempted], failedIds: [...progress.failed],
+        ...definedOptions({
+          requestedIds: scope ? [...scope.ids] : undefined,
+          succeededIds: scope && sessionCurrent(scope) ? [...progress.succeeded] : undefined,
+          unattemptedIds: scope?.ids.filter(id => !progress.attempted.includes(id)),
+        }),
+      },
+    });
+  }
+  function copyResult(scope: Scope, data: Result<S>): Result<S> {
+    return { data: data.data.map(record => parseContractRecord(scope.contract, record)) };
+  }
+  async function refresh(scope: Scope, attempted: readonly (string | number)[], succeeded: readonly (string | number)[]) {
+    if (!attempted.length) return;
+    const matcher = { ...scope.matcher, resource: scope.contract.name };
+    const owner = { source: scope.source, authSession: scope.authScope.cacheKey };
+    try {
+      if (succeeded.length) {
+        const confirmedDetail = (key: readonly unknown[]) => {
+          if (!sessionCurrent(scope)) return false;
+          const descriptor = readOwnedDataQuery(key, matcher, owner);
+          return descriptor?.action === 'one' && descriptor.id !== undefined && succeeded.includes(descriptor.id);
+        };
+        const queries = client.getQueryCache().findAll({ predicate: query => confirmedDetail(query.queryKey) });
+        // Removal callbacks may retire authentication before the next confirmed detail.
+        for (const query of queries) {
+          if (!sessionCurrent(scope)) return;
+          client.removeQueries({ predicate: candidate => candidate === query && confirmedDetail(candidate.queryKey) });
+        }
+      }
+      const request = { client, matcher, owner, current: () => sessionCurrent(scope) };
+      await Promise.allSettled([
+        invalidateOwnedQueries({ ...request, scopes: ['list', 'many'] }),
+        ...attempted.map(id => invalidateOwnedQueries({ ...request, scopes: ['detail'], id })),
+      ]);
+    } catch {
+      // Cache failures cannot falsify a checked deletion receipt.
+    }
+  }
+  const mutation = createMutation<Result<S>, Failure, Invocation>(() => ({
+    retry: false,
+    onMutate: () => undefined,
+    onSuccess: () => {},
+    onError: () => {},
+    onSettled: () => {},
+    mutationFn: async invocation => {
+      let scope: Scope;
+      try { scope = invocation.readScope(); }
+      catch (cause) {
+        const error = failure(cause);
+        const current = () => latestToken === invocation.token && originCurrent(invocation.origin);
+        if (!current()) throw cancelled(undefined, invocation.readProgress());
+        observe(() => { if (current()) return invocation.callbacks.onError?.(copyFailure(error)); });
+        observe(() => { if (current()) return invocation.callbacks.onSettled?.(undefined, copyFailure(error)); });
+        throw error;
+      }
+      const progress = invocation.readProgress();
+      const { attempted, succeeded, failed } = progress;
+      const causes: HttpError[] = [];
+      const data: ContractRecord<S>[] = [];
+      let rejected: Failure | undefined;
+      const current = () => isCurrent(scope) && latestToken === invocation.token;
+      const ensureCurrent = () => {
+        if (!current() || active?.token !== invocation.token) throw cancelled(scope, progress);
+      };
+      const request = () => ({
+        resource: scope.contract.name,
+        ...definedOptions({
+          meta: scope.meta === undefined ? undefined : decodeBaseRecord(snapshotPlainData(scope.meta)),
+          variables: scope.variables === undefined ? undefined : snapshotPlainData(scope.variables),
+        }),
+      });
+      try {
+        ensureCurrent();
+        if (scope.deleteMany) {
+          const params = { ...request(), ids: [...scope.ids] };
+          attempted.push(...scope.ids);
+          const response = await scope.deleteMany(params);
+          if (!sessionCurrent(scope)) throw cancelled(scope, progress);
+          data.push(...decodeDeleteManyReceipt(scope.contract, scope.ids, response, true));
+          succeeded.push(...scope.ids);
+        } else {
+          for (const id of scope.ids) {
+            ensureCurrent();
+            const params = { ...request(), id };
+            attempted.push(id);
+            try {
+              const response = await scope.deleteOne(params);
+              if (!sessionCurrent(scope)) throw cancelled(scope, progress);
+              data.push(...decodeDeleteManyReceipt(scope.contract, [id], response, false));
+              succeeded.push(id);
+            } catch (cause) {
+              if (!sessionCurrent(scope)) throw cancelled(scope, progress);
+              failed.push(id);
+              causes.push(failure(cause, true));
+            }
+          }
+          if (failed.length) rejected = succeeded.length
+            ? new DeleteManyPartialError(succeeded, failed, causes) : causes[0] ?? failure(undefined, true);
+        }
+      } catch (cause) {
+        rejected = failure(cause, attempted.length > 0);
+      } finally {
+        for (const id of succeeded) {
+          if (!sessionCurrent(scope)) break;
+          auditWithProvider({ action: 'delete', resource: scope.contract.name, recordId: id,
+            ...definedOptions({ meta: scope.meta }) }, scope.audit, () => sessionCurrent(scope));
+        }
+        if (succeeded.length) observe(() => {
+          if (sessionCurrent(scope)) return scope.live?.publish?.({
+            type: 'DELETE', resource: scope.contract.name, payload: { ids: [...succeeded] },
+          });
+        });
+        if (sessionCurrent(scope)) await refresh(scope, attempted, succeeded);
+      }
+      ensureCurrent();
+      if (rejected) {
+        const error = rejected;
+        const authError = causes.find(cause => cause.statusCode === 401 || cause.statusCode === 403) ?? error;
+        observe(async () => {
+          await handleAuthError(failure(authError, true), context,
+            () => targetCurrent(scope) && latestToken === invocation.token,
+            () => clearAuthQueries(client, scope.auth), scope.authScope,
+            () => mounted && latestToken !== invocation.token);
+        });
+        notify(scope, current, 'error', error instanceof DeleteManyPartialError
+          ? i18n.t('common.batchDeletePartialFail', { failed: error.failedIds.length, total: scope.ids.length })
+          : i18n.t('common.batchDeleteFailed', { count: scope.ids.length }));
+        observe(() => { if (current()) return invocation.callbacks.onError?.(copyFailure(error)); });
+        observe(() => { if (current()) return invocation.callbacks.onSettled?.(undefined, copyFailure(error)); });
+        throw error;
+      }
+      const result = { data };
+      notify(scope, current, 'success', i18n.t('common.batchDeleteSuccess', { count: scope.ids.length }));
+      observe(() => { if (current()) return invocation.callbacks.onSuccess?.(copyResult(scope, result)); });
+      observe(() => { if (current()) return invocation.callbacks.onSettled?.(copyResult(scope, result), null); });
+      ensureCurrent();
+      return copyResult(scope, result);
+    },
+  }));
+  $effect.pre(() => {
+    if (latest && !isCurrent(latest)) {
+      latest = undefined;
+      active = undefined;
+      mutation.reset();
+    }
+  });
+  $effect(() => () => { mounted = false; active = undefined; latestToken = undefined; });
+
+  function detachedPromise(promise: Promise<Result<S>>, scope: Scope, token: object, progress: Progress): Promise<Result<S>> {
+    return promise.then(data => {
+      if (!isCurrent(scope) || latestToken !== token) throw cancelled(scope, progress);
+      return copyResult(scope, data);
+    }, (cause: unknown) => {
+      if (!isCurrent(scope) || latestToken !== token) throw cancelled(scope, progress);
+      throw cause instanceof DeleteManyPartialError || cause instanceof HttpError
+        ? copyFailure(cause) : failure(cause, progress.attempted.length > 0);
+    });
+  }
+  function mutateAsync(params: ContractDeleteManyParams<S>, callbacks: Callbacks<S> = {}): Promise<Result<S>> {
+    const origin = captureOrigin();
+    const observer = { onSuccess: callbacks.onSuccess, onError: callbacks.onError, onSettled: callbacks.onSettled };
+    let scope: Scope;
+    try { scope = capture(params); }
+    catch (cause) {
+      const error = failure(cause);
+      if (active && isCurrent(active.scope)) return Promise.reject(error);
+      latest = undefined;
+      active = undefined;
+      const token = {};
+      const progress = newProgress();
+      latestToken = token;
+      return mutation.mutateAsync(Object.freeze({
+        scope: undefined, origin, token, callbacks: definedOptions(observer),
+        readScope: () => { throw error; }, readProgress: () => progress,
+      })).catch((cause: unknown) => {
+        if (!originCurrent(origin) || latestToken !== token) throw cancelled(undefined, progress);
+        throw cause instanceof HttpError ? copyFailure(cause) : failure(cause);
+      });
+    }
+    if (active && isCurrent(active.scope)) {
+      if (active.scope.signature === scope.signature) {
+        const owner = active.scope;
+        const { token, progress } = active;
+        const current = () => isCurrent(owner) && latestToken === token;
+        return detachedPromise(active.promise, owner, token, progress).then(data => {
+          if (current()) {
+            observe(() => observer.onSuccess?.(copyResult(owner, data)));
+            observe(() => { if (current()) return observer.onSettled?.(copyResult(owner, data), null); });
+          }
+          if (!current()) throw cancelled(owner, progress);
+          return data;
+        }, (cause: unknown) => {
+          const error = cause instanceof DeleteManyPartialError || cause instanceof HttpError
+            ? cause : failure(cause, progress.attempted.length > 0);
+          if (current()) {
+            observe(() => observer.onError?.(copyFailure(error)));
+            observe(() => { if (current()) return observer.onSettled?.(undefined, copyFailure(error)); });
+          }
+          if (!current()) throw cancelled(owner, progress);
+          throw error;
+        });
+      }
+      return Promise.reject(new HttpError('Batch deletion is already running', 409, undefined, { code: 'DELETE_MANY_BUSY' }));
+    }
+    const token = {};
+    latestToken = token;
+    latest = scope;
+    const target = scope;
+    const progress = newProgress();
+    // Preserve scope and token identity through Svelte's mutation-state projection.
+    const promise = mutation.mutateAsync(Object.freeze({
+      scope, origin, token, callbacks: definedOptions(observer), readScope: () => target,
+      readProgress: () => progress,
+    })).finally(() => { if (active?.token === token) active = undefined; });
+    active = { scope, token, promise, progress };
+    return detachedPromise(promise, target, token, progress);
+  }
+  // Copies preserve the mutation's data/error discriminants without sharing mutable records.
+  function detachedState(state: typeof mutation): typeof mutation;
+  function detachedState(state: typeof mutation): object {
+    return replaceReactiveUnionMembers(state, {
+      get data() {
+        const scope = state.variables?.scope;
+        return state.data && scope ? copyResult(scope, state.data) : undefined;
+      },
+      get error() { return state.error ? copyFailure(state.error) : null; },
+      get failureReason() { return state.failureReason ? copyFailure(state.failureReason) : null; },
+    });
+  }
+  const result = replaceReactiveUnionMembers(detachedState(mutation), {
+    get variables() {
+      const scope = mutation.variables?.scope;
+      return scope ? parseDeleteManyParams(scope.contract, scope.input) : undefined;
+    },
+    mutateAsync,
+    mutate(params: ContractDeleteManyParams<S>, callbacks?: Callbacks<S>): void {
+      void mutateAsync(params, callbacks).catch(() => {});
+    },
+    reset() { active = undefined; latest = undefined; latestToken = undefined; mutation.reset(); },
+  });
+  const idle: typeof result = {
+    context: undefined, data: undefined, error: null, failureCount: 0, failureReason: null,
+    isError: false, isIdle: true, isPending: false, isPaused: false, isSuccess: false,
+    status: 'idle', submittedAt: 0, variables: undefined,
+    mutate: result.mutate, mutateAsync: result.mutateAsync, reset: result.reset,
+  };
+  const view = createQueryResultView(() => {
+    const invocation = mutation.variables;
+    if (!mounted || (invocation && (!originCurrent(invocation.origin) || latestToken !== invocation.token ||
+      (invocation.scope && !isCurrent(invocation.scope))))) return idle;
+    return result;
+  });
+  const overtime = createOvertimeTracker(() => view.isPending, options.overtimeOptions ?? adminOptions.overtime);
+  return { mutation: view, get overtime() { return overtime; } };
+}

package/src/enterprise.ts

@@ -1,4 +1,4 @@
-/** 企业级管理能力的正式 Provider 契约。 */
+/** Formal provider contract for enterprise management capabilities. */
 
 export interface EnterpriseActionError {
   message: string;
@@ -10,7 +10,7 @@ export interface EnterpriseActionResult {
   error?: EnterpriseActionError;
 }
 
-/** 每次企业能力调用都必须显式携带当前请求树的租户与追踪上下文。 */
+/** Every enterprise capability call must carry the current request tree's tenant and trace context. */
 export interface EnterpriseRequestContext {
   tenantId?: string | number;
   requestId?: string;
@@ -18,7 +18,7 @@ export interface EnterpriseRequestContext {
   meta?: Readonly<Record<string, unknown>>;
 }
 
-/** Provider 调用使用的严格请求上下文；三项边界标识不可省略。 */
+/** Strict provider request context; all three boundary identifiers are required. */
 export interface StrictEnterpriseRequestContext {
   tenantId: string | number;
   requestId: string;
@@ -179,7 +179,7 @@ export interface ApiCredentialSummary {
 
 export interface CreatedApiCredential {
   credential: ApiCredentialSummary;
-  /** 只在创建时返回一次；列表接口不得返回此字段。 */
+  /** Returned only at creation time; list endpoints must not expose this field. */
   secret: string;
 }
 

package/src/export-format.ts

@@ -1,10 +1,10 @@
-// 纯函数导出格式化工具 — 不依赖 Svelte runes 或浏览器 API（downloadData 除外）
-// 可被 bun:test 直接测试
+// Pure export formatting helpers with no Svelte rune or browser API dependencies except downloadData.
+// These helpers can be tested directly with bun:test.
 
-/** 支持的导出/导入格式 */
+/** Supported export and import formats. */
 export type ExportFormat = 'csv' | 'json' | 'xlsx';
 
-/** CSV 转义，含公式注入防护 */
+/** Escapes a CSV field and prevents formula injection. */
 export function escapeCsvField(fieldValue: string): string {
   let escapedValue = fieldValue;
   if (/^[=+@\t\r]/.test(escapedValue)) escapedValue = "'" + escapedValue;
@@ -13,10 +13,11 @@ export function escapeCsvField(fieldValue: string): string {
     : escapedValue;
 }
 
-/** 将记录数组转为 CSV 字符串 */
+/** Converts records to a CSV string. */
 export function toCsv(records: Record<string, unknown>[]): string {
-  if (records.length === 0) return '';
-  const fieldNames = Object.keys(records[0]);
+  const [firstRecord] = records;
+  if (!firstRecord) return '';
+  const fieldNames = Object.keys(firstRecord);
   const header = fieldNames.map(escapeCsvField).join(',');
   const rows = records.map(record =>
     fieldNames.map(fieldName => {
@@ -32,22 +33,23 @@ export function toCsv(records: Record<string, unknown>[]): string {
   return [header, ...rows].join('\n');
 }
 
-/** 将记录数组转为格式化的 JSON 字符串 */
+/** Converts records to a formatted JSON string. */
 export function toJson(records: Record<string, unknown>[]): string {
   return JSON.stringify(records, null, 2);
 }
 
-/** 转义 XML 特殊字符 */
+/** Escapes XML special characters. */
 export function escapeXml(xmlValue: string): string {
   return xmlValue.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
 }
 
 /**
- * 生成最小可用的 XLSX（SpreadsheetML）——零依赖。
+ * Generates a minimal XLSX document using SpreadsheetML with no dependencies.
  */
 export function toXlsx(records: Record<string, unknown>[]): string {
-  if (records.length === 0) return '';
-  const fieldNames = Object.keys(records[0]);
+  const [firstRecord] = records;
+  if (!firstRecord) return '';
+  const fieldNames = Object.keys(firstRecord);
 
   const headerCells = fieldNames.map(fieldName => `<Cell><Data ss:Type="String">${escapeXml(fieldName)}</Data></Cell>`).join('');
   const dataRows = records.map(record =>
@@ -75,8 +77,8 @@ ${dataRows}
 }
 
 /**
- * 将记录以指定格式下载为文件。
- * 依赖浏览器 document API；在 Node/bun:test 中需 mock。
+ * Downloads records in the requested format.
+ * Requires the browser document API, which must be mocked in Node or bun:test.
  */
 export function downloadData(
   records: Record<string, unknown>[],