@qrvey/utils 1.3.0-1 → 1.3.0-2

package/dist/cjs/globalization/service/i18nextBuilder.d.ts

@@ -5,6 +5,15 @@ export declare class I18nServiceBuilder {
     private static _initI18n;
     static setTranslations(i18nDefault: any, i18nResource: II18nResource): II18nResource;
 }
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 export declare abstract class I18nService {
+    /**
+      * This method by means of the key searches in the configuration object, replaces the values received by means of the options parameter and returns the translated text. Ex: <b>translate('the_value_is {{number}}',{number: 1});</b>
+      * @param key String used as key
+      * @param options Object of type II18nServiceTranslateOption that contains the dynamic parameters to replace
+      * @returns The translated text Ex: <b>The value is: 1</b>
+      */
     abstract translate(key: string, options?: II18nServiceTranslateOption): string;
 }

package/dist/cjs/globalization/service/i18nextBuilder.js

@@ -47,6 +47,9 @@ class I18nServiceBuilder {
     }
 }
 exports.I18nServiceBuilder = I18nServiceBuilder;
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 class I18nService {
 }
 exports.I18nService = I18nService;

package/dist/globalization/service/i18nextBuilder.d.ts

@@ -5,6 +5,15 @@ export declare class I18nServiceBuilder {
     private static _initI18n;
     static setTranslations(i18nDefault: any, i18nResource: II18nResource): II18nResource;
 }
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 export declare abstract class I18nService {
+    /**
+      * This method by means of the key searches in the configuration object, replaces the values received by means of the options parameter and returns the translated text. Ex: <b>translate('the_value_is {{number}}',{number: 1});</b>
+      * @param key String used as key
+      * @param options Object of type II18nServiceTranslateOption that contains the dynamic parameters to replace
+      * @returns The translated text Ex: <b>The value is: 1</b>
+      */
     abstract translate(key: string, options?: II18nServiceTranslateOption): string;
 }

package/dist/globalization/service/i18nextBuilder.js

@@ -40,6 +40,9 @@ export class I18nServiceBuilder {
         return mergeDeep(i18nResource, i18nDefault, { mergeExistingValues: false });
     }
 }
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 export class I18nService {
 }
 class I18nServiceConcrete extends I18nService {

package/package.json

@@ -1,42 +1,39 @@
 {
   "name": "@qrvey/utils",
-  "version": "1.3.0-1",
+  "version": "1.3.0-2",
   "description": "Helper, Utils for all Qrvey Projects",
   "homepage": "https://bitbucket.org/qrvey/qrvey_utils/wiki/Home",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc && tsc -m commonjs --outDir dist/cjs",
     "build-clean": "node ./scripts/clean-build",
-    "docs": "./node_modules/.bin/jsdoc -c ./jsdoc.config.json",
-    "doxs": "doxdox './dist/**/*.js' --ignore './dist/cjs/**/*.js' --output README.md --layout markdown --package ./package.json",
+    "compodoc": "npx compodoc -p tsconfig.doc.json",
+    "compodoc:server": "./node_modules/.bin/compodoc -p ./tsconfig.doc.json -s --port=4400",
     "lint": "eslint src --quiet --exit-on-fatal-error --ext .ts,.js",
     "lint-dev": "eslint src --debug --ext .ts,.tsx",
     "publishing-old": "node ./scripts/prepare-publish && np",
     "publishing-prerelease-old": "node ./scripts/prepare-publish && np --any-branch --tag=$npm_config_tag",
     "publishing-beta-1": "node ./scripts/publishing --np-new-version=$npm_config_np_new_version --np-any-branch=$npm_config_np_any_branch --np-tag=$npm_config_np_tag",
-    "publishing-beta-2": "node ./scripts/clean-build && node ./scripts/generating-docs && np --any-branch --np-tag=$npm_config_np_tag",
+    "publishing-beta-2": "node ./scripts/clean-build && node ./scripts/generating-docs --np-new-version=$npm_config_np_new_version && np $npm_config_np_new_version --any-branch --tag=$npm_config_np_tag",
     "test": "jest test",
     "test:watch": "jest --watch test"
   },
   "author": "Qrvey Inc",
   "license": "MIT",
   "devDependencies": {
-    "@types/jest": "27.4.1",
-    "@typescript-eslint/eslint-plugin": "5.22.0",
-    "@typescript-eslint/parser": "5.22.0",
-    "doxdox": "3.0.0",
     "eslint": "8.14.0",
     "jest": "27.5.1",
-    "jsdoc": "3.6.10",
     "np": "7.6.1",
     "typedoc": "0.22.15",
-    "typescript": "4.6.4"
+    "typescript": "4.6.4",
+    "@compodoc/compodoc": "1.1.19",
+    "@types/jest": "27.4.1",
+    "@typescript-eslint/eslint-plugin": "5.22.0",
+    "@typescript-eslint/parser": "5.22.0"
   },
   "dependencies": {
     "d3": "6.3.1",
+    "dayjs": "1.11.1",
     "i18next": "21.6.16"
-  },
-  "peerDependencies": {
-    "dayjs": ">=1.11.1 <1.12.0"
   }
 }

package/scripts/generating-docs/index.js

@@ -67,9 +67,9 @@ async function startGeneratingDocs(settings) {
     await pushingChanges(settings);
 }
 
-async function generatingDocument(settings) {
+async function generatingDocument(_settings) {
     console.log('==>>> Generating Document...');
-    await execute(`doxdox './dist/**/*.js' --output ${settings.docsFileName} --ignore './dist/cjs/**/*.js' --package ${settings.packagePath} --layout markdown`);
+    await execute('npm run compodoc');
 }
 
 async function changingVersion(settings) {

package/src/globalization/service/i18nextBuilder.ts

@@ -35,7 +35,17 @@ export class I18nServiceBuilder {
   }
 }
 
+/**
+ * This class allows to use the translation service of the i18next library
+ */
 export abstract class I18nService {
+
+  /**
+    * This method by means of the key searches in the configuration object, replaces the values received by means of the options parameter and returns the translated text. Ex: <b>translate('the_value_is {{number}}',{number: 1});</b>
+    * @param key String used as key
+    * @param options Object of type II18nServiceTranslateOption that contains the dynamic parameters to replace
+    * @returns The translated text Ex: <b>The value is: 1</b>
+    */
   abstract translate(key: string, options?: II18nServiceTranslateOption): string;
 }
 

package/tsconfig.doc.json

@@ -0,0 +1,4 @@
+{
+  "include": ["src/**/*.ts"],
+  "exclude": ["test/*.test.ts", "test/**/*.test.js"]
+}