@esri/hub-common 9.8.1 → 9.10.1

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

@@ -1,16 +0,0 @@
-import { IGroup } from "@esri/arcgis-rest-portal";
-import { Filter, IFacet, IHubSearchOptions } from "./types";
-import { ISearchResponse } from "..";
-export interface IGroupSearchResult {
-    groups: IGroup[];
-    facets: IFacet[];
-}
-/**
- * Search Groups using Filter<"group">
- *
- * Currently just returns ISearchResult<IGroup>
- * @param filter
- * @param options
- * @returns
- */
-export declare function _searchGroups(filter: Filter<"group">, options: IHubSearchOptions): Promise<ISearchResponse<IGroup>>;

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

@@ -1,28 +0,0 @@
-import { IUser, UserSession } from "@esri/arcgis-rest-auth";
-import { Filter, IHubSearchOptions, ISearchResponse } from "..";
-/**
- * Extends IHubSearchOptions to make auth mandatory
- */
-export interface IAuthenticatedHubSearchOptions extends IHubSearchOptions {
-    authentication: UserSession;
-}
-/**
- * Extends `IUser` with url optional props for the user's
- * profile and thumbnail
- */
-export interface IHubUser extends IUser {
-    profileUrl?: string;
-    thumbnailUrl?: string;
-}
-/**
- * Search for Users via the Portal API.
- *
- * **Note** Authentication is required
- *
- * Note: in the future, there may be options to search via
- * a Hub specific API
- * @param filter
- * @param options
- * @returns
- */
-export declare function _searchUsers(filter: Filter<"user">, options: IAuthenticatedHubSearchOptions): Promise<ISearchResponse<IHubUser>>;

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

@@ -1,73 +0,0 @@
-import { IGroup, IItem, ISearchOptions, ISearchResult } from "@esri/arcgis-rest-portal";
-import { IContentFilter, IContentFilterDefinition, Filter, IFacet } from "./types";
-/**
- * @private
- * Convert portal search response to items
- * @param response
- * @returns
- */
-export declare function convertPortalResponseToFacets(response: ISearchResult<IItem> | ISearchResult<IGroup>): IFacet[];
-/**
- * Merge `Filter<"content">` 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 mergeContentFilter(filters: Array<Filter<"content">>): Filter<"content">;
-/**
- * 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. `title: "Water"` expands into `title: { any: ["Water"]}`
- *
- * - "well known" type values are expanded
- *    - i.e. `type: "$storymap"` expands into two `subFilter` entries
- * - 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 expandContentFilter(filter: Filter<"content">): IContentFilter;
-/**
- * @private
- * Expand from a well-known "type" into it's longer form
- *
- * i.e. `type: "$storymap"` expands into two subFilters entries
- *
- * @param filter
- * @returns
- */
-export declare function expandTypeField(filter: Filter<"content">): Filter<"content">;
-/**
- * @private
- * Convert a `ContentFilterDefinition` to a `ContentFilter`
- *
- * ContentFilter is a narrower version of ContentFilterDefinition, without
- * the union types. Using a ContentFilter makes working with the structure
- * in typescript much easier.
- *
- * @param filter
- * @returns
- */
-export declare function convertContentDefinitionToFilter(filter: IContentFilterDefinition): IContentFilter;
-/**
- * @private
- * Serialize a `ContentFilter` into an `ISearchOptions` for use with `searchItems`
- * @param filter
- * @returns
- */
-export declare function serializeContentFilterForPortal(filter: IContentFilter): ISearchOptions;
-/**
- * @private
- * Convert a ContentFilter to a SearchOptions
- *
- * @param filter
- * @returns
- */
-export declare function convertContentFilterToSearchOptions(filter: IContentFilter): ISearchOptions;

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

@@ -1,36 +0,0 @@
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { Filter, IGroupFilterDefinition } from ".";
-/**
- *
- * Merge `Filter<"group">` 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 mergeGroupFilters(filters: Array<Filter<"group">>): Filter<"group">;
-/**
- * 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. `title: "Water"` expands into `title: { any: ["Water"]}`
- *
- * - 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 expandGroupFilter(filter: Filter<"group">): IGroupFilterDefinition;
-/**
- * @private
- * Serialize an `IGroupFilterDefinition` into an `ISearchOptions` for use
- * with `searchGroups`
- * @param filter
- * @returns
- */
-export declare function serializeGroupFilterForPortal(filter: IGroupFilterDefinition): ISearchOptions;

package/dist/types/search/hub-api-search.d.ts

