Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

hapiest-cloudfront-url

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

hapiest-cloudfront-url

Maps origin URLs to an AWS Cloudfront distribution URL

  • 0.0.5
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Install

npm install --save hapiest-cloudfront-url

Basic usage

I highly recommend you use this with node-config if possible though it's not a requirement.

With node-config

Include a config section that adheres to the following (assuming JSON format):

{
    "myCloudfrontDistribution": {
      "cloudfrontDomainName": "somedomain.cloudfront.net",
      "enabled": "true",
      "origins": [{
        "host": "mybucket.s3.amazonaws.com",
        "path": "/public"
      },{
        "host": "www.mysite.com",
        "path": "my/crazy/path"
      },{
        "host": "localhost",
        "port": 3000,
        "path": "localstorage/bucket/public"
      }]
    }
}

You then simply use the createFromNodeConfig function provided:

const NodeConfig = require('config');
const CfUrlServiceFactory = require('hapiest-cloudfront-url');
const cfUrlService = CfUrlServiceFactory.createFromNodeConfig(NodeConfig, 'myCloudfrontDistribution');

Without node-config

const CfUrlServiceFactory = require('hapiest-cloudfront-url');
const cfUrlService = CfUrlServiceFactory.create({
    cloudfrontDomainName: 'somedomain.cloudfront.net',
    enabled: true,
    origins: [{
        host: 'mybucket.s3.amazonaws.com',
        path: '/public'
    },{
        host: 'www.mysite.com',
        path: 'my/crazy/path'
    },{
        host: 'localhost',
        port: 3000,
        path: 'localstorage/bucket/public'
    }]
});

Converting an origin URL to Cloudfront URL

When the originUrl provided the convertUrl function matches one of the URLs associated with the distribution, the return value is a URL relative to the Cloudfront domain.

const originUrl = 'http://mybucket.s3.amazonaws.com/public/images/image.jpg';
const cfUrl = cfUrlService.convertUrl(originUrl);
// http://somedomain.cloudfront.net/images/image.jpg

const originUrl2 = 'https://www.mysite.com/my/crazy/path/something.txt';
const cfUrl2 = cfUrlService.convertUrl(originUrl2);
// https://somedomain.cloudfront.net/something.txt

const originUrl3 = 'http://localhost:3000/localstorage/bucket/public/images/thumb.jpg'
const cfUrl3 = cfUrlService.convertUrl(originUrl3);
// http://somedomain.cloudfront.net/images/thumb.jpg

If the provided URL does not match an origin, the provided URL is simply returned:

const originalUrl = 'http://www.someothersite.com/does/not/match/an/origin.jpg';
const cfUrl = cfUrlService.convertUrl(originUrl);
// 'http://www.someothersite.com/does/not/match/an/origin.jpg'

When enabled=false, convertUrl always returns the original URL though you can override that behavior by passing in a second parameter of true.

Keywords

FAQs

Package last updated on 13 Oct 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc