ochre-sdk 0.20.24 → 0.20.25

package/dist/index.d.mts

@@ -1268,9 +1268,9 @@ declare function fetchSetItems<U extends Array<DataCategory> = Array<DataCategor
   error: string;
 }>;
 //#endregion
-//#region src/utils/fetchers/set/property-values-by-property-variables.d.ts
+//#region src/utils/fetchers/set/property-values.d.ts
 /**
- * Fetches and parses Set property values by property variables from the OCHRE API
+ * Fetches and parses Set property values from the OCHRE API
  *
  * @param params - The parameters for the fetch
  * @param params.setScopeUuids - An array of set scope UUIDs to filter by
@@ -1285,7 +1285,7 @@ declare function fetchSetItems<U extends Array<DataCategory> = Array<DataCategor
  * @returns Parsed Set property values and requested attribute values.
  * Returns empty arrays/objects when no matches are found, and null outputs on fetch/parse errors.
  */
-declare function fetchSetPropertyValuesByPropertyVariables(params: {
+declare function fetchSetPropertyValues(params: {
   setScopeUuids: Array<string>;
   queries?: Array<Query>;
   attributes?: {
@@ -1470,4 +1470,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, LevelContext, LevelContextItem, License, Link, Metadata, Note, Observation, Period, Person, Property, PropertyContexts, PropertyValue, PropertyValueContent, PropertyValueContentType, PropertyValueQueryItem, PropertyVariable, Query, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValuesByPropertyVariables, 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, Query, Resource, Scope, Section, Set, SetAttributeValueQueryItem, SetItemsSort, SetItemsSortDirection, SpatialUnit, Style, Text, Tree, WebBlock, WebBlockLayout, WebElement, WebElementComponent, WebImage, WebSegment, WebSegmentItem, WebTitle, Webpage, Website, WebsiteType, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };

package/dist/index.mjs

@@ -861,10 +861,10 @@ function validateSetQueriesOperators(queries, ctx) {
 	});
 }
 /**
-* Schema for validating the parameters for the Set property values by property variables fetching function
+* Schema for validating the parameters for the Set property values fetching function
 * @internal
 */
-const setPropertyValuesByPropertyVariablesParamsSchema = z.object({
+const setPropertyValuesParamsSchema = z.object({
 	setScopeUuids: z.array(uuidSchema).min(1, "At least one set scope UUID is required"),
 	belongsToCollectionScopeUuids: z.array(uuidSchema).default([]),
 	queries: setQueriesSchema,
@@ -2807,7 +2807,7 @@ async function fetchSetItems(params, itemCategories, options) {
 	}
 }
 //#endregion
-//#region src/utils/fetchers/set/property-values-by-property-variables.ts
+//#region src/utils/fetchers/set/property-values.ts
 function parsePropertyValueLabel(content) {
 	if (content == null || content === "") return null;
 	if (typeof content === "object") return parseStringContent({ content });
@@ -2944,14 +2944,14 @@ const attributeValueQueryItemSchema = z.object({
 	content: val.content != null && val.content !== "" ? val.content : null
 }));
 /**
-* Schema for the property values by property variables OCHRE API response
+* Schema for the property values OCHRE API response
 */
 const responseSchema = z.object({ result: z.union([z.object({ ochre: z.object({
 	propertyValue: z.union([propertyValueQueryItemSchema, z.array(propertyValueQueryItemSchema)]).optional(),
 	attributeValue: z.union([attributeValueQueryItemSchema, z.array(attributeValueQueryItemSchema)]).optional()
 }) }), z.array(z.unknown()).length(0)]) });
 /**
-* Build an XQuery string to fetch property values by property variables from the OCHRE API
+* Build an XQuery string to fetch property values from the OCHRE API
 * @param params - The parameters for the fetch
 * @param params.setScopeUuids - An array of set scope UUIDs to filter by
 * @param params.belongsToCollectionScopeUuids - An array of collection scope UUIDs to filter by
@@ -3020,7 +3020,7 @@ ${queryBlocks.join("\n\n")}
 return (${returnedSequences.join(", ")})`}}</ochre>`;
 }
 /**
-* Fetches and parses Set property values by property variables from the OCHRE API
+* Fetches and parses Set property values from the OCHRE API
 *
 * @param params - The parameters for the fetch
 * @param params.setScopeUuids - An array of set scope UUIDs to filter by
@@ -3035,10 +3035,10 @@ return (${returnedSequences.join(", ")})`}}</ochre>`;
 * @returns Parsed Set property values and requested attribute values.
 * Returns empty arrays/objects when no matches are found, and null outputs on fetch/parse errors.
 */
-async function fetchSetPropertyValuesByPropertyVariables(params, options) {
+async function fetchSetPropertyValues(params, options) {
 	try {
 		const version = options?.version ?? 2;
-		const { setScopeUuids, belongsToCollectionScopeUuids, queries, attributes, isLimitedToLeafPropertyValues } = setPropertyValuesByPropertyVariablesParamsSchema.parse(params);
+		const { setScopeUuids, belongsToCollectionScopeUuids, queries, attributes, isLimitedToLeafPropertyValues } = setPropertyValuesParamsSchema.parse(params);
 		const xquery = buildXQuery({
 			setScopeUuids,
 			belongsToCollectionScopeUuids,
@@ -3100,7 +3100,7 @@ async function fetchSetPropertyValuesByPropertyVariables(params, options) {
 			propertyValues: null,
 			propertyValuesByPropertyVariableUuid: null,
 			attributeValues: null,
-			error: error instanceof Error ? error.message : "Failed to fetch property values by property variables"
+			error: error instanceof Error ? error.message : "Failed to fetch property values"
 		};
 	}
 }
@@ -4700,4 +4700,4 @@ async function fetchWebsite(abbreviation, options) {
 	}
 }
 //#endregion
-export { DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValuesByPropertyVariables, fetchWebsite, filterProperties, flattenItemProperties, getLeafPropertyValues, getPropertyByLabel, getPropertyByLabelAndValue, getPropertyByLabelAndValues, getPropertyByUuid, getPropertyValueByLabel, getPropertyValueByUuid, getPropertyValuesByLabel, getPropertyValuesByUuid, getUniqueProperties, getUniquePropertyLabels };
+export { DEFAULT_API_VERSION, DEFAULT_PAGE_SIZE, fetchGallery, fetchItem, fetchSetItems, fetchSetPropertyValues, 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.20.24",
+  "version": "0.20.25",
   "type": "module",
   "license": "MIT",
   "description": "Node.js library for working with OCHRE (Online Cultural and Historical Research Environment) data",