npm - not-node - Versions diffs - 6.2.25 → 6.2.26 - Mend

not-node 6.2.25 → 6.2.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/docs/module-Model_Default.html +2048 -1960
package/docs/quicksearch.html +8 -5
package/docs/scripts/docstrap.lib.js +24455 -11
package/docs/scripts/prettify/jquery.min.js +5695 -3
package/package.json +1 -1
package/src/model/default.js +13 -5
package/test/validators.js +28 -20

package/docs/quicksearch.html CHANGED Viewed

@@ -1,21 +1,23 @@
 <html>
 <head>
 </head>
 <body style="background: transparent;">
     <script src="scripts/docstrap.lib.js"></script>
     <script src="scripts/lunr.min.js"></script>
     <script src="scripts/fulltext-search.js"></script>
     <script type="text/x-docstrap-searchdb">
-    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Global Members &lt;constant&gt; DEFAULT_MANIFEST_FILE_ENDING :string Manifest files ending Type: string &lt;constant&gt; DEFAULT_ROUTES_FILE_ENDING :string Routes collection files ending Type: string &lt;constant&gt; DEFAULT_WS_ROUTE_ACTION_SPLITTER :string Standart splitter of module resources paths Type: string &lt;constant&gt; DEFAULT_WS_ROUTES_FILE_ENDING :string WS End-points collection files ending Type: string &lt;constant&gt; EventEmitter Not an App, But can be used for hosting modules and models. &lt;constant&gt; LOGIC_BINDINGS_LIST :string List of methods to be binded from notApp to logics Type: string &lt;constant&gt; MODEL_BINDINGS_LIST :string List of methods to be binded from notApp to models Type: string &lt;constant&gt; MODULE_BINDINGS_LIST :string List of methods to be binded from notApp to notModule Type: string &lt;constant&gt; ROUTE_BINDINGS_LIST :string List of methods to be binded from notApp to routes and WS end-points Type: string &lt;constant&gt; WS_ROUTE_BINDINGS_LIST :string List of methods to be binded from notApp to routes and WS end-points Type: string Methods checkAdmin(req, res, next) Checks if user is authenticated, by searching req.session.user If auth pass next, else throw error Parameters: Name Type Description req object Express Request object res object Express Repost object next function callback checkCredentials(rule, auth, role, admin) Check rule against presented credentials Parameters: Name Type Description rule object action rule { auth - if user should be authenticated role - if user shoud have some role admin - if user should be super user } auth Boolean user state of auth role String | Array user state of role admin Boolean user state of admin Returns: pass or not Type boolean checkRoleBuilder(role) Returns Express middleware witch check role against one presented in request Parameters: Name Type Description role string | array action roles Returns: express middleware Type function checkSupremacy(base, against, roles) Check to sets of roles against each other to define if base is strictly higher than second Parameters: Name Type Description base String | Array first set of roles against String | Array second set of roles roles Array roles in order of supremacy from highest to lowest Returns: true if base &gt; against Type boolean checkUser(req, res, next) Checks if user is authenticated, by searching req.session.user If auth pass next, else throw error Parameters: Name Type Description req object Express Request object res object Express Repost object next function callback cleanse(req) Reset session Parameters: Name Type Description req object Express Request compareRoles(userRoles, actionRoles, strict) Compares two list of roles Parameters: Name Type Default Description userRoles array | string roles of user actionRoles array | string roles of action strict boolean true if true userRoles should contain all of actionRoles. else atleast one Returns: if user roles comply to action roles Type boolean createSpecial(owner, system) Creates array of special roles Parameters: Name Type Description owner boolean if actor is owner of document system boolean if actor is a system process Returns: list of special roles Type Array.&lt;string&gt; extractAuthData() Collects various authentification and authorization data from request object Returns: various authentification data for actor { root:boolean, auth: boolean, role: [string], uid: ObjectId, sid: string, ip:string } Type object extractSafeFields(schema, action, data, roles, actorId, system) Using schema and information about action and actor to extract only safe information forming new object with data only from safe fields Parameters: Name Type Default Description schema Object mongoose model schema with extended fields from not-* action string action to check against data Object source of data to extract from roles Array.&lt;string&gt; actor roles actorId string | ObjectId actor objectId system boolean false true if actor is a system procedure Returns: object containing only data from safe fields Type Object fieldIsSafe(field, action, roles, special) Check if field of target object is safe to access by actor with defined roles in specific action Parameters: Name Type Description field Object description of field from schema action string action to check against roles Array.&lt;string&gt; actor roles special string special relations of actor and target (@owner, @system) Returns: true - safe Type boolean fromSchema(schema, rawMutationsList) Takes in mongoose model schema, scans for fields names nad creates list of field's names to initialize from LIB, if in supplied rawMutationsList, exists mutation for a field in list, field name in list will be replaced by a mutation description Parameters: Name Type Description schema Object mongoose model schema rawMutationsList Array list of mutations [src, mutation]/[dst,mutation,src] Returns: initialized ui descriptions of fields for schema Type Object getIP(req) Get request ip Parameters: Name Type Description req object Express Request getMutationForField(name, list) Returns mutation tuple for a field or false Parameters: Name Type Description name string field name list Array fields description lists Returns: Type boolean | item getOwnerId(data) Get data owner ObjectId Parameters: Name Type Description data Object Document Object Returns: owner ObjectId or undefined if field is not found Type ObjectId | undefined getRole(req) Returns user role from request object Parameters: Name Type Description req object Express Request Returns: user role getSafeFieldsForRoleAction(schema, action, roles, owner, system) Scans schema checks every field access regulations for specific action of actor with roles. Returns list of fields that could be accessed safely. Parameters: Name Type Description schema Object mongoose model schema with extended fields from not-* action string action to check against roles Array.&lt;string&gt; actor roles owner boolean actor is an owner of document system boolean actor is a system procedure Returns: list of accessible fields Type Array.&lt;string&gt; getSessionId(req) Get session id for active session Parameters: Name Type Description req object Express Request getUserId(req) Get user id for active session Parameters: Name Type Description req object Express Request ifAdmin(req) Returns true if user is admin Parameters: Name Type Description req object Express Request object Returns: true - admin, false - not admin Type boolean initField(field, resultOnly, type) Retrieves field information there are few signatures of this function (field:string, resultOnly:boolean = true, type:string = 'ui')=&gt; Object | [string, Object] (field:Array, resultOnly:boolean = true, type:string = 'ui')=&gt; Object | [string, Object] Parameters: Name Type Description field string | Array field to retrieve from store and init field: string - just name of the field field: Array - [destinationField:string, mutation: Object, sourceField:string] field: Array - [sourceField:string, mutation: Object] sourceField - standart field to extend mutation - to extend by destinationField - name of resulting field, if no dest then src will be used resultOnly boolean return only result, if false then returns [name, value] type string type of field information initFields() list = [ 'title', //for standart only name ['titleNonStandart', {component: 'UITextforBlind'}] //arrays of [name, mutation] ['someID', {}, 'ID'], //copy of standart ID field under name as someID ] intersect_safe(a, b) Two arrays in - one intersection of two out Parameters: Name Type Description a array first array b array scecond array Returns: array consisted of elements presented in both input arrays Type array isOwner(data, user_id) Check if data is belongs to user Parameters: Name Type Description data Object object user_id ObjectId possible owner Returns: true - belongs, false - not belongs Type boolean isUser(req) Checks if user is authenticated, by searching req.session.user Parameters: Name Type Description req object Express Request object Returns: true - authenticated, false - guest Type boolean module:Model/Validator() Take array of validator (https://www.npmjs.com/package/validator) rules and create array of mongoose-validator (https://www.npmjs.com/package/mongoose-validator) rules then return it ruleIsWildcard(safeFor) Checks if safe field rule is some sort variant of wild card Parameters: Name Type Description safeFor string | Array.&lt;string&gt; safe field rule Returns: if it's wildcard Type boolean setAuth(req, id, role) Set auth data in session, user id and role Parameters: Name Type Description req object Express Request id string user id role string user role setGuest(req) Set auth data in session to Guest Parameters: Name Type Description req object Express Request setRole(req, role) Set user role for active session Parameters: Name Type Description req object Express Request role Array.&lt;string&gt; array of roles setUserId(req, _id) Set user id for active session Parameters: Name Type Description req object Express Request _id string user id × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Modules Classes exports module:notModuleRegistrator notApp notDomain notManifest notModule notRoute × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Classes Classes exports module:notModuleRegistrator notApp notDomain notManifest notModule notRoute × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST not-node Node.js server side framework × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module.exports.html":{"id":"module.exports.html","title":"Class: exports","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: exports exports Initialization sequence manipulations Holds list of initalizers and manages em adds/removes new exports() Methods clearActionFromRules(action, ruleSet) Clear action definition from rules of access Parameters: Name Type Default Description action object action data ruleSet object null specific set of rules for this action Returns: clean action data Type object clearFromDirtyFields(action) Deletes fields listed in DIRTY_FIELDS constant from object Parameters: Name Type Description action Object action object filter(manifest, auth, role, root) Filters manifest for current user auth, role, root. Removes all actions that can not be performed Parameters: Name Type Description manifest object full raw manifest auth boolean user auth status role boolean user role status root boolean user root status Returns: filtered manifest Type object filterRoute(route, auth, role, root) Clear route from action variants that not permited for user according to his auth, role, root status Parameters: Name Type Description route object route object auth boolean user auth status role boolean user role status root boolean user root status Returns: Return router with only actions user can access with current states of auth, role, root. With removed definitions of what rules of access are. Type object filterRouteAction() findAll(input) Searching fields in directory Parameters: Name Type Description input Object Properties Name Type Description notModule notModule srcDir string findAll(input) Searching fields in directory Parameters: Name Type Description input Object Properties Name Type Description notModule notModule srcDir string findAll(input) Searching fields in directory Parameters: Name Type Description input Object Properties Name Type Description notModule notModule srcDir string findAll(input) Searching fields in directory Parameters: Name Type Description input Object Properties Name Type Description notModule notModule srcDir string getConstructor(conf) Returns constructor of Session driver Parameters: Name Type Description conf Object configuration os session from application config Properties Name Type Description driver string name of session storage engine Returns: class constructor or undefined Type Object insert(what, where) Insert initalizator after and before specified modules or at the end Parameters: Name Type Description what Object initializator class constructor where Object specification where to insert Properties Name Type Description after Array.String list of constructor names of initalizators after which item should be inserted before Array.String list of constructor names of initalizators before which item should be inserted remove(rem, add) Removing item and optionally adding few on place of removed Parameters: Name Type Description rem string name of class of initalizator to remove add Array.Constructor list of class constructors replace(whatRemove, whatInsert, where) Replacing existing item or if item is not exists in list then inserting items accroding to where instruction Parameters: Name Type Description whatRemove string name of class of initalizator to remove whatInsert Array.Constructor list of class constructors where Object specification where to insert Properties Name Type Description after Array.String list of constructor names of initalizators after which item should be inserted before Array.String list of constructor names of initalizators before which item should be inserted ruleSetHasFieldsDirective(ruleSet) Return true if ruleSet object has not empty list of fields Parameters: Name Type Description ruleSet Object specific set of rules for action Returns: if rule set has not empty fields list Type boolean × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Auth.html":{"id":"module-Auth.html","title":"Module: Auth","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Auth × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Common.html":{"id":"module-Common.html","title":"Module: Common","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Common Members &lt;inner, constant&gt; isAsync Returns true if argument is Async function &lt;inner, constant&gt; isFunc Test argument type to be 'function' Methods &lt;static&gt; compareObjectIds(firstId, secondId) Validates and compares ObjectIds in string or Object form Parameters: Name Type Description firstId string | ObjectId first id secondId string | ObjectId second id Returns: true if equal Type booelean &lt;static&gt; copyObj(obj) Copies object to secure it from changes Parameters: Name Type Description obj object original object Returns: copy of object Type object &lt;static&gt; executeObjectFunction(obj, name, params) Executes method of object in appropriate way inside Promise Parameters: Name Type Description obj object original object name string method name to execute params Array array of params Returns: results of method execution Type Promise &lt;static&gt; firstLetterToLower(string) Change first letter case to lower Parameters: Name Type Description string string input string Returns: result Type string &lt;static&gt; firstLetterToUpper(string) Change first letter case to higher Parameters: Name Type Description string string input string Returns: result Type string &lt;static&gt; getTodayDate() Returns today Date object without hours, minutes, seconds Returns: current date with 00:00:00 in ms of unix time Type number &lt;static&gt; mapBind(from, name, list) Executes method of object in apropriate way inside Promise Parameters: Name Type Description from Object original object name Object method name to execute list Array array of params Returns: results of method execution Type Promise &lt;static&gt; tryFile(filePath) Synchronously check file existence and if it's really a file Parameters: Name Type Description filePath string full path to file Returns: true if path exists and it's a file Type boolean &lt;static&gt; validateObjectId(id) Validates if string is a ObjectId Parameters: Name Type Description id string ObjectId string to validate Returns: true if check is not failed Type booelean &lt;inner&gt; objHas(obj, name) Returns true if object has field of name Parameters: Name Type Description obj object some object name string field name Returns: if object contains field with name Type boolean × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Lib.html":{"id":"module-Lib.html","title":"Module: Lib","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Lib Methods &lt;static&gt; joinToFile(target, sources, splitter) Joins many files in one Parameters: Name Type Description target string result file path sources array list of source files splitter splitter file splitter × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Default.html":{"id":"module-Model_Default.html","title":"Module: Model/Default","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Default Methods &lt;static&gt; add(data) Starts add routine Parameters: Name Type Description data object data Returns: Promise Type Promise &lt;static&gt; countWithFilter(filter) Counts record method Parameters: Name Type Description filter object | array filter rules Returns: Promise Type Promise &lt;static&gt; getOne(id, population) Retrieves one record by primary key If versioning ON, it retrieves __latest and not __closed Parameters: Name Type Description id string primary key population Array optional if needed population of some fields Returns: Promise Type Promise &lt;static&gt; getOneByID(ID) Retrieves one record by unique numeric ID If versioning ON, it retrieves __latest and not __closed Parameters: Name Type Description ID number some unique numeric identificator Returns: Promise of document, if increment is OFF - then Promise.resolve(null) Type Promise &lt;static&gt; getOneRaw(id) Retrieves one record by primary key, without any restriction Parameters: Name Type Description id string primary key Returns: Promise Type Promise &lt;static&gt; list(skip, size, sorter, filter) List record method Parameters: Name Type Description skip number number of skiped records size number length of return list sorter Object sorter rules filter Object | Array filter rules Returns: Promise Type Promise &lt;static&gt; listAll() List all records from collection If Versioning is ON restricts to __latest and not __closed By default sorts by _id in DESC Returns: Promise Type Promise &lt;static&gt; listAllAndPopulate(populate) List all record in collection and populates If Versioning is ON restricts to __latest and not __closed By default sorts by _id in DESC Parameters: Name Type Description populate object | array populate rules Returns: Promise Type Promise &lt;async, static&gt; listAndCount(skip, size, sorter, filter, search, populate) List record in collection and populates, with count of total founded records By default sorts by _id in DESC Parameters: Name Type Description skip number number of skiped records size number length of return list sorter object sorter rules filter object | array filter rules search object | array search rules populate object populate rules Returns: {list, count, pages} Type Promise &lt;static&gt; listAndPopulate(skip, size, sorter, filter, populate) List record and populate method Parameters: Name Type Description skip number number of skiped records size number length of return list sorter object sorter rules filter object | array filter rules populate object populate rules Returns: Promise Type Promise &lt;static&gt; listByField(field, list, filter, populate) Returns list of items with specific values in specific field, optionaly filtered Parameters: Name Type Description field string name of the field to search in list array list of 'id' field values filter object | array filter rules populate object populate rules Returns: Promise Type Promise &lt;static&gt; makeQuery(method, filter) Common query with filtering constructor for generic method Parameters: Name Type Description method string name of the method filter object | array filtering rules object Returns: mongoose query object Type Query &lt;static&gt; sanitizeInput(input) Sanitize input Parameters: Name Type Description input object data Returns: data; Type object &lt;static&gt; update(filter, data, many) Starts update routine Parameters: Name Type Default Description filter object search criteria data object data many boolean false if true will affect all records according to filter Returns: Promise Type Promise &lt;inner&gt; close() Closes document and saves it This is replaces remove when Versioning is ON Returns: ID Type numeric &lt;inner&gt; getID() Returns incremental ID for this doc Returns: ID Type numeric × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Enrich.html":{"id":"module-Model_Enrich.html","title":"Module: Model/Enrich","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Enrich × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Increment.html":{"id":"module-Model_Increment.html","title":"Module: Model/Increment","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Increment Methods &lt;inner&gt; formId() &lt;inner&gt; newGetNext() Generate new ID for current model and filterFields &lt;inner&gt; newRebase(modelName, ID) Sets new current ID for model Parameters: Name Type Description modelName string name of target model ID number desired new start ID for model &lt;inner&gt; notContainedInData(fields, data) Returns sub-list of fields which is not contained in object Parameters: Name Type Description fields Array.string list of fields data Object object to filter against Returns: sub-list of fields not contained in object Type Array.string &lt;inner&gt; secureUpdate(thisModel, which, cmd, opts) Some drivers versions work-arounds Parameters: Name Type Description thisModel Mongoose.Model counter model which Object filter object of update request cmd Object command object of update request opts Object options of request × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Proto.html":{"id":"module-Model_Proto.html","title":"Module: Model/Proto","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Proto × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Routine.html":{"id":"module-Model_Routine.html","title":"Module: Model/Routine","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Routine × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Validator.html":{"id":"module-Model_Validator.html","title":"Module: Model/Validator","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Validator (require(\"Model/Validator\"))() Take array of validator (https://www.npmjs.com/package/validator) rules and create array of mongoose-validator (https://www.npmjs.com/package/mongoose-validator) rules then return it × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Versioning.html":{"id":"module-Model_Versioning.html","title":"Module: Model/Versioning","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Versioning × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-not-node.html":{"id":"module-not-node.html","title":"Module: not-node","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: not-node Members &lt;static&gt; Application Application object &lt;static&gt; Auth Authentication module &lt;static&gt; Common Common functions &lt;static&gt; Enrich Mongoose Model additional features enricher &lt;static&gt; Error :not-node/Error Error module Type: not-node/Error &lt;static&gt; Fields Fields library manager &lt;static&gt; Increment Mongoose Model autoincrement field &lt;static&gt; Init Application initialization procedures &lt;static&gt; Manifest Manifest infrastructure &lt;static&gt; notApp Web Application &lt;static&gt; notDomain General Application &lt;static&gt; Proto Mongoose Model prototype &lt;static&gt; Routine Mongoose Documents routine operation &lt;static&gt; Versioning Mongoose Documents versioning × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-not-node_Error.html":{"id":"module-not-node_Error.html","title":"Module: not-node/Error","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: not-node/Error Methods &lt;static&gt; addError(errors, field, error) Пополняем объект ошибок Parameters: Name Type Description errors object errors field string name of the field error object error to add Returns: modified errors Type object × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-notModuleRegistrator.html":{"id":"module-notModuleRegistrator.html","title":"Module: notModuleRegistrator","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: notModuleRegistrator Search and register notModule resouces Logic to find and register resources of notModule new (require(\"notModuleRegistrator\"))() Methods &lt;static&gt; registerContent(input) Searching for content of module and registering it. Parameters: Name Type Description input Object Properties Name Type Description nModule notModule Returns: true - executed, false - no paths Type boolean × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Parser.html":{"id":"module-Parser.html","title":"Module: Parser","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Parser Methods &lt;static&gt; getRouteLine(url, modelName, actionName, actionData) Create routeLine for end-point Parameters: Name Type Description url string url in manifest format modelName string name of the model actionName string name of the action in the route file actionData object data from manifest for this action Returns: resolved router line Type string &lt;static&gt; parseLine(line, modelName, actionName) routeLine parser Parameters: Name Type Description line string raw route line like '/api/:modelName' or '/:record[_id]' modelName string is for name of the model routes collection actionName string is for name of the action in the routes collection record[fieldName] - is for client side mostly, shows what model field walue should be placed there. Samples ':record[_id]', ':record[authorId]' Returns: resolved line Type string × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Repos.html":{"id":"module-Repos.html","title":"Module: Repos","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Repos × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Rollup.html":{"id":"module-Rollup.html","title":"Module: Rollup","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Rollup × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-ShellHelpers.html":{"id":"module-ShellHelpers.html","title":"Module: ShellHelpers","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: ShellHelpers × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notApp.html":{"id":"notApp.html","title":"Class: notApp","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notApp notApp Application new notApp(options) Parameters: Name Type Description options object application options { mongoose: mongooseConnectionToDB modulesCollectionPaths: [__dirname + '/modules'], //each path to folder with modules modulesPaths: [], //each path to module modules: { filestore: require('not-filestore') //each npm not-* module with custom overriden name as key } } Example Application creation routine let App = new notApp({ mongoose: mongooseLink modulesCollectionPaths: [__dirname + '/modules'], //each path to folder with modules modulesPaths: [], //each path to module modules: { filestore: require('not-filestore') //each npm not-* module with custom overriden name as key } }) .importModuleFrom(__dirname+'/anotherModule', 'anotherCustomModuleName') //import module from path .importModulesFrom(__dirname+'/directoryOfUsefullessModules') .importModule(require('notModule'), 'notModule') .expose(ExpressApp); Methods collectManifest() Returns application manifest, by user credentials object Returns: manifest Type object expose(app) Exposes routes to ExpressJS application Parameters: Name Type Description app object ExpressJS application instance getManifest() Returns application manifest, by ExpressRequest Returns: manifest Type object × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notDomain.html":{"id":"notDomain.html","title":"Class: notDomain","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notDomain notDomain Domain new notDomain(options) Parameters: Name Type Description options object application options { mongoose: mongooseConnectionToDB modulesCollectionPaths: [__dirname + '/modules'], //each path to folder with modules modulesPaths: [], //each path to module modules: { filestore: require('not-filestore') //each npm not-* module with custom overriden name as key } } Example Domain creation routine let App = new new notDomain({ mongoose: mongooseLink modulesCollectionPaths: [__dirname + '/modules'], //each path to folder with modules modulesPaths: [], //each path to module modules: { filestore: require('not-filestore') //each npm not-* module with custom overriden name as key } }) .importModuleFrom(__dirname+'/anotherModule', 'anotherCustomModuleName') //import module from path .importModulesFrom(__dirname+'/directoryOfUsefullessModules') .importModule(require('notModule'), 'notModule'); Members DEFAULT_INFORMER informer - messages DEFAULT_REPORTER reporter - errors logger logger Methods &lt;async&gt; execInModules(methodName) Execute method in modules Parameters: Name Type Description methodName string name of the method to execute fabricate() Execute fabricateModels methods on all registered modules Create mongoose models. forEachMod(func) Cycles throu all imported modules, passes name, module, and itself to argument function Parameters: Name Type Description func function function to perfom some action with module getEnv(key) Returns application environment variable Parameters: Name Type Description key string name of var Returns: value or undefined Type object | undefined getLogic(name) Returns logic Parameters: Name Type Description name string 'logicName' or 'moduleName//logicName' ('User', 'moduleName//User') Returns: logic Type object getLogicFile(logicName) Returns file with logic declarations Parameters: Name Type Description logicName string 'logicName' or 'moduleName//logicName' Returns: CommonJS module object Type object getModel(name) Returns model Parameters: Name Type Description name string 'modelName' or 'moduleName//modelName' ('User', 'moduleName//User') Returns: model Type object getModelFile(modelName) Returns file with model declarations Parameters: Name Type Description modelName string 'modelName' or 'moduleName//modelName' Returns: CommonJS module object Type object getModelSchema(modelName) Returns specified by name or 'moduleName//modelName' model Schema Parameters: Name Type Description modelName string 'modelName' or 'moduleName//modelName' Returns: model schema Type object getModule(moduleName) Return module by specified module name Parameters: Name Type Description moduleName string 'moduleName' Returns: module Type object getRoute(name) Returns route Parameters: Name Type Description name string 'moduleName//routeName//functionName' ('not-user//user//add') Returns: route Type function getStatus() Returns info about whole system. Modules - total count, list, content Routes - total count, list Models - total count, list Actions - total count, list Roles - total count, list Returns: complex object with results Type Object importModule(mod, moduleName) Import module object. Chainable. Parameters: Name Type Description mod object notModule instance moduleName string name under witch module will be registered Returns: notDomain Type object importModuleFrom(modulePath, moduleName) Import single module from module dir. Chainable. Parameters: Name Type Description modulePath string path to module directory moduleName string name under witch module will be registered Returns: notDomain Type object importModulesFrom(modulesPath) Importing modules from directory. Chainable. Parameters: Name Type Description modulesPath string path to container directory Returns: notDomain Type object setEnv(key, val) Setting application environment variable Parameters: Name Type Description key string name of var val object value Returns: chainable Type notDomain shutdown(timeout) Logging message about shutdown. Emits event app:shutdown Exits from process after timeout Parameters: Name Type Default Description timeout number OPT_DEFAULT_SHUTDOWN_TIMEOUT time in ms before exit × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notManifest.html":{"id":"notManifest.html","title":"Class: notManifest","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notManifest notManifest API manifest new notManifest(app, notApp, moduleName) Parameters: Name Type Description app object express application instance notApp object notApplication instance moduleName string name of owner module Methods filterManifest(manifest, auth, role, root) Filters manifest for current user auth, role, root. Removes all actions that can not be performed Parameters: Name Type Description manifest object full raw manifest auth boolean user auth status role boolean user role status root boolean user root status Returns: filtered manifest Type object registerRoute(moduleManifest, routeName) Check if manifest file has url and actions, so we could register routes Parameters: Name Type Description moduleManifest object library of .manifest.js files routeName string name of registerRouteForAction(app, routesPath, routeLine, modelName, actionSetName, actionData) Создаем путь для одной конечной точки Parameters: Name Type Description app object express app object routesPath string directory where routes files is placed routeLine string aka '/login', '/user/:id', etc modelName string name of the mongoose model, should be exact as file name with routes for this model. If /models/theme.js contains 'Theme' mongoose model, then /routes/theme.js should ` contain routes for that model. actionSetName string name of action in routes file. Look for existing route file for understanding actionData object representation of action data Returns: if route were registered Type boolean registerRoutes(moduleManifest) Создаем пути согласно манифесту Parameters: Name Type Description moduleManifest object notManifest of module routeHasRoutes(route) Check if manifest file has url, model and actions, so we could register routes Parameters: Name Type Description route object content of .manifest.js file Returns: true if could create routes Type boolean × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notModule.html":{"id":"notModule.html","title":"Class: notModule","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notModule notModule Module representation new notModule(options) Parameters: Name Type Description options Object options Properties Name Type Description modPath String path to module location modObject Object loaded module object × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notRoute.html":{"id":"notRoute.html","title":"Class: notRoute","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notRoute notRoute Route representation new notRoute(notApp, moduleName, routeName, actionName, actionData) Parameters: Name Type Description notApp object notApplication instance moduleName string name of owner module routeName string route name actionName string action name actionData object action data Methods &lt;static&gt; actionAvailableByRule(action, user) Cycle throu rules of action and checking user credentials against them If user creds comply to some rule - returns copy of rule Parameters: Name Type Description action object action rules object user object user credentials (auth, role, root) Returns: returns rule or null Type object | null exec(req, res, callback) Executes route action if such exist Parameters: Name Type Description req object Express Request Object res object Express Response Object callback function Returns: result of execution or HttpError Type object selectRule(req) Select rule from available or return null Parameters: Name Type Description req object Express Request Object Returns: rule or null Type object × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Global Members &lt;constant&gt; DEFAULT_MANIFEST_FILE_ENDING :string Manifest files ending Type: string &lt;constant&gt; DEFAULT_ROUTES_FILE_ENDING :string Routes collection files ending Type: string &lt;constant&gt; DEFAULT_WS_ROUTE_ACTION_SPLITTER :string Standart splitter of module resources paths Type: string &lt;constant&gt; DEFAULT_WS_ROUTES_FILE_ENDING :string WS End-points collection files ending Type: string &lt;constant&gt; EventEmitter Not an App, But can be used for hosting modules and models. &lt;constant&gt; LOGIC_BINDINGS_LIST :string List of methods to be binded from notApp to logics Type: string &lt;constant&gt; MODEL_BINDINGS_LIST :string List of methods to be binded from notApp to models Type: string &lt;constant&gt; MODULE_BINDINGS_LIST :string List of methods to be binded from notApp to notModule Type: string &lt;constant&gt; ROUTE_BINDINGS_LIST :string List of methods to be binded from notApp to routes and WS end-points Type: string &lt;constant&gt; WS_ROUTE_BINDINGS_LIST :string List of methods to be binded from notApp to routes and WS end-points Type: string Methods checkAdmin(req, res, next) Checks if user is authenticated, by searching req.session.user If auth pass next, else throw error Parameters: Name Type Description req object Express Request object res object Express Repost object next function callback checkCredentials(rule, auth, role, admin) Check rule against presented credentials Parameters: Name Type Description rule object action rule { auth - if user should be authenticated role - if user shoud have some role admin - if user should be super user } auth Boolean user state of auth role String | Array user state of role admin Boolean user state of admin Returns: pass or not Type boolean checkRoleBuilder(role) Returns Express middleware witch check role against one presented in request Parameters: Name Type Description role string | array action roles Returns: express middleware Type function checkSupremacy(base, against, roles) Check to sets of roles against each other to define if base is strictly higher than second Parameters: Name Type Description base String | Array first set of roles against String | Array second set of roles roles Array roles in order of supremacy from highest to lowest Returns: true if base &gt; against Type boolean checkUser(req, res, next) Checks if user is authenticated, by searching req.session.user If auth pass next, else throw error Parameters: Name Type Description req object Express Request object res object Express Repost object next function callback cleanse(req) Reset session Parameters: Name Type Description req object Express Request compareRoles(userRoles, actionRoles, strict) Compares two list of roles Parameters: Name Type Default Description userRoles array | string roles of user actionRoles array | string roles of action strict boolean true if true userRoles should contain all of actionRoles. else atleast one Returns: if user roles comply to action roles Type boolean createSpecial(owner, system) Creates array of special roles Parameters: Name Type Description owner boolean if actor is owner of document system boolean if actor is a system process Returns: list of special roles Type Array.&lt;string&gt; extractAuthData() Collects various authentification and authorization data from request object Returns: various authentification data for actor { root:boolean, auth: boolean, role: [string], uid: ObjectId, sid: string, ip:string } Type object extractSafeFields(schema, action, data, roles, actorId, system) Using schema and information about action and actor to extract only safe information forming new object with data only from safe fields Parameters: Name Type Default Description schema Object mongoose model schema with extended fields from not-* action string action to check against data Object source of data to extract from roles Array.&lt;string&gt; actor roles actorId string | ObjectId actor objectId system boolean false true if actor is a system procedure Returns: object containing only data from safe fields Type Object fieldIsSafe(field, action, roles, special) Check if field of target object is safe to access by actor with defined roles in specific action Parameters: Name Type Description field Object description of field from schema action string action to check against roles Array.&lt;string&gt; actor roles special string special relations of actor and target (@owner, @system) Returns: true - safe Type boolean fromSchema(schema, rawMutationsList) Takes in mongoose model schema, scans for fields names nad creates list of field's names to initialize from LIB, if in supplied rawMutationsList, exists mutation for a field in list, field name in list will be replaced by a mutation description Parameters: Name Type Description schema Object mongoose model schema rawMutationsList Array list of mutations [src, mutation]/[dst,mutation,src] Returns: initialized ui descriptions of fields for schema Type Object getIP(req) Get request ip Parameters: Name Type Description req object Express Request getMutationForField(name, list) Returns mutation tuple for a field or false Parameters: Name Type Description name string field name list Array fields description lists Returns: Type boolean | item getOwnerId(data) Get data owner ObjectId Parameters: Name Type Description data Object Document Object Returns: owner ObjectId or undefined if field is not found Type ObjectId | undefined getRole(req) Returns user role from request object Parameters: Name Type Description req object Express Request Returns: user role getSafeFieldsForRoleAction(schema, action, roles, owner, system) Scans schema checks every field access regulations for specific action of actor with roles. Returns list of fields that could be accessed safely. Parameters: Name Type Description schema Object mongoose model schema with extended fields from not-* action string action to check against roles Array.&lt;string&gt; actor roles owner boolean actor is an owner of document system boolean actor is a system procedure Returns: list of accessible fields Type Array.&lt;string&gt; getSessionId(req) Get session id for active session Parameters: Name Type Description req object Express Request getUserId(req) Get user id for active session Parameters: Name Type Description req object Express Request ifAdmin(req) Returns true if user is admin Parameters: Name Type Description req object Express Request object Returns: true - admin, false - not admin Type boolean initField(field, resultOnly, type) Retrieves field information there are few signatures of this function (field:string, resultOnly:boolean = true, type:string = 'ui')=&gt; Object | [string, Object] (field:Array, resultOnly:boolean = true, type:string = 'ui')=&gt; Object | [string, Object] Parameters: Name Type Description field string | Array field to retrieve from store and init field: string - just name of the field field: Array - [destinationField:string, mutation: Object, sourceField:string] field: Array - [sourceField:string, mutation: Object] sourceField - standart field to extend mutation - to extend by destinationField - name of resulting field, if no dest then src will be used resultOnly boolean return only result, if false then returns [name, value] type string type of field information initFields() list = [ 'title', //for standart only name ['titleNonStandart', {component: 'UITextforBlind'}] //arrays of [name, mutation] ['someID', {}, 'ID'], //copy of standart ID field under name as someID ] intersect_safe(a, b) Two arrays in - one intersection of two out Parameters: Name Type Description a array first array b array scecond array Returns: array consisted of elements presented in both input arrays Type array isOwner(data, user_id) Check if data is belongs to user Parameters: Name Type Description data Object object user_id ObjectId possible owner Returns: true - belongs, false - not belongs Type boolean isUser(req) Checks if user is authenticated, by searching req.session.user Parameters: Name Type Description req object Express Request object Returns: true - authenticated, false - guest Type boolean module:Model/Validator() Take array of validator (https://www.npmjs.com/package/validator) rules and create array of mongoose-validator (https://www.npmjs.com/package/mongoose-validator) rules then return it ruleIsWildcard(safeFor) Checks if safe field rule is some sort variant of wild card Parameters: Name Type Description safeFor string | Array.&lt;string&gt; safe field rule Returns: if it's wildcard Type boolean setAuth(req, id, role) Set auth data in session, user id and role Parameters: Name Type Description req object Express Request id string user id role string user role setGuest(req) Set auth data in session to Guest Parameters: Name Type Description req object Express Request setRole(req, role) Set user role for active session Parameters: Name Type Description req object Express Request role Array.&lt;string&gt; array of roles setUserId(req, _id) Set user id for active session Parameters: Name Type Description req object Express Request _id string user id × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Modules Classes exports module:notModuleRegistrator notApp notDomain notManifest notModule notRoute × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Classes Classes exports module:notModuleRegistrator notApp notDomain notManifest notModule notRoute × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST not-node Node.js server side framework × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module.exports.html":{"id":"module.exports.html","title":"Class: exports","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: exports exports Initialization sequence manipulations Holds list of initalizers and manages em adds/removes new exports() Methods clearActionFromRules(action, ruleSet) Clear action definition from rules of access Parameters: Name Type Default Description action object action data ruleSet object null specific set of rules for this action Returns: clean action data Type object clearFromDirtyFields(action) Deletes fields listed in DIRTY_FIELDS constant from object Parameters: Name Type Description action Object action object filter(manifest, auth, role, root) Filters manifest for current user auth, role, root. Removes all actions that can not be performed Parameters: Name Type Description manifest object full raw manifest auth boolean user auth status role boolean user role status root boolean user root status Returns: filtered manifest Type object filterRoute(route, auth, role, root) Clear route from action variants that not permited for user according to his auth, role, root status Parameters: Name Type Description route object route object auth boolean user auth status role boolean user role status root boolean user root status Returns: Return router with only actions user can access with current states of auth, role, root. With removed definitions of what rules of access are. Type object filterRouteAction() findAll(input) Searching fields in directory Parameters: Name Type Description input Object Properties Name Type Description notModule notModule srcDir string findAll(input) Searching fields in directory Parameters: Name Type Description input Object Properties Name Type Description notModule notModule srcDir string findAll(input) Searching fields in directory Parameters: Name Type Description input Object Properties Name Type Description notModule notModule srcDir string findAll(input) Searching fields in directory Parameters: Name Type Description input Object Properties Name Type Description notModule notModule srcDir string getConstructor(conf) Returns constructor of Session driver Parameters: Name Type Description conf Object configuration os session from application config Properties Name Type Description driver string name of session storage engine Returns: class constructor or undefined Type Object insert(what, where) Insert initalizator after and before specified modules or at the end Parameters: Name Type Description what Object initializator class constructor where Object specification where to insert Properties Name Type Description after Array.String list of constructor names of initalizators after which item should be inserted before Array.String list of constructor names of initalizators before which item should be inserted remove(rem, add) Removing item and optionally adding few on place of removed Parameters: Name Type Description rem string name of class of initalizator to remove add Array.Constructor list of class constructors replace(whatRemove, whatInsert, where) Replacing existing item or if item is not exists in list then inserting items accroding to where instruction Parameters: Name Type Description whatRemove string name of class of initalizator to remove whatInsert Array.Constructor list of class constructors where Object specification where to insert Properties Name Type Description after Array.String list of constructor names of initalizators after which item should be inserted before Array.String list of constructor names of initalizators before which item should be inserted ruleSetHasFieldsDirective(ruleSet) Return true if ruleSet object has not empty list of fields Parameters: Name Type Description ruleSet Object specific set of rules for action Returns: if rule set has not empty fields list Type boolean × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Auth.html":{"id":"module-Auth.html","title":"Module: Auth","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Auth × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Common.html":{"id":"module-Common.html","title":"Module: Common","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Common Members &lt;inner, constant&gt; isAsync Returns true if argument is Async function &lt;inner, constant&gt; isFunc Test argument type to be 'function' Methods &lt;static&gt; compareObjectIds(firstId, secondId) Validates and compares ObjectIds in string or Object form Parameters: Name Type Description firstId string | ObjectId first id secondId string | ObjectId second id Returns: true if equal Type booelean &lt;static&gt; copyObj(obj) Copies object to secure it from changes Parameters: Name Type Description obj object original object Returns: copy of object Type object &lt;static&gt; executeObjectFunction(obj, name, params) Executes method of object in appropriate way inside Promise Parameters: Name Type Description obj object original object name string method name to execute params Array array of params Returns: results of method execution Type Promise &lt;static&gt; firstLetterToLower(string) Change first letter case to lower Parameters: Name Type Description string string input string Returns: result Type string &lt;static&gt; firstLetterToUpper(string) Change first letter case to higher Parameters: Name Type Description string string input string Returns: result Type string &lt;static&gt; getTodayDate() Returns today Date object without hours, minutes, seconds Returns: current date with 00:00:00 in ms of unix time Type number &lt;static&gt; mapBind(from, name, list) Executes method of object in apropriate way inside Promise Parameters: Name Type Description from Object original object name Object method name to execute list Array array of params Returns: results of method execution Type Promise &lt;static&gt; tryFile(filePath) Synchronously check file existence and if it's really a file Parameters: Name Type Description filePath string full path to file Returns: true if path exists and it's a file Type boolean &lt;static&gt; validateObjectId(id) Validates if string is a ObjectId Parameters: Name Type Description id string ObjectId string to validate Returns: true if check is not failed Type booelean &lt;inner&gt; objHas(obj, name) Returns true if object has field of name Parameters: Name Type Description obj object some object name string field name Returns: if object contains field with name Type boolean × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Lib.html":{"id":"module-Lib.html","title":"Module: Lib","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Lib Methods &lt;static&gt; joinToFile(target, sources, splitter) Joins many files in one Parameters: Name Type Description target string result file path sources array list of source files splitter splitter file splitter × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Default.html":{"id":"module-Model_Default.html","title":"Module: Model/Default","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Default Methods &lt;static&gt; add(data) Starts add routine Parameters: Name Type Description data object data Returns: Promise Type Promise &lt;static&gt; countWithFilter(filter) Counts record method Parameters: Name Type Description filter object | array filter rules Returns: Promise Type Promise &lt;static&gt; getOne(id, population) Retrieves one record by primary key If versioning ON, it retrieves __latest and not __closed Parameters: Name Type Description id string primary key population Array optional if needed population of some fields Returns: Promise Type Promise &lt;static&gt; getOneByID(ID) Retrieves one record by unique number ID If versioning ON, it retrieves __latest and not __closed Parameters: Name Type Description ID number some unique number identificator Returns: Promise of document, if increment is OFF - then Promise.resolve(null) Type Promise &lt;static&gt; getOneRaw(id) Retrieves one record by primary key, without any restriction Parameters: Name Type Description id string primary key Returns: Promise Type Promise &lt;static&gt; list(skip, size, sorter, filter) List record method Parameters: Name Type Description skip number number of skiped records size number length of return list sorter Object sorter rules filter Object | Array filter rules Returns: Promise Type Promise &lt;static&gt; listAll() List all records from collection If Versioning is ON restricts to __latest and not __closed By default sorts by _id in DESC Returns: Promise Type Promise &lt;static&gt; listAllAndPopulate(populate) List all record in collection and populates If Versioning is ON restricts to __latest and not __closed By default sorts by _id in DESC Parameters: Name Type Description populate object | array populate rules Returns: Promise Type Promise &lt;async, static&gt; listAndCount(skip, size, sorter, filter, search, populate) List record in collection and populates, with count of total founded records By default sorts by _id in DESC Parameters: Name Type Description skip number number of skiped records size number length of return list sorter object sorter rules filter object | array filter rules search object | array search rules populate object populate rules Returns: {list, count, pages} Type Promise &lt;static&gt; listAndPopulate(skip, size, sorter, filter, populate) List record and populate method Parameters: Name Type Description skip number number of skiped records size number length of return list sorter object sorter rules filter object | array filter rules populate object populate rules Returns: Promise Type Promise &lt;static&gt; listByField(field, list, filter, populate) Returns list of items with specific values in specific field, optionaly filtered Parameters: Name Type Description field string name of the field to search in list array list of 'id' field values filter object | array filter rules populate object populate rules Returns: Promise Type Promise &lt;static&gt; makeQuery(method, filter) Common query with filtering constructor for generic method Parameters: Name Type Description method string name of the method filter object | array filtering rules object Returns: mongoose query object Type Query &lt;static&gt; sanitizeInput(input) Sanitize input Parameters: Name Type Description input object data Returns: data; Type object &lt;static&gt; update(filter, data, many) Starts update routine Parameters: Name Type Default Description filter object search criteria data object data many boolean false if true will affect all records according to filter Returns: Promise Type Promise &lt;inner&gt; close() Closes document and saves it This is replaces remove when Versioning is ON Returns: ID Type number &lt;inner&gt; getID() Returns incremental ID for this doc Returns: ID Type number × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Enrich.html":{"id":"module-Model_Enrich.html","title":"Module: Model/Enrich","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Enrich × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Increment.html":{"id":"module-Model_Increment.html","title":"Module: Model/Increment","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Increment Methods &lt;inner&gt; formId() &lt;inner&gt; newGetNext() Generate new ID for current model and filterFields &lt;inner&gt; newRebase(modelName, ID) Sets new current ID for model Parameters: Name Type Description modelName string name of target model ID number desired new start ID for model &lt;inner&gt; notContainedInData(fields, data) Returns sub-list of fields which is not contained in object Parameters: Name Type Description fields Array.string list of fields data Object object to filter against Returns: sub-list of fields not contained in object Type Array.string &lt;inner&gt; secureUpdate(thisModel, which, cmd, opts) Some drivers versions work-arounds Parameters: Name Type Description thisModel Mongoose.Model counter model which Object filter object of update request cmd Object command object of update request opts Object options of request × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Proto.html":{"id":"module-Model_Proto.html","title":"Module: Model/Proto","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Proto × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Routine.html":{"id":"module-Model_Routine.html","title":"Module: Model/Routine","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Routine × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Validator.html":{"id":"module-Model_Validator.html","title":"Module: Model/Validator","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Validator (require(\"Model/Validator\"))() Take array of validator (https://www.npmjs.com/package/validator) rules and create array of mongoose-validator (https://www.npmjs.com/package/mongoose-validator) rules then return it × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Model_Versioning.html":{"id":"module-Model_Versioning.html","title":"Module: Model/Versioning","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Model/Versioning × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-not-node.html":{"id":"module-not-node.html","title":"Module: not-node","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: not-node Members &lt;static&gt; Application Application object &lt;static&gt; Auth Authentication module &lt;static&gt; Common Common functions &lt;static&gt; Enrich Mongoose Model additional features enricher &lt;static&gt; Error :not-node/Error Error module Type: not-node/Error &lt;static&gt; Fields Fields library manager &lt;static&gt; Increment Mongoose Model autoincrement field &lt;static&gt; Init Application initialization procedures &lt;static&gt; Manifest Manifest infrastructure &lt;static&gt; notApp Web Application &lt;static&gt; notDomain General Application &lt;static&gt; Proto Mongoose Model prototype &lt;static&gt; Routine Mongoose Documents routine operation &lt;static&gt; Versioning Mongoose Documents versioning × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-not-node_Error.html":{"id":"module-not-node_Error.html","title":"Module: not-node/Error","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: not-node/Error Methods &lt;static&gt; addError(errors, field, error) Пополняем объект ошибок Parameters: Name Type Description errors object errors field string name of the field error object error to add Returns: modified errors Type object × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-notModuleRegistrator.html":{"id":"module-notModuleRegistrator.html","title":"Module: notModuleRegistrator","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: notModuleRegistrator Search and register notModule resouces Logic to find and register resources of notModule new (require(\"notModuleRegistrator\"))() Methods &lt;static&gt; registerContent(input) Searching for content of module and registering it. Parameters: Name Type Description input Object Properties Name Type Description nModule notModule Returns: true - executed, false - no paths Type boolean × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Parser.html":{"id":"module-Parser.html","title":"Module: Parser","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Parser Methods &lt;static&gt; getRouteLine(url, modelName, actionName, actionData) Create routeLine for end-point Parameters: Name Type Description url string url in manifest format modelName string name of the model actionName string name of the action in the route file actionData object data from manifest for this action Returns: resolved router line Type string &lt;static&gt; parseLine(line, modelName, actionName) routeLine parser Parameters: Name Type Description line string raw route line like '/api/:modelName' or '/:record[_id]' modelName string is for name of the model routes collection actionName string is for name of the action in the routes collection record[fieldName] - is for client side mostly, shows what model field walue should be placed there. Samples ':record[_id]', ':record[authorId]' Returns: resolved line Type string × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Repos.html":{"id":"module-Repos.html","title":"Module: Repos","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Repos × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-Rollup.html":{"id":"module-Rollup.html","title":"Module: Rollup","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: Rollup × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"module-ShellHelpers.html":{"id":"module-ShellHelpers.html","title":"Module: ShellHelpers","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Module: ShellHelpers × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notApp.html":{"id":"notApp.html","title":"Class: notApp","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notApp notApp Application new notApp(options) Parameters: Name Type Description options object application options { mongoose: mongooseConnectionToDB modulesCollectionPaths: [__dirname + '/modules'], //each path to folder with modules modulesPaths: [], //each path to module modules: { filestore: require('not-filestore') //each npm not-* module with custom overriden name as key } } Example Application creation routine let App = new notApp({ mongoose: mongooseLink modulesCollectionPaths: [__dirname + '/modules'], //each path to folder with modules modulesPaths: [], //each path to module modules: { filestore: require('not-filestore') //each npm not-* module with custom overriden name as key } }) .importModuleFrom(__dirname+'/anotherModule', 'anotherCustomModuleName') //import module from path .importModulesFrom(__dirname+'/directoryOfUsefullessModules') .importModule(require('notModule'), 'notModule') .expose(ExpressApp); Methods collectManifest() Returns application manifest, by user credentials object Returns: manifest Type object expose(app) Exposes routes to ExpressJS application Parameters: Name Type Description app object ExpressJS application instance getManifest() Returns application manifest, by ExpressRequest Returns: manifest Type object × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notDomain.html":{"id":"notDomain.html","title":"Class: notDomain","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notDomain notDomain Domain new notDomain(options) Parameters: Name Type Description options object application options { mongoose: mongooseConnectionToDB modulesCollectionPaths: [__dirname + '/modules'], //each path to folder with modules modulesPaths: [], //each path to module modules: { filestore: require('not-filestore') //each npm not-* module with custom overriden name as key } } Example Domain creation routine let App = new new notDomain({ mongoose: mongooseLink modulesCollectionPaths: [__dirname + '/modules'], //each path to folder with modules modulesPaths: [], //each path to module modules: { filestore: require('not-filestore') //each npm not-* module with custom overriden name as key } }) .importModuleFrom(__dirname+'/anotherModule', 'anotherCustomModuleName') //import module from path .importModulesFrom(__dirname+'/directoryOfUsefullessModules') .importModule(require('notModule'), 'notModule'); Members DEFAULT_INFORMER informer - messages DEFAULT_REPORTER reporter - errors logger logger Methods &lt;async&gt; execInModules(methodName) Execute method in modules Parameters: Name Type Description methodName string name of the method to execute fabricate() Execute fabricateModels methods on all registered modules Create mongoose models. forEachMod(func) Cycles throu all imported modules, passes name, module, and itself to argument function Parameters: Name Type Description func function function to perfom some action with module getEnv(key) Returns application environment variable Parameters: Name Type Description key string name of var Returns: value or undefined Type object | undefined getLogic(name) Returns logic Parameters: Name Type Description name string 'logicName' or 'moduleName//logicName' ('User', 'moduleName//User') Returns: logic Type object getLogicFile(logicName) Returns file with logic declarations Parameters: Name Type Description logicName string 'logicName' or 'moduleName//logicName' Returns: CommonJS module object Type object getModel(name) Returns model Parameters: Name Type Description name string 'modelName' or 'moduleName//modelName' ('User', 'moduleName//User') Returns: model Type object getModelFile(modelName) Returns file with model declarations Parameters: Name Type Description modelName string 'modelName' or 'moduleName//modelName' Returns: CommonJS module object Type object getModelSchema(modelName) Returns specified by name or 'moduleName//modelName' model Schema Parameters: Name Type Description modelName string 'modelName' or 'moduleName//modelName' Returns: model schema Type object getModule(moduleName) Return module by specified module name Parameters: Name Type Description moduleName string 'moduleName' Returns: module Type object getRoute(name) Returns route Parameters: Name Type Description name string 'moduleName//routeName//functionName' ('not-user//user//add') Returns: route Type function getStatus() Returns info about whole system. Modules - total count, list, content Routes - total count, list Models - total count, list Actions - total count, list Roles - total count, list Returns: complex object with results Type Object importModule(mod, moduleName) Import module object. Chainable. Parameters: Name Type Description mod object notModule instance moduleName string name under witch module will be registered Returns: notDomain Type object importModuleFrom(modulePath, moduleName) Import single module from module dir. Chainable. Parameters: Name Type Description modulePath string path to module directory moduleName string name under witch module will be registered Returns: notDomain Type object importModulesFrom(modulesPath) Importing modules from directory. Chainable. Parameters: Name Type Description modulesPath string path to container directory Returns: notDomain Type object setEnv(key, val) Setting application environment variable Parameters: Name Type Description key string name of var val object value Returns: chainable Type notDomain shutdown(timeout) Logging message about shutdown. Emits event app:shutdown Exits from process after timeout Parameters: Name Type Default Description timeout number OPT_DEFAULT_SHUTDOWN_TIMEOUT time in ms before exit × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notManifest.html":{"id":"notManifest.html","title":"Class: notManifest","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notManifest notManifest API manifest new notManifest(app, notApp, moduleName) Parameters: Name Type Description app object express application instance notApp object notApplication instance moduleName string name of owner module Methods filterManifest(manifest, auth, role, root) Filters manifest for current user auth, role, root. Removes all actions that can not be performed Parameters: Name Type Description manifest object full raw manifest auth boolean user auth status role boolean user role status root boolean user root status Returns: filtered manifest Type object registerRoute(moduleManifest, routeName) Check if manifest file has url and actions, so we could register routes Parameters: Name Type Description moduleManifest object library of .manifest.js files routeName string name of registerRouteForAction(app, routesPath, routeLine, modelName, actionSetName, actionData) Создаем путь для одной конечной точки Parameters: Name Type Description app object express app object routesPath string directory where routes files is placed routeLine string aka '/login', '/user/:id', etc modelName string name of the mongoose model, should be exact as file name with routes for this model. If /models/theme.js contains 'Theme' mongoose model, then /routes/theme.js should ` contain routes for that model. actionSetName string name of action in routes file. Look for existing route file for understanding actionData object representation of action data Returns: if route were registered Type boolean registerRoutes(moduleManifest) Создаем пути согласно манифесту Parameters: Name Type Description moduleManifest object notManifest of module routeHasRoutes(route) Check if manifest file has url, model and actions, so we could register routes Parameters: Name Type Description route object content of .manifest.js file Returns: true if could create routes Type boolean × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notModule.html":{"id":"notModule.html","title":"Class: notModule","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notModule notModule Module representation new notModule(options) Parameters: Name Type Description options Object options Properties Name Type Description modPath String path to module location modObject Object loaded module object × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "},"notRoute.html":{"id":"notRoute.html","title":"Class: notRoute","body":" Documentation Modules AuthCommonLibModel/DefaultModel/EnrichModel/IncrementModel/ProtoModel/RoutineModel/ValidatorModel/Versioningnot-nodenot-node/ErrornotModuleRegistratorParserReposRollupShellHelpers Classes module.exportsnotAppnotDomainnotManifestnotModulenotRoute Global checkAdmincheckCredentialscheckRoleBuildercheckSupremacycheckUsercleansecompareRolescreateSpecialDEFAULT_MANIFEST_FILE_ENDINGDEFAULT_ROUTES_FILE_ENDINGDEFAULT_WS_ROUTE_ACTION_SPLITTERDEFAULT_WS_ROUTES_FILE_ENDINGEventEmitterextractAuthDataextractSafeFieldsfieldIsSafefromSchemagetIPgetMutationForFieldgetOwnerIdgetRolegetSafeFieldsForRoleActiongetSessionIdgetUserIdifAdmininitFieldinitFieldsintersect_safeisOwnerisUserLOGIC_BINDINGS_LISTMODEL_BINDINGS_LISTMODULE_BINDINGS_LISTROUTE_BINDINGS_LISTruleIsWildcardsetAuthsetGuestsetRolesetUserIdWS_ROUTE_BINDINGS_LIST Class: notRoute notRoute Route representation new notRoute(notApp, moduleName, routeName, actionName, actionData) Parameters: Name Type Description notApp object notApplication instance moduleName string name of owner module routeName string route name actionName string action name actionData object action data Methods &lt;static&gt; actionAvailableByRule(action, user) Cycle throu rules of action and checking user credentials against them If user creds comply to some rule - returns copy of rule Parameters: Name Type Description action object action rules object user object user credentials (auth, role, root) Returns: returns rule or null Type object | null exec(req, res, callback) Executes route action if such exist Parameters: Name Type Description req object Express Request Object res object Express Response Object callback function Returns: result of execution or HttpError Type object selectRule(req) Select rule from available or return null Parameters: Name Type Description req object Express Request Object Returns: rule or null Type object × Search results Close Documentation generated by JSDoc 3.6.7 on 2021-11-05T18:45:46+03:00 using the DocStrap template. "}}
     </script>
     <script type="text/javascript">
-        $(document).ready(function() {
+        $(document).ready(function () {
             Searcher.init();
         });
-        $(window).on("message", function(msg) {
+        $(window).on("message", function (msg) {
             var msgData = msg.originalEvent.data;
             if (msgData.msgid != "docstrap.quicksearch.start") {
@@ -24,8 +26,9 @@
             var results = Searcher.search(msgData.searchTerms);
-            window.parent.postMessage({"results": results, "msgid": "docstrap.quicksearch.done"}, "*");
+            window.parent.postMessage({ "results": results, "msgid": "docstrap.quicksearch.done" }, "*");
         });
     </script>
 </body>
-</html>
+</html>