yukon - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

index.js

@@ -1,3 +0,159 @@
-module.exports = function() {
-  console.log('hello world');
-}
+var _ = require('lodash');
+
+module.exports = function(app, config) {
+  var yukonConfig = _.merge(defaultConfig, config);
+  yukonConfig.debug = yukonConfig.customDebug || yukonConfig.yukonCustomDebug;
+
+  var debug = yukonConfig.debug('yukon->index');
+  debug('initializing');
+  
+  var api = require('./api.js')(app, yukonConfig);
+
+  yukonConfig.noduleDefaults.middlewares = [
+    config.appPreApi  || passThrough,
+    require('./preApi')(app, yukonConfig, api), // preprocessing logic before APIs are called
+
+    config.appDoApi   || passThrough,
+    require('./doApi')(app, yukonConfig), // handles all API calls in parallel
+
+    config.appPostApi || passThrough,
+    require('./postApi')(app, yukonConfig), // common post-processing logic after all APIs return
+
+    config.appFinish  || passThrough,
+    require('./finish')(app, yukonConfig), // finish with json or html
+  ];
+  
+  // nodulejs finds and loads nodules based on config below, registers routes with express based on nodule route and other properties
+  require('nodulejs')(app, yukonConfig); 
+};
+
+function passThrough(req, res, next) {
+  next();
+}
+
+var defaultConfig =  {
+  // required, to set apiServer on individual nodule, use nodule.apiHost
+  apiServer: [],
+
+  // called at the start of every api call, things like timers and custom headers can be set here
+  beforeApiCall: function(callArgs, req, res) { },
+
+  // called after every api call, regardless of success or failure, do things like logging here
+  // Note: called before onApiSuccess and onApiError
+  afterApiCall: function(callArgs, req, res) { },
+
+  // called on every successful API call (can be called multiple times per request if running multiple API calls)
+  onApiSuccess: function(req, res) { },
+
+  // called on every failed API call (should only be called once per request as framework routes into error flow on first unhandled error)
+  onApiError: function(req, res) { },
+
+  // these API calls will always be assumed success, all others will be routed through error flow unless handleError is set at the nodule level
+  defaultValidStatusCodes: [200, 204],
+
+  // directory to start in for templateNames with a directory in them
+  templateRoot: 'nodules',
+
+  // default debug function
+  yukonCustomDebug: function(identifier) {   
+    return function(msg) {
+      if (defaultConfig.debugToConsole) console.log(identifier+': '+msg);
+    };
+  },
+
+  noduleDefaults: {
+    // array of middleware functions to be executed on each request, set in yukon init method
+    middlewares: null, 
+
+    // use to skip API call(s) altogether
+    skipApi: false,
+
+    // array of optional functions to be called with the apis specified in the nodule (IE - global or semi-global calls like getProfile, getGlobalNav)
+    // these can be conditional per nodule/request if set in the appDoApi middleware
+    apiCalls: [],
+
+    // arguments (if needed) to go with the apiCalls above
+    apiAgs: [],
+
+    // Properties inherited from nodule.js (see nodule conf (TODO:link here) as these may get out of date):
+    // middlewares (REQUIRED) - array of (or function which returns array of) middleware functions which will be called in order for each nodule on each express request
+    // route (REQUIRED) - needs to be defined in each nodule, and be unique
+    // routeVerb - (default:get)
+    // routeIndex - (default:0)
+
+    // NOTE: the params below call be mutated in the preProcessor using this.myParam notation
+    //       they can also be mutated in the postProcessor if the API calls are not dependent on them (IE - templateName)
+
+    //  app looks for [nodule name].[ templateExt ] if not specified and request is not JSON
+    templateName: null,
+
+    // app looks for templates with the same filename + this extension
+    templateExt: '.jade',
+
+    // can be array or string - path to API server, can be used to over-ride default 
+    apiHost: null, 
+
+    // path to API - note: if path ends with a / framework automatically appends req.params.id
+    // Notes on multiple APIs per component:
+    //    1. Set the apiPath property to an array instead of a string.
+    //    2. The app places each API call in res.locals.data1, res.locals.data2, etc. 
+    //    3. If any of the APIs needs params, make sure you put them in the correct slot. IE - apiParams[1] = {indludecta:'true'};
+    //    4. If an array of stubNames is created - those will be used in place of the corresponding APIs when in stub mode.
+    //    6. As before, to use the same stub for each call just leave stubName blank (looks for standard name) or specify a custom string.
+    //    7. As always you can set any of the properties above dynamically inside your preProcessor using the this.[propertyName] nomenclature.
+    apiPath: null,
+
+    // params to send to API server
+    // If apiVerb is 'post', this can be a deep json object (apiBodyType=json) or a shallow object of name value pairs (apiBodyType=form)
+    // If using multiple apiPaths, make sure you put the apiParams in the correct slot. IE - apiParams[1] = {indludecta:'true'};
+    apiParams: {},
+
+    // valid values: get, post, put, del - or array of these if different values are needed for different calls (uses 'del' since delete is a reserved word)
+    apiVerb: 'get',
+
+    // valid values: json, form  - or array of these if different values are needed for different calls (use 'form' for a standard post submit with name/value pairs - everything else is json body)
+    apiBodyType: 'json',
+
+    // array of cookie names to look for in the request and pass to the browser (with value from request cookie)
+    apiCookies: [], // TODO - add cookies to custom headers and handle outside api.js as this is an edgy edge case
+
+    // set to > 0 (milliseconds) force stub calls to simualate a longer api call - works for API or Stubs
+    // WARNING: don't forget to turn this off in production mode!
+    apiSleep: 0,
+
+    // (numeric) - max API return time in ms, needs to be array if more than one API is called, set other values to null to use default - IE - [null,20000,null]
+    timeout: null,
+
+    // can be [null|true|number|array] - tells the component to handle the error rather than the framework
+    //   if there are multiple APIs, set a value for each API - within an array
+    //   set to true to handle all API errors locally, 
+    //   set to a number (IE - 503 to handle all 503 statusCodes)
+    //   set to array (IE [404,502,503] to handle all those statusCodes)
+    // NOTE: statusCodes 200,204,400,401,403 are always handled by the component
+    handleError: null,
+
+    // if not specified, app looks for [nodule name].stub.json - looks for stubName first in nodule folder, then in app/shared/stubs
+    // Note: can be array to use stubs for multiple api calls
+    stubName: null,
+
+    // alternate place to look for stubs than the nodule dir, can be changed at request-time if needed
+    sharedStubPath: null,
+
+    // 'html', 'json' only current values - use this to force any nodule to behave like a json or html call regardless of naming conventions or directory conventions
+    contentType: null,
+
+    // set true to force api to use stub (IE - if API isn't ready yet)
+    forceStub: false,
+
+    // set this to an Error() instance to "throw" an error from your page - see channel.js for example
+    error: null,
+
+    // use to manipulate query params or other business logic before api call(s)
+    preProcessor: function(req, res) { },
+
+    // use to process data returned from the API before calling template or sending back to client as JSON
+    postProcessor: function(req, res) { },
+    // NOTE: one important property you can set in this function is res.renderData - this is the data sent to the jade template or back to the client as JSON
+    // if you don't specify res.renderData the app uses res.locals.data1
+  }    
+};

