meadow-endpoints 3.0.7 → 4.0.3

package/source/crud/Meadow-Endpoint-Undelete.js

@@ -1,161 +0,0 @@
-/**
-* Meadow Endpoint - Undelete a Record
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Undelete a record using the Meadow DAL object
-*/
-
-var libAsync = require('async');
-
-
-var doAPIUndeleteEndpoint = 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.Undelete;
-
-	// 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 tmpIDRecord = 0;
-	if (typeof(pRequest.params.IDRecord) === 'string')
-	{
-		tmpIDRecord = pRequest.params.IDRecord;
-	}
-	else if (typeof(pRequest.body[pRequest.DAL.defaultIdentifier]) === 'number')
-	{
-		tmpIDRecord = pRequest.body[pRequest.DAL.defaultIdentifier];
-	}
-	else if (typeof(pRequest.body[pRequest.DAL.defaultIdentifier]) === 'string')
-	{
-		tmpIDRecord = pRequest.body[pRequest.DAL.defaultIdentifier];
-	}
-	// Although the undelete request does allow multiple undeletes, we require an identifier.
-	// TODO: Decide if we want to keep this pattern similar to Delete, or, if we want to change it to allow bulk undeletes.
-	if (tmpIDRecord < 1)
-	{
-		return pRequest.CommonServices.sendError('Record undelete failure - a valid record ID is required in the passed-in record.', pRequest, pResponse, fNext);
-	}
-
-	var tmpRecordCount = {};
-	var tmpQuery;
-
-	libAsync.waterfall(
-		[
-			function(fStageComplete)
-			{
-				tmpQuery = pRequest.DAL.query;
-
-				// INJECT: Query configuration and population
-				var tmpSchema = pRequest.DAL.schema;
-				var tmpHasDeletedBit = false;
-				for (let i = 0; i < tmpSchema.length; i++)
-				{
-					if (tmpSchema[i].Type == 'Deleted')
-					{
-						// There is a deleted bit on the record!
-						tmpHasDeletedBit = true;
-					}
-				}
-
-				if (!tmpHasDeletedBit)
-				{
-					return fStageComplete("NO_DELETED_BIT");
-				}
-
-
-				return fStageComplete();
-			},
-			function(fStageComplete)
-			{
-				// Now see if the record, with this identifier, for this user, has the deleted bit set to 1
-				tmpQuery.addFilter(pRequest.DAL.defaultIdentifier, tmpIDRecord);
-				tmpQuery.addFilter('Deleted', 1);
-				tmpQuery.setIDUser(pRequest.UserSession.UserID);
-
-				return fStageComplete();
-			},
-			function(fStageComplete)
-			{
-				// Load the record so we can do security checks on it
-				pRequest.DAL.doRead(tmpQuery,
-					function(pError, pQuery, pRecord)
-					{
-						if (!pRecord)
-						{
-							tmpRecordCount = {Count:0};
-							return fStageComplete("NO_UNDELETABLE_RECORD_FOUND");
-						}
-
-						pRequest.Record = pRecord;
-
-						return fStageComplete();
-					});
-			},
-			function(fStageComplete)
-			{
-				pRequest.Authorizers.authorizeRequest('Undelete', pRequest, fStageComplete);
-			},
-			function(fStageComplete)
-			{
-				// INJECT: Once we've check the authorizer and are ready to Undelete, invoke an injected behavior before we execute the actuall delete operation
-				return pRequest.BehaviorModifications.runBehavior('Undelete-PreOperation', pRequest, fStageComplete);
-			},
-			function(fStageComplete)
-			{
-				// INJECT: Record modification before delete
-
-				if (pRequest.MeadowAuthorization)
-				{
-					return fStageComplete(false);
-				}
-
-				// It looks like this record was not authorized.  Send an error.
-				return fStageComplete({Code:405,Message:'UNAUTHORIZED ACCESS IS NOT ALLOWED'});
-			},
-			function(fStageComplete)
-			{
-				// Do the delete
-				pRequest.DAL.doUndelete(tmpQuery,
-					function(pError, pQuery, pCount)
-					{
-						// It returns the number of rows deleted
-						tmpRecordCount = {Count:pCount};
-
-						return fStageComplete(pError);
-					});
-			},
-			function(fStageComplete)
-			{
-				// INJECT: After the delete count is grabbed, let the user alter the response content
-				return pRequest.BehaviorModifications.runBehavior('Undelete-PostOperation', pRequest, fStageComplete);
-			}
-		], function(pError)
-		{
-			if (pError &&
-				pError !== "NO_RECORD_FOUND")
-			{
-				return pRequest.CommonServices.sendCodedError('Error undeleting a record.', pError, pRequest, pResponse, fNext);
-			}
-
-			pRequest.CommonServices.log.info('Undeleted '+tmpRecordCount.Count+' records with ID '+tmpIDRecord+'.', {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-Undelete'}, pRequest);
-			pResponse.send(tmpRecordCount);
-
-			return fNext();
-		}
-	);
-};
-
-module.exports = doAPIUndeleteEndpoint;

package/source/crud/Meadow-Endpoint-Update.js

@@ -1,80 +0,0 @@
-/**
-* Meadow Endpoint - Update a Record
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Update a record using the Meadow DAL object
-*/
-
-var libAsync = require('async');
-
-var doUpdate = require('./Meadow-Operation-Update.js');
-
-var doAPIUpdateEndpoint = 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.Update;
-
-	// 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;
-	}
-
-	// Configure the request for the generic update operation
-	pRequest.UpdatedRecords = [];
-	pRequest.MeadowOperation = 'Update';
-
-	libAsync.waterfall(
-		[
-			function(fStageComplete)
-			{
-				//1. Validate request body to ensure it is a valid record
-				if (typeof(pRequest.body) !== 'object')
-				{
-					return pRequest.CommonServices.sendError('Record update failure - a valid record is required.', pRequest, pResponse, fNext);
-				}
-				if (pRequest.body[pRequest.DAL.defaultIdentifier] < 1)
-				{
-					return pRequest.CommonServices.sendError('Record update failure - a valid record ID is required in the passed-in record.', pRequest, pResponse, fNext);
-				}
-
-				pRequest.Record = pRequest.body;
-
-				return fStageComplete(null);
-			},
-			function(fStageComplete)
-			{
-				//4. Do the update operation
-				doUpdate(pRequest.body, pRequest, pResponse, fStageComplete);
-			},
-			function(fStageComplete)
-			{
-				//5. Respond with the new record
-
-				// If there was an error, respond with that instead
-				if (pRequest.RecordUpdateError)
-					return fStageComplete(pRequest.RecordUpdateErrorMessage);
-
-				pResponse.send(pRequest.Record);
-				return fStageComplete(null);
-			}
-		], function(pError)
-		{
-			if (pError)
-			{
-				return pRequest.CommonServices.sendCodedError('Error updating a record.', pError, pRequest, pResponse, fNext);
-			}
-
-			return fNext();
-		});
-};
-
-module.exports = doAPIUpdateEndpoint;

