@esri/hub-common 13.0.0-next.2 → 13.0.0

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

@@ -1,5 +1,53 @@
-import { IUser } from "@esri/arcgis-rest-auth";
-import { IGroup } from "@esri/arcgis-rest-portal";
+import { IUser, UserSession } from "@esri/arcgis-rest-auth";
+import { IGroup, ISearchOptions } from "@esri/arcgis-rest-portal";
+import { ISearchResponse } from "../types";
+import { IMatchOptions, IDateRange, IRelativeDate, IWellKnownApis, IApiDefinition, NamedApis } from "./types/types";
+import { WellKnownCollection } from "./wellKnownCatalog";
+import { LegacySearchCategory } from "./_internal/commonHelpers/isLegacySearchCategory";
+/**
+ * Well known APIs
+ * Short-forms for specifying common APIs
+ * We will likely deprecate this
+ */
+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
+ * 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
+ * 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>>): (authentication?: UserSession) => Promise<ISearchResponse<T>>;
 /**
  * Construct a the full url to a group thumbnail
  *
@@ -22,3 +70,14 @@ export declare function getGroupThumbnailUrl(portalUrl: string, group: IGroup, t
  * @returns
  */
 export declare function getUserThumbnailUrl(portalUrl: string, user: IUser, token?: string): string;
+/**
+ * Function that can migrate a legacy search category to a wellknown
+ * collection key. Useful when the caller has an unknown value that
+ * could either be a search category or wellknown collection.
+ *
+ * If the value passed is not a search category, it is returned as-is.
+ *
+ * @param collectionOrSearchCategory key to be migrated
+ * @returns the migrated wellknown collection key
+ */
+export declare function migrateToCollectionKey(collectionOrSearchCategory: LegacySearchCategory | WellKnownCollection): WellKnownCollection;

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

