@esri/arcgis-rest-basemap-sessions 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundled/basemap-sessions.esm.js +74 -25
- package/dist/bundled/basemap-sessions.esm.js.map +1 -1
- package/dist/bundled/basemap-sessions.esm.min.js +5 -5
- package/dist/bundled/basemap-sessions.esm.min.js.map +1 -1
- package/dist/bundled/basemap-sessions.umd.js +74 -25
- package/dist/bundled/basemap-sessions.umd.js.map +1 -1
- package/dist/bundled/basemap-sessions.umd.min.js +5 -5
- package/dist/bundled/basemap-sessions.umd.min.js.map +1 -1
- package/dist/cjs/BaseSession.js +73 -24
- package/dist/cjs/BaseSession.js.map +1 -1
- package/dist/cjs/utils/detemineSafetyMargin.js.map +1 -1
- package/dist/cjs/utils/writable.js.map +1 -1
- package/dist/esm/BaseSession.d.ts +35 -17
- package/dist/esm/BaseSession.js +73 -24
- package/dist/esm/BaseSession.js.map +1 -1
- package/dist/esm/utils/detemineSafetyMargin.js.map +1 -1
- package/dist/esm/utils/writable.d.ts +1 -1
- package/dist/esm/utils/writable.js.map +1 -1
- package/package.json +1 -1
- package/dist/cjs/StaticBasemapTilesSession.js +0 -30
- package/dist/cjs/StaticBasemapTilesSession.js.map +0 -1
- package/dist/esm/StaticBasemapTilesSession.d.ts +0 -20
- package/dist/esm/StaticBasemapTilesSession.js +0 -26
- package/dist/esm/StaticBasemapTilesSession.js.map +0 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* @preserve
|
|
2
2
|
* @esri/arcgis-rest-basemap-sessions - v1.0.0 - Apache-2.0
|
|
3
3
|
* Copyright (c) 2017-2025 Esri, Inc.
|
|
4
|
-
* Wed
|
|
4
|
+
* Wed Aug 20 2025 22:29:08 GMT+0000 (Coordinated Universal Time)
|
|
5
5
|
*/
|
|
6
6
|
import { request } from '@esri/arcgis-rest-request';
|
|
7
7
|
|
|
@@ -32,7 +32,7 @@ function determineSafetyMargin(duration, safetyMargin) {
|
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
34
|
* The base class for all basemap sessions. This class implements the {@linkcode IAuthenticationManager} interface and provides methods to start, refresh, and check the expiration of a session.
|
|
35
|
-
* This is not
|
|
35
|
+
* This is not intended to be used directly, but instead is extended by other classes such as {@linkcode BasemapStyleSession} and {@linkcode StaticBasemapTilesSession}.
|
|
36
36
|
*
|
|
37
37
|
* @abstract
|
|
38
38
|
* @implements {IAuthenticationManager}
|
|
@@ -59,6 +59,10 @@ class BaseSession {
|
|
|
59
59
|
* The ID of the timer used to check the expiration time of the session.
|
|
60
60
|
*/
|
|
61
61
|
this.expirationTimerId = null;
|
|
62
|
+
/**
|
|
63
|
+
* A pending session that is being refreshed. This is used to prevent multiple refreshes from happening at the same time.
|
|
64
|
+
*/
|
|
65
|
+
this.pendingSession = null;
|
|
62
66
|
/**
|
|
63
67
|
* A handler that is used to automatically refresh the session when it expires.
|
|
64
68
|
*/
|
|
@@ -77,12 +81,13 @@ class BaseSession {
|
|
|
77
81
|
this.emitter = mitt();
|
|
78
82
|
}
|
|
79
83
|
/**
|
|
80
|
-
* Checks if the session is expired. If it is expired, it emits an "expired" event. The event will fire **before** the method returns true.
|
|
84
|
+
* Checks if the session is expired. If it is expired, it emits an "expired" event and disables expiration time checking. The event will fire **before** the method returns true.
|
|
81
85
|
*
|
|
82
86
|
* @returns {boolean} - Returns true if the session is expired, otherwise false.
|
|
83
87
|
*/
|
|
84
88
|
isSessionExpired() {
|
|
85
89
|
if (this.isExpired) {
|
|
90
|
+
this.disableCheckingExpirationTime();
|
|
86
91
|
this.emitter.emit("expired", {
|
|
87
92
|
token: this.token,
|
|
88
93
|
startTime: this.startTime,
|
|
@@ -96,14 +101,14 @@ class BaseSession {
|
|
|
96
101
|
* Starts checking the expiration time of the session. This will check the expiration time immediately and then on an interval.
|
|
97
102
|
* If the session is expired, it will emit an "expired" event.
|
|
98
103
|
*/
|
|
99
|
-
|
|
104
|
+
enableCheckingExpirationTime() {
|
|
100
105
|
const check = () => {
|
|
101
106
|
this.isSessionExpired();
|
|
102
107
|
};
|
|
103
108
|
if (!this.expirationTimerId) {
|
|
104
109
|
this.expirationTimerId = setInterval(check,
|
|
105
110
|
// check every 10 seconds or 1/100th of the duration, whichever is smaller
|
|
106
|
-
this.expirationCheckInterval); // check
|
|
111
|
+
this.expirationCheckInterval); // check immediately then on an interval
|
|
107
112
|
}
|
|
108
113
|
setTimeout(() => {
|
|
109
114
|
check(); // check immediately after starting the interval
|
|
@@ -113,20 +118,12 @@ class BaseSession {
|
|
|
113
118
|
/**
|
|
114
119
|
* Stops checking the expiration time of the session. This will clear the interval that was set by {@linkcode BaseSession.startCheckingExpirationTime}.
|
|
115
120
|
*/
|
|
116
|
-
|
|
121
|
+
disableCheckingExpirationTime() {
|
|
117
122
|
if (this.expirationTimerId) {
|
|
118
123
|
clearInterval(this.expirationTimerId);
|
|
119
124
|
this.expirationTimerId = null;
|
|
120
125
|
}
|
|
121
126
|
}
|
|
122
|
-
/**
|
|
123
|
-
* Indicates if the session is currently checking for expiration time.
|
|
124
|
-
*
|
|
125
|
-
* @returns {boolean} - Returns true if the session is checking for expiration time, otherwise false.
|
|
126
|
-
*/
|
|
127
|
-
get checkingExpirationTime() {
|
|
128
|
-
return !!this.expirationTimerId;
|
|
129
|
-
}
|
|
130
127
|
/**
|
|
131
128
|
* Starts a new session using the provided parameters and returns an instance of the session class.
|
|
132
129
|
*
|
|
@@ -134,7 +131,13 @@ class BaseSession {
|
|
|
134
131
|
* @param SessionClass - The class to use for the session.
|
|
135
132
|
* @returns A promise that resolves to an instance of the session class.
|
|
136
133
|
*/
|
|
137
|
-
static async startSession({ startSessionUrl, styleFamily = "arcgis", authentication, safetyMargin, duration = DEFAULT_DURATION, autoRefresh =
|
|
134
|
+
static async startSession({ startSessionUrl, styleFamily = "arcgis", authentication, safetyMargin, duration = DEFAULT_DURATION, autoRefresh = false }, SessionClass) {
|
|
135
|
+
if (duration < 10) {
|
|
136
|
+
throw new Error("Session duration must be at least 10 seconds.");
|
|
137
|
+
}
|
|
138
|
+
if (duration > 43200) {
|
|
139
|
+
throw new Error("Session duration cannot exceed 12 hours (43200 seconds).");
|
|
140
|
+
}
|
|
138
141
|
const sessionResponse = await startNewSession({
|
|
139
142
|
startSessionUrl,
|
|
140
143
|
styleFamily,
|
|
@@ -153,12 +156,37 @@ class BaseSession {
|
|
|
153
156
|
endTime: new Date(sessionResponse.endTime),
|
|
154
157
|
duration
|
|
155
158
|
});
|
|
156
|
-
session.
|
|
159
|
+
session.enableCheckingExpirationTime();
|
|
157
160
|
if (autoRefresh) {
|
|
158
|
-
session.
|
|
161
|
+
session.enableAutoRefresh();
|
|
159
162
|
}
|
|
160
163
|
return session;
|
|
161
164
|
}
|
|
165
|
+
/**
|
|
166
|
+
* Indicates if the session is currently checking for expiration time.
|
|
167
|
+
*
|
|
168
|
+
* @returns {boolean} - Returns true if the session is checking for expiration time, otherwise false.
|
|
169
|
+
*/
|
|
170
|
+
get checkingExpirationTime() {
|
|
171
|
+
return !!this.expirationTimerId;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Returns the number of seconds until the session is no longer valid rounded down. If the session is expired, it will return 0.
|
|
175
|
+
*/
|
|
176
|
+
get secondsUntilExpiration() {
|
|
177
|
+
return Math.floor(this.millisecondsUntilExpiration / 1000);
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Returns the number of milliseconds until the session token is no longer valid. If the session is expired, it will return 0.
|
|
181
|
+
*/
|
|
182
|
+
get millisecondsUntilExpiration() {
|
|
183
|
+
if (this.isExpired) {
|
|
184
|
+
return 0;
|
|
185
|
+
}
|
|
186
|
+
const now = new Date();
|
|
187
|
+
const millisecondsLeft = this.endTime.getTime() - now.getTime();
|
|
188
|
+
return millisecondsLeft;
|
|
189
|
+
}
|
|
162
190
|
/**
|
|
163
191
|
* Checks if the session is expired.
|
|
164
192
|
*
|
|
@@ -178,7 +206,7 @@ class BaseSession {
|
|
|
178
206
|
return Promise.resolve(this.token);
|
|
179
207
|
}
|
|
180
208
|
/**
|
|
181
|
-
* Indicates if the session can be refreshed. This is always true for this
|
|
209
|
+
* Indicates if the session can be refreshed. This is always true for this basemap sessions.
|
|
182
210
|
*
|
|
183
211
|
* @returns {boolean} - Always returns true.
|
|
184
212
|
*/
|
|
@@ -200,6 +228,11 @@ class BaseSession {
|
|
|
200
228
|
* @returns A promise that resolves to the current instance of the session.
|
|
201
229
|
*/
|
|
202
230
|
async refreshCredentials() {
|
|
231
|
+
if (this.pendingSession) {
|
|
232
|
+
// if there is a pending session, wait for it to resolve
|
|
233
|
+
await this.pendingSession;
|
|
234
|
+
return this;
|
|
235
|
+
}
|
|
203
236
|
// @TODO switch this to structured clone when we upgrade to Node 20+ types so we don't have to parse the dates later
|
|
204
237
|
const previous = JSON.parse(JSON.stringify({
|
|
205
238
|
token: this.token,
|
|
@@ -208,16 +241,19 @@ class BaseSession {
|
|
|
208
241
|
expires: this.expires
|
|
209
242
|
}));
|
|
210
243
|
try {
|
|
211
|
-
|
|
244
|
+
this.pendingSession = startNewSession({
|
|
212
245
|
startSessionUrl: this.startSessionUrl,
|
|
213
246
|
styleFamily: this.styleFamily,
|
|
214
247
|
authentication: this.authentication,
|
|
215
248
|
duration: this.duration
|
|
216
249
|
});
|
|
250
|
+
const newSession = await this.pendingSession;
|
|
251
|
+
this.pendingSession = null; // reset the pending session
|
|
217
252
|
this.setToken(newSession.sessionToken);
|
|
218
253
|
this.setStartTime(new Date(newSession.startTime));
|
|
219
254
|
this.setEndTime(new Date(newSession.endTime));
|
|
220
255
|
this.setExpires(new Date(newSession.endTime - this.safetyMargin * 1000));
|
|
256
|
+
this.enableCheckingExpirationTime(); // restart checking expiration time after refreshing credentials
|
|
221
257
|
this.emitter.emit("refreshed", {
|
|
222
258
|
previous: {
|
|
223
259
|
token: previous.token,
|
|
@@ -241,11 +277,11 @@ class BaseSession {
|
|
|
241
277
|
}
|
|
242
278
|
/**
|
|
243
279
|
* Enables auto-refresh for the session. This will automatically refresh the session when it expires.
|
|
244
|
-
* It will also start checking the expiration time of the session if it is not already started via {@linkcode BaseSession.
|
|
280
|
+
* It will also start checking the expiration time of the session if it is not already started via {@linkcode BaseSession.enableCheckingExpirationTime}.
|
|
245
281
|
*/
|
|
246
|
-
|
|
282
|
+
enableAutoRefresh() {
|
|
247
283
|
if (!this.expirationTimerId) {
|
|
248
|
-
this.
|
|
284
|
+
this.enableCheckingExpirationTime();
|
|
249
285
|
}
|
|
250
286
|
this.autoRefreshHandler = () => {
|
|
251
287
|
this.refreshCredentials().catch((error) => {
|
|
@@ -257,14 +293,25 @@ class BaseSession {
|
|
|
257
293
|
/**
|
|
258
294
|
* Disables auto-refresh for the session. This will stop automatically refreshing the session when it expires.
|
|
259
295
|
* This will **not** stop checking the expiration time of the session. If you want to stop automated expiration
|
|
260
|
-
* checking, call {@linkcode BaseSession.
|
|
296
|
+
* checking, call {@linkcode BaseSession.disableCheckingExpirationTime} after calling this method.
|
|
261
297
|
*/
|
|
262
|
-
|
|
298
|
+
disableAutoRefresh() {
|
|
263
299
|
if (this.autoRefreshHandler) {
|
|
264
300
|
this.off("expired", this.autoRefreshHandler);
|
|
265
301
|
this.autoRefreshHandler = null;
|
|
266
302
|
}
|
|
267
303
|
}
|
|
304
|
+
/**
|
|
305
|
+
* Removes all event listeners and disables auto-refresh and expiration time checking. This is useful for cleaning up the session when it is no longer needed or replaced with a new session.
|
|
306
|
+
*/
|
|
307
|
+
destroy() {
|
|
308
|
+
this.disableAutoRefresh();
|
|
309
|
+
this.disableCheckingExpirationTime();
|
|
310
|
+
this.emitter.off("expired");
|
|
311
|
+
this.emitter.off("refreshed");
|
|
312
|
+
this.emitter.off("error");
|
|
313
|
+
this.emitter.off("*");
|
|
314
|
+
}
|
|
268
315
|
on(eventName, handler) {
|
|
269
316
|
this.emitter.on(eventName, handler);
|
|
270
317
|
this.isSessionExpired(); // check if the session is expired immediately after adding the handler
|
|
@@ -304,7 +351,9 @@ BaseSession.error = function error(e) { }; // eslint-disable-line @typescript-es
|
|
|
304
351
|
// the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.
|
|
305
352
|
/* istanbul ignore next -- @preserve */
|
|
306
353
|
/**
|
|
307
|
-
* Event handler for when
|
|
354
|
+
* Event handler for when the current session expires and the session token it no longer valid. This event will only fire if {@linkcode BaseSession.checkingExpirationTime}
|
|
355
|
+
* is `true` which is the default. Once this event fires, {@linkcode BaseSession.checkingExpirationTime} will be set to `false` until the session is refreshed with
|
|
356
|
+
* {@linkcode BaseSession.refreshCredentials}.
|
|
308
357
|
*
|
|
309
358
|
* @event expired
|
|
310
359
|
* @param e - The parameters for the expired event.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"basemap-sessions.esm.js","sources":["../../node_modules/mitt/dist/mitt.mjs","../../src/utils/defaults.ts","../../src/utils/startNewSession.ts","../../src/utils/detemineSafetyMargin.ts","../../src/BaseSession.ts","../../src/BasemapStyleSession.ts"],"sourcesContent":["export default function(n){return{all:n=n||new Map,on:function(t,e){var i=n.get(t);i?i.push(e):n.set(t,[e])},off:function(t,e){var i=n.get(t);i&&(e?i.splice(i.indexOf(e)>>>0,1):n.set(t,[]))},emit:function(t,e){var i=n.get(t);i&&i.slice().map(function(n){n(e)}),(i=n.get(\"*\"))&&i.slice().map(function(n){n(t,e)})}}}\n//# sourceMappingURL=mitt.mjs.map\n","export const DEFAULT_START_BASEMAP_STYLE_SESSION_URL =\n \"https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/sessions/start\";\n\nexport const DEFAULT_SAFETY_MARGIN = 5 * 60; // Default to 5 minutes in seconds\n\nexport const DEFAULT_CHECK_EXPIRATION_INTERVAL = 10; // Default to 10 seconds\n\nexport const DEFAULT_DURATION = 12 * 60 * 60; // Default to 12 hours in seconds\n","import { IAuthenticationManager, request } from \"@esri/arcgis-rest-request\";\nimport { StyleFamily } from \"../types/StyleFamily.js\";\nimport { DEFAULT_DURATION } from \"./defaults.js\";\n\nexport interface IRequestNewSessionParams {\n startSessionUrl: string;\n authentication: IAuthenticationManager | string;\n styleFamily?: StyleFamily;\n duration?: number;\n}\n\nexport interface IStartSessionResponse {\n sessionToken: string;\n endTime: number;\n startTime: number;\n styleFamily: StyleFamily;\n}\n\nexport function startNewSession({\n startSessionUrl,\n authentication,\n styleFamily = \"arcgis\",\n duration = DEFAULT_DURATION\n}: IRequestNewSessionParams): Promise<IStartSessionResponse> {\n return request(startSessionUrl, {\n httpMethod: \"GET\",\n authentication: authentication,\n params: { styleFamily, durationSeconds: duration }\n });\n}\n","import { DEFAULT_SAFETY_MARGIN } from \"./defaults.js\";\n\nexport function determineSafetyMargin(\n duration: number | undefined,\n safetyMargin: number | undefined\n): number {\n if (safetyMargin) {\n return safetyMargin;\n }\n // common cases are\n // duration is 60 seconds, this will return a 1 second safety margin\n // duration is 43200 seconds, this will return a 300 second (5 minutes) safety margin\n return Math.min(Math.max(duration / 100, 1), DEFAULT_SAFETY_MARGIN);\n}\n","import mitt from \"mitt\";\n\nimport { IAuthenticationManager } from \"@esri/arcgis-rest-request\";\nimport { StyleFamily } from \"./types/StyleFamily.js\";\nimport { startNewSession } from \"./utils/startNewSession.js\";\nimport { Writable } from \"./utils/writable.js\";\nimport { determineSafetyMargin } from \"./utils/detemineSafetyMargin.js\";\nimport {\n DEFAULT_DURATION,\n DEFAULT_SAFETY_MARGIN,\n DEFAULT_CHECK_EXPIRATION_INTERVAL\n} from \"./utils/defaults.js\";\n\nexport interface IBasemapSessionParams {\n token: string;\n startSessionUrl: string;\n styleFamily: StyleFamily;\n authentication: IAuthenticationManager | string;\n expires: Date;\n startTime: Date;\n endTime: Date;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n}\n\nexport interface IStartSessionParams {\n styleFamily?: StyleFamily;\n authentication: IAuthenticationManager | string;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n\n /**\n * The URL to start the session. If not provided, it will use the default URL.\n * @private\n */\n startSessionUrl?: string;\n}\n\n/**\n * The base class for all basemap sessions. This class implements the {@linkcode IAuthenticationManager} interface and provides methods to start, refresh, and check the expiration of a session.\n * This is not intendet to be used directly, but instead is extended by other classes such as {@linkcode BasemapStyleSession} and {@linkcode StaticBasemapTilesSession}.\n *\n * @abstract\n * @implements {IAuthenticationManager}\n */\nexport abstract class BaseSession implements IAuthenticationManager {\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when an error occurs during session management.\n */\n static readonly error = function error(e: Error): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when a session expires and the `token` it no longer valid.\n *\n * @event expired\n * @param e - The parameters for the expired event.\n * @param e.token - The session token that expired.\n * @param e.startTime - The start time of the session.\n * @param e.endTime - The end time of the session.\n * @param e.expires - The expiration time of the session.\n */\n static readonly expired = function expired(e: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n }): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when a session refreshes and a new `token` is available.\n *\n * @event refreshed\n * @param e. - The parameters for the refreshed event.\n * @param e.previous - The previous session details.\n * @param e.previous.token - The previous session token.\n * @param e.previous.startTime - The start time of the previous session.\n * @param e.previous.endTime - The end time of the previous session.\n * @param e.previous.expires - The expiration time of the previous session.\n * @param e.current - The current session details.\n * @param e.current.token - The current session token.\n * @param e.current.startTime - The start time of the current token.\n * @param e.current.endTime - The end time of the current session.\n * @param e.current.expires - The expiration time of the current token.\n */\n static readonly refreshed = function refreshed(e: {\n previous: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n };\n current: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n };\n }): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n /**\n * The portal URL that the session is associated with. This generally is not used but exists to implement the `IAuthenticationManager` interface.\n */\n readonly portal: string;\n\n /**\n * The style family of the session. This is used to determine the type of basemap styles that are available.\n */\n readonly styleFamily: StyleFamily;\n\n /**\n * The authentication manager or token used for the session.\n * This can be an instance of {@linkcode ApiKeyManager}, {@linkcode ArcGISIdentityManager}, {@linkcode ApplicationCredentialsManager} or a string token.\n */\n readonly authentication: IAuthenticationManager | string;\n\n /**\n * The expiration date of the session. This is the {@linkcode BaseSession.endTime} minus the {@linkcode BaseSession.safetyMargin}. This is used internally to determine if the session is expired.\n */\n readonly expires: Date;\n\n /**\n * The start time of the session. This is the time returned from the API when the session war started.\n */\n readonly startTime: Date;\n\n /**\n * The end time of the session. This is the time returned from the API when the session will end.\n */\n readonly endTime: Date;\n\n /**\n * The token for the session.\n */\n readonly token: string;\n\n /**\n * The URL used to start the session.\n */\n readonly startSessionUrl: string;\n\n /**\n * The safety margin in milliseconds. This subtracted from the {@linkcode BaseSession.endTime} to get the {@linkcode BaseSession.expiration}.\n */\n readonly safetyMargin: number;\n\n /**\n * The duration of the session in seconds. This is used to determine how long the session will last when the session is refreshed.\n */\n readonly duration: number;\n\n /**\n * The interval at which to check the expiration time of the session. This is always 10 seconds or 1/100th of the duration, whichever is smaller.\n */\n readonly expirationCheckInterval: number;\n\n /**\n * The ID of the timer used to check the expiration time of the session.\n */\n private expirationTimerId: any = null;\n\n /**\n * Internal instance of [`mitt`](https://github.com/developit/mitt) used for event handlers. It is recommended to use {@linkcode BasemapSession.on}, {@linkcode BasemapSession.off} or {@linkcode BasemapSession.once} instead of `emitter.`\n */\n private emitter: any;\n\n /**\n * A handler that is used to automatically refresh the session when it expires.\n */\n private autoRefreshHandler: (() => void) | null = null;\n\n /**\n * Creates a new instance of the BaseSession class. Generally you should not create an instance of this class directly, but instead use the static methods to start a session or deserialize a session.\n *\n * You may need to create an instance of this class directly if you are not using the built in deserialize method.\n *\n * @param params - The parameters for the session.\n * @param params.startSessionUrl - The URL to start the session.\n * @param params.token - The token for the session.\n * @param params.styleFamily - The style family of the session.\n * @param params.authentication - The authentication manager or token used for the session.\n * @param params.expires - The expiration date of the session.\n * @param params.startTime - The start time of the session.\n * @param params.endTime - The end time of the session.\n * @param params.safetyMargin - The safety margin in milliseconds.\n * @param params.duration - Indicates if this is a test session.\n */\n constructor(params: IBasemapSessionParams) {\n this.startSessionUrl = params.startSessionUrl;\n this.token = params.token;\n this.styleFamily = params.styleFamily || \"arcgis\";\n this.authentication = params.authentication;\n this.duration = params.duration || DEFAULT_DURATION;\n this.startTime = params.startTime;\n this.endTime = params.endTime;\n this.expires = params.expires;\n this.safetyMargin = params.safetyMargin;\n this.expirationCheckInterval =\n Math.min(this.duration / 100, DEFAULT_CHECK_EXPIRATION_INTERVAL) * 1000;\n this.emitter = mitt();\n }\n\n /**\n * Checks if the session is expired. If it is expired, it emits an \"expired\" event. The event will fire **before** the method returns true.\n *\n * @returns {boolean} - Returns true if the session is expired, otherwise false.\n */\n isSessionExpired() {\n if (this.isExpired) {\n this.emitter.emit(\"expired\", {\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n });\n }\n return this.isExpired;\n }\n\n /**\n * Starts checking the expiration time of the session. This will check the expiration time immediately and then on an interval.\n * If the session is expired, it will emit an \"expired\" event.\n */\n startCheckingExpirationTime() {\n const check = () => {\n this.isSessionExpired();\n };\n\n if (!this.expirationTimerId) {\n this.expirationTimerId = setInterval(\n check,\n // check every 10 seconds or 1/100th of the duration, whichever is smaller\n this.expirationCheckInterval\n ); // check immediatly then on an interval\n }\n\n setTimeout(() => {\n check(); // check immediately after starting the interval\n }, 10);\n\n return this.expirationTimerId; // return the timer ID so it can be stopped later\n }\n\n /**\n * Stops checking the expiration time of the session. This will clear the interval that was set by {@linkcode BaseSession.startCheckingExpirationTime}.\n */\n stopCheckingExpirationTime() {\n if (this.expirationTimerId) {\n clearInterval(this.expirationTimerId);\n this.expirationTimerId = null;\n }\n }\n\n /**\n * Indicates if the session is currently checking for expiration time.\n *\n * @returns {boolean} - Returns true if the session is checking for expiration time, otherwise false.\n */\n get checkingExpirationTime(): boolean {\n return !!this.expirationTimerId;\n }\n\n /**\n * Starts a new session using the provided parameters and returns an instance of the session class.\n *\n * @param params - The parameters for starting the session.\n * @param SessionClass - The class to use for the session.\n * @returns A promise that resolves to an instance of the session class.\n */\n protected static async startSession<T extends BaseSession>(\n {\n startSessionUrl,\n styleFamily = \"arcgis\",\n authentication,\n safetyMargin,\n duration = DEFAULT_DURATION,\n autoRefresh = true\n }: {\n startSessionUrl?: string;\n styleFamily?: StyleFamily;\n authentication: IAuthenticationManager | string;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n },\n SessionClass: new (params: IBasemapSessionParams) => T\n ): Promise<T> {\n const sessionResponse = await startNewSession({\n startSessionUrl,\n styleFamily,\n authentication,\n duration\n });\n const actualSafetyMargin = determineSafetyMargin(duration, safetyMargin);\n\n const session = new SessionClass({\n startSessionUrl: startSessionUrl,\n token: sessionResponse.sessionToken,\n styleFamily,\n authentication,\n safetyMargin: actualSafetyMargin,\n expires: new Date(sessionResponse.endTime - actualSafetyMargin * 1000),\n startTime: new Date(sessionResponse.startTime),\n endTime: new Date(sessionResponse.endTime),\n duration\n });\n\n session.startCheckingExpirationTime();\n\n if (autoRefresh) {\n session.startAutoRefresh();\n }\n\n return session as T;\n }\n\n /**\n * Checks if the session is expired.\n *\n */\n get isExpired(): boolean {\n return this.expires < new Date();\n }\n\n /**\n * Gets the session token. If the session is expired, it will refresh the credentials and return the new token.\n *\n * @returns A promise that resolves to the session token.\n */\n getToken(): Promise<string> {\n if (this.isExpired) {\n return this.refreshCredentials().then(() => this.token);\n }\n\n return Promise.resolve(this.token);\n }\n\n /**\n * Indicates if the session can be refreshed. This is always true for this class.\n *\n * @returns {boolean} - Always returns true.\n */\n get canRefresh(): boolean {\n return true;\n }\n\n /**\n * Indicates if the session is set to automatically refresh when it expires.\n *\n * @returns {boolean} - Returns true if auto-refresh is enabled, otherwise false.\n */\n get autoRefresh(): boolean {\n return !!this.autoRefreshHandler && !!this.expirationTimerId;\n }\n\n /**\n * Refreshes the session credentials by starting a new session.\n * This will emit a \"refreshed\" event with the previous and current session details.\n *\n * @returns A promise that resolves to the current instance of the session.\n */\n async refreshCredentials(): Promise<this> {\n // @TODO switch this to structured clone when we upgrade to Node 20+ types so we don't have to parse the dates later\n const previous = JSON.parse(\n JSON.stringify({\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n })\n );\n\n try {\n const newSession = await startNewSession({\n startSessionUrl: this.startSessionUrl,\n styleFamily: this.styleFamily,\n authentication: this.authentication,\n duration: this.duration\n });\n\n this.setToken(newSession.sessionToken);\n this.setStartTime(new Date(newSession.startTime));\n this.setEndTime(new Date(newSession.endTime));\n this.setExpires(new Date(newSession.endTime - this.safetyMargin * 1000));\n\n this.emitter.emit(\"refreshed\", {\n previous: {\n token: previous.token,\n startTime: new Date(previous.startTime),\n endTime: new Date(previous.endTime),\n expires: new Date(previous.expires)\n },\n current: {\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n }\n });\n } catch (error) {\n this.emitter.emit(\"error\", error);\n throw error;\n }\n\n return this;\n }\n /**\n * Enables auto-refresh for the session. This will automatically refresh the session when it expires.\n * It will also start checking the expiration time of the session if it is not already started via {@linkcode BaseSession.startCheckingExpirationTime}.\n */\n startAutoRefresh() {\n if (!this.expirationTimerId) {\n this.startCheckingExpirationTime();\n }\n\n this.autoRefreshHandler = () => {\n this.refreshCredentials().catch((error: Error) => {\n this.emitter.emit(\"error\", error);\n });\n };\n\n this.on(\"expired\", this.autoRefreshHandler);\n }\n\n /**\n * Disables auto-refresh for the session. This will stop automatically refreshing the session when it expires.\n * This will **not** stop checking the expiration time of the session. If you want to stop automated expiration\n * checking, call {@linkcode BaseSession.stopCheckingExpirationTime} after calling this method.\n */\n stopAutoRefresh() {\n if (this.autoRefreshHandler) {\n this.off(\"expired\", this.autoRefreshHandler);\n this.autoRefreshHandler = null;\n }\n }\n\n /**\n * A handler that listens for an eventName and returns custom handler.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n on(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n on(event: \"expired\", handler: typeof BaseSession.expired): void;\n on(event: \"error\", handler: typeof BaseSession.error): void;\n on(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n this.emitter.on(eventName, handler);\n this.isSessionExpired(); // check if the session is expired immediately after adding the handler\n }\n\n /**\n * A handler that listens for an event once and returns a custom handler. Events listened to with this method cannot be removed with {@linkcode BasemapSession.off}.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n once(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n once(event: \"expired\", handler: typeof BaseSession.expired): void;\n once(event: \"error\", handler: typeof BaseSession.error): void;\n once(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n const fn = (e: any) => {\n this.emitter.off(eventName, fn);\n handler(e);\n };\n\n this.emitter.on(eventName, fn);\n }\n\n /**\n * A handler that will remove a listener from a given event.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n off(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n off(event: \"expired\", handler: typeof BaseSession.expired): void;\n off(event: \"error\", handler: typeof BaseSession.error): void;\n off(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n this.emitter.off(eventName, handler);\n }\n\n /**\n * These private methods are used to set the internal state of the session.\n */\n private setToken(token: string) {\n (this as Writable<typeof this>).token = token;\n }\n private setStartTime(startTime: Date) {\n (this as Writable<typeof this>).startTime = startTime;\n }\n private setEndTime(endTime: Date) {\n (this as Writable<typeof this>).endTime = endTime;\n }\n private setExpires(expires: Date) {\n (this as Writable<typeof this>).expires = expires;\n }\n}\n","import {\n BaseSession,\n IBasemapSessionParams,\n IStartSessionParams\n} from \"./BaseSession.js\";\nimport { DEFAULT_START_BASEMAP_STYLE_SESSION_URL } from \"./utils/defaults.js\";\n\n/**\n * `BasemapStyleSession` is a class that extends {@linkcode BaseSession} to manage sessions\n * for basemap styles. It provides methods to {@linkcode BasemapStyleSession.start} a new session\n * which should be used instead of constructing a new instance directly.\n *\n * @class BasemapStyleSession\n * @extends BaseSession\n */\nexport class BasemapStyleSession extends BaseSession {\n /**\n * Creates an instance of `BasemapStyleSession`. Constructing `BasemapStyleSession` directly is discouraged.\n * Instead, use the static method {@linkcode BasemapStyleSession.start} to start a new session.\n */\n constructor(params: IBasemapSessionParams) {\n super(params);\n }\n\n /**\n * Starts a new basemap style session.\n */\n static async start(params: IStartSessionParams) {\n return BaseSession.startSession<BasemapStyleSession>(\n {\n ...params,\n startSessionUrl:\n params?.startSessionUrl || DEFAULT_START_BASEMAP_STYLE_SESSION_URL\n },\n BasemapStyleSession as new (\n params: IBasemapSessionParams\n ) => BasemapStyleSession\n );\n }\n}\n"],"names":[],"mappings":";;;;;;;AAAe,aAAQ,CAAC,CAAC,CAAC,CAAC,OAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,EAAC,CAAC,CAAC;;MCA5S,uCAAuC,GAClD,qFAAqF;MAE1E,qBAAqB,GAAG,CAAC,GAAG,GAAG;MAE/B,iCAAiC,GAAG,GAAG;MAEvC,gBAAgB,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG;;SCW7B,eAAe,CAAC,EAC9B,eAAe,EACf,cAAc,EACd,WAAW,GAAG,QAAQ,EACtB,QAAQ,GAAG,gBAAgB,EACF;IACzB,OAAO,OAAO,CAAC,eAAe,EAAE;QAC9B,UAAU,EAAE,KAAK;QACjB,cAAc,EAAE,cAAc;QAC9B,MAAM,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE;KACnD,CAAC,CAAC;AACL;;SC3BgB,qBAAqB,CACnC,QAA4B,EAC5B,YAAgC;IAEhC,IAAI,YAAY,EAAE;QAChB,OAAO,YAAY,CAAC;KACrB;;;;IAID,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;AACtE;;AC2BA;;;;;;;MAOsB,WAAW;;;;;;;;;;;;;;;;;IAmJ/B,YAAY,MAA6B;;;;QA5BjC,sBAAiB,GAAQ,IAAI,CAAC;;;;QAU9B,uBAAkB,GAAwB,IAAI,CAAC;QAmBrD,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,QAAQ,CAAC;QAClD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,gBAAgB,CAAC;QACpD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,uBAAuB;YAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,GAAG,EAAE,iCAAiC,CAAC,GAAG,IAAI,CAAC;QAC1E,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;KACvB;;;;;;IAOD,gBAAgB;QACd,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;gBAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC,CAAC;SACJ;QACD,OAAO,IAAI,CAAC,SAAS,CAAC;KACvB;;;;;IAMD,2BAA2B;QACzB,MAAM,KAAK,GAAG;YACZ,IAAI,CAAC,gBAAgB,EAAE,CAAC;SACzB,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,iBAAiB,GAAG,WAAW,CAClC,KAAK;;YAEL,IAAI,CAAC,uBAAuB,CAC7B,CAAC;SACH;QAED,UAAU,CAAC;YACT,KAAK,EAAE,CAAC;SACT,EAAE,EAAE,CAAC,CAAC;QAEP,OAAO,IAAI,CAAC,iBAAiB,CAAC;KAC/B;;;;IAKD,0BAA0B;QACxB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACtC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;SAC/B;KACF;;;;;;IAOD,IAAI,sBAAsB;QACxB,OAAO,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC;KACjC;;;;;;;;IASS,aAAa,YAAY,CACjC,EACE,eAAe,EACf,WAAW,GAAG,QAAQ,EACtB,cAAc,EACd,YAAY,EACZ,QAAQ,GAAG,gBAAgB,EAC3B,WAAW,GAAG,IAAI,EAQnB,EACD,YAAsD;QAEtD,MAAM,eAAe,GAAG,MAAM,eAAe,CAAC;YAC5C,eAAe;YACf,WAAW;YACX,cAAc;YACd,QAAQ;SACT,CAAC,CAAC;QACH,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC;YAC/B,eAAe,EAAE,eAAe;YAChC,KAAK,EAAE,eAAe,CAAC,YAAY;YACnC,WAAW;YACX,cAAc;YACd,YAAY,EAAE,kBAAkB;YAChC,OAAO,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,GAAG,kBAAkB,GAAG,IAAI,CAAC;YACtE,SAAS,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;YAC9C,OAAO,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;YAC1C,QAAQ;SACT,CAAC,CAAC;QAEH,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAEtC,IAAI,WAAW,EAAE;YACf,OAAO,CAAC,gBAAgB,EAAE,CAAC;SAC5B;QAED,OAAO,OAAY,CAAC;KACrB;;;;;IAMD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;KAClC;;;;;;IAOD,QAAQ;QACN,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;SACzD;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACpC;;;;;;IAOD,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC;KACb;;;;;;IAOD,IAAI,WAAW;QACb,OAAO,CAAC,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC;KAC9D;;;;;;;IAQD,MAAM,kBAAkB;;QAEtB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CACzB,IAAI,CAAC,SAAS,CAAC;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CACH,CAAC;QAEF,IAAI;YACF,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC;gBACvC,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB,CAAC,CAAC;YAEH,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YACvC,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;YAEzE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC7B,QAAQ,EAAE;oBACR,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,SAAS,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACvC,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;oBACnC,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;iBACpC;gBACD,OAAO,EAAE;oBACP,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB;aACF,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAClC,MAAM,KAAK,CAAC;SACb;QAED,OAAO,IAAI,CAAC;KACb;;;;;IAKD,gBAAgB;QACd,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,2BAA2B,EAAE,CAAC;SACpC;QAED,IAAI,CAAC,kBAAkB,GAAG;YACxB,IAAI,CAAC,kBAAkB,EAAE,CAAC,KAAK,CAAC,CAAC,KAAY;gBAC3C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;aACnC,CAAC,CAAC;SACJ,CAAC;QAEF,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;KAC7C;;;;;;IAOD,eAAe;QACb,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC3B,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC7C,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;SAChC;KACF;IAWD,EAAE,CACA,SAAiB,EACjB,OAG4B;QAE5B,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,gBAAgB,EAAE,CAAC;KACzB;IAWD,IAAI,CACF,SAAiB,EACjB,OAG4B;QAE5B,MAAM,EAAE,GAAG,CAAC,CAAM;YAChB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAChC,OAAO,CAAC,CAAC,CAAC,CAAC;SACZ,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;KAChC;IAWD,GAAG,CACD,SAAiB,EACjB,OAG4B;QAE5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;KACtC;;;;IAKO,QAAQ,CAAC,KAAa;QAC3B,IAA8B,CAAC,KAAK,GAAG,KAAK,CAAC;KAC/C;IACO,YAAY,CAAC,SAAe;QACjC,IAA8B,CAAC,SAAS,GAAG,SAAS,CAAC;KACvD;IACO,UAAU,CAAC,OAAa;QAC7B,IAA8B,CAAC,OAAO,GAAG,OAAO,CAAC;KACnD;IACO,UAAU,CAAC,OAAa;QAC7B,IAA8B,CAAC,OAAO,GAAG,OAAO,CAAC;KACnD;;AAxdD;AACA;AACA;;;AAGgB,iBAAK,GAAG,SAAS,KAAK,CAAC,CAAQ,KAAU,CAAC;AAE1D;AACA;AACA;;;;;;;;;;AAUgB,mBAAO,GAAG,SAAS,OAAO,CAAC,CAK1C,KAAU,CAAC;AAEZ;AACA;AACA;;;;;;;;;;;;;;;;AAgBgB,qBAAS,GAAG,SAAS,SAAS,CAAC,CAa9C,KAAU,CAAC;;AClGd;;;;;;;;MAQa,mBAAoB,SAAQ,WAAW;;;;;IAKlD,YAAY,MAA6B;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;KACf;;;;IAKD,aAAa,KAAK,CAAC,MAA2B;QAC5C,OAAO,WAAW,CAAC,YAAY,iCAExB,MAAM,KACT,eAAe,EACb,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,KAAI,uCAAuC,KAEtE,mBAEwB,CACzB,CAAC;KACH;;;;;"}
|
|
1
|
+
{"version":3,"file":"basemap-sessions.esm.js","sources":["../../node_modules/mitt/dist/mitt.mjs","../../src/utils/defaults.ts","../../src/utils/startNewSession.ts","../../src/utils/detemineSafetyMargin.ts","../../src/BaseSession.ts","../../src/BasemapStyleSession.ts"],"sourcesContent":["export default function(n){return{all:n=n||new Map,on:function(t,e){var i=n.get(t);i?i.push(e):n.set(t,[e])},off:function(t,e){var i=n.get(t);i&&(e?i.splice(i.indexOf(e)>>>0,1):n.set(t,[]))},emit:function(t,e){var i=n.get(t);i&&i.slice().map(function(n){n(e)}),(i=n.get(\"*\"))&&i.slice().map(function(n){n(t,e)})}}}\n//# sourceMappingURL=mitt.mjs.map\n","export const DEFAULT_START_BASEMAP_STYLE_SESSION_URL =\n \"https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/sessions/start\";\n\nexport const DEFAULT_SAFETY_MARGIN = 5 * 60; // Default to 5 minutes in seconds\n\nexport const DEFAULT_CHECK_EXPIRATION_INTERVAL = 10; // Default to 10 seconds\n\nexport const DEFAULT_DURATION = 12 * 60 * 60; // Default to 12 hours in seconds\n","import { IAuthenticationManager, request } from \"@esri/arcgis-rest-request\";\nimport { StyleFamily } from \"../types/StyleFamily.js\";\nimport { DEFAULT_DURATION } from \"./defaults.js\";\n\nexport interface IRequestNewSessionParams {\n startSessionUrl: string;\n authentication: IAuthenticationManager | string;\n styleFamily?: StyleFamily;\n duration?: number;\n}\n\nexport interface IStartSessionResponse {\n sessionToken: string;\n endTime: number;\n startTime: number;\n styleFamily: StyleFamily;\n}\n\nexport function startNewSession({\n startSessionUrl,\n authentication,\n styleFamily = \"arcgis\",\n duration = DEFAULT_DURATION\n}: IRequestNewSessionParams): Promise<IStartSessionResponse> {\n return request(startSessionUrl, {\n httpMethod: \"GET\",\n authentication: authentication,\n params: { styleFamily, durationSeconds: duration }\n });\n}\n","import { DEFAULT_SAFETY_MARGIN } from \"./defaults.js\";\n\nexport function determineSafetyMargin(\n duration: number | undefined,\n safetyMargin: number | undefined\n): number {\n if (safetyMargin) {\n return safetyMargin;\n }\n\n // common cases are\n // duration is 60 seconds, this will return a 1 second safety margin\n // duration is 43200 seconds, this will return a 300 second (5 minutes) safety margin\n return Math.min(Math.max(duration / 100, 1), DEFAULT_SAFETY_MARGIN);\n}\n","import mitt from \"mitt\";\n\nimport { IAuthenticationManager } from \"@esri/arcgis-rest-request\";\nimport { StyleFamily } from \"./types/StyleFamily.js\";\nimport {\n IStartSessionResponse,\n startNewSession\n} from \"./utils/startNewSession.js\";\nimport { Writable } from \"./utils/writable.js\";\nimport { determineSafetyMargin } from \"./utils/detemineSafetyMargin.js\";\nimport {\n DEFAULT_DURATION,\n DEFAULT_CHECK_EXPIRATION_INTERVAL\n} from \"./utils/defaults.js\";\n\nexport interface IBasemapSessionParams {\n token: string;\n startSessionUrl: string;\n styleFamily: StyleFamily;\n authentication: IAuthenticationManager | string;\n expires: Date;\n startTime: Date;\n endTime: Date;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n}\n\nexport interface IStartSessionParams {\n styleFamily?: StyleFamily;\n authentication: IAuthenticationManager | string;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n\n /**\n * The URL to start the session. If not provided, it will use the default URL.\n * @private\n */\n startSessionUrl?: string;\n}\n\n/**\n * The base class for all basemap sessions. This class implements the {@linkcode IAuthenticationManager} interface and provides methods to start, refresh, and check the expiration of a session.\n * This is not intended to be used directly, but instead is extended by other classes such as {@linkcode BasemapStyleSession} and {@linkcode StaticBasemapTilesSession}.\n *\n * @abstract\n * @implements {IAuthenticationManager}\n */\nexport abstract class BaseSession implements IAuthenticationManager {\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when an error occurs during session management.\n */\n static readonly error = function error(e: Error): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when the current session expires and the session token it no longer valid. This event will only fire if {@linkcode BaseSession.checkingExpirationTime}\n * is `true` which is the default. Once this event fires, {@linkcode BaseSession.checkingExpirationTime} will be set to `false` until the session is refreshed with\n * {@linkcode BaseSession.refreshCredentials}.\n *\n * @event expired\n * @param e - The parameters for the expired event.\n * @param e.token - The session token that expired.\n * @param e.startTime - The start time of the session.\n * @param e.endTime - The end time of the session.\n * @param e.expires - The expiration time of the session.\n */\n static readonly expired = function expired(e: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n }): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when a session refreshes and a new `token` is available.\n *\n * @event refreshed\n * @param e. - The parameters for the refreshed event.\n * @param e.previous - The previous session details.\n * @param e.previous.token - The previous session token.\n * @param e.previous.startTime - The start time of the previous session.\n * @param e.previous.endTime - The end time of the previous session.\n * @param e.previous.expires - The expiration time of the previous session.\n * @param e.current - The current session details.\n * @param e.current.token - The current session token.\n * @param e.current.startTime - The start time of the current token.\n * @param e.current.endTime - The end time of the current session.\n * @param e.current.expires - The expiration time of the current token.\n */\n static readonly refreshed = function refreshed(e: {\n previous: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n };\n current: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n };\n }): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n /**\n * The portal URL that the session is associated with. This generally is not used but exists to implement the `IAuthenticationManager` interface.\n */\n readonly portal: string;\n\n /**\n * The style family of the session. This is used to determine the type of basemap styles that are available.\n */\n readonly styleFamily: StyleFamily;\n\n /**\n * The authentication manager or token used for the session.\n * This can be an instance of {@linkcode ApiKeyManager}, {@linkcode ArcGISIdentityManager}, {@linkcode ApplicationCredentialsManager} or a string token.\n */\n readonly authentication: IAuthenticationManager | string;\n\n /**\n * The expiration date of the session. This is the {@linkcode BaseSession.endTime} minus the {@linkcode BaseSession.safetyMargin}. This is used internally to determine if the session is expired.\n */\n readonly expires: Date;\n\n /**\n * The start time of the session. This is the time returned from the API when the session war started.\n */\n readonly startTime: Date;\n\n /**\n * The end time of the session. This is the time returned from the API when the session will end.\n */\n readonly endTime: Date;\n\n /**\n * The token for the session.\n */\n readonly token: string;\n\n /**\n * The URL used to start the session.\n */\n readonly startSessionUrl: string;\n\n /**\n * The safety margin in milliseconds. This subtracted from the {@linkcode BaseSession.endTime} to get the {@linkcode BaseSession.expiration}.\n */\n readonly safetyMargin: number;\n\n /**\n * The duration of the session in seconds. This is used to determine how long the session will last when the session is refreshed.\n */\n readonly duration: number;\n\n /**\n * The interval at which to check the expiration time of the session. This is always 10 seconds or 1/100th of the duration, whichever is smaller.\n */\n private readonly expirationCheckInterval: number;\n\n /**\n * The ID of the timer used to check the expiration time of the session.\n */\n private expirationTimerId: any = null;\n\n /**\n * A pending session that is being refreshed. This is used to prevent multiple refreshes from happening at the same time.\n */\n private pendingSession: Promise<IStartSessionResponse> | null = null;\n\n /**\n * Internal instance of [`mitt`](https://github.com/developit/mitt) used for event handlers. It is recommended to use {@linkcode BasemapSession.on}, {@linkcode BasemapSession.off} or {@linkcode BasemapSession.once} instead of `emitter.`\n */\n private emitter: any;\n\n /**\n * A handler that is used to automatically refresh the session when it expires.\n */\n private autoRefreshHandler: (() => void) | null = null;\n\n /**\n * Creates a new instance of the BaseSession class. Generally you should not create an instance of this class directly, but instead use the static methods to start a session or deserialize a session.\n *\n * You may need to create an instance of this class directly if you are not using the built in deserialize method.\n *\n * @param params - The parameters for the session.\n * @param params.startSessionUrl - The URL to start the session.\n * @param params.token - The token for the session.\n * @param params.styleFamily - The style family of the session.\n * @param params.authentication - The authentication manager or token used for the session.\n * @param params.expires - The expiration date of the session.\n * @param params.startTime - The start time of the session.\n * @param params.endTime - The end time of the session.\n * @param params.safetyMargin - The safety margin in milliseconds.\n * @param params.duration - Indicates if this is a test session.\n */\n constructor(params: IBasemapSessionParams) {\n this.startSessionUrl = params.startSessionUrl;\n this.token = params.token;\n this.styleFamily = params.styleFamily || \"arcgis\";\n this.authentication = params.authentication;\n this.duration = params.duration || DEFAULT_DURATION;\n this.startTime = params.startTime;\n this.endTime = params.endTime;\n this.expires = params.expires;\n this.safetyMargin = params.safetyMargin;\n this.expirationCheckInterval =\n Math.min(this.duration / 100, DEFAULT_CHECK_EXPIRATION_INTERVAL) * 1000;\n this.emitter = mitt();\n }\n\n /**\n * Checks if the session is expired. If it is expired, it emits an \"expired\" event and disables expiration time checking. The event will fire **before** the method returns true.\n *\n * @returns {boolean} - Returns true if the session is expired, otherwise false.\n */\n isSessionExpired() {\n if (this.isExpired) {\n this.disableCheckingExpirationTime();\n\n this.emitter.emit(\"expired\", {\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n });\n }\n\n return this.isExpired;\n }\n\n /**\n * Starts checking the expiration time of the session. This will check the expiration time immediately and then on an interval.\n * If the session is expired, it will emit an \"expired\" event.\n */\n enableCheckingExpirationTime() {\n const check = () => {\n this.isSessionExpired();\n };\n\n if (!this.expirationTimerId) {\n this.expirationTimerId = setInterval(\n check,\n // check every 10 seconds or 1/100th of the duration, whichever is smaller\n this.expirationCheckInterval\n ); // check immediately then on an interval\n }\n\n setTimeout(() => {\n check(); // check immediately after starting the interval\n }, 10);\n\n return this.expirationTimerId; // return the timer ID so it can be stopped later\n }\n\n /**\n * Stops checking the expiration time of the session. This will clear the interval that was set by {@linkcode BaseSession.startCheckingExpirationTime}.\n */\n disableCheckingExpirationTime() {\n if (this.expirationTimerId) {\n clearInterval(this.expirationTimerId);\n this.expirationTimerId = null;\n }\n }\n\n /**\n * Starts a new session using the provided parameters and returns an instance of the session class.\n *\n * @param params - The parameters for starting the session.\n * @param SessionClass - The class to use for the session.\n * @returns A promise that resolves to an instance of the session class.\n */\n protected static async startSession<T extends BaseSession>(\n {\n startSessionUrl,\n styleFamily = \"arcgis\",\n authentication,\n safetyMargin,\n duration = DEFAULT_DURATION,\n autoRefresh = false\n }: {\n startSessionUrl?: string;\n styleFamily?: StyleFamily;\n authentication: IAuthenticationManager | string;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n },\n SessionClass: new (params: IBasemapSessionParams) => T\n ): Promise<T> {\n if (duration < 10) {\n throw new Error(\"Session duration must be at least 10 seconds.\");\n }\n\n if (duration > 43200) {\n throw new Error(\n \"Session duration cannot exceed 12 hours (43200 seconds).\"\n );\n }\n\n const sessionResponse = await startNewSession({\n startSessionUrl,\n styleFamily,\n authentication,\n duration\n });\n const actualSafetyMargin = determineSafetyMargin(duration, safetyMargin);\n\n const session = new SessionClass({\n startSessionUrl: startSessionUrl,\n token: sessionResponse.sessionToken,\n styleFamily,\n authentication,\n safetyMargin: actualSafetyMargin,\n expires: new Date(sessionResponse.endTime - actualSafetyMargin * 1000),\n startTime: new Date(sessionResponse.startTime),\n endTime: new Date(sessionResponse.endTime),\n duration\n });\n\n session.enableCheckingExpirationTime();\n\n if (autoRefresh) {\n session.enableAutoRefresh();\n }\n\n return session as T;\n }\n\n /**\n * Indicates if the session is currently checking for expiration time.\n *\n * @returns {boolean} - Returns true if the session is checking for expiration time, otherwise false.\n */\n get checkingExpirationTime(): boolean {\n return !!this.expirationTimerId;\n }\n\n /**\n * Returns the number of seconds until the session is no longer valid rounded down. If the session is expired, it will return 0.\n */\n get secondsUntilExpiration(): number {\n return Math.floor(this.millisecondsUntilExpiration / 1000);\n }\n\n /**\n * Returns the number of milliseconds until the session token is no longer valid. If the session is expired, it will return 0.\n */\n get millisecondsUntilExpiration(): number {\n if (this.isExpired) {\n return 0;\n }\n\n const now = new Date();\n const millisecondsLeft = this.endTime.getTime() - now.getTime();\n\n return millisecondsLeft;\n }\n\n /**\n * Checks if the session is expired.\n *\n */\n get isExpired(): boolean {\n return this.expires < new Date();\n }\n\n /**\n * Gets the session token. If the session is expired, it will refresh the credentials and return the new token.\n *\n * @returns A promise that resolves to the session token.\n */\n getToken(): Promise<string> {\n if (this.isExpired) {\n return this.refreshCredentials().then(() => this.token);\n }\n\n return Promise.resolve(this.token);\n }\n\n /**\n * Indicates if the session can be refreshed. This is always true for this basemap sessions.\n *\n * @returns {boolean} - Always returns true.\n */\n get canRefresh(): boolean {\n return true;\n }\n\n /**\n * Indicates if the session is set to automatically refresh when it expires.\n *\n * @returns {boolean} - Returns true if auto-refresh is enabled, otherwise false.\n */\n get autoRefresh(): boolean {\n return !!this.autoRefreshHandler && !!this.expirationTimerId;\n }\n\n /**\n * Refreshes the session credentials by starting a new session.\n * This will emit a \"refreshed\" event with the previous and current session details.\n *\n * @returns A promise that resolves to the current instance of the session.\n */\n async refreshCredentials(): Promise<this> {\n if (this.pendingSession) {\n // if there is a pending session, wait for it to resolve\n await this.pendingSession;\n return this;\n }\n\n // @TODO switch this to structured clone when we upgrade to Node 20+ types so we don't have to parse the dates later\n const previous = JSON.parse(\n JSON.stringify({\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n })\n );\n\n try {\n this.pendingSession = startNewSession({\n startSessionUrl: this.startSessionUrl,\n styleFamily: this.styleFamily,\n authentication: this.authentication,\n duration: this.duration\n });\n\n const newSession = await this.pendingSession;\n\n this.pendingSession = null; // reset the pending session\n\n this.setToken(newSession.sessionToken);\n this.setStartTime(new Date(newSession.startTime));\n this.setEndTime(new Date(newSession.endTime));\n this.setExpires(new Date(newSession.endTime - this.safetyMargin * 1000));\n\n this.enableCheckingExpirationTime(); // restart checking expiration time after refreshing credentials\n\n this.emitter.emit(\"refreshed\", {\n previous: {\n token: previous.token,\n startTime: new Date(previous.startTime),\n endTime: new Date(previous.endTime),\n expires: new Date(previous.expires)\n },\n current: {\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n }\n });\n } catch (error) {\n this.emitter.emit(\"error\", error);\n throw error;\n }\n\n return this;\n }\n /**\n * Enables auto-refresh for the session. This will automatically refresh the session when it expires.\n * It will also start checking the expiration time of the session if it is not already started via {@linkcode BaseSession.enableCheckingExpirationTime}.\n */\n enableAutoRefresh() {\n if (!this.expirationTimerId) {\n this.enableCheckingExpirationTime();\n }\n\n this.autoRefreshHandler = () => {\n this.refreshCredentials().catch((error: Error) => {\n this.emitter.emit(\"error\", error);\n });\n };\n\n this.on(\"expired\", this.autoRefreshHandler);\n }\n\n /**\n * Disables auto-refresh for the session. This will stop automatically refreshing the session when it expires.\n * This will **not** stop checking the expiration time of the session. If you want to stop automated expiration\n * checking, call {@linkcode BaseSession.disableCheckingExpirationTime} after calling this method.\n */\n disableAutoRefresh() {\n if (this.autoRefreshHandler) {\n this.off(\"expired\", this.autoRefreshHandler);\n this.autoRefreshHandler = null;\n }\n }\n\n /**\n * Removes all event listeners and disables auto-refresh and expiration time checking. This is useful for cleaning up the session when it is no longer needed or replaced with a new session.\n */\n destroy() {\n this.disableAutoRefresh();\n this.disableCheckingExpirationTime();\n this.emitter.off(\"expired\");\n this.emitter.off(\"refreshed\");\n this.emitter.off(\"error\");\n this.emitter.off(\"*\");\n }\n\n /**\n * A handler that listens for an eventName and returns custom handler.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n on(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n on(event: \"expired\", handler: typeof BaseSession.expired): void;\n on(event: \"error\", handler: typeof BaseSession.error): void;\n on(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n this.emitter.on(eventName, handler);\n this.isSessionExpired(); // check if the session is expired immediately after adding the handler\n }\n\n /**\n * A handler that listens for an event once and returns a custom handler. Events listened to with this method cannot be removed with {@linkcode BasemapSession.off}.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n once(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n once(event: \"expired\", handler: typeof BaseSession.expired): void;\n once(event: \"error\", handler: typeof BaseSession.error): void;\n once(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n const fn = (e: any) => {\n this.emitter.off(eventName, fn);\n handler(e);\n };\n\n this.emitter.on(eventName, fn);\n }\n\n /**\n * A handler that will remove a listener from a given event.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n off(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n off(event: \"expired\", handler: typeof BaseSession.expired): void;\n off(event: \"error\", handler: typeof BaseSession.error): void;\n off(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n this.emitter.off(eventName, handler);\n }\n\n /**\n * These private methods are used to set the internal state of the session.\n */\n private setToken(token: string) {\n (this as Writable<typeof this>).token = token;\n }\n private setStartTime(startTime: Date) {\n (this as Writable<typeof this>).startTime = startTime;\n }\n private setEndTime(endTime: Date) {\n (this as Writable<typeof this>).endTime = endTime;\n }\n private setExpires(expires: Date) {\n (this as Writable<typeof this>).expires = expires;\n }\n}\n","import {\n BaseSession,\n IBasemapSessionParams,\n IStartSessionParams\n} from \"./BaseSession.js\";\nimport { DEFAULT_START_BASEMAP_STYLE_SESSION_URL } from \"./utils/defaults.js\";\n\n/**\n * `BasemapStyleSession` is a class that extends {@linkcode BaseSession} to manage sessions\n * for basemap styles. It provides methods to {@linkcode BasemapStyleSession.start} a new session\n * which should be used instead of constructing a new instance directly.\n *\n * @class BasemapStyleSession\n * @extends BaseSession\n */\nexport class BasemapStyleSession extends BaseSession {\n /**\n * Creates an instance of `BasemapStyleSession`. Constructing `BasemapStyleSession` directly is discouraged.\n * Instead, use the static method {@linkcode BasemapStyleSession.start} to start a new session.\n */\n constructor(params: IBasemapSessionParams) {\n super(params);\n }\n\n /**\n * Starts a new basemap style session.\n */\n static async start(params: IStartSessionParams) {\n return BaseSession.startSession<BasemapStyleSession>(\n {\n ...params,\n startSessionUrl:\n params?.startSessionUrl || DEFAULT_START_BASEMAP_STYLE_SESSION_URL\n },\n BasemapStyleSession as new (\n params: IBasemapSessionParams\n ) => BasemapStyleSession\n );\n }\n}\n"],"names":[],"mappings":";;;;;;;AAAe,aAAQ,CAAC,CAAC,CAAC,CAAC,OAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAC,CAAC,EAAC,CAAC,CAAC;;MCA5S,uCAAuC,GAClD,qFAAqF;MAE1E,qBAAqB,GAAG,CAAC,GAAG,GAAG;MAE/B,iCAAiC,GAAG,GAAG;MAEvC,gBAAgB,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG;;SCW7B,eAAe,CAAC,EAC9B,eAAe,EACf,cAAc,EACd,WAAW,GAAG,QAAQ,EACtB,QAAQ,GAAG,gBAAgB,EACF;IACzB,OAAO,OAAO,CAAC,eAAe,EAAE;QAC9B,UAAU,EAAE,KAAK;QACjB,cAAc,EAAE,cAAc;QAC9B,MAAM,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE;KACnD,CAAC,CAAC;AACL;;SC3BgB,qBAAqB,CACnC,QAA4B,EAC5B,YAAgC;IAEhC,IAAI,YAAY,EAAE;QAChB,OAAO,YAAY,CAAC;KACrB;;;;IAKD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;AACtE;;AC4BA;;;;;;;MAOsB,WAAW;;;;;;;;;;;;;;;;;IA0J/B,YAAY,MAA6B;;;;QAjCjC,sBAAiB,GAAQ,IAAI,CAAC;;;;QAK9B,mBAAc,GAA0C,IAAI,CAAC;;;;QAU7D,uBAAkB,GAAwB,IAAI,CAAC;QAmBrD,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,QAAQ,CAAC;QAClD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,gBAAgB,CAAC;QACpD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,uBAAuB;YAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,GAAG,EAAE,iCAAiC,CAAC,GAAG,IAAI,CAAC;QAC1E,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC;KACvB;;;;;;IAOD,gBAAgB;QACd,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,6BAA6B,EAAE,CAAC;YAErC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE;gBAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,CAAC,SAAS,CAAC;KACvB;;;;;IAMD,4BAA4B;QAC1B,MAAM,KAAK,GAAG;YACZ,IAAI,CAAC,gBAAgB,EAAE,CAAC;SACzB,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,iBAAiB,GAAG,WAAW,CAClC,KAAK;;YAEL,IAAI,CAAC,uBAAuB,CAC7B,CAAC;SACH;QAED,UAAU,CAAC;YACT,KAAK,EAAE,CAAC;SACT,EAAE,EAAE,CAAC,CAAC;QAEP,OAAO,IAAI,CAAC,iBAAiB,CAAC;KAC/B;;;;IAKD,6BAA6B;QAC3B,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YACtC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;SAC/B;KACF;;;;;;;;IASS,aAAa,YAAY,CACjC,EACE,eAAe,EACf,WAAW,GAAG,QAAQ,EACtB,cAAc,EACd,YAAY,EACZ,QAAQ,GAAG,gBAAgB,EAC3B,WAAW,GAAG,KAAK,EAQpB,EACD,YAAsD;QAEtD,IAAI,QAAQ,GAAG,EAAE,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;SAClE;QAED,IAAI,QAAQ,GAAG,KAAK,EAAE;YACpB,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAC;SACH;QAED,MAAM,eAAe,GAAG,MAAM,eAAe,CAAC;YAC5C,eAAe;YACf,WAAW;YACX,cAAc;YACd,QAAQ;SACT,CAAC,CAAC;QACH,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAEzE,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC;YAC/B,eAAe,EAAE,eAAe;YAChC,KAAK,EAAE,eAAe,CAAC,YAAY;YACnC,WAAW;YACX,cAAc;YACd,YAAY,EAAE,kBAAkB;YAChC,OAAO,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,GAAG,kBAAkB,GAAG,IAAI,CAAC;YACtE,SAAS,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;YAC9C,OAAO,EAAE,IAAI,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;YAC1C,QAAQ;SACT,CAAC,CAAC;QAEH,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAEvC,IAAI,WAAW,EAAE;YACf,OAAO,CAAC,iBAAiB,EAAE,CAAC;SAC7B;QAED,OAAO,OAAY,CAAC;KACrB;;;;;;IAOD,IAAI,sBAAsB;QACxB,OAAO,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC;KACjC;;;;IAKD,IAAI,sBAAsB;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC,CAAC;KAC5D;;;;IAKD,IAAI,2BAA2B;QAC7B,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO,CAAC,CAAC;SACV;QAED,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;QAEhE,OAAO,gBAAgB,CAAC;KACzB;;;;;IAMD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;KAClC;;;;;;IAOD,QAAQ;QACN,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;SACzD;QAED,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACpC;;;;;;IAOD,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC;KACb;;;;;;IAOD,IAAI,WAAW;QACb,OAAO,CAAC,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC;KAC9D;;;;;;;IAQD,MAAM,kBAAkB;QACtB,IAAI,IAAI,CAAC,cAAc,EAAE;;YAEvB,MAAM,IAAI,CAAC,cAAc,CAAC;YAC1B,OAAO,IAAI,CAAC;SACb;;QAGD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CACzB,IAAI,CAAC,SAAS,CAAC;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CACH,CAAC;QAEF,IAAI;YACF,IAAI,CAAC,cAAc,GAAG,eAAe,CAAC;gBACpC,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC;YAE7C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;YAE3B,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YACvC,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;YAEzE,IAAI,CAAC,4BAA4B,EAAE,CAAC;YAEpC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC7B,QAAQ,EAAE;oBACR,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,SAAS,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACvC,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;oBACnC,OAAO,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;iBACpC;gBACD,OAAO,EAAE;oBACP,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB;aACF,CAAC,CAAC;SACJ;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAClC,MAAM,KAAK,CAAC;SACb;QAED,OAAO,IAAI,CAAC;KACb;;;;;IAKD,iBAAiB;QACf,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC3B,IAAI,CAAC,4BAA4B,EAAE,CAAC;SACrC;QAED,IAAI,CAAC,kBAAkB,GAAG;YACxB,IAAI,CAAC,kBAAkB,EAAE,CAAC,KAAK,CAAC,CAAC,KAAY;gBAC3C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;aACnC,CAAC,CAAC;SACJ,CAAC;QAEF,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;KAC7C;;;;;;IAOD,kBAAkB;QAChB,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC3B,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAC7C,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;SAChC;KACF;;;;IAKD,OAAO;QACL,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,CAAC,6BAA6B,EAAE,CAAC;QACrC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;KACvB;IAWD,EAAE,CACA,SAAiB,EACjB,OAG4B;QAE5B,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,gBAAgB,EAAE,CAAC;KACzB;IAWD,IAAI,CACF,SAAiB,EACjB,OAG4B;QAE5B,MAAM,EAAE,GAAG,CAAC,CAAM;YAChB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAChC,OAAO,CAAC,CAAC,CAAC,CAAC;SACZ,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;KAChC;IAWD,GAAG,CACD,SAAiB,EACjB,OAG4B;QAE5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;KACtC;;;;IAKO,QAAQ,CAAC,KAAa;QAC3B,IAA8B,CAAC,KAAK,GAAG,KAAK,CAAC;KAC/C;IACO,YAAY,CAAC,SAAe;QACjC,IAA8B,CAAC,SAAS,GAAG,SAAS,CAAC;KACvD;IACO,UAAU,CAAC,OAAa;QAC7B,IAA8B,CAAC,OAAO,GAAG,OAAO,CAAC;KACnD;IACO,UAAU,CAAC,OAAa;QAC7B,IAA8B,CAAC,OAAO,GAAG,OAAO,CAAC;KACnD;;AAzhBD;AACA;AACA;;;AAGgB,iBAAK,GAAG,SAAS,KAAK,CAAC,CAAQ,KAAU,CAAC;AAE1D;AACA;AACA;;;;;;;;;;;;AAYgB,mBAAO,GAAG,SAAS,OAAO,CAAC,CAK1C,KAAU,CAAC;AAEZ;AACA;AACA;;;;;;;;;;;;;;;;AAgBgB,qBAAS,GAAG,SAAS,SAAS,CAAC,CAa9C,KAAU,CAAC;;ACtGd;;;;;;;;MAQa,mBAAoB,SAAQ,WAAW;;;;;IAKlD,YAAY,MAA6B;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;KACf;;;;IAKD,aAAa,KAAK,CAAC,MAA2B;QAC5C,OAAO,WAAW,CAAC,YAAY,iCAExB,MAAM,KACT,eAAe,EACb,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,KAAI,uCAAuC,KAEtE,mBAEwB,CACzB,CAAC;KACH;;;;;"}
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
/* @preserve
|
|
2
2
|
* @esri/arcgis-rest-basemap-sessions - v1.0.0 - Apache-2.0
|
|
3
3
|
* Copyright (c) 2017-2025 Esri, Inc.
|
|
4
|
-
* Wed
|
|
4
|
+
* Wed Aug 20 2025 22:29:08 GMT+0000 (Coordinated Universal Time)
|
|
5
5
|
*/
|
|
6
|
-
import{request as
|
|
7
|
-
/* istanbul ignore next -- @preserve */a.error=function(
|
|
6
|
+
import{request as e}from"@esri/arcgis-rest-request";const t="https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/sessions/start",i=300,s=10,r=43200;function n({startSessionUrl:t,authentication:i,styleFamily:s="arcgis",duration:r=43200}){return e(t,{httpMethod:"GET",authentication:i,params:{styleFamily:s,durationSeconds:r}})}class a{constructor(e){var t;this.expirationTimerId=null,this.pendingSession=null,this.autoRefreshHandler=null,this.startSessionUrl=e.startSessionUrl,this.token=e.token,this.styleFamily=e.styleFamily||"arcgis",this.authentication=e.authentication,this.duration=e.duration||r,this.startTime=e.startTime,this.endTime=e.endTime,this.expires=e.expires,this.safetyMargin=e.safetyMargin,this.expirationCheckInterval=1e3*Math.min(this.duration/100,10),this.emitter={all:t=t||new Map,on:function(e,i){var s=t.get(e);s?s.push(i):t.set(e,[i])},off:function(e,i){var s=t.get(e);s&&(i?s.splice(s.indexOf(i)>>>0,1):t.set(e,[]))},emit:function(e,i){var s=t.get(e);s&&s.slice().map((function(e){e(i)})),(s=t.get("*"))&&s.slice().map((function(t){t(e,i)}))}}}isSessionExpired(){return this.isExpired&&(this.disableCheckingExpirationTime(),this.emitter.emit("expired",{token:this.token,startTime:this.startTime,endTime:this.endTime,expires:this.expires})),this.isExpired}enableCheckingExpirationTime(){const e=()=>{this.isSessionExpired()};return this.expirationTimerId||(this.expirationTimerId=setInterval(e,this.expirationCheckInterval)),setTimeout((()=>{e()}),10),this.expirationTimerId}disableCheckingExpirationTime(){this.expirationTimerId&&(clearInterval(this.expirationTimerId),this.expirationTimerId=null)}static async startSession({startSessionUrl:e,styleFamily:t="arcgis",authentication:i,safetyMargin:s,duration:r=43200,autoRefresh:a=!1},o){if(r<10)throw new Error("Session duration must be at least 10 seconds.");if(r>43200)throw new Error("Session duration cannot exceed 12 hours (43200 seconds).");const h=await n({startSessionUrl:e,styleFamily:t,authentication:i,duration:r}),m=function(e,t){return t||Math.min(Math.max(e/100,1),300)}(r,s),d=new o({startSessionUrl:e,token:h.sessionToken,styleFamily:t,authentication:i,safetyMargin:m,expires:new Date(h.endTime-1e3*m),startTime:new Date(h.startTime),endTime:new Date(h.endTime),duration:r});return d.enableCheckingExpirationTime(),a&&d.enableAutoRefresh(),d}get checkingExpirationTime(){return!!this.expirationTimerId}get secondsUntilExpiration(){return Math.floor(this.millisecondsUntilExpiration/1e3)}get millisecondsUntilExpiration(){if(this.isExpired)return 0;const e=new Date;return this.endTime.getTime()-e.getTime()}get isExpired(){return this.expires<new Date}getToken(){return this.isExpired?this.refreshCredentials().then((()=>this.token)):Promise.resolve(this.token)}get canRefresh(){return!0}get autoRefresh(){return!!this.autoRefreshHandler&&!!this.expirationTimerId}async refreshCredentials(){if(this.pendingSession)return await this.pendingSession,this;const e=JSON.parse(JSON.stringify({token:this.token,startTime:this.startTime,endTime:this.endTime,expires:this.expires}));try{this.pendingSession=n({startSessionUrl:this.startSessionUrl,styleFamily:this.styleFamily,authentication:this.authentication,duration:this.duration});const t=await this.pendingSession;this.pendingSession=null,this.setToken(t.sessionToken),this.setStartTime(new Date(t.startTime)),this.setEndTime(new Date(t.endTime)),this.setExpires(new Date(t.endTime-1e3*this.safetyMargin)),this.enableCheckingExpirationTime(),this.emitter.emit("refreshed",{previous:{token:e.token,startTime:new Date(e.startTime),endTime:new Date(e.endTime),expires:new Date(e.expires)},current:{token:this.token,startTime:this.startTime,endTime:this.endTime,expires:this.expires}})}catch(e){throw this.emitter.emit("error",e),e}return this}enableAutoRefresh(){this.expirationTimerId||this.enableCheckingExpirationTime(),this.autoRefreshHandler=()=>{this.refreshCredentials().catch((e=>{this.emitter.emit("error",e)}))},this.on("expired",this.autoRefreshHandler)}disableAutoRefresh(){this.autoRefreshHandler&&(this.off("expired",this.autoRefreshHandler),this.autoRefreshHandler=null)}destroy(){this.disableAutoRefresh(),this.disableCheckingExpirationTime(),this.emitter.off("expired"),this.emitter.off("refreshed"),this.emitter.off("error"),this.emitter.off("*")}on(e,t){this.emitter.on(e,t),this.isSessionExpired()}once(e,t){const i=s=>{this.emitter.off(e,i),t(s)};this.emitter.on(e,i)}off(e,t){this.emitter.off(e,t)}setToken(e){this.token=e}setStartTime(e){this.startTime=e}setEndTime(e){this.endTime=e}setExpires(e){this.expires=e}}
|
|
7
|
+
/* istanbul ignore next -- @preserve */a.error=function(e){},
|
|
8
8
|
/* istanbul ignore next -- @preserve */
|
|
9
|
-
a.expired=function(
|
|
9
|
+
a.expired=function(e){},
|
|
10
10
|
/* istanbul ignore next -- @preserve */
|
|
11
|
-
a.refreshed=function(
|
|
11
|
+
a.refreshed=function(e){};class o extends a{constructor(e){super(e)}static async start(e){return a.startSession(Object.assign(Object.assign({},e),{startSessionUrl:(null==e?void 0:e.startSessionUrl)||t}),o)}}export{a as BaseSession,o as BasemapStyleSession,s as DEFAULT_CHECK_EXPIRATION_INTERVAL,r as DEFAULT_DURATION,i as DEFAULT_SAFETY_MARGIN,t as DEFAULT_START_BASEMAP_STYLE_SESSION_URL,n as startNewSession};
|
|
12
12
|
//# sourceMappingURL=basemap-sessions.esm.min.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"basemap-sessions.esm.min.js","sources":["../../src/utils/defaults.ts","../../src/utils/startNewSession.ts","../../src/BaseSession.ts","../../node_modules/mitt/dist/mitt.mjs","../../src/utils/detemineSafetyMargin.ts","../../src/BasemapStyleSession.ts"],"sourcesContent":["export const DEFAULT_START_BASEMAP_STYLE_SESSION_URL =\n \"https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/sessions/start\";\n\nexport const DEFAULT_SAFETY_MARGIN = 5 * 60; // Default to 5 minutes in seconds\n\nexport const DEFAULT_CHECK_EXPIRATION_INTERVAL = 10; // Default to 10 seconds\n\nexport const DEFAULT_DURATION = 12 * 60 * 60; // Default to 12 hours in seconds\n","import { IAuthenticationManager, request } from \"@esri/arcgis-rest-request\";\nimport { StyleFamily } from \"../types/StyleFamily.js\";\nimport { DEFAULT_DURATION } from \"./defaults.js\";\n\nexport interface IRequestNewSessionParams {\n startSessionUrl: string;\n authentication: IAuthenticationManager | string;\n styleFamily?: StyleFamily;\n duration?: number;\n}\n\nexport interface IStartSessionResponse {\n sessionToken: string;\n endTime: number;\n startTime: number;\n styleFamily: StyleFamily;\n}\n\nexport function startNewSession({\n startSessionUrl,\n authentication,\n styleFamily = \"arcgis\",\n duration = DEFAULT_DURATION\n}: IRequestNewSessionParams): Promise<IStartSessionResponse> {\n return request(startSessionUrl, {\n httpMethod: \"GET\",\n authentication: authentication,\n params: { styleFamily, durationSeconds: duration }\n });\n}\n","import mitt from \"mitt\";\n\nimport { IAuthenticationManager } from \"@esri/arcgis-rest-request\";\nimport { StyleFamily } from \"./types/StyleFamily.js\";\nimport { startNewSession } from \"./utils/startNewSession.js\";\nimport { Writable } from \"./utils/writable.js\";\nimport { determineSafetyMargin } from \"./utils/detemineSafetyMargin.js\";\nimport {\n DEFAULT_DURATION,\n DEFAULT_SAFETY_MARGIN,\n DEFAULT_CHECK_EXPIRATION_INTERVAL\n} from \"./utils/defaults.js\";\n\nexport interface IBasemapSessionParams {\n token: string;\n startSessionUrl: string;\n styleFamily: StyleFamily;\n authentication: IAuthenticationManager | string;\n expires: Date;\n startTime: Date;\n endTime: Date;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n}\n\nexport interface IStartSessionParams {\n styleFamily?: StyleFamily;\n authentication: IAuthenticationManager | string;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n\n /**\n * The URL to start the session. If not provided, it will use the default URL.\n * @private\n */\n startSessionUrl?: string;\n}\n\n/**\n * The base class for all basemap sessions. This class implements the {@linkcode IAuthenticationManager} interface and provides methods to start, refresh, and check the expiration of a session.\n * This is not intendet to be used directly, but instead is extended by other classes such as {@linkcode BasemapStyleSession} and {@linkcode StaticBasemapTilesSession}.\n *\n * @abstract\n * @implements {IAuthenticationManager}\n */\nexport abstract class BaseSession implements IAuthenticationManager {\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when an error occurs during session management.\n */\n static readonly error = function error(e: Error): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when a session expires and the `token` it no longer valid.\n *\n * @event expired\n * @param e - The parameters for the expired event.\n * @param e.token - The session token that expired.\n * @param e.startTime - The start time of the session.\n * @param e.endTime - The end time of the session.\n * @param e.expires - The expiration time of the session.\n */\n static readonly expired = function expired(e: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n }): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when a session refreshes and a new `token` is available.\n *\n * @event refreshed\n * @param e. - The parameters for the refreshed event.\n * @param e.previous - The previous session details.\n * @param e.previous.token - The previous session token.\n * @param e.previous.startTime - The start time of the previous session.\n * @param e.previous.endTime - The end time of the previous session.\n * @param e.previous.expires - The expiration time of the previous session.\n * @param e.current - The current session details.\n * @param e.current.token - The current session token.\n * @param e.current.startTime - The start time of the current token.\n * @param e.current.endTime - The end time of the current session.\n * @param e.current.expires - The expiration time of the current token.\n */\n static readonly refreshed = function refreshed(e: {\n previous: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n };\n current: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n };\n }): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n /**\n * The portal URL that the session is associated with. This generally is not used but exists to implement the `IAuthenticationManager` interface.\n */\n readonly portal: string;\n\n /**\n * The style family of the session. This is used to determine the type of basemap styles that are available.\n */\n readonly styleFamily: StyleFamily;\n\n /**\n * The authentication manager or token used for the session.\n * This can be an instance of {@linkcode ApiKeyManager}, {@linkcode ArcGISIdentityManager}, {@linkcode ApplicationCredentialsManager} or a string token.\n */\n readonly authentication: IAuthenticationManager | string;\n\n /**\n * The expiration date of the session. This is the {@linkcode BaseSession.endTime} minus the {@linkcode BaseSession.safetyMargin}. This is used internally to determine if the session is expired.\n */\n readonly expires: Date;\n\n /**\n * The start time of the session. This is the time returned from the API when the session war started.\n */\n readonly startTime: Date;\n\n /**\n * The end time of the session. This is the time returned from the API when the session will end.\n */\n readonly endTime: Date;\n\n /**\n * The token for the session.\n */\n readonly token: string;\n\n /**\n * The URL used to start the session.\n */\n readonly startSessionUrl: string;\n\n /**\n * The safety margin in milliseconds. This subtracted from the {@linkcode BaseSession.endTime} to get the {@linkcode BaseSession.expiration}.\n */\n readonly safetyMargin: number;\n\n /**\n * The duration of the session in seconds. This is used to determine how long the session will last when the session is refreshed.\n */\n readonly duration: number;\n\n /**\n * The interval at which to check the expiration time of the session. This is always 10 seconds or 1/100th of the duration, whichever is smaller.\n */\n readonly expirationCheckInterval: number;\n\n /**\n * The ID of the timer used to check the expiration time of the session.\n */\n private expirationTimerId: any = null;\n\n /**\n * Internal instance of [`mitt`](https://github.com/developit/mitt) used for event handlers. It is recommended to use {@linkcode BasemapSession.on}, {@linkcode BasemapSession.off} or {@linkcode BasemapSession.once} instead of `emitter.`\n */\n private emitter: any;\n\n /**\n * A handler that is used to automatically refresh the session when it expires.\n */\n private autoRefreshHandler: (() => void) | null = null;\n\n /**\n * Creates a new instance of the BaseSession class. Generally you should not create an instance of this class directly, but instead use the static methods to start a session or deserialize a session.\n *\n * You may need to create an instance of this class directly if you are not using the built in deserialize method.\n *\n * @param params - The parameters for the session.\n * @param params.startSessionUrl - The URL to start the session.\n * @param params.token - The token for the session.\n * @param params.styleFamily - The style family of the session.\n * @param params.authentication - The authentication manager or token used for the session.\n * @param params.expires - The expiration date of the session.\n * @param params.startTime - The start time of the session.\n * @param params.endTime - The end time of the session.\n * @param params.safetyMargin - The safety margin in milliseconds.\n * @param params.duration - Indicates if this is a test session.\n */\n constructor(params: IBasemapSessionParams) {\n this.startSessionUrl = params.startSessionUrl;\n this.token = params.token;\n this.styleFamily = params.styleFamily || \"arcgis\";\n this.authentication = params.authentication;\n this.duration = params.duration || DEFAULT_DURATION;\n this.startTime = params.startTime;\n this.endTime = params.endTime;\n this.expires = params.expires;\n this.safetyMargin = params.safetyMargin;\n this.expirationCheckInterval =\n Math.min(this.duration / 100, DEFAULT_CHECK_EXPIRATION_INTERVAL) * 1000;\n this.emitter = mitt();\n }\n\n /**\n * Checks if the session is expired. If it is expired, it emits an \"expired\" event. The event will fire **before** the method returns true.\n *\n * @returns {boolean} - Returns true if the session is expired, otherwise false.\n */\n isSessionExpired() {\n if (this.isExpired) {\n this.emitter.emit(\"expired\", {\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n });\n }\n return this.isExpired;\n }\n\n /**\n * Starts checking the expiration time of the session. This will check the expiration time immediately and then on an interval.\n * If the session is expired, it will emit an \"expired\" event.\n */\n startCheckingExpirationTime() {\n const check = () => {\n this.isSessionExpired();\n };\n\n if (!this.expirationTimerId) {\n this.expirationTimerId = setInterval(\n check,\n // check every 10 seconds or 1/100th of the duration, whichever is smaller\n this.expirationCheckInterval\n ); // check immediatly then on an interval\n }\n\n setTimeout(() => {\n check(); // check immediately after starting the interval\n }, 10);\n\n return this.expirationTimerId; // return the timer ID so it can be stopped later\n }\n\n /**\n * Stops checking the expiration time of the session. This will clear the interval that was set by {@linkcode BaseSession.startCheckingExpirationTime}.\n */\n stopCheckingExpirationTime() {\n if (this.expirationTimerId) {\n clearInterval(this.expirationTimerId);\n this.expirationTimerId = null;\n }\n }\n\n /**\n * Indicates if the session is currently checking for expiration time.\n *\n * @returns {boolean} - Returns true if the session is checking for expiration time, otherwise false.\n */\n get checkingExpirationTime(): boolean {\n return !!this.expirationTimerId;\n }\n\n /**\n * Starts a new session using the provided parameters and returns an instance of the session class.\n *\n * @param params - The parameters for starting the session.\n * @param SessionClass - The class to use for the session.\n * @returns A promise that resolves to an instance of the session class.\n */\n protected static async startSession<T extends BaseSession>(\n {\n startSessionUrl,\n styleFamily = \"arcgis\",\n authentication,\n safetyMargin,\n duration = DEFAULT_DURATION,\n autoRefresh = true\n }: {\n startSessionUrl?: string;\n styleFamily?: StyleFamily;\n authentication: IAuthenticationManager | string;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n },\n SessionClass: new (params: IBasemapSessionParams) => T\n ): Promise<T> {\n const sessionResponse = await startNewSession({\n startSessionUrl,\n styleFamily,\n authentication,\n duration\n });\n const actualSafetyMargin = determineSafetyMargin(duration, safetyMargin);\n\n const session = new SessionClass({\n startSessionUrl: startSessionUrl,\n token: sessionResponse.sessionToken,\n styleFamily,\n authentication,\n safetyMargin: actualSafetyMargin,\n expires: new Date(sessionResponse.endTime - actualSafetyMargin * 1000),\n startTime: new Date(sessionResponse.startTime),\n endTime: new Date(sessionResponse.endTime),\n duration\n });\n\n session.startCheckingExpirationTime();\n\n if (autoRefresh) {\n session.startAutoRefresh();\n }\n\n return session as T;\n }\n\n /**\n * Checks if the session is expired.\n *\n */\n get isExpired(): boolean {\n return this.expires < new Date();\n }\n\n /**\n * Gets the session token. If the session is expired, it will refresh the credentials and return the new token.\n *\n * @returns A promise that resolves to the session token.\n */\n getToken(): Promise<string> {\n if (this.isExpired) {\n return this.refreshCredentials().then(() => this.token);\n }\n\n return Promise.resolve(this.token);\n }\n\n /**\n * Indicates if the session can be refreshed. This is always true for this class.\n *\n * @returns {boolean} - Always returns true.\n */\n get canRefresh(): boolean {\n return true;\n }\n\n /**\n * Indicates if the session is set to automatically refresh when it expires.\n *\n * @returns {boolean} - Returns true if auto-refresh is enabled, otherwise false.\n */\n get autoRefresh(): boolean {\n return !!this.autoRefreshHandler && !!this.expirationTimerId;\n }\n\n /**\n * Refreshes the session credentials by starting a new session.\n * This will emit a \"refreshed\" event with the previous and current session details.\n *\n * @returns A promise that resolves to the current instance of the session.\n */\n async refreshCredentials(): Promise<this> {\n // @TODO switch this to structured clone when we upgrade to Node 20+ types so we don't have to parse the dates later\n const previous = JSON.parse(\n JSON.stringify({\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n })\n );\n\n try {\n const newSession = await startNewSession({\n startSessionUrl: this.startSessionUrl,\n styleFamily: this.styleFamily,\n authentication: this.authentication,\n duration: this.duration\n });\n\n this.setToken(newSession.sessionToken);\n this.setStartTime(new Date(newSession.startTime));\n this.setEndTime(new Date(newSession.endTime));\n this.setExpires(new Date(newSession.endTime - this.safetyMargin * 1000));\n\n this.emitter.emit(\"refreshed\", {\n previous: {\n token: previous.token,\n startTime: new Date(previous.startTime),\n endTime: new Date(previous.endTime),\n expires: new Date(previous.expires)\n },\n current: {\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n }\n });\n } catch (error) {\n this.emitter.emit(\"error\", error);\n throw error;\n }\n\n return this;\n }\n /**\n * Enables auto-refresh for the session. This will automatically refresh the session when it expires.\n * It will also start checking the expiration time of the session if it is not already started via {@linkcode BaseSession.startCheckingExpirationTime}.\n */\n startAutoRefresh() {\n if (!this.expirationTimerId) {\n this.startCheckingExpirationTime();\n }\n\n this.autoRefreshHandler = () => {\n this.refreshCredentials().catch((error: Error) => {\n this.emitter.emit(\"error\", error);\n });\n };\n\n this.on(\"expired\", this.autoRefreshHandler);\n }\n\n /**\n * Disables auto-refresh for the session. This will stop automatically refreshing the session when it expires.\n * This will **not** stop checking the expiration time of the session. If you want to stop automated expiration\n * checking, call {@linkcode BaseSession.stopCheckingExpirationTime} after calling this method.\n */\n stopAutoRefresh() {\n if (this.autoRefreshHandler) {\n this.off(\"expired\", this.autoRefreshHandler);\n this.autoRefreshHandler = null;\n }\n }\n\n /**\n * A handler that listens for an eventName and returns custom handler.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n on(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n on(event: \"expired\", handler: typeof BaseSession.expired): void;\n on(event: \"error\", handler: typeof BaseSession.error): void;\n on(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n this.emitter.on(eventName, handler);\n this.isSessionExpired(); // check if the session is expired immediately after adding the handler\n }\n\n /**\n * A handler that listens for an event once and returns a custom handler. Events listened to with this method cannot be removed with {@linkcode BasemapSession.off}.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n once(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n once(event: \"expired\", handler: typeof BaseSession.expired): void;\n once(event: \"error\", handler: typeof BaseSession.error): void;\n once(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n const fn = (e: any) => {\n this.emitter.off(eventName, fn);\n handler(e);\n };\n\n this.emitter.on(eventName, fn);\n }\n\n /**\n * A handler that will remove a listener from a given event.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n off(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n off(event: \"expired\", handler: typeof BaseSession.expired): void;\n off(event: \"error\", handler: typeof BaseSession.error): void;\n off(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n this.emitter.off(eventName, handler);\n }\n\n /**\n * These private methods are used to set the internal state of the session.\n */\n private setToken(token: string) {\n (this as Writable<typeof this>).token = token;\n }\n private setStartTime(startTime: Date) {\n (this as Writable<typeof this>).startTime = startTime;\n }\n private setEndTime(endTime: Date) {\n (this as Writable<typeof this>).endTime = endTime;\n }\n private setExpires(expires: Date) {\n (this as Writable<typeof this>).expires = expires;\n }\n}\n","export default function(n){return{all:n=n||new Map,on:function(t,e){var i=n.get(t);i?i.push(e):n.set(t,[e])},off:function(t,e){var i=n.get(t);i&&(e?i.splice(i.indexOf(e)>>>0,1):n.set(t,[]))},emit:function(t,e){var i=n.get(t);i&&i.slice().map(function(n){n(e)}),(i=n.get(\"*\"))&&i.slice().map(function(n){n(t,e)})}}}\n//# sourceMappingURL=mitt.mjs.map\n","import { DEFAULT_SAFETY_MARGIN } from \"./defaults.js\";\n\nexport function determineSafetyMargin(\n duration: number | undefined,\n safetyMargin: number | undefined\n): number {\n if (safetyMargin) {\n return safetyMargin;\n }\n // common cases are\n // duration is 60 seconds, this will return a 1 second safety margin\n // duration is 43200 seconds, this will return a 300 second (5 minutes) safety margin\n return Math.min(Math.max(duration / 100, 1), DEFAULT_SAFETY_MARGIN);\n}\n","import {\n BaseSession,\n IBasemapSessionParams,\n IStartSessionParams\n} from \"./BaseSession.js\";\nimport { DEFAULT_START_BASEMAP_STYLE_SESSION_URL } from \"./utils/defaults.js\";\n\n/**\n * `BasemapStyleSession` is a class that extends {@linkcode BaseSession} to manage sessions\n * for basemap styles. It provides methods to {@linkcode BasemapStyleSession.start} a new session\n * which should be used instead of constructing a new instance directly.\n *\n * @class BasemapStyleSession\n * @extends BaseSession\n */\nexport class BasemapStyleSession extends BaseSession {\n /**\n * Creates an instance of `BasemapStyleSession`. Constructing `BasemapStyleSession` directly is discouraged.\n * Instead, use the static method {@linkcode BasemapStyleSession.start} to start a new session.\n */\n constructor(params: IBasemapSessionParams) {\n super(params);\n }\n\n /**\n * Starts a new basemap style session.\n */\n static async start(params: IStartSessionParams) {\n return BaseSession.startSession<BasemapStyleSession>(\n {\n ...params,\n startSessionUrl:\n params?.startSessionUrl || DEFAULT_START_BASEMAP_STYLE_SESSION_URL\n },\n BasemapStyleSession as new (\n params: IBasemapSessionParams\n ) => BasemapStyleSession\n );\n }\n}\n"],"names":["DEFAULT_START_BASEMAP_STYLE_SESSION_URL","DEFAULT_SAFETY_MARGIN","DEFAULT_CHECK_EXPIRATION_INTERVAL","DEFAULT_DURATION","startNewSession","startSessionUrl","authentication","styleFamily","duration","request","httpMethod","params","durationSeconds","BaseSession","constructor","n","this","token","startTime","endTime","expires","safetyMargin","expirationCheckInterval","Math","min","emitter","all","Map","on","t","e","i","get","push","set","off","splice","indexOf","emit","slice","map","isSessionExpired","isExpired","startCheckingExpirationTime","check","expirationTimerId","setInterval","setTimeout","stopCheckingExpirationTime","clearInterval","checkingExpirationTime","static","autoRefresh","SessionClass","sessionResponse","actualSafetyMargin","max","determineSafetyMargin","session","sessionToken","Date","startAutoRefresh","getToken","refreshCredentials","then","Promise","resolve","canRefresh","autoRefreshHandler","async","previous","JSON","parse","stringify","newSession","setToken","setStartTime","setEndTime","setExpires","current","error","catch","stopAutoRefresh","eventName","handler","once","fn","BasemapStyleSession","super","startSession"],"mappings":";;;;;0DAAaA,EACX,qFAEWC,EAAwB,IAExBC,EAAoC,GAEpCC,EAAmB,eCWhBC,GAAgBC,gBAC9BA,EAAeC,eACfA,EAAcC,YACdA,EAAc,SAAQC,SACtBA,EAAWL,QAEX,OAAOM,EAAQJ,EAAiB,CAC9BK,WAAY,MACZJ,eAAgBA,EAChBK,OAAQ,CAAEJ,cAAaK,gBAAiBJ,IAE5C,OCkBsBK,EAmJpBC,YAAYH,GClMC,IAASI,EDsKdC,uBAAyB,KAUzBA,wBAA0C,KAmBhDA,KAAKX,gBAAkBM,EAAON,gBAC9BW,KAAKC,MAAQN,EAAOM,MACpBD,KAAKT,YAAcI,EAAOJ,aAAe,SACzCS,KAAKV,eAAiBK,EAAOL,eAC7BU,KAAKR,SAAWG,EAAOH,UAAYL,EACnCa,KAAKE,UAAYP,EAAOO,UACxBF,KAAKG,QAAUR,EAAOQ,QACtBH,KAAKI,QAAUT,EAAOS,QACtBJ,KAAKK,aAAeV,EAAOU,aAC3BL,KAAKM,wBACgE,IAAnEC,KAAKC,IAAIR,KAAKR,SAAW,IFxMkB,IEyM7CQ,KAAKS,QC9MwB,CAACC,IAAIX,EAAEA,GAAG,IAAIY,IAAIC,GAAG,SAASC,EAAEC,GAAG,IAAIC,EAAEhB,EAAEiB,IAAIH,GAAGE,EAAEA,EAAEE,KAAKH,GAAGf,EAAEmB,IAAIL,EAAE,CAACC,GAAG,EAAEK,IAAI,SAASN,EAAEC,GAAG,IAAIC,EAAEhB,EAAEiB,IAAIH,GAAGE,IAAID,EAAEC,EAAEK,OAAOL,EAAEM,QAAQP,KAAK,EAAE,GAAGf,EAAEmB,IAAIL,EAAE,IAAI,EAAES,KAAK,SAAST,EAAEC,GAAG,IAAIC,EAAEhB,EAAEiB,IAAIH,GAAGE,GAAGA,EAAEQ,QAAQC,KAAI,SAASzB,GAAGA,EAAEe,EAAE,KAAIC,EAAEhB,EAAEiB,IAAI,OAAOD,EAAEQ,QAAQC,KAAI,SAASzB,GAAGA,EAAEc,EAAEC,EAAE,GAAE,GDsNrTW,mBASE,OARIzB,KAAK0B,WACP1B,KAAKS,QAAQa,KAAK,UAAW,CAC3BrB,MAAOD,KAAKC,MACZC,UAAWF,KAAKE,UAChBC,QAASH,KAAKG,QACdC,QAASJ,KAAKI,UAGXJ,KAAK0B,UAOdC,8BACE,MAAMC,EAAQ,KACZ5B,KAAKyB,kBAAkB,EAezB,OAZKzB,KAAK6B,oBACR7B,KAAK6B,kBAAoBC,YACvBF,EAEA5B,KAAKM,0BAITyB,YAAW,KACTH,GAAO,GACN,IAEI5B,KAAK6B,kBAMdG,6BACMhC,KAAK6B,oBACPI,cAAcjC,KAAK6B,mBACnB7B,KAAK6B,kBAAoB,MASzBK,6BACF,QAASlC,KAAK6B,kBAUNM,2BACR9C,gBACEA,EAAeE,YACfA,EAAc,SAAQD,eACtBA,EAAce,aACdA,EAAYb,SACZA,EAAWL,MAAgBiD,YAC3BA,GAAc,GAShBC,GAEA,MAAMC,QAAwBlD,EAAgB,CAC5CC,kBACAE,cACAD,iBACAE,aAEI+C,WEzSR/C,EACAa,GAEA,OAAIA,GAMGE,KAAKC,IAAID,KAAKiC,IAAIhD,EAAW,IAAK,GJTN,IIUrC,CF+R+BiD,CAAsBjD,EAAUa,GAErDqC,EAAU,IAAIL,EAAa,CAC/BhD,gBAAiBA,EACjBY,MAAOqC,EAAgBK,aACvBpD,cACAD,iBACAe,aAAckC,EACdnC,QAAS,IAAIwC,KAAKN,EAAgBnC,QAA+B,IAArBoC,GAC5CrC,UAAW,IAAI0C,KAAKN,EAAgBpC,WACpCC,QAAS,IAAIyC,KAAKN,EAAgBnC,SAClCX,aASF,OANAkD,EAAQf,8BAEJS,GACFM,EAAQG,mBAGHH,EAOLhB,gBACF,OAAO1B,KAAKI,QAAU,IAAIwC,KAQ5BE,WACE,OAAI9C,KAAK0B,UACA1B,KAAK+C,qBAAqBC,MAAK,IAAMhD,KAAKC,QAG5CgD,QAAQC,QAAQlD,KAAKC,OAQ1BkD,iBACF,OAAO,EAQLf,kBACF,QAASpC,KAAKoD,sBAAwBpD,KAAK6B,kBAS7CwB,2BAEE,MAAMC,EAAWC,KAAKC,MACpBD,KAAKE,UAAU,CACbxD,MAAOD,KAAKC,MACZC,UAAWF,KAAKE,UAChBC,QAASH,KAAKG,QACdC,QAASJ,KAAKI,WAIlB,IACE,MAAMsD,QAAmBtE,EAAgB,CACvCC,gBAAiBW,KAAKX,gBACtBE,YAAaS,KAAKT,YAClBD,eAAgBU,KAAKV,eACrBE,SAAUQ,KAAKR,WAGjBQ,KAAK2D,SAASD,EAAWf,cACzB3C,KAAK4D,aAAa,IAAIhB,KAAKc,EAAWxD,YACtCF,KAAK6D,WAAW,IAAIjB,KAAKc,EAAWvD,UACpCH,KAAK8D,WAAW,IAAIlB,KAAKc,EAAWvD,QAA8B,IAApBH,KAAKK,eAEnDL,KAAKS,QAAQa,KAAK,YAAa,CAC7BgC,SAAU,CACRrD,MAAOqD,EAASrD,MAChBC,UAAW,IAAI0C,KAAKU,EAASpD,WAC7BC,QAAS,IAAIyC,KAAKU,EAASnD,SAC3BC,QAAS,IAAIwC,KAAKU,EAASlD,UAE7B2D,QAAS,CACP9D,MAAOD,KAAKC,MACZC,UAAWF,KAAKE,UAChBC,QAASH,KAAKG,QACdC,QAASJ,KAAKI,WAGlB,MAAO4D,GAEP,MADAhE,KAAKS,QAAQa,KAAK,QAAS0C,GACrBA,EAGR,OAAOhE,KAMT6C,mBACO7C,KAAK6B,mBACR7B,KAAK2B,8BAGP3B,KAAKoD,mBAAqB,KACxBpD,KAAK+C,qBAAqBkB,OAAOD,IAC/BhE,KAAKS,QAAQa,KAAK,QAAS0C,EAAM,GACjC,EAGJhE,KAAKY,GAAG,UAAWZ,KAAKoD,oBAQ1Bc,kBACMlE,KAAKoD,qBACPpD,KAAKmB,IAAI,UAAWnB,KAAKoD,oBACzBpD,KAAKoD,mBAAqB,MAa9BxC,GACEuD,EACAC,GAKApE,KAAKS,QAAQG,GAAGuD,EAAWC,GAC3BpE,KAAKyB,mBAYP4C,KACEF,EACAC,GAKA,MAAME,EAAMxD,IACVd,KAAKS,QAAQU,IAAIgD,EAAWG,GAC5BF,EAAQtD,EAAE,EAGZd,KAAKS,QAAQG,GAAGuD,EAAWG,GAY7BnD,IACEgD,EACAC,GAKApE,KAAKS,QAAQU,IAAIgD,EAAWC,GAMtBT,SAAS1D,GACdD,KAA+BC,MAAQA,EAElC2D,aAAa1D,GAClBF,KAA+BE,UAAYA,EAEtC2D,WAAW1D,GAChBH,KAA+BG,QAAUA,EAEpC2D,WAAW1D,GAChBJ,KAA+BI,QAAUA;uCAld5BP,QAAQ,SAAeiB;;AAcvBjB,UAAU,SAAiBiB;;AAyB3BjB,YAAY,SAAmBiB,WG7EpCyD,UAA4B1E,EAKvCC,YAAYH,GACV6E,MAAM7E,GAMRwC,mBAAmBxC,GACjB,OAAOE,EAAY4E,4CAEZ9E,IACHN,iBACEM,eAAAA,EAAQN,kBAAmBL,IAE/BuF"}
|
|
1
|
+
{"version":3,"file":"basemap-sessions.esm.min.js","sources":["../../src/utils/defaults.ts","../../src/utils/startNewSession.ts","../../src/BaseSession.ts","../../node_modules/mitt/dist/mitt.mjs","../../src/utils/detemineSafetyMargin.ts","../../src/BasemapStyleSession.ts"],"sourcesContent":["export const DEFAULT_START_BASEMAP_STYLE_SESSION_URL =\n \"https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/sessions/start\";\n\nexport const DEFAULT_SAFETY_MARGIN = 5 * 60; // Default to 5 minutes in seconds\n\nexport const DEFAULT_CHECK_EXPIRATION_INTERVAL = 10; // Default to 10 seconds\n\nexport const DEFAULT_DURATION = 12 * 60 * 60; // Default to 12 hours in seconds\n","import { IAuthenticationManager, request } from \"@esri/arcgis-rest-request\";\nimport { StyleFamily } from \"../types/StyleFamily.js\";\nimport { DEFAULT_DURATION } from \"./defaults.js\";\n\nexport interface IRequestNewSessionParams {\n startSessionUrl: string;\n authentication: IAuthenticationManager | string;\n styleFamily?: StyleFamily;\n duration?: number;\n}\n\nexport interface IStartSessionResponse {\n sessionToken: string;\n endTime: number;\n startTime: number;\n styleFamily: StyleFamily;\n}\n\nexport function startNewSession({\n startSessionUrl,\n authentication,\n styleFamily = \"arcgis\",\n duration = DEFAULT_DURATION\n}: IRequestNewSessionParams): Promise<IStartSessionResponse> {\n return request(startSessionUrl, {\n httpMethod: \"GET\",\n authentication: authentication,\n params: { styleFamily, durationSeconds: duration }\n });\n}\n","import mitt from \"mitt\";\n\nimport { IAuthenticationManager } from \"@esri/arcgis-rest-request\";\nimport { StyleFamily } from \"./types/StyleFamily.js\";\nimport {\n IStartSessionResponse,\n startNewSession\n} from \"./utils/startNewSession.js\";\nimport { Writable } from \"./utils/writable.js\";\nimport { determineSafetyMargin } from \"./utils/detemineSafetyMargin.js\";\nimport {\n DEFAULT_DURATION,\n DEFAULT_CHECK_EXPIRATION_INTERVAL\n} from \"./utils/defaults.js\";\n\nexport interface IBasemapSessionParams {\n token: string;\n startSessionUrl: string;\n styleFamily: StyleFamily;\n authentication: IAuthenticationManager | string;\n expires: Date;\n startTime: Date;\n endTime: Date;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n}\n\nexport interface IStartSessionParams {\n styleFamily?: StyleFamily;\n authentication: IAuthenticationManager | string;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n\n /**\n * The URL to start the session. If not provided, it will use the default URL.\n * @private\n */\n startSessionUrl?: string;\n}\n\n/**\n * The base class for all basemap sessions. This class implements the {@linkcode IAuthenticationManager} interface and provides methods to start, refresh, and check the expiration of a session.\n * This is not intended to be used directly, but instead is extended by other classes such as {@linkcode BasemapStyleSession} and {@linkcode StaticBasemapTilesSession}.\n *\n * @abstract\n * @implements {IAuthenticationManager}\n */\nexport abstract class BaseSession implements IAuthenticationManager {\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when an error occurs during session management.\n */\n static readonly error = function error(e: Error): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when the current session expires and the session token it no longer valid. This event will only fire if {@linkcode BaseSession.checkingExpirationTime}\n * is `true` which is the default. Once this event fires, {@linkcode BaseSession.checkingExpirationTime} will be set to `false` until the session is refreshed with\n * {@linkcode BaseSession.refreshCredentials}.\n *\n * @event expired\n * @param e - The parameters for the expired event.\n * @param e.token - The session token that expired.\n * @param e.startTime - The start time of the session.\n * @param e.endTime - The end time of the session.\n * @param e.expires - The expiration time of the session.\n */\n static readonly expired = function expired(e: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n }): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n // the static methods for event handlers are used to provide doc via typedoc and do not need to be tested.\n /* istanbul ignore next -- @preserve */\n /**\n * Event handler for when a session refreshes and a new `token` is available.\n *\n * @event refreshed\n * @param e. - The parameters for the refreshed event.\n * @param e.previous - The previous session details.\n * @param e.previous.token - The previous session token.\n * @param e.previous.startTime - The start time of the previous session.\n * @param e.previous.endTime - The end time of the previous session.\n * @param e.previous.expires - The expiration time of the previous session.\n * @param e.current - The current session details.\n * @param e.current.token - The current session token.\n * @param e.current.startTime - The start time of the current token.\n * @param e.current.endTime - The end time of the current session.\n * @param e.current.expires - The expiration time of the current token.\n */\n static readonly refreshed = function refreshed(e: {\n previous: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n };\n current: {\n token: string;\n startTime: Date;\n endTime: Date;\n expires: Date;\n };\n }): void {}; // eslint-disable-line @typescript-eslint/no-empty-function\n\n /**\n * The portal URL that the session is associated with. This generally is not used but exists to implement the `IAuthenticationManager` interface.\n */\n readonly portal: string;\n\n /**\n * The style family of the session. This is used to determine the type of basemap styles that are available.\n */\n readonly styleFamily: StyleFamily;\n\n /**\n * The authentication manager or token used for the session.\n * This can be an instance of {@linkcode ApiKeyManager}, {@linkcode ArcGISIdentityManager}, {@linkcode ApplicationCredentialsManager} or a string token.\n */\n readonly authentication: IAuthenticationManager | string;\n\n /**\n * The expiration date of the session. This is the {@linkcode BaseSession.endTime} minus the {@linkcode BaseSession.safetyMargin}. This is used internally to determine if the session is expired.\n */\n readonly expires: Date;\n\n /**\n * The start time of the session. This is the time returned from the API when the session war started.\n */\n readonly startTime: Date;\n\n /**\n * The end time of the session. This is the time returned from the API when the session will end.\n */\n readonly endTime: Date;\n\n /**\n * The token for the session.\n */\n readonly token: string;\n\n /**\n * The URL used to start the session.\n */\n readonly startSessionUrl: string;\n\n /**\n * The safety margin in milliseconds. This subtracted from the {@linkcode BaseSession.endTime} to get the {@linkcode BaseSession.expiration}.\n */\n readonly safetyMargin: number;\n\n /**\n * The duration of the session in seconds. This is used to determine how long the session will last when the session is refreshed.\n */\n readonly duration: number;\n\n /**\n * The interval at which to check the expiration time of the session. This is always 10 seconds or 1/100th of the duration, whichever is smaller.\n */\n private readonly expirationCheckInterval: number;\n\n /**\n * The ID of the timer used to check the expiration time of the session.\n */\n private expirationTimerId: any = null;\n\n /**\n * A pending session that is being refreshed. This is used to prevent multiple refreshes from happening at the same time.\n */\n private pendingSession: Promise<IStartSessionResponse> | null = null;\n\n /**\n * Internal instance of [`mitt`](https://github.com/developit/mitt) used for event handlers. It is recommended to use {@linkcode BasemapSession.on}, {@linkcode BasemapSession.off} or {@linkcode BasemapSession.once} instead of `emitter.`\n */\n private emitter: any;\n\n /**\n * A handler that is used to automatically refresh the session when it expires.\n */\n private autoRefreshHandler: (() => void) | null = null;\n\n /**\n * Creates a new instance of the BaseSession class. Generally you should not create an instance of this class directly, but instead use the static methods to start a session or deserialize a session.\n *\n * You may need to create an instance of this class directly if you are not using the built in deserialize method.\n *\n * @param params - The parameters for the session.\n * @param params.startSessionUrl - The URL to start the session.\n * @param params.token - The token for the session.\n * @param params.styleFamily - The style family of the session.\n * @param params.authentication - The authentication manager or token used for the session.\n * @param params.expires - The expiration date of the session.\n * @param params.startTime - The start time of the session.\n * @param params.endTime - The end time of the session.\n * @param params.safetyMargin - The safety margin in milliseconds.\n * @param params.duration - Indicates if this is a test session.\n */\n constructor(params: IBasemapSessionParams) {\n this.startSessionUrl = params.startSessionUrl;\n this.token = params.token;\n this.styleFamily = params.styleFamily || \"arcgis\";\n this.authentication = params.authentication;\n this.duration = params.duration || DEFAULT_DURATION;\n this.startTime = params.startTime;\n this.endTime = params.endTime;\n this.expires = params.expires;\n this.safetyMargin = params.safetyMargin;\n this.expirationCheckInterval =\n Math.min(this.duration / 100, DEFAULT_CHECK_EXPIRATION_INTERVAL) * 1000;\n this.emitter = mitt();\n }\n\n /**\n * Checks if the session is expired. If it is expired, it emits an \"expired\" event and disables expiration time checking. The event will fire **before** the method returns true.\n *\n * @returns {boolean} - Returns true if the session is expired, otherwise false.\n */\n isSessionExpired() {\n if (this.isExpired) {\n this.disableCheckingExpirationTime();\n\n this.emitter.emit(\"expired\", {\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n });\n }\n\n return this.isExpired;\n }\n\n /**\n * Starts checking the expiration time of the session. This will check the expiration time immediately and then on an interval.\n * If the session is expired, it will emit an \"expired\" event.\n */\n enableCheckingExpirationTime() {\n const check = () => {\n this.isSessionExpired();\n };\n\n if (!this.expirationTimerId) {\n this.expirationTimerId = setInterval(\n check,\n // check every 10 seconds or 1/100th of the duration, whichever is smaller\n this.expirationCheckInterval\n ); // check immediately then on an interval\n }\n\n setTimeout(() => {\n check(); // check immediately after starting the interval\n }, 10);\n\n return this.expirationTimerId; // return the timer ID so it can be stopped later\n }\n\n /**\n * Stops checking the expiration time of the session. This will clear the interval that was set by {@linkcode BaseSession.startCheckingExpirationTime}.\n */\n disableCheckingExpirationTime() {\n if (this.expirationTimerId) {\n clearInterval(this.expirationTimerId);\n this.expirationTimerId = null;\n }\n }\n\n /**\n * Starts a new session using the provided parameters and returns an instance of the session class.\n *\n * @param params - The parameters for starting the session.\n * @param SessionClass - The class to use for the session.\n * @returns A promise that resolves to an instance of the session class.\n */\n protected static async startSession<T extends BaseSession>(\n {\n startSessionUrl,\n styleFamily = \"arcgis\",\n authentication,\n safetyMargin,\n duration = DEFAULT_DURATION,\n autoRefresh = false\n }: {\n startSessionUrl?: string;\n styleFamily?: StyleFamily;\n authentication: IAuthenticationManager | string;\n safetyMargin?: number;\n duration?: number;\n autoRefresh?: boolean;\n },\n SessionClass: new (params: IBasemapSessionParams) => T\n ): Promise<T> {\n if (duration < 10) {\n throw new Error(\"Session duration must be at least 10 seconds.\");\n }\n\n if (duration > 43200) {\n throw new Error(\n \"Session duration cannot exceed 12 hours (43200 seconds).\"\n );\n }\n\n const sessionResponse = await startNewSession({\n startSessionUrl,\n styleFamily,\n authentication,\n duration\n });\n const actualSafetyMargin = determineSafetyMargin(duration, safetyMargin);\n\n const session = new SessionClass({\n startSessionUrl: startSessionUrl,\n token: sessionResponse.sessionToken,\n styleFamily,\n authentication,\n safetyMargin: actualSafetyMargin,\n expires: new Date(sessionResponse.endTime - actualSafetyMargin * 1000),\n startTime: new Date(sessionResponse.startTime),\n endTime: new Date(sessionResponse.endTime),\n duration\n });\n\n session.enableCheckingExpirationTime();\n\n if (autoRefresh) {\n session.enableAutoRefresh();\n }\n\n return session as T;\n }\n\n /**\n * Indicates if the session is currently checking for expiration time.\n *\n * @returns {boolean} - Returns true if the session is checking for expiration time, otherwise false.\n */\n get checkingExpirationTime(): boolean {\n return !!this.expirationTimerId;\n }\n\n /**\n * Returns the number of seconds until the session is no longer valid rounded down. If the session is expired, it will return 0.\n */\n get secondsUntilExpiration(): number {\n return Math.floor(this.millisecondsUntilExpiration / 1000);\n }\n\n /**\n * Returns the number of milliseconds until the session token is no longer valid. If the session is expired, it will return 0.\n */\n get millisecondsUntilExpiration(): number {\n if (this.isExpired) {\n return 0;\n }\n\n const now = new Date();\n const millisecondsLeft = this.endTime.getTime() - now.getTime();\n\n return millisecondsLeft;\n }\n\n /**\n * Checks if the session is expired.\n *\n */\n get isExpired(): boolean {\n return this.expires < new Date();\n }\n\n /**\n * Gets the session token. If the session is expired, it will refresh the credentials and return the new token.\n *\n * @returns A promise that resolves to the session token.\n */\n getToken(): Promise<string> {\n if (this.isExpired) {\n return this.refreshCredentials().then(() => this.token);\n }\n\n return Promise.resolve(this.token);\n }\n\n /**\n * Indicates if the session can be refreshed. This is always true for this basemap sessions.\n *\n * @returns {boolean} - Always returns true.\n */\n get canRefresh(): boolean {\n return true;\n }\n\n /**\n * Indicates if the session is set to automatically refresh when it expires.\n *\n * @returns {boolean} - Returns true if auto-refresh is enabled, otherwise false.\n */\n get autoRefresh(): boolean {\n return !!this.autoRefreshHandler && !!this.expirationTimerId;\n }\n\n /**\n * Refreshes the session credentials by starting a new session.\n * This will emit a \"refreshed\" event with the previous and current session details.\n *\n * @returns A promise that resolves to the current instance of the session.\n */\n async refreshCredentials(): Promise<this> {\n if (this.pendingSession) {\n // if there is a pending session, wait for it to resolve\n await this.pendingSession;\n return this;\n }\n\n // @TODO switch this to structured clone when we upgrade to Node 20+ types so we don't have to parse the dates later\n const previous = JSON.parse(\n JSON.stringify({\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n })\n );\n\n try {\n this.pendingSession = startNewSession({\n startSessionUrl: this.startSessionUrl,\n styleFamily: this.styleFamily,\n authentication: this.authentication,\n duration: this.duration\n });\n\n const newSession = await this.pendingSession;\n\n this.pendingSession = null; // reset the pending session\n\n this.setToken(newSession.sessionToken);\n this.setStartTime(new Date(newSession.startTime));\n this.setEndTime(new Date(newSession.endTime));\n this.setExpires(new Date(newSession.endTime - this.safetyMargin * 1000));\n\n this.enableCheckingExpirationTime(); // restart checking expiration time after refreshing credentials\n\n this.emitter.emit(\"refreshed\", {\n previous: {\n token: previous.token,\n startTime: new Date(previous.startTime),\n endTime: new Date(previous.endTime),\n expires: new Date(previous.expires)\n },\n current: {\n token: this.token,\n startTime: this.startTime,\n endTime: this.endTime,\n expires: this.expires\n }\n });\n } catch (error) {\n this.emitter.emit(\"error\", error);\n throw error;\n }\n\n return this;\n }\n /**\n * Enables auto-refresh for the session. This will automatically refresh the session when it expires.\n * It will also start checking the expiration time of the session if it is not already started via {@linkcode BaseSession.enableCheckingExpirationTime}.\n */\n enableAutoRefresh() {\n if (!this.expirationTimerId) {\n this.enableCheckingExpirationTime();\n }\n\n this.autoRefreshHandler = () => {\n this.refreshCredentials().catch((error: Error) => {\n this.emitter.emit(\"error\", error);\n });\n };\n\n this.on(\"expired\", this.autoRefreshHandler);\n }\n\n /**\n * Disables auto-refresh for the session. This will stop automatically refreshing the session when it expires.\n * This will **not** stop checking the expiration time of the session. If you want to stop automated expiration\n * checking, call {@linkcode BaseSession.disableCheckingExpirationTime} after calling this method.\n */\n disableAutoRefresh() {\n if (this.autoRefreshHandler) {\n this.off(\"expired\", this.autoRefreshHandler);\n this.autoRefreshHandler = null;\n }\n }\n\n /**\n * Removes all event listeners and disables auto-refresh and expiration time checking. This is useful for cleaning up the session when it is no longer needed or replaced with a new session.\n */\n destroy() {\n this.disableAutoRefresh();\n this.disableCheckingExpirationTime();\n this.emitter.off(\"expired\");\n this.emitter.off(\"refreshed\");\n this.emitter.off(\"error\");\n this.emitter.off(\"*\");\n }\n\n /**\n * A handler that listens for an eventName and returns custom handler.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n on(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n on(event: \"expired\", handler: typeof BaseSession.expired): void;\n on(event: \"error\", handler: typeof BaseSession.error): void;\n on(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n this.emitter.on(eventName, handler);\n this.isSessionExpired(); // check if the session is expired immediately after adding the handler\n }\n\n /**\n * A handler that listens for an event once and returns a custom handler. Events listened to with this method cannot be removed with {@linkcode BasemapSession.off}.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n once(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n once(event: \"expired\", handler: typeof BaseSession.expired): void;\n once(event: \"error\", handler: typeof BaseSession.error): void;\n once(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n const fn = (e: any) => {\n this.emitter.off(eventName, fn);\n handler(e);\n };\n\n this.emitter.on(eventName, fn);\n }\n\n /**\n * A handler that will remove a listener from a given event.\n *\n * @param eventName A string of what event to listen for.\n * @param handler A function of what to do when eventName was called.\n */\n off(event: \"refreshed\", handler: typeof BaseSession.refreshed): void;\n off(event: \"expired\", handler: typeof BaseSession.expired): void;\n off(event: \"error\", handler: typeof BaseSession.error): void;\n off(\n eventName: string,\n handler:\n | typeof BaseSession.refreshed\n | typeof BaseSession.expired\n | typeof BaseSession.error\n ) {\n this.emitter.off(eventName, handler);\n }\n\n /**\n * These private methods are used to set the internal state of the session.\n */\n private setToken(token: string) {\n (this as Writable<typeof this>).token = token;\n }\n private setStartTime(startTime: Date) {\n (this as Writable<typeof this>).startTime = startTime;\n }\n private setEndTime(endTime: Date) {\n (this as Writable<typeof this>).endTime = endTime;\n }\n private setExpires(expires: Date) {\n (this as Writable<typeof this>).expires = expires;\n }\n}\n","export default function(n){return{all:n=n||new Map,on:function(t,e){var i=n.get(t);i?i.push(e):n.set(t,[e])},off:function(t,e){var i=n.get(t);i&&(e?i.splice(i.indexOf(e)>>>0,1):n.set(t,[]))},emit:function(t,e){var i=n.get(t);i&&i.slice().map(function(n){n(e)}),(i=n.get(\"*\"))&&i.slice().map(function(n){n(t,e)})}}}\n//# sourceMappingURL=mitt.mjs.map\n","import { DEFAULT_SAFETY_MARGIN } from \"./defaults.js\";\n\nexport function determineSafetyMargin(\n duration: number | undefined,\n safetyMargin: number | undefined\n): number {\n if (safetyMargin) {\n return safetyMargin;\n }\n\n // common cases are\n // duration is 60 seconds, this will return a 1 second safety margin\n // duration is 43200 seconds, this will return a 300 second (5 minutes) safety margin\n return Math.min(Math.max(duration / 100, 1), DEFAULT_SAFETY_MARGIN);\n}\n","import {\n BaseSession,\n IBasemapSessionParams,\n IStartSessionParams\n} from \"./BaseSession.js\";\nimport { DEFAULT_START_BASEMAP_STYLE_SESSION_URL } from \"./utils/defaults.js\";\n\n/**\n * `BasemapStyleSession` is a class that extends {@linkcode BaseSession} to manage sessions\n * for basemap styles. It provides methods to {@linkcode BasemapStyleSession.start} a new session\n * which should be used instead of constructing a new instance directly.\n *\n * @class BasemapStyleSession\n * @extends BaseSession\n */\nexport class BasemapStyleSession extends BaseSession {\n /**\n * Creates an instance of `BasemapStyleSession`. Constructing `BasemapStyleSession` directly is discouraged.\n * Instead, use the static method {@linkcode BasemapStyleSession.start} to start a new session.\n */\n constructor(params: IBasemapSessionParams) {\n super(params);\n }\n\n /**\n * Starts a new basemap style session.\n */\n static async start(params: IStartSessionParams) {\n return BaseSession.startSession<BasemapStyleSession>(\n {\n ...params,\n startSessionUrl:\n params?.startSessionUrl || DEFAULT_START_BASEMAP_STYLE_SESSION_URL\n },\n BasemapStyleSession as new (\n params: IBasemapSessionParams\n ) => BasemapStyleSession\n );\n }\n}\n"],"names":["DEFAULT_START_BASEMAP_STYLE_SESSION_URL","DEFAULT_SAFETY_MARGIN","DEFAULT_CHECK_EXPIRATION_INTERVAL","DEFAULT_DURATION","startNewSession","startSessionUrl","authentication","styleFamily","duration","request","httpMethod","params","durationSeconds","BaseSession","constructor","n","this","token","startTime","endTime","expires","safetyMargin","expirationCheckInterval","Math","min","emitter","all","Map","on","t","e","i","get","push","set","off","splice","indexOf","emit","slice","map","isSessionExpired","isExpired","disableCheckingExpirationTime","enableCheckingExpirationTime","check","expirationTimerId","setInterval","setTimeout","clearInterval","static","autoRefresh","SessionClass","Error","sessionResponse","actualSafetyMargin","max","determineSafetyMargin","session","sessionToken","Date","enableAutoRefresh","checkingExpirationTime","secondsUntilExpiration","floor","millisecondsUntilExpiration","now","getTime","getToken","refreshCredentials","then","Promise","resolve","canRefresh","autoRefreshHandler","async","pendingSession","previous","JSON","parse","stringify","newSession","setToken","setStartTime","setEndTime","setExpires","current","error","catch","disableAutoRefresh","destroy","eventName","handler","once","fn","BasemapStyleSession","super","startSession"],"mappings":";;;;;0DAAaA,EACX,qFAEWC,EAAwB,IAExBC,EAAoC,GAEpCC,EAAmB,eCWhBC,GAAgBC,gBAC9BA,EAAeC,eACfA,EAAcC,YACdA,EAAc,SAAQC,SACtBA,EAAWL,QAEX,OAAOM,EAAQJ,EAAiB,CAC9BK,WAAY,MACZJ,eAAgBA,EAChBK,OAAQ,CAAEJ,cAAaK,gBAAiBJ,IAE5C,OCoBsBK,EA0JpBC,YAAYH,GC3MC,IAASI,ED0KdC,uBAAyB,KAKzBA,oBAAwD,KAUxDA,wBAA0C,KAmBhDA,KAAKX,gBAAkBM,EAAON,gBAC9BW,KAAKC,MAAQN,EAAOM,MACpBD,KAAKT,YAAcI,EAAOJ,aAAe,SACzCS,KAAKV,eAAiBK,EAAOL,eAC7BU,KAAKR,SAAWG,EAAOH,UAAYL,EACnCa,KAAKE,UAAYP,EAAOO,UACxBF,KAAKG,QAAUR,EAAOQ,QACtBH,KAAKI,QAAUT,EAAOS,QACtBJ,KAAKK,aAAeV,EAAOU,aAC3BL,KAAKM,wBACgE,IAAnEC,KAAKC,IAAIR,KAAKR,SAAW,IFjNkB,IEkN7CQ,KAAKS,QCvNwB,CAACC,IAAIX,EAAEA,GAAG,IAAIY,IAAIC,GAAG,SAASC,EAAEC,GAAG,IAAIC,EAAEhB,EAAEiB,IAAIH,GAAGE,EAAEA,EAAEE,KAAKH,GAAGf,EAAEmB,IAAIL,EAAE,CAACC,GAAG,EAAEK,IAAI,SAASN,EAAEC,GAAG,IAAIC,EAAEhB,EAAEiB,IAAIH,GAAGE,IAAID,EAAEC,EAAEK,OAAOL,EAAEM,QAAQP,KAAK,EAAE,GAAGf,EAAEmB,IAAIL,EAAE,IAAI,EAAES,KAAK,SAAST,EAAEC,GAAG,IAAIC,EAAEhB,EAAEiB,IAAIH,GAAGE,GAAGA,EAAEQ,QAAQC,KAAI,SAASzB,GAAGA,EAAEe,EAAE,KAAIC,EAAEhB,EAAEiB,IAAI,OAAOD,EAAEQ,QAAQC,KAAI,SAASzB,GAAGA,EAAEc,EAAEC,EAAE,GAAE,GD+NrTW,mBAYE,OAXIzB,KAAK0B,YACP1B,KAAK2B,gCAEL3B,KAAKS,QAAQa,KAAK,UAAW,CAC3BrB,MAAOD,KAAKC,MACZC,UAAWF,KAAKE,UAChBC,QAASH,KAAKG,QACdC,QAASJ,KAAKI,WAIXJ,KAAK0B,UAOdE,+BACE,MAAMC,EAAQ,KACZ7B,KAAKyB,kBAAkB,EAezB,OAZKzB,KAAK8B,oBACR9B,KAAK8B,kBAAoBC,YACvBF,EAEA7B,KAAKM,0BAIT0B,YAAW,KACTH,GAAO,GACN,IAEI7B,KAAK8B,kBAMdH,gCACM3B,KAAK8B,oBACPG,cAAcjC,KAAK8B,mBACnB9B,KAAK8B,kBAAoB,MAWnBI,2BACR7C,gBACEA,EAAeE,YACfA,EAAc,SAAQD,eACtBA,EAAce,aACdA,EAAYb,SACZA,EAAWL,MAAgBgD,YAC3BA,GAAc,GAShBC,GAEA,GAAI5C,EAAW,GACb,MAAM,IAAI6C,MAAM,iDAGlB,GAAI7C,EAAW,MACb,MAAM,IAAI6C,MACR,4DAIJ,MAAMC,QAAwBlD,EAAgB,CAC5CC,kBACAE,cACAD,iBACAE,aAEI+C,WEtTR/C,EACAa,GAEA,OAAIA,GAOGE,KAAKC,IAAID,KAAKiC,IAAIhD,EAAW,IAAK,GJVN,IIWrC,CF2S+BiD,CAAsBjD,EAAUa,GAErDqC,EAAU,IAAIN,EAAa,CAC/B/C,gBAAiBA,EACjBY,MAAOqC,EAAgBK,aACvBpD,cACAD,iBACAe,aAAckC,EACdnC,QAAS,IAAIwC,KAAKN,EAAgBnC,QAA+B,IAArBoC,GAC5CrC,UAAW,IAAI0C,KAAKN,EAAgBpC,WACpCC,QAAS,IAAIyC,KAAKN,EAAgBnC,SAClCX,aASF,OANAkD,EAAQd,+BAEJO,GACFO,EAAQG,oBAGHH,EAQLI,6BACF,QAAS9C,KAAK8B,kBAMZiB,6BACF,OAAOxC,KAAKyC,MAAMhD,KAAKiD,4BAA8B,KAMnDA,kCACF,GAAIjD,KAAK0B,UACP,OAAO,EAGT,MAAMwB,EAAM,IAAIN,KAGhB,OAFyB5C,KAAKG,QAAQgD,UAAYD,EAAIC,UASpDzB,gBACF,OAAO1B,KAAKI,QAAU,IAAIwC,KAQ5BQ,WACE,OAAIpD,KAAK0B,UACA1B,KAAKqD,qBAAqBC,MAAK,IAAMtD,KAAKC,QAG5CsD,QAAQC,QAAQxD,KAAKC,OAQ1BwD,iBACF,OAAO,EAQLtB,kBACF,QAASnC,KAAK0D,sBAAwB1D,KAAK8B,kBAS7C6B,2BACE,GAAI3D,KAAK4D,eAGP,aADM5D,KAAK4D,eACJ5D,KAIT,MAAM6D,EAAWC,KAAKC,MACpBD,KAAKE,UAAU,CACb/D,MAAOD,KAAKC,MACZC,UAAWF,KAAKE,UAChBC,QAASH,KAAKG,QACdC,QAASJ,KAAKI,WAIlB,IACEJ,KAAK4D,eAAiBxE,EAAgB,CACpCC,gBAAiBW,KAAKX,gBACtBE,YAAaS,KAAKT,YAClBD,eAAgBU,KAAKV,eACrBE,SAAUQ,KAAKR,WAGjB,MAAMyE,QAAmBjE,KAAK4D,eAE9B5D,KAAK4D,eAAiB,KAEtB5D,KAAKkE,SAASD,EAAWtB,cACzB3C,KAAKmE,aAAa,IAAIvB,KAAKqB,EAAW/D,YACtCF,KAAKoE,WAAW,IAAIxB,KAAKqB,EAAW9D,UACpCH,KAAKqE,WAAW,IAAIzB,KAAKqB,EAAW9D,QAA8B,IAApBH,KAAKK,eAEnDL,KAAK4B,+BAEL5B,KAAKS,QAAQa,KAAK,YAAa,CAC7BuC,SAAU,CACR5D,MAAO4D,EAAS5D,MAChBC,UAAW,IAAI0C,KAAKiB,EAAS3D,WAC7BC,QAAS,IAAIyC,KAAKiB,EAAS1D,SAC3BC,QAAS,IAAIwC,KAAKiB,EAASzD,UAE7BkE,QAAS,CACPrE,MAAOD,KAAKC,MACZC,UAAWF,KAAKE,UAChBC,QAASH,KAAKG,QACdC,QAASJ,KAAKI,WAGlB,MAAOmE,GAEP,MADAvE,KAAKS,QAAQa,KAAK,QAASiD,GACrBA,EAGR,OAAOvE,KAMT6C,oBACO7C,KAAK8B,mBACR9B,KAAK4B,+BAGP5B,KAAK0D,mBAAqB,KACxB1D,KAAKqD,qBAAqBmB,OAAOD,IAC/BvE,KAAKS,QAAQa,KAAK,QAASiD,EAAM,GACjC,EAGJvE,KAAKY,GAAG,UAAWZ,KAAK0D,oBAQ1Be,qBACMzE,KAAK0D,qBACP1D,KAAKmB,IAAI,UAAWnB,KAAK0D,oBACzB1D,KAAK0D,mBAAqB,MAO9BgB,UACE1E,KAAKyE,qBACLzE,KAAK2B,gCACL3B,KAAKS,QAAQU,IAAI,WACjBnB,KAAKS,QAAQU,IAAI,aACjBnB,KAAKS,QAAQU,IAAI,SACjBnB,KAAKS,QAAQU,IAAI,KAYnBP,GACE+D,EACAC,GAKA5E,KAAKS,QAAQG,GAAG+D,EAAWC,GAC3B5E,KAAKyB,mBAYPoD,KACEF,EACAC,GAKA,MAAME,EAAMhE,IACVd,KAAKS,QAAQU,IAAIwD,EAAWG,GAC5BF,EAAQ9D,EAAE,EAGZd,KAAKS,QAAQG,GAAG+D,EAAWG,GAY7B3D,IACEwD,EACAC,GAKA5E,KAAKS,QAAQU,IAAIwD,EAAWC,GAMtBV,SAASjE,GACdD,KAA+BC,MAAQA,EAElCkE,aAAajE,GAClBF,KAA+BE,UAAYA,EAEtCkE,WAAWjE,GAChBH,KAA+BG,QAAUA,EAEpCkE,WAAWjE,GAChBJ,KAA+BI,QAAUA;uCAnhB5BP,QAAQ,SAAeiB;;AAgBvBjB,UAAU,SAAiBiB;;AAyB3BjB,YAAY,SAAmBiB,WGjFpCiE,UAA4BlF,EAKvCC,YAAYH,GACVqF,MAAMrF,GAMRuC,mBAAmBvC,GACjB,OAAOE,EAAYoF,4CAEZtF,IACHN,iBACEM,eAAAA,EAAQN,kBAAmBL,IAE/B+F"}
|