@supertone/keygen

Keygen-ts

Introduction

Keygen API for TypeScript

This repository hosts TypeScript interfaces for the Keygen API.

Application Integration

In addition, it includes an application that integrates multiple APIs, consolidating their functionality into a cohesive unit.

Core Directory

The core directory is a crucial part of this repository, which includes TypeScript definitions pertinent to the Keygen API.

Enumerations for Keygen

The directory houses TypeScript enumerations (enums) for Keygen. These enums provide a reliable way to encapsulate and manage sets of constants that are related to Keygen.

API Request and Response Interfaces

Furthermore, it contains TypeScript interfaces for API request parameters and responses. These interfaces ensure type safety and structure when making requests to the API and handling its responses. They serve as contracts that outline what the request parameters and responses should look like, providing a consistent way to interact with the API.

---

Installation

yarn add @supertone/keygen

Set environment

.env file should look as follows.

KEYGEN_AUTH_TOKEN=<YOUR_TOKEN>
KEYGEN_ACCOUNT_ID=<YOUR_ACCOUNT>

For end-to-end (E2E) tests, set an ID for each topic as follows.

E2E_TEST_PRODUCT_ID=<YOUR_PRODUCT_ID>
E2E_TEST_GROUP_ID=<YOUR_GROUP_ID>

---

Folder structure

• 📂 keygen-ts
  • 📂 api
    • 📂 artifacts
    • 📂 groups
    • 📂 licenses
    • 📂 machines
    • 📂 policies
    • 📂 releases
    • 📂 users
  • 📂 application
    • 📂 license-manager
    • 📂 release-manager
  • 📂 core
    • constant
    • enum
    • interface
    • types
    • util

---

Application

license-manager

• keygenActivateLicense
• keygenChangePolicy
• keygenCreateLicense
• keygenRetrieveLicense
• keygenValidateLicense

release-manager

• getArtifactUrl
• getReleaseWithArtifacts