@@ -1,10 +0,0 @@
-import { DatasetResource, IHubRequestOptions } from "..";
-/**
- * Search the Hub API
- *
- * @param requestOptions
- * @returns JSONAPI response
- */
-export declare function hubApiSearch(requestOptions: IHubRequestOptions): Promise<{
-    data: DatasetResource[];
-}>;

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

@@ -1,9 +0,0 @@
-export * from "./hub-api-search";
-export * from "./content-utils";
-export * from "./group-utils";
-export * from "./user-utils";
-export * from "./utils";
-export * from "./types";
-export * from "./_searchContent";
-export * from "./_searchGroups";
-export * from "./_searchUsers";

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

@@ -1,315 +0,0 @@
-import { UserSession } from "@esri/arcgis-rest-auth";
-import { IHubContent, IModel } from "..";
-/**
- * Generic filter used with various search functions.
- *
- * `Filter<T extends FilterType>` [FilterType](../FilterType) is constrained to
- *
- * - `Filter<"any">` [IAnyFilterDefinition](../IAnyFilterDefinition)
- * - `Filter<"content">` [IContentFilterDefinition](../IContentFilterDefinition)
- * - `Filter<"user">` [IUserFilterDefinition](../IUserFilterDefinition)
- * - `Filter<"group">` [IGroupFilterDefinition](../IGroupFilterDefinition)
- *
- * When constructing a Filter as json, the `filterType` must be specified,
- * and it must be `keyof` [FilterTypeMap](../FilterTypeMap)
- *
- * ```ts
- * const f:Filter<"content"> = {
- *   filterType: "content" // must match the FilterType
- *   term: "water"
- * }
- * ```
- */
-export declare type Filter<T extends FilterType> = IFilterTypeMap[T] & {
-    filterType: T;
-};
-/**
- * Defines the valid FilterTypes for use with `Filter<T extends FilterType>`
- * See [Filter](../Filter)
- */
-export interface IFilterTypeMap {
-    any: IAnyFilterDefinition;
-    content: IContentFilterDefinition;
-    user: IUserFilterDefinition;
-    group: IGroupFilterDefinition;
-    event: IEventFilterDefinition;
-}
-export declare type FilterType = keyof IFilterTypeMap;
-/**
- * Common set of fields that are reasonable to apply at the
- * top level of a Catalog
- */
-export interface IAnyFilterDefinition {
-    title?: string | string[] | IMatchOptions;
-    access?: string | string[] | IMatchOptions;
-    owner?: string | string[] | IMatchOptions;
-    tags?: string | string[] | IMatchOptions;
-    created?: IDateRange<number> | IRelativeDate;
-    modified?: IDateRange<number> | IRelativeDate;
-    description?: string | string[] | IMatchOptions;
-    group?: string | string[] | IMatchOptions;
-    orgid?: string | string[] | IMatchOptions;
-    type?: string | NamedContentFilter | Array<string | NamedContentFilter> | IMatchOptions;
-}
-/**
- * Fields related to Content based searches
- */
-export interface IContentFilterDefinition {
-    access?: string | string[] | IMatchOptions;
-    owner?: string | string[] | IMatchOptions;
-    tags?: string | string[] | IMatchOptions;
-    created?: IDateRange<number> | IRelativeDate;
-    description?: string | string[] | IMatchOptions;
-    snippet?: string | string[] | IMatchOptions;
-    group?: string | string[] | IMatchOptions;
-    id?: string | string[] | IMatchOptions;
-    modified?: IDateRange<number> | IRelativeDate;
-    orgid?: string | string[] | IMatchOptions;
-    term?: string;
-    title?: string | string[] | IMatchOptions;
-    type?: string | NamedContentFilter | Array<string | NamedContentFilter> | IMatchOptions;
-    typekeywords?: string | string[] | IMatchOptions;
-    [key: string]: any;
-    /**
-     * @internal
-     * Support for complex OR queries; Used with various expansions
-     */
-    subFilters?: Array<IContentFilterDefinition | NamedContentFilter>;
-}
-export interface IContentFilter {
-    access?: IMatchOptions;
-    created?: IDateRange<number>;
-    description?: IMatchOptions;
-    group?: IMatchOptions;
-    id?: IMatchOptions;
-    modified?: IDateRange<number>;
-    orgid?: IMatchOptions;
-    owner?: IMatchOptions;
-    tags?: IMatchOptions;
-    term?: string;
-    title?: IMatchOptions;
-    type?: IMatchOptions;
-    typekeywords?: IMatchOptions;
-    [key: string]: any;
-    subFilters?: IContentFilter[];
-}
-export interface IWellKnownContentFilters {
-    $apps: IContentFilterDefinition[];
-    $dashboard: IContentFilterDefinition[];
-    $dataset: IContentFilterDefinition[];
-    $experience: IContentFilterDefinition[];
-    $site: IContentFilterDefinition[];
-    $storymap: IContentFilterDefinition[];
-    $initiative: IContentFilterDefinition[];
-    $document: IContentFilterDefinition[];
-}
-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 {
-    access?: string | string[] | IMatchOptions;
-    created?: IDateRange<number> | IRelativeDate;
-    id?: string | string[] | IMatchOptions;
-    isInvitationOnly?: boolean;
-    modified?: IDateRange<number> | IRelativeDate;
-    orgid?: string | string[] | IMatchOptions;
-    owner?: string | string[] | IMatchOptions;
-    searchUserAccess?: "groupMember";
-    tags?: string | string[] | IMatchOptions;
-    term?: string;
-    title?: string | string[] | IMatchOptions;
-    typekeywords?: string | string[] | IMatchOptions;
-}
-export interface IEventFilterDefinition {
-    created?: IDateRange<number> | IRelativeDate;
-    modified?: IDateRange<number> | IRelativeDate;
-    orgid?: string | string[] | IMatchOptions;
-    title?: string | string[] | IMatchOptions;
-}
-export interface IFacet {
-    label: string;
-    attribute?: string;
-    type: "single-select" | "multi-select" | "date-range" | "histogram";
-    options?: IFacetOption[];
-}
-export interface IFacetOption {
-    label: string;
-    value: string;
-    count?: number;
-    selected: boolean;
-    filter: Filter<FilterType>;
-}
-/**
- * Catalog is the definition which powers what options
- * are available in a Gallery. It controls not only
- * the scoping of the search, but also the options
- * available to the UX.
- *
- * Thus the lower-level `searchContent`, `searchUser`, `searchGroup` functions
- * do not take Catalogs, rather they accept [Filters](../Filter)
- *
- * ```ts
- * const simpleCatalog:Catalog = {
- *   title: "Select Map",
- *   filter: {
- *     filterType: "content",
- *     type: "Web Map",
- *     owner: "jsmith"
- *   }
- * }
- * ```
- *
- * ## Collections
- * The key feature of a Catalog is the ability to defined [Collections](../Collection).
- * These are essentially sub-sets of content, typically organized around
- * generalized content types, i.e. "Datasets", vs "Maps", vs "Documents"
- *
- *
- * ```ts
- * const complex:Catalog = {
- *   filter: {
- *    type: "content",
- *    groups: ["3ef", "bc4"]
- *   },
- *   collections: [
- *     {
- *       label: "Documents",
- *       filter: {
- *         filterType: "content",
- *         type: ["Microsoft Word", "PDF", "Microsoft Excel"]
- *       }
- *     },
- *     {
- *       label: "Datasets",
- *       filter: {
- *         filterType: "content",
- *         type: ["Feature Layer", "Feature Service", "Map Service", "CSV"]
- *       }
- *     }
- *   ]
- * }
- * ```
- */
-export interface ICatalog {
-    /**
-     * Title for the Gallery
-     */
-    title?: string;
-    filter: Filter<FilterType>;
-    sort?: ISortOption[];
-    collections?: ICollection[];
-    facets?: IFacet[];
-}
-/**
- * Sort Option to be displayed in a UI
- */
-export interface ISortOption {
-    label: string;
-    attribute: string;
-}
-/**
- * A Filter that defines a subset of a Catalog, aka a Collection
- */
-export interface ICollection {
-    label: string;
-    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;
-    unit: "minutes" | "hours" | "days" | "weeks" | "months" | "years";
-}
-/**
- * Define how values should be matched
- */
-export interface IMatchOptions {
-    /**
-     * return results which have ANY of the listed values
-     * for the specified field
-     */
-    any?: string | string[];
-    /**
-     * return resutls which have ALL of the listed values
-     * for the specified field
-     */
-    all?: string | string[];
-    /**
-     * return results which do not have any of the listed
-     * values for the specified field
-     */
-    not?: string | string[];
-    /**
-     * Depending on the API being searched, `exact` will
-     * attempt to structure the query such that it is an
-     * exact match. For Portal API, this may involve using
-     * the `filter` parameter, if the specific field can
-     * be used with that parameter
-     */
-    exact?: string | string[];
-}
-/**
- * Search Options
- */
-export interface IHubSearchOptions {
-    site?: IModel;
-    authentication?: UserSession;
-    sortField?: string;
-    sortOrder?: "desc" | "asc";
-    page?: string;
-    num?: number;
-    aggregations?: string[];
-    bbox?: string;
-    fields?: string;
-    api?: NamedApis | IApiDefinition;
-}
-/**
- * searchContent return
- */
-export interface IContentSearchResult {
-    total: number;
-    results: IHubContent[];
-    facets?: IFacet[];
-    hasNext: boolean;
-    next: (params?: any) => Promise<IContentSearchResult>;
-}
-export interface IWellKnownApis {
-    arcgis: IApiDefinition;
-    arcgisQA: IApiDefinition;
-    arcgisDEV: IApiDefinition;
-    hub: IApiDefinition;
-    hubQA: IApiDefinition;
-    hubDEV: IApiDefinition;
-}
-export declare type NamedApis = keyof IWellKnownApis;
-export interface IApiDefinition {
-    label?: string;
-    url: string;
-    type: "arcgis" | "arcgis-hub";
-    authentication?: UserSession;
-}

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

