colibris-types 1.0.42 → 2.0.1

package/lib/index.js

@@ -1,13 +1,16 @@
-import { organizationDefinitions, } from "./org.js";
-import { assetDefinitions, } from "./computers.js";
-import { licenseDefintions } from "./licenses.js";
-import { telecomDefinitions } from "./telecom.js";
-import { carDefinitions, } from "./cars.js";
-export { organizationDefinitions, assetDefinitions, licenseDefintions, telecomDefinitions, carDefinitions, };
-export const schemasDefinitions = {
-    ...organizationDefinitions,
-    ...assetDefinitions,
-    ...licenseDefintions,
-    ...telecomDefinitions,
-    ...carDefinitions,
-};
+// Notification
+export { NotificationSchema, NotificationTypeSchema, } from "./notification.js";
+// Notification Settings (user preferences)
+export { NotificationTypePreferenceSchema, NotificationPreferencesSchema, } from "./notification-settings.js";
+// Imports (history + upload schemas)
+export { 
+// History
+ImportsHistorySchema, ImportsHistoryTypeSchema, ImportsHistoryStatusSchema, 
+// Organization uploads
+PeopleUploadSchema, PeopleUploadRowSchema, SubsidiaryUploadSchema, SubsidiaryUploadRowSchema, organizationDefinitions, 
+// Asset uploads
+ComputerUploadSchema, ComputerUploadRowSchema, assetDefinitions, 
+// Telecom uploads
+BouyguesGlobalInvoiceUploadSchema, BouyguesGlobalInvoiceUploadRowSchema, BouyguesDetailedInvoiceUploadSchema, BouyguesDetailedInvoiceUploadRowSchema, BouyguesFleetUploadSchema, BouyguesFleetUploadRowSchema, OrangeDetailedInvoiceUploadSchema, OrangeDetailedInvoiceUploadRowSchema, OrangeFleetUploadSchema, OrangeFleetUploadRowSchema, SfrDetailedInvoiceUploadSchema, SfrDetailedInvoiceUploadRowSchema, telecomDefinitions, 
+// Consolidated definitions
+schemasDefinitions, } from "./imports/index.js";

package/lib/notification-settings.d.ts

@@ -0,0 +1,53 @@
+import { z } from "zod";
+export declare const NotificationTypePreferenceSchema: z.ZodObject<{
+    inApp: z.ZodBoolean;
+    email: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    inApp: boolean;
+    email: boolean;
+}, {
+    inApp: boolean;
+    email: boolean;
+}>;
+export declare const NotificationPreferencesSchema: z.ZodObject<{
+    monthlyReport: z.ZodObject<{
+        inApp: z.ZodBoolean;
+        email: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        inApp: boolean;
+        email: boolean;
+    }, {
+        inApp: boolean;
+        email: boolean;
+    }>;
+    thresholds: z.ZodObject<{
+        inApp: z.ZodBoolean;
+        email: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        inApp: boolean;
+        email: boolean;
+    }, {
+        inApp: boolean;
+        email: boolean;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    monthlyReport: {
+        inApp: boolean;
+        email: boolean;
+    };
+    thresholds: {
+        inApp: boolean;
+        email: boolean;
+    };
+}, {
+    monthlyReport: {
+        inApp: boolean;
+        email: boolean;
+    };
+    thresholds: {
+        inApp: boolean;
+        email: boolean;
+    };
+}>;
+export type NotificationTypePreference = z.infer<typeof NotificationTypePreferenceSchema>;
+export type NotificationPreferences = z.infer<typeof NotificationPreferencesSchema>;

package/lib/notification-settings.js

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi";
+extendZodWithOpenApi(z);
+export const NotificationTypePreferenceSchema = z
+    .object({
+    inApp: z.boolean().openapi({ description: "Enable in-app notifications" }),
+    email: z.boolean().openapi({ description: "Enable email notifications" }),
+})
+    .openapi("NotificationTypePreference");
+export const NotificationPreferencesSchema = z
+    .object({
+    monthlyReport: NotificationTypePreferenceSchema.openapi({
+        description: "Monthly report notification preferences",
+    }),
+    thresholds: NotificationTypePreferenceSchema.openapi({
+        description: "Threshold alerts notification preferences",
+    }),
+})
+    .openapi("NotificationPreferences");

package/lib/notification.d.ts

@@ -0,0 +1,37 @@
+import { z } from "zod";
+export declare const NotificationTypeSchema: z.ZodEnum<["success", "error", "warning", "info", "pending"]>;
+export declare const NotificationSchema: z.ZodObject<{
+    id: z.ZodString;
+    user: z.ZodString;
+    createdAt: z.ZodString;
+    title: z.ZodString;
+    content: z.ZodString;
+    read: z.ZodBoolean;
+    url: z.ZodOptional<z.ZodString>;
+    to: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    type: z.ZodOptional<z.ZodEnum<["success", "error", "warning", "info", "pending"]>>;
+    isDownloadable: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    id: string;
+    user: string;
+    createdAt: string;
+    content: string;
+    read: boolean;
+    type?: "success" | "error" | "warning" | "info" | "pending" | undefined;
+    url?: string | undefined;
+    to?: string[] | undefined;
+    isDownloadable?: boolean | undefined;
+}, {
+    title: string;
+    id: string;
+    user: string;
+    createdAt: string;
+    content: string;
+    read: boolean;
+    type?: "success" | "error" | "warning" | "info" | "pending" | undefined;
+    url?: string | undefined;
+    to?: string[] | undefined;
+    isDownloadable?: boolean | undefined;
+}>;
+export type Notification = z.infer<typeof NotificationSchema>;

package/lib/notification.js

@@ -0,0 +1,39 @@
+import { z } from "zod";
+import { extendZodWithOpenApi } from "@asteasolutions/zod-to-openapi";
+extendZodWithOpenApi(z);
+export const NotificationTypeSchema = z
+    .enum(["success", "error", "warning", "info", "pending"])
+    .openapi({ description: "Type of notification" });
+export const NotificationSchema = z
+    .object({
+    id: z.string().openapi({ description: "Unique notification identifier" }),
+    user: z
+        .string()
+        .openapi({ description: "User email associated with the notification" }),
+    createdAt: z
+        .string()
+        .openapi({ description: "ISO 8601 timestamp of creation" }),
+    title: z.string().openapi({ description: "Notification title (i18n key)" }),
+    content: z
+        .string()
+        .openapi({ description: "Notification content (i18n key)" }),
+    read: z
+        .boolean()
+        .openapi({ description: "Whether the notification has been read" }),
+    url: z
+        .string()
+        .optional()
+        .openapi({ description: "Optional URL for the notification" }),
+    to: z
+        .array(z.string())
+        .optional()
+        .openapi({ description: "Optional list of recipients" }),
+    type: NotificationTypeSchema.optional(),
+    isDownloadable: z
+        .boolean()
+        .optional()
+        .openapi({
+        description: "Whether the notification contains downloadable content",
+    }),
+})
+    .openapi("Notification");

package/package.json

@@ -1,28 +1,44 @@
 {
   "name": "colibris-types",
-  "version": "1.0.42",
-  "description": "",
+  "version": "2.0.1",
+  "description": "Shared TypeScript types and Zod schemas for Colibris platform",
   "main": "./lib/index.js",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "type": "module",
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/jest": "^29.5.12",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.1.2",
-    "typescript": "^5.4.5"
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
   },
   "files": [
     "lib/**/*"
   ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "yarn build"
+  },
+  "keywords": [
+    "colibris",
+    "types",
+    "zod",
+    "openapi"
+  ],
+  "author": "",
+  "license": "UNLICENSED",
   "dependencies": {
-    "zod": "^3.23.4"
+    "zod": "^3.23.4",
+    "@asteasolutions/zod-to-openapi": "^7.0.0"
   },
-  "types": "./lib/index.d.ts",
-  "scripts": {
-    "test": "jest",
-    "cover": "jest --coverage",
-    "build": "tsc"
+  "devDependencies": {
+    "@types/node": "^22.9.1",
+    "typescript": "^5.4.5"
+  },
+  "peerDependencies": {
+    "zod": "^3.22.0"
   }
-}
+}

package/README.md

@@ -1,2 +0,0 @@
-Update package version: `npm version [patch|minor|major]`
-Publish new version: `npm publish`

package/lib/base.d.ts

@@ -1,9 +0,0 @@
-import { z } from "zod";
-declare const Model: z.ZodObject<{
-    id_company: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    id_company: number;
-}, {
-    id_company: number;
-}>;
-export { Model };

package/lib/base.js

@@ -1,3 +0,0 @@
-import { z } from "zod";
-const Model = z.object({ id_company: z.number() });
-export { Model };

package/lib/cars.d.ts

@@ -1,206 +0,0 @@
-import { z } from "zod";
-declare const CarCategory: z.ZodObject<{
-    id_car_category: z.ZodNumber;
-    name: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    id_car_category: number;
-}, {
-    name: string;
-    id_car_category: number;
-}>;
-declare const CarEnegySource: z.ZodObject<{
-    id_car_energy_source: z.ZodNumber;
-    name: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    id_car_energy_source: number;
-}, {
-    name: string;
-    id_car_energy_source: number;
-}>;
-declare const CarStatus: z.ZodObject<{
-    id_car_status: z.ZodNumber;
-    name: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    id_car_status: number;
-}, {
-    name: string;
-    id_car_status: number;
-}>;
-declare const Car: z.ZodObject<z.objectUtil.extendShape<{
-    id_company: z.ZodNumber;
-}, {
-    id_car: z.ZodNumber;
-    reg_country: z.ZodString;
-    reg_id_number: z.ZodString;
-    brand: z.ZodString;
-    model: z.ZodString;
-    variant_information: z.ZodOptional<z.ZodString>;
-    car_category: z.ZodString;
-    car_energy_source: z.ZodString;
-    car_status: z.ZodString;
-    owner: z.ZodString;
-    renter: z.ZodOptional<z.ZodString>;
-    renting_subsidiary: z.ZodOptional<z.ZodString>;
-    affected_subsidiary: z.ZodOptional<z.ZodString>;
-    rent_amount: z.ZodOptional<z.ZodNumber>;
-    start_date: z.ZodOptional<z.ZodDate>;
-    end_date: z.ZodOptional<z.ZodDate>;
-    expected_delivery_date: z.ZodOptional<z.ZodDate>;
-    expected_return_date: z.ZodOptional<z.ZodDate>;
-    expected_duration_months: z.ZodOptional<z.ZodNumber>;
-    delivery_date: z.ZodOptional<z.ZodDate>;
-    return_date: z.ZodOptional<z.ZodDate>;
-}>, "strip", z.ZodTypeAny, {
-    brand: string;
-    id_company: number;
-    id_car: number;
-    reg_country: string;
-    reg_id_number: string;
-    model: string;
-    car_category: string;
-    car_energy_source: string;
-    car_status: string;
-    owner: string;
-    variant_information?: string | undefined;
-    renter?: string | undefined;
-    renting_subsidiary?: string | undefined;
-    affected_subsidiary?: string | undefined;
-    rent_amount?: number | undefined;
-    start_date?: Date | undefined;
-    end_date?: Date | undefined;
-    expected_delivery_date?: Date | undefined;
-    expected_return_date?: Date | undefined;
-    expected_duration_months?: number | undefined;
-    delivery_date?: Date | undefined;
-    return_date?: Date | undefined;
-}, {
-    brand: string;
-    id_company: number;
-    id_car: number;
-    reg_country: string;
-    reg_id_number: string;
-    model: string;
-    car_category: string;
-    car_energy_source: string;
-    car_status: string;
-    owner: string;
-    variant_information?: string | undefined;
-    renter?: string | undefined;
-    renting_subsidiary?: string | undefined;
-    affected_subsidiary?: string | undefined;
-    rent_amount?: number | undefined;
-    start_date?: Date | undefined;
-    end_date?: Date | undefined;
-    expected_delivery_date?: Date | undefined;
-    expected_return_date?: Date | undefined;
-    expected_duration_months?: number | undefined;
-    delivery_date?: Date | undefined;
-    return_date?: Date | undefined;
-}>;
-export declare const carDefinitions: {
-    car_category: z.ZodObject<{
-        id_car_category: z.ZodNumber;
-        name: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        id_car_category: number;
-    }, {
-        name: string;
-        id_car_category: number;
-    }>;
-    car_energy_source: z.ZodObject<{
-        id_car_energy_source: z.ZodNumber;
-        name: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        id_car_energy_source: number;
-    }, {
-        name: string;
-        id_car_energy_source: number;
-    }>;
-    car_status: z.ZodObject<{
-        id_car_status: z.ZodNumber;
-        name: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        id_car_status: number;
-    }, {
-        name: string;
-        id_car_status: number;
-    }>;
-    car: z.ZodObject<z.objectUtil.extendShape<{
-        id_company: z.ZodNumber;
-    }, {
-        id_car: z.ZodNumber;
-        reg_country: z.ZodString;
-        reg_id_number: z.ZodString;
-        brand: z.ZodString;
-        model: z.ZodString;
-        variant_information: z.ZodOptional<z.ZodString>;
-        car_category: z.ZodString;
-        car_energy_source: z.ZodString;
-        car_status: z.ZodString;
-        owner: z.ZodString;
-        renter: z.ZodOptional<z.ZodString>;
-        renting_subsidiary: z.ZodOptional<z.ZodString>;
-        affected_subsidiary: z.ZodOptional<z.ZodString>;
-        rent_amount: z.ZodOptional<z.ZodNumber>;
-        start_date: z.ZodOptional<z.ZodDate>;
-        end_date: z.ZodOptional<z.ZodDate>;
-        expected_delivery_date: z.ZodOptional<z.ZodDate>;
-        expected_return_date: z.ZodOptional<z.ZodDate>;
-        expected_duration_months: z.ZodOptional<z.ZodNumber>;
-        delivery_date: z.ZodOptional<z.ZodDate>;
-        return_date: z.ZodOptional<z.ZodDate>;
-    }>, "strip", z.ZodTypeAny, {
-        brand: string;
-        id_company: number;
-        id_car: number;
-        reg_country: string;
-        reg_id_number: string;
-        model: string;
-        car_category: string;
-        car_energy_source: string;
-        car_status: string;
-        owner: string;
-        variant_information?: string | undefined;
-        renter?: string | undefined;
-        renting_subsidiary?: string | undefined;
-        affected_subsidiary?: string | undefined;
-        rent_amount?: number | undefined;
-        start_date?: Date | undefined;
-        end_date?: Date | undefined;
-        expected_delivery_date?: Date | undefined;
-        expected_return_date?: Date | undefined;
-        expected_duration_months?: number | undefined;
-        delivery_date?: Date | undefined;
-        return_date?: Date | undefined;
-    }, {
-        brand: string;
-        id_company: number;
-        id_car: number;
-        reg_country: string;
-        reg_id_number: string;
-        model: string;
-        car_category: string;
-        car_energy_source: string;
-        car_status: string;
-        owner: string;
-        variant_information?: string | undefined;
-        renter?: string | undefined;
-        renting_subsidiary?: string | undefined;
-        affected_subsidiary?: string | undefined;
-        rent_amount?: number | undefined;
-        start_date?: Date | undefined;
-        end_date?: Date | undefined;
-        expected_delivery_date?: Date | undefined;
-        expected_return_date?: Date | undefined;
-        expected_duration_months?: number | undefined;
-        delivery_date?: Date | undefined;
-        return_date?: Date | undefined;
-    }>;
-};
-export { CarCategory, CarEnegySource, CarStatus, Car };

package/lib/cars.js

@@ -1,44 +0,0 @@
-import { z } from "zod";
-import { Model } from "./base.js";
-const CarCategory = z.object({
-    id_car_category: z.number(),
-    name: z.string().max(250),
-});
-const CarEnegySource = z.object({
-    id_car_energy_source: z.number(),
-    name: z.string().max(250),
-});
-const CarStatus = z.object({
-    id_car_status: z.number(),
-    name: z.string().max(250),
-});
-const Car = Model.extend({
-    id_car: z.number(),
-    reg_country: z.string().max(50),
-    reg_id_number: z.string().max(20),
-    brand: z.string().max(50),
-    model: z.string().max(50),
-    variant_information: z.string().max(50).optional(),
-    car_category: z.string().max(250),
-    car_energy_source: z.string().max(250),
-    car_status: z.string().max(250),
-    owner: z.string().max(250),
-    renter: z.string().max(250).optional(),
-    renting_subsidiary: z.string().max(250).optional(),
-    affected_subsidiary: z.string().max(250).optional(),
-    rent_amount: z.number().optional(),
-    start_date: z.coerce.date().optional(),
-    end_date: z.coerce.date().optional(),
-    expected_delivery_date: z.coerce.date().optional(),
-    expected_return_date: z.coerce.date().optional(),
-    expected_duration_months: z.number().optional(),
-    delivery_date: z.coerce.date().optional(),
-    return_date: z.coerce.date().optional(),
-});
-export const carDefinitions = {
-    car_category: CarCategory,
-    car_energy_source: CarEnegySource,
-    car_status: CarStatus,
-    car: Car,
-};
-export { CarCategory, CarEnegySource, CarStatus, Car };