jimpex 10.0.2 → 11.0.1

package/dist/esm/services/utils/ensureBearerToken.js

@@ -1,94 +0,0 @@
-import {
-  __publicField
-} from "../../chunk-V6TY7KAL.js";
-import { deepAssignWithOverwrite } from "@homer0/deep-assign";
-import { providerCreator } from "../../utils";
-class EnsureBearerToken {
-  /**
-   * @param options  The options to construct the class.
-   */
-  constructor({
-    inject: { HTTPError, statuses },
-    ...options
-  }) {
-    /**
-     * To generate the errors when the validation fails.
-     */
-    __publicField(this, "_HTTPError");
-    /**
-     * The customization options for the service.
-     */
-    __publicField(this, "_options");
-    this._HTTPError = HTTPError;
-    this._options = deepAssignWithOverwrite(
-      {
-        error: {
-          message: "Unauthorized",
-          status: statuses("unauthorized"),
-          response: {}
-        },
-        expression: /bearer (.*?)(?:$|\s)/i,
-        local: "token"
-      },
-      options
-    );
-  }
-  /**
-   * Generates the middleware that verifies if a request has an `Authorization` header
-   * with a bearer token.
-   */
-  getMiddleware() {
-    return (req, res, next) => {
-      let unauthorized = true;
-      const {
-        headers: { authorization }
-      } = req;
-      if (authorization) {
-        const matches = this._options.expression.exec(authorization);
-        if (matches) {
-          const [, token] = matches;
-          res.locals[this._options.local] = token;
-          unauthorized = false;
-        }
-      }
-      if (unauthorized) {
-        const {
-          error: { message, status, response }
-        } = this._options;
-        next(
-          new this._HTTPError(message, status, {
-            response
-          })
-        );
-      } else {
-        next();
-      }
-    };
-  }
-  /**
-   * The customization options.
-   */
-  get options() {
-    return deepAssignWithOverwrite({}, this._options);
-  }
-}
-const ensureBearerTokenProvider = providerCreator(
-  (options = {}) => (app) => {
-    const { serviceName = "ensureBearerToken", ...rest } = options;
-    app.set(
-      serviceName,
-      () => new EnsureBearerToken({
-        inject: {
-          HTTPError: app.get("HTTPError"),
-          statuses: app.get("statuses")
-        },
-        ...rest
-      }).getMiddleware()
-    );
-  }
-);
-export {
-  EnsureBearerToken,
-  ensureBearerTokenProvider
-};
-//# sourceMappingURL=ensureBearerToken.js.map

