@enyo-energy/energy-app-sdk 1.51.0 → 1.52.0

package/dist/cjs/types/enyo-authentication.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnyoAuthenticationStateEnum = exports.EnyoOauthRedirectUrlPatternEnum = void 0;
+exports.EnyoAuthenticationStateEnum = exports.ENYO_AUTHENTICATION_MAX_TIMEOUT_MS = exports.ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS = exports.EnyoOauthRedirectUrlPatternEnum = void 0;
 /**
  * How the host encodes the pending request into the enyo callback URL it hands
  * out as {@link EnyoOauthAuthenticationStart.enyoRedirectUrl}.
@@ -27,6 +27,10 @@ var EnyoOauthRedirectUrlPatternEnum;
      */
     EnyoOauthRedirectUrlPatternEnum["PathSegment"] = "path-segment";
 })(EnyoOauthRedirectUrlPatternEnum || (exports.EnyoOauthRedirectUrlPatternEnum = EnyoOauthRedirectUrlPatternEnum = {}));
+/** Default value of {@link EnyoAuthentication.timeoutMs} when it is omitted: 10 seconds. */
+exports.ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS = 10 * 1000;
+/** Largest allowed value of {@link EnyoAuthentication.timeoutMs}: 2 minutes. */
+exports.ENYO_AUTHENTICATION_MAX_TIMEOUT_MS = 2 * 60 * 1000;
 var EnyoAuthenticationStateEnum;
 (function (EnyoAuthenticationStateEnum) {
     EnyoAuthenticationStateEnum["Authenticated"] = "Authenticated";

package/dist/cjs/types/enyo-authentication.d.cts

@@ -185,7 +185,23 @@ export interface EnyoAuthentication {
      * host keeps its default behaviour and may skip the step.
      */
     authenticationRequired?: boolean;
+    /**
+     * How long the host waits, in milliseconds, for the package to answer the
+     * submitted credentials, i.e. for the listener registered with
+     * `listenForAuthenticationResponse` to resolve its {@link EnyoAuthenticateState}.
+     *
+     * Raise it for vendors whose login round-trip is slow (cloud logins, devices
+     * that have to be woken up first). When omitted, the host uses
+     * {@link ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS} (10 seconds). Values above
+     * {@link ENYO_AUTHENTICATION_MAX_TIMEOUT_MS} (2 minutes) are not allowed and
+     * are capped by the host.
+     */
+    timeoutMs?: number;
 }
+/** Default value of {@link EnyoAuthentication.timeoutMs} when it is omitted: 10 seconds. */
+export declare const ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS: number;
+/** Largest allowed value of {@link EnyoAuthentication.timeoutMs}: 2 minutes. */
+export declare const ENYO_AUTHENTICATION_MAX_TIMEOUT_MS: number;
 export interface EnyoApiKeyAuthenticationResponse {
     apiKey: string;
     /** Values submitted for additional fields, keyed by fieldName */

package/dist/cjs/version.cjs

@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
 /**
  * Current version of the enyo Energy App SDK.
  */
-exports.SDK_VERSION = '1.51.0';
+exports.SDK_VERSION = '1.52.0';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/cjs/version.d.cts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "1.51.0";
+export declare const SDK_VERSION = "1.52.0";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/types/enyo-authentication.d.ts

@@ -185,7 +185,23 @@ export interface EnyoAuthentication {
      * host keeps its default behaviour and may skip the step.
      */
     authenticationRequired?: boolean;
+    /**
+     * How long the host waits, in milliseconds, for the package to answer the
+     * submitted credentials, i.e. for the listener registered with
+     * `listenForAuthenticationResponse` to resolve its {@link EnyoAuthenticateState}.
+     *
+     * Raise it for vendors whose login round-trip is slow (cloud logins, devices
+     * that have to be woken up first). When omitted, the host uses
+     * {@link ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS} (10 seconds). Values above
+     * {@link ENYO_AUTHENTICATION_MAX_TIMEOUT_MS} (2 minutes) are not allowed and
+     * are capped by the host.
+     */
+    timeoutMs?: number;
 }
+/** Default value of {@link EnyoAuthentication.timeoutMs} when it is omitted: 10 seconds. */
+export declare const ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS: number;
+/** Largest allowed value of {@link EnyoAuthentication.timeoutMs}: 2 minutes. */
+export declare const ENYO_AUTHENTICATION_MAX_TIMEOUT_MS: number;
 export interface EnyoApiKeyAuthenticationResponse {
     apiKey: string;
     /** Values submitted for additional fields, keyed by fieldName */

package/dist/types/enyo-authentication.js

@@ -24,6 +24,10 @@ export var EnyoOauthRedirectUrlPatternEnum;
      */
     EnyoOauthRedirectUrlPatternEnum["PathSegment"] = "path-segment";
 })(EnyoOauthRedirectUrlPatternEnum || (EnyoOauthRedirectUrlPatternEnum = {}));
+/** Default value of {@link EnyoAuthentication.timeoutMs} when it is omitted: 10 seconds. */
+export const ENYO_AUTHENTICATION_DEFAULT_TIMEOUT_MS = 10 * 1000;
+/** Largest allowed value of {@link EnyoAuthentication.timeoutMs}: 2 minutes. */
+export const ENYO_AUTHENTICATION_MAX_TIMEOUT_MS = 2 * 60 * 1000;
 export var EnyoAuthenticationStateEnum;
 (function (EnyoAuthenticationStateEnum) {
     EnyoAuthenticationStateEnum["Authenticated"] = "Authenticated";

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "1.51.0";
+export declare const SDK_VERSION = "1.52.0";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/version.js

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export const SDK_VERSION = '1.51.0';
+export const SDK_VERSION = '1.52.0';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enyo-energy/energy-app-sdk",
-  "version": "1.51.0",
+  "version": "1.52.0",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",