@loaders.gl/arcgis 5.0.0-alpha.10

package/src/authentication.ts

@@ -0,0 +1,118 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import type {
+  AuthenticatedFetchOptions,
+  FetchLike,
+  RequestCredential,
+  TokenValue
+} from '@loaders.gl/loader-utils';
+import {
+  TokenAuthentication,
+  createAuthenticatedFetch,
+  createQueryParameterCredential
+} from '@loaders.gl/loader-utils';
+
+/** Maximum JSON error bytes retained by the authentication detector. */
+const MAXIMUM_AUTHENTICATION_ERROR_BYTES = 16384;
+
+/** ArcGIS token authentication independent of the application's sign-in SDK. */
+export class ArcGISAuthentication extends TokenAuthentication {
+  /** Discriminator used in `core.credentials`. */
+  static readonly type = 'arcgis';
+  /** Creates an exact-origin ArcGIS credential. */
+  constructor(options: ArcGISCredentialOptions) {
+    super(createArcGISCredential(options));
+  }
+
+  /**
+   * Creates a fetch transport for discovery and service requests.
+   * Refreshes are isolated by trusted origin so server-specific tokens cannot cross hosts.
+   * Reuse the returned transport to deduplicate concurrent refreshes within each origin.
+   */
+  createFetch(options: Pick<AuthenticatedFetchOptions, 'fetch' | 'fetchOptions'> = {}): FetchLike {
+    return createAuthenticatedFetch({
+      ...options,
+      credentials: this.origins.map(origin =>
+        createArcGISCredential({
+          origins: [origin],
+          token: this.token
+        })
+      )
+    });
+  }
+}
+
+/** Options for an ArcGIS REST service credential. */
+export type ArcGISCredentialOptions = {
+  /** ArcGIS token or application-managed token callback. */
+  token: TokenValue;
+  /** Exact ArcGIS Online or Enterprise origins authorized to receive the token. */
+  origins: readonly string[];
+};
+
+/** Creates an exact-origin ArcGIS `token` query credential. */
+export function createArcGISCredential(options: ArcGISCredentialOptions): RequestCredential {
+  return {
+    ...createQueryParameterCredential({
+      id: 'arcgis-token',
+      origins: options.origins,
+      parameterName: 'token',
+      token: options.token,
+      refreshStatusCodes: [401, 403, 498, 499]
+    }),
+    shouldRefresh: isArcGISAuthenticationError,
+    canReplayRequest: canReplayArcGISRequest
+  };
+}
+
+/**
+ * Detects small JSON authentication errors without buffering successful feature/tile bodies.
+ * Only 498/499 envelopes trigger renewal; permission and query errors remain visible.
+ */
+async function isArcGISAuthenticationError(response: Response): Promise<boolean> {
+  if (response.status !== 200 || !response.headers.get('content-type')?.includes('json'))
+    return false;
+  if (Number(response.headers.get('content-length')) > MAXIMUM_AUTHENTICATION_ERROR_BYTES)
+    return false;
+  const reader = response.clone().body?.getReader();
+  if (!reader) return false;
+  const chunks: Uint8Array[] = [];
+  let length = 0;
+  try {
+    while (true) {
+      const {value, done} = await reader.read();
+      if (done) {
+        const bytes = new Uint8Array(length);
+        let offset = 0;
+        for (const chunk of chunks) {
+          bytes.set(chunk, offset);
+          offset += chunk.length;
+        }
+        const json = JSON.parse(new TextDecoder().decode(bytes));
+        return json?.error?.code === 498 || json?.error?.code === 499;
+      }
+      if (value.byteLength > MAXIMUM_AUTHENTICATION_ERROR_BYTES - length) return false;
+      length += value.byteLength;
+      // Copy only accepted bytes so small views cannot retain oversized backing buffers.
+      chunks.push(value.slice());
+    }
+  } catch {
+    return false;
+  } finally {
+    // A tee cancellation can wait for the original consumer; do not await it here.
+    void reader.cancel().catch(() => {});
+  }
+}
+
+/** Permits string or URLSearchParams form POST queries on numbered feature or map layers. */
+function canReplayArcGISRequest(url: string, request: RequestInit): boolean {
+  return (
+    request.method?.toUpperCase() === 'POST' &&
+    /\/(FeatureServer|MapServer)\/\d+\/query\/?$/i.test(new URL(url).pathname) &&
+    new Headers(request.headers).get('content-type')?.split(';')[0] ===
+      'application/x-www-form-urlencoded' &&
+    (typeof request.body === 'string' || request.body instanceof URLSearchParams)
+  );
+}

package/src/bundled.ts

