@esri/arcgis-rest-basemap-sessions 1.0.0

package/dist/esm/BasemapStyleSession.js

@@ -0,0 +1,26 @@
+import { BaseSession } from "./BaseSession.js";
+import { DEFAULT_START_BASEMAP_STYLE_SESSION_URL } from "./utils/defaults.js";
+/**
+ * `BasemapStyleSession` is a class that extends {@linkcode BaseSession} to manage sessions
+ * for basemap styles. It provides methods to {@linkcode BasemapStyleSession.start} a new session
+ * which should be used instead of constructing a new instance directly.
+ *
+ * @class BasemapStyleSession
+ * @extends BaseSession
+ */
+export class BasemapStyleSession extends BaseSession {
+    /**
+     * Creates an instance of `BasemapStyleSession`. Constructing `BasemapStyleSession` directly is discouraged.
+     * Instead, use the static method {@linkcode BasemapStyleSession.start} to start a new session.
+     */
+    constructor(params) {
+        super(params);
+    }
+    /**
+     * Starts a new basemap style session.
+     */
+    static async start(params) {
+        return BaseSession.startSession(Object.assign(Object.assign({}, params), { startSessionUrl: (params === null || params === void 0 ? void 0 : params.startSessionUrl) || DEFAULT_START_BASEMAP_STYLE_SESSION_URL }), BasemapStyleSession);
+    }
+}
+//# sourceMappingURL=BasemapStyleSession.js.map

package/dist/esm/BasemapStyleSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasemapStyleSession.js","sourceRoot":"","sources":["../../src/BasemapStyleSession.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAGZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,uCAAuC,EAAE,MAAM,qBAAqB,CAAC;AAE9E;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAClD;;;OAGG;IACH,YAAY,MAA6B;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,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;IACJ,CAAC;CACF","sourcesContent":["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"]}

package/dist/esm/StaticBasemapTilesSession.d.ts

@@ -0,0 +1,20 @@
+import { BaseSession, IBasemapSessionParams, IStartSessionParams } from "./BaseSession.js";
+/**
+ * `StaticBasemapTilesSession` is a class that extends {@linkcode BaseSession} to manage sessions
+ * for static basemap tiles. It provides methods to {@linkcode StaticBasemapTilesSession.start} a new session
+ * which should be used instead of constructing a new instance directly.
+ *
+ * @class StaticBasemapTilesSession
+ * @extends BaseSession
+ */
+export declare class StaticBasemapTilesSession extends BaseSession {
+    /**
+     * Creates an instance of `StaticBasemapTilesSession`. Constructing `StaticBasemapTilesSession` directly is discouraged.
+     * Instead, use the static method {@linkcode StaticBasemapTilesSession.start} to start a new session.`
+     */
+    constructor(params: IBasemapSessionParams);
+    /**
+     * Starts a new static basemap tiles session.
+     */
+    static start(params: IStartSessionParams): Promise<StaticBasemapTilesSession>;
+}

package/dist/esm/StaticBasemapTilesSession.js

@@ -0,0 +1,26 @@
+import { BaseSession } from "./BaseSession.js";
+import { DEFAULT_START_STATIC_BASEMAP_SESSION_URL } from "./utils/defaults.js";
+/**
+ * `StaticBasemapTilesSession` is a class that extends {@linkcode BaseSession} to manage sessions
+ * for static basemap tiles. It provides methods to {@linkcode StaticBasemapTilesSession.start} a new session
+ * which should be used instead of constructing a new instance directly.
+ *
+ * @class StaticBasemapTilesSession
+ * @extends BaseSession
+ */
+export class StaticBasemapTilesSession extends BaseSession {
+    /**
+     * Creates an instance of `StaticBasemapTilesSession`. Constructing `StaticBasemapTilesSession` directly is discouraged.
+     * Instead, use the static method {@linkcode StaticBasemapTilesSession.start} to start a new session.`
+     */
+    constructor(params) {
+        super(params);
+    }
+    /**
+     * Starts a new static basemap tiles session.
+     */
+    static async start(params) {
+        return BaseSession.startSession(Object.assign(Object.assign({}, params), { startSessionUrl: (params === null || params === void 0 ? void 0 : params.startSessionUrl) || DEFAULT_START_STATIC_BASEMAP_SESSION_URL }), StaticBasemapTilesSession);
+    }
+}
+//# sourceMappingURL=StaticBasemapTilesSession.js.map

package/dist/esm/StaticBasemapTilesSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StaticBasemapTilesSession.js","sourceRoot":"","sources":["../../src/StaticBasemapTilesSession.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAGZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,wCAAwC,EAAE,MAAM,qBAAqB,CAAC;AAE/E;;;;;;;GAOG;AACH,MAAM,OAAO,yBAA0B,SAAQ,WAAW;IACxD;;;OAGG;IACH,YAAY,MAA6B;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAChB,MAA2B;QAE3B,OAAO,WAAW,CAAC,YAAY,iCAExB,MAAM,KACT,eAAe,EACb,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,KAAI,wCAAwC,KAEvE,yBAE8B,CAC/B,CAAC;IACJ,CAAC;CACF","sourcesContent":["import {\n  BaseSession,\n  IBasemapSessionParams,\n  IStartSessionParams\n} from \"./BaseSession.js\";\nimport { DEFAULT_START_STATIC_BASEMAP_SESSION_URL } from \"./utils/defaults.js\";\n\n/**\n * `StaticBasemapTilesSession` is a class that extends {@linkcode BaseSession} to manage sessions\n * for static basemap tiles. It provides methods to {@linkcode StaticBasemapTilesSession.start} a new session\n * which should be used instead of constructing a new instance directly.\n *\n * @class StaticBasemapTilesSession\n * @extends BaseSession\n */\nexport class StaticBasemapTilesSession extends BaseSession {\n  /**\n   * Creates an instance of `StaticBasemapTilesSession`. Constructing `StaticBasemapTilesSession` directly is discouraged.\n   * Instead, use the static method {@linkcode StaticBasemapTilesSession.start} to start a new session.`\n   */\n  constructor(params: IBasemapSessionParams) {\n    super(params);\n  }\n\n  /**\n   * Starts a new static basemap tiles session.\n   */\n  static async start(\n    params: IStartSessionParams\n  ): Promise<StaticBasemapTilesSession> {\n    return BaseSession.startSession(\n      {\n        ...params,\n        startSessionUrl:\n          params?.startSessionUrl || DEFAULT_START_STATIC_BASEMAP_SESSION_URL\n      },\n      StaticBasemapTilesSession as new (\n        params: IBasemapSessionParams\n      ) => StaticBasemapTilesSession\n    );\n  }\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./BaseSession.js";
+export * from "./BasemapStyleSession.js";
+export * from "./types/StyleFamily.js";
+export * from "./utils/defaults.js";
+export * from "./utils/startNewSession.js";

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+export * from "./BaseSession.js";
+export * from "./BasemapStyleSession.js";
+export * from "./types/StyleFamily.js";
+export * from "./utils/defaults.js";
+export * from "./utils/startNewSession.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC","sourcesContent":["export * from \"./BaseSession.js\";\nexport * from \"./BasemapStyleSession.js\";\nexport * from \"./types/StyleFamily.js\";\nexport * from \"./utils/defaults.js\";\nexport * from \"./utils/startNewSession.js\";\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/types/StyleFamily.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Defines the style family for basemap sessions.
+ */
+export declare type StyleFamily = "open" | "arcgis";

package/dist/esm/types/StyleFamily.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=StyleFamily.js.map

package/dist/esm/types/StyleFamily.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StyleFamily.js","sourceRoot":"","sources":["../../../src/types/StyleFamily.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Defines the style family for basemap sessions.\n */\nexport type StyleFamily = \"open\" | \"arcgis\";\n"]}

package/dist/esm/utils/defaults.d.ts

@@ -0,0 +1,4 @@
+export declare const DEFAULT_START_BASEMAP_STYLE_SESSION_URL = "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/sessions/start";
+export declare const DEFAULT_SAFETY_MARGIN: number;
+export declare const DEFAULT_CHECK_EXPIRATION_INTERVAL = 10;
+export declare const DEFAULT_DURATION: number;

package/dist/esm/utils/defaults.js

@@ -0,0 +1,5 @@
+export const DEFAULT_START_BASEMAP_STYLE_SESSION_URL = "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/sessions/start";
+export const DEFAULT_SAFETY_MARGIN = 5 * 60; // Default to 5 minutes in seconds
+export const DEFAULT_CHECK_EXPIRATION_INTERVAL = 10; // Default to 10 seconds
+export const DEFAULT_DURATION = 12 * 60 * 60; // Default to 12 hours in seconds
+//# sourceMappingURL=defaults.js.map

package/dist/esm/utils/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../../src/utils/defaults.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,uCAAuC,GAClD,oFAAoF,CAAC;AAEvF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,kCAAkC;AAE/E,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,CAAC,CAAC,wBAAwB;AAE7E,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,iCAAiC","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"]}

package/dist/esm/utils/detemineSafetyMargin.d.ts

@@ -0,0 +1 @@
+export declare function determineSafetyMargin(duration: number | undefined, safetyMargin: number | undefined): number;

package/dist/esm/utils/detemineSafetyMargin.js

@@ -0,0 +1,11 @@
+import { DEFAULT_SAFETY_MARGIN } from "./defaults.js";
+export function determineSafetyMargin(duration, safetyMargin) {
+    if (safetyMargin) {
+        return safetyMargin;
+    }
+    // common cases are
+    // duration is 60 seconds, this will return a 1 second safety margin
+    // duration is 43200 seconds, this will return a 300 second (5 minutes) safety margin
+    return Math.min(Math.max(duration / 100, 1), DEFAULT_SAFETY_MARGIN);
+}
+//# sourceMappingURL=detemineSafetyMargin.js.map

