tshex-cli 1.0.28 → 1.0.29

package/build/main.js

@@ -1,159 +1,2 @@
 #!/usr/bin/env node
-import { program } from 'commander';
-import fs from 'node:fs';
-import path from 'node:path';
-import readline from 'node:readline/promises';
-import { stdin as input, stdout as output } from 'node:process';
-function readPackageJson() {
-    const filePath = path.join(import.meta.dirname, '..', 'package.json');
-    const fileContents = fs.readFileSync(filePath, 'utf-8');
-    return JSON.parse(fileContents);
-}
-function executeCreateProject(templatesDir, projectDir) {
-    try {
-        fs.cpSync(path.join(templatesDir, 'lib'), projectDir, {
-            recursive: true,
-            filter: (src) => src.endsWith('.gitkeep') === false
-        });
-        console.log('Project created successfully');
-    }
-    catch (err) {
-        console.error(err);
-    }
-}
-function executeCreateContext(templatesDir, contextDir) {
-    try {
-        fs.cpSync(path.join(templatesDir, 'ctx'), contextDir, {
-            recursive: true,
-            filter: (src) => src.endsWith('.gitkeep') === false
-        });
-        console.log('Context created successfully');
-    }
-    catch (err) {
-        console.error(err);
-    }
-}
-function executeCreateReactContext(templatesDir, contextDir) {
-    try {
-        fs.cpSync(path.join(templatesDir, 'ctx-react'), contextDir, {
-            recursive: true,
-            filter: (src) => src.endsWith('.gitkeep') === false
-        });
-        console.log('React context created successfully');
-    }
-    catch (err) {
-        console.error(err);
-    }
-}
-function executeCreateTests(sourceDir, destinationDir, fileContents, ignoredSourceDir, rootSourceDir = sourceDir) {
-    const entries = fs.readdirSync(sourceDir, { withFileTypes: true });
-    if (fs.existsSync(destinationDir) === false) {
-        fs.mkdirSync(destinationDir, { recursive: true });
-    }
-    for (const entry of entries) {
-        const sourcePath = path.join(sourceDir, entry.name);
-        const destinationPath = path.join(destinationDir, entry.name);
-        if (entry.isDirectory()) {
-            if (entry.name === 'shared' && sourceDir === rootSourceDir) {
-                continue;
-            }
-            if (ignoredSourceDir !== undefined && sourcePath.startsWith(ignoredSourceDir)) {
-                continue;
-            }
-            if (fs.existsSync(destinationPath) && fs.statSync(destinationPath).isDirectory() === false) {
-                continue;
-            }
-            executeCreateTests(sourcePath, destinationPath, fileContents, ignoredSourceDir, rootSourceDir);
-            continue;
-        }
-        if (entry.isFile() && entry.name.endsWith('.ts') && fs.existsSync(destinationPath) === false) {
-            fs.writeFileSync(destinationPath, fileContents);
-        }
-    }
-}
-async function ensureTestsDirectory(testsRootDir) {
-    if (fs.existsSync(testsRootDir)) {
-        if (fs.statSync(testsRootDir).isDirectory() === false) {
-            throw new Error(`Tests path exists but is not a directory: ${testsRootDir}`);
-        }
-        return;
-    }
-    const rl = readline.createInterface({ input, output });
-    try {
-        const answer = await rl.question(`Tests directory does not exist at ${testsRootDir}. Create it? (y/N) `);
-        if (answer.trim().toLowerCase() !== 'y') {
-            return false;
-        }
-    }
-    finally {
-        rl.close();
-    }
-    fs.mkdirSync(testsRootDir, { recursive: true });
-    return true;
-}
-async function main(program) {
-    const templatesDir = path.join(import.meta.dirname, '..', 'templates');
-    const options = program.opts();
-    let targetDir = path.resolve(options.dir ?? process.cwd());
-    if (Object.keys(options).length === 0) {
-        program.help();
-    }
-    if (fs.existsSync(targetDir) === false) {
-        fs.mkdirSync(targetDir, { recursive: true });
-    }
-    if (options.project !== undefined) {
-        targetDir = path.join(targetDir, options.project);
-        executeCreateProject(templatesDir, targetDir);
-    }
-    if (options.react === true && options.context === undefined) {
-        program.error('Option --react requires --context <name>');
-    }
-    if (options.context !== undefined) {
-        targetDir = path.join(targetDir, options.context);
-        if (options.react === true) {
-            executeCreateReactContext(templatesDir, targetDir);
-        }
-        else {
-            executeCreateContext(templatesDir, targetDir);
-        }
-    }
-    if (options.tests !== undefined) {
-        const sourceDir = path.resolve(options.tests);
-        const testsTemplateFile = path.join(templatesDir, 'tests', 'content.ts');
-        if (fs.existsSync(sourceDir) === false) {
-            program.error(`Tests source directory does not exist: ${sourceDir}`);
-        }
-        if (fs.statSync(sourceDir).isDirectory() === false) {
-            program.error(`Tests source path is not a directory: ${sourceDir}`);
-        }
-        if (fs.existsSync(testsTemplateFile) === false) {
-            program.error(`Tests template file does not exist: ${testsTemplateFile}`);
-        }
-        const testsTemplateContents = fs.readFileSync(testsTemplateFile, 'utf-8');
-        const testsRootDir = path.join(targetDir, 'tests');
-        const testsDirectoryCreated = await ensureTestsDirectory(testsRootDir);
-        if (testsDirectoryCreated === false) {
-            program.error('Tests directory creation cancelled');
-        }
-        const testsDir = path.join(testsRootDir, path.basename(sourceDir));
-        if (testsDir === sourceDir) {
-            program.error('Tests destination directory cannot be the same as the source directory');
-        }
-        executeCreateTests(sourceDir, testsDir, testsTemplateContents, testsRootDir);
-        console.log('Tests structure created successfully');
-    }
-}
-const packageJson = readPackageJson();
-program
-    .name('tshex')
-    .version(packageJson.version)
-    .option('-P, --project <name>', "creates a new project with it's shared directory")
-    .option('-C, --context <name>', 'creates a new context')
-    .option('-R, --react', 'creates a React context with --context')
-    .option('-T, --tests <path>', 'creates a .ts tests structure from an existing directory')
-    .option('--dir <path>', 'sets the directory to create the new item')
-    .parse(process.argv);
-void main(program).catch((err) => {
-    const message = err instanceof Error ? err.message : String(err);
-    program.error(message);
-});
+import{program as l}from"commander";import r from"node:fs";import n from"node:path";import p from"node:readline/promises";import{stdin as m,stdout as x}from"node:process";function h(){let e=n.join(import.meta.dirname,"..","package.json"),s=r.readFileSync(e,"utf-8");return JSON.parse(s)}function g(e,s){try{r.cpSync(n.join(e,"lib"),s,{recursive:!0,filter:t=>t.endsWith(".gitkeep")===!1}),console.log("Project created successfully")}catch(t){console.error(t)}}function j(e,s){try{r.cpSync(n.join(e,"ctx"),s,{recursive:!0,filter:t=>t.endsWith(".gitkeep")===!1}),console.log("Context created successfully")}catch(t){console.error(t)}}function S(e,s){try{r.cpSync(n.join(e,"ctx-react"),s,{recursive:!0,filter:t=>t.endsWith(".gitkeep")===!1}),console.log("React context created successfully")}catch(t){console.error(t)}}function d(e,s,t,i,c=e){let u=r.readdirSync(e,{withFileTypes:!0});r.existsSync(s)===!1&&r.mkdirSync(s,{recursive:!0});for(let o of u){let a=n.join(e,o.name),f=n.join(s,o.name);if(o.isDirectory()){if(o.name==="shared"&&e===c||i!==void 0&&a.startsWith(i)||r.existsSync(f)&&r.statSync(f).isDirectory()===!1)continue;d(a,f,t,i,c);continue}o.isFile()&&o.name.endsWith(".ts")&&r.existsSync(f)===!1&&r.writeFileSync(f,t)}}async function w(e){if(r.existsSync(e)){if(r.statSync(e).isDirectory()===!1)throw new Error(`Tests path exists but is not a directory: ${e}`);return}let s=p.createInterface({input:m,output:x});try{if((await s.question(`Tests directory does not exist at ${e}. Create it? (y/N) `)).trim().toLowerCase()!=="y")return!1}finally{s.close()}return r.mkdirSync(e,{recursive:!0}),!0}async function T(e){let s=n.join(import.meta.dirname,"..","templates"),t=e.opts(),i=n.resolve(t.dir??process.cwd());if(Object.keys(t).length===0&&e.help(),r.existsSync(i)===!1&&r.mkdirSync(i,{recursive:!0}),t.project!==void 0&&(i=n.join(i,t.project),g(s,i)),t.react===!0&&t.context===void 0&&e.error("Option --react requires --context <name>"),t.context!==void 0&&(i=n.join(i,t.context),t.react===!0?S(s,i):j(s,i)),t.tests!==void 0){let c=n.resolve(t.tests),u=n.join(s,"tests","content.ts");r.existsSync(c)===!1&&e.error(`Tests source directory does not exist: ${c}`),r.statSync(c).isDirectory()===!1&&e.error(`Tests source path is not a directory: ${c}`),r.existsSync(u)===!1&&e.error(`Tests template file does not exist: ${u}`);let o=r.readFileSync(u,"utf-8"),a=n.join(i,"tests");await w(a)===!1&&e.error("Tests directory creation cancelled");let y=n.join(a,n.basename(c));y===c&&e.error("Tests destination directory cannot be the same as the source directory"),d(c,y,o,a),console.log("Tests structure created successfully")}}var v=h();l.name("tshex").version(v.version).option("-P, --project <name>","creates a new project with it's shared directory").option("-C, --context <name>","creates a new context").option("-R, --react","creates a React context with --context").option("-T, --tests <path>","creates a .ts tests structure from an existing directory").option("--dir <path>","sets the directory to create the new item").parse(process.argv);T(l).catch(e=>{let s=e instanceof Error?e.message:String(e);l.error(s)});

package/docs/shared/application/data.md

@@ -49,7 +49,7 @@ The base class provides `none()` as an explicit empty result and requires
 contracts such as `Filterable`, `Creatable`, and `Updatable`, plus the
 `DatasetManager` extension for set operations.
 
-#### First Implementation
+#### Implementation
 
 In the following example we implement an in-memory manager and its driver.
 
@@ -92,6 +92,18 @@ export class MemoryUsersDriver extends DriverAdapter<MemoryUsersManager> {
 raw records. The application layer can use both without knowing whether the
 source is memory, SQL, or an HTTP-backed adapter.
 
+Put all your complex data operations in `DataManager`. `Repository` should only handle the transformation of raw records into domain representations. For example, if you need to relate users to their posts, implement that in a manager:
+
+```ts
+class ComplexUsersManager extends DataManager<EnrichedUserRecord> {
+    ...
+
+    public async findAllAndRelate(): Promise<Array<EnrichedUserRecord>> {
+        ...
+    }
+}
+```
+
 #### Repository
 
 `Repository` is responsible for transforming raw records into domain-oriented

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tshex-cli",
-  "version": "1.0.28",
+  "version": "1.0.29",
   "author": "https://github.com/virtualitems/",
   "license": "MIT",
   "description": "Typescript Hexagonal Architecture CLI",
@@ -41,15 +41,14 @@
   "bin": {
     "tshex": "./build/main.js"
   },
+  "scripts": {
+    "build": "deno run --allow-all npm:esbuild --bundle --minify --platform=node --external:commander --format=esm --outfile=./build/main.js ./source/main.ts",
+    "test": "deno test --allow-all tests/"
+  },
   "dependencies": {
-    "commander": "^12.1.0"
+    "commander": "^15.0.0"
   },
   "devDependencies": {
-    "@fission-ai/openspec": "^1.6.0",
-    "@types/node": "^22.5.4",
-    "typescript": "^5.4.5"
-  },
-  "scripts": {
-    "build": "tsc"
+    "@types/node": "^18"
   }
 }

