@thepassle/app-tools 0.9.4 → 0.9.5

package/env/README.md

@@ -20,6 +20,54 @@ if (PROD) {
 }
 ```
 
+OR
+
+```js
+import { ENV } from '@thepassle/app-tools/env.js';
+
+if (ENV === 'dev') {
+  console.log('Running in dev mode');
+}
+
+if (ENV === 'prod') {
+  console.log('Running in prod mode');
+}
+```
+
+### Custom Env Modes
+
+In certain situations you might want to set your own env mode.
+
+Demos that should use "just" json files instead of a full api server might be a good use case for it.
+Here is an example using it in combination with the [Api Module](../api/README.md).
+
+```js
+import { ENV } from '@thepassle/app-tools/env.js';
+
+const baseURLs = {
+  'prod': 'https://api.domain.com', // prod api server
+  'dev': 'http://localhost:8888', // local api server
+  'dev-static': 'http://localhost:8000' // demos using "just" json files
+}
+const typedEnv = /** @type {keyof baseURLs} */ (ENV);
+
+export const api = new Api({
+  baseURL: baseURLs[typedEnv],
+});
+```
+
+Then in your HTML demo files you can set these special env values.
+
+```html
+<my-el api-endpoint="recommendation.json"></my-el>
+
+<script type="module">
+  import { ENV, setEnv } from '@thepassle/app-tools/env.js';
+  setEnv('dev-static');
+  import '../my-el.js';
+</script>
+```
+
 When resolving imports, Node will look for keys in the package export to figure out which file to use. For example "default", "import", or "require".
 
 Tools however can use custom keys here as well, like "types", "browser", "development", or "production". Depending on what kind of import it is, and which environment (dev/prod) tools (like bundlers or dev servers) can resolve/distinguish between which file should actually be used.

package/env/dev.js

@@ -1,2 +1,9 @@
 export const DEV = true;
-export const PROD = false;
+export const PROD = false;
+export let ENV = 'dev';
+/**
+ * @param {string} env
+ */
+export function setEnv(env) {
+  ENV = env;
+}

package/env/prod.js

@@ -1,2 +1,9 @@
 export const DEV = false;
-export const PROD = true;
+export const PROD = true;
+export let ENV = 'prod';
+/**
+ * @param {string} env
+ */
+export function setEnv(env) {
+  ENV = env;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thepassle/app-tools",
-  "version": "0.9.4",
+  "version": "0.9.5",
   "description": "",
   "type": "module",
   "scripts": {

package/types/env/dev.d.ts

@@ -1,2 +1,7 @@
+/**
+ * @param {string} env
+ */
+export function setEnv(env: string): void;
 export const DEV: true;
 export const PROD: false;
+export let ENV: string;

package/types/env/prod.d.ts

@@ -1,2 +1,7 @@
+/**
+ * @param {string} env
+ */
+export function setEnv(env: string): void;
 export const DEV: false;
 export const PROD: true;
+export let ENV: string;