add lint to services

Author: ryanslatten

plugins/arcgis/service/eslint.config.mjs

@@ -9,7 +9,19 @@ export default [
     files: ["**/*.{js,mjs,cjs,ts}"],
     languageOptions: { globals: globals.browser },
     plugins: { jsdoc },
-    rules: { "jsdoc/require-description": "warn" },
+    rules: {
+      "jsdoc/require-description": "warn",
+      "semi": ["error", "always"]
+    },
+    "overrides": [
+      {
+        // enable the rule specifically for TypeScript files
+        "files": ["*.ts", "*.tsx"],
+        "rules": {
+          "@typescript-eslint/no-explicit-any": "off"
+        }
+      }
+    ]
   },
   pluginJs.configs.recommended,
   ...tseslint.configs.recommended,

plugins/arcgis/service/src/AddLayersRequest.ts

@@ -24,5 +24,5 @@ export interface Field {
     nullable: boolean
     editable: boolean
     domain?: string
-    defaultValue?: any
+    defaultValue?: unknown
 }

plugins/arcgis/service/src/ArcGISConfig.ts

@@ -1,4 +1,4 @@
-import { MageEventId } from "@ngageoint/mage.service/lib/entities/events/entities.events"
+import { MageEventId } from "@ngageoint/mage.service/lib/entities/events/entities.events";
 
 /**
  * Contains an arc feature service url and layers.
@@ -11,8 +11,8 @@ export interface FeatureServiceConfig {
     url: string
 
     /**
-    * Serialized ArcGISIdentityManager
-    */
+     * Serialized ArcGISIdentityManager
+     */
     identityManager: string
 
     /**
@@ -56,7 +56,7 @@ export interface AttributeConfig {
     /**
      * Value mappings
      */
-    mappings?: { [value: string]: any }
+    mappings?: { [value: string]: unknown }
 
     /**
      * Default values
@@ -100,7 +100,7 @@ export interface AttributeDefaultConfig {
     /**
      * Default value.
      */
-    value: any
+    value: unknown
 
     /**
      * Conditional attribute equality values when the default applies.
@@ -122,6 +122,6 @@ export interface AttributeValueConfig {
     /**
      * Attribute values.
      */
-    values: any[]
+    values: unknown[]
 
 }

plugins/arcgis/service/src/ArcGISPluginConfig.ts

@@ -1,4 +1,4 @@
-import { FeatureServiceConfig, AttributeConfig } from "./ArcGISConfig"
+import { FeatureServiceConfig, AttributeConfig } from "./ArcGISConfig";
 
 /**
  * Contains various configuration values used by the plugin.
@@ -71,13 +71,13 @@ export interface ArcGISPluginConfig {
   idSeparator: string
 
   /**
-  * The event id field attribute name.
-  */
+   * The event id field attribute name.
+   */
   eventIdField?: string
 
   /**
-  * The last edited date field attribute name on the ArcGIS server.
-  */
+   * The last edited date field attribute name on the ArcGIS server.
+   */
   lastEditedDateField?: string
 
   /**
@@ -123,7 +123,7 @@ export interface ArcGISPluginConfig {
   /**
    * Override mappings between event form fields and ArcGIS attributes as: { event: { form: { field: attribute } } }
    */
