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

@axeptio/s3-cloudfront-static-deploy

v2.0.1

Published

Simple node API for rapid file deployment (like JSON or other) in an AWS S3 bucket with cloudFront invalidation, versioning and rollback.

Downloads

543

Readme

S3 CloudFront static deploy

Simple node API for rapid file deployment (like JSON or other) in an AWS S3 bucket with cloudFront invalidation, versioning and rollback.

:rocket: Installation

npm i @axeptio/s3-cloudfront-static-deploy

For the moment you have to create and configure your bucket authorization and cloudfront from AWS

:gear: API

Parameters

AWS Clients

Instead of instanciating its own S3 and CloudFront clients, this package requires you to pass yours as the first parameter of every API functions. For example:

const AWS = require('aws-sdk');
const clients = {
  s3: new AWS.S3(),
  cloudfront: new AWS.CloudFront()
};
publishFile(clients, options);

Options

The second parameter of the functions are the options required to execute this specific job. Documented in JSDoc.

Event Handlers

Due to their async nature, functions of this lib return only promises. When completed, a function will resolve, and in any erroneous case, it will reject. If you need extra control over the execution flow, (especially when there are several steps), you can use the onEvent param that is always the last parameter of the function call.

publishFile(clients, options, event => {
  console.log(event.type); // "success" / "error" / "info" / "progress"
  console.log(event.method); // "invalidateFile"
  console.log(event.message); // "successfully invalidated the file"
});

Available functions

  • enableVersioning Enabled or suspended versionning of a bucket. Options are: bucket, isEnabled
  • publishFile Create/update and invalidate file for cloudfront deploying. (tested only with a JSON stringify)
  • publishFiles Create/update and invalidate files for cloudfront deploying. (tested only with a JSON stringify)
  • rollbackFile Mark deleted the lasted version of a file in a bucket and invalidate on cloudfront.
  • rollbackFiles Mark deleted the lasted version of files in a bucket and invalidate on cloudfront.
  • listFileVersions List all versions of a file in a bucket.
  • putFile Create or update a file in a bucket. (tested only with a JSON stringify)
  • deleteFile Apply deleted mark on a last version of a file in a bucket.
  • deleteFiles Apply deleted mark on last version of files in a bucket.
  • invalidateFile Invalidate file in cloudfront for deploying
  • invalidateFiles Invalidate files in cloudfront for deploying

:eyes: Testing

You can test the deploying with sending a Json with random data (words)

export BUCKET_NAME=${S3BucketName} DISTRIBUTION_ID=${CloudFrontDistributionID} && npm run test