antd-crud-table 0.7.0 → 0.8.0

package/dist/CrudTable.cjs

@@ -1 +1 @@
-Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./CrudTable-DRN70sET.cjs");require("./exportData.cjs"),exports.default=e.t;
+Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./CrudTable-BfVtTGYV.cjs");require("./exportData.cjs"),exports.default=e.t;

package/dist/CrudTable.d.ts

@@ -66,6 +66,16 @@ export interface CrudTableConfig<T extends object, K extends keyof T> {
     enableColumnSettings?: boolean;
     /** Show the export entries in the toolbar menu. Defaults to true. */
     enableExport?: boolean;
+    /**
+     * Show the import entry in the toolbar menu. Defaults to false.
+     *
+     * Import creates records through the data source's `create` (or `createMany`
+     * when available), so it is only meaningful for a writable source. Opt-in,
+     * mirroring how a consumer decides whether the table accepts bulk input.
+     */
+    enableImport?: boolean;
+    /** Max simultaneous single-row creates during import. Defaults to 5. */
+    importConcurrency?: number;
     /**
      * Whether export covers the whole filtered result set or just the rows on
      * screen. Defaults to `'all'`, falling back to `'page'` when the data source

package/dist/CrudTable.js

@@ -1,3 +1,3 @@
-import { t as e } from "./CrudTable-Btf58zof.js";
+import { t as e } from "./CrudTable-jy8Db0uQ.js";
 import "./exportData.js";
 export { e as default };

package/dist/CrudTableLazy.cjs

@@ -1 +1 @@
-Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./en_US-D3Kl6g3n.cjs");let t=require("react"),n=require("react/jsx-runtime");var r=(0,t.lazy)(()=>Promise.resolve().then(()=>require("./CrudTable.cjs"))),i=i=>(0,n.jsx)(t.Suspense,{fallback:(0,n.jsx)(`div`,{style:{textAlign:`center`,padding:`2rem`},children:i.locale?.loading??e.t.loading}),children:(0,n.jsx)(r,{...i})});exports.default=i;
+Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./en_US-Q8nDeJhg.cjs");let t=require("react"),n=require("react/jsx-runtime");var r=(0,t.lazy)(()=>Promise.resolve().then(()=>require("./CrudTable.cjs"))),i=i=>(0,n.jsx)(t.Suspense,{fallback:(0,n.jsx)(`div`,{style:{textAlign:`center`,padding:`2rem`},children:i.locale?.loading??e.t.loading}),children:(0,n.jsx)(r,{...i})});exports.default=i;

package/dist/CrudTableLazy.js

@@ -1,4 +1,4 @@
-import { t as e } from "./en_US-DGCMDOdX.js";
+import { t as e } from "./en_US-DghHhwRq.js";
 import { Suspense as t, lazy as n } from "react";
 import { jsx as r } from "react/jsx-runtime";
 //#region lib/CrudTableLazy.tsx

package/dist/core/RestDataSource.d.ts

@@ -21,17 +21,62 @@ export interface RestParamNames {
     /** Parameter carrying the sort direction. Defaults to `sortOrder`. */
     sortOrder: string;
 }
+/**
+ * An HTTP verb.
+ *
+ * The common ones are listed so they autocomplete, but any string is accepted:
+ * a closed union cannot describe every API, and being unable to send the verb
+ * a server expects is not a constraint worth enforcing.
+ */
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | (string & Record<never, never>);
 /** HTTP verbs used per mutating operation. */
 export interface RestMethods {
     /** Verb for creating a record. Defaults to `POST`. */
-    create: 'POST' | 'PUT';
+    create: HttpMethod;
     /** Verb for updating a record. Defaults to `PUT`. */
-    update: 'PUT' | 'PATCH' | 'POST';
+    update: HttpMethod;
     /** Verb for deleting a record. Defaults to `DELETE`. */
-    remove: 'DELETE' | 'POST';
+    remove: HttpMethod;
+}
+/** Which operation a request belongs to. */
+export type RestOperation = 'list' | 'create' | 'update' | 'remove';
+/** Query-string values a caller can attach to a request. */
+export type RestQueryValue = string | number | boolean;
+/**
+ * What a request is for, handed to every call-time hook.
+ *
+ * Carrying the operation and its subject is what lets one hook serve all four
+ * - an `Idempotency-Key` on create, an `If-Match` built from the id on update,
+ * a fresh token on everything.
+ */
+export interface RestRequestContext<T, K extends keyof T> {
+    operation: RestOperation;
+    /** Present for `update` and `remove`. */
+    id?: T[K];
+    /** Present for `create` and `update`. */
+    draft?: CrudDraft<T>;
+    /** Present for `list`. */
+    query?: CrudQuery<T>;
+}
+/**
+ * Per-request adjustments, resolved at call time.
+ *
+ * Returned from {@link RestDataSourceOptions.configureRequest}, which may be
+ * async - so a token can be awaited from a refresh call rather than captured
+ * when the source was constructed.
+ */
+export interface RestRequestOverrides {
+    /** Merged over the static headers. */
+    headers?: Record<string, string>;
+    /** Replaces the verb this operation would otherwise use. */
+    method?: HttpMethod;
+    /** Merged over the static query parameters. */
+    query?: Record<string, RestQueryValue>;
+    /** Passed through to `fetch` - `credentials`, `mode`, `cache`, `signal`, ... */
+    init?: Omit<RequestInit, 'method' | 'body' | 'headers'>;
 }
 /** Everything needed to point a {@link RestDataSource} at an API. */
