@inseefr/lunatic 0.2.0-experimental → 0.2.0-prisme

package/src/utils/store-tools/auto-load.js

@@ -1,72 +1,74 @@
-import openStorage from './open-or-create-store';
-import updateStoreInfo from './create/update-store-info';
-import cleanStorage from './clear-store-data';
-import cleanInfoStorage from './clear-store-info';
-
-const workerPath =
-	process.env.LUNATIC_LOADER_WORKER_PATH ||
-	process.env.REACT_APP_LUNATIC_LOADER_WORKER_PATH ||
-	'workers/lunatic-loader-worker-0.1.0.js';
-
-export const loadSuggesters = (suggesterFetcher) => async (suggesters) => {
-	Object.entries(suggesters).forEach(async ([name, attrs]) => {
-		const { version } = attrs;
-		const db = await openStorage(name, version);
-		if (db) {
-			await cleanStorage(db);
-			await cleanInfoStorage(db);
-			await updateStoreInfo(db, attrs);
-		}
-	});
-	Object.entries(suggesters).forEach(([name, attrs]) => {
-		const { url, version, fields, stopWords } = attrs;
-		const f = suggesterFetcher || fetch;
-		f(url).then(async (res) => {
-			const data = await res.json();
-			const [launch] = task({ name, fields, stopWords }, version);
-			await launch(data);
-		});
-	});
-};
-
-/**
- * Only with Worker
- */
-function task({ name, fields, stopWords }, version, log = () => null) {
-	const worker = new Worker(workerPath);
-	let start = false;
-	let stop = false;
-
-	function launch(entities, post = () => null) {
-		return new Promise(function (resolve) {
-			start = true;
-			worker.postMessage({
-				name,
-				version,
-				fields,
-				entities,
-				stopWords,
-			});
-			worker.addEventListener('message', function (e) {
-				const { data } = e;
-				if (data === 'success') {
-					if (!stop) {
-						post();
-					}
-					resolve(data);
-				} else {
-					log(data);
-				}
-			});
-		});
-	}
-
-	function terminate() {
-		if (start) {
-			stop = true;
-			worker.terminate();
-		}
-	}
-
-	return [launch, terminate];
-}
+import openStorage from './open-or-create-store';
+import updateStoreInfo from './create/update-store-info';
+import cleanStorage from './clear-store-data';
+import cleanInfoStorage from './clear-store-info';
+import { createWorker } from '../suggester-workers/create-worker';
+
+const workerPath =
+	process.env.LUNATIC_LOADER_WORKER_PATH ||
+	process.env.REACT_APP_LUNATIC_LOADER_WORKER_PATH ||
+	'workers/lunatic-loader-worker-0.1.0.js';
+
+export const loadSuggesters = (suggesterFetcher) => async (suggesters) => {
+	Object.entries(suggesters).forEach(async ([name, attrs]) => {
+		const { version } = attrs;
+		const db = await openStorage(name, version);
+		if (db) {
+			await cleanStorage(db);
+			await cleanInfoStorage(db);
+			await updateStoreInfo(db, attrs);
+		}
+	});
+	Object.entries(suggesters).forEach(([name, attrs]) => {
+		const { url, version, fields, stopWords } = attrs;
+		const f = suggesterFetcher || fetch;
+		f(url).then(async (res) => {
+			const data = await res.json();
+			const [launch, terminate] = task({ name, fields, stopWords }, version);
+			await launch(data);
+			terminate();
+		});
+	});
+};
+
+/**
+ * Only with Worker
+ */
+function task({ name, fields, stopWords }, version, log = () => null) {
+	const worker = createWorker(workerPath);
+	let start = false;
+	let stop = false;
+
+	function launch(entities, post = () => null) {
+		return new Promise(function (resolve) {
+			start = true;
+			worker.postMessage({
+				name,
+				version,
+				fields,
+				entities,
+				stopWords,
+			});
+			worker.addEventListener('message', function (e) {
+				const { data } = e;
+				if (data === 'success') {
+					if (!stop) {
+						post();
+					}
+					resolve(data);
+				} else {
+					log(data);
+				}
+			});
+		});
+	}
+
+	function terminate() {
+		if (start) {
+			stop = true;
+			worker.terminate();
+		}
+	}
+
+	return [launch, terminate];
+}

package/src/utils/store-tools/clear-store-data.js

@@ -1,8 +1,8 @@
-import { clearDb } from '../idb-tools';
-import CONSTANTES from './constantes';
-
-async function clear(db) {
-	await clearDb(db, CONSTANTES.STORE_DATA_NAME);
-}
-
-export default clear;
+import { clearDb } from '../idb-tools';
+import CONSTANTES from './constantes';
+
+async function clear(db) {
+	await clearDb(db, CONSTANTES.STORE_DATA_NAME);
+}
+
+export default clear;

package/src/utils/store-tools/clear-store-info.js

@@ -1,8 +1,8 @@
-import { clearDb } from '../idb-tools';
-import CONSTANTES from './constantes';
-
-async function clear(db) {
-	await clearDb(db, CONSTANTES.STORE_INFO_NAME);
-}
-
-export default clear;
+import { clearDb } from '../idb-tools';
+import CONSTANTES from './constantes';
+
+async function clear(db) {
+	await clearDb(db, CONSTANTES.STORE_INFO_NAME);
+}
+
+export default clear;

package/src/utils/store-tools/constantes.js

@@ -1,20 +1,20 @@
-export const STORE_DATA_NAME = 'store/entities';
-export const STORE_INFO_NAME = 'store/info';
-export const STORE_INDEX_NAME = 'store/entities/index';
-export const STORE_INDEX_PATH = 'searching';
-export const MAX_STRING = String.fromCharCode(65535);
-export const SEARCH_TYPES = {
-	prefix: 'search/prefix',
-	tokens: 'search/tokens',
-};
-
-const CONSTANTES = {
-	STORE_DATA_NAME,
-	STORE_INDEX_NAME,
-	STORE_INDEX_PATH,
-	MAX_STRING,
-	SEARCH_TYPES,
-	STORE_INFO_NAME,
-};
-
-export default CONSTANTES;
+export const STORE_DATA_NAME = 'store/entities';
+export const STORE_INFO_NAME = 'store/info';
+export const STORE_INDEX_NAME = 'store/entities/index';
+export const STORE_INDEX_PATH = 'searching';
+export const MAX_STRING = String.fromCharCode(65535);
+export const SEARCH_TYPES = {
+	prefix: 'search/prefix',
+	tokens: 'search/tokens',
+};
+
+const CONSTANTES = {
+	STORE_DATA_NAME,
+	STORE_INDEX_NAME,
+	STORE_INDEX_PATH,
+	MAX_STRING,
+	SEARCH_TYPES,
+	STORE_INFO_NAME,
+};
+
+export default CONSTANTES;

package/src/utils/store-tools/create/create.js

@@ -1,19 +1,19 @@
-import { clearDb } from '../../idb-tools';
-import CONSTANTES from '../constantes';
-import openOrCreateStore from '../open-or-create-store';
-import updateStoreInfo from './update-store-info';
-
-async function create(storeInfo, idbVersion) {
-	const { name } = storeInfo;
-	try {
-		const db = await openOrCreateStore(name, idbVersion);
-		await clearDb(db, CONSTANTES.STORE_INFO_NAME);
-		await updateStoreInfo(db, storeInfo);
-
-		return db;
-	} catch (e) {
-		throw e;
-	}
-}
-
-export default create;
+import { clearDb } from '../../idb-tools';
+import CONSTANTES from '../constantes';
+import openOrCreateStore from '../open-or-create-store';
+import updateStoreInfo from './update-store-info';
+
+async function create(storeInfo, idbVersion) {
+	const { name } = storeInfo;
+	try {
+		const db = await openOrCreateStore(name, idbVersion);
+		await clearDb(db, CONSTANTES.STORE_INFO_NAME);
+		await updateStoreInfo(db, storeInfo);
+
+		return db;
+	} catch (e) {
+		throw e;
+	}
+}
+
+export default create;

package/src/utils/store-tools/create/index.js

@@ -1 +1 @@
-export { default } from './create';
+export { default } from './create';

package/src/utils/store-tools/create/update-store-info.js

@@ -1,26 +1,26 @@
-import CONSTANTES from '../constantes';
-
-function update(db, storeInfo) {
-	return new Promise(function (resolve, reject) {
-		try {
-			const transaction = db.transaction(
-				CONSTANTES.STORE_INFO_NAME,
-				'readwrite'
-			);
-			const store = transaction.objectStore(CONSTANTES.STORE_INFO_NAME);
-			const request = store.add(storeInfo);
-
-			request.onsuccess = function () {
-				resolve('success');
-			};
-
-			request.onerror = function (e) {
-				reject(e);
-			};
-		} catch (e) {
-			reject(e);
-		}
-	});
-}
-
-export default update;
+import CONSTANTES from '../constantes';
+
+function update(db, storeInfo) {
+	return new Promise(function (resolve, reject) {
+		try {
+			const transaction = db.transaction(
+				CONSTANTES.STORE_INFO_NAME,
+				'readwrite'
+			);
+			const store = transaction.objectStore(CONSTANTES.STORE_INFO_NAME);
+			const request = store.add(storeInfo);
+
+			request.onsuccess = function () {
+				resolve('success');
+			};
+
+			request.onerror = function (e) {
+				reject(e);
+			};
+		} catch (e) {
+			reject(e);
+		}
+	});
+}
+
+export default update;

package/src/utils/store-tools/get-store-count.js

@@ -1,22 +1,22 @@
-import CONSTANTES from './constantes';
-
-function get(db) {
-	return new Promise(function (resolve, reject) {
-		try {
-			const transaction = db.transaction(
-				[CONSTANTES.STORE_DATA_NAME],
-				'readonly'
-			);
-
-			const store = transaction.objectStore(CONSTANTES.STORE_DATA_NAME);
-			const countRequest = store.count();
-			countRequest.onsuccess = function () {
-				resolve(countRequest.result);
-			};
-		} catch (e) {
-			reject(e);
-		}
-	});
-}
-
-export default get;
+import CONSTANTES from './constantes';
+
+function get(db) {
+	return new Promise(function (resolve, reject) {
+		try {
+			const transaction = db.transaction(
+				[CONSTANTES.STORE_DATA_NAME],
+				'readonly'
+			);
+
+			const store = transaction.objectStore(CONSTANTES.STORE_DATA_NAME);
+			const countRequest = store.count();
+			countRequest.onsuccess = function () {
+				resolve(countRequest.result);
+			};
+		} catch (e) {
+			reject(e);
+		}
+	});
+}
+
+export default get;

package/src/utils/store-tools/index.js

@@ -1,5 +1,5 @@
-export * as CONSTANTES from './constantes';
-export { default as openOrCreateStore } from './open-or-create-store';
-export { default as clearStoreData } from './clear-store-data';
-export { default as useStoreIndex } from './use-store-index';
-export { default as getStoreCount } from './get-store-count';
+export * as CONSTANTES from './constantes';
+export { default as openOrCreateStore } from './open-or-create-store';
+export { default as clearStoreData } from './clear-store-data';
+export { default as useStoreIndex } from './use-store-index';
+export { default as getStoreCount } from './get-store-count';

package/src/utils/store-tools/open-or-create-store.js

