@ticmas/frontend-utils 1.0.0

package/.yarnrc

@@ -0,0 +1,2 @@
+yarn-offline-mirror ".yarn-cache/"
+yarn-offline-mirror-pruning true

package/.yarnrc.yml

@@ -0,0 +1,2 @@
+defaultSemverRangePrefix: ""
+yarnPath: .yarn/releases/yarn-classic.cjs

package/README.md

@@ -0,0 +1,53 @@
+# @ticmas/frontend-utils
+
+`@ticmas-ui/frontend-utils` es una librería interna diseñada para centralizar funciones utilitarias y comunes utilizadas en proyectos de frontend. Su propósito es mejorar la consistencia y reutilización de código dentro de los proyectos del equipo.
+
+## 📋 Requisitos
+
+- **Node 20+**
+- **Yarn** 
+- **Tener configurado token de GITLAB_REGISTRY** 
+
+## 🚀 Instalación
+
+Instalá la librería con el siguiente comando:
+
+```bash
+yarn add @ticmas/frontend-utils
+```
+
+## 🤝 Contribución
+1. Cloná el repositorio:
+
+```bash
+git clone git@github.com:tu-organizacion/frontend-utils.git
+````
+
+2. Instalá las dependencias:
+
+```bash
+yarn install
+```
+
+3. Seguí las buenas prácticas de la guía de estilo de código del equipo de ingeniería:
+
+* Cada nueva función debe incluir tests unitarios.
+* Asegurate de pasar el check de ESLint antes de crear un Merge Request.
+* Evitá introducir lógica de negocio propia de productos. La librería debe mantenerse genérica y enfocada en utilidades comunes.
+* Creá un Merge Request y compartilo en el canal `#developers` para su revisión..
+
+## 🧪 Tests
+
+Ejecutá los tests para validar los cambios:
+
+```bash
+yarn test
+```
+
+## 🧪 ESLint
+
+Ejecutá ESLint para validar los cambios:
+
+```bash
+yarn lint
+```

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@ticmas/frontend-utils",
+  "version": "1.0.0",
+  "repository": "https://gitlab.com/vidatec/libs/frontend-utils.git",
+  "license": "MIT",
+  "scripts": {
+    "clean-build": "rimraf dist",
+    "build": "yarn clean-build && tsc -p tsconfig.build.json",
+    "build-storybook": "yarn build && typedoc --out public",
+    "lint": "eslint \"src/**/*.ts\" --fix",
+    "test": "vitest run --coverage",
+    "test:ci": "vitest run --coverage --poolOptions.threads.singleThread --passWithNoTests",
+    "test:watch": "vitest",
+    "test-e2e:ci": "echo \"OK\"",
+    "typescript": "tsc"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "8.23.0",
+    "@typescript-eslint/parser": "8.23.0",
+    "@vitejs/plugin-react": "4.3.4",
+    "@vitest/coverage-v8": "3.0.5",
+    "eslint": "8.56.0",
+    "eslint-config-prettier": "10.0.1",
+    "eslint-plugin-import": "2.31.0",
+    "eslint-plugin-prettier": "5.2.3",
+    "jsdom": "26.0.0",
+    "prettier": "3.4.2",
+    "rimraf": "6.0.1",
+    "typedoc": "0.27.6",
+    "typescript": "5.7.3",
+    "vite-tsconfig-paths": "5.1.4",
+    "vitest": "3.0.5"
+  },
+  "packageManager": "yarn@1.22.22"
+}

package/src/microfrontends/check-global-property/__tests__/check-global-property.test.ts

@@ -0,0 +1,45 @@
+import { checkGlobalProperty } from '../check-global-property';
+
+/**
+ * Mocks
+ */
+
+const KEY_MOCK = 'A.KEY';
+
+/**
+ * Tests
+ */
+
+describe('checkGlobalProperty', () => {
+  afterEach(() => {
+    delete (globalThis as any)[KEY_MOCK];
+  });
+
+  it('should return true if the global property exists', () => {
+    (globalThis as any)[KEY_MOCK] = true;
+
+    const result = checkGlobalProperty(KEY_MOCK);
+
+    expect(result).toBeTruthy();
+  });
+
+  it('should return false if the global property does not exist', () => {
+    const result = checkGlobalProperty('nonExistentKey');
+
+    expect(result).toBeFalsy();
+  });
+
+  it('should return true if the global property exists with a falsy value', () => {
+    (globalThis as any)[KEY_MOCK] = 0;
+
+    const result = checkGlobalProperty(KEY_MOCK);
+
+    expect(result).toBeTruthy();
+  });
+
+  it('should handle cases where the key is an empty string', () => {
+    const result = checkGlobalProperty('');
+
+    expect(result).toBeFalsy();
+  });
+});

package/src/microfrontends/check-global-property/check-global-property.ts

@@ -0,0 +1,19 @@
+/**
+ * Verifica si una propiedad global está definida en el objeto `globalThis` de la aplicación host.
+ *
+ * Esta función comprueba si existe una propiedad con la clave proporcionada en el contexto global (`globalThis`).
+ * Si la propiedad está definida, retorna `true`, de lo contrario, retorna `false`.
+ *
+ * @param {string} key - La clave de la propiedad global que se desea verificar.
+ * @returns {boolean} `true` si la propiedad global está definida, `false` en caso contrario.
+ *
+ * @example
+ * // Ejemplo de uso:
+ * const isPropertyDefined = checkGlobalProperty('myGlobalVar');
+ * if (isPropertyDefined) {
+ *   console.log('La propiedad global está definida.');
+ * } else {
+ *   console.log('La propiedad global no está definida.');
+ * }
+ */
+export const checkGlobalProperty = (key: string): boolean => key in globalThis;

package/src/microfrontends/check-global-property/index.ts

@@ -0,0 +1 @@
+export * from './check-global-property';

package/src/microfrontends/index.ts

@@ -0,0 +1 @@
+export * from './check-global-property';

package/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "exclude": [
+    "node_modules",
+    "**/__tests__/**",
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,111 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    "types": ["vitest/globals"],                         /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "sourceMap": false,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    "noEmit": false,                                   /* Disable emitting files from a compilation. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}

package/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/*"],
+  "name": "frontend-utils",
+  "includeVersion": false
+}

package/vitest.config.mjs

@@ -0,0 +1,28 @@
+import react from '@vitejs/plugin-react';
+import tsconfigPaths from 'vite-tsconfig-paths';
+import { configDefaults, defineConfig } from 'vitest/config';
+import path from 'path';
+
+export default defineConfig({
+  plugins: [
+    react(), 
+    tsconfigPaths()
+  ],
+  test: {
+    clearMocks: true,
+    coverage: {
+      include: ['src'],
+      exclude: [
+        'dist', 
+        'src/core/__tests__/mocks/**', 
+        '**/**/index.ts?(x)', 
+        '**/**/*.test.ts?(x)'
+      ],
+      reporter: ['text', 'json', 'html'],
+    },
+    environment: 'jsdom',
+    globals: true,
+    include: [...configDefaults.include],
+    exclude: [...configDefaults.exclude],
+  }
+});