package/source/main.ts

@@ -9,12 +9,12 @@ import { program } from 'commander'
 import fs from 'node:fs'
 import path from 'node:path'
 import readline from 'node:readline/promises'
-import { stdin as input, stdout as output } from 'node:process'
+import { stdin, stdout } from 'node:process'
 
 // FUNCTIONS
 
 function readPackageJson() {
-    const filePath = path.join(import.meta.dirname, '..', 'package.json')
+    const filePath = path.join(import.meta.dirname!, '..', 'package.json')
     const fileContents = fs.readFileSync(filePath, 'utf-8')
     return JSON.parse(fileContents)
 }
@@ -77,19 +77,35 @@ function executeCreateTests(
                 continue
             }
 
-            if (ignoredSourceDir !== undefined && sourcePath.startsWith(ignoredSourceDir)) {
+            if (
+                ignoredSourceDir !== undefined &&
+                sourcePath.startsWith(ignoredSourceDir)
+            ) {
                 continue
             }
 
-            if (fs.existsSync(destinationPath) && fs.statSync(destinationPath).isDirectory() === false) {
+            if (
+                fs.existsSync(destinationPath) &&
+                fs.statSync(destinationPath).isDirectory() === false
+            ) {
                 continue
             }
 
-            executeCreateTests(sourcePath, destinationPath, fileContents, ignoredSourceDir, rootSourceDir)
+            executeCreateTests(
+                sourcePath,
+                destinationPath,
+                fileContents,
+                ignoredSourceDir,
+                rootSourceDir
+            )
             continue
         }
 
-        if (entry.isFile() && entry.name.endsWith('.ts') && fs.existsSync(destinationPath) === false) {
+        if (
+            entry.isFile() &&
+            entry.name.endsWith('.ts') &&
+            fs.existsSync(destinationPath) === false
+        ) {
             fs.writeFileSync(destinationPath, fileContents)
         }
     }
@@ -104,10 +120,12 @@ async function ensureTestsDirectory(testsRootDir: string) {
         return
     }
 
-    const rl = readline.createInterface({ input, output })
+    const rl = readline.createInterface({ input: stdin, output: stdout })
 
     try {
-        const answer = await rl.question(`Tests directory does not exist at ${testsRootDir}. Create it? (y/N) `)
+        const answer = await rl.question(
+            `Tests directory does not exist at ${testsRootDir}. Create it? (y/N) `
+        )
 
         if (answer.trim().toLowerCase() !== 'y') {
             return false
@@ -121,7 +139,7 @@ async function ensureTestsDirectory(testsRootDir: string) {
 }
 
 async function main(program: typeof import('commander').program) {
-    const templatesDir = path.join(import.meta.dirname, '..', 'templates')
+    const templatesDir = path.join(import.meta.dirname!, '..', 'templates')
 
     const options = program.opts()
 
@@ -182,7 +200,9 @@ async function main(program: typeof import('commander').program) {
         const testsDir = path.join(testsRootDir, path.basename(sourceDir))
 
         if (testsDir === sourceDir) {
-            program.error('Tests destination directory cannot be the same as the source directory')
+            program.error(
+                'Tests destination directory cannot be the same as the source directory'
+            )
         }
 
         executeCreateTests(sourceDir, testsDir, testsTemplateContents, testsRootDir)
@@ -198,7 +218,10 @@ program
     .option('-P, --project <name>', "creates a new project with it's shared directory")
     .option('-C, --context <name>', 'creates a new context')
     .option('-R, --react', 'creates a React context with --context')
-    .option('-T, --tests <path>', 'creates a .ts tests structure from an existing directory')
+    .option(
+        '-T, --tests <path>',
+        'creates a .ts tests structure from an existing directory'
+    )
     .option('--dir <path>', 'sets the directory to create the new item')
     .parse(process.argv)
 

package/templates/ctx/example-ports.ts

@@ -1,4 +1,5 @@
 // Ports are exports from the context root level
+// you can delete this file and create your own ports file in the context root level
 
 export function example(): void {
     // ...

package/templates/lib/shared/application/data/capabilities.ts

@@ -0,0 +1,56 @@
+type Generic = Record<string, unknown>
+
+export interface Listable {
+    all(): Generic | Promise<Generic[]>
+}
+
+/**
+ * @description Declares a filtering operation over plain source records.
+ */
+export interface Filterable {
+    filter(selector: unknown): Generic | Promise<Generic[]>
+}
+
+/**
+ * @description Declares a sorting operation over plain source records.
+ */
+export interface Sortable {
+    sort(selector: unknown): Generic | Promise<Generic[]>
+}
+
+/**
+ * @description Declares a creation operation for plain source records.
+ */
+export interface Creatable {
+    create(data: unknown): unknown
+}
+
+/**
+ * @description Declares an update operation that selects source records and applies new plain data.
+ */
+export interface Updatable {
+    update(selector: unknown, data: unknown): unknown
+}
+
+/**
+ * @description Declares a deletion operation over source records selected by plain criteria.
+ */
+export interface Deletable {
+    delete(selector: unknown): unknown
+}
+
+/**
+ * @description Declares an aggregation operation over source records.
+ */
+export interface Aggregatable {
+    aggregate(selector: unknown): unknown
+}
+
+/**
+ * @description Declares operations for selecting or preloading relationships from a data source.
+ */
+export interface Relatable {
+    selectRelated(...args: unknown[]): unknown
+
+    prefetchRelated(...args: unknown[]): unknown
+}

package/templates/lib/shared/application/data/managers.ts

@@ -1,66 +1,9 @@
-/**
- * @description Declares a filtering operation over plain source records.
- */
-export interface Filterable<S = Record<string, unknown>> {
-    filter(selector: S): Promise<Array<S>>
-}
-
-/**
- * @description Declares a sorting operation over plain source records.
- */
-export interface Sortable<S = Record<string, unknown>> {
-    sort(selector: S): Promise<Array<S>>
-}
-
-/**
- * @description Declares a creation operation for plain source records.
- */
-export interface Creatable<D = Record<string, unknown>> {
-    create(data: D): Promise<unknown>
-}
-
-/**
- * @description Declares an update operation that selects source records and applies new plain data.
- */
-export interface Updatable<S = Record<string, unknown>, D = Record<string, unknown>> {
-    update(selector: S, data: D): Promise<unknown>
-}
-
-/**
- * @description Declares a deletion operation over source records selected by plain criteria.
- */
-export interface Deletable<S = Record<string, unknown>> {
-    delete(selector: S): Promise<unknown>
-}
-
-/**
- * @description Declares an aggregation operation over source records.
- */
-export interface Aggregatable<S = Record<string, unknown>> {
-    aggregate(selector: S): Promise<S>
-}
-
-/**
- * @description Declares operations for selecting or preloading relationships from a data source.
- */
-export interface Relatable {
-    selectRelated(...args: unknown[]): unknown
-
-    prefetchRelated(...args: unknown[]): unknown
-}
-
 /**
  * @description Operates on a data source using plain objects and arrays.
  * It exposes the raw data without transforming it.
  */
 export abstract class DataManager<T = Record<string, unknown>> {
     [property: string]: unknown
-
-    public none(): Array<T> {
-        return []
-    }
-
-    public abstract all(): Promise<Array<T>>
 } //:: class
 
 /**

package/templates/lib/shared/application/data/repositories.ts

@@ -1,29 +1,18 @@
 import { type DataManager } from './managers.js'
 import { type DriverAdapter } from './drivers.js'
 
+type Generic = Record<string, unknown>
+
 /**
  * @description Acts as an intermediary between plain source data and domain objects.
  * It transforms records into domain representations and can translate them back when needed.
  */
-export abstract class Repository<
-    DataShape extends Record<string, unknown> = Record<string, unknown>,
-    EntityShape extends Record<string, unknown> = Record<string, unknown>
-> {
+export abstract class Repository<RawDataShape = Generic, EntityShape = Generic> {
     [property: string]: unknown
 
-    public constructor(public readonly driver: DriverAdapter<DataManager<DataShape>>) {}
-
-    public async all(): Promise<Array<EntityShape>> {
-        const connection = await this.driver.connect()
-        const raw = await connection.all()
-        const entities = this.transformList(raw)
-        await this.driver.disconnect()
-        return entities
-    }
-
-    protected transformList(data: Array<DataShape>): Array<EntityShape> {
-        return data.map(this.transform)
-    }
+    public constructor(
+        public readonly driver: DriverAdapter<DataManager<RawDataShape>>
+    ) {}
 
-    protected abstract transform(data: DataShape): EntityShape
+    protected abstract transform(data: RawDataShape): EntityShape
 } //:: class

package/templates/lib/shared/application/loggers.ts

@@ -1,6 +1,3 @@
-import { type TimeZone } from '../../types/timezones'
-import { type Locale } from '../../types/locales'
-
 export const DEBUG = 10
 
 export const INFO = 20
@@ -22,20 +19,6 @@ export abstract class Logger {
 
     public level: number = 0
 
-    public datetimeLocales: Locale[] = ['en-GB']
-
-    public datetimeFormatOptions: Intl.DateTimeFormatOptions & { timeZone: TimeZone } = {
-        timeZone: 'UTC',
-        year: 'numeric',
-        month: '2-digit',
-        day: '2-digit',
-        hour: '2-digit',
-        minute: '2-digit',
-        second: '2-digit',
-        fractionalSecondDigits: 3,
-        hourCycle: 'h23'
-    }
-
     public abstract debug(data: unknown): void
 
     public abstract info(data: unknown): void
@@ -45,8 +28,4 @@ export abstract class Logger {
     public abstract error(data: unknown): void
 
     public abstract critical(data: unknown): void
-
-    protected getCurrentDatetime(): string {
-        return new Date().toLocaleString(this.datetimeLocales, this.datetimeFormatOptions)
-    }
 } //:: class

package/templates/lib/shared/domain/entities.ts

@@ -12,6 +12,6 @@ export abstract class Entity {
     }
 
     public toString(): string {
-        return String(this.constructor.name)
+        return this.constructor.name
     }
 } //:: class

package/templates/lib/shared/application/http/handlers.ts

@@ -1,13 +0,0 @@
-/**
- * @description Http request handler to process incoming requests and generate responses.
- */
-export interface HttpRequestHandler {
-    handle(request: Request): Response | Promise<Response>
-}
-
-/**
- * @description An HTTP middleware that pipes requests through handlers.
- */
-export interface HttpMiddleware {
-    process(request: Request, handler: HttpRequestHandler): Response | Promise<Response>
-}