@ecogood/e-calculator-schemas 2.7.13 → 2.7.15

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Michael Rudolph
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2021 Michael Rudolph
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,26 +1,26 @@
-# E-Calculator Schemas
-
-This project contains the data transfer objects which are used by the [E-Calculator REST API](https://git.ecogood.org/services/balance-sheet-calculator)
-and the [E-Calculator Frontend](https://git.ecogood.org/services/e-calculator-frontend).
-
-## Install
-
-```bash
-npm install e-calculator-schemas
-```
-
-## Usage
-
-```typescript
-import { RegionResponseBodySchema } from 'e-calculator-schemas/dist/region.dto';
-const regionJson = {
-  countryCode: 'DEU',
-  countryName: 'Germany',
-};
-RegionResponseBodySchema.parse(regionJson);
-```
-
-## Publish
-```bash
-npm publish
-```
+# E-Calculator Schemas
+
+This project contains the data transfer objects which are used by the [E-Calculator REST API](https://git.ecogood.org/services/balance-sheet-calculator)
+and the [E-Calculator Frontend](https://git.ecogood.org/services/e-calculator-frontend).
+
+## Install
+
+```bash
+npm install e-calculator-schemas
+```
+
+## Usage
+
+```typescript
+import { RegionResponseBodySchema } from 'e-calculator-schemas/dist/region.dto';
+const regionJson = {
+  countryCode: 'DEU',
+  countryName: 'Germany',
+};
+RegionResponseBodySchema.parse(regionJson);
+```
+
+## Publish
+```bash
+npm publish
+```

package/dist/balance.sheet.dto.d.ts

@@ -150,6 +150,59 @@ export declare const BalanceSheetCreateRequestBodySchema: z.ZodObject<{
         shortName: string;
         weight: number;
     }>, "many">>;
+    generalInformation: z.ZodObject<{
+        company: z.ZodObject<{
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+        }, {
+            name: string;
+        }>;
+        contactPerson: z.ZodObject<{
+            email: z.ZodString;
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            email: string;
+        }, {
+            name: string;
+            email: string;
+        }>;
+        period: z.ZodOptional<z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            end: string;
+            start: string;
+        }, {
+            end: string;
+            start: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    }, {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    }>;
 }, "strip", z.ZodTypeAny, {
     type: BalanceSheetType;
     version: BalanceSheetVersion;
@@ -192,9 +245,35 @@ export declare const BalanceSheetCreateRequestBodySchema: z.ZodObject<{
         shortName: string;
         weight: number;
     }[];
+    generalInformation: {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    };
 }, {
     type: BalanceSheetType;
     version: BalanceSheetVersion;
+    generalInformation: {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    };
     companyFacts?: {
         totalPurchaseFromSuppliers?: number | undefined;
         totalStaffCosts?: number | undefined;
@@ -383,6 +462,59 @@ export declare const BalanceSheetPatchRequestBodySchema: z.ZodObject<{
         shortName: string;
         weight: number;
     }>, "many">>;
+    generalInformation: z.ZodOptional<z.ZodObject<{
+        company: z.ZodObject<{
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+        }, {
+            name: string;
+        }>;
+        contactPerson: z.ZodObject<{
+            email: z.ZodString;
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            email: string;
+        }, {
+            name: string;
+            email: string;
+        }>;
+        period: z.ZodOptional<z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            end: string;
+            start: string;
+        }, {
+            end: string;
+            start: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    }, {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     ratings: {
         shortName: string;
@@ -423,6 +555,19 @@ export declare const BalanceSheetPatchRequestBodySchema: z.ZodObject<{
         shortName: string;
         weight: number;
     }[] | undefined;
+    generalInformation?: {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    } | undefined;
 }, {
     companyFacts?: {
         totalPurchaseFromSuppliers?: number | undefined;
@@ -463,6 +608,19 @@ export declare const BalanceSheetPatchRequestBodySchema: z.ZodObject<{
         shortName: string;
         weight: number;
     }[] | undefined;
+    generalInformation?: {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    } | undefined;
 }>;
 export declare const BalanceSheetResponseBodySchema: z.ZodObject<{
     id: z.ZodNumber;
@@ -658,6 +816,59 @@ export declare const BalanceSheetResponseBodySchema: z.ZodObject<{
         hasCanteen?: boolean | undefined;
         averageJourneyToWorkForStaffInKm?: number | undefined;
     }>;
+    generalInformation: z.ZodObject<{
+        company: z.ZodObject<{
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+        }, {
+            name: string;
+        }>;
+        contactPerson: z.ZodObject<{
+            email: z.ZodString;
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            email: string;
+        }, {
+            name: string;
+            email: string;
+        }>;
+        period: z.ZodOptional<z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            end: string;
+            start: string;
+        }, {
+            end: string;
+            start: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    }, {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    }>;
     stakeholderWeights: z.ZodArray<z.ZodObject<{
         shortName: z.ZodEffects<z.ZodString, string, string>;
         weight: z.ZodEffects<z.ZodNumber, number, number>;
@@ -720,6 +931,19 @@ export declare const BalanceSheetResponseBodySchema: z.ZodObject<{
         shortName: string;
         weight: number;
     }[];
+    generalInformation: {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    };
 }, {
     type: BalanceSheetType;
     id: number;
@@ -772,6 +996,19 @@ export declare const BalanceSheetResponseBodySchema: z.ZodObject<{
         shortName: string;
         weight: number;
     }[];
+    generalInformation: {
+        company: {
+            name: string;
+        };
+        contactPerson: {
+            name: string;
+            email: string;
+        };
+        period?: {
+            end: string;
+            start: string;
+        } | undefined;
+    };
 }>;
 export declare const BalanceSheetItemResponseSchema: z.ZodObject<{
     id: z.ZodNumber;

package/dist/balance.sheet.dto.js

@@ -6,17 +6,20 @@ const zod_1 = require("zod");
 const company_facts_dto_1 = require("./company.facts.dto");
 const rating_dto_1 = require("./rating.dto");
 const stakeholder_weight_dto_1 = require("./stakeholder.weight.dto");
+const general_information_dto_1 = require("./general.information.dto");
 exports.BalanceSheetCreateRequestBodySchema = zod_1.z.object({
     type: zod_1.z.nativeEnum(shared_schemas_1.BalanceSheetType),
     version: zod_1.z.nativeEnum(shared_schemas_1.BalanceSheetVersion),
     companyFacts: company_facts_dto_1.CompanyFactsCreateRequestBodySchema.default({}),
     ratings: rating_dto_1.RatingRequestBodySchema.array().default([]),
     stakeholderWeights: stakeholder_weight_dto_1.StakeholderWeightSchema.array().default([]),
+    generalInformation: general_information_dto_1.GeneralInformationSchema,
 });
 exports.BalanceSheetPatchRequestBodySchema = zod_1.z.object({
     companyFacts: company_facts_dto_1.CompanyFactsPatchRequestBodySchema.optional(),
     ratings: rating_dto_1.RatingRequestBodySchema.array().default([]),
     stakeholderWeights: stakeholder_weight_dto_1.StakeholderWeightSchema.array().optional(),
+    generalInformation: general_information_dto_1.GeneralInformationSchema.optional(),
 });
 exports.BalanceSheetResponseBodySchema = zod_1.z.object({
     id: zod_1.z.number(),
@@ -24,6 +27,7 @@ exports.BalanceSheetResponseBodySchema = zod_1.z.object({
     version: zod_1.z.nativeEnum(shared_schemas_1.BalanceSheetVersion),
     ratings: rating_dto_1.RatingResponseBodySchema.array(),
     companyFacts: company_facts_dto_1.CompanyFactsResponseBodySchema,
+    generalInformation: general_information_dto_1.GeneralInformationSchema,
     stakeholderWeights: stakeholder_weight_dto_1.StakeholderWeightSchema.array(),
 });
 exports.BalanceSheetItemResponseSchema = zod_1.z.object({

package/dist/general.information.dto.d.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+export declare const GeneralInformationSchema: z.ZodObject<{
+    company: z.ZodObject<{
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+    }, {
+        name: string;
+    }>;
+    contactPerson: z.ZodObject<{
+        email: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        email: string;
+    }, {
+        name: string;
+        email: string;
+    }>;
+    period: z.ZodOptional<z.ZodObject<{
+        start: z.ZodString;
+        end: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        end: string;
+        start: string;
+    }, {
+        end: string;
+        start: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    company: {
+        name: string;
+    };
+    contactPerson: {
+        name: string;
+        email: string;
+    };
+    period?: {
+        end: string;
+        start: string;
+    } | undefined;
+}, {
+    company: {
+        name: string;
+    };
+    contactPerson: {
+        name: string;
+        email: string;
+    };
+    period?: {
+        end: string;
+        start: string;
+    } | undefined;
+}>;

package/dist/general.information.dto.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneralInformationSchema = void 0;
+const zod_1 = require("zod");
+const shared_schemas_1 = require("./shared.schemas");
+const CompanySchema = zod_1.z.object({
+    name: shared_schemas_1.isNonEmptyString,
+});
+const isoDateRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$/;
+const IsoDateString = zod_1.z.string().regex(isoDateRegex, 'Invalid ISO date format');
+const PeriodSchema = zod_1.z.object({
+    start: IsoDateString,
+    end: IsoDateString,
+});
+const ContactPersonSchema = zod_1.z.object({
+    email: zod_1.z.string().email(),
+    name: shared_schemas_1.isNonEmptyString,
+});
+exports.GeneralInformationSchema = zod_1.z.object({
+    company: CompanySchema,
+    contactPerson: ContactPersonSchema,
+    period: PeriodSchema.optional(),
+});

package/dist/organization.dto.js

@@ -2,17 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrganizationItemsResponseSchema = exports.OrganizationResponseSchema = exports.OrganizationRequestSchema = void 0;
 const zod_1 = require("zod");
-const errorMsg = 'Must not be blank';
-const isNonEmptyString = zod_1.z
-    .string({ required_error: errorMsg })
-    .min(1, { message: errorMsg });
+const shared_schemas_1 = require("./shared.schemas");
 exports.OrganizationRequestSchema = zod_1.z.object({
-    name: isNonEmptyString,
+    name: shared_schemas_1.isNonEmptyString,
     address: zod_1.z.object({
-        city: isNonEmptyString,
-        houseNumber: isNonEmptyString,
-        street: isNonEmptyString,
-        zip: isNonEmptyString,
+        city: shared_schemas_1.isNonEmptyString,
+        houseNumber: shared_schemas_1.isNonEmptyString,
+        street: shared_schemas_1.isNonEmptyString,
+        zip: shared_schemas_1.isNonEmptyString,
     }),
 });
 exports.OrganizationResponseSchema = exports.OrganizationRequestSchema.extend({
@@ -20,5 +17,5 @@ exports.OrganizationResponseSchema = exports.OrganizationRequestSchema.extend({
     invitations: zod_1.z.string().email().array(),
 });
 exports.OrganizationItemsResponseSchema = zod_1.z
-    .object({ id: zod_1.z.number(), name: isNonEmptyString })
+    .object({ id: zod_1.z.number(), name: shared_schemas_1.isNonEmptyString })
     .array();

package/dist/shared.schemas.d.ts

@@ -19,3 +19,4 @@ export declare const isPositiveNumber: z.ZodDefault<z.ZodNumber>;
 export declare const isPositiveNumberNotZero: z.ZodDefault<z.ZodNumber>;
 export declare const isPercentage: z.ZodNumber;
 export declare const isPercentageNotZero: z.ZodNumber;
+export declare const isNonEmptyString: z.ZodString;

package/dist/shared.schemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPercentageNotZero = exports.isPercentage = exports.isPositiveNumberNotZero = exports.isPositiveNumber = exports.isNumberWithDefaultZero = exports.isWeightOptional = exports.isWeight = exports.WEIGHT_VALUES = exports.BalanceSheetVersion = exports.BalanceSheetType = exports.isIndustryCode = exports.isCountryCode = void 0;
+exports.isNonEmptyString = exports.isPercentageNotZero = exports.isPercentage = exports.isPositiveNumberNotZero = exports.isPositiveNumber = exports.isNumberWithDefaultZero = exports.isWeightOptional = exports.isWeight = exports.WEIGHT_VALUES = exports.BalanceSheetVersion = exports.BalanceSheetType = exports.isIndustryCode = exports.isCountryCode = void 0;
 const zod_1 = require("zod");
 exports.isCountryCode = zod_1.z.string().min(3).max(3);
 exports.isIndustryCode = zod_1.z.string().min(1).max(4);
@@ -48,3 +48,7 @@ exports.isPercentageNotZero = zod_1.z
 })
     .min(1, 'Percentage should be between 1 and 100')
     .max(100, 'Percentage should be between 0 and 100');
+const errorMsg = 'Must not be blank';
+exports.isNonEmptyString = zod_1.z
+    .string({ required_error: errorMsg })
+    .min(1, { message: errorMsg });

package/package.json

@@ -1,52 +1,52 @@
-{
-  "name": "@ecogood/e-calculator-schemas",
-  "version": "2.7.13",
-  "description": "A package providing the schemas for the e-calculator application.",
-  "main": "dist/e-calculator-schemas",
-  "types": "dist/e-calculator-schemas",
-  "scripts": {
-    "build": "tsc",
-    "test": "jest --watch --runInBand",
-    "test:ci": "jest --runInBand",
-    "format": "prettier --write .",
-    "lint": "eslint .",
-    "lint-fix": "eslint . --fix",
-    "update:to:latest": "ncu -u && yarn update && yarn install && yarn audit fix",
-    "prepare": "rm -r dist || true && yarn run build && yarn run test:ci && yarn run lint"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "files": [
-    "dist",
-    "LICENSE",
-    "README.md"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://git.ecogood.org/services/e-calculator-schemas"
-  },
-  "keywords": [
-    "version",
-    "compare"
-  ],
-  "author": "Michael Rudolph",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://git.ecogood.org/services/e-calculator-schemas/issues"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.4.0",
-    "@types/eslint__js": "^8.42.3",
-    "@types/jest": "^28.1.6",
-    "eslint": "^9.4.0",
-    "jest": "^29.5.0",
-    "prettier": "2.3.2",
-    "ts-jest": "^29.0.5",
-    "typescript": "^5.4.5",
-    "typescript-eslint": "^7.13.0"
-  },
-  "dependencies": {
-    "zod": "^3.23.8"
-  }
-}
+{
+  "name": "@ecogood/e-calculator-schemas",
+  "version": "2.7.15",
+  "description": "A package providing the schemas for the e-calculator application.",
+  "main": "dist/e-calculator-schemas",
+  "types": "dist/e-calculator-schemas",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest --watch --runInBand",
+    "test:ci": "jest --runInBand",
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "lint-fix": "eslint . --fix",
+    "update:to:latest": "ncu -u && yarn update && yarn install && yarn audit fix",
+    "prepare": "rm -r dist || true && yarn run build && yarn run test:ci && yarn run lint"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://git.ecogood.org/services/e-calculator-schemas"
+  },
+  "keywords": [
+    "version",
+    "compare"
+  ],
+  "author": "Michael Rudolph",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://git.ecogood.org/services/e-calculator-schemas/issues"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.4.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/jest": "^28.1.6",
+    "eslint": "^9.4.0",
+    "jest": "^29.5.0",
+    "prettier": "2.3.2",
+    "ts-jest": "^29.0.5",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.13.0"
+  },
+  "dependencies": {
+    "zod": "^3.23.8"
+  }
+}