feat: SDK-713 npm package structure for userlib

.gitignore

@@ -15,3 +15,6 @@ target/
 # Mac Temporary Files
 .DS_Store
 **/.DS_Store
+
+# Node Modules
+**/node_modules/

dfx.nix

@@ -69,7 +69,7 @@ let
                   cp ${pkgs.motoko.didc}/bin/didc $out
                   cp ${pkgs.motoko.rts}/rts/mo-rts.wasm $out
                   mkdir $out/stdlib && cp -R ${pkgs.motoko.stdlib}/. $out/stdlib
-                  mkdir $out/js-user-library && cp -R ${userlib-js}/. $out/js-user-library
+                  mkdir $out/js-user-library && tar --strip-components=1 --directory=$out/js-user-library -xzvf ${userlib-js}/internet-computer-*.tgz
                 '';
               }
             )

src/dfx/assets/new_project_node_files/webpack.config.js

@@ -19,7 +19,7 @@ const aliases = Object.entries(dfxJson.canisters).reduce((acc, [name,value]) =>
     process.env["HOME"],
     ".cache/dfinity/versions",
     dfxJson.dfx || process.env["DFX_VERSION"],
-    "js-user-library/dist/lib.prod.js",
+    "js-user-library/",
   ),
 });
 

src/dfx/src/commands/start.rs

@@ -100,7 +100,7 @@ pub fn exec(env: &dyn Environment, args: &ArgMatches<'_>) -> DfxResult {
 
     let bootstrap_dir = env
         .get_cache()
-        .get_binary_command_path("js-user-library/dist/bootstrap")?;
+        .get_binary_command_path("js-user-library/bootstrap")?;
     let frontend_watchdog = webserver(
         address_and_port,
         vec![url::Url::parse(IC_CLIENT_BIND_ADDR).unwrap()],

src/userlib/js/.gitignore

@@ -1,3 +1,6 @@
-dist/
-out/
+build_info.json
 node_modules/
+src/**/*.js
+src/**/*.js.map
+src/**/*.d.ts
+

src/userlib/js/.npmignore

@@ -0,0 +1,13 @@
+# We work with a safelist here, so block everything that's not permitted, and add packages
+# that are.
+**
+
+!bootstrap/**
+!src/**/*.d.ts
+!src/**/*.js
+!types/**/*.d.ts
+!package.json
+!README.md
+
+# The following line further removes all test files (which matches .js and .d.ts).
+src/**/*.test.*

src/userlib/js/README.adoc

@@ -1,5 +1,28 @@
-= js-user-library
+= JavaScript User Library
+
+This is an internal document and is not published to NPM. The public facing README is in
+`./README.md`. This file can be safely removed once we are open sourced.
+
+Package: `@internet-computer/userlib`
 
 == Development
 
-Run `nix-shell` in this directory, and then use `npm` as normal.
+=== How to build and use locally
+
+In this repo:
+
+[source,bash]
+cd src/userlib/js  # You are here
+npm install
+npm run build
+pwd  # Keep this
+cp -rf . $(dfx cache show)
+
+Alternatively, it might be easier to simply create a symlink;
+
+[source,bash]
+rm -rf $(dfx cache show)/js-user-library
+ln -s src/userlib/js $(dfx cache show)/js-user-library
+
+Then you just need to run `npm run build` when you change the code. You can also use
+`npm run build -- --watch` for a quick watch mode.

src/userlib/js/README.md

@@ -0,0 +1,7 @@
+# JavaScript User Library
+
+Package: `@internet-computer/userlib`
+
+## API
+
+TBD.

src/userlib/js/default.nix

@@ -1,12 +1,14 @@
-{ pkgs }:
-
+{ pkgs ? import ../../../nix { inherit system; }
+, system ? builtins.currentSystem
+}:
 let
   repoRoot = ../../..;
   src = pkgs.lib.noNixFiles (pkgs.lib.gitOnlySource repoRoot ./.);
 in
 pkgs.napalm.buildPackage src {
   root = ./.;
   name = "dfinity-sdk-userlib-js";
+
   # ci script now does everything CI should do. Bundle is needed because it's the output
   # of the nix derivation.
   npmCommands = [
@@ -16,9 +18,9 @@ pkgs.napalm.buildPackage src {
   ];
 
   installPhase = ''
+    npm pack
     mkdir -p $out
-    cp -R dist $out
-    cp package.json $out
-    cp README.adoc $out
+
+    cp internet-computer-*.tgz $out
   '';
 }

src/userlib/js/package.json

@@ -1,17 +1,11 @@
 {
   "private": true,
-  "name": "@internet-computer/js-user-library",
-  "version": "0.1.0",
-  "main": "dist/lib.node.js",
-  "browser": {
-    "./dist/lib.node.js": "./dist/lib.web.js"
-  },
-  "files": [
-    "dist/**/*"
-  ],
+  "name": "@internet-computer/userlib",
+  "version": "0.5.0",
+  "main": "src/index.js",
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "bundle": "npm run build && webpack",
+    "bundle": "npm run build",
     "ci": "npm run prettier && npm run lint && npm run build && npm run test",
     "lint": "tslint --project tsconfig.json --config tslint.json",
     "lint:fix": "npm run lint -- --fix",

src/userlib/js/tsconfig.json

@@ -15,10 +15,10 @@
     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
      "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
-     "outDir": "out",                        /* Redirect output structure to the directory. */
+    // "outDir": "out",                        /* Redirect output structure to the directory. */
     // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     // "composite": true,                     /* Enable project compilation */
-     "tsBuildInfoFile": "./out/build_info.json",               /* Specify file to store incremental compilation information */
+     "tsBuildInfoFile": "./build_info.json",               /* Specify file to store incremental compilation information */
     // "removeComments": true,                /* Do not emit comments to output. */
     // "noEmit": true,                        /* Do not emit outputs. */
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */