autoforce 0.1.2 → 0.1.4

package/lib/helpers/lwc.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import sf from "./connect.js";
 import templateGenerator from "./template.js";
 const templateEngine = templateGenerator("dictionary", "md");
-import { sortByName, splitFilename, DICTIONARY_FOLDER, DOCS_FOLDER } from "./util.js";
+import { sortByName, splitFilename, DICTIONARY_FOLDER, TEMPLATES_FOLDER } from "./util.js";
 function getMetadata(lwc) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -59,7 +59,7 @@ function executeLwc(items, filename, folder) {
         templateEngine.render(lwcContext, {
             helpers: {}
         });
-        templateEngine.save(filename, DOCS_FOLDER + "/" + folder);
+        templateEngine.save(filename, TEMPLATES_FOLDER + "/" + folder);
     });
 }
 const lwcModule = {

package/lib/helpers/metadata.js

@@ -10,7 +10,7 @@ const helpers = {
 export default helpers;
 /*
 import context from "./context.js";
-import { DOCS_FOLDER } from "./util.js";
+import { TEMPLATES_FOLDER } from "./util.js";
 import type { DocumentationModule, IProcessInfo, IMetadataNode, IMetadataComponentNode } from "../types/auto.js";
 function getMetadataFromContext(components: string[]) {
     return getMetadataArray(context.getProcessMetadata(), components);
@@ -66,7 +66,7 @@ function getMetadataArray(metadata: IProcessInfo[], props: string[]) {
       return items;
     };
   
-    return getItemsFromTree({ folder: DOCS_FOLDER, childs: metadata });
+    return getItemsFromTree({ folder: TEMPLATES_FOLDER, childs: metadata });
   }
   
 export async function execute() {

package/lib/helpers/object.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import sf from "./connect.js";
 import templateGenerator from "./template.js";
 const templateEngine = templateGenerator("dictionary", "md");
-import { sortByLabel, DICTIONARY_FOLDER, DOCS_FOLDER, } from "./util.js";
+import { sortByLabel, DICTIONARY_FOLDER, TEMPLATES_FOLDER, } from "./util.js";
 function getMetadata(objetos) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -123,7 +123,7 @@ function executeObjects(items, filename, folder) {
         templateEngine.render(objectContext, {
             helpers: { isManaged, isMetadataFormula, attributesFormula }
         });
-        templateEngine.save(filename, DOCS_FOLDER + "/" + folder);
+        templateEngine.save(filename, TEMPLATES_FOLDER + "/" + folder);
     });
 }
 const objectModule = {

package/lib/helpers/tasks.js

@@ -7,15 +7,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import context from "./context.js";
+import context, { initializeContext } from "./context.js";
 import { logError, logStep } from "./color.js";
 import fs from "fs";
-import { getFiles, filterJson } from "./util.js";
+import { getFiles, filterJson, searchInFolderHierarchy } from "./util.js";
 import { validateCommand, validateFunction, executeFunction, executeCommand, taskFunctions } from "./taskFunctions.js";
 import prompts from "prompts";
-export const TASKS_FOLDER = process.cwd() + "/commands/tasks";
-export const SUBTASKS_FOLDER = process.cwd() + "/commands/subtasks";
-export const NEW_FOLDER = process.cwd() + "/commands/new";
+import { fileURLToPath } from 'url';
+const COMMAND_FOLDER = searchInFolderHierarchy('commands', fileURLToPath(import.meta.url));
+export const TASKS_FOLDER = `${COMMAND_FOLDER}/tasks`;
+export const SUBTASKS_FOLDER = `${COMMAND_FOLDER}/subtasks`;
+export const NEW_FOLDER = `${COMMAND_FOLDER}/new`;
 export function getTaskFolder(command) {
     const folders = {
         'task': TASKS_FOLDER,
@@ -70,6 +72,7 @@ export function helpTask(task) {
     });
 }
 export function validateTask(task) {
+    initializeContext();
     if (task.guards) {
         // Valida que sea 
     }
@@ -103,6 +106,7 @@ export function validateTask(task) {
 }
 export function runTask(task, taskContext, tabs = '') {
     return __awaiter(this, void 0, void 0, function* () {
+        initializeContext();
         // Valida que este ya esten las variables de enotorno y  configuracion
         if (task.guards) {
             yield context.validate(task.guards);
@@ -128,6 +132,7 @@ export function runTask(task, taskContext, tabs = '') {
 }
 export function previewTask(task, tabs = '') {
     return __awaiter(this, void 0, void 0, function* () {
+        initializeContext();
         logStep(`${task.name}: ${task.description}`, tabs);
         for (const step of task.steps) {
             previewStep(step, tabs);

package/lib/helpers/util.d.ts

@@ -1,6 +1,8 @@
-export declare const DOCS_FOLDER: string;
+export declare const TEMPLATES_FOLDER: string;
 export declare const DICTIONARY_FOLDER: string;
 export declare const WORKING_FOLDER: string;
+export declare const CONFIG_FILE: string;
+export declare function createConfigurationFile(): Promise<boolean>;
 export declare function sortByName(objA: {
     Name: string;
 }, objB: {
@@ -26,6 +28,7 @@ export declare const filterFiles: (fullPath: string) => boolean;
  * @param {string[]} newArray El array de elementos a agregar
  */
 export declare function addNewItems(baseArray: string[], newArray: string[]): void;
+export declare function searchInFolderHierarchy(element: string, parentFolder: string): string;
 export declare function getFiles(source: string, filter?: (file: string) => boolean, recursive?: boolean, ignoreList?: string[]): string[];
 export declare function convertNameToKey(name: string): string;
 export declare function convertKeyToName(key: string): string;

package/lib/helpers/util.js

@@ -1,7 +1,35 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import fs from "fs";
-export const DOCS_FOLDER = process.cwd() + "/docs";
-export const DICTIONARY_FOLDER = process.cwd() + "/docs/diccionarios";
+import { fileURLToPath } from 'url';
+export const TEMPLATES_FOLDER = searchInFolderHierarchy('templates', fileURLToPath(import.meta.url));
+export const DICTIONARY_FOLDER = TEMPLATES_FOLDER + "/diccionarios";
 export const WORKING_FOLDER = process.env.INIT_CWD || ".";
+export const CONFIG_FILE = process.cwd() + '/.autoforce.json';
+export function createConfigurationFile() {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.log('Preguntar por GitHub o GitLab');
+        console.log('Chequear las variables de entorno');
+        console.log('Tema proyecto guardar la referencia');
+        console.log('Genera documentacion');
+        console.log('Direccion de las carpetas');
+        const config = { projectNumber: 1 };
+        try {
+            fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2));
+        }
+        catch (_a) {
+            throw new Error(`No se pudo guardar la configuracion en ${CONFIG_FILE}`);
+        }
+        return true;
+    });
+}
 export function sortByName(objA, objB) {
     return objA.Name > objB.Name ? 1 : objA.Name < objB.Name ? -1 : 0;
 }
@@ -58,6 +86,21 @@ export function addNewItems(baseArray, newArray) {
         }
     }
 }
+export function searchInFolderHierarchy(element, parentFolder) {
+    if (fs.existsSync(`${parentFolder}/${element}`)) {
+        return `${parentFolder}/${element}`;
+    }
+    else {
+        const lastIndex = parentFolder.lastIndexOf('/');
+        if (lastIndex !== -1) {
+            const newParentFolder = parentFolder.substring(0, lastIndex);
+            if (newParentFolder !== '') {
+                return searchInFolderHierarchy(element, newParentFolder);
+            }
+        }
+    }
+    return '';
+}
 export function getFiles(source, filter = (file) => file !== undefined, recursive = false, ignoreList = []) {
     const files = [];
     for (const file of fs.readdirSync(source)) {

package/package.json

@@ -2,16 +2,22 @@
   "name": "autoforce",
   "homepage": "https://sebastianclaros.github.io/autoforce",
   "private": false,
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Developer Automation tool for Github / Gitlab and Salesforce projects.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sebastianclaros/autoforce.git"
   },
-  "main": "./lib/index.js",
+  "main": "./bin/index.js",
   "files": [
-    "lib/**/*"
+    "commands/**/*",
+    "templates/**/*",
+    "lib/**/*",
+    "bin/**/*"
   ],
+  "bin": {
+    "autoforce": "./bin/index.js"
+  },
   "type": "module",
   "scripts": {
     "prebuild": "rm -rf ./lib/",
@@ -20,7 +26,7 @@
     "test:build": "yarn build && npm publish --dry-run && node ./bin/index.js",
     "test": "jest --config jest.config.js"
   },
-  "dependencies": {
+  "devDependencies": {
     "@eslint/js": "^9.9.1",
     "@types/jest": "29.4.0",
     "@typescript-eslint/eslint-plugin": "5.54.0",
@@ -37,7 +43,7 @@
     "typescript": "4.9.5",
     "typescript-eslint": "^8.3.0"
   },
-  "devDependencies": {
+  "dependencies": {
     "@octokit/graphql": "^8.1.1",
     "@types/graphql": "^14.5.0",
     "@types/jsforce": "^1.11.5",

package/templates/dictionary/class-all.md

@@ -0,0 +1,9 @@
+{{#each properties}}
+{{scopeModifiers}} {{name}} {{modifiers}}  
+{{/each}}  
+{{#each constructors as |item|}}
+{{scopeModifiers}} {{name}}({{#each parameters}}{{type}} {{name}}{{/each}}) {{returnType}} {{modifiers}}
+{{/each}}
+{{#each methods as |item|}}
+{{scopeModifiers}} {{name}}({{#each parameters}}{{type}} {{name}}{{/each}}) {{returnType}} {{modifiers}}
+{{/each}}

package/templates/dictionary/class-diagrama.md

@@ -0,0 +1,13 @@
+```mermaid
+classDiagram
+
+{{#if parentClass}}
+    {{parentClass}} <|-- {{Name}}
+{{/if}}
+class {{Name}} {
+
+    {{#with SymbolTable}}
+        {{import class-all}}
+    {{/with}}
+}
+```

package/templates/dictionary/class-inner.md

@@ -0,0 +1,19 @@
+---
+title: { { Name } }
+---
+
+## Introducción
+
+<!-- START autogenerated-class -->
+
+## Diagrama
+
+{{import class-diagrama.md}}
+
+### Metodos
+
+{{import class-metodos.md}}
+
+{{import class-referencias.md}}
+
+<!-- END autogenerated-class -->

package/templates/dictionary/class-metodos.md

@@ -0,0 +1,15 @@
+{{#if SymbolTable.constructors}}
+_Constructores_
+| # | Argumentos |
+| --- | ---------- |
+{{#each SymbolTable.constructors}}
+| <div class="icons">{{modifiers}}</div> | <ul>{{#each parameters}}<li>{{#with type}}{{linkToType}}{{/with}} {{name}}</li>{{/each}}</ul>|
+{{/each}}
+{{/if}}
+
+_Metodos_
+| # | Nombre | Return | Argumentos |
+| --- | ------ | ------ | ---------- |
+{{#each SymbolTable.methods}}
+| <div class="icons">{{modifiers}}</div> | {{name}} | {{#with returnType}}{{linkToType}}{{/with}}| <ul>{{#each parameters}}<li>{{#with type}}{{linkToType}}{{/with}} {{name}}</li>{{/each}}</ul>|
+{{/each}}

package/templates/dictionary/class-public.md

@@ -0,0 +1,13 @@
+{{#each properties}}
+{{#if (filterByPublic this)}}
+{{scopeModifiers}} {{name}} {{modifiers}}  
+ {{/if}}
+{{/each}}
+{{#each constructors as |item|}}
+{{scopeModifiers}} {{name}}({{#each parameters}}{{type}} {{name}}{{/each}}) {{returnType}} {{modifiers}}
+{{/each}}
+{{#each methods as |item|}}
+{{#if (filterByPublic this)}}
+{{scopeModifiers}} {{name}}({{#each parameters}}{{type}} {{name}}{{/each}}) {{returnType}} {{modifiers}}
+{{/if}}
+{{/each}}

package/templates/dictionary/class-referencias.md

@@ -0,0 +1,5 @@
+| #   | Referencia       | #   | Referencia |
+| --- | ---------------- | --- | ---------- |
+| +   | public or global | #   | protected  |
+| -   | private          | ~   | Package    |
+| $   | final or static  | \*  | abstract   |

package/templates/dictionary/class.md

@@ -0,0 +1,29 @@
+---
+title: { { Name } }
+---
+
+## Introducción
+
+<!-- START autogenerated-class -->
+
+## Descripción
+
+{{description}}
+
+- Status: {{Status}}
+- Api Version: {{ApiVersion}}
+- Interface
+  {{#each SymbolTable.interfaces}} \* [{{this}}](/diccionarios/classes/{{this}})
+  {{/each}}
+
+## Diagrama
+
+{{import class-diagrama.md}}
+
+### Metodos
+
+{{import class-metodos.md}}
+
+{{import class-referencias.md}}
+
+<!-- END autogenerated-class -->

package/templates/dictionary/classes.md

@@ -0,0 +1,52 @@
+---
+title: Modelo de Clases
+---
+
+## Introducción
+
+## Classes
+
+<!-- START autogenerated-classes -->
+
+### Diagrama
+
+```mermaid
+classDiagram
+{{#each classes as |class|}}
+
+    {{#each SymbolTable.interfaces}}
+        {{this}} <|-- {{class.Name}} : implements
+    {{/each}}
+    {{#if parentClass}}
+        {{parentClass}} <|-- {{Name}}
+    {{/if}}
+
+    class {{Name}} {
+        {{#with SymbolTable}}
+            {{import class-public}}
+        {{/with}}
+    }
+
+    link {{class.Name}} "{{classLinkGraph}}"
+{{/each}}
+{{#each namespaces as |namespace|}}
+ namespace _{{@key}} {
+   {{#each namespace}}
+    class {{this}}
+   {{/each}}
+}
+{{/each}}
+```
+
+### Listado
+
+| #   | Name | Api Version | Descripcion |
+| --- | ---- | ----------- | ----------- |
+
+{{#each classes}}
+| <div class="icons">{{#with TableDeclaration}}{{modifiers}}{{/with}}</div> | [{{Name}}]({{classLink}}) |{{ApiVersion}}|{{description}}|
+{{/each}}
+
+{{import class-referencias.md}}
+
+<!-- END autogenerated-classes -->

package/templates/dictionary/object.md

@@ -0,0 +1,35 @@
+---
+title: { { label } }
+---
+
+<!-- START autogenerated-object -->
+
+## Descripción
+
+{{description}}
+
+- Label: {{label}}
+- ApiName: {{fullName}}
+- Sharing Mode: {{sharingModel}}
+- Visibilidad: {{visibility}}
+- [Ver en Salesforce](https://test.salesforce.com/lightning/setup/ObjectManager/lookupRedirect?lookup=entityByApiName&apiName={{fullName}})
+
+## Campos
+
+| #   | Label | Api Name | Tipo | Descripcion |
+| --- | ----- | -------- | ---- | ----------- |
+
+{{#each fields}}
+{{#unless (isManaged this)}}
+| <div class="icons">{{attributesFormula}}</div> | {{label}} | {{fullName}} | {{typeFormula}} | {{descriptionFormula}} <ul>{{#each valueSet.valueSetDefinition.value}}<li>{{label}}</li>{{/each}}</ul> |
+{{/unless}}
+{{/each}}
+
+| #                                                              | Referencia    |
+| -------------------------------------------------------------- | ------------- |
+| <div class="icons">![Required](/img/lock_60.png)</div>         | Requerido     |
+| <div class="icons">![Esternal Id](/img/database_60.png)</div>  | External Id   |
+| <div class="icons">![Track History](/img/tracker_60.png)</div> | Track History |
+| <div class="icons">![Encripted](/img/password_60.png)</div>    | Encriptado    |
+
+<!-- END autogenerated-object -->

package/templates/dictionary/objects.md

@@ -0,0 +1,63 @@
+---
+title: Modelo de datos
+---
+
+## Introducción
+
+## Objetos
+
+<!-- START autogenerated-objects -->
+
+```mermaid
+erDiagram
+{{#each objects}}
+    {{#each fields}}
+        {{#unless (isManaged this)}}
+        {{#if referenceTo}}
+            {{referenceTo}} ||..|{ {{../fullName}} : "{{relationshipLabel}}"
+        {{/if}}
+        {{/unless}}
+    {{/each}}
+{{/each}}
+
+{{#each objects}}
+{{fullName}} {
+    {{#each fields}}
+        {{#unless (isManaged this)}}
+        {{#if referenceTo}}
+            {{fullName}} {{referenceTo}}
+        {{/if}}
+        {{/unless}}
+    {{/each}}
+}
+{{/each}}
+
+```
+
+### Transaccionales
+
+| #   | Label | Api Name | Descripcion |
+| --- | ----- | -------- | ----------- |
+
+{{#each objects}}
+{{#unless (isMetadataFormula this)}}
+| <div class="icons">{{attributesFormula}}</div> | [{{label}}](/diccionarios/objects/{{fullName}}) | {{fullName}} |{{description}}|
+{{/unless}}
+{{/each}}
+
+### Configuracion
+
+| #   | Label | Api Name | Descripcion |
+| --- | ----- | -------- | ----------- |
+
+{{#each objects}}
+{{#if (isMetadataFormula this)}}
+| <div class="icons">{{attributesFormula}}</div> | [{{label}}](/diccionarios/objects/{{fullName}}) | {{fullName}} |{{description}}|
+{{/if}}
+{{/each}}
+
+| #                                                              | Referencia    |
+| -------------------------------------------------------------- | ------------- |
+| <div class="icons">![Track History](/img/tracker_60.png)</div> | Track History |
+
+<!-- END autogenerated-objects -->

package/templates/intro.md

@@ -0,0 +1,20 @@
+---
+title: { { title } }
+slug: { { name } }
+---
+
+## Descripcion
+
+{{descripcion}}
+
+## Componentes
+
+## Objetos
+
+<!-- START autogenerated-objects -->
+<!-- END autogenerated-objects -->
+
+## Clases
+
+<!-- START autogenerated-classes -->
+<!-- END autogenerated-classes -->

package/templates/process.md

@@ -0,0 +1,23 @@
+---
+title: {{name}}
+process: {{identifier}}
+{{#if rol}}
+tags: [{{rol}}]
+{{/if}}
+---
+
+## Descripcion
+
+{{descripcion}}
+
+## Componentes
+
+## Objetos
+
+<!-- START autogenerated-objects -->
+<!-- END autogenerated-objects -->
+
+## Clases
+
+<!-- START autogenerated-classes -->
+<!-- END autogenerated-classes -->

package/templates/story.md

@@ -0,0 +1,32 @@
+---
+sidebar_position: 1
+tags: [{ { rol } }]
+---
+
+# {{titulo}}
+
+- Modulo: [{{modulo}}](/{{modulo}})
+- Roles: [{{rol}}](/tags/{{rol}})
+
+## Descripcion:
+
+## Escenarios
+
+1.
+
+<!-- START autogenerated-objects -->
+<!-- END autogenerated-objects -->
+
+<!-- START autogenerated-classes -->
+<!-- END autogenerated-classes -->
+
+<!-- START autogenerated-usecase -->
+
+:::tip
+Para refrescar metadata:
+
+```bash
+{{command}}
+```
+
+<!-- END autogenerated-usecase -->

package/templates/usecase.md

@@ -0,0 +1,52 @@
+---
+sidebar_position: 1
+tags: [{ { actor } }]
+---
+
+# {{titulo}}
+
+- Modulo: [{{modulo}}](/{{modulo}})
+- Roles: [{{actor}}](/tags/{{actor}})
+- Alcance:
+- Proposito:
+
+## Descripcion:
+
+- Suposiciones:
+- Cuando:
+- Precondiciones:
+- Postcondiciones:
+
+## Flujo Principal
+
+_Pasos: _
+
+1.
+
+## Flujos Alternativos
+
+_Pasos: _
+
+1.
+
+## Use cases relacionados
+
+| Nombre | Descripcion |
+| ------ | ----------- |
+
+<!-- START autogenerated-objects -->
+<!-- END autogenerated-objects -->
+
+<!-- START autogenerated-classes -->
+<!-- END autogenerated-classes -->
+
+<!-- START autogenerated-usecase -->
+
+:::tip
+Para refrescar metadata:
+
+```bash
+{{command}}
+```
+
+<!-- END autogenerated-usecase -->