package.json

 {
   "name": "yukon",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Self-discovering component-based API-driven framework based on express",
@@ -11,10 +11,14 @@ "main": "index.js",
     "type": "git",
-    "url": "https://github.com/JackSpaniel/yukon"
+    "url": "https://github.com/jackspaniel/yukon"
   },
-  "author": "Jackspaniel Solutions <[e-mail]> (https://github.com/JackSpaniel)",
+  "author": "jackspaniel Solutions <[e-mail]> (https://github.com/jackspaniel)",
   "license": "Apache 2.0",
   "bugs": {
-    "url": "https://github.com/JackSpaniel/yukon/issues"
+    "url": "https://github.com/jackspaniel/yukon/issues"
   },
-  "homepage": "https://github.com/JackSpaniel/yukon"
+  "homepage": "https://github.com/jackspaniel/yukon",
+  "dependencies": {
+    "lodash": "^2.4.1",
+    "superagent": "^0.21.0"
+  }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

30493

increased by4671.99%

Number of package files

9

increased by350%

Lines of code

354

increased by17600%

Number of medium quality alerts

1

decreased by-50%

Number of lines in readme file

5

increased byInfinity%

Worsened metrics

Dependency count

2

increased byInfinity%

Number of low supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedlodash@^2.4.1

• + Addedsuperagent@^0.21.0

• + Addedasync@0.9.2(transitive)

• + Addedcombined-stream@0.0.7(transitive)

• + Addedcomponent-emitter@1.1.2(transitive)

• + Addedcookiejar@2.0.1(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addeddebug@2.6.9(transitive)

• + Addeddelayed-stream@0.0.5(transitive)

• + Addedextend@1.2.1(transitive)

• + Addedform-data@0.1.3(transitive)

• + Addedformidable@1.0.14(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedisarray@0.0.1(transitive)

• + Addedlodash@2.4.2(transitive)

• + Addedmethods@1.0.1(transitive)

• + Addedmime@1.2.11(transitive)

• + Addedms@2.0.0(transitive)

• + Addedqs@1.2.0(transitive)

• + Addedreadable-stream@1.0.27-1(transitive)

• + Addedreduce-component@1.0.1(transitive)

• + Addedstring_decoder@0.10.31(transitive)

• + Addedsuperagent@0.21.0(transitive)