@ecogood/e-calculator-schemas 2.7.10 → 2.7.13

package/dist/organization.dto.d.ts

@@ -0,0 +1,88 @@
+import { z } from 'zod';
+export declare const OrganizationRequestSchema: z.ZodObject<{
+    name: z.ZodString;
+    address: z.ZodObject<{
+        city: z.ZodString;
+        houseNumber: z.ZodString;
+        street: z.ZodString;
+        zip: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        city: string;
+        houseNumber: string;
+        street: string;
+        zip: string;
+    }, {
+        city: string;
+        houseNumber: string;
+        street: string;
+        zip: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    address: {
+        city: string;
+        houseNumber: string;
+        street: string;
+        zip: string;
+    };
+}, {
+    name: string;
+    address: {
+        city: string;
+        houseNumber: string;
+        street: string;
+        zip: string;
+    };
+}>;
+export declare const OrganizationResponseSchema: z.ZodObject<z.objectUtil.extendShape<{
+    name: z.ZodString;
+    address: z.ZodObject<{
+        city: z.ZodString;
+        houseNumber: z.ZodString;
+        street: z.ZodString;
+        zip: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        city: string;
+        houseNumber: string;
+        street: string;
+        zip: string;
+    }, {
+        city: string;
+        houseNumber: string;
+        street: string;
+        zip: string;
+    }>;
+}, {
+    id: z.ZodNumber;
+    invitations: z.ZodArray<z.ZodString, "many">;
+}>, "strip", z.ZodTypeAny, {
+    name: string;
+    id: number;
+    address: {
+        city: string;
+        houseNumber: string;
+        street: string;
+        zip: string;
+    };
+    invitations: string[];
+}, {
+    name: string;
+    id: number;
+    address: {
+        city: string;
+        houseNumber: string;
+        street: string;
+        zip: string;
+    };
+    invitations: string[];
+}>;
+export declare const OrganizationItemsResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: number;
+}, {
+    name: string;
+    id: number;
+}>, "many">;

package/dist/organization.dto.js

@@ -0,0 +1,24 @@
+"use strict";
+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 });
+exports.OrganizationRequestSchema = zod_1.z.object({
+    name: isNonEmptyString,
+    address: zod_1.z.object({
+        city: isNonEmptyString,
+        houseNumber: isNonEmptyString,
+        street: isNonEmptyString,
+        zip: isNonEmptyString,
+    }),
+});
+exports.OrganizationResponseSchema = exports.OrganizationRequestSchema.extend({
+    id: zod_1.z.number(),
+    invitations: zod_1.z.string().email().array(),
+});
+exports.OrganizationItemsResponseSchema = zod_1.z
+    .object({ id: zod_1.z.number(), name: isNonEmptyString })
+    .array();

package/dist/rating.dto.d.ts

@@ -0,0 +1,69 @@
+import { z } from 'zod';
+export declare const RatingRequestBodySchema: z.ZodObject<{
+    shortName: z.ZodString;
+    weight: z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>;
+    estimations: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    shortName: string;
+    weight?: number | undefined;
+    estimations?: number | undefined;
+}, {
+    shortName: string;
+    weight?: number | undefined;
+    estimations?: number | undefined;
+}>;
+export declare enum RatingType {
+    topic = "topic",
+    aspect = "aspect"
+}
+export declare const RatingResponseBodySchema: z.ZodEffects<z.ZodObject<{
+    shortName: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodNativeEnum<typeof RatingType>;
+    isPositive: z.ZodBoolean;
+    estimations: z.ZodNumber;
+    weight: z.ZodNumber;
+    isWeightSelectedByUser: z.ZodBoolean;
+    points: z.ZodNumber;
+    maxPoints: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    type: RatingType;
+    shortName: string;
+    weight: number;
+    estimations: number;
+    isPositive: boolean;
+    isWeightSelectedByUser: boolean;
+    points: number;
+    maxPoints: number;
+}, {
+    name: string;
+    type: RatingType;
+    shortName: string;
+    weight: number;
+    estimations: number;
+    isPositive: boolean;
+    isWeightSelectedByUser: boolean;
+    points: number;
+    maxPoints: number;
+}>, {
+    name: string;
+    type: RatingType;
+    shortName: string;
+    weight: number;
+    estimations: number;
+    isPositive: boolean;
+    isWeightSelectedByUser: boolean;
+    points: number;
+    maxPoints: number;
+}, {
+    name: string;
+    type: RatingType;
+    shortName: string;
+    weight: number;
+    estimations: number;
+    isPositive: boolean;
+    isWeightSelectedByUser: boolean;
+    points: number;
+    maxPoints: number;
+}>;