@@ -0,0 +1,68 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {ArcGISFeatureServerSourceLoaderWithParser as ArcGISFeatureServerSourceLoader} from './arcgis/arcgis-feature-server-source-loader';
+export {
+  ArcGISFeatureServerSourceLoaderWithParser as ArcGISFeatureServerSourceLoader,
+  ArcGISVectorSource,
+  ArcGISFeatureQueryError
+} from './arcgis/arcgis-feature-server-source-loader';
+import {ArcGISImageServerSourceLoaderWithParser as ArcGISImageServerSourceLoader} from './arcgis/arcgis-image-server-source-loader';
+export {
+  ArcGISImageServerSourceLoaderWithParser as ArcGISImageServerSourceLoader,
+  ArcGISImageSource
+} from './arcgis/arcgis-image-server-source-loader';
+import {ArcGISImageTileSourceLoaderWithParser as ArcGISImageTileSourceLoader} from './arcgis/arcgis-image-tile-source-loader';
+export {
+  ArcGISImageTileSourceLoaderWithParser as ArcGISImageTileSourceLoader,
+  ArcGISImageTileSource
+} from './arcgis/arcgis-image-tile-source-loader';
+import {ArcGISMapTileSourceLoaderWithParser as ArcGISMapTileSourceLoader} from './arcgis/arcgis-map-tile-source-loader';
+export {
+  ArcGISMapTileSourceLoaderWithParser as ArcGISMapTileSourceLoader,
+  ArcGISMapTileSource
+} from './arcgis/arcgis-map-tile-source-loader';
+import {ArcGISSceneServerSourceLoaderWithParser as ArcGISSceneServerSourceLoader} from './arcgis/arcgis-scene-server-source-loader';
+export {
+  ArcGISSceneServerSourceLoaderWithParser as ArcGISSceneServerSourceLoader,
+  ArcGISSceneServerSource,
+  ArcGISSceneServerQueryError
+} from './arcgis/arcgis-scene-server-source-loader';
+import {ArcGISVectorTileServerSourceLoaderWithParser as ArcGISVectorTileServerSourceLoader} from './arcgis/arcgis-vector-tile-server-source-loader';
+export {
+  ArcGISVectorTileServerSourceLoaderWithParser as ArcGISVectorTileServerSourceLoader,
+  ArcGISVectorTileServerSource
+} from './arcgis/arcgis-vector-tile-server-source-loader';
+
+export type * from './index';
+export {
+  getArcGISServices,
+  discoverArcGISCapabilities,
+  selectArcGISService
+} from './arcgis/arcgis-capability-graph';
+export {aggregateArcGISSceneFeatures} from './arcgis/arcgis-scene-aggregation';
+export {ArcGISAuthentication, createArcGISCredential} from './authentication';
+
+/** A synchronous ArcGIS source loader, including its runtime implementation. */
+export type ArcGISLoader = (typeof ARCGIS_LOADERS)[number];
+
+/** All runtime ArcGIS loaders, in the same selection order as the package root. */
+export const ARCGIS_LOADERS = [
+  ArcGISFeatureServerSourceLoader,
+  ArcGISImageServerSourceLoader,
+  ArcGISImageTileSourceLoader,
+  ArcGISMapTileSourceLoader,
+  ArcGISVectorTileServerSourceLoader,
+  ArcGISSceneServerSourceLoader
+];
+
+/** Finds a runtime source loader by its canonical identifier or service type. */
+export function getArcGISLoader(serviceType: string): ArcGISLoader | undefined {
+  const normalizedServiceType = serviceType.toLowerCase();
+  return ARCGIS_LOADERS.find(
+    loader => loader.id === normalizedServiceType || loader.type === normalizedServiceType
+  );
+}
+
+export {resolveArcGISItem} from './arcgis-items';

package/src/index.ts

