@cepharum/concrete-db 0.1.0 → 0.1.2-alpha.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 cepharum GmbH
+Copyright (c) 2022 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

package/concrete-db.d.ts

@@ -144,6 +144,48 @@ declare module "concrete-db" {
 		shape: Shape;
 	}
 
+	/**
+	 * Describes a model's item processed during shaping stage.
+	 */
+	export interface CollectedItem {
+		/**
+		 * Refers to record this item is based on.
+		 */
+		$original: CollectedRecord;
+
+		/**
+		 * Exposes local shape declared in context of record item was collected
+		 * from.
+		 */
+		$localShape: ShapeModel;
+
+		/**
+		 * Exposes shape of item's model in context of its originating record.
+		 */
+		$shape: ShapeModel;
+
+		/**
+		 * Names this item's model.
+		 */
+		$model: string;
+
+		/**
+		 * Uniquely identifies the item in context of its model.
+		 */
+		$id: string;
+
+		/**
+		 * Lists segments of relative path of file this item's originating
+		 * record has been read from.
+		 */
+		$segments: string[];
+
+		/**
+		 * item's properties
+		 */
+		[name: string]: any;
+	}
+
 	/**
 	 * Lists default values for properties of a single model's item.
 	 */
@@ -202,6 +244,18 @@ declare module "concrete-db" {
 		defaults: ShapePropertyDefaults;
 		properties: ShapeProperties;
 		collections: ShapeCollections;
+		contributions: {
+			[contributedModelName: string]: {
+				[targetPropertyName: string]: string;
+			};
+		};
+
+		/**
+		 * Declares term to compute an item's variant. If falsy or omitted, the
+		 * model does not have variants and multiple records describing an item
+		 * are merged property by property.
+		 */
+		variant?: string;
 	}
 
 	export interface Shape {

package/cure.mjs

@@ -1,31 +1,4 @@
-/**
- * (c) 2021 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
- */
-
+#!/usr/bin/env node
 import File from "fs";
 import Path from "path";
 
@@ -35,6 +8,7 @@ import YAML from "yaml";
 import meta from "./lib/meta.cjs";
 import { cure } from "./lib/index.mjs";
 import { ShapeFileName } from "./lib/defaults.mjs";
+import { YAMLParserOptions } from "./lib/options.mjs";
 
 
 const args = minimist( process.argv.slice( 2 ) );
@@ -71,7 +45,7 @@ if ( args.V || args.version ) {
 	const globalShapeFile = args.s || args.shape || Path.resolve( process.cwd(), ShapeFileName );
 
 	try {
-		options.shape = Object.freeze( YAML.parse( await File.promises.readFile( globalShapeFile, { encoding: "utf8" } ) ) );
+		options.shape = Object.freeze( YAML.parse( await File.promises.readFile( globalShapeFile, { encoding: "utf8" } ), YAMLParserOptions ) );
 	} catch ( cause ) {
 		if ( cause.code !== "ENOENT" ) {
 			throw cause;

package/lib/collector.mjs

@@ -1,31 +1,3 @@
-/**
- * (c) 2021 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
- */
-
 import File from "fs";
 import Path from "path";
 import EventEmitter from "events";
@@ -35,13 +7,13 @@ import FileEssentials from "file-essentials";
 import YAML from "yaml";
 import merge from "lodash.merge";
 
-import { ShapeFileName, DefaultCollectorOptions, DefaultShape } from "./defaults.mjs";
+import {
+	ShapeFileName,
+	DefaultCollectorOptions,
+	DefaultShape
+} from "./defaults.mjs";
 import { deepFreeze } from "./helper.mjs";
-
-
-const YAMLParserOptions = {
-	version: "1.1",
-};
+import { YAMLParserOptions } from "./options.mjs";
 
 
 /**
@@ -58,7 +30,10 @@ export class Collector extends EventEmitter {
 		super();
 
 		Object.defineProperties( this, {
-			options: { value: { ...DefaultCollectorOptions, ...options }, enumerable: true },
+			options: {
+				value: { ...DefaultCollectorOptions, ...options },
+				enumerable: true
+			},
 			records: { value: new Map(), enumerable: true },
 		} );
 	}

package/lib/cure.mjs

@@ -1,31 +1,3 @@
-/**
- * (c) 2021 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
- */
-
 import { Collector } from "./collector.mjs";
 import { Shaper } from "./shaper.mjs";
 import { Generator } from "./generator.mjs";

package/lib/defaults.mjs

@@ -1,38 +1,10 @@
-/**
- * (c) 2021 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
- */
-
 import { readFileSync } from "fs";
 import { dirname, resolve } from "path";
 import { fileURLToPath } from "url";
 
 import YAML from "yaml";
 
-export const ShapeFileName = ".concrete-db.shape.yml";
+export const ShapeFileName = ".concrete-db.shape.yaml";
 
 /**
  * @type {CollectorOptions}
@@ -68,4 +40,4 @@ export const DefaultGeneratorOptions = {};
 /**
  * @type {Shape}
  */
-export const DefaultShape = YAML.parse( readFileSync( resolve( dirname( fileURLToPath( import.meta.url ) ), "default.shape.yml" ), { encoding: "utf8" } ) );
+export const DefaultShape = YAML.parse( readFileSync( resolve( dirname( fileURLToPath( import.meta.url ) ), "default.shape.yaml" ), { encoding: "utf8" } ) );

package/lib/generator.mjs

@@ -1,31 +1,3 @@
-/**
- * (c) 2021 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
- */
-
 import EventEmitter from "events";
 import File from "fs";
 import Path from "path";

package/lib/helper.mjs

@@ -1,31 +1,3 @@
-/**
- * (c) 2021 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
- */
-
 /**
  * Wraps provided object in a proxy offering case-insensitive access on
  * object's properties. Any accessed property's value is wrapped before
@@ -37,7 +9,7 @@
  * @param {object} meta set of meta properties to blend in (case-sensitively)
  * @returns {any} provided data wrapped for case-insensitive selection of own properties
  */
-export function augmentedDataSpace( data, meta = undefined ) {
+export function augmentDataSpace( data, meta = undefined ) {
 	if ( !data || typeof data !== "object" ) {
 		return data;
 	}
@@ -50,8 +22,12 @@ export function augmentedDataSpace( data, meta = undefined ) {
 				return meta[name];
 			}
 
+			if ( typeof name === "symbol" ) {
+				return object[name];
+			}
+
 			if ( Object.prototype.hasOwnProperty.call( object, name ) ) {
-				return augmentedDataSpace( object[name] );
+				return augmentDataSpace( object[name] );
 			}
 
 			if ( !cached && typeof name === "string" ) {
@@ -68,12 +44,11 @@ export function augmentedDataSpace( data, meta = undefined ) {
 				}
 			}
 
-			return augmentedDataSpace( object[cached[name.toLocaleLowerCase()]] );
+			return augmentDataSpace( object[cached[name.toLocaleLowerCase()]] );
 		},
 	} );
 }
 
-
 /**
  * Implements special kind of value representing reference on uniquely identified
  * item of a model selected by its name.

package/lib/index.mjs

@@ -1,31 +1,3 @@
-/**
- * (c) 2021 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
- */
-
 import { cure } from "./cure.mjs";
 import { Collector } from "./collector.mjs";
 import { Shaper } from "./shaper.mjs";

package/lib/meta.cjs

@@ -1,31 +1,3 @@
-/**
- * (c) 2021 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
- */
-
 const meta = require( "../package.json" );
 
 module.exports = meta;

package/lib/options.mjs

@@ -0,0 +1,3 @@
+export const YAMLParserOptions = {
+	version: "1.1",
+};