@vicin/sigil 3.4.0 → 4.0.0

package/CHANGELOG.md

@@ -1,255 +1,7 @@
-# Changelog
+# @vicin/sigil
 
-All notable changes to this project will be documented in this file.
+## 4.0.0
 
-## [3.4.0] - 2026-02-28
+### Major Changes
 
-### Changed
-
-- Updated internal logic to handle edge-cases
-- Edge cases part added to tests
-- Updated README.md
-
-### Added
-
-- `AttachSigil` / `attachSigil` which are `WithSigil` / `withSigil` renamed for clarity
-
-### Deprecated
-
-- `WithSigil` / `withSigil` renamed for clarity. old names will be removed in v4
-- `SigilLabelSet` / `getSigilLabelSet` methods to minimize api surface and bundle size as they are redundant (internall 'new Set(this.SigilLabelLineage)' only). will be removed in v4
-
-## [3.3.0] - 2026-02-27
-
-### Changed
-
-- Label registry now stores user defined labels only, and `getSigilLabels` has no `includeAuto` argument any more
-
-### Added
-
-- Options `skipLabelUniquenessCheck` is added to avoid false-positive HMR throws
-
-## [3.2.1] - 2026-02-27
-
-### Changed
-
-- Updated README.md
-
-## [3.2.0] - 2026-02-27
-
-### Added
-
-- `RECOMMENDED_LABEL_REGEX` is the same as `DEFAULT_LABEL_REGEX` but renamed for clarity
-- `getSigilLabels` to get registered sigil labels
-
-### Deprecated
-
-- `DEFAULT_LABEL_REGEX` is deprecated use `RECOMMENDED_LABEL_REGEX` instead, will be removed in v4
-
-## [3.1.4] - 2026-02-26
-
-### Changed
-
-- Updated description in `package.json`
-
-## [3.1.3] - 2026-02-26
-
-### Changed
-
-- Patched type tests where `sigil` should be imported as type only
-
-## [3.1.2] - 2026-02-26
-
-### Changed
-
-- Patched README.md
-
-### Added
-
-- `GetPrototype<T>` helper to get type of class instance in `protected` or `private` classes
-
-### Removed
-
-- `isSigilified` method in `Sigil` class as it's redundant and separate check function is present
-
-## [3.1.1] - 2026-02-25
-
-### Changed
-
-- Updated README.md
-
-## [3.1.0] - 2026-02-25
-
-### Added
-
-- `isExactType` is added to check for exact instances (children are ingored as well)
-
-### Removed
-
-- `SigilOptions.skipLabelInheritanceCheck` is removed.
-- `isOfTypeStrict` is removed.
-
-## [3.0.0] - 2026-02-24
-
-### Added
-
-- `sigil` symbol used for type-only nominal branding of classes
-
-### Changed
-
-- `__SIGIL_BRAND__` is classes replaced with `sigil` symbol
-
-### Removed
-
-- `withSigilTyped` is removed as library moved into manual branding
-
-### Breaking changes
-
-- `withSigilTyped` is removed as library moved into manual branding
-- `SigilBrandOf` is renamed to `SigilOf`
-- `UpdateSigilBrand` is renamed to `ExtendSigil`
-
-## [2.2.1] - 2026-02-23
-
-### Added
-
-- `SigilEffectiveLabel`/`getSigilEffectiveLabel()` which are last passed label for logging purposes.
-
-### Changed
-
-- Patched multiple bugs.
-- Updated defualt options, now `SigilOptions.autofillLabels` is `true` by default.
-
-## [2.1.0] - 2026-02-22
-
-### Changed
-
-- Changed name of `updateOptions` to be `updateSigilOptions`
-- Updated JSDOCs of multiple APIs
-
-## [2.0.3] - 2026-02-21
-
-- Patched types
-
-## [2.0.2] - 2026-02-21
-
-### Changed
-
-- Patched types
-
-## [2.0.1] - 2026-02-21
-
-### Removed
-
-- `updateOptions.devMarker`
-
-### Changed
-
-- Now dev checks are internal only
-
-## [2.0.0] - 2026-02-20
-
-### Breaking changes
-
-- All `SigilRegistry`options, methods and classes are removed
-
-## [1.3.0] - 2026-02-18
-
-### Added
-
-- `isOfType()` & `isOfTypeStrict()` now can be called from instances
-
-## [1.2.7] - 2026-02-13
-
-### Added
-
-- Support for `abstract` classes using `SigilifyAbstract` factory
-
-## [1.2.6] - 2026-02-11
-
-### Changed
-
-- Fixed type bug in 'isOfType'
-
-## [1.2.5] - 2026-02-10
-
-### Changed
-
-- Documentation updates (README)
-
-## [1.2.4] - 2026-02-10
-
-**Stable release**
-
-### Changed
-
-- Documentation updates (README)
-
-## [1.2.3] - 2026-02-10
-
-### Changed
-
-- Documentation updates (README)
-
-## [1.2.2] - 2026-02-10
-
-### Changed
-
-- Documentation updates (README and JSDOCs)
-
-## [1.2.1] - 2026-02-10
-
-### Added
-
-- Re-introduced 'ISigilStatic' and 'ISigilIntance' types
-
-## [1.2.0] - 2026-02-10
-
-### Added
-
-- Added new typing method (decorator with brand field update)
-- Added type to exported base classes
-
-### Changed
-
-- Simplified types
-- Fix type bug in `Sigilify`
-- Updated `Sigilify` to return typed class directly
-- Fix options propagation bug
-
-### Deprecated
-
-- `typed` higher order function as it has no use-case anymore
-- `typed` will be removed in v2.0.0
-
-## [1.1.1] - 2026-02-09
-
-### Changed
-
-- Improved package build outputs to make sure it support multiple JavaScript module systems (ESM and CommonJS).
-- Updated build configuration to ensure correct usage in different runtimes and bundlers.
-
-## [1.1.0] - 2026-02-08
-
-### Added
-
-- `SigilRegistry` class
-- `getActiveRegistry()` helper
-- Registry-related options in `updateOptions`
-
-### Deprecated
-
-- `REGISTRY` constant (use `SigilRegistry` instead)
-- `REGISTRY` will be removed in v2.0.0.
-
-## [1.0.1] - 2026-02-07
-
-### Changed
-
-- Documentation updates (README)
-
-## [1.0.0] - 2026-02-07
-
-### Added
-
-- Initial release with core features
+- 08a7dbf: Moved toward minimal set with updated APIs

package/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing to Sigil
+
+Thanks for your interest! We welcome contributions.
+
+## How to Contribute
+
+- **Issues**: Report bugs or suggest features via GitHub Issues. Use templates if possible.
+- **Pull Requests (PRs)**:
+  1. Fork the repo and create a branch: `git checkout -b feature/my-new-feature`.
+  2. Commit changes: Follow conventional commits (e.g., "feat: add new ValueObject").
+  3. Push and open a PR against `develop` branch.
+  4. Describe changes, link to issues, and add tests.
+- **Code Style**: Use Prettier/ESLint.
+- **Tests**: All PRs must pass unit tests.
+- **License**: By contributing, you agree to MIT license.
+
+## Setup
+
+- Clone: `git clone https://github.com/ZiadTaha62/vicin-packages.git`
+- Install: `pnpm install`
+- Build: `pnpm run build --filter @vicin/sigil`
+- Test: `pnpm run test --filter @vicin/sigil` coverage should be `>90%` of lines.
+
+Questions? Open an issue!

package/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2026 Ziad Taha and contributors
+MIT License
+
+Copyright (c) 2026 Ziad Taha and vicin contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: