@jrmc/adonis-etl 1.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jeremy Chaufourier
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

package/README.md

@@ -0,0 +1 @@
+# adonis-etl

package/build/commands/commands.json

@@ -0,0 +1 @@
+{"commands":[{"commandName":"make:etl","description":"Create a new ETL files (source, transform, destination)","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the ETL process","type":"string"}],"options":{},"filePath":"make/etl.js"}],"version":1}

package/build/commands/main.d.ts

@@ -0,0 +1,4 @@
+import { CommandMetaData, Command } from '@adonisjs/ace/types';
+
+export function getMetaData(): Promise<CommandMetaData[]>
+export function getCommand(metaData: CommandMetaData): Promise<Command | null>

package/build/commands/main.js

@@ -0,0 +1,36 @@
+import { readFile } from 'node:fs/promises'
+
+/**
+ * In-memory cache of commands after they have been loaded
+ */
+let commandsMetaData
+
+/**
+ * Reads the commands from the "./commands.json" file. Since, the commands.json
+ * file is generated automatically, we do not have to validate its contents
+ */
+export async function getMetaData() {
+  if (commandsMetaData) {
+    return commandsMetaData
+  }
+
+  const commandsIndex = await readFile(new URL('./commands.json', import.meta.url), 'utf-8')
+  commandsMetaData = JSON.parse(commandsIndex).commands
+
+  return commandsMetaData
+}
+
+/**
+ * Imports the command by lookingup its path from the commands
+ * metadata
+ */
+export async function getCommand(metaData) {
+  const commands = await getMetaData()
+  const command = commands.find(({ commandName }) => metaData.commandName === commandName)
+  if (!command) {
+    return null
+  }
+
+  const { default: commandConstructor } = await import(new URL(command.filePath, import.meta.url).href)
+  return commandConstructor
+}

package/build/commands/make/etl.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @jrmc/adonis-etl
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { BaseCommand } from '@adonisjs/core/ace';
+export default class MakeEtl extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    name: string;
+    run(): Promise<void>;
+}

package/build/commands/make/etl.js

@@ -0,0 +1,95 @@
+/**
+ * @jrmc/adonis-etl
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+// import { stubsRoot } from '../../stubs/main.js'
+import { args, BaseCommand } from '@adonisjs/core/ace';
+import string from '@adonisjs/core/helpers/string';
+import { stubsRoot } from '../../stubs/main.js';
+export default class MakeEtl extends BaseCommand {
+    static commandName = 'make:etl';
+    static description = 'Create a new ETL files (source, transform, destination)';
+    async run() {
+        // Ask which ETL components to create
+        const components = await this.prompt.multiple('Which ETL components do you want to create?', [
+            'Source',
+            'Transform',
+            'Destination'
+        ], {
+            validate: (value) => {
+                if (!value || value.length === 0) {
+                    return 'You must select at least one component';
+                }
+                return true;
+            }
+        });
+        // Ask for source details if source is selected
+        let sourceDetails = null;
+        if (components.includes('Source') || components.includes('Transform')) {
+            sourceDetails = await this.prompt.ask('What is the source type? (e.g., database, api, file)', {
+                validate: (value) => {
+                    if (!value || value.trim().length === 0) {
+                        return 'Source type is required';
+                    }
+                    return true;
+                }
+            });
+        }
+        // Ask for destination details if destination is selected
+        let destinationDetails = null;
+        if (components.includes('Destination') || components.includes('Transform')) {
+            destinationDetails = await this.prompt.ask('What is the destination type? (e.g., database, api, file)', {
+                validate: (value) => {
+                    if (!value || value.trim().length === 0) {
+                        return 'Destination type is required';
+                    }
+                    return true;
+                }
+            });
+        }
+        const codemods = await this.createCodemods();
+        let className = null;
+        // Create the selected components
+        for (const component of components) {
+            if (component === 'Source') {
+                className = [
+                    string.snakeCase(this.name),
+                    string.snakeCase(sourceDetails),
+                    'source',
+                ].join('_');
+            }
+            else if (component === 'Destination') {
+                className = [
+                    string.snakeCase(this.name),
+                    string.snakeCase(destinationDetails),
+                    'destination',
+                ].join('_');
+            }
+            else if (component === 'Transform') {
+                className = [
+                    string.snakeCase(this.name),
+                    string.snakeCase(sourceDetails),
+                    'to',
+                    string.snakeCase(destinationDetails),
+                    'transform',
+                ].join('_');
+            }
+            const stubPath = `make/etl/${component.toLowerCase()}s/main.ts.stub`;
+            await codemods.makeUsingStub(stubsRoot, stubPath, {
+                className
+            });
+        }
+        this.logger.success(`ETL files created successfully for: ${this.name}`);
+    }
+}
+__decorate([
+    args.string({ description: 'Name of the ETL process' })
+], MakeEtl.prototype, "name", void 0);

package/build/configure.d.ts

@@ -0,0 +1,2 @@
+import type Configure from '@adonisjs/core/commands/configure';
+export declare function configure(command: Configure): Promise<void>;

package/build/configure.js

@@ -0,0 +1,9 @@
+export async function configure(command) {
+    const codemods = await command.createCodemods();
+    /**
+     * Register provider
+     */
+    await codemods.updateRcFile((rcFile) => {
+        rcFile.addCommand('@jrmc/adonis-etl/commands');
+    });
+}

package/build/index.d.ts

@@ -0,0 +1,3 @@
+export { configure } from './configure.js';
+export { etl } from '@jrmc/etl';
+export type * from '@jrmc/etl/types';

package/build/index.js

@@ -0,0 +1,2 @@
+export { configure } from './configure.js';
+export { etl } from '@jrmc/etl';

package/build/stubs/main.d.ts

@@ -0,0 +1 @@
+export declare const stubsRoot: string;

package/build/stubs/main.js

@@ -0,0 +1,2 @@
+import { getDirname } from '@poppinss/utils';
+export const stubsRoot = getDirname(import.meta.url);

package/build/stubs/make/etl/destinations/main.ts.stub

@@ -0,0 +1,12 @@
+{{#var resourceFileName = string(className).snakeCase().ext('.ts').toString()}}
+{{{
+  exports({
+    to: app.makePath('app/etl/destinations', resourceFileName)
+  })
+}}}
+import { Destination } from '@jrmc/adonis-etl'
+
+export default class {{ className }} implements Destination {
+  async write(row: unknown) {
+  }
+}

package/build/stubs/make/etl/sources/main.ts.stub

@@ -0,0 +1,13 @@
+{{#var resourceFileName = string(className).snakeCase().ext('.ts').toString()}}
+{{{
+  exports({
+    to: app.makePath('app/etl/sources', resourceFileName)
+  })
+}}}
+import { Source } from '@jrmc/adonis-etl'
+
+export default class {{ className }} implements Source {
+  async *each() {
+
+  }
+}

package/build/stubs/make/etl/transforms/main.ts.stub

@@ -0,0 +1,13 @@
+{{#var resourceFileName = string(className).snakeCase().ext('.ts').toString()}}
+{{{
+  exports({
+    to: app.makePath('app/etl/transforms', resourceFileName)
+  })
+}}}
+import { Transform } from '@jrmc/adonis-etl'
+
+export default class {{ className }} implements Transform {
+  async process(row: unknown) {
+    return row
+  }
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@jrmc/adonis-etl",
+  "version": "1.0.0-alpha.1",
+  "keywords": [
+    "adonisjs",
+    "etl",
+    "ace",
+    "commands"
+  ],
+  "author": "Jeremy Chaufourier jeremy@chaufourier.fr",
+  "license": "MIT",
+  "description": "AdonisJS ETL commands package",
+  "type": "module",
+  "main": "build/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/batosai/adonis-etl.git"
+  },
+  "files": [
+    "build"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "npm run clean && tsc && npm run copy-stubs",
+    "copy-stubs": "cp -r stubs/make build/stubs/",
+    "postbuild": "adonis-kit index build/commands",
+    "prepublishOnly": "npm run build",
+    "clean": "del-cli build",
+    "format": "prettier --write ."
+  },
+  "exports": {
+    ".": "./build/index.js",
+    "./commands": "./build/commands/main.js",
+    "./commands/*": "./build/commands/*.js"
+  },
+  "dependencies": {
+    "@jrmc/etl": "^1.0.1"
+  },
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.19.0",
+    "@adonisjs/lucid": "^21.7.0",
+    "@adonisjs/prettier-config": "^1.4.5",
+    "@adonisjs/tsconfig": "^1.4.1",
+    "@types/node": "^24.0.11",
+    "del-cli": "^7.0.0",
+    "prettier": "^3.6.2",
+    "typescript": "^5.8.3"
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "publishConfig": {
+    "access": "public",
+    "tag": "alpha"
+  },
+  "volta": {
+    "node": "22.17.0"
+  }
+}