Project update. [p][robotic]

clevercanyon · Mar 22, 2024 · c0a08d1 · c0a08d1
1 parent a2831cb
commit c0a08d1
Show file tree

Hide file tree

Showing 24 changed files with 307 additions and 20 deletions.
diff --git a/.browserslistrc b/.browserslistrc
@@ -17,7 +17,7 @@
 # Generated data.
 # <generated:start>
 
-# Last generated Mar 22, 2024 7:11 AM UTC.
+# Last generated Mar 22, 2024 7:58 AM UTC.
 
 [production]
 node >= 20.9.0

diff --git a/.dockerignore b/.dockerignore
@@ -17,7 +17,7 @@
 # Generated data.
 # <generated:start>
 
-# Last generated Mar 22, 2024 7:11 AM UTC.
+# Last generated Mar 22, 2024 7:58 AM UTC.
 
 # Locals
 

diff --git a/.env.vault b/.env.vault
@@ -8,12 +8,12 @@ DOTENV_VAULT_MAIN="7GW98NfL4hM4N6HbfeDXCKreVxKvcVPupFRnZ8XJ+pomaQ=="
 DOTENV_VAULT_MAIN_VERSION=1
 
 # dev
-DOTENV_VAULT_DEV="a+hP6nwf4CqONa9HrqVRAS9dngtgA6QHT3l5D2DEHArCV934o/YKSUa7mJ4cah+U/cRf4bGUGgblBQqQW9vIWtMgDOOQA9E8Mf6NBX79DKJZOwODwrIYBfRHH6KcrD+NNOhOmSeJ5q+tado5J5Dyq3sBkWiQ7PkAgvEeMUnociUlfQSu+tXqXUJwm0zaY2PmCwanWeZMLFddlZTETwa+BvkPaOPM29XfeyJD/tUs9LRuqs7OKD7Qy+hM7ku2Nd3AIA=="
-DOTENV_VAULT_DEV_VERSION=467
+DOTENV_VAULT_DEV="kSpcS87N4T+DP0j67/NEgV2VkFKSfZ0wtuR/JNYOGbnmYwCwIuqLefBaluLkYzZcwDMzh/GdbnM0fhxm8IpxeNI/wCR00nnCApNOt9nJN6aXA/XF8ebczvOvVW0k1FdH7qAVd/6+DtjO5+RH2/hX3cXhy9f9bZ4t1PT4J/c970H5xgaulwjwPOUY4X/APedGp0hRuLfqsDpkULk6yHwngyGvmJBQEwrOh6dEZqLJP4xleavS7ErfXSbF5oh861jy1Q=="
+DOTENV_VAULT_DEV_VERSION=469
 
 # ci
-DOTENV_VAULT_CI="Qf4313mFcLvwmOisZB1rijt+IuiWsVk9z8k74kBCRWWLdfqRvNKZBSOWjzK9OuCwByPvgINYL4+8qr752as6FFMGFtXpLlOewG36R7JJv+caYksGYy/x0YJIEFGyIPHf1hlat/C2MVp1l+HF/T0bG9laB0yDKcKc84E10HNVHw=="
-DOTENV_VAULT_CI_VERSION=467
+DOTENV_VAULT_CI="tSs3/1qDGDC5N/LUwefxIQMn/m/K+HOVxRhGsIegmRtVYLKU+TjrjyRhwyDoKjlNqZaOoihxsLbFqPL2Pj4ZaiuokBIbHzv7sgg6kqKm21nlAnYZ/cKfhAIf8iIe7Qud6fP0gHJ+3d9a83LgRlh0dvMO4D8CJGLspEbNjHgpIg=="
+DOTENV_VAULT_CI_VERSION=469
 
 # stage
 DOTENV_VAULT_STAGE="aRP8su2YV4jZu3w1HZ/SLaots0IwJDFw75TCpvXEFeNp7tw="

diff --git a/.gitattributes b/.gitattributes
@@ -17,7 +17,7 @@
 # Generated data.
 # <generated:start>
 
