electron-lisenser

Electron/Javascript Client for the Lisenser Service

Installation

npm install electron-lisenser

Quick Start

1import { Lisenser } from 'lisenser'
2
3const lisenser = new Lisenser('<your-product-id>', 'My App')
4
5async function checkLicense() {
6  const status = await lisenser.getLicenseStatus()
7
8  switch (status.status) {
9    case 'no-key':
10      console.log('No license key found')
11      break
12    case 'invalid':
13      console.log('Invalid license key')
14      break
15    case 'expired':
16      console.log(`License expired ${status.daysToExpiry} days ago`)
17      break
18    case 'active':
19      console.log(`License will expire in ${status.daysToExpiry} days`)
20      break
21  }
22}
23
24checkLicense()

API Reference

Lisenser

An instance of the Lisenser class is used to manage the license status of an Electron app.

productId: string

The product ID of the app.

appName: string

The name of the app.

machineId: string

A unique identifier for the machine running the app.

constructor(productId: string, appName: string = '', machineId?: string)

Initializes a new instance of the Lisenser class.

Parameters

• productId The product ID of the app.
• appName The name of the app.
• machineId A unique identifier for the machine running the app. If not provided, a machine ID will be generated using the machine-digest package.

---

getLicenseStatus(): Promise<client.LicenseStatus>

Returns the status of the license key. If no license key is stored locally, returns no-key.

Returns

The status of the license key.

---

activateLicenseKey(licenseKey: string): Promise<client.LicenseStatus>

Activates the given license key.

Parameters

• licenseKey The license key to activate

---

Returns

The status of the license key

---

startTrial(): Promise<client.TrialActivationStatus>

Attempts to start a trial for the app.

Returns

The activation status of the trial

---

getTrialStatus(): Promise<client.TrialStatus>

Gets the current status of the trial for the app.

Returns

The current status of the trial

---

createLicenseKeyWindow(iconPath: string, urlToBuy: string, overrideAppName?: string): Promise<boolean>

Opens a window for entering a license key.

Parameters

• iconPath The path to the app icon
• urlToBuy The URL to purchase a license key
• overrideAppName The name of the app to display in the window. If not provided, the appName provided in the constructor will be used.

Returns

A boolean that is true if the License was successfully activated, and false otherwise.

---