@likewatt/models 1.0.10

package/README.md

@@ -0,0 +1,9 @@
+# @likewatt/models
+
+This package is private and hosted on https://verdaccio.likewatt-infra.com, a private NPM repository.  
+It should not be shared to people outside of Likewatt.
+
+# Release
+
+This package uses CI/CD to deploy automatic new versions when a commit is pushed to the `main` branch.  
+The changelogs is also automatically generated. 

package/dist/core/CollectiveSite.d.ts

@@ -0,0 +1,33 @@
+import { Document } from 'mongoose';
+import { SiteType } from './internal/enums';
+export type CollectiveSiteDocument = CollectiveSite & Document;
+export declare class CollectiveSite {
+    _createdAt: string;
+    _lastModified: string;
+    addressGeocode: number[];
+    addressCitySIREN: number;
+    type: SiteType;
+    description: string;
+    address: string;
+    initialOwner: string;
+    name: string;
+    addressDepartementNum: number;
+    id: string;
+    addressZipCode: string;
+    addressCity: string;
+    addressDepartement: string;
+    user: string;
+    country: string;
+    isVisible: boolean;
+    timezone: number;
+    sites: string[];
+}
+export declare const CollectiveSiteSchema: import("mongoose").Schema<CollectiveSite, import("mongoose").Model<CollectiveSite, any, any, any, Document<unknown, any, CollectiveSite, any> & CollectiveSite & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, CollectiveSite, Document<unknown, {}, import("mongoose").FlatRecord<CollectiveSite>, {}> & import("mongoose").FlatRecord<CollectiveSite> & {
+    _id: import("mongoose").Types.ObjectId;
+} & {
+    __v: number;
+}>;

package/dist/core/CollectiveSite.js

@@ -0,0 +1,140 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectiveSiteSchema = exports.CollectiveSite = void 0;
+const mongoose_1 = require("@nestjs/mongoose");
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+const enums_1 = require("./internal/enums");
+let CollectiveSite = class CollectiveSite {
+};
+exports.CollectiveSite = CollectiveSite;
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "_createdAt", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "_lastModified", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ type: [Number], required: true }),
+    (0, class_validator_1.IsArray)(),
+    __metadata("design:type", Array)
+], CollectiveSite.prototype, "addressGeocode", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], CollectiveSite.prototype, "addressCitySIREN", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ enum: enums_1.SiteType }),
+    (0, mongoose_1.Prop)({ type: String, enum: enums_1.SiteType, required: true }),
+    (0, class_validator_1.IsEnum)(enums_1.SiteType),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "type", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "description", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "address", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "initialOwner", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "name", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], CollectiveSite.prototype, "addressDepartementNum", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "id", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "addressZipCode", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "addressCity", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "addressDepartement", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "user", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], CollectiveSite.prototype, "country", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ default: true }),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], CollectiveSite.prototype, "isVisible", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], CollectiveSite.prototype, "timezone", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)(),
+    (0, mongoose_1.Prop)({ type: [String], required: true }),
+    (0, class_validator_1.IsArray)(),
+    __metadata("design:type", Array)
+], CollectiveSite.prototype, "sites", void 0);
+exports.CollectiveSite = CollectiveSite = __decorate([
+    (0, mongoose_1.Schema)({
+        toJSON: { virtuals: true, versionKey: false },
+        toObject: { virtuals: true, versionKey: false },
+    })
+], CollectiveSite);
+exports.CollectiveSiteSchema = mongoose_1.SchemaFactory.createForClass(CollectiveSite);

package/dist/core/Scenario.d.ts

