@venizia/ardor-kernel 0.4.1 → 0.4.2

package/README.md

@@ -21,7 +21,7 @@ which re-exports this package.
 | Bindings | `CoreBindings`, `LocalStorageKeys` |
 | Constants | `RequestMethods`, `RequestTypes`, `RequestBodyTypes`, `RequestCountData`, `HeaderConstants`, `Environments`, `App` |
 | Network | `NetworkHeaders`, `RequestBodyEncoder`, `ResponseReader`, `AuthRecovery`, `AuthTokenStore` (the fetch transport is IGNIS's `NodeFetchNetworkRequest`) |
-| Helpers | `Logger`, `BaseHelper`, `SocketIOClientHelper` |
+| Helpers | `Logger`, `BaseHelper` |
 | Utilities | `isDefined`, `isString`, `isNumber`, `isObject`, `isBrowser`, `isValidDate`, `isEditableTarget`, `toDataUrl` |
 | Types | `IdType`, `AnyType`, `AnyObject`, `ValueOrPromise`, `ValueOf`, `TConstValue`, `TPaths`, `TFullPaths`, `ISendParams`, `IRestDataProviderOptions`, `IApplicationInfo`, ... |
 

package/dist/utilities/runtime-config.d.ts

@@ -3,14 +3,26 @@
  * The preset image writes it at container start, from the environment variables that start with `VITE_`.
  */
 export declare const RUNTIME_CONFIG_GLOBAL = "__APP_CONFIG__";
+interface IRuntimeConfigOptions {
+    key: string;
+    buildTimeEnv?: Record<string, unknown>;
+    defaultValue?: string;
+}
 /**
  * One config value: the runtime one (`window.__APP_CONFIG__`), else the build-time one
  * (`buildTimeEnv`, passed by the app as `import.meta.env`), else `defaultValue`. Only a non-empty
  * string counts, and a missing global is not an error.
+ *
+ * With `required: true` the result is a `string`: when all three are absent it throws, naming the
+ * key and never a value. Without it, the result is `string | undefined`.
  */
-export declare const getRuntimeConfig: (opts: {
-    key: string;
-    buildTimeEnv?: Record<string, unknown>;
-    defaultValue?: string;
-}) => string | undefined;
+export declare const getRuntimeConfig: {
+    (opts: IRuntimeConfigOptions & {
+        required: true;
+    }): string;
+    (opts: IRuntimeConfigOptions & {
+        required?: boolean;
+    }): string | undefined;
+};
+export {};
 //# sourceMappingURL=runtime-config.d.ts.map

package/dist/utilities/runtime-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime-config.d.ts","sourceRoot":"","sources":["../../src/utilities/runtime-config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,qBAAqB,mBAAmB,CAAC;AAmBtD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,KAAG,MAAM,GAAG,SAQZ,CAAC"}
+{"version":3,"file":"runtime-config.d.ts","sourceRoot":"","sources":["../../src/utilities/runtime-config.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,qBAAqB,mBAAmB,CAAC;AAmBtD,UAAU,qBAAqB;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,EAAE;IAC7B,CAAC,IAAI,EAAE,qBAAqB,GAAG;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,GAAG,MAAM,CAAC;IAC3D,CAAC,IAAI,EAAE,qBAAqB,GAAG;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,MAAM,GAAG,SAAS,CAAC;CAgB5E,CAAC"}

package/dist/utilities/runtime-config.js

@@ -1,3 +1,4 @@
+import { getError } from '@venizia/ignis-inversion';
 /**
  * The name `config.js` writes the runtime config under: `window.__APP_CONFIG__`, a record of strings.
  * The preset image writes it at container start, from the environment variables that start with `VITE_`.
@@ -19,11 +20,20 @@ const readString = (opts) => {
  * One config value: the runtime one (`window.__APP_CONFIG__`), else the build-time one
  * (`buildTimeEnv`, passed by the app as `import.meta.env`), else `defaultValue`. Only a non-empty
  * string counts, and a missing global is not an error.
+ *
+ * With `required: true` the result is a `string`: when all three are absent it throws, naming the
+ * key and never a value. Without it, the result is `string | undefined`.
  */
 export const getRuntimeConfig = (opts) => {
-    const { key, buildTimeEnv, defaultValue } = opts;
-    return (readString({ source: Reflect.get(globalThis, RUNTIME_CONFIG_GLOBAL), key }) ??
+    const { key, buildTimeEnv, defaultValue, required } = opts;
+    const value = readString({ source: Reflect.get(globalThis, RUNTIME_CONFIG_GLOBAL), key }) ??
         readString({ source: buildTimeEnv, key }) ??
-        defaultValue);
+        defaultValue;
+    if (required && value === undefined) {
+        throw getError({
+            message: `[getRuntimeConfig] '${key}' is required and not set | Write it to config.js (a VITE_ variable of the container, listed in APP_REQUIRED_ENV), or pass it in buildTimeEnv or defaultValue`,
+        });
+    }
+    return value;
 };
 //# sourceMappingURL=runtime-config.js.map

package/dist/utilities/runtime-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"runtime-config.js","sourceRoot":"","sources":["../../src/utilities/runtime-config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,gBAAgB,CAAC;AAEtD,MAAM,UAAU,GAAG,CAAC,IAAsC,EAAsB,EAAE;IAChF,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE7B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,qEAAqE;IACrE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QACvD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEhD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvE,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAIhC,EAAsB,EAAE;IACvB,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IAEjD,OAAO,CACL,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,qBAAqB,CAAC,EAAE,GAAG,EAAE,CAAC;QAC3E,UAAU,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;QACzC,YAAY,CACb,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"runtime-config.js","sourceRoot":"","sources":["../../src/utilities/runtime-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,gBAAgB,CAAC;AAEtD,MAAM,UAAU,GAAG,CAAC,IAAsC,EAAsB,EAAE;IAChF,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAE7B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,qEAAqE;IACrE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QACvD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,KAAK,GAAY,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEhD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvE,CAAC,CAAC;AAQF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAGzB,CAAC,IAAoD,EAAU,EAAE;IACnE,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAE3D,MAAM,KAAK,GACT,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,qBAAqB,CAAC,EAAE,GAAG,EAAE,CAAC;QAC3E,UAAU,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;QACzC,YAAY,CAAC;IAEf,IAAI,QAAQ,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACpC,MAAM,QAAQ,CAAC;YACb,OAAO,EAAE,uBAAuB,GAAG,+JAA+J;SACnM,CAAC,CAAC;IACL,CAAC;IAED,OAAO,KAAe,CAAC;AACzB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venizia/ardor-kernel",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "ARDOR kernel - the isomorphic core of the ARDOR frontend framework: application base on IGNIS inversion, service and CRUD bases, request/auth constants, binding keys, logger, network fetchers and socket client. No React and no react-admin.",
   "keywords": [
     "ardor",
@@ -68,12 +68,12 @@
   "devDependencies": {
     "@size-limit/preset-small-lib": "^14.2.0",
     "@types/bun": "^1.4.3",
-    "@venizia/dev-configs": "^0.4.1",
-    "@venizia/ignis-connectors": "^0.4.1",
-    "@venizia/ignis-filter": "^0.4.1",
-    "@venizia/ignis-helpers": "^0.4.1",
-    "@venizia/ignis-inversion": "^0.4.1",
-    "@venizia/ignis-kernel": "^0.4.1",
+    "@venizia/dev-configs": "^0.4.2",
+    "@venizia/ignis-connectors": "^0.4.2",
+    "@venizia/ignis-filter": "^0.4.2",
+    "@venizia/ignis-helpers": "^0.4.2",
+    "@venizia/ignis-inversion": "^0.4.2",
+    "@venizia/ignis-kernel": "^0.4.2",
     "eslint": "^10.13.0",
     "oxlint": "1.89.0",
     "oxlint-tsgolint": "7.0.2004",