chore(hub-common): enforce tslint

.github/workflows/pull-request-tests.yml

@@ -42,6 +42,9 @@ jobs:
       - name: Install Dependencies
         run: npm ci
 
+      - name: Lint
+        run: npm run lint
+
       - name: Build
         run: npm run build
 

packages/common/e2e/tslint.json

@@ -1,15 +1,9 @@
 {
   "extends": [
-    "tslint:recommended",
-    "tslint-config-standard",
-    "tslint-config-prettier"
+    "../../../tslint.json"
   ],
   "rules": {
     "no-console": false,
-    "strict-type-predicates": false,
-    "ordered-imports": ["any"],
-    "only-arrow-functions": [false],
-    "object-literal-sort-keys": false,
-    "interface-name": [true, "always-prefix"]
+    "no-unused-variable": false
   }
 }

packages/common/src/ArcGISContextManager.ts

@@ -6,7 +6,7 @@ import type { IArcGISContext } from "./types/IArcGISContext";
 
 import { getHubApiFromPortalUrl } from "./urls/getHubApiFromPortalUrl";
 import { getPortalBaseFromOrgUrl } from "./urls/getPortalBaseFromOrgUrl";
-import { Level, Logger } from "./utils/logger";
+import { Logger } from "./utils/logger";
 import { HubServiceStatus } from "./core";
 import { cloneObject, maybeAdd } from "./util";
 import { base64ToUnicode, unicodeToBase64 } from "./utils/encoding";
@@ -18,7 +18,7 @@ import { failSafe } from "./utils/fail-safe";
 import { updateUserHubSettings } from "./utils/hubUserAppResources";
 import { IUserHubSettings } from "./utils/IUserHubSettings";
 import { fetchAndMigrateUserHubSettings } from "./utils/internal/fetchAndMigrateUserHubSettings";
-import { getProp, getWithDefault, setProp } from "./objects";
+import { getProp, getWithDefault } from "./objects";
 import { fetchOrgLimits, IOrgLimit, OrgLimitType } from "./org/fetchOrgLimits";
 import type { IArcGISContextManagerOptions } from "./types/IArcGISContextManagerOptions";
 import type { IUserResourceConfig } from "./types/IUserResourceConfig";

packages/common/src/associations/internal/getIncludesAndReferencesQuery.ts

@@ -1,4 +1,4 @@
-import { IGroup, getItemGroups } from "@esri/arcgis-rest-portal";
+import { getItemGroups } from "@esri/arcgis-rest-portal";
 import { HubEntity, HubEntityType } from "../../core/types";
 import { getTypesFromEntityType } from "../../core/getTypesFromEntityType";
 import { getProp } from "../../objects/get-prop";

packages/common/src/channels/_internal/ChannelUiSchemaEdit.ts

@@ -1,4 +1,4 @@
-import { IUiSchema, UiSchemaRuleEffects } from "../../core/schemas/types";
+import { IUiSchema } from "../../core/schemas/types";
 import { IArcGISContext } from "../../types";
 import { IHubChannel } from "../../core/types";
 import { buildUiSchema as buildUiSchemaCreate } from "./ChannelUiSchemaCreate";

packages/common/src/channels/_internal/transformEntityPermissionPoliciesToFormValues.ts

