express-yui
Advanced tools
Comparing version 1.3.2 to 1.4.0
{ | ||
"name": "express-yui", | ||
"description": "Express extension for YUI Applications", | ||
"version": "1.3.2", | ||
"version": "1.4.0", | ||
"homepage": "https://github.com/yahoo/express-yui", | ||
@@ -15,11 +15,11 @@ "author": "Caridy Patino <caridy@yahoo-inc.com> (http://github.com/caridy)", | ||
"dependencies": { | ||
"express-state": "~1.1.1", | ||
"express-state": "~1.2.0", | ||
"debug": "*" | ||
}, | ||
"peerDependencies": { | ||
"express": "3.x", | ||
"express": ">=3.x", | ||
"yui": "^3.15.0" | ||
}, | ||
"devDependencies": { | ||
"express": "3.x", | ||
"express": "4.x", | ||
"express3-handlebars": "*", | ||
@@ -26,0 +26,0 @@ "jshint": "~1.1.0", |
@@ -17,6 +17,6 @@ Express YUI | ||
This compontent extends express by adding a new `app.yui` member to the express | ||
application. It is responsible for controlling and exposing both the yui | ||
configuration and the application state on the client side as well has | ||
controlling the yui instance on the server. | ||
This component extends Express by adding a new `app.yui` member to the Express | ||
application. It is responsible for controlling and exposing both the YUI | ||
configuration and the application state on the client side as well as | ||
controlling the YUI instance on the server. | ||
@@ -37,19 +37,17 @@ | ||
### Features | ||
* Control YUI config and seed modules per request. | ||
* Provide basic configurations for CDN, debugging, and other common conditions in YUI. | ||
* Provide middleware to serve `static` assets from origin server. | ||
* Provide middleware to `expose` the app `state` object with the YUI config and seed URLs. | ||
* control yui config and seed modules per request. | ||
* provide basic configurations for cdn, debug, and other common conditions in yui. | ||
* provide middleware to serve `static` assets from origin server. | ||
* provide middleware to `expose` the app `state` object with the yui config and seed urls. | ||
Usage | ||
----- | ||
### Extending express functionalities | ||
### Extending Express functionality | ||
`express-yui` is a conventional `express` extension, which means it will extend | ||
the functionalities provided on `express` by augmenting the express app instance | ||
functionality provided in `express` by augmenting the Express app instance | ||
with a new member called `yui`. At the same time, `express-yui` provides a set of | ||
static methods that you can call directly off the `express-yui` module. These | ||
methods include utility methods and express middleware. | ||
methods include utility methods and Express middleware. | ||
@@ -77,5 +75,5 @@ Here is an example of how to extend an `express` app with `express-yui`: | ||
To expose the state of the app (which includes the computed yui configuration | ||
based on the configuration defined through the express app instance), you can | ||
call the `expose` middleware for any particular route: | ||
To expose the state of the app (which includes the computed YUI configuration | ||
based on the configuration defined through the Express app instance), you can | ||
call the `expose` middleware for any route: | ||
@@ -120,2 +118,5 @@ ```js | ||
[locator]: https://github.com/yahoo/locator | ||
[locator-yui]: https://github.com/yahoo/locator-yui | ||
```js | ||
@@ -159,13 +160,13 @@ var express = require('express'), | ||
As a result, any yui module under the `__dirname` folder or any npm dependency marked as | ||
As a result, any YUI module under the `__dirname` folder or any npm dependency marked as | ||
a locator bundle will be built by the `locator-yui` plugin, and become automatically | ||
available on the client, and potentially on the server as well. This means you | ||
no longer need to manually define loader metadata or any kind of yui config to load those | ||
no longer need to manually define loader metadata or any kind of YUI config to load those | ||
modules, and `express-yui` will be capable to handle almost everthing for you. | ||
### Using yui modules on the server side | ||
### Using YUI modules on the server side | ||
Using modules on the server is exactly the same that using them on the client thru | ||
`app.yui.use()` statement. Here is an example of the use of yql module to load the | ||
Using modules on the server is exactly the same that using them on the client through | ||
`app.yui.use()` statement. Here is an example of the use of YQL module to load the | ||
weather forecast and passing the result into the template: | ||
@@ -201,3 +202,3 @@ | ||
Ideally, you will use a CDN to serve all static assets for your application, but your | ||
express app is perfectly capable to do so, and even serve as origin server for your CDN. | ||
Express app is perfectly capable of doing so, and even serving as the origin server for your CDN. | ||
@@ -210,3 +211,3 @@ ```js | ||
With this configuration, a group called `foo` with version `1.2.3`, and `yui` | ||
version `3.11.0`, it will produce urls like these: | ||
version `3.11.0`, it will produce URLs like these: | ||
@@ -216,4 +217,4 @@ * /yui-3.11.0/yui-base/yui-base-min.js | ||
Any of those urls will be valid because `express-yui` static method produces an express app | ||
that can be mounted under your express application to serve yui core modules and application | ||
Any of those URLs will be valid because `express-yui` static method produces an Express app | ||
that can be mounted under your Express application to serve YUI core modules and application | ||
specific modules (modules compiled by [locator][] into the `build` folder). | ||
@@ -250,3 +251,3 @@ | ||
You can find the [API Docs][] under `apidocs` folder, and you can browse it thru this url: | ||
You can find the [API Docs][] under `apidocs` folder, and you can browse it through this URL: | ||
@@ -253,0 +254,0 @@ * http://rawgithub.com/yahoo/express-yui/master/apidocs/index.html |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
265
92080
20
1641
1
+ Addedaccepts@2.0.0(transitive)
+ Addedarray-flatten@3.0.0(transitive)
+ Addedbody-parser@2.0.2(transitive)
+ Addedbytes@3.1.2(transitive)
+ Addedcall-bind-apply-helpers@1.0.1(transitive)
+ Addedcall-bound@1.0.3(transitive)
+ Addedcontent-disposition@1.0.0(transitive)
+ Addedcookie@0.7.1(transitive)
+ Addedcookie-signature@1.2.2(transitive)
+ Addeddebug@3.1.04.3.6(transitive)
+ Addeddestroy@1.2.0(transitive)
+ Addeddunder-proto@1.0.1(transitive)
+ Addedencodeurl@1.0.22.0.0(transitive)
+ Addedes-define-property@1.0.1(transitive)
+ Addedes-errors@1.3.0(transitive)
+ Addedes-object-atoms@1.0.0(transitive)
+ Addedetag@1.8.1(transitive)
+ Addedexpress@5.0.1(transitive)
+ Addedexpress-state@1.2.0(transitive)
+ Addedfinalhandler@2.0.0(transitive)
+ Addedforwarded@0.2.0(transitive)
+ Addedfresh@0.5.22.0.0(transitive)
+ Addedfunction-bind@1.1.2(transitive)
+ Addedget-intrinsic@1.2.6(transitive)
+ Addedgopd@1.2.0(transitive)
+ Addedhas-symbols@1.1.0(transitive)
+ Addedhasown@2.0.2(transitive)
+ Addedhttp-errors@2.0.0(transitive)
+ Addediconv-lite@0.5.20.6.3(transitive)
+ Addedipaddr.js@1.9.1(transitive)
+ Addedis-promise@4.0.0(transitive)
+ Addedmath-intrinsics@1.1.0(transitive)
+ Addedmedia-typer@1.1.0(transitive)
+ Addedmerge-descriptors@2.0.0(transitive)
+ Addedmime-types@3.0.0(transitive)
+ Addedms@2.1.2(transitive)
+ Addednegotiator@1.0.0(transitive)
+ Addedobject-inspect@1.13.3(transitive)
+ Addedon-finished@2.4.1(transitive)
+ Addedonce@1.4.0(transitive)
+ Addedpath-to-regexp@8.2.0(transitive)
+ Addedproxy-addr@2.0.7(transitive)
+ Addedqs@6.13.0(transitive)
+ Addedrange-parser@1.2.1(transitive)
+ Addedraw-body@3.0.0(transitive)
+ Addedrouter@2.0.0(transitive)
+ Addedsafe-buffer@5.2.1(transitive)
+ Addedsafer-buffer@2.1.2(transitive)
+ Addedsend@1.1.0(transitive)
+ Addedserve-static@2.1.0(transitive)
+ Addedsetprototypeof@1.2.0(transitive)
+ Addedside-channel@1.1.0(transitive)
+ Addedside-channel-list@1.0.0(transitive)
+ Addedside-channel-map@1.0.1(transitive)
+ Addedside-channel-weakmap@1.0.2(transitive)
+ Addedstatuses@2.0.1(transitive)
+ Addedtoidentifier@1.0.1(transitive)
+ Addedtype-is@2.0.0(transitive)
+ Addedutils-merge@1.0.1(transitive)
+ Addedwrappy@1.0.2(transitive)
- Removedaccepts@1.2.131.3.8(transitive)
- Removedbase64-url@1.2.1(transitive)
- Removedbasic-auth@1.0.4(transitive)
- Removedbasic-auth-connect@1.0.0(transitive)
- Removedbatch@0.5.3(transitive)
- Removedbody-parser@1.13.3(transitive)
- Removedbytes@2.1.02.4.0(transitive)
- Removedcommander@2.6.0(transitive)
- Removedcompressible@2.0.18(transitive)
- Removedcompression@1.5.2(transitive)
- Removedconnect@2.30.2(transitive)
- Removedconnect-timeout@1.6.2(transitive)
- Removedcontent-disposition@0.5.0(transitive)
- Removedcookie@0.1.3(transitive)
- Removedcookie-parser@1.3.5(transitive)
- Removedcookie-signature@1.0.6(transitive)
- Removedcore-util-is@1.0.3(transitive)
- Removedcrc@3.3.0(transitive)
- Removedcsrf@3.0.6(transitive)
- Removedcsurf@1.8.3(transitive)
- Removeddebug@2.2.0(transitive)
- Removeddepd@1.0.11.1.2(transitive)
- Removeddestroy@1.0.31.0.4(transitive)
- Removederrorhandler@1.4.3(transitive)
- Removedescape-html@1.0.2(transitive)
- Removedetag@1.7.0(transitive)
- Removedexpress@3.21.2(transitive)
- Removedexpress-session@1.11.3(transitive)
- Removedexpress-state@1.1.4(transitive)
- Removedfinalhandler@0.4.0(transitive)
- Removedforwarded@0.1.2(transitive)
- Removedfresh@0.3.0(transitive)
- Removedhttp-errors@1.3.1(transitive)
- Removediconv-lite@0.4.110.4.13(transitive)
- Removedipaddr.js@1.0.5(transitive)
- Removedisarray@0.0.1(transitive)
- Removedmerge-descriptors@1.0.0(transitive)
- Removedmethod-override@2.3.10(transitive)
- Removedmime@1.3.4(transitive)
- Removedminimist@0.0.8(transitive)
- Removedmkdirp@0.5.1(transitive)
- Removedmorgan@1.6.1(transitive)
- Removedms@0.7.10.7.2(transitive)
- Removedmultiparty@3.3.2(transitive)
- Removednegotiator@0.5.30.6.3(transitive)
- Removedon-finished@2.3.0(transitive)
- Removedon-headers@1.0.2(transitive)
- Removedpause@0.1.0(transitive)
- Removedproxy-addr@1.0.10(transitive)
- Removedqs@4.0.0(transitive)
- Removedrandom-bytes@1.0.0(transitive)
- Removedrange-parser@1.0.3(transitive)
- Removedraw-body@2.1.7(transitive)
- Removedreadable-stream@1.1.14(transitive)
- Removedresponse-time@2.3.3(transitive)
- Removedrndm@1.2.0(transitive)
- Removedsend@0.13.00.13.2(transitive)
- Removedserve-favicon@2.3.2(transitive)
- Removedserve-index@1.7.3(transitive)
- Removedserve-static@1.10.3(transitive)
- Removedstatuses@1.2.11.5.0(transitive)
- Removedstream-counter@0.2.0(transitive)
- Removedstring_decoder@0.10.31(transitive)
- Removedtsscmp@1.0.5(transitive)
- Removeduid-safe@2.0.02.1.4(transitive)
- Removedutils-merge@1.0.0(transitive)
- Removedvary@1.0.1(transitive)
- Removedvhost@3.0.2(transitive)
Updatedexpress-state@~1.2.0