package/dist/esm/services/utils/ensureBearerToken.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/services/utils/ensureBearerToken.ts"],"sourcesContent":["import { deepAssignWithOverwrite } from '@homer0/deep-assign';\nimport { providerCreator, type Statuses } from '../../utils';\nimport type { HTTPErrorClass } from '../common';\nimport type { DeepPartial, ExpressMiddleware } from '../../types';\n/**\n * The options for the error the middleare can generate.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenErrorOptions = {\n  /**\n   * The error message for the response.\n   *\n   * @default 'Unauthorized'\n   */\n  message: string;\n  /**\n   * The HTTP status that will be added to the error context.\n   *\n   * @default 401\n   */\n  status: number;\n  /**\n   * Context information for the error handler and that can be added to the actual\n   * response.\n   */\n  response: unknown;\n};\n/**\n * The options to customize the service/middleware.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenOptions = {\n  error: EnsureBearerTokenErrorOptions;\n  expression: RegExp;\n  local: string;\n};\n/**\n * The options to construct a {@link EnsureBearerToken}.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerConstructorOptions = DeepPartial<EnsureBearerTokenOptions> & {\n  /**\n   * A dictionary with the dependencies to inject.\n   */\n  inject: {\n    HTTPError: HTTPErrorClass;\n    statuses: Statuses;\n  };\n};\n/**\n * Custom options for the provider that will register an instance of\n * {@link EnsureBearerToken}\n * as a service.\n *\n * @group Services/EnsureBearerToken\n */\nexport type EnsureBearerTokenProviderOptions = DeepPartial<EnsureBearerTokenOptions> & {\n  /**\n   * The name that will be used to register the service on the container. This is to allow\n   * multiple \"instances\" of the service to be created.\n   *\n   * @default 'ensureBearerToken'\n   */\n  serviceName?: string;\n};\n/**\n * This service gives you a middleware that verifies if a request has an `Authorization`\n * header with a bearer token; if it does, the token will be saved on the `res.locals`,\n * otherwise, it will generate an error.\n *\n * This is a \"service middleware\" to allow certain flexibility: you can have controllers\n * where some routes are protected and others are not. For those cases, you get the\n * service from the container, and include it only in the routes that need it.\n *\n * @group Services\n * @group Services/EnsureBearerToken\n */\nexport class EnsureBearerToken {\n  /**\n   * To generate the errors when the validation fails.\n   */\n  protected readonly _HTTPError: HTTPErrorClass;\n  /**\n   * The customization options for the service.\n   */\n  protected readonly _options: EnsureBearerTokenOptions;\n  /**\n   * @param options  The options to construct the class.\n   */\n  constructor({\n    inject: { HTTPError, statuses },\n    ...options\n  }: EnsureBearerConstructorOptions) {\n    this._HTTPError = HTTPError;\n    this._options = deepAssignWithOverwrite(\n      {\n        error: {\n          message: 'Unauthorized',\n          status: statuses('unauthorized'),\n          response: {},\n        },\n        expression: /bearer (.*?)(?:$|\\s)/i,\n        local: 'token',\n      },\n      options,\n    );\n  }\n  /**\n   * Generates the middleware that verifies if a request has an `Authorization` header\n   * with a bearer token.\n   */\n  getMiddleware(): ExpressMiddleware {\n    return (req, res, next) => {\n      let unauthorized = true;\n      const {\n        headers: { authorization },\n      } = req;\n      if (authorization) {\n        const matches = this._options.expression.exec(authorization);\n        if (matches) {\n          const [, token] = matches;\n          res.locals[this._options.local] = token;\n          unauthorized = false;\n        }\n      }\n\n      if (unauthorized) {\n        const {\n          error: { message, status, response },\n        } = this._options;\n        next(\n          new this._HTTPError(message, status, {\n            response,\n          }),\n        );\n      } else {\n        next();\n      }\n    };\n  }\n  /**\n   * The customization options.\n   */\n  get options(): Readonly<EnsureBearerTokenOptions> {\n    return deepAssignWithOverwrite({}, this._options);\n  }\n}\n/**\n * Generates a \"service middleware\" that can be used on route controllers in order to\n * validate the presence of a bearer token on the requests authorization header.\n *\n * The registered service is an instance of {@link EnsureBearerToken}, and it uses the key\n * `ensureBearerToken`.\n *\n * Since it's a \"provider creator\", when registering it, you can pass custom options.\n *\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   // Register it on the container\n *   container.register(ensureBearerTokenProvider);\n *\n *   // Let's assume we are in a controller now...\n *   // Getting access to the middleware.\n *   const ensureBearerToken = container.get<ExpressMiddleware>('ensureBearerToken');\n *\n * @example\n *\n * <caption>Customizing the service</caption>\n *\n *   // Register it on the container\n *   container.register(\n *     ensureBearerTokenProvider({\n *       serviceName: 'ensureBearerTokenCustom',\n *       error: {\n *         message: 'Missing token!',\n *       },\n *     }),\n *   );\n *\n * @group Providers\n * @group Services/EnsureBearerToken\n */\nexport const ensureBearerTokenProvider = providerCreator(\n  (options: EnsureBearerTokenProviderOptions = {}) =>\n    (app) => {\n      const { serviceName = 'ensureBearerToken', ...rest } = options;\n      app.set(serviceName, () =>\n        new EnsureBearerToken({\n          inject: {\n            HTTPError: app.get('HTTPError'),\n            statuses: app.get('statuses'),\n          },\n          ...rest,\n        }).getMiddleware(),\n      );\n    },\n);\n"],"mappings":";;;AAAA,SAAS,+BAA+B;AACxC,SAAS,uBAAsC;AA+ExC,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA,EAY7B,YAAY;AAAA,IACV,QAAQ,EAAE,WAAW,SAAS;AAAA,IAC9B,GAAG;AAAA,EACL,GAAmC;AAXnC;AAAA;AAAA;AAAA,wBAAmB;AAInB;AAAA;AAAA;AAAA,wBAAmB;AAQjB,SAAK,aAAa;AAClB,SAAK,WAAW;AAAA,MACd;AAAA,QACE,OAAO;AAAA,UACL,SAAS;AAAA,UACT,QAAQ,SAAS,cAAc;AAAA,UAC/B,UAAU,CAAC;AAAA,QACb;AAAA,QACA,YAAY;AAAA,QACZ,OAAO;AAAA,MACT;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,gBAAmC;AACjC,WAAO,CAAC,KAAK,KAAK,SAAS;AACzB,UAAI,eAAe;AACnB,YAAM;AAAA,QACJ,SAAS,EAAE,cAAc;AAAA,MAC3B,IAAI;AACJ,UAAI,eAAe;AACjB,cAAM,UAAU,KAAK,SAAS,WAAW,KAAK,aAAa;AAC3D,YAAI,SAAS;AACX,gBAAM,CAAC,EAAE,KAAK,IAAI;AAClB,cAAI,OAAO,KAAK,SAAS,KAAK,IAAI;AAClC,yBAAe;AAAA,QACjB;AAAA,MACF;AAEA,UAAI,cAAc;AAChB,cAAM;AAAA,UACJ,OAAO,EAAE,SAAS,QAAQ,SAAS;AAAA,QACrC,IAAI,KAAK;AACT;AAAA,UACE,IAAI,KAAK,WAAW,SAAS,QAAQ;AAAA,YACnC;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF,OAAO;AACL,aAAK;AAAA,MACP;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAIA,IAAI,UAA8C;AAChD,WAAO,wBAAwB,CAAC,GAAG,KAAK,QAAQ;AAAA,EAClD;AACF;AAsCO,MAAM,4BAA4B;AAAA,EACvC,CAAC,UAA4C,CAAC,MAC5C,CAAC,QAAQ;AACP,UAAM,EAAE,cAAc,qBAAqB,GAAG,KAAK,IAAI;AACvD,QAAI;AAAA,MAAI;AAAA,MAAa,MACnB,IAAI,kBAAkB;AAAA,QACpB,QAAQ;AAAA,UACN,WAAW,IAAI,IAAI,WAAW;AAAA,UAC9B,UAAU,IAAI,IAAI,UAAU;AAAA,QAC9B;AAAA,QACA,GAAG;AAAA,MACL,CAAC,EAAE,cAAc;AAAA,IACnB;AAAA,EACF;AACJ;","names":[]}

package/dist/esm/services/utils/index.js

@@ -1,11 +0,0 @@
-import "../../chunk-V6TY7KAL.js";
-import { providers } from "../../utils";
-import { ensureBearerTokenProvider } from "./ensureBearerToken";
-const utilsServicesProvider = providers({
-  ensureBearerTokenProvider
-});
-export * from "./ensureBearerToken";
-export {
-  utilsServicesProvider
-};
-//# sourceMappingURL=index.js.map

package/dist/esm/services/utils/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/services/utils/index.ts"],"sourcesContent":["import { providers } from '../../utils';\nimport { ensureBearerTokenProvider } from './ensureBearerToken';\n/**\n * Registers all the utility services on the container.\n *\n * - {@link EnsureBearerToken | ensureBearerToken}\n *\n * @example\n *\n *   // Register the collection on the container\n *   container.register(utilsServicesProvider);\n *   // Getting access to one the services instance\n *   const ensureBearerToken = container.get<EnsureBearerToken>('ensureBearerToken');\n *\n * @group Providers\n */\nexport const utilsServicesProvider = providers({\n  ensureBearerTokenProvider,\n});\n\nexport * from './ensureBearerToken';\n"],"mappings":";AAAA,SAAS,iBAAiB;AAC1B,SAAS,iCAAiC;AAenC,MAAM,wBAAwB,UAAU;AAAA,EAC7C;AACF,CAAC;AAED,cAAc;","names":[]}

package/dist/esm/types/events.js

@@ -1 +0,0 @@
-//# sourceMappingURL=events.js.map

package/dist/esm/types/events.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/types/express.js

@@ -1 +0,0 @@
-//# sourceMappingURL=express.js.map

package/dist/esm/types/express.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/types/http.js

@@ -1 +0,0 @@
-//# sourceMappingURL=http.js.map

package/dist/esm/types/http.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/types/index.js

@@ -1,7 +0,0 @@
-export * from "./events";
-export * from "./express";
-export * from "./http";
-export * from "./options";
-export * from "./utils";
-export * from "./wootils";
-//# sourceMappingURL=index.js.map

package/dist/esm/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/types/index.ts"],"sourcesContent":["export * from './events';\nexport * from './express';\nexport * from './http';\nexport * from './options';\nexport * from './utils';\nexport * from './wootils';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/dist/esm/types/options.js

@@ -1 +0,0 @@
-//# sourceMappingURL=options.js.map

package/dist/esm/types/options.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/types/utils.js

@@ -1 +0,0 @@
-//# sourceMappingURL=utils.js.map

package/dist/esm/types/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/types/wootils.js

@@ -1 +0,0 @@
-//# sourceMappingURL=wootils.js.map

package/dist/esm/types/wootils.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/utils/fns/index.js

@@ -1,5 +0,0 @@
-export * from "./others";
-export * from "./routes";
-export * from "./statuses";
-export * from "./text";
-//# sourceMappingURL=index.js.map

package/dist/esm/utils/fns/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/utils/fns/index.ts"],"sourcesContent":["export * from './others';\nexport * from './routes';\nexport * from './statuses';\nexport * from './text';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}

package/dist/esm/utils/fns/others.js

@@ -1,6 +0,0 @@
-import "../../chunk-V6TY7KAL.js";
-const notUndefined = (value) => value !== void 0;
-export {
-  notUndefined
-};
-//# sourceMappingURL=others.js.map

package/dist/esm/utils/fns/others.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/utils/fns/others.ts"],"sourcesContent":["/**\n * A utility function that can be used in `.filter` calls to remove `undefined` values and\n * assert that the type is not longer `undefined`.\n *\n * @param value  The value to check.\n * @template T  The type that is not `undefined`.\n * @example\n *\n *   const arr: (number | undefined)[] = [1, 2, 3, undefined];\n *   const filtered = arr.filter(notUndefined);\n *   // filtered = [1, 2, 3] and its type is number[]\n *\n * @group Utilities\n */\nexport const notUndefined = <T>(value: T | undefined): value is T => value !== undefined;\n"],"mappings":";AAcO,MAAM,eAAe,CAAI,UAAqC,UAAU;","names":[]}

package/dist/esm/utils/fns/routes.js

@@ -1,25 +0,0 @@
-import "../../chunk-V6TY7KAL.js";
-import { escapeForRegExp } from "./text";
-const removeLeadingSlash = (url) => url.replace(/^\/+/, "");
-const removeTrailingSlash = (url) => url.replace(/\/+$/, "");
-const removeSlashes = (url, leading = true, trailing = true) => {
-  const newUrl = leading ? removeLeadingSlash(url) : url;
-  return trailing ? removeTrailingSlash(newUrl) : newUrl;
-};
-const createRouteExpression = (route, leadingSlash = true, trailingSlash = false) => {
-  let expression = removeSlashes(route).split("/").map((part) => part.startsWith(":") ? "(?:([^\\/]+?))" : escapeForRegExp(part)).join("\\/");
-  if (leadingSlash) {
-    expression = `\\/${expression}`;
-  }
-  if (trailingSlash) {
-    expression = `${expression}\\/`;
-  }
-  return new RegExp(expression);
-};
-export {
-  createRouteExpression,
-  removeLeadingSlash,
-  removeSlashes,
-  removeTrailingSlash
-};
-//# sourceMappingURL=routes.js.map

package/dist/esm/utils/fns/routes.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/utils/fns/routes.ts"],"sourcesContent":["import { escapeForRegExp } from './text';\n\n/**\n * Removes any leading slash from a URL.\n *\n * @param url  The URL to format.\n * @group Utilities\n */\nexport const removeLeadingSlash = (url: string): string => url.replace(/^\\/+/, '');\n/**\n * Removes any trailing slash from a URL.\n *\n * @param url  The URL to format.\n * @group Utilities\n */\nexport const removeTrailingSlash = (url: string): string => url.replace(/\\/+$/, '');\n/**\n * Remove any leading and trailing slash from a URL.\n *\n * @param url       The URL to format.\n * @param leading   Whether or not to remove any leading slash.\n * @param trailing  Whether or not to remove the trailing slash.\n * @group Utilities\n */\nexport const removeSlashes = (\n  url: string,\n  leading: boolean = true,\n  trailing: boolean = true,\n) => {\n  const newUrl = leading ? removeLeadingSlash(url) : url;\n  return trailing ? removeTrailingSlash(newUrl) : newUrl;\n};\n\n/**\n * Given a server route definition, this function creates a regular expression to match\n * it: The expression replaces the routes parameters with placeholders so it can be\n * compared with real routes.\n *\n * @param route          The route from which the expression will be created.\n * @param leadingSlash   Whether or not the expression should match a leading slash.\n * @param trailingSlash  Whether or not the expression should match a trailing slash.\n *                       The reason this is `false` by default is because these\n *                       expressions are often used to match against incoming requests,\n *                       and they don't have a trailing slash.\n * @group Utilities\n */\nexport const createRouteExpression = (\n  route: string,\n  leadingSlash: boolean = true,\n  trailingSlash: boolean = false,\n): RegExp => {\n  let expression = removeSlashes(route)\n    .split('/')\n    .map((part) => (part.startsWith(':') ? '(?:([^\\\\/]+?))' : escapeForRegExp(part)))\n    .join('\\\\/');\n  if (leadingSlash) {\n    expression = `\\\\/${expression}`;\n  }\n  if (trailingSlash) {\n    expression = `${expression}\\\\/`;\n  }\n\n  return new RegExp(expression);\n};\n"],"mappings":";AAAA,SAAS,uBAAuB;AAQzB,MAAM,qBAAqB,CAAC,QAAwB,IAAI,QAAQ,QAAQ,EAAE;AAO1E,MAAM,sBAAsB,CAAC,QAAwB,IAAI,QAAQ,QAAQ,EAAE;AAS3E,MAAM,gBAAgB,CAC3B,KACA,UAAmB,MACnB,WAAoB,SACjB;AACH,QAAM,SAAS,UAAU,mBAAmB,GAAG,IAAI;AACnD,SAAO,WAAW,oBAAoB,MAAM,IAAI;AAClD;AAeO,MAAM,wBAAwB,CACnC,OACA,eAAwB,MACxB,gBAAyB,UACd;AACX,MAAI,aAAa,cAAc,KAAK,EACjC,MAAM,GAAG,EACT,IAAI,CAAC,SAAU,KAAK,WAAW,GAAG,IAAI,mBAAmB,gBAAgB,IAAI,CAAE,EAC/E,KAAK,KAAK;AACb,MAAI,cAAc;AAChB,iBAAa,MAAM,UAAU;AAAA,EAC/B;AACA,MAAI,eAAe;AACjB,iBAAa,GAAG,UAAU;AAAA,EAC5B;AAEA,SAAO,IAAI,OAAO,UAAU;AAC9B;","names":[]}

package/dist/esm/utils/fns/statuses.js

@@ -1,6 +0,0 @@
-import "../../chunk-V6TY7KAL.js";
-import statuses from "statuses";
-export {
-  statuses
-};
-//# sourceMappingURL=statuses.js.map

package/dist/esm/utils/fns/statuses.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/utils/fns/statuses.ts"],"sourcesContent":["import statuses from 'statuses';\n/**\n * The type definitions for the `statuses` library.\n *\n * While the library has type definitions, TypeScript throws an error that they can't be\n * exported, so that's why they are copied in there.\n */\nexport type Statuses = {\n  /**\n   * Given a status code, returns the status text, and given a status text, returns the\n   * status code.\n   *\n   * @param code  The status code or status text to look up.\n   * @throws If the status is invalid.\n   */\n  (code: number | string): number | string;\n  /**\n   * A list of all the supported status codes.\n   */\n  codes: number[];\n  /**\n   * A dictionary with the status texts and their corresponding status codes.\n   */\n  code: Record<string, number | undefined>;\n  /**\n   * A dictionary with the status codes and their corresponding status texts, for\n   * responses that expect an empty body.\n   */\n  empty: Record<number, boolean | undefined>;\n  /**\n   * A dictionary with the status codes and their corresponding status texts.\n   */\n  message: Record<number, string | undefined>;\n  /**\n   * A dictionary with status codes for responses that are valid for redirections.\n   */\n  redirect: Record<number, boolean | undefined>;\n  /**\n   * A dictionary with status codes that should be retried.\n   */\n  retry: Record<number, boolean | undefined>;\n};\n\nexport { statuses };\n"],"mappings":";AAAA,OAAO,cAAc;","names":[]}

package/dist/esm/utils/fns/text.js

