@totemstan/debe NPM

DEBE

Extends the TOTEM web service to provide the following endpoints:

DATASET.TYPE ? QUERY
NOTEBOOK.TYPE ? QUERY
AREA/PATH/FILE.TYPE ? QUERY
COMMAND.TYPE ? QUERY

to access DATASETs, NOTEBOOKs, FILEs and COMMANDs per Totem's API and TOTEM's skinning guide.

Use TYPE to convert a DATASET:

db | xml | csv | txt | flat | kml | html | json

inspect a DATASET:

tree | schema | nav | delta | view | blog

render a NOTEBOOK:

view | run | plugin | pivot | site | spivot | brief | gridbrief | pivbrief | runbrief

probe a NOTEBOOK:

exe | tou | md | status | suitors | usage | reset | EVENTS

manage a NOTEBOOK:

import | export | publish | addkey | subkey

license a NOTEBOOK:

js | py | m | me | jade | ...

DEBE also provides the following service COMMANDs:

agent | alert | ingest | riddle | task | ping

to distribute jobs, alert clients, ingest data, validate sessions, spread tasks, and test connections, and provides several FILE areas:

stores | uploads | shares | west | east | jades

for supervised/unsupervised file sharing.

Manage

npm install @totemstan/debe		# install
npm run start [ ? | $ | ...]	# Unit test
npm run verminor				# Roll minor version
npm run vermajor				# Roll major version
npm run redoc					# Regen documentation

npm run	startdbs				# Start required database servers
npm run setprot					# Configure for protected mode
npm run setdebug				# Configure for debugging mode
npm run setoper					# Configure for operational mode
npm run setprod					# Configure for production mode

npm run genio						# Generate totem-man.github.io from jades/totemblog
npm run raster --in=src --out=tar	# Rasterize source url into a target file

Usage

Acquire, optionally configure and start a DEBE server:

require("debe").config({
	key: value, 						// set key
	"key.key": value, 					// indexed set
	"key.key.": value					// indexed append
}, sql => {
	console.log( sql ? "look mom - Im running!" : "something evil is lurking" );
});

where configuration keys follow ENUMS deep copy conventions.

Program Reference

String

String
- ~linkify(ref) ⇐ Array
- ~mailify()
- ~align()
- ~trimGoogle()

String~linkify(ref) ⇐ Array

Returns a ref-joined list of links

Kind: inner method of String
Extends: Array

Param	Type
ref	String

String~mailify()

Kind: inner method of String

String~align()

Kind: inner method of String

String~trimGoogle()

Kind: inner method of String

Array

Array

Array~gridify(noheader)

Creates an html table from an array.

Kind: inner method of Array

Param	Type	Description
noheader	Boolean	switch to enable header processing

Array~groupify(dot)

Groups each "x.y.z. ...." spec in the list.

Kind: inner method of Array

Param	Type	Description
dot	string	item seperator

Array~blog(keys, ds, cb)

Blogs each string in the list.

Kind: inner method of Array
See: totem:blogify

Param	Type	Description
keys	List	list of keys to blog
ds	String	Name of dataset being blogged
cb	function	callback(recs) blogified version of records

Array~merge(Recs, idx)

Merge changes when doing table deltas from their baseline versions.

Kind: inner method of Array

Param	Type	Description
Recs	Array	Source records to merge into this records
idx	String	Key name to use for detecting record changes

Array~schemaify(src)

Returns a schema of the array using the specified src path.

Kind: inner method of Array

Param	Type	Description
src	String	path to source

Array~treeify(idx, kids, level, keys, wt)

Returns a tree = {name,weight,nodes} from records having been sorted on keys=key,...

Kind: inner method of Array

Param	Type	Description
idx	Number	starting index (0 on first call)
kids	Number	number of leafs following starting index (this.length on first call)
level	Number	current depth (0 on first call)
keys	Array	pivot keys
wt	String	key name that contains leaf weight (defaults to "size")

Array~joinify(cb)

Joins a list with an optional callback cb(head,list) to join the current list with the current head.

Kind: inner method of Array

Param	Type
cb	function

Example

[	a: null,
		g1: [ b: null, c: null, g2: [ x: null ] ],
		g3: [ y: null ] ].joinify()

returning a string
	"a,g1(b,c,g2(x)),g3(y)"

Data

DEBE

Provides UI interfaces to the barebone TOTEM web service to support notebooks and other entities. This module documented in accordance with jsdoc.

Env Dependencies

HOSTNAME = name of host machine
REPO = http://DOMAIN:ACCOUNT
JIRA = http://DOMAIN
RAS = http://DOMAIN
BY = https://DOMAIN

