@expresscsv/react 1.0.0 → 1.3.0

package/README.md

@@ -36,7 +36,7 @@ const schema = x.row({
 function App() {
   const { open, status } = useExpressCSV({
     schema,
-    getSessionToken: async () => fetchSessionToken(),
+    getAuthToken: async () => fetchAuthToken(),
     importNamespace: "user-import",
     title: "Import Users",
   });
@@ -73,7 +73,7 @@ function App() {
 }
 ```
 
-Have your backend keep the ExpressCSV secret key, call the ExpressCSV session-creation endpoint, and return a short-lived importer session token to the browser via `getSessionToken`.
+Have your backend keep the ExpressCSV secret key, call the ExpressCSV session-creation endpoint, and return a short-lived importer auth token to the browser via `getAuthToken`.
 
 ## Preloading
 
@@ -82,7 +82,7 @@ By default the importer preloads in a hidden iframe so it appears instantly when
 ```tsx
 const { open } = useExpressCSV({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
 });
 
@@ -102,7 +102,7 @@ To disable preloading (there will be a brief loading screen instead):
 ```tsx
 const { open } = useExpressCSV({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   preload: false,
 });
@@ -126,7 +126,7 @@ const candidateSchema = x.row({
 
 const { open } = useExpressCSV({
   schema: candidateSchema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "candidate-import",
   templateDownload: {
     source: "generate",
@@ -183,7 +183,7 @@ const dualTheme: Theme = {
 function App() {
   const { open } = useExpressCSV({
     schema,
-    getSessionToken: async () => fetchSessionToken(),
+    getAuthToken: async () => fetchAuthToken(),
     importNamespace: "user-import",
     theme,
   });
@@ -229,7 +229,7 @@ Control light/dark mode with `colorMode`:
 ```tsx
 const { open } = useExpressCSV({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   colorMode: "system", // 'light' | 'dark' | 'system'
 });
@@ -242,7 +242,7 @@ Inject custom CSS for fine-grained styling overrides.
 ```tsx
 const { open } = useExpressCSV({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   customCSS: `
     .ecsv [data-step="upload"] {
@@ -262,7 +262,7 @@ Load custom fonts via the `fonts` option:
 ```tsx
 const { open } = useExpressCSV({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   fonts: {
     title: { source: "google", name: "Space Grotesk", weights: [400, 600, 700] },
@@ -355,7 +355,7 @@ function CandidateImporter() {
 
   const { open, status: importerStatus } = useExpressCSV({
     schema: candidateSchema,
-    getSessionToken: async () => fetchSessionToken(),
+    getAuthToken: async () => fetchAuthToken(),
     importNamespace: "candidate-import",
     title: "Import Candidates",
   });
@@ -418,7 +418,7 @@ function useExpressCSV<TSchema>(
 | Option | Type | Required | Default | Description |
 |---|---|---|---|---|
 | `schema` | Schema | Yes | - | Schema definition created with `x.row()` |
-| `getSessionToken` | `() => Promise<string>` | Yes | - | Async callback that asks your backend for a short-lived importer session token |
+| `getAuthToken` | `() => Promise<string>` | Yes | - | Async callback that asks your backend for a short-lived importer auth token |
 | `importNamespace` | `string` | Yes | - | Stable namespace string your app assigns to this importer configuration. Keep it the same for the same workflow; use a different value for different importers. |
 | `title` | `string` | No | - | Title shown in the importer header |
 | `preload` | `boolean` | No | `true` | Preload the importer for instant display |

package/dist/index.d.cts

@@ -3801,7 +3801,7 @@ export declare type SchemaFieldName<TSchema extends ExType<unknown, ExBaseDef, u
 
 export declare interface SDKOptions<TSchema extends ExType<unknown, ExBaseDef, unknown>> {
     schema: TSchema;
-    getSessionToken: () => Promise<string>;
+    getAuthToken: () => Promise<string>;
     /** Stable namespace string your app assigns to this importer configuration or workflow */
     importNamespace: string;
     title?: string;
@@ -3945,7 +3945,7 @@ declare interface URLOptions {
     message?: string;
 }
 
-export declare function useExpressCSV<TSchema extends ExType<unknown, ExBaseDef, unknown>>({ schema, title, importNamespace, getSessionToken, debug, preload, theme, colorMode, customCSS, fonts, stepDisplay, previewSchemaBeforeUpload, columnMatching, promptedEdits, templateDownload, sessionRecovery, locale, disableStatusStep, }: UseExpressCSVOptions<TSchema>): {
+export declare function useExpressCSV<TSchema extends ExType<unknown, ExBaseDef, unknown>>({ schema, title, importNamespace, getAuthToken, debug, preload, theme, colorMode, customCSS, fonts, stepDisplay, previewSchemaBeforeUpload, columnMatching, promptedEdits, templateDownload, sessionRecovery, locale, disableStatusStep, }: UseExpressCSVOptions<TSchema>): {
     open: (options: OpenOptions<Infer<TSchema>>) => void;
     status: ImporterStatus;
 };

package/dist/index.d.mts

@@ -3801,7 +3801,7 @@ export declare type SchemaFieldName<TSchema extends ExType<unknown, ExBaseDef, u
 
 export declare interface SDKOptions<TSchema extends ExType<unknown, ExBaseDef, unknown>> {
     schema: TSchema;
-    getSessionToken: () => Promise<string>;
+    getAuthToken: () => Promise<string>;
     /** Stable namespace string your app assigns to this importer configuration or workflow */
     importNamespace: string;
     title?: string;
@@ -3945,7 +3945,7 @@ declare interface URLOptions {
     message?: string;
 }
 
-export declare function useExpressCSV<TSchema extends ExType<unknown, ExBaseDef, unknown>>({ schema, title, importNamespace, getSessionToken, debug, preload, theme, colorMode, customCSS, fonts, stepDisplay, previewSchemaBeforeUpload, columnMatching, promptedEdits, templateDownload, sessionRecovery, locale, disableStatusStep, }: UseExpressCSVOptions<TSchema>): {
+export declare function useExpressCSV<TSchema extends ExType<unknown, ExBaseDef, unknown>>({ schema, title, importNamespace, getAuthToken, debug, preload, theme, colorMode, customCSS, fonts, stepDisplay, previewSchemaBeforeUpload, columnMatching, promptedEdits, templateDownload, sessionRecovery, locale, disableStatusStep, }: UseExpressCSVOptions<TSchema>): {
     open: (options: OpenOptions<Infer<TSchema>>) => void;
     status: ImporterStatus;
 };

package/dist/index.d.ts

@@ -3801,7 +3801,7 @@ export declare type SchemaFieldName<TSchema extends ExType<unknown, ExBaseDef, u
 
 export declare interface SDKOptions<TSchema extends ExType<unknown, ExBaseDef, unknown>> {
     schema: TSchema;
-    getSessionToken: () => Promise<string>;
+    getAuthToken: () => Promise<string>;
     /** Stable namespace string your app assigns to this importer configuration or workflow */
     importNamespace: string;
     title?: string;
@@ -3945,7 +3945,7 @@ declare interface URLOptions {
     message?: string;
 }
 
-export declare function useExpressCSV<TSchema extends ExType<unknown, ExBaseDef, unknown>>({ schema, title, importNamespace, getSessionToken, debug, preload, theme, colorMode, customCSS, fonts, stepDisplay, previewSchemaBeforeUpload, columnMatching, promptedEdits, templateDownload, sessionRecovery, locale, disableStatusStep, }: UseExpressCSVOptions<TSchema>): {
+export declare function useExpressCSV<TSchema extends ExType<unknown, ExBaseDef, unknown>>({ schema, title, importNamespace, getAuthToken, debug, preload, theme, colorMode, customCSS, fonts, stepDisplay, previewSchemaBeforeUpload, columnMatching, promptedEdits, templateDownload, sessionRecovery, locale, disableStatusStep, }: UseExpressCSVOptions<TSchema>): {
     open: (options: OpenOptions<Infer<TSchema>>) => void;
     status: ImporterStatus;
 };