package/source/crud/Meadow-Endpoint-Upsert.js

@@ -1,78 +0,0 @@
-/**
-* Meadow Endpoint - Upsert (Insert OR Update) a Record
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Upsert a record using the Meadow DAL object
-*/
-
-var libAsync = require('async');
-
-var doUpsert = require('./Meadow-Operation-Upsert.js');
-
-var doAPIUpsertEndpoint = 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.Update;
-
-	// 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;
-	}
-
-	// Configure the request for the generic create & update operations
-	pRequest.CreatedRecords = [];
-	pRequest.UpdatedRecords = [];
-	pRequest.UpsertedRecords = [];
-	pRequest.MeadowOperation = 'Upsert';
-
-	libAsync.waterfall(
-		[
-			function(fStageComplete)
-			{
-				//1. Validate request body to ensure it is a valid record
-				if (typeof(pRequest.body) !== 'object')
-				{
-					return pRequest.CommonServices.sendError('Record upsert failure - a valid record is required.', pRequest, pResponse, fNext);
-				}
-
-				pRequest.Record = pRequest.body;
-
-				return fStageComplete(null);
-			},
-			function(fStageComplete)
-			{
-				//4. Do the upsert operation
-				doUpsert(pRequest.body, pRequest, pResponse, fStageComplete);
-			},
-			function(fStageComplete)
-			{
-				//5. Respond with the new record
-
-				// If there was an error, respond with that instead
-				if (pRequest.RecordUpsertError)
-					return fStageComplete(pRequest.RecordUpsertErrorMessage);
-
-				pResponse.send(pRequest.Record);
-				return fStageComplete(null);
-			}
-		], function(pError)
-		{
-			if (pError)
-			{
-				return pRequest.CommonServices.sendCodedError('Error upserting a record.', pError, pRequest, pResponse, fNext);
-			}
-
-			return fNext();
-		});
-};
-
-module.exports = doAPIUpsertEndpoint;

