@cepharum/concrete-db 0.2.0 → 0.2.2

package/concrete-db.d.ts

@@ -1,32 +1,4 @@
-/**
- * (c) 2022 cepharum GmbH, Berlin, http://cepharum.de
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2021 cepharum GmbH
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- * @author: cepharum
- */
-
-declare module "concrete-db" {
+declare namespace ConcreteDB {
 	export interface CuringOptions extends CollectorOptions, ShaperOptions, GeneratorOptions {
 		/**
 		 * Selects base folder for writing files of resulting concrete-db.
@@ -260,18 +232,34 @@ declare module "concrete-db" {
 	 */
 	export type ShapeCollections = ShapeCollection[];
 
+	/**
+	 * Defines optional constraints to apply.
+	 */
+	export interface ShapeConstraints {
+		/**
+		 * If set, multiple source records addressing same target record aren't
+		 * merged, but some exception is thrown.
+		 *
+		 * This doesn't affect definition of variants. However, merging single
+		 * variant from multiple sources is rejected, too.
+		 */
+		singleSource?: boolean;
+	}
+
 	/**
 	 * Describes rules controlling shaping of a model.
 	 */
 	export interface ShapeModel {
 		defaults: ShapePropertyDefaults;
-		properties: ShapeProperties;
-		collections: ShapeCollections;
-		contributions: {
+		properties?: ShapeProperties;
+		collections?: ShapeCollections;
+		contributions?: {
 			[contributedModelName: string]: {
 				[targetPropertyName: string]: string;
 			};
 		};
+
+		constraints?: ShapeConstraints;
 	}
 
 	export interface Shape {

package/lib/shaper.mjs

@@ -166,7 +166,7 @@ export class Shaper extends EventEmitter {
 		const augmentedData = augmentDataSpace( data, metaProperties );
 
 		metaProperties.$model = this.detectModel( augmentedData, shape );
-		metaProperties.$shape = this.getShapeOfModel( {}, shape, metaProperties.$model );
+		metaProperties.$shape = this.getShapeOfModel( shapesPerModelCache, shape, metaProperties.$model );
 		metaProperties.$id = this.identifyRecord( augmentedData, metaProperties.$shape );
 
 		if ( !itemsPerModel.hasOwnProperty( metaProperties.$model ) ) {
@@ -551,6 +551,10 @@ export class Shaper extends EventEmitter {
 	 * @returns {ModelItem} provided target
 	 */
 	mergeModelItem( target, source ) {
+		if ( target?.$shape?.constraints?.singleSource ) {
+			throw new Error( `merging ${target.$model} with ID ${target.$id} from multiple source records rejected by shape` );
+		}
+
 		const _to = target || {};
 		const oldNames = target ? Object.keys( _to.$shape.properties ) : [];
 		const newNames = Object.keys( source.$shape.properties );
@@ -558,8 +562,8 @@ export class Shaper extends EventEmitter {
 		// merge properties of items
 		for ( const name of Object.keys( source ) ) {
 			if ( !String( name ).startsWith( "$" ) ) {
-				const wasCollecting = oldNames.some( n => n.replace( /\s*\[]$/, "" ).trim() === name );
-				const isCollecting = newNames.some( n => n.replace( /\s*\[]$/, "" ).trim() === name );
+				const wasCollecting = oldNames.some( n => n.replace( /\s+/g, "" ) === name + "[]" );
+				const isCollecting = newNames.some( n => n.replace( /\s+/g, "" ) === name + "[]" );
 
 				if ( _to.hasOwnProperty( name ) ) {
 					if ( isCollecting ) {
@@ -709,7 +713,7 @@ export class Shaper extends EventEmitter {
 
 		for ( const property of Object.keys( properties ) ) {
 			if ( accept.indexOf( property ) > -1 || !String( property ).startsWith( "$" ) ) {
-				const propertyName = property.replace( /\s*\[]$/, "" );
+				const propertyName = property.replace( /\s*\[]\s*$/, "" );
 				const isCollecting = property !== propertyName;
 
 				const term = properties[property];

package/lib/term-functions.mjs

@@ -69,12 +69,13 @@ export function compare( left, right ) {
  * @param {number} maxWordSize maximum number of characters in extracted words
  * @param {boolean} ignoreCase set true to drop case of extracted words
  * @param {boolean} strict set false to have any non-string value converted to string instead of being ignored
+ * @param {string} wordPattern provides source of global unicode regexp matching a word to generate
  * @returns {Object<string,number>} map of extracted words into either words's number of occurrences
  */
-export function spread( value, minSize = 10, minWordSize = 3, maxWordSize = Infinity, ignoreCase = true, strict = true ) {
+export function spread( value, minSize = 10, minWordSize = 3, maxWordSize = Infinity, ignoreCase = true, strict = true, wordPattern = undefined ) {
 	const result = {};
 
-	for ( const word of generateWords( value, minSize, ignoreCase, strict ) ) {
+	for ( const word of generateWords( value, minSize, ignoreCase, strict, wordPattern ) ) {
 		if ( word.length >= minWordSize && word.length <= maxWordSize ) {
 			result[word] = ( result[word] || 0 ) + 1;
 		}
@@ -102,9 +103,10 @@ export function fail( message ) {
  * @param {number} minSize minimum number of characters in a string to be considered for extracting terms
  * @param {boolean} ignoreCase set true to drop case of extracted terms
  * @param {boolean} strict set false to have any non-string value converted to string instead of being ignored
+ * @param {string} wordPattern provides source of global unicode regexp matching a word to generate
  * @returns {Generator<string|*, void, *>} iterator over flat sequence of terms
  */
-function *generateWords( source, minSize, ignoreCase, strict ) {
+function *generateWords( source, minSize, ignoreCase, strict, wordPattern = undefined ) {
 	let stream;
 
 	if ( Array.isArray( source ) ) {
@@ -124,17 +126,17 @@ function *generateWords( source, minSize, ignoreCase, strict ) {
 			return;
 		}
 
-		const ptn = /([\p{L}\p{N}_][\p{L}\p{N}_-]*)/gu;
+		const ptn = wordPattern ? new RegExp( wordPattern, "gu" ) : /[\p{L}\p{N}_][\p{L}\p{N}_-]*/gu;
 		let match;
 
 		while ( ( match = ptn.exec( string ) ) ) {
-			yield ignoreCase ? match[1].toLocaleLowerCase() : match[1];
+			yield ignoreCase ? ( match[1] ?? match[0] ).toLocaleLowerCase() : match[1] ?? match[0];
 		}
 
 		return;
 	}
 
 	for ( const sub of stream ) {
-		yield* generateWords( sub, minSize, ignoreCase, strict );
+		yield* generateWords( sub, minSize, ignoreCase, strict, wordPattern );
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cepharum/concrete-db",
-	"version": "0.2.0",
+	"version": "0.2.2",
 	"description": "a read-only web database generator",
 	"main": "lib/collector.mjs",
 	"types": "concrete-db.d.ts",