lucos_search_component 4.0.1 → 4.0.2

package/CLAUDE.md

@@ -0,0 +1,7 @@
+# lucos_search_component
+
+## Public interface changes
+
+Any change to the public interface of this component (new attributes, modified attribute behaviour, removed attributes) must be accompanied by a new or updated example in `example/index.html`.
+
+For **breaking changes** (removing or renaming an attribute, changing the expected format of an existing attribute), also review all existing examples in `example/index.html` to check whether any need updating or removing entirely.

package/dist/index.js

@@ -5696,12 +5696,13 @@ var categoryColoursCSS = "/* Generated by scripts/generate-colours.js — do not
 /**
  * Builds a Typesense filter_by expression from the search component's filter attributes.
  *
- * @param {string|null} types       - Value of data-types attribute (e.g. "Person,Place")
- * @param {string|null} excludeTypes - Value of data-exclude-types attribute (e.g. "Language")
- * @param {string|null} isContact   - Value of data-is-contact attribute ("true" or "false")
+ * @param {string|null} types          - Value of data-types attribute (e.g. "Person,Place")
+ * @param {string|null} excludeTypes   - Value of data-exclude-types attribute (e.g. "Language")
+ * @param {string|null} isContact      - Value of data-is-contact attribute ("true" or "false")
+ * @param {string|null} allowedOrigins - Value of data-allowed-origins attribute (e.g. "https://eolas.l42.eu")
  * @returns {string|null} filter expression, or null if no filters apply
  */
