@esri/hub-common 9.8.1 → 9.10.1

package/dist/types/sites/_migrate-feed-config.d.ts

@@ -1,15 +0,0 @@
-import { IModel } from "..";
-/**
- * Migrates the site so it can store configurations for multiple feed formats
- * (dcat-us-1.1, dcat-ap-2.0.1, etc.). If the site has an existing custom
- * configuration for dcat-us 1.1, a copy of that configuration will be modified
- * to use values from the v3 api instead of values from the index.
- *
- * Structural Impacts:
- * - site.data.feeds will be added.
- * - site.data.feeds.dcatUS11 will be added if site.data.values.dcatConfig exists.
- *
- * @param {object} model Site Model
- * @private
- */
-export declare function _migrateFeedConfig(model: IModel): IModel;

package/dist/types/sites/_purge-non-guids-from-catalog.d.ts

@@ -1,7 +0,0 @@
-import { IModel } from "..";
-/**
- * Remove any non-guid entries from the data catalog groups array
- * @param {object} model Site Model
- * @private
- */
-export declare function _purgeNonGuidsFromCatalog(model: IModel): IModel;

package/dist/types/sites/domains/_check-status-and-parse-json.d.ts

@@ -1,7 +0,0 @@
-/**
- * Parse a response object, and throw if it contains an error.
- * Just a wrapper to hide some platform idiosyncracies
- * @param {Response} response Response object to parse
- * @private
- */
-export declare function _checkStatusAndParseJson(response: Response): Promise<any>;

package/dist/types/sites/domains/_ensure-safe-domain-length.d.ts

@@ -1,12 +0,0 @@
-/**
- * Ensure that a subdomain is not greater than 63 characters in length
- * Subdomains are prep-ended on the org's url key, and the combined
- * length can not exceed 63 chars as per rules of domains.
- * If the requested subdomain + the url key is > 63 chars, we
- * strip off the last 6 chars and replace that w/ random characeters
- * This was an actual reported bug.
- * @param {String} subdomain Proposed subdomain
- * @param {String} urlKey Org url key
- * @private
- */
-export declare function _ensureSafeDomainLength(subdomain: string, urlKey?: string): string;

package/dist/types/sites/domains/_get-auth-header.d.ts

@@ -1,12 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-interface IHeaders {
-    Authorization?: string;
-    [key: string]: string;
-}
-/**
- * Construct the auth header from a hub request options
- * @param {IHubRequestOptions} hubRequestOptions
- * @private
- */
-export declare function _getAuthHeader(hubRequestOptions: IHubRequestOptions): IHeaders;
-export {};

package/dist/types/sites/domains/_get-domain-service-url.d.ts

@@ -1,6 +0,0 @@
-/**
- * Extract the domain service from the request options
- * @param {string} hubApiUrl
- * @private
- */
-export declare function _getDomainServiceUrl(hubApiUrl?: string): string;

package/dist/types/sites/domains/_lookup-portal.d.ts

@@ -1,11 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-/**
- * Lookup a domain in Portal
- * @param {string} hostname to locate the site for
- * @param {IRequestOptions} requestOptions
- * @private
- */
-export declare function _lookupPortal(hostname: string, requestOptions: IRequestOptions): Promise<{
-    hostname: string;
-    siteId: string;
-}>;

package/dist/types/sites/domains/add-domain.d.ts

@@ -1,7 +0,0 @@
-import { IDomainEntry, IHubRequestOptions } from "../../types";
-/**
- * Create an entry in the domain system
- * @param {IHubDomain} domainEntry Domain hash to be stored
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function addDomain(domainEntry: Partial<IDomainEntry>, hubRequestOptions: IHubRequestOptions): Promise<any>;

package/dist/types/sites/domains/domain-exists-portal.d.ts

@@ -1,7 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Check if an item exists with the specified domain keyword
- * @param {String} hostname to check for
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function domainExistsPortal(hostname: string, hubRequestOptions: IHubRequestOptions): Promise<boolean>;

package/dist/types/sites/domains/domain-exists.d.ts

@@ -1,11 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Check if a domain entry exists. Different from lookupDomain
- * in that this will return true/false, where as lookupDomain will
- * return the domain entry or throw. However, lookupDomain can work
- * with ArcGIS Enterprise.
- * Will throw if used in Portal.
- * @param {string} hostname Domain entry to check for
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function domainExists(hostname: string, hubRequestOptions: IHubRequestOptions): Promise<boolean>;

package/dist/types/sites/domains/ensure-unique-domain-name.d.ts

@@ -1,8 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Given a subdomain, ensure that we have a unique hostname
- * incrementing if needed
- * @param {String} subdomain Subdomain to unique-ify
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function ensureUniqueDomainName(subdomain: string, hubRequestOptions: IHubRequestOptions): Promise<string>;

package/dist/types/sites/domains/get-domains-for-site.d.ts

@@ -1,7 +0,0 @@
-import { IHubRequestOptions, IDomainEntry } from "../../types";
-/**
- * Get a list
- * @param {string} siteId Item id of the Site
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function getDomainsForSite(siteId: string, hubRequestOptions: IHubRequestOptions): Promise<IDomainEntry[]>;

package/dist/types/sites/domains/get-unique-domain-name-portal.d.ts

@@ -1,9 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Ensure a unique domain name by checking for and incrementing
- * a subdomain
- * @param {String} subdomain Subdomain to ensure is unique
- * @param {IHubRequestOptions} hubRequestOptions
- * @param {*} step Step number
- */
-export declare function getUniqueDomainNamePortal(subdomain: string, hubRequestOptions: IHubRequestOptions, step?: number): Promise<string>;