@@ -1,35 +0,0 @@
-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,123 +0,0 @@
-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
- */
-export declare const SEARCH_APIS: IWellKnownApis;
-/**
- * @private
- * Convert array of api "names" into full ApiDefinitions
- * @param apis
- * @returns
- */
-export declare function expandApis(apis: Array<NamedApis | IApiDefinition>): IApiDefinition[];
-/**
- * @private
- * Convert an api "name" into a full ApiDefinition
- * @param api
- * @returns
- */
-export declare function expandApi(api: NamedApis | IApiDefinition): IApiDefinition;
-/**
- * @private
- * Merge two date ranges by taking the longest span
- * @param dr1
- * @param dr2
- * @returns
- */
-export declare function mergeDateRange(dr1: IDateRange<number>, dr2: IDateRange<number>): IDateRange<number>;
-/**
- * @private
- * Merge two [`MatchOptions`](../MatchOptions)
- *
- * Currently a naieve implementation where the arrays are simply merged
- *
- * @param mo1
- * @param mo2
- * @returns
- */
-export declare function mergeMatchOptions(mo1: IMatchOptions, mo2: IMatchOptions): IMatchOptions;
-/**
- * @private
- * Convert a field value into a MatchOptions if it's not already one
- * @param value
- * @returns
- */
-export declare function valueToMatchOptions(value: string | string[] | IMatchOptions): IMatchOptions;
-/**
- * @private
- * Convert a RelativeDate to a DateRange<number>
- * @param relative
- * @returns
- */
-export declare function relativeDateToDateRange(relative: IRelativeDate): IDateRange<number>;
-/**
- * @private
- * As a final `ISearchOptions` object gets created, many such objects are created, and
- * need to be systematically "merged" so as to return consistently structured `q` and `filter`
- * values.
- * @param so1
- * @param so2
- * @param join
- * @returns
- */
-export declare function mergeSearchOptions(so1: ISearchOptions, so2: ISearchOptions, join: "AND" | "OR"): ISearchOptions;
-/**
- * @private
- * Serialize a `MatchOptions` into `q` or `filter` on an `ISearchOptions`
- * @param key
- * @param opts
- * @returns
- */
-export declare function serializeMatchOptions(key: string, opts: IMatchOptions): ISearchOptions;
-/**
- * @private
- * Serialize a DateRange<number> into a Portal Query string
- * @param key
- * @param range
- * @returns
- */
-export declare function serializeDateRange(key: string, range: IDateRange<number>): ISearchOptions;
-/**
- * @private
- * Serialize a `string` or `string[]` into a string
- * @param join
- * @param key
- * @param value
- * @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/sites/_apply-site-schema.d.ts

@@ -1,7 +0,0 @@
-import { IModel } from "../types";
-/**
- * Apply the first schema version to the item
- * @param {Object} model Site Model
- * @private
- */
-export declare function _applySiteSchema(model: IModel): IModel;

package/dist/types/sites/_enforce-lowercase-domains.d.ts

@@ -1,7 +0,0 @@
-import { IModel } from "..";
-/**
- * Enforce lowercase domains
- * @param {Object} model Site Model
- * @private
- */
-export declare function _enforceLowercaseDomains(model: IModel): IModel;

package/dist/types/sites/_ensure-catalog.d.ts

@@ -1,8 +0,0 @@
-import { IModel } from "..";
-/**
- * Move the data.values.groups array into the
- * data.catalog object
- * @param {Object} model Site Model
- * @private
- */
-export declare function _ensureCatalog(model: IModel): IModel;

package/dist/types/sites/_ensure-telemetry.d.ts

@@ -1,8 +0,0 @@
-import { IModel, IDraft } from "..";
-/**
- * Add telemetry config object
- * @private
- * @param {object} model Site Model
- * @returns {object}
- */
-export declare function _ensureTelemetry<T extends IModel | IDraft>(model: T): T;