@speckle/objectloader 2.4.2-alpha.2 → 2.4.2

package/.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "useBuiltIns": "entry",
+        "corejs": "3"
+      }
+    ]
+  ],
+  "ignore": ["node_modules/**/*"]
+}

package/.browserslistrc

@@ -0,0 +1 @@
+since 2019

package/.eslintrc.cjs

@@ -10,7 +10,8 @@ const config = {
   },
   parserOptions: {
     sourceType: 'module'
-  }
+  },
+  ignorePatterns: ['examples/browser/objectloader.web.js']
 }
 
 module.exports = config

package/examples/browser/index.html

@@ -14,8 +14,8 @@
       To ensure this example runs correctly, please serve this file from a local http
       server - if you manually open the file in a browser, it might not work.
     </p>
-    <button onclick="loadData()">PRESS ME</button>
+    <button type="button" onclick="loadData()">PRESS ME</button>
   </body>
 
-  <script src="script.js" type="module"></script>
+  <script src="./script.js" type="module"></script>
 </html>

package/examples/browser/script.js

@@ -1,4 +1,4 @@
-import ObjectLoader from '../../index.js'
+import ObjectLoader from './objectloader.web.js'
 window.ObjectLoader = ObjectLoader
 
 // let loader = new ObjectLoader({serverUrl:"https://latest.speckle.dev", streamId:"16d73b756a", objectId:"99b20746460c4369f25e08e92c988a9d"})

package/examples/node/{script.js → script.mjs}

@@ -1,7 +1,6 @@
 // Since Node v<18 does not provide fetch, we need to pass it in the options object. Note that fetch must return a WHATWG compliant stream, so cross-fetch won't work, but node/undici's implementation will.
-
 import { fetch } from 'undici'
