@expresscsv/sdk 0.1.17 → 0.1.19

package/README.md

@@ -5,6 +5,8 @@
 
 A TypeScript SDK for embedding the [ExpressCSV](https://expresscsv.com) CSV import widget into any web application. Define a schema, open the widget, and receive validated, typed data in chunks.
 
+If you want to define schemas in shared or backend code without any frontend dependencies, use [`@expresscsv/schemas`](https://www.npmjs.com/package/@expresscsv/schemas) for the schema definition itself, then pass that schema into `@expresscsv/sdk`.
+
 ## Installation
 
 ```bash
@@ -55,6 +57,8 @@ importer.open({
 });
 ```
 
+If your schema is assembled dynamically at runtime, still use `x.row(...)`. Just note that dynamic schema assembly can widen TypeScript inference, so use it intentionally when you need runtime-driven columns.
+
 Your `publishableKey` is available from the [ExpressCSV dashboard](https://expresscsv.com). Two key types are available: **production** keys for live usage, and **dev/testing** keys that provide unlimited test imports.
 
 ## Webhook Delivery
@@ -112,6 +116,8 @@ interface WebhookPayload {
 }
 ```
 
+When you already have a schema, prefer `InferWebhookPayload<typeof schema>` from `@expresscsv/schemas` instead of rewriting this object shape by hand.
+
 Example payload:
 
 ```json
@@ -150,6 +156,25 @@ Your endpoint should return a **2xx** status code to acknowledge each chunk. Non
 
 Chunks are delivered **serially** — the next chunk is only sent after the previous one succeeds.
 
+If your schema is defined in shared or backend code with `@expresscsv/schemas`, you can reuse the built-in webhook payload helper when handling deliveries:
+
+```typescript
+import express from "express";
+import type { InferWebhookPayload } from "@expresscsv/schemas";
+import { employeeSchema } from "../shared/employee-schema";
+
+const app = express();
+app.use(express.json());
+
+app.post("/webhooks/csv-import", async (req, res) => {
+  const payload = req.body as InferWebhookPayload<typeof employeeSchema>;
+
+  await db.insertMany("users", payload.records);
+
+  res.status(200).json({ ok: true });
+});
+```
+
 Below is a minimal Express.js example:
 
 ```typescript
@@ -241,6 +266,40 @@ const importer = new CSVImporter({
 });
 ```
 
+## Template Downloads
+
+Generated templates can include example rows that match your schema.
+
+```typescript
+import { CSVImporter, x, type Infer } from "@expresscsv/sdk";
+
+const candidateSchema = x.row({
+  firstName: x.string().label("First Name"),
+  email: x.string().email().label("Email"),
+  role: x.select([
+    { label: "Admin", value: "admin" },
+    { label: "Editor", value: "editor" },
+  ]).label("Role"),
+});
+
+const importer = new CSVImporter({
+  schema: candidateSchema,
+  publishableKey: "your-publishable-key",
+  importIdentifier: "candidate-import",
+  templateDownload: {
+    source: "generate",
+    formats: ["csv", "xlsx"],
+    exampleRows: () => [
+      {
+        firstName: "Alice",
+        email: "alice@example.com",
+        role: "admin",
+      },
+    ],
+  },
+});
+```
+
 ## Theming and Styling
 
 Customize the widget's appearance with the `theme`, `colorMode`, `customCSS`, and `fonts` options.
@@ -375,6 +434,8 @@ const importer = new CSVImporter({
 
 The `x` schema builder provides a type-safe, fluent API for defining your CSV structure.
 
+For apps that share schema definitions with backend code or webhook handlers, prefer defining the schema in `@expresscsv/schemas` and importing it into your frontend. That keeps schema authoring free of widget/runtime dependencies.
+
 ### Field Types
 
 ```typescript
@@ -413,6 +474,65 @@ const schema = x.row({
 });
 ```
 
+### Runtime-Built Schemas
+
+For a fixed schema, keep everything in a normal `x.row(...)` definition:
+
+```typescript
+const schema = x.row({
+  email: x.string().email().label("Email"),
+  lifecycleStage: x
+    .select([
+      { label: "Lead", value: "lead" },
+      { label: "Customer", value: "customer" },
+      { label: "Churned", value: "churned" },
+    ])
+    .label("Lifecycle Stage"),
+  accountOwner: x.string().label("Account Owner").optional(),
+  contractValue: x.number().currency("USD").label("Contract Value").optional(),
+});
+```
+
+`x.row(...)` also works for runtime-built schemas, which is useful when the shape depends on account data, user preferences, or enabled custom fields.
+
+```typescript
+import { x } from "@expresscsv/sdk";
+
+function buildCustomerSchema(options: {
+  collectCrmId: boolean;
+  collectHealthScore: boolean;
+  collectSegment: boolean;
+}) {
+  return x.row({
+    email: x.string().email().label("Email"),
+    companyName: x.string().label("Company Name"),
+    ...(options.collectCrmId ? { crmId: x.string().label("CRM ID") } : {}),
+    ...(options.collectHealthScore
+      ? { healthScore: x.number().label("Health Score") }
+      : {}),
+    ...(options.collectSegment
+      ? {
+          segment: x
+            .select([
+              { label: "SMB", value: "smb" },
+              { label: "Mid-Market", value: "mid-market" },
+              { label: "Enterprise", value: "enterprise" },
+            ])
+            .label("Segment"),
+        }
+      : {}),
+  });
+}
+
+const schema = buildCustomerSchema({
+  collectCrmId: true,
+  collectHealthScore: true,
+  collectSegment: false,
+});
+```
+
+Dynamic schema assembly preserves the same runtime parsing behavior, but it can widen `Infer<typeof schema>` because the exact keys are no longer fully known to TypeScript. Use it intentionally.
+
 ### Common Modifiers
 
 All field types support:
@@ -571,7 +691,7 @@ new CSVImporter(options: SDKOptions)
 | `fonts` | `Record<string, ECSVFontSource>` | No | - | Custom font sources |
 | `stepDisplay` | `'progressBar' \| 'segmented' \| 'numbered'` | No | `'progressBar'` | Step indicator style |
 | `previewSchemaBeforeUpload` | `boolean` | No | `true` | Show schema preview before upload |
-| `templateDownload` | `TemplateDownloadConfig` | No | - | Template download configuration |
+| `templateDownload` | `TemplateDownloadOptions<TSchema>` | No | - | Template download configuration with optional schema-typed example rows |
 | `saveSession` | `boolean` | No | - | Persist session state |
 | `locale` | `DeepPartial<ExpressCSVLocaleInput>` | No | - | Localization overrides |
 

package/dist/index.d.cts

@@ -1256,6 +1256,7 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private cachedSchemaJson;
     private initCompletePromise;
     private resolveInitComplete;
+    private resolvedTemplateDownload;
     constructor(options: SDKOptions<TSchema>);
     /**
      * Enhanced state management
@@ -3126,6 +3127,11 @@ declare class ExRow<T extends ExRowShape> extends ExType<{
      * Factory method to create an ExRow validator for a row of data
      *
      * @param shape - Object defining the structure of fields in the row
+     *
+     * Object literals preserve exact key inference. If callers build the shape
+     * through a widened variable or conditional assembly, TypeScript may widen
+     * the resulting row type as well.
+     *
      * @returns A new ExRow instance
      */
     static create<T extends ExRowShape>(shape: T): ExRow<T>;
@@ -3770,7 +3776,7 @@ export declare interface SDKOptions<TSchema extends ExType<unknown, ExBaseDef, u
     fonts?: Record<string, ECSVFontSource>;
     stepDisplay?: 'progressBar' | 'segmented' | 'numbered';
     previewSchemaBeforeUpload?: boolean;
-    templateDownload?: TemplateDownloadConfig;
+    templateDownload?: TemplateDownloadOptions<TSchema>;
     saveSession?: boolean;
     locale?: DeepPartial<ExpressCSVLocaleInput>;
     disableStatusStep?: boolean;
@@ -3827,18 +3833,28 @@ export declare interface TailwindThemeVars {
 
 /**
  * Configuration for template download in the upload step.
- * When `source` is `"generate"`, a header-only template file is created
- * client-side from the schema column names.
+ * When `source` is `"generate"`, a template file is created client-side
+ * from the schema column names and optional example rows.
  */
-declare interface TemplateDownloadConfig {
+export declare interface TemplateDownloadConfig {
     source: 'generate';
     formats?: TemplateDownloadFormat[];
+    exampleRows?: TemplateDownloadExampleRow[];
 }
 
+/**
+ * A serializable example row used to populate generated templates.
+ */
+export declare type TemplateDownloadExampleRow = Record<string, unknown>;
+
 /**
  * Template download format
  */
-declare type TemplateDownloadFormat = 'csv' | 'xlsx';
+export declare type TemplateDownloadFormat = 'csv' | 'xlsx';
+
+export declare type TemplateDownloadOptions<TSchema extends ExType<unknown, ExBaseDef, unknown>> = Omit<TemplateDownloadConfig, 'exampleRows'> & {
+    exampleRows?: Infer<TSchema>[] | (() => Infer<TSchema>[]);
+};
 
 /**
  * A branded string type for locale entries that require interpolation via `{variable}` syntax.

package/dist/index.d.mts

@@ -1256,6 +1256,7 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private cachedSchemaJson;
     private initCompletePromise;
     private resolveInitComplete;
+    private resolvedTemplateDownload;
     constructor(options: SDKOptions<TSchema>);
     /**
      * Enhanced state management
@@ -3126,6 +3127,11 @@ declare class ExRow<T extends ExRowShape> extends ExType<{
      * Factory method to create an ExRow validator for a row of data
      *
      * @param shape - Object defining the structure of fields in the row
+     *
+     * Object literals preserve exact key inference. If callers build the shape
+     * through a widened variable or conditional assembly, TypeScript may widen
+     * the resulting row type as well.
+     *
      * @returns A new ExRow instance
      */
     static create<T extends ExRowShape>(shape: T): ExRow<T>;
@@ -3770,7 +3776,7 @@ export declare interface SDKOptions<TSchema extends ExType<unknown, ExBaseDef, u
     fonts?: Record<string, ECSVFontSource>;
     stepDisplay?: 'progressBar' | 'segmented' | 'numbered';
     previewSchemaBeforeUpload?: boolean;
-    templateDownload?: TemplateDownloadConfig;
+    templateDownload?: TemplateDownloadOptions<TSchema>;
     saveSession?: boolean;
     locale?: DeepPartial<ExpressCSVLocaleInput>;
     disableStatusStep?: boolean;
@@ -3827,18 +3833,28 @@ export declare interface TailwindThemeVars {
 
 /**
  * Configuration for template download in the upload step.
- * When `source` is `"generate"`, a header-only template file is created
- * client-side from the schema column names.
+ * When `source` is `"generate"`, a template file is created client-side
+ * from the schema column names and optional example rows.
  */
-declare interface TemplateDownloadConfig {
+export declare interface TemplateDownloadConfig {
     source: 'generate';
     formats?: TemplateDownloadFormat[];
+    exampleRows?: TemplateDownloadExampleRow[];
 }
 
+/**
+ * A serializable example row used to populate generated templates.
+ */
+export declare type TemplateDownloadExampleRow = Record<string, unknown>;
+
 /**
  * Template download format
  */
-declare type TemplateDownloadFormat = 'csv' | 'xlsx';
+export declare type TemplateDownloadFormat = 'csv' | 'xlsx';
+
+export declare type TemplateDownloadOptions<TSchema extends ExType<unknown, ExBaseDef, unknown>> = Omit<TemplateDownloadConfig, 'exampleRows'> & {
+    exampleRows?: Infer<TSchema>[] | (() => Infer<TSchema>[]);
+};
 
 /**
  * A branded string type for locale entries that require interpolation via `{variable}` syntax.

package/dist/index.d.ts

@@ -1256,6 +1256,7 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private cachedSchemaJson;
     private initCompletePromise;
     private resolveInitComplete;
+    private resolvedTemplateDownload;
     constructor(options: SDKOptions<TSchema>);
     /**
      * Enhanced state management
@@ -3126,6 +3127,11 @@ declare class ExRow<T extends ExRowShape> extends ExType<{
      * Factory method to create an ExRow validator for a row of data
      *
      * @param shape - Object defining the structure of fields in the row
+     *
+     * Object literals preserve exact key inference. If callers build the shape
+     * through a widened variable or conditional assembly, TypeScript may widen
+     * the resulting row type as well.
+     *
      * @returns A new ExRow instance
      */
     static create<T extends ExRowShape>(shape: T): ExRow<T>;
@@ -3770,7 +3776,7 @@ export declare interface SDKOptions<TSchema extends ExType<unknown, ExBaseDef, u
     fonts?: Record<string, ECSVFontSource>;
     stepDisplay?: 'progressBar' | 'segmented' | 'numbered';
     previewSchemaBeforeUpload?: boolean;
-    templateDownload?: TemplateDownloadConfig;
+    templateDownload?: TemplateDownloadOptions<TSchema>;
     saveSession?: boolean;
     locale?: DeepPartial<ExpressCSVLocaleInput>;
     disableStatusStep?: boolean;
@@ -3827,18 +3833,28 @@ export declare interface TailwindThemeVars {
 
 /**
  * Configuration for template download in the upload step.
- * When `source` is `"generate"`, a header-only template file is created
- * client-side from the schema column names.
+ * When `source` is `"generate"`, a template file is created client-side
+ * from the schema column names and optional example rows.
  */
-declare interface TemplateDownloadConfig {
+export declare interface TemplateDownloadConfig {
     source: 'generate';
     formats?: TemplateDownloadFormat[];
+    exampleRows?: TemplateDownloadExampleRow[];
 }
 
+/**
+ * A serializable example row used to populate generated templates.
+ */
+export declare type TemplateDownloadExampleRow = Record<string, unknown>;
+
 /**
  * Template download format
  */
-declare type TemplateDownloadFormat = 'csv' | 'xlsx';
+export declare type TemplateDownloadFormat = 'csv' | 'xlsx';
+
+export declare type TemplateDownloadOptions<TSchema extends ExType<unknown, ExBaseDef, unknown>> = Omit<TemplateDownloadConfig, 'exampleRows'> & {
+    exampleRows?: Infer<TSchema>[] | (() => Infer<TSchema>[]);
+};
 
 /**
  * A branded string type for locale entries that require interpolation via `{variable}` syntax.