package/dist/types/sites/domains/get-unique-domain-name.d.ts

@@ -1,10 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Ensure a unique domain name by checking for and incrementing
- * a subdomain
- * @param {String} subdomain Subdomain to ensure is unique
- * @param {String} baseHostname base hostname
- * @param hubRequestOptions
- * @param {Number} step Step number
- */
-export declare function getUniqueDomainName(subdomain: string, baseHostname: string, hubRequestOptions: IHubRequestOptions, step?: number): Promise<string>;

package/dist/types/sites/domains/index.d.ts

@@ -1,18 +0,0 @@
-export * from "./_check-status-and-parse-json";
-export * from "./_get-auth-header";
-export * from "./_get-domain-service-url";
-export * from "./_lookup-portal";
-export * from "./add-domain";
-export * from "./domain-exists";
-export * from "./domain-exists-portal";
-export * from "./get-domains-for-site";
-export * from "./get-unique-domain-name";
-export * from "./get-unique-domain-name-portal";
-export * from "./is-domain-for-legacy-site";
-export * from "./is-domain-used-elsewhere";
-export * from "./is-valid-domain";
-export * from "./lookup-domain";
-export * from "./remove-domain";
-export * from "./update-domain";
-export * from "./_ensure-safe-domain-length";
-export * from "./ensure-unique-domain-name";

package/dist/types/sites/domains/is-domain-for-legacy-site.d.ts

@@ -1,9 +0,0 @@
-import { IDomainEntry } from "../../types";
-/**
- * Determine if a domain entry belongs to a legacy site.
- * This is used to allow customers to "reclaim" domains that
- * were associated with legacy sites which can no longer be
- * edited.
- * @param {IHubDomain} domainEntry Domain Info record
- */
-export declare function isDomainForLegacySite(domainEntry: IDomainEntry): boolean;

package/dist/types/sites/domains/is-domain-used-elsewhere.d.ts

@@ -1,10 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Check to see if a domain is in use by any site other than the
- * one passed in. This is used in various validators while the
- * user is editing properties of the site.
- * @param {string} hostname to check
- * @param {string} siteId Site Id we are checking for
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function isDomainUsedElsewhere(hostname: string, siteId: string, hubRequestOptions: IHubRequestOptions): Promise<boolean>;

package/dist/types/sites/domains/is-valid-domain.d.ts

@@ -1,7 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Validate a custom domain
- * @param {string} hostname to validate
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function isValidDomain(hostname: string, hubRequestOptions: IHubRequestOptions): Promise<any>;

package/dist/types/sites/domains/lookup-domain.d.ts

@@ -1,11 +0,0 @@
-import { IHubRequestOptions, IDomainEntry } from "../../types";
-/**
- * Fetch a the information about a domain.
- * Different implementation for Portal vs AGO
- * @param {string} hostname of domain record to locate
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function lookupDomain(hostname: string, hubRequestOptions: IHubRequestOptions): Promise<IDomainEntry | {
-    hostname: string;
-    siteId: string;
-}>;

package/dist/types/sites/domains/remove-domain.d.ts

@@ -1,8 +0,0 @@
-import { IHubRequestOptions } from "../../types";
-/**
- * Remove a domain entry.
- * User must be a member of the org that owns the domain entry.
- * @param {int} domainId Id of the domain entry to remove
- * @param {IHubRequestOptions} hubRequestOptions`dom
- */
-export declare function removeDomain(domainId: string, hubRequestOptions: IHubRequestOptions): Promise<any>;

package/dist/types/sites/domains/update-domain.d.ts