-import ObjectLoader from '../../index.js'
+import ObjectLoader from '../../dist/objectloader.js'
 
 const loader = new ObjectLoader({
   serverUrl: 'https://latest.speckle.dev',

package/jsconfig.json

@@ -3,5 +3,5 @@
   "compilerOptions": {
     "module": "es2020"
   },
-  "include": ["index.js", "examples"]
+  "include": ["src/**", "examples"]
 }

package/package.json

@@ -1,18 +1,24 @@
 {
   "name": "@speckle/objectloader",
-  "version": "2.4.2-alpha.2",
+  "version": "2.4.2",
   "description": "Simple API helper to stream in objects from the Speckle Server.",
-  "main": "index.js",
+  "main": "dist/objectloader.js",
+  "module": "dist/objectloader.esm.js",
   "homepage": "https://speckle.systems",
-  "type": "module",
   "repository": {
     "type": "git",
     "url": "https://github.com/specklesystems/speckle-server.git",
     "directory": "packages/objectloader"
   },
+  "engines": {
+    "node": "^16.0.0"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint . --ext .js,.ts"
+    "lint": "eslint . --ext .js,.ts",
+    "build:dev": "rollup --config",
+    "build": "NODE_ENV=production rollup --config",
+    "dev": "rollup --config --watch",
+    "example": "EXAMPLE_BUILD=1 rollup --config && http-server ./examples/browser -p 3031 -o"
   },
   "keywords": [
     "speckle",
@@ -21,11 +27,24 @@
   ],
   "author": "AEC Systems",
   "license": "Apache-2.0",
+  "dependencies": {
+    "@babel/core": "^7.17.9",
+    "core-js": "^3.21.1",
+    "regenerator-runtime": "^0.13.7"
+  },
   "devDependencies": {
+    "@babel/preset-env": "^7.16.11",
+    "@rollup/plugin-babel": "^5.3.1",
+    "@rollup/plugin-commonjs": "^21.0.3",
+    "@rollup/plugin-node-resolve": "^13.1.3",
     "eslint": "^8.11.0",
     "eslint-config-prettier": "^8.5.0",
+    "http-server": "^14.1.0",
     "prettier": "^2.5.1",
+    "rollup": "^2.70.1",
+    "rollup-plugin-delete": "^2.0.0",
+    "rollup-plugin-terser": "^7.0.2",
     "undici": "^4.14.1"
   },
-  "gitHead": "9227228667897643190b839b1172349807e8ac65"
+  "gitHead": "5627e490f9a3ecadf19cc4686ad15f344d9ad2d3"
 }

package/readme.md

@@ -12,12 +12,18 @@ Comprehensive developer and user documentation can be found in our:
 
 This is a small utility class that helps you stream an object and all its sub-components from the Speckle Server API. It is intended to be used in contexts where you want to "download" the whole object, or iteratively traverse its whole tree.
 
+### Examples
+
+If you've got this repo checked out locally, you can run `npm run example` to run an example web page running ObjectLoader in the browser at 'http://127.0.0.1:3031/'. This will run the example HTML found under ./examples/browser/'.
+
+To test ObjectLoader in a node environment, just run `node ./examples/node/script.mjs`
+
 ### In the browser
 
 Here's a sample way on how to use it, pilfered from the [3d viewer package](../viewer):
 
 ```js
-
+import ObjectLoader from '@speckle/objectloader';
 
 async load( { serverUrl, token, streamId, objectId } ) {
 
@@ -40,34 +46,41 @@ async load( { serverUrl, token, streamId, objectId } ) {
 
 If you do not want to process the objects one by one as they are streamed to you, you can use the `getAndConstructObject()` method. Here's an example:
 
-````js
+```js
+import ObjectLoader from '@speckle/objectloader'
 
-let loader = new ObjectLoader( {
-  serverUrl: "https://latest.speckle.dev",
-  streamId: "3ed8357f29",
-  objectId: "0408ab9caaa2ebefb2dd7f1f671e7555",
+let loader = new ObjectLoader({
+  serverUrl: 'https://latest.speckle.dev',
+  streamId: '3ed8357f29',
+  objectId: '0408ab9caaa2ebefb2dd7f1f671e7555',
   options: {
     fullyTraverseArrays: false, // Default: false. By default, if an array starts with a primitive type, it will not be traversed. Set it to true if you want to capture scenarios in which lists can have intersped objects and primitives, e.g. [ 1, 2, "a", { important object } ]
-    excludeProps: [ 'displayValue', 'displayMesh', '__closure' ] // Default: []. Any prop names that you pass in here will be ignored from object construction traversal.
+    excludeProps: ['displayValue', 'displayMesh', '__closure'] // Default: []. Any prop names that you pass in here will be ignored from object construction traversal.
   }
-} )
+})
 
-let obj = await loader.getAndConstructObject( ( e ) => console.log( 'Progress', e ) )
+let obj = await loader.getAndConstructObject((e) => console.log('Progress', e))
+```
 
 ### On the server
 
 Since Node.js does not yet support the [`fetch API`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch), you'll need to provide your own `fetch` function in the options object. Note that `fetch` must return a [Web Stream](https://nodejs.org/api/webstreams.html), so [node-fetch](https://github.com/node-fetch/node-fetch) won't work, but [node/undici's](https://undici.nodejs.org/) implementation will.
 
 ```js
+import ObjectLoader from '@speckle/objectloader'
 import { fetch } from 'undici'
 
 let loader = new ObjectLoader({
   serverUrl: 'https://latest.speckle.dev',
   streamId: '3ed8357f29',
   objectId: '0408ab9caaa2ebefb2dd7f1f671e7555',
-  options: { enableCaching: false, excludeProps: [], fetch },
+  options: { enableCaching: false, excludeProps: [], fetch }
 })
-````
+```
+
+## Development
+
+Run `npm run build` to build prod release, run `npm run build:dev` to build dev release. Or run `npm run dev` to run the build in `watch` mode.
 
 ## Community
 

package/rollup.config.js

@@ -0,0 +1,66 @@
+import commonjs from '@rollup/plugin-commonjs'
+import nodeResolve from '@rollup/plugin-node-resolve'
+import { terser } from 'rollup-plugin-terser'
+import { babel } from '@rollup/plugin-babel'
+import clean from 'rollup-plugin-delete'
+import pkg from './package.json'
+
+const isProd = process.env.NODE_ENV === 'production'
+const isExample = !!process.env.EXAMPLE_BUILD
+
+const sourcemap = isProd ? false : 'inline'
+
+/**
+ * Build config
+ * @param {boolean} isWebBuild If set to true will generate a web-ready config with everything bundled into a single file
+ * @returns {import('rollup').RollupOptions}
+ */
+function buildConfig(isWebBuild = false) {
+  /** @type {import('rollup').RollupOptions} */
+  const config = {
+    input: 'src/index.js',
+    output: [
+      {
+        file: isWebBuild
+          ? 'examples/browser/objectloader.web.js'
+          : 'dist/objectloader.esm.js',
+        format: 'esm',
+        sourcemap,
+        exports: 'default'
+      },
+      ...(isWebBuild
+        ? []
+        : [
+            {
+              file: 'dist/objectloader.js',
+              format: 'cjs',
+              sourcemap,
+              exports: 'default'
+            }
+          ])
+    ],
+    plugins: [
+      ...(isWebBuild
+        ? [
+            // Bundling in all deps in web build
+            commonjs(),
+            nodeResolve()
+          ]
+        : [
+            // Cleaning dir only inside 'dist'
+            clean({ targets: 'dist/*' })
+          ]),
+      babel({ babelHelpers: 'bundled' }),
+      ...(isProd ? [terser()] : [])
+    ],
+    external: isWebBuild
+      ? undefined
+      : // In non web build we don't want to bundle in any deps
+        Object.keys(pkg.dependencies || {}).map((d) => new RegExp(`^${d}(\\/.*)?$`))
+  }
+
+  return config
+}
+
+const config = isExample ? buildConfig(true) : buildConfig()
+export default config

package/{index.js → src/index.js}

@@ -1,3 +1,7 @@
+// POLYFILLS
+import 'core-js'
+import 'regenerator-runtime/runtime'
+
 /**
  * Simple client that streams object info from a Speckle Server.
  * TODO: Object construction progress reporting is weird.