@genesislcap/build-kit 14.144.1-alpha-82ebae3.0 → 14.144.1

package/README.md

@@ -17,9 +17,23 @@ Build context contains user configuration, CLI command details (dev/prod/analyze
 
 See [@genesislcap/ts-builder](../ts-builder/README.md) for an example.
 
+# Development SSL Certificates
+
+`@genesislcap/build-kit` bundles a `localhost.crt` and `localhost.key` file which bundlers may apply to their development server options.
+
+```ts
+import { getDevCertOptions } from '@genesislcap/build-kit';
+...
+{
+  options: getDevCertOptions(),
+}
+```
+
+Please follow the [Development-SSL-Certificate](https://www.notion.so/genesisglobal/Development-SSL-Certificates-30cfd42948674d0db511d04c1adb59db) guide to complete local machine setup.
+
 ## License
 
 Note: this project provides front end dependencies and uses licensed components listed in the next section, thus licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
-Genesis low-code platform
+Genesis low-code platform

package/cert/localhost.crt

@@ -0,0 +1,25 @@
+-----BEGIN CERTIFICATE-----
+MIIEKzCCApOgAwIBAgIRAJ2DkMm20NkXjwvT0PHJCo0wDQYJKoZIhvcNAQELBQAw
+YzEeMBwGA1UEChMVbWtjZXJ0IGRldmVsb3BtZW50IENBMRwwGgYDVQQLDBNydW5u
+ZXJAZnYtYXozMzktNjA5MSMwIQYDVQQDDBpta2NlcnQgcnVubmVyQGZ2LWF6MzM5
+LTYwOTAeFw0yMjEyMjIwODMxNTRaFw0yNTAzMjIwODMxNTRaMEcxJzAlBgNVBAoT
+Hm1rY2VydCBkZXZlbG9wbWVudCBjZXJ0aWZpY2F0ZTEcMBoGA1UECwwTcnVubmVy
+QGZ2LWF6NDE3LTI0MTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAN4X
+hSYzKgfdIeeeMg5jpYNUJVXDjkpWI5cz73nvNztW0GAZi7vn+ts2iheP26eY4dI7
+XaynT7JXqkqabJxFz5McgvPye9KV0foTBfTXy1Gg5AnsEgrni1zNmmJna6zB0Ybm
+aMAeFfcOR+suhFti13R5ppstgg1MgzFWsaJYNSfziBqyj7E9CTBRWmPKIrzzdsQl
+LBriGuLrgPesIdKfYfEgy5tHJLNgpQVwTGSzibknZdmSU+T9da7hfmiOtcKq1E3J
+PMwIThxmh9QCDlqsKh+5qywagVllG2OaUQxJfGrq5Ihe56XzG/2ZeZuZl8H+NM3o
+Rw2fMosW1g0pVEkazR0CAwEAAaN2MHQwDgYDVR0PAQH/BAQDAgWgMBMGA1UdJQQM
+MAoGCCsGAQUFBwMBMB8GA1UdIwQYMBaAFA2vMaRHhWB/nx6U6EphkwufFZpJMCwG
+A1UdEQQlMCOCCWxvY2FsaG9zdIcEfwAAAYcQAAAAAAAAAAAAAAAAAAAAATANBgkq
+hkiG9w0BAQsFAAOCAYEAmp0smvtKBB3rbmKpOTaGQ4hPur2ezfU2xt121k2x4lpL
+q/YmdwEm69j/ewJNI2oPvTgoWKCECJ5tEr/e0a0En8SaXKRZal2Px4VmCTssUOyh
+DXJj0V2Wkk79dbKjAqSnwoAif6lxDzwdZywXPecWx1cwGI78LDzCQ/AuCQXYFVAw
+ffjPDau8rI+8kn/q4aWbIFbgpgUQ80F6zS7/ZYPMLQvcu5SuspzMzV0lMhCOUWff
+nMJJpT+3JoHIEfBCAFPfsK83ELGIKM1ghDU8Z9qnNFTCxUhhv0JfiGzRoTYSjby7
+LYtiFn4/6QBrTqLNyymRCCArehHCHUVPRlPvLuHsTLw7vPT14DK/bngeUqrFDJZE
+35qJyB8TKY2pk7hl8svRGmyagScF+hG/0V/imb0hmvuNqpW64ooqTb1J0HJSxKHz
+f3GDwWNVRjMeolMeZKe52/dqaGJLgATdHxKxX9geQ/RswUHd3UYFzUqeuje9xTQ/
+0Y96jGaZZ3P/WXp4NGYl
+-----END CERTIFICATE-----

package/cert/localhost.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDeF4UmMyoH3SHn
+njIOY6WDVCVVw45KViOXM+957zc7VtBgGYu75/rbNooXj9unmOHSO12sp0+yV6pK
+mmycRc+THILz8nvSldH6EwX018tRoOQJ7BIK54tczZpiZ2uswdGG5mjAHhX3Dkfr
+LoRbYtd0eaabLYINTIMxVrGiWDUn84gaso+xPQkwUVpjyiK883bEJSwa4hri64D3
+rCHSn2HxIMubRySzYKUFcExks4m5J2XZklPk/XWu4X5ojrXCqtRNyTzMCE4cZofU
+Ag5arCofuassGoFZZRtjmlEMSXxq6uSIXuel8xv9mXmbmZfB/jTN6EcNnzKLFtYN
+KVRJGs0dAgMBAAECggEAUrGLQEf4tGjgAO/kT3tG23lvVVm1F3SvV9NcrZgmho+y
+krWwU8zymMDb9h34eZTxMGguXuUFRbBildid7CoKOgp5r/9vn19tiaGfrCTVbZVs
+k001Ap5oQ6vCejVr4C1iqMoN4srQ/uZwXN87JRPOiW3qXQk6zVzZ1HslNP+G+1J+
+Q5FeaLei+nZzY+Aug8u/l1+FaE09m8xt7Rghn1sEg7IFdP+7pImkrzuykT0ceE+g
+XkQNk2YcChGuF3pV0fyXzWwwR5rYoxEtbNrc42pBTEiBtKqh6GjHjJCkqMeVQvuy
+d1PMWxyXyu2HqtzddDHVknAFlRy9KSc80AgyQOSAeQKBgQDfuPXBGbJiXewHygyX
+TkEXmGrAxQ8+Gxn8blj6LzALNjjGDiW9CwbxmVWdMbEBE3lUZi92erCYLFZUPXTa
+BdPsE1dki2T2eVWVwK/qoc44IBDCJ3LtjfODNi5OaTBvAUMzI3pYVJS0vwM86ywx
+UF3R54RHGPLdNN0So8k45QDQmwKBgQD+IlWIzigv1SEiEOaqQUoJB0Vfxq2u91eN
+ius5Wj5ONDfNv++mbr3bBuI0Bpg4u7W9i5hJVLE04GtlfjSuOX0QnkbQYu5/NbCH
+Vxw9YUwtOZJlk0kx3H6qpftYgEPwXir7fcuoXFUT7jD+Q5FWvQA76asF9zVnt9RG
+OGoB6FeopwKBgQDP9wZzxyhcakRzhS2pJPQ7M9LgeQ5PRDAmyIjroBvAAFpMOXB5
+R5vf0BKWuk942Zpqi0bJkwk/m89wJWTPGqXCCMSvUSi8OVQGjgS5Tkn9QElzweoC
+y3a23RG0j/GW7oyCKBOdspo9XmZrJY2CFdvwuI7s7FMur+plXl06Bx53ywKBgQDO
+ehjiuRUfn9t2sSKoS7maUkUERwkQcje5cZgiFfcvVO/OBFby82Df1tzshjshRSmp
+IgUN93iuzHOVl4+3yk+Zs+83GlpKEtYlcBoqqKXazL7sNlmu4EYt4gOv6S7J2ci0
+YoWYecRKGCnIPB+WyKKrCvQAOdUzOsGGeAlxGVQ3WwKBgE7fJGLuraf1hHRMuPsS
+ZGnJE93QVWOFCym34lxRWEQ3rKEXMtAhUhq/M6x5sJnv7ePTujyDoPAbAioxLS/L
+GsrvcDc91bwNs7sDTyq//n0ehf2HJMFrbdtIPblxA26dHtX7BmW6eppDhm4OV8zO
+1vSzX8HjCcx1AkcATKDA9J3e
+-----END PRIVATE KEY-----

package/dist/cert/localhost.crt

@@ -0,0 +1,25 @@
+-----BEGIN CERTIFICATE-----
+MIIEKzCCApOgAwIBAgIRAJ2DkMm20NkXjwvT0PHJCo0wDQYJKoZIhvcNAQELBQAw
+YzEeMBwGA1UEChMVbWtjZXJ0IGRldmVsb3BtZW50IENBMRwwGgYDVQQLDBNydW5u
+ZXJAZnYtYXozMzktNjA5MSMwIQYDVQQDDBpta2NlcnQgcnVubmVyQGZ2LWF6MzM5
+LTYwOTAeFw0yMjEyMjIwODMxNTRaFw0yNTAzMjIwODMxNTRaMEcxJzAlBgNVBAoT
+Hm1rY2VydCBkZXZlbG9wbWVudCBjZXJ0aWZpY2F0ZTEcMBoGA1UECwwTcnVubmVy
+QGZ2LWF6NDE3LTI0MTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAN4X
+hSYzKgfdIeeeMg5jpYNUJVXDjkpWI5cz73nvNztW0GAZi7vn+ts2iheP26eY4dI7
+XaynT7JXqkqabJxFz5McgvPye9KV0foTBfTXy1Gg5AnsEgrni1zNmmJna6zB0Ybm
+aMAeFfcOR+suhFti13R5ppstgg1MgzFWsaJYNSfziBqyj7E9CTBRWmPKIrzzdsQl
+LBriGuLrgPesIdKfYfEgy5tHJLNgpQVwTGSzibknZdmSU+T9da7hfmiOtcKq1E3J
+PMwIThxmh9QCDlqsKh+5qywagVllG2OaUQxJfGrq5Ihe56XzG/2ZeZuZl8H+NM3o
+Rw2fMosW1g0pVEkazR0CAwEAAaN2MHQwDgYDVR0PAQH/BAQDAgWgMBMGA1UdJQQM
+MAoGCCsGAQUFBwMBMB8GA1UdIwQYMBaAFA2vMaRHhWB/nx6U6EphkwufFZpJMCwG
+A1UdEQQlMCOCCWxvY2FsaG9zdIcEfwAAAYcQAAAAAAAAAAAAAAAAAAAAATANBgkq
+hkiG9w0BAQsFAAOCAYEAmp0smvtKBB3rbmKpOTaGQ4hPur2ezfU2xt121k2x4lpL
+q/YmdwEm69j/ewJNI2oPvTgoWKCECJ5tEr/e0a0En8SaXKRZal2Px4VmCTssUOyh
+DXJj0V2Wkk79dbKjAqSnwoAif6lxDzwdZywXPecWx1cwGI78LDzCQ/AuCQXYFVAw
+ffjPDau8rI+8kn/q4aWbIFbgpgUQ80F6zS7/ZYPMLQvcu5SuspzMzV0lMhCOUWff
+nMJJpT+3JoHIEfBCAFPfsK83ELGIKM1ghDU8Z9qnNFTCxUhhv0JfiGzRoTYSjby7
+LYtiFn4/6QBrTqLNyymRCCArehHCHUVPRlPvLuHsTLw7vPT14DK/bngeUqrFDJZE
+35qJyB8TKY2pk7hl8svRGmyagScF+hG/0V/imb0hmvuNqpW64ooqTb1J0HJSxKHz
+f3GDwWNVRjMeolMeZKe52/dqaGJLgATdHxKxX9geQ/RswUHd3UYFzUqeuje9xTQ/
+0Y96jGaZZ3P/WXp4NGYl
+-----END CERTIFICATE-----

package/dist/cert/localhost.key

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDeF4UmMyoH3SHn
+njIOY6WDVCVVw45KViOXM+957zc7VtBgGYu75/rbNooXj9unmOHSO12sp0+yV6pK
+mmycRc+THILz8nvSldH6EwX018tRoOQJ7BIK54tczZpiZ2uswdGG5mjAHhX3Dkfr
+LoRbYtd0eaabLYINTIMxVrGiWDUn84gaso+xPQkwUVpjyiK883bEJSwa4hri64D3
+rCHSn2HxIMubRySzYKUFcExks4m5J2XZklPk/XWu4X5ojrXCqtRNyTzMCE4cZofU
+Ag5arCofuassGoFZZRtjmlEMSXxq6uSIXuel8xv9mXmbmZfB/jTN6EcNnzKLFtYN
+KVRJGs0dAgMBAAECggEAUrGLQEf4tGjgAO/kT3tG23lvVVm1F3SvV9NcrZgmho+y
+krWwU8zymMDb9h34eZTxMGguXuUFRbBildid7CoKOgp5r/9vn19tiaGfrCTVbZVs
+k001Ap5oQ6vCejVr4C1iqMoN4srQ/uZwXN87JRPOiW3qXQk6zVzZ1HslNP+G+1J+
+Q5FeaLei+nZzY+Aug8u/l1+FaE09m8xt7Rghn1sEg7IFdP+7pImkrzuykT0ceE+g
+XkQNk2YcChGuF3pV0fyXzWwwR5rYoxEtbNrc42pBTEiBtKqh6GjHjJCkqMeVQvuy
+d1PMWxyXyu2HqtzddDHVknAFlRy9KSc80AgyQOSAeQKBgQDfuPXBGbJiXewHygyX
+TkEXmGrAxQ8+Gxn8blj6LzALNjjGDiW9CwbxmVWdMbEBE3lUZi92erCYLFZUPXTa
+BdPsE1dki2T2eVWVwK/qoc44IBDCJ3LtjfODNi5OaTBvAUMzI3pYVJS0vwM86ywx
+UF3R54RHGPLdNN0So8k45QDQmwKBgQD+IlWIzigv1SEiEOaqQUoJB0Vfxq2u91eN
+ius5Wj5ONDfNv++mbr3bBuI0Bpg4u7W9i5hJVLE04GtlfjSuOX0QnkbQYu5/NbCH
+Vxw9YUwtOZJlk0kx3H6qpftYgEPwXir7fcuoXFUT7jD+Q5FWvQA76asF9zVnt9RG
+OGoB6FeopwKBgQDP9wZzxyhcakRzhS2pJPQ7M9LgeQ5PRDAmyIjroBvAAFpMOXB5
+R5vf0BKWuk942Zpqi0bJkwk/m89wJWTPGqXCCMSvUSi8OVQGjgS5Tkn9QElzweoC
+y3a23RG0j/GW7oyCKBOdspo9XmZrJY2CFdvwuI7s7FMur+plXl06Bx53ywKBgQDO
+ehjiuRUfn9t2sSKoS7maUkUERwkQcje5cZgiFfcvVO/OBFby82Df1tzshjshRSmp
+IgUN93iuzHOVl4+3yk+Zs+83GlpKEtYlcBoqqKXazL7sNlmu4EYt4gOv6S7J2ci0
+YoWYecRKGCnIPB+WyKKrCvQAOdUzOsGGeAlxGVQ3WwKBgE7fJGLuraf1hHRMuPsS
+ZGnJE93QVWOFCym34lxRWEQ3rKEXMtAhUhq/M6x5sJnv7ePTujyDoPAbAioxLS/L
+GsrvcDc91bwNs7sDTyq//n0ehf2HJMFrbdtIPblxA26dHtX7BmW6eppDhm4OV8zO
+1vSzX8HjCcx1AkcATKDA9J3e
+-----END PRIVATE KEY-----

package/dist/utils/https.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+/**
+ * @public
+ */
+export type DevCertOptions = {
+    cert: Buffer;
+    key: Buffer;
+};
+/**
+ * Get default dev cert options.
+ *
+ * @public
+ */
+export declare const getDevCertOptions: () => DevCertOptions | undefined;
+//# sourceMappingURL=https.d.ts.map

package/dist/utils/https.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"https.d.ts","sourceRoot":"","sources":["../../src/utils/https.ts"],"names":[],"mappings":";AAIA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,QAAO,cAAc,GAAG,SAWrD,CAAC"}

package/dist/utils/https.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDevCertOptions = void 0;
+const tslib_1 = require("tslib");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const consola_1 = tslib_1.__importDefault(require("consola"));
+/**
+ * Get default dev cert options.
+ *
+ * @public
+ */
+const getDevCertOptions = () => {
+    const certDir = (0, node_path_1.resolve)(__dirname, '../../cert/');
+    const cert = (0, node_path_1.resolve)(certDir, 'localhost.crt');
+    const key = (0, node_path_1.resolve)(certDir, 'localhost.key');
+    if ((0, node_fs_1.existsSync)(cert) && (0, node_fs_1.existsSync)(key)) {
+        return {
+            cert: (0, node_fs_1.readFileSync)(cert),
+            key: (0, node_fs_1.readFileSync)(key),
+        };
+    }
+    consola_1.default.warn(`Could not load the default development certificates from ${certDir}.`);
+};
+exports.getDevCertOptions = getDevCertOptions;

package/dist/utils/index.d.ts

@@ -8,9 +8,11 @@ export * from './env';
 export * from './federation';
 export * from './fs';
 export * from './handlebars';
+export * from './https';
 export * from './json';
 export * from './npm';
 export * from './prompts';
+export * from './proxy';
 export * from './object';
 export * from './seed.fetching';
 export * from './seed.meta';

package/dist/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,cAAc,CAAC;AAC7B,cAAc,MAAM,CAAC;AACrB,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,cAAc,CAAC;AAC7B,cAAc,MAAM,CAAC;AACrB,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC"}

package/dist/utils/index.js

@@ -11,9 +11,11 @@ tslib_1.__exportStar(require("./env"), exports);
 tslib_1.__exportStar(require("./federation"), exports);
 tslib_1.__exportStar(require("./fs"), exports);
 tslib_1.__exportStar(require("./handlebars"), exports);
+tslib_1.__exportStar(require("./https"), exports);
 tslib_1.__exportStar(require("./json"), exports);
 tslib_1.__exportStar(require("./npm"), exports);
 tslib_1.__exportStar(require("./prompts"), exports);
+tslib_1.__exportStar(require("./proxy"), exports);
 tslib_1.__exportStar(require("./object"), exports);
 tslib_1.__exportStar(require("./seed.fetching"), exports);
 tslib_1.__exportStar(require("./seed.meta"), exports);

package/dist/utils/proxy.d.ts

@@ -0,0 +1,82 @@
+import type { ServerOptions } from 'http-proxy';
+/**
+ * @public
+ */
+export declare const getPort: (packageJson: any) => number;
+/**
+ * @public
+ */
+export declare const convertWsEndpointToHTTP: (endpoint?: string, socketExt?: string) => string;
+/**
+ * Config to create a development proxy for a specific path.
+ *
+ * @public
+ */
+export type DevProxyConfig = {
+    target?: string;
+    path?: string;
+    options?: ServerOptions;
+};
+/**
+ * Config to create development proxies for an array of paths.
+ *
+ * @public
+ */
+export type DevProxiesConfig = Omit<DevProxyConfig, 'path'> & {
+    paths?: string[];
+};
+/**
+ * Object containing entries for each proxy keyed by path.
+ *
+ * @public
+ */
+export type DevProxies = Record<string, ServerOptions> & {};
+/**
+ * Create development proxy for a specific path.
+ *
+ * @example
+ * ```ts
+ * const proxy = createDevProxy({ path: '/sm', target: process.env.API_HOST, options: {...} });
+ * ```
+ *
+ * @remarks
+ * Applicable when running in dev mode and a valid target and path is set.
+ *
+ * @privateRemarks
+ * It is important to guard for the case where neither target nor path is set by returning undefined.
+ * Proxies with empty string targets will cause blow ups in vite, whereas webpack seems to tolerate them.
+ *
+ * @param config - A {@link DevProxyConfig}.
+ * @returns A {@link DevProxies} object or undefined.
+ *
+ * @public
+ */
+export declare const createDevProxy: (config: DevProxyConfig) => DevProxies | undefined;
+/**
+ * Create development proxies for an array of paths.
+ *
+ * @example Create default development proxies
+ * ```ts
+ * const proxy = createDevProxies();
+ * ```
+ *
+ * @example Create custom development proxies
+ * ```ts
+ * const proxy = createDevProxies({ paths: ['/foo', '/bar'], target: 'http://mydomain.com' });
+ * ```
+ *
+ * @remarks
+ * `process.env.API_HOST` will be used as the target if `config.target` is not set. Undefined will be returned if
+ * neither are available.
+ *
+ * @privateRemarks
+ * It is important to guard for the case where neither target nor API_HOST are set by returning undefined.
+ * Proxies with empty string targets will cause blow ups in vite, whereas webpack seems to tolerate them.
+ *
+ * @param config - An optional {@link DevProxiesConfig}.
+ * @returns A {@link DevProxies} object or undefined.
+ *
+ * @public
+ */
+export declare const createDevProxies: (config?: DevProxiesConfig) => DevProxies | undefined;
+//# sourceMappingURL=proxy.d.ts.map

package/dist/utils/proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../src/utils/proxy.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAGhD;;GAEG;AACH,eAAO,MAAM,OAAO,wBAAkB,MACwC,CAAC;AAE/E;;GAEG;AACH,eAAO,MAAM,uBAAuB,mDAGnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,GAAG;IAC5D,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,EAAE,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc,WAAY,cAAc,KAAG,UAAU,GAAG,SAmBpE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,gBAAgB,YAAY,gBAAgB,KAAQ,UAAU,GAAG,SA0B7E,CAAC"}

package/dist/utils/proxy.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDevProxies = exports.createDevProxy = exports.convertWsEndpointToHTTP = exports.getPort = void 0;
+const tslib_1 = require("tslib");
+const consola_1 = tslib_1.__importDefault(require("consola"));
+const portfinder_sync_1 = tslib_1.__importDefault(require("portfinder-sync"));
+/**
+ * @public
+ */
+const getPort = (packageJson) => { var _a; return portfinder_sync_1.default.getPort(((_a = packageJson.config) === null || _a === void 0 ? void 0 : _a.PORT) || process.env.PORT || 9000); };
+exports.getPort = getPort;
+/**
+ * @public
+ */
+const convertWsEndpointToHTTP = (endpoint = '', socketExt = '') => {
+    const protocolUpdate = endpoint.replace(/^ws(s)?:\/\//, 'http$1://');
+    return socketExt ? protocolUpdate.replace(`/${socketExt}`, '') : protocolUpdate;
+};
+exports.convertWsEndpointToHTTP = convertWsEndpointToHTTP;
+/**
+ * Create development proxy for a specific path.
+ *
+ * @example
+ * ```ts
+ * const proxy = createDevProxy({ path: '/sm', target: process.env.API_HOST, options: {...} });
+ * ```
+ *
+ * @remarks
+ * Applicable when running in dev mode and a valid target and path is set.
+ *
+ * @privateRemarks
+ * It is important to guard for the case where neither target nor path is set by returning undefined.
+ * Proxies with empty string targets will cause blow ups in vite, whereas webpack seems to tolerate them.
+ *
+ * @param config - A {@link DevProxyConfig}.
+ * @returns A {@link DevProxies} object or undefined.
+ *
+ * @public
+ */
+const createDevProxy = (config) => {
+    var _a;
+    if (!config.target || !config.path) {
+        return undefined;
+    }
+    const { options, path, target } = config;
+    return {
+        [path]: Object.assign(Object.assign({ target, secure: false, changeOrigin: true, cookieDomainRewrite: 'localhost', ws: true }, (options !== null && options !== void 0 ? options : {})), { headers: Object.assign({ origin: target }, ((_a = options === null || options === void 0 ? void 0 : options.headers) !== null && _a !== void 0 ? _a : {})) }),
+    };
+};
+exports.createDevProxy = createDevProxy;
+/**
+ * Create development proxies for an array of paths.
+ *
+ * @example Create default development proxies
+ * ```ts
+ * const proxy = createDevProxies();
+ * ```
+ *
+ * @example Create custom development proxies
+ * ```ts
+ * const proxy = createDevProxies({ paths: ['/foo', '/bar'], target: 'http://mydomain.com' });
+ * ```
+ *
+ * @remarks
+ * `process.env.API_HOST` will be used as the target if `config.target` is not set. Undefined will be returned if
+ * neither are available.
+ *
+ * @privateRemarks
+ * It is important to guard for the case where neither target nor API_HOST are set by returning undefined.
+ * Proxies with empty string targets will cause blow ups in vite, whereas webpack seems to tolerate them.
+ *
+ * @param config - An optional {@link DevProxiesConfig}.
+ * @returns A {@link DevProxies} object or undefined.
+ *
+ * @public
+ */
+const createDevProxies = (config = {}) => {
+    var _a;
+    if (!config.target && !process.env.API_HOST) {
+        return undefined;
+    }
+    const socketExt = process.env.SOCKET_EXT || 'gwf';
+    const paths = Array.isArray(config.paths) ? config.paths : ['/sm', '/sso', `/${socketExt}`];
+    const target = (_a = config.target) !== null && _a !== void 0 ? _a : (0, exports.convertWsEndpointToHTTP)(process.env.API_HOST, socketExt);
+    const defaultConfig = Object.assign(Object.assign({}, config), { target });
+    const proxies = paths.reduce((prev, curr) => (Object.assign(Object.assign({}, prev), (0, exports.createDevProxy)(Object.assign(Object.assign({}, defaultConfig), { path: curr })))), {});
+    if (Object.keys(proxies).length) {
+        consola_1.default.info('Dev Proxies:');
+        console.table(proxies);
+    }
+    return proxies;
+};
+exports.createDevProxies = createDevProxies;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/build-kit",
   "description": "Build utilities & types",
-  "version": "14.144.1-alpha-82ebae3.0",
+  "version": "14.144.1",
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,8 @@
     "node": ">=20.0.0"
   },
   "scripts": {
-    "build": "npm run clean && tsc -b ./tsconfig.json",
+    "build": "npm run clean && tsc -b ./tsconfig.json && npm run copyfiles",
+    "copyfiles": "copyfiles --verbose cert/*.* ./dist",
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "dev": "tsc -b ./tsconfig.json -w",
     "test": "uvu -r tsm --tsmconfig ../uvu-playwright-builder/config/tsm.ts -r @esbuild-kit/cjs-loader -r ../uvu-playwright-builder/config/jsdom.setup.ts . 'test.ts' --i dist --i coverage"
@@ -27,6 +28,7 @@
     "inquirer": "^8.2.3",
     "jiti": "^1.18.2",
     "pkg-types": "^1.0.2",
+    "portfinder-sync": "^0.0.2",
     "pretty-ms": "^7.0.0",
     "rimraf": "^5.0.0",
     "tmp": "0.2.1",
@@ -34,7 +36,8 @@
   },
   "devDependencies": {
     "@esbuild-kit/cjs-loader": "2.4.2",
-    "@genesislcap/foundation-testing": "14.144.1-alpha-82ebae3.0",
+    "@genesislcap/foundation-testing": "14.144.1",
+    "@types/http-proxy": "^1.17.8",
     "@types/node": "^20.8.7",
     "tsm": "^2.2.1",
     "typescript": "^4.5.5",
@@ -48,5 +51,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a444c0935138d856a4369b32a94a6202bb6dfeeb"
+  "gitHead": "35ac01f58ce5a5502d34247e49ab93d0888cd3f7"
 }

package/src/utils/https.ts

@@ -0,0 +1,29 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import consola from 'consola';
+
+/**
+ * @public
+ */
+export type DevCertOptions = {
+  cert: Buffer;
+  key: Buffer;
+};
+
+/**
+ * Get default dev cert options.
+ *
+ * @public
+ */
+export const getDevCertOptions = (): DevCertOptions | undefined => {
+  const certDir = resolve(__dirname, '../../cert/');
+  const cert = resolve(certDir, 'localhost.crt');
+  const key = resolve(certDir, 'localhost.key');
+  if (existsSync(cert) && existsSync(key)) {
+    return {
+      cert: readFileSync(cert),
+      key: readFileSync(key),
+    };
+  }
+  consola.warn(`Could not load the default development certificates from ${certDir}.`);
+};

package/src/utils/index.ts

@@ -8,9 +8,11 @@ export * from './env';
 export * from './federation';
 export * from './fs';
 export * from './handlebars';
+export * from './https';
 export * from './json';
 export * from './npm';
 export * from './prompts';
+export * from './proxy';
 export * from './object';
 export * from './seed.fetching';
 export * from './seed.meta';

package/src/utils/proxy.ts

@@ -0,0 +1,139 @@
+import consola from 'consola';
+import type { ServerOptions } from 'http-proxy';
+import portfinderSync from 'portfinder-sync';
+
+/**
+ * @public
+ */
+export const getPort = (packageJson): number =>
+  portfinderSync.getPort(packageJson.config?.PORT || process.env.PORT || 9000);
+
+/**
+ * @public
+ */
+export const convertWsEndpointToHTTP = (endpoint = '', socketExt = '') => {
+  const protocolUpdate = endpoint.replace(/^ws(s)?:\/\//, 'http$1://');
+  return socketExt ? protocolUpdate.replace(`/${socketExt}`, '') : protocolUpdate;
+};
+
+/**
+ * Config to create a development proxy for a specific path.
+ *
+ * @public
+ */
+export type DevProxyConfig = {
+  target?: string;
+  path?: string;
+  options?: ServerOptions;
+};
+
+/**
+ * Config to create development proxies for an array of paths.
+ *
+ * @public
+ */
+export type DevProxiesConfig = Omit<DevProxyConfig, 'path'> & {
+  paths?: string[];
+};
+
+/**
+ * Object containing entries for each proxy keyed by path.
+ *
+ * @public
+ */
+export type DevProxies = Record<string, ServerOptions> & {};
+
+/**
+ * Create development proxy for a specific path.
+ *
+ * @example
+ * ```ts
+ * const proxy = createDevProxy({ path: '/sm', target: process.env.API_HOST, options: {...} });
+ * ```
+ *
+ * @remarks
+ * Applicable when running in dev mode and a valid target and path is set.
+ *
+ * @privateRemarks
+ * It is important to guard for the case where neither target nor path is set by returning undefined.
+ * Proxies with empty string targets will cause blow ups in vite, whereas webpack seems to tolerate them.
+ *
+ * @param config - A {@link DevProxyConfig}.
+ * @returns A {@link DevProxies} object or undefined.
+ *
+ * @public
+ */
+export const createDevProxy = (config: DevProxyConfig): DevProxies | undefined => {
+  if (!config.target || !config.path) {
+    return undefined;
+  }
+  const { options, path, target } = config;
+  return {
+    [path]: {
+      target,
+      secure: false,
+      changeOrigin: true,
+      cookieDomainRewrite: 'localhost',
+      ws: true,
+      ...(options ?? {}),
+      headers: {
+        origin: target,
+        ...(options?.headers ?? {}),
+      },
+    },
+  };
+};
+
+/**
+ * Create development proxies for an array of paths.
+ *
+ * @example Create default development proxies
+ * ```ts
+ * const proxy = createDevProxies();
+ * ```
+ *
+ * @example Create custom development proxies
+ * ```ts
+ * const proxy = createDevProxies({ paths: ['/foo', '/bar'], target: 'http://mydomain.com' });
+ * ```
+ *
+ * @remarks
+ * `process.env.API_HOST` will be used as the target if `config.target` is not set. Undefined will be returned if
+ * neither are available.
+ *
+ * @privateRemarks
+ * It is important to guard for the case where neither target nor API_HOST are set by returning undefined.
+ * Proxies with empty string targets will cause blow ups in vite, whereas webpack seems to tolerate them.
+ *
+ * @param config - An optional {@link DevProxiesConfig}.
+ * @returns A {@link DevProxies} object or undefined.
+ *
+ * @public
+ */
+export const createDevProxies = (config: DevProxiesConfig = {}): DevProxies | undefined => {
+  if (!config.target && !process.env.API_HOST) {
+    return undefined;
+  }
+  const socketExt = process.env.SOCKET_EXT || 'gwf';
+  const paths = Array.isArray(config.paths) ? config.paths : ['/sm', '/sso', `/${socketExt}`];
+  const target = config.target ?? convertWsEndpointToHTTP(process.env.API_HOST, socketExt);
+  const defaultConfig: DevProxyConfig = {
+    ...config,
+    target,
+  };
+  const proxies = paths.reduce(
+    (prev, curr) => ({
+      ...prev,
+      ...createDevProxy({
+        ...defaultConfig,
+        path: curr,
+      }),
+    }),
+    {},
+  );
+  if (Object.keys(proxies).length) {
+    consola.info('Dev Proxies:');
+    console.table(proxies);
+  }
+  return proxies;
+};

package/test/utils/https.test.ts

@@ -0,0 +1,14 @@
+import { assert, createLogicSuite } from '@genesislcap/foundation-testing';
+import { getDevCertOptions } from '../../src/utils/https';
+
+const suite = createLogicSuite('https dev server');
+
+suite('should have default cert options', () => {
+  const options = getDevCertOptions();
+  assert.ok(
+    options,
+    'Dev server cert options could not be created. Please ensure the local cert and key is available in build-kit/cert and is being published.',
+  );
+});
+
+suite.run();

package/test/utils/proxy.test.ts

@@ -0,0 +1,95 @@
+import { assert, createLogicSuite } from '@genesislcap/foundation-testing';
+import type { ServerOptions } from 'http-proxy';
+import type { DevProxies } from '../../src/utils/proxy';
+import { convertWsEndpointToHTTP, createDevProxies, createDevProxy } from '../../src/utils/proxy';
+
+const suite = createLogicSuite('dev server proxies');
+
+suite('should convert websocket to http endpoints as expected', ({ runCases }) => {
+  runCases(convertWsEndpointToHTTP, [
+    [
+      ['wss://public-foundation.genesislab.global/gwf/', 'gwf'],
+      'https://public-foundation.genesislab.global/',
+    ],
+    [
+      ['wss://public-foundation.genesislab.global/gwf/'],
+      'https://public-foundation.genesislab.global/gwf/',
+    ],
+    [['wss://public-foundation.genesislab.global'], 'https://public-foundation.genesislab.global'],
+    [
+      ['ws://public-foundation.genesislab.global/gwf/', 'gwf'],
+      'http://public-foundation.genesislab.global/',
+    ],
+    [
+      ['ws://public-foundation.genesislab.global/gwf/'],
+      'http://public-foundation.genesislab.global/gwf/',
+    ],
+    [['ws://public-foundation.genesislab.global'], 'http://public-foundation.genesislab.global'],
+    [['wss://localhost:6060/gwf/', 'gwf'], 'https://localhost:6060/'],
+    [['ws://localhost:6060/gwf/', 'gwf'], 'http://localhost:6060/'],
+    [['ws://localhost:6060/gwf/'], 'http://localhost:6060/gwf/'],
+    [['ws://localhost:6060'], 'http://localhost:6060'],
+  ]);
+});
+
+suite('createDevProxy should return the expected proxy for given target', () => {
+  const proxy = createDevProxy({
+    target: 'https://rte.ie',
+    path: '/api',
+    options: {
+      ws: false,
+      cookieDomainRewrite: {
+        'old.domain': 'new.domain',
+        '*': '',
+      },
+    },
+  });
+  const expectedProxy: DevProxies = {
+    ['/api']: {
+      target: 'https://rte.ie',
+      secure: false,
+      changeOrigin: true,
+      cookieDomainRewrite: {
+        'old.domain': 'new.domain',
+        '*': '',
+      },
+      ws: false,
+      headers: {
+        origin: 'https://rte.ie',
+      },
+    },
+  };
+  assert.equal(proxy, expectedProxy);
+});
+
+suite('createDevProxy should return undefined when no target or API_HOST is set', () => {
+  assert.not.ok(createDevProxy({ path: '/api' }));
+  assert.not.ok(createDevProxy({}));
+});
+
+suite('createDevProxies should return default proxies for given target', () => {
+  const proxies = createDevProxies({ target: 'https://rte.ie' });
+  const expectedServerOptions: ServerOptions = {
+    target: 'https://rte.ie',
+    secure: false,
+    changeOrigin: true,
+    cookieDomainRewrite: 'localhost',
+    ws: true,
+    headers: {
+      origin: 'https://rte.ie',
+    },
+  };
+  const expectedProxies: DevProxies = {
+    ['/sm']: expectedServerOptions,
+    ['/sso']: expectedServerOptions,
+    ['/gwf']: expectedServerOptions,
+  };
+  assert.equal(proxies, expectedProxies);
+});
+
+suite('createDevProxies should return undefined when no target or API_HOST is set', () => {
+  assert.not.ok(createDevProxies({ paths: ['/sm', '/gwf'] }));
+  assert.not.ok(createDevProxies());
+});
+
+suite.run();