@componentor/quickjs-for-quickjs 0.31.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+quickjs-emscripten copyright (c) 2019-2024 Jake Teton-Landis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# quickjs-for-quickjs
+
+![yo dawg i herd u like quickjs so i put quickjs in ur quickjs so u can eval while u eval](./yodawg.jpg)
+
+This package is a build of [quickjs-emscripten](https://github.com/justjake/quickjs-emscripten) that can run inside QuickJS or any other JavaScript runtime without WebAssembly support. The QuickJS C library is compiled to Asm.js, and then bundled together with the quickjs-emscripten JavaScript wrapper into a single standalone file with no external dependencies.
+
+`quickjs-for-quickjs` has been tested in the following configurations:
+
+- ✅ NodeJS -> quickjs-for-quickjs
+- ✅ NodeJS -> quickjs-emscripten RELEASE_SYNC -> quickjs-for-quickjs
+- ❌ NodeJS -> quickjs-emscripten RELEASE_SYNC -> quickjs-for-quickjs -> quickjs-for-quickjs (This hits stack overflow in QuickJS. It could work with a larger stack size for the outer QuickJS instance)
+
+## Why?
+
+For fun!
+
+This could have practical applications, like if you're a user writing a plugin for a 3rd-party system using quickjs-emscripten for scripting, and you as a plugin author also want your plugin to have its own plugin ecosystem.
+
+## Usage
+
+For a more detailed example, see [the "example" directory][example] in the repo.
+
+[example]: https://github.com/justjake/quickjs-emscripte/tree/main/packages/quickjs-for-quickjs/example
+
+```javascript
+// nodejs-host.mjs
+import fs from "node:fs/promises"
+import module from "node:module"
+import { getQuickJS, setUpContext } from "quickjs-for-quickjs"
+
+// get quickjs source code
+const require = module.createRequire(import.meta.url)
+const quickjsSource = await fs.readFile(require.resolve("quickjs-for-quickjs"), "utf8")
+
+// create the host QuickJS context
+const QuickJS = await getQuickJS()
+const context = QuickJS.createContext()
+
+// inject console.log, which is required for quickjs-for-quickjs to work
+setUpContext(context)
+
+// allow the host QuickJS to import quickjs-for-quickjs module
+context.runtime.setModuleLoader((name) => {
+  if (name === "quickjs-for-quickjs") {
+    return quickjsSource
+  }
+  throw new Error(`Module not found: ${name}`)
+})
+
+const quickjsHost = `
+// import and create inner QuickJS guest context
+import { getQuickJS } from "quickjs-for-quickjs"
+const context = await getQuickJS().then(mod => mod.createContext())
+
+// eval some code in the inner context
+const innerResult = context.evalCode('1 + 2', "quickjs-guest.mjs").unwrap()
+
+// export the result
+export const result = innerResult.consume(context.dump)
+`
+
+// eval the quickjs host
+const handle = context.evalCode(quickjsHost, "quickjs-host.mjs").unwrap()
+
+// get the result
+context.runtime.executePendingJob()
+const result = context.unwrapResult(context.getPromiseState(handle))
+
+console.log(result.consume(context.dump))
+```

package/dist/index.d.mts

@@ -0,0 +1,10 @@
+import { QuickJSWASMModule, QuickJSContext } from '@componentor/quickjs-emscripten-core';
+export { default as RELEASE_SYNC } from '@componentor/quickjs-asmjs-mjs-release-sync';
+
+declare function getQuickJS(): Promise<QuickJSWASMModule>;
+declare function newQuickJSWASMModule(): Promise<QuickJSWASMModule>;
+declare function setUpContext(context: QuickJSContext, options?: {
+    log?: (...args: unknown[]) => void;
+}): QuickJSContext;
+
+export { getQuickJS, newQuickJSWASMModule, setUpContext };