Service - Transform Units - Revision history

Sven the Barbarian at 00:45, 3 September 2025

2025-09-03T00:45:56Z

← Older revision		Revision as of 00:45, 3 September 2025
Line 15:		Line 15:
	* https://www.codeproject.com/Articles/12116/JavaScript-Mathematical-Expression-Evaluator		* https://www.codeproject.com/Articles/12116/JavaScript-Mathematical-Expression-Evaluator

	Must make sure equation is validated/sanitized first, be careful of eval or new Function which can invoke arbritrary commands		Must make sure equation is validated/sanitized first, be careful/do not use "eval" or "new Function" which can invoke arbritrary commands.

	= Transform request =		= Transform request =
Line 30:		Line 30:
	<syntaxhighlight lang="JavaScript">		<syntaxhighlight lang="JavaScript">
	{		{
	inputUnits: [		inputUnits: {
	{		unitTypeId: {
	unitTypeId: ~~"zz",~~
	stageId: "xx", // optional, stage that applies stageAdjustments to input unit		stageId: "xx", // optional, stage that applies stageAdjustments to input unit
	~~numberOfUnits: 1, // default number of inputUnits used to perform this transform~~
	calculatedProperties:{ // calculates changes to inputUnits unitTrackedProperties		calculatedProperties:{ // calculates changes to inputUnits unitTrackedProperties
	unitTypeTrackedPropertyId: {		unitTypeTrackedPropertyId: {
	integerOnly: false, // default false, if true then calculated splits must be integers, will not process transformation if split per outputUnit are not integers		integerOnly: false, // default false, if true then calculated splits must be integers, will not process transformation if split per outputUnit are not integers. Maybe can remove and use unitTypeTrackedProperty.precision
	quantityReductionSetting: "spread"\|"clearPerUnit", // if not all quantityUnitTypeTrackedPropertyId are used up in transformation, do we reduce all numberOfUnits quantity equally, or clear quantity out one unit at a time		quantityReductionSetting: "spread"\|"clearPerUnit", // if not all quantityUnitTypeTrackedPropertyId are used up in transformation, do we reduce all numberOfUnits quantity equally, or clear quantity out one unit at a time, frontend uses to calculate initial values
	~~valueUsePerOutputUnit~~: 1,		valueUse: 1, // per transformUnitsObject quantity, maybe allow overwriting on frontend
	},		},
	// ...		// ...
Line 45:		Line 43:
	},		},
	//..		//..
	],		},
	outputUnits: [		outputUnits: [
	{		{
Line 54:		Line 52:
	unitTypeTrackedPropertyId: {		unitTypeTrackedPropertyId: {
	calculationType: "calculateValue", // can add other types later		calculationType: "calculateValue", // can add other types later
			integerOnly: false, // maybe not needed, in unitTypeTrackedProperty.precision
	combinationEquation: "[calcPropTagA]+[calcPropTagB]", // optional, method of combining multiple calculateByProperties together, defaults to adding/sum		combinationEquation: "[calcPropTagA]+[calcPropTagB]", // optional, method of combining multiple calculateByProperties together, defaults to adding/sum
	calculateByProperties: {		calculateByProperties: {
	calcPropTag: { // any string, used in combinationEquation		calcPropTag: { // any string, used in combinationEquation
	~~calculation~~: "~~[valueUsePerOutputUnit:{inputUnitTypeId}:{unitTypeTrackedPropertyId}]*[unitTypeTrackedProperty:{inputUnitTypeId}:{unitTypeTrackedPropertyId}]~~",		calculationType: "xx", //"calculationPerInputUnit"\|"singleValue"

	or		// if "calculationPerInputUnit"
			inputUnitValueUseCalcs:{ // used by frontend to calculate default values per inputUnit instances
			inputUnitTypeId: {
			unitTypeTrackedPropertyId: "[valueUse]*0.25"
			}
			},
			calculation: "[inputUnitValueUse:{inputUnitTypeId}:{unitTypeTrackedPropertyId}]*[unitTypeTrackedProperty:{inputUnitTypeId}:{unitTypeTrackedPropertyId}]",

			// if "singleValue"
	defaultValue: "30", // not calculated, user can overwrite defaultValue		defaultValue: "30", // not calculated, user can overwrite defaultValue

Sven the Barbarian at 15:37, 25 July 2025

2025-07-25T15:37:10Z

Show changes

Sven the Barbarian at 12:18, 16 February 2025

2025-02-16T12:18:08Z

Show changes

Sven the Barbarian at 13:22, 12 August 2023

2023-08-12T13:22:06Z

← Older revision		Revision as of 13:22, 12 August 2023
Line 43:		Line 43:
	inputUnitTypeId: "xxx", // different unitTypeIds can have different properties/calculations		inputUnitTypeId: "xxx", // different unitTypeIds can have different properties/calculations
	propertyName: "xxx", // property that gets inserted into calculation		propertyName: "xxx", // property that gets inserted into calculation
	calculation: "[property]*[quantity]", ~~// regExp equation? use a standard format to perform calculation~~		calculation: "[property]*[quantity]",
	},		},
	// ..		// ..
Line 55:		Line 55:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			== Calculating values ==

			combinationEquation and calculateByProperties.calculation fields replace out special tags first like [propertyA]/[propertyB]/[property]/[quantity], the parse through an evaluation library, eg:

			* https://mathjs.org/
			* https://www.npmjs.com/package/string-math
			* https://www.npmjs.com/package/exact-math
			* https://www.codeproject.com/Articles/12116/JavaScript-Mathematical-Expression-Evaluator

			Must make sure equation is validated/sanitized first, be careful of eval or new Function which can invoke arbritrary commands

	= Transform request =		= Transform request =

Sven the Barbarian at 14:31, 9 August 2023

2023-08-09T14:31:17Z

← Older revision		Revision as of 14:31, 9 August 2023
Line 37:		Line 37:
	calculatedProperties: { // calculates a property added to the outputUnits		calculatedProperties: { // calculates a property added to the outputUnits
	{propertyName}: {		{propertyName}: {
	calculationType: "~~multiplyQuantityValue~~", // can add other types later		calculationType: "calculateValue", // can add other types later
	~~multipleByProperties~~: [ // can set many inputType properties~~, all products get summed~~		combinationEquation: "[propertyA]+[propertyB]", // optional, method of combining multiple calculateByProperties together, defaults to adding/sum
			calculateByProperties: [ // can set many inputType properties
	{		{
	inputUnitTypeId: "xxx",		inputUnitTypeId: "xxx", // different unitTypeIds can have different properties/calculations
	propertyName: "xxx", // property that gets ~~multiplied with the~~ quantity ~~of that Unit used for each outputUnit~~		propertyName: "xxx", // property that gets inserted into calculation
			calculation: "[property]*[quantity]", // regExp equation? use a standard format to perform calculation
	},		},
	// ..		// ..

Sven the Barbarian at 12:12, 6 August 2023

2023-08-06T12:12:54Z

@@ Line 21: / Line 21: @@
 </syntaxhighlight>
-== TransformConfig ==
+= transformConfig structure =
 <syntaxhighlight lang="JavaScript">
+{
 	inputUnitTypes: {
 		{unitTypeId}: {
@@ Line 54: / Line 53: @@
+}
 </syntaxhighlight>
 = Transform request =
@@ Line 81: / Line 65: @@
 * each itemType set can set to override default ratio with a set value (total or per Unit) for each input ItemType, as long as all input quantities are used in full (either by having >0 sets use remaining ratio, or override accurately to use all quantity)
 * if multiple
 = Working documents =

Sven the Barbarian at 11:58, 6 August 2023

2023-08-06T11:58:46Z

← Older revision		Revision as of 11:58, 6 August 2023
Line 39:		Line 39:
	{propertyName}: {		{propertyName}: {
	calculationType: "multiplyQuantityValue", // can add other types later		calculationType: "multiplyQuantityValue", // can add other types later
	~~multipleByProperty~~: "xxx", // property ~~of each input Unit~~ that gets multiplied with the quantity of that Unit used for each outputUnit		multipleByProperties: [ // can set many inputType properties, all products get summed
	}, //..		{
			inputUnitTypeId: "xxx",
			propertyName: "xxx", // property that gets multiplied with the quantity of that Unit used for each outputUnit
			},
			// ..
			]
			},
			//..
	}		}
	}, //		},
			//..
	},		},
	}		}
Line 72:		Line 80:
	* each itemType set defaults to even ratio usage of inputUnit total quantity		* each itemType set defaults to even ratio usage of inputUnit total quantity
	* each itemType set can set to override default ratio with a set value (total or per Unit) for each input ItemType, as long as all input quantities are used in full (either by having >0 sets use remaining ratio, or override accurately to use all quantity)		* each itemType set can set to override default ratio with a set value (total or per Unit) for each input ItemType, as long as all input quantities are used in full (either by having >0 sets use remaining ratio, or override accurately to use all quantity)
			* if multiple

	= Working documents =		= Working documents =

Sven the Barbarian at 11:54, 6 August 2023

2023-08-06T11:54:13Z

← Older revision		Revision as of 11:54, 6 August 2023
Line 28:		Line 28:
	inputUnitTypes: {		inputUnitTypes: {
	{unitTypeId}: {		{unitTypeId}: {
			stageId: "xx", // optional stage that Units get updated to
	quantityProperty: "xx", // optional, name of property that is used as quantity to spread across output Units, if none set then quantity is 1		quantityProperty: "xx", // optional, name of property that is used as quantity to spread across output Units, if none set then quantity is 1
	~~stageId~~: ~~"xx"~~, // ~~optional stage that Units get updated to~~		splitIntegerOnly: false, // default false, if true splits can only be integers, will not process transformation if split per outputUnit is not integer
	}, //		}, //
	},		},

Sven the Barbarian: Created page with "= Overview = Transformations are used to convert a number of input Units into sets of output Units. = Repository = https://bitbucket.org/izara-supply-units/izara-supply-units-transform-units = DynamoDB tables = == Standard Config Table Per Service == === Configuration tags === { configTag: "SupplyGraphServiceName" configKey: "SupplyGraphServiceName" configValue: xxx // eg: "SupplyGraph" } == TransformC..."

2023-08-06T11:52:09Z

Created page with "= Overview = Transformations are used to convert a number of input Units into sets of output Units. = Repository = https://bitbucket.org/izara-supply-units/izara-supply-units-transform-units = DynamoDB tables = == Standard Config Table Per Service == === Configuration tags === <syntaxhighlight lang="JavaScript"> { configTag: "SupplyGraphServiceName" configKey: "SupplyGraphServiceName" configValue: xxx // eg: "SupplyGraph" } </syntaxhighlight> == TransformC..."

New page

= Overview =

Transformations are used to convert a number of input Units into sets of output Units.

= Repository =

https://bitbucket.org/izara-supply-units/izara-supply-units-transform-units

= DynamoDB tables =

== [[Standard Config Table Per Service]] ==

=== Configuration tags ===

<syntaxhighlight lang="JavaScript">
{
configTag: "SupplyGraphServiceName"
configKey: "SupplyGraphServiceName"
configValue: xxx // eg: "SupplyGraph"
}
</syntaxhighlight>

== TransformConfig ==

<syntaxhighlight lang="JavaScript">
{
transformConfigId
inputUnitTypes: {
{unitTypeId}: {
quantityProperty: "xx", // optional, name of property that is used as quantity to spread across output Units, if none set then quantity is 1
stageId: "xx", // optional stage that Units get updated to
}, //
},
outputUnitTypes: {
{unitTypeId}: {
stageId: "xx", // required initial stage Units are set to
calculatedProperties: { // calculates a property added to the outputUnits
{propertyName}: {
calculationType: "multiplyQuantityValue", // can add other types later
multipleByProperty: "xxx", // property of each input Unit that gets multiplied with the quantity of that Unit used for each outputUnit
}, //..
}
}, //
},
}
</syntaxhighlight>

* partition key: transformConfigId
* sort key: (none)

== UsersTransformConfigs ==

<syntaxhighlight lang="JavaScript">
{
userId: "xx" // user who owns the transformConfig
transformConfigId: "xx",
}
</syntaxhighlight>

* partition key: userId
* sort key: transformConfigId

= Transform request =

* Input Units might have multiple Unit records of the same UnitType, and each record has it's quantityProperty which might be >1
* All quantityProperty will be used completely in one transformation, no partial quantities handled
* Do not differentiate which inputUnits are used on which outputUnits, if want to do that need to split into multiple transformations
* When we calculate calculatedProperties we sum all inputUnits calculations together to work out a value per quantity, then apply the ratio set for each outputUnit to calculate each outputUnits property
* outputUnits are split by itemType, but each itemType is split by sets so different calculatedProperties can be done (eg calcualting cost for sizes of different clothing)
* each itemType sets the quantity (number of Units) that are created
* each itemType set defaults to even ratio usage of inputUnit total quantity
* each itemType set can set to override default ratio with a set value (total or per Unit) for each input ItemType, as long as all input quantities are used in full (either by having >0 sets use remaining ratio, or override accurately to use all quantity)

= Working documents =

[[:Category:Working_documents - Transform Units|Transform Units]]

[[Category:Backend services| Transform Units]]