@lucaapp/service-utils 1.62.6 → 1.64.0

package/README.md

@@ -1,24 +1,31 @@
 ## service-utils
 
-`service-utils` aims at swapping common functionality for most/all backend services in order to reduce code duplication.
-Future use-cases should include logging, inter-service communication, metrics etc.
+`service-utils` is a shared package that provides functionality for backend
+services to reduce code duplication. It includes utilities for:
 
-#### Development
+- Logging and monitoring
+- API validation and OpenAPI documentation
+- Error handling
+- Database operations
+- Authentication and authorization
+- Kafka messaging
+- HTTP client operations
+- And more
 
-Development of service-utils package will take place in your local machine, not within the docker context.
-Therefore, some adoptions and preparations are necessary.
-Follow these steps for initial setup:
+### Development Setup
 
-* Navigate to `packages/service-utils`
-* Run `yarn link`
-* Navigate to `services/backend`
-* Run `yarn link @lucaapp/service-utils`
+1. Navigate to `packages/service-utils`
+2. Run `yarn link`
+3. Navigate to `services/backend`
+4. Run `yarn link @lucaapp/service-utils`
 
-This will connect your local sources for `@lucaapp/service-utils`.
-When making changes within the package, make sure to run the `build` target within `packages/service-utils/package.json` to have the changes available to backend web.
+This will connect your local sources for `@lucaapp/service-utils`. When making
+changes:
 
-After this preparations run `package-development` from `services/backend/package.json`.
-The following environment should be at least in place when running the target to make sure your local `backend` setup uses the proper endpoints:
+1. Run `yarn build` in `packages/service-utils` to compile changes
+2. Run `yarn package-development` in `services/backend` to test changes
+
+Required environment variables for local development:
 
 ```shell
 export DB_HOSTNAME=localhost
@@ -26,16 +33,34 @@ export KAFKA_BROKER=localhost:9094
 export REDIS_HOSTNAME=localhost
 ```
 
-It will utilize the linked package and run `backend` locally.
-Make sure your docker stack has at least `database`, `kafka` and `redis`, but *not* `backend` up and running.
+Ensure your docker stack has `database`, `kafka`, and `redis` running (but not
+`backend`).
+
+### Available Scripts
+
+- `yarn build` - Compile TypeScript to JavaScript
+- `yarn ts:check` - Type check without emitting files
+- `yarn lint` - Run ESLint
+- `yarn test` - Run tests with Vitest
+- `yarn test:coverage` - Run tests with coverage report
+- `yarn test:ci` - Run tests in CI environment
+- `yarn audit` - Run security audit (ignoring dev dependencies)
+
+### Publishing
 
