Initial commit

Author: kayhuba

.gitignore

@@ -0,0 +1,2 @@
+/.idea/
+/node_modules/

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers (once there are two), or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a member of the project team with his or her respective 
+email address. All complaints will be reviewed and investigated and will result 
+in a response that is deemed necessary and appropriate to the circumstances. 
+The project team is obligated to maintain confidentiality with regard to the 
+reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2018, Kay Huber, unblu inc.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -0,0 +1,62 @@
+# JS Source Extractor
+
+An extractor of source code from Javascript libraries containing source maps with embedded or referenced source.
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+### Install for Node
+
+
+```
+$ npm install --save-dev js-source-extractor
+```
+
+To extract source code from a sourcemap embedded in a javascript and call a callback per source file, use:
+
+```js
+import { extractSrc } from './js-source-extractor'
+
+const baseDir = __dirname + "/../resources";
+extractSrc(new URL(util.format('file://%s/embedded-sourcemap-test.js', baseDir)), null, (path: string, sourceName: string, source: string | null) => {
+    console.log("Path: " + path);              // '/src'
+    console.log("SourceName: " + sourceName);  // '/embedded-sourcemap-test.ts'
+    console.log("Source: " + source);          // 'console.log(\'Hello World!\');'
+});
+```
+
+To extract code from a sourcemap embedded in a javascript and write the source files to the disk, use:
+```js
+const baseDir = __dirname + "/../resources";
+const outDir = tmpdir() + path.sep + 'js-source-extractor-test'; // directory to store source files in
+await extractSrcToDir(new URL(util.format('file://%s/embedded-sourcemap-test.js', baseDir)), outDir);
+```
+
+## Running the tests
+
+JS Source Extractor features a number of mocha tests to verify the various API functionalities.
+
+To start the tests, use:
+```
+$ npm run test
+
+```
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Authors
+
+* **Kay Huber** - *Initial work* - [unblu inc.](https://github.com/unblu)
+
+See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the ISC License - see the [LICENSE.md](LICENSE) file for details
+
+## Acknowledgments
+
+* Thanks Dave for your encouragement to create this tiny tool

dist/js-source-extractor.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import { URL } from "url";
+/**
+ * Type of resource. Required if not automatically determinable.
+ */
+export declare enum ResourceType {
+    JAVASCRIPT = "Javascript",
+    SOURCE_MAP = "Source Map"
+}
+/**
+ * Extract source code from either a provided Javascript file containing a source map information, a Source Map file or a source map in string form.
+ * Source code files must either be referenced and accessible via information in the source map or be contained in the source map (embedded).
+ *
+ * The extracted source code is stored in the file system. The directory structure that is provided with the source file path information in the source map will be created automatically.
+ *
+ * @param {module:url.URL | null} resourceUrl An url (http(s):// or file:// for local file access) to retrieve either a Javascript file or a Source Map file. If null, sourceMap must be specified.
+ * @param {string | null} sourceMap Source Map JSON in string form to use directly. Must contain source code or refer with absolute urls to source files. If null, resourceUrl must be specified.
+ * @param {string} outDir Directory where the source files should be stored into.
+ * @param {ResourceType} resourceType Optional type describing whether the resourceUrl references a Javascript or a Source Map file. Automatic detection (according to the file name extensions) is attempted if not specified.
+ * @param {RegExp} srcInclude Optional pattern to test a source code path against before sending it to the receiver. Defaults to .*
+ * @param {RegExp} srcExclude Optional pattern to test a source code path against to exclude from sending it to the receiver. Exclude pattern is tested after the include pattern.
+ * @returns {Promise<void>} Async function without a direct result (use receiver to receive information)
+ */
+export declare function extractSrcToDir(resourceUrl: URL | null, sourceMap: string | null, outDir?: string, resourceType?: ResourceType, srcInclude?: RegExp, srcExclude?: RegExp): Promise<void>;
+/**
+ * Extract source code from either a provided Javascript file containing a source map information, a Source Map file or a source map in string form.
+ * Source code files must either be referenced and accessible via information in the source map or be contained in the source map (embedded).
+ *
+ * Example:
+ * ```js
+ * const baseDir = __dirname + "/../resources";
+ * extractSrc(new URL(util.format('file://%s/embedded-sourcemap-test.js', baseDir)), null, (path: string, sourceName: string, source: string | null) => {
+ *   console.log("Path: " + path);              // '/src'
+ *   console.log("SourceName: " + sourceName);  // '/embedded-sourcemap-test.ts'
+ *   console.log("Source: " + source);          // 'console.log(\'Hello World!\');'
+ * });
+ * ```
+ *
+ * Note: Either resourceUrl or sourceMap must be specified.
+ *
+ * @param {module:url.URL | null} resourceUrl An url (http(s):// or file:// for local file access) to retrieve either a Javascript file or a Source Map file. If null, sourceMap must be specified.
+ * @param {string | null} sourceMap Source Map JSON in string form to use directly. Must contain source code or refer with absolute urls to source files. If null, resourceUrl must be specified.
+ * @param {(path: string, sourceName: string, source: (string | null)) => void} receiver A callback function called for each source file referenced in the source map.
+ *                                                                              Path is the base path of the source file, sourceName the file name, source the source code, if the file was found
+ * @param {ResourceType} resourceType Optional type describing whether the resourceUrl references a Javascript or a Source Map file. Automatic detection (according to the file name extensions) is attempted if not specified.
+ * @param {RegExp} srcInclude Optional pattern to test a source code path against before sending it to the receiver. Defaults to .*
+ * @param {RegExp} srcExclude Optional pattern to test a source code path against to exclude from sending it to the receiver. Exclude pattern is tested after the include pattern.
+ * @returns {Promise<void>} Async function without a direct result (use receiver to receive information)
+ */
+export declare function extractSrc(resourceUrl: URL | null, sourceMap: string | null, receiver: (path: string, sourceName: string, source: string | null) => void, resourceType?: ResourceType, srcInclude?: RegExp, srcExclude?: RegExp): Promise<void>;