@e22m4u/js-http-static-router 0.0.1 → 0.1.0

package/src/static-route.js

@@ -0,0 +1,91 @@
+import fs from 'fs';
+import path from 'path';
+import {escapeRegexp} from './utils/escape-regexp.js';
+import {InvalidArgumentError} from '@e22m4u/js-format';
+
+/**
+ * Static route.
+ */
+export class StaticRoute {
+  /**
+   * Remote path.
+   *
+   * @type {string}
+   */
+  remotePath;
+
+  /**
+   * Resource path.
+   *
+   * @type {string}
+   */
+  resourcePath;
+
+  /**
+   * RegExp.
+   *
+   * @type {RegExp}
+   */
+  regexp;
+
+  /**
+   * Is file.
+   *
+   * @type {boolean}
+   */
+  isFile;
+
+  /**
+   * Constructor.
+   *
+   * @param {string} routeDef
+   */
+  constructor(routeDef) {
+    if (!routeDef || typeof routeDef !== 'object' || Array.isArray(routeDef)) {
+      throw new InvalidArgumentError(
+        'Parameter "routeDef" must be an Object, but %v was given.',
+        routeDef,
+      );
+    }
+    // remotePath
+    if (typeof routeDef.remotePath !== 'string') {
+      throw new InvalidArgumentError(
+        'Option "remotePath" must be a String, but %v was given.',
+        routeDef.remotePath,
+      );
+    }
+    if (!routeDef.remotePath.startsWith('/')) {
+      throw new InvalidArgumentError(
+        'Option "remotePath" must starts with "/", but %v was given.',
+        routeDef.remotePath,
+      );
+    }
+    // resourcePath
+    if (typeof routeDef.resourcePath !== 'string') {
+      throw new InvalidArgumentError(
+        'Option "resourcePath" must be a String, but %v was given.',
+        routeDef.resourcePath,
+      );
+    }
+    const resourcePath = path.resolve(routeDef.resourcePath);
+    let stats;
+    try {
+      stats = fs.statSync(resourcePath);
+    } catch (error) {
+      console.error(error);
+      throw new InvalidArgumentError(
+        'Resource path %v does not exist.',
+        resourcePath,
+      );
+    }
+    const isFile = stats.isFile();
+    const escapedRemotePath = escapeRegexp(routeDef.remotePath);
+    const regexp = isFile
+      ? new RegExp(`^${escapedRemotePath}$`)
+      : new RegExp(`^${escapedRemotePath}(?:$|\\/)`);
+    this.remotePath = routeDef.remotePath;
+    this.resourcePath = resourcePath;
+    this.regexp = regexp;
+    this.isFile = isFile;
+  }
+}

package/src/utils/get-pathname-from-url.d.ts

@@ -0,0 +1,7 @@
+
+/**
+ * Get pathname from url.
+ *
+ * @param request
+ */
+export declare function getPathnameFromUrl(url: string): string;

package/src/utils/get-pathname-from-url.js

@@ -0,0 +1,27 @@
+import {InvalidArgumentError} from '@e22m4u/js-format';
+
+/**
+ * Host RegExp.
+ */
+const HOST_RE = /^https?:\/\/[^/]+/;
+
+/**
+ * Query string RegExp.
+ */
+const QUERY_STRING_RE = /\?.*$/;
+
+/**
+ * Get pathname from url.
+ *
+ * @param {string} url
+ * @returns {string}
+ */
+export function getPathnameFromUrl(url) {
+  if (typeof url !== 'string') {
+    throw new InvalidArgumentError(
+      'Parameter "url" must be a String, but %v was given.',
+      url,
+    );
+  }
+  return url.replace(HOST_RE, '').replace(QUERY_STRING_RE, '');
+}

package/src/utils/get-request-pathname.spec.js