@@ -0,0 +1,70 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+export type {Service as ArcGISService} from './arcgis/arcgis-server';
+export type {
+  ArcGISCapabilityGraph,
+  ArcGISCapabilityGraphOptions,
+  ArcGISServiceCapabilities,
+  ArcGISServiceSelection
+} from './arcgis/arcgis-capability-graph';
+
+export {ArcGISFeatureServerSourceLoader} from './arcgis/arcgis-feature-server-source-loader-types';
+export type {ArcGISVectorSource} from './arcgis/arcgis-feature-server-source-loader';
+export {ArcGISImageServerSourceLoader} from './arcgis/arcgis-image-server-source-loader-types';
+export type {ArcGISImageSource} from './arcgis/arcgis-image-server-source-loader';
+export {ArcGISImageTileSourceLoader} from './arcgis/arcgis-image-tile-source-loader-types';
+export type {ArcGISImageTileSource} from './arcgis/arcgis-image-tile-source-loader';
+export {ArcGISMapTileSourceLoader} from './arcgis/arcgis-map-tile-source-loader-types';
+export type {ArcGISMapTileSource} from './arcgis/arcgis-map-tile-source-loader';
+export {ArcGISSceneServerSourceLoader} from './arcgis/arcgis-scene-server-source-loader-types';
+export type {
+  ArcGISSceneServerSource,
+  ArcGISSceneServerQueryError
+} from './arcgis/arcgis-scene-server-source-loader';
+export {ArcGISVectorTileServerSourceLoader} from './arcgis/arcgis-vector-tile-server-source-loader-types';
+export type {ArcGISVectorTileServerSource} from './arcgis/arcgis-vector-tile-server-source-loader';
+export type {
+  ArcGISFeatureServiceQueryOptions,
+  ArcGISFeatureServerSourceLoaderOptions,
+  ArcGISExportImageParameters,
+  ArcGISImageSourceLoaderProps,
+  ArcGISImageTileSourceLoaderOptions,
+  ArcGISMapTileSourceLoaderOptions,
+  ArcGISVectorTileServiceMetadata,
+  ArcGISVectorTileServerSourceLoaderOptions,
+  ArcGISSceneServerSourceOptions,
+  ArcGISSceneQueryOptions,
+  ArcGISSceneQueryResult
+} from './arcgis-source-types';
+
+export type {
+  ArcGISSceneAggregationOperation,
+  ArcGISSceneAggregationSpec,
+  ArcGISSceneAggregationOptions,
+  ArcGISSceneAggregationGroup
+} from './arcgis/arcgis-scene-aggregation';
+
+export type {ArcGISLoader} from './service-registry';
+export {ARCGIS_LOADERS, getArcGISLoader} from './service-registry';
+
+export type {ArcGISAuthentication} from './authentication';
+export type {ArcGISCredentialOptions} from './authentication';
+
+export type {
+  ArcGISFeatureQueryParameters,
+  ArcGISFeatureQueryOptions,
+  ArcGISFeatureQueryProgress,
+  ArcGISFeatureQueryResult,
+  ArcGISFeatureObjectIds,
+  ArcGISFeatureExtent
+} from './arcgis-feature-query-types';
+export type {ArcGISFeatureQueryError} from './arcgis/arcgis-feature-query';
+
+export type {
+  ArcGISItem,
+  ArcGISItemLayer,
+  ArcGISItemResolution,
+  ArcGISItemOptions
+} from './arcgis-items';

package/src/service-registry.ts

@@ -0,0 +1,43 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {ArcGISFeatureServerSourceLoader} from './arcgis/arcgis-feature-server-source-loader-types';
+import {ArcGISImageServerSourceLoader} from './arcgis/arcgis-image-server-source-loader-types';
+import {ArcGISImageTileSourceLoader} from './arcgis/arcgis-image-tile-source-loader-types';
+import {ArcGISMapTileSourceLoader} from './arcgis/arcgis-map-tile-source-loader-types';
+import {ArcGISSceneServerSourceLoader} from './arcgis/arcgis-scene-server-source-loader-types';
+import {ArcGISVectorTileServerSourceLoader} from './arcgis/arcgis-vector-tile-server-source-loader-types';
+
+/** A source loader currently exposed through the ArcGIS package. */
+export type ArcGISLoader =
+  | typeof ArcGISFeatureServerSourceLoader
+  | typeof ArcGISImageServerSourceLoader
+  | typeof ArcGISImageTileSourceLoader
+  | typeof ArcGISMapTileSourceLoader
+  | typeof ArcGISVectorTileServerSourceLoader
+  | typeof ArcGISSceneServerSourceLoader;
+
+/** All source loaders owned by `@loaders.gl/arcgis`, in URL-selection order. */
+export const ARCGIS_LOADERS: ArcGISLoader[] = [
+  ArcGISFeatureServerSourceLoader,
+  ArcGISImageServerSourceLoader,
+  ArcGISImageTileSourceLoader,
+  ArcGISMapTileSourceLoader,
+  ArcGISVectorTileServerSourceLoader,
+  ArcGISSceneServerSourceLoader
+];
+
+/**
+ * Finds a service loader by its canonical loader id or service type.
+ *
+ * The lookup is intentionally small and explicit. It provides discovery without
+ * introducing a second request lifecycle or hiding provider-specific options.
+ */
+export function getArcGISLoader(serviceType: string): ArcGISLoader | undefined {
+  const normalizedServiceType = serviceType.toLowerCase();
+  return ARCGIS_LOADERS.find(
+    serviceLoader =>
+      serviceLoader.id === normalizedServiceType || serviceLoader.type === normalizedServiceType
+  );
+}