telos-server 1.0.9 → 1.0.11

package/README.md

@@ -9,15 +9,16 @@ which operates on a declarative file system based CMS.
 
 ## 2 - Contents
 
-### 2.1 - Content
+### 2.1 - Telos Folder
 
-The Telos Server shall source its content and endpoints from a folder on disk, which by default
-shall be called "telos", and shall be stored in the same directory the server process runs from.
+Telos Server shall source its content and endpoints from a Telos folder, stored on disk, which by
+default shall be called "telos", and shall be stored in the same directory the server process runs
+from.
 
 File names in the telos folder shall have their names segmented into chunks by periods, with the
 first chunk specifying the name of the file, the last chunk specifying the extension, and each
 intermediate chunk specifying a property. If a property chunk contains a hyphen, the part preceding
-the hyphen shall specify the name of the property, and the part following the hypen shall specify
+the hyphen shall specify the name of the property, and the part following the hyphen shall specify
 the value of the property.
 
 Folder names may be split the same way, though in folders the final chunk will also be a property
@@ -57,15 +58,41 @@ blank response.
 
 If a file has the property "private", it shall be inaccessible from the client.
 
-##### 2.1.2.3 - Universal Preprocessor
+##### 2.1.2.3 - Task
+
+If a JS file has the property "task", it shall serve as a script in a persistent background
+process. It shall use Common JS to assign as the module exports a single function which, at regular
+intervals, shall be invoked by an event handler responsive to the Telos engine.
+
+##### 2.1.2.4 - Universal Preprocessor
 
 If a file has the property "pup", it will be processed by the
 [Universal Preprocessor](https://github.com/Telos-Project/Universal-Preprocessor) before being
 fetched.
 
-### 2.2 - Usage
+### 2.2 - Telos Engine
+
+The Telos engine is a background process embedded in an associated bus module, which is integrated
+into, but may be used independently of, Telos Server.
+
+The Telos engine, at regular intervals, calls the bus net of Telos Origin with the following
+object:
+
+    { tags: ["telos-engine"] }
+
+The Telos engine also stores a reference to the initialization call object of Telos Origin, which
+shall be returned from the Telos engine bus module query function if the following object is passed
+to it:
+
+    { tags: ["telos-configuration"] }
 
-#### 2.2.1 - Setup
+The default interval for the Telos engine is 60 times per second. This may be altered using a
+number assigned to the content.options.options.engineInterval field in the initialization call
+object of Telos Origin specifying how long in seconds to wait between each interval.
+
+### 2.3 - Usage
+
+#### 2.3.1 - Setup
 
 First, create a folder for your project. Within this folder, create your "telos" folder, and
 populate it with the content you intend to serve.
@@ -83,7 +110,30 @@ the following command before uploading your project:
 
     npx telos-origin -m wrap
 
-#### 2.2.2 - Configuration
+#### 2.3.2 - Configuration
+
+The default port can be reconfigured with a Telos Config utility with the desired port specified as
+a numerical field in the properties with the alias "port".
+
+#### 2.3.3 - Middleware
+
+Telos Server may be extended through middleware referenced in the Telos Origin APInt.
+
+The utilities which reference such middleware shall have the "type" property specified as
+"telos-server-middleware", and shall reference as their source a CommonJS module which exports an
+object with a "middleware" field containing a list of middleware functions.
+
+A middleware function shall take two arguments, the first being the HTTP request which invoked it
+it the form of an HTTP JSON object, and the second being a file metadata object specifying
+information about the file on disk which matches the request URI. Said metadata object shall have
+the fields "file", containing a string specifying the full file path, "meta", containing an object
+specifying the properties derived from the file path as shown in section 2.1.1, and "type",
+containing a string specifying the file type.
 
-The defualt port can be reconfigured with a Telos Config utility with the desired port specified as
-a numerical field in the properties with the alias "port".
+The function may return an HTTP JSON response object representing the response to be returned to
+the client. Additional fields may be added to the response object for certain behaviors. Ideally,
+only one middleware function should return a response for each request, but in the event that there
+are multiple responses, a "priority" field containing a number may be added to indicate how the
+response should be weighed relative to others. If the response is to return a filestream rather
+than a text response, the body of the response shall be set to the path to the streamed resource,
+and the response object shall have the field "file", containing a boolean value of true.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "telos-server",
-	"version": "1.0.9",
+	"version": "1.0.11",
 	"description": "An Extensible CMS Server for Telos Origin.",
 	"main": "telosServer.json",
 	"dependencies": {