Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@akamai-consulting/edgegrid-js-fetch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

EdgeGrid for Node.js

This library implements an Authentication handler for the Akamai EdgeGrid Authentication scheme in JavaScript for environments supporting the WHATWG Fetch Standard

Install

npm install --save @akamai-consulting/edgegrid-js-fetch

Authentication

You can obtain the authentication credentials through an API client. Requests to the API are marked with a timestamp and a signature and are executed immediately.

Create authentication credentials.

Place your credentials in an EdgeGrid file ~/.edgerc, in the [default] section.

[default]
client_secret = C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=
host = akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net
access_token = akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij
client_token = akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj

Use your local .edgerc by creating a stream providing contents of your edgerc file.

import {EdgeGridCredentials, EdgeGrid}  from '@akamai-consulting/edgegrid-js-fetch';

const config = await EdgeGridCredentials.parseEdgercStream(
  Readable.toWeb(fs.createReadStream(
    path.join(os.homedir(), '.edgerc')
  ))
);

Alternatively, you can hard code your credentials by passing the credential values to the EdgeGridCredentials() constructor.

import {EdgeGridCredentials, EdgeGrid}  from '@akamai-consulting/edgegrid-js-fetch';

const clientSecret = "C113nt53KR3TN6N90yVuAgICxIRwsObLi0E67/N8eRN=",
      host = "akab-h05tnam3wl42son7nktnlnnx-kbob3i3v.luna.akamaiapis.net";
      accessToken = "akab-acc35t0k3nodujqunph3w7hzp7-gtm6ij",
      clientToken = "akab-c113ntt0k3n4qtari252bfxxbsl-yvsdj",
    

const config = new EdgeGridCredentials(client_secret, host, access_token, client_token);

Use

The EdgeGrid class can be used to create a signed Request object

// Create EdgeGrid object from config
const eg = new EdgeGrid(config);

// Create Signed Request to get list of EdgeWorkers
const request = await eg.signRequest('/edgeworkers/v1/ids');

// Make request using the standard `fetch`
const response = await fetch(request);

The EdgeGrid class can also be used to directly perform a fetch, with the same options as the standard fetch

// Create EdgeGrid object from config
const eg = new EdgeGrid(config);

// Sign and fetch in a single step
const response = await eg.fetch('/edgeworkers/v1/ids');

Reporting issues

To report an issue or make a suggestion, create a new GitHub issue.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.