@esri/hub-common 12.3.2 → 12.5.0

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

@@ -0,0 +1,50 @@
+import { IUser } from "@esri/arcgis-rest-types";
+import { HubFamily } from "../types";
+import { EntityType, IHubCatalog, IHubCollection } from "./types";
+/**
+ * This is used to determine what IHubCatalog definition JSON object
+ * can be created
+ */
+export declare type WellKnownCatalog = "myContent" | "myGroup" | "favorites" | "organization" | "world";
+/**
+ * This is used to determine what IHubCollection definition JSON object
+ * can be created. We use HubFamily here to define most of the collections
+ * to ensure consistency
+ */
+export declare type WellKnownCollection = Exclude<HubFamily, "app" | "map"> | "appAndMap" | "solution";
+/**
+ * A list of optional arguments to pass into getWellKnownCatalog
+ * user is the owner of the entity
+ * collectionNames is a list of names of the collections, only those collections
+ * in the catalog will be returned
+ */
+export interface IGetWellKnownCatalogOptions {
+    user?: IUser;
+    collectionNames?: WellKnownCollection[];
+}
+/** Get a single catalog based on the name, entity type and optional requests
+ * @param i18nScope Translation scope to be interpolated into the catalog
+ * @param name Name of the catalog requested
+ * @param entityType
+ * @param options An opitional IGetWellKnownCatalogOptions definition JSON object
+ * @returns An IHubCatalog definition JSON object
+ */
+export declare function getWellKnownCatalog(i18nScope: string, name: WellKnownCatalog, entityType: EntityType, options?: IGetWellKnownCatalogOptions): IHubCatalog;
+/**
+ * Get a list of collections based on the entity type and an optional
+ * list of collection names, will return a list of default collections if none passed
+ * @param i18nScope Translation scope to be interpolated into the collections
+ * @param entityType
+ * @param collectionNames List of names of the requested collections, optional, if passed in,
+ * only those collections will be returned
+ * @returns A list of IHubCollection definition JSON objects
+ */
+export declare function getWellknownCollections(i18nScope: string, entityType: EntityType, collectionNames?: WellKnownCollection[]): IHubCollection[];
+/**
+ * Get a single collection based on the collection name and entity type
+ * @param i18nScope
+ * @param entityType
+ * @param collectionName Name of the collection requested
+ * @returns An IHubCollection definition JSON object
+ */
+export declare function getWellknownCollection(i18nScope: string, entityType: EntityType, collectionName: WellKnownCollection): IHubCollection;

package/dist/types/urls/build-url.d.ts

@@ -1,5 +1,5 @@
-interface IQueryParams {
-    [key: string]: string;
+export interface IQueryParams {
+    [key: string]: string | number;
 }
 /**
  * @private
@@ -9,4 +9,3 @@ export declare function buildUrl(params: {
     path: string;
     query?: IQueryParams;
 }): string;
-export {};

package/package.json

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