meadow-endpoints 3.0.7 → 4.0.2

package/source/crud/Meadow-StreamRecordArray.js

@@ -1,45 +0,0 @@
-/**
-* Meadow Endpoint Marshaller - Stream an array of recods as JSON to an output stream.
-*
-* If the array is small enough, we just call send() for simplicity.
-*
-* @license MIT
-*
-* @author Alex Decker <alex.decker@headlight.com>
-* @module Meadow
-*/
-
-const libAsync = require('async');
-const JSONStream = require('JSONStream');
-const libUnderscore = require('underscore');
-
-module.exports = (pResponse, pRecords, fCallback) =>
-{
-	// for meadow invoke, writeHead isn't provided, so just call send(), which is the shim it uses...
-	// also, for small arrays, don't bother with the async serialization; this threshold could use tuning
-	if (!pResponse.writeHead || !Array.isArray(pRecords) || pRecords.length < 2500)
-	{
-		pResponse.send(pRecords);
-		return fCallback();
-	}
-
-	pResponse.writeHead(200,
-	{
-		'content-type': 'application/json',
-	});
-
-	const recordJsonMarshaller = JSONStream.stringify();
-	recordJsonMarshaller.pipe(pResponse);
-
-	// we write the records in chunks; doing one per loop is very inefficient, doing all is the same as not doing this at all
-	libAsync.eachSeries(libUnderscore.chunk(pRecords, 1000), (pRecordChunk, fNext) =>
-	{
-		pRecordChunk.forEach(recordJsonMarshaller.write);
-		setImmediate(fNext);
-	},
-	(error) =>
-	{
-		recordJsonMarshaller.end();
-		fCallback(error);
-	});
-};

package/source/schema/Meadow-Endpoint-New.js

