@tallyui/connector-vendure 3.1.1 → 3.2.1

package/README.md

@@ -6,6 +6,14 @@ Requests with expired or rejected credentials reject with `ConnectorUnauthorized
 
 Sign-in itself rejects with `SignInError`.
 
+## Signing in
+
+Vendure supports two credential kinds: email and password (`kind: 'password'`), which `signIn` exchanges for a bearer session `token`, and a device key (`kind: 'api-key'`, stored as `api_key`), a Vendure API key available in Vendure 3.6+.
+
+Render `vendureAuth.fieldSets.password` or `vendureAuth.fieldSets['api-key']` (also exported as `vendureAuthFieldSets`) and store `kind` with the credentials. `vendureAuth.fields` remains the email and password form. Each kind sends only its chosen credential; when `kind` is absent, `api_key` wins over a session token as before.
+
+`capabilities()` works with a device key and no sign-in. Signing out a device-key till forgets the key on the device; it does not revoke the key on the server. The store owner revokes the key in Vendure.
+
 ## Customers
 
 `searchCustomers`, `createCustomer` and `getCustomer` are online only and run in the session's channel, selected by the `vendure-token` header.

package/dist/index.d.ts

@@ -1,9 +1,23 @@
-import { ConnectorAuth, ProductTraits, CollectionSync, ReplicationAdapter, StockReconcileAdapter, SyncContext, StoreSettingsChoice, StoreSettings, CustomerInput, Customer, TallyConnector } from '@tallyui/core';
+import { ConnectorAuth, AuthField, ProductTraits, CollectionSync, ReplicationAdapter, StockReconcileAdapter, SyncContext, StoreSettingsChoice, StoreSettings, CustomerInput, Customer, TallyConnector } from '@tallyui/core';
 export { ConnectorUnauthorizedError } from '@tallyui/core';
 import { RxJsonSchema } from 'rxdb';
 
 declare const vendureSignIn: NonNullable<ConnectorAuth['signIn']>;
-declare const vendureAuth: ConnectorAuth;
+type VendureCredentialKind = 'password' | 'api-key';
+/** What a Vendure till stores: `kind` says which credential it chose (absent on credentials saved before 3.2.0). */
+interface VendureCredentials {
+    kind?: VendureCredentialKind;
+    url: string;
+    email?: string;
+    password?: string;
+    token?: string;
+    api_key?: string;
+    channel_token?: string;
+}
+declare const vendureAuthFieldSets: Record<VendureCredentialKind, AuthField[]>;
+declare const vendureAuth: ConnectorAuth & {
+    fieldSets: Record<VendureCredentialKind, AuthField[]>;
+};
 
 /**
  * RxDB schema for Vendure products.
@@ -151,4 +165,4 @@ declare const createVendureConnector: (options?: {
  */
 declare const vendureConnector: TallyConnector;
 
-export { VendureTimezoneConfigError, createVendureConnector, createVendureCustomer, createVendureProductReplication, createVendureVariantFeedReplication, getVendureCustomer, searchVendureCustomers, toVendureCustomer, vendureAuth, vendureConnector, vendureGlobalStockSettings, vendureProductReplication, vendureProductSchema, vendureProductSync, vendureProductTraits, vendureSignIn, vendureStockReconcile, vendureStoreSettings };
+export { type VendureCredentialKind, type VendureCredentials, VendureTimezoneConfigError, createVendureConnector, createVendureCustomer, createVendureProductReplication, createVendureVariantFeedReplication, getVendureCustomer, searchVendureCustomers, toVendureCustomer, vendureAuth, vendureAuthFieldSets, vendureConnector, vendureGlobalStockSettings, vendureProductReplication, vendureProductSchema, vendureProductSync, vendureProductTraits, vendureSignIn, vendureStockReconcile, vendureStoreSettings };

package/dist/index.js

@@ -106,24 +106,34 @@ var vendureSignIn = async (baseUrl, { email, password }, init = {}) => {
   return { token, expiresAt: void 0, capabilities };
 };
 var warnedAuthToken = false;
-var vendureAuth = {
-  type: "Vendure Admin API",
-  fields: [
+var vendureAuthFieldSets = {
+  password: [
     { key: "url", label: "Backend URL", type: "url", placeholder: "https://my-vendure-server.com", required: true },
     { key: "email", label: "Email", type: "text", required: true },
     { key: "password", label: "Password", type: "password", required: true },
     { key: "channel_token", label: "Channel token (optional)", type: "text" }
   ],
-  // An API key (Vendure 3.6+) wins over a signed-in session token; channel_token selects a non-default channel.
+  "api-key": [
+    { key: "url", label: "Backend URL", type: "url", placeholder: "https://my-vendure-server.com", required: true },
+    { key: "api_key", label: "Device key", type: "password", required: true },
+    { key: "channel_token", label: "Channel token (optional)", type: "text" }
+  ]
+};
+var vendureAuth = {
+  type: "Vendure Admin API",
+  fields: vendureAuthFieldSets.password,
+  fieldSets: vendureAuthFieldSets,
+  // Without kind, an API key (Vendure 3.6+) wins over a session token; channel_token selects a non-default channel.
   // auth_token is the deprecated name for token, kept so existing apps keep working.
   getHeaders: (credentials) => {
     if (credentials.token === void 0 && credentials.auth_token !== void 0 && !warnedAuthToken) {
       warnedAuthToken = true;
       console.warn("@tallyui/connector-vendure: the 'auth_token' credential is deprecated; store the credential as 'token' instead.");
     }
-    const token = credentials.token ?? credentials.auth_token;
+    const token = credentials.kind === "api-key" ? void 0 : credentials.token ?? credentials.auth_token;
+    const apiKey = credentials.kind === "password" ? void 0 : credentials.api_key;
     return {
-      ...credentials.api_key ? { "vendure-api-key": credentials.api_key } : token ? { Authorization: `Bearer ${token}` } : {},
+      ...apiKey ? { "vendure-api-key": apiKey } : token ? { Authorization: `Bearer ${token}` } : {},
       ...credentials.channel_token ? { "vendure-token": credentials.channel_token } : {}
     };
   },
@@ -1016,6 +1026,7 @@ export {
   searchVendureCustomers,
   toVendureCustomer,
   vendureAuth,
+  vendureAuthFieldSets,
   vendureConnector,
   vendureGlobalStockSettings,
   vendureProductReplication,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tallyui/connector-vendure",
-  "version": "3.1.1",
+  "version": "3.2.1",
   "type": "module",
   "description": "Vendure connector for Tally UI",
   "main": "./dist/index.js",
@@ -26,11 +26,11 @@
     "directory": "connectors/vendure"
   },
   "peerDependencies": {
-    "@tallyui/core": "^3.1.1"
+    "@tallyui/core": "^3.2.1"
   },
   "devDependencies": {
-    "@tallyui/database": "3.1.1",
-    "@tallyui/pos": "3.1.1",
+    "@tallyui/database": "3.2.1",
+    "@tallyui/pos": "3.2.1",
     "rxdb": "17.5.0"
   },
   "scripts": {

package/src/auth.ts

@@ -1,4 +1,4 @@
-import { SignInError, type ConnectorAuth } from '@tallyui/core';
+import { SignInError, type AuthField, type ConnectorAuth } from '@tallyui/core';
 
 import { readVendureCapabilities } from './capabilities';
 
@@ -54,24 +54,46 @@ export const vendureSignIn: NonNullable<ConnectorAuth['signIn']> = async (baseUr
 // Warns once per module lifetime when a caller still relies on the deprecated auth_token alias.
 let warnedAuthToken = false;
 
-export const vendureAuth: ConnectorAuth = {
-  type: 'Vendure Admin API',
-  fields: [
+export type VendureCredentialKind = 'password' | 'api-key';
+/** What a Vendure till stores: `kind` says which credential it chose (absent on credentials saved before 3.2.0). */
+export interface VendureCredentials {
+  kind?: VendureCredentialKind;
+  url: string;
+  email?: string; password?: string; // sign-in form only, never sent as headers
+  token?: string; // from signIn, for kind 'password'
+  api_key?: string; // the device key, for kind 'api-key'
+  channel_token?: string;
+}
+
+export const vendureAuthFieldSets: Record<VendureCredentialKind, AuthField[]> = {
+  password: [
     { key: 'url', label: 'Backend URL', type: 'url', placeholder: 'https://my-vendure-server.com', required: true },
     { key: 'email', label: 'Email', type: 'text', required: true },
     { key: 'password', label: 'Password', type: 'password', required: true },
     { key: 'channel_token', label: 'Channel token (optional)', type: 'text' },
   ],
-  // An API key (Vendure 3.6+) wins over a signed-in session token; channel_token selects a non-default channel.
+  'api-key': [
+    { key: 'url', label: 'Backend URL', type: 'url', placeholder: 'https://my-vendure-server.com', required: true },
+    { key: 'api_key', label: 'Device key', type: 'password', required: true },
+    { key: 'channel_token', label: 'Channel token (optional)', type: 'text' },
+  ],
+};
+
+export const vendureAuth: ConnectorAuth & { fieldSets: Record<VendureCredentialKind, AuthField[]> } = {
+  type: 'Vendure Admin API',
+  fields: vendureAuthFieldSets.password,
+  fieldSets: vendureAuthFieldSets,
+  // Without kind, an API key (Vendure 3.6+) wins over a session token; channel_token selects a non-default channel.
   // auth_token is the deprecated name for token, kept so existing apps keep working.
   getHeaders: (credentials): Record<string, string> => {
     if (credentials.token === undefined && credentials.auth_token !== undefined && !warnedAuthToken) {
       warnedAuthToken = true;
       console.warn("@tallyui/connector-vendure: the 'auth_token' credential is deprecated; store the credential as 'token' instead.");
     }
-    const token = credentials.token ?? credentials.auth_token;
+    const token = credentials.kind === 'api-key' ? undefined : credentials.token ?? credentials.auth_token;
+    const apiKey = credentials.kind === 'password' ? undefined : credentials.api_key;
     return {
-      ...(credentials.api_key ? { 'vendure-api-key': credentials.api_key } : token ? { Authorization: `Bearer ${token}` } : {}),
+      ...(apiKey ? { 'vendure-api-key': apiKey } : token ? { Authorization: `Bearer ${token}` } : {}),
       ...(credentials.channel_token ? { 'vendure-token': credentials.channel_token } : {}),
     };
   },

package/src/index.ts

@@ -104,7 +104,7 @@ export const createVendureConnector = (options: {
 export const vendureConnector = createVendureConnector();
 
 // Re-export pieces for advanced usage
-export { vendureAuth, vendureSignIn } from './auth';
+export { vendureAuth, vendureAuthFieldSets, vendureSignIn, type VendureCredentialKind, type VendureCredentials } from './auth';
 export { vendureProductSchema } from './schemas/products';
 export { vendureProductTraits } from './traits/product';
 export { vendureProductSync } from './sync/products';