@esri/hub-common 14.169.0 → 14.170.0

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.170.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>> {
-}