@@ -0,0 +1,37 @@
+import {expect} from 'chai';
+import {format} from '@e22m4u/js-format';
+import {getPathnameFromUrl} from './get-pathname-from-url.js';
+
+describe('getPathnameFromUrl', function () {
+  it('should require the parameter "request" to be a String', function () {
+    const throwable = v => () => getPathnameFromUrl(v);
+    const error = v =>
+      format('Parameter "url" must be a String, but %s was given.', v);
+    expect(throwable(10)).to.throw(error('10'));
+    expect(throwable(0)).to.throw(error('0'));
+    expect(throwable(true)).to.throw(error('true'));
+    expect(throwable(false)).to.throw(error('false'));
+    expect(throwable(null)).to.throw(error('null'));
+    expect(throwable({})).to.throw(error('Object'));
+    expect(throwable([])).to.throw(error('Array'));
+    expect(throwable(undefined)).to.throw(error('undefined'));
+    throwable('str')();
+    throwable('')();
+  });
+
+  it('should return a pathname without a query string', function () {
+    const res1 = getPathnameFromUrl('pathname?foo=bar');
+    const res2 = getPathnameFromUrl('/pathname?foo=bar');
+    const res3 = getPathnameFromUrl('http://example.com/pathname?foo=bar');
+    expect(res1).to.be.eq('pathname');
+    expect(res2).to.be.eq('/pathname');
+    expect(res3).to.be.eq('/pathname');
+  });
+
+  it('should preserve a trailing slash', function () {
+    const res1 = getPathnameFromUrl('/pathname/');
+    expect(res1).to.be.eq('/pathname/');
+    const res2 = getPathnameFromUrl('/pathname/?foo=bar');
+    expect(res2).to.be.eq('/pathname/');
+  });
+});

package/src/utils/index.d.ts

@@ -1,2 +1,2 @@
 export * from './escape-regexp.js';
-export * from './normalize-path.js';
+export * from './get-pathname-from-url.js';

package/src/utils/index.js

@@ -1,2 +1,2 @@
 export * from './escape-regexp.js';
-export * from './normalize-path.js';
+export * from './get-pathname-from-url.js';

package/example/static/nested/index.html

@@ -1,10 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <title>Index Page</title>
-</head>
-<body>
-    <h1>Index Page</h1>
-    <p>at /static/nested/index.html</p>
-</body>
-</html>

package/src/types.d.ts

@@ -1,38 +0,0 @@
-/**
- * A callable type with the "new" operator
- * that allows class and constructor types.
- */
-export interface Constructor<T = object> {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  new (...args: any[]): T;
-}
-
-/**
- * An object prototype that excludes
- * function and scalar values.
- */
-export type Prototype<T = object> = T &
-  object & {bind?: never} & {
-    call?: never;
-  } & {prototype?: object};
-
-/**
- * A function type without class and constructor.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type Callable<T = unknown> = (...args: any[]) => T;
-
-/**
- * Makes a specific property of T as optional.
- */
-export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-
-/**
- * A part of the Flatten type.
- */
-export type Identity<T> = T;
-
-/**
- * Makes T more human-readable.
- */
-export type Flatten<T> = Identity<{[k in keyof T]: T[k]}>;

package/src/utils/normalize-path.d.ts

@@ -1,12 +0,0 @@
-/**
- * Normalize path.
- *
- * Заменяет любые повторяющиеся слеши на один.
- * Удаляет пробельные символы в начале и конце.
- * Удаляет слеш в конце строки.
- * Гарантирует слеш в начале строки (по умолчанию).
- *
- * @param value
- * @param noStartingSlash
- */
-export function normalizePath(value: string, noStartingSlash?: boolean): string;

package/src/utils/normalize-path.js

@@ -1,22 +0,0 @@
-/**
- * Normalize path.
- *
- * Заменяет любые повторяющиеся слеши на один.
- * Удаляет пробельные символы в начале и конце.
- * Удаляет слеш в конце строки.
- * Гарантирует слеш в начале строки (по умолчанию).
- *
- * @param {string} value
- * @param {boolean} [noStartingSlash]
- * @returns {string}
- */
-export function normalizePath(value, noStartingSlash = false) {
-  if (typeof value !== 'string') {
-    return '/';
-  }
-  const res = value
-    .trim()
-    .replace(/\/+/g, '/')
-    .replace(/(^\/|\/$)/g, '');
-  return noStartingSlash ? res : '/' + res;
-}