@esri/hub-common 9.10.1 → 9.10.2

package/dist/types/items/serialize-model.d.ts

@@ -0,0 +1,12 @@
+import { IModel } from "../types";
+import { IItem } from "@esri/arcgis-rest-types";
+interface ISerializedModel extends IItem {
+    text: string;
+}
+/**
+ * Given a model, return a serialized clone that can be sent to
+ * the items api
+ * @param {Object} model Item model {item:{}, data:{}}
+ */
+export declare function serializeModel(model: IModel): ISerializedModel;
+export {};

package/dist/types/items/share-item-to-groups.d.ts

@@ -0,0 +1,9 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * Share an item to a set of groups
+ * @param {String} itemId Iten Id to share to the groups
+ * @param {Array} groups Array of group id's to which the item will be shared
+ * @param {String} owner optional Owner username to determine which endpoint to hit
+ * @param {*} requestOptions
+ */
+export declare function shareItemToGroups(itemId: string, groups: string[], requestOptions: IRequestOptions, owner?: string): Promise<import("@esri/arcgis-rest-portal").ISharingResponse[]>;

package/dist/types/items/unprotect-model.d.ts

@@ -0,0 +1,11 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../types";
+/**
+ * Given a model, determine if it is protected, and unprotect it if it is.
+ * Otherwise, just resolve with the same result.
+ * @param {Object} model Model Object
+ * @param {IRequestOptions} requestOptions
+ */
+export declare function unprotectModel(model: IModel, requestOptions: IRequestOptions): Promise<{
+    success: boolean;
+}>;

package/dist/types/items/unshare-item-from-groups.d.ts

@@ -0,0 +1,10 @@
+import { ISharingResponse } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * Unshare an item from a set of groups
+ * @param {String} itemId Item Id to unshare from groups
+ * @param {Array} groups Array of group id's from which the item will be unshared
+ * @param {String} owner optional Owner username to determine which endpoint to hit
+ * @param {IRequestOptions} requestOptions
+ */
+export declare function unshareItemFromGroups(itemId: string, groups: string[], requestOptions: IRequestOptions, owner?: string): Promise<ISharingResponse[]>;

package/dist/types/objects/_deep-map-values.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Maps over _all_ values of an object graph
+ * @param object
+ * @param callback function to be called on each value
+ * @param propertyPath an initial path (optional, only changes what is passed to the callback as the "path" argument)
+ * @private
+ */
+export declare function _deepMapValues(object: Record<string, any>, callback: (val: any, path: string) => any, propertyPath?: string): any;
+/**
+ * Is this a string?
+ * @param v
+ * @private
+ */
+export declare function _isString(v: any): boolean;
+/**
+ * Return if the passed entry is a Date
+ * @param v
+ * @private
+ */
+export declare function _isDate(v: any): boolean;
+/**
+ * Is this a function?
+ * @param v
+ * @private
+ */
+export declare function _isFunction(v: any): boolean;
+/**
+ * Is this an Object?
+ * @param v
+ * @private
+ */
+export declare function _isObject(v: any): boolean;
+/**
+ * Is this a regexp?
+ * @param v
+ * @private
+ */
+export declare function _isRegExp(v: any): boolean;

package/dist/types/objects/_map-values.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Maps over the values of an object (one level deep)
+ * @param obj
+ * @param fn
+ * @private
+ */
+export declare function _mapValues(obj: Record<string, any>, fn: (value: any, key: any, obj: any) => void): Record<string, any>;

package/dist/types/objects/deep-set.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Deep set function. Like Ember.set, but smarter as it will create the path
+ * @param {Object} target Object we want to set the property on
+ * @param {String} path Dotted path to the property we want to set
+ * @param {Any} value Value we want to assign to the property
+ */
+export declare function deepSet(target: Record<string, any>, path: string, value?: any): void;

package/dist/types/objects/deep-string-replace.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Iterate over an object graph, and for all string properties, search for a string,
+ * and replace it with another string
+ */
+export declare function deepStringReplace(obj: Record<string, any>, stringOrRegex: string | RegExp, replacement: string): Record<string, any>;

package/dist/types/objects/deepFind.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Traverse a graph, locating the first entry with an `id` property that
+ * has a specific string or number value
+ *
+ * ```js
+ * const l = {
+ *  one: {
+ *    two: [
+ *      {
+ *        id: "n001",
+ *        color: "red"
+ *      },
+ *      {
+ *        id: "n002",
+ *        color: "yellow"
+ *      }
+ *    ]
+ *  }
+ * };
+ *
+ * const config = deepFindById(l, "n002")
+ * //> {id: "n002", color:"yellow"}
+ * ```
+ *
+ * This was designed to search a Site/Page/Project layout, and return
+ * the config for a card. There was some concern about the performance
+ * and using a real layout object, in the test, it takes ~1.5ms to
+ * do the search.
+ *
+ * @param object
+ * @param key
+ * @param value
+ * @returns
+ */
+export declare function deepFindById(object: any, value: string | number): any;
+/**
+ * Traverse a graph locating an entry that passes the predicate
+ *
+ * @param object
+ * @param predicate
+ * @returns
+ */
+export declare function deepFind(object: any, predicate: (object: any) => boolean): any;

