Compare commits
124 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 8514c4def0 | |||
| aeac92f3fd | |||
| ce338e27ea | |||
| b4897d238f | |||
| df69e46697 | |||
| 1493430d9f | |||
| 78afde963b | |||
| a4a633e936 | |||
| 27fbe00cb0 | |||
| f3cc468eda | |||
| b303799b8d | |||
| 590ed5b180 | |||
| ddcf52de19 | |||
| c1b3af09ef | |||
| a1e2cda010 | |||
| d409d3a532 | |||
| b4dae84835 | |||
| 20e27c93d9 | |||
| 117dc6013c | |||
| c6bc433a73 | |||
| 299815838c | |||
| e8318cbf2f | |||
| ae60053cff | |||
| dca3cf1f08 | |||
| eaf379b119 | |||
| 0074938e57 | |||
| eed1c75aba | |||
| 6de2f36964 | |||
| 76e777a3ac | |||
| 165cd3737e | |||
| 2f11d1ba0f | |||
| 33692ff417 | |||
| f408337186 | |||
| bd6d574226 | |||
| d5c2d167ec | |||
| 2af6d5a974 | |||
| fdba21d60d | |||
| c17ebca309 | |||
| a014dcf1ab | |||
| 44bee7bf6f | |||
| 7841917058 | |||
| f5a674f98d | |||
| 80ece7c093 | |||
| 39250b3d47 | |||
| ed78c0becf | |||
| 63c103fde5 | |||
| 88003bde0f | |||
| 276a0641e8 | |||
| b166269cb4 | |||
| 3ca1b425bf | |||
| ffc07da665 | |||
| be2adaf259 | |||
| 7aa9637826 | |||
| a3c4f87741 | |||
| f005f57764 | |||
| 6e418cdbf8 | |||
| 87155900e1 | |||
| d24b11f737 | |||
| 17ebd58951 | |||
| 32bd229f91 | |||
| 4e5ddf8411 | |||
| 701c7c1b8b | |||
| 9a272def16 | |||
| 0213950aae | |||
| b7342dbf05 | |||
| 677c8d33b9 | |||
| ffc781011d | |||
| aeec1b36a3 | |||
| 4c2e7f9446 | |||
| dddad457f3 | |||
| 4f110c6e64 | |||
| 12d971c470 | |||
| 886c245e8d | |||
| 50d610e5df | |||
| 5edb62c134 | |||
| 38f22a6d95 | |||
|
|
91cdb71388 | ||
| ab33e97c8d | |||
| 47f840841c | |||
| fe2210dc9f | |||
| 489ebab6ee | |||
| 46baf07551 | |||
| cf0aabfbfc | |||
| a5005aeb96 | |||
| a7e9f1303d | |||
| 92a6508c6a | |||
| 32f6b5cbf8 | |||
| bdfbcead8d | |||
| e73e704886 | |||
| efa818680a | |||
| 572d85b3d3 | |||
| 41e1386a8d | |||
| 98d6f9e483 | |||
| f295776bea | |||
| cde63e95a8 | |||
| 6e4804a5ad | |||
| 137592a19b | |||
| b850bc48cd | |||
| e1ce867493 | |||
| 8e94ca9a60 | |||
| 81eaaaca90 | |||
| 340e7716f0 | |||
| af7b9c46d2 | |||
| 56d4432d31 | |||
|
|
324abf821e | ||
|
|
fde407a762 | ||
|
|
c9ac84954f | ||
|
|
e0b4a93f1c | ||
|
|
70015b5ffc | ||
| 5a4d47411a | |||
| 1730706034 | |||
| 7ecf342548 | |||
| 7f10392757 | |||
| 9e229eee85 | |||
| 74c2c87f22 | |||
| 0e0ee89263 | |||
| a0e8f2f5e2 | |||
| 043c5a0c6e | |||
| a1d5b4fc4e | |||
| cd0b8f18af | |||
| d5387ddc05 | |||
| 3487b348df | |||
| 81036f8da3 | |||
| b1464d97bf |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
name: Default (not tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags-ignore:
|
||||||
|
- '**'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Install pnpm and npmci
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
|
||||||
|
- name: Run npm prepare
|
||||||
|
run: npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
||||||
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
name: Default (tags)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- '*'
|
||||||
|
|
||||||
|
env:
|
||||||
|
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||||
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
|
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
security:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
continue-on-error: true
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Audit production dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --prod
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Audit development dependencies
|
||||||
|
run: |
|
||||||
|
npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
npmci command pnpm audit --audit-level=high --dev
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
test:
|
||||||
|
if: ${{ always() }}
|
||||||
|
needs: security
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Test stable
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm test
|
||||||
|
|
||||||
|
- name: Test build
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
npmci npm build
|
||||||
|
|
||||||
|
release:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Release
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm publish
|
||||||
|
|
||||||
|
metadata:
|
||||||
|
needs: test
|
||||||
|
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ${{ env.IMAGE }}
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare
|
||||||
|
run: |
|
||||||
|
pnpm install -g pnpm
|
||||||
|
pnpm install -g @shipzone/npmci
|
||||||
|
npmci npm prepare
|
||||||
|
|
||||||
|
- name: Code quality
|
||||||
|
run: |
|
||||||
|
npmci command npm install -g typescript
|
||||||
|
npmci npm install
|
||||||
|
|
||||||
|
- name: Trigger
|
||||||
|
run: npmci trigger
|
||||||
|
|
||||||
|
- name: Build docs and upload artifacts
|
||||||
|
run: |
|
||||||
|
npmci node install stable
|
||||||
|
npmci npm install
|
||||||
|
pnpm install -g @git.zone/tsdoc
|
||||||
|
npmci command tsdoc
|
||||||
|
continue-on-error: true
|
||||||
25
.gitignore
vendored
25
.gitignore
vendored
@@ -1,13 +1,20 @@
|
|||||||
node_modules/
|
.nogit/
|
||||||
.settings/
|
|
||||||
.idea/
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
|
public/
|
||||||
|
pages/
|
||||||
|
|
||||||
#npm devug
|
# installs
|
||||||
npm-debug.log
|
node_modules/
|
||||||
|
|
||||||
ts/*.js
|
# caches
|
||||||
ts/*.js.map
|
.yarn/
|
||||||
ts/typings/
|
.cache/
|
||||||
|
.rpt2_cache
|
||||||
|
|
||||||
test/browser/browserified/
|
# builds
|
||||||
|
dist/
|
||||||
|
dist_*/
|
||||||
|
|
||||||
|
# custom
|
||||||
16
.travis.yml
16
.travis.yml
@@ -1,16 +0,0 @@
|
|||||||
language: node_js
|
|
||||||
node_js:
|
|
||||||
- 4.2.2
|
|
||||||
before_install:
|
|
||||||
- npm install -g tsd
|
|
||||||
deploy:
|
|
||||||
provider: npm
|
|
||||||
email: npm@lossless.digital
|
|
||||||
api_key:
|
|
||||||
secure: 3bZ0lm2fGelnmSTyoYrBU6Rpz565Vth47jF5JDwOPlhOQLe6uerfUcY4SfEt+3GzsR0OOzP9TdJ/H7owTO7dAcsqVrCqWuWK51Mq38nsL8fhqe1Zgnf+iYv8xk+nt43MIGqEYW+0ixguOZWNUcZMIDkYEf5+lAlwIgjHoK8fzeKZRASNY2Jwk6gNGBskVSxRPvIMyKCX5Gi1hgYR4jxgAXTI9At6FcX2bq/RUeKzZf0MIwGITWnMnFAFLo+yLSTyu4nOIsJUsZ0+hwfxWhuUTznD9RUS5//+EP0gwKnZfRWl9WCNdA0I+bskW3Pn9jRBIoJcbJUITgnvSSfdNfxDaupKR00/2upKJ9ZA8bAI5qnKhUsNQXyzLdHpiN2LKPQW8amgaI5cpqo0hJ1W7NMAlW9fgKzPul7zZe9B1HmsBOBFi7seXsW8oDbB8HJjIyc8me9BHqhW/UPcFOvGoxQC9NaLmmko486Z7QtUkfxXJnGEAmBmB4twMA4Fh1vJCIrXBQkiDh7CFlPIxqQtrTgV7NcR6yMkcOltnLw9wMHZEHNoYHmRerStCa5EfvoFXm2RyBs7Nt4xC75iIksJGF/hqEtq9ow49HIYMvf5sZ6nYuF+z35SwLiWMj+yP77OOvcNBx3wvEbYqXlrQ+fPW6j0gglcZ+QZrfernTIRscika8w=
|
|
||||||
on:
|
|
||||||
tags: true
|
|
||||||
repo: pushrocks/smartenv
|
|
||||||
notifications:
|
|
||||||
slack:
|
|
||||||
secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=
|
|
||||||
11
.vscode/launch.json
vendored
Normal file
11
.vscode/launch.json
vendored
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "npm test",
|
||||||
|
"name": "Run npm test",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
26
.vscode/settings.json
vendored
Normal file
26
.vscode/settings.json
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"json.schemas": [
|
||||||
|
{
|
||||||
|
"fileMatch": ["/npmextra.json"],
|
||||||
|
"schema": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"npmci": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for npmci"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"type": "object",
|
||||||
|
"description": "settings for gitzone",
|
||||||
|
"properties": {
|
||||||
|
"projectType": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2015 Push.Rocks
|
Copyright (c) 2015 Task Venture Capital GmbH
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
28
README.md
28
README.md
@@ -1,28 +0,0 @@
|
|||||||
# smartenv
|
|
||||||
store things about your environment and let them travel across modules
|
|
||||||
|
|
||||||
## Status
|
|
||||||
[](https://travis-ci.org/pushrocks/smartenv)
|
|
||||||
[](https://david-dm.org/pushrocks/smartenv)
|
|
||||||
[](https://david-dm.org/pushrocks/smartenv#info=devDependencies)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/smartenv/master/dependencies/npm)
|
|
||||||
[](https://www.bithound.io/github/pushrocks/smartenv)
|
|
||||||
|
|
||||||
## Install
|
|
||||||
Install the package through npm
|
|
||||||
|
|
||||||
```
|
|
||||||
npm install smartenv
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
var smartenv = require("smartenv");
|
|
||||||
|
|
||||||
smartenv.info(); //prints an output about your current environment and registered objects
|
|
||||||
smartenv.register({akey:"a text"},"somevalue"); // register a new object
|
|
||||||
smartenv.makeGlobal() // make smartenv available from gobal.smartenv
|
|
||||||
smartenv.get("somevalue").akey; // returns "a text"
|
|
||||||
smartenv.items.somevalue.akey; // also returns "a text"
|
|
||||||
```
|
|
||||||
19
changelog.md
Normal file
19
changelog.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-11-01 - 6.0.0 - BREAKING CHANGE(Smartenv)
|
||||||
|
Add Deno and Bun runtime detection, introduce getSafeModuleFor API, update docs and tests, and make isNode semantics Node-only (breaking change)
|
||||||
|
|
||||||
|
- Implement runtime detection for Deno and Bun; runtimeEnv now returns one of 'node' | 'deno' | 'bun' | 'browser'.
|
||||||
|
- Change isNode to be true only for Node.js; add isDeno and isBun accessors. This is a breaking change in behavior for code that relied on isNode including Deno/Bun.
|
||||||
|
- Add getSafeModuleFor(target, moduleNameOrUrl, getFunction?) API to load modules conditionally for single, multiple or 'server' runtimes. Existing helpers getSafeNodeModule and getSafeWebModule updated to work with wider runtimes.
|
||||||
|
- Add runtime-specific version getters (nodeVersion, denoVersion, bunVersion) and update printEnv output accordingly.
|
||||||
|
- Expand and add tests for Node, Deno, Bun and Browser environments (tests/* files).
|
||||||
|
- Update documentation (readme.md and readme.hints.md) to describe detection order, new API and migration notes from 4.x to 5.x/6.x.
|
||||||
|
- Bump devDependencies (tsbuild, tsrun, tstest) and include an updated deno.lock.
|
||||||
|
|
||||||
|
## [5.0.13] - 2025-07-28
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Updated readme.md with comprehensive documentation including API reference, core features, and usage examples
|
||||||
|
- Added readme.hints.md with architecture and implementation details for future reference
|
||||||
|
- Improved documentation structure and clarity
|
||||||
10
dist/index.js
vendored
10
dist/index.js
vendored
@@ -1,10 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
var environment = require("./smartenv.environment");
|
|
||||||
var objectstorage = require("./smartenv.objectstorage");
|
|
||||||
var smartenv = {}; //create smartenv object
|
|
||||||
smartenv.getEnv = environment.getEnv;
|
|
||||||
smartenv.printEnv = environment.printEnv;
|
|
||||||
smartenv.obs = objectstorage.obs;
|
|
||||||
module.exports = smartenv;
|
|
||||||
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImluZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDBDQUEwQztBQUUxQyxJQUFPLFdBQVcsV0FBVyx3QkFBd0IsQ0FBQyxDQUFDO0FBQ3ZELElBQU8sYUFBYSxXQUFXLDBCQUEwQixDQUFDLENBQUM7QUFFM0QsSUFBSSxRQUFRLEdBQU8sRUFBRSxDQUFDLENBQUMsd0JBQXdCO0FBQy9DLFFBQVEsQ0FBQyxNQUFNLEdBQUcsV0FBVyxDQUFDLE1BQU0sQ0FBQztBQUNyQyxRQUFRLENBQUMsUUFBUSxHQUFHLFdBQVcsQ0FBQyxRQUFRLENBQUM7QUFDekMsUUFBUSxDQUFDLEdBQUcsR0FBRyxhQUFhLENBQUMsR0FBRyxDQUFDO0FBRWpDLGlCQUFTLFFBQVEsQ0FBQyIsImZpbGUiOiJpbmRleC5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCJ0eXBpbmdzL21haW4uZC50c1wiIC8+XG5cbmltcG9ydCBlbnZpcm9ubWVudCA9IHJlcXVpcmUoXCIuL3NtYXJ0ZW52LmVudmlyb25tZW50XCIpO1xuaW1wb3J0IG9iamVjdHN0b3JhZ2UgPSByZXF1aXJlKFwiLi9zbWFydGVudi5vYmplY3RzdG9yYWdlXCIpO1xuXG52YXIgc21hcnRlbnY6YW55ID0ge307IC8vY3JlYXRlIHNtYXJ0ZW52IG9iamVjdFxuc21hcnRlbnYuZ2V0RW52ID0gZW52aXJvbm1lbnQuZ2V0RW52O1xuc21hcnRlbnYucHJpbnRFbnYgPSBlbnZpcm9ubWVudC5wcmludEVudjtcbnNtYXJ0ZW52Lm9icyA9IG9iamVjdHN0b3JhZ2Uub2JzO1xuXG5leHBvcnQgPSBzbWFydGVudjtcbiJdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==
|
|
||||||
51
dist/smartenv.classes.helpers.js
vendored
51
dist/smartenv.classes.helpers.js
vendored
@@ -1,51 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
exports.getEnvString = function () {
|
|
||||||
if (typeof window !== "undefined") {
|
|
||||||
return "browser";
|
|
||||||
}
|
|
||||||
else if (typeof process !== "undefined") {
|
|
||||||
return "node";
|
|
||||||
}
|
|
||||||
};
|
|
||||||
exports.getUserAgentString = function () {
|
|
||||||
if (exports.isBrowser()) {
|
|
||||||
return navigator.userAgent;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
exports.isNode = function () {
|
|
||||||
if (exports.getEnvString() === "node") {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
exports.getNodeVersion = function () {
|
|
||||||
return process.version;
|
|
||||||
};
|
|
||||||
exports.isBrowser = function () {
|
|
||||||
return !exports.isNode();
|
|
||||||
};
|
|
||||||
exports.isCI = function () {
|
|
||||||
if (process.env.CI) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
;
|
|
||||||
};
|
|
||||||
exports.isTravis = function () {
|
|
||||||
if (process.env.TRAVIS) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
;
|
|
||||||
};
|
|
||||||
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZW52LmNsYXNzZXMuaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwwQ0FBMEM7QUFFL0Isb0JBQVksR0FBRztJQUN0QixFQUFFLENBQUMsQ0FBQyxPQUFPLE1BQU0sS0FBSyxXQUFXLENBQUMsQ0FBQyxDQUFDO1FBQ2hDLE1BQU0sQ0FBQyxTQUFTLENBQUM7SUFDckIsQ0FBQztJQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxPQUFPLE9BQU8sS0FBSyxXQUFXLENBQUMsQ0FBQyxDQUFDO1FBQ3hDLE1BQU0sQ0FBQyxNQUFNLENBQUM7SUFDbEIsQ0FBQztBQUNMLENBQUMsQ0FBQztBQUVTLDBCQUFrQixHQUFHO0lBQzVCLEVBQUUsQ0FBQSxDQUFDLGlCQUFTLEVBQUUsQ0FBQyxDQUFBLENBQUM7UUFDWixNQUFNLENBQUUsU0FBUyxDQUFDLFNBQVMsQ0FBQztJQUNoQyxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixNQUFNLENBQUMsU0FBUyxDQUFDO0lBQ3JCLENBQUM7QUFDTCxDQUFDLENBQUM7QUFFUyxjQUFNLEdBQUc7SUFDaEIsRUFBRSxDQUFDLENBQUMsb0JBQVksRUFBRSxLQUFLLE1BQU0sQ0FBQyxDQUFBLENBQUM7UUFDM0IsTUFBTSxDQUFDLElBQUksQ0FBQztJQUNoQixDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixNQUFNLENBQUMsS0FBSyxDQUFDO0lBQ2pCLENBQUM7QUFDTCxDQUFDLENBQUM7QUFFUyxzQkFBYyxHQUFHO0lBQ3hCLE1BQU0sQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDO0FBQzNCLENBQUMsQ0FBQztBQUVTLGlCQUFTLEdBQUc7SUFDbkIsTUFBTSxDQUFDLENBQUMsY0FBTSxFQUFFLENBQUM7QUFDckIsQ0FBQyxDQUFDO0FBRVMsWUFBSSxHQUFHO0lBQ2QsRUFBRSxDQUFBLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsQ0FBQSxDQUFDO1FBQ2YsTUFBTSxDQUFDLElBQUksQ0FBQztJQUNoQixDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixNQUFNLENBQUMsS0FBSyxDQUFDO0lBQ2pCLENBQUM7SUFBQSxDQUFDO0FBQ04sQ0FBQyxDQUFDO0FBRVMsZ0JBQVEsR0FBRztJQUNsQixFQUFFLENBQUEsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxDQUFBLENBQUM7UUFDbkIsTUFBTSxDQUFDLElBQUksQ0FBQztJQUNoQixDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixNQUFNLENBQUMsS0FBSyxDQUFDO0lBQ2pCLENBQUM7SUFBQSxDQUFDO0FBQ04sQ0FBQyxDQUFDIiwiZmlsZSI6InNtYXJ0ZW52LmNsYXNzZXMuaGVscGVycy5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCJ0eXBpbmdzL21haW4uZC50c1wiIC8+XG5cbmV4cG9ydCB2YXIgZ2V0RW52U3RyaW5nID0gZnVuY3Rpb24oKTpzdHJpbmcge1xuICAgIGlmICh0eXBlb2Ygd2luZG93ICE9PSBcInVuZGVmaW5lZFwiKSB7XG4gICAgICAgIHJldHVybiBcImJyb3dzZXJcIjtcbiAgICB9IGVsc2UgaWYgKHR5cGVvZiBwcm9jZXNzICE9PSBcInVuZGVmaW5lZFwiKSB7XG4gICAgICAgIHJldHVybiBcIm5vZGVcIjtcbiAgICB9XG59O1xuXG5leHBvcnQgdmFyIGdldFVzZXJBZ2VudFN0cmluZyA9IGZ1bmN0aW9uKCk6c3RyaW5ne1xuICAgIGlmKGlzQnJvd3NlcigpKXtcbiAgICAgICAgcmV0dXJuICBuYXZpZ2F0b3IudXNlckFnZW50O1xuICAgIH0gZWxzZSB7XG4gICAgICAgIHJldHVybiB1bmRlZmluZWQ7XG4gICAgfVxufTtcblxuZXhwb3J0IHZhciBpc05vZGUgPSBmdW5jdGlvbigpOmJvb2xlYW4ge1xuICAgIGlmIChnZXRFbnZTdHJpbmcoKSA9PT0gXCJub2RlXCIpe1xuICAgICAgICByZXR1cm4gdHJ1ZTtcbiAgICB9IGVsc2Uge1xuICAgICAgICByZXR1cm4gZmFsc2U7XG4gICAgfVxufTtcblxuZXhwb3J0IHZhciBnZXROb2RlVmVyc2lvbiA9IGZ1bmN0aW9uKCk6c3RyaW5nIHtcbiAgICByZXR1cm4gcHJvY2Vzcy52ZXJzaW9uO1xufTtcblxuZXhwb3J0IHZhciBpc0Jyb3dzZXIgPSBmdW5jdGlvbigpOmJvb2xlYW4ge1xuICAgIHJldHVybiAhaXNOb2RlKCk7XG59O1xuXG5leHBvcnQgdmFyIGlzQ0kgPSBmdW5jdGlvbigpe1xuICAgIGlmKHByb2Nlc3MuZW52LkNJKXtcbiAgICAgICAgcmV0dXJuIHRydWU7XG4gICAgfSBlbHNlIHtcbiAgICAgICAgcmV0dXJuIGZhbHNlO1xuICAgIH07XG59O1xuXG5leHBvcnQgdmFyIGlzVHJhdmlzID0gZnVuY3Rpb24oKXtcbiAgICBpZihwcm9jZXNzLmVudi5UUkFWSVMpe1xuICAgICAgICByZXR1cm4gdHJ1ZTtcbiAgICB9IGVsc2Uge1xuICAgICAgICByZXR1cm4gZmFsc2U7XG4gICAgfTtcbn07Il0sInNvdXJjZVJvb3QiOiIvc291cmNlLyJ9
|
|
||||||
18
dist/smartenv.classes.js
vendored
18
dist/smartenv.classes.js
vendored
@@ -1,18 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
var helpers = require("./smartenv.classes.helpers");
|
|
||||||
var Environment = (function () {
|
|
||||||
function Environment() {
|
|
||||||
this.runtimeEnv = helpers.getEnvString();
|
|
||||||
this.isBrowser = helpers.isBrowser();
|
|
||||||
this.userAgent = helpers.getUserAgentString();
|
|
||||||
this.isNode = helpers.isNode();
|
|
||||||
this.nodeVersion = helpers.getNodeVersion();
|
|
||||||
this.isCI = helpers.isCI();
|
|
||||||
this.isTravis = helpers.isTravis();
|
|
||||||
}
|
|
||||||
;
|
|
||||||
return Environment;
|
|
||||||
})();
|
|
||||||
exports.Environment = Environment;
|
|
||||||
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZW52LmNsYXNzZXMudHMiXSwibmFtZXMiOlsiRW52aXJvbm1lbnQiLCJFbnZpcm9ubWVudC5jb25zdHJ1Y3RvciJdLCJtYXBwaW5ncyI6IkFBQUEsMENBQTBDO0FBRTFDLElBQU8sT0FBTyxXQUFXLDRCQUE0QixDQUFDLENBQUM7QUFDdkQ7SUFRSUE7UUFDSUMsSUFBSUEsQ0FBQ0EsVUFBVUEsR0FBR0EsT0FBT0EsQ0FBQ0EsWUFBWUEsRUFBRUEsQ0FBQ0E7UUFDekNBLElBQUlBLENBQUNBLFNBQVNBLEdBQUdBLE9BQU9BLENBQUNBLFNBQVNBLEVBQUVBLENBQUNBO1FBQ3JDQSxJQUFJQSxDQUFDQSxTQUFTQSxHQUFHQSxPQUFPQSxDQUFDQSxrQkFBa0JBLEVBQUVBLENBQUNBO1FBQzlDQSxJQUFJQSxDQUFDQSxNQUFNQSxHQUFHQSxPQUFPQSxDQUFDQSxNQUFNQSxFQUFFQSxDQUFDQTtRQUMvQkEsSUFBSUEsQ0FBQ0EsV0FBV0EsR0FBR0EsT0FBT0EsQ0FBQ0EsY0FBY0EsRUFBRUEsQ0FBQ0E7UUFDNUNBLElBQUlBLENBQUNBLElBQUlBLEdBQUdBLE9BQU9BLENBQUNBLElBQUlBLEVBQUVBLENBQUNBO1FBQzNCQSxJQUFJQSxDQUFDQSxRQUFRQSxHQUFHQSxPQUFPQSxDQUFDQSxRQUFRQSxFQUFFQSxDQUFDQTtJQUN2Q0EsQ0FBQ0E7O0lBQ0xELGtCQUFDQTtBQUFEQSxDQWpCQSxBQWlCQ0EsSUFBQTtBQWpCWSxtQkFBVyxjQWlCdkIsQ0FBQSIsImZpbGUiOiJzbWFydGVudi5jbGFzc2VzLmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cInR5cGluZ3MvbWFpbi5kLnRzXCIgLz5cblxuaW1wb3J0IGhlbHBlcnMgPSByZXF1aXJlKFwiLi9zbWFydGVudi5jbGFzc2VzLmhlbHBlcnNcIik7XG5leHBvcnQgY2xhc3MgRW52aXJvbm1lbnQge1xuICAgIHJ1bnRpbWVFbnY6c3RyaW5nO1xuICAgIGlzQnJvd3Nlcjpib29sZWFuO1xuICAgIHVzZXJBZ2VudDpzdHJpbmc7XG4gICAgaXNOb2RlOmJvb2xlYW47XG4gICAgbm9kZVZlcnNpb246c3RyaW5nO1xuICAgIGlzQ0k6Ym9vbGVhbjtcbiAgICBpc1RyYXZpczpib29sZWFuO1xuICAgIGNvbnN0cnVjdG9yKCkge1xuICAgICAgICB0aGlzLnJ1bnRpbWVFbnYgPSBoZWxwZXJzLmdldEVudlN0cmluZygpO1xuICAgICAgICB0aGlzLmlzQnJvd3NlciA9IGhlbHBlcnMuaXNCcm93c2VyKCk7XG4gICAgICAgIHRoaXMudXNlckFnZW50ID0gaGVscGVycy5nZXRVc2VyQWdlbnRTdHJpbmcoKTtcbiAgICAgICAgdGhpcy5pc05vZGUgPSBoZWxwZXJzLmlzTm9kZSgpO1xuICAgICAgICB0aGlzLm5vZGVWZXJzaW9uID0gaGVscGVycy5nZXROb2RlVmVyc2lvbigpO1xuICAgICAgICB0aGlzLmlzQ0kgPSBoZWxwZXJzLmlzQ0koKTtcbiAgICAgICAgdGhpcy5pc1RyYXZpcyA9IGhlbHBlcnMuaXNUcmF2aXMoKTtcbiAgICB9O1xufVxuIl0sInNvdXJjZVJvb3QiOiIvc291cmNlLyJ9
|
|
||||||
39
dist/smartenv.environment.js
vendored
39
dist/smartenv.environment.js
vendored
@@ -1,39 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
/**
|
|
||||||
* Deals with the environment the current JS script is running in.
|
|
||||||
*/
|
|
||||||
var plugins = require("./smartenv.plugins");
|
|
||||||
var classes = require("./smartenv.classes");
|
|
||||||
var objectStorage = require("./smartenv.objectstorage");
|
|
||||||
var environment;
|
|
||||||
var envDetermined = false;
|
|
||||||
/**
|
|
||||||
* returns the environment
|
|
||||||
* @returns {Environment}
|
|
||||||
*/
|
|
||||||
exports.getEnv = function () {
|
|
||||||
if (!envDetermined) {
|
|
||||||
environment = new classes.Environment();
|
|
||||||
envDetermined = true; // ensure code above only runs once
|
|
||||||
}
|
|
||||||
;
|
|
||||||
return environment;
|
|
||||||
};
|
|
||||||
/**
|
|
||||||
* prints the environment to console
|
|
||||||
*/
|
|
||||||
exports.printEnv = function () {
|
|
||||||
if (this.getEnv().isNode) {
|
|
||||||
plugins.beautylog.ok("running on NODE");
|
|
||||||
var smartenvVersion = require("../package.json").version;
|
|
||||||
plugins.beautylog.log("node version is " + this.getEnv().nodeVersion + " and smartenv version is " + smartenvVersion);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.ok("running on BROWSER");
|
|
||||||
plugins.beautylog.log("browser is " + this.getEnv().userAgent);
|
|
||||||
}
|
|
||||||
plugins.beautylog.log("the smartenv registration store currently holds the following properties:");
|
|
||||||
console.log(Object.getOwnPropertyNames(objectStorage.obs.getAll()));
|
|
||||||
};
|
|
||||||
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZW52LmVudmlyb25tZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDBDQUEwQztBQUMxQzs7R0FFRztBQUNILElBQU8sT0FBTyxXQUFXLG9CQUFvQixDQUFDLENBQUM7QUFDL0MsSUFBTyxPQUFPLFdBQVcsb0JBQW9CLENBQUMsQ0FBQztBQUMvQyxJQUFPLGFBQWEsV0FBVywwQkFBMEIsQ0FBQyxDQUFDO0FBRzNELElBQUksV0FBK0IsQ0FBQztBQUNwQyxJQUFJLGFBQWEsR0FBVyxLQUFLLENBQUM7QUFFbEM7OztHQUdHO0FBQ1EsY0FBTSxHQUFHO0lBQ2hCLEVBQUUsQ0FBQyxDQUFDLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztRQUNqQixXQUFXLEdBQUcsSUFBSSxPQUFPLENBQUMsV0FBVyxFQUFFLENBQUM7UUFDeEMsYUFBYSxHQUFHLElBQUksQ0FBQyxDQUFDLG1DQUFtQztJQUM3RCxDQUFDO0lBQUEsQ0FBQztJQUNGLE1BQU0sQ0FBQyxXQUFXLENBQUM7QUFDdkIsQ0FBQyxDQUFDO0FBRUY7O0dBRUc7QUFDUyxnQkFBUSxHQUFHO0lBQ25CLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO1FBQ3ZCLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGlCQUFpQixDQUFDLENBQUM7UUFDeEMsSUFBSSxlQUFlLEdBQUcsT0FBTyxDQUFDLGlCQUFpQixDQUFDLENBQUMsT0FBTyxDQUFDO1FBQ3pELE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLGtCQUFrQixHQUFHLElBQUksQ0FBQyxNQUFNLEVBQUUsQ0FBQyxXQUFXLEdBQUcsMkJBQTJCLEdBQUcsZUFBZSxDQUFDLENBQUM7SUFDMUgsQ0FBQztJQUFDLElBQUksQ0FBQyxDQUFDO1FBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsb0JBQW9CLENBQUMsQ0FBQztRQUMzQyxPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxhQUFhLEdBQUcsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ25FLENBQUM7SUFDRCxPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQywyRUFBMkUsQ0FBQyxDQUFDO0lBQ25HLE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLG1CQUFtQixDQUFDLGFBQWEsQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxDQUFDO0FBQ3hFLENBQUMsQ0FBQyIsImZpbGUiOiJzbWFydGVudi5lbnZpcm9ubWVudC5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCJ0eXBpbmdzL21haW4uZC50c1wiIC8+XG4vKipcbiAqIERlYWxzIHdpdGggdGhlIGVudmlyb25tZW50IHRoZSBjdXJyZW50IEpTIHNjcmlwdCBpcyBydW5uaW5nIGluLlxuICovXG5pbXBvcnQgcGx1Z2lucyA9IHJlcXVpcmUoXCIuL3NtYXJ0ZW52LnBsdWdpbnNcIik7XG5pbXBvcnQgY2xhc3NlcyA9IHJlcXVpcmUoXCIuL3NtYXJ0ZW52LmNsYXNzZXNcIik7XG5pbXBvcnQgb2JqZWN0U3RvcmFnZSA9IHJlcXVpcmUoXCIuL3NtYXJ0ZW52Lm9iamVjdHN0b3JhZ2VcIik7XG5cblxudmFyIGVudmlyb25tZW50OmNsYXNzZXMuRW52aXJvbm1lbnQ7XG52YXIgZW52RGV0ZXJtaW5lZDpib29sZWFuID0gZmFsc2U7XG5cbi8qKlxuICogcmV0dXJucyB0aGUgZW52aXJvbm1lbnRcbiAqIEByZXR1cm5zIHtFbnZpcm9ubWVudH1cbiAqL1xuZXhwb3J0IHZhciBnZXRFbnYgPSBmdW5jdGlvbigpe1xuICAgIGlmICghZW52RGV0ZXJtaW5lZCkge1xuICAgICAgICBlbnZpcm9ubWVudCA9IG5ldyBjbGFzc2VzLkVudmlyb25tZW50KCk7XG4gICAgICAgIGVudkRldGVybWluZWQgPSB0cnVlOyAvLyBlbnN1cmUgY29kZSBhYm92ZSBvbmx5IHJ1bnMgb25jZVxuICAgIH07XG4gICAgcmV0dXJuIGVudmlyb25tZW50O1xufTtcblxuLyoqXG4gKiBwcmludHMgdGhlIGVudmlyb25tZW50IHRvIGNvbnNvbGVcbiAqL1xuZXhwb3J0IHZhciAgcHJpbnRFbnYgPSBmdW5jdGlvbigpIHtcbiAgICBpZiAodGhpcy5nZXRFbnYoKS5pc05vZGUpIHtcbiAgICAgICAgcGx1Z2lucy5iZWF1dHlsb2cub2soXCJydW5uaW5nIG9uIE5PREVcIik7XG4gICAgICAgIHZhciBzbWFydGVudlZlcnNpb24gPSByZXF1aXJlKFwiLi4vcGFja2FnZS5qc29uXCIpLnZlcnNpb247XG4gICAgICAgIHBsdWdpbnMuYmVhdXR5bG9nLmxvZyhcIm5vZGUgdmVyc2lvbiBpcyBcIiArIHRoaXMuZ2V0RW52KCkubm9kZVZlcnNpb24gKyBcIiBhbmQgc21hcnRlbnYgdmVyc2lvbiBpcyBcIiArIHNtYXJ0ZW52VmVyc2lvbik7XG4gICAgfSBlbHNlIHtcbiAgICAgICAgcGx1Z2lucy5iZWF1dHlsb2cub2soXCJydW5uaW5nIG9uIEJST1dTRVJcIik7XG4gICAgICAgIHBsdWdpbnMuYmVhdXR5bG9nLmxvZyhcImJyb3dzZXIgaXMgXCIgKyB0aGlzLmdldEVudigpLnVzZXJBZ2VudCk7XG4gICAgfVxuICAgIHBsdWdpbnMuYmVhdXR5bG9nLmxvZyhcInRoZSBzbWFydGVudiByZWdpc3RyYXRpb24gc3RvcmUgY3VycmVudGx5IGhvbGRzIHRoZSBmb2xsb3dpbmcgcHJvcGVydGllczpcIik7XG4gICAgY29uc29sZS5sb2coT2JqZWN0LmdldE93blByb3BlcnR5TmFtZXMob2JqZWN0U3RvcmFnZS5vYnMuZ2V0QWxsKCkpKTtcbn07Il0sInNvdXJjZVJvb3QiOiIvc291cmNlLyJ9
|
|
||||||
46
dist/smartenv.objectstorage.js
vendored
46
dist/smartenv.objectstorage.js
vendored
@@ -1,46 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
var plugins = require("./smartenv.plugins");
|
|
||||||
exports.obs = {
|
|
||||||
add: function (paramNameArg, objectArg) {
|
|
||||||
if (paramNameArg === void 0) { paramNameArg = "undefined"; }
|
|
||||||
if (objectArg === void 0) { objectArg = "undefined"; }
|
|
||||||
if (paramNameArg == "undefined") {
|
|
||||||
plugins.beautylog.error("paramName is undefined");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (objectArg == "undefined") {
|
|
||||||
plugins.beautylog.error("objectArg is undefined");
|
|
||||||
}
|
|
||||||
if (typeof exports.obsItems[paramNameArg] === "undefined") {
|
|
||||||
exports.obsItems[paramNameArg] = objectArg;
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.error("object is already present, so add operation has failed.");
|
|
||||||
}
|
|
||||||
return exports.obsItems[paramNameArg];
|
|
||||||
},
|
|
||||||
replace: function (paramNameArg, objectArg) {
|
|
||||||
exports.obsItems[paramNameArg] = objectArg;
|
|
||||||
},
|
|
||||||
merge: function (paramNameArg, objectArg) {
|
|
||||||
if (!(typeof exports.obsItems[paramNameArg] === "undefined")) {
|
|
||||||
exports.obsItems[paramNameArg] = plugins._.assign(exports.obsItems[paramNameArg], objectArg);
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
plugins.beautylog.error("object is not present, so there is nothing to merge");
|
|
||||||
}
|
|
||||||
},
|
|
||||||
get: function (keyName) {
|
|
||||||
return exports.obsItems[keyName];
|
|
||||||
},
|
|
||||||
getAll: function () {
|
|
||||||
return exports.obsItems;
|
|
||||||
},
|
|
||||||
addComplete: function (itemsArg) {
|
|
||||||
exports.obsItems = plugins._.assign(exports.obsItems, itemsArg);
|
|
||||||
return exports.obsItems;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
exports.obsItems = {};
|
|
||||||
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZW52Lm9iamVjdHN0b3JhZ2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsMENBQTBDO0FBQzFDLElBQU8sT0FBTyxXQUFXLG9CQUFvQixDQUFDLENBQUM7QUFFcEMsV0FBRyxHQUFPO0lBQ2pCLEdBQUcsRUFBRSxVQUFTLFlBQTBCLEVBQUMsU0FBdUI7UUFBbEQsNEJBQTBCLEdBQTFCLDBCQUEwQjtRQUFDLHlCQUF1QixHQUF2Qix1QkFBdUI7UUFDNUQsRUFBRSxDQUFDLENBQUMsWUFBWSxJQUFJLFdBQVcsQ0FBQyxDQUFBLENBQUM7WUFDN0IsT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsd0JBQXdCLENBQUMsQ0FBQztZQUNsRCxNQUFNLENBQUM7UUFDWCxDQUFDO1FBQ0QsRUFBRSxDQUFDLENBQUMsU0FBUyxJQUFJLFdBQVcsQ0FBQyxDQUFBLENBQUM7WUFDMUIsT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsd0JBQXdCLENBQUMsQ0FBQztRQUN0RCxDQUFDO1FBQ0QsRUFBRSxDQUFDLENBQUMsT0FBTyxnQkFBUSxDQUFDLFlBQVksQ0FBQyxLQUFLLFdBQVcsQ0FBQyxDQUFBLENBQUM7WUFDL0MsZ0JBQVEsQ0FBQyxZQUFZLENBQUMsR0FBRyxTQUFTLENBQUM7UUFDdkMsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMseURBQXlELENBQUMsQ0FBQztRQUN2RixDQUFDO1FBQ0QsTUFBTSxDQUFDLGdCQUFRLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDbEMsQ0FBQztJQUNELE9BQU8sRUFBRSxVQUFTLFlBQVksRUFBQyxTQUFTO1FBQ3BDLGdCQUFRLENBQUMsWUFBWSxDQUFDLEdBQUcsU0FBUyxDQUFDO0lBQ3ZDLENBQUM7SUFDRCxLQUFLLEVBQUUsVUFBUyxZQUFZLEVBQUMsU0FBUztRQUNsQyxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsT0FBTyxnQkFBUSxDQUFDLFlBQVksQ0FBQyxLQUFLLFdBQVcsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUNqRCxnQkFBUSxDQUFDLFlBQVksQ0FBQyxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLGdCQUFRLENBQUMsWUFBWSxDQUFDLEVBQUMsU0FBUyxDQUFDLENBQUM7UUFDaEYsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMscURBQXFELENBQUMsQ0FBQztRQUNuRixDQUFDO0lBQ0wsQ0FBQztJQUNELEdBQUcsRUFBRSxVQUFTLE9BQU87UUFDakIsTUFBTSxDQUFDLGdCQUFRLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDN0IsQ0FBQztJQUNELE1BQU0sRUFBRTtRQUNKLE1BQU0sQ0FBQyxnQkFBUSxDQUFDO0lBQ3BCLENBQUM7SUFDRCxXQUFXLEVBQUUsVUFBUyxRQUFRO1FBQzFCLGdCQUFRLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsZ0JBQVEsRUFBQyxRQUFRLENBQUMsQ0FBQztRQUMvQyxNQUFNLENBQUMsZ0JBQVEsQ0FBQztJQUNwQixDQUFDO0NBQ0osQ0FBQztBQUNTLGdCQUFRLEdBQU8sRUFBRSxDQUFDIiwiZmlsZSI6InNtYXJ0ZW52Lm9iamVjdHN0b3JhZ2UuanMiLCJzb3VyY2VzQ29udGVudCI6WyIvLy8gPHJlZmVyZW5jZSBwYXRoPVwidHlwaW5ncy9tYWluLmQudHNcIiAvPlxuaW1wb3J0IHBsdWdpbnMgPSByZXF1aXJlKFwiLi9zbWFydGVudi5wbHVnaW5zXCIpO1xuXG5leHBvcnQgdmFyIG9iczphbnkgPSB7XG4gICAgYWRkOiBmdW5jdGlvbihwYXJhbU5hbWVBcmcgPSBcInVuZGVmaW5lZFwiLG9iamVjdEFyZyA9IFwidW5kZWZpbmVkXCIpIHtcbiAgICAgICAgaWYgKHBhcmFtTmFtZUFyZyA9PSBcInVuZGVmaW5lZFwiKXtcbiAgICAgICAgICAgIHBsdWdpbnMuYmVhdXR5bG9nLmVycm9yKFwicGFyYW1OYW1lIGlzIHVuZGVmaW5lZFwiKTtcbiAgICAgICAgICAgIHJldHVybjtcbiAgICAgICAgfVxuICAgICAgICBpZiAob2JqZWN0QXJnID09IFwidW5kZWZpbmVkXCIpe1xuICAgICAgICAgICAgcGx1Z2lucy5iZWF1dHlsb2cuZXJyb3IoXCJvYmplY3RBcmcgaXMgdW5kZWZpbmVkXCIpO1xuICAgICAgICB9XG4gICAgICAgIGlmICh0eXBlb2Ygb2JzSXRlbXNbcGFyYW1OYW1lQXJnXSA9PT0gXCJ1bmRlZmluZWRcIil7XG4gICAgICAgICAgICBvYnNJdGVtc1twYXJhbU5hbWVBcmddID0gb2JqZWN0QXJnO1xuICAgICAgICB9IGVsc2Uge1xuICAgICAgICAgICAgcGx1Z2lucy5iZWF1dHlsb2cuZXJyb3IoXCJvYmplY3QgaXMgYWxyZWFkeSBwcmVzZW50LCBzbyBhZGQgb3BlcmF0aW9uIGhhcyBmYWlsZWQuXCIpO1xuICAgICAgICB9XG4gICAgICAgIHJldHVybiBvYnNJdGVtc1twYXJhbU5hbWVBcmddO1xuICAgIH0sXG4gICAgcmVwbGFjZTogZnVuY3Rpb24ocGFyYW1OYW1lQXJnLG9iamVjdEFyZyl7XG4gICAgICAgIG9ic0l0ZW1zW3BhcmFtTmFtZUFyZ10gPSBvYmplY3RBcmc7XG4gICAgfSxcbiAgICBtZXJnZTogZnVuY3Rpb24ocGFyYW1OYW1lQXJnLG9iamVjdEFyZyl7XG4gICAgICAgIGlmKCEodHlwZW9mIG9ic0l0ZW1zW3BhcmFtTmFtZUFyZ10gPT09IFwidW5kZWZpbmVkXCIpKXtcbiAgICAgICAgICAgIG9ic0l0ZW1zW3BhcmFtTmFtZUFyZ10gPSBwbHVnaW5zLl8uYXNzaWduKG9ic0l0ZW1zW3BhcmFtTmFtZUFyZ10sb2JqZWN0QXJnKTtcbiAgICAgICAgfSBlbHNlIHtcbiAgICAgICAgICAgIHBsdWdpbnMuYmVhdXR5bG9nLmVycm9yKFwib2JqZWN0IGlzIG5vdCBwcmVzZW50LCBzbyB0aGVyZSBpcyBub3RoaW5nIHRvIG1lcmdlXCIpO1xuICAgICAgICB9XG4gICAgfSxcbiAgICBnZXQ6IGZ1bmN0aW9uKGtleU5hbWUpIHtcbiAgICAgICAgcmV0dXJuIG9ic0l0ZW1zW2tleU5hbWVdO1xuICAgIH0sXG4gICAgZ2V0QWxsOiBmdW5jdGlvbiAoKSB7XG4gICAgICAgIHJldHVybiBvYnNJdGVtcztcbiAgICB9LFxuICAgIGFkZENvbXBsZXRlOiBmdW5jdGlvbihpdGVtc0FyZykge1xuICAgICAgICBvYnNJdGVtcyA9IHBsdWdpbnMuXy5hc3NpZ24ob2JzSXRlbXMsaXRlbXNBcmcpO1xuICAgICAgICByZXR1cm4gb2JzSXRlbXM7XG4gICAgfVxufTtcbmV4cG9ydCB2YXIgb2JzSXRlbXM6YW55ID0ge307Il0sInNvdXJjZVJvb3QiOiIvc291cmNlLyJ9
|
|
||||||
9
dist/smartenv.plugins.js
vendored
9
dist/smartenv.plugins.js
vendored
@@ -1,9 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
var plugins = {
|
|
||||||
beautylog: require("beautylog"),
|
|
||||||
Q: require("q"),
|
|
||||||
_: require("lodash")
|
|
||||||
};
|
|
||||||
module.exports = plugins;
|
|
||||||
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInNtYXJ0ZW52LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsMENBQTBDO0FBQzFDLElBQUksT0FBTyxHQUFHO0lBQ1YsU0FBUyxFQUFFLE9BQU8sQ0FBQyxXQUFXLENBQUM7SUFDL0IsQ0FBQyxFQUFFLE9BQU8sQ0FBQyxHQUFHLENBQUM7SUFDZixDQUFDLEVBQUUsT0FBTyxDQUFDLFFBQVEsQ0FBQztDQUN2QixDQUFDO0FBRUYsaUJBQVMsT0FBTyxDQUFDIiwiZmlsZSI6InNtYXJ0ZW52LnBsdWdpbnMuanMiLCJzb3VyY2VzQ29udGVudCI6WyIvLy8gPHJlZmVyZW5jZSBwYXRoPVwidHlwaW5ncy9tYWluLmQudHNcIiAvPlxudmFyIHBsdWdpbnMgPSB7XG4gICAgYmVhdXR5bG9nOiByZXF1aXJlKFwiYmVhdXR5bG9nXCIpLFxuICAgIFE6IHJlcXVpcmUoXCJxXCIpLFxuICAgIF86IHJlcXVpcmUoXCJsb2Rhc2hcIilcbn07XG5cbmV4cG9ydCA9IHBsdWdpbnM7Il0sInNvdXJjZVJvb3QiOiIvc291cmNlLyJ9
|
|
||||||
32
npmextra.json
Normal file
32
npmextra.json
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
{
|
||||||
|
"npmci": {
|
||||||
|
"npmGlobalTools": [],
|
||||||
|
"npmAccessLevel": "public"
|
||||||
|
},
|
||||||
|
"gitzone": {
|
||||||
|
"projectType": "npm",
|
||||||
|
"module": {
|
||||||
|
"githost": "code.foss.global",
|
||||||
|
"gitscope": "push.rocks",
|
||||||
|
"gitrepo": "smartenv",
|
||||||
|
"description": "A module for storing and accessing environment details across different platforms.",
|
||||||
|
"npmPackagename": "@push.rocks/smartenv",
|
||||||
|
"license": "MIT",
|
||||||
|
"keywords": [
|
||||||
|
"environment detection",
|
||||||
|
"cross-platform",
|
||||||
|
"node.js",
|
||||||
|
"browser",
|
||||||
|
"module loading",
|
||||||
|
"CI detection",
|
||||||
|
"OS detection",
|
||||||
|
"runtime environment",
|
||||||
|
"typescript",
|
||||||
|
"async"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tsdoc": {
|
||||||
|
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"mode":"default",
|
|
||||||
"coveralls":true
|
|
||||||
}
|
|
||||||
67
package.json
67
package.json
@@ -1,34 +1,63 @@
|
|||||||
{
|
{
|
||||||
"name": "smartenv",
|
"name": "@push.rocks/smartenv",
|
||||||
"version": "1.0.8",
|
"version": "6.0.0",
|
||||||
"description": "store things about your environment and let them travel across modules",
|
"description": "A module for storing and accessing environment details across different platforms.",
|
||||||
"main": "dist/index.js",
|
"main": "dist_ts/index.js",
|
||||||
|
"typings": "dist_ts/index.d.ts",
|
||||||
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)",
|
"test": "(tstest test/ --web)",
|
||||||
"testbrowser": "(npm test) && (node testbrowser.js)"
|
"build": "(tsbuild --web --allowimplicitany && tsbundle npm)",
|
||||||
|
"testbrowser": "(npm test) && (node testbrowser.js)",
|
||||||
|
"buildDocs": "tsdoc"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/pushrocks/smartenv.git"
|
"url": "https://code.foss.global/push.rocks/smartenv.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"environment"
|
"environment detection",
|
||||||
|
"cross-platform",
|
||||||
|
"node.js",
|
||||||
|
"browser",
|
||||||
|
"module loading",
|
||||||
|
"CI detection",
|
||||||
|
"OS detection",
|
||||||
|
"runtime environment",
|
||||||
|
"typescript",
|
||||||
|
"async"
|
||||||
],
|
],
|
||||||
"author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
|
"author": "Lossless GmbH <hello@lossless.support> (https://lossless.com)",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/pushrocks/smartenv/issues"
|
"url": "https://gitlab.com/pushrocks/smartenv/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/pushrocks/smartenv",
|
"homepage": "https://code.foss.global/push.rocks/smartenv",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"beautylog": "3.0.3",
|
"@push.rocks/smartpromise": "^4.0.2"
|
||||||
"lodash": "^4.5.0",
|
|
||||||
"q": "^1.4.1"
|
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"easyserve": "0.0.5",
|
"@git.zone/tsbuild": "^2.6.8",
|
||||||
"gulp": "^3.9.1",
|
"@git.zone/tsbundle": "^2.0.15",
|
||||||
"gulp-browser": "1.0.10",
|
"@git.zone/tsrun": "^1.6.2",
|
||||||
"npmts": "3.1.2"
|
"@git.zone/tstest": "^2.7.0",
|
||||||
}
|
"@types/node": "^22.0.0"
|
||||||
|
},
|
||||||
|
"private": false,
|
||||||
|
"files": [
|
||||||
|
"ts/**/*",
|
||||||
|
"ts_web/**/*",
|
||||||
|
"dist/**/*",
|
||||||
|
"dist_*/**/*",
|
||||||
|
"dist_ts/**/*",
|
||||||
|
"dist_ts_web/**/*",
|
||||||
|
"assets/**/*",
|
||||||
|
"cli.js",
|
||||||
|
"npmextra.json",
|
||||||
|
"readme.md"
|
||||||
|
],
|
||||||
|
"browserslist": [
|
||||||
|
"last 1 chrome versions"
|
||||||
|
],
|
||||||
|
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
|
||||||
}
|
}
|
||||||
|
|||||||
9479
pnpm-lock.yaml
generated
Normal file
9479
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
79
readme.hints.md
Normal file
79
readme.hints.md
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
# SmartEnv Hints
|
||||||
|
|
||||||
|
## Architecture Overview
|
||||||
|
- Single main class `Smartenv` that provides all functionality
|
||||||
|
- Uses dependency injection pattern with plugins imported from smartenv.plugins.ts
|
||||||
|
- Utilizes @push.rocks/smartpromise for async operations
|
||||||
|
- **BREAKING CHANGE**: `runtimeEnv` now returns `'node' | 'deno' | 'bun' | 'browser'` (previously only 'node' | 'browser')
|
||||||
|
|
||||||
|
## Runtime Detection System
|
||||||
|
|
||||||
|
### Detection Order (Critical!)
|
||||||
|
The order matters to avoid false positives:
|
||||||
|
1. **Deno** - Check `globalThis.Deno?.version` first (Deno has a `process` object for compatibility)
|
||||||
|
2. **Bun** - Check `globalThis.Bun?.version` second (Bun also has a `process` object)
|
||||||
|
3. **Node.js** - Check `globalThis.process?.versions?.node` third (must be specific to avoid Deno/Bun)
|
||||||
|
4. **Browser** - Check `globalThis.window && globalThis.document` as fallback
|
||||||
|
|
||||||
|
### Runtime Properties
|
||||||
|
- `runtimeEnv: TRuntimeType` - Returns 'node' | 'deno' | 'bun' | 'browser'
|
||||||
|
- `isNode: boolean` - True only for Node.js (excludes Deno and Bun)
|
||||||
|
- `isDeno: boolean` - True only for Deno runtime
|
||||||
|
- `isBun: boolean` - True only for Bun runtime
|
||||||
|
- `isBrowser: boolean` - True only for browser environment
|
||||||
|
|
||||||
|
### Version Getters
|
||||||
|
- `nodeVersion: string` - Node.js version (returns 'undefined' in other runtimes)
|
||||||
|
- `denoVersion: string` - Deno version (returns 'undefined' in other runtimes)
|
||||||
|
- `bunVersion: string` - Bun version (returns 'undefined' in other runtimes)
|
||||||
|
|
||||||
|
## Module Loading API
|
||||||
|
|
||||||
|
### New: getSafeModuleFor()
|
||||||
|
Flexible module loading that supports runtime targeting:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Load for specific runtime
|
||||||
|
await env.getSafeModuleFor('node', 'path')
|
||||||
|
|
||||||
|
// Load for multiple runtimes
|
||||||
|
await env.getSafeModuleFor(['node', 'deno'], 'path')
|
||||||
|
|
||||||
|
// Load for all server-side runtimes (shorthand for ['node', 'deno', 'bun'])
|
||||||
|
await env.getSafeModuleFor('server', 'path')
|
||||||
|
|
||||||
|
// Browser loading requires getFunction
|
||||||
|
await env.getSafeModuleFor('browser', 'url', () => window.someLibrary)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
- `target: TRuntimeTarget | TRuntimeTarget[]` - Runtime(s) to load for
|
||||||
|
- `moduleNameOrUrl: string` - Module name or URL
|
||||||
|
- `getFunction?: () => any` - Required for browser module loading
|
||||||
|
|
||||||
|
**Returns:** Module or `undefined` if runtime doesn't match
|
||||||
|
|
||||||
|
### Legacy Methods (Still Supported)
|
||||||
|
- `getSafeNodeModule()` - Now works for Node.js, Deno, and Bun
|
||||||
|
- `getSafeWebModule()` - Browser-only module loading
|
||||||
|
|
||||||
|
## Key Implementation Details
|
||||||
|
- Dynamic module loading using Function constructor for server-side modules
|
||||||
|
- Script tag injection for browser module loading with duplicate prevention
|
||||||
|
- OS detection uses the native 'os' module loaded dynamically (works in Node.js, Deno, Bun)
|
||||||
|
- All detection uses `globalThis` for robustness across environments
|
||||||
|
|
||||||
|
## Testing Approach
|
||||||
|
- Tests use @git.zone/tstest with tap-based testing across all runtimes
|
||||||
|
- `test.node.ts` - Node.js specific tests, verifies it's not confused with Deno/Bun
|
||||||
|
- `test.deno.ts` - Deno runtime tests
|
||||||
|
- `test.bun.ts` - Bun runtime tests
|
||||||
|
- `test.chrome.ts` - Browser environment tests
|
||||||
|
- Each test file verifies proper runtime detection and module loading
|
||||||
|
|
||||||
|
## Important Notes
|
||||||
|
- The `getSafeNodeModule` uses dynamic import via Function constructor to avoid bundler issues
|
||||||
|
- Browser module loading tracks loaded scripts to prevent duplicate loads
|
||||||
|
- All OS detection methods are async and return false in browser environments
|
||||||
|
- The package is isomorphic and designed for use in all four runtime contexts
|
||||||
|
- Runtime detection checks globals in specific order to avoid false positives from compatibility layers
|
||||||
615
readme.md
Normal file
615
readme.md
Normal file
@@ -0,0 +1,615 @@
|
|||||||
|
# @push.rocks/smartenv
|
||||||
|
|
||||||
|
> 🚀 **Universal JavaScript Runtime Detection** - One library for Node.js, Deno, Bun, and Browser
|
||||||
|
|
||||||
|
A powerful TypeScript library that provides comprehensive runtime environment detection and safe module loading across **all major JavaScript runtimes**. Write once, run everywhere with confidence.
|
||||||
|
|
||||||
|
## Why smartenv?
|
||||||
|
|
||||||
|
Modern JavaScript runs in many environments - Node.js, Deno, Bun, and browsers. Writing isomorphic code that works everywhere is challenging. **smartenv** solves this by providing:
|
||||||
|
|
||||||
|
- ✅ **Accurate runtime detection** - Distinguishes Node.js from Deno, Bun, and browsers without false positives
|
||||||
|
- ✅ **Smart module loading** - Load the right modules for each runtime automatically
|
||||||
|
- ✅ **Platform detection** - Detect macOS, Linux, Windows, and CI environments
|
||||||
|
- ✅ **Zero dependencies** (except @push.rocks/smartpromise)
|
||||||
|
- ✅ **Full TypeScript support** with complete type definitions
|
||||||
|
- ✅ **Battle-tested** - Comprehensive test suite across all runtimes
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm install @push.rocks/smartenv --save
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @push.rocks/smartenv --save
|
||||||
|
```
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Smartenv } from '@push.rocks/smartenv';
|
||||||
|
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
// Detect the runtime
|
||||||
|
console.log(env.runtimeEnv); // 'node' | 'deno' | 'bun' | 'browser'
|
||||||
|
|
||||||
|
// Load modules safely for your runtime
|
||||||
|
const pathModule = await env.getSafeModuleFor('server', 'path');
|
||||||
|
if (pathModule) {
|
||||||
|
console.log('Path module loaded!');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check specific runtimes
|
||||||
|
if (env.isNode) {
|
||||||
|
console.log(`Running on Node.js ${env.nodeVersion}`);
|
||||||
|
} else if (env.isDeno) {
|
||||||
|
console.log(`Running on Deno ${env.denoVersion}`);
|
||||||
|
} else if (env.isBun) {
|
||||||
|
console.log(`Running on Bun ${env.bunVersion}`);
|
||||||
|
} else {
|
||||||
|
console.log(`Running in ${env.userAgent}`);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Core Features
|
||||||
|
|
||||||
|
### 🎯 Multi-Runtime Detection
|
||||||
|
|
||||||
|
Accurately detects all major JavaScript runtimes using proper detection order to avoid false positives:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
// Runtime type - returns one of: 'node' | 'deno' | 'bun' | 'browser'
|
||||||
|
console.log(env.runtimeEnv);
|
||||||
|
|
||||||
|
// Boolean checks for each runtime
|
||||||
|
env.isNode; // true only in Node.js
|
||||||
|
env.isDeno; // true only in Deno
|
||||||
|
env.isBun; // true only in Bun
|
||||||
|
env.isBrowser; // true only in browser
|
||||||
|
```
|
||||||
|
|
||||||
|
**Why detection order matters:** Deno and Bun provide `process` objects for Node.js compatibility. smartenv checks for `Deno` and `Bun` globals first, then `process.versions.node`, ensuring accurate detection.
|
||||||
|
|
||||||
|
### 📦 Smart Module Loading
|
||||||
|
|
||||||
|
The new `getSafeModuleFor()` API lets you target specific runtimes or groups:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Load for a specific runtime
|
||||||
|
const fsNode = await env.getSafeModuleFor('node', 'fs');
|
||||||
|
|
||||||
|
// Load for Deno (requires 'node:' prefix for Node.js built-ins)
|
||||||
|
const fsDeno = await env.getSafeModuleFor('deno', 'node:path');
|
||||||
|
|
||||||
|
// Load for all server-side runtimes (Node.js + Deno + Bun)
|
||||||
|
const pathModule = await env.getSafeModuleFor('server', 'path');
|
||||||
|
|
||||||
|
// Load for multiple specific runtimes
|
||||||
|
const crypto = await env.getSafeModuleFor(['node', 'bun'], 'crypto');
|
||||||
|
|
||||||
|
// Browser module loading
|
||||||
|
const jQuery = await env.getSafeModuleFor(
|
||||||
|
'browser',
|
||||||
|
'https://code.jquery.com/jquery-3.6.0.min.js',
|
||||||
|
() => window.jQuery
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
**Target options:**
|
||||||
|
- `'node'` - Node.js only
|
||||||
|
- `'deno'` - Deno only
|
||||||
|
- `'bun'` - Bun only
|
||||||
|
- `'browser'` - Browser only
|
||||||
|
- `'server'` - Shorthand for `['node', 'deno', 'bun']`
|
||||||
|
- `['node', 'deno']` - Array of specific runtimes
|
||||||
|
|
||||||
|
If the current runtime doesn't match the target, the method returns `undefined` and logs a warning.
|
||||||
|
|
||||||
|
### 🖥️ Platform Detection
|
||||||
|
|
||||||
|
Detect operating systems in server-side runtimes (Node.js, Deno, Bun):
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
// Async OS detection
|
||||||
|
const isMac = await env.isMacAsync(); // macOS
|
||||||
|
const isLinux = await env.isLinuxAsync(); // Linux
|
||||||
|
const isWindows = await env.isWindowsAsync(); // Windows
|
||||||
|
|
||||||
|
if (isMac) {
|
||||||
|
console.log('Running on macOS');
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🔢 Version Information
|
||||||
|
|
||||||
|
Get version strings for each runtime:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
// Returns version string or 'undefined' if not in that runtime
|
||||||
|
env.nodeVersion; // e.g., 'v20.10.0'
|
||||||
|
env.denoVersion; // e.g., '1.40.0'
|
||||||
|
env.bunVersion; // e.g., '1.0.20'
|
||||||
|
env.userAgent; // Browser user agent string
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🏗️ CI Detection
|
||||||
|
|
||||||
|
Detect if running in a continuous integration environment:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
if (env.isCI) {
|
||||||
|
console.log('Running in CI environment');
|
||||||
|
// Enable extended test suite, different build config, etc.
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Reference
|
||||||
|
|
||||||
|
### Runtime Detection Properties
|
||||||
|
|
||||||
|
#### `runtimeEnv: TRuntimeType`
|
||||||
|
|
||||||
|
Returns the detected runtime as a string.
|
||||||
|
|
||||||
|
**Type:** `'node' | 'deno' | 'bun' | 'browser'`
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
console.log(env.runtimeEnv); // 'node', 'deno', 'bun', or 'browser'
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `isNode: boolean`
|
||||||
|
|
||||||
|
`true` if running in Node.js (specifically checks for `process.versions.node`).
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
if (env.isNode) {
|
||||||
|
console.log('Node.js environment');
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `isDeno: boolean`
|
||||||
|
|
||||||
|
`true` if running in Deno (checks for `Deno` global).
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
if (env.isDeno) {
|
||||||
|
console.log('Deno environment');
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `isBun: boolean`
|
||||||
|
|
||||||
|
`true` if running in Bun (checks for `Bun` global).
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
if (env.isBun) {
|
||||||
|
console.log('Bun environment');
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `isBrowser: boolean`
|
||||||
|
|
||||||
|
`true` if running in a browser environment.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
if (env.isBrowser) {
|
||||||
|
console.log('Browser environment');
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `isCI: boolean`
|
||||||
|
|
||||||
|
`true` if running in a CI environment (checks `process.env.CI` in server runtimes).
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
if (env.isCI) {
|
||||||
|
// CI-specific logic
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Version Properties
|
||||||
|
|
||||||
|
#### `nodeVersion: string`
|
||||||
|
|
||||||
|
Node.js version string. Returns `'undefined'` if not in Node.js.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
console.log(env.nodeVersion); // 'v20.10.0'
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `denoVersion: string`
|
||||||
|
|
||||||
|
Deno version string. Returns `'undefined'` if not in Deno.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
console.log(env.denoVersion); // '1.40.0'
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `bunVersion: string`
|
||||||
|
|
||||||
|
Bun version string. Returns `'undefined'` if not in Bun.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
console.log(env.bunVersion); // '1.0.20'
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `userAgent: string`
|
||||||
|
|
||||||
|
Browser user agent string. Returns `'undefined'` if not in browser.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
console.log(env.userAgent); // 'Mozilla/5.0...'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Platform Detection Methods
|
||||||
|
|
||||||
|
#### `isMacAsync(): Promise<boolean>`
|
||||||
|
|
||||||
|
Asynchronously checks if running on macOS. Works in Node.js, Deno, and Bun.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const isMac = await env.isMacAsync();
|
||||||
|
if (isMac) {
|
||||||
|
console.log('Running on macOS');
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `isLinuxAsync(): Promise<boolean>`
|
||||||
|
|
||||||
|
Asynchronously checks if running on Linux. Works in Node.js, Deno, and Bun.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const isLinux = await env.isLinuxAsync();
|
||||||
|
if (isLinux) {
|
||||||
|
console.log('Running on Linux');
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `isWindowsAsync(): Promise<boolean>`
|
||||||
|
|
||||||
|
Asynchronously checks if running on Windows. Works in Node.js, Deno, and Bun.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const isWindows = await env.isWindowsAsync();
|
||||||
|
if (isWindows) {
|
||||||
|
console.log('Running on Windows');
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Module Loading Methods
|
||||||
|
|
||||||
|
#### `getSafeModuleFor<T>(target, moduleNameOrUrl, getFunction?): Promise<T | undefined>`
|
||||||
|
|
||||||
|
**The recommended way to load modules** - supports runtime targeting with flexible options.
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
- `target: TRuntimeTarget | TRuntimeTarget[]` - Runtime(s) to load for
|
||||||
|
- `moduleNameOrUrl: string` - Module name (server runtimes) or URL (browser)
|
||||||
|
- `getFunction?: () => any` - Function to retrieve module (required for browser)
|
||||||
|
|
||||||
|
**Returns:** `Promise<T | undefined>` - Loaded module or undefined if runtime doesn't match
|
||||||
|
|
||||||
|
**Examples:**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Node.js only
|
||||||
|
const fs = await env.getSafeModuleFor('node', 'fs');
|
||||||
|
|
||||||
|
// Deno only (note: use 'node:' prefix for Node.js built-ins)
|
||||||
|
const path = await env.getSafeModuleFor('deno', 'node:path');
|
||||||
|
|
||||||
|
// All server runtimes
|
||||||
|
const crypto = await env.getSafeModuleFor('server', 'crypto');
|
||||||
|
|
||||||
|
// Multiple specific runtimes
|
||||||
|
const util = await env.getSafeModuleFor(['node', 'bun'], 'util');
|
||||||
|
|
||||||
|
// Browser
|
||||||
|
const lib = await env.getSafeModuleFor(
|
||||||
|
'browser',
|
||||||
|
'https://cdn.example.com/lib.js',
|
||||||
|
() => window.MyLib
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `getSafeNodeModule<T>(moduleName, runAfterFunc?): Promise<T>`
|
||||||
|
|
||||||
|
**Legacy method** - Loads modules in server-side runtimes (Node.js, Deno, Bun).
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const fs = await env.getSafeNodeModule('fs');
|
||||||
|
|
||||||
|
// With post-load callback
|
||||||
|
const express = await env.getSafeNodeModule('express', async (mod) => {
|
||||||
|
console.log('Express loaded');
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `getSafeWebModule(url, getFunction): Promise<any>`
|
||||||
|
|
||||||
|
**Legacy method** - Loads web modules via script tag in browser. Prevents duplicate loading.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const jQuery = await env.getSafeWebModule(
|
||||||
|
'https://code.jquery.com/jquery-3.6.0.min.js',
|
||||||
|
() => window.jQuery
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `getEnvAwareModule(options): Promise<any>`
|
||||||
|
|
||||||
|
**Legacy method** - Loads environment-appropriate modules.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const module = await env.getEnvAwareModule({
|
||||||
|
nodeModuleName: 'node-fetch',
|
||||||
|
webUrlArg: 'https://unpkg.com/whatwg-fetch@3.6.2/dist/fetch.umd.js',
|
||||||
|
getFunction: () => window.fetch
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Utility Methods
|
||||||
|
|
||||||
|
#### `printEnv(): Promise<void>`
|
||||||
|
|
||||||
|
Prints environment information to console for debugging.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
await env.printEnv();
|
||||||
|
// Node.js: "running on NODE" + version
|
||||||
|
// Deno: "running on DENO" + version
|
||||||
|
// Bun: "running on BUN" + version
|
||||||
|
// Browser: "running on BROWSER" + user agent
|
||||||
|
```
|
||||||
|
|
||||||
|
## Real-World Examples
|
||||||
|
|
||||||
|
### 🌍 Isomorphic Cryptography
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { Smartenv } from '@push.rocks/smartenv';
|
||||||
|
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
// Load crypto for any server runtime
|
||||||
|
const crypto = await env.getSafeModuleFor('server', 'crypto');
|
||||||
|
|
||||||
|
if (crypto) {
|
||||||
|
const hash = crypto.createHash('sha256');
|
||||||
|
hash.update('hello world');
|
||||||
|
console.log(hash.digest('hex'));
|
||||||
|
} else if (env.isBrowser) {
|
||||||
|
// Use Web Crypto API
|
||||||
|
const encoder = new TextEncoder();
|
||||||
|
const data = encoder.encode('hello world');
|
||||||
|
const hashBuffer = await crypto.subtle.digest('SHA-256', data);
|
||||||
|
console.log(Array.from(new Uint8Array(hashBuffer))
|
||||||
|
.map(b => b.toString(16).padStart(2, '0'))
|
||||||
|
.join(''));
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 📁 Cross-Runtime File System
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
async function readConfig() {
|
||||||
|
if (env.isNode) {
|
||||||
|
const fs = await env.getSafeModuleFor('node', 'fs/promises');
|
||||||
|
return JSON.parse(await fs.readFile('config.json', 'utf-8'));
|
||||||
|
} else if (env.isDeno) {
|
||||||
|
const content = await Deno.readTextFile('config.json');
|
||||||
|
return JSON.parse(content);
|
||||||
|
} else if (env.isBun) {
|
||||||
|
const file = Bun.file('config.json');
|
||||||
|
return await file.json();
|
||||||
|
} else {
|
||||||
|
// Browser: fetch from server
|
||||||
|
const response = await fetch('/config.json');
|
||||||
|
return response.json();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🔧 Development vs Production
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
async function setupEnvironment() {
|
||||||
|
// Different behavior in CI
|
||||||
|
if (env.isCI) {
|
||||||
|
console.log('CI Environment detected');
|
||||||
|
// Skip interactive prompts, use default values
|
||||||
|
return { mode: 'ci', verbose: true };
|
||||||
|
}
|
||||||
|
|
||||||
|
// Platform-specific paths
|
||||||
|
if (await env.isMacAsync()) {
|
||||||
|
return { configPath: '/Users/username/.config' };
|
||||||
|
} else if (await env.isLinuxAsync()) {
|
||||||
|
return { configPath: '/home/username/.config' };
|
||||||
|
} else if (await env.isWindowsAsync()) {
|
||||||
|
return { configPath: 'C:\\Users\\username\\AppData\\Local' };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🎨 Conditional Analytics Loading
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
async function initializeAnalytics() {
|
||||||
|
if (!env.isBrowser) {
|
||||||
|
console.log('Analytics skipped - not in browser');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only load analytics in browser
|
||||||
|
const analytics = await env.getSafeModuleFor(
|
||||||
|
'browser',
|
||||||
|
'https://www.googletagmanager.com/gtag/js?id=GA_MEASUREMENT_ID',
|
||||||
|
() => window.gtag
|
||||||
|
);
|
||||||
|
|
||||||
|
if (analytics) {
|
||||||
|
analytics('config', 'GA_MEASUREMENT_ID');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 🧪 Runtime-Specific Testing
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const env = new Smartenv();
|
||||||
|
|
||||||
|
async function runTests() {
|
||||||
|
console.log(`Testing in ${env.runtimeEnv}`);
|
||||||
|
|
||||||
|
// Load test utilities for current runtime
|
||||||
|
const testLib = await env.getSafeModuleFor(
|
||||||
|
['node', 'deno', 'bun'],
|
||||||
|
'@git.zone/tstest'
|
||||||
|
);
|
||||||
|
|
||||||
|
if (testLib) {
|
||||||
|
// Run server-side tests
|
||||||
|
await runServerTests(testLib);
|
||||||
|
} else {
|
||||||
|
// Run browser tests
|
||||||
|
await runBrowserTests();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## TypeScript Support
|
||||||
|
|
||||||
|
smartenv is written in TypeScript and provides complete type definitions:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import {
|
||||||
|
Smartenv,
|
||||||
|
TRuntimeType, // 'node' | 'deno' | 'bun' | 'browser'
|
||||||
|
TRuntimeTarget, // TRuntimeType | 'server'
|
||||||
|
IEnvObject
|
||||||
|
} from '@push.rocks/smartenv';
|
||||||
|
|
||||||
|
const env: Smartenv = new Smartenv();
|
||||||
|
const runtime: TRuntimeType = env.runtimeEnv;
|
||||||
|
|
||||||
|
// Type-safe module loading
|
||||||
|
const fs = await env.getSafeModuleFor<typeof import('fs')>('node', 'fs');
|
||||||
|
if (fs) {
|
||||||
|
fs.readFileSync('./file.txt', 'utf-8'); // Full type support
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## How Runtime Detection Works
|
||||||
|
|
||||||
|
smartenv uses a careful detection order to avoid false positives:
|
||||||
|
|
||||||
|
1. **Check for Deno** - `globalThis.Deno?.version` (Deno has `process` for compatibility)
|
||||||
|
2. **Check for Bun** - `globalThis.Bun?.version` (Bun also has `process`)
|
||||||
|
3. **Check for Node.js** - `globalThis.process?.versions?.node` (must be specific)
|
||||||
|
4. **Check for Browser** - `globalThis.window && globalThis.document` (fallback)
|
||||||
|
|
||||||
|
This order is critical because Deno and Bun provide `process` objects for Node.js compatibility, which would cause false Node.js detection if checked first.
|
||||||
|
|
||||||
|
## Migration from 4.x to 5.x
|
||||||
|
|
||||||
|
**Breaking Changes:**
|
||||||
|
|
||||||
|
1. **`runtimeEnv` return type changed:**
|
||||||
|
- **Before:** `'node' | 'browser'`
|
||||||
|
- **After:** `'node' | 'deno' | 'bun' | 'browser'`
|
||||||
|
|
||||||
|
2. **`isNode` is now more specific:**
|
||||||
|
- **Before:** Returns `true` for Node.js, Deno, and Bun
|
||||||
|
- **After:** Returns `true` only for Node.js
|
||||||
|
|
||||||
|
**Migration guide:**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Before (4.x)
|
||||||
|
if (env.isNode) {
|
||||||
|
// This ran in Node.js, Deno, and Bun
|
||||||
|
}
|
||||||
|
|
||||||
|
// After (5.x) - Option 1: Check all server runtimes
|
||||||
|
if (env.isNode || env.isDeno || env.isBun) {
|
||||||
|
// Works in Node.js, Deno, and Bun
|
||||||
|
}
|
||||||
|
|
||||||
|
// After (5.x) - Option 2: Use the new module loading API
|
||||||
|
const module = await env.getSafeModuleFor('server', 'path');
|
||||||
|
if (module) {
|
||||||
|
// Module loaded successfully in any server runtime
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Performance
|
||||||
|
|
||||||
|
- ⚡ **Lightweight** - Minimal overhead with lazy evaluation
|
||||||
|
- 🚀 **Fast detection** - Simple boolean checks, no heavy operations
|
||||||
|
- 💾 **Cached results** - Detection runs once, results are cached
|
||||||
|
- 📦 **Small bundle** - ~5KB minified, tree-shakeable
|
||||||
|
|
||||||
|
## Browser Compatibility
|
||||||
|
|
||||||
|
Tested and working in:
|
||||||
|
- ✅ Chrome/Chromium (latest)
|
||||||
|
- ✅ Firefox (latest)
|
||||||
|
- ✅ Safari (latest)
|
||||||
|
- ✅ Edge (latest)
|
||||||
|
|
||||||
|
## Node.js Compatibility
|
||||||
|
|
||||||
|
- ✅ Node.js 18.x
|
||||||
|
- ✅ Node.js 20.x (LTS)
|
||||||
|
- ✅ Node.js 22.x
|
||||||
|
|
||||||
|
## Deno Compatibility
|
||||||
|
|
||||||
|
- ✅ Deno 1.40+
|
||||||
|
|
||||||
|
**Note:** When using Deno, use the `node:` prefix for Node.js built-in modules:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
const path = await env.getSafeModuleFor('deno', 'node:path');
|
||||||
|
```
|
||||||
|
|
||||||
|
## Bun Compatibility
|
||||||
|
|
||||||
|
- ✅ Bun 1.0+
|
||||||
|
|
||||||
|
## License and Legal Information
|
||||||
|
|
||||||
|
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||||
|
|
||||||
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
### Trademarks
|
||||||
|
|
||||||
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||||
|
|
||||||
|
### Company Information
|
||||||
|
|
||||||
|
Task Venture Capital GmbH
|
||||||
|
Registered at District court Bremen HRB 35230 HB, Germany
|
||||||
|
|
||||||
|
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||||
|
|
||||||
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
<head>
|
|
||||||
<script async src="browserified/index.js"></script>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
</body>
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
var smartenv = require("./index.js");
|
|
||||||
smartenv.printEnv();
|
|
||||||
81
test/test.bun.ts
Normal file
81
test/test.bun.ts
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as smartenv from '../ts/index.js';
|
||||||
|
|
||||||
|
let testEnv: smartenv.Smartenv;
|
||||||
|
|
||||||
|
tap.test('should create smartenv instance', async () => {
|
||||||
|
testEnv = new smartenv.Smartenv();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should detect Bun runtime correctly', async () => {
|
||||||
|
expect(testEnv.runtimeEnv).toEqual('bun');
|
||||||
|
expect(testEnv.isBun).toBeTrue();
|
||||||
|
expect(testEnv.isNode).toBeFalse();
|
||||||
|
expect(testEnv.isDeno).toBeFalse();
|
||||||
|
expect(testEnv.isBrowser).toBeFalse();
|
||||||
|
console.log(' Bun runtime detected correctly');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should get Bun version', async () => {
|
||||||
|
const version = testEnv.bunVersion;
|
||||||
|
expect(version).not.toEqual('undefined');
|
||||||
|
expect(typeof version).toEqual('string');
|
||||||
|
console.log('Bun version is ' + version);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should print environment', async () => {
|
||||||
|
testEnv.printEnv();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should load modules for Bun', async () => {
|
||||||
|
const pathModule = await testEnv.getSafeModuleFor('bun', 'path');
|
||||||
|
expect(pathModule).not.toBeUndefined();
|
||||||
|
expect(typeof pathModule.join).toEqual('function');
|
||||||
|
console.log(' Successfully loaded module for Bun');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should load modules for server runtimes', async () => {
|
||||||
|
const pathModule = await testEnv.getSafeModuleFor('server', 'path');
|
||||||
|
expect(pathModule).not.toBeUndefined();
|
||||||
|
expect(typeof pathModule.join).toEqual('function');
|
||||||
|
console.log(' Successfully loaded module with server target');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should load modules for array of runtimes', async () => {
|
||||||
|
const pathModule = await testEnv.getSafeModuleFor(['bun', 'node'], 'path');
|
||||||
|
expect(pathModule).not.toBeUndefined();
|
||||||
|
expect(typeof pathModule.join).toEqual('function');
|
||||||
|
console.log(' Successfully loaded module with array target');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should not load modules for wrong runtime', async () => {
|
||||||
|
const result = await testEnv.getSafeModuleFor('node', 'path');
|
||||||
|
expect(result).toBeUndefined();
|
||||||
|
console.log(' Correctly rejected Node.js-only module in Bun');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should detect OS', async () => {
|
||||||
|
const resultMac = await testEnv.isMacAsync();
|
||||||
|
const resultLinux = await testEnv.isLinuxAsync();
|
||||||
|
const resultWindows = await testEnv.isWindowsAsync();
|
||||||
|
const osModule = await import('os');
|
||||||
|
if (resultMac) {
|
||||||
|
expect(osModule.platform()).toEqual('darwin');
|
||||||
|
console.log('platform is Mac!');
|
||||||
|
} else if (resultLinux) {
|
||||||
|
expect(osModule.platform()).toEqual('linux');
|
||||||
|
console.log('platform is Linux!');
|
||||||
|
} else {
|
||||||
|
expect(osModule.platform()).toEqual('win32');
|
||||||
|
console.log('platform is Windows!');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should detect CI environment if present', async () => {
|
||||||
|
if (process.env.CI) {
|
||||||
|
expect(testEnv.isCI).toBeTrue();
|
||||||
|
}
|
||||||
|
console.log('CI detection: ' + testEnv.isCI);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
58
test/test.chrome.ts
Normal file
58
test/test.chrome.ts
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as smartenv from '../ts/index.js';
|
||||||
|
|
||||||
|
let testEnv: smartenv.Smartenv;
|
||||||
|
|
||||||
|
tap.test('should create smartenv instance', async () => {
|
||||||
|
testEnv = new smartenv.Smartenv();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should detect browser runtime correctly', async () => {
|
||||||
|
expect(testEnv.runtimeEnv).toEqual('browser');
|
||||||
|
expect(testEnv.isBrowser).toBeTrue();
|
||||||
|
expect(testEnv.isNode).toBeFalse();
|
||||||
|
expect(testEnv.isDeno).toBeFalse();
|
||||||
|
expect(testEnv.isBun).toBeFalse();
|
||||||
|
console.log(' Browser runtime detected correctly');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should get user agent', async () => {
|
||||||
|
const userAgent = testEnv.userAgent;
|
||||||
|
expect(userAgent).not.toEqual('undefined');
|
||||||
|
expect(typeof userAgent).toEqual('string');
|
||||||
|
console.log('User agent: ' + userAgent);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should print environment', async () => {
|
||||||
|
testEnv.printEnv();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should not get server runtime versions', async () => {
|
||||||
|
expect(testEnv.nodeVersion).toEqual('undefined');
|
||||||
|
expect(testEnv.denoVersion).toEqual('undefined');
|
||||||
|
expect(testEnv.bunVersion).toEqual('undefined');
|
||||||
|
console.log(' Server runtime versions correctly return undefined in browser');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should not load server modules', async () => {
|
||||||
|
const result = await testEnv.getSafeModuleFor('server', 'path');
|
||||||
|
expect(result).toBeUndefined();
|
||||||
|
console.log(' Correctly rejected server module in browser');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should not detect as CI', async () => {
|
||||||
|
expect(testEnv.isCI).toBeFalse();
|
||||||
|
console.log(' CI detection correctly false in browser');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('OS detection should return false in browser', async () => {
|
||||||
|
const resultMac = await testEnv.isMacAsync();
|
||||||
|
const resultLinux = await testEnv.isLinuxAsync();
|
||||||
|
const resultWindows = await testEnv.isWindowsAsync();
|
||||||
|
expect(resultMac).toBeFalse();
|
||||||
|
expect(resultLinux).toBeFalse();
|
||||||
|
expect(resultWindows).toBeFalse();
|
||||||
|
console.log(' OS detection correctly returns false in browser');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
4
test/test.d.ts
vendored
4
test/test.d.ts
vendored
@@ -1,4 +0,0 @@
|
|||||||
/// <reference path="../ts/typings/main.d.ts" />
|
|
||||||
declare var smartenv: any;
|
|
||||||
declare var beautylog: any;
|
|
||||||
declare var key2: string;
|
|
||||||
59
test/test.deno.ts
Normal file
59
test/test.deno.ts
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as smartenv from '../ts/index.js';
|
||||||
|
|
||||||
|
let testEnv: smartenv.Smartenv;
|
||||||
|
|
||||||
|
tap.test('should create smartenv instance', async () => {
|
||||||
|
testEnv = new smartenv.Smartenv();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should detect Deno runtime correctly', async () => {
|
||||||
|
expect(testEnv.runtimeEnv).toEqual('deno');
|
||||||
|
expect(testEnv.isDeno).toBeTrue();
|
||||||
|
expect(testEnv.isNode).toBeFalse();
|
||||||
|
expect(testEnv.isBun).toBeFalse();
|
||||||
|
expect(testEnv.isBrowser).toBeFalse();
|
||||||
|
console.log(' Deno runtime detected correctly');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should get Deno version', async () => {
|
||||||
|
const version = testEnv.denoVersion;
|
||||||
|
expect(version).not.toEqual('undefined');
|
||||||
|
expect(typeof version).toEqual('string');
|
||||||
|
console.log('Deno version is ' + version);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should print environment', async () => {
|
||||||
|
testEnv.printEnv();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should load modules for Deno', async () => {
|
||||||
|
// Deno requires 'node:' prefix for Node.js built-in modules
|
||||||
|
const pathModule = await testEnv.getSafeModuleFor('deno', 'node:path');
|
||||||
|
expect(pathModule).not.toBeUndefined();
|
||||||
|
expect(typeof pathModule.join).toEqual('function');
|
||||||
|
console.log(' Successfully loaded module for Deno');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should load modules for server runtimes', async () => {
|
||||||
|
// Deno requires 'node:' prefix for Node.js built-in modules
|
||||||
|
const pathModule = await testEnv.getSafeModuleFor('server', 'node:path');
|
||||||
|
expect(pathModule).not.toBeUndefined();
|
||||||
|
expect(typeof pathModule.join).toEqual('function');
|
||||||
|
console.log(' Successfully loaded module with server target');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should not load modules for wrong runtime', async () => {
|
||||||
|
const result = await testEnv.getSafeModuleFor('node', 'node:path');
|
||||||
|
expect(result).toBeUndefined();
|
||||||
|
console.log(' Correctly rejected Node.js-only module in Deno');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should detect CI environment if present', async () => {
|
||||||
|
// CI detection relies on Node.js process.env, which may not work in Deno
|
||||||
|
// This test documents expected behavior
|
||||||
|
const isCI = testEnv.isCI;
|
||||||
|
console.log('CI detection in Deno: ' + isCI);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
23
test/test.js
23
test/test.js
@@ -1,23 +0,0 @@
|
|||||||
/// <reference path="../ts/typings/main.d.ts" />
|
|
||||||
var smartenv = require("../dist/index.js");
|
|
||||||
var beautylog = require("beautylog");
|
|
||||||
beautylog.info("Now testing the smartenv module");
|
|
||||||
smartenv.printEnv();
|
|
||||||
beautylog.info("Now testing the smartenv module");
|
|
||||||
//test smartenv.obs.add
|
|
||||||
smartenv.obs.add("myTestObject", { key1: "Peter" });
|
|
||||||
smartenv.obs.add("myTestObject", { key1: "Klaus" }); //now trying to add a second
|
|
||||||
smartenv.printEnv();
|
|
||||||
beautylog.log(smartenv.obs.get("myTestObject").key1); // this should be Peter
|
|
||||||
//test smartenv.obs.replace
|
|
||||||
smartenv.obs.replace("myTestObject", { key1: "Klaus" });
|
|
||||||
beautylog.log(smartenv.obs.get("myTestObject").key1); // this should be Klaus
|
|
||||||
//test smartenv.obs.merge
|
|
||||||
smartenv.obs.merge("myTestObject", { key2: "Peter" });
|
|
||||||
beautylog.log(smartenv.obs.get("myTestObject").key1 + smartenv.obs.get("myTestObject").key2); // this should be KlausPeter
|
|
||||||
var key2 = "hello";
|
|
||||||
smartenv.obs.get("myTestObject").key2 = key2;
|
|
||||||
beautylog.log(smartenv.obs.get("myTestObject").key2);
|
|
||||||
beautylog.success("Success!");
|
|
||||||
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsZ0RBQWdEO0FBQ2hELElBQUksUUFBUSxHQUFHLE9BQU8sQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDO0FBQzNDLElBQUksU0FBUyxHQUFHLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQztBQUNyQyxTQUFTLENBQUMsSUFBSSxDQUFDLGlDQUFpQyxDQUFDLENBQUM7QUFDbEQsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO0FBQ3BCLFNBQVMsQ0FBQyxJQUFJLENBQUMsaUNBQWlDLENBQUMsQ0FBQztBQUVsRCx1QkFBdUI7QUFDdkIsUUFBUSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsY0FBYyxFQUFDLEVBQUMsSUFBSSxFQUFDLE9BQU8sRUFBQyxDQUFDLENBQUM7QUFDaEQsUUFBUSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsY0FBYyxFQUFDLEVBQUMsSUFBSSxFQUFDLE9BQU8sRUFBQyxDQUFDLENBQUMsQ0FBQyw0QkFBNEI7QUFDN0UsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDO0FBQ3BCLFNBQVMsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyx1QkFBdUI7QUFFN0UsMkJBQTJCO0FBQzNCLFFBQVEsQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLGNBQWMsRUFBQyxFQUFDLElBQUksRUFBQyxPQUFPLEVBQUMsQ0FBQyxDQUFDO0FBQ3BELFNBQVMsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyx1QkFBdUI7QUFFN0UseUJBQXlCO0FBQ3pCLFFBQVEsQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLGNBQWMsRUFBQyxFQUFDLElBQUksRUFBQyxPQUFPLEVBQUMsQ0FBQyxDQUFDO0FBQ2xELFNBQVMsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLENBQUMsSUFBSSxHQUFHLFFBQVEsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsNEJBQTRCO0FBRTFILElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQztBQUNuQixRQUFRLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMsQ0FBQyxJQUFJLEdBQUcsSUFBSSxDQUFDO0FBQzdDLFNBQVMsQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUM7QUFFckQsU0FBUyxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQyIsImZpbGUiOiJ0ZXN0LmpzIiwic291cmNlc0NvbnRlbnQiOlsiLy8vIDxyZWZlcmVuY2UgcGF0aD1cIi4uL3RzL3R5cGluZ3MvbWFpbi5kLnRzXCIgLz5cbnZhciBzbWFydGVudiA9IHJlcXVpcmUoXCIuLi9kaXN0L2luZGV4LmpzXCIpO1xudmFyIGJlYXV0eWxvZyA9IHJlcXVpcmUoXCJiZWF1dHlsb2dcIik7XG5iZWF1dHlsb2cuaW5mbyhcIk5vdyB0ZXN0aW5nIHRoZSBzbWFydGVudiBtb2R1bGVcIik7XG5zbWFydGVudi5wcmludEVudigpO1xuYmVhdXR5bG9nLmluZm8oXCJOb3cgdGVzdGluZyB0aGUgc21hcnRlbnYgbW9kdWxlXCIpO1xuXG4vL3Rlc3Qgc21hcnRlbnYub2JzLmFkZFxuc21hcnRlbnYub2JzLmFkZChcIm15VGVzdE9iamVjdFwiLHtrZXkxOlwiUGV0ZXJcIn0pO1xuc21hcnRlbnYub2JzLmFkZChcIm15VGVzdE9iamVjdFwiLHtrZXkxOlwiS2xhdXNcIn0pOyAvL25vdyB0cnlpbmcgdG8gYWRkIGEgc2Vjb25kXG5zbWFydGVudi5wcmludEVudigpO1xuYmVhdXR5bG9nLmxvZyhzbWFydGVudi5vYnMuZ2V0KFwibXlUZXN0T2JqZWN0XCIpLmtleTEpOyAvLyB0aGlzIHNob3VsZCBiZSBQZXRlclxuXG4vL3Rlc3Qgc21hcnRlbnYub2JzLnJlcGxhY2VcbnNtYXJ0ZW52Lm9icy5yZXBsYWNlKFwibXlUZXN0T2JqZWN0XCIse2tleTE6XCJLbGF1c1wifSk7XG5iZWF1dHlsb2cubG9nKHNtYXJ0ZW52Lm9icy5nZXQoXCJteVRlc3RPYmplY3RcIikua2V5MSk7IC8vIHRoaXMgc2hvdWxkIGJlIEtsYXVzXG5cbi8vdGVzdCBzbWFydGVudi5vYnMubWVyZ2VcbnNtYXJ0ZW52Lm9icy5tZXJnZShcIm15VGVzdE9iamVjdFwiLHtrZXkyOlwiUGV0ZXJcIn0pO1xuYmVhdXR5bG9nLmxvZyhzbWFydGVudi5vYnMuZ2V0KFwibXlUZXN0T2JqZWN0XCIpLmtleTEgKyBzbWFydGVudi5vYnMuZ2V0KFwibXlUZXN0T2JqZWN0XCIpLmtleTIpOyAvLyB0aGlzIHNob3VsZCBiZSBLbGF1c1BldGVyXG5cbnZhciBrZXkyID0gXCJoZWxsb1wiO1xuc21hcnRlbnYub2JzLmdldChcIm15VGVzdE9iamVjdFwiKS5rZXkyID0ga2V5MjtcbmJlYXV0eWxvZy5sb2coc21hcnRlbnYub2JzLmdldChcIm15VGVzdE9iamVjdFwiKS5rZXkyKTtcblxuYmVhdXR5bG9nLnN1Y2Nlc3MoXCJTdWNjZXNzIVwiKTsiXSwic291cmNlUm9vdCI6Ii9zb3VyY2UvIn0=
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,IAAI,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC3C,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AACrC,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,QAAQ,EAAE,CAAC;AACpB,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAElD,uBAAuB;AACvB,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,EAAC,EAAC,IAAI,EAAC,OAAO,EAAC,CAAC,CAAC;AAChD,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,EAAC,EAAC,IAAI,EAAC,OAAO,EAAC,CAAC,CAAC,CAAC,4BAA4B;AAC7E,QAAQ,CAAC,QAAQ,EAAE,CAAC;AACpB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,uBAAuB;AAE7E,2BAA2B;AAC3B,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,EAAC,EAAC,IAAI,EAAC,OAAO,EAAC,CAAC,CAAC;AACpD,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,uBAAuB;AAE7E,yBAAyB;AACzB,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,EAAC,EAAC,IAAI,EAAC,OAAO,EAAC,CAAC,CAAC;AAClD,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,4BAA4B;AAE1H,IAAI,IAAI,GAAG,OAAO,CAAC;AACnB,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC;AAC7C,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC;AAErD,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC"}
|
|
||||||
81
test/test.node.ts
Normal file
81
test/test.node.ts
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
import { tap, expect } from '@git.zone/tstest/tapbundle';
|
||||||
|
import * as smartenv from '../ts/index.js';
|
||||||
|
|
||||||
|
let testEnv: smartenv.Smartenv;
|
||||||
|
|
||||||
|
tap.test('should create smartenv instance', async () => {
|
||||||
|
testEnv = new smartenv.Smartenv();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should detect Node.js runtime correctly', async () => {
|
||||||
|
expect(testEnv.runtimeEnv).toEqual('node');
|
||||||
|
expect(testEnv.isNode).toBeTrue();
|
||||||
|
expect(testEnv.isDeno).toBeFalse();
|
||||||
|
expect(testEnv.isBun).toBeFalse();
|
||||||
|
expect(testEnv.isBrowser).toBeFalse();
|
||||||
|
console.log('✓ Node.js runtime detected correctly (not confused with Deno or Bun)');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should get Node.js version', async () => {
|
||||||
|
const version = testEnv.nodeVersion;
|
||||||
|
expect(version).not.toEqual('undefined');
|
||||||
|
expect(typeof version).toEqual('string');
|
||||||
|
expect(version).toMatch(/^v\d+\.\d+\.\d+/);
|
||||||
|
console.log('Node.js version is ' + version);
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should print environment', async () => {
|
||||||
|
testEnv.printEnv();
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should load modules for Node.js', async () => {
|
||||||
|
const pathModule = await testEnv.getSafeModuleFor('node', 'path');
|
||||||
|
expect(pathModule).not.toBeUndefined();
|
||||||
|
expect(typeof pathModule.join).toEqual('function');
|
||||||
|
console.log('✓ Successfully loaded module for Node.js');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should load modules for server runtimes', async () => {
|
||||||
|
const pathModule = await testEnv.getSafeModuleFor('server', 'path');
|
||||||
|
expect(pathModule).not.toBeUndefined();
|
||||||
|
expect(typeof pathModule.join).toEqual('function');
|
||||||
|
console.log('✓ Successfully loaded module with server target');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should load modules for array of runtimes', async () => {
|
||||||
|
const pathModule = await testEnv.getSafeModuleFor(['node', 'deno'], 'path');
|
||||||
|
expect(pathModule).not.toBeUndefined();
|
||||||
|
expect(typeof pathModule.join).toEqual('function');
|
||||||
|
console.log('✓ Successfully loaded module with array target');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should not load modules for wrong runtime', async () => {
|
||||||
|
const result = await testEnv.getSafeModuleFor('browser', 'path');
|
||||||
|
expect(result).toBeUndefined();
|
||||||
|
console.log('✓ Correctly rejected browser-only module in Node.js');
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should get os', async () => {
|
||||||
|
const resultMac = await testEnv.isMacAsync();
|
||||||
|
const resultLinux = await testEnv.isLinuxAsync();
|
||||||
|
const resultWindows = await testEnv.isWindowsAsync();
|
||||||
|
const osModule = await import('os');
|
||||||
|
if (resultMac) {
|
||||||
|
expect(osModule.platform()).toEqual('darwin');
|
||||||
|
console.log('platform is Mac!');
|
||||||
|
} else if (resultLinux) {
|
||||||
|
expect(osModule.platform()).toEqual('linux');
|
||||||
|
console.log('platform is Linux!');
|
||||||
|
} else {
|
||||||
|
expect(osModule.platform()).toEqual('win32');
|
||||||
|
console.log('platform is Windows!');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.test('should state wether we are in CI', async () => {
|
||||||
|
if (process.env.CI) {
|
||||||
|
expect(testEnv.isCI).toBeTrue();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
tap.start();
|
||||||
26
test/test.ts
26
test/test.ts
@@ -1,26 +0,0 @@
|
|||||||
/// <reference path="../ts/typings/main.d.ts" />
|
|
||||||
var smartenv = require("../dist/index.js");
|
|
||||||
var beautylog = require("beautylog");
|
|
||||||
beautylog.info("Now testing the smartenv module");
|
|
||||||
smartenv.printEnv();
|
|
||||||
beautylog.info("Now testing the smartenv module");
|
|
||||||
|
|
||||||
//test smartenv.obs.add
|
|
||||||
smartenv.obs.add("myTestObject",{key1:"Peter"});
|
|
||||||
smartenv.obs.add("myTestObject",{key1:"Klaus"}); //now trying to add a second
|
|
||||||
smartenv.printEnv();
|
|
||||||
beautylog.log(smartenv.obs.get("myTestObject").key1); // this should be Peter
|
|
||||||
|
|
||||||
//test smartenv.obs.replace
|
|
||||||
smartenv.obs.replace("myTestObject",{key1:"Klaus"});
|
|
||||||
beautylog.log(smartenv.obs.get("myTestObject").key1); // this should be Klaus
|
|
||||||
|
|
||||||
//test smartenv.obs.merge
|
|
||||||
smartenv.obs.merge("myTestObject",{key2:"Peter"});
|
|
||||||
beautylog.log(smartenv.obs.get("myTestObject").key1 + smartenv.obs.get("myTestObject").key2); // this should be KlausPeter
|
|
||||||
|
|
||||||
var key2 = "hello";
|
|
||||||
smartenv.obs.get("myTestObject").key2 = key2;
|
|
||||||
beautylog.log(smartenv.obs.get("myTestObject").key2);
|
|
||||||
|
|
||||||
beautylog.success("Success!");
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
/// <reference path="typings/tsd.d.ts" />
|
|
||||||
var plugins = {
|
|
||||||
beautylog: require("beautylog")("os"),
|
|
||||||
gulp: require("gulp"),
|
|
||||||
gulpBrowser: require("gulp-browser"),
|
|
||||||
easyserve: require("easyserve")
|
|
||||||
};
|
|
||||||
|
|
||||||
plugins.gulp.task('compileBrowserJS', function() {
|
|
||||||
var stream = plugins.gulp.src('test/browser/index.js')
|
|
||||||
.pipe(plugins.gulpBrowser.browserify())
|
|
||||||
.pipe(plugins.gulp.dest("test/browser/browserified/"));
|
|
||||||
return stream;
|
|
||||||
});
|
|
||||||
|
|
||||||
plugins.gulp.task('default',['compileBrowserJS'], function() {
|
|
||||||
plugins.beautylog.success('browserJS has been browserified');
|
|
||||||
plugins.easyserve("test/browser/");
|
|
||||||
});
|
|
||||||
|
|
||||||
plugins.gulp.start.apply(plugins.gulp, ['default']);
|
|
||||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
/**
|
||||||
|
* autocreated commitinfo by @push.rocks/commitinfo
|
||||||
|
*/
|
||||||
|
export const commitinfo = {
|
||||||
|
name: '@push.rocks/smartenv',
|
||||||
|
version: '6.0.0',
|
||||||
|
description: 'A module for storing and accessing environment details across different platforms.'
|
||||||
|
}
|
||||||
12
ts/index.ts
12
ts/index.ts
@@ -1,11 +1 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
export * from './smartenv.classes.smartenv.js';
|
||||||
|
|
||||||
import environment = require("./smartenv.environment");
|
|
||||||
import objectstorage = require("./smartenv.objectstorage");
|
|
||||||
|
|
||||||
var smartenv:any = {}; //create smartenv object
|
|
||||||
smartenv.getEnv = environment.getEnv;
|
|
||||||
smartenv.printEnv = environment.printEnv;
|
|
||||||
smartenv.obs = objectstorage.obs;
|
|
||||||
|
|
||||||
export = smartenv;
|
|
||||||
|
|||||||
20
ts/interfaces/index.ts
Normal file
20
ts/interfaces/index.ts
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
export let defaultme = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runtime type representing the detected JavaScript runtime environment
|
||||||
|
*/
|
||||||
|
export type TRuntimeType = 'node' | 'deno' | 'bun' | 'browser';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runtime target for module loading - can be a specific runtime or 'server' for all server-side runtimes
|
||||||
|
*/
|
||||||
|
export type TRuntimeTarget = TRuntimeType | 'server';
|
||||||
|
|
||||||
|
declare global {
|
||||||
|
namespace NodeJS {
|
||||||
|
interface Global {
|
||||||
|
window: any;
|
||||||
|
navigator: any;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
|
|
||||||
export var getEnvString = function():string {
|
|
||||||
if (typeof window !== "undefined") {
|
|
||||||
return "browser";
|
|
||||||
} else if (typeof process !== "undefined") {
|
|
||||||
return "node";
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
export var getUserAgentString = function():string{
|
|
||||||
if(isBrowser()){
|
|
||||||
return navigator.userAgent;
|
|
||||||
} else {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
export var isNode = function():boolean {
|
|
||||||
if (getEnvString() === "node"){
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
export var getNodeVersion = function():string {
|
|
||||||
return process.version;
|
|
||||||
};
|
|
||||||
|
|
||||||
export var isBrowser = function():boolean {
|
|
||||||
return !isNode();
|
|
||||||
};
|
|
||||||
|
|
||||||
export var isCI = function(){
|
|
||||||
if(process.env.CI){
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
export var isTravis = function(){
|
|
||||||
if(process.env.TRAVIS){
|
|
||||||
return true;
|
|
||||||
} else {
|
|
||||||
return false;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
259
ts/smartenv.classes.smartenv.ts
Normal file
259
ts/smartenv.classes.smartenv.ts
Normal file
@@ -0,0 +1,259 @@
|
|||||||
|
import * as plugins from './smartenv.plugins.js';
|
||||||
|
import * as interfaces from './interfaces/index.js';
|
||||||
|
|
||||||
|
// interfaces
|
||||||
|
export interface IEnvObject {
|
||||||
|
name: string;
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Smartenv class that makes it easy
|
||||||
|
*/
|
||||||
|
export class Smartenv {
|
||||||
|
public async getEnvAwareModule(optionsArg: {
|
||||||
|
nodeModuleName: string;
|
||||||
|
webUrlArg: string;
|
||||||
|
getFunction: () => any;
|
||||||
|
}) {
|
||||||
|
if (this.isNode) {
|
||||||
|
const moduleResult = await this.getSafeNodeModule(optionsArg.nodeModuleName);
|
||||||
|
return moduleResult;
|
||||||
|
} else if (this.isBrowser) {
|
||||||
|
const moduleResult = await this.getSafeWebModule(
|
||||||
|
optionsArg.webUrlArg,
|
||||||
|
optionsArg.getFunction
|
||||||
|
);
|
||||||
|
return moduleResult;
|
||||||
|
} else {
|
||||||
|
console.error('platform for loading not supported by smartenv');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public async getSafeNodeModule<T = any>(moduleNameArg: string, runAfterFunc?: (moduleArg: T) => Promise<any>): Promise<T> {
|
||||||
|
if (!this.isNode && !this.isDeno && !this.isBun) {
|
||||||
|
console.error(`You tried to load a server module in a wrong context: ${moduleNameArg}. This does not throw.`);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// tslint:disable-next-line: function-constructor
|
||||||
|
const returnValue: T = await (new Function(`return import('${moduleNameArg}')`)() as Promise<T>);
|
||||||
|
if (runAfterFunc) {
|
||||||
|
await runAfterFunc(returnValue);
|
||||||
|
}
|
||||||
|
return returnValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
public loadedScripts: string[] = [];
|
||||||
|
public async getSafeWebModule(urlArg: string, getFunctionArg: () => any) {
|
||||||
|
if (!this.isBrowser) {
|
||||||
|
console.error('You tried to load a web module in a wrong context');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.loadedScripts.includes(urlArg)) {
|
||||||
|
return getFunctionArg();
|
||||||
|
} else {
|
||||||
|
this.loadedScripts.push(urlArg);
|
||||||
|
}
|
||||||
|
|
||||||
|
const done = plugins.smartpromise.defer();
|
||||||
|
if (globalThis.importScripts) {
|
||||||
|
globalThis.importScripts(urlArg);
|
||||||
|
done.resolve();
|
||||||
|
} else {
|
||||||
|
const script = document.createElement('script');
|
||||||
|
script.onload = () => {
|
||||||
|
done.resolve();
|
||||||
|
};
|
||||||
|
script.src = urlArg;
|
||||||
|
document.head.appendChild(script);
|
||||||
|
}
|
||||||
|
await done.promise;
|
||||||
|
return getFunctionArg();
|
||||||
|
}
|
||||||
|
|
||||||
|
public get runtimeEnv(): interfaces.TRuntimeType {
|
||||||
|
// Check Deno first (most distinctive)
|
||||||
|
if (typeof globalThis.Deno !== 'undefined' &&
|
||||||
|
typeof (globalThis as any).Deno?.version !== 'undefined') {
|
||||||
|
return 'deno';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check Bun second (most distinctive)
|
||||||
|
if (typeof globalThis.Bun !== 'undefined' &&
|
||||||
|
typeof (globalThis as any).Bun?.version !== 'undefined') {
|
||||||
|
return 'bun';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check Node.js (be explicit about versions to avoid Deno/Bun false positives)
|
||||||
|
if (typeof globalThis.process !== 'undefined' &&
|
||||||
|
typeof (globalThis as any).process?.versions?.node !== 'undefined') {
|
||||||
|
return 'node';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check Browser (default fallback)
|
||||||
|
if (typeof globalThis.window !== 'undefined' &&
|
||||||
|
typeof (globalThis as any).document !== 'undefined') {
|
||||||
|
return 'browser';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Safe fallback
|
||||||
|
return 'browser';
|
||||||
|
}
|
||||||
|
|
||||||
|
public get isBrowser(): boolean {
|
||||||
|
return this.runtimeEnv === 'browser';
|
||||||
|
}
|
||||||
|
|
||||||
|
public get isNode(): boolean {
|
||||||
|
return this.runtimeEnv === 'node';
|
||||||
|
}
|
||||||
|
|
||||||
|
public get isDeno(): boolean {
|
||||||
|
return this.runtimeEnv === 'deno';
|
||||||
|
}
|
||||||
|
|
||||||
|
public get isBun(): boolean {
|
||||||
|
return this.runtimeEnv === 'bun';
|
||||||
|
}
|
||||||
|
|
||||||
|
public get userAgent(): string {
|
||||||
|
if (this.isBrowser) {
|
||||||
|
// make sure we are in Browser
|
||||||
|
return navigator.userAgent;
|
||||||
|
} else {
|
||||||
|
return 'undefined';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public get nodeVersion(): string {
|
||||||
|
if (this.isNode) {
|
||||||
|
return process.version;
|
||||||
|
}
|
||||||
|
return 'undefined';
|
||||||
|
}
|
||||||
|
|
||||||
|
public get denoVersion(): string {
|
||||||
|
if (this.isDeno) {
|
||||||
|
return (globalThis as any).Deno.version.deno;
|
||||||
|
}
|
||||||
|
return 'undefined';
|
||||||
|
}
|
||||||
|
|
||||||
|
public get bunVersion(): string {
|
||||||
|
if (this.isBun) {
|
||||||
|
return (globalThis as any).Bun.version;
|
||||||
|
}
|
||||||
|
return 'undefined';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load a module only if the current runtime matches the target runtime(s)
|
||||||
|
* @param target - Single runtime, array of runtimes, or 'server' for all server-side runtimes
|
||||||
|
* @param moduleNameOrUrl - Module name (for Node/Deno/Bun) or URL (for browser)
|
||||||
|
* @param getFunction - Optional function to retrieve the module in browser context
|
||||||
|
* @returns The loaded module or undefined if runtime doesn't match
|
||||||
|
*/
|
||||||
|
public async getSafeModuleFor<T = any>(
|
||||||
|
target: interfaces.TRuntimeTarget | interfaces.TRuntimeTarget[],
|
||||||
|
moduleNameOrUrl: string,
|
||||||
|
getFunction?: () => any
|
||||||
|
): Promise<T | undefined> {
|
||||||
|
// Normalize target to array
|
||||||
|
let targetRuntimes: interfaces.TRuntimeType[];
|
||||||
|
|
||||||
|
if (Array.isArray(target)) {
|
||||||
|
// Expand 'server' if present in array
|
||||||
|
targetRuntimes = target.flatMap(t =>
|
||||||
|
t === 'server' ? ['node', 'deno', 'bun'] as interfaces.TRuntimeType[] : [t as interfaces.TRuntimeType]
|
||||||
|
);
|
||||||
|
} else if (target === 'server') {
|
||||||
|
targetRuntimes = ['node', 'deno', 'bun'];
|
||||||
|
} else {
|
||||||
|
targetRuntimes = [target];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if current runtime matches any target
|
||||||
|
if (!targetRuntimes.includes(this.runtimeEnv)) {
|
||||||
|
console.warn(
|
||||||
|
`Module "${moduleNameOrUrl}" requested for runtime(s) [${targetRuntimes.join(', ')}] ` +
|
||||||
|
`but current runtime is "${this.runtimeEnv}". Skipping load.`
|
||||||
|
);
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load based on current runtime
|
||||||
|
if (this.isNode || this.isDeno || this.isBun) {
|
||||||
|
// Server-side runtimes use dynamic import
|
||||||
|
const moduleResult = await this.getSafeNodeModule<T>(moduleNameOrUrl);
|
||||||
|
return moduleResult;
|
||||||
|
} else if (this.isBrowser) {
|
||||||
|
if (!getFunction) {
|
||||||
|
console.error(`Browser module load requires getFunction parameter for "${moduleNameOrUrl}"`);
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
const moduleResult = await this.getSafeWebModule(moduleNameOrUrl, getFunction);
|
||||||
|
return moduleResult as T;
|
||||||
|
}
|
||||||
|
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
public get isCI(): boolean {
|
||||||
|
if (this.isNode) {
|
||||||
|
if (process.env.CI) {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public async isMacAsync(): Promise<boolean> {
|
||||||
|
if (this.isNode) {
|
||||||
|
const os = await this.getSafeNodeModule('os');
|
||||||
|
return os.platform() === 'darwin';
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public async isWindowsAsync(): Promise<boolean> {
|
||||||
|
if (this.isNode) {
|
||||||
|
const os = await this.getSafeNodeModule('os');
|
||||||
|
return os.platform() === 'win32';
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public async isLinuxAsync(): Promise<boolean> {
|
||||||
|
if (this.isNode) {
|
||||||
|
const os = await this.getSafeNodeModule('os');
|
||||||
|
return os.platform() === 'linux';
|
||||||
|
} else {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* prints the environment to console
|
||||||
|
*/
|
||||||
|
public async printEnv() {
|
||||||
|
if (this.isNode) {
|
||||||
|
console.log('running on NODE');
|
||||||
|
console.log('node version is ' + this.nodeVersion);
|
||||||
|
} else if (this.isDeno) {
|
||||||
|
console.log('running on DENO');
|
||||||
|
console.log('deno version is ' + this.denoVersion);
|
||||||
|
} else if (this.isBun) {
|
||||||
|
console.log('running on BUN');
|
||||||
|
console.log('bun version is ' + this.bunVersion);
|
||||||
|
} else {
|
||||||
|
console.log('running on BROWSER');
|
||||||
|
console.log('browser is ' + this.userAgent);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
|
|
||||||
import helpers = require("./smartenv.classes.helpers");
|
|
||||||
export class Environment {
|
|
||||||
runtimeEnv:string;
|
|
||||||
isBrowser:boolean;
|
|
||||||
userAgent:string;
|
|
||||||
isNode:boolean;
|
|
||||||
nodeVersion:string;
|
|
||||||
isCI:boolean;
|
|
||||||
isTravis:boolean;
|
|
||||||
constructor() {
|
|
||||||
this.runtimeEnv = helpers.getEnvString();
|
|
||||||
this.isBrowser = helpers.isBrowser();
|
|
||||||
this.userAgent = helpers.getUserAgentString();
|
|
||||||
this.isNode = helpers.isNode();
|
|
||||||
this.nodeVersion = helpers.getNodeVersion();
|
|
||||||
this.isCI = helpers.isCI();
|
|
||||||
this.isTravis = helpers.isTravis();
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
/**
|
|
||||||
* Deals with the environment the current JS script is running in.
|
|
||||||
*/
|
|
||||||
import plugins = require("./smartenv.plugins");
|
|
||||||
import classes = require("./smartenv.classes");
|
|
||||||
import objectStorage = require("./smartenv.objectstorage");
|
|
||||||
|
|
||||||
|
|
||||||
var environment:classes.Environment;
|
|
||||||
var envDetermined:boolean = false;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* returns the environment
|
|
||||||
* @returns {Environment}
|
|
||||||
*/
|
|
||||||
export var getEnv = function(){
|
|
||||||
if (!envDetermined) {
|
|
||||||
environment = new classes.Environment();
|
|
||||||
envDetermined = true; // ensure code above only runs once
|
|
||||||
};
|
|
||||||
return environment;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* prints the environment to console
|
|
||||||
*/
|
|
||||||
export var printEnv = function() {
|
|
||||||
if (this.getEnv().isNode) {
|
|
||||||
plugins.beautylog.ok("running on NODE");
|
|
||||||
var smartenvVersion = require("../package.json").version;
|
|
||||||
plugins.beautylog.log("node version is " + this.getEnv().nodeVersion + " and smartenv version is " + smartenvVersion);
|
|
||||||
} else {
|
|
||||||
plugins.beautylog.ok("running on BROWSER");
|
|
||||||
plugins.beautylog.log("browser is " + this.getEnv().userAgent);
|
|
||||||
}
|
|
||||||
plugins.beautylog.log("the smartenv registration store currently holds the following properties:");
|
|
||||||
console.log(Object.getOwnPropertyNames(objectStorage.obs.getAll()));
|
|
||||||
};
|
|
||||||
@@ -1,41 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
import plugins = require("./smartenv.plugins");
|
|
||||||
|
|
||||||
export var obs:any = {
|
|
||||||
add: function(paramNameArg = "undefined",objectArg = "undefined") {
|
|
||||||
if (paramNameArg == "undefined"){
|
|
||||||
plugins.beautylog.error("paramName is undefined");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (objectArg == "undefined"){
|
|
||||||
plugins.beautylog.error("objectArg is undefined");
|
|
||||||
}
|
|
||||||
if (typeof obsItems[paramNameArg] === "undefined"){
|
|
||||||
obsItems[paramNameArg] = objectArg;
|
|
||||||
} else {
|
|
||||||
plugins.beautylog.error("object is already present, so add operation has failed.");
|
|
||||||
}
|
|
||||||
return obsItems[paramNameArg];
|
|
||||||
},
|
|
||||||
replace: function(paramNameArg,objectArg){
|
|
||||||
obsItems[paramNameArg] = objectArg;
|
|
||||||
},
|
|
||||||
merge: function(paramNameArg,objectArg){
|
|
||||||
if(!(typeof obsItems[paramNameArg] === "undefined")){
|
|
||||||
obsItems[paramNameArg] = plugins._.assign(obsItems[paramNameArg],objectArg);
|
|
||||||
} else {
|
|
||||||
plugins.beautylog.error("object is not present, so there is nothing to merge");
|
|
||||||
}
|
|
||||||
},
|
|
||||||
get: function(keyName) {
|
|
||||||
return obsItems[keyName];
|
|
||||||
},
|
|
||||||
getAll: function () {
|
|
||||||
return obsItems;
|
|
||||||
},
|
|
||||||
addComplete: function(itemsArg) {
|
|
||||||
obsItems = plugins._.assign(obsItems,itemsArg);
|
|
||||||
return obsItems;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
export var obsItems:any = {};
|
|
||||||
@@ -1,8 +1,3 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
import * as smartpromise from '@push.rocks/smartpromise';
|
||||||
var plugins = {
|
|
||||||
beautylog: require("beautylog"),
|
|
||||||
Q: require("q"),
|
|
||||||
_: require("lodash")
|
|
||||||
};
|
|
||||||
|
|
||||||
export = plugins;
|
export { smartpromise };
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
{
|
|
||||||
"ambientDependencies": {
|
|
||||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"experimentalDecorators": true,
|
||||||
|
"useDefineForClassFields": false,
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"verbatimModuleSyntax": true
|
||||||
|
},
|
||||||
|
"exclude": [
|
||||||
|
"dist_*/**/*.d.ts"
|
||||||
|
]
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user