ochre-sdk 0.19.4 → 0.19.5

package/dist/index.d.mts

@@ -640,129 +640,6 @@ type PropertyValueQueryItem = {
   label: string | null;
 };
 //#endregion
-//#region src/utils/fetchers/gallery.d.ts
-/**
- * Fetches and parses a gallery from the OCHRE API
- *
- * @param uuid - The UUID of the gallery
- * @param filter - The filter to apply to the gallery
- * @param page - The page number to fetch
- * @param pageSize - The number of items per page
- * @param options - The options for the fetch
- * @param options.fetch - The fetch function to use
- * @param options.version - The version of the OCHRE API to use
- * @returns The parsed gallery or an error message if the fetch/parse fails
- */
-declare function fetchGallery(uuid: string, filter: string, page: number, pageSize: number, options?: {
-  fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
-  version?: ApiVersion;
-}): Promise<{
-  item: Gallery | null;
-  error: null;
-} | {
-  item: null;
-  error: string;
-}>;
-//#endregion
-//#region src/utils/fetchers/item.d.ts
-/**
- * Fetches and parses an OCHRE item from the OCHRE API
- *
- * @param uuid - The UUID of the OCHRE item to fetch
- * @returns Object containing the parsed OCHRE item, or an error message if the fetch/parse fails
- */
-declare function fetchItem<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(uuid: string, category?: T, itemCategories?: U, options?: {
-  fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
-  version?: ApiVersion;
-}): Promise<{
-  error: null;
-  item: Item<T, U>;
-} | {
-  error: string;
-  item: never;
-}>;
-//#endregion
-//#region src/utils/fetchers/items-by-property-values.d.ts
-/**
- * Fetches and parses items by property values from the OCHRE API
- *
- * @param params - The parameters for the fetch
- * @param params.projectScopeUuid - The UUID of the project scope
- * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
- * @param params.propertyVariableUuids - The property variable UUIDs to query by
- * @param params.propertyValues - The property values to query by
- * @param params.page - The page number (1-indexed)
- * @param params.pageSize - The number of items per page
- * @param params.itemCategory - The category of the items to fetch
- * @param params.includeChildItems - Whether to include child items of the same category
- * @param categoryParams - The category parameters for the fetch
- * @param categoryParams.category - The category of the items to fetch
- * @param categoryParams.itemCategories - The categories of the items to fetch
- * @param options - Options for the fetch
- * @param options.fetch - The fetch function to use
- * @param options.version - The version of the OCHRE API to use
- * @returns The parsed items by property values or null if the fetch/parse fails
- */
-declare function fetchItemsByPropertyValues<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(params: {
-  projectScopeUuid: string;
-  belongsToCollectionScopeUuids: Array<string>;
-  propertyVariableUuids: Array<string>;
-  propertyValues: Array<{
-    dataType: Exclude<PropertyValueContentType, "coordinate">;
-    value: string;
-  }>;
-  page: number;
-  pageSize?: number;
-  itemCategory?: "resource" | "spatialUnit" | "concept" | "text";
-  includeChildItems?: boolean;
-}, categoryParams?: {
-  category?: T;
-  itemCategories?: U;
-}, options?: {
-  fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
-  version?: ApiVersion;
-}): Promise<{
-  totalCount: number;
-  page: number;
-  pageSize: number;
-  items: Array<Item<T, U>>;
-  error: null;
-} | {
-  totalCount: null;
-  page: null;
-  pageSize: null;
-  items: null;
-  error: string;
-}>;
-//#endregion
-//#region src/utils/fetchers/property-values-by-property-variables.d.ts
-/**
- * Fetches and parses property values by property variables from the OCHRE API
- *
- * @param params - The parameters for the fetch
- * @param params.projectScopeUuid - The UUID of the project scope
- * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
- * @param params.propertyVariableUuids - The property variable UUIDs to query by
- * @param options - Options for the fetch
- * @param options.fetch - The fetch function to use
- * @param options.version - The version of the OCHRE API to use
- * @returns The parsed property values by property variables or null if the fetch/parse fails
- */
-declare function fetchPropertyValuesByPropertyVariables(params: {
-  projectScopeUuid: string;
-  belongsToCollectionScopeUuids: Array<string>;
-  propertyVariableUuids: Array<string>;
-}, options?: {
-  fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
-  version?: ApiVersion;
-}): Promise<{
-  items: Array<PropertyValueQueryItem> | null;
-  error: null;
-} | {
-  items: null;
-  error: string;
-}>;
-//#endregion
 //#region src/types/website.d.ts
 /**
  * Represents a level context item with a variable and value
@@ -1198,6 +1075,129 @@ type WebBlock<T extends WebBlockLayout = WebBlockLayout> = {
   };
 };
 //#endregion
+//#region src/utils/fetchers/gallery.d.ts
+/**
+ * Fetches and parses a gallery from the OCHRE API
+ *
+ * @param uuid - The UUID of the gallery
+ * @param filter - The filter to apply to the gallery
+ * @param page - The page number to fetch
+ * @param pageSize - The number of items per page
+ * @param options - The options for the fetch
+ * @param options.fetch - The fetch function to use
+ * @param options.version - The version of the OCHRE API to use
+ * @returns The parsed gallery or an error message if the fetch/parse fails
+ */
+declare function fetchGallery(uuid: string, filter: string, page: number, pageSize: number, options?: {
+  fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
+  version?: ApiVersion;
+}): Promise<{
+  item: Gallery | null;
+  error: null;
+} | {
+  item: null;
+  error: string;
+}>;
+//#endregion
+//#region src/utils/fetchers/item.d.ts
+/**
+ * Fetches and parses an OCHRE item from the OCHRE API
+ *
+ * @param uuid - The UUID of the OCHRE item to fetch
+ * @returns Object containing the parsed OCHRE item, or an error message if the fetch/parse fails
+ */
+declare function fetchItem<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(uuid: string, category?: T, itemCategories?: U, options?: {
+  fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
+  version?: ApiVersion;
+}): Promise<{
+  error: null;
+  item: Item<T, U>;
+} | {
+  error: string;
+  item: never;
+}>;
+//#endregion
+//#region src/utils/fetchers/items-by-property-values.d.ts
+/**
+ * Fetches and parses items by property values from the OCHRE API
+ *
+ * @param params - The parameters for the fetch
+ * @param params.projectScopeUuid - The UUID of the project scope
+ * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
+ * @param params.propertyVariableUuids - The property variable UUIDs to query by
+ * @param params.propertyValues - The property values to query by
+ * @param params.page - The page number (1-indexed)
+ * @param params.pageSize - The number of items per page
+ * @param params.itemCategory - The category of the items to fetch
+ * @param params.includeChildItems - Whether to include child items of the same category
+ * @param categoryParams - The category parameters for the fetch
+ * @param categoryParams.category - The category of the items to fetch
+ * @param categoryParams.itemCategories - The categories of the items to fetch
+ * @param options - Options for the fetch
+ * @param options.fetch - The fetch function to use
+ * @param options.version - The version of the OCHRE API to use
+ * @returns The parsed items by property values or null if the fetch/parse fails
+ */
+declare function fetchItemsByPropertyValues<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(params: {
+  projectScopeUuid: string;
+  belongsToCollectionScopeUuids: Array<string>;
+  propertyVariableUuids: Array<string>;
+  propertyValues: Array<{
+    dataType: Exclude<PropertyValueContentType, "coordinate">;
+    value: string;
+  }>;
+  page: number;
+  pageSize?: number;
+  itemCategory?: "resource" | "spatialUnit" | "concept" | "text";
+  includeChildItems?: boolean;
+}, categoryParams?: {
+  category?: T;
+  itemCategories?: U;
+}, options?: {
+  fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
+  version?: ApiVersion;
+}): Promise<{
+  totalCount: number;
+  page: number;
+  pageSize: number;
+  items: Array<Item<T, U>>;
+  error: null;
+} | {
+  totalCount: null;
+  page: null;
+  pageSize: null;
+  items: null;
+  error: string;
+}>;
+//#endregion
+//#region src/utils/fetchers/property-values-by-property-variables.d.ts
+/**
+ * Fetches and parses property values by property variables from the OCHRE API
+ *
+ * @param params - The parameters for the fetch
+ * @param params.projectScopeUuid - The UUID of the project scope
+ * @param params.belongsToCollectionScopeUuids - The collection scope UUIDs to filter by
+ * @param params.propertyVariableUuids - The property variable UUIDs to query by
+ * @param options - Options for the fetch
+ * @param options.fetch - The fetch function to use
+ * @param options.version - The version of the OCHRE API to use
+ * @returns The parsed property values by property variables or null if the fetch/parse fails
+ */
+declare function fetchPropertyValuesByPropertyVariables(params: {
+  projectScopeUuid: string;
+  belongsToCollectionScopeUuids: Array<string>;
+  propertyVariableUuids: Array<string>;
+}, options?: {
+  fetch?: (input: string | URL | globalThis.Request, init?: RequestInit) => Promise<Response>;
+  version?: ApiVersion;
+}): Promise<{
+  items: Array<PropertyValueQueryItem> | null;
+  error: null;
+} | {
+  items: null;
+  error: string;
+}>;
+//#endregion
 //#region src/utils/fetchers/website.d.ts
 /**
  * Fetches and parses a website configuration from the OCHRE API
@@ -1351,4 +1351,4 @@ declare const DEFAULT_PAGE_SIZE = 48;
  */
 declare function flattenItemProperties<T extends DataCategory = DataCategory, U extends DataCategory | Array<DataCategory> = (T extends "tree" ? Exclude<DataCategory, "tree"> : T extends "set" ? Array<DataCategory> : never)>(item: Item<T, U>): Item<T, U>;
 //#endregion
-export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Resource, Section, Set, SpatialUnit, Text, Tree, fetchGallery, fetchItem, fetchItemsByPropertyValues, fetchPropertyValuesByPropertyVariables, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { ApiVersion, Bibliography, Concept, Context, ContextItem, ContextNode, Coordinate, DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, Data, DataCategory, Event, FileFormat, Gallery, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Resource, Scope, Section, Set, SpatialUnit, Style, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsiteType, fetchGallery, fetchItem, fetchItemsByPropertyValues, fetchPropertyValuesByPropertyVariables, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ochre-sdk",
-  "version": "0.19.4",
+  "version": "0.19.5",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",