@schorts/shared-kernel 4.2.0 → 4.2.2

package/CHANGELOG

@@ -1,357 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [4.2.0] - 2025-10-21
-
-### Added
-
-- Added `ConsoleTelemetry` for dev or test environments.
-
-## [4.1.2] - 2025-10-21
-
-### Changed
-
-- Allow any params in the `init` method of the `Telemetry` and `Subscription`.
-
-## [4.1.1] - 2025-10-21
-
-### Added
-
-- Added telemetry module to the main entry point.
-
-## [4.1.0] - 2025-10-21
-
-### Added
-
-- Added `Telemetry`.
-
-## [4.0.0] - 2025-10-21
-
-### Added
-
-- Added `ABAC` support to `RBACPolicy`.
-
-## [3.1.5] - 2025-10-18
-
-### Fixed
-
-- Fixed `greater_than_or_equal` validation in the `FloatValue`.
-
-## [3.1.4] - 2025-10-18
-
-### Added
-
-- Added `converters` module.
-
-## [3.1.3] - 2025-10-18
-
-### Added
-
-- Added support for `meta` field on the body for the `create` method of the `JSONAPIConnector`.
-
-## [3.1.2] - 2025-10-18
-
-### Added
-
-- Added support for arrays in the `create` method of the `JSONAPIConnector`.
-
-## [3.1.1] - 2025-10-16
-
-### Added
-
-- Added `in-memory` implementation to the `state-manager` module.
-
-## [3.1.0] - 2025-10-16
-
-### Added
-
-- Added `pub-sub` module.
-
-## [3.0.0] - 2025-10-15
-
-### Changed
-
-- Update how filters are stored in the `Criteria` to allow multiple filters over one field.
-
-## [2.6.0] - 2025-10-14
-
-### Added
-
-- Added `countBy` to `DAO`.
-
-## [2.5.9] - 2025-10-14
-
-### Fixed
-
-- `JSONAPIErrors` was never thrown in the `JSONAPIConnector` due to a missing `await`.
-
-## [2.5.8] - 2025-10-14
-
-### Fixed
-
-- Remove `Object.freeze` from `IntegerValue` and `FloatValue` to prevent errors when assigning the `attributeName` on subclasses.
-
-## [2.5.7] - 2025-10-13
-
-### Added
-
-- Added `ObjectValue`.
-
-## [2.5.6] - 2025-10-13
-
-### Added
-
-- Added `min` and `max` to `FloatValue`.
-
-## [2.5.5] - 2025-10-13
-
-### Added
-
-- Added `greater_than_or_equal` and `less_than_or_equal` to `rule`.
-
-## [2.5.4] - 2025-10-13
-
-### Added
-
-- Added `rule` function to avoid the use of `const` when defining the schema on the `ArrayValue`.
-
-## [2.5.3] - 2025-10-13
-
-### Added
-
-- Added `ArrayValue` to value-objects.
-
-## [2.5.2] - 2025-10-13
-
-### Changed
-
-- Allow `DateValue` to be optional.
-
-## [2.5.1] - 2025-10-13
-
-### Changed
-
-- `toPrimitives` method from `DomainEvent` now is defined in the abstract class. In future versions the `DomainEventRegistry` will be updated to handle the transformation of values like date/string and preserve it between conversions.
-
-## [2.5.0] - 2025-10-12
-
-### Added
-
-_ Added `event-bus` with `in-memory` implementations.
-
-## [2.4.2] - 2025-10-12
-
-### Fixed
-
-- Add `id` param to `create` method in the `JSONAPIConnector`.
-
-## [2.4.1] - 2025-10-12
-
-### Fixed
-
-- Added missed export for `JSONAPIErrors`.
-
-## [2.4.0] - 2025-10-11
-
-### Changed
-
-- Now the `JSONAPIConnector` throws a `JSONAPIErrors` exception instead of a generic `HTTPException`.
-
-## [2.3.4] - 2025-10-11
-
-### Changed
-
-- Allow partial attributes in the `create` and `update` methods of the `JSONAPIConnector`.
-
-## [2.3.3] - 2025-10-11
-
-### Added
-
-- Added `ValueNotValid` exception.
-
-## [2.3.2] - 2025-10-11
-
-### Added
-
-- Added `NotAuthorized` exception.
-
-## [2.3.1] - 2025-10-11
-
-### Changed
-
-- `userID` now is protected in the `RBACPolicy`.
-
-## [2.3.0] - 2025-10-10
-
-### Added
-
-- Added `RBAC` module.
-
-## [2.2.4] - 2025-10-10
-
-### Changed
-
-- Remove `Optional` param in the `EnumValue`. Instead allow null values in the `allowedTypes` array.
-
-## [2.2.3] - 2025-10-10
-
-### Changed
-
-- Allow `optional` param in the `EnumValue`.
-
-## [2.2.2] - 2025-10-10
-
-### Added
-
-- Added `FloatValue` to value-objects.
-
-## [2.2.1] - 2025-10-10
-
-### Added
-
-- Added `DateValue` to value-objects.
-
-## [2.2.0] - 2025-10-09
-
-### Changed
-
-- Now the `FetchHTTPProvider` returns the body of the request even on errors to handle JSON/API errors better.
-
-## [2.0.1]
-
-### Added
-
-- Added `BooleanValue`.
-
-## [2.0.0]
-
-### Changed
-
-- Rename method `currentUser` to `getCurrentUser` on the `AuthProvider` interface.
-
-## [1.3.2]
-
-### Changed
-
-- Now the `.authenticate` method from `AuthProvider` should return the token to remove responsabilities from it. A `AuthManager` should be implemented instead in case of future needs.
-
-## [1.3.1] - 2025-10-04
-
-### Added
-
-- Added `ValuesNotValid` exception to have a central error for value objects.
-
-## [1.3.0] - 2025-10-04
-
-### Added
-
-- Added `Result` to have more controlled results in application services.
-
-### Fixed
-
-- Added missed exports for `i18n` module. 
-
-## [1.2.3] - 2025-10-03
-
-### Changed
-
-- Added to constructor of the `FetchHTTPProvider` the possibility to receive a function to fetch the `Authorization`.
-
-## [1.2.2] - 2025-10-03
-
-### Added
-
-- Added implementation of the state manager from the session storage.
-
-### Changed
-
-- `FetchHTTPProvider` now supports the `headers` options.
-
-## [1.2.1] - 2025-10-03
-
-### Changed
-
-- `FetchHTTPProvider` now supports the `credentials` options.
-
-## [1.2.0] - 2025-10-02
-
-### Added
-
-- Added `i18n` support via `TranslationResolver`.
-
-## [1.1.5] - 2025-10-01
-
-### Changed
-
-- Now the `BaseModel` is more flexible to avoid typing issues in the `fromPrimitives` method.
-
-## [1.1.4] - 2025-10-01
-
-### Added
-
-- Added support for `CommonJS`.
-
-## [1.1.3] - 2025-10-01
-
-### Added
-
-- Added root entry point. Now you can import everything from `@schorts/shared-kernel` instead of having to choose an specific module. Example:  `@schorts/shared-kernel/auth`.
-
-## [1.1.2] - 2025-09-30
-
-### Changed
-
-- Now the `DAO` actions like `create`, `update` and `delete` can receive a `UnitOfWork`.
-
-## [1.1.1] - 2025-09-30
-
-### Added
-
-- Added `RegisterEntity` decorator to only decorate the entity to add it to the `EntityRegistry`.
-
-## [1.1.0] - 2025-09-30
-
-### Changed
-
-- Now the `ValueObject` for ID property on `Entity` is required.
-
-### Added
-
-- Added `EntityRegistry` to dynamically instantiate entities in the DAO implementation.
-
-## [1.0.5] - 2025-09-30
-
-### Added
-
-- Introduce `DAO` concept for a related package with a `Firestore` implementation.
-- Introduce `UnitOfWOrk` concept for a related package with a `Firestore` implementation.
-
-## [1.0.4] - 2025-09-30
-
-### Fixed
-
-- Add `dist` folder to the repo and NPM package.
-
-## [1.0.3] - 2025-09-30
-
-### Added
-
-- This CHANGELOG file to keep track of the relevant changes.
-
-### Changed
-
-- Removed indirect dependencies from the `package.json`.
-
-[1.2.0]: https://github.com/schorts99/shared-kernel/compare/v1.2.4...v1.2.0
-[1.1.4]: https://github.com/schorts99/shared-kernel/compare/v1.1.3...v1.1.4
-[1.1.3]: https://github.com/schorts99/shared-kernel/compare/v1.1.2...v1.1.3
-[1.1.2]: https://github.com/schorts99/shared-kernel/compare/v1.1.1...v1.1.2
-[1.1.1]: https://github.com/schorts99/shared-kernel/compare/v1.1.0...v1.1.1
-[1.1.0]: https://github.com/schorts99/shared-kernel/compare/v1.0.5...v1.1.0
-[1.0.5]: https://github.com/schorts99/shared-kernel/compare/v1.0.4...v0.0.5
-[1.0.4]: https://github.com/schorts99/shared-kernel/compare/v1.0.3...v0.0.4
-[1.0.3]: https://github.com/schorts99/shared-kernel/releases/tag/v1.0.3