@@ -42,12 +42,21 @@ export declare function deleteSite(id: string, requestOptions: IHubRequestOption
  */
 export declare function fetchSite(identifier: string, requestOptions: IHubRequestOptions): Promise<IHubSite>;
 /**
+ * @internal
  * Convert an IModel for a Hub Site Item into an IHubSite
  * @param model
  * @param requestOptions
  * @returns
  */
 export declare function convertModelToSite(model: IModel, requestOptions: IRequestOptions): IHubSite;
+/**
+ * @internal
+ * Convert an IHubSite into an IModel
+ * @param site
+ * @param requestOptions
+ * @returns
+ */
+export declare function convertSiteToModel(site: IHubSite, requestOptions: IRequestOptions): IModel;
 /**
  * Convert a Hub Site Application item into a Hub Site, fetching any
  * additional information that may be required

package/dist/types/sites/_internal/SiteSchema.d.ts

@@ -0,0 +1,7 @@
+import { IConfigurationSchema } from "../../core";
+export declare type SiteEditorType = (typeof SiteEditorTypes)[number];
+export declare const SiteEditorTypes: readonly ["hub:site:edit"];
+/**
+ * defines the JSON schema for a Hub Site's editable fields
+ */
+export declare const SiteSchema: IConfigurationSchema;

package/dist/types/sites/_internal/SiteUiSchemaCreate.d.ts

@@ -0,0 +1,7 @@
+import { IUiSchema } from "../../core";
+/**
+ * minimal create uiSchema for Hub Projects - this defines
+ * how the schema properties should be rendered in the
+ * project creation experience
+ */
+export declare const uiSchema: IUiSchema;

package/dist/types/sites/_internal/SiteUiSchemaEdit.d.ts

@@ -0,0 +1,7 @@
+import { IUiSchema } from "../../core";
+/**
+ * complete edit uiSchema for Hub Projects - this defines
+ * how the schema properties should be rendered in the
+ * project editing experience
+ */
+export declare const uiSchema: IUiSchema;

package/dist/types/sites/_internal/catalogMigration.d.ts

@@ -0,0 +1,9 @@
+import { IModel } from "../../types";
+/**
+ * Add the default catalog and collections to the Site model
+ * Note: This migration is only applies via `fetchSite(..):IHubSite` and not
+ * the older `getSiteById(...):IModel`
+ * @param model
+ * @returns
+ */
+export declare function catalogMigration(model: IModel): IModel;

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

@@ -2,6 +2,8 @@ import { IHubRequestOptions, IModel } from "../types";
 /**
  * @private
  * @internal
+ * As of May 2023, Hub Site Application registration must be done via HMAC signed request
+ * which is handled by the Hub Domain Service. This file is left here for reference.
  * Register the Site item as an application so we can oauth against it
  * @param {string} siteId Item Id of the site
  * @param {Array} uris Arrayf valid uris for the site

package/dist/types/versioning/updateVersionMetadata.d.ts

@@ -3,8 +3,9 @@ import { IVersionMetadata } from "./types";
 /**
  * Updates the specified version's metadata
  * @param id
- * @param version
+ * @param versionMetadata
+ * @param owner
  * @param requestOptions
  * @returns
  */
-export declare function updateVersionMetadata(id: string, version: IVersionMetadata, requestOptions: IHubUserRequestOptions): Promise<IVersionMetadata>;
+export declare function updateVersionMetadata(id: string, versionMetadata: IVersionMetadata, owner: string, requestOptions: IHubUserRequestOptions): Promise<IVersionMetadata>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "13.0.0-next.2",
+  "version": "13.0.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",

package/dist/esm/search/_internal/utils.js

@@ -1,95 +0,0 @@
-import { UserSession } from "@esri/arcgis-rest-auth";
-import { cloneObject } from "../../util";
-/**
- * @private
- * Convert a field value into a MatchOptions if it's not already one
- * @param value
- * @returns
- */
-export function valueToMatchOptions(value) {
-    let result = {};
-    if (Array.isArray(value)) {
-        result = {
-            any: value,
-        };
-    }
-    else {
-        if (typeof value === "string") {
-            result = {
-                any: [value],
-            };
-        }
-        if (typeof value === "object") {
-            result = value;
-        }
-    }
-    return result;
-}
-/**
- * @private
- * Convert a RelativeDate to a DateRange<number>
- * @param relative
- * @returns
- */
-export function relativeDateToDateRange(relative) {
-    // hash of offsets
-    const offsetMs = {
-        min: 1000 * 60,
-        hours: 1000 * 60 * 60,
-        days: 1000 * 60 * 60 * 24,
-        weeks: 1000 * 60 * 60 * 24 * 7,
-    };
-    const now = new Date();
-    // default
-    const result = {
-        type: "date-range",
-        from: now.getTime(),
-        to: now.getTime(),
-    };
-    //
-    switch (relative.unit) {
-        case "hours":
-        case "days":
-        case "weeks":
-            result.from = result.to - offsetMs[relative.unit] * relative.num;
-            break;
-        case "months":
-            // get the current month and subtract num
-            // NOTE: when the previous month has fewer days than this month
-            // setMonth() will return a date w/in the current month
-            // example: 3/30 -> 3/2 b/c there is no 2/28
-            now.setMonth(now.getMonth() - relative.num);
-            result.from = now.getTime();
-            break;
-        case "years":
-            now.setFullYear(now.getFullYear() - relative.num);
-            result.from = now.getTime();
-            break;
-    }
-    return result;
-}
-/**
- * @private
- * Create a `.next()` function for a type
- * @param request
- * @param nextStart
- * @param total
- * @param fn
- * @returns
- */
-export function getNextFunction(request, nextStart, total, fn) {
-    const clonedRequest = cloneObject(request);
-    // clone will not handle authentication so we do it manually
-    if (request.authentication) {
-        clonedRequest.authentication = UserSession.deserialize(request.authentication.serialize());
-    }
-    // figure out the start
-    clonedRequest.start = nextStart > -1 ? nextStart : total + 1;
-    return (authentication) => {
-        if (authentication) {
-            clonedRequest.authentication = authentication;
-        }
-        return fn(clonedRequest);
-    };
-}
-//# sourceMappingURL=utils.js.map

package/dist/esm/search/_internal/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/search/_internal/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAGrD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAwC;IAExC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,GAAG;YACP,GAAG,EAAE,KAAK;SACX,CAAC;KACH;SAAM;QACL,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,GAAG;gBACP,GAAG,EAAE,CAAC,KAAK,CAAC;aACb,CAAC;SACH;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,GAAG,KAAK,CAAC;SAChB;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAuB;IAEvB,kBAAkB;IAClB,MAAM,QAAQ,GAAG;QACf,GAAG,EAAE,IAAI,GAAG,EAAE;QACd,KAAK,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE;QACrB,IAAI,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;QACzB,KAAK,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;KAC/B,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,UAAU;IACV,MAAM,MAAM,GAAuB;QACjC,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE;QACnB,EAAE,EAAE,GAAG,CAAC,OAAO,EAAE;KAClB,CAAC;IACF,EAAE;IACF,QAAQ,QAAQ,CAAC,IAAI,EAAE;QACrB,KAAK,OAAO,CAAC;QACb,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO;YACV,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC;YACjE,MAAM;QACR,KAAK,QAAQ;YACX,yCAAyC;YACzC,+DAA+D;YAC/D,uDAAuD;YACvD,4CAA4C;YAC5C,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC5C,MAAM,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM;QACR,KAAK,OAAO;YACV,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAClD,MAAM,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM;KACT;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,OAAuB,EACvB,SAAiB,EACjB,KAAa,EACb,EAA2C;IAE3C,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAE3C,4DAA4D;IAC5D,IAAI,OAAO,CAAC,cAAc,EAAE;QAC1B,aAAa,CAAC,cAAc,GAAG,WAAW,CAAC,WAAW,CACnD,OAAO,CAAC,cAA8B,CAAC,SAAS,EAAE,CACpD,CAAC;KACH;IAED,uBAAuB;IACvB,aAAa,CAAC,KAAK,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;IAE7D,OAAO,CAAC,cAA4B,EAAE,EAAE;QACtC,IAAI,cAAc,EAAE;YAClB,aAAa,CAAC,cAAc,GAAG,cAAc,CAAC;SAC/C;QACD,OAAO,EAAE,CAAC,aAAa,CAAC,CAAC;IAC3B,CAAC,CAAC;AACJ,CAAC"}

package/dist/node/search/_internal/utils.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNextFunction = exports.relativeDateToDateRange = exports.valueToMatchOptions = void 0;
-const arcgis_rest_auth_1 = require("@esri/arcgis-rest-auth");
-const util_1 = require("../../util");
-/**
- * @private
- * Convert a field value into a MatchOptions if it's not already one
- * @param value
- * @returns
- */
-function valueToMatchOptions(value) {
-    let result = {};
-    if (Array.isArray(value)) {
-        result = {
-            any: value,
-        };
-    }
-    else {
-        if (typeof value === "string") {
-            result = {
-                any: [value],
-            };
-        }
-        if (typeof value === "object") {
-            result = value;
-        }
-    }
-    return result;
-}
-exports.valueToMatchOptions = valueToMatchOptions;
-/**
- * @private
- * Convert a RelativeDate to a DateRange<number>
- * @param relative
- * @returns
- */
-function relativeDateToDateRange(relative) {
-    // hash of offsets
-    const offsetMs = {
-        min: 1000 * 60,
-        hours: 1000 * 60 * 60,
-        days: 1000 * 60 * 60 * 24,
-        weeks: 1000 * 60 * 60 * 24 * 7,
-    };
-    const now = new Date();
-    // default
-    const result = {
-        type: "date-range",
-        from: now.getTime(),
-        to: now.getTime(),
-    };
-    //
-    switch (relative.unit) {
-        case "hours":
-        case "days":
-        case "weeks":
-            result.from = result.to - offsetMs[relative.unit] * relative.num;
-            break;
-        case "months":
-            // get the current month and subtract num
-            // NOTE: when the previous month has fewer days than this month
-            // setMonth() will return a date w/in the current month
-            // example: 3/30 -> 3/2 b/c there is no 2/28
-            now.setMonth(now.getMonth() - relative.num);
-            result.from = now.getTime();
-            break;
-        case "years":
-            now.setFullYear(now.getFullYear() - relative.num);
-            result.from = now.getTime();
-            break;
-    }
-    return result;
-}
-exports.relativeDateToDateRange = relativeDateToDateRange;
-/**
- * @private
- * Create a `.next()` function for a type
- * @param request
- * @param nextStart
- * @param total
- * @param fn
- * @returns
- */
-function getNextFunction(request, nextStart, total, fn) {
-    const clonedRequest = util_1.cloneObject(request);
-    // clone will not handle authentication so we do it manually
-    if (request.authentication) {
-        clonedRequest.authentication = arcgis_rest_auth_1.UserSession.deserialize(request.authentication.serialize());
-    }
-    // figure out the start
-    clonedRequest.start = nextStart > -1 ? nextStart : total + 1;
-    return (authentication) => {
-        if (authentication) {
-            clonedRequest.authentication = authentication;
-        }
-        return fn(clonedRequest);
-    };
-}
-exports.getNextFunction = getNextFunction;
-//# sourceMappingURL=utils.js.map

package/dist/node/search/_internal/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/search/_internal/utils.ts"],"names":[],"mappings":";;;AAAA,6DAAqD;AAGrD,qCAAyC;AAGzC;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,KAAwC;IAExC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,GAAG;YACP,GAAG,EAAE,KAAK;SACX,CAAC;KACH;SAAM;QACL,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,GAAG;gBACP,GAAG,EAAE,CAAC,KAAK,CAAC;aACb,CAAC;SACH;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,MAAM,GAAG,KAAK,CAAC;SAChB;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AApBD,kDAoBC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CACrC,QAAuB;IAEvB,kBAAkB;IAClB,MAAM,QAAQ,GAAG;QACf,GAAG,EAAE,IAAI,GAAG,EAAE;QACd,KAAK,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE;QACrB,IAAI,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE;QACzB,KAAK,EAAE,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;KAC/B,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,UAAU;IACV,MAAM,MAAM,GAAuB;QACjC,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE;QACnB,EAAE,EAAE,GAAG,CAAC,OAAO,EAAE;KAClB,CAAC;IACF,EAAE;IACF,QAAQ,QAAQ,CAAC,IAAI,EAAE;QACrB,KAAK,OAAO,CAAC;QACb,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO;YACV,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC;YACjE,MAAM;QACR,KAAK,QAAQ;YACX,yCAAyC;YACzC,+DAA+D;YAC/D,uDAAuD;YACvD,4CAA4C;YAC5C,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC5C,MAAM,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM;QACR,KAAK,OAAO;YACV,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAClD,MAAM,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC;YAC5B,MAAM;KACT;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAvCD,0DAuCC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,OAAuB,EACvB,SAAiB,EACjB,KAAa,EACb,EAA2C;IAE3C,MAAM,aAAa,GAAG,kBAAW,CAAC,OAAO,CAAC,CAAC;IAE3C,4DAA4D;IAC5D,IAAI,OAAO,CAAC,cAAc,EAAE;QAC1B,aAAa,CAAC,cAAc,GAAG,8BAAW,CAAC,WAAW,CACnD,OAAO,CAAC,cAA8B,CAAC,SAAS,EAAE,CACpD,CAAC;KACH;IAED,uBAAuB;IACvB,aAAa,CAAC,KAAK,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC;IAE7D,OAAO,CAAC,cAA4B,EAAE,EAAE;QACtC,IAAI,cAAc,EAAE;YAClB,aAAa,CAAC,cAAc,GAAG,cAAc,CAAC;SAC/C;QACD,OAAO,EAAE,CAAC,aAAa,CAAC,CAAC;IAC3B,CAAC,CAAC;AACJ,CAAC;AAxBD,0CAwBC"}

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

@@ -1,28 +0,0 @@
-import { UserSession } from "@esri/arcgis-rest-auth";
-import { ISearchOptions } from "@esri/arcgis-rest-portal";
-import { ISearchResponse } from "../../types";
-import { IMatchOptions, IDateRange, IRelativeDate } from "../types/types";
-/**
- * @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
- * 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>>): (authentication?: UserSession) => Promise<ISearchResponse<T>>;