@wisemen/quantity 0.9.0 → 0.9.1

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-export * from './quantities/current/index.js';
-export * from './quantities/distance/index.js';
-export * from './quantities/duration/index.js';
-export * from './quantities/mass/index.js';
-export * from './quantities/temperature/index.js';
-export * from './quantities/energy/index.js';
-export * from './quantities/power/index.js';
-export * from './quantities/speed/index.js';
-export * from './quantities/voltage/index.js';
-export * from './rate/index.js';
+export { Current, CurrentUnit, CurrentDto, CurrentDtoBuilder, CurrentUnitApiProperty, IsCurrent, CurrentColumn } from './quantities/current/index.js';
+export { Distance, DistanceUnit, DistanceDto, DistanceDtoBuilder, DistanceUnitApiProperty, IsDistance, DistanceColumn } from './quantities/distance/index.js';
+export { Duration, DurationUnit, DurationDto, DurationDtoBuilder, DurationUnitApiProperty, IsDuration, DurationColumn } from './quantities/duration/index.js';
+export { Mass, MassUnit, MassDto, MassDtoBuilder, MassUnitApiProperty, IsMass, MassColumn } from './quantities/mass/index.js';
+export { Temperature, TemperatureUnit, TemperatureDto, TemperatureDtoBuilder, TemperatureUnitApiProperty, IsTemperature, TemperatureColumn } from './quantities/temperature/index.js';
+export { Energy, EnergyUnit, EnergyDto, EnergyDtoBuilder, EnergyUnitApiProperty, IsEnergy, EnergyColumn } from './quantities/energy/index.js';
+export { Power, PowerUnit, PowerDto, PowerDtoBuilder, PowerUnitApiProperty, IsPower, PowerColumn } from './quantities/power/index.js';
+export { Speed, SpeedUnit, SpeedDto, SpeedDtoBuilder, SpeedUnitApiProperty, IsSpeed, SpeedColumn } from './quantities/speed/index.js';
+export { Voltage, VoltageUnit, VoltageDto, VoltageDtoBuilder, VoltageUnitApiProperty, IsVoltage, VoltageColumn } from './quantities/voltage/index.js';
+export { Rate, RateScale, RateDto, RateDtoBuilder, RateScaleApiProperty, IsRate, RateColumn } from './rate/index.js';

package/dist/index.js

@@ -1,11 +1,11 @@
-export * from './quantities/current/index.js';
-export * from './quantities/distance/index.js';
-export * from './quantities/duration/index.js';
-export * from './quantities/mass/index.js';
-export * from './quantities/temperature/index.js';
-export * from './quantities/energy/index.js';
-export * from './quantities/power/index.js';
-export * from './quantities/speed/index.js';
-export * from './quantities/voltage/index.js';
-export * from './rate/index.js';
+export { Current, CurrentUnit, CurrentDto, CurrentDtoBuilder, CurrentUnitApiProperty, IsCurrent, CurrentColumn } from './quantities/current/index.js';
+export { Distance, DistanceUnit, DistanceDto, DistanceDtoBuilder, DistanceUnitApiProperty, IsDistance, DistanceColumn } from './quantities/distance/index.js';
+export { Duration, DurationUnit, DurationDto, DurationDtoBuilder, DurationUnitApiProperty, IsDuration, DurationColumn } from './quantities/duration/index.js';
+export { Mass, MassUnit, MassDto, MassDtoBuilder, MassUnitApiProperty, IsMass, MassColumn } from './quantities/mass/index.js';
+export { Temperature, TemperatureUnit, TemperatureDto, TemperatureDtoBuilder, TemperatureUnitApiProperty, IsTemperature, TemperatureColumn } from './quantities/temperature/index.js';
+export { Energy, EnergyUnit, EnergyDto, EnergyDtoBuilder, EnergyUnitApiProperty, IsEnergy, EnergyColumn } from './quantities/energy/index.js';
+export { Power, PowerUnit, PowerDto, PowerDtoBuilder, PowerUnitApiProperty, IsPower, PowerColumn } from './quantities/power/index.js';
+export { Speed, SpeedUnit, SpeedDto, SpeedDtoBuilder, SpeedUnitApiProperty, IsSpeed, SpeedColumn } from './quantities/speed/index.js';
+export { Voltage, VoltageUnit, VoltageDto, VoltageDtoBuilder, VoltageUnitApiProperty, IsVoltage, VoltageColumn } from './quantities/voltage/index.js';
+export { Rate, RateScale, RateDto, RateDtoBuilder, RateScaleApiProperty, IsRate, RateColumn } from './rate/index.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mCAAmC,CAAA;AACjD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AACrJ,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAC7J,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAC7J,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAC7H,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,cAAc,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAA;AACrL,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAK,8BAA8B,CAAA;AAC5I,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACrI,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACrI,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AACrJ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/quantities/voltage/index.d.ts