@@ -1,6 +0,0 @@
-import "../../chunk-V6TY7KAL.js";
-const escapeForRegExp = (text) => text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
-export {
-  escapeForRegExp
-};
-//# sourceMappingURL=text.js.map

package/dist/esm/utils/fns/text.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/utils/fns/text.ts"],"sourcesContent":["/**\n * Escapes a string to be used on `new RegExp(...)`.\n *\n * @param text  The text to escape.\n * @group Utilities\n */\nexport const escapeForRegExp = (text: string): string =>\n  text.replace(/[-[\\]{}()*+?.,\\\\^$|#\\s]/g, '\\\\$&');\n"],"mappings":";AAMO,MAAM,kBAAkB,CAAC,SAC9B,KAAK,QAAQ,4BAA4B,MAAM;","names":[]}

package/dist/esm/utils/index.js

@@ -1,3 +0,0 @@
-export * from "./fns";
-export * from "./wrappers";
-//# sourceMappingURL=index.js.map

package/dist/esm/utils/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/utils/index.ts"],"sourcesContent":["export * from './fns';\nexport * from './wrappers';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}

package/dist/esm/utils/wrappers.js

@@ -1,41 +0,0 @@
-import "../chunk-V6TY7KAL.js";
-import {
-  createProvider,
-  createProviderCreator,
-  createProviders,
-  resourceFactory,
-  resourceCreatorFactory
-} from "@homer0/jimple";
-const provider = createProvider();
-const providerCreator = createProviderCreator();
-const providers = createProviders();
-const controllerFactory = resourceFactory();
-const controller = (connect) => controllerFactory("controller", "connect", connect);
-const controllerCreatorFactory = resourceCreatorFactory();
-const controllerCreator = (creator) => controllerCreatorFactory("controller", "connect", creator);
-const controllerProviderFactory = resourceFactory();
-const controllerProvider = (register) => controllerProviderFactory("provider", "register", register);
-const controllerProviderCreatorFactory = resourceCreatorFactory();
-const controllerProviderCreator = (creator) => controllerProviderCreatorFactory("provider", "register", creator);
-const middlewareFactory = resourceFactory();
-const middleware = (connect) => middlewareFactory("middleware", "connect", connect);
-const middlewareCreatorFactory = resourceCreatorFactory();
-const middlewareCreator = (creator) => middlewareCreatorFactory("middleware", "connect", creator);
-const middlewareProviderFactory = resourceFactory();
-const middlewareProvider = (register) => middlewareProviderFactory("provider", "register", register);
-const middlewareProviderCreatorFactory = resourceCreatorFactory();
-const middlewareProviderCreator = (creator) => middlewareProviderCreatorFactory("provider", "register", creator);
-export {
-  controller,
-  controllerCreator,
-  controllerProvider,
-  controllerProviderCreator,
-  middleware,
-  middlewareCreator,
-  middlewareProvider,
-  middlewareProviderCreator,
-  provider,
-  providerCreator,
-  providers
-};
-//# sourceMappingURL=wrappers.js.map

package/dist/esm/utils/wrappers.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/utils/wrappers.ts"],"sourcesContent":["import {\n  createProvider,\n  createProviderCreator,\n  createProviders,\n  resourceFactory,\n  type ProviderRegisterFn as OriginalProviderRegisterFn,\n  type GenericCurriedFn,\n  resourceCreatorFactory,\n} from '@homer0/jimple';\nimport type { Jimpex } from '../app';\nimport type { Router, ExpressMiddlewareLike, NoStringIndex } from '../types';\n/**\n * The function a provider uses to configure a resource in the container.\n *\n * @group Wrappers\n */\nexport type ProviderRegisterFn = OriginalProviderRegisterFn<Jimpex>;\n/**\n * Creates an object that can configure/extend the container by registering services and\n * resources.\n *\n * @example\n *\n *   class APIClient {}\n *   const apiClientProvider = provider((app) => {\n *     app.set('apiClient', () => new APIClient());\n *   });\n *\n * @group Wrappers\n */\nexport const provider = createProvider<Jimpex>();\n/**\n * Creates an object like a provider, but that it can also be used as a function, as it\n * normally expose options for the resources it will configure.\n *\n * @example\n *\n * <caption>Registering as a common provider</caption>\n *\n *   const apiClientProvider = providerCreator(\n *     ({ serviceName = 'apiClient' }) =>\n *       (app) => {\n *         app.set(serviceName, () => new APIClient());\n *       },\n *   );\n *\n *   container.register(apiClientProvider);\n *\n * @example\n *\n * <caption>Registering a created provider</caption>\n *\n *   container.register(\n *     apiClientProvider({\n *       serviceName: 'myApiClient',\n *     }),\n *   );\n *\n * @group Wrappers\n */\nexport const providerCreator = createProviderCreator<Jimpex>();\n/**\n * Creates a collection of providers that can be registered one by one, or all at once.\n *\n * @example\n *\n * <caption>Registering all the providers at once</caption>\n *\n *   const collection = providers({\n *     apiClient: apiClientProvider,\n *     http: httpProvider,\n *   });\n *\n *   container.register(collection);\n *\n * @example\n *\n * <caption>Registering one by one</caption>\n *\n *   container.register(collection.http);\n *\n * @group Wrappers\n */\nexport const providers = createProviders<Jimpex>();\n/**\n * An object that can configure/extend the container by registering services and\n * resources.\n *\n * @group Wrappers\n */\nexport type Provider = ReturnType<typeof provider>;\n/**\n * A provider creator is like a provider, but it can also be used as a function, and it\n * expose options for the resources it will configure.\n *\n * @group Wrappers\n */\nexport type ProviderCreator = ReturnType<typeof providerCreator>;\n/**\n * A collection of providers that can be registered one by one, or all at once.\n *\n * @group Wrappers\n */\nexport type Providers = ReturnType<typeof providers>;\n/**\n * A union of all types that can be registered in the provider with a `register` function.\n *\n * @group Wrappers\n */\nexport type ProviderLike = Provider | ProviderCreator | Providers;\n\n// --\n/**\n * The function a controller uses to mount a controller/middleware in the container.\n *\n * @param container  The reference to the Jimpex container.\n * @param route      The route on which the controller will be mounted on.\n * @group Wrappers\n */\nexport type ControllerConnectFn = <ContainerType extends Jimpex = Jimpex>(\n  container: ContainerType,\n  route: string,\n) => Router | ExpressMiddlewareLike;\n\nconst controllerFactory = resourceFactory<ControllerConnectFn>();\n/**\n * Generates a routes controller for the application container to mount.\n *\n * @param connect  A function that will be called the moment the application mounts the\n *                 controller, and that is in charge of registering routes and\n *                 middlewares.\n * @example\n *\n *   const myController = controller((app) => {\n *     const router = app.getRouter();\n *     const ctrl = new MyController();\n *     return router.get('...', ctrl.doSomething()).post('...', ctrl.doSomethingElse());\n *   });\n *\n *   // ...\n *   container.mount('/charo', myController);\n *\n * @group Wrappers\n */\nexport const controller = (connect: ControllerConnectFn) =>\n  controllerFactory('controller', 'connect', connect);\n/**\n * A high order function that generates a controller. It's used on the definitions of a\n * controller creator.\n *\n * @group Wrappers\n */\nexport type ControllerCreatorFn = GenericCurriedFn<ControllerConnectFn>;\nconst controllerCreatorFactory = resourceCreatorFactory<ControllerConnectFn>();\n/**\n * Generates a configurable routes controller for the application to mount. It's\n * configurable because the `creator`, instead of just being sent to the container to\n * mount, it can also be called as a function with custom parameters the controller can\n * receive.\n *\n * @param creator  A function that will generate a controller.\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   const myController = controllerCreator((options = {}) => (app) => {\n *     const router = app.getRouter();\n *     const ctrl = new MyController(options);\n *     return router.get('...', ctrl.doSomething()).post('...', ctrl.doSomethingElse());\n *   });\n *\n *   // ...\n *   container.mount('/charo', myController);\n *\n * @example\n *\n * <caption>Custom parameters</caption>\n *\n *   container.mount('/pili', myController({ foo: 'bar' }));\n *\n * @group Wrappers\n */\nexport const controllerCreator = <CreatorFn extends ControllerCreatorFn>(\n  creator: CreatorFn,\n) => controllerCreatorFactory('controller', 'connect', creator);\n/**\n * A resource that will define middlewares for specific routes.\n *\n * @group Wrappers\n */\nexport type Controller = ReturnType<typeof controller>;\n/**\n * A controller creator is like a controller, but it can also be used as a function, and\n * it can receive custom parameters to configure its behavior.\n *\n * @group Wrappers\n */\nexport type ControllerCreator = ReturnType<typeof controllerCreator>;\n\n// --\n/**\n * The function a controller provider uses to configure/extend the container before\n * returning an actual controller.\n *\n * @param container  The reference to the Jimpex container.\n * @param route      The route on which the controller will be mounted on.\n * @group Wrappers\n */\nexport type ControllerProviderRegisterFn = <ContainerType extends Jimpex = Jimpex>(\n  container: ContainerType,\n  route: string,\n) => Controller;\n\nconst controllerProviderFactory = resourceFactory<ControllerProviderRegisterFn>();\n/**\n * Creates a \"controller provider\", which is a controller that can configure/extend the\n * container before the application mounts it.\n *\n * @param register  A function that will be called the moment the application mounts\n *                  the controller provider.\n * @example\n *\n *   class MyController {}\n *   const myControllerProvider = controllerProvider((app) => {\n *     app.set('myController', () => new MyController());\n *     return controller(() => {\n *       const ctrl = app.get<MyController>('myController');\n *       const router = app.getRouter();\n *       return router.get('/', ctrl.doSomething());\n *     });\n *   });\n *\n * @group Wrappers\n */\nexport const controllerProvider = (register: ControllerProviderRegisterFn) =>\n  controllerProviderFactory('provider', 'register', register);\n/**\n * A high order function that generates a controller provider. It's used on the\n * definitions of a controller provider creator.\n *\n * @group Wrappers\n */\nexport type ControllerProviderCreatorFn = GenericCurriedFn<ControllerProviderRegisterFn>;\nconst controllerProviderCreatorFactory =\n  resourceCreatorFactory<ControllerProviderRegisterFn>();\n/**\n * Generates a configurable controller provider for the application to mount. This is a\n * mix of a controller creator and a controller provider: it gives you the flexibility of\n * the creator, with the resources of the provider.\n *\n * @param creator  A function that will generate a controller provider.\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   class MyController {}\n *   const myControllerProvider = controllerProviderCreator(\n *     ({ serviceName = 'myController' }) =>\n *       (app) => {\n *         app.set(serviceName, () => new MyController());\n *         return controller(() => {\n *           const ctrl = app.get<MyController>(serviceName);\n *           const router = app.getRouter();\n *           return router.get('/', ctrl.doSomething());\n *         });\n *       },\n *   );\n *\n *   // ...\n *   container.mount('/charo', myControllerProvider);\n *\n * @example\n *\n * <caption>Custom parameters</caption>\n *\n *   container.mount('/pili', myControllerProvider({ serviceName: 'something' }));\n *\n * @group Wrappers\n */\nexport const controllerProviderCreator = <CreatorFn extends ControllerProviderCreatorFn>(\n  creator: CreatorFn,\n) => controllerProviderCreatorFactory('provider', 'register', creator);\n/**\n * A special kind of controller that can be used to configure/extend the container before\n * returning an actual controller.\n *\n * @group Wrappers\n */\nexport type ControllerProvider = ReturnType<typeof controllerProvider>;\n/**\n * A \"creator version\" of a controller provider: a controller that can be used to\n * configure/extend the container before returning an actual controller, but that can also\n * be called as a function, and it can receive custom parameters to configure its\n * behavior.\n *\n * @group Wrappers\n */\nexport type ControllerProviderCreator = ReturnType<typeof controllerProviderCreator>;\n\n// --\n/**\n * The function a middleware uses to mount itself in the container.\n *\n * @param container  The reference to the Jimpex container.\n * @param route      This is optional because the implementation can use it as a\n *                   \"global widdleware\", or for a specific route.\n * @returns The resource can choose to be enabled or not by returning the function, or\n *          `undefined`.\n * @group Wrappers\n */\nexport type MiddlewareConnectFn = <ContainerType extends Jimpex = Jimpex>(\n  app: ContainerType,\n  route?: string,\n) => Router | ExpressMiddlewareLike | undefined;\n\nconst middlewareFactory = resourceFactory<MiddlewareConnectFn>();\n/**\n * Generates a middleware for the application container to mount.\n *\n * @param connect  A function that will be called the moment the application tries to\n *                 mount the middleware.\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   const myMiddleware = controller((app) => {\n *     const responsesBuilder = app.get<ResponsesBuilder>('responsesBuilder');\n *     return (_, res) => {\n *       responsesBuilder.json({ res, data: { hello: 'world' } });\n *     };\n *   });\n *\n *   // ...\n *   container.use(myMiddleware);\n *\n * @example\n *\n * <caption>On a specific route</caption>\n *\n *   container.mount('/charo', myMiddleware);\n *\n * @group Wrappers\n */\nexport const middleware = (connect: MiddlewareConnectFn) =>\n  middlewareFactory('middleware', 'connect', connect);\n/**\n * A high order function that generates a middleware. It's used on the definitions of a\n * middleware creator.\n *\n * @group Wrappers\n */\nexport type MiddlewareCreatorFn = GenericCurriedFn<MiddlewareConnectFn>;\nconst middlewareCreatorFactory = resourceCreatorFactory<MiddlewareConnectFn>();\n/**\n * Generates a configurable middleware for the application to use. It's configurable\n * because the `creator`, instead of just being sent to the container to mount, it can\n * also be called as a function with custom parameters the middleware can receive.\n *\n * @param creator  A function that will generate a middleware.\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   const myMiddleware = middlewareCreator((options = {}) => (app) => {\n *     const message = options.message || 'Hello Charo!';\n *     const responsesBuilder = app.get<ResponsesBuilder>('responsesBuilder');\n *     return (_, res) => {\n *       responsesBuilder.json({ res, data: { message } });\n *     };\n *   });\n *\n *   // ...\n *   container.use(myMiddleware);\n *\n * @example\n *\n * <caption>Custom parameters</caption>\n *\n *   container.use(myMiddleware({ message: 'Hello Pili!' }));\n *\n * @group Wrappers\n */\nexport const middlewareCreator = <CreatorFn extends MiddlewareCreatorFn>(\n  creator: CreatorFn,\n) => middlewareCreatorFactory('middleware', 'connect', creator);\n/**\n * A resource that will define middlewares the application can use.\n *\n * @group Wrappers\n */\nexport type Middleware = ReturnType<typeof middleware>;\n/**\n * A middleware creator is like a middleware, but i can also be used as a function, and it\n * can receive custom parameters to configure its behavior.\n *\n * @group Wrappers\n */\nexport type MiddlewareCreator = ReturnType<typeof middlewareCreator>;\n\n// --\n/**\n * The function a middelware provider uses to configure/extend the container before\n * returning an actual middleware.\n *\n * @param container  The reference to the Jimpex container.\n * @param route      This is available only in the case the middleware is mounted on a\n *                   specific route.\n * @group Wrappers\n */\nexport type MiddlewareProviderRegisterFn = <ContainerType extends Jimpex = Jimpex>(\n  container: ContainerType,\n  route?: string,\n) => Middleware;\nconst middlewareProviderFactory = resourceFactory<MiddlewareProviderRegisterFn>();\n/**\n * Creates a \"middleware provider\", which is a middleware that can configure/extend the\n * container before the application uses it.\n *\n * @param register  A function that will be called the moment the application uses the\n *                  middleware provider.\n * @example\n *\n *   class MyServiceWithMiddleware {\n *     constructor(private readonly responsesBuilder: ResponsesBuilder) {}\n *     getMiddleware() {\n *       return (_, res) => {\n *         this.responsesBuilder.json({ res, data: { message } });\n *       };\n *     }\n *   }\n *\n *   const myMiddlewareProvider = middlewareProvider((app) => {\n *     app.set(\n *       'myMiddleware',\n *       () => new MyServiceWithMiddleware(app.get('responsesBuilder')),\n *     );\n *     return middleware(() =>\n *       app.get<MyServiceWithMiddleware>('myMiddleware').getMiddleware(),\n *     );\n *   });\n *\n * @group Wrappers\n */\nexport const middlewareProvider = (register: MiddlewareProviderRegisterFn) =>\n  middlewareProviderFactory('provider', 'register', register);\n/**\n * A high order function that generates a middleware provider. It's used on the\n * definitions of a middleware provider creator.\n *\n * @group Wrappers\n */\nexport type MiddlewareProviderCreatorFn = GenericCurriedFn<MiddlewareProviderRegisterFn>;\nconst middlewareProviderCreatorFactory =\n  resourceCreatorFactory<MiddlewareProviderRegisterFn>();\n/**\n * Generates a configurable middleware provider for the application to use. This is a mix\n * of a middleware creator and a middleware provider: it gives you the flexibility of the\n * creator, with the resources of the provider.\n *\n * @param creator  A function that will generate a middleware provider.\n * @example\n *\n * <caption>Basic usage</caption>\n *\n *   class MyServiceWithMiddleware {\n *     constructor(private readonly responsesBuilder: ResponsesBuilder) {}\n *     getMiddleware() {\n *       return (_, res) => {\n *         this.responsesBuilder.json({ res, data: { message } });\n *       };\n *     }\n *   }\n *   const myMiddlewareProvider = middlewareProviderCreator(\n *     ({ serviceName = 'myMiddleware' }) =>\n *       (app) => {\n *         app.set(\n *           serviceName,\n *           () => new MyServiceWithMiddleware(app.get('responsesBuilder')),\n *         );\n *         return middleware(() =>\n *           app.get<MyServiceWithMiddleware>(serviceName).getMiddleware(),\n *         );\n *       },\n *   );\n *\n *   // ...\n *   container.use(myMiddlewareProvider);\n *\n * @example\n *\n * <caption>Custom parameters</caption>\n *\n *   container.use(myMiddlewareProvider({ serviceName: 'something' }));\n *\n * @group Wrappers\n */\nexport const middlewareProviderCreator = <CreatorFn extends MiddlewareProviderCreatorFn>(\n  creator: CreatorFn,\n) => middlewareProviderCreatorFactory('provider', 'register', creator);\n/**\n * A special kind of middleware that can be used to configure/extend the container before\n * returning an actual middleware.\n *\n * @group Wrappers\n */\nexport type MiddlewareProvider = ReturnType<typeof middlewareProvider>;\n/**\n * A \"creator version\" of a middleware provider: a middleware that can be used to\n * configure/extend the container before returning an actual middleware, but that can also\n * be called as a function, and it can receive custom parameters to configure its\n * behavior.\n *\n * @group Wrappers\n */\nexport type MiddlewareProviderCreator = ReturnType<typeof middlewareProviderCreator>;\n\n// --\n/**\n * A union types of the different kinds of middlewares that can be used by the\n * application.\n *\n * @group Wrappers\n */\nexport type MiddlewareLike =\n  | NoStringIndex<Middleware>\n  | NoStringIndex<MiddlewareProvider>\n  | ExpressMiddlewareLike;\n/**\n * A union types of the different kinds of controllers that can be mounted by the\n * application.\n *\n * @group Wrappers\n */\nexport type ControllerLike =\n  | NoStringIndex<Controller>\n  | NoStringIndex<ControllerProvider>\n  | MiddlewareLike;\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAGA;AAAA,OACK;AAsBA,MAAM,WAAW,eAAuB;AA8BxC,MAAM,kBAAkB,sBAA8B;AAuBtD,MAAM,YAAY,gBAAwB;AAyCjD,MAAM,oBAAoB,gBAAqC;AAoBxD,MAAM,aAAa,CAAC,YACzB,kBAAkB,cAAc,WAAW,OAAO;AAQpD,MAAM,2BAA2B,uBAA4C;AA6BtE,MAAM,oBAAoB,CAC/B,YACG,yBAAyB,cAAc,WAAW,OAAO;AA6B9D,MAAM,4BAA4B,gBAA8C;AAqBzE,MAAM,qBAAqB,CAAC,aACjC,0BAA0B,YAAY,YAAY,QAAQ;AAQ5D,MAAM,mCACJ,uBAAqD;AAmChD,MAAM,4BAA4B,CACvC,YACG,iCAAiC,YAAY,YAAY,OAAO;AAkCrE,MAAM,oBAAoB,gBAAqC;AA4BxD,MAAM,aAAa,CAAC,YACzB,kBAAkB,cAAc,WAAW,OAAO;AAQpD,MAAM,2BAA2B,uBAA4C;AA8BtE,MAAM,oBAAoB,CAC/B,YACG,yBAAyB,cAAc,WAAW,OAAO;AA6B9D,MAAM,4BAA4B,gBAA8C;AA8BzE,MAAM,qBAAqB,CAAC,aACjC,0BAA0B,YAAY,YAAY,QAAQ;AAQ5D,MAAM,mCACJ,uBAAqD;AA2ChD,MAAM,4BAA4B,CACvC,YACG,iCAAiC,YAAY,YAAY,OAAO;","names":[]}