-export interface RestDataSourceOptions<T> {
+export interface RestDataSourceOptions<T, K extends keyof T = keyof T> {
     /** Prefixed to every request path, exactly once. */
     baseUrl?: string;
     /** Overrides for the per-operation paths. */
@@ -42,10 +87,35 @@ export interface RestDataSourceOptions<T> {
     methods?: Partial<RestMethods>;
     /** Sent with every request, merged over the default content type. */
     headers?: Readonly<Record<string, string>>;
+    /** Appended to every request's query string, merged with generated parameters. */
+    query?: Readonly<Record<string, RestQueryValue>>;
+    /**
+     * Passed through to `fetch` on every request.
+     *
+     * This is where `credentials: 'include'` for cookie auth lives, along with
+     * `mode`, `cache`, `redirect` and a long-lived `signal`.
+     */
+    init?: Omit<RequestInit, 'method' | 'body' | 'headers'>;
+    /**
+     * Adjusts a request as it is made.
+     *
+     * Runs per call and may be async, so it covers what static options cannot:
+     * a rotating or awaited token, a header only one operation sends, a verb
+     * chosen from the payload. Its result is merged over the static options.
+     */
+    configureRequest?: (context: RestRequestContext<T, K>) => RestRequestOverrides | Promise<RestRequestOverrides>;
     /** Maps a draft onto the request body. Defaults to sending the draft as-is. */
-    serializeRequest?: (draft: CrudDraft<T>) => unknown;
+    serializeRequest?: (draft: CrudDraft<T>, context: RestRequestContext<T, K>) => unknown;
     /** Maps a list response onto a page. Required when the API wraps its payload. */
     parseResponse?: (payload: unknown) => CrudPage<T>;
+    /**
+     * Maps a create or update response onto the stored record.
+     *
+     * The inbound counterpart to `serializeRequest`. Without it a write response
+     * is taken as the record itself, so an API that answers `{ data: { ... } }`
+     * hands back the envelope.
+     */
+    parseRecord?: (payload: unknown, context: RestRequestContext<T, K>) => T;
     /** Injected for testing; defaults to the global `fetch`. */
     fetchImpl?: typeof fetch;
 }
@@ -80,12 +150,20 @@ export declare class RestDataSource<T extends object, K extends keyof T> impleme
     protected readonly methods: RestMethods;
     /** Headers sent with every request. */
     protected readonly headers: Readonly<Record<string, string>>;
+    /** Appended to every request's query string. */
+    protected readonly query: Readonly<Record<string, RestQueryValue>>;
+    /** Passed through to `fetch` on every request. */
+    protected readonly init: Omit<RequestInit, 'method' | 'body' | 'headers'>;
+    /** Resolves per-request adjustments at call time. */
+    protected readonly configureRequest?: (context: RestRequestContext<T, K>) => RestRequestOverrides | Promise<RestRequestOverrides>;
     /** Maps a draft onto the request body. */
-    protected readonly serializeRequest: (draft: CrudDraft<T>) => unknown;
+    protected readonly serializeRequest: (draft: CrudDraft<T>, context: RestRequestContext<T, K>) => unknown;
     /** Maps a list payload onto a page, when the API wraps its results. */
     protected readonly parseResponse?: (payload: unknown) => CrudPage<T>;
+    /** Maps a create or update response onto the stored record. */
+    protected readonly parseRecord?: (payload: unknown, context: RestRequestContext<T, K>) => T;
     private readonly fetchImpl;
-    constructor(options?: RestDataSourceOptions<T>);
+    constructor(options?: RestDataSourceOptions<T, K>);
     /**
      * Encode sort instructions as query parameters.
      *
@@ -94,6 +172,15 @@ export declare class RestDataSource<T extends object, K extends keyof T> impleme
      * server may not share. Override to support one.
      */
     protected serializeSort(sort: readonly CrudSort<T>[] | undefined, params: URLSearchParams): void;
+    /**
+     * Encode filters as query parameters.
+     *
+     * Each filter is sent under its own field name, which suits an API that
+     * filters per column. An API with a single search parameter - `?q=` is the
+     * common shape - wants them combined instead, so this is a seam rather than
+     * inline, matching {@link serializeSort}.
+     */
+    protected serializeFilters(filters: CrudQuery<T>['filters'], params: URLSearchParams): void;
     /** Build the list URL, including pagination, sort and filters. */
     protected buildListUrl(query: CrudQuery<T>): string;
     /** Path addressing a single record. Override for `?id=` style APIs. */
@@ -112,7 +199,9 @@ export declare class RestDataSource<T extends object, K extends keyof T> impleme
      * building a full URL earlier and prefixing again is how it ended up
      * duplicated for relative bases.
      */
-    protected request(path: string, init?: RequestInit): Promise<unknown>;
+    protected request(path: string, context: RestRequestContext<T, K>, init?: RequestInit): Promise<unknown>;
+    /** Interpret a create or update response. */
+    protected toRecord(payload: unknown, context: RestRequestContext<T, K>): T;
     list(query: CrudQuery<T>): Promise<CrudPage<T>>;
     create(draft: CrudDraft<T>): Promise<T>;
     update(id: T[K], draft: CrudDraft<T>): Promise<T>;

package/dist/core/index.d.ts

@@ -6,6 +6,6 @@ export { StaticDataSource } from './StaticDataSource';
 export { LocalStorageDataSource } from './LocalStorageDataSource';
 export type { Timestamped } from './LocalStorageDataSource';
 export { RestDataSource, RestError } from './RestDataSource';
-export type { RestDataSourceOptions, RestEndpoints, RestMethods, RestParamNames, } from './RestDataSource';
+export type { HttpMethod, RestDataSourceOptions, RestEndpoints, RestMethods, RestOperation, RestParamNames, RestQueryValue, RestRequestContext, RestRequestOverrides, } from './RestDataSource';
 export { CustomDataSource, UnsupportedOperationError } from './CustomDataSource';
 export type { CrudOperations } from './CustomDataSource';

package/dist/core/types.d.ts

@@ -71,6 +71,14 @@ export interface CrudDataSource<T, K extends keyof T> {
     list(query: CrudQuery<T>): Promise<CrudPage<T>>;
     /** Persist a new record and return it as stored, identity included. */
     create(draft: CrudDraft<T>): Promise<T>;
+    /**
+     * Persist many new records in one call, returning them as stored.
+     *
+     * Exists so bulk import can avoid firing one request per row against sources
+     * that can create server-side in a batch. Optional: callers must fall back to
+     * repeated `create` (with bounded concurrency) when a source does not offer it.
+     */
+    createMany?(drafts: readonly CrudDraft<T>[]): Promise<readonly T[]>;
     /** Merge `draft` into the record at `id` and return the stored result. */
     update(id: T[K], draft: CrudDraft<T>): Promise<T>;
     /** Delete the record at `id`. */

package/dist/{en_US-DGCMDOdX.js → en_US-DghHhwRq.js}

@@ -23,6 +23,25 @@ var e = {
 	exportPage: (e) => `Export page as ${e}`,
 	nothingToExport: "Nothing to export",
 	exportFailed: (e) => `Export failed: ${e}`,
+	importMenu: "Import",
+	importTitle: "Import data",
+	importSelectFile: "Choose a file to import",
+	importAcceptHint: (e) => `Accepted formats: ${e}`,
+	importMapColumns: "Map columns",
+	importIgnoreColumn: "— Ignore —",
+	importPreview: "Preview",
+	importRowLabel: "Row",
+	importStatusLabel: "Status",
+	importRowValid: "Valid",
+	importSummary: (e, t) => `${e} valid, ${t} to skip`,
+	importPreviewTruncated: (e, t) => `Showing first ${e} of ${t} rows`,
+	importRun: "Import",
+	importBack: "Back",
+	importNothingValid: "No valid rows to import",
+	importSuccess: (e) => `Imported ${e} rows`,
+	importPartial: (e, t, n) => `Imported ${e} of ${t}. ${n} failed.`,
+	importParseFailed: (e) => `Could not read file: ${e}`,
+	importUnsupportedFormat: (e) => `Unsupported file format: ${e}`,
 	createSuccess: "Created successfully",
 	updateSuccess: "Updated successfully",
 	deleteSuccess: "Deleted successfully",

package/dist/en_US-Q8nDeJhg.cjs

@@ -0,0 +1 @@
+var e={actions:`Actions`,edit:`Edit`,delete:`Delete`,create:`New`,refresh:`Refresh`,createTitle:`Create Item`,editTitle:`Edit Item`,ok:`OK`,cancel:`Cancel`,requiredField:e=>`${e} is required`,confirmDeleteTitle:`Are you sure?`,confirmDeleteContent:`This action cannot be undone.`,confirmDeleteOk:`Yes, Delete`,confirmBulkDeleteTitle:e=>`Delete ${e} items?`,confirmBulkDeleteOk:`Yes, Delete All`,deleteSelected:e=>`Delete Selected (${e})`,selectItemsToDelete:`Please select items to delete`,bulkDeleteSuccess:e=>`Deleted ${e} items`,bulkDeletePartial:(e,t,n)=>`Deleted ${e} of ${t}. ${n} failed.`,exportAll:e=>`Export all as ${e}`,exportPage:e=>`Export page as ${e}`,nothingToExport:`Nothing to export`,exportFailed:e=>`Export failed: ${e}`,importMenu:`Import`,importTitle:`Import data`,importSelectFile:`Choose a file to import`,importAcceptHint:e=>`Accepted formats: ${e}`,importMapColumns:`Map columns`,importIgnoreColumn:`— Ignore —`,importPreview:`Preview`,importRowLabel:`Row`,importStatusLabel:`Status`,importRowValid:`Valid`,importSummary:(e,t)=>`${e} valid, ${t} to skip`,importPreviewTruncated:(e,t)=>`Showing first ${e} of ${t} rows`,importRun:`Import`,importBack:`Back`,importNothingValid:`No valid rows to import`,importSuccess:e=>`Imported ${e} rows`,importPartial:(e,t,n)=>`Imported ${e} of ${t}. ${n} failed.`,importParseFailed:e=>`Could not read file: ${e}`,importUnsupportedFormat:e=>`Unsupported file format: ${e}`,createSuccess:`Created successfully`,updateSuccess:`Updated successfully`,deleteSuccess:`Deleted successfully`,loading:`Loading CRUD table…`,yes:`Yes`,no:`No`,empty:`-`,selectPlaceholder:e=>`Select ${e.toLowerCase()}`,tagsPlaceholder:`Type and press enter`,invalidEmail:`Please enter a valid email`,invalidUrl:`Please enter a valid URL`,invalidImageUrl:`Please enter a valid image URL`,invalidJson:`Please enter valid JSON`};Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return e}});

package/dist/fields/registry.d.ts

@@ -19,6 +19,18 @@ export interface FieldTypeDefinition {
     toFormValue?: (value: unknown) => unknown;
     /** Convert the submitted form value back into the record shape. */
     fromFormValue?: (value: unknown) => unknown;
+    /**
+     * Convert a raw string cell from an imported file into the record shape.
+     *
+     * Import values arrive as text (a CSV field, a spreadsheet cell), which is a
+     * different starting point from {@link fromFormValue} (whose input is the
+     * form control's own value - a dayjs, a boolean, an object). A type that
+     * needs no conversion omits this and the raw string is stored as-is; types
+     * whose record shape is not a string (numbers, dates, arrays, JSON) provide
+     * one. `enum` is resolved by the importer instead, since it needs the
+     * column's `enumOptions` to accept either the stored key or the exported label.
+     */
+    fromImportValue?: (value: string) => unknown;
     /** Validation rules implied by the type itself (merged before user rules). */
     rules?: (col: FieldColumn, locale: CrudTableLocale) => FormRule[];
     /** Form.Item valuePropName override (e.g. 'checked' for Switch). */

package/dist/hooks/useCrudTable.d.ts

@@ -71,7 +71,7 @@ export interface StaticStrategy<T, K extends keyof T> extends UseCrudTableOption
 /** Serves records from a REST API. */
 export interface RestStrategy<T, K extends keyof T> extends UseCrudTableOptionsBase<T, K> {
     /** Endpoints, parameter names, verbs and payload mapping. */
-    api: RestDataSourceOptions<T>;
+    api: RestDataSourceOptions<T, K>;
 }
 /** Serves records persisted to `localStorage`. */
 export interface LocalStorageStrategy<T, K extends keyof T> extends UseCrudTableOptionsBase<T, K> {

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./CrudTable-DRN70sET.cjs"),t=require("./useCrudTable-40jpmCkr.cjs"),n=require("./en_US-D3Kl6g3n.cjs"),r=require("./exportData.cjs"),i=require("./CrudTableLazy.cjs"),a=require("./useLocalStorageCrud.cjs");exports.CrudTable=e.t,exports.default=e.t,exports.CrudTableLazy=i.default,exports.CustomDataSource=t.r,exports.InMemoryDataSource=t.l,exports.LocalStorageDataSource=t.s,exports.RestDataSource=t.a,exports.RestError=t.o,exports.StaticDataSource=t.c,exports.UnsupportedOperationError=t.i,exports.defaultFieldLocale=e.r,exports.defaultIdGenerator=t.m,exports.enUS=n.t,exports.exportAllData=r.exportAllData,exports.exportData=r.exportData,exports.exportToCSV=r.exportToCSV,exports.exportToExcel=r.exportToExcel,exports.exportToJSON=r.exportToJSON,exports.fieldRegistry=e.i,exports.filterRecords=t.u,exports.getFieldDefinition=e.a,exports.paginateRecords=t.d,exports.queryRecords=t.f,exports.randomUuid=t.h,exports.sortRecords=t.p,exports.toError=t.t,exports.useCrudTable=t.n,exports.useLocalStorageCrud=a.useLocalStorageCrud,exports.useResolvedLocale=e.n;
+Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./CrudTable-BfVtTGYV.cjs"),t=require("./useCrudTable-Ex2Imgll.cjs"),n=require("./en_US-Q8nDeJhg.cjs"),r=require("./exportData.cjs"),i=require("./CrudTableLazy.cjs"),a=require("./useLocalStorageCrud.cjs");let o=require("to-spreadsheet");var s=e=>e.replace(/&#x([0-9a-fA-F]+);/g,(e,t)=>String.fromCodePoint(parseInt(t,16))).replace(/&#(\d+);/g,(e,t)=>String.fromCodePoint(parseInt(t,10))).replace(/&lt;/g,`<`).replace(/&gt;/g,`>`).replace(/&quot;/g,`"`).replace(/&apos;/g,`'`).replace(/&amp;/g,`&`),c=(e,t)=>{let n=e.match(RegExp(`\\b${t.replace(`:`,`\\:`)}\\s*=\\s*"([^"]*)"|\\b${t.replace(`:`,`\\:`)}\\s*=\\s*'([^']*)'`));if(n)return s(n[1]===void 0?n[2]:n[1])},l=e=>{let t=e.match(/<Table\b[^>]*>([\s\S]*?)<\/Table>/i);if(!t)return[];let n=t[1],r=[],i=0,a=/<Row\b([^>]*)>([\s\S]*?)<\/Row>|<Row\b([^>]*)\/>/gi,o;for(;(o=a.exec(n))!==null;){let e=o[1]??o[3]??``,t=o[2]??``,n=c(e,`ss:Index`);n&&(i=Number(n)-1);let a=[],l=0,u=/<Cell\b([^>]*)>([\s\S]*?)<\/Cell>|<Cell\b([^>]*)\/>/gi,d;for(;(d=u.exec(t))!==null;){let e=d[1]??d[3]??``,t=d[2]??``,n=c(e,`ss:Index`);n&&(l=Number(n)-1);let r=t.match(/<Data\b[^>]*>([\s\S]*?)<\/Data>/i),i=r?s(r[1]):``;a[l]=i,l++}for(let e=0;e<a.length;e++)a[e]===void 0&&(a[e]=``);r[i]=a,i++}let l=r.reduce((e,t)=>Math.max(e,t?t.length:0),0);for(let e=0;e<r.length;e++){r[e]||(r[e]=[]);for(let t=0;t<l;t++)r[e][t]===void 0&&(r[e][t]=``)}return r},u=t=>e.m(l(typeof t==`string`?t:e.a(t)));e.f(`xls`,u);var d=e=>e==null?``:e instanceof Date?e.toISOString():String(e),f=async t=>{let n=(await(0,o.readExcel)(t)).sheets[0];if(!n)return{headers:[],rows:[]};let r=n.rows.map(e=>e.map(d));return e.m(r)};e.f(`xlsx`,f),exports.CrudImportModal=e.n,exports.CrudTable=e.t,exports.default=e.t,exports.CrudTableLazy=i.default,exports.CustomDataSource=t.r,exports.InMemoryDataSource=t.l,exports.LocalStorageDataSource=t.s,exports.RestDataSource=t.a,exports.RestError=t.o,exports.StaticDataSource=t.c,exports.UnsupportedOperationError=t.i,exports.autoMapColumns=e.r,exports.coerceValue=e.i,exports.defaultFieldLocale=e.g,exports.defaultIdGenerator=t.m,exports.detectFormat=e.o,exports.enUS=n.t,exports.evaluateRules=e.s,exports.exportAllData=r.exportAllData,exports.exportData=r.exportData,exports.exportToCSV=r.exportToCSV,exports.exportToExcel=r.exportToExcel,exports.exportToJSON=r.exportToJSON,exports.fieldRegistry=e._,exports.fileParsers=e.c,exports.filterRecords=t.u,exports.getFieldDefinition=e.v,exports.paginateRecords=t.d,exports.parseCsv=e.l,exports.parseSpreadsheetML=l,exports.parseSpreadsheetMLTable=u,exports.parseTable=e.u,exports.parseXlsx=f,exports.prepareRows=e.d,exports.queryRecords=t.f,exports.randomUuid=t.h,exports.registerFileParser=e.f,exports.runImport=e.p,exports.sortRecords=t.p,exports.toError=t.t,exports.useCrudTable=t.n,exports.useLocalStorageCrud=a.useLocalStorageCrud,exports.useResolvedLocale=e.h;

package/dist/index.d.ts

@@ -7,7 +7,7 @@ export { useLocalStorageCrud } from './hooks/useLocalStorageCrud';
 export type { CrudOperationName, CrudTableActions, CrudTableState, UseCrudTableOptions, StaticStrategy, RestStrategy, LocalStorageStrategy, OperationsStrategy, DataSourceStrategy, } from './hooks/useCrudTable';
 export type { UseLocalStorageCrudOptions } from './hooks/useLocalStorageCrud';
 export { CustomDataSource, InMemoryDataSource, LocalStorageDataSource, RestDataSource, RestError, StaticDataSource, UnsupportedOperationError, defaultIdGenerator, filterRecords, paginateRecords, queryRecords, randomUuid, sortRecords, } from './core';
-export type { CrudDataSource, CrudDraft, CrudFilters, CrudFilterValue, CrudOperations, CrudPage, CrudQuery, CrudSort, IdGenerator, RestDataSourceOptions, RestEndpoints, RestMethods, RestParamNames, SortDirection, Timestamped, } from './core';
+export type { CrudDataSource, CrudDraft, CrudFilters, CrudFilterValue, CrudOperations, CrudPage, CrudQuery, CrudSort, IdGenerator, HttpMethod, RestDataSourceOptions, RestEndpoints, RestMethods, RestOperation, RestParamNames, RestQueryValue, RestRequestContext, RestRequestOverrides, SortDirection, Timestamped, } from './core';
 export { enUS, useResolvedLocale } from './locale';
 export type { CrudTableLocale, PartialCrudTableLocale, ResolvedLocale } from './locale';
 export { fieldRegistry, getFieldDefinition, defaultFieldLocale } from './fields/registry';
@@ -15,3 +15,9 @@ export type { FieldType, FieldTypeDefinition } from './fields/registry';
 export type { EnumOption, FieldColumn } from './fields/types';
 export { exportData, exportToCSV, exportToJSON, exportToExcel, exportAllData, } from './utils/exportData';
 export type { ColumnOption, ExportFormat, ExportOptions } from './utils/exportData';
+export { parseCsv, parseTable, detectFormat, autoMapColumns, coerceValue, evaluateRules, prepareRows, runImport, registerFileParser, fileParsers, } from './utils/importData';
+export type { ImportFormat, ImportColumn, ParsedTable, ColumnMapping, PreparedRow, ImportResult, ImportRowOutcome, ImportSink, RunImportOptions, FileParser, } from './utils/importData';
+export { default as CrudImportModal } from './CrudImportModal';
+export type { CrudImportModalProps } from './CrudImportModal';
+export { parseSpreadsheetML, parseSpreadsheetMLTable } from './utils/importSpreadsheetML';
+export { parseXlsx } from './utils/importXlsx';

package/dist/index.js

@@ -1,7 +1,50 @@
-import { a as e, i as t, n, r, t as i } from "./CrudTable-Btf58zof.js";
-import { a, c as o, d as s, f as c, h as l, i as u, l as d, m as f, n as p, o as m, p as h, r as g, s as _, t as v, u as y } from "./useCrudTable-DxjnXVlQ.js";
-import { t as b } from "./en_US-DGCMDOdX.js";
-import { exportAllData as x, exportData as S, exportToCSV as C, exportToExcel as w, exportToJSON as T } from "./exportData.js";
-import E from "./CrudTableLazy.js";
-import { useLocalStorageCrud as D } from "./useLocalStorageCrud.js";
-export { i as CrudTable, i as default, E as CrudTableLazy, g as CustomDataSource, d as InMemoryDataSource, _ as LocalStorageDataSource, a as RestDataSource, m as RestError, o as StaticDataSource, u as UnsupportedOperationError, r as defaultFieldLocale, f as defaultIdGenerator, b as enUS, x as exportAllData, S as exportData, C as exportToCSV, w as exportToExcel, T as exportToJSON, t as fieldRegistry, y as filterRecords, e as getFieldDefinition, s as paginateRecords, c as queryRecords, l as randomUuid, h as sortRecords, v as toError, p as useCrudTable, D as useLocalStorageCrud, n as useResolvedLocale };
+import { _ as e, a as t, c as n, d as r, f as i, g as a, h as o, i as s, l as c, m as l, n as u, o as d, p as f, r as p, s as m, t as h, u as g, v as _ } from "./CrudTable-jy8Db0uQ.js";
+import { a as v, c as y, d as b, f as x, h as S, i as C, l as w, m as T, n as E, o as D, p as O, r as k, s as A, t as j, u as M } from "./useCrudTable-BVXxakfl.js";
+import { t as N } from "./en_US-DghHhwRq.js";
+import { exportAllData as P, exportData as F, exportToCSV as I, exportToExcel as L, exportToJSON as R } from "./exportData.js";
+import z from "./CrudTableLazy.js";
+import { useLocalStorageCrud as B } from "./useLocalStorageCrud.js";
+import { readExcel as V } from "to-spreadsheet";
+//#region lib/utils/importSpreadsheetML.ts
+var H = (e) => e.replace(/&#x([0-9a-fA-F]+);/g, (e, t) => String.fromCodePoint(parseInt(t, 16))).replace(/&#(\d+);/g, (e, t) => String.fromCodePoint(parseInt(t, 10))).replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&quot;/g, "\"").replace(/&apos;/g, "'").replace(/&amp;/g, "&"), U = (e, t) => {
+	let n = e.match(RegExp(`\\b${t.replace(":", "\\:")}\\s*=\\s*"([^"]*)"|\\b${t.replace(":", "\\:")}\\s*=\\s*'([^']*)'`));
+	if (n) return H(n[1] === void 0 ? n[2] : n[1]);
+}, W = (e) => {
+	let t = e.match(/<Table\b[^>]*>([\s\S]*?)<\/Table>/i);
+	if (!t) return [];
+	let n = t[1], r = [], i = 0, a = /<Row\b([^>]*)>([\s\S]*?)<\/Row>|<Row\b([^>]*)\/>/gi, o;
+	for (; (o = a.exec(n)) !== null;) {
+		let e = o[1] ?? o[3] ?? "", t = o[2] ?? "", n = U(e, "ss:Index");
+		n && (i = Number(n) - 1);
+		let a = [], s = 0, c = /<Cell\b([^>]*)>([\s\S]*?)<\/Cell>|<Cell\b([^>]*)\/>/gi, l;
+		for (; (l = c.exec(t)) !== null;) {
+			let e = l[1] ?? l[3] ?? "", t = l[2] ?? "", n = U(e, "ss:Index");
+			n && (s = Number(n) - 1);
+			let r = t.match(/<Data\b[^>]*>([\s\S]*?)<\/Data>/i), i = r ? H(r[1]) : "";
+			a[s] = i, s++;
+		}
+		for (let e = 0; e < a.length; e++) a[e] === void 0 && (a[e] = "");
+		r[i] = a, i++;
+	}
+	let s = r.reduce((e, t) => Math.max(e, t ? t.length : 0), 0);
+	for (let e = 0; e < r.length; e++) {
+		r[e] || (r[e] = []);
+		for (let t = 0; t < s; t++) r[e][t] === void 0 && (r[e][t] = "");
+	}
+	return r;
+}, G = (e) => l(W(typeof e == "string" ? e : t(e)));
+i("xls", G);
+//#endregion
+//#region lib/utils/importXlsx.ts
+var K = (e) => e == null ? "" : e instanceof Date ? e.toISOString() : String(e), q = async (e) => {
+	let t = (await V(e)).sheets[0];
+	if (!t) return {
+		headers: [],
+		rows: []
+	};
+	let n = t.rows.map((e) => e.map(K));
+	return l(n);
+};
+i("xlsx", q);
+//#endregion
+export { u as CrudImportModal, h as CrudTable, h as default, z as CrudTableLazy, k as CustomDataSource, w as InMemoryDataSource, A as LocalStorageDataSource, v as RestDataSource, D as RestError, y as StaticDataSource, C as UnsupportedOperationError, p as autoMapColumns, s as coerceValue, a as defaultFieldLocale, T as defaultIdGenerator, d as detectFormat, N as enUS, m as evaluateRules, P as exportAllData, F as exportData, I as exportToCSV, L as exportToExcel, R as exportToJSON, e as fieldRegistry, n as fileParsers, M as filterRecords, _ as getFieldDefinition, b as paginateRecords, c as parseCsv, W as parseSpreadsheetML, G as parseSpreadsheetMLTable, g as parseTable, q as parseXlsx, r as prepareRows, x as queryRecords, S as randomUuid, i as registerFileParser, f as runImport, O as sortRecords, j as toError, E as useCrudTable, B as useLocalStorageCrud, o as useResolvedLocale };

package/dist/locale/types.d.ts

@@ -58,6 +58,44 @@ export interface CrudTableLocale {
     nothingToExport: string;
     /** Error shown when gathering or writing the export failed. */
     exportFailed: (message: string) => string;
+    /** Menu entry that opens the import dialog. */
+    importMenu: string;
+    /** Import dialog title. */
+    importTitle: string;
+    /** Prompt to choose a file to import. */
+    importSelectFile: string;
+    /** Hint listing the accepted file formats (e.g. "CSV"). */
+    importAcceptHint: (formats: string) => string;
+    /** Heading of the header-to-column mapping step. */
+    importMapColumns: string;
+    /** The "do not import this column" option in the mapping selects. */
+    importIgnoreColumn: string;
+    /** Heading of the parsed-row preview. */
+    importPreview: string;
+    /** Column header for the row-number column in the preview. */
+    importRowLabel: string;
+    /** Column header for the per-row status column in the preview. */
+    importStatusLabel: string;
+    /** Status text for a row that passed validation. */
+    importRowValid: string;
+    /** Summary of how many rows are valid / invalid before importing. */
+    importSummary: (valid: number, invalid: number) => string;
+    /** Note shown when the preview is truncated to the first `shown` of `total`. */
+    importPreviewTruncated: (shown: number, total: number) => string;
+    /** Label of the button that performs the import. */
+    importRun: string;
+    /** Label of the button that returns to file selection. */
+    importBack: string;
+    /** Warning shown when no rows are valid to import. */
+    importNothingValid: string;
+    /** Confirmation that every row was imported. */
+    importSuccess: (count: number) => string;
+    /** Report of a partial import: created of total, with a failure count. */
+    importPartial: (created: number, total: number, failed: number) => string;
+    /** Error shown when reading or parsing the file failed. */
+    importParseFailed: (message: string) => string;
+    /** Error shown when the chosen file's format is not supported. */
+    importUnsupportedFormat: (name: string) => string;
     /** Confirmation that a record was created. */
     createSuccess: string;
     /** Confirmation that a record was updated. */