@esri/hub-common 14.146.1 → 14.148.0

package/dist/node/initiatives/_internal/InitiativeSchema.js

@@ -10,6 +10,7 @@ exports.InitiativeEditorTypes = [
     "hub:initiative:create",
     "hub:initiative:metrics",
     "hub:initiative:associations",
+    "hub:initiative:settings",
 ];
 /**
  * defines the JSON schema for a Hub Initiative's editable fields

package/dist/node/initiatives/_internal/InitiativeSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"InitiativeSchema.js","sourceRoot":"","sources":["../../../../src/initiatives/_internal/InitiativeSchema.ts"],"names":[],"mappings":";;;AAAA,mFAAgF;AAEhF,uFAAoF;AACpF,uCAA8C;AAC9C,iFAKyD;AAG5C,QAAA,qBAAqB,GAAG;IACnC,qBAAqB;IACrB,uBAAuB;IACvB,wBAAwB;IACxB,6BAA6B;CACrB,CAAC;AAEX;;GAEG;AACU,QAAA,gBAAgB,GAAyB,gCACjD,yCAAmB,KACtB,UAAU,kCACL,yCAAmB,CAAC,UAAU,KACjC,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC1B,EACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,uBAAe,CAAC,UAAU;YACnC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,uBAAe,CAAC;SACnC,EACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,WAAW,CAAC;YACvB,UAAU,EAAE,2BAAY,CAAC,UAAU;SACpC,KAEH,KAAK,EAAE;QACL,8CAAgC;QAChC,0CAA4B;QAC5B,uCAAyB;QACzB,gCAAkB;KACnB,GACsB,CAAC"}
+{"version":3,"file":"InitiativeSchema.js","sourceRoot":"","sources":["../../../../src/initiatives/_internal/InitiativeSchema.ts"],"names":[],"mappings":";;;AAAA,mFAAgF;AAEhF,uFAAoF;AACpF,uCAA8C;AAC9C,iFAKyD;AAG5C,QAAA,qBAAqB,GAAG;IACnC,qBAAqB;IACrB,uBAAuB;IACvB,wBAAwB;IACxB,6BAA6B;IAC7B,yBAAyB;CACjB,CAAC;AAEX;;GAEG;AACU,QAAA,gBAAgB,GAAyB,gCACjD,yCAAmB,KACtB,UAAU,kCACL,yCAAmB,CAAC,UAAU,KACjC,OAAO,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC1B,EACD,MAAM,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,uBAAe,CAAC,UAAU;YACnC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,uBAAe,CAAC;SACnC,EACD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,WAAW,CAAC;YACvB,UAAU,EAAE,2BAAY,CAAC,UAAU;SACpC,KAEH,KAAK,EAAE;QACL,8CAAgC;QAChC,0CAA4B;QAC5B,uCAAyB;QACzB,gCAAkB;KACnB,GACsB,CAAC"}

package/dist/node/initiatives/_internal/InitiativeUiSchemaSettings.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildUiSchema = void 0;
+/**
+ * @private
+ * constructs the settings uiSchema for Hub Initiatives.
+ * This defines how the schema should be rendered
+ * in the initiative settings pane
+ */
+exports.buildUiSchema = async (i18nScope, options, context) => {
+    return {
+        type: "Layout",
+        elements: [
+            {
+                type: "Section",
+                labelKey: `${i18nScope}.sections.mapSettings.label`,
+                elements: [
+                    {
+                        type: "Control",
+                        scope: "/properties/view/properties/mapSettings",
+                        labelKey: `${i18nScope}.fields.mapSettings.label`,
+                        options: {
+                            type: "Control",
+                            control: "hub-composite-input-map-settings",
+                            // the settings that are visible for configuring the map
+                            visibleSettings: ["gallery"],
+                            // if the map preview is displayed
+                            showPreview: true,
+                        },
+                    },
+                ],
+            },
+        ],
+    };
+};
+//# sourceMappingURL=InitiativeUiSchemaSettings.js.map

package/dist/node/initiatives/_internal/InitiativeUiSchemaSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InitiativeUiSchemaSettings.js","sourceRoot":"","sources":["../../../../src/initiatives/_internal/InitiativeUiSchemaSettings.ts"],"names":[],"mappings":";;;AAIA;;;;;GAKG;AACU,QAAA,aAAa,GAAG,KAAK,EAChC,SAAiB,EACjB,OAAgC,EAChC,OAAuB,EACH,EAAE;IACtB,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,SAAS;gBACf,QAAQ,EAAE,GAAG,SAAS,6BAA6B;gBACnD,QAAQ,EAAE;oBACR;wBACE,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,yCAAyC;wBAChD,QAAQ,EAAE,GAAG,SAAS,2BAA2B;wBACjD,OAAO,EAAE;4BACP,IAAI,EAAE,SAAS;4BACf,OAAO,EAAE,kCAAkC;4BAC3C,wDAAwD;4BACxD,eAAe,EAAE,CAAC,SAAS,CAAC;4BAC5B,kCAAkC;4BAClC,WAAW,EAAE,IAAI;yBAClB;qBACF;iBACF;aACF;SACF;KACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/types/content/hostedServiceUtils.d.ts

@@ -2,19 +2,47 @@ import { IFeatureServiceDefinition } from "@esri/arcgis-rest-feature-layer";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IHubEditableContent } from "../core/types/IHubEditableContent";
 /**
+ * DEPRECATED: This will be removed in the next breaking version. Use "isHostedFeatureServiceMainItem" instead.
  * Determines whether an item represents a hosted feature service
  * @param item item to check
  * @returns whether the item represents a hosted feature service
  */
 export declare function isHostedFeatureServiceItem(item: IItem): boolean;
 /**
- * Determines whether an entity represents a hosted feature service
+ * Determines whether an item represents the main item of a hosted feature service
+ * (i.e. the item that was created when the service was published, not an item that
+ * referenced the service via url after it was created).
+ *
+ * NOTE: This check works for both hosted feature service items created in ArcGIS Online
+ * and in ArcGIS Enterprise.
+ *
  * @param item item to check
- * @returns whether the item represents a hosted feature service
+ * @returns whether the item passes the hosted feature service check
+ */
+export declare function isHostedFeatureServiceMainItem(item: IItem): boolean;
+/**
+ * DEPRECATED: This will be removed in the next breaking version Use "isHostedFeatureServiceMainEntity" instead
+ * Determines whether an entity represents a hosted feature service
+ * @param content content entity to check
+ * @returns
  */
 export declare function isHostedFeatureServiceEntity(content: IHubEditableContent): boolean;