-  fieldAttributes?: any
+  fieldAttributes?: unknown
 
   /**
    * The attribute configurations.
@@ -162,16 +162,16 @@ export const defaultArcGISPluginConfig = Object.freeze<ArcGISPluginConfig>({
         {
           value: 3,
           condition: [
-            { attribute:'geometry_type', values: ['esriGeometryPolyline'] }
+            { attribute: 'geometry_type', values: ['esriGeometryPolyline'] }
           ]
         },
         {
           value: 1,
           condition: [
-            { attribute:'geometry_type', values: ['esriGeometryPolygon'] }
+            { attribute: 'geometry_type', values: ['esriGeometryPolygon'] }
           ]
         }
       ]
     }
   }
-})
+});

plugins/arcgis/service/src/ArcGISService.ts

@@ -1,57 +1,92 @@
-import { ArcGISIdentityManager } from '@esri/arcgis-rest-request'
-import { FeatureServiceConfig } from './ArcGISConfig'
-import { PluginStateRepository } from '@ngageoint/mage.service/lib/plugins.api'
+import { ArcGISIdentityManager } from '@esri/arcgis-rest-request';
+import { FeatureServiceConfig } from './ArcGISConfig';
+import { PluginStateRepository } from '@ngageoint/mage.service/lib/plugins.api';
+import { ArcGISPluginConfig } from './ArcGISPluginConfig';
 
+/**
+ * Interface for managing ArcGIS identity and authentication.
+ */
 export interface ArcGISIdentityService {
+  /**
+   * Sign in to ArcGIS with the feature service credentials.
+   * @param {FeatureServiceConfig} featureService The feature service configuration.
+   * @returns {Promise<ArcGISIdentityManager>} The ArcGIS identity manager.
+   */
   signin(featureService: FeatureServiceConfig): Promise<ArcGISIdentityManager>
+
+  /**
+   * Update the identity managers with latest tokens.
+   * @returns {Promise<void>}
+   */
   updateIndentityManagers(): Promise<void>
 }
 