package/dist/rating.dto.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RatingResponseBodySchema = exports.RatingType = exports.RatingRequestBodySchema = void 0;
+const zod_1 = require("zod");
+const shared_schemas_1 = require("./shared.schemas");
+exports.RatingRequestBodySchema = zod_1.z.object({
+    shortName: zod_1.z.string(),
+    weight: shared_schemas_1.isWeightOptional,
+    estimations: zod_1.z.number().min(-200).max(10).optional(),
+});
+var RatingType;
+(function (RatingType) {
+    RatingType["topic"] = "topic";
+    RatingType["aspect"] = "aspect";
+})(RatingType || (exports.RatingType = RatingType = {}));
+exports.RatingResponseBodySchema = zod_1.z
+    .object({
+    shortName: zod_1.z.string(),
+    name: zod_1.z.string(),
+    type: zod_1.z.nativeEnum(RatingType),
+    isPositive: zod_1.z.boolean(),
+    estimations: zod_1.z.number({
+        invalid_type_error: 'Number expected',
+        required_error: 'Number expected',
+    }),
+    weight: zod_1.z.number(),
+    isWeightSelectedByUser: zod_1.z.boolean(),
+    points: zod_1.z.number(),
+    maxPoints: zod_1.z.number(),
+})
+    .refine((data) => {
+    const isValid = data.type === RatingType.topic ||
+        (data.isPositive &&
+            zod_1.z.number().min(0).max(10).safeParse(data.estimations).success) ||
+        (!data.isPositive &&
+            zod_1.z.number().min(-200).max(0).safeParse(data.estimations).success);
+    return isValid;
+}, (data) => ({
+    message: `Number should be between ${data.isPositive ? '0 and 10' : '-200 and 0'}`,
+    path: [`estimations`],
+}));

package/dist/region.dto.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const RegionResponseBodySchema: z.ZodObject<{
+    countryCode: z.ZodString;
+    countryName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    countryCode: string;
+    countryName: string;
+}, {
+    countryCode: string;
+    countryName: string;
+}>;

package/dist/region.dto.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegionResponseBodySchema = void 0;
+const zod_1 = require("zod");
+exports.RegionResponseBodySchema = zod_1.z.object({
+    countryCode: zod_1.z.string(),
+    countryName: zod_1.z.string(),
+});

package/dist/shared.schemas.d.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+export declare const isCountryCode: z.ZodString;
+export declare const isIndustryCode: z.ZodString;
+export declare enum BalanceSheetType {
+    Compact = "Compact",
+    Full = "Full"
+}
+export declare enum BalanceSheetVersion {
+    v5_0_6 = "5.06",
+    v5_0_8 = "5.08",
+    v5_0_9 = "5.09",
+    v5_1_0 = "5.10"
+}
+export declare const WEIGHT_VALUES: number[];
+export declare const isWeight: z.ZodEffects<z.ZodNumber, number, number>;
+export declare const isWeightOptional: z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>;
+export declare const isNumberWithDefaultZero: z.ZodDefault<z.ZodNumber>;
+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;

package/dist/shared.schemas.js

@@ -0,0 +1,50 @@
+"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;
+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);
+var BalanceSheetType;
+(function (BalanceSheetType) {
+    BalanceSheetType["Compact"] = "Compact";
+    BalanceSheetType["Full"] = "Full";
+})(BalanceSheetType || (exports.BalanceSheetType = BalanceSheetType = {}));
+var BalanceSheetVersion;
+(function (BalanceSheetVersion) {
+    BalanceSheetVersion["v5_0_6"] = "5.06";
+    BalanceSheetVersion["v5_0_8"] = "5.08";
+    BalanceSheetVersion["v5_0_9"] = "5.09";
+    BalanceSheetVersion["v5_1_0"] = "5.10";
+})(BalanceSheetVersion || (exports.BalanceSheetVersion = BalanceSheetVersion = {}));
+const isNumberCustomError = zod_1.z.number({
+    invalid_type_error: 'Number expected',
+    required_error: 'Number expected',
+});
+exports.WEIGHT_VALUES = [0, 0.5, 1, 1.5, 2];
+exports.isWeight = zod_1.z
+    .number()
+    .refine((v) => exports.WEIGHT_VALUES.some((w) => w === v), {
+    message: `Weight has to be one of the following values ${exports.WEIGHT_VALUES}`,
+});
+exports.isWeightOptional = exports.isWeight.optional();
+exports.isNumberWithDefaultZero = isNumberCustomError.default(0);
+exports.isPositiveNumber = isNumberCustomError
+    .nonnegative('Number should be positive')
+    .default(0);
+exports.isPositiveNumberNotZero = isNumberCustomError
+    .gt(0, 'Number should be positive and greater than zero')
+    .default(0);
+exports.isPercentage = zod_1.z
+    .number({
+    invalid_type_error: 'Percentage expected',
+    required_error: 'Percentage expected',
+})
+    .min(0, 'Percentage should be between 0 and 100')
+    .max(100, 'Percentage should be between 0 and 100');
+exports.isPercentageNotZero = zod_1.z
+    .number({
+    invalid_type_error: 'Percentage expected',
+    required_error: 'Percentage expected',
+})
+    .min(1, 'Percentage should be between 1 and 100')
+    .max(100, 'Percentage should be between 0 and 100');

package/dist/stakeholder.weight.dto.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const StakeholderWeightSchema: z.ZodObject<{
+    shortName: z.ZodEffects<z.ZodString, string, string>;
+    weight: z.ZodEffects<z.ZodNumber, number, number>;
+}, "strip", z.ZodTypeAny, {
+    shortName: string;
+    weight: number;
+}, {
+    shortName: string;
+    weight: number;
+}>;

package/dist/stakeholder.weight.dto.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StakeholderWeightSchema = void 0;
+const zod_1 = require("zod");
+const shared_schemas_1 = require("./shared.schemas");
+const STAKEHOLDER_NAMES = ['A', 'B', 'C', 'D', 'E'];
+const isStakeholderShortName = zod_1.z
+    .string()
+    .refine((v) => STAKEHOLDER_NAMES.some((w) => w === v), {
+    message: `Short name has to be one of the following values ${STAKEHOLDER_NAMES}`,
+});
+exports.StakeholderWeightSchema = zod_1.z.object({
+    shortName: isStakeholderShortName,
+    weight: shared_schemas_1.isWeight,
+});

package/dist/translations/de.d.ts

@@ -0,0 +1,11 @@
+export declare const DE_ERROR_TRANSLATIONS: {
+    'Number expected': string;
+    'Number should be positive': string;
+    'Percentage expected': string;
+    'Percentage should be between 0 and 100': string;
+    'Percentage should be between 1 and 100': string;
+    'Number should be between 0 and 10': string;
+    'Number should be between -200 and 0': string;
+    'Must not be blank': string;
+    'Number should be positive and greater than zero': string;
+};

package/dist/translations/de.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DE_ERROR_TRANSLATIONS = void 0;
+exports.DE_ERROR_TRANSLATIONS = {
+    'Number expected': 'Zahl erwartet',
+    'Number should be positive': 'Zahl sollte positiv sein',
+    'Percentage expected': 'Prozentangabe erwartet',
+    'Percentage should be between 0 and 100': 'Prozentangabe sollte zwischen 0 und 100 liegen',
+    'Percentage should be between 1 and 100': 'Prozentangabe sollte zwischen 1 und 100 liegen',
+    'Number should be between 0 and 10': 'Zahl sollte zwischen 0 und 10 liegen',
+    'Number should be between -200 and 0': 'Zahl sollte zwischen -200 und 0 liegen',
+    'Must not be blank': 'Darf nicht leer sein',
+    'Number should be positive and greater than zero': 'Zahl sollte positiv und größer als 0 sein',
+};

package/dist/translations/en.d.ts

@@ -0,0 +1,2 @@
+export declare const EN_WORDS: string[];
+export declare const EN_ERROR_TRANSLATIONS: {};

