@esri/hub-common 15.33.0 → 15.35.0

package/dist/types/org/fetch.d.ts

@@ -0,0 +1,26 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubOrganization } from "../core/types/IHubOrganization";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IHubSearchResult } from "../search/types/IHubSearchResult";
+/**
+ * Fetch an organization from the portal
+ * Note: IHubOrganization is a read-only interface for a subset of the IPortal object
+ * The full portal is exposed as the `portal` property on the IHubOrganization object.
+ * @param identifier
+ * @param requestOptions
+ * @returns
+ */
+export declare function fetchOrganization(identifier: string, requestOptions: IRequestOptions): Promise<IHubOrganization>;
+/**
+ * Convert an IHubOrganization to an IHubSearchResult
+ * @param org
+ * @returns
+ */
+export declare function organizationToSearchResult(org: IHubOrganization): IHubSearchResult;
+/**
+ * Convert an IPortal to an IHubOrganization
+ * @param portal
+ * @param token
+ * @returns
+ */
+export declare function portalToOrganization(portal: IPortal, token?: string): IHubOrganization;

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

@@ -1,2 +1,3 @@
 export * from "./fetch-org";
 export * from "./fetchOrgLimits";
+export * from "./fetch";

package/dist/types/pages/_internal/computeLinks.d.ts

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubEntityLinks } from "../../core/types";
 /**

package/dist/types/projects/_internal/computeLinks.d.ts

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 import { IHubEntityLinks } from "../../core";
 /**
  * Compute the links that get appended to a Hub Project

package/dist/types/resources/_internal/_validate-url-helpers.d.ts

@@ -1,4 +1,4 @@
-import { IExtent, IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-types";
+import { IExtent, IFeatureServiceDefinition, ILayerDefinition } from "@esri/arcgis-rest-feature-layer";
 import { ItemType } from "../../types";
 /**
  * Feature service / Doc Links Should not have data urls. Let"s exclude them from that.

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

@@ -1,5 +1,5 @@
 import { IHubRequestOptions, ITemplateAsset } from "../types";
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 /**
  * Given an item, return an array of assets that includes
  * all the resources, as well as the thumbnail

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

@@ -1,5 +1,5 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 import { IPortal } from "@esri/arcgis-rest-portal";
 import { IHubRequestOptions } from "../types";
 export interface IThumbnailOptions {

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

@@ -0,0 +1,9 @@
+import { IHubSearchOptions, IHubSearchResponse, IHubSearchResult, IQuery } from "../types";
+/**
+ * Since the portal api does not actually have a search endpoint for orgs,
+ * this function simply extracts the id predicate from the query and
+ * fetches the orgs that match that ids.
+ * @param query
+ * @param options
+ */
+export declare function portalFetchOrgs(query: IQuery, options: IHubSearchOptions): Promise<IHubSearchResponse<IHubSearchResult>>;

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

@@ -1,4 +1,4 @@
-import { IUser } from "@esri/arcgis-rest-types";
+import { IUser } from "@esri/arcgis-rest-portal";
 import { IGroupsByMembership } from "./types/IGroupsByMembership";
 /**
  * Retrieves the user's groups categorized by their membership type.

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

@@ -1,4 +1,4 @@
-import { IUser } from "@esri/arcgis-rest-types";
+import { IUser } from "@esri/arcgis-rest-portal";
 import { IGroupsByMembership } from "./types/IGroupsByMembership";
 import { IQuery } from "./types/IHubCatalog";
 /**

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

@@ -75,7 +75,7 @@ export interface IHubCollection {
      */
     displayConfig?: IGalleryDisplayConfig;
 }