+/**
+ * Creates a new ArcGIS identity service.
+ * @param {PluginStateRepository<ArcGISPluginConfig>} stateRepo The plugin state repository.
+ * @returns {ArcGISIdentityService} The ArcGIS identity service.
+ */
 export function createArcGISIdentityService(
-  stateRepo: PluginStateRepository<any>
+  stateRepo: PluginStateRepository<ArcGISPluginConfig>
 ): ArcGISIdentityService {
-  const identityManagerCache: Map<string, Promise<ArcGISIdentityManager>> = new Map()
+  const identityManagerCache: Map<string, Promise<ArcGISIdentityManager>> = new Map();
 
   return {
     async signin(featureService: FeatureServiceConfig): Promise<ArcGISIdentityManager> {
-      let cached = await identityManagerCache.get(featureService.url)
+      const cached = await identityManagerCache.get(featureService.url);
       if (!cached) {
-        const identityManager = ArcGISIdentityManager.deserialize(featureService.identityManager)
-        const promise = identityManager.getUser().then(() => identityManager)
-        identityManagerCache.set(featureService.url, promise)
-        return promise
+        const identityManager = ArcGISIdentityManager.deserialize(featureService.identityManager);
+        const promise = identityManager.getUser().then(() => identityManager);
+        identityManagerCache.set(featureService.url, promise);
+        return promise;
       } else {
-        return cached
+        return cached;
       }
     },
+
     async updateIndentityManagers() {
-      const config = await stateRepo.get()
-      for (let [url, persistedIdentityManagerPromise] of identityManagerCache) {
-        const persistedIdentityManager = await persistedIdentityManagerPromise
-        const featureService: FeatureServiceConfig | undefined = config.featureServices.find((service: FeatureServiceConfig) => service.url === url)
-        if (featureService) {
-          const identityManager = ArcGISIdentityManager.deserialize(featureService.identityManager)
+      const config = await stateRepo.get() as ArcGISPluginConfig | null;
+      for (const [url, persistedIdentityManagerPromise] of identityManagerCache) {
+        const persistedIdentityManager = await persistedIdentityManagerPromise;
+        const featureService: FeatureServiceConfig | undefined = config?.featureServices.find((service: FeatureServiceConfig) => service.url === url);
+        if (featureService && config) {
+          const identityManager = ArcGISIdentityManager.deserialize(featureService.identityManager);
           if (identityManager.token !== persistedIdentityManager.token || identityManager.refreshToken !== persistedIdentityManager.refreshToken) {
-            featureService.identityManager = persistedIdentityManager.serialize()
-            await stateRepo.put(config)
+            featureService.identityManager = persistedIdentityManager.serialize();
+            await stateRepo.patch(config as never);
           }
         }
       }
     }
-  }
+  };
 }
 
+/**
+ * Gets the portal URL for an ArcGIS feature service.
+ * @param {FeatureServiceConfig | string} featureService The feature service config or URL.
+ * @returns {string} The portal URL.
+ */
 export function getPortalUrl(featureService: FeatureServiceConfig | string): string {
-	const url = getFeatureServiceUrl(featureService)
-  return `https://${url.hostname}/arcgis/sharing/rest`
+  const url = getFeatureServiceUrl(featureService);
+  return `https://${url.hostname}/arcgis/sharing/rest`;
 }
 
+/**
+ * Gets the server URL for an ArcGIS feature service.
+ * @param {FeatureServiceConfig | string} featureService The feature service config or URL.
+ * @returns {string} The server URL.
+ */
 export function getServerUrl(featureService: FeatureServiceConfig | string): string {
-	const url = getFeatureServiceUrl(featureService)
-  return `https://${url.hostname}/arcgis`
+  const url = getFeatureServiceUrl(featureService);
+  return `https://${url.hostname}/arcgis`;
 }
 
+/**
+ * Gets the URL object for an ArcGIS feature service.
+ * @param {FeatureServiceConfig | string} featureService The feature service config or URL string.
+ * @returns {URL} The feature service URL.
+ */
 export function getFeatureServiceUrl(featureService: FeatureServiceConfig | string): URL {
-  const url = typeof featureService === 'string' ? featureService : featureService.url
-  return new URL(url)
+  const url = typeof featureService === 'string' ? featureService : featureService.url;
+  return new URL(url);
 }

plugins/arcgis/service/src/ArcObject.ts

@@ -5,7 +5,7 @@
 export interface ArcObject {
     geometry: ArcGeometry,
     attributes: {
-        [key: string]: any
+        [key: string]: unknown
     }
 }
 

plugins/arcgis/service/src/ArcObjects.ts

@@ -1,5 +1,5 @@
-import { ArcObject } from './ArcObject'
-import { ArcObservation } from './ArcObservation'
+import { ArcObject } from './ArcObject';
+import { ArcObservation } from './ArcObservation';
 
 /**
  * Observation Features Objects to send, update, or delete in ArcGIS.
@@ -9,17 +9,17 @@ export class ArcObjects {
     /**
      * The features to send to the arc server.
      */
-    objects: ArcObject[]
+    objects: ArcObject[];
 
     /**
      * The observations to send to the arc server.
      */
-    observations: ArcObservation[]
+    observations: ArcObservation[];
 
     /**
      * The observations to delete from the arc server.
      */
-    deletions: ArcObservation[]
+    deletions: ArcObservation[];
 
     /**
      * Indicates if these arc objects have been created from observations in the database and this
@@ -32,43 +32,43 @@ export class ArcObjects {
      * Constructor.
      */
     constructor() {
-        this.objects = []
-        this.observations = []
-        this.deletions = []
+        this.objects = [];
+        this.observations = [];
+        this.deletions = [];
         this.firstRun = false;
     }
 
     /**
      * Add an observation.
-     * @param observation The observation to add.
+     * @param {ArcObservation} observation The observation to add.
      */
     add(observation: ArcObservation) {
-        this.observations.push(observation)
-        this.objects.push(observation.object)
+        this.observations.push(observation);
+        this.objects.push(observation.object);
     }
 
     /**
      * Count of observations.
-     * @return observation count.
+     * @returns {number} observation count.
      */
     count(): number {
-        return this.objects.length
+        return this.objects.length;
     }
 
     /**
      * Is observations empty.
-     * @return true if empty.
+     * @returns {boolean} true if empty.
      */
     isEmpty(): boolean {
-        return this.count() == 0
+        return this.count() == 0;
     }
 
     /**
      * Clear the observations.
      */
     clear() {
-        this.objects = []
-        this.observations = []
+        this.objects = [];
+        this.observations = [];
     }
 
 }

plugins/arcgis/service/src/ArcObservation.ts

@@ -1,5 +1,5 @@
-import { ArcObject } from './ArcObject'
-import { ObservationId } from '@ngageoint/mage.service/lib/entities/observations/entities.observations'
+import { ArcObject } from './ArcObject';
+import { ObservationId } from '@ngageoint/mage.service/lib/entities/observations/entities.observations';
 
 /**
  * The ArcGIS Observation wraps the raw ArcObject and combines Arc & MAGE metadata.