@jaws-developers-customers/consulca-types 1.0.0

package/README.md

@@ -0,0 +1,81 @@
+# @jaws-developers-customers/consulca-types
+
+Pacchetto NPM con tipi del dominio Consulca e helper pronti all'uso per date, valuta e oggetti principali derivati dallo schema MariaDB.
+
+## Installazione
+
+```bash
+npm install @jaws-developers-customers/consulca-types
+```
+
+## Pubblicazione automatica
+
+Ogni push su `main` esegue i test e pubblica automaticamente il pacchetto su npm tramite GitHub Actions.
+
+Prerequisito:
+
+- npm Trusted Publisher configurato per questo repository/workflow su npm
+
+Il workflow genera una versione unica per ogni run su `main`, così la pubblicazione non fallisce per versioni duplicate.
+
+## Cosa esporta
+
+- tipi TypeScript per le entità principali (`User`, `Property`, `Lease`, `Inspection`, `Claim`, `Work`, ...)
+- cataloghi `ENUM` dello schema (`USER_ROLES`, `ACCESS_CHANNELS`, `PROPERTY_TYPES`, ...)
+- helper:
+  - `formatDate`
+  - `formatDateTime`
+  - `formatCurrency`
+  - `getUserFullName`
+  - `formatAddress`
+  - `hasUserRole`
+  - `hasAccessChannel`
+
+## Esempio
+
+```js
+const {
+  formatCurrency,
+  formatDate,
+  getUserFullName,
+  hasUserRole,
+} = require('@jaws-developers-customers/consulca-types');
+
+console.log(formatDate('2026-09-16T10:30:00Z'));
+console.log(formatCurrency(1250.5));
+console.log(getUserFullName({ first_name: 'Mario', last_name: 'Rossi' }));
+console.log(hasUserRole([{ role: 'manager' }], 'manager'));
+```
+
+### Esempio TypeScript
+
+```ts
+import {
+  formatDateTime,
+  type Inspection,
+  type User,
+} from '@jaws-developers-customers/consulca-types';
+
+const user: User = {
+  id: 'uuid',
+  email: 'mario.rossi@example.com',
+  password_hash: 'hashed',
+  first_name: 'Mario',
+  last_name: 'Rossi',
+  status: 'active',
+  created_at: new Date(),
+  updated_at: new Date(),
+};
+
+const inspection: Inspection = {
+  id: 'uuid',
+  lease_id: 'lease-id',
+  inspector_id: user.id,
+  inspection_type: 'move_in',
+  status: 'draft',
+  created_at: new Date(),
+  updated_at: new Date(),
+};
+
+console.log(formatDateTime(inspection.created_at, 'it-CH'));
+```

package/index.d.ts

@@ -0,0 +1,252 @@
+export type UserStatus = 'active' | 'invited' | 'suspended' | 'disabled';
+export type UserRole = 'lessor' | 'manager' | 'website_manager' | 'inspector';
+export type AccessChannel = 'intranet_dashboard' | 'mobile_app' | 'website_admin';
+export type AccessStatus = 'active' | 'revoked';
+export type PropertyType = 'apartment' | 'house' | 'commercial' | 'parking' | 'other';
+export type PropertyStatus = 'active' | 'inactive' | 'archived';
+export type ManagementRole = 'primary' | 'secondary' | 'accounting' | 'technical' | 'other';
+export type LeaseStatus = 'planned' | 'active' | 'ended' | 'cancelled';
+export type InspectionType = 'move_in' | 'move_out';
+export type InspectionStatus = 'draft' | 'in_progress' | 'submitted' | 'approved' | 'rejected';
+export type ConditionStatus = 'good' | 'minor_damage' | 'major_damage' | 'not_checked';
+export type ClaimStatus = 'draft' | 'submitted' | 'in_review' | 'approved' | 'rejected' | 'closed';
+export type WorkStatus = 'planned' | 'assigned' | 'in_progress' | 'completed' | 'cancelled';
+
+export interface Addressable {
+  address_line1?: string | null;
+  address_line2?: string | null;
+  postal_code?: string | null;
+  city?: string | null;
+  country_code?: string | null;
+}
+
+export interface User extends Addressable {
+  id: string;
+  email: string;
+  password_hash: string;
+  first_name: string;
+  last_name: string;
+  phone?: string | null;
+  status: UserStatus;
+  email_verified_at?: string | Date | null;
+  last_login_at?: string | Date | null;
+  created_at: string | Date;
+  updated_at: string | Date;
+}
+
+export interface UserRoleAssignment {
+  user_id: string;
+  role: UserRole;
+  created_at: string | Date;
+}
+
+export interface UserAccessChannel {
+  user_id: string;
+  channel: AccessChannel;
+  status: AccessStatus;
+  created_at: string | Date;
+  revoked_at?: string | Date | null;
+}
+
+export interface Session {
+  id: string;
+  user_id: string;
+  channel: AccessChannel;
+  access_token_hash: string;
+  refresh_token_hash?: string | null;
+  expires_at: string | Date;
+  refresh_expires_at?: string | Date | null;
+  user_agent?: string | null;
+  ip_address?: Uint8Array | string | null;
+  created_at: string | Date;
+  revoked_at?: string | Date | null;
+}
+
+export interface Building extends Addressable {
+  id: string;
+  name: string;
+  created_at: string | Date;
+  updated_at: string | Date;
+}
+
+export interface Property {
+  id: string;
+  building_id: string;
+  property_number: string;
+  property_type: PropertyType;
+  floor?: string | null;
+  rooms?: number | null;
+  area_m2?: number | null;
+  status: PropertyStatus;
+  created_at: string | Date;
+  updated_at: string | Date;
+}
+
+export interface PropertyLessor {
+  property_id: string;
+  user_id: string;
+  ownership_share?: number | null;
+  is_primary: boolean | number;
+  created_at: string | Date;
+}
+
+export interface PropertyManager {
+  property_id: string;
+  user_id: string;
+  management_role: ManagementRole;
+  valid_from?: string | Date | null;
+  valid_until?: string | Date | null;
+  created_at: string | Date;
+}
+
+export interface Lease {
+  id: string;
+  property_id: string;
+  tenant_name?: string | null;
+  tenant_email?: string | null;
+  tenant_phone?: string | null;
+  start_date: string | Date;
+  end_date?: string | Date | null;
+  status: LeaseStatus;
+  created_at: string | Date;
+  updated_at: string | Date;
+}
+
+export interface Inspection {
+  id: string;
+  lease_id: string;
+  inspector_id: string;
+  inspection_type: InspectionType;
+  status: InspectionStatus;
+  scheduled_at?: string | Date | null;
+  started_at?: string | Date | null;
+  submitted_at?: string | Date | null;
+  notes?: string | null;
+  created_at: string | Date;
+  updated_at: string | Date;
+}
+
+export interface InspectionItem {
+  id: string;
+  inspection_id: string;
+  room?: string | null;
+  item_name: string;
+  condition_status: ConditionStatus;
+  comment?: string | null;
+  created_at: string | Date;
+}
+
+export interface InspectionAttachment {
+  id: string;
+  inspection_id: string;
+  item_id?: string | null;
+  file_name: string;
+  storage_key: string;
+  mime_type?: string | null;
+  file_size?: number | null;
+  created_at: string | Date;
+}
+
+export interface Claim {
+  id: string;
+  property_id: string;
+  submitted_by: string;
+  status: ClaimStatus;
+  incident_date?: string | Date | null;
+  title: string;
+  description: string;
+  amount_estimate?: number | null;
+  currency: string;
+  submitted_at?: string | Date | null;
+  created_at: string | Date;
+  updated_at: string | Date;
+}
+
+export interface ClaimAttachment {
+  id: string;
+  claim_id: string;
+  file_name: string;
+  storage_key: string;
+  mime_type?: string | null;
+  file_size?: number | null;
+  created_at: string | Date;
+}
+
+export interface Manufacturer extends Addressable {
+  id: string;
+  name: string;
+  country_code: string;
+  email?: string | null;
+  phone?: string | null;
+  created_at: string | Date;
+  updated_at: string | Date;
+}
+
+export interface Work {
+  id: string;
+  property_id: string;
+  manufacturer_id?: string | null;
+  created_by: string;
+  title: string;
+  description?: string | null;
+  status: WorkStatus;
+  scheduled_at?: string | Date | null;
+  completed_at?: string | Date | null;
+  created_at: string | Date;
+  updated_at: string | Date;
+}
+
+export interface AuditLog {
+  id: number;
+  user_id?: string | null;
+  channel?: AccessChannel | null;
+  action: string;
+  entity_type?: string | null;
+  entity_id?: string | null;
+  metadata?: Record<string, unknown> | null;
+  created_at: string | Date;
+}
+
+export declare const USER_STATUSES: readonly UserStatus[];
+export declare const USER_ROLES: readonly UserRole[];
+export declare const ACCESS_CHANNELS: readonly AccessChannel[];
+export declare const ACCESS_STATUSES: readonly AccessStatus[];
+export declare const PROPERTY_TYPES: readonly PropertyType[];
+export declare const PROPERTY_STATUSES: readonly PropertyStatus[];
+export declare const MANAGEMENT_ROLES: readonly ManagementRole[];
+export declare const LEASE_STATUSES: readonly LeaseStatus[];
+export declare const INSPECTION_TYPES: readonly InspectionType[];
+export declare const INSPECTION_STATUSES: readonly InspectionStatus[];
+export declare const CONDITION_STATUSES: readonly ConditionStatus[];
+export declare const CLAIM_STATUSES: readonly ClaimStatus[];
+export declare const WORK_STATUSES: readonly WorkStatus[];
+
+export declare function toDate(value: string | number | Date | null | undefined): Date | null;
+export declare function formatDate(
+  value: string | number | Date | null | undefined,
+  locales?: string | string[],
+  options?: Intl.DateTimeFormatOptions
+): string;
+export declare function formatDateTime(
+  value: string | number | Date | null | undefined,
+  locales?: string | string[],
+  options?: Intl.DateTimeFormatOptions
+): string;
+export declare function formatCurrency(
+  amount: string | number | null | undefined,
+  currency?: string,
+  locales?: string | string[],
+  options?: Intl.NumberFormatOptions
+): string;
+export declare function getUserFullName(
+  user: Pick<User, 'first_name' | 'last_name'> | Partial<Pick<User, 'first_name' | 'last_name'>> | null | undefined
+): string;
+export declare function formatAddress(entity: Addressable | null | undefined): string;
+export declare function hasUserRole(
+  userRoles: Array<UserRoleAssignment | UserRole> | null | undefined,
+  role: UserRole
+): boolean;
+export declare function hasAccessChannel(
+  accessChannels: Array<UserAccessChannel | AccessChannel> | null | undefined,
+  channel: AccessChannel
+): boolean;

package/index.js

@@ -0,0 +1,141 @@
+'use strict';
+
+const USER_STATUSES = Object.freeze(['active', 'invited', 'suspended', 'disabled']);
+const USER_ROLES = Object.freeze(['lessor', 'manager', 'website_manager', 'inspector']);
+const ACCESS_CHANNELS = Object.freeze(['intranet_dashboard', 'mobile_app', 'website_admin']);
+const ACCESS_STATUSES = Object.freeze(['active', 'revoked']);
+const PROPERTY_TYPES = Object.freeze(['apartment', 'house', 'commercial', 'parking', 'other']);
+const PROPERTY_STATUSES = Object.freeze(['active', 'inactive', 'archived']);
+const MANAGEMENT_ROLES = Object.freeze(['primary', 'secondary', 'accounting', 'technical', 'other']);
+const LEASE_STATUSES = Object.freeze(['planned', 'active', 'ended', 'cancelled']);
+const INSPECTION_TYPES = Object.freeze(['move_in', 'move_out']);
+const INSPECTION_STATUSES = Object.freeze(['draft', 'in_progress', 'submitted', 'approved', 'rejected']);
+const CONDITION_STATUSES = Object.freeze(['good', 'minor_damage', 'major_damage', 'not_checked']);
+const CLAIM_STATUSES = Object.freeze(['draft', 'submitted', 'in_review', 'approved', 'rejected', 'closed']);
+const WORK_STATUSES = Object.freeze(['planned', 'assigned', 'in_progress', 'completed', 'cancelled']);
+
+function toDate(value) {
+  if (value === null || value === undefined || value === '') {
+    return null;
+  }
+
+  const date = value instanceof Date ? value : new Date(value);
+  return Number.isNaN(date.getTime()) ? null : date;
+}
+
+function formatDate(value, locales = 'it-CH', options = {}) {
+  const date = toDate(value);
+  if (!date) {
+    return '';
+  }
+
+  return new Intl.DateTimeFormat(locales, {
+    year: 'numeric',
+    month: '2-digit',
+    day: '2-digit',
+    ...options,
+  }).format(date);
+}
+
+function formatDateTime(value, locales = 'it-CH', options = {}) {
+  const date = toDate(value);
+  if (!date) {
+    return '';
+  }
+
+  return new Intl.DateTimeFormat(locales, {
+    year: 'numeric',
+    month: '2-digit',
+    day: '2-digit',
+    hour: '2-digit',
+    minute: '2-digit',
+    ...options,
+  }).format(date);
+}
+
+function formatCurrency(amount, currency = 'CHF', locales = 'it-CH', options = {}) {
+  if (amount === null || amount === undefined || amount === '') {
+    return '';
+  }
+
+  const numericAmount = Number(amount);
+  if (Number.isNaN(numericAmount)) {
+    return '';
+  }
+
+  return new Intl.NumberFormat(locales, {
+    style: 'currency',
+    currency,
+    ...options,
+  }).format(numericAmount);
+}
+
+function getUserFullName(user) {
+  return [user?.first_name, user?.last_name].filter(Boolean).join(' ').trim();
+}
+
+function formatAddress(entity) {
+  if (!entity) {
+    return '';
+  }
+
+  const line1 = [entity.address_line1, entity.address_line2].filter(Boolean).join(', ');
+  const line2 = [entity.postal_code, entity.city].filter(Boolean).join(' ');
+
+  return [line1, line2, entity.country_code].filter(Boolean).join(', ');
+}
+
+function hasUserRole(userRoles, role) {
+  return (userRoles ?? []).some((userRole) => {
+    if (typeof userRole === 'string') {
+      return userRole === role;
+    }
+
+    return userRole?.role === role;
+  });
+}
+
+function hasAccessChannel(accessChannels, channel) {
+  return (accessChannels ?? []).some((accessChannel) => {
+    if (typeof accessChannel === 'string') {
+      return accessChannel === channel;
+    }
+
+    return accessChannel?.channel === channel && accessChannel?.status !== 'revoked';
+  });
+}
+
+function getColorPalette(){
+    return {
+        "parcoCeresio": {
+
+        },
+        "general": {
+            
+        }
+    };
+}
+
+module.exports = {
+  ACCESS_CHANNELS,
+  ACCESS_STATUSES,
+  CLAIM_STATUSES,
+  CONDITION_STATUSES,
+  INSPECTION_STATUSES,
+  INSPECTION_TYPES,
+  LEASE_STATUSES,
+  MANAGEMENT_ROLES,
+  PROPERTY_STATUSES,
+  PROPERTY_TYPES,
+  USER_ROLES,
+  USER_STATUSES,
+  WORK_STATUSES,
+  formatAddress,
+  formatCurrency,
+  formatDate,
+  formatDateTime,
+  getUserFullName,
+  hasAccessChannel,
+  hasUserRole,
+  toDate,
+};

package/index.mjs

@@ -0,0 +1,27 @@
+import pkg from './index.js';
+
+export const {
+  ACCESS_CHANNELS,
+  ACCESS_STATUSES,
+  CLAIM_STATUSES,
+  CONDITION_STATUSES,
+  INSPECTION_STATUSES,
+  INSPECTION_TYPES,
+  LEASE_STATUSES,
+  MANAGEMENT_ROLES,
+  PROPERTY_STATUSES,
+  PROPERTY_TYPES,
+  USER_ROLES,
+  USER_STATUSES,
+  WORK_STATUSES,
+  formatAddress,
+  formatCurrency,
+  formatDate,
+  formatDateTime,
+  getUserFullName,
+  hasAccessChannel,
+  hasUserRole,
+  toDate,
+} = pkg;
+
+export default pkg;

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@jaws-developers-customers/consulca-types",
+  "version": "1.0.0",
+  "description": "Tipi e helper per il dominio Consulca.",
+  "keywords": [
+    "consulca",
+    "mariadb",
+    "types",
+    "helpers",
+    "formatter"
+  ],
+  "homepage": "https://github.com/JAWS-Developers-Customers/15-NPMPackage#readme",
+  "bugs": {
+    "url": "https://github.com/JAWS-Developers-Customers/15-NPMPackage/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JAWS-Developers-Customers/15-NPMPackage.git"
+  },
+  "license": "UNLICENSED",
+  "author": "JAWS-Developers-Customers",
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./index.js",
+      "import": "./index.mjs",
+      "default": "./index.js"
+    }
+  },
+  "main": "index.js",
+  "types": "index.d.ts",
+  "directories": {
+    "test": "test"
+  },
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "node --test"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}