@ampproject/toolbox-runtime-version

AMP Runtime Version

Use it to query cdn.ampproject.org for the current release or canary version of the AMP Runtime. Uses a stale-while-revalidate caching strategy to avoid network requests in the critical path.

You can use the API to re-write AMP runtime URLs to their versioned counter parts to improve browser caching, e.g. to replace:

https://cdn.ampproject.org/v0.css

with:

https://cdn.ampproject.org/rtv/001515617716922/v0.css

Installation

Install via:

npm install @ampproject/toolbox-runtime-version

Usage

Basic usage:

const runtimeVersion = require('@ampproject/toolbox-runtime-version');

// Release version
runtimeVersion.currentVersion().then(version => {
  console.log(version);
});

// Canary version
runtimeVersion.currentVersion({canary: true}).then(version => {
  console.log(version);
});

// Rewriting cache URLs
const ampRuntimeUrl = 'https://cdn.ampproject.org/v0.js';
const version = await runtimeVersion.currentVersion();
const versionedAmpRuntimeUrl = ampRuntimeUrl.replace(
  'https://cdn.ampproject.org/',
  'https://cdn.ampproject.org/rtv/' + version + '/'
);
console.log(versionedAmpRuntimeUrl);

Changelog

2.0.0

Migration notes:

• The SeparateKeyframe transformer's compress option has been renamed to minify. The same option will also be used by the MinifyHtml transformer. The default value continues to be true.

• The API for implementing a custom transformer has changed. We no longer monkey patch the node class, but instead rely on helper methods defined in NodeUtils:

  const {firstChildByTag, appendChild, createElement} =
  require('@ampproject/toolbox-optimizer').NodeUtils; class CustomTransformer { constructor(config)
  { this.log_ = config.log.tag('CUSTOM'); } transform(tree, params) { this.log_.info('Running custom
  transformation for ', params.filePath); const html = firstChildByTag(tree, 'html'); if (!html)
  return; const head = firstChildByTag(html, 'head'); if (!head) return; const desc =
  createElement('meta', { name: 'description', content: 'this is just a demo', }); appendChild(head,
  desc); } }
  

:rocket: Enhancement

• core, optimizer
  • #588 Add MinifyHtml transformer (@sebastianbenz)
• cli, optimizer
  • #576 migrate to htmlparser2 (@sebastianbenz)
  • #573 Auto inject missing AMP boilerplate (@sebastianbenz)
• optimizer
  • #569 Add AutoExtensionImporter (@sebastianbenz)
  • #596 Add Markdown transformer (@sebastianbenz)
• cors
  • #542 Remove AMP-Redirect-To from access-control-expose-headers for email (@fstanis)

:bug: Bug Fix

• optimizer
  • #591 Only trim whitespace in head (@sebastianbenz)
  • #590 AutoExtensionImporter: fix amp-carousel adding amp-lightbox-gallery (@sebastianbenz)
  • #581 Fix: Empty <amp-experiment> blocks boilerplate removal (@sebastianbenz)
  • #580 Fix: ReorderHead priorities (@sebastianbenz)

:house: Internal

• cli, core, cors, optimizer, update-cache
  • #575 Auto snapshot (@sebastianbenz)
• linter, optimizer-express
  • #570 update dependencies (@sebastianbenz)
• cache-list, cache-url, cli, core, cors, lighthouse-plugin-amp, linter, optimizer-express, optimizer, runtime-version, script-csp, update-cache, validator-rules
  • #568 Adds "repository" and "homepage" to every package.json (@fstanis)

Committers: 2

• Filip Stanis (@fstanis)
• Sebastian Benz (@sebastianbenz)