masquerade-orm 0.1.1 → 0.8.0

package/README.md

@@ -1,10 +1,11 @@
 <div align="center">
+
   <a href="#">
-  <img
-  src="https://github.com/user-attachments/assets/3bf1ab31-f9c6-4362-b17d-1dfe7c414f17"
-  alt="Masquerade ORM Logo"
-  style="max-width: 50%; height: auto;"
-  />
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://github.com/MasqueradeORM/MasqueradeORM/releases/download/0.1.0/DARK-THEME-LOGO-transperent-bg.png">
+        <source  media="(prefers-color-scheme: light)" srcset="https://github.com/MasqueradeORM/MasqueradeORM/releases/download/0.1.0/LIGHT-THEME-LOGO-transperent-bg.png">
+        <img style="max-width: 33%; height: auto;" alt="MasqueradeORM Logo" src="https://github.com/MasqueradeORM/MasqueradeORM/releases/download/0.1.0/DARK-THEME-LOGO-transperent-bg.png">
+    </picture>
   </a>
   <br><br>
   <a href="">

package/docs/in-depth-class-definitions.md

@@ -95,7 +95,7 @@ const newInstance = new ExampleClass()
 newInstance.json.stringArr.push('d') 
 newInstance.jsonArr.stringArr.push('d')
 // The below mutation IS an assigment, but it is
-// nested, and therefore will also not be persisted.
+// nested, and therefore also won't be persisted.
 newInstance.json.nestedObj.someProp = 'hola mundo'
 
 // First solution - property assigment
@@ -174,13 +174,26 @@ this means *ClassD's* table will inherit columns from both *ClassA* and *ClassB*
 ## 4) Guidelines for Classes
 
 Classes that are connected to the ORM and mapped to database tables must follow a few simple rules:
-- **Rule 1:** Class must either directly extend Entity (imported from the package) or extend another class that has Entity as an ancestor.
-- **Rule 2:** Class properties must have a single “main” type: a `primitive`, a `primitive array`, an `object`, or a class that follows **Rule 1**.
-- **Rule 3:** Class names must be PascalCasde.
+- **Rule 1:** Class must either directly extend `Entity` (imported from the package) or extend another class that has `Entity` as an ancestor.
+- **Rule 2:** Class properties must have a single **“main” type**, which can be a `primitive`, an `object`, or a **class that follows **Rule 1****.
+
+
+- **Rule 3:** Class names must be PascalCased.
 - **Rule 4:** Class property names must be camelCased.
 
 As long as these rules are adhered to, the class is valid.  
 
+**“Main” Type Mapping** 
+
+```ts
+class EntityExtendingClass extends Entity {
+    // class properties + constructor
+}
+
+string[] // main type 'string'
+(string | undefined)[] | undefined // main type 'string'
+EntityExtendingClass[] | undefined // main type 'EntityExtendingClass'
+```
 
 <br>
 <div align="center">

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "masquerade-orm",
-  "version": "0.1.1",
+  "version": "0.8.0",
   "description": "Lightweight ORM compatible with SQLite and Postgresql in Node.js",
   "keywords": [
     "orm",
@@ -33,7 +33,7 @@
     "./package.json": "./package.json"
   },
   "bin": {
-    "orm-ts-setup": "./bin/universalTsInit.js"
+    "orm-ts-setup": "bin/universalTsInit.js"
   },
   "license": "MIT",
   "author": "Masquerade-Orm",