Add a browser SDK example (#1079)

Author: dcodeIO

examples/sdk/README.md

@@ -0,0 +1,9 @@
+Browser SDK
+===========
+
+An [AssemblyScript](http://assemblyscript.org) example using the [AssemblyScript browser SDK](https://github.com/AssemblyScript/assemblyscript/tree/master/lib/sdk).
+
+Instructions
+------------
+
+Open [index.html](./index.html) in a browser and see the console. View the source to learn how it works.

examples/sdk/index.html

@@ -0,0 +1,59 @@
+<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js"></script>
+<script>
+require([ "https://cdn.jsdelivr.net/npm/assemblyscript@latest/dist/sdk.js" ], function(sdk) {
+  const { asc } = sdk;
+  asc.ready.then(() => {
+    console.log("Running simple example...");
+    simpleExample(asc);
+    console.log("\nRunning extended example...");
+    extendedExample(asc);
+  });
+});
+
+// This uses `asc.compileString`, a convenience API useful if all one wants to
+// do is to quickly compile a single source string to WebAssembly.
+function simpleExample(asc) {
+  const { text, binary } = asc.compileString(`export function test(): void {}`, {
+    optimizeLevel: 3,
+    runtime: "none"
+  });
+  console.log(">>> TEXT >>>\n" + text);
+  console.log(">>> BINARY >>>\n" + binary.length + " bytes");
+}
+
+// The full API works very much like asc on the command line, with additional
+// environment bindings being provided to access the (virtual) file system.
+function extendedExample(asc) {
+  const stdout = asc.createMemoryStream();
+  const stderr = asc.createMemoryStream();
+  asc.main([
+    "module.ts",
+    "-O3",
+    "--runtime", "none",
+    "--binaryFile", "module.wasm",
+    "--textFile", "module.wat",
+    "--sourceMap"
+  ], {
+    stdout: stdout,
+    stderr: stderr,
+    readFile: (name, baseDir) => {
+      if (name === "module.ts") return `export function test(): void {}`;
+      return null;
+    },
+    writeFile: (name, data, baseDir) => {
+      console.log(">>> WRITE:" + name + " >>>\n" + data.length);
+    },
+    listFiles: (dirname, baseDir) => {
+      return [];
+    }
+  }, err => {
+    console.log(">>> STDOUT >>>\n" + stdout.toString());
+    console.log(">>> STDERR >>>\n" + stderr.toString());
+    if (err) {
+      console.log(">>> THROWN >>>");
+      console.log(err);
+    }
+  });
+}
+</script>
+<p>See the browser console!</p>

lib/sdk/README.md

@@ -15,6 +15,9 @@ Exports
 * **binaryen**<br />
   The version of binaryen required by the compiler.
 
+* **long**<br />
+  The version of long.js required by the compiler.
+
 * **assemblyscript**<br />
   The AssemblyScript compiler as a library.
 
@@ -27,12 +30,14 @@ Example usage
 
 ```js
 require(
-  ["https://cdn.jsdelivr.net/npm/assemblyscript@nightly/dist/sdk"],
+  ["https://cdn.jsdelivr.net/npm/assemblyscript@latest/dist/sdk"],
   function(sdk) {
-    const { binaryen, assemblyscript, asc } = sdk;
+    const { asc } = sdk;
     asc.ready.then(() => {
       asc.main(...);
     });
   }
 );
 ```
+
+There is also the [SDK example](https://github.com/AssemblyScript/assemblyscript/tree/master/examples/sdk) showing how to compile some actual code.

lib/sdk/index.js

@@ -1,18 +1,22 @@
 const BINARYEN_VERSION = "nightly";
+const LONG_VERSION = "latest";
 const ASSEMBLYSCRIPT_VERSION = "nightly";
 
 // AMD/require.js (browser)
 if (typeof define === "function" && define.amd) {
   const paths = {
     "binaryen": "https://cdn.jsdelivr.net/npm/binaryen@" + BINARYEN_VERSION + "/index",
+    "long": "https://cdn.jsdelivr.net/npm/long@" + LONG_VERSION + "/dist/long",
     "assemblyscript": "https://cdn.jsdelivr.net/npm/assemblyscript@" + ASSEMBLYSCRIPT_VERSION + "/dist/assemblyscript",
     "assemblyscript/cli/asc": "https://cdn.jsdelivr.net/npm/assemblyscript@" + ASSEMBLYSCRIPT_VERSION + "/dist/asc",
   };
   require.config({ paths });
-  define(Object.keys(paths), (binaryen, assemblyscript, asc) => ({
+  define(Object.keys(paths), (binaryen, long, assemblyscript, asc) => ({
     BINARYEN_VERSION,
+    LONG_VERSION,
     ASSEMBLYSCRIPT_VERSION,
     binaryen,
+    long,
     assemblyscript,
     asc
   }));
@@ -21,8 +25,10 @@ if (typeof define === "function" && define.amd) {
 } else if (typeof module === "object" && module.exports) {
   module.exports = {
     BINARYEN_VERSION,
+    LONG_VERSION,
     ASSEMBLYSCRIPT_VERSION,
     binaryen: require("binaryen"),
+    long: require("long"),
     assemblyscript: require("assemblyscript"),
     asc: require("assemblyscript/cli/asc")
   };

lib/sdk/tests/index.html

@@ -4,12 +4,15 @@
   if (!x) throw Error("assertion failed");
 }
 require(["../index"], function(sdk) {
-  const { BINARYEN_VERSION, ASSEMBLYSCRIPT_VERSION, binaryen, assemblyscript, asc } = sdk;
+  const { BINARYEN_VERSION, LONG_VERSION, ASSEMBLYSCRIPT_VERSION, binaryen, long, assemblyscript, asc } = sdk;
   assert(typeof BINARYEN_VERSION === "string");
+  assert(typeof LONG_VERSION === "string");
   assert(typeof ASSEMBLYSCRIPT_VERSION === "string");
   console.log("Binaryen@" + BINARYEN_VERSION);
+  console.log("Long@" + LONG_VERSION);
   console.log("AssemblyScript@" + ASSEMBLYSCRIPT_VERSION);
   assert(typeof binaryen === "object" && binaryen && typeof binaryen._BinaryenTypeNone === "function");
+  assert(typeof long === "function" && long && typeof long.fromInt === "function");
   assert(typeof assemblyscript === "object" && assemblyscript && typeof assemblyscript.parse === "function");
   assert(typeof asc === "object" && asc && typeof asc.main === "function");
   asc.ready.then(() => console.log("ready", sdk));

scripts/build-sdk.js

@@ -1,11 +1,12 @@
 const path = require("path");
 const fs = require("fs");
-const pkg = require("../package.json");
+const pkg = require("../package-lock.json");
 
 fs.readFile(path.join(__dirname, "..", "lib", "sdk", "index.js"), "utf8", function(err, data) {
   if (err) throw err;
   data = data
-    .replace(/BINARYEN_VERSION = "nightly"/, "BINARYEN_VERSION = " + JSON.stringify(pkg.dependencies.binaryen))
+    .replace(/BINARYEN_VERSION = "nightly"/, "BINARYEN_VERSION = " + JSON.stringify(pkg.dependencies.binaryen.version))
+    .replace(/LONG_VERSION = "latest"/, "LONG_VERSION = " + JSON.stringify(pkg.dependencies.long.version))
     .replace(/ASSEMBLYSCRIPT_VERSION = "nightly"/, "ASSEMBLYSCRIPT_VERSION = " + JSON.stringify(pkg.version));
   fs.writeFile(path.join(__dirname, "..", "dist", "sdk.js"), data, function(err) {
     if (err) throw err;