@sasjs/utils 3.7.4 → 4.0.0

package/README.md

@@ -6,6 +6,29 @@
 
 A library of utilities and types for SASjs written in TypeScript.
 
+## Entry points
+
+This is a Node library, and the barrel - `import { x } from '@sasjs/utils'` - is its Node
+entry point. Importing from it pulls in the modules that only Node can run: `fs-extra` and
+`@fast-csv/format` through `./file`, `prompts` through `./input`, `chalk` and `consola`
+through `./logger` and `./formatter`.
+
+Code that is bundled for a browser imports the subpath it needs instead:
+
+```
+import { ServerType } from '@sasjs/utils/types'
+import { prefixMessage } from '@sasjs/utils/error'
+import { isSpecialMissing } from '@sasjs/utils/input/validators'
+import { bytesToSize } from '@sasjs/utils/utils'
+```
+
+The hash and sync helpers - `getHash`, `compareHashes`, `extractHashArray`,
+`generateCompileProgram`, `generateProgramToGetRemoteHash`, `generateProgramToSyncHashDiff`
+and `findResourcesNotPresentLocally` - live in `@sasjs/utils/fs`. They hash files and
+folders on disk, so they are Node-only, and the barrel does not re-export them: a browser
+bundle that imports the barrel for anything else no longer reaches `crypto`, which used to
+arrive with the whole AES/RSA/ECDSA polyfill suite behind it.
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

package/index.d.ts

@@ -8,4 +8,3 @@ export * from './time';
 export * from './types';
 export * from './utils';
 export * from './compileTree';
-export * from './fs';

package/index.js

@@ -20,5 +20,10 @@ __exportStar(require("./time"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./compileTree"), exports);
-__exportStar(require("./fs"), exports);
+// './fs' is deliberately absent: it is the only module here that imports
+// `crypto`, and re-exporting it put that - plus browserify-sign, parse-asn1,
+// asn1.js and vm-browserify, roughly 555 KB of AES/RSA/ECDSA polyfills and a
+// vm shim's dynamic code execution - into every browser bundle that imported
+// anything from this barrel. The helpers live at '@sasjs/utils/fs' instead.
+// See sasjs/utils#275.
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAAsB;AACtB,yCAAsB;AACtB,8CAA2B;AAC3B,0CAAuB;AACvB,2CAAwB;AACxB,6CAA0B;AAC1B,yCAAsB;AACtB,0CAAuB;AACvB,0CAAuB;AACvB,gDAA6B;AAC7B,uCAAoB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAAsB;AACtB,yCAAsB;AACtB,8CAA2B;AAC3B,0CAAuB;AACvB,2CAAwB;AACxB,6CAA0B;AAC1B,yCAAsB;AACtB,0CAAuB;AACvB,0CAAuB;AACvB,gDAA6B;AAC7B,yEAAyE;AACzE,6EAA6E;AAC7E,6EAA6E;AAC7E,6EAA6E;AAC7E,4EAA4E;AAC5E,uBAAuB"}

package/package.json

@@ -95,5 +95,5 @@
     "jwt-decode": "4.0.0",
     "prompts": "2.4.2"
   },
-  "version": "3.7.4"
+  "version": "4.0.0"
 }