@freshpointcz/fresh-core 0.0.14 → 0.0.15

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import dayjs, { Dayjs } from 'dayjs';
 import { Logger } from 'winston';
-import { BaseEntity, ColumnOptions, Repository, DataSourceOptions } from 'typeorm';
+import { BaseEntity, ColumnOptions, Repository, EntityTarget, EntityManager, DataSourceOptions } from 'typeorm';
 import { Job } from 'node-schedule';
 import * as eslint from 'eslint';
 import * as typescript_eslint_dist_compatibility_types from 'typescript-eslint/dist/compatibility-types';
@@ -291,7 +291,8 @@ declare enum LanguageCode {
 declare enum PaymentMethod {
     CODE = 0,
     CARD = 1,
-    NONE = 2
+    NONE = 2,
+    CREDIT = 3
 }
 
 declare enum TransactionType {
@@ -343,6 +344,8 @@ declare function TimestampColumn(options?: ColumnOptions): PropertyDecorator;
 
 declare abstract class FreshDao<T extends BaseEntity> {
     protected abstract repo: Repository<T>;
+    protected abstract entity: EntityTarget<T>;
+    protected getRepo(manager?: EntityManager, entity?: EntityTarget<T>): Repository<T>;
 }
 
 declare class Category extends FreshEntity {
@@ -360,7 +363,93 @@ declare class Product extends FreshEntity {
 declare class Subcategory extends FreshEntity {
 }
 
+/**
+ * Runtime validation for enum values.
+ * If a runtime enum object is provided, the value must match one of its values
+ * If no enum object is provided, this falls back to accepting `string | number`
+ *
+ * @example
+ * isEnumValue(TransactionType, 0) // true
+ * isEnumValue(TransactionType, 99) // false
+ * isEnumValue(undefined, 99) // true
+ * isEnumValue(undefined, "99") // true
+ */
+declare function isEnumValue<E extends Record<string, string | number>>(enumObj: E | undefined, v: unknown): v is E[keyof E];
+
+/**
+ * Non-null object typeguard
+ * @usage Use for narrowing `unknown` type and to check that a value is a non-null object
+ * @description
+ * WARNING: Arrays and functions are technically objects in JS,
+ * but this guard intentionally allows them only as plain objects
+ * via structural usage.
+ */
+declare function isObject(v: unknown): v is Record<string, unknown>;
+/**
+ * Wrapper around `Object.prototype.hasOwnProperty`.
+ * @usage Use this instead of `key in obj`
+ */
+declare function hasOwn(obj: Record<string, unknown>, key: string): boolean;
+
+/**
+ * Checks that a value is a finite number
+ *
+ * Rejects numbers like:
+ * - NaN
+ * - Infinity / -Infinity
+ *
+ * @usage numeric fields validation
+ */
+declare function isNumber(v: unknown): v is number;
+/**
+ * Checks that a value is a string
+ */
+declare function isString(v: unknown): v is string;
+/**
+ * Validates a numeric boolean flag represented as 0 or 1
+ */
+declare function isFlag01(v: unknown): v is 0 | 1;
+/**
+ * Checks that a value is a finite number within a given range
+ * By default, the range is inclusive on both ends
+ *
+ * @param v - Value to validate
+ * @param min - Minimum allowed value
+ * @param max - Maximum allowed value
+ * @param options - Range behavior configuration
+ * @param options.includeMin - Whether `min` is allowed (default: true)
+ * @param options.includeMax - Whether `max` is allowed (default: true)
+ *
+ * @returns `true` if the value is a finite number within the range
+ * @example
+ * isNumberInRange(5, 1, 10); // true
+ * isNumberInRange(1, 1, 10); // true
+ * isNumberInRange(1, 1, 10, { includeMin: false }); // false
+ * isNumberInRange(10, 1, 10, { includeMax: false }); // false
+ * isNumberInRange("5", 1, 10); // false
+ * isNumberInRange(NaN, 1, 10); // false
+ */
+declare function isNumberInRange(v: unknown, min: number, max: number, options?: {
+    includeMin?: boolean;
+    includeMax?: boolean;
+}): v is number;
+
 type Maybe<T> = T | null;
+/**
+ * Validates a value that may be `null` or given type
+ *
+ * WARNING:
+ * `undefined` is NOT accepted by this function.
+ * If you need `undefined` support, it must be handled
+ * before calling this guard or explicitly allowed elsewhere.
+ *
+ * @typeParam T - The underlying non-nullable type
+ * @param v - Value to validate
+ * @param inner - Typeguard function for the underlying type `T`
+ *
+ * @returns `true` if the value is `null` or satisfies the inner typeguard
+ */
+declare function isMaybe<T>(v: unknown, inner: (x: unknown) => x is T): v is Maybe<T>;
 
 declare abstract class DataHelper<T> {
     private _data?;
@@ -465,6 +554,8 @@ declare abstract class FreshJob<T = void> extends Singleton {
     abstract invoke(): T | Promise<T>;
 }
 
+type CardNumber = `${number}${number}${number}${number}`;
+
 declare class ApiError extends Error {
     private _statusCode;
     get statusCode(): number;
@@ -550,4 +641,4 @@ interface HealthCheckResult {
     };
 }
 
-export { AMOUNT_UNIT, ActionCommandCode, ApiError, Category, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, FreshDao, FreshEntity, FreshHyperEntity, FreshJob, FreshTranslationBase, type HealthCheckResult, HttpStatus, LanguageCode, Manufacturer, type Maybe, PaymentMethod, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, Product, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TimestampColumn, TransactionType, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, isValidCron, logger };
+export { AMOUNT_UNIT, ActionCommandCode, ApiError, type CardNumber, Category, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, FreshDao, FreshEntity, FreshHyperEntity, FreshJob, FreshTranslationBase, type HealthCheckResult, HttpStatus, LanguageCode, Manufacturer, type Maybe, PaymentMethod, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, Product, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TimestampColumn, TransactionType, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, hasOwn, isEnumValue, isFlag01, isMaybe, isNumber, isNumberInRange, isObject, isString, isValidCron, logger };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import dayjs, { Dayjs } from 'dayjs';
 import { Logger } from 'winston';
-import { BaseEntity, ColumnOptions, Repository, DataSourceOptions } from 'typeorm';
+import { BaseEntity, ColumnOptions, Repository, EntityTarget, EntityManager, DataSourceOptions } from 'typeorm';
 import { Job } from 'node-schedule';
 import * as eslint from 'eslint';
 import * as typescript_eslint_dist_compatibility_types from 'typescript-eslint/dist/compatibility-types';
@@ -291,7 +291,8 @@ declare enum LanguageCode {
 declare enum PaymentMethod {
     CODE = 0,
     CARD = 1,
-    NONE = 2
+    NONE = 2,
+    CREDIT = 3
 }
 
 declare enum TransactionType {
@@ -343,6 +344,8 @@ declare function TimestampColumn(options?: ColumnOptions): PropertyDecorator;
 
 declare abstract class FreshDao<T extends BaseEntity> {
     protected abstract repo: Repository<T>;
+    protected abstract entity: EntityTarget<T>;
+    protected getRepo(manager?: EntityManager, entity?: EntityTarget<T>): Repository<T>;
 }
 
 declare class Category extends FreshEntity {
@@ -360,7 +363,93 @@ declare class Product extends FreshEntity {
 declare class Subcategory extends FreshEntity {
 }
 
+/**
+ * Runtime validation for enum values.
+ * If a runtime enum object is provided, the value must match one of its values
+ * If no enum object is provided, this falls back to accepting `string | number`
+ *
+ * @example
+ * isEnumValue(TransactionType, 0) // true
+ * isEnumValue(TransactionType, 99) // false
+ * isEnumValue(undefined, 99) // true
+ * isEnumValue(undefined, "99") // true
+ */
+declare function isEnumValue<E extends Record<string, string | number>>(enumObj: E | undefined, v: unknown): v is E[keyof E];
+
+/**
+ * Non-null object typeguard
+ * @usage Use for narrowing `unknown` type and to check that a value is a non-null object
+ * @description
+ * WARNING: Arrays and functions are technically objects in JS,
+ * but this guard intentionally allows them only as plain objects
+ * via structural usage.
+ */
+declare function isObject(v: unknown): v is Record<string, unknown>;
+/**
+ * Wrapper around `Object.prototype.hasOwnProperty`.
+ * @usage Use this instead of `key in obj`
+ */
+declare function hasOwn(obj: Record<string, unknown>, key: string): boolean;
+
+/**
+ * Checks that a value is a finite number
+ *
+ * Rejects numbers like:
+ * - NaN
+ * - Infinity / -Infinity
+ *
+ * @usage numeric fields validation
+ */
+declare function isNumber(v: unknown): v is number;
+/**
+ * Checks that a value is a string
+ */
+declare function isString(v: unknown): v is string;
+/**
+ * Validates a numeric boolean flag represented as 0 or 1
+ */
+declare function isFlag01(v: unknown): v is 0 | 1;
+/**
+ * Checks that a value is a finite number within a given range
+ * By default, the range is inclusive on both ends
+ *
+ * @param v - Value to validate
+ * @param min - Minimum allowed value
+ * @param max - Maximum allowed value
+ * @param options - Range behavior configuration
+ * @param options.includeMin - Whether `min` is allowed (default: true)
+ * @param options.includeMax - Whether `max` is allowed (default: true)
+ *
+ * @returns `true` if the value is a finite number within the range
+ * @example
+ * isNumberInRange(5, 1, 10); // true
+ * isNumberInRange(1, 1, 10); // true
+ * isNumberInRange(1, 1, 10, { includeMin: false }); // false
+ * isNumberInRange(10, 1, 10, { includeMax: false }); // false
+ * isNumberInRange("5", 1, 10); // false
+ * isNumberInRange(NaN, 1, 10); // false
+ */
+declare function isNumberInRange(v: unknown, min: number, max: number, options?: {
+    includeMin?: boolean;
+    includeMax?: boolean;
+}): v is number;
+
 type Maybe<T> = T | null;
+/**
+ * Validates a value that may be `null` or given type
+ *
+ * WARNING:
+ * `undefined` is NOT accepted by this function.
+ * If you need `undefined` support, it must be handled
+ * before calling this guard or explicitly allowed elsewhere.
+ *
+ * @typeParam T - The underlying non-nullable type
+ * @param v - Value to validate
+ * @param inner - Typeguard function for the underlying type `T`
+ *
+ * @returns `true` if the value is `null` or satisfies the inner typeguard
+ */
+declare function isMaybe<T>(v: unknown, inner: (x: unknown) => x is T): v is Maybe<T>;
 
 declare abstract class DataHelper<T> {
     private _data?;
@@ -465,6 +554,8 @@ declare abstract class FreshJob<T = void> extends Singleton {
     abstract invoke(): T | Promise<T>;
 }
 
+type CardNumber = `${number}${number}${number}${number}`;
+
 declare class ApiError extends Error {
     private _statusCode;
     get statusCode(): number;
@@ -550,4 +641,4 @@ interface HealthCheckResult {
     };
 }
 
-export { AMOUNT_UNIT, ActionCommandCode, ApiError, Category, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, FreshDao, FreshEntity, FreshHyperEntity, FreshJob, FreshTranslationBase, type HealthCheckResult, HttpStatus, LanguageCode, Manufacturer, type Maybe, PaymentMethod, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, Product, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TimestampColumn, TransactionType, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, isValidCron, logger };
+export { AMOUNT_UNIT, ActionCommandCode, ApiError, type CardNumber, Category, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, FreshDao, FreshEntity, FreshHyperEntity, FreshJob, FreshTranslationBase, type HealthCheckResult, HttpStatus, LanguageCode, Manufacturer, type Maybe, PaymentMethod, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, Product, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TimestampColumn, TransactionType, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, hasOwn, isEnumValue, isFlag01, isMaybe, isNumber, isNumberInRange, isObject, isString, isValidCron, logger };

package/dist/index.js

@@ -452,6 +452,14 @@ __export(index_exports, {
   TransactionType: () => TransactionType,
   createDeferred: () => createDeferred,
   freshEslintConfig: () => eslint_config_default,
+  hasOwn: () => hasOwn,
+  isEnumValue: () => isEnumValue,
+  isFlag01: () => isFlag01,
+  isMaybe: () => isMaybe,
+  isNumber: () => isNumber,
+  isNumberInRange: () => isNumberInRange,
+  isObject: () => isObject,
+  isString: () => isString,
   isValidCron: () => isValidCron,
   logger: () => logger
 });
@@ -1140,6 +1148,7 @@ var PaymentMethod = /* @__PURE__ */ (function(PaymentMethod2) {
   PaymentMethod2[PaymentMethod2["CODE"] = 0] = "CODE";
   PaymentMethod2[PaymentMethod2["CARD"] = 1] = "CARD";
   PaymentMethod2[PaymentMethod2["NONE"] = 2] = "NONE";
+  PaymentMethod2[PaymentMethod2["CREDIT"] = 3] = "CREDIT";
   return PaymentMethod2;
 })({});
 
@@ -1198,6 +1207,9 @@ _ts_decorate3([
 
 // src/database/dao/fresh-dao.ts
 var _FreshDao = class _FreshDao {
+  getRepo(manager, entity = this.entity) {
+    return manager ? manager.getRepository(entity) : this.repo;
+  }
 };
 __name(_FreshDao, "FreshDao");
 var FreshDao = _FreshDao;
@@ -1286,6 +1298,56 @@ Subcategory = _ts_decorate8([
   (0, import_typeorm9.Entity)()
 ], Subcategory);
 
+// src/common/typeguards/enums.ts
+function isEnumValue(enumObj, v) {
+  if (!enumObj) {
+    return typeof v === "string" || typeof v === "number";
+  }
+  const values = new Set(Object.values(enumObj));
+  return (typeof v === "string" || typeof v === "number") && values.has(v);
+}
+__name(isEnumValue, "isEnumValue");
+
+// src/common/typeguards/objects.ts
+function isObject(v) {
+  return typeof v === "object" && v !== null;
+}
+__name(isObject, "isObject");
+function hasOwn(obj, key) {
+  return Object.prototype.hasOwnProperty.call(obj, key);
+}
+__name(hasOwn, "hasOwn");
+
+// src/common/typeguards/primitives.ts
+function isNumber(v) {
+  return typeof v === "number" && Number.isFinite(v);
+}
+__name(isNumber, "isNumber");
+function isString(v) {
+  return typeof v === "string";
+}
+__name(isString, "isString");
+function isFlag01(v) {
+  return v === 0 || v === 1;
+}
+__name(isFlag01, "isFlag01");
+function isNumberInRange(v, min, max, options) {
+  var _a, _b;
+  if (!isNumber(v)) {
+    return false;
+  }
+  const includeMin = (_a = options == null ? void 0 : options.includeMin) != null ? _a : true;
+  const includeMax = (_b = options == null ? void 0 : options.includeMax) != null ? _b : true;
+  if (includeMin ? v < min : v <= min) {
+    return false;
+  }
+  if (includeMax ? v > max : v >= max) {
+    return false;
+  }
+  return true;
+}
+__name(isNumberInRange, "isNumberInRange");
+
 // src/core/data-helper.ts
 var _DataHelper = class _DataHelper {
   constructor(startDataRetrieve = true, deviceIds) {
@@ -1459,6 +1521,12 @@ var _ApiError = class _ApiError extends Error {
 __name(_ApiError, "ApiError");
 var ApiError = _ApiError;
 
+// src/types/maybe-type.ts
+function isMaybe(v, inner) {
+  return v === null || inner(v);
+}
+__name(isMaybe, "isMaybe");
+
 // src/config/eslint-config.ts
 var import_typescript_eslint = __toESM(require("typescript-eslint"));
 var import_eslint_plugin_prettier = __toESM(require("eslint-plugin-prettier"));
@@ -1670,6 +1738,14 @@ var datasource_default = PG_DATA_SOURCE_OPTIONS;
   TransactionType,
   createDeferred,
   freshEslintConfig,
+  hasOwn,
+  isEnumValue,
+  isFlag01,
+  isMaybe,
+  isNumber,
+  isNumberInRange,
+  isObject,
+  isString,
   isValidCron,
   logger
 });