ochre-sdk 1.3.16 → 1.3.18

package/dist/parsers/website/components.mjs

@@ -455,6 +455,24 @@ function parseMapComponent(parameters) {
 	let maximumBounds = null;
 	const maximumBoundsProperty = componentReader.value("maximum-bounds");
 	if (maximumBoundsProperty !== null) maximumBounds = parseBounds(String(maximumBoundsProperty));
+	const layerSettings = [];
+	for (const layerReader of componentReader.nestedAllByValue("customize-special", "arcgis-layer")) {
+		const uuid = layerReader.uuid("use-layer");
+		if (uuid == null) continue;
+		const opacity = layerReader.value("opacity-percent");
+		const filterFields = layerReader.stringValues("filter-field");
+		layerSettings.push({
+			uuid,
+			isBasemap: layerReader.value("is-basemap"),
+			isDisplayedByDefault: layerReader.value("displayed-by-default"),
+			opacity: typeof opacity === "number" ? Math.min(Math.max(opacity, 0), 100) / 100 : null,
+			ochreLinkField: layerReader.stringValue("ochre-link-field"),
+			periodField: layerReader.stringValue("period-field"),
+			periodOrder: layerReader.stringValues("period-order"),
+			filterFields: filterFields.length > 0 ? filterFields : null,
+			markerColor: layerReader.stringValue("marker-color")
+		});
+	}
 	return {
 		component: "map",
 		linkUuids,
@@ -462,6 +480,7 @@ function parseMapComponent(parameters) {
 		customBasemap,
 		initialBounds,
 		maximumBounds,
+		layerSettings,
 		...properties
 	};
 }

package/dist/parsers/website/reader.d.mts

@@ -44,6 +44,7 @@ export declare class WebsitePresentationReader<T extends LanguageCodes> {
    * @returns The string, or null when the property is unset or not string-like
    */
   stringValue(label: string): string | null;
+  stringValues(label: string): Array<string>;
   uuid(label: string): string | null;
   multilingualValue(label: string, options: ParserOptions<T>): MultilingualString<T> | null;
   /**

package/dist/parsers/website/reader.mjs

@@ -63,6 +63,17 @@ var WebsitePresentationReader = class WebsitePresentationReader {
 		if (typeof value === "string") return value;
 		return typeof value === "number" ? value.toString() : null;
 	}
+	stringValues(label) {
+		const values = [];
+		for (const property of this.sourceProperties) {
+			if (getProperty([property], { label }) == null) continue;
+			for (const { content } of property.values) {
+				const value = typeof content === "number" ? content.toString() : content;
+				if (typeof value === "string" && value.trim() !== "") values.push(value.trim());
+			}
+		}
+		return values;
+	}
 	uuid(label) {
 		return this.valueNode(label)?.uuid ?? null;
 	}

package/dist/types/index.d.mts

@@ -229,7 +229,7 @@ export type Image<T extends LanguageCodes = LanguageCodes> = {
  *  Download option of an item in OCHRE
  */
 export type DownloadOption = {
-  type: "highQuality" | "iiifManifest" | "document" | "ocr";
+  type: "highQuality" | "iiifManifest" | "document" | "ocr" | "mets" | "alto";
   href: string;
   fileFormat: string;
 };

package/dist/types/website.d.mts

@@ -426,6 +426,17 @@ export type WebElementComponent<T extends LanguageCodes = LanguageCodes> = {
   customBasemap: string | null;
   initialBounds: [[number, number], [number, number]] | null;
   maximumBounds: [[number, number], [number, number]] | null;
+  layerSettings: Array<{
+    uuid: string;
+    isBasemap: boolean | null;
+    isDisplayedByDefault: boolean | null;
+    opacity: number | null;
+    ochreLinkField: string | null;
+    periodField: string | null;
+    periodOrder: Array<string>;
+    filterFields: Array<string> | null;
+    markerColor: string | null;
+  }>;
   isControlsDisplayed: boolean;
   isInteractive: boolean;
   isClustered: boolean;

package/dist/xml/schemas.d.mts

@@ -449,7 +449,7 @@ export declare const XMLGalleryData: v.ObjectSchema<{
           }, "XMLImageMap: Shape error">, undefined>;
           readonly downloadOptions: v.OptionalSchema<v.ObjectSchema<{
             readonly option: v.ArraySchema<v.ObjectSchema<{
-              readonly type: v.PicklistSchema<["highQuality", "iiifManifest", "document", "ocr"], "XMLDownloadOptions: type is highQuality, iiifManifest, document, or ocr">;
+              readonly type: v.PicklistSchema<["highQuality", "iiifManifest", "document", "ocr", "mets", "alto"], "XMLDownloadOptions: type is highQuality, iiifManifest, document, ocr, mets, or alto">;
               readonly href: v.SchemaWithPipe<readonly [v.StringSchema<"XMLDownloadOptions: href is string and required">, v.UrlAction<string, "XMLDownloadOptions: href is not a valid URL">]>;
               readonly fileFormat: v.StringSchema<"XMLDownloadOptions: fileFormat is string and required">;
             }, "XMLDownloadOptions: option is object with type, href, and fileFormat">, undefined>;
@@ -1653,7 +1653,7 @@ export declare const XMLGalleryData: v.ObjectSchema<{
                   }, "XMLImage: Shape error">, undefined>;
                   readonly downloadOptions: v.OptionalSchema<v.ObjectSchema<{
                     readonly option: v.ArraySchema<v.ObjectSchema<{
-                      readonly type: v.PicklistSchema<["highQuality", "iiifManifest", "document", "ocr"], "XMLDownloadOptions: type is highQuality, iiifManifest, document, or ocr">;
+                      readonly type: v.PicklistSchema<["highQuality", "iiifManifest", "document", "ocr", "mets", "alto"], "XMLDownloadOptions: type is highQuality, iiifManifest, document, ocr, mets, or alto">;
                       readonly href: v.SchemaWithPipe<readonly [v.StringSchema<"XMLDownloadOptions: href is string and required">, v.UrlAction<string, "XMLDownloadOptions: href is not a valid URL">]>;
                       readonly fileFormat: v.StringSchema<"XMLDownloadOptions: fileFormat is string and required">;
                     }, "XMLDownloadOptions: option is object with type, href, and fileFormat">, undefined>;
@@ -2997,7 +2997,7 @@ export declare const XMLGalleryData: v.ObjectSchema<{
               }, "XMLImage: Shape error">, undefined>;
               readonly downloadOptions: v.OptionalSchema<v.ObjectSchema<{
                 readonly option: v.ArraySchema<v.ObjectSchema<{
-                  readonly type: v.PicklistSchema<["highQuality", "iiifManifest", "document", "ocr"], "XMLDownloadOptions: type is highQuality, iiifManifest, document, or ocr">;
+                  readonly type: v.PicklistSchema<["highQuality", "iiifManifest", "document", "ocr", "mets", "alto"], "XMLDownloadOptions: type is highQuality, iiifManifest, document, ocr, mets, or alto">;
                   readonly href: v.SchemaWithPipe<readonly [v.StringSchema<"XMLDownloadOptions: href is string and required">, v.UrlAction<string, "XMLDownloadOptions: href is not a valid URL">]>;
                   readonly fileFormat: v.StringSchema<"XMLDownloadOptions: fileFormat is string and required">;
                 }, "XMLDownloadOptions: option is object with type, href, and fileFormat">, undefined>;

package/dist/xml/schemas.mjs

@@ -226,8 +226,10 @@ const XMLDownloadOptions = v.object({ option: v.array(v.object({
 		"highQuality",
 		"iiifManifest",
 		"document",
-		"ocr"
-	], "XMLDownloadOptions: type is highQuality, iiifManifest, document, or ocr"),
+		"ocr",
+		"mets",
+		"alto"
+	], "XMLDownloadOptions: type is highQuality, iiifManifest, document, ocr, mets, or alto"),
 	href: v.pipe(v.string("XMLDownloadOptions: href is string and required"), v.url("XMLDownloadOptions: href is not a valid URL")),
 	fileFormat: v.string("XMLDownloadOptions: fileFormat is string and required")
 }, "XMLDownloadOptions: option is object with type, href, and fileFormat")) }, "XMLDownloadOptions: Shape error");

package/dist/xml/types.d.mts

@@ -168,7 +168,7 @@ export type XMLImage = {
 };
 export type XMLDownloadOptions = {
   option: Array<{
-    type: "highQuality" | "iiifManifest" | "document" | "ocr";
+    type: "highQuality" | "iiifManifest" | "document" | "ocr" | "mets" | "alto";
     href: string;
     fileFormat: string;
   }>;

package/package.json

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