package/__tests__/auth/auth-provider.test.ts

@@ -1,50 +0,0 @@
-import { expectTypeOf } from "expect-type";
-
-import { AuthProvider } from "../../src/auth";
-import { Entity } from "../../src/entities";
-import { UUIDValue } from "../../src/value-objects";
-
-type Model = {
-  id: string;
-  name: string;
-};
-
-class IDValue extends UUIDValue {
-  attributeName = "ID";
-}
-
-class TestUser extends Entity<IDValue, Model> {
-  toPrimitives(): Model {
-    return {
-      id: this.id.toString(),
-      name: "test",
-    };
-  }
-}
-
-describe('AuthProvider', () => {
-  it('should declare an "authenticate" method', () => {
-    expectTypeOf<AuthProvider<TestUser>['authenticate']>().toBeFunction();
-    expectTypeOf<AuthProvider<TestUser>['authenticate']>().returns.toEqualTypeOf<Promise<void>>();
-  });
-
-  it('should declare a "logout" method', () => {
-    expectTypeOf<AuthProvider<TestUser>['logout']>().toBeFunction();
-    expectTypeOf<AuthProvider<TestUser >['logout']>().returns.toEqualTypeOf<Promise<void>>();
-  });
-
-  it('should declare a "isAuthenticated" method', () => {
-    expectTypeOf<AuthProvider<TestUser>['isAuthenticated']>().toBeFunction();
-    expectTypeOf<AuthProvider<TestUser>['isAuthenticated']>().returns.toEqualTypeOf<Promise<boolean>>();
-  });
-
-  it('should declare a "currentUser" method', () => {
-    expectTypeOf<AuthProvider<TestUser>['currentUser']>().toBeFunction();
-    expectTypeOf<AuthProvider<TestUser>['currentUser']>().returns.toEqualTypeOf<Promise<TestUser  | null>>();
-  });
-
-  it('should declare a "onAuthChange" method', () => {
-    expectTypeOf<AuthProvider<TestUser>['onAuthChange']>().toBeFunction();
-    expectTypeOf<AuthProvider<TestUser>['onAuthChange']>().returns.toEqualTypeOf<() => void>();
-  });
-});

