msul-gis-middleware 0.0.2 → 0.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msul-gis-middleware",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "type": "module",
   "scripts": {
     "dev": "vite",
@@ -21,7 +21,7 @@
     "@arcgis/core": "^4.34.8",
     "@arcgis/map-components": "^4.34.9"
   },
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Apache-2.0",
   "contributors": [
       "Nathan Collins <coll372@msu.edu>",
       "Austin Deneau <ad@msu.edu>",

package/src/README.MD

@@ -0,0 +1,61 @@
+### GIS Middleware
+
+## Installation
+
+```bash
+npm install gis-middleware
+```
+## Usage
+* Import the middleware in your HTML file.
+
+```javascript
+
+<script src="/path/to/arcgis-middleware.iife.js"></script>
+```
+
+* Create an instance of the ArcGisMiddleware class.
+    The ArcGisMiddleware class expects ArcGIS portal url
+    and unique id for the webmap as parameters.
+
+```javascript
+const arcGisMiddleware = new ArcGisMiddleware(
+        'YOUR_GIS_PORTAL_URL',
+        'YOUR_MAP_ID'
+);
+```
+
+* Set the building id.
+
+```javascript
+arcGisMiddleware.setBuildingById('YOUR_BUILDING_ID');
+```
+
+* Set the floor id.
+
+```javascript
+arcGisMiddleware.setFloorById('YOUR_FLOOR_ID');
+```
+
+* Generate the HTML that displays the map.
+
+```javascript
+const result = arcGisMiddleware.generate().element;
+```
+
+The generated HTML returns a result object.
+The result object contains `element` key and
+an `errors` key. The `element` inside the result
+is either a DOM element representing the map
+or null. The `errors` key is a list of errors, if any,
+or empty.
+
+```javascript
+// Access the HTML using
+const element = result.element
+
+// Access the errors using
+const errors = result.errors
+
+// Append that DOM element to the page, for example, a div with the id of arcgis-result
+document.getElementById('arcgis-result').appendChild(element);
+```

package/vite.config.js

@@ -13,8 +13,7 @@ export default defineConfig({
       formats: ['iife']
     },
     rollupOptions: {
-      // Ensure @arcgis/core is NOT in the external list
-      external: [],
-    }
+      external: ['@arcgis/core', '@arcgis/map-components' ],
+    } 
   }
 });