@esri/hub-common 9.8.1 → 9.10.1

package/dist/types/i18n/get-culture.d.ts

@@ -1,7 +0,0 @@
-import { IHubRequestOptions } from "../types";
-/**
- * Return the culture from the Hub Request Options
- * In priority order: user.culture, portal.culture, en-us
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function getCulture(hubRequestOptions: IHubRequestOptions): any;

package/dist/types/i18n/hub-locales.d.ts

@@ -1,4 +0,0 @@
-/**
- * Locales supported by the hub
- */
-export declare const HUB_LOCALES: string[];

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

@@ -1,4 +0,0 @@
-export * from "./convert-to-well-known-locale";
-export * from "./fetch-hub-translation";
-export * from "./get-culture";
-export * from "./hub-locales";

package/dist/types/index.d.ts

@@ -1,24 +0,0 @@
-export * from "./access";
-export * from "./api";
-export * from "./auth";
-export * from "./categories";
-export * from "./content";
-export * from "./downloads";
-export * from "./extent";
-export * from "./groups";
-export * from "./items";
-export * from "./objects";
-export * from "./resources";
-export * from "./search";
-export * from "./sites";
-export * from "./types";
-export * from "./urls";
-export * from "./util";
-export * from "./utils";
-export * from "./i18n";
-export * from "./request";
-export * from "./surveys";
-import OperationStack from "./OperationStack";
-import OperationError from "./OperationError";
-export { OperationStack, OperationError };
-export { btoa, atob } from "abab";

package/dist/types/items/_unprotect-and-remove-item.d.ts

@@ -1,10 +0,0 @@
-import { IUserItemOptions } from "@esri/arcgis-rest-portal";
-/**
- * Unprotect and Remove an Item
- * Assumes caller has checked that the curernt user should be able to
- * unprotect and remove the item. Underlying calls are failsafe
- * so a failure to unprotect or temove the item will not reject.
- * @param {IUserItemOptions} userItemOptions id and authentication
- * @private
- */
-export declare function _unprotectAndRemoveItem(userItemOptions: IUserItemOptions): Promise<any>;

package/dist/types/items/apply-properties-to-items.d.ts

@@ -1,8 +0,0 @@
-import { IItem } from "@esri/arcgis-rest-types";
-/**
- * Apply a hash of properties to an array of items.
- * Extracted to simplify testing.
- * @param {array} items Array of items to apply the properties to
- * @param {object} props hash of properties to apply to the item
- */
-export declare function applyPropertiesToItems(items: IItem[], props: Record<string, any>): IItem[];

package/dist/types/items/delete-prop.d.ts

@@ -1,7 +0,0 @@
-/**
- * Delete a property from an object using a deep path
- * MODIFIES PASSED TARGET
- * @param {Object} target Object from which we want to delete the property
- * @param {string} path Dotted path to the property we want to delete
- */
-export declare function deleteProp(target: Record<string, any>, lookupStr: string): void;

package/dist/types/items/does-item-exist-with-title.d.ts

@@ -1,5 +0,0 @@
-import { IAuthenticationManager } from "@esri/arcgis-rest-request";
-/**
- * Check if a site/page exists with a specific name
- */
-export declare function doesItemExistWithTitle(itemTitle: string, options: Record<string, string>, authMgr: IAuthenticationManager): Promise<boolean>;

package/dist/types/items/fail-safe-update.d.ts

@@ -1,10 +0,0 @@
-import { IModel } from "../types";
-import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
-/**
- * Update a model's item, wrapped in a failSafe so this will not blow up if
- * the user lacks rights somehow. This should be used in places where there is
- * a high-probability that the current user CAN update the item.
- * @param {Object} model Model object to be updated
- * @param {IRequestOptions} requestOptions
- */
-export declare function failSafeUpdate(model: IModel, requestOptions: IUserRequestOptions): Promise<any>;

package/dist/types/items/fetch-all-pages.d.ts

@@ -1,11 +0,0 @@
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { SearchableType, SearchFunction } from "../types";
-/**
- * Fetches all the pages in a search request
- * @param {SearchFunction} searchFunc
- * @param {ISearchOptions} opts
- * @param {number} limit
- * @param {batchSize} number of concurrent requests at a time
- * @returns {Promise<SearchableType[]>}
- */
-export declare function fetchAllPages(searchFunc: SearchFunction, opts: ISearchOptions, limit?: number, batchSize?: number): Promise<SearchableType[]>;

package/dist/types/items/get-model-from-options.d.ts

@@ -1,10 +0,0 @@
-import { IModel } from "../types";
-/**
- * To streamline passing of either a model id or the model itself, we use this function
- * to extract the model or fetch it, and return it. It uses `failSafe` and if the item
- * is not accessible for whatever reason, will return a model-ish object with `isMissing: true`
- * It is up to the caller to take approriate action
- * @param {String} modelType the type of model to extract from the options hash
- * @param {Object} options Something that extends IRequestOptions
- */
-export declare function getModelFromOptions(modelType: string, options: Record<string, any>): Promise<IModel>;

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

@@ -1,8 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
-/**
- * Gets the full item/data model for an item
- * @param {string} id Id of the item to fetch
- * @param {Object} requestOptions
- */
-export declare function getModel(id: string, requestOptions: IRequestOptions): Promise<IModel>;

package/dist/types/items/get-structured-license.d.ts

@@ -1,20 +0,0 @@
-export interface IStructuredLicense {
-    type: string;
-    name?: string;
-    text?: string;
-    abbr?: string;
-    url?: string;
-}
-export declare const STANDARD_LICENSES: {
-    type: string;
-    abbr: string;
-    name: string;
-    url: string;
-}[];
-/**
- * generates the structured license of an item based on its
- * configured "licenseInfo"
- * @param rawLicense an item's raw licenseInfo string
- * @returns {IStructuredLicense}
- */
-export declare function getStructuredLicense(rawLicense: string): IStructuredLicense;

package/dist/types/items/get-unique-item-title.d.ts

@@ -1,12 +0,0 @@
-import { IAuthenticationManager } from "@esri/arcgis-rest-request";
-/**
- * Given a title, construct a site/page title that is unique
- * if that title exists, this fn will add a number on the end, and increment until
- * an available title is found
- * @param {string} title site/page title to ensure if unique
- * @param {object} options an object that can be passed in to the q, eg. typekeywords, type
- * @param {object} authMgr auth info tells the function what url to use for the "root" of the API,
- * if missing, it will search against PROD
- * @param {number} step Number to increment. Defaults to 0
- */
-export declare function getUniqueItemTitle(title: string, options: Record<string, string>, authMgr: IAuthenticationManager, step?: number): Promise<string>;

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

@@ -1,18 +0,0 @@
-export * from "./_unprotect-and-remove-item";
-export * from "./apply-properties-to-items";
-export * from "./delete-prop";
-export * from "./fail-safe-update";
-export * from "./get-model";
-export * from "./get-model-from-options";
-export * from "./interpolate";
-export * from "./interpolate-item-id";
-export * from "./normalize-solution-template-item";
-export * from "./replace-item-id";
-export * from "./serialize-model";
-export * from "./share-item-to-groups";
-export * from "./unprotect-model";
-export * from "./unshare-item-from-groups";
-export * from "./does-item-exist-with-title";
-export * from "./get-unique-item-title";
-export * from "./fetch-all-pages";
-export * from "./get-structured-license";

package/dist/types/items/interpolate-item-id.d.ts

@@ -1,7 +0,0 @@
-import { IModelTemplate } from "../types";
-/**
- * Interpolate the item id back into any  {{appid}} instances
- * in the item. Allows for self-referencing in templates
- * @param {object} model Item Model
- */
-export declare function interpolateItemId(model: IModelTemplate | any): IModelTemplate | any;

package/dist/types/items/interpolate.d.ts

@@ -1,7 +0,0 @@
-/**
- * Interpolates handlebars-style placeholders on an object graph
- * @param template
- * @param settings
- * @param transforms
- */
-export declare function interpolate(template: any, settings: any, transforms?: any): any;

package/dist/types/items/normalize-solution-template-item.d.ts

@@ -1,9 +0,0 @@
-import { IItem } from "@esri/arcgis-rest-types";
-import { IItemTemplate } from "../types";
-export declare const itemPropsNotInTemplates: string[];
-/**
- * Given an item, remove a standard set of properties not needed in a template
- * TODO: This should land in a templating helper lib in hub.js
- * @param {Object} item Item to be normalized
- */
-export declare function normalizeSolutionTemplateItem(item: IItem): IItemTemplate;

package/dist/types/items/replace-item-id.d.ts

@@ -1,7 +0,0 @@
-import { IModel } from "../types";
-/**
- * Replaces instances of item ids on an item model
- * @param {Object} obj Object graph to traverse
- * @param {string} itemId id to replace with `{{appid}}`
- */
-export declare function replaceItemId(obj: IModel | Record<string, any>, itemId: string, replacement?: string): Record<string, any>;

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

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

@@ -1,8 +0,0 @@
-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 {*} requestOptions
- */
-export declare function shareItemToGroups(itemId: string, groups: string[], requestOptions: IRequestOptions): Promise<import("@esri/arcgis-rest-portal").ISharingResponse[]>;

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

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

@@ -1,9 +0,0 @@
-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 {IRequestOptions} requestOptions
- */
-export declare function unshareItemFromGroups(itemId: string, groups: string[], requestOptions: IRequestOptions): Promise<ISharingResponse[]>;

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

@@ -1,38 +0,0 @@
-/**
- * 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

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

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

@@ -1,5 +0,0 @@
-/**
- * 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

@@ -1,43 +0,0 @@
-/**
- * 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

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

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

@@ -1,6 +0,0 @@
-/**
- * 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

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

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

@@ -1,8 +0,0 @@
-/**
- * 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

@@ -1,9 +0,0 @@
-/**
- * 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

@@ -1,8 +0,0 @@
-/**
- * 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

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

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

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

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

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

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

@@ -1,6 +0,0 @@
-/**
- * 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

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

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

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

@@ -1,6 +0,0 @@
-/**
- * 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

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

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

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