@@ -1,37 +0,0 @@
-/**
-* Meadow Endpoint - New Record
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Create a new record using the Meadow DAL object
-*/
-var doAPINewEndpoint = function(pRequest, pResponse, fNext)
-{
-	// This state is the requirement for the UserRoleIndex value in the UserSession object... processed by default as >=
-	// The default here is that any authenticated user can use this endpoint.
-	pRequest.EndpointAuthorizationRequirement = pRequest.EndpointAuthorizationLevels.New;
-	
-	// INJECT: Pre authorization (for instance to change the authorization level)
-
-	if (pRequest.CommonServices.authorizeEndpoint(pRequest, pResponse, fNext) === false)
-	{
-		// If this endpoint fails, it's sent an error automatically.
-		return;
-	}
-
-	// INJECT: Pre endpoint operation
-
-	var tmpEmptyObject = pRequest.DAL.schemaFull.defaultObject;
-
-	// INJECT: After the empty object is grabbed, let the user alter it
-
-	pRequest.CommonServices.log.info('Delivered new '+pRequest.DAL.scope, {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-New'}, pRequest);
-	pResponse.send(tmpEmptyObject);
-	return fNext();
-};
-
-module.exports = doAPINewEndpoint;

package/source/schema/Meadow-Endpoint-Schema.js

@@ -1,37 +0,0 @@
-/**
-* Meadow Endpoint - Get the Record Schema
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Get the JSONSchema for a particular scope
-*/
-var doAPISchemaEndpoint = function(pRequest, pResponse, fNext)
-{
-	// This state is the requirement for the UserRoleIndex value in the UserSession object... processed by default as >=
-	// The default here is that any authenticated user can use this endpoint.
-	pRequest.EndpointAuthorizationRequirement = pRequest.EndpointAuthorizationLevels.Schema;
-	
-	// INJECT: Pre authorization (for instance to change the authorization level)
-
-	if (pRequest.CommonServices.authorizeEndpoint(pRequest, pResponse, fNext) === false)
-	{
-		// If this endpoint fails, it's sent an error automatically.
-		return;
-	}
-
-	// INJECT: Pre endpoint operation
-
-	var tmpSchema = pRequest.DAL.jsonSchema;
-
-	// INJECT: After the schema is grabbed, let the user alter it
-
-	pRequest.CommonServices.log.info('Delivered a JSON schema for '+pRequest.DAL.scope, {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-Schema'}, pRequest);
-	pResponse.send(tmpSchema);
-	return fNext();
-};
-
-module.exports = doAPISchemaEndpoint;

package/source/schema/Meadow-Endpoint-Validate.js

@@ -1,43 +0,0 @@
-/**
-* Meadow Endpoint - Validate a Record
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Validate a record using the Meadow DAL object
-*/
-var doAPIValidateEndpoint = function(pRequest, pResponse, fNext)
-{
-	// This state is the requirement for the UserRoleIndex value in the UserSession object... processed by default as >=
-	// The default here is that any authenticated user can use this endpoint.
-	pRequest.EndpointAuthorizationRequirement = pRequest.EndpointAuthorizationLevels.New;
-	
-	// INJECT: Pre authorization (for instance to change the authorization level)
-	
-	if (pRequest.CommonServices.authorizeEndpoint(pRequest, pResponse, fNext) === false)
-	{
-		// If this endpoint fails, it's sent an error automatically.
-		return;
-	}
-
-	if (typeof(pRequest.body) !== 'object')
-	{
-		return pRequest.CommonServices.sendError('Record validate failure - a valid JSON object is required.', pRequest, pResponse, fNext);
-	}
-	var tmpRecord = pRequest.body;
-
-	// INJECT: Pre endpoint operation
-
-	var tmpValid = pRequest.DAL.schemaFull.validateObject(tmpRecord);
-
-	// INJECT: After the record is validated, let the API user alter the resultant
-
-	pRequest.CommonServices.log.info('Delivered validation for '+pRequest.DAL.scope+': '+tmpValid, {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-Validate'}, pRequest);
-	pResponse.send(tmpValid);
-	return fNext();
-};
-
-module.exports = doAPIValidateEndpoint;

package/test/Animal.json

@@ -1,140 +0,0 @@
-{
-	"Scope": "FableTest",
-
-	"DefaultIdentifier": "IDAnimal",
-
-	"Schema": [
-		{ "Column": "IDAnimal",        "Type":"AutoIdentity" },
-		{ "Column": "GUIDAnimal",      "Type":"AutoGUID" },
-		{ "Column": "CreateDate",      "Type":"CreateDate" },
-		{ "Column": "CreatingIDUser",  "Type":"CreateIDUser" },
-		{ "Column": "UpdateDate",      "Type":"UpdateDate" },
-		{ "Column": "UpdatingIDUser",  "Type":"UpdateIDUser" },
-		{ "Column": "Deleted",         "Type":"Deleted" },
-		{ "Column": "DeletingIDUser",  "Type":"DeleteIDUser" },
-		{ "Column": "DeleteDate",      "Type":"DeleteDate" },
-		{ "Column": "Name",  "Type":"String" },
-		{ "Column": "Type",  "Type":"String" },
-        { "Column": "IDCustomer",  "Type":"Number" }
-	],
-
-	"DefaultObject": {
-		"IDAnimal": null,
-		"GUIDAnimal": "",
-
-		"CreateDate": false,
-		"CreatingIDUser": 0,
-		"UpdateDate": false,
-		"UpdatingIDUser": 0,
-		"Deleted": 0,
-		"DeleteDate": false,
-		"DeletingIDUser": 0,
-
-		"Name": "Unknown",
-		"Type": "Unclassified",
-        "IDCustomer": 0
-	},
-
-	"JsonSchema": {
-		"title": "Animal",
-		"description": "A creature that lives in a meadow.",
-		"type": "object",
-		"properties": {
-			"IDAnimal": {
-				"description": "The unique identifier for an animal",
-				"type": "integer"
-			},
-			"Name": {
-				"description": "The animal's name",
-				"type": "string"
-			},
-			"Type": {
-				"description": "The type of the animal",
-				"type": "string"
-			},
-            "IDCustomer": {
-				"description": "The customer ID of the record",
-				"type": "number"
-			}
-		},
-		"required": ["IDAnimal", "Name", "CreatingIDUser"]
-	},
-
-	"Authorization": {
-        "__DefaultAPISecurity": {
-            "Create": "Deny",
-            "Read": "Deny",
-            "Reads": "Deny",
-            "ReadsBy": "Deny",
-            "ReadMax": "Deny",
-            "ReadSelectList": "Deny",
-            "Update": "Deny",
-            "Delete": "Deny",
-            "Count": "Deny",
-            "CountBy": "Deny",
-            "Schema": "Deny",
-            "Validate": "Deny",
-            "New": "Deny"
-        },
-        "Unauthenticated": {
-            "Create": "Deny",
-            "Read": "Allow",
-            "Reads": "Allow",
-            "ReadsBy": "Allow",
-            "ReadMax": "Allow",
-            "ReadSelectList": "Allow",
-            "Update": "Allow",
-            "Delete": "Allow",
-            "Count": "Allow",
-            "CountBy": "Allow",
-            "Schema": "Allow",
-            "Validate": "Allow",
-            "New": "Allow"
-        },
-        "Readonly": {
-            "Create": "Deny",
-            "Read": "Allow",
-            "Reads": "Allow",
-            "ReadsBy": "Allow",
-            "ReadMax": "Allow",
-            "ReadSelectList": "Allow",
-            "Update": "Deny",
-            "Delete": "Deny",
-            "Count": "Allow",
-            "CountBy": "Allow",
-            "Schema": "Allow",
-            "Validate": "Allow",
-            "New": "Deny"
-        },
-        "User": {
-            "Create": "Allow",
-            "Read": "Allow",
-            "Reads": "Allow",
-            "ReadsBy": "Allow",
-            "ReadMax": "Allow",
-            "ReadSelectList": "Allow",
-            "Update": "Allow",
-            "Delete": "Allow",
-            "Count": "Allow",
-            "CountBy": "Allow",
-            "Schema": "Allow",
-            "Validate": "Allow",
-            "New": "Allow"
-        },
-        "Manager": {
-            "Create": "Allow",
-            "Read": "Allow",
-            "Reads": "Allow",
-            "ReadsBy": "Allow",
-            "ReadMax": "Allow",
-            "ReadSelectList": "Allow",
-            "Update": "Allow",
-            "Delete": "Allow",
-            "Count": "Allow",
-            "CountBy": "Allow",
-            "Schema": "Allow",
-            "Validate": "Allow",
-            "New": "Allow"
-        }
-    }
-}