@expresscsv/sdk 1.0.0 → 1.3.0

package/README.md

@@ -35,7 +35,7 @@ const schema = x.row({
 
 const importer = new CSVImporter({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   title: "Import Users",
 });
@@ -60,7 +60,7 @@ 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.
 
-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`. The SDK opens the importer immediately, then completes the initial session bootstrap in the background.
+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`. The SDK opens the importer immediately, then completes the initial session bootstrap in the background.
 
 ## Delivery
 
@@ -125,7 +125,7 @@ By default, the SDK preloads the importer in a hidden iframe for instant display
 // Preload is enabled by default
 const importer = new CSVImporter({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
 });
 
@@ -138,7 +138,7 @@ To disable preloading (there will be a brief loading screen instead):
 ```typescript
 const importer = new CSVImporter({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   preload: false,
 });
@@ -162,7 +162,7 @@ const candidateSchema = x.row({
 
 const importer = new CSVImporter({
   schema: candidateSchema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "candidate-import",
   templateDownload: {
     source: "generate",
@@ -218,7 +218,7 @@ const dualTheme: Theme = {
 
 const importer = new CSVImporter({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   theme,
 });
@@ -262,7 +262,7 @@ Control light/dark mode with `colorMode`:
 ```typescript
 const importer = new CSVImporter({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   colorMode: "system", // 'light' | 'dark' | 'system'
 });
@@ -275,7 +275,7 @@ Inject custom CSS for fine-grained styling overrides.
 ```typescript
 const importer = new CSVImporter({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   customCSS: `
     .ecsv [data-step="upload"] {
@@ -295,7 +295,7 @@ Load custom fonts via the `fonts` option:
 ```typescript
 const importer = new CSVImporter({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
   fonts: {
     title: { source: "google", name: "Space Grotesk", weights: [400, 600, 700] },
@@ -557,7 +557,7 @@ new CSVImporter(options: SDKOptions)
 | 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 |
@@ -652,7 +652,7 @@ type Row = Infer<typeof schema>;
 
 const importer = new CSVImporter({
   schema,
-  getSessionToken: async () => fetchSessionToken(),
+  getAuthToken: async () => fetchAuthToken(),
   importNamespace: "user-import",
 });
 

package/dist/index.d.cts

@@ -1293,10 +1293,10 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private debug;
     private importNamespace;
     private sessionId;
-    private currentSessionToken;
-    private currentSessionTokenExpiresAt;
-    private sessionTokenRefreshTimer;
-    private sessionTokenRefreshPromise;
+    private currentAuthToken;
+    private currentAuthTokenExpiresAt;
+    private authTokenRefreshTimer;
+    private authTokenRefreshPromise;
     private _destroyTimer;
     private _beforeUnloadHandler;
     private importerUrl;
@@ -1337,12 +1337,12 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private completeOpenLifecycleForClose;
     private sendImportProgress;
     private waitForEvent;
-    private fetchImporterSessionToken;
-    private updateSessionToken;
-    private clearSessionTokenRefreshTimer;
-    private scheduleSessionTokenRefresh;
-    private ensureActiveSessionToken;
-    private refreshSessionBoundToken;
+    private fetchImporterAuthToken;
+    private updateAuthToken;
+    private clearAuthTokenRefreshTimer;
+    private scheduleAuthTokenRefresh;
+    private ensureActiveAuthToken;
+    private refreshBoundAuthToken;
     private beginImporterStartup;
     private cancelImporterStartup;
     private assertActiveImporterStartup;
@@ -3940,7 +3940,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;

package/dist/index.d.mts

@@ -1293,10 +1293,10 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private debug;
     private importNamespace;
     private sessionId;
-    private currentSessionToken;
-    private currentSessionTokenExpiresAt;
-    private sessionTokenRefreshTimer;
-    private sessionTokenRefreshPromise;
+    private currentAuthToken;
+    private currentAuthTokenExpiresAt;
+    private authTokenRefreshTimer;
+    private authTokenRefreshPromise;
     private _destroyTimer;
     private _beforeUnloadHandler;
     private importerUrl;
@@ -1337,12 +1337,12 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private completeOpenLifecycleForClose;
     private sendImportProgress;
     private waitForEvent;
-    private fetchImporterSessionToken;
-    private updateSessionToken;
-    private clearSessionTokenRefreshTimer;
-    private scheduleSessionTokenRefresh;
-    private ensureActiveSessionToken;
-    private refreshSessionBoundToken;
+    private fetchImporterAuthToken;
+    private updateAuthToken;
+    private clearAuthTokenRefreshTimer;
+    private scheduleAuthTokenRefresh;
+    private ensureActiveAuthToken;
+    private refreshBoundAuthToken;
     private beginImporterStartup;
     private cancelImporterStartup;
     private assertActiveImporterStartup;
@@ -3940,7 +3940,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;

package/dist/index.d.ts

@@ -1293,10 +1293,10 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private debug;
     private importNamespace;
     private sessionId;
-    private currentSessionToken;
-    private currentSessionTokenExpiresAt;
-    private sessionTokenRefreshTimer;
-    private sessionTokenRefreshPromise;
+    private currentAuthToken;
+    private currentAuthTokenExpiresAt;
+    private authTokenRefreshTimer;
+    private authTokenRefreshPromise;
     private _destroyTimer;
     private _beforeUnloadHandler;
     private importerUrl;
@@ -1337,12 +1337,12 @@ export declare class CSVImporter<TSchema extends ExType<unknown, ExBaseDef, unkn
     private completeOpenLifecycleForClose;
     private sendImportProgress;
     private waitForEvent;
-    private fetchImporterSessionToken;
-    private updateSessionToken;
-    private clearSessionTokenRefreshTimer;
-    private scheduleSessionTokenRefresh;
-    private ensureActiveSessionToken;
-    private refreshSessionBoundToken;
+    private fetchImporterAuthToken;
+    private updateAuthToken;
+    private clearAuthTokenRefreshTimer;
+    private scheduleAuthTokenRefresh;
+    private ensureActiveAuthToken;
+    private refreshBoundAuthToken;
     private beginImporterStartup;
     private cancelImporterStartup;
     private assertActiveImporterStartup;
@@ -3940,7 +3940,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;