package/__tests__/auth/require-auth.decorator.test.ts

@@ -1,88 +0,0 @@
-import { RequireAuth, NotAuthenticated } from '../../src/auth';
-
-class FakeAuthProvider {
-  constructor(private authenticated: boolean) {}
-  async isAuthenticated() {
-    return this.authenticated;
-  }
-}
-
-class TestService {
-  authProvider: FakeAuthProvider;
-
-  constructor(authenticated: boolean) {
-    this.authProvider = new FakeAuthProvider(authenticated);
-  }
-
-  async securedMethod(): Promise<string> {
-    return 'should not reach';
-  }
-}
-
-describe('RequireAuth decorator (manual application)', () => {
-  it('should throw NotAuthenticated when not authenticated and no onFail', async () => {
-    const service = new TestService(false);
-    const originalMethod = service.securedMethod;
-    const decorated = RequireAuth()(originalMethod, {
-      kind: 'method',
-      name: 'securedMethod',
-      access: { has: () => true, get: () => originalMethod },
-      static: false,
-      private: false,
-      addInitializer: () => {},
-      metadata: {
-        get: () => undefined,
-        set: () => {},
-      },
-    });
-    const wrappedMethod = typeof decorated === 'function' ? decorated : decorated?.value;
-    service.securedMethod = wrappedMethod.bind(service);
-
-    await expect(service.securedMethod()).rejects.toThrow(NotAuthenticated);
-  });
-
-  it('should return fallback value when not authenticated and onFail is provided', async () => {
-    const service = new TestService(false);
-    const fallback = () => 'fallback';
-    const originalMethod = service.securedMethod;
-    const decorated = RequireAuth(fallback)(originalMethod, {
-      kind: 'method',
-      name: 'securedMethod',
-      access: { has: () => true, get: () => originalMethod },
-      static: false,
-      private: false,
-      addInitializer: () => {},
-      metadata: {
-        get: () => undefined,
-        set: () => {},
-      },
-    });
-    const wrappedMethod = typeof decorated === 'function' ? decorated : decorated?.value;
-    service.securedMethod = wrappedMethod.bind(service);
-    const result = await service.securedMethod();
-
-    expect(result).toBe('fallback');
-  });
-
-  it('should call original method when authenticated', async () => {
-    const service = new TestService(true);
-    const originalMethod = service.securedMethod;
-    const decorated = RequireAuth()(originalMethod, {
-      kind: 'method',
-      name: 'securedMethod',
-      access: { has: () => true, get: () => originalMethod },
-      static: false,
-      private: false,
-      addInitializer: () => {},
-      metadata: {
-        get: () => undefined,
-        set: () => {},
-      },
-    });
-    const wrappedMethod = typeof decorated === 'function' ? decorated : decorated?.value;
-    service.securedMethod = wrappedMethod.bind(service);
-    const result = await service.securedMethod();
-
-    expect(result).toBe('should not reach');
-  });
-});

package/__tests__/criteria/criteria.test.ts

@@ -1,159 +0,0 @@
-import { expectTypeOf } from "expect-type";
-
-import {
-  Criteria,
-  FilterCriterion,
-  Order,
-  Operator,
-  Direction,
-  PaginationNotValid,
-  OffsetNotValid,
-  LimitNotValid,
-} from "../../src/criteria";
-
-describe('Criteria', () => {
-  describe('filters', () => {
-    it('should be defined', () => {
-      expectTypeOf<Criteria>().toHaveProperty("filters");
-    });
-
-    it('should be of type Record<string, FilterCriterion>', () => {
-      expectTypeOf<Criteria["filters"]>().toEqualTypeOf<Record<string, FilterCriterion>>();
-    });
-
-    it('should be empty', () => {
-      const criteria = new Criteria();
-      const filters = criteria.filters;
-      const filterKeys = Object.keys(filters);
-
-      expect(filterKeys).toHaveLength(0);
-    });
-  });
-
-  describe('orders', () => {
-    it('should be defined', () => {
-      expectTypeOf<Criteria>().toHaveProperty("orders");
-    });
-
-    it('should be of type Array<Order>', () => {
-      expectTypeOf<Criteria["orders"]>().toEqualTypeOf<Array<Order>>();
-    });
-
-    it('should be empty', () => {
-      const criteria = new Criteria();
-      const orders = criteria.orders;
-
-      expect(orders).toHaveLength(0);
-    });
-  });
-
-  it('should have a "limit" property of type number or undefined', () => {
-    expectTypeOf<Criteria>().toHaveProperty("limit");
-    expectTypeOf<Criteria["limit"]>().toEqualTypeOf<number | undefined>();
-  });
-
-  it('should have a "offset" property of type number or undefined', () => {
-    expectTypeOf<Criteria>().toHaveProperty("offset");
-    expectTypeOf<Criteria["offset"]>().toEqualTypeOf<number | undefined>();
-  });
-
-  describe('#where', () => {
-    it('should receive field, operator and value', () => {
-      expectTypeOf<Criteria["where"]>().parameters.toEqualTypeOf<[string, Operator, any]>();
-    });
-
-    it('should return the same instance', () => {
-      const criteria = new Criteria();
-      const result = criteria.where('field', 'EQUAL', 'value');
-
-      expect(result).toEqual(criteria);
-    });
-
-    it('should add the filter to the "filters" property', () => {
-      const criteria = new Criteria();
-      const result = criteria.where('field', 'EQUAL', 'value');
-      const filters = result.filters;
-      const expectedFilters = { field: { value: "value", operator: "EQUAL" } };
-
-      expect(filters["field"]).toBeDefined();
-      expect(filters).toEqual(expectedFilters);
-    });
-  });
-
-  describe('#orderBy', () => {
-    it('should receive field and direction', () => {
-      expectTypeOf<Criteria["orderBy"]>().parameters.toEqualTypeOf<[string, Direction?]>();
-    });
-
-    it('should return the same instance', () => {
-      const criteria = new Criteria();
-      const result = criteria.orderBy('field', 'DESC');
-
-      expect(result).toEqual(criteria);
-    });
-
-    it('should add the order to the "orders" property', () => {
-      const criteria = new Criteria();
-      const result = criteria.orderBy("field", "DESC");
-      const orders = result.orders;
-      const expectedOrders = [{ field: "field", direction: "DESC" }];
-
-      expect(orders).toHaveLength(1);
-      expect(orders).toEqual(expectedOrders);
-    });
-  });
-
-  describe('#limitResults', () => {
-    it('should receive a number', () => {
-      expectTypeOf<Criteria["limitResults"]>().parameters.toEqualTypeOf<[number]>();
-    });
-
-    it('should return the same instance', () => {
-      const criteria = new Criteria();
-      const result = criteria.limitResults(1);
-
-      expect(result).toEqual(criteria);
-    });
-
-    it('should assign the value to the "limit" property', () => {
-      const criteria = new Criteria();
-      const limit = 1;
-      const result = criteria.limitResults(limit);
-
-      expect(result.limit).toEqual(limit);
-    });
-
-    it('should throw an LimitNotValid exception if value is less than 1', () => {
-      const criteria = new Criteria();
-
-      expect(() => criteria.limitResults(0)).toThrow(LimitNotValid);
-    });
-  });
-
-  describe('#offsetResults', () => {
-    it('should receive a number', () => {
-      expectTypeOf<Criteria["offsetResults"]>().parameters.toEqualTypeOf<[number]>();
-    });
-
-    it('should return the same instance', () => {
-      const criteria = new Criteria();
-      const result = criteria.offsetResults(1);
-
-      expect(result).toEqual(criteria);
-    });
-
-    it('should assign the value to the "offset" property', () => {
-      const criteria = new Criteria();
-      const offset = 1;
-      const result = criteria.offsetResults(offset);
-
-      expect(result.offset).toEqual(offset);
-    });
-
-    it('should throw an OffsetNotValid exception if value is less than 1', () => {
-      const criteria = new Criteria();
-
-      expect(() => criteria.offsetResults(0)).toThrow(OffsetNotValid);
-    });
-  });
-});