package/source/crud/Meadow-Operation-Create.js

@@ -1,105 +0,0 @@
-/**
-* Meadow Operation - Create a record function
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Shared record create code
-*/
-var libAsync = require('async');
-
-var doCreate = function(pRecord, pRequest, pResponse, fCallback)
-{
-	pRequest.MeadowOperation = (typeof(pRequest.MeadowOperation) === 'string') ? pRequest.MeadowOperation : 'Create';
-
-	libAsync.waterfall(
-		[
-			function(fStageComplete)
-			{
-				// Do this for compatibility with injected behaviors
-				pRequest.Record = pRecord;
-
-				//Make sure record gets created with a customerID
-				if (!pRequest.Record.hasOwnProperty('IDCustomer') &&
-					pRequest.DAL.jsonSchema.properties.hasOwnProperty('IDCustomer'))
-				{
-					pRequest.Record.IDCustomer = pRequest.UserSession.CustomerID || 0;
-				}
-
-				pRequest.BehaviorModifications.runBehavior('Create-PreOperation', pRequest, fStageComplete);
-			},
-			function(fStageComplete)
-			{
-				pRequest.Authorizers.authorizeRequest('Create', pRequest, fStageComplete);
-			},
-			function (fStageComplete)
-			{
-				if (pRequest.MeadowAuthorization)
-				{
-					return fStageComplete(false);
-				}
-
-				// It looks like this record was not authorized.  Send an error.
-				return fStageComplete({Code:405,Message:'UNAUTHORIZED ACCESS IS NOT ALLOWED'});
-			},
-			function(fStageComplete)
-			{
-				//3. Prepare create query
-				var tmpQuery = pRequest.DAL.query;
-
-				tmpQuery.setIDUser(pRequest.UserSession.UserID);
-				tmpQuery.addRecord(pRecord);
-
-				return fStageComplete(null, tmpQuery);
-			},
-			// 3. INJECT: Query configuration
-			function (tmpQuery, fStageComplete)
-			{
-				pRequest.Query = tmpQuery;
-				pRequest.BehaviorModifications.runBehavior('Create-QueryConfiguration', pRequest, fStageComplete);
-			},
-			function(fStageComplete)
-			{
-				//4. Do the create operation
-				pRequest.DAL.doCreate(pRequest.Query,
-					function(pError, pQuery, pReadQuery, pNewRecord)
-					{
-						if (!pNewRecord)
-						{
-							return fStageComplete('Error in DAL create: '+pError);
-						}
-
-						pRequest.Record = pNewRecord;
-
-						pRequest.CreatedRecords.push(pNewRecord);
-
-						//pRequest.CommonServices.log.info('Created a record with ID '+pNewRecord[pRequest.DAL.defaultIdentifier]+'.', {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-CreateBulk'}, pRequest);
-
-						return fStageComplete(null);
-					});
-			},
-			function(fStageComplete)
-			{
-				return pRequest.BehaviorModifications.runBehavior('Create-PostOperation', pRequest, fStageComplete);
-			}
-		], function(pError)
-		{
-			if (pError)
-			{
-				pRecord.Error = 'Error creating record:'+pError;
-				// Added for singleton operations
-				pRequest.RecordCreateError = true;
-				pRequest.RecordCreateErrorMessage = pError;
-				// Also push the record to the created record stack with an error message
-				pRequest.CreatedRecords.push(pRecord);
-				pRequest.CommonServices.log.error('Error creating record:'+pError, {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-'+pRequest.MeadowOperation, Stack: pError.stack }, pRequest);
-			}
-
-			return fCallback();
-		});
-};
-
-module.exports = doCreate;

package/source/crud/Meadow-Operation-Update.js

@@ -1,145 +0,0 @@
-/**
-* Meadow Operation - Update a record
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Update a record using the Meadow DAL object.
-*/
-
-var libAsync = require('async');
-
-var doUpdate = function(pRecordToModify, pRequest, pResponse, fCallback, pOptionalCachedUpdatingRecord)
-{
-	// pOptionalCachedUpdatingRecord allows the caller to pass in a record, so the initial read doesn't need to happen.
-	pRequest.MeadowOperation = (typeof(pRequest.MeadowOperation) === 'string') ? pRequest.MeadowOperation : 'Update';
-
-	// If there is not a default identifier or cached record, fail
-	if ((pRecordToModify[pRequest.DAL.defaultIdentifier] < 1) && (typeof(pOptionalCachedUpdatingRecord) === 'undefined'))
-	{
-		return fCallback('Record update failure - a valid record ID is required in the passed-in record.');
-	}
-
-	libAsync.waterfall(
-		[
-			function(fStageComplete)
-			{
-				pRequest.Record = pRecordToModify;
-
-				if (typeof(pOptionalCachedUpdatingRecord) !== 'undefined')
-				{
-					// Use the cached updating record instead of reading a record.
-					return fStageComplete(false, pOptionalCachedUpdatingRecord);
-				}
-				else
-				{
-					var tmpQuery = pRequest.DAL.query;
-
-					// This is not overloadable.
-					tmpQuery.addFilter(pRequest.DAL.defaultIdentifier, pRecordToModify[pRequest.DAL.defaultIdentifier]);
-
-					// Load the record so we can do security checks on it
-					pRequest.DAL.doRead(tmpQuery,
-						function(pError, pQuery, pRecord)
-						{
-							if (!pError && !pRecord)
-							{
-								//short-circuit: Can't update a record that doesn't exist!
-								pError = 'Record not found.';
-							}
-
-							return fStageComplete(pError, pRecord);
-						});
-				}
-			},
-			function(pOriginalRecord, fStageComplete)
-			{
-				//send the original record to the Authorizer so it can verify ownership/etc
-				// TODO: Because the authorizer looks in the request for the record, we need to fix this somehow to work asynchronously.
-				pRequest.UpdatingRecord = pRecordToModify;
-				pRequest.Record = pOriginalRecord;
-
-				pRequest.Authorizers.authorizeRequest('Update', pRequest, function(err)
-					{
-						pRequest.Record = pRequest.UpdatingRecord;
-						return fStageComplete(err);
-					});
-			},
-			function(fStageComplete)
-			{
-				//2. INJECT: Record modification before update
-				pRequest.BehaviorModifications.runBehavior('Update-PreOperation', pRequest, fStageComplete);
-			},
-			function (fStageComplete)
-			{
-				if (pRequest.MeadowAuthorization)
-				{
-					return fStageComplete(false);
-				}
-
-				// It looks like this record was not authorized.  Send an error.
-				var tmpError = {Code:405,Message:'UNAUTHORIZED ACCESS IS NOT ALLOWED'};
-				tmpError.Scope = pRequest.DAL.scope;
-				tmpError[pRequest.DAL.defaultIdentifier] = pRequest.Record[pRequest.DAL.defaultIdentifier];
-				return fStageComplete(tmpError);
-			},
-			// 3a. INJECT: Query configuration
-			function (fStageComplete)
-			{
-				pRequest.Query = pRequest.DAL.query;
-				pRequest.BehaviorModifications.runBehavior('Update-QueryConfiguration', pRequest, fStageComplete);
-			},
-			function(fStageComplete)
-			{
-				//3b. Prepare update query
-				var tmpQuery = pRequest.Query;
-
-				tmpQuery.setIDUser(pRequest.UserSession.UserID);
-				tmpQuery.addRecord(pRequest.Record);
-
-				return fStageComplete(null, tmpQuery);
-			},
-			function(pPreparedQuery, fStageComplete)
-			{
-				//4. Do the update operation
-				pRequest.DAL.doUpdate(pPreparedQuery,
-					function(pError, pQuery, pReadQuery, pRecord)
-					{
-						if (!pRecord)
-						{
-							return fStageComplete('Error updating a record.');
-						}
-
-						pRequest.Record = pRecord;
-
-						pRequest.UpdatedRecords.push(pRecord);
-
-						//pRequest.CommonServices.log.info('Updated a record with ID '+pRecord[pRequest.DAL.defaultIdentifier]+'.', {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-UpdateBulk'}, pRequest);
-
-						return fStageComplete(null);
-					});
-			},
-			function(fStageComplete)
-			{
-				// INJECT: Post modification with record
-				return pRequest.BehaviorModifications.runBehavior('Update-PostOperation', pRequest, fStageComplete);
-			}
-		], function(pError)
-		{
-			if (pError)
-			{
-				pRecordToModify.Error = 'Error updating record:'+pError;
-				pRequest.RecordUpdateError = true;
-				pRequest.RecordUpdateErrorMessage = pError;
-				pRequest.UpdatedRecords.push(pRecordToModify);
-				pRequest.CommonServices.log.error('Error updating record:'+pError, {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-'+pRequest.MeadowOperation, Stack: pError.stack }, pRequest);
-			}
-
-			return fCallback();
-		});
-};
-
-module.exports = doUpdate;

package/source/crud/Meadow-Operation-Upsert.js

@@ -1,106 +0,0 @@
-/**
-* Meadow Operation - Upsert a record
-*
-* @license MIT
-*
-* @author Steven Velozo <steven@velozo.com>
-* @module Meadow
-*/
-/**
-* Upsert a record using the Meadow DAL object.
-*/
-
-var libAsync = require('async');
-
-var doCreate = require('./Meadow-Operation-Create.js');
-var doUpdate = require('./Meadow-Operation-Update.js');
-
-var doUpsert = function(pRecordToUpsert, pRequest, pResponse, fCallback)
-{
-	pRequest.MeadowOperation = (typeof(pRequest.MeadowOperation) === 'string') ? pRequest.MeadowOperation : 'Upsert';
-
-	libAsync.waterfall(
-		[
-			function(fStageComplete)
-			{
-				// Prepare to gather requirements for upserting
-				pRequest.Record = pRecordToUpsert;
-
-				var tmpQuery = pRequest.DAL.query;
-
-				// This operation will be create only if there is no GUID or ID in the record bundle
-				pRequest.UpsertCreateOnly = true;
-
-				// See if there is a default identifier or default GUIdentifier
-				if ((typeof(pRecordToUpsert[pRequest.DAL.defaultGUIdentifier]) !== 'undefined') && pRecordToUpsert[pRequest.DAL.defaultGUIdentifier].length > 0)
-				{
-					tmpQuery.addFilter(pRequest.DAL.defaultGUIdentifier, pRecordToUpsert[pRequest.DAL.defaultGUIdentifier]);
-					pRequest.UpsertCreateOnly = false;
-				}
-				if ((typeof(pRecordToUpsert[pRequest.DAL.defaultIdentifier]) !== 'undefined') && (pRecordToUpsert[pRequest.DAL.defaultIdentifier] > 0))
-				{
-					tmpQuery.addFilter(pRequest.DAL.defaultIdentifier, pRecordToUpsert[pRequest.DAL.defaultIdentifier]);
-					pRequest.UpsertCreateOnly = false;
-				}
-
-				if (pRequest.UpsertCreateOnly)
-				{
-					// Just create the record
-					doCreate(pRecordToUpsert, pRequest, pResponse, fStageComplete);
-				}
-				else
-				{
-					// Load the record to see if it exists
-					pRequest.DAL.doRead(tmpQuery,
-						function(pError, pQuery, pRecord)
-						{
-							if (pError)
-							{
-								// Return the error, because there was an error.
-								return fStageComplete(pError);
-							}
-							else if (!pError && !pRecord)
-							{
-								// Record not found -- do a create.
-								doCreate(pRecordToUpsert, pRequest, pResponse, fStageComplete);
-							}
-							else
-							{
-								// Set the default ID in the passed-in record if it doesn't exist..
-								if (!pRecordToUpsert.hasOwnProperty(pRequest.DAL.defaultIdentifier))
-								{
-									pRecordToUpsert[pRequest.DAL.defaultIdentifier] = pRecord[pRequest.DAL.defaultIdentifier];
-								}
-								// If the found record does not match the passed ID --- what the heck?!
-								if (pRecordToUpsert[pRequest.DAL.defaultIdentifier] != pRecord[pRequest.DAL.defaultIdentifier])
-								{
-									return fStageComplete('Default identifier does not match GUID record.');
-								}
-								// Record found -- do an update.  Use the cached record, though.
-								doUpdate(pRecordToUpsert, pRequest, pResponse, fStageComplete, pRecord);
-							}
-						});
-				}
-			},
-			function(fStageComplete)
-			{
-				// Now stuff the record into the upserted array
-				pRequest.UpsertedRecords.push(pRequest.Record);
-				fStageComplete(null);
-			}
-		], function(pError)
-		{
-			if (pError)
-			{
-				pRecordToUpsert.Error = 'Error upserting record:'+pError;
-				pRequest.RecordUpsertError = true;
-				pRequest.RecordUpsertErrorMessage = pError;
-				pRequest.UpsertedRecords.push(pRecordToUpsert);
-				pRequest.CommonServices.log.error('Error upserting record:'+pError, {SessionID:pRequest.UserSession.SessionID, RequestID:pRequest.RequestUUID, RequestURL:pRequest.url, Action:pRequest.DAL.scope+'-'+pRequest.MeadowOperation, Stack: pError.stack }, pRequest);
-			}
-
-			return fCallback();
-		});
-};
-
-module.exports = doUpsert;