Merge pull request #14 from kethinov/1.0.3

1.0.3

Author: kethinov

CHANGELOG.md

@@ -4,6 +4,12 @@
 
 - Put your changes here...
 
+## 1.0.3
+
+- Fixed missing exports so you can require/import Single Page Express less verbosely in your projects.
+- Updated docs to clarify what the different builds of Single Page Express are meant to be used for.
+- Updated dependencies.
+
 ## 1.0.2
 
 - Fixed bug causing custom `res` variables to not be set properly during certain default render method calls.

README.md

@@ -32,11 +32,11 @@ First, install `single-page-express` from npm.
 
 The package is distributed with the following builds available:
 
-- `dist/single-page-express.cjs`: CommonJS bundle.
+- `dist/single-page-express.cjs`: CommonJS bundle: `const singlePageExpress = require('single-page-express')`
 - `dist/single-page-express.js`: Standalone bundle that can be included via `<script>` tags.
 - `dist/single-page-express.min.js`: Minified standalone bundle that can be included via `<script>` tags.
-- `dist/single-page-express.mjs`: ES module.
-- `dist/single-page-express.min.mjs`: Minified ES module.
+- `dist/single-page-express.mjs`: ES module: `import singlePageExpress from 'single-page-express'`
+- `dist/single-page-express.min.mjs`: Minified ES module: `import singlePageExpress from 'single-page-express/min'`
 
 Then, in your frontend code:
 
@@ -54,12 +54,12 @@ Once those variables are defined, you can call the `single-page-express` constru
 Below is an example using Teddy for templating and defining two simple templates.
 
 ```javascript
-const templatingEngine = require('./node_modules/teddy/dist/teddy.client.cjs')
+const templatingEngine = require('teddy/client')
 const templates = {
   index: '<p>hello world</p>',
   secondPage: '<p>this page has a {variable} in it</p>'
 }
-const app = require('./node_modules/single-page-express/dist/single-page-express.cjs')({
+const app = require('single-page-express')({
   templatingEngine,
   templates
 })
@@ -148,7 +148,7 @@ There are 3 sample apps you can run to see demos of how `single-page-express` ca
 3. Express-based sample app:
    - This is a full Express app that demos sharing routes and templates on the backend and frontend.
    - To run it:
-     - `cd sampleApps/express` 
+     - `cd sampleApps/express`
      - `npm ci`
      - `cd ../../`
      - `npm run express-sample`

package-lock.json

@@ -8,10 +8,19 @@
       "url": "https://github.com/rooseveltframework/single-page-express/graphs/contributors"
     }
   ],
-  "version": "1.0.2",
+  "version": "1.0.3",
   "files": [
     "dist"
   ],
+  "exports": {
+    ".": {
+      "import": "./dist/single-page-express.mjs",
+      "require": "./dist/single-page-express.cjs"
+    },
+    "./min": {
+      "default": "./dist/single-page-express.min.mjs"
+    }
+  },
   "homepage": "https://github.com/rooseveltframework/single-page-express",
   "license": "CC-BY-4.0",
   "main": "single-page-express.js",
@@ -31,7 +40,7 @@
     "express": "4.21.2",
     "mocha": "11.1.0",
     "standard": "17.1.2",
-    "teddy": "0.6.20",
+    "teddy": "0.6.21",
     "webpack": "5.97.1",
     "webpack-cli": "6.0.1"
   },

package.json

@@ -1,5 +1,5 @@
 const singlePageExpress = require('../../single-page-express') // use require('./node_modules/single-page-express/dist/single-page-express.cjs') in your app
-const teddy = require('./node_modules/teddy/dist/teddy.client.cjs')
+const teddy = require('teddy/client')
 
 // start single-page-express
 const app = singlePageExpress({

sampleApps/express/browser.js

@@ -4,7 +4,7 @@
   "dependencies": {
     "express": "4.21.2",
     "module-alias": "2.2.3",
-    "teddy": "0.6.20",
+    "teddy": "0.6.21",
     "webpack": "5.97.1"
   },
   "_moduleAliases": {