fix: optional config fields

Author: pozil

dist/utils/types.d.ts

@@ -83,18 +83,54 @@ export type ProducerEvent = {
     payload: any;
 };
 export type Configuration = {
+    /**
+     * Authentication type. One of `user-supplied`, `username-password`, `oauth-client-credentials` or `oauth-jwt-bearer`.
+     */
     authType: AuthType;
-    pubSubEndpoint: string;
-    loginUrl: string;
-    username: string;
-    password: string;
-    userToken: string;
-    clientId: string;
-    clientSecret: string;
-    privateKey: string;
-    accessToken: string;
-    instanceUrl: string;
-    organizationId: string;
+    /**
+     * A custom Pub/Sub API endpoint. The default endpoint `api.pubsub.salesforce.com:7443` is used if none is supplied.
+     */
+    pubSubEndpoint?: string;
+    /**
+     * Salesforce login host. One of `https://login.salesforce.com`, `https://test.salesforce.com` or your domain specific host.
+     */
+    loginUrl?: string;
+    /**
+     * Salesforce username.
+     */
+    username?: string;
+    /**
+     * Salesforce user password.
+     */
+    password?: string;
+    /**
+     * Salesforce user security token.
+     */
+    userToken?: string;
+    /**
+     * Connected app client ID.
+     */
+    clientId?: string;
+    /**
+     * Connected app client secret.
+     */
+    clientSecret?: string;
+    /**
+     * Private key content.
+     */
+    privateKey?: string;
+    /**
+     * Salesforce access token.
+     */
+    accessToken?: string;
+    /**
+     * Salesforce instance URL.
+     */
+    instanceUrl?: string;
+    /**
+     * Optional organization ID. If you don't provide one, we'll attempt to parse it from the accessToken.
+     */
+    organizationId?: string;
 };
 export type Logger = {
     debug: Function;

dist/utils/types.d.ts.map

@@ -110,18 +110,18 @@ export const EventSubscriptionAdminState = {
 
 /**
  * @typedef {Object} Configuration
- * @property {AuthType} authType
- * @property {string} pubSubEndpoint
- * @property {string} loginUrl
- * @property {string} username
- * @property {string} password
- * @property {string} userToken
- * @property {string} clientId
- * @property {string} clientSecret
- * @property {string} privateKey
- * @property {string} accessToken
- * @property {string} instanceUrl
- * @property {string} organizationId
+ * @property {AuthType} authType Authentication type. One of `user-supplied`, `username-password`, `oauth-client-credentials` or `oauth-jwt-bearer`.
+ * @property {string} [pubSubEndpoint] A custom Pub/Sub API endpoint. The default endpoint `api.pubsub.salesforce.com:7443` is used if none is supplied.
+ * @property {string} [loginUrl] Salesforce login host. One of `https://login.salesforce.com`, `https://test.salesforce.com` or your domain specific host.
+ * @property {string} [username] Salesforce username.
+ * @property {string} [password] Salesforce user password.
+ * @property {string} [userToken] Salesforce user security token.
+ * @property {string} [clientId] Connected app client ID.
+ * @property {string} [clientSecret] Connected app client secret.
+ * @property {string} [privateKey] Private key content.
+ * @property {string} [accessToken] Salesforce access token.
+ * @property {string} [instanceUrl] Salesforce instance URL.
+ * @property {string} [organizationId] Optional organization ID. If you don't provide one, we'll attempt to parse it from the accessToken.
  */
 
 /**