@@ -1,47 +1,47 @@
-/* eslint-disable no-restricted-globals */
-import CONSTANTE from './constantes';
-import { getIDB } from '../idb-tools';
-
-const IDB_REF = getIDB();
-
-function openStorage(name, idbVersion = 1) {
-	return new Promise(function (resolve, reject) {
-		if (!IDB_REF) {
-			reject('indexedDb not supported !');
-		}
-		const request = IDB_REF.open(name, idbVersion);
-		let db;
-		let doIt = true;
-
-		request.onupgradeneeded = function (e) {
-			doIt = false;
-			db = e.target.result;
-			const store = db.createObjectStore(CONSTANTE.STORE_DATA_NAME, {
-				keyPath: 'id',
-			});
-			db.createObjectStore(CONSTANTE.STORE_INFO_NAME, {
-				keyPath: 'name',
-			});
-			store.createIndex(CONSTANTE.STORE_INDEX_NAME, 'tokens', {
-				multiEntry: true,
-			});
-
-			const txn = e.target.transaction;
-			txn.oncomplete = function () {
-				resolve(db);
-			};
-		};
-
-		request.onsuccess = function () {
-			if (doIt) {
-				resolve(request.result);
-			}
-		};
-
-		request.onerror = function (e) {
-			reject(e);
-		};
-	});
-}
-
-export default openStorage;
+/* eslint-disable no-restricted-globals */
+import CONSTANTE from './constantes';
+import { getIDB } from '../idb-tools';
+
+const IDB_REF = getIDB();
+
+function openStorage(name, idbVersion = 1) {
+	return new Promise(function (resolve, reject) {
+		if (!IDB_REF) {
+			reject('indexedDb not supported !');
+		}
+		const request = IDB_REF.open(name, idbVersion);
+		let db;
+		let doIt = true;
+
+		request.onupgradeneeded = function (e) {
+			doIt = false;
+			db = e.target.result;
+			const store = db.createObjectStore(CONSTANTE.STORE_DATA_NAME, {
+				keyPath: 'id',
+			});
+			db.createObjectStore(CONSTANTE.STORE_INFO_NAME, {
+				keyPath: 'name',
+			});
+			store.createIndex(CONSTANTE.STORE_INDEX_NAME, 'tokens', {
+				multiEntry: true,
+			});
+
+			const txn = e.target.transaction;
+			txn.oncomplete = function () {
+				resolve(db);
+			};
+		};
+
+		request.onsuccess = function () {
+			if (doIt) {
+				resolve(request.result);
+			}
+		};
+
+		request.onerror = function (e) {
+			reject(e);
+		};
+	});
+}
+
+export default openStorage;

package/src/utils/store-tools/use-store-index.js

@@ -1,24 +1,24 @@
-import { useEffect, useState } from 'react';
-import createStore from './create';
-
-function useStoreIndex(storeInfo, idbVersion) {
-	const [db, setDb] = useState(undefined);
-
-	useEffect(
-		function () {
-			async function init() {
-				if (storeInfo && idbVersion) {
-					const db = await createStore(storeInfo, idbVersion);
-					setDb(db);
-				}
-			}
-
-			init();
-			return function () {};
-		},
-		[storeInfo, idbVersion]
-	);
-	return db;
-}
-
-export default useStoreIndex;
+import { useEffect, useState } from 'react';
+import createStore from './create';
+
+function useStoreIndex(storeInfo, idbVersion) {
+	const [db, setDb] = useState(undefined);
+
+	useEffect(
+		function () {
+			async function init() {
+				if (storeInfo && idbVersion) {
+					const db = await createStore(storeInfo, idbVersion);
+					setDb(db);
+				}
+			}
+
+			init();
+			return function () {};
+		},
+		[storeInfo, idbVersion]
+	);
+	return db;
+}
+
+export default useStoreIndex;

package/src/utils/suggester-workers/append-to-index/create-append-task.js

@@ -1,3 +1,5 @@
+import { createWorker } from '../create-worker';
+
 const workerPath =
 	process.env.LUNATIC_LOADER_WORKER_PATH ||
 	process.env.REACT_APP_LUNATIC_LOADER_WORKER_PATH ||
