jimpex 7.0.1 → 8.0.0

package/src/services/html/htmlGenerator.js

@@ -1,391 +0,0 @@
-const ObjectUtils = require('wootils/shared/objectUtils');
-const { deferred } = require('wootils/shared');
-const { eventNames } = require('../../constants');
-const { providerCreator } = require('../../utils/wrappers');
-/**
- * @typedef {import('../../types').AppConfiguration} AppConfiguration
- * @typedef {import('../../types').Logger} Logger
- * @typedef {import('../frontend/frontendFs').FrontendFs} FrontendFs
- */
-
-/**
- * @typedef {import('../../types').ProviderCreator<O>} ProviderCreator<O>
- * @template O
- */
-
-/**
- * The options to customize the an `HTMLGenerator` service.
- *
- * @typedef {Object} HTMLGeneratorOptions
- * @property {string}   template             The name of the file it should use as
- *                                           template.
- *                                           Default `'index.tpl.html'`.
- * @property {string}   file                 The name of the generated file. Default
- *                                           `'index.html'`.
- * @property {boolean}  deleteTemplateAfter  Whether or not to delete the tempalte after
- *                                           generating the file. Default `true`.
- * @property {string}   replacePlaceholder   The placeholder string where the information
- *                                           will be written. Default
- *                                           `'{{appConfiguration}}'`.
- * @property {RegExp}   valuesExpression     A regular expression for dynamic placeholders
- *                                           that will be replaced by values when the file
- *                                           is generated.
- *                                           Default `'{{(.*?)}}'`.
- * @property {string}   variable             The name of the variable that will have the
- *                                           information on the file. Default
- *                                           `'appConfiguration'`.
- * @property {string[]} configurationKeys    A list of settings from the app configuration
- *                                           that will be used as the information to
- *                                           inject on the file.
- *                                           Default `['features', 'version',
- *                                           'postMessagesPrefix']`.
- * @parent module:services
- */
-
-/**
- * @typedef {HTMLGeneratorOptions & HTMLGeneratorProviderOptionsProperties} HTMLGeneratorProviderOptions
- * @parent module:services
- * @prettierignore
- */
-
-/**
- * @typedef {Object} HTMLGeneratorProviderOptionsProperties
- * @property {string} [serviceName='htmlGenerator']
- * The name that will be used to register the service on the app container. This is to
- * allow multiple "instances" of the service to be created.
- * @property {?string} [valuesService='htmlGeneratorValues']
- * The name of a service that the generator will use in order to read the values that will
- * be injected on the template. If the service is available, the values from
- * `configurationKeys`
- * will be ignored.
- * @parent module:services
- */
-
-/**
- * @callback HTMLGeneratorValuesServiceGetValues
- * @returns {Promise<Object>}
- * @parent module:services
- */
-
-/**
- * A service to provide the information value to an `HTMLGenerator` service to use on the
- * generated file.
- *
- * @typedef {Object} HTMLGeneratorValuesService
- * @property {HTMLGeneratorValuesServiceGetValues} getValues
- * This is the method an `HTMLGenerator` service will call in order to retrieve the values
- * that should be injected on the generated file.
- * @parent module:services
- */
-
-/**
- * This is a utility sever that generates an HTML file with custom information when the
- * app server is started.
- *
- * @parent module:services
- */
-class HTMLGenerator {
-  /**
-   * @param {AppConfiguration} appConfiguration
-   * To read the values of the settings that are going to be send to the file.
-   * @param {Logger} appLogger
-   * To log messages when the file is generated, when the template is removed, and if it
-   * happens,
-   * when an error is thrown.
-   * @param {FrontendFs} frontendFs
-   * To read the contents of the template.
-   * @param {Partial<HTMLGeneratorOptions>} [options={}]
-   * To customize the service.
-   * @param {?HTMLGeneratorValuesService} [valuesService=null]
-   * If specified, instead of getting the values from the app configuration, they'll be
-   * retrieved from this service `getValues` method.
-   * @throws {Error}
-   * If `valuesService` is specified but it doesn't have a `getValues` method.
-   */
-  constructor(
-    appConfiguration,
-    appLogger,
-    frontendFs,
-    options = {},
-    valuesService = null,
-  ) {
-    /**
-     * The service options.
-     *
-     * @type {HTMLGeneratorOptions}
-     * @access protected
-     * @ignore
-     */
-    this._options = ObjectUtils.merge(
-      {
-        template: 'index.tpl.html',
-        file: 'index.html',
-        deleteTemplateAfter: true,
-        replacePlaceholder: '{{appConfiguration}}',
-        valuesExpression: /\{\{(.*?)\}\}/gi,
-        variable: 'appConfiguration',
-        configurationKeys: ['features', 'version', 'postMessagesPrefix'],
-      },
-      options,
-    );
-    /**
-     * This check is to completely overwrite the `configurationKeys` if they were specified on
-     * the received `options` parameters. The reason it's being made after the `extend` it's because
-     * `extend` mergers the array, so if you have `['a', 'b', 'c']` and merge it with `['d', 'e']`
-     * you end up with `['d', 'e', 'c']`, and in this case, that's not very useful.
-     */
-    if (options.configurationKeys) {
-      this._options.configurationKeys = options.configurationKeys.slice();
-    }
-    // If `valuesService` was specified, check if it has a `getValues` method.
-    if (valuesService && typeof valuesService.getValues !== 'function') {
-      throw new Error('The HTMLGenerator values service must have a `getValues` method');
-    }
-    /**
-     * A local reference for the `appConfiguration` service.
-     *
-     * @type {AppConfiguration}
-     * @access protected
-     * @ignore
-     */
-    this._appConfiguration = appConfiguration;
-    /**
-     * A local reference for the `appLogger` service.
-     *
-     * @type {Logger}
-     * @access protected
-     * @ignore
-     */
-    this._appLogger = appLogger;
-    /**
-     * A local reference for the `frontendFs` service.
-     *
-     * @type {FrontendFs}
-     * @access protected
-     * @ignore
-     */
-    this._frontendFs = frontendFs;
-    /**
-     * A local reference for the recieved `valuesService` service.
-     *
-     * @type {?HTMLGeneratorValuesService}
-     * @access protected
-     * @ignore
-     */
-    this._valuesService = valuesService;
-    /**
-     * Whether or not the file has been generated.
-     *
-     * @type {boolean}
-     * @access protected
-     * @ignore
-     */
-    this._fileReady = false;
-    /**
-     * A deferred promise to return when another service asks if the file has been
-     * generated. Once this sevice finishes generating the file, the promise will be
-     * resolved.
-     *
-     * @type {Object}
-     * @access protected
-     * @ignore
-     */
-    this._fileDeferred = deferred();
-  }
-  /**
-   * Generate the HTML file.
-   *
-   * @returns {Promise}
-   */
-  generateHTML() {
-    // Get the service options.
-    const { template, deleteTemplateAfter, file } = this._options;
-    // Define the variable where the template contents will be saved.
-    let templateContents = '';
-    // Read the template file.
-    return this._frontendFs
-      .read(`./${template}`)
-      .then((contents) => {
-        // Save the template contents.
-        templateContents = contents;
-        // Get the values to inject.
-        return this.getValues();
-      })
-      .then((values) => {
-        // Get the HTML code for the file.
-        const html = this._processHTML(templateContents, values);
-        // Write the generated file.
-        return this._frontendFs.write(file, html);
-      })
-      .then(() => {
-        this._appLogger.success(`The HTML was successfully generated (${file})`);
-        /**
-         * If the template needs to be deleted, return the call to the `delete` method, otherwise,
-         * just an empty object to continue the promise chain.
-         */
-        return deleteTemplateAfter && this._frontendFs.delete(`./${template}`);
-      })
-      .then(() => {
-        // If the template was deleted, log a message informing it.
-        if (deleteTemplateAfter) {
-          this._appLogger.info(
-            `The HTML template was successfully removed (${template})`,
-          );
-        }
-        /**
-         * Mark the `_fileReady` flag as `true` so the next calls to `whenReady` won't get the
-         * deferred promise.
-         */
-        this._fileReady = true;
-        // Resolve the deferred promise.
-        this._fileDeferred.resolve();
-      })
-      .catch((error) => {
-        this._appLogger.error('There was an error while generating the HTML');
-        return Promise.reject(error);
-      });
-  }
-  /**
-   * Get the name of the file the service generates.
-   *
-   * @returns {string}
-   */
-  getFile() {
-    return this._options.file;
-  }
-  /**
-   * Get the values that are going to be injected on the file.
-   *
-   * @returns {Promise<Object>}
-   */
-  getValues() {
-    let valuesPromise;
-    // If an `HTMLGeneratorValuesService` was specified...
-    if (this._valuesService) {
-      // ...get the values from there.
-      valuesPromise = this._valuesService.getValues();
-    } else if (this._options.configurationKeys.length) {
-      /**
-       * ...if there are configuration keys to be copied, set to return an already resolved
-       * promise with the settings from the configuration.
-       */
-      valuesPromise = Promise.resolve(
-        this._appConfiguration.get(this._options.configurationKeys),
-      );
-    } else {
-      // ...otherwsie, return an already resolved promise with an empty object.
-      valuesPromise = Promise.resolve({});
-    }
-
-    return valuesPromise;
-  }
-  /**
-   * Returns a promise that will be resolved when the file has been generated.
-   *
-   * @returns {Promise}
-   */
-  whenReady() {
-    return this._fileReady ? Promise.resolve() : this._fileDeferred.promise;
-  }
-  /**
-   * The service options.
-   *
-   * @type {HTMLGeneratorOptions}
-   * @todo Remove Object.freeze.
-   */
-  get options() {
-    return Object.freeze(this._options);
-  }
-  /**
-   * Get a value from an object dictionary using a string _"object path"_
-   * (`prop.sub.otherProp`).
-   * If the property doesn't exist or the path is invalid, it will return `null`.
-   *
-   * @param {Object} values     The dictionary from where the value will be read.
-   * @param {string} valuePath  The path to the value.
-   * @returns {*}
-   * @access protected
-   * @ignore
-   * @todo Use ObjectUtils.get for this.
-   */
-  _getFromValues(values, valuePath) {
-    const pathParts = valuePath.split('.');
-    const first = pathParts.shift();
-    let currentElement = values[first];
-    if (typeof currentElement === 'undefined') {
-      currentElement = null;
-    } else if (pathParts.length) {
-      pathParts.some((currentPart) => {
-        currentElement = currentElement[currentPart];
-        let shouldBreak = false;
-        if (typeof currentElement === 'undefined') {
-          currentElement = null;
-          shouldBreak = true;
-        }
-
-        return shouldBreak;
-      });
-    }
-
-    return currentElement;
-  }
-  /**
-   * Creates the code for the HTML file.
-   *
-   * @param {string} template  The template code where the values are going to be
-   *                           injected.
-   * @param {Object} values    The dictionary of values to inject.
-   * @returns {string}
-   * @access protected
-   * @ignore
-   */
-  _processHTML(template, values) {
-    const { replacePlaceholder, valuesExpression, variable } = this._options;
-    const htmlObject = JSON.stringify(values);
-    let code = template.replace(replacePlaceholder, `window.${variable} = ${htmlObject}`);
-    const matches = [];
-    let match = valuesExpression.exec(code);
-    while (match) {
-      const [string, value] = match;
-      matches.push({
-        string,
-        value,
-      });
-
-      match = valuesExpression.exec(code);
-    }
-
-    matches.forEach((info) => {
-      code = code.replace(info.string, this._getFromValues(values, info.value));
-    });
-
-    return code;
-  }
-}
-/**
- * A service that hooks itself to the `after-start` event of the app server in order to
- * trigger the generation an the html file when the server starts.
- *
- * @type {ProviderCreator<HTMLGeneratorProviderOptions>}
- * @parent module:services
- */
-const htmlGenerator = providerCreator((options = {}) => (app) => {
-  const { serviceName = 'htmlGenerator' } = options;
-  app.set(serviceName, () => {
-    const { valuesService = 'htmlGeneratorValues' } = options;
-    return new HTMLGenerator(
-      app.get('appConfiguration'),
-      app.get('appLogger'),
-      app.get('frontendFs'),
-      options,
-      valuesService ? app.try(valuesService) : null,
-    );
-  });
-
-  app
-    .get('events')
-    .once(eventNames.afterStart, () => app.get(serviceName).generateHTML());
-});
-
-module.exports.HTMLGenerator = HTMLGenerator;
-module.exports.htmlGenerator = htmlGenerator;