package/__tests__/criteria/direction.test.ts

@@ -1,11 +0,0 @@
-import { expectTypeOf } from "expect-type";
-
-import { Direction } from "../../src/criteria";
-
-type ExpectedDirection = "ASC" | "DESC";
-
-describe('Direction', () => {
-  it('should match the expected type', () => {
-    expectTypeOf<Direction>().toEqualTypeOf<ExpectedDirection>();
-  });
-});

package/__tests__/criteria/filter-criterion.test.ts

@@ -1,15 +0,0 @@
-import { expectTypeOf } from "expect-type";
-
-import { FilterCriterion, Operator } from "../../src/criteria";
-
-type ExpectedFilterCriterion = {
-  value: any;
-  operator: Operator;
-}
-
-describe('FilterCriterion', () => {
-  it('should match the expected type', () => {
-    expectTypeOf<FilterCriterion>().toEqualTypeOf<ExpectedFilterCriterion>();
-  });
-});
-

package/__tests__/criteria/operator.test.ts

@@ -1,22 +0,0 @@
-import { expectTypeOf } from "expect-type";
-
-import { Operator } from "../../src/criteria";
-
-type ExpectedOperator =
-  | "EQUAL"
-  | "GREATER_THAN"
-  | "LESS_THAN"
-  | "GREATER_THAN_OR_EQUAL"
-  | "LESS_THAN_OR_EQUAL"
-  | "NOT_EQUAL"
-  | "IN"
-  | "NOT_IN"
-  | "LIKE"
-  | "BETWEEN"
-  | "GEO_RADIUS";
-
-describe('Operator', () => {
-  it('should match the expected type', () => {
-    expectTypeOf<Operator>().toEqualTypeOf<ExpectedOperator>();
-  });
-});