@compassdigital/sdk.typescript 4.573.0 → 4.574.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.573.0",
+	"version": "4.574.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/interface/compassconnect.ts

@@ -25,11 +25,11 @@ export interface Auth {
 		token?: string;
 		expires?: string;
 	};
-	// Access token string (should be moved inside access object under real scenarios)
+	// Access token (flat field for backward compatibility; prefer the access object in new clients)
 	access_token?: string;
-	// Duration in seconds until the access token expires (should be moved inside access object under real scenarios)
+	// Access token lifetime in seconds (flat field for backward compatibility)
 	expires_in?: number;
-	// Unix timestamp when the token expires (should be moved inside access object under real scenarios)
+	// When the access token expires (epoch ms, flat field for backward compatibility)
 	expires_at?: number;
 	attributes?: {
 		clientName?: string;
@@ -51,20 +51,20 @@ export interface Auth {
 	};
 	// Identifier of the user or session
 	id?: string;
-	// Refresh token string (should be moved inside refresh object under real scenarios)
+	// Refresh token (flat field for backward compatibility; prefer the refresh object in new clients)
 	refresh_token?: string;
 }
 
 // GET /compassconnect/oms_token - Gets an OMS token
 
 export interface GetCompassconnectOmsTokenQuery {
-	// The SSO code recieved from login
+	// SSO authorization code from the IdP after login
 	code: string;
 	// The client id of the application getting the token
 	client_id: string;
 	// The callback uri of the application calling the service
 	callback_uri: string;
-	// The url
+	// Base URL of the Compass/OMS instance (e.g. https://host/oauth2.0)
 	oms_url: string;
 }