@esri/hub-common 24.3.0 → 24.4.0

package/dist/types/core/matchUtils/matchBySlug.d.ts

@@ -0,0 +1,13 @@
+import { IArcGISContext } from "../../types/IArcGISContext";
+import { MatchableType, IIdentifierMatches } from "../matchTypes";
+/**
+ * Match by slug
+ * Handles these two cases via delegation:
+ * - org-short::custom-slug, via search: typekeyword: "slug|{identifier}" and type: {type}
+ * - indexer-slug-via-title, via search: title: "%identifier.replace('-', ' ')%" and type: {type}
+ * @param type
+ * @param identifier
+ * @param context
+ * @returns
+ */
+export declare function matchBySlug(type: MatchableType, identifier: string, context: IArcGISContext): Promise<IIdentifierMatches>;

package/dist/types/core/matchUtils/matchByTitleSearch.d.ts

@@ -0,0 +1,11 @@
+import { IArcGISContext } from "../../types/IArcGISContext";
+import { MatchableType, IIdentifierMatches } from "../matchTypes";
+/**
+ * Match by a title search
+ * Handles searching by title: "%identifier.replace('-', ' ')%" and type: {type}
+ * @param type
+ * @param identifier
+ * @param context
+ * @returns
+ */
+export declare function matchByTitleSearch(type: MatchableType, identifier: string, context: IArcGISContext): Promise<IIdentifierMatches>;

package/dist/types/core/matchesInCatalog.d.ts

@@ -0,0 +1,14 @@
+import { IHubCatalog } from "../search/types/IHubCatalog";
+import { IArcGISContext } from "../types/IArcGISContext";
+import { MatchableType, IMatch } from "./matchTypes";
+/**
+ * Check which of the given matches are contained in the specified catalog.
+ * Decorates each match with inCatalog: true|false, which the disambiguation
+ * UX can then use to determine how to present the matches.
+ * @param type
+ * @param matches
+ * @param catalog
+ * @param context
+ * @param path
+ */
+export declare function matchesInCatalog(type: MatchableType, matches: IMatch[], catalog: IHubCatalog, context: IArcGISContext, path?: string): Promise<IMatch[]>;

package/dist/types/index.d.ts

@@ -70,6 +70,9 @@ export { getHubTypeFromItemType } from "./core/getHubTypeFromItemType";
 export { getRelativeWorkspaceUrl } from "./core/getRelativeWorkspaceUrl";
 export { getTypeFromEntity } from "./core/getTypeFromEntity";
 export { getTypesFromEntityType } from "./core/getTypesFromEntityType";
+export { matchIdentifier } from "./core/matchIdentifier";
+export { MatchableType, IIdentifierMatches, IMatch } from "./core/matchTypes";
+export { matchesInCatalog } from "./core/matchesInCatalog";
 export { addHistoryEntry, IHubHistory, IHubHistoryEntry, removeHistoryEntry, } from "./core/hubHistory";
 export { isValidEntityType } from "./core/isValidEntityType";
 export { getHubEntityTypeFromPath, getPathForHubEntityType, IParsedPath, parseContainmentPath, pathMap, } from "./core/parseContainmentPath";
@@ -315,6 +318,7 @@ export { setProp } from "./objects/set-prop";
 export { fetchOrganization, portalToOrganization, portalToSearchResult, } from "./org/fetch";
 export { fetchOrg } from "./org/fetch-org";
 export { fetchMaxNumUserGroupsLimit, fetchOrgLimits, IOrgLimit, OrgLimitType, } from "./org/fetchOrgLimits";
+export { HUB_PAGE_ITEM_TYPE, ENTERPRISE_PAGE_ITEM_TYPE, } from "./pages/defaults";
 export { HubPage } from "./pages/HubPage";
 export { convertItemToPage, convertModelToPage, createPage, deletePage, enrichPageSearchResult, fetchPage, updatePage, } from "./pages/HubPages";
 export { checkPermission, EntityOrOptions, } from "./permissions/checkPermission";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "24.3.0",
+  "version": "24.4.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",
@@ -68,6 +68,7 @@
     "test": "vitest --config=vitest.config.mjs --reporter=dot --run",
     "test:coverage": "vitest --config=vitest.config.mjs --coverage --run",
     "test:watch": "vitest --config=vitest.config.mjs --reporter=verbose",
+    "test:harness": "vitest --config=vitest.config.mjs --reporter=verbose --dir ./harnesses",
     "y:publish": "yalc publish",
     "y:push": "yalc push"
   },