OSS Diff

.npmignore

@@ -0,0 +1,30 @@
+# Documentation
+docs/
+*.md
+!README.md
+CODEOWNERS
+
+# Test and mock files
+__tests__/
+__mocks__/
+**/__tests__/
+**/__mocks__/
+coverage/
+jest.config.js
+
+# Backup folders / artifacts
+backups/
+*.backup
+*.bak
+*.swp
+*.tgz
+
+# Local configuration files
+.env
+.env.*
+config.local.js
+*.local.js
+
+# Tooling and CI
+.github/
+.claude/

README.md

@@ -26,6 +26,27 @@ Stores important bits of knowledge in structured JSON-LD objects:
 1. **Open and Free**—expose all contributions immediately without charge to write or read;
 1. **Attributed and Versioned**—always include asserted ownership and transaction metadata so consumers can evaluate trustworthiness and relevance.
 
+### Programmatic usage
+This project exposes a single public entry point at the package root (`index.js`).  Only a few
+functions are exported – everything else lives in internal modules and is intentionally
+kept private.  Example:
+
+```js
+import { app, createServer, start } from 'rerum_server'
+
+// `app` is the configured Express application; you can pass it to Supertest or reuse it
+// inside another HTTP stack.
+
+const server = createServer(8080)   // returns a http.Server but does not listen
+server.listen()
+
+// or simply
+start(8080) // convenience helper that both creates and listens
+```
+
+Consumers no longer need to reach into `./app.js` or other deep paths – if it isn't
+exported here it isn't part of the stable API.
+
 ## What we add
 You will find a `__rerum` property on anything you read from this repository. This is written onto
 all objects by the server and is not editable by the client applications. While applications may assert

__tests__/public_api.test.js

@@ -0,0 +1,22 @@
+import { app, createServer, start } from '../index.js'
+
+describe('public API entry point', () => {
+  test('exports an express app instance', () => {
+    expect(app).toBeDefined()
+    expect(typeof app.use).toBe('function') // express app
+  })
+
+  test('createServer returns a http.Server', () => {
+    const server = createServer(0) // port 0 for ephemeral
+    expect(server).toBeDefined()
+    expect(typeof server.listen).toBe('function')
+    server.close()
+  })
+
+  test('start starts the server and returns it', (done) => {
+    const server = start(0)
+    server.on('listening', () => {
+      server.close(() => done())
+    })
+  })
+})

__tests__/routes_mounted.test.js

@@ -7,7 +7,8 @@
 
 import request from "supertest"
 import api_routes from "../routes/api-routes.js"
-import app from "../app.js"
+// leverage the public entry point instead of a deep path
+import app from "../index.js"
 import fs from "fs"
 
 let app_stack = app.router.stack

app.js

@@ -3,8 +3,7 @@
 import express from 'express'
 import path from 'path'
 import cookieParser from 'cookie-parser'
-import dotenv from 'dotenv'
-dotenv.config()
+import config from './config/index.js'
 import logger from 'morgan'
 import cors from 'cors'
 import indexRouter from './routes/index.js'
@@ -71,7 +70,7 @@ app.use(express.static(path.join(__dirname, 'public')))
  * This is without middleware
  */
 app.all('*_', (req, res, next) => {
-  if(process.env.DOWN === "true"){
+  if(config.DOWN === "true"){
       res.status(503).json({"message":"RERUM v1 is down for updates or maintenance at this time.  We apologize for the inconvenience.  Try again later."})
   }
   else{