@@ -8,14 +10,13 @@ const workerPath =
  */
 function task(info, version, log = () => null) {
 	const { name, fields, stopWords } = info;
-	const worker = new Worker(workerPath);
+	const worker = createWorker(workerPath);
 	let start = false;
 	let stop = false;
 
 	function launch(entities, post = () => null) {
 		return new Promise(function (resolve) {
 			start = true;
-			worker.postMessage({ name, version, fields, stopWords, entities });
 			worker.addEventListener('message', function (e) {
 				const { data } = e;
 				if (data === 'success') {
@@ -27,6 +28,7 @@ function task(info, version, log = () => null) {
 					log(data);
 				}
 			});
+			worker.postMessage({ name, version, fields, stopWords, entities });
 		});
 	}
 

package/src/utils/suggester-workers/append-to-index/prepare-entities.js

@@ -3,17 +3,34 @@ import MESSAGES from './store-messages';
 
 const DEFAULT_BATCH_SIZE = 1000;
 
-function createTokensMap(tokens) {
-	return tokens.reduce(function (map, token) {
-		if (token in map) {
-			return { ...map, [token]: { count: map[token] + 1 } };
-		}
-		return { ...map, [token]: { count: 1 } };
+function appendField(fields, field) {
+	if (fields.indexOf(field) !== -1) {
+		return fields;
+	}
+	return [...fields, field];
+}
+
+function createTokensMap(tokensFields) {
+	return Object.entries(tokensFields).reduce(function (map, [field, tokens]) {
+		return tokens.reduce(function (map2, token) {
+			if (token in map2) {
+				const entry = map2[token];
+				const { fields, count } = entry;
+				return {
+					...map2,
+					[token]: {
+						count: count + 1,
+						fields: appendField(fields, field),
+					},
+				};
+			}
+			return { ...map2, [token]: { count: 1, fields: [field] } };
+		}, map);
 	}, {});
 }
 
-function prepareEntities(entities, { fields, stopWords, stemmer }, log) {
-	const tokenizer = createTokenizer(fields, stopWords, stemmer);
+function prepareEntities(entities, { fields, stopWords }, log) {
+	const tokenizer = createTokenizer(fields, stopWords);
 
 	let done = 0;
 	const size = DEFAULT_BATCH_SIZE;
@@ -22,8 +39,8 @@ function prepareEntities(entities, { fields, stopWords, stemmer }, log) {
 	return entities.map(function (suggestion) {
 		const { id } = suggestion;
 		if (id) {
-			const tokens = tokenizer(suggestion);
-			const tokensMap = createTokensMap(tokens);
+			const tokensFields = tokenizer(suggestion);
+			const tokensMap = createTokensMap(tokensFields);
 
 			done++;
 			if (done % size === 0 || done === max) {
@@ -36,7 +53,7 @@ function prepareEntities(entities, { fields, stopWords, stemmer }, log) {
 					},
 				});
 			}
-			return { id, suggestion, tokens: Object.keys(tokensMap) };
+			return { id, suggestion, tokens: Object.keys(tokensMap), tokensMap };
 		} else throw new Error(`Missing id on entity.`);
 	}, []);
 }

package/src/utils/suggester-workers/commons-tokenizer/create-entity-tokenizer.js

@@ -0,0 +1,56 @@
+import createFieldsTokenizer from './create-fields-tokenizer';
+import { composeFilters, createFilterStopWords } from './filters';
+import filterStemmer from './filters/filter-stemmer';
+import filterLength from './filters/filter-length';
+import filterSynonyms from './filters/filter-synonyms';
+import filterAccents from './filters/filter-accents';
+import filterToLower from './filters/filter-to-lower';
+import filterDouble from './filters/filter-double';
+
+function createMapFieldsTokenizer(fields, filters) {
+	return fields.reduce(function (mapFieldTokenizers, field) {
+		const { name } = field;
+		return {
+			...mapFieldTokenizers,
+			[name]: createFieldsTokenizer(field, filters),
+		};
+	}, {});
+}
+
+function createFilterTokens(fields, stopWords) {
+	const filterStopWords = createFilterStopWords(stopWords);
+	const getFilters = composeFilters(
+		filterDouble,
+		filterAccents,
+		filterStemmer,
+		filterSynonyms,
+		filterToLower,
+		filterStopWords,
+		filterLength
+	);
+	const FIELDS_TOKENIZER_MAP = createMapFieldsTokenizer(
+		fields || [],
+		getFilters
+	);
+
+	return function (field, entity) {
+		const { name } = field;
+		const tokenizeIt = FIELDS_TOKENIZER_MAP[name];
+		if (name in entity) {
+			return tokenizeIt(`${entity[name]}`);
+		}
+		return [];
+	};
+}
+
+function createEntityTokenizer(fields, stopWords) {
+	const tokenizeAll = createFilterTokens(fields, stopWords);
+	return function (entity) {
+		return fields.reduce(function (a, field) {
+			const { name } = field;
+			return { ...a, [name]: tokenizeAll(field, entity) };
+		}, {});
+	};
+}
+
+export default createEntityTokenizer;