@golemio/energetics 1.7.1 → 1.7.2-dev.2265329102

package/dist/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoice.d.ts

@@ -0,0 +1,40 @@
+export interface IPpasDistributionInvoice {
+    id: string;
+    preceding_id?: string;
+    customer_id: string;
+    customer_company_id: string;
+    customer_name: string;
+    customer_contract_account_id: string;
+    customer_address_street: string;
+    customer_address_house_number: string | null;
+    customer_address_house_org_number: string | null;
+    customer_address_city: string;
+    customer_address_city_part: string;
+    customer_address_post_code: string;
+    customer_address_country: string;
+    customer_address_ruian_id: number;
+    facts_doc_date: string;
+    facts_net_date: string;
+    facts_billing_transaction: string;
+    facts_to_pay_amount: number;
+    facts_currency: string;
+    facts_price_brutto: number;
+    is_canceled?: boolean;
+    canceled_reason?: string;
+    eic: string;
+    place_id: string;
+    installations_billing_class: string;
+    installations_measurement_type: string;
+    installations_contract_contract_id: string | null;
+    installations_contract_move_in_date: string;
+    installations_contract_move_out_date: string;
+    installations_tdd_class: string;
+    installations_address_street: string;
+    installations_address_house_number: string | null;
+    installations_address_house_org_number: string | null;
+    installations_address_city: string;
+    installations_address_city_part: string;
+    installations_address_post_code: string;
+    installations_address_country: string;
+    installations_address_ruian_id: number;
+}

package/dist/{integration-engine/enapo/interfaces/IPPasMeasurementData.js → schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoice.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=IPPasMeasurementData.js.map
+//# sourceMappingURL=IPpasDistributionInvoice.js.map

package/dist/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPpasDistributionInvoice.js","sourceRoot":"","sources":["../../../../../../src/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoice.ts"],"names":[],"mappings":""}

package/dist/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoiceDevice.d.ts

@@ -0,0 +1,18 @@
+export interface IPpasDistributionInvoiceDevice {
+    device_serial_number: string;
+    invoice_id: string;
+    date_from: string;
+    date_to: string;
+    reading_type: string;
+    type: string;
+    kind: string;
+    reading_from: number;
+    reading_to: number;
+    consumption: number;
+    unit: string;
+    meter_reading_type: string | null;
+    gas_consumption_kwh: number;
+    volume_coefficient: number;
+    combustion_heat: number;
+    normometers_nm3: number;
+}

package/dist/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoiceDevice.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IPpasDistributionInvoiceDevice.js.map

package/dist/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoiceDevice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPpasDistributionInvoiceDevice.js","sourceRoot":"","sources":["../../../../../../src/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoiceDevice.ts"],"names":[],"mappings":""}

package/dist/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoicePrice.d.ts

@@ -0,0 +1,17 @@
+export interface IPpasDistributionInvoicePrice {
+    invoice_id: string;
+    date_from: string;
+    date_to: string;
+    kind: string;
+    description: string;
+    price_group: string;
+    quantity: number;
+    unit: string;
+    unit_price: number;
+    time_slot: number;
+    price_netto: number;
+    currency: string;
+    tax_rate: number;
+    price_type: string;
+    customer_id: string;
+}

package/dist/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoicePrice.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IPpasDistributionInvoicePrice.js.map

package/dist/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoicePrice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPpasDistributionInvoicePrice.js","sourceRoot":"","sources":["../../../../../../src/schema-definitions/models/enapo/ppas/interfaces/IPpasDistributionInvoicePrice.ts"],"names":[],"mappings":""}

package/dist/schema-definitions/models/interfaces/IMeasurementDto.d.ts

@@ -7,4 +7,5 @@ export interface IMeasurementDto {
     meter: string;
     source: string;
     measurement_category: string;
+    device_serial_number: string | null;
 }

package/docs/implementation_documentation.md

@@ -626,6 +626,63 @@ Task stahuje geometrie (polygony) pro budovy a stavby ze systému ENO. Je automa
 -   unit testy
     -   [EnoGeometryTask.test.ts](../test/integration-engine/enapo/task/EnoGeometryTask.test.ts)
 
+#### _PPAS Distribution API_
+
+-   zdroj dat
+    -   url: https://distribution-api.ppas.cz (module.energetics.enapo.ppas.distribution.url)
+    -   OAuth2 URL: https://distribution-oauth.ppas.cz/oauth/token (module.energetics.enapo.ppas.distribution.oauthUrl)
+    -   autentizace: OAuth2 Client Credentials Flow
+        -   clientId: module.energetics.enapo.ppas.distribution.clientId
+        -   clientSecret: module.energetics.enapo.ppas.distribution.clientSecret
+        -   accessToken header: module.energetics.enapo.ppas.distribution.accessToken
+    -   API dokumentace: interní dokumentace PPAS
+    -   Kdyz jsou hodnoty v consumptionKwh negativni tak se jedna o storno označeno jako CORRECTION pokud ne označeno jako STANDARD, pokud prijdou dve nulove hodnoty za sebou, nazváno zero rows, tak je první brána jako STANDARD a druhá CORRECTION
+-   formát dat
+    -   protokol: https (REST API)
+    -   datový typ: json
+    -   validační schémata:
+        -   [PpasDistributionInvoiceListInput](../src/schema-definitions/datasources/enapo/ppas/distribution/IPpasDistributionInvoiceListInput.ts) - seznam faktur
+        -   [PpasDistributionInvoiceDetailInput](../src/schema-definitions/datasources/enapo/ppas/distribution/IPpasDistributionInvoiceDetailInput.ts) - detail faktury včetně zařízení a cen
+        -   [PpasDistributionSchema](../src/schema-definitions/datasources/enapo/ppas/distribution/PpasDistributionSchema.ts) - JSON Schema validace
+    -   příklad vstupních dat:
+        -   [ppas_distribution_invoice_list_input.json](../test/integration-engine/data/enapo/ppas_distribution_invoice_list_input.json)
+        -   [ppas_distribution_invoice_detail_input.json](../test/integration-engine/data/enapo/ppas_distribution_invoice_detail_input.json)
+-   datasource
+    -   [PpasDistributionDatasource](../src/integration-engine/enapo/datasources/ppas/distribution/PpasDistributionDatasource.ts)
+        -   `getInvoiceList(from, to, ic?)` - získání seznamu faktur za období
+        -   `getInvoiceDetail(intNum)` - získání detailu faktury včetně zařízení, odečtů a cen
+    -   Automatická správa OAuth2 tokenu (refresh před expirací)
+    -   Validace odpovědí pomocí JSON Schema
+-   unit testy
+    -   [PpasDistributionDatasource.test.ts](../test/integration-engine/enapo/datasource/PpasDistributionDatasource.test.ts)
+
+#### _task: EnapoPpasDistributionTask_
+
+Task stahuje fakturační data distribuce od PPAS včetně informací o fakturách, zařízeních, odečtech a cenách. Data jsou následně transformována a uložena do tří souvisejících tabulek.
+
+-   vstupní rabbitmq fronta
+    -   název: dataplatform.enapoenergetics.fetchPpasDistribution
+    -   TTL: 1 hodina
+    -   parametry: `{ from?, to? }`
+        -   `from` - datum od (formát YYYY-MM-DD), volitelné - výchozí: dnes - 3 dny
+        -   `to` - datum do (formát YYYY-MM-DD), volitelné - výchozí: dnes
+    -   validační schéma: [EnapoPpasDistributionParamsSchema](../src/integration-engine/enapo/workers/schema/EnapoPpasDistributionParamsSchema.ts)
+-   závislé fronty (do kterých jsou odesílány zprávy z metody workeru)
+    -   žádné
+-   datové zdroje
+    -   PPAS Distribution API
+    -   [PpasDistributionDatasource](../src/integration-engine/enapo/datasources/ppas/distribution/PpasDistributionDatasource.ts)
+-   transformace
+    -   [PpasDistributionTransformation](../src/integration-engine/enapo/transformations/ppas/PpasDistributionTransformation.ts) - transformace dat faktur
+        -   Transformuje fakturační hlavičku s informacemi o zákazníkovi, adresách a fakturovaných částkách
+        -   Zpracovává zařízení (devices) s jejich odečty včetně spotřeby elektřiny a plynu
+        -   Zpracovává cenové položky (prices) s detailními informacemi o tarifech a jednotkových cenách
+        -   Rozlišuje mezi standardní cenou STANDARD a korekcí CORRECTION 
+-   data modely
+    -   [PpasDistributionInvoiceModel](../src/schema-definitions/models/enapo/ppas/PpasDistributionInvoiceModel.ts) tabulka `ppas_distribution_invoice` - hlavičky faktur
+    -   [PpasDistributionInvoiceDeviceModel](../src/schema-definitions/models/enapo/ppas/PpasDistributionInvoiceDeviceModel.ts) tabulka `ppas_distribution_invoice_device` - zařízení a odečty
+    -   [PpasDistributionInvoicePriceModel](../src/schema-definitions/models/enapo/ppas/PpasDistributionInvoicePriceModel.ts) tabulka `ppas_distribution_invoice_price` - cenové položky
+
 ## Uložení dat
 
 -   typ databáze

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/energetics",
-    "version": "1.7.1",
+    "version": "1.7.2-dev.2265329102",
     "description": "Golemio Energetics Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",

package/dist/integration-engine/commodity-providers/workers/interfaces/IPreEanMeasurement.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IPreEanMeasurement.js","sourceRoot":"","sources":["../../../../../src/integration-engine/commodity-providers/workers/interfaces/IPreEanMeasurement.ts"],"names":[],"mappings":""}

package/dist/integration-engine/enapo/interfaces/IPPasMeasurementData.d.ts

@@ -1,28 +0,0 @@
-export interface IPPasMeasurementData {
-    StandardTime: string;
-    Timestamp: string;
-    OperatingAmount: number;
-    ConvertAmount: number;
-    OperatingDifference: number;
-    ConvertDifference: number;
-    ConvertCoefficient: number;
-    Correction: number;
-    Temperature: number;
-    Pressure: number;
-    SampleState: number;
-    Consumption: number;
-    Energy: number | null;
-    EnergyConsumption: number | null;
-    DeviceSerialNumber: string;
-    StateOfArchiveValues: any | null;
-    DealerLicenceNumberHash: string | null;
-    ManuallyInserted: boolean | null;
-    Edited: boolean;
-    Imported: boolean | null;
-    UserId: number;
-    LastChangeDate: string | null;
-    IsChangedRow: boolean | null;
-    ModemSerialNumber: string;
-    Battery: number;
-    SampleStateDescription: string;
-}

package/dist/integration-engine/enapo/interfaces/IPPasMeasurementData.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IPPasMeasurementData.js","sourceRoot":"","sources":["../../../../src/integration-engine/enapo/interfaces/IPPasMeasurementData.ts"],"names":[],"mappings":""}

package/dist/integration-engine/enapo/interfaces/predi/IPrediMetadata.d.ts

@@ -1,17 +0,0 @@
-export interface IPrediMetadata {
-    year: number;
-    month: number;
-    month_name: string;
-    days_in_stored_month: number;
-    id_company: string;
-    trade_name: string;
-    ean: string;
-    address: string;
-    tarif_type: string;
-    tarif_1T2T: string;
-    phases: string;
-    circuit_breaker: string;
-    location_type: string;
-    type_B_meter: "YES" | "NO";
-    meter_replaced: "YES" | "NO";
-}

package/dist/integration-engine/enapo/interfaces/predi/IPrediMetadata.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IPrediMetadata.js","sourceRoot":"","sources":["../../../../../src/integration-engine/enapo/interfaces/predi/IPrediMetadata.ts"],"names":[],"mappings":""}