+/**
+ * Determines whether an entity represents the main entity of a hosted feature service
+ * (i.e. the entity that was created when the service was published, not an entity that
+ * referenced the service via url after it was created)
+ *
+ * NOTE: This check works for both hosted feature service entities created in ArcGIS Online
+ * and in ArcGIS Enterprise.
+ *
+ * @param content content entity to check
+ * @returns
+ */
+export declare function isHostedFeatureServiceMainEntity(content: IHubEditableContent): boolean;
+export declare function isAGOFeatureServiceUrl(url: string): boolean;
 export declare enum ServiceCapabilities {
-    EXTRACT = "Extract"
+    EXTRACT = "Extract",
+    QUERY = "Query"
 }
 /**
  * Returns a whether a service has a capability

package/dist/types/core/schemas/shared/subschemas.d.ts

@@ -46,6 +46,21 @@ export declare const ENTITY_LOCATION_SCHEMA: {
         type: string;
     };
 };
+/**
+ * defines the JSON schema for the map configuration settings
+ */
+export declare const ENTITY_MAP_SCHEMA: {
+    type: string;
+    properties: {
+        baseViewItemId: {
+            type: string;
+            items: {
+                type: string;
+            };
+            maxItems: number;
+        };
+    };
+};
 export declare const ENTITY_IMAGE_SCHEMA: {
     type: string;
     properties: {

package/dist/types/core/schemas/types.d.ts

@@ -12,7 +12,7 @@ export interface IEditorConfig {
  * to the supported/defined uiSchema configurations
  */
 export declare type EntityEditorType = (typeof validEntityEditorTypes)[number];
-export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:attendees"];
+export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:attendees"];
 /** Defines the possible editor type values for a stat card. These
  * correspond to the supported/defined uiSchema configurations. This should
  * have its own signature in the getEditorConfig function.
@@ -36,7 +36,7 @@ export declare const validCardEditorTypes: readonly ["hub:card:stat", "hub:card:
  * to defined schema/uiSchema configurations
  */
 export declare type EditorType = (typeof validEditorTypes)[number];
-export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:attendees", "hub:card:stat", "hub:card:follow"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:group:create:followers", "hub:group:create:association", "hub:group:create:view", "hub:group:create:edit", "hub:initiativeTemplate:edit", "hub:survey:edit", "hub:survey:settings", "hub:event:create", "hub:event:edit", "hub:event:attendees", "hub:card:stat", "hub:card:follow"];
 /**
  * An editor's module when dynamically imported depending on the EditorType. This
  * will always have a buildUiSchema function, and sometimes it will have a

package/dist/types/core/traits/IWithViewSettings.d.ts

@@ -1,5 +1,5 @@
 import { HubEntityHero } from "../../types";
-import { IHubTimeline, IMetricDisplayConfig, HubActionLink } from "../types";
+import { IHubTimeline, IMetricDisplayConfig, HubActionLink, IHubMapSettings } from "../types";
 /**
  * Properties to be exclusively displayed on an entity's
  * pre-defined view
@@ -25,6 +25,10 @@ export interface IWithViewSettings {
      * name of an entity's featured image
      */
     featuredImageName?: string;
+    /**
+     * configuration settings for the entity map
+     */
+    mapSettings?: IHubMapSettings;
     /**
      * whether the entity should render it's location on a map
      */

package/dist/types/core/types/IHubEditableContent.d.ts

@@ -12,12 +12,17 @@ export interface IHubEditableContent extends IHubItemEntity, IWithSlug, IWithPer
      */
     licenseInfo: string;
     /**
-     * If the item represents a hosted feature service, shows whether the service has the "Extract"
-     * capability enabled. This is a pre-requisite for Hosted Downloads to work.
+     * If the item represents a feature or map service, shows whether the service has the
+     * "Query" capability enabled. This is a pre-requisite for the Hub Download System to work.
+     */
+    serverQueryCapability?: boolean;
+    /**
+     * If the item represents a feature service, shows whether the service has the "Extract"
+     * capability enabled. This is a pre-requisite for Create Replica Downloads to work.
      */
     serverExtractCapability?: boolean;
     /**
-     * If the item represents a hosted feature service with "Extract enabled", shows the formats that
+     * If the item represents a feature service with "Extract enabled", shows the formats that
      * can be extracted from the service via the "createReplica" operation.
      */
     serverExtractFormats?: string[];

package/dist/types/core/types/IHubMapSettings.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Interface for Hub Map settings.  Used to configure the map for an entity.
+ */
+export interface IHubMapSettings {
+    baseViewItemId: string[];
+}

package/dist/types/core/types/index.d.ts

@@ -17,6 +17,7 @@ export * from "./IHubInitiativeTemplate";
 export * from "./IHubItemEntity";
 export * from "./IHubLayout";
 export * from "./IHubLocation";
+export * from "./IHubMapSettings";
 export * from "./IHubPage";
 export * from "./IHubProject";
 export * from "./IHubTemplate";

package/dist/types/downloads/canUseHubDownloadSystem.d.ts

@@ -0,0 +1,2 @@
+import { IHubEditableContent } from "../core/types/IHubEditableContent";
+export declare function canUseHubDownloadSystem(entity: IHubEditableContent): boolean;

package/dist/types/downloads/{_internal/format-fetchers/getHubDownloadApiFormats.d.ts → getHubDownloadApiFormats.d.ts}

@@ -1,7 +1,6 @@
-import { IDynamicDownloadFormat } from "../../types";
-import { IHubEditableContent } from "../../../core/types/IHubEditableContent";
+import { IDynamicDownloadFormat } from "./types";
+import { IHubEditableContent } from "../core/types/IHubEditableContent";
 /**
- * @private
  * Returns all the formats that are available for download via the Hub Download API for a given entity.
  * Formats will vary from entity to entity depending on actual operation that the Hub Download API will
  * perform under the hood (e.g., hitting /createReplica or paging through the service's features).

package/dist/types/downloads/index.d.ts

@@ -3,4 +3,6 @@ export * from "./types";
 export * from "./fetchDownloadFileUrl";
 export * from "./fetchDownloadFormats";
 export * from "./canUseCreateReplica";
+export * from "./canUseHubDownloadSystem";
 export * from "./canUseHubDownloadApi";
+export * from "./getHubDownloadApiFormats";

package/dist/types/initiatives/_internal/InitiativeSchema.d.ts

@@ -1,6 +1,6 @@
 import { IConfigurationSchema } from "../../core";
 export declare type InitiativeEditorType = (typeof InitiativeEditorTypes)[number];
-export declare const InitiativeEditorTypes: readonly ["hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations"];
+export declare const InitiativeEditorTypes: readonly ["hub:initiative:edit", "hub:initiative:create", "hub:initiative:metrics", "hub:initiative:associations", "hub:initiative:settings"];
 /**
  * defines the JSON schema for a Hub Initiative's editable fields
  */

package/dist/types/initiatives/_internal/InitiativeUiSchemaSettings.d.ts

@@ -0,0 +1,10 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+import { IHubInitiative } from "../../core/types";
+/**
+ * @private
+ * constructs the settings uiSchema for Hub Initiatives.
+ * This defines how the schema should be rendered
+ * in the initiative settings pane
+ */
+export declare const buildUiSchema: (i18nScope: string, options: Partial<IHubInitiative>, context: IArcGISContext) => Promise<IUiSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.146.1",
+  "version": "14.148.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",

package/dist/esm/downloads/_internal/format-fetchers/getHubDownloadApiFormats.js

@@ -1,18 +0,0 @@
-import { getCreateReplicaFormats } from "./getCreateReplicaFormats";
-import { getPagingJobFormats } from "./getPagingJobFormats";
-import { canUseCreateReplica } from "../../canUseCreateReplica";
-/**
- * @private
- * Returns all the formats that are available for download via the Hub Download API for a given entity.
- * Formats will vary from entity to entity depending on actual operation that the Hub Download API will
- * perform under the hood (e.g., hitting /createReplica or paging through the service's features).
- *
- * @param entity Service entity to return download formats for
- * @returns available download formats for the entity
- */
-export function getHubDownloadApiFormats(entity) {
-    return canUseCreateReplica(entity)
-        ? getCreateReplicaFormats(entity)
-        : getPagingJobFormats();
-}
-//# sourceMappingURL=getHubDownloadApiFormats.js.map

package/dist/esm/downloads/_internal/format-fetchers/getHubDownloadApiFormats.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getHubDownloadApiFormats.js","sourceRoot":"","sources":["../../../../../src/downloads/_internal/format-fetchers/getHubDownloadApiFormats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CACtC,MAA2B;IAE3B,OAAO,mBAAmB,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,uBAAuB,CAAC,MAAM,CAAC;QACjC,CAAC,CAAC,mBAAmB,EAAE,CAAC;AAC5B,CAAC"}

package/dist/node/downloads/_internal/format-fetchers/getHubDownloadApiFormats.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHubDownloadApiFormats = void 0;
-const getCreateReplicaFormats_1 = require("./getCreateReplicaFormats");
-const getPagingJobFormats_1 = require("./getPagingJobFormats");
-const canUseCreateReplica_1 = require("../../canUseCreateReplica");
-/**
- * @private
- * Returns all the formats that are available for download via the Hub Download API for a given entity.
- * Formats will vary from entity to entity depending on actual operation that the Hub Download API will
- * perform under the hood (e.g., hitting /createReplica or paging through the service's features).
- *
- * @param entity Service entity to return download formats for
- * @returns available download formats for the entity
- */
-function getHubDownloadApiFormats(entity) {
-    return canUseCreateReplica_1.canUseCreateReplica(entity)
-        ? getCreateReplicaFormats_1.getCreateReplicaFormats(entity)
-        : getPagingJobFormats_1.getPagingJobFormats();
-}
-exports.getHubDownloadApiFormats = getHubDownloadApiFormats;
-//# sourceMappingURL=getHubDownloadApiFormats.js.map

package/dist/node/downloads/_internal/format-fetchers/getHubDownloadApiFormats.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getHubDownloadApiFormats.js","sourceRoot":"","sources":["../../../../../src/downloads/_internal/format-fetchers/getHubDownloadApiFormats.ts"],"names":[],"mappings":";;;AAAA,uEAAoE;AACpE,+DAA4D;AAG5D,mEAAgE;AAEhE;;;;;;;;GAQG;AACH,SAAgB,wBAAwB,CACtC,MAA2B;IAE3B,OAAO,yCAAmB,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,iDAAuB,CAAC,MAAM,CAAC;QACjC,CAAC,CAAC,yCAAmB,EAAE,CAAC;AAC5B,CAAC;AAND,4DAMC"}