Requires: module:totem, module:atomic, module:geohack, module:man, module:randpr, module:enums, module:reader, module:skin, module:blog, module:dogs, module:pipe, module:crypto, module:child_process, module:fs, module:stream, module:cluster, module:repl, module:i18n-abide, module:optimist, module:tokml, module:officegen
Author: ACMESDS
Example

// npm test D2
// Start challenge-protected server with additional byTable-routed entpoints.

config({
	riddles: 10,
	"byTable.": {
		wfs: function (req,res) {
			res("here i go again");

			Fetch(ENV.WFS_TEST, data => {
				Trace(data);
			});
		}
	}
}, sql => {
	Trace( "This bad boy in an encrypted service with a database and has an /wfs endpoint" );
});

Example

// npm test D3
// Start server using default config

config({
}, sql => {
	Trace( "Stateful network flow manger started" );
});

Example

// npm test D4
// Start server and prep file system

function readFile(sql, path, cb) {
	sql.beginBulk();
	readers.xls( "./config.stores/test.xls", rec => { 
		if (rec) 
			cb(rec,sql);

		else 
			sql.endBulk();
	});
}

config({
}, sql => {
	var recs = 0, now = new Date();
	readFile( sql, "./config.stores/test.xls", (rec,sql) => {
		if ( ++recs<5 ) {
			var 
				doc = (rec.doc || rec.Doc || rec.report || rec.Report || "")
						.replace( /\n/g, " ")
						.replace( /\&\#10;/g, " "),

				docs = doc				
						.match( /(.*)TEXT:(.*)COMMENTS:(.*)/ ) || [ "", "", doc, ""],

				text = "";

			docs[2].replace( /\.  /g, "\n").replace( /^[0-9 ]*\. \(.*\) (.*)/gm, (str,txt) => text += txt + ".  " );

			sql.query("INSERT INTO openv.docs SET ?", {
				Reported: rec.reported || rec.Reported || now,
				Name: rec.reportID || ("tbd-"+recs),
				Pipe: JSON.stringify( text )
			}, err => Trace("add", err) );
		}
	});
});

DEBE

DEBE~$libs

Kind: inner property of DEBE

~$libs

$libs.$site

Kind: static property of $libs

$libs.$notebooks

Kind: static property of $libs

$libs.$

See man

Kind: static property of $libs

$libs.$log

See debe

Kind: static property of $libs

$libs.$task

See debe

Kind: static property of $libs

$libs.$sql

See jsdb

Kind: static property of $libs

$libs.$neo

See jsdb

Kind: static property of $libs

$libs.$copy

See enums

Kind: static property of $libs

$libs.$each

See enums

Kind: static property of $libs

$libs.$fetch()

Kind: static method of $libs

$libs.$get()

Kind: static method of $libs

$libs.$help()

Kind: static method of $libs

DEBE~tableRoutes.

Route table to a database according to security requirements.

Kind: inner property of DEBE

DEBE~defaultDocs

Default doc for reserved notebook keys

Kind: inner property of DEBE

DEBE~licenseOnDownload

Kind: inner property of DEBE

DEBE~filters.

Filter dataset recs on specifed req-res thread

Kind: inner property of DEBE

~filters.

filters..xdoc

Kind: static property of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..xxls

Kind: static property of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..xpps

Kind: static property of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..xppt

Kind: static property of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..dbx(recs, req, res)

Kind: static method of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..db(recs, req, res)

Kind: static method of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..kml(recs, req, res)

Kind: static method of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..flat(recs, req, res)

Kind: static method of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..txt(recs, req, res)

Kind: static method of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..html(recs, req, res)

Kind: static method of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..tree(recs, req, res)

Kind: static method of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

filters..schema(recs, req, res)

Kind: static method of filters.

Param	Type	Description
recs	Array	Records to filter
req	Object	Totem session request
res	function	Totem session response

DEBE~byArea.

/AREA/FILE-endpoint routers

Kind: inner property of DEBE

byArea..root(req, res)

Default area navigator.

Kind: static method of byArea.

Param	Type	Description
req	Object	Totem session request
res	function	Totem session response

DEBE~byTable.

/TABLE-endpoint routers

Kind: inner property of DEBE

~byTable.

byTable..uploads

Upload files to upload area

Kind: static property of byTable.

Param	Type	Description
req	Object	Totem session request
res	function	Totem session response

byTable..stores

Upload files to stores area

Kind: static property of byTable.

Param	Type	Description
req	Object	Totem session request
res	function	Totem session response