package/dist/esm/utils/detemineSafetyMargin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detemineSafetyMargin.js","sourceRoot":"","sources":["../../../src/utils/detemineSafetyMargin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEtD,MAAM,UAAU,qBAAqB,CACnC,QAA4B,EAC5B,YAAgC;IAEhC,IAAI,YAAY,EAAE;QAChB,OAAO,YAAY,CAAC;KACrB;IACD,mBAAmB;IACnB,oEAAoE;IACpE,qFAAqF;IACrF,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;AACtE,CAAC","sourcesContent":["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"]}

package/dist/esm/utils/startNewSession.d.ts

@@ -0,0 +1,15 @@
+import { IAuthenticationManager } from "@esri/arcgis-rest-request";
+import { StyleFamily } from "../types/StyleFamily.js";
+export interface IRequestNewSessionParams {
+    startSessionUrl: string;
+    authentication: IAuthenticationManager | string;
+    styleFamily?: StyleFamily;
+    duration?: number;
+}
+export interface IStartSessionResponse {
+    sessionToken: string;
+    endTime: number;
+    startTime: number;
+    styleFamily: StyleFamily;
+}
+export declare function startNewSession({ startSessionUrl, authentication, styleFamily, duration }: IRequestNewSessionParams): Promise<IStartSessionResponse>;

package/dist/esm/utils/startNewSession.js

@@ -0,0 +1,10 @@
+import { request } from "@esri/arcgis-rest-request";
+import { DEFAULT_DURATION } from "./defaults.js";
+export function startNewSession({ startSessionUrl, authentication, styleFamily = "arcgis", duration = DEFAULT_DURATION }) {
+    return request(startSessionUrl, {
+        httpMethod: "GET",
+        authentication: authentication,
+        params: { styleFamily, durationSeconds: duration }
+    });
+}
+//# sourceMappingURL=startNewSession.js.map

package/dist/esm/utils/startNewSession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"startNewSession.js","sourceRoot":"","sources":["../../../src/utils/startNewSession.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0B,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAE5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAgBjD,MAAM,UAAU,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,CAAC","sourcesContent":["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"]}

package/dist/esm/utils/writable.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Utility type to convert all properties of an object type to writable.
+ *
+ * If needed a more complex version of is avalable at: https://github.com/sindresorhus/type-fest/blob/main/source/writable.d.ts
+ */
+export declare type Writable<T> = {
+    -readonly [K in keyof T]: T[K];
+};

package/dist/esm/utils/writable.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=writable.js.map

package/dist/esm/utils/writable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writable.js","sourceRoot":"","sources":["../../../src/utils/writable.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Utility type to convert all properties of an object type to writable.\n *\n * If needed a more complex version of is avalable at: https://github.com/sindresorhus/type-fest/blob/main/source/writable.d.ts\n */\nexport type Writable<T> = {\n  -readonly [K in keyof T]: T[K];\n};\n"]}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@esri/arcgis-rest-basemap-sessions",
+  "version": "1.0.0",
+  "description": "Helper functions for the Basemap Sessions service in @esri/arcgis-rest-js.",
+  "license": "Apache-2.0",
+  "keywords": [
+    "ES6",
+    "arcgis",
+    "esri",
+    "fetch",
+    "promise",
+    "typescript"
+  ],
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "unpkg": "dist/bundled/basemap-sessions.umd.min.js",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "types": "dist/esm/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist/**"
+  ],
+  "scripts": {
+    "build": "npm-run-all --parallel build:*",
+    "postbuild": "node ../../scripts/create-dist-package-jsons.js",
+    "build:bundled": "rollup -c ../../rollup.js",
+    "build:cjs": "tsc --outDir ./dist/cjs -m commonjs",
+    "postbuild:cjs": "node ../../scripts/create-dist-package-jsons.js",
+    "build:esm": "tsc --outDir ./dist/esm --declaration",
+    "postbuild:esm": "node ../../scripts/create-dist-package-jsons.js",
+    "dev": "npm-run-all --parallel dev:*",
+    "dev:bundled": "rollup -w -c ../../rollup.js",
+    "dev:cjs": "tsc -w --outDir ./dist/cjs -m commonjs",
+    "dev:esm": "tsc -w --outDir ./dist/esm --declaration"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "mitt": "^3.0.1",
+    "tslib": "^2.3.0"
+  },
+  "peerDependencies": {
+    "@esri/arcgis-rest-request": "^4.0.0"
+  },
+  "devDependencies": {
+    "@esri/arcgis-rest-request": "^4.0.1"
+  },
+  "contributors": [
+    "Patrick Arlt <parlt@esri.com> (http://patrickarlt.com/)"
+  ],
+  "homepage": "https://github.com/Esri/arcgis-rest-js#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esri/arcgis-rest-js.git",
+    "directory": "packages/arcgis-rest-basemap-sessions"
+  },
+  "bugs": {
+    "url": "https://github.com/Esri/arcgis-rest-js/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "esri": {
+    "keyExports": [
+      "@TODO"
+    ]
+  }
+}