package/dist/types/objects/ensure-prop.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Ensure that an object has a deep property path.
+ * This will replace any existing object at the end of the path
+ * @param {Object} target Object we want to ensure has some deep property
+ * @param {string} path Dotted path to the property we want to ensure exists
+ */
+export declare function ensureProp(target: Record<string, any>, path: string): void;

package/dist/types/objects/get-prop.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get a property out of a deeply nested object
+ * Does not handle anything but nested object graph
+ */
+export declare function getProp(obj: {
+    [index: string]: any;
+}, path: string): any;

package/dist/types/objects/get-props.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Given an array of prop paths, return all the values that exist, in an array
+ */
+export declare function getProps(obj: {
+    [index: string]: any;
+}, props: string[]): any[];

package/dist/types/objects/get-with-default.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Gets the value of a property from an object with a
+ * default if that prop is undefined
+ * @param obj
+ * @param prop
+ * @param def
+ */
+export declare function getWithDefault(obj: {
+    [key: string]: any;
+}, prop: string, def: any): any;

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

@@ -0,0 +1,12 @@
+export * from "./_deep-map-values";
+export * from "./_map-values";
+export * from "./deep-set";
+export * from "./ensure-prop";
+export * from "./get-prop";
+export * from "./get-props";
+export * from "./get-with-default";
+export * from "./remove-empty-props";
+export * from "./deep-string-replace";
+export * from "./merge-objects";
+export * from "./set-prop";
+export * from "./deepFind";

package/dist/types/objects/merge-objects.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Apply a specified set properties from a source object to a target object
+ *
+ * @param {Object} source The source object
+ * @param {Object} target The target object
+ * @param {Array} allowList Array of property paths (if not provided, source returned)
+ */
+export declare function mergeObjects(source: any, target: any, allowList?: string[]): any;

package/dist/types/objects/remove-empty-props.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Remove empty properties from an object graph
+ * @param {Object} obj Object to remove empty/null properties from
+ */
+export declare function removeEmptyProps(obj: {
+    [index: string]: any;
+}): {
+    [index: string]: any;
+};

package/dist/types/objects/set-prop.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Sets a deep object property, constructing the property path as necessary
+ *
+ * @param path - the path to the property we want to set
+ * @param val - the value we want to set it to
+ * @param obj - the target object
+ */
+export declare function setProp(path: string | string[], val: any, obj: any): void;

package/dist/types/request.d.ts

@@ -0,0 +1,24 @@
+import { IHubRequestOptions } from "./types";
+/**
+ * remote server error
+ */
+export declare class RemoteServerError extends Error {
+    status: number;
+    url: string;
+    constructor(message: string, url: string, status: number);
+}
+/**
+ * ```js
+ * import { hubApiRequest } from "@esri/hub-common";
+ * //
+ * hubApiRequest(
+ *   "/datasets",
+ *   requestOptions
+ * })
+ *   .then(response);
+ * ```
+ * make a request to the Hub API
+ * @param route API route
+ * @param requestOptions request options
+ */
+export declare function hubApiRequest(route: string, requestOptions?: IHubRequestOptions): Promise<any>;

package/dist/types/resources/_add-token-to-resource-url.d.ts

@@ -0,0 +1,8 @@
+import { IHubRequestOptions } from "../types";
+/**
+ * Add a token to the resource request if the request is to the portal
+ * @param {string} url Resource Url
+ * @param {IRequestOptions} requestOptions
+ * @private
+ */
+export declare function _addTokenToResourceUrl(url: string, requestOptions: IHubRequestOptions): string;

package/dist/types/resources/add-solution-resource-url-to-assets.d.ts

@@ -0,0 +1,7 @@
+import { IModelTemplate, IHubRequestOptions, ITemplateAsset } from "../types";
+/**
+ * Add a url property to the entries in the assets hash
+ * @param {IModelTemplate} template
+ * @param {IHubRequestOptions} hubRequestOptions
+ */
+export declare function addSolutionResourceUrlToAssets(template: IModelTemplate, hubRequestOptions: IHubRequestOptions): ITemplateAsset[];

package/dist/types/resources/convert-solution-template-resources-to-assets.d.ts

@@ -0,0 +1,9 @@
+import { IHubRequestOptions, ITemplateAsset, IModelTemplate } from "../types";
+/**
+ * Convert the resources array on an individual template in a solution
+ * into an assets array that can be used to upload the resources to
+ * the newly created item.
+ * @param {object} template Template from a Solution
+ * @param {IHubRequestOptions} hubRequestOptions
+ */
+export declare function convertSolutionTemplateResourcesToAssets(template: IModelTemplate, hubRequestOptions: IHubRequestOptions): ITemplateAsset[];

package/dist/types/resources/fetch-and-upload-resource.d.ts

