masquerade-orm 0.8.1 → 0.8.3

package/README.md

@@ -37,21 +37,22 @@ npm install masquerade-orm
 ```
 
 # Features
-- **Effortless setup** - no ORM-specific structures; just use your classes.
-- **Zero schema planning** - tables and schema are generated automatically.
-- **Powerful IntelliSense** - confidently build complex queries with real-time IDE feedback when something’s wrong.
-- **Minimal memory usage** - one class instance per database row, minimizing memory usage and avoiding duplicates through smart state management.
-- **Optimized querying** - fewer queries through intelligent transaction grouping without sacrificing data integrity.
-- **Relational WHERE clauses** - easily write conditions that compare two columns within the same table or columns across different tables.
-- **Write complex WHERE conditions using a template-literal helper** - enabling expressive comparisons like >=, LIKE, object-property access, and even array element matching, all without cluttering your query code.
-- **SQL injection protection** - all queries are parameterized.
-- **Lightweight** - minimal dependencies.
-- **Strong typing even in JavaScript** - powered by JSDoc, no compile step required.
-- **Reduced data transfer size** - improves performance in client-server setups (not applicable for embedded databases like SQLite).
-- **Abstract and non-abstract inheritance** - enables the use of abstract classes, even in JavaScript.
+- **Effortless setup** - No ORM-specific structures; just use your classes.
+- **Zero schema planning** - Tables and schema are generated automatically.
+- **Powerful IntelliSense** - Confidently build complex queries with real-time IDE guidance and warnings when something’s wrong.
+- **Minimal memory usage** - One class instance per database row, minimizing memory usage and avoiding duplicates through smart state management.
+- **Optimized querying** - Fewer queries through intelligent transaction grouping without sacrificing data integrity.
+- **Expressive template-literal WHERE clauses** - Write complex, readable conditions such as LIKE, ≥, nested property access, array element matching (and more) by using IntelliSense-enabled tagged template literals. Any SQL WHERE logic can be expressed through this API.
+- **Cross-column conditions** - Easily write WHERE clauses that compare two columns (within the same table or across joined tables).
+- **Powerful relation capabilities** - Full support for eager & lazy loading, unidirectional / bidirectional / self-referencing relationships, and modifying associations even when they are not loaded.
+- **SQL injection protection** - All queries are parameterized.
+- **Minimal data transfer size** - Improves performance in client-server setups (not applicable for embedded databases like SQLite).
+- **Soft + hard deletion support**
+- **Abstract and non-abstract inheritance** - Enables the use of abstract classes, even in JavaScript.
+- **Strong typing even in JavaScript** - Powered by JSDoc, no compile step required.
+- **Smart schema cleanup** - Automatically detect and easily remove unused tables and columns, reducing database bloat and improving performance.
+- **Lightweight** - Minimal dependencies.
 - **Combines the convenience of embedded SQLite with the strict typing of RDBMS**
-- **Eager and lazy relations**
-- **Unidirectional, bidirectional, and self-referenced relations**
 
 
 # Example Code Implementation
@@ -134,13 +135,12 @@ user.friendList.pop()
 
 - **[Getting Started - Javascript](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/getting-started-javascript.md#class-definitions)**
 - **[Getting Started - Typescript](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/getting-started-typescript.md#class-definitions)**
+- **[Defining Classes: In-Depth](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/in-depth-class-definitions.md)** **(important read)**
 - **[Find Method](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/find.md#find)**
 - **[Saving to Database](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/saving-to-database.md#saving-to-the-database)**
 - **[Deleting Instances from the Database](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/deletion.md)**
 - **[Managing Database Tables](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/managing-the-database.md)**
-- **[Defining Classes: In-Depth](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/in-depth-class-definitions.md)** **(important read)**
-
-
+- **[JSDoc – UX Tips](https://github.com/MasqueradeORM/MasqueradeORM/blob/master/docs/jsdoc-ux-tips.md)**
 
 <br>
 <div align="center">

package/bin/universalTsInit.js

@@ -1,59 +1,59 @@
-#!/usr/bin/env node
-
-import ts from "typescript"
-import fs from "fs"
-import path from "path"
-import { createSourceFile, SyntaxKind, ScriptKind, ScriptTarget } from "typescript"
-import { nodeArr2ClassDict } from "../src/ORM/bootOrm.js"
-
-const configPath = ts.findConfigFile(
-  "./",
-  ts.sys.fileExists,
-  "tsconfig.json"
-)
-
-if (!configPath) {
-  throw new Error("tsconfig.json not found")
-}
-
-const configFile = ts.readConfigFile(
-  configPath,
-  ts.sys.readFile
-)
-
-const parsed = ts.parseJsonConfigFileContent(
-  configFile.config,
-  ts.sys,
-  "./"
-)
-
-const program = ts.createProgram({
-  rootNames: parsed.fileNames,
-  options: parsed.options
-})
-
-const classNodesArr = []
-
-for (const sourceFile of program.getSourceFiles()) {
-  if (sourceFile.isDeclarationFile) continue
-  const fileText = sourceFile.getFullText()
-  const fileNodesArr = createSourceFile('', fileText, ScriptTarget.Latest, true, ScriptKind.TSX).statements
-
-  for (const node of fileNodesArr) {
-    //@ts-ignore
-    if ((node.kind === SyntaxKind.ClassDeclaration || node.kind === SyntaxKind.ClassExpression) && node.heritageClauses) 
-      classNodesArr.push(node)
-  }
-}
-
-const classDict = nodeArr2ClassDict(classNodesArr)
-const filePath = path.join(
-  process.cwd(),
-  "ormTypeScriptSetup.js"
-)
-const content = `export function UniversalTsSetup() {globalThis.masqueradeClassDict_ = ${JSON.stringify(classDict)};\n}`
-fs.writeFileSync(filePath, content, "utf8")
-
-
-
-
+#!/usr/bin/env node
+
+import ts from "typescript"
+import fs from "fs"
+import path from "path"
+import { createSourceFile, SyntaxKind, ScriptKind, ScriptTarget } from "typescript"
+import { nodeArr2ClassDict } from "../src/ORM/bootOrm.js"
+
+const configPath = ts.findConfigFile(
+  "./",
+  ts.sys.fileExists,
+  "tsconfig.json"
+)
+
+if (!configPath) {
+  throw new Error("tsconfig.json not found")
+}
+
+const configFile = ts.readConfigFile(
+  configPath,
+  ts.sys.readFile
+)
+
+const parsed = ts.parseJsonConfigFileContent(
+  configFile.config,
+  ts.sys,
+  "./"
+)
+
+const program = ts.createProgram({
+  rootNames: parsed.fileNames,
+  options: parsed.options
+})
+
+const classNodesArr = []
+
+for (const sourceFile of program.getSourceFiles()) {
+  if (sourceFile.isDeclarationFile) continue
+  const fileText = sourceFile.getFullText()
+  const fileNodesArr = createSourceFile('', fileText, ScriptTarget.Latest, true, ScriptKind.TSX).statements
+
+  for (const node of fileNodesArr) {
+    //@ts-ignore
+    if ((node.kind === SyntaxKind.ClassDeclaration || node.kind === SyntaxKind.ClassExpression) && node.heritageClauses) 
+      classNodesArr.push(node)
+  }
+}
+
+const classDict = nodeArr2ClassDict(classNodesArr)
+const filePath = path.join(
+  process.cwd(),
+  "ormTypeScriptSetup.js"
+)
+const content = `export function UniversalTsSetup() {globalThis.masqueradeClassDict_ = ${JSON.stringify(classDict)};\n}`
+fs.writeFileSync(filePath, content, "utf8")
+
+
+
+

package/docs/deletion.md

@@ -1,6 +1,6 @@
 # Deleting Instances from the Database
 
-### Soft Deletion
+## Soft Deletion
 The ORM does not support soft deletion by default. To implement soft deletion, just create an abstract class like so: 
 
 **TypeScript**
@@ -69,10 +69,10 @@ const softDelUser = new SoftDeletableUser('JohnDoe', 'JohnDoe@gmail.com', 'hashe
 
 **Note:** Unlike `Entity`, the `SoftDel` classes need to be passed into the `ORM.boot` method that is being called to init the ORM.
 
-### Hard Deletion
+## Hard Deletion
 
 ```ts
-import { sql } from "masquerade"
+import { sql } from "masquerade-orm"
 const twoYearsAgo = new Date().setFullYear(new Date().getFullYear() - 2)
 
 // finds all instances that haven't been mutated in over two years
@@ -91,7 +91,7 @@ The `delete` method hard-deletes the instance from the database; the instance ca
 </div>
 
 
-## Pre-Deletion Step
+## Pre-Deletion Step for Hard Deletion
 
 ### When is a pre-deletion step required?  
 A pre-deletion step is required when the class instance has **dependents**.