npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@netacea/cloudfront

v5.2.24

Published

Netacea Cloudfront CDN integration

Downloads

1,156

Readme

Netacea CloudFront

Netacea Header

npm   TypeScript

@netacea/cloudfront is a package designed to add Netacea functionality to CloudFront Lambda@Edge.

Installation

🌻 Starting fresh

Quickest way to get started, is pulling the Netacea CloudFront template repository from github and following the steps in there to get up and running.

git clone https://github.com/Netacea/cloudfront-worker-template-typescript.git

Follow the README.md in the cloudfront-worker-template-typescript repository to get this deployed.

✍ Existing Lambda@Edge worker

Run the following command to install the netacea worker

npm i @netacea/cloudfront --save

Require (javascript) or import (typescript) the worker

// JAVASCRIPT:
const NetaceaCloudFront = require('@netacea/cloudfront').default
// TYPESCRIPT:
import NetaceaCloudFront from '@netacea/cloudfront'

Then declare a variable for the worker.

const worker = new NetaceaCloudFront({
  apiKey: 'your-api-key', // REQUIRED
  secretKey: 'your-secret-key', // REQUIRED IF MITIGATING
  kinesisStreamName: 'your-kinesis-stream-name', // REQUIRED
  kinesisAccessKey: 'your-kinesis-access-key', // REQUIRED
  kinesisSecretKey: 'your-kinesis-secret-key' // REQUIRED if not using secretsManager
})

It's best security practice to not commit your apiKey, secretKey, kinesisAccessKey, kinesisSecretKey to any repository.

The code will run in the Viewer Request, Origin Response and Viewer Response events.

Example Viewer Request:

import NetaceaCloudFront from '@netacea/cloudfront'
const worker = new NetaceaCloudFront({
  apiKey: 'your-api-key', // REQUIRED
  secretKey: 'your-secret-key', // REQUIRED IF MITIGATING
  kinesisStreamName: 'your-kinesis-stream-name', // REQUIRED
  kinesisAccessKey: 'your-kinesis-access-key', // REQUIRED
  kinesisSecretKey: 'your-kinesis-secret-key' // REQUIRED if not using secretsManager
})

export const handler = async (event: any, context: any, callback: any): Promise<any> => {
  context.callbackWaitsForEmptyEventLoop = false
  const netaceaResponse = await worker.run(event)
  const { request, response } = netaceaResponse.Records[0].cf
  if (response !== undefined) {
    return callback(null, response)
  }
  return callback(null, request)
}

Example Origin Response:

import NetaceaCloudFront from '@netacea/cloudfront'
const worker = new NetaceaCloudFront({
  apiKey: 'your-api-key', // REQUIRED
  secretKey: 'your-secret-key', // REQUIRED IF MITIGATING
  kinesisStreamName: 'your-kinesis-stream-name', // REQUIRED
  kinesisAccessKey: 'your-kinesis-access-key', // REQUIRED
  kinesisSecretKey: 'your-kinesis-secret-key' // REQUIRED if not using secretsManager
})

export const handler = async (event: any, context: any, callback: any): Promise<void> => {
  context.callbackWaitsForEmptyEventLoop = false
  if (event.Records[0].cf.response.status >= 400) {
    worker.addNetaceaCookiesToResponse(event)
    worker.ingest(event)
  }
  return callback(null, event.Records[0].cf.response)
}

Example Viewer Response:

import NetaceaCloudFront from '@netacea/cloudfront'
const worker = new NetaceaCloudFront({
  apiKey: 'your-api-key', // REQUIRED
  secretKey: 'your-secret-key', // REQUIRED IF MITIGATING
  kinesisStreamName: 'your-kinesis-stream-name', // REQUIRED
  kinesisAccessKey: 'your-kinesis-access-key', // REQUIRED
  kinesisSecretKey: 'your-kinesis-secret-key' // REQUIRED if not using secretsManager
})

export const handler = async (event: any, context: any, callback: any): Promise<void> => {
  context.callbackWaitsForEmptyEventLoop = false
  if (event.Records[0].cf.response.status < 400) {
    worker.addNetaceaCookiesToResponse(event)
    worker.ingest(event)
  }
  return callback(null, event.Records[0].cf.response)
}

This line is very important for ingest to take place. Without this, latency will be added to some requests.

context.callbackWaitsForEmptyEventLoop = false

⬆ Updating

npm i @netacea/cloudfront@latest --save

This will update the netacea module to the latest version.