@@ -0,0 +1,13 @@
+import { IItemResourceResponse } from "@esri/arcgis-rest-portal";
+import { UserSession } from "@esri/arcgis-rest-auth";
+/**
+ * Fetch image from a url, and upload as a resource
+ * @param {Object} options {id, owner, fileName, url, authentication}
+ */
+export declare function fetchAndUploadResource(options: {
+    id: string;
+    owner: string;
+    fileName: string;
+    url: string;
+    authentication: UserSession;
+}): Promise<IItemResourceResponse>;

package/dist/types/resources/fetch-and-upload-thumbnail.d.ts

@@ -0,0 +1,12 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
+/**
+ * Fetch image from a url, then upload to an item as it's thumbnail
+ * @param {object} options
+ */
+export declare function fetchAndUploadThumbnail(options: {
+    id: string;
+    owner: string;
+    fileName: string;
+    url: string;
+    authentication: UserSession;
+}): Promise<any>;

package/dist/types/resources/fetch-image-as-blob.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Given a url to an image, return it as a blob
+ * @param {String} url Url to fetch the image from. Must have token if it's a non-publi item resource url
+ * @param {Object} options additional optinos
+ */
+export declare function fetchImageAsBlob(url: string, options?: RequestInit): Promise<Blob>;

package/dist/types/resources/get-item-assets.d.ts

@@ -0,0 +1,9 @@
+import { IHubRequestOptions, ITemplateAsset } from "../types";
+import { IItem } from "@esri/arcgis-rest-types";
+/**
+ * Given an item, return an array of assets that includes
+ * all the resources, as well as the thumbnail
+ * @param {object} item Item
+ * @param {IHubRequestOptions} IHubRequestOptions
+ */
+export declare function getItemAssets(item: IItem, hubRequestOptions: IHubRequestOptions): Promise<ITemplateAsset[]>;

package/dist/types/resources/get-item-thumbnail-url.d.ts

@@ -0,0 +1,16 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-types";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubRequestOptions } from "../types";
+export interface IThumbnailOptions {
+    token?: string;
+    width?: number;
+}
+/**
+ * Get the fully qualified URL for an item's thumbnail
+ * @param item w/ id, thumbnail, and access
+ * @param portalUrlOrObject a portal base or API URL, a portal object, or request options containing either of those
+ * @param optionsOrToken options including width and/or token for the current user's session; will only be appended as a query parameter if the item's access is **not** `public`
+ * @returns URL to the item's thumbnail, defaults to `https://www.arcgis.com/sharing/rest/content/items/{item.id}/info/{item.thumbnail}`. Returns `null` if the item does not have a thumbnail assigned.
+ */
+export declare function getItemThumbnailUrl(item: IItem, portalUrlOrObject?: string | IPortal | IHubRequestOptions | IRequestOptions, optionsOrToken?: IThumbnailOptions | string): string | null;

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

@@ -0,0 +1,11 @@
+export * from "./_add-token-to-resource-url";
+export * from "./convert-solution-template-resources-to-assets";
+export * from "./fetch-and-upload-resource";
+export * from "./fetch-and-upload-thumbnail";
+export * from "./fetch-image-as-blob";
+export * from "./get-item-assets";
+export * from "./get-item-thumbnail-url";
+export * from "./string-to-blob";
+export * from "./upload-resources-from-url";
+export * from "./add-solution-resource-url-to-assets";
+export * from "./object-to-json-blob";

package/dist/types/resources/object-to-json-blob.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Convert an object to a Blob with type  'application/json'
+ * @param {*} obj
+ * @returns Blob
+ */
+export declare function objectToJsonBlob(obj: any): Blob;

package/dist/types/resources/string-to-blob.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Given a string, return it as a blob
+ * NOTE: USE objectToJsonBlob if you're saving a JSON resource!!!
+ * NOTE: This is not currently supported in Node
+ * @param {string} the string
+ */
+export declare function stringToBlob(s: string, type?: string): Blob;

package/dist/types/resources/upload-resources-from-url.d.ts

@@ -0,0 +1,8 @@
+import { IModel, IHubRequestOptions, IItemResource } from "../types";
+/**
+ * Given an Item and an array of resources, upload them
+ * @param {Object} itemModel Item add the resource to
+ * @param {Array} resources Array of resources, with urls, to upload to the item
+ * @param {Object} requestOptions {authentication}
+ */
+export declare function uploadResourcesFromUrl(itemModel: IModel, resources: IItemResource[], requestOptions: IHubRequestOptions): Promise<any[]>;

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

@@ -0,0 +1,8 @@
+import { Filter, IHubSearchOptions } from "./types";
+import { IHubContent, ISearchResponse } from "..";
+/**
+ * Search for content via the Portal or Hub API
+ * @param filter
+ * @param options
+ */
+export declare function _searchContent(filter: Filter<"content">, options: IHubSearchOptions): Promise<ISearchResponse<IHubContent>>;

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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,73 @@
+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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,9 @@
+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";