@enyo-energy/energy-app-sdk 1.2.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +211 -1
- package/dist/cjs/energy-app-package-definition.cjs +1 -0
- package/dist/cjs/energy-app-package-definition.d.cts +1 -0
- package/dist/cjs/energy-app-permission.type.cjs +2 -0
- package/dist/cjs/energy-app-permission.type.d.cts +3 -1
- package/dist/cjs/energy-app.cjs +16 -0
- package/dist/cjs/energy-app.d.cts +15 -0
- package/dist/cjs/enyo-energy-app-sdk.d.cts +3 -0
- package/dist/cjs/implementations/pricing/compose-electricity-prices.cjs +218 -0
- package/dist/cjs/implementations/pricing/compose-electricity-prices.d.cts +100 -0
- package/dist/cjs/implementations/pricing/price-component-validators.cjs +295 -0
- package/dist/cjs/implementations/pricing/price-component-validators.d.cts +90 -0
- package/dist/cjs/implementations/pricing/price-schedule-resolver.cjs +182 -0
- package/dist/cjs/implementations/pricing/price-schedule-resolver.d.cts +95 -0
- package/dist/cjs/index.cjs +7 -0
- package/dist/cjs/index.d.cts +7 -0
- package/dist/cjs/packages/energy-app-electricity-tariff.d.cts +34 -1
- package/dist/cjs/packages/energy-app-grid-fee.cjs +2 -0
- package/dist/cjs/packages/energy-app-grid-fee.d.cts +181 -0
- package/dist/cjs/types/enyo-electricity-tariff.cjs +33 -1
- package/dist/cjs/types/enyo-electricity-tariff.d.cts +161 -4
- package/dist/cjs/types/enyo-grid-fee.cjs +15 -0
- package/dist/cjs/types/enyo-grid-fee.d.cts +129 -0
- package/dist/cjs/types/enyo-price-composition.cjs +15 -0
- package/dist/cjs/types/enyo-price-composition.d.cts +126 -0
- package/dist/cjs/types/enyo-price-schedule.cjs +45 -0
- package/dist/cjs/types/enyo-price-schedule.d.cts +137 -0
- package/dist/cjs/version.cjs +1 -1
- package/dist/cjs/version.d.cts +1 -1
- package/dist/energy-app-package-definition.d.ts +1 -0
- package/dist/energy-app-package-definition.js +1 -0
- package/dist/energy-app-permission.type.d.ts +3 -1
- package/dist/energy-app-permission.type.js +2 -0
- package/dist/energy-app.d.ts +15 -0
- package/dist/energy-app.js +16 -0
- package/dist/enyo-energy-app-sdk.d.ts +3 -0
- package/dist/implementations/pricing/compose-electricity-prices.d.ts +100 -0
- package/dist/implementations/pricing/compose-electricity-prices.js +212 -0
- package/dist/implementations/pricing/price-component-validators.d.ts +90 -0
- package/dist/implementations/pricing/price-component-validators.js +285 -0
- package/dist/implementations/pricing/price-schedule-resolver.d.ts +95 -0
- package/dist/implementations/pricing/price-schedule-resolver.js +175 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +7 -0
- package/dist/packages/energy-app-electricity-tariff.d.ts +34 -1
- package/dist/packages/energy-app-grid-fee.d.ts +181 -0
- package/dist/packages/energy-app-grid-fee.js +1 -0
- package/dist/types/enyo-electricity-tariff.d.ts +161 -4
- package/dist/types/enyo-electricity-tariff.js +32 -0
- package/dist/types/enyo-grid-fee.d.ts +129 -0
- package/dist/types/enyo-grid-fee.js +12 -0
- package/dist/types/enyo-price-composition.d.ts +126 -0
- package/dist/types/enyo-price-composition.js +12 -0
- package/dist/types/enyo-price-schedule.d.ts +137 -0
- package/dist/types/enyo-price-schedule.js +42 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared scheduling primitives for time-dependent price components
|
|
3
|
+
* (dynamic grid fees and tariff bonuses).
|
|
4
|
+
*
|
|
5
|
+
* All amounts in this module are expressed **per kilowatt hour** and are always
|
|
6
|
+
* a positive magnitude — the direction is defined by the component that carries
|
|
7
|
+
* the schedule: a grid fee is *added* to the energy price, a tariff bonus is
|
|
8
|
+
* *subtracted* from it. Keeping magnitudes unsigned removes the single most
|
|
9
|
+
* common integration mistake (an inverted sign silently flipping an optimizer's
|
|
10
|
+
* decisions) and is enforced by the validators in
|
|
11
|
+
* `implementations/pricing/price-schedule-validators.ts`.
|
|
12
|
+
*/
|
|
13
|
+
/**
|
|
14
|
+
* The kind of schedule a price component follows.
|
|
15
|
+
*/
|
|
16
|
+
export var EnyoPriceScheduleTypeEnum;
|
|
17
|
+
(function (EnyoPriceScheduleTypeEnum) {
|
|
18
|
+
/** One amount that applies at every point in time. */
|
|
19
|
+
EnyoPriceScheduleTypeEnum["Constant"] = "constant";
|
|
20
|
+
/**
|
|
21
|
+
* Calendar-recurring windows — used for high-tariff/low-tariff (HT/NT)
|
|
22
|
+
* network charges, seasonal charges, and weekday-dependent bonuses.
|
|
23
|
+
*/
|
|
24
|
+
EnyoPriceScheduleTypeEnum["Recurring"] = "recurring";
|
|
25
|
+
/**
|
|
26
|
+
* Explicit absolute time windows — used for grid fees or bonuses published
|
|
27
|
+
* as a dated series (e.g. a day-ahead publication by the grid operator).
|
|
28
|
+
*/
|
|
29
|
+
EnyoPriceScheduleTypeEnum["Absolute"] = "absolute";
|
|
30
|
+
})(EnyoPriceScheduleTypeEnum || (EnyoPriceScheduleTypeEnum = {}));
|
|
31
|
+
/**
|
|
32
|
+
* Which energy direction a price component applies to.
|
|
33
|
+
*/
|
|
34
|
+
export var EnyoPriceAppliesToEnum;
|
|
35
|
+
(function (EnyoPriceAppliesToEnum) {
|
|
36
|
+
/** Applies to energy drawn from the grid. */
|
|
37
|
+
EnyoPriceAppliesToEnum["Consumption"] = "consumption";
|
|
38
|
+
/** Applies to energy fed into the grid. */
|
|
39
|
+
EnyoPriceAppliesToEnum["FeedIn"] = "feed-in";
|
|
40
|
+
/** Applies to both directions. */
|
|
41
|
+
EnyoPriceAppliesToEnum["Both"] = "both";
|
|
42
|
+
})(EnyoPriceAppliesToEnum || (EnyoPriceAppliesToEnum = {}));
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED