@equinor/echo-cli 1.0.3-beta-0 → 1.0.3

package/lib/echo-create.d.ts

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import { Command } from '@oclif/core';
+export default class CreateApp extends Command {
+    static description: string;
+    static flags: {
+        description: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        git: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        help: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<void>;
+        install: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        key: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        name: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        shortName: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        templateName: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/lib/echo-create.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+import { Command, Flags } from '@oclif/core';
+import { createProject } from './tools/create/createProject.js';
+import { promptForMissingOptions } from './tools/create/promptOptions.js';
+import { echoCliLogo } from './utils/logo.js';
+export default class CreateApp extends Command {
+    static description = 'Creates a new Echo app';
+    static flags = {
+        description: Flags.string({ char: 'd', description: 'App description' }),
+        git: Flags.boolean({ char: 'g', description: 'Initialize git repository' }),
+        help: Flags.help({ char: 'h' }),
+        install: Flags.boolean({
+            char: 'i',
+            description: 'Install dev dependencies'
+        }),
+        key: Flags.string({ char: 'k', description: 'Key for app/tile' }),
+        name: Flags.string({
+            char: 'n',
+            description: 'Name for app/tile(use quotes for spaces)'
+        }),
+        shortName: Flags.string({ char: 'N', description: 'App short name' }),
+        templateName: Flags.string({
+            char: 't',
+            description: 'App template to use'
+        })
+    };
+    async run() {
+        const parsed = await this.parse(CreateApp);
+        echoCliLogo();
+        const options = await promptForMissingOptions(parsed.flags);
+        await createProject(options);
+    }
+}
+CreateApp.run();
+//# sourceMappingURL=echo-create.js.map

package/lib/echo-create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"echo-create.js","sourceRoot":"","sources":["../src/echo-create.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,OAAO;IACnC,MAAM,CAAC,WAAW,GAAG,wBAAwB,CAAC;IAE9C,MAAM,CAAC,KAAK,GAAG;QAClB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC;QACxE,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;QAC3E,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAC/B,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,0BAA0B;SAC1C,CAAC;QACF,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;QACjE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACf,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,0CAA0C;SAC1D,CAAC;QACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;QACrE,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,qBAAqB;SACrC,CAAC;KACL,CAAC;IAEK,KAAK,CAAC,GAAG;QACZ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3C,WAAW,EAAE,CAAC;QACd,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5D,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;;AAGL,SAAS,CAAC,GAAG,EAAE,CAAC"}

package/lib/echo-dev-host/.env

@@ -0,0 +1,29 @@
+/* eslint-disable */
+
+Never use PROCESS.ENV/process.env use env() instead. (Except for process.env.NODE_ENV)
+---------------------------------
+
+Based on: https://www.freecodecamp.org/news/how-to-implement-runtime-environment-variables-with-create-react-app-docker-and-nginx-7f9d42a91d70/
+
+All variables in this files are converted to env() during build, and values here are replaced
+by environment variables if they exists. This is done by running the env.sh bash script before the
+build.
+
+env.sh generates env-config.js containing all the variables, which is included in index.html,
+and appended to Window._env_. env() is a shortcut for Window._env_ and should be used in code.
+
+NOTE: Seems like window._env_ is not available in a worker
+
+*/
+WEBSITE_HOSTNAME=localhost:3000;
+REACT_APP_DEFAULT_CACHE_LOCATION=localstorage
+REACT_APP_API_URL=https://dt-echopedia-api-dev.azurewebsites.net
+REACT_APP_WEB_URL=https://dt-echopedia-web-dev.azurewebsites.net
+REACT_APP_WEB_PROD_URL=https://echo.equinor.com
+REACT_APP_AZURE_AD_TENNANT=StatoilSRM.onmicrosoft.com
+REACT_APP_AZURE_AD_TENNANT_ID=3aa4a235-b6e2-48d5-9195-7fcf05b459b0
+REACT_APP_AZURE_AD_CLIENT_ID=751d2504-0b66-4b78-9807-4b60525a14c6
+REACT_APP_API_CLIENT_ID=aef35d97-53d4-4fd0-adaf-c5a514b38436
+REACT_APP_APPINSIGHTS_CONNECTION_STRING=InstrumentationKey=e5299075-a00d-4012-96f9-42861e8d8a9e;IngestionEndpoint=https://northeurope-3.in.applicationinsights.azure.com/;LiveEndpoint=https://northeurope.livediagnostics.monitor.azure.com/;ApplicationId=a9b64222-d4a9-42e6-a615-7428fe1a26af
+REACT_APP_AZURE_BUILD_NUMBER=0.8.dev.9
+REACT_APP_LOGGER_ACTIVE=false

package/lib/echo-dev-host/README.md

@@ -0,0 +1,121 @@
+# echo-dev-host
+
+**echo-dev-host** is a lightweight host application for developing and testing Echo Modules locally. It is shipped as source code with [`echo-cli`](../README.md) and provides a development shell that closely mimics the EchopediaWeb environment.
+
+---
+
+## What is echo-dev-host?
+
+- Provides a local "empty shell" of EchopediaWeb for rapid Echo Module development.
+- Ensures your module runs with the same dependencies and environment as production.
+- Supports hot module reloading for fast feedback during development.
+- Now shipped as source code, so you can update dependencies and rebuild locally—no need to wait for a new `echo-cli` release.
+
+---
+
+## New Workflow (from 2025)
+
+**You are now in control of the Echo library versions used by your dev host!**
+
+1. **Develop Echo libraries** (`echo-core`, `echo-base`, `echo-utils`, etc.) in the EchopediaWeb monorepo.
+2. **Release new versions** of these libraries from EchopediaWeb.
+3. **echo-cli** now ships with the source code of `echo-dev-host` (formerly echo-client), not a pre-built version.
+4. **Consumer project:**
+    - Builds `echo-dev-host` locally using `npx build-echo-dev-host`
+    - Can update Echo library dependencies locally using `npx update-echo-libs`
+    - No need to bump and release `echo-cli` for every Echo library update—much more efficient and flexible.
+
+---
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (see [root README](../../../README.md) for version requirements)
+- [`echo-cli`](../README.md) installed as a dev dependency in your Echo Module project
+
+### Typical Workflow
+
+1. **Install dependencies**  
+   In your Echo Module project:
+
+    ```sh
+    npm install
+    ```
+
+2. **Build echo-dev-host locally**
+
+    ```sh
+    npx build-echo-dev-host
+    ```
+
+    This will:
+
+    - Copy `echo-dev-host` from `node_modules/@equinor/echo-cli` to your project root as `echo-dev-host-tmp`
+    - Install dependencies and build `echo-dev-host`
+    - Copy the build output back to `node_modules/@equinor/echo-cli`
+
+3. **Start development server**
+
+    ```sh
+    npm start
+    ```
+
+    Your module will open in the browser, running inside the dev host.
+
+4. **Update Echo library dependencies (optional)**  
+   To update the Echo libraries used by your dev host:
+    ```sh
+    npx update-echo-libs
+    ```
+    - You will be prompted for each Echo library to update to the latest or specify a version.
+    - Use the `-a` flag to update all to the latest automatically:
+        ```sh
+        npx update-echo-libs -a
+        ```
+    - This updates dependencies and rebuilds `echo-dev-host`.
+
+---
+
+## Commands Reference
+
+- **`npx build-echo-dev-host`**
+
+    - Builds the dev host locally with your current Echo library versions.
+    - Should be run after installing or updating dependencies.
+
+- **`npx update-echo-libs`**
+    - Prompts you to update Echo library dependencies in the dev host.
+    - Rebuilds the dev host after updating.
+    - Use `-a` to update all Echo libraries to the latest versions automatically.
+
+---
+
+## Why this new approach?
+
+- **No more waiting for echo-cli releases** just to get new Echo library versions.
+- **You control the dev host dependencies**—update and rebuild as needed.
+- **Faster, more flexible development** for all Echo teams.
+
+---
+
+## Troubleshooting
+
+- If you see errors about missing `echo-dev-host` build output, re-run:
+    ```sh
+    npx build-echo-dev-host
+    ```
+- For dependency version mismatches, use:
+    ```sh
+    npx update-echo-libs
+    ```
+
+---
+
+## More Information
+
+- [echo-cli documentation](../README.md)
+- [How to release new echo-cli versions](../README.md#how-to-make-a-new-release)
+- [EchopediaWeb monorepo documentation](../../../README.md)
+
+---

package/lib/echo-dev-host/babel.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+    presets: ['@babel/preset-env', ['@babel/preset-react', {'runtime': 'automatic'}]],
+    plugins: [
+        '@babel/plugin-syntax-dynamic-import'
+    ],
+    env: {
+        test: {
+            plugins: ['@babel/plugin-transform-runtime'],
+        },
+    },
+};

package/lib/echo-dev-host/env.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+#https://www.freecodecamp.org/news/how-to-implement-runtime-environment-variables-with-create-react-app-docker-and-nginx-7f9d42a91d70/
+#
+
+# Recreate config file
+rm -rf ./env-config.js
+touch ./env-config.js
+
+echo "creating env-config.js"
+
+# Add assignment 
+echo "window._env_ = {" >> ./env-config.js
+
+# Read each line in .env file
+# Each line represents key=value pairs
+while read -r line || [[ -n "$line" ]];
+do
+  #only process lines containting =
+  if [[ $line == *"="* ]]; then
+
+    # Split env variables by character `=`
+    if printf '%s\n' "$line" | grep -q -e '='; then
+      varname=$(printf '%s\n' "$line" | sed -e 's/=.*//')
+      varvalue=$(printf '%s\n' "$line" | sed -e 's/^[^=]*=//')
+    fi
+
+    # Read value of current variable if exists as Environment variable
+    value=$(printf '%s\n' "${!varname}")
+    # Otherwise use value from .env file
+    [[ -z $value ]] && value=${varvalue}
+  
+    # Append configuration property to JS file
+    echo "  $varname: \"$value\"," >> ./env-config.js
+
+    #print variables
+    valueObfuscated=$(printf '%s' "$value" | cut -c 1-3)
+    #echo "  $varname: \"$value\"," #print the environment variables
+    echo "  $varname=\"$valueObfuscated***\"," #print the environment variables obfuscated
+  fi
+done < .env
+
+echo "}" >> ./env-config.js
+
+#if directory exists, copy to public folder. Needed for dev enironment (npm start)
+if [ -d "public" ]; then
+  rm -rf ./public/env-config.js
+  cp ./env-config.js ./public/env-config.js
+fi
+
+echo "done creating env-config.js"

package/lib/echo-dev-host/jest.config.js

@@ -0,0 +1,21 @@
+module.exports = {
+    testEnvironment: 'jsdom',
+    moduleNameMapper: {
+        '\\.css$': 'identity-obj-proxy',
+        '\\.svg$': '<rootDir>/src/__mocks__/svgrMock.ts'
+    },
+    preset: 'ts-jest',
+    coveragePathIgnorePatterns: ['src/types/*', 'src/index.ts', 'src/typings/*'],
+    collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}', '!<rootDir>/node_modules/'],
+    coverageThreshold: {
+        global: {
+            lines: 90,
+            statements: 90
+        }
+    },
+    transform: {
+        '^.+\\.(j|t)sx?$': 'ts-jest'
+    },
+    testMatch: ['**/__tests__/**/*.test.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)'],
+    setupFilesAfterEnv: ['<rootDir>/src/setupTests.ts']
+};