@@ -0,0 +1,68 @@
+import { Document, Types, Schema as MSchema } from 'mongoose';
+export declare class Objective {
+    id: number;
+    name: string;
+    unit: string;
+    value: number;
+    unit2?: string;
+    value2?: number;
+}
+export declare const ObjectiveSchema: MSchema<Objective, import("mongoose").Model<Objective, any, any, any, Document<unknown, any, Objective, any> & Objective & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Objective, Document<unknown, {}, import("mongoose").FlatRecord<Objective>, {}> & import("mongoose").FlatRecord<Objective> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare class Technology {
+    id: string;
+    isDefault?: boolean;
+    index: number;
+    settings: Record<string, unknown>;
+    type?: number;
+}
+export declare const TechnologySchema: MSchema<Technology, import("mongoose").Model<Technology, any, any, any, Document<unknown, any, Technology, any> & Technology & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Technology, Document<unknown, {}, import("mongoose").FlatRecord<Technology>, {}> & import("mongoose").FlatRecord<Technology> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare class ConfigSite {
+    incrementations: Record<string, unknown>[];
+    rateOfGrowth?: Record<string, number>;
+}
+export declare const ConfigSiteSchema: MSchema<ConfigSite, import("mongoose").Model<ConfigSite, any, any, any, Document<unknown, any, ConfigSite, any> & ConfigSite & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, ConfigSite, Document<unknown, {}, import("mongoose").FlatRecord<ConfigSite>, {}> & import("mongoose").FlatRecord<ConfigSite> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;
+export declare class Scenario {
+    _id: Types.ObjectId;
+    discountRate?: number;
+    objectives: Objective[];
+    name: string;
+    technologies: Technology[];
+    configSite: ConfigSite;
+    optimizationHorizon?: Record<string, string>;
+    siteId: string;
+    createdAt: Date;
+}
+export type ScenarioDocument = Scenario & Document;
+export declare const ScenarioSchema: MSchema<Scenario, import("mongoose").Model<Scenario, any, any, any, Document<unknown, any, Scenario, any> & Scenario & Required<{
+    _id: Types.ObjectId;
+}> & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Scenario, Document<unknown, {}, import("mongoose").FlatRecord<Scenario>, {}> & import("mongoose").FlatRecord<Scenario> & Required<{
+    _id: Types.ObjectId;
+}> & {
+    __v: number;
+}>;

package/dist/core/Scenario.js

@@ -0,0 +1,197 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScenarioSchema = exports.Scenario = exports.ConfigSiteSchema = exports.ConfigSite = exports.TechnologySchema = exports.Technology = exports.ObjectiveSchema = exports.Objective = void 0;
+const mongoose_1 = require("@nestjs/mongoose");
+const mongoose_2 = require("mongoose");
+const swagger_1 = require("@nestjs/swagger");
+const class_validator_1 = require("class-validator");
+let Objective = class Objective {
+};
+exports.Objective = Objective;
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 1 }),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], Objective.prototype, "id", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 'CO2 Reduction' }),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], Objective.prototype, "name", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 'tons' }),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], Objective.prototype, "unit", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 1200 }),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], Objective.prototype, "value", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 'kg' }),
+    (0, mongoose_1.Prop)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], Objective.prototype, "unit2", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 1200000 }),
+    (0, mongoose_1.Prop)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], Objective.prototype, "value2", void 0);
+exports.Objective = Objective = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], Objective);
+exports.ObjectiveSchema = mongoose_1.SchemaFactory.createForClass(Objective);
+let Technology = class Technology {
+};
+exports.Technology = Technology;
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 'pv1' }),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], Technology.prototype, "id", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: true }),
+    (0, mongoose_1.Prop)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], Technology.prototype, "isDefault", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 0 }),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], Technology.prototype, "index", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        example: { power: 100, orientation: 'south', tilt: 30 },
+    }),
+    (0, mongoose_1.Prop)({ type: mongoose_2.Schema.Types.Mixed, required: true }),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], Technology.prototype, "settings", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 1 }),
+    (0, mongoose_1.Prop)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], Technology.prototype, "type", void 0);
+exports.Technology = Technology = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], Technology);
+exports.TechnologySchema = mongoose_1.SchemaFactory.createForClass(Technology);
+let ConfigSite = class ConfigSite {
+};
+exports.ConfigSite = ConfigSite;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        example: [
+            { type: 'PV', step: 10, max: 100 },
+            { type: 'Wind', step: 5, max: 50 },
+        ],
+    }),
+    (0, mongoose_1.Prop)({ type: [mongoose_2.Schema.Types.Mixed], default: [] }),
+    (0, class_validator_1.IsArray)(),
+    __metadata("design:type", Array)
+], ConfigSite.prototype, "incrementations", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        example: { year1: 1.02, year2: 1.03 },
+    }),
+    (0, mongoose_1.Prop)({ type: mongoose_2.Schema.Types.Mixed }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], ConfigSite.prototype, "rateOfGrowth", void 0);
+exports.ConfigSite = ConfigSite = __decorate([
+    (0, mongoose_1.Schema)({ _id: false })
+], ConfigSite);
+exports.ConfigSiteSchema = mongoose_1.SchemaFactory.createForClass(ConfigSite);
+let Scenario = class Scenario {
+};
+exports.Scenario = Scenario;
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: '661fd9ef3a4ec63c4f0e5a21' }),
+    (0, mongoose_1.Prop)({ type: mongoose_2.Schema.Types.ObjectId, auto: true }),
+    __metadata("design:type", mongoose_2.Types.ObjectId)
+], Scenario.prototype, "_id", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ example: 0.05 }),
+    (0, mongoose_1.Prop)({ type: mongoose_2.Schema.Types.Mixed }),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", Number)
+], Scenario.prototype, "discountRate", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: [Objective] }),
+    (0, mongoose_1.Prop)({ type: [exports.ObjectiveSchema], required: true }),
+    (0, class_validator_1.IsArray)(),
+    __metadata("design:type", Array)
+], Scenario.prototype, "objectives", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 'Scenario A - Hybrid PV/Wind' }),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], Scenario.prototype, "name", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: [Technology] }),
+    (0, mongoose_1.Prop)({ type: [exports.TechnologySchema], required: true }),
+    (0, class_validator_1.IsArray)(),
+    __metadata("design:type", Array)
+], Scenario.prototype, "technologies", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ type: ConfigSite }),
+    (0, mongoose_1.Prop)({ type: exports.ConfigSiteSchema, required: true }),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", ConfigSite)
+], Scenario.prototype, "configSite", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({
+        example: {
+            start: '2025-01-01',
+            end: '2030-12-31',
+        },
+    }),
+    (0, mongoose_1.Prop)({ type: mongoose_2.Schema.Types.Mixed }),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], Scenario.prototype, "optimizationHorizon", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: 'site_12345' }),
+    (0, mongoose_1.Prop)({ required: true }),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], Scenario.prototype, "siteId", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ example: '2025-04-24T14:05:00.000Z' }),
+    (0, mongoose_1.Prop)({ default: Date.now }),
+    __metadata("design:type", Date)
+], Scenario.prototype, "createdAt", void 0);
+exports.Scenario = Scenario = __decorate([
+    (0, mongoose_1.Schema)({
+        toJSON: { virtuals: true, versionKey: false },
+        toObject: { virtuals: true, versionKey: false },
+    })
+], Scenario);
+exports.ScenarioSchema = mongoose_1.SchemaFactory.createForClass(Scenario);

package/dist/core/Site.d.ts

@@ -0,0 +1,55 @@
+import { Types, Schema as MSchema, Document } from 'mongoose';
+import { SiteType, Profiles } from './internal/enums';
+import { EnergyPrice } from './internal/energy-price.model';
+import { PeakHour } from './internal/peak-hour.model';
+import { OffPeakHour } from './internal/off-peak-hour.model';
+import { SubscriptionRate } from './internal/subscription-rate.model';
+import { CustomerInfos } from './internal/customer-infos.model';
+export declare class Site {
+    country: string;
+    energyPrices: EnergyPrice[];
+    addressCitySIREN: number;
+    purchaseAreaOfTension: string;
+    addressGeocode: number[];
+    peakHours: PeakHour[];
+    offPeakHours: OffPeakHour[];
+    type: SiteType;
+    purchaseMeterOwner: string;
+    purchaseContractType: string;
+    description: string;
+    subscriptionRates: SubscriptionRate[];
+    address: string;
+    ratesOption: string;
+    owner: string;
+    name: string;
+    isC_AND_I: boolean;
+    appUrl: string;
+    addressDepartementNum: number;
+    id: string;
+    addressZipCode: string;
+    subscribedPowers: EnergyPrice[];
+    addressCity: string;
+    addressDepartement: string;
+    reportURL: string;
+    enedisNumber: string;
+    startDate: Date;
+    endDate: Date;
+    automaticUpdateError?: string;
+    scenario?: Types.ObjectId;
+    user: string;
+    profile: Profiles;
+    collectiveSiteId?: string;
+    initialOwner: string;
+    isExtractingData?: boolean;
+    customerInfos?: CustomerInfos;
+}
+export type SiteDocument = Site & Document;
+export declare const SiteSchema: MSchema<Site, import("mongoose").Model<Site, any, any, any, Document<unknown, any, Site, any> & Site & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Site, Document<unknown, {}, import("mongoose").FlatRecord<Site>, {}> & import("mongoose").FlatRecord<Site> & {
+    _id: Types.ObjectId;
+} & {
+    __v: number;
+}>;