package/dist/translations/en.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EN_ERROR_TRANSLATIONS = exports.EN_WORDS = void 0;
+exports.EN_WORDS = [
+    'Number expected',
+    'Number should be positive',
+    'Percentage expected',
+    'Percentage should be between 0 and 100',
+    'Percentage should be between 1 and 100',
+    'Number should be between 0 and 10',
+    'Number should be between -200 and 0',
+    'Must not be blank',
+    'Number should be positive and greater than zero',
+];
+exports.EN_ERROR_TRANSLATIONS = Object.assign({}, exports.EN_WORDS.reduce((prevValue, w) => (Object.assign(Object.assign({}, prevValue), { [w]: w })), {}));

package/dist/user.schema.d.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+export declare const UserRequestBodySchema: z.ZodObject<{
+    email: z.ZodString;
+    password: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    password: string;
+}, {
+    email: string;
+    password: string;
+}>;
+export declare const PasswordResetRequestBodySchema: z.ZodObject<{
+    newPassword: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    newPassword: string;
+}, {
+    newPassword: string;
+}>;
+export declare const UserInvitationResponseSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: number;
+}, {
+    name: string;
+    id: number;
+}>;

package/dist/user.schema.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserInvitationResponseSchema = exports.PasswordResetRequestBodySchema = exports.UserRequestBodySchema = void 0;
+const zod_1 = require("zod");
+const isPassword = zod_1.z.string().min(20);
+exports.UserRequestBodySchema = zod_1.z.object({
+    email: zod_1.z.string().email(),
+    password: isPassword,
+});
+exports.PasswordResetRequestBodySchema = zod_1.z.object({
+    newPassword: isPassword,
+});
+exports.UserInvitationResponseSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    name: zod_1.z.string(),
+});

package/dist/workbook.dto.d.ts

@@ -0,0 +1,58 @@
+import { z } from 'zod';
+import { BalanceSheetType, BalanceSheetVersion } from './shared.schemas';
+export declare const WorkbookResponseBodySchema: z.ZodObject<{
+    version: z.ZodNativeEnum<typeof BalanceSheetVersion>;
+    type: z.ZodNativeEnum<typeof BalanceSheetType>;
+    groups: z.ZodArray<z.ZodObject<{
+        shortName: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        shortName: string;
+    }, {
+        name: string;
+        shortName: string;
+    }>, "many">;
+    evaluationLevels: z.ZodArray<z.ZodObject<{
+        level: z.ZodNumber;
+        name: z.ZodString;
+        pointsFrom: z.ZodNumber;
+        pointsTo: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        level: number;
+        pointsFrom: number;
+        pointsTo: number;
+    }, {
+        name: string;
+        level: number;
+        pointsFrom: number;
+        pointsTo: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    groups: {
+        name: string;
+        shortName: string;
+    }[];
+    type: BalanceSheetType;
+    version: BalanceSheetVersion;
+    evaluationLevels: {
+        name: string;
+        level: number;
+        pointsFrom: number;
+        pointsTo: number;
+    }[];
+}, {
+    groups: {
+        name: string;
+        shortName: string;
+    }[];
+    type: BalanceSheetType;
+    version: BalanceSheetVersion;
+    evaluationLevels: {
+        name: string;
+        level: number;
+        pointsFrom: number;
+        pointsTo: number;
+    }[];
+}>;

package/dist/workbook.dto.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkbookResponseBodySchema = void 0;
+const zod_1 = require("zod");
+const shared_schemas_1 = require("./shared.schemas");
+const GroupSchema = zod_1.z.object({
+    shortName: zod_1.z.string(),
+    name: zod_1.z.string(),
+});
+const EvaluationLevelSchema = zod_1.z.object({
+    level: zod_1.z.number(),
+    name: zod_1.z.string(),
+    pointsFrom: zod_1.z.number(),
+    pointsTo: zod_1.z.number(),
+});
+exports.WorkbookResponseBodySchema = zod_1.z.object({
+    version: zod_1.z.nativeEnum(shared_schemas_1.BalanceSheetVersion),
+    type: zod_1.z.nativeEnum(shared_schemas_1.BalanceSheetType),
+    groups: GroupSchema.array(),
+    evaluationLevels: EvaluationLevelSchema.array(),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecogood/e-calculator-schemas",
-  "version": "2.7.10",
+  "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",