-# Last generated Mar 22, 2024 7:11 AM UTC.
+# Last generated Mar 22, 2024 7:58 AM UTC.
 
 # Default
 

diff --git a/.gitignore b/.gitignore
@@ -17,7 +17,7 @@
 # Generated data.
 # <generated:start>
 
-# Last generated Mar 22, 2024 7:11 AM UTC.
+# Last generated Mar 22, 2024 7:58 AM UTC.
 
 # Locals
 

diff --git a/.npmignore b/.npmignore
@@ -25,7 +25,7 @@
 # Generated data.
 # <generated:start>
 
-# Last generated Mar 22, 2024 7:11 AM UTC.
+# Last generated Mar 22, 2024 7:58 AM UTC.
 
 # Locals
 

diff --git a/.prettierignore b/.prettierignore
@@ -17,7 +17,7 @@
 # Generated data.
 # <generated:start>
 
-# Last generated Mar 22, 2024 7:11 AM UTC.
+# Last generated Mar 22, 2024 7:58 AM UTC.
 
 # Packages
 

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -7,7 +7,7 @@
  * @note This entire file will be updated automatically.
  * @note Instead of editing here, please review `./settings.mjs`.
  *
- * Last generated using `./settings.mjs` Mar 22, 2024 7:11 AM UTC.
+ * Last generated using `./settings.mjs` Mar 22, 2024 7:58 AM UTC.
  */
 {
     "editor.formatOnType": false,

diff --git a/.vscodeignore b/.vscodeignore
@@ -17,7 +17,7 @@
 # Generated data.
 # <generated:start>
 
-# Last generated Mar 22, 2024 7:11 AM UTC.
+# Last generated Mar 22, 2024 7:58 AM UTC.
 
 # Locals
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "1.0.920",
+    "version": "1.0.921",
     "license": "GPL-3.0-or-later",
     "name": "@clevercanyon/utilities",
     "description": "Utilities for JavaScript apps running in any environment.",

diff --git a/src/app.ts b/src/app.ts
@@ -11,6 +11,8 @@ import { $brand, $env, $obj, $str, $time, $url, $user, type $type } from '#index
  * Defines types.
  */
 export type BaseURLOptions = { parsed?: boolean };
+export type RootR2OriginURLOptions = { parsed?: boolean };
+export type RootR2BaseURLOptions = { parsed?: boolean };
 export type R2OriginURLOptions = { parsed?: boolean };
 export type R2BaseURLOptions = { parsed?: boolean };
 
@@ -115,6 +117,62 @@ export const baseURL = $fnꓺmemo(
     },
 );
 
