@esri/hub-common 24.7.1 → 25.0.0

package/dist/types/resources-api/api/orval/api/orval-resources.d.ts

@@ -8,11 +8,56 @@ import { customClient } from "../custom-client";
 export interface UpdateResourceDto {
     [key: string]: unknown;
 }
+export declare enum ResourceSortOrder {
+    asc = "asc",
+    desc = "desc"
+}
+export declare enum ResourceSort {
+    createdAt = "createdAt",
+    updatedAt = "updatedAt"
+}
+export declare enum AllowedResourceEntityType {
+    event = "event"
+}
 export declare enum ResourceStatus {
     PENDING = "PENDING",
     UPLOADED = "UPLOADED",
     FAILED = "FAILED"
 }
+export type SearchResourcesParams = {
+    /**
+     * Single resource ID or comma seperated resource IDs
+     */
+    ids?: string[];
+    /**
+     * Resource status
+     */
+    status?: ResourceStatus;
+    /**
+     * Entity type
+     */
+    entityType?: AllowedResourceEntityType;
+    /**
+     * Entity ID associated with the resource
+     */
+    entityId?: string;
+    /**
+     * Maximum number of resources to return in response
+     */
+    num?: number;
+    /**
+     * Index to start at
+     */
+    start?: number;
+    /**
+     * Property to sort results by
+     */
+    sortBy?: ResourceSort;
+    /**
+     * sort results order desc or asc
+     */
+    sortOrder?: ResourceSortOrder;
+};
 export interface IResource {
     /** @nullable */
     altText: string | null;
@@ -30,6 +75,11 @@ export interface IResource {
     updatedAt: string;
     uploadedBy: string;
 }
+export interface IPagedResourceResponse {
+    items: IResource[];
+    nextStart: number;
+    total: number;
+}
 /**
  * MIME type of the resource
  */
@@ -69,7 +119,7 @@ export declare const createResource: (iCreateResource: ICreateResource, options?
 /**
  * Search for resources matching request criteria.
  */
-export declare const searchResources: (options?: SecondParameter<typeof customClient>) => Promise<void>;
+export declare const searchResources: (params?: SearchResourcesParams, options?: SecondParameter<typeof customClient>) => Promise<IPagedResourceResponse>;
 /**
  * Get a single resource.
  */
@@ -81,7 +131,7 @@ export declare const updateResource: (id: string, updateResourceDto: UpdateResou
 /**
  * Delete an existing resource.
  */
-export declare const deleteResource: (id: string, options?: SecondParameter<typeof customClient>) => Promise<void>;
+export declare const deleteResource: (id: string, options?: SecondParameter<typeof customClient>) => Promise<IResource>;
 export type CreateResourceResult = NonNullable<Awaited<ReturnType<typeof createResource>>>;
 export type SearchResourcesResult = NonNullable<Awaited<ReturnType<typeof searchResources>>>;
 export type GetResourceResult = NonNullable<Awaited<ReturnType<typeof getResource>>>;

package/dist/types/resources-api/api/resources.d.ts

@@ -1,4 +1,5 @@
-import { ICreateResourceParams, IGetResourceParams, IResource } from "./types";
+import { ICreateResourceParams, IGetResourceParams, ISearchResourcesParams, IDeleteResourceParams, IResource } from "./types";
+import { IPagedResourceResponse } from "./orval/api/orval-resources";
 /**
  * create a resource
  *
@@ -13,3 +14,17 @@ export declare function createResource(options: ICreateResourceParams): Promise<
  * @return {Promise<IResource>}
  */
 export declare function getResource(options: IGetResourceParams): Promise<IResource>;
+/**
+ * delete a resource by id
+ *
+ * @param {IDeleteResourceParams} options
+ * @return {Promise<IResource>}
+ */
+export declare function deleteResource(options: IDeleteResourceParams): Promise<IResource>;
+/**
+ * search resources
+ *
+ * @param {ISearchResourcesParams} options
+ * @return {Promise<IResource>}
+ */
+export declare function searchResources(options: ISearchResourcesParams): Promise<IPagedResourceResponse>;

package/dist/types/resources-api/api/types.d.ts

@@ -1,6 +1,6 @@
 export { IResource, ICreateResource, ICreateResourceMimeType, ICreateResourceEntityType, } from "./orval/api/orval-resources";
 import { IHubRequestOptions } from "../../hub-types";
-import { ICreateResource } from "./orval/api/orval-resources";
+import { ICreateResource, SearchResourcesParams } from "./orval/api/orval-resources";
 /**
  * options for making requests against the Resources API
  *
@@ -22,3 +22,9 @@ export interface ICreateResourceParams extends IResourcesRequestOptions {
 export interface IGetResourceParams extends IResourcesRequestOptions {
     id: string;
 }
+export interface ISearchResourcesParams extends IResourcesRequestOptions {
+    params: SearchResourcesParams;
+}
+export interface IDeleteResourceParams extends IResourcesRequestOptions {
+    id: string;
+}

package/dist/types/search/_internal/hubDiscussionsHelpers/processRelations.d.ts

@@ -1,7 +1,7 @@
-import { PostRelation } from "../../../discussions/api/enums/postRelation";
+import { TPostRelation } from "../../../discussions/api/enums/postRelation";
 /**
  * Convert an array of `include` into an array of PostRelation enum values.
  * @param relations array of include (e.g. ["channel", "replies"]).
  * @returns PostRelation[] with order of first appearance preserved and duplicates removed.
  */
-export declare function processRelations(relations?: string[]): PostRelation[];
+export declare function processRelations(relations?: string[]): TPostRelation[];

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

@@ -1,6 +1,6 @@
-import { CARD_TITLE_TAGS } from "../../core/schemas/shared/enums/cardTitleTags";
-import { CORNERS } from "../../core/schemas/shared/enums/corners";
-import { DROP_SHADOWS } from "../../core/schemas/shared/enums/dropShadows";
+import { TCardTitleTag } from "../../core/schemas/shared/enums/cardTitleTags";
+import { TCorner } from "../../core/schemas/shared/enums/corners";
+import { TDropShadow } from "../../core/schemas/shared/enums/dropShadows";
 export type CatalogType = "content" | "exclusion";
 export interface IHubCatalog {
     /**
@@ -157,7 +157,7 @@ export interface IGalleryDisplayConfig {
     /**  Gallery layout options to expose in the layout switcher */
     layouts?: Array<"list" | "grid" | "map" | "table" | "calendar" | "compact" | "grid-filled">;
     /** header tag for the gallery card titles - needed for a11y */
-    cardTitleTag?: CARD_TITLE_TAGS;
+    cardTitleTag?: TCardTitleTag;
     /** Type of media to render in the layout card */
     imageType?: "thumbnail" | "icon";
     /**
@@ -167,9 +167,9 @@ export interface IGalleryDisplayConfig {
      */
     showThumbnail?: "show" | "hide" | "grid";
     /** card corner appearance */
-    corners?: CORNERS;
+    corners?: TCorner;
     /** card drop shadow */
-    shadow?: DROP_SHADOWS;
+    shadow?: TDropShadow;
     /**
      * whether to show a button on the gallery card linking
      * out to the content - redundant with the title link,

package/dist/types/sites/_internal/enums/searchCategories.d.ts

@@ -1,8 +1,9 @@
-export declare enum SearchCategories {
-    DATA = "components.search.category_tabs.data",
-    SITES = "components.search.category_tabs.sites",
-    DOCUMENTS = "components.search.category_tabs.documents",
-    APPS_AND_MAPS = "components.search.category_tabs.apps_and_maps",
-    EVENTS = "components.search.category_tabs.events",
-    INITIATIVES = "components.search.category_tabs.initiatives"
-}
+export declare const SearchCategories: {
+    readonly DATA: "components.search.category_tabs.data";
+    readonly SITES: "components.search.category_tabs.sites";
+    readonly DOCUMENTS: "components.search.category_tabs.documents";
+    readonly APPS_AND_MAPS: "components.search.category_tabs.apps_and_maps";
+    readonly EVENTS: "components.search.category_tabs.events";
+    readonly INITIATIVES: "components.search.category_tabs.initiatives";
+};
+export type TSearchCategory = (typeof SearchCategories)[keyof typeof SearchCategories];

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

@@ -1,5 +1,5 @@
 import { IHubCollection } from "../search/types/IHubCatalog";
-import { SearchCategories } from "./_internal/enums/searchCategories";
+import { TSearchCategory } from "./_internal/enums/searchCategories";
 /**
  * Convert searchCategories to collections. If no searchCategories are provided,
  * the default collections will be returned.
@@ -7,4 +7,4 @@ import { SearchCategories } from "./_internal/enums/searchCategories";
  * @param searchCategories searchCategories from site model (data.values.searchCategories)
  * @returns IHubCollections that respect the searchCategories configuration
  */
-export declare function searchCategoriesToCollections(searchCategories?: SearchCategories[]): IHubCollection[];
+export declare function searchCategoriesToCollections(searchCategories?: TSearchCategory[]): IHubCollection[];

package/dist/types/utils/internal/setEntityStatusKeyword.d.ts

@@ -1,8 +1,8 @@
-import { HubEntityStatus } from "../../enums/hubEntityStatus";
+import { THubEntityStatus } from "../../enums/hubEntityStatus";
 /**
  * adds/updates the entity status typekeyword and returns
  * a new array of typekeywords
  * @param typeKeywords entity's current typekeywords
  * @param status entity status
  */
-export declare function setEntityStatusKeyword(typeKeywords: string[], status: HubEntityStatus): string[];
+export declare function setEntityStatusKeyword(typeKeywords: string[], status: THubEntityStatus): string[];

package/package.json

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