@@ -2,3 +2,4 @@ export * from './voltage.js';
 export * from './voltage.dto.js';
 export * from './voltage.column.js';
 export * from './voltage-unit.enum.js';
+export * from './is-voltage.validator.js';

package/dist/quantities/voltage/index.js

@@ -2,4 +2,5 @@ export * from './voltage.js';
 export * from './voltage.dto.js';
 export * from './voltage.column.js';
 export * from './voltage-unit.enum.js';
+export * from './is-voltage.validator.js';
 //# sourceMappingURL=index.js.map

package/dist/quantities/voltage/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/quantities/voltage/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/quantities/voltage/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA;AACtC,cAAc,2BAA2B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wisemen/quantity",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "publishConfig": {
     "access": "public"
   },
@@ -8,7 +8,8 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "files": [
-    "dist/"
+    "dist/",
+    "skills/"
   ],
   "peerDependencies": {
     "@nestjs/common": "^11.1.19",

package/skills/getting-started/SKILL.md

@@ -0,0 +1,78 @@
+---
+name: getting-started
+description: |
+  Use when dealing with physical quantities like distance, duration, speed, power etc
+  Supports:
+    - basic arithmetic and utils
+    - columns with typeorm
+    - validation with class-validator
+    - openapi documentation with nestjs
+---
+
+# Quantity
+
+- Use `@wisemen/quantity` whenever generating or reviewing TypeScript/NestJS code that represents physical quantities such as distance, duration, speed, power, mass, energy, voltage, temperature, current.
+- Prefer dedicated Quantity classes over plain numbers. Quantities are immutable; arithmetic operations must return new instances. Inspect the class' methods to discover all available operations.
+- When creating database entities, use `<Quantity>Column`.
+- When creating DTOs, use `<Quantity>ApiProperty`, `<Quantity>Dto`, and `Is<Quantity>` validation where applicable.
+
+## Usage
+
+### Basic arithmetic and utils
+
+Use a <Quantity> class to define a quantity value.
+
+```ts
+import { Distance, DistanceUnit } from "@wisemen/quantity"
+
+const radius = new Distance(100, DistanceUnit.METER)
+const innerRadius = radius.subtract(15, DistanceUnit.METER)
+const clippedRadius = Distance.max(innerRadius, Distance.ZERO)
+const circumference = clippedRadius.multiply(2 * Math.PI).round()
+```
+
+### Quantity in database entities
+
+Use a `<Quantity>Column` decorator in a TypeORM entity property to model the field as a database column.
+It is required to specify in what unit the quantity value will be stored in the database.
+TypeORM's column options like `nullable` are supported.
+
+```ts
+import { Distance, DistanceUnit, DistanceColumn } from "@wisemen/quantity"
+
+class ExampleEntity {
+  @DistanceColumn(DistanceUnit.METER, { nullable: true })
+  distance: Distance | null
+}
+```
+
+### Quantity in dtos (requests command, request query and response)
+
+Use a `<Quantity>ApiProperty` decorator in a dto to document a quantity field in the nestjs open api docs.
+Use a `Is<Quantity>` decorator in a dto to add quantity validation functionality for class-validator if needed.
+A minimum and maximum value can be set by the `min` and `max` optional attributes in the validation options.
+
+```ts
+import { ApiProperty } from "@nestjs/swagger";
+import { Distance, DistanceDto } from "@wisemen/quantity"
+
+class ExampleCommand {
+  @ApiProperty({ type: DistanceDto })
+  @IsDistance({ min: Distance.ZERO })
+  distance: DistanceDto
+}
+```
+
+## Available quantities
+
+- Current
+- Distance
+- Duration
+- Mass
+- Temperature
+- Energy
+- Power
+- Speed
+- Voltage
+
+If a required quantity is unavailable, stop and tell the user it must first be added and released to `@wisemen/quantity` before continuing.