@esri/hub-common 14.169.0 → 14.171.0

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

@@ -1,12 +1,16 @@
 import { IExtent } from "@esri/arcgis-rest-feature-layer";
 import { IWithVersioningBehavior } from "../behaviors";
-import { IWithCatalog, IWithLayout, IWithPermissions, IWithSlug } from "../traits/index";
 import { IHubItemEntity, IHubItemEntityEditor } from "./IHubItemEntity";
+import { IWithSlug } from "../traits/IWithSlug";
+import { IWithCatalog, IWithCatalogs } from "../traits/IWithCatalog";
+import { IWithLayout } from "../traits/IWithLayout";
+import { IWithPermissions } from "../traits/IWithPermissions";
 /**
  * DRAFT: Under development and more properties will likely be added
  * @internal
  */
-export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout, IWithPermissions, IWithVersioningBehavior {
+export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, // DEPRECATED: Use IWithCatalogs instead
+IWithCatalogs, IWithLayout, IWithPermissions, IWithVersioningBehavior {
     /**
      * Array of minimal page objects
      */
@@ -69,9 +73,13 @@ export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWith
     /** Legacy teams - list of ids */
     legacyTeams: string[];
     /**
-     * True when the site is a "Hub Home" site
+     * True when the site is a "Hub Home" site for an organization
      */
     isHubHome: boolean;
+    /**
+     * True when the site is the "Umbrella" site for an environment (i.e. hub.arcgis.com)
+     */
+    isUmbrella: boolean;
 }
 export declare type IHubSiteEditor = IHubItemEntityEditor<IHubSite> & {
     _discussions?: boolean;

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

@@ -5,6 +5,7 @@ export * from "./HubGroups";
 export * from "./HubGroup";
 export * from "./addGroupMembers";
 export * from "./getWellKnownGroup";
+export * from "./isOpenDataGroup";
 export * from "./autoAddUsers";
 export * from "./inviteUsers";
 export * from "./emailOrgUsers";

package/dist/types/groups/isOpenDataGroup.d.ts

@@ -0,0 +1,2 @@
+import { IGroup } from "@esri/arcgis-rest-types";
+export declare const isOpenDataGroup: (group: IGroup) => boolean;

package/dist/types/index.d.ts

@@ -39,6 +39,11 @@ export * from "./core/updateHubEntity";
 export * from "./urls/getCardModelUrl";
 export * from "./core/EntityEditor";
 export * from "./search/explainQueryResult";
+export * from "./search/searchEntityCatalogs";
+export * from "./search/searchCatalogs";
+export * from "./search/getAddContentConfig";
+export * from "./search/_internal/getCatalogGroups";
+export * from "./search/getPredicateValues";
 export * from "./core/hubHistory";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";

package/dist/types/search/Catalog.d.ts

@@ -108,7 +108,7 @@ export declare class Catalog implements IHubCatalog {
     /**
      * Search for Items
      * Will throw if the Catalog does not have a scope defined for items
-     * @param query
+     * @param query - string or IQuery
      * @param options
      * @returns
      */
@@ -123,7 +123,7 @@ export declare class Catalog implements IHubCatalog {
     /**
      * Search for Groups
      * Will throw if the Catalog does not have a scope defined for groups
-     * @param query
+     * @param query  - string or IQuery
      * @param options
      * @returns
      */
@@ -131,29 +131,32 @@ export declare class Catalog implements IHubCatalog {
     /**
      * Search for Users
      * Will throw if the Catalog does not have a scope defined for users
-     * @param query
+     * @param query  - string or IQuery
      * @param options
      * @returns
      */
     searchUsers(query: string | IQuery, options?: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;
     /**
-     * Execute a search against all the collections in the Catalog
-     * @param query
+     * Execute a term search against all the collections in the Catalog
+     * or an IQuery against all collections that match the targetEntity.
+     * Note: This will not search scopes which do not have corresponding collections.
+     * If you want that behavior, use `searchCatalogs` function instead.
+     * @param query  - string or IQuery
      * @param options
      * @returns
      */
-    searchCollections(query: string, options?: IHubSearchOptions): Promise<ISearchResponseHash>;
+    searchCollections(query: string | IQuery, options?: IHubSearchOptions): Promise<ISearchResponseHash>;
     /**
-     * Execute a search against all the scopes in the Catalog
-     * @param query
+     * Execute a term search against all the scopes in the Catalog
+     * @param query - term or IQuery
      * @param options
      * @returns
      */
-    searchScopes(query: string, options?: IHubSearchOptions): Promise<ISearchResponseHash>;
+    searchScopes(query: string | IQuery, options?: IHubSearchOptions, limitTo?: EntityType[]): Promise<ISearchResponseHash>;
     /**
-     * Execute a search against the Catalog as a whole
-     * @param query
-     * @param targetEntity
+     * Execute a term search or IQuery search against the Catalog.
+     * @param query - term or IQuery
+     * @param options
      * @returns
      */
     private search;

package/dist/types/search/_internal/getCatalogGroups.d.ts

@@ -0,0 +1,11 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IGroupsByMembership } from "../types/IGroupsByMembership";
+import { IHubCatalog } from "../types/IHubCatalog";
+/**
+ * Return an IGroupsByMembership object that contains all the groups, from all the
+ * collections/scopes in the catalog, which the current user is an owner/member/admin of.
+ * @param catalog
+ * @param context
+ * @returns
+ */
+export declare function getCatalogGroups(catalog: IHubCatalog, context: IArcGISContext): IGroupsByMembership;

package/dist/types/search/_internal/getEntityTypeFromType.d.ts

@@ -1,7 +1,7 @@
 import { EntityType } from "../types";
 /**
  * @private
- * Given a type (e.g. Hub Site Application) return the appropriate entity type
+ * Given a type (e.g. "Hub Site Application") return the appropriate entity type
  * that can be used as a `targetEntity` in an `IQuery`
  * @param type
  * @returns

package/dist/types/search/_internal/getUserGroupsFromQuery.d.ts

@@ -0,0 +1,13 @@
+import { IUser } from "@esri/arcgis-rest-types";
+import { IGroupsByMembership } from "../types/IGroupsByMembership";
+import { IQuery } from "../types/IHubCatalog";
+/**
+ * Given a query and a user, return an object with the set of groups
+ * that are in the Query, and which the user is a member of, split by
+ * membership type.
+ * NOTE: This excludes viewOnly groups the user is just a member of.
+ * @param query
+ * @param user
+ * @returns
+ */
+export declare function getUserGroupsFromQuery(query: IQuery, user: IUser): IGroupsByMembership;

package/dist/types/search/_internal/getWorkflowForType.d.ts

@@ -0,0 +1,61 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { Permission } from "../../permissions/types/Permission";
+import { EntityType } from "../types/IHubCatalog";
+/**
+ * @internal
+ * Define the workflows that are available for each content type
+ */
+export interface ITypeWorkflow {
+    /**
+     * The "type" the workflow applies to. This is not strictly an Item Type,
+     * it can also be an abstraction like "document", as well as things like Group
+     * or Event which are not item-backed.
+     */
+    type: string;
+    /**
+     * The target entity type for the type
+     */
+    targetEntity: EntityType;
+    /**
+     * The workflows that are available for the type
+     */
+    workflows: ContentWorkflow[];
+    /**
+     * Additional properties that may apply to some workflows
+     * e.g. upload file types for the type
+     */
+    properties?: Record<string, any>;
+}
+/**
+ * @internal
+ * Structure that defines the permission checks and workflows for each content type
+ */
+export interface ITypeWorkflowDefinition extends ITypeWorkflow {
+    /**
+     * The permission required to create content of this type
+     */
+    permission: Permission;
+}
+/**
+ * @internal
+ * Define the workflows
+ */
+export declare type ContentWorkflow = "create" | "upload" | "existing";
+/**
+ * Given a type and context, return the workflows that are available to the user.
+ * This checks the permissions for defined for the type, and if the user has the
+ * permission, returns the workflows defined for the type.
+ * @param type
+ * @param context
+ * @returns
+ */
+export declare function getWorkflowForType(type: string, context: IArcGISContext): ITypeWorkflow;
+/**
+ * Return a list of types to use as the "default" types a user could possibly
+ * create / add (depending on permissions and group access).
+ * This list is used when an IQuery does not have type predicates, which
+ * we interpret as "all types", which is this list.
+ * @param context
+ * @returns
+ */
+export declare function getDefaultCreateableTypes(context: IArcGISContext, limitTo?: EntityType[]): string[];

package/dist/types/search/_internal/index.d.ts

@@ -5,3 +5,5 @@ export * from "./portalSearchUsers";
 export * from "./hubSearchChannels";
 export * from "./hubSearchEvents";
 export * from "./hubSearchEventAttendees";
+export * from "./getWorkflowForType";
+export * from "./getCatalogGroups";

package/dist/types/search/_internal/portalSearchItems.d.ts

@@ -25,6 +25,13 @@ export declare function portalSearchItemsAsItems(query: IQuery, options: IHubSea
  * @returns IQuery
  */
 export declare function expandQuery(query: IQuery): IQuery;
+/**
+ * Expand the predicates in a query without applying
+ * the well-known type expansions
+ * @param query
+ * @returns
+ */
+export declare function expandPredicates(query: IQuery): IQuery;
 /**
  * Convert an `IItem` to a `IHubSearchResult`
  * Fetches the enrichments, and attaches them as directed in the `include` list

package/dist/types/search/getAddContentConfig.d.ts

@@ -0,0 +1,11 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { IHubCatalog, IQuery } from "./types/IHubCatalog";
+import { IAddContentWorkflowConfig } from "./types/AddContentWorkflowTypes";
+/**
+ * Get the add content configuration, given nothing, or a catalog or query.
+ * Delegates to the appropriate function based on the type of the input.
+ * @param context
+ * @param catalogOrQuery
+ * @returns
+ */
+export declare function getAddContentConfig(context: IArcGISContext, catalogOrQuery?: IQuery | IHubCatalog): IAddContentWorkflowConfig;

package/dist/types/search/getPredicateValues.d.ts

@@ -0,0 +1,8 @@
+import { IQuery } from "..";
+/**
+ * Get all the values for a predicate in a query
+ * @param predicateProp The predicate property to get the values for
+ * @param query The query to get the values from
+ * @returns An array of all the values for the predicate
+ */
+export declare function getPredicateValues(predicateProp: string, query: IQuery, props?: string[]): string[];

package/dist/types/search/searchCatalogs.d.ts

@@ -0,0 +1,15 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { ICatalogSearchResponse, IHubCatalog, IPagingOptions, IQuery, ISortOptions } from "./types";
+/**
+ * Given an array of catalog json objects, execute a search on all the collections
+ * in all the catalogs. If a scope exists without any associated collections in the catalog,
+ * the scope will be searched as well.
+ * If passed an IQuery, only collections using the same targetEntity will be searched
+ * If passed a string, a query will be executed on all collections in all catalogs
+ * @param catalogs
+ * @param query - string or IQuery
+ * @param options - IPagingOptions & ISortOptions - only num is used
+ * @param context
+ * @returns
+ */
+export declare function searchCatalogs(catalogs: IHubCatalog[], query: string | IQuery, options: IPagingOptions & ISortOptions, context: IArcGISContext): Promise<ICatalogSearchResponse[]>;

package/dist/types/search/searchEntityCatalogs.d.ts

@@ -0,0 +1,15 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { HubEntity } from "../core";
+import { ICatalogSearchResponse, IPagingOptions, IQuery, ISortOptions } from "./types";
+/**
+ * Given an entity, execute a search on all the catalogs, and their associated with the entity
+ * If the entity has no catalogs, an empty array is returned
+ * If passed an IQuery, only collections using the same targetEntity will be searched
+ * If passed a string, a query will be executed on all collections in all catalogs
+ * @param entity
+ * @param query - string or IQuery
+ * @param options - IPagingOptions & ISortOptions - only num is used
+ * @param context
+ * @returns
+ */
+export declare function searchEntityCatalogs(entity: HubEntity, query: string | IQuery, options: IPagingOptions & ISortOptions, context: IArcGISContext): Promise<ICatalogSearchResponse[]>;

package/dist/types/search/types/AddContentWorkflowTypes.d.ts

@@ -0,0 +1,36 @@
+import { IGroupsByMembership } from "./IGroupsByMembership";
+import { EntityType, IQuery } from "./IHubCatalog";
+/**
+ * `AddContentWorkflow` is a string literal type that
+ * defines the possible "Add Content" workflows
+ */
+export declare type AddContentWorkflow = "create" | "upload" | "existing";
+/**
+ * `IAddContentWorkflowConfig` is an interface that defines the
+ * configuration for the "Add Content" workflows
+ */
+export interface IAddContentWorkflowConfig {
+    create?: IAddContentCreateWorkflowConfig;
+    upload?: IAddContentUploadWorkflowConfig;
+    existing?: IAddContentExistingWorkflowConfig;
+    state: "enabled" | "disabled";
+    reason?: "no-permission" | "not-in-groups" | "invalid-object" | "unsupported-target-entity";
+}
+export declare type AddContentWorkflowConfig = IAddContentCreateWorkflowConfig | IAddContentExistingWorkflowConfig | IAddContentUploadWorkflowConfig;
+interface IAddContentWorkflowBaseConfig {
+    targetEntity: EntityType;
+    workflow: AddContentWorkflow;
+    types: string[];
+    groups?: IGroupsByMembership;
+}
+export interface IAddContentCreateWorkflowConfig extends IAddContentWorkflowBaseConfig {
+    workflow: "create";
+}
+export interface IAddContentExistingWorkflowConfig extends IAddContentWorkflowBaseConfig {
+    workflow: "existing";
+    query: IQuery;
+}
+export interface IAddContentUploadWorkflowConfig extends IAddContentWorkflowBaseConfig {
+    workflow: "upload";
+}
+export {};

package/dist/types/search/types/IGroupsByMembership.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Arrays of groupId's, based on the user's membership in the group
+ */
+export interface IGroupsByMembership {
+    /**
+     * Groups where the user is the owner, allowing them
+     * to add / remove members, as well as share content
+     * they do not own
+     */
+    owner: string[];
+    /**
+     * Groups where the user is an admin, allowing them
+     * to add / remove members, as well as share content
+     * they do not own
+     */
+    admin: string[];
+    /**
+     * Groups where the user is a member. ViewOnly groups
+     * will not be included in this list.
+     */
+    member: string[];
+}

package/dist/types/search/types/IHubCatalog.d.ts

@@ -4,6 +4,10 @@ export interface IHubCatalog {
      * Title for the Gallery
      */
     title?: string;
+    /**
+     * Optional Emoji to show in the UI
+     */
+    emojii?: string;
     /**
      * Filter defines the "scopes" of the Catalog, on a per entity type basis
      */
@@ -16,6 +20,16 @@ export interface IHubCatalog {
      * Schema Version
      */
     schemaVersion: number;
+    /**
+     * Hashes to verify the integrity of the catalog
+     * Only verified when the catalog is loaded into the editor
+     * If the hashes do not match, the catalog will not be loaded
+     * and the user will simply have the option to reset the catalog
+     */
+    integrity?: {
+        scopes: string;
+        collections: string;
+    };
 }
 export interface ICatalogScope extends Partial<Record<EntityType, IQuery>> {
 }

package/dist/types/search/types/IHubSearchOptions.d.ts

@@ -3,10 +3,38 @@ import { IHubRequestOptions } from "../../types";
 import { EntityType } from "./IHubCatalog";
 import { NamedApis, IApiDefinition } from "./types";
 export declare type Enrichments = "data" | "metadata" | "org" | "service" | "layers";
+/**
+ * Paging Options
+ * Separated out from IHubSearchOptions to allow for reuse
+ */
+export interface IPagingOptions {
+    /**
+     * Maximum number of results to return, per-page
+     */
+    num?: number;
+    /**
+     * The result number of the first entry in the result set response. The start parameter, along with the num parameter, can be used to paginate the search results.
+     */
+    start?: number;
+}
+/**
+ * Sorting Options
+ * Separated out from IHubSearchOptions to allow for reuse
+ */
+export interface ISortOptions {
+    /**
+     * What field should the results be sorted on
+     */
+    sortField?: string;
+    /**
+     * Sort direction
+     */
+    sortOrder?: "desc" | "asc";
+}
 /**
  * Search Options
  */
-export interface IHubSearchOptions {
+export interface IHubSearchOptions extends IPagingOptions, ISortOptions {
     /**
      * Fields to return aggregations on
      */
@@ -49,24 +77,8 @@ export interface IHubSearchOptions {
      * Specify what entity to search for; For use with hubSearch
      */
     targetEntity?: EntityType;
-    /**
-     * Maximum number of results to return, per-page
-     */
-    num?: number;
     /**
      * LEGACY. Use `start` and `num` instead
      */
     page?: string;
-    /**
-     * What field should the results be sorted on
-     */
-    sortField?: string;
-    /**
-     * Sort direction
-     */
-    sortOrder?: "desc" | "asc";
-    /**
-     * The result number of the first entry in the result set response. The start parameter, along with the num parameter, can be used to paginate the search results.
-     */
-    start?: number;
 }

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

@@ -4,4 +4,4 @@ export * from "./IHubSearchResult";
 export * from "./IHubSearchResponse";
 export * from "./types";
 export * from "./IHubCatalog";
-export * from "./ISearchResponseHash";
+export * from "./AddContentWorkflowTypes";

package/dist/types/search/types/types.d.ts

@@ -1,4 +1,6 @@
 import { EntityType, IHubCatalog } from "./IHubCatalog";
+import { IHubSearchResponse } from "./IHubSearchResponse";
+import { IHubSearchResult } from "./IHubSearchResult";
 /**
  * Sort Option to be displayed in a UI
  */
@@ -110,3 +112,17 @@ export interface IContainsResponse {
      */
     duration?: number;
 }
+/**
+ * Response from a search operation on a Catalog
+ */
+export interface ICatalogSearchResponse {
+    catalogTitle: string;
+    collectionResults: ISearchResponseHash;
+    scopeResults?: ISearchResponseHash;
+}
+/**
+ * Response from a Catalog search operation where the responses for different collections
+ * or entities are grouped into a single object.
+ */
+export interface ISearchResponseHash extends Record<string, IHubSearchResponse<IHubSearchResult>> {
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.169.0",
+  "version": "14.171.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/search/types/ISearchResponseHash.js

@@ -1 +0,0 @@
-//# sourceMappingURL=ISearchResponseHash.js.map

package/dist/esm/search/types/ISearchResponseHash.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ISearchResponseHash.js","sourceRoot":"","sources":["../../../../src/search/types/ISearchResponseHash.ts"],"names":[],"mappings":""}

package/dist/node/search/types/ISearchResponseHash.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ISearchResponseHash.js","sourceRoot":"","sources":["../../../../src/search/types/ISearchResponseHash.ts"],"names":[],"mappings":""}

package/dist/types/search/types/ISearchResponseHash.d.ts

@@ -1,7 +0,0 @@
-import { IHubSearchResponse, IHubSearchResult } from ".";
-/**
- * Response from a Catalog search operation where the responses for different collections
- * or entities are grouped into a single object.
- */
-export interface ISearchResponseHash extends Record<string, IHubSearchResponse<IHubSearchResult>> {
-}