@ms-cloudpack/create-express-app 1.6.31 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/createExpressApp.d.ts +26 -5
- package/lib/createExpressApp.d.ts.map +1 -1
- package/lib/createExpressApp.js +30 -18
- package/lib/createExpressApp.js.map +1 -1
- package/lib/getDomain.d.ts +3 -6
- package/lib/getDomain.d.ts.map +1 -1
- package/lib/getDomain.js +9 -15
- package/lib/getDomain.js.map +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js.map +1 -1
- package/package.json +3 -3
|
@@ -1,26 +1,47 @@
|
|
|
1
1
|
import type { HttpsConfig } from '@ms-cloudpack/common-types';
|
|
2
2
|
import { type Express } from 'express';
|
|
3
3
|
import type { Server } from 'http';
|
|
4
|
-
export
|
|
4
|
+
export interface CreateExpressAppOptions {
|
|
5
|
+
/** Port(s) to try */
|
|
5
6
|
portRange?: number | number[];
|
|
7
|
+
/** Throw an error if none of the ports specified in `portRange` are available. */
|
|
6
8
|
requireSpecifiedPort?: boolean;
|
|
9
|
+
/**
|
|
10
|
+
* Hostname to use for the server. Supports replacement `{ip}` for the current IP address.
|
|
11
|
+
* @default 'localhost'
|
|
12
|
+
*/
|
|
7
13
|
hostname?: string;
|
|
14
|
+
/** Include these headers with all responses */
|
|
8
15
|
requestHeaders?: Record<string, string>;
|
|
9
|
-
cwd
|
|
16
|
+
/** cwd for resolving any relative paths in `sslOptions` */
|
|
17
|
+
cwd?: string;
|
|
18
|
+
/** Options for an HTTPS server. Certificate paths support tokens `{homedir}` and `{tmpdir}`. */
|
|
10
19
|
sslOptions?: HttpsConfig;
|
|
20
|
+
/** @deprecated use returned `app` */
|
|
11
21
|
setupCallback?: (app: Express, baseUrl: string) => void | Promise<void>;
|
|
22
|
+
/** Path of any static assets */
|
|
12
23
|
publicDir?: string;
|
|
24
|
+
/** @deprecated Inferred based on presence of `server` */
|
|
13
25
|
middlewareMode?: boolean;
|
|
26
|
+
/** If provided, act as a middleware on this server, rather than starting a new server */
|
|
14
27
|
server?: Server;
|
|
15
|
-
}
|
|
28
|
+
}
|
|
29
|
+
export interface CreateExpressAppResult {
|
|
16
30
|
app: Express;
|
|
17
|
-
|
|
31
|
+
/** http or https server */
|
|
32
|
+
server: Server;
|
|
33
|
+
/** Close the server */
|
|
18
34
|
close: () => Promise<void>;
|
|
35
|
+
/** Base URL of the app */
|
|
19
36
|
url: string;
|
|
37
|
+
/** @deprecated use `url` */
|
|
20
38
|
baseUrl: string;
|
|
21
39
|
protocol: 'http' | 'https';
|
|
40
|
+
/** Domain (no protocol or port) the app is running on */
|
|
22
41
|
domain: string;
|
|
42
|
+
/** Port the app is running on */
|
|
23
43
|
port: number;
|
|
24
|
-
}
|
|
44
|
+
}
|
|
45
|
+
export declare function createExpressApp(options: CreateExpressAppOptions): Promise<CreateExpressAppResult>;
|
|
25
46
|
export type { Express };
|
|
26
47
|
//# sourceMappingURL=createExpressApp.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createExpressApp.d.ts","sourceRoot":"","sources":["../src/createExpressApp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAG9D,OAAgB,EAAE,KAAK,OAAO,EAAE,MAAM,SAAS,CAAC;AAEhD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAMnC,
|
|
1
|
+
{"version":3,"file":"createExpressApp.d.ts","sourceRoot":"","sources":["../src/createExpressApp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAG9D,OAAgB,EAAE,KAAK,OAAO,EAAE,MAAM,SAAS,CAAC;AAEhD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAMnC,MAAM,WAAW,uBAAuB;IACtC,qBAAqB;IACrB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,kFAAkF;IAClF,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+CAA+C;IAC/C,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,gGAAgG;IAChG,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,qCAAqC;IACrC,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yFAAyF;IACzF,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,OAAO,CAAC;IACb,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAuGxG;AAED,YAAY,EAAE,OAAO,EAAE,CAAC"}
|
package/lib/createExpressApp.js
CHANGED
|
@@ -6,17 +6,22 @@ import https from 'https';
|
|
|
6
6
|
import { parseHttpsConfig } from './parseHttpsConfig.js';
|
|
7
7
|
import { getDomain } from './getDomain.js';
|
|
8
8
|
export async function createExpressApp(options) {
|
|
9
|
-
const {
|
|
9
|
+
const {
|
|
10
|
+
// eslint-disable-next-line etc/no-deprecated
|
|
11
|
+
setupCallback, hostname, requestHeaders = {}, cwd = '', sslOptions, requireSpecifiedPort, publicDir, portRange: ports, } = options;
|
|
12
|
+
if (sslOptions && !cwd) {
|
|
13
|
+
throw new Error('Must provide `cwd` when `sslOptions` are provided');
|
|
14
|
+
}
|
|
10
15
|
const portRange = typeof ports === 'number' ? [ports] : ports;
|
|
11
|
-
if (requireSpecifiedPort &&
|
|
12
|
-
throw new Error('
|
|
16
|
+
if (requireSpecifiedPort && !portRange?.length) {
|
|
17
|
+
throw new Error('Must specify a portRange when requireSpecifiedPort is true');
|
|
13
18
|
}
|
|
14
19
|
// Get the available port.
|
|
15
20
|
const port = await getPort({
|
|
16
21
|
port: portRange,
|
|
17
22
|
});
|
|
18
|
-
if (requireSpecifiedPort &&
|
|
19
|
-
throw new Error(
|
|
23
|
+
if (requireSpecifiedPort && !portRange?.includes(port)) {
|
|
24
|
+
throw new Error(`No ports from portRange ${JSON.stringify(portRange)} are available`);
|
|
20
25
|
}
|
|
21
26
|
const app = express();
|
|
22
27
|
// Use cors.
|
|
@@ -34,25 +39,30 @@ export async function createExpressApp(options) {
|
|
|
34
39
|
}
|
|
35
40
|
const domain = getDomain(hostname);
|
|
36
41
|
let server = options.server;
|
|
37
|
-
const
|
|
42
|
+
const isHttps = !!sslOptions && Object.keys(sslOptions).length !== 0;
|
|
43
|
+
const protocol = isHttps ? 'https' : 'http';
|
|
38
44
|
let url = `${protocol}://${domain}`;
|
|
39
|
-
if ((
|
|
45
|
+
if ((isHttps && port !== 443) || (!isHttps && port !== 80)) {
|
|
40
46
|
url += `:${port}`;
|
|
41
47
|
}
|
|
42
48
|
// Call setup callback with the app.
|
|
43
49
|
await setupCallback?.(app, url);
|
|
44
|
-
if (!
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
50
|
+
if (!server) {
|
|
51
|
+
if (isHttps) {
|
|
52
|
+
// Create an HTTPS server.
|
|
53
|
+
const httpsServer = https.createServer(parseHttpsConfig(sslOptions, cwd), app);
|
|
54
|
+
server = httpsServer.listen(port, domain);
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
// Create an HTTP server.
|
|
58
|
+
server = app.listen(port, domain);
|
|
59
|
+
}
|
|
52
60
|
}
|
|
53
|
-
// Track
|
|
61
|
+
// Track new connections so that we can close them and exit cleanly on ctrl+C.
|
|
62
|
+
// (Calling close() on an express server simply stops it from accepting new connections;
|
|
63
|
+
// it doesn't close existing keep-alive connections, which makes the CLI hang on exit.)
|
|
54
64
|
const sockets = new Set();
|
|
55
|
-
server
|
|
65
|
+
server.on('connection', (socket) => {
|
|
56
66
|
sockets.add(socket);
|
|
57
67
|
socket.on('close', () => {
|
|
58
68
|
sockets.delete(socket);
|
|
@@ -66,7 +76,9 @@ export async function createExpressApp(options) {
|
|
|
66
76
|
socket.destroy();
|
|
67
77
|
}
|
|
68
78
|
sockets.clear();
|
|
69
|
-
await new Promise((resolve, reject) =>
|
|
79
|
+
await new Promise((resolve, reject) => {
|
|
80
|
+
server.close((err) => (err ? reject(err) : resolve()));
|
|
81
|
+
});
|
|
70
82
|
},
|
|
71
83
|
url,
|
|
72
84
|
baseUrl: url,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createExpressApp.js","sourceRoot":"","sources":["../src/createExpressApp.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,OAAyB,MAAM,SAAS,CAAC;AAChD,OAAO,OAAO,MAAM,UAAU,CAAC;AAE/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"createExpressApp.js","sourceRoot":"","sources":["../src/createExpressApp.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,OAAyB,MAAM,SAAS,CAAC;AAChD,OAAO,OAAO,MAAM,UAAU,CAAC;AAE/B,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AA6C3C,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,OAAgC;IACrE,MAAM;IACJ,6CAA6C;IAC7C,aAAa,EACb,QAAQ,EACR,cAAc,GAAG,EAAE,EACnB,GAAG,GAAG,EAAE,EACR,UAAU,EACV,oBAAoB,EACpB,SAAS,EACT,SAAS,EAAE,KAAK,GACjB,GAAG,OAAO,CAAC;IAEZ,IAAI,UAAU,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAE9D,IAAI,oBAAoB,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;IAChF,CAAC;IAED,0BAA0B;IAC1B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC;QACzB,IAAI,EAAE,SAAS;KAChB,CAAC,CAAC;IAEH,IAAI,oBAAoB,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IAEtB,YAAY;IACZ,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAEhB,mBAAmB;IACnB,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IAEvB,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACvB,KAAK,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YACvE,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IAEH,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;IACnC,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC5B,MAAM,OAAO,GAAG,CAAC,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,GAAG,GAAG,GAAG,QAAQ,MAAM,MAAM,EAAE,CAAC;IAEpC,IAAI,CAAC,OAAO,IAAI,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,IAAI,KAAK,EAAE,CAAC,EAAE,CAAC;QAC3D,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;IACpB,CAAC;IACD,oCAAoC;IACpC,MAAM,aAAa,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAEhC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,IAAI,OAAO,EAAE,CAAC;YACZ,0BAA0B;YAC1B,MAAM,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,gBAAgB,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;YAC/E,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,yBAAyB;YACzB,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,wFAAwF;IACxF,uFAAuF;IACvF,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QACjC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACtB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,GAAG;QACH,MAAM;QACN,KAAK,CAAC,KAAK;YACT,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,CAAC;YACD,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC1C,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;QACL,CAAC;QACD,GAAG;QACH,OAAO,EAAE,GAAG;QACZ,QAAQ;QACR,MAAM;QACN,IAAI;KACL,CAAC;AACJ,CAAC","sourcesContent":["import type { HttpsConfig } from '@ms-cloudpack/common-types';\nimport compression from 'compression';\nimport cors from 'cors';\nimport express, { type Express } from 'express';\nimport getPort from 'get-port';\nimport type { Server } from 'http';\nimport https from 'https';\nimport type { Socket } from 'net';\nimport { parseHttpsConfig } from './parseHttpsConfig.js';\nimport { getDomain } from './getDomain.js';\n\nexport interface CreateExpressAppOptions {\n /** Port(s) to try */\n portRange?: number | number[];\n /** Throw an error if none of the ports specified in `portRange` are available. */\n requireSpecifiedPort?: boolean;\n /**\n * Hostname to use for the server. Supports replacement `{ip}` for the current IP address.\n * @default 'localhost'\n */\n hostname?: string;\n /** Include these headers with all responses */\n requestHeaders?: Record<string, string>;\n /** cwd for resolving any relative paths in `sslOptions` */\n cwd?: string;\n /** Options for an HTTPS server. Certificate paths support tokens `{homedir}` and `{tmpdir}`. */\n sslOptions?: HttpsConfig;\n /** @deprecated use returned `app` */\n setupCallback?: (app: Express, baseUrl: string) => void | Promise<void>;\n /** Path of any static assets */\n publicDir?: string;\n /** @deprecated Inferred based on presence of `server` */\n middlewareMode?: boolean;\n /** If provided, act as a middleware on this server, rather than starting a new server */\n server?: Server;\n}\n\nexport interface CreateExpressAppResult {\n app: Express;\n /** http or https server */\n server: Server;\n /** Close the server */\n close: () => Promise<void>;\n /** Base URL of the app */\n url: string;\n /** @deprecated use `url` */\n baseUrl: string;\n protocol: 'http' | 'https';\n /** Domain (no protocol or port) the app is running on */\n domain: string;\n /** Port the app is running on */\n port: number;\n}\n\nexport async function createExpressApp(options: CreateExpressAppOptions): Promise<CreateExpressAppResult> {\n const {\n // eslint-disable-next-line etc/no-deprecated\n setupCallback,\n hostname,\n requestHeaders = {},\n cwd = '',\n sslOptions,\n requireSpecifiedPort,\n publicDir,\n portRange: ports,\n } = options;\n\n if (sslOptions && !cwd) {\n throw new Error('Must provide `cwd` when `sslOptions` are provided');\n }\n\n const portRange = typeof ports === 'number' ? [ports] : ports;\n\n if (requireSpecifiedPort && !portRange?.length) {\n throw new Error('Must specify a portRange when requireSpecifiedPort is true');\n }\n\n // Get the available port.\n const port = await getPort({\n port: portRange,\n });\n\n if (requireSpecifiedPort && !portRange?.includes(port)) {\n throw new Error(`No ports from portRange ${JSON.stringify(portRange)} are available`);\n }\n\n const app = express();\n\n // Use cors.\n app.use(cors());\n\n // Use compression.\n app.use(compression());\n\n app.use((_, res, next) => {\n for (const [headerName, headerValue] of Object.entries(requestHeaders)) {\n res.setHeader(headerName, headerValue);\n }\n next();\n });\n\n if (publicDir !== undefined) {\n app.use(express.static(publicDir, { index: false }));\n }\n\n const domain = getDomain(hostname);\n let server = options.server;\n const isHttps = !!sslOptions && Object.keys(sslOptions).length !== 0;\n const protocol = isHttps ? 'https' : 'http';\n let url = `${protocol}://${domain}`;\n\n if ((isHttps && port !== 443) || (!isHttps && port !== 80)) {\n url += `:${port}`;\n }\n // Call setup callback with the app.\n await setupCallback?.(app, url);\n\n if (!server) {\n if (isHttps) {\n // Create an HTTPS server.\n const httpsServer = https.createServer(parseHttpsConfig(sslOptions, cwd), app);\n server = httpsServer.listen(port, domain);\n } else {\n // Create an HTTP server.\n server = app.listen(port, domain);\n }\n }\n\n // Track new connections so that we can close them and exit cleanly on ctrl+C.\n // (Calling close() on an express server simply stops it from accepting new connections;\n // it doesn't close existing keep-alive connections, which makes the CLI hang on exit.)\n const sockets = new Set<Socket>();\n server.on('connection', (socket) => {\n sockets.add(socket);\n socket.on('close', () => {\n sockets.delete(socket);\n });\n });\n\n return {\n app,\n server,\n async close() {\n for (const socket of sockets) {\n socket.destroy();\n }\n sockets.clear();\n await new Promise<void>((resolve, reject) => {\n server.close((err) => (err ? reject(err) : resolve()));\n });\n },\n url,\n baseUrl: url,\n protocol,\n domain,\n port,\n };\n}\n\nexport type { Express };\n"]}
|
package/lib/getDomain.d.ts
CHANGED
|
@@ -1,10 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
* If undefined or empty, returns 'localhost'.
|
|
6
|
-
* @param str The string to parse.
|
|
7
|
-
* @returns The domain.
|
|
2
|
+
* Get the domain from the given string, replacing the `{ip}` symbol with the current IP.
|
|
3
|
+
* Defaults to 'localhost'.
|
|
4
|
+
* @returns The domain (no protocol)
|
|
8
5
|
*/
|
|
9
6
|
export declare function getDomain(str: string | undefined): string;
|
|
10
7
|
//# sourceMappingURL=getDomain.d.ts.map
|
package/lib/getDomain.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getDomain.d.ts","sourceRoot":"","sources":["../src/getDomain.ts"],"names":[],"mappings":"AAQA
|
|
1
|
+
{"version":3,"file":"getDomain.d.ts","sourceRoot":"","sources":["../src/getDomain.ts"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAIzD"}
|
package/lib/getDomain.js
CHANGED
|
@@ -5,12 +5,9 @@ const addressSymbols = {
|
|
|
5
5
|
ip: () => getLocalIP(),
|
|
6
6
|
};
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* If undefined or empty, returns 'localhost'.
|
|
12
|
-
* @param str The string to parse.
|
|
13
|
-
* @returns The domain.
|
|
8
|
+
* Get the domain from the given string, replacing the `{ip}` symbol with the current IP.
|
|
9
|
+
* Defaults to 'localhost'.
|
|
10
|
+
* @returns The domain (no protocol)
|
|
14
11
|
*/
|
|
15
12
|
export function getDomain(str) {
|
|
16
13
|
if (!str)
|
|
@@ -21,16 +18,13 @@ export function getDomain(str) {
|
|
|
21
18
|
function getLocalIP() {
|
|
22
19
|
const networkInterfaces = os.networkInterfaces();
|
|
23
20
|
for (const nets of Object.values(networkInterfaces)) {
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
if (net.family === 'IPv4' && !net.internal) {
|
|
29
|
-
return net.address;
|
|
30
|
-
}
|
|
21
|
+
// Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
|
|
22
|
+
const net = nets?.find((n) => n.family === 'IPv4' && !n.internal);
|
|
23
|
+
if (net) {
|
|
24
|
+
return net.address;
|
|
31
25
|
}
|
|
32
26
|
}
|
|
33
|
-
|
|
34
|
-
|
|
27
|
+
// Throw an error to avoid creating a server with an unexpected URL
|
|
28
|
+
throw new Error('Failed to get local IP address.');
|
|
35
29
|
}
|
|
36
30
|
//# sourceMappingURL=getDomain.js.map
|
package/lib/getDomain.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getDomain.js","sourceRoot":"","sources":["../src/getDomain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,6BAA6B;AAC7B,6DAA6D;AAC7D,MAAM,cAAc,
|
|
1
|
+
{"version":3,"file":"getDomain.js","sourceRoot":"","sources":["../src/getDomain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AAEpB,6BAA6B;AAC7B,6DAA6D;AAC7D,MAAM,cAAc,GAAiC;IACnD,EAAE,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAuB;IAC/C,IAAI,CAAC,GAAG;QAAE,OAAO,WAAW,CAAC;IAC7B,+BAA+B;IAC/B,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,MAAc,EAAE,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,KAAK,CAAC,CAAC;AAC/F,CAAC;AAED,SAAS,UAAU;IACjB,MAAM,iBAAiB,GAAG,EAAE,CAAC,iBAAiB,EAAE,CAAC;IAEjD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACpD,6DAA6D;QAC7D,MAAM,GAAG,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,GAAG,CAAC,OAAO,CAAC;QACrB,CAAC;IACH,CAAC;IAED,mEAAmE;IACnE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import os from 'os';\n\n// Supported address symbols:\n// These are functions to not call them if they are not used.\nconst addressSymbols: Record<string, () => string> = {\n ip: () => getLocalIP(),\n};\n\n/**\n * Get the domain from the given string, replacing the `{ip}` symbol with the current IP.\n * Defaults to 'localhost'.\n * @returns The domain (no protocol)\n */\nexport function getDomain(str: string | undefined): string {\n if (!str) return 'localhost';\n // Replace the address symbols.\n return str.replace(/{(\\w+)}/g, (match, symbol: string) => addressSymbols[symbol]() || match);\n}\n\nfunction getLocalIP(): string {\n const networkInterfaces = os.networkInterfaces();\n\n for (const nets of Object.values(networkInterfaces)) {\n // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses\n const net = nets?.find((n) => n.family === 'IPv4' && !n.internal);\n if (net) {\n return net.address;\n }\n }\n\n // Throw an error to avoid creating a server with an unexpected URL\n throw new Error('Failed to get local IP address.');\n}\n"]}
|
package/lib/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as express from 'express';
|
|
2
2
|
import type { HttpsConfig as _HttpsConfig } from '@ms-cloudpack/common-types';
|
|
3
3
|
export type { Express, Request, Response, Router } from 'express';
|
|
4
|
-
export { createExpressApp } from './createExpressApp.js';
|
|
4
|
+
export { createExpressApp, type CreateExpressAppOptions, type CreateExpressAppResult } from './createExpressApp.js';
|
|
5
5
|
export { parseHttpsConfig } from './parseHttpsConfig.js';
|
|
6
6
|
export { getDomain } from './getDomain.js';
|
|
7
7
|
export { express };
|
package/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,EAAE,WAAW,IAAI,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE9E,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,EAAE,WAAW,IAAI,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE9E,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,KAAK,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACpH,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB,2DAA2D;AAC3D,MAAM,MAAM,WAAW,GAAG,YAAY,CAAC"}
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAInC,OAAO,EAAE,gBAAgB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAInC,OAAO,EAAE,gBAAgB,EAA6D,MAAM,uBAAuB,CAAC;AACpH,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,CAAC","sourcesContent":["import * as express from 'express';\nimport type { HttpsConfig as _HttpsConfig } from '@ms-cloudpack/common-types';\n\nexport type { Express, Request, Response, Router } from 'express';\nexport { createExpressApp, type CreateExpressAppOptions, type CreateExpressAppResult } from './createExpressApp.js';\nexport { parseHttpsConfig } from './parseHttpsConfig.js';\nexport { getDomain } from './getDomain.js';\nexport { express };\n\n/** @deprecated Import from `@ms-cloudpack/common-types` */\nexport type HttpsConfig = _HttpsConfig;\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ms-cloudpack/create-express-app",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.0",
|
|
4
4
|
"description": "Helper for creating an express app server, abstracting a common plugin setup.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
}
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@ms-cloudpack/common-types": "^0.13.
|
|
17
|
+
"@ms-cloudpack/common-types": "^0.13.3",
|
|
18
18
|
"@ms-cloudpack/path-string-parsing": "^1.2.3",
|
|
19
|
-
"@ms-cloudpack/path-utilities": "^2.7.
|
|
19
|
+
"@ms-cloudpack/path-utilities": "^2.7.29",
|
|
20
20
|
"@types/express": "^4.17.16",
|
|
21
21
|
"compression": "^1.7.4",
|
|
22
22
|
"cors": "^2.8.5",
|