@@ -1,8 +0,0 @@
-import { IDomainEntry } from "../../types";
-import { IHubRequestOptions } from "../../types";
-/**
- * Update an entry in the domain system
- * @param {IHubDomain} domainEntry  Doman object to be updated
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function updateDomain(domainEntry: IDomainEntry, hubRequestOptions: IHubRequestOptions): Promise<any>;

package/dist/types/sites/drafts/build-draft.d.ts

@@ -1,7 +0,0 @@
-import { IModel, IDraft } from "../..";
-/**
- * Builds a draft with a subset of the model properties
- * @param {*} model - item model
- * @param {*} includeList - list of property paths to include in draft object
- */
-export declare function buildDraft(model: IModel, includeList: string[]): IDraft;

package/dist/types/sites/drafts/index.d.ts

@@ -1 +0,0 @@
-export * from "./build-draft";

package/dist/types/sites/get-site-by-id.d.ts

@@ -1,7 +0,0 @@
-import { IHubRequestOptions } from "..";
-/**
- * Get a Site Model by it's Item Id, and apply schema upgrades
- * @param {String} id Site Item Id
- * @param {IHubRequestOptions} hubRequestOptions
- */
-export declare function getSiteById(id: string, hubRequestOptions: IHubRequestOptions): Promise<import("..").IModel>;

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

@@ -1,14 +0,0 @@
-import { IHubRequestOptions } from "../types";
-/**
- * Returns site model given various kinds of identifier
- *
- * @param identifier - a site item ID, site hostname, enterprise site slug, or full site URL
- * @param hubRequestOptions
- */
-export declare function fetchSite(identifier: string, hubRequestOptions: IHubRequestOptions): Promise<import("../types").IModel>;
-export * from "./domains";
-export * from "./drafts";
-export * from "./_ensure-telemetry";
-export * from "./get-site-by-id";
-export * from "./site-schema-version";
-export * from "./upgrade-site-schema";

package/dist/types/sites/site-schema-version.d.ts

@@ -1 +0,0 @@
-export declare const SITE_SCHEMA_VERSION = 1.5;

package/dist/types/sites/upgrade-site-schema.d.ts

@@ -1,6 +0,0 @@
-import { IModel } from "../types";
-/**
- * Upgrades the schema upgrades
- * @param model IModel
- */
-export declare function upgradeSiteSchema(model: IModel): IModel;

package/dist/types/surveys/get-input-feature-service-model.d.ts

@@ -1,11 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
-/**
- * Gets the primary input Feature Service for the given
- * Form ID. This will be the Fieldworker view, if it exists,
- * otherwise the source Feature Service.
- * @param {string} formId The Form ID
- * @param requestOptions The request options
- * @returns {Promise<IModel>}
- */
-export declare const getInputFeatureServiceModel: (formId: string, requestOptions: IRequestOptions) => Promise<IModel>;

package/dist/types/surveys/get-source-feature-service-model-from-fieldworker.d.ts

@@ -1,10 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
-/**
- * Fetches a Survey's source Feature Service from a given
- * Fieldworker View ID
- * @param {string} fieldworkerId The Fieldworker View ID
- * @param {IRequestOptions} requestOptions The request options
- * @returns {Promise<IModel>}
- */
-export declare const getSourceFeatureServiceModelFromFieldworker: (fieldworkerId: string, requestOptions: IRequestOptions) => Promise<IModel>;

package/dist/types/surveys/get-stakeholder-model.d.ts

@@ -1,10 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IModel } from "../types";
-/**
- * Fetches a Survey's Stakeholder View for a given
- * Form ID
- * @param {string} formId A Form ID
- * @param {IRequestOptions} requestOptions The request options
- * @returns {Promise<IModel>}
- */
-export declare const getStakeholderModel: (formId: string, requestOptions: IRequestOptions) => Promise<IModel>;

package/dist/types/surveys/get-survey-models.d.ts

@@ -1,10 +0,0 @@
-import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IItem } from "@esri/arcgis-rest-portal";
-import { IGetSurveyModelsResponse } from "../types";
-/**
- * Builds a dictionary of Survey items for the given Form model
- * @param {string} formId The Form ID of the survey
- * @param {IRequestOptions} requestOptions The request options
- * @returns {Promise<IGetSurveyModelsResponse>}
- */
-export declare const getSurveyModels: (formItemOrId: string | IItem, requestOptions: IRequestOptions) => Promise<IGetSurveyModelsResponse>;

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

@@ -1,5 +0,0 @@
-export * from "./get-input-feature-service-model";
-export * from "./get-source-feature-service-model-from-fieldworker";
-export * from "./get-stakeholder-model";
-export * from "./get-survey-models";
-export * from "./is-fieldworker-view";

package/dist/types/surveys/is-fieldworker-view.d.ts

@@ -1,8 +0,0 @@
-import { IItem } from "@esri/arcgis-rest-types";
-/**
- * Determines if the provided Feature Service item is a
- * Fieldworker View
- * @param {IItem} featureServiceItem
- * @returns {boolean}
- */
-export declare function isFieldworkerView(featureServiceItem: IItem): boolean;