@esri/hub-common 9.7.0 → 9.8.0

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

@@ -105,16 +105,21 @@ export interface IWellKnownContentFilters {
 }
 export declare type NamedContentFilter = keyof IWellKnownContentFilters;
 export interface IUserFilterDefinition {
+    created?: IDateRange<number> | IRelativeDate;
     disabled?: boolean;
     email?: string | string[] | IMatchOptions;
     firstname?: string | string[] | IMatchOptions;
     fullname?: string | string[] | IMatchOptions;
     groups?: string | string[] | IMatchOptions;
+    lastlogin?: IDateRange<number> | IRelativeDate;
     lastname?: string | string[] | IMatchOptions;
+    modified?: IDateRange<number> | IRelativeDate;
+    role?: string | string[] | IMatchOptions;
+    term?: string;
+    userlicensetype?: string | string[] | IMatchOptions;
     username?: string | string[] | IMatchOptions;
 }
 export interface IGroupFilterDefinition {
-    term?: string;
     access?: string | string[] | IMatchOptions;
     created?: IDateRange<number> | IRelativeDate;
     id?: string | string[] | IMatchOptions;
@@ -124,6 +129,7 @@ export interface IGroupFilterDefinition {
     owner?: string | string[] | IMatchOptions;
     searchUserAccess?: "groupMember";
     tags?: string | string[] | IMatchOptions;
+    term?: string;
     title?: string | string[] | IMatchOptions;
     typekeywords?: string | string[] | IMatchOptions;
 }
@@ -207,6 +213,9 @@ export interface ICatalog {
     collections?: ICollection[];
     facets?: IFacet[];
 }
+/**
+ * Sort Option to be displayed in a UI
+ */
 export interface ISortOption {
     label: string;
     attribute: string;
@@ -219,11 +228,18 @@ export interface ICollection {
     filter: Filter<FilterType>;
     facets?: IFacet[];
 }
+/**
+ * Defines a span of time by specifying a `from` and `to` Date
+ * as either a number or a ISO string
+ */
 export interface IDateRange<T> {
     type?: "date-range";
     from: T;
     to: T;
 }
+/**
+ * Relative Date will be convertd to a `IDateRange` at run-time
+ */
 export interface IRelativeDate {
     type: "relative-date";
     num: number;
@@ -270,7 +286,7 @@ export interface IHubSearchOptions {
     aggregations?: string[];
     bbox?: string;
     fields?: string;
-    apis?: Array<NamedApis | IApiDefinition>;
+    api?: NamedApis | IApiDefinition;
 }
 /**
  * searchContent return
@@ -279,6 +295,8 @@ export interface IContentSearchResult {
     total: number;
     results: IHubContent[];
     facets?: IFacet[];
+    hasNext: boolean;
+    next: (params?: any) => Promise<IContentSearchResult>;
 }
 export interface IWellKnownApis {
     arcgis: IApiDefinition;

package/dist/types/search/user-utils.d.ts

@@ -0,0 +1,35 @@
+import { ISearchOptions } from "@esri/arcgis-rest-portal";
+import { Filter, IUserFilterDefinition } from "..";
+/**
+ *
+ * Merge `Filter<"user">` objects
+ *
+ * Useful in components which may get partial filters from a variety of
+ * sub-components, which are then combined into a single filter prior
+ * to executing the search.
+ * @param filters
+ * @returns
+ */
+export declare function mergeUserFilters(filters: Array<Filter<"user">>): Filter<"user">;
+/**
+ * Prior to serialization into the query syntax for the backing APIs, we first expand [Filters](../Filter)
+ *
+ * Filter's can express their intent in a very terse form, but to ensure consistent structures
+ * we expand them into their more verbose form.
+ *
+ * i.e. `firstname: "John"` expands into `firstname: { any: ["John"]}`
+ *
+ * - Fields defined as `string | string[] | MatchOptions` will be converted to a `MatchOptions`
+ * - RelativeDate fields are converted to DateRange<number>
+ * @param filter
+ * @returns
+ */
+export declare function expandUserFilter(filter: Filter<"user">): IUserFilterDefinition;
+/**
+ * @private
+ * Serialize an `IUserFilterDefinition` into an `ISearchOptions` for use
+ * with `searchUsers`
+ * @param filter
+ * @returns
+ */
+export declare function serializeUserFilterForPortal(filter: IUserFilterDefinition): ISearchOptions;

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

@@ -1,5 +1,7 @@
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis, IContentSearchResult } from "./types";
+import { IUser } from "@esri/arcgis-rest-auth";
+import { IGroup, ISearchOptions } from "@esri/arcgis-rest-portal";
+import { ISearchResponse } from "..";
+import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis } from "./types";
 /**
  * Well known APIs
  * Short-forms for specifying common APIs
@@ -7,20 +9,18 @@ import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinitio
 export declare const SEARCH_APIS: IWellKnownApis;
 /**
  * @private
- * Convert api "names" into full ApiDefinitions
+ * Convert array of api "names" into full ApiDefinitions
  * @param apis
  * @returns
  */
 export declare function expandApis(apis: Array<NamedApis | IApiDefinition>): IApiDefinition[];
 /**
  * @private
- * Merge multiple search responses
- *
- * Naieve implementation that just merges arrays
- * @param responses
+ * Convert an api "name" into a full ApiDefinition
+ * @param api
  * @returns
  */
-export declare function mergeSearchResults(responses: IContentSearchResult[]): IContentSearchResult;
+export declare function expandApi(api: NamedApis | IApiDefinition): IApiDefinition;
 /**
  * @private
  * Merge two date ranges by taking the longest span
@@ -90,3 +90,34 @@ export declare function serializeDateRange(key: string, range: IDateRange<number
  * @returns
  */
 export declare function serializeStringOrArray(join: "AND" | "OR", key: string, value: string | string[]): string;
+/**
+ * Create a `.next()` function for a type
+ * @param request
+ * @param nextStart
+ * @param total
+ * @param fn
+ * @returns
+ */
+export declare function getNextFunction<T>(request: ISearchOptions, nextStart: number, total: number, fn: (r: any) => Promise<ISearchResponse<T>>): () => Promise<ISearchResponse<T>>;
+/**
+ * Construct a the full url to a group thumbnail
+ *
+ * - If the group has a thumbnail, construct the full url
+ * - If the group is not public, append on the token
+ * @param portalUrl
+ * @param group
+ * @param token
+ * @returns
+ */
+export declare function getGroupThumbnailUrl(portalUrl: string, group: IGroup, token?: string): string;
+/**
+ * Construct a the full url to a user thumbnail
+ *
+ * - If the user has a thumbnail, construct the full url
+ * - If the user is not public, append on the token
+ * @param portalUrl
+ * @param user
+ * @param token
+ * @returns
+ */
+export declare function getUserThumbnailUrl(portalUrl: string, user: IUser, token?: string): string;

package/dist/types/types.d.ts

@@ -3,6 +3,7 @@ import { IPortal, ISearchResult } from "@esri/arcgis-rest-portal";
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { IStructuredLicense } from "./items/get-structured-license";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IFacet } from "./search";
 /**
  * Generic Model, used with all items that have a json
  * `/data` payload
@@ -395,4 +396,20 @@ export interface IHubTeam extends IGroup {
         [key: string]: any;
     };
 }
+/**
+ * Defines a generic search response interface with parameterized result type
+ * for different types of searches
+ *
+ * total - total number of results
+ * results - potentially paginated list of results
+ * hasNext - boolean flag for if there are any more pages ofresults
+ * next - invokable function for obtaining next page of results
+ */
+export interface ISearchResponse<T> {
+    total: number;
+    results: T[];
+    hasNext: boolean;
+    next: (params?: any) => Promise<ISearchResponse<T>>;
+    facets?: IFacet[];
+}
 export {};

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

@@ -3,6 +3,7 @@ export * from "./get-hub-locale-asset-url";
 export * from "./get-portal-api-url";
 export * from "./get-portal-url";
 export * from "./hub-cdn-urlmap";
+export * from "./upgrade-protocol";
 export * from "./strip-protocol";
 export * from "./_get-http-and-https-uris";
 export * from "./_get-location";

package/dist/types/urls/upgrade-protocol.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Add protocol or upgrade http to https
+ * @param {string} url
+ */
+export declare function upgradeProtocol(url: string): string;