+/**
+ * Checks if environment has an app’s root R2 origin URL.
+ *
+ * @returns True if environment has an app’s root R2 origin URL.
+ */
+export const hasRootR2OriginURL = $fnꓺmemo((): boolean => {
+    return $env.get('APP_ROOT_R2_ORIGIN_URL') ? true : false;
+});
+
+/**
+ * Gets current app’s root R2 origin URL.
+ *
+ * @param   options Options (all optional); {@see RootR2OriginURLOptions}.
+ *
+ * @returns         Current app’s root R2 origin URL.
+ *
+ * @note Unable to deep freeze a URL, but we would do so if possible.
+ *       For now, we just declare it readonly using a TypeScript return type.
+ */
+export const rootR2OriginURL = $fnꓺmemo(
+    { deep: true, maxSize: 2 },
+    <Options extends RootR2OriginURLOptions>(options?: Options): Options extends RootR2OriginURLOptions & { parsed: true } ? $type.ReadonlyDeep<$type.URL> : string => {
+        const opts = $obj.defaults({}, options || {}, { parsed: false }) as Required<RootR2OriginURLOptions>,
+            value = $str.rTrim($env.get('APP_ROOT_R2_ORIGIN_URL', { type: 'string', require: true }), '/');
+        return (opts.parsed ? $url.parse(value) : value) as ReturnType<typeof rootR2OriginURL<Options>>;
+    },
+);
+
+/**
+ * Checks if environment has an app’s root R2 base URL.
+ *
+ * @returns True if environment has an app’s root R2 base URL.
+ */
+export const hasRootR2BaseURL = $fnꓺmemo((): boolean => {
+    return $env.get('APP_ROOT_R2_BASE_URL') || hasRootR2OriginURL() ? true : false;
+});
+
+/**
+ * Gets current app’s root R2 base URL.
+ *
+ * @param   options Options (all optional); {@see RootR2BaseURLOptions}.
+ *
+ * @returns         Current app’s root R2 base URL.
+ *
+ * @note Unable to deep freeze a URL, but we would do so if possible.
+ *       For now, we just declare it readonly using a TypeScript return type.
+ */
+export const rootR2BaseURL = $fnꓺmemo(
+    { deep: true, maxSize: 2 },
+    <Options extends RootR2BaseURLOptions>(options?: Options): Options extends RootR2BaseURLOptions & { parsed: true } ? $type.ReadonlyDeep<$type.URL> : string => {
+        const opts = $obj.defaults({}, options || {}, { parsed: false }) as Required<RootR2BaseURLOptions>,
+            value = $env.get('APP_ROOT_R2_BASE_URL', { type: 'string', default: '' }) || rootR2OriginURL() + '/app/' + pkgSlug() + '/';
+        return (opts.parsed ? $url.parse(value) : value) as ReturnType<typeof rootR2BaseURL<Options>>;
+    },
+);
+
 /**
  * Checks if environment has an app’s R2 origin URL.
  *

diff --git a/src/tests/brand/index.ts b/src/tests/brand/index.ts
@@ -7,6 +7,8 @@ import { afterAll, beforeAll, describe, expect, test } from 'vitest';
 
 const __origAppPkgName__ = $env.get('APP_PKG_NAME', { type: 'unknown' });
 const __origAppBaseURL__ = $env.get('APP_BASE_URL', { type: 'unknown' });
+const __origAppRootR2OriginURL__ = $env.get('APP_ROOT_R2_ORIGIN_URL', { type: 'unknown' });
+const __origAppRootR2BaseURL__ = $env.get('APP_ROOT_R2_BASE_URL', { type: 'unknown' });
 const __origAppR2OriginURL__ = $env.get('APP_R2_ORIGIN_URL', { type: 'unknown' });
 const __origAppR2BaseURL__ = $env.get('APP_R2_BASE_URL', { type: 'unknown' });
 const __origAppBrandProps__ = $env.get('APP_BRAND_PROPS', { type: 'unknown' });
@@ -16,6 +18,8 @@ describe('$brand', async () => {
     beforeAll(async () => {
         $env.set('APP_PKG_NAME', '@clevercanyon/x.tld');
         $env.set('APP_BASE_URL', 'https://x.tld/base/');
+        $env.set('APP_ROOT_R2_ORIGIN_URL', 'https://r2.tld');
+        $env.set('APP_ROOT_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_R2_ORIGIN_URL', 'https://r2.tld');
         $env.set('APP_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_BRAND_PROPS', { type: 'site' });
@@ -24,6 +28,8 @@ describe('$brand', async () => {
     afterAll(async () => {
         $env.set('APP_PKG_NAME', __origAppPkgName__);
         $env.set('APP_BASE_URL', __origAppBaseURL__);
+        $env.set('APP_ROOT_R2_ORIGIN_URL', __origAppRootR2OriginURL__);
+        $env.set('APP_ROOT_R2_BASE_URL', __origAppRootR2BaseURL__);
         $env.set('APP_R2_ORIGIN_URL', __origAppR2OriginURL__);
         $env.set('APP_R2_BASE_URL', __origAppR2BaseURL__);
         $env.set('APP_BRAND_PROPS', __origAppBrandProps__);
@@ -37,6 +43,12 @@ describe('$brand', async () => {
             $app.hasBaseURL.flush(),
             $app.baseURL.flush(),
             //
+            $app.hasRootR2OriginURL.flush(),
+            $app.rootR2OriginURL.flush(),
+            //
+            $app.hasRootR2BaseURL.flush(),
+            $app.rootR2BaseURL.flush(),
+            //
             $app.hasR2OriginURL.flush(),
             $app.r2OriginURL.flush(),
             //

diff --git a/src/tests/classes/logger/index.ts b/src/tests/classes/logger/index.ts
@@ -7,6 +7,8 @@ import { afterAll, beforeAll, describe, expect, test } from 'vitest';
 
 const __origAppPkgName__ = $env.get('APP_PKG_NAME', { type: 'unknown' });
 const __origAppBaseURL__ = $env.get('APP_BASE_URL', { type: 'unknown' });
+const __origAppRootR2OriginURL__ = $env.get('APP_ROOT_R2_ORIGIN_URL', { type: 'unknown' });
+const __origAppRootR2BaseURL__ = $env.get('APP_ROOT_R2_BASE_URL', { type: 'unknown' });
 const __origAppR2OriginURL__ = $env.get('APP_R2_ORIGIN_URL', { type: 'unknown' });
 const __origAppR2BaseURL__ = $env.get('APP_R2_BASE_URL', { type: 'unknown' });
 const __origAppBrandProps__ = $env.get('APP_BRAND_PROPS', { type: 'unknown' });
@@ -19,6 +21,8 @@ describe('Logger', async () => {
     beforeAll(async () => {
         $env.set('APP_PKG_NAME', '@clevercanyon/x.tld');
         $env.set('APP_BASE_URL', 'https://x.tld/base/');
+        $env.set('APP_ROOT_R2_ORIGIN_URL', 'https://r2.tld');
+        $env.set('APP_ROOT_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_R2_ORIGIN_URL', 'https://r2.tld');
         $env.set('APP_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_BRAND_PROPS', { type: 'site' });
@@ -27,6 +31,8 @@ describe('Logger', async () => {
     afterAll(async () => {
         $env.set('APP_PKG_NAME', __origAppPkgName__);
         $env.set('APP_BASE_URL', __origAppBaseURL__);
+        $env.set('APP_ROOT_R2_ORIGIN_URL', __origAppRootR2OriginURL__);
+        $env.set('APP_ROOT_R2_BASE_URL', __origAppRootR2BaseURL__);
         $env.set('APP_R2_ORIGIN_URL', __origAppR2OriginURL__);
         $env.set('APP_R2_BASE_URL', __origAppR2BaseURL__);
         $env.set('APP_BRAND_PROPS', __origAppBrandProps__);
@@ -40,6 +46,12 @@ describe('Logger', async () => {
             $app.hasBaseURL.flush(),
             $app.baseURL.flush(),
             //
+            $app.hasRootR2OriginURL.flush(),
+            $app.rootR2OriginURL.flush(),
+            //
+            $app.hasRootR2BaseURL.flush(),
+            $app.rootR2BaseURL.flush(),
+            //
             $app.hasR2OriginURL.flush(),
             $app.r2OriginURL.flush(),
             //

diff --git a/src/tests/preact/apis/iso/hydratively-render-spa.web.tsx b/src/tests/preact/apis/iso/hydratively-render-spa.web.tsx
@@ -8,6 +8,8 @@ import { afterAll, beforeAll, describe, expect, test, vi } from 'vitest';
 
 const __origAppPkgName__ = $env.get('APP_PKG_NAME', { type: 'unknown' });
 const __origAppBaseURL__ = $env.get('APP_BASE_URL', { type: 'unknown' });
+const __origAppRootR2OriginURL__ = $env.get('APP_ROOT_R2_ORIGIN_URL', { type: 'unknown' });
+const __origAppRootR2BaseURL__ = $env.get('APP_ROOT_R2_BASE_URL', { type: 'unknown' });
 const __origAppR2OriginURL__ = $env.get('APP_R2_ORIGIN_URL', { type: 'unknown' });
 const __origAppR2BaseURL__ = $env.get('APP_R2_BASE_URL', { type: 'unknown' });
 const __origAppBrandProps__ = $env.get('APP_BRAND_PROPS', { type: 'unknown' });
@@ -17,6 +19,8 @@ describe('$preact.iso.hydrativelyRenderSPA() [web]', async () => {
     beforeAll(async () => {
         $env.set('APP_PKG_NAME', '@clevercanyon/x.tld');
         $env.set('APP_BASE_URL', 'https://x.tld/base/');
+        $env.set('APP_ROOT_R2_ORIGIN_URL', 'https://r2.tld');
+        $env.set('APP_ROOT_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_R2_ORIGIN_URL', 'https://r2.tld');
         $env.set('APP_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_BRAND_PROPS', { type: 'site' });
@@ -25,6 +29,8 @@ describe('$preact.iso.hydrativelyRenderSPA() [web]', async () => {
     afterAll(async () => {
         $env.set('APP_PKG_NAME', __origAppPkgName__);
         $env.set('APP_BASE_URL', __origAppBaseURL__);
+        $env.set('APP_ROOT_R2_ORIGIN_URL', __origAppRootR2OriginURL__);
+        $env.set('APP_ROOT_R2_BASE_URL', __origAppRootR2BaseURL__);
         $env.set('APP_R2_ORIGIN_URL', __origAppR2OriginURL__);
         $env.set('APP_R2_BASE_URL', __origAppR2BaseURL__);
         $env.set('APP_BRAND_PROPS', __origAppBrandProps__);
@@ -38,6 +44,12 @@ describe('$preact.iso.hydrativelyRenderSPA() [web]', async () => {
             $app.hasBaseURL.flush(),
             $app.baseURL.flush(),
             //
+            $app.hasRootR2OriginURL.flush(),
+            $app.rootR2OriginURL.flush(),
+            //
+            $app.hasRootR2BaseURL.flush(),
+            $app.rootR2BaseURL.flush(),
+            //
             $app.hasR2OriginURL.flush(),
             $app.r2OriginURL.flush(),
             //

diff --git a/src/tests/preact/apis/iso/prerender-spa-404.cfw.tsx b/src/tests/preact/apis/iso/prerender-spa-404.cfw.tsx
@@ -8,6 +8,8 @@ import { afterAll, beforeAll, describe, expect, test } from 'vitest';
 
 const __origAppPkgName__ = $env.get('APP_PKG_NAME', { type: 'unknown' });
 const __origAppBaseURL__ = $env.get('APP_BASE_URL', { type: 'unknown' });
+const __origAppRootR2OriginURL__ = $env.get('APP_ROOT_R2_ORIGIN_URL', { type: 'unknown' });
+const __origAppRootR2BaseURL__ = $env.get('APP_ROOT_R2_BASE_URL', { type: 'unknown' });
 const __origAppR2OriginURL__ = $env.get('APP_R2_ORIGIN_URL', { type: 'unknown' });
 const __origAppR2BaseURL__ = $env.get('APP_R2_BASE_URL', { type: 'unknown' });
 const __origAppBrandProps__ = $env.get('APP_BRAND_PROPS', { type: 'unknown' });
@@ -17,6 +19,8 @@ describe('$preact.iso.prerenderSPA() [404-cfw]', async () => {
     beforeAll(async () => {
         $env.set('APP_PKG_NAME', '@clevercanyon/x.tld');
         $env.set('APP_BASE_URL', 'https://x.tld/base/');
+        $env.set('APP_ROOT_R2_ORIGIN_URL', 'https://r2.tld');
+        $env.set('APP_ROOT_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_R2_ORIGIN_URL', 'https://r2.tld');
         $env.set('APP_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_BRAND_PROPS', { type: 'site' });
@@ -25,6 +29,8 @@ describe('$preact.iso.prerenderSPA() [404-cfw]', async () => {
     afterAll(async () => {
         $env.set('APP_PKG_NAME', __origAppPkgName__);
         $env.set('APP_BASE_URL', __origAppBaseURL__);
+        $env.set('APP_ROOT_R2_ORIGIN_URL', __origAppRootR2OriginURL__);
+        $env.set('APP_ROOT_R2_BASE_URL', __origAppRootR2BaseURL__);
         $env.set('APP_R2_ORIGIN_URL', __origAppR2OriginURL__);
         $env.set('APP_R2_BASE_URL', __origAppR2BaseURL__);
         $env.set('APP_BRAND_PROPS', __origAppBrandProps__);
@@ -38,6 +44,12 @@ describe('$preact.iso.prerenderSPA() [404-cfw]', async () => {
             $app.hasBaseURL.flush(),
             $app.baseURL.flush(),
             //
+            $app.hasRootR2OriginURL.flush(),
+            $app.rootR2OriginURL.flush(),
+            //
+            $app.hasRootR2BaseURL.flush(),
+            $app.rootR2BaseURL.flush(),
+            //
             $app.hasR2OriginURL.flush(),
             $app.r2OriginURL.flush(),
             //

diff --git a/src/tests/preact/apis/iso/prerender-spa-for-web-fixture.tsx b/src/tests/preact/apis/iso/prerender-spa-for-web-fixture.tsx
@@ -12,6 +12,8 @@ import { afterAll, beforeAll, describe, expect, test } from 'vitest';
 
 const __origAppPkgName__ = $env.get('APP_PKG_NAME', { type: 'unknown' });
 const __origAppBaseURL__ = $env.get('APP_BASE_URL', { type: 'unknown' });
+const __origAppRootR2OriginURL__ = $env.get('APP_ROOT_R2_ORIGIN_URL', { type: 'unknown' });
+const __origAppRootR2BaseURL__ = $env.get('APP_ROOT_R2_BASE_URL', { type: 'unknown' });
 const __origAppR2OriginURL__ = $env.get('APP_R2_ORIGIN_URL', { type: 'unknown' });
 const __origAppR2BaseURL__ = $env.get('APP_R2_BASE_URL', { type: 'unknown' });
 const __origAppBrandProps__ = $env.get('APP_BRAND_PROPS', { type: 'unknown' });
@@ -21,6 +23,8 @@ describe('$preact.iso.prerenderSPA() [web-fixture]', async () => {
     beforeAll(async () => {
         $env.set('APP_PKG_NAME', '@clevercanyon/x.tld');
         $env.set('APP_BASE_URL', 'https://x.tld/base/');
+        $env.set('APP_ROOT_R2_ORIGIN_URL', 'https://r2.tld');
+        $env.set('APP_ROOT_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_R2_ORIGIN_URL', 'https://r2.tld');
         $env.set('APP_R2_BASE_URL', 'https://r2.tld/base/');
         $env.set('APP_BRAND_PROPS', { type: 'site' });
@@ -29,6 +33,8 @@ describe('$preact.iso.prerenderSPA() [web-fixture]', async () => {
     afterAll(async () => {
         $env.set('APP_PKG_NAME', __origAppPkgName__);
         $env.set('APP_BASE_URL', __origAppBaseURL__);
+        $env.set('APP_ROOT_R2_ORIGIN_URL', __origAppRootR2OriginURL__);
+        $env.set('APP_ROOT_R2_BASE_URL', __origAppRootR2BaseURL__);
         $env.set('APP_R2_ORIGIN_URL', __origAppR2OriginURL__);
         $env.set('APP_R2_BASE_URL', __origAppR2BaseURL__);
         $env.set('APP_BRAND_PROPS', __origAppBrandProps__);
@@ -42,6 +48,12 @@ describe('$preact.iso.prerenderSPA() [web-fixture]', async () => {
             $app.hasBaseURL.flush(),
             $app.baseURL.flush(),
             //
+            $app.hasRootR2OriginURL.flush(),
+            $app.rootR2OriginURL.flush(),
+            //
+            $app.hasRootR2BaseURL.flush(),
+            $app.rootR2BaseURL.flush(),
+            //
             $app.hasR2OriginURL.flush(),
             $app.r2OriginURL.flush(),
             //