@decaf-ts/for-typeorm 0.0.23 → 0.0.24

package/LICENSE.md

@@ -1,22 +1,164 @@
-MIT License
+Mozilla Public License Version 2.0
 
-Copyright (c) 2025 Tiago Venceslau and Contributors
+1. Definitions
 
-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:
+"Contributor"
+    means each individual or legal entity that creates, contributes to the
+    creation of, or owns Covered Software.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+"Contributor Version"
+    means the combination of the Contributions of others (if any) used by a
+    Contributor and that particular Contributor's Contribution.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+"Covered Software"
+    means Source Code Form to which the initial Contributor has attached the
+    notice in Exhibit A, the Executable Form of such Source Code Form, and
+    Modifications of such Source Code Form.
 
+"Executable Form"
+    means any form of the work other than Source Code Form.
+
+"Larger Work"
+    means a work which combines Covered Software with other material, in a
+    separate file or files, that is not Covered Software.
+
+"License"
+    means this document.
+
+"Licensable"
+    means having the right to grant, to the maximum extent possible, whether
+    at the time of the making or afterwards, any and all of the rights
+    conveyed by this License.
+
+"Modifications"
+    means any addition to or deletion from the contents of Covered Software
+    or any new file that contains Covered Software.
+
+"Patent Claims"
+    means any patent claim(s), now owned or hereafter acquired, including
+    without limitation, method, process, and apparatus claims, in any patent
+    Licensable by grantor.
+
+"Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU Lesser
+    General Public License, Version 2.1, the European Union Public License 1.1,
+    or any subsequent versions of those licenses that are designated as a
+    Secondary License in the notice in Exhibit A.
+
+"Source Code Form"
+    means the form of the work preferred for making modifications.
+
+"You" (or "Your")
+    means an individual or a legal entity exercising rights under, and
+    complying with all of the terms of, this License. For legal entities,
+    "You" includes any entity that controls, is controlled by, or is under
+    common control with You. For purposes of this definition, "control"
+    means (a) the power, direct or indirect, to cause the direction or
+    management of such entity, whether by contract or otherwise, or (b)
+    ownership of more than fifty percent (50%) of the outstanding shares or
+    beneficial ownership of such entity.
+
+2. License Grants and Conditions
+
+Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive
+license:
+
+  a. under intellectual property rights (other than patent or trademark)
+     Licensable by such Contributor to use, reproduce, make available,
+     modify, display, perform, distribute, and otherwise exploit its
+     Contributions, either on an exclusive or non-exclusive basis; and
+
+  b. under Patent Claims to make, use, sell, offer for sale, have made,
+     import, and otherwise transfer the Contribution(s) of such
+     Contributor, if any, in the Covered Software.
+
+This license does not grant rights to any trademarks, service marks, or logos
+of any Contributor (except as may be necessary to comply with the notice
+requirements in Section 3.4).
+
+3. Distribution Obligations
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under the
+terms of this License. You must inform recipients that the Source Code Form
+of the Covered Software is governed by the terms of this License and include
+a copy of this License in or with the Source Code Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+  a. such Covered Software must also be made available in Source Code Form,
+     as described in Section 3.1, and You must inform recipients of the
+     Executable Form how to obtain a complete copy of the corresponding
+     Source Code Form in a reasonable manner on or through a medium
+     customarily used for software exchange; and
+
+  b. You may distribute the Executable Form under terms of your choice,
+     provided that You do not attempt to limit or alter the recipients'
+     rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a work that combines Covered Software with
+other material, and distribute the Larger Work as a single product. In such
+case, the Covered Software must still be made available under this License
+and must include the notices described in Exhibit A relating to the Covered
+Software.
+
+3.4. Notices
+
+You must cause each file that You distribute containing Covered Software to
+carry the legal notices described in Exhibit A.
+
+4. Incompatible With Secondary Licenses
+
+If the Covered Software is made available under the terms of this License
+and also made available under the terms of a Secondary License, then the
+terms of the Secondary License apply to the Covered Software in addition to
+this License to the extent the Secondary License grants additional
+permissions. If the Covered Software is not made available under a Secondary
+License, then this License governs its use.
+
+5. Disclaimer of Warranty
+
+Covered Software is provided "as is" without warranty of any kind, either
+express or implied, including, but not limited to, the implied warranties of
+merchantability, fitness for a particular purpose, and noninfringement.
+
+6. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including
+negligence), contract, or otherwise, unless required by applicable law (such
+as deliberate and grossly negligent acts) or agreed to in writing, shall any
+Contributor be liable to You for damages, including any direct, indirect,
+special, incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the Covered
+Software (including but not limited to damages for loss of goodwill, work
+stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the
+possibility of such damages.
+
+7. Termination
+
+This License and the rights granted hereunder will terminate automatically
+if You fail to comply with terms of this License and do not cure such
+breach within thirty (30) days of becoming aware of the breach.
+
+8. Miscellaneous
+
+This License constitutes the entire agreement between the parties with
+respect to the subject matter hereof. If any provision of this License is
+held to be unenforceable, that provision shall be reformed only to the
+extent necessary to make it enforceable. The headings are for convenience
+only and do not affect the interpretation.
+
+Exhibit A - Source Code Form License Notice
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+  Copyright (c) 2025 Tiago Venceslau and Contributors

package/README.md

@@ -1,3 +1,5 @@
+![Banner](./workdocs/assets/decaf-logo.svg)
+
 # Decaf.ts — TypeORM Integration
 
 A thin, focused TypeORM-backed adapter that plugs Decaf.ts models, repositories and query primitives into relational databases via TypeORM, keeping the same API you use across other Decaf adapters. It provides:
@@ -7,7 +9,6 @@ A thin, focused TypeORM-backed adapter that plugs Decaf.ts models, repositories
 - Decorator wiring: automatically wires Decaf decorators to TypeORM metadata on import (no need to use TypeORM decorators directly)
 - Utilities and types: constants, operator translation, raw Postgres types, and small helpers like convertJsRegexToPostgres
 
-
 ![Licence](https://img.shields.io/github/license/decaf-ts/ts-workspace.svg?style=plastic)
 ![GitHub language count](https://img.shields.io/github/languages/count/decaf-ts/ts-workspace?style=plastic)
 ![GitHub top language](https://img.shields.io/github/languages/top/decaf-ts/ts-workspace?style=plastic)
@@ -31,6 +32,9 @@ A thin, focused TypeORM-backed adapter that plugs Decaf.ts models, repositories
 
 Documentation available [here](https://decaf-ts.github.io/ts-workspace/)
 
+Minimal size: 12.3 KB kb gzipped
+
+
 # Decaf.ts for TypeORM — Detailed Description
 
 Decaf.ts for TypeORM provides a complete implementation of Decaf.ts' data access abstractions backed by a TypeORM DataSource. It bridges Decaf models, repositories, and query primitives with TypeORM's ORM facilities, while keeping a consistent API across different database adapters in the Decaf.ts ecosystem.
@@ -630,6 +634,24 @@ The TypeORM adapter wires Decaf decorators into TypeORM metadata automatically o
 | @index(directionsOrName?, compositionsOrName?) | @Index()                                                                                                                           | Single or composite indexes are registered; when compositions are present, Index([prop, ...compositions]). |
 
 
+## Coding Principles
+
+- group similar functionality in folders (analog to namespaces but without any namespace declaration)
+- one class per file;
+- one interface per file (unless interface is just used as a type);
+- group types as other interfaces in a types.ts file per folder;
+- group constants or enums in a constants.ts file per folder;
+- group decorators in a decorators.ts file per folder;
+- always import from the specific file, never from a folder or index file (exceptions for dependencies on other packages);
+- prefer the usage of established design patters where applicable:
+  - Singleton (can be an anti-pattern. use with care);
+  - factory;
+  - observer;
+  - strategy;
+  - builder;
+  - etc;
+
+
 ### Related
 
 [![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=decaf-ts&repo=ts-workspace)](https://github.com/decaf-ts/ts-workspace)
@@ -666,6 +688,6 @@ So if you can, if this project in any way. either by learning something or simpl
 
 ## License
 
-This project is released under the [MIT License](./LICENSE.md).
+This project is released under the [Mozilla Public License 2.0](./LICENSE.md).
 
 By developers, for developers...