-function buildFilterBy(types, excludeTypes, isContact) {
+function buildFilterBy(types, excludeTypes, isContact, allowedOrigins) {
 	const parts = [];
 	if (types) {
 		parts.push(`types:=[${types}]`);
@@ -5713,6 +5714,9 @@ function buildFilterBy(types, excludeTypes, isContact) {
 	} else if (isContact === 'false') {
 		parts.push('is_contact:=false');
 	}
+	if (allowedOrigins) {
+		parts.push(`origin:=[${allowedOrigins}]`);
+	}
 	return parts.length > 0 ? parts.join(' && ') : null;
 }
 
@@ -5748,7 +5752,7 @@ function buildFormDataEntries(name, values, optionMap) {
 
 class LucosSearchComponent extends HTMLSpanElement {
 	static get observedAttributes() {
-		return ['data-api-key','data-types','data-exclude_types','data-is-contact','data-label-override-zxx','data-common','data-preload','data-create'];
+		return ['data-api-key','data-types','data-exclude_types','data-is-contact','data-label-override-zxx','data-common','data-preload','data-create','data-allowed-origins'];
 	}
 	constructor() {
 		super();
@@ -5934,6 +5938,7 @@ class LucosSearchComponent extends HTMLSpanElement {
 					component.getAttribute("data-types"),
 					component.getAttribute("data-exclude_types"),
 					component.getAttribute("data-is-contact"),
+					component.getAttribute("data-allowed-origins"),
 				);
 				if (filterBy) queryParams.set("filter_by", filterBy);
 				try {
@@ -6012,6 +6017,7 @@ class LucosSearchComponent extends HTMLSpanElement {
 						component.getAttribute("data-types"),
 						component.getAttribute("data-exclude_types"),
 						component.getAttribute("data-is-contact"),
+						component.getAttribute("data-allowed-origins"),
 					);
 					// per_page: 250 acts as an upper bound — data-preload is intended for finite datasets
 					const preloadParams = new URLSearchParams({ q: '*', per_page: 250 });

package/example/index.html

@@ -19,6 +19,7 @@
 		<label for="search6">Languages with label override for zxx:</label><span is="lucos-search" data-api-key="${KEY_LUCOS_ARACHNE}" data-types="Language" data-label-override-zxx="No Language"><select id="search6"></select></span>
 		<label for="search7">Languages with zxx pre-selected:</label><span is="lucos-search" data-api-key="${KEY_LUCOS_ARACHNE}" data-types="Language" data-label-override-zxx="No Language"><select id="search7" multiple><option selected>https://eolas.l42.eu/metadata/language/zxx/</option></select></span>
 		<label for="search11">Languages with label override, common and preload:</label><span is="lucos-search" data-api-key="${KEY_LUCOS_ARACHNE}" data-types="Language" data-label-override-zxx="Instrumental / No Language" data-common="https://eolas.l42.eu/metadata/language/en/,https://eolas.l42.eu/metadata/language/ga/,https://eolas.l42.eu/metadata/language/zxx/" data-preload><select id="search11" multiple ></select></span>
+		<label for="search_origins">Eolas only (data-allowed-origins):</label><span is="lucos-search" data-api-key="${KEY_LUCOS_ARACHNE}" data-allowed-origins="https://eolas.l42.eu"><select id="search_origins"></select></span>
 		<label for="search5">More than 10:</label>
 		<span is="lucos-search" data-api-key="${KEY_LUCOS_ARACHNE}" data-exclude_types="Track"><select id="search5" multiple>
 			<option selected>https://eolas.l42.eu/metadata/place/125/</option>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lucos_search_component",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Web Components for searching lucOS data",
   "type": "module",
   "main": "dist/index.js",

package/test/filter.test.mjs

@@ -31,3 +31,23 @@ test('data-exclude-types produces types:!= filter', () => {
 	const result = buildFilterBy(null, 'Track', null);
 	assert.equal(result, 'types:!=[Track]');
 });
+
+test('data-allowed-origins produces origin:= filter', () => {
+	const result = buildFilterBy(null, null, null, 'https://eolas.l42.eu');
+	assert.equal(result, 'origin:=[https://eolas.l42.eu]');
+});
+
+test('data-allowed-origins with multiple comma-separated origins', () => {
+	const result = buildFilterBy(null, null, null, 'https://eolas.l42.eu,https://contacts.l42.eu');
+	assert.equal(result, 'origin:=[https://eolas.l42.eu,https://contacts.l42.eu]');
+});
+
+test('data-allowed-origins combines with data-types', () => {
+	const result = buildFilterBy('Person', null, null, 'https://eolas.l42.eu');
+	assert.equal(result, 'types:=[Person] && origin:=[https://eolas.l42.eu]');
+});
+
+test('absent data-allowed-origins produces no origin filter', () => {
+	const result = buildFilterBy('Person', null, null, null);
+	assert.equal(result, 'types:=[Person]');
+});

package/web-components/filter.js

@@ -1,12 +1,13 @@
 /**
  * Builds a Typesense filter_by expression from the search component's filter attributes.
  *
- * @param {string|null} types       - Value of data-types attribute (e.g. "Person,Place")
- * @param {string|null} excludeTypes - Value of data-exclude-types attribute (e.g. "Language")
- * @param {string|null} isContact   - Value of data-is-contact attribute ("true" or "false")
+ * @param {string|null} types          - Value of data-types attribute (e.g. "Person,Place")
+ * @param {string|null} excludeTypes   - Value of data-exclude-types attribute (e.g. "Language")
+ * @param {string|null} isContact      - Value of data-is-contact attribute ("true" or "false")
+ * @param {string|null} allowedOrigins - Value of data-allowed-origins attribute (e.g. "https://eolas.l42.eu")
  * @returns {string|null} filter expression, or null if no filters apply
  */
-export function buildFilterBy(types, excludeTypes, isContact) {
+export function buildFilterBy(types, excludeTypes, isContact, allowedOrigins) {
 	const parts = [];
 	if (types) {
 		parts.push(`types:=[${types}]`);
@@ -18,5 +19,8 @@ export function buildFilterBy(types, excludeTypes, isContact) {
 	} else if (isContact === 'false') {
 		parts.push('is_contact:=false');
 	}
+	if (allowedOrigins) {
+		parts.push(`origin:=[${allowedOrigins}]`);
+	}
 	return parts.length > 0 ? parts.join(' && ') : null;
 }

package/web-components/lucos-search.js

@@ -6,7 +6,7 @@ import { buildFormDataEntries } from './form-serialise.js';
 
 class LucosSearchComponent extends HTMLSpanElement {
 	static get observedAttributes() {
-		return ['data-api-key','data-types','data-exclude_types','data-is-contact','data-label-override-zxx','data-common','data-preload','data-create'];
+		return ['data-api-key','data-types','data-exclude_types','data-is-contact','data-label-override-zxx','data-common','data-preload','data-create','data-allowed-origins'];
 	}
 	constructor() {
 		super();
@@ -192,6 +192,7 @@ class LucosSearchComponent extends HTMLSpanElement {
 					component.getAttribute("data-types"),
 					component.getAttribute("data-exclude_types"),
 					component.getAttribute("data-is-contact"),
+					component.getAttribute("data-allowed-origins"),
 				);
 				if (filterBy) queryParams.set("filter_by", filterBy);
 				try {
@@ -270,6 +271,7 @@ class LucosSearchComponent extends HTMLSpanElement {
 						component.getAttribute("data-types"),
 						component.getAttribute("data-exclude_types"),
 						component.getAttribute("data-is-contact"),
+						component.getAttribute("data-allowed-origins"),
 					);
 					// per_page: 250 acts as an upper bound — data-preload is intended for finite datasets
 					const preloadParams = new URLSearchParams({ q: '*', per_page: 250 });