-You should now be able to develop changes for `@lucaapp/service-utils`.
+The package is automatically published when changes are merged to `dev`. Follow
+[semantic-release](https://www.npmjs.com/package/semantic-release) conventions
+in commit messages to trigger appropriate versioning.
 
-#### Packaging
+### Dependencies
 
-Packaging of `@lucaapp/service-utils` will be automatically published, when run in `dev`.
-See `./gitlab-ci/publish[.template].yml` for reference.
+The package uses modern versions of key dependencies:
 
-Make sure to follow [semantic-release](https://www.npmjs.com/package/semantic-release) conventions when writing commit messages.
+- TypeScript 5.5.3
+- Node.js 18
+- Express 4.21.2
+- Sequelize 6.32.0
+- Zod 3.22.3
+- Vitest 3.0.5 for testing
 
-Depending on the used semantic-release indicators a new version of `@lucaapp/service-utils` will be made available and tagged within the luca-web repository.
+See `package.json` for a complete list of dependencies.

package/dist/lib/kafka/events/operatorLocationGroup.d.ts

@@ -0,0 +1,16 @@
+export declare enum OperatorRole {
+    Owner = "Owner",// level 6
+    Admin = "Admin",// level 5
+    Finance = "Finance",// level 4
+    Manager = "Manager",// level 3
+    Supervisor = "Supervisor",// level 2
+    Viewer = "Viewer"
+}
+export type OperatorLocationGroup = {
+    uuid: string;
+    operatorId: string;
+    locationGroupId: string;
+    role: OperatorRole;
+    createdAt: Date;
+    updatedAt: Date;
+};

package/dist/lib/kafka/events/operatorLocationGroup.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperatorRole = void 0;
+var OperatorRole;
+(function (OperatorRole) {
+    OperatorRole["Owner"] = "Owner";
+    OperatorRole["Admin"] = "Admin";
+    OperatorRole["Finance"] = "Finance";
+    OperatorRole["Manager"] = "Manager";
+    OperatorRole["Supervisor"] = "Supervisor";
+    OperatorRole["Viewer"] = "Viewer";
+})(OperatorRole || (exports.OperatorRole = OperatorRole = {}));

package/dist/lib/kafka/events/reservation.d.ts

@@ -5,4 +5,9 @@ export type Reservation = {
     startsAt: Date;
     createdAt: Date;
     updatedAt: Date;
+    tables?: Array<{
+        id: string;
+        internalNumber: number;
+        customName: string | null;
+    }>;
 };

package/dist/lib/money/sequelize/index.d.ts

@@ -0,0 +1 @@
+export * from './money';

package/dist/lib/money/sequelize/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./money"), exports);

package/dist/lib/money/sequelize/money.d.ts

@@ -0,0 +1,21 @@
+import { DataTypes } from 'sequelize';
+declare class MONEY extends DataTypes.ABSTRACT.prototype.constructor {
+    static key: string;
+    static warn: () => void;
+    key: string;
+    escape: boolean;
+    types: {
+        postgres: string[];
+        sqlite: string[];
+    };
+    static toSql(): string;
+    validate(value: unknown, options: unknown): boolean;
+    _sanitize(value: unknown): number;
+    static stringify(value: unknown): string;
+    static dialectTypes: string;
+    static parse(value: unknown): number;
+}
+export declare const ExtendedDataTypes: {
+    MONEY: typeof MONEY & (() => typeof MONEY);
+};
+export {};

package/dist/lib/money/sequelize/money.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtendedDataTypes = void 0;
+const sequelize_1 = require("sequelize");
+// Define the MONEY data type
+class MONEY extends sequelize_1.DataTypes.ABSTRACT.prototype.constructor {
+    constructor() {
+        super(...arguments);
+        this.key = MONEY.key;
+        // Optional: disable escaping after stringifier. Do this at your own risk, since this opens opportunity for SQL injections.
+        this.escape = false;
+        // Optional: map dialect datatype names (mandatory if not creating dialect-specific datatype classes as in the example below)
+        this.types = {
+            postgres: ['pg_new_type'],
+            sqlite: ['sqlite_new_type'],
+        };
+    }
+    // Mandatory: complete definition of the new type in the database
+    static toSql() {
+        return 'INTEGER(11) UNSIGNED ZEROFILL';
+    }
+    // Optional: validator function
+    validate(value, options) {
+        return typeof value === 'number' && !Number.isNaN(value);
+    }
+    // Optional: sanitizer
+    _sanitize(value) {
+        // Force all numbers to be positive
+        return value < 0 ? 0 : Math.round(value);
+    }
+    // Optional: value stringifier before sending to database
+    static stringify(value) {
+        return value.toString();
+    }
+    // Optional: parser for values received from the database
+    static parse(value) {
+        return Number.parseInt(value);
+    }
+}
+// Mandatory: set the type key
+MONEY.key = 'MONEY';
+MONEY.warn = () => { };
+MONEY.dialectTypes = 'test';
+// Create a new type that extends DataTypes and includes MONEY
+exports.ExtendedDataTypes = {
+    // ...DataTypes,
+    MONEY: sequelize_1.Utils.classToInvokable(MONEY),
+};
+// Export the extended DataTypes
+// export { ExtendedDataTypes as DataTypes };
+// // Type declaration merging
+// declare module 'sequelize' {
+//   interface DataTypes {
+//     MONEY: typeof MONEY;
+//   }
+// }

package/dist/types/pino.d.ts

@@ -0,0 +1,2 @@
+export type { Logger } from 'pino';
+export type { HttpLogger } from 'pino-http';

package/dist/types/pino.ded.d.ts

@@ -0,0 +1,2 @@
+export type { Logger } from 'pino';
+export type { HttpLogger } from 'pino-http';

package/dist/types/pino.ded.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/pino.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lucaapp/service-utils",
-  "version": "1.62.6",
+  "version": "1.64.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -20,14 +20,14 @@
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "6.1.0",
     "@hapi/boom": "^10.0.0",
-    "@sentry/node": "^9.3.0",
-    "@tsconfig/node18": "1.0.1",
+    "@sentry/node": "^9.10.1",
+    "@tsconfig/node22": "22.0.0",
     "@types/express": "4.17.15",
     "@types/express-serve-static-core": "^4.17.43",
-    "@types/node": "18.18.2",
+    "@types/node": "22.13.11",
     "@types/response-time": "^2.3.8",
     "@types/swagger-ui-express": "4.1.3",
-    "axios": "^1.7.4",
+    "axios": "^1.8.2",
     "busboy": "^1.6.0",
     "cls-rtracer": "^2.6.2",
     "express": "4.21.2",
@@ -47,41 +47,44 @@
     "swagger-ui-express": "5.0.1",
     "url-value-parser": "^2.2.0",
     "uuid": "^9.0.0",
-    "zod": "3.22.3"
+    "zod": "3.22.3",
+    "@apidevtools/swagger-parser": "10.0.3"
   },
   "devDependencies": {
-    "@types/busboy": "^1.5.3",
+    "@types/busboy": "^1.5.4",
     "@types/lodash": "^4.14.187",
     "@types/negotiator": "^0.6.1",
     "@types/pino-http": "5.8.4",
-    "@types/supertest": "2.0.11",
+    "@types/supertest": "2.0.16",
     "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^7.15.0",
     "@typescript-eslint/parser": "^7.15.0",
-    "@vitest/coverage-v8": "3.0.4",
-    "conventional-changelog-conventionalcommits": "^5.0.0",
+    "@vitest/coverage-v8": "3.1.1",
+    "conventional-changelog-conventionalcommits": "^8.0.0",
     "eslint": "8.57.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-vitest": "0.4.1",
-    "improved-yarn-audit": "^3.0.0",
+    "improved-yarn-audit": "^3.0.3",
     "prettier": "2.7.1",
-    "semantic-release": "^19.0.3",
-    "semantic-release-monorepo": "^7.0.5",
+    "semantic-release": "^19.0.5",
+    "semantic-release-monorepo": "^7.0.8",
     "supertest": "^6.3.3",
     "typescript": "5.5.3",
     "vite-tsconfig-paths": "4.3.2",
-    "vitest": "3.0.5"
+    "vitest": "3.1.1"
   },
   "resolutions": {
     "yaml": "2.2.2",
-    "semver": "7.5.2",
-    "follow-redirects": "1.15.6",
+    "semver": "7.7.1",
+    "follow-redirects": "1.15.9",
     "braces": "3.0.3",
-    "send": "0.19.0",
+    "send": "0.19.1",
     "rollup": "4.22.4",
-    "cookie": ">= 0.7.0",
+    "cookie": ">= 1.0.2",
     "string-width": "4.2.3",
     "@types/express": "4.17.15",
-    "esbuild": "^0.25.0"
+    "esbuild": "^0.25.5",
+    "axios": "^1.8.2",
+    "vite": "6.2.5"
   }
 }