@@ -1,7 +1,6 @@
 import { HubEntityType } from "../../core/types";
 import {
   COLLABORATION_TYPES,
-  CollaborationType,
   IEntityPermissionPolicy,
 } from "../../permissions/types/IEntityPermissionPolicy";
 import {
@@ -17,26 +16,6 @@ export interface IHubRoleConfigValue {
   roles: Record<string, { value: string; id?: string }>;
 }
 
-const COLLABORATION_TYPE_TO_ENTITY_TYPE_MAP: Partial<
-  Record<CollaborationType, HubEntityType>
-> = {
-  [COLLABORATION_TYPES.user]: "user",
-  [COLLABORATION_TYPES.group]: "group",
-  [COLLABORATION_TYPES.groupAdmin]: "group",
-  [COLLABORATION_TYPES.org]: "organization",
-  [COLLABORATION_TYPES.orgAdmin]: "organization",
-};
-
-const COLLABORATION_TYPE_TO_ROLE_MAP: Partial<
-  Record<CollaborationType, string>
-> = {
-  [COLLABORATION_TYPES.user]: "user",
-  [COLLABORATION_TYPES.group]: "member",
-  [COLLABORATION_TYPES.groupAdmin]: "admin",
-  [COLLABORATION_TYPES.org]: "member",
-  [COLLABORATION_TYPES.orgAdmin]: "admin",
-};
-
 /**
  * @private
  * Transforms an array of IEntityPermissionPolicy (Hub entity) objects to an array of IHubRoleConfigValue (entity editor) objects

packages/common/src/channels/_internal/transformFormValuesToEntityPermissionPolicies.ts

@@ -1,31 +1,10 @@
-import { HubEntityType } from "../../core/types/HubEntityType";
 import {
   COLLABORATION_TYPES,
-  CollaborationType,
   IEntityPermissionPolicy,
 } from "../../permissions/types";
-import {
-  CHANNEL_PERMISSIONS,
-  ChannelNonePermission,
-} from "./ChannelBusinessRules";
+import { ChannelNonePermission } from "./ChannelBusinessRules";
 import { IHubRoleConfigValue } from "./transformEntityPermissionPoliciesToFormValues";
 
-const ENTITY_TYPE_TO_COLLABORATION_TYPE_MAP: Partial<
-  Record<HubEntityType, { [key: string]: CollaborationType }>
-> = {
-  user: {
-    user: COLLABORATION_TYPES.user,
-  },
-  organization: {
-    admin: COLLABORATION_TYPES.orgAdmin,
-    member: COLLABORATION_TYPES.org,
-  },
-  group: {
-    admin: COLLABORATION_TYPES.groupAdmin,
-    member: COLLABORATION_TYPES.group,
-  },
-};
-
 /**
  * @private
  * Transforms an array of IHubRoleConfigValue objects into an array of IEntityPermissionPolicy objects

packages/common/src/collections.ts

@@ -247,7 +247,7 @@ const site: string[] = ["Hub Site Application", "Site Application"];
  */
 export const getCollection = (type?: string) => {
   if (!type) {
-    return;
+    return undefined;
   }
   const lowerCaseType = type.toLocaleLowerCase();
   return Object.keys(collections).find((key) => {
@@ -264,7 +264,7 @@ export const getCollection = (type?: string) => {
  */
 export const getCollectionTypes = (collection?: string) => {
   if (!collection) {
-    return;
+    return undefined;
   }
   const lowerCaseCollection = collection.toLocaleLowerCase();
   return collections[lowerCaseCollection];

packages/common/src/content/_internal/computeProps.ts

@@ -15,7 +15,6 @@ import {
   IServiceExtendedProps,
 } from "../../core/types/IHubEditableContent";
 import { getRelativeWorkspaceUrl } from "../../core/getRelativeWorkspaceUrl";
-import { isDiscussable } from "../../discussions";
 import {
   hasServiceCapability,
   ServiceCapabilities,

packages/common/src/core/catalogContains.ts

@@ -8,7 +8,6 @@ import { isCuid } from "../utils/is-cuid";
 import { isGuid } from "../utils/is-guid";
 import type { IArcGISContext } from "../types/IArcGISContext";
 import { hubSearch } from "../search/hubSearch";
-import { getWithDefault } from "../objects/get-with-default";
 
 /**
  * Given an identifier and a catalog, check if the catalog contains the identifier.
@@ -116,11 +115,11 @@ export async function catalogContains(
         isContained = queryResponse.results.reduce(
           (slugKeywordPresent, entry) => {
             // try .keywords, then rawResult.typeKeywords, else empty array
-            const kwds = getWithDefault(
-              entry,
-              "typeKeywords",
-              getWithDefault(entry, "rawResult.typeKeywords", [])
-            );
+            // const kwds = getWithDefault(
+            //   entry,
+            //   "typeKeywords",
+            //   getWithDefault(entry, "rawResult.typeKeywords", [])
+            // );
             // if (kwds.includes(pred.typekeywords)) {
             //   slugKeywordPresent = true;
             // }

packages/common/src/core/deepCatalogContains.ts

@@ -1,6 +1,5 @@
 import type { IArcGISContext } from "../types/IArcGISContext";
 import { getProp } from "../objects/get-prop";
-import { getEntityTypeFromType } from "../search/_internal/getEntityTypeFromType";
 import { IHubCatalog } from "../search/types/IHubCatalog";
 import { IContainsResponse, IDeepCatalogInfo } from "../search/types/types";
 import { deepContains, pathToCatalogInfo } from "./_internal/deepContains";

packages/common/src/core/fetchHubEntity.ts

@@ -12,7 +12,7 @@ import { fetchHubGroup } from "../groups/HubGroups";
 import { fetchInitiativeTemplate } from "../initiative-templates/fetch";
 import { fetchSurvey } from "../surveys/fetch";
 import { fetchEvent } from "../events/fetch";
-import { convertUserToHubUser, fetchHubUser } from "../users";
+import { fetchHubUser } from "../users";
 import { fetchOrganization } from "../org/fetch";
 import { fetchHubChannel } from "../channels/fetch";
 

packages/common/src/core/schemas/internal/events/EventGalleryCardUiSchema.ts

@@ -1,10 +1,6 @@
 import type { IArcGISContext } from "../../../../types/IArcGISContext";
 import { getWellKnownCatalog } from "../../../../search/wellKnownCatalog";
-import {
-  IUiSchema,
-  UiSchemaMessageTypes,
-  UiSchemaRuleEffects,
-} from "../../types";
+import { IUiSchema, UiSchemaRuleEffects } from "../../types";
 import { IEventGalleryCardEditorOptions } from "../EditorOptions";
 import { fetchCategoriesUiSchemaElement } from "../fetchCategoriesUiSchemaElement";
 import { getTagItems } from "../getTagItems";

packages/common/src/core/schemas/internal/getCardEditorSchemas.ts

@@ -42,6 +42,8 @@ export async function getCardEditorSchemas(
   let uiSchema;
   let schemaPromise;
   let uiSchemaPromise;
+  // defaults is used below... but maybe in a closure?
+  // tslint:disable-next-line:no-unused-variable
   let defaults;
 
   switch (cardType) {

packages/common/src/core/schemas/internal/getTagItems.ts

@@ -5,7 +5,6 @@ import { ISearchOptions, searchItems } from "@esri/arcgis-rest-portal";
 
 import { IHubRequestOptions } from "../../../hub-types";
 import { IUiSchemaComboboxItem } from "../types";
-import { EntityEditorOptions } from "./EditorOptions";
 /**
  * Fetch the entity's org tags (limited to the top 200),
  * merge with any configured on the entity itself, and convert

packages/common/src/core/schemas/types.ts

@@ -1,5 +1,4 @@
 import { JSONSchema } from "json-schema-typed";
-import Ajv from "ajv";
 
 import { ProjectEditorTypes } from "../../projects/_internal/ProjectSchema";
 import { InitiativeEditorTypes } from "../../initiatives/_internal/InitiativeSchema";

packages/common/src/discussions/_internal/computeProps.ts

@@ -5,7 +5,6 @@ import { IModel } from "../../hub-types";
 
 import { IHubDiscussion } from "../../core";
 
-import { isDiscussable } from "../utils";
 import { computeItemProps } from "../../core/_internal/computeItemProps";
 
 /**

packages/common/src/downloads/_internal/file-url-fetchers/fetchHubApiDownloadFile.ts

@@ -78,8 +78,7 @@ function validateOptions(options: IFetchDownloadFileOptions) {
  * @returns a download api url that can be polled
  */
 function getDownloadApiRequestUrl(options: IFetchDownloadFileOptions) {
-  const { entity, format, context, layers, geometry, where, updateCache } =
-    options;
+  const { entity, format, context, layers, geometry, where } = options;
 
   const searchParams = new URLSearchParams({
     redirect: "false", // Needed to get the download URL instead of the file itself

packages/common/src/downloads/_internal/format-fetchers/getCreateReplicaFormats.ts

@@ -1,5 +1,5 @@
 import { IHubEditableContent } from "../../../core/types/IHubEditableContent";
-import { IDynamicDownloadFormat, ServiceDownloadFormat } from "../../types";
+import { IDynamicDownloadFormat } from "../../types";
 import { CreateReplicaFormat, CREATE_REPLICA_FORMATS } from "../_types";
 
 /**

packages/common/src/downloads/_internal/getDownloadFlow.ts

@@ -1,8 +1,4 @@
-import {
-  DownloadFlowType,
-  IHubEditableContent,
-  IServiceExtendedProps,
-} from "../../core";
+import { DownloadFlowType, IHubEditableContent } from "../../core";
 import { getProp } from "../../objects/get-prop";
 import { canUseCreateReplica } from "../canUseCreateReplica";
 import { canUseHubDownloadSystem } from "../canUseHubDownloadSystem";

packages/common/src/downloads/getHubDownloadApiFormats.ts

@@ -1,10 +1,7 @@
 import { getCreateReplicaFormats } from "./_internal/format-fetchers/getCreateReplicaFormats";
 import { getPagingJobFormats } from "./_internal/format-fetchers/getPagingJobFormats";
 import { IDynamicDownloadFormat } from "./types";
-import {
-  IHubEditableContent,
-  IServiceExtendedProps,
-} from "../core/types/IHubEditableContent";
+import { IHubEditableContent } from "../core/types/IHubEditableContent";
 import { canUseCreateReplica } from "./canUseCreateReplica";
 import { canUseHubDownloadSystem } from "./canUseHubDownloadSystem";
 import { getFgdbJobFormats } from "./_internal/format-fetchers/getFgdbJobFormats";

packages/common/src/events/_internal/EventUiSchemaEdit.ts

@@ -6,7 +6,6 @@ import { HubEventAttendanceType, HubEventCapacityType } from "../types";
 import { getLocationExtent } from "../../core/schemas/internal/getLocationExtent";
 import { getLocationOptions } from "../../core/schemas/internal/getLocationOptions";
 import { fetchCategoriesUiSchemaElement } from "../../core/schemas/internal/fetchCategoriesUiSchemaElement";
-import { getWellKnownCatalog } from "../../search/wellKnownCatalog";
 import { buildReferencedContentSchema } from "./buildReferencedContentSchema";
 import { getThumbnailUiSchemaElement } from "../../core/schemas/internal/getThumbnailUiSchemaElement";
 import { getEntityThumbnailUrl } from "../../core/getEntityThumbnailUrl";

packages/common/src/events/_internal/PropertyMapper.ts

@@ -3,7 +3,6 @@ import {
   mapEntityToStore,
   mapStoreToEntity,
 } from "../../core/_internal/PropertyMapper";
-import { HubActionLink } from "../../core/types/ActionLinks";
 import { IHubEvent } from "../../core/types/IHubEvent";
 import { SettableAccessLevel } from "../../core/types/types";
 import { cloneObject } from "../../util";

packages/common/src/groups/HubGroups.ts

@@ -11,7 +11,6 @@ import {
   createGroup,
   updateGroup,
   protectGroup,
-  unprotectGroup,
 } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubGroup } from "../core/types/IHubGroup";

packages/common/src/groups/_internal/GroupUiSchemaCreateFollowers.ts

@@ -156,7 +156,6 @@ export const buildDefaults = async (
   options: EntityEditorOptions,
   context: IArcGISContext
 ): Promise<IConfigurationValues> => {
-  const { name } = options;
   return {
     ...getWellKnownGroup("hubFollowersGroup", context),
   };

packages/common/src/groups/_internal/GroupUiSchemaSettings.ts

@@ -1,7 +1,6 @@
 import { IUiSchema, UiSchemaRuleEffects } from "../../core";
 import type { IArcGISContext } from "../../types/IArcGISContext";
 import { EntityEditorOptions } from "../../core/schemas/internal/EditorOptions";
-import { IHubGroup } from "../../core";
 
 /**
  * @private
@@ -14,7 +13,6 @@ export const buildUiSchema = async (
   options: EntityEditorOptions,
   context: IArcGISContext
 ): Promise<IUiSchema> => {
-  const entity = options as IHubGroup;
   return {
     type: "Layout",
     elements: [

packages/common/src/initiative-templates/_internal/computeProps.ts

@@ -1,7 +1,6 @@
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubInitiativeTemplate } from "../../core";
-import { isDiscussable } from "../../discussions";
 import { processEntityFeatures } from "../../permissions/_internal/processEntityFeatures";
 import { getItemThumbnailUrl } from "../../resources";
 import { IModel } from "../../hub-types";

packages/common/src/initiative-templates/edit.ts

@@ -3,16 +3,9 @@ import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
 // Note - we separate these imports so we can cleanly spy on things in tests
 import { createModel, getModel, updateModel } from "../models";
 import { constructSlug } from "../items/slugs";
-import {
-  IPortal,
-  IUserItemOptions,
-  removeItem,
-} from "@esri/arcgis-rest-portal";
+import { IUserItemOptions, removeItem } from "@esri/arcgis-rest-portal";
 import { PropertyMapper } from "../core/_internal/PropertyMapper";
-import {
-  IHubInitiativeTemplate,
-  IHubInitiativeTemplateEditor,
-} from "../core/types/IHubInitiativeTemplate";
+import { IHubInitiativeTemplate } from "../core/types/IHubInitiativeTemplate";
 import {
   DEFAULT_INITIATIVE_TEMPLATE,
   DEFAULT_INITIATIVE_TEMPLATE_MODEL,
@@ -24,7 +17,6 @@ import { setDiscussableKeyword } from "../discussions";
 import { IModel } from "../hub-types";
 import { ensureUniqueEntitySlug } from "../items/_internal/ensureUniqueEntitySlug";
 import { IHubItemEntity } from "../core";
-import { editorToEntity } from "../core/schemas/internal/metrics/editorToEntity";
 
 /**
  * @private

packages/common/src/initiative-templates/fetch.ts

@@ -2,24 +2,17 @@ import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { getItem, IItem } from "@esri/arcgis-rest-portal";
 
 import { getFamily } from "../content/get-family";
-import {
-  deriveLocationFromItem,
-  getHubRelativeUrl,
-} from "../content/_internal/internalContentUtils";
+import { deriveLocationFromItem } from "../content/_internal/internalContentUtils";
 import { IHubInitiativeTemplate } from "../core/types";
 import { PropertyMapper } from "../core/_internal/PropertyMapper";
 import { getItemBySlug } from "../items/slugs";
 
 import { fetchModelFromItem } from "../models";
 import { IHubSearchResult } from "../search";
 import { IHubRequestOptions, IModel } from "../hub-types";
-import { isGuid, mapBy } from "../utils";
+import { isGuid } from "../utils";
 import { computeProps } from "./_internal/computeProps";
 import { getPropertyMap } from "./_internal/getPropertyMap";
-import { getItemThumbnailUrl } from "../resources/get-item-thumbnail-url";
-import { getItemHomeUrl } from "../urls/get-item-home-url";
-import { getItemIdentifier } from "../items";
-import { getRelativeWorkspaceUrl } from "../core/getRelativeWorkspaceUrl";
 import { computeLinks } from "./_internal/computeLinks";
 
 export async function fetchInitiativeTemplate(

packages/common/src/initiatives/HubInitiative.ts

@@ -36,14 +36,12 @@ import {
 } from "../core";
 import { IEditorConfig } from "../core/schemas/types";
 import { enrichEntity } from "../core/enrichEntity";
-import { IGroup } from "@esri/arcgis-rest-types";
 import { getProp, getWithDefault } from "../objects";
 import { upsertResource } from "../resources/upsertResource";
 import { doesResourceExist } from "../resources/doesResourceExist";
 import { removeResource } from "../resources/removeResource";
 import { metricToEditor } from "../metrics/metricToEditor";
 import { getGroup } from "@esri/arcgis-rest-portal";
-import { MembershipAccess } from "../core/types";
 import { convertGroupToHubGroup } from "../groups/_internal/convertGroupToHubGroup";
 import { getEditorSlug } from "../core/_internal/getEditorSlug";