-export declare const targetEntities: readonly ["item", "group", "user", "portalUser", "communityUser", "groupMember", "event", "channel", "discussionPost", "eventAttendee"];
+export declare const targetEntities: readonly ["item", "group", "user", "portalUser", "communityUser", "groupMember", "event", "channel", "discussionPost", "eventAttendee", "organization"];
 export declare type EntityType = (typeof targetEntities)[number];
 /**
  * @private

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

@@ -1,4 +1,4 @@
-import { IUser } from "@esri/arcgis-rest-types";
+import { IUser } from "@esri/arcgis-rest-portal";
 import { HubFamily } from "../types";
 import { EntityType, IFilter, IHubCatalog, IHubCollection } from "./types";
 import { IArcGISContext } from "..";

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

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubEntityLinks } from "../../core/types";
 /**

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

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 import { IHubSurvey } from "../core/types/IHubSurvey";
 import { IHubRequestOptions } from "../types";
 /**

package/dist/types/surveys/utils/is-draft.d.ts

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 /**
  * Determines if a given Form item is a draft
  * @param {IItem} formItem A Form item

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

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 /**
  * Determines if the provided Feature Service item is a
  * Fieldworker View

package/dist/types/surveys/utils/is-survey123-connect.d.ts

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 /**
  * Returns true if the given Form item is a Survey123 Connect
  * survey

package/dist/types/surveys/utils/should-display-map.d.ts

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 /**
  * Determines the display mode of the given survey
  * @param {Object} formItem A Form item

package/dist/types/templates/_internal/computeLinks.d.ts

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubEntityLinks } from "../../core/types";
 /**

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

@@ -1,4 +1,4 @@
-import { IItem } from "@esri/arcgis-rest-types";
+import { IItem } from "@esri/arcgis-rest-portal";
 /**
  * We do our best to glean what the solution template
  * is supposed to become when deployed. This util

package/dist/types/types.d.ts

@@ -1,7 +1,9 @@
-import { IItem, IUser, IGroup, IPolygon, ISpatialReference, IGeometry } from "@esri/arcgis-rest-types";
+import { IItem, IUser, IGroup } from "@esri/arcgis-rest-portal";
 import { IPortal, ISearchResult } from "@esri/arcgis-rest-portal";
 import { UserSession } from "@esri/arcgis-rest-auth";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IGeometry } from "@esri/arcgis-rest-feature-layer";
+import { IPolygon, ISpatialReference } from "@esri/arcgis-rest-types";
 /**
  * Generic Model, used with all items that have a json
  * `/data` payload
@@ -146,7 +148,7 @@ export declare type IRevertableTaskResult = IRevertableTaskSuccess | IRevertable
 /**
  * All Hub families
  */
-export declare const HubFamilies: readonly ["app", "content", "dataset", "document", "event", "feedback", "initiative", "map", "people", "site", "team", "template", "project", "channel", "discussion", "eventAttendee"];
+export declare const HubFamilies: readonly ["app", "content", "dataset", "document", "event", "feedback", "initiative", "map", "people", "site", "team", "template", "project", "channel", "discussion", "eventAttendee", "organization"];
 /**
  * All Hub families
  */

package/dist/types/users/HubUsers.d.ts

@@ -1,4 +1,4 @@
-import { IUser } from "@esri/arcgis-rest-types";
+import { IUser } from "@esri/arcgis-rest-portal";
 import { IHubUser } from "../core/types/IHubUser";
 import { IHubRequestOptions } from "../types";
 import { IHubSearchResult } from "../search/types/IHubSearchResult";

package/dist/types/users/_internal/computeProps.d.ts

@@ -1,4 +1,4 @@
-import { IUser } from "@esri/arcgis-rest-types";
+import { IUser } from "@esri/arcgis-rest-portal";
 import { IArcGISContext } from "../../ArcGISContext";
 import { IHubUser } from "../../core/types";
 /**

package/dist/types/utils/is-update-group.d.ts

@@ -1,4 +1,4 @@
-import { IGroup } from "@esri/arcgis-rest-types";
+import { IGroup } from "@esri/arcgis-rest-portal";
 /**
  * Determines if a given IGroup is an update group
  * @param {IGroup} group The group to evaluate

package/package.json

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