topic My First NPM Package in Alfresco Archive

topic My First NPM Package in Alfresco Archive https://connect.hyland.com/t5/alfresco-archive/my-first-npm-package/m-p/160187#M114173 <HTML><HEAD></HEAD><BODY><PRE __default_attr="info" __jive_macro_name="alert" alert="info" class="jive_text_macro jive_macro_alert">This is a personal blog post that is primarily intended for tracking my own learning rather than provided to the Alfresco Community for educational purposes. However if you find it useful, informative or have any comments on it then please comment below.</PRE>At the end of <A _jive_internal="true" href="https://community.alfresco.com/people/ddraper/blog/2016/12/28/a-better-way-of-writing-and-testing-components" rel="nofollow noopener noreferrer">my last blog post</A> I was looking at ways in which to write better components by abstracting as much non-browser specific code to utility modules. The idea of this was to improve testing so to minimize the amount of code that needed to be tested against multiple browsers. The side-effect of this approach means producing common capabilities that can be easily re-used against multiple web application frameworks such as <A href="https://vuejs.org/" rel="nofollow noopener noreferrer">Vue.js</A>, <A href="https://facebook.github.io/react/" rel="nofollow noopener noreferrer">React</A>, <A href="https://angular.io/" rel="nofollow noopener noreferrer">Angular</A>, etc.As I developed my application I found myself pulling in more and more code and configuration that was already available in one of the many <A href="https://github.com/vuejs/vue-cli" rel="nofollow noopener noreferrer">Vue.js CLI</A> template projects. Most UI frameworks now come with a CLI that makes it easy to rapidly build out an application. I want to test out other frameworks so I thought it would make sense to abstract the core authentication and routing code into a separate project so that it could be imported into multiple different projects created using a CLI.I followed some of the approach in <A href="https://medium.com/@nohkachi/how-to-create-reusable-modules-in-express-4-x-by-using-events-for-loose-coupling-a63e89e44b22#.yfv2pa32f" rel="nofollow noopener noreferrer">this blog post</A> and then mostly following <A href="https://medium.com/@jdaudier/how-to-create-and-publish-your-first-node-js-module-444e7585b738#.u9bogqmzw" rel="nofollow noopener noreferrer">these instructions</A> on setting it up as <A href="https://www.npmjs.com/package/alfresco-auth-router" rel="nofollow noopener noreferrer">an NPM package</A>. Some useful information on testing the package prior to publication in described <A href="http://podefr.tumblr.com/post/30488475488/locally-test-your-npm-modules-without-publishing" rel="nofollow noopener noreferrer">here</A>. It was also necessary to follow <A href="http://stackoverflow.com/questions/16631064/declare-multiple-module-exports-in-node-js" rel="nofollow noopener noreferrer">this information</A> in order to create a package with multiple exports.The end result means that it is now possible to to install this new package with the following command:<PRE class="language-none line-numbers"><CODE>npm install alfresco-auth-router --save-dev‍‍</CODE></PRE>Or if you prefer <A href="https://yarnpkg.com/" rel="nofollow noopener noreferrer">Yarn</A>:<PRE class="language-none line-numbers"><CODE>yarn add --dev alfresco-auth-router‍‍</CODE></PRE>Then it is just a simple case of setting up the <A href="http://passportjs.org/" rel="nofollow noopener noreferrer">Passport.js</A> and <A href="https://expressjs.com/en/guide/routing.html" rel="nofollow noopener noreferrer">Express routing</A> using the following code in the server.js file:<PRE class="language-javascript line-numbers"><CODE>passport.use(alfrescoAuthRouter.passportStrategy()); passport.serializeUser(alfrescoAuthRouter.serializeUser); passport.deserializeUser(alfrescoAuthRouter.deserializeUser); server.use('/auth', alfrescoAuthRouter.authRoutes(passport)); server.use('/proxy', alfrescoAuthRouter.apiRoutes());‍‍‍‍‍‍‍‍‍‍</CODE></PRE>This should make it much simpler to test out lots of different UI frameworks on Node.js against REST APIs provided by an Alfresco Repository. You can view this in <A href="https://github.com/draperd/AlfrescoNodeJS" rel="nofollow noopener noreferrer">my project</A> by checking out <A href="https://github.com/draperd/AlfrescoNodeJS/releases/tag/Blog9" rel="nofollow noopener noreferrer">this tag</A>.</BODY></HTML> Wed, 28 Dec 2016 17:16:20 GMT ddraper 2016-12-28T17:16:20Z My First NPM Package https://connect.hyland.com/t5/alfresco-archive/my-first-npm-package/m-p/160187#M114173 This is a personal blog post that is primarily intended for tracking my own learning rather than provided to the Alfresco Community for educational purposes. However if you find it useful, informative or have any comments on it then please comment below.At the end of my last blog post I was looking Wed, 28 Dec 2016 17:16:20 GMT https://connect.hyland.com/t5/alfresco-archive/my-first-npm-package/m-p/160187#M114173 ddraper 2016-12-28T17:16:20Z