EBSI URI scheme library

This library supports the EBSI URI Scheme. It allows you to parse EBSI URIs, serialize EBSI URI components, transform EBSI URIs into URLs, and URLs into EBSI URIs.

Table of Contents

1. Installation
2. Usage
3. License

Installation

npm install @cef-ebsi/ebsi-uri

or if you use yarn:

yarn add @cef-ebsi/ebsi-uri

Usage

Parse

The parse function takes an EBSI URI (string) and returns the URI components network, service, and resource.

Example:

parse("ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw");

returns

{
  "network": "test",
  "service": "did-registry",
  "resource": "/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw"
}

Serialize

The serialize function takes an object containing the URI components network, service, and resource. It returns a string representation of the EBSI URI.

Example:

serialize({
  network: "test",
  service: "did-registry",
  resource: "/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw",
});

returns ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw

Transform EBSI URIs into URLs

The toUrl function takes an EBSI URI (string) and returns a URL string. The function also requires that you pass an object containing a list of supported services with their version number, as well as an object containing the host to resolve for each network.

Example:

toUrl("ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw", {
  services: { "did-registry": "v4" },
  hosts: { test: "api-test.ebsi.eu" },
});

returns https://api-test.ebsi.eu/did-registry/v4/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw

Transform URLs into EBSI URIs

The fromUrl function takes an URL (string) and returns an EBSI URI string. The function accepts an optional object that contains the list of supported services with their version number, and will throw an error if the URL contains a service or service version that is not supported.

Example:

fromUrl(
  "https://api-test.ebsi.eu/did-registry/v4/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw",
);

returns ebsi:test:did-registry:/identifiers/did:ebsi:zx23VhpbGYeqF2MRJk3HzPw

License

Copyright (c) 2019 European Commission Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in compliance with the Licence. You may obtain a copy of the Licence at:

• https://joinup.ec.europa.eu/page/eupl-text-11-12

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

Library based on did-resolver library licensed under Apache 2.0 Copyright 2020 decentralized identity.