package/src/services/html/index.js

@@ -1,17 +0,0 @@
-const { providers } = require('../../utils/wrappers');
-const { htmlGenerator } = require('./htmlGenerator');
-
-/**
- * @typedef {import('../../types').Provider} Provider
- */
-
-/**
- * The providers collection for the HTML services.
- *
- * @type {Provider}
- * @property {Provider} htmlGenerator  The default provider for {@link HTMLGenerator}.
- * @parent module:services
- */
-module.exports = providers({
-  htmlGenerator,
-});

package/src/services/http/apiClient.js

@@ -1,148 +0,0 @@
-const ObjectUtils = require('wootils/shared/objectUtils');
-const APIClientBase = require('wootils/shared/apiClient');
-const { providerCreator } = require('../../utils/wrappers');
-
-/**
- * @typedef {import('../../types').APIClientBase} APIClientBase
- * @typedef {import('../../types').APIClientEndpoints} APIClientEndpoints
- * @typedef {import('./http').HTTP} HTTP
- * @typedef {import('../common/httpError').HTTPError} HTTPError
- */
-
-/**
- * @typedef {import('../../types').ProviderCreator<O>} ProviderCreator<O>
- * @template O
- */
-
-/**
- * The options to customize how the service gets registered.
- *
- * @typedef {Object} APIClientProviderOptions
- * @property {string}           serviceName           The name of the service that will be
- *                                                    registered into the app. Default
- *                                                    `'apiClient'`.
- * @property {string}           configurationSetting  The name of the configuration
- *                                                    setting that has the API
- *                                                    information. Default `'api'`.
- * @property {typeof APIClient} clientClass           The class the service will
- *                                                    instantiate. It has to extend from
- *                                                    {@link APIClient}, which is the
- *                                                    default value.
- * @parent module:services
- */
-
-/**
- * The configuration for the API the client will make requests to.
- *
- * @typedef {Object} APIClientConfiguration
- * @property {string}             url        The API entry point.
- * @property {APIClientEndpoints} endpoints  A dictionary of named endpoints relative to
- *                                           the API entry point.
- * @parent module:services
- */
-
-/**
- * An API client for the app to use. What makes this service special is that its that it
- * formats the received errors using the `AppError` service class and as fetch function it
- * uses the `http` service, allowing the app to to internally handle all the requests and
- * responses.
- *
- * @augments APIClientBase
- * @parent module:services
- */
-class APIClient extends APIClientBase {
-  /**
-   * @param {APIClientConfiguration} apiConfig  The configuration for the API the client
-   *                                            will make requests to.
-   * @param {HTTP}                   http       To get the `fetch` function for this
-   *                                            service to use on all the requests.
-   * @param {ClassHTTPError}         HTTPError  To format the received errors.
-   */
-  constructor(apiConfig, http, HTTPError) {
-    super(apiConfig.url, apiConfig.endpoints || apiConfig.gateway, http.fetch);
-    /**
-     * The configuration for the API the client will make requests to.
-     *
-     * @type {APIClientConfiguration}
-     * @access protected
-     * @ignore
-     */
-    this._apiConfig = ObjectUtils.copy(apiConfig);
-    /**
-     * A local reference for the class the app uses to generate HTTP errors.
-     *
-     * @type {ClassHTTPError}
-     * @access protected
-     * @ignore
-     */
-    this._HTTPError = HTTPError;
-  }
-  /**
-   * Formats a response error with the App error class.
-   *
-   * @param {Object} response  A received response from a request.
-   * @param {number} status    The HTTP status of the request.
-   * @returns {HTTPError}
-   */
-  error(response, status) {
-    return new this._HTTPError(this.getErrorMessageFromResponse(response), status);
-  }
-  /**
-   * Helper method that tries to get an error message from a given response.
-   *
-   * @param {Object} response                       A received response from a request.
-   * @param {string} [fallback='Unexpected error']  A fallback message in case the method
-   *                                                doesn't found one on the response.
-   * @returns {string}
-   */
-  getErrorMessageFromResponse(response, fallback = 'Unexpected error') {
-    let message;
-    if (response.error) {
-      message = response.error;
-    } else if (response.data && response.data && response.data.message) {
-      ({ message } = response.data);
-    } else if (response.data && response.data && response.data.error) {
-      message = response.data.error;
-    } else {
-      message = fallback;
-    }
-
-    return message;
-  }
-  /**
-   * The configuration for the API the client will make requests to.
-   *
-   * @type {APIClientConfiguration}
-   * @todo Remove Object.freeze.
-   */
-  get apiConfig() {
-    return Object.freeze(this._apiConfig);
-  }
-}
-/**
- * An API Client service to make requests to an API using endpoints defined on the app
- * configuration.
- *
- * @type {ProviderCreator<APIClientProviderOptions>}
- * @parent module:services
- */
-const apiClient = providerCreator((options = {}) => (app) => {
-  const defaultName = 'apiClient';
-  const { serviceName = defaultName, clientClass: ClientClass = APIClient } = options;
-  let { configurationSetting } = options;
-  if (!configurationSetting) {
-    configurationSetting = serviceName === defaultName ? 'api' : serviceName;
-  }
-  app.set(
-    serviceName,
-    () =>
-      new ClientClass(
-        app.get('appConfiguration').get(configurationSetting),
-        app.get('http'),
-        app.get('HTTPError'),
-      ),
-  );
-});
-
-module.exports.APIClient = APIClient;
-module.exports.apiClient = apiClient;