npm - @licensespring/node-sdk - Versions diffs - 1.3.10-alpha → 1.3.11 - Mend

@licensespring/node-sdk 1.3.10-alpha → 1.3.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md CHANGED Viewed

@@ -1,1074 +1,17 @@
 # LicenseSpring node.js SDK
-This package is a node.js implementation of Licensespring SDK. For more information and tutorials, see: [https://docs.licensespring.com/sdk](https://docs.licensespring.com/sdk)
+### Usage
-### Install
+This package is a node.js implementation of Licensespring SDK. For more information and tutorials, see: [https://docs.licensespring.com/nodejs-sdk](https://docs.licensespring.com/nodejs-sdk)
+### Installation
 To install the SDK in your nodejs or typescript project run:
 ```
 npm i --save @licensespring/node-sdk
 ```
-## LicenseAPI
-Provides a direct interface to the [LicenseSpring API](https://docs.licensespring.com/license-api/). The `LicenseAPI` class encapsulates API calls, input checks, authentication and signature verification. Typescript definitions are provided for the arguments and return types of the class methods.
-To import the LicenseAPI class use:
-```javascript
-const { LicenseAPI } = require('@licensespring/node-sdk');
-```
-### Creating an instance
-```javascript
-const licenseAPI = new LicenseAPI({
-  apiKey: '12345678-4bfe-4e3a-8737-757004d6294c',
-  sharedKey: 'eYuHrlajvIVTiSFIXpxpKhw78f4Ewy-00-12345678',
-  appName: 'js-sdk-test-1',
-  appVersion: '0.0.1',
-  /** NOTE: the following properties are set to their default values by the SDK and can be overriden manually: */
-  // apiPath: 'http://api.dev.licensespring.com/api/v4',
-  // publicKey: '...',
-});
-```
-The constructor takes the a single argument of the following type:
-```typescript
-{
-  /** your Licensespring API key - required if using API key-based authentication */
-  apiKey: string,
-  /** your Licensespring API Shared key - required if using API key-based authentication **/
-  sharedKey: string,
-  /** your OAuth client ID - required if using OAuth API authentication */
-  clientID: string,
-  /** your OAuth client secret - required if using OAuth API authentication */
-  clientSecret: string,
-  /** optional override for OAuth token url */
-  tokenUrl?: string,
-  /** custom name for your application */
-  appName: string,
-  /** custom version string for your application */
-  appVersion: string,
-  /** your Air Gap Activation key (optional) */
-  airGapKey?: string,
-  /** override for License API url (default is https://api.licensespring.com/api/v4/) **/
-  apiPath?: string,
-  /** override for License API public key (default is pub key for api.licensespring.com) **/
-  publicKey?: string,
-  /** override for License File filename (default is "License") */
-  filename?: string,
-  /** override for License File path (default is current directory) */
-  filePath?: string,
-  /** override for License File encryption key */
-  fileKey?: string,
-  /** override for license grace period duration in hours (default is 24) */
-  gracePeriod?: number,
-  /** override for License File guard file (default is false) */
-  isGuardFileEnabled?: boolean,
-  /** override for Hardware ID calculation method (default is 0, for more info see "Hardware ID" section) */
-  hardwareIDMethod?: number,
-}
-```
-### API methods
-For more information on API functionality, see our [LicenseSpring API docs](https://docs.licensespring.com/license-api/).
-For type definitions see [Types](#types).
-#### getHardwareID
-Generates a [Hardware ID](#hardware-id). This value is required for various API method calls.
-If the optional argument is not provided, it defaults to the value set in the configuration object provided when instantiating the LicensespringAPI object. If no value was provided in the config object, it defaults to 0 (the default Hardware ID method).
-```typescript
-getHardwareID(algorithm?: HardwareIdAlgorithm): string
-```
-#### Check License
-[https://docs.licensespring.com/license-api/check](https://docs.licensespring.com/license-api/check)
-```typescript
-checkLicense(payload: LicenseIdentificator, includeExpiredFeatures: boolean = false): Promise<LicenseResponse>
-```
-#### Activate License Online
-[https://docs.licensespring.com/license-api/activation-deactivation/activation](https://docs.licensespring.com/license-api/activation-deactivation/activation)
-```typescript
-activateLicense(payload: LicenseActivationIdentificatorWithVariables): Promise<LicenseResponse>
-```
-#### Deactivate License Online
-[https://docs.licensespring.com/license-api/activation-deactivation/deactivation](https://docs.licensespring.com/license-api/activation-deactivation/deactivation)
-```typescript
-deactivateLicense(payload: LicenseIdentificator): Promise<boolean>
-```
-#### Activate License Offline
-```typescript
-createOfflineActivationPayload(payload: CreateOfflineActivationRequestPayload): string
-checkOfflineActivationResponse(payload: string): LicenseResponseOffline
-```
-First create an offline request payload, which can be stored in a file:
-```typescript
-const offlineActivationPayload = licenseAPI.createOfflineActivationPayload({
-  'license_key': 'AAAA-0000-1111-2222',
-  'product': 'productcode',
-  'hardware_id': 'a0b1c2d3',
-});
-nodeFs.writeFileSync('activate_offline.req', offlineActivationPayload);
-```
-This file is then uploaded to the [Offline Portal](https://docs.licensespring.com/portals/offline). If the file is valid, the system will activate the license. This will also generate an `ls_activation.lic` file, which you can forward to your offline application and verify it locally.
-The contents of this file are verified using `checkOfflineActivationResponse`, for example:
-```typescript
-const activationResponse = nodeFs.readFileSync('ls_activation.lic');
-try {
-  return licenseAPI.checkOfflineActivationResponse(activationResponse);
-} catch (error) {
-  return false;
-}
-```
-#### Deactivate License Offline
-```typescript
-createOfflineDeactivationPayload(payload: CreateOfflineActivationRequestPayload): string
-```
-First create an offline request payload, which can be stored in a file:
-```typescript
-const offlineDeactivationPayload = licenseAPI.createOfflineDeactivationPayload({
-  'license_key': 'AAAA-0000-1111-2222',
-  'product': 'productcode',
-  'hardware_id': 'a0b1c2d3',
-});
-nodeFs.writeFileSync('deactivate_offline.req', offlineDeactivationPayload);
-```
-This file is then uploaded to the [Offline Portal](https://docs.licensespring.com/portals/offline). If the file is valid, the system will deactivate the license.
-#### Get Trial License Key
-[https://docs.licensespring.com/license-api/trial-key](https://docs.licensespring.com/license-api/trial-key)
-```typescript
-getTrialKey(payload: TrialKeyPayload): Promise<LicenseTrialResponse>
-```
-#### List Licenses for a User
-[https://docs.licensespring.com/license-api/user-licenses](https://docs.licensespring.com/license-api/user-licenses)
-```typescript
-getUserLicenses(payload: GetUserLicensesPayload): Promise<LicenseResponse[]>
-```
-#### List License Users for a Customer
-[https://docs.licensespring.com/license-api/customer-license-users](https://docs.licensespring.com/license-api/customer-license-users)
-```typescript
-getCustomerLicenseUsers(payload: GetCustomerLicensesPayload): Promise<CustomerLicenseUsersResponse>
-```
-#### Check License Feature
-[https://docs.licensespring.com/license-api/license-feature-check](https://docs.licensespring.com/license-api/license-feature-check)
-```typescript
-checkLicenseFeature(payload: LicenseIdentificatorAndFeature): Promise<LicenseFeatureResponse>
-```
-#### Add License Consumption
-[https://docs.licensespring.com/license-api/consumption/add](https://docs.licensespring.com/license-api/consumption/add)
-```typescript
-addConsumption(payload: LicenseIdentificatorAddConsumptions): Promise<LicenseConsumptionsResponse>
-```
-#### Add License Feature Consumption
-[https://docs.licensespring.com/license-api/consumption/add-feature](https://docs.licensespring.com/license-api/consumption/add-feature)
-```typescript
-addFeatureConsumption(payload: LicenseIdentificatorAddFeatureConsumptions): Promise<LicenseFeatureConsumptionResponse>
-```
-#### Product Details
-[https://docs.licensespring.com/license-api/product-details](https://docs.licensespring.com/license-api/product-details)
-```typescript
-getProductDetails(payload: ProductDetailsPayload): Promise<ProductDetailsResponse>
-```
-#### Get Device Variables
-[https://docs.licensespring.com/license-api/device-variables/get](https://docs.licensespring.com/license-api/device-variables/get)
-```typescript
-getDeviceVariables(payload: LicenseIdentificator): Promise<DeviceVariable[]>
-```
-#### Track Device Variables
-[https://docs.licensespring.com/license-api/device-variables/track](https://docs.licensespring.com/license-api/device-variables/track)
-```typescript
-trackDeviceVariables(payload: LicenseIdentificatorWithVariables): Promise<DeviceVariable[]>
-```
-#### Borrow Floating License
-[https://docs.licensespring.com/license-api/floating/license/borrow](https://docs.licensespring.com/license-api/floating/license/borrow)
-```typescript
-floatingBorrow(payload: LicenseIdentificatorWithBorrowedUntil): Promise<LicenseBorrowResponse>
-```
-#### Release Floating License
-[https://docs.licensespring.com/license-api/floating/license/release](https://docs.licensespring.com/license-api/floating/license/release)
-```typescript
-floatingRelease(payload: LicenseIdentificator): Promise<boolean>
-```
-#### Release Floating Feature
-[https://docs.licensespring.com/license-api/floating/feature/release](https://docs.licensespring.com/license-api/floating/feature/release)
-```typescript
-featureRelease(payload: LicenseIdentificatorAndFeature): Promise<boolean>
-```
-#### Change User Password
-[https://docs.licensespring.com/license-api/change-password](https://docs.licensespring.com/license-api/change-password)
-```typescript
-changePassword(payload: PasswordChangePayload): Promise<boolean>
-```
-#### List Product Versions for License
-[https://docs.licensespring.com/license-api/versions](https://docs.licensespring.com/license-api/versions)
-```typescript
-getVersions(payload: LicenseIdentificator): Promise<VersionsResponse>
-```
-#### Product Installation File Info for License
-[https://docs.licensespring.com/license-api/installation-file](https://docs.licensespring.com/license-api/installation-file)
-```typescript
-getInstallationFile(payload: LicenseIdentificatorWithInstallation): Promise<InstallationFileResponse>
-```
-#### Get Single Sign On URL
-[https://docs.licensespring.com/license-api/sso-url](https://docs.licensespring.com/license-api/sso-url)
-```typescript
-getSSOUrl(payload: SSOURLParams): Promise<{ url: string }>
-```
-#### Get Air Gap Activation Code
-[https://docs.licensespring.com/license-entitlements/activation-types/air-gapped](https://docs.licensespring.com/license-entitlements/activation-types/air-gapped)
-```typescript
-getAirGapActivationCode(initializationCode: string, licenseKey: string): string
-```
-#### Verify Air-Gap Confirmation Code
-```typescript
-verifyConfirmationCode(confirmationCode: string, licenseKey: string, policyId?: string): boolean
-```
-#### Activate Air-Gapped License
-[https://docs.licensespring.com/license-entitlements/activation-types/air-gapped](https://docs.licensespring.com/license-entitlements/activation-types/air-gapped)
-```typescript
-activateAirgappedLicense(activationPayload: OfflineActivation, licenseKey: string, policyId: string): LicenseResponse
-```
-## LicenseManager
-Provides a high-level interface for managing licenses, including local licenses. The LicenseManager is required to work with local license files. Typescript definitions are provided for the arguments and return types of the class methods.
-To import the LicenseManager class use:
-```javascript
-const { LicenseManager } = require('@licensespring/node-sdk');
-```
-To create an instance:
-```javascript
-const licenseManager = new LicenseManager({
-  apiKey: '12345678-4bfe-4e3a-8737-757004d6294c',
-  sharedKey: 'eYuHrlajvIVTiSFIXpxpKhw78f4Ewy-00-12345678',
-  appName: 'js-sdk-test-1',
-  appVersion: '0.0.1',
-  productCode: 'lkp',
-  /** NOTE: the following properties are set to their default values by the SDK and can be overriden manually: */
-  // apiPath: 'http://api.dev.licensespring.com/api/v4',
-  // publicKey: '...',
-});
-```
-The constructor takes the a single argument of the following type:
-```typescript
-{
-  /** your Licensespring API key */
-  apiKey: string,
-  /** your Licensespring API Shared key **/
-  sharedKey: string,
-  /** custom name for your application */
-  appName: string,
-  /** custom version string for your application */
-  appVersion: string,
-  /** your product short code */
-  productCode: string,
-  /** your Air Gap Activation key (optional) */
-  airGapKey?: string,
-  /** override for License API url (default is https://api.licensespring.com/api/v4/) **/
-  apiPath?: string,
-  /** override for License API public key (default is pub key for api.licensespring.com) **/
-  publicKey?: string,
-  /** override for License File filename (default is "License") */
-  filename?: string,
-  /** override for License File path (default is current directory) */
-  filePath?: string,
-  /** override for License File encryption key */
-  fileKey?: string,
-  /** override for license grace period duration in hours (default is 24) */
-  gracePeriod?: number,
-  /** override for License File guard file (default is false) */
-  isGuardFileEnabled?: boolean,
-  /** override for Hardware ID calculation method (default is 0, for more info see "Hardware ID" section) */
-  hardwareIDMethod?: number,
-}
-```
-### Methods
-Methods that take a `Managed` License identificator are the same as in License API, except that `product` and `hardware_id` do not have to be specified in the payload as they are provided by the License Manager object.
-#### Check License
-[https://docs.licensespring.com/license-api/check](https://docs.licensespring.com/license-api/check)
-```javascript
-checkLicense(payload: Managed<LicenseIdentificator>): Promise<LicenseResponse>
-```
-#### Activate License Online
-[https://docs.licensespring.com/license-api/activation-deactivation/activation](https://docs.licensespring.com/license-api/activation-deactivation/activation)
-```javascript
-activateLicense(payload: Managed<LicenseIdentificatorWithVariables>): Promise<LicenseResponse>
-```
-#### Deactivate License Online
-[https://docs.licensespring.com/license-api/activation-deactivation/deactivation](https://docs.licensespring.com/license-api/activation-deactivation/deactivation)
-```javascript
-deactivateLicense(payload: Managed<LicenseIdentificator>): Promise<boolean>
-```
-#### Activate License Offline
-```typescript
-createOfflineActivationPayload(payload: Managed<CreateOfflineActivationRequestPayload>): string
-activateOffline(payload: string): LicenseResponseOffline
-```
-First create an offline request payload, which can be stored in a file:
-```typescript
-const offlineActivationPayload = licenseManager.createOfflineActivationPayload({
-  'license_key': 'AAAA-0000-1111-2222'
-});
-nodeFs.writeFileSync('activate_offline.req', offlineActivationPayload);
-```
-This file is then uploaded to the [Offline Portal](https://docs.licensespring.com/portals/offline). If the file is valid, the system will activate the license. This will also generate an `ls_activation.lic` file, which you can forward to your offline application.
-You can then pass the contents of this `ls_activation.lic` file to `activateOffline` which will verify the file response and (if valid) apply the activation locally. For example:
-```typescript
-const activationResponse = nodeFs.readFileSync('ls_activation.lic');
-activateOffline(activationResponse);
-```
-#### Deactivate License Offline
-```typescript
-createOfflineDeactivationPayload(payload: Managed<CreateOfflineActivationRequestPayload>): string
-deactivateOffline(): void
-```
-First create an offline request payload, which can be stored in a file:
-```typescript
-const offlineDeactivationPayload = licenseManager.createOfflineDeactivationPayload({
-  'license_key': 'AAAA-0000-1111-2222'
-});
-nodeFs.writeFileSync('deactivate_offline.req', offlineDeactivationPayload);
-```
-This file is then uploaded to the [Offline Portal](https://docs.licensespring.com/portals/offline). If the file is valid, the system will deactivate the license.
-To apply the license deactivation locally, you can call `licenseManager.deactivateOffline()`.
-#### Get Trial License Key
-[https://docs.licensespring.com/license-api/trial-key](https://docs.licensespring.com/license-api/trial-key)
-```javascript
-getTrialKey(payload: Managed<TrialKeyPayload>): Promise<LicenseTrialResponse>
-```
-#### List Licenses for a User
-[https://docs.licensespring.com/license-api/user-licenses](https://docs.licensespring.com/license-api/user-licenses)
-```javascript
-getUserLicenses(payload: Managed<GetUserLicensesPayload>): Promise<LicenseResponse[]>
-```
-#### List License Users for a Customer
-[https://docs.licensespring.com/license-api/customer-license-users](https://docs.licensespring.com/license-api/customer-license-users)
-```javascript
-getCustomerLicenseUsers(payload: Managed<GetCustomerLicensesPayload>): Promise<CustomerLicenseUsersResponse>
-```
-#### Check License Feature
-[https://docs.licensespring.com/license-api/license-feature-check](https://docs.licensespring.com/license-api/license-feature-check)
-```javascript
-checkLicenseFeature(payload: Managed<LicenseIdentificatorAndFeature>): Promise<LicenseFeatureResponse>
-```
-#### Add License Consumption
-[https://docs.licensespring.com/license-api/consumption/add](https://docs.licensespring.com/license-api/consumption/add)
-```javascript
-addConsumption(payload: Managed<LicenseIdentificatorAddConsumptions>): Promise<LicenseConsumptionsResponse>
-```
-#### Add License Feature Consumption
-[https://docs.licensespring.com/license-api/consumption/add-feature](https://docs.licensespring.com/license-api/consumption/add-feature)
-```javascript
-addFeatureConsumption(payload: Managed<LicenseIdentificatorAddFeatureConsumptions>): Promise<LicenseFeatureConsumptionResponse>
-```
-#### Product Details
-[https://docs.licensespring.com/license-api/product-details](https://docs.licensespring.com/license-api/product-details)
-```javascript
-getProductDetails(payload: Managed<ProductDetailsPayload>): Promise<ProductDetailsResponse>
-```
-#### Get Device Variables
-[https://docs.licensespring.com/license-api/device-variables/get](https://docs.licensespring.com/license-api/device-variables/get)
-```javascript
-getDeviceVariables(payload: Managed<LicenseIdentificator>): Promise<DeviceVariable[]>
-```
-#### Track Device Variables
-[https://docs.licensespring.com/license-api/device-variables/track](https://docs.licensespring.com/license-api/device-variables/track)
-```javascript
-trackDeviceVariables(payload: Managed<LicenseIdentificatorWithVariables>): Promise<DeviceVariable[]>
-```
-#### Borrow Floating License
-[https://docs.licensespring.com/license-api/floating/license/borrow](https://docs.licensespring.com/license-api/floating/license/borrow)
-```javascript
-floatingBorrow(payload: Managed<LicenseIdentificatorWithBorrowedUntil>): Promise<LicenseBorrowResponse>
-```
-#### Release Floating License
-[https://docs.licensespring.com/license-api/floating/license/release](https://docs.licensespring.com/license-api/floating/license/release)
-```javascript
-floatingRelease(payload: Managed<LicenseIdentificator>): Promise<boolean>
-```
-#### Release Floating Feature
-[https://docs.licensespring.com/license-api/floating/feature/release](https://docs.licensespring.com/license-api/floating/feature/release)
-```javascript
-featureRelease(payload: Managed<LicenseIdentificatorAndFeature>): Promise<boolean>
-```
-#### Change User Password
-[https://docs.licensespring.com/license-api/change-password](https://docs.licensespring.com/license-api/change-password)
-```javascript
-changePassword(payload: PasswordChangePayload): Promise<boolean>
-```
-#### List Product Versions for License
-[https://docs.licensespring.com/license-api/versions](https://docs.licensespring.com/license-api/versions)
-```javascript
-getVersions(payload: Managed<LicenseIdentificator>): Promise<VersionsResponse>
-```
-#### Product Installation File Info for License
-[https://docs.licensespring.com/license-api/installation-file](https://docs.licensespring.com/license-api/installation-file)
-```javascript
-getInstallationFile(payload: Managed<LicenseIdentificatorWithInstallation>): Promise<InstallationFileResponse>
-```
-#### Get Single Sign On URL
-[https://docs.licensespring.com/license-api/sso-url](https://docs.licensespring.com/license-api/sso-url)
-```javascript
-getSSOUrl(payload: SSOURLParams): Promise<{ url: string }>
-```
-#### Get Air Gap Activation Code
-[https://docs.licensespring.com/license-entitlements/activation-types/air-gapped](https://docs.licensespring.com/license-entitlements/activation-types/air-gapped)
-```javascript
-getAirGapActivationCode(initializationCode: string, licenseKey: string)
-```
-#### Activate Air-Gapped License
-Performs `verifyConfirmationCode` and activates Air-Gapped License:
-```javascript
-activateAirGapLicense(confirmationCode: string, licenseKey: string, policyFilePath: string, policyID: string)
-```
-#### Is License Valid
-Checks if License is enabled, active and not expired:
-```javascript
-isValid(license: LicenseResponse): boolean
-```
-#### Maintenance Days Remaining
-Returns days remaining in maintenance period:
-```javascript
-maintenanceDaysRemaining(license: LicenseResponse): number
-```
-#### Validity Days Remaining
-Returns days remaining in license validity period:
-```javascript
-daysRemaining(license: LicenseResponse): number
-```
-#### Load License File
-See [License File](#license-file)
-```javascript
-loadLicense(): License
-```
-#### Check License File For Corruption
-```javascript
-isLicenseFileCorrupted(): boolean
-```
-#### Clear Local Storage
-```javascript
-clearLocalStorage(): void
-```
-## License File
-For more info see our docs: [https://docs.licensespring.com/sdks/tutorials/best-practices/local-license-file](https://docs.licensespring.com/sdks/tutorials/best-practices/local-license-file) and [https://docs.licensespring.com/sdks/python/licensefile](https://docs.licensespring.com/sdks/python/licensefile)
-To load a local license file, create an instance of `LicenseManager` and call the method `loadLicense`:
-```javascript
-const licenseFile = licenseManager.loadLicense();
-```
-The License class provides an interface for working with the License File.
-### Methods
-#### Get Feature Data
-```javascript
-public featureData(featureCode: string): ProductFeature
-```
-#### Check License Status
-Throws an exception if the license is disabled, inactive or expired
-```javascript
-checkLicenseStatus(): void
-```
-#### Perform Full License Check
-Checks License status and saves to local license file
-```javascript
-check(includeExpiredFeatures: boolean = false): Promise<LicenseResponse>
-```
-#### Get Air-Gap License Deactivation Code
-```javascript
-getDeactivationCode(initializationCode: string): string
-```
-#### Deactivate Air-Gap License
-```javascript
-deactivateAirGap(confirmationCode: string): void
-```
-#### Deactivate License
-Deactivates a License, updates local license file. Optionally deletes license file
-```javascript
-deactivate(deleteLicense: boolean = false): Promise<boolean>
-```
-#### Local License Check
-Performs a local check using the local license file. Throws an exception if license is not valid
-```javascript
-localCheck(): Promise<true>
-```
-#### Change Password
-Performs password change for user associated to License
-```javascript
-changePassword(oldPassword: string, newPassword: string): Promise<boolean>
-```
-#### Add Local Consumption
-Adds a License consumption to the local license data
-```javascript
-addLocalConsumption(consumptions: number = 1)
-```
-#### Add Local Feature Consumption
-Adds a License feature consumption to the local license data
-```javascript
-addLocalFeatureConsumption(featureCode: string, consumptions: number = 1)
-```
-#### Sync License Feature Consumption
-Sends a feature consumption request to the server and updates local data
-```javascript
-syncFeatureConsumption(feature: { code: string, local_consumption: number }): Promise<boolean>
-```
-#### Sync License Consumption
-Syncs local consumptions to server
-```javascript
-syncConsumption(overages: number = -1): Promise<boolean>
-```
-#### Borrow Floating License
-```javascript
-floatingBorrow(borrowUntil: string, password?: string): Promise<boolean>
-```
-#### Release Floating License
-```javascript
-floatingRelease(): Promise<boolean>
-```
-#### Check Feature Status
-Checks License Feature status, throws exception if not active
-```javascript
-checkFeature(featureCode: string): Promise<void>
-```
-#### Release Borrowed Feature
-```javascript
-releaseFeature(featureCode: string): Promise<void>
-```
-#### Update Offline
-```javascript
-Update local cache from Offline License File (at given `path`). Optionally reset local consumption value.
-public updateOffline(path: string, resetConsumption: boolean): boolean
-```
-#### Deactivate Offline License
-```javascript
-deactivateOffline(offlinePath: string): Promise<void>
-```
-#### Get Product Details
-Retrieves Product Details from server
-```javascript
-productDetails(includeLatestVersion: boolean = false, includeCustomFields: boolean = false, includeExpiredFeatures: boolean = false): Promise<ProductDetailsResponse>
-```
-#### Get Product Details Local
-Retrieves Product Details from local data
-```javascript
-get productDetailsLocal()
-```
-#### Set Device Variables Local
-Set custom variables to local data
-```javascript
-setDeviceVariablesLocal(variables: { [key: string]: string|number }, save: boolean = true): void
-```
-#### Set Device Variables
-Send locally stored variables to server. Optionally save to license file
-```javascript
-setDeviceVariables(save: boolean = false): Promise<void>
-```
-#### Get Device Variable Local
-Get the value of a variable from local data
-```javascript
-getDeviceVariableLocal(variable: string)
-```
-#### Get Device Variables Local
-Get all variables from local data
-```javascript
-getDeviceVariablesLocal()
-```
-#### Get Device Variables
-```javascript
-getDeviceVariables(): Promise<DeviceVariable[]>
-```
-### Getters
-```javascript
-get allowGraceSubscriptionPeriod()
-get allowOverages()
-get allowUnlimitedActivations()
-get allowUnlimitedConsumptions()
-get borrowUntil()
-get consumptionPeriod()
-get consumptionReset()
-get customerInformation()
-get customFields()
-get daysRemaining()
-get daysSinceLastCheck()
-get expiryDate()
-get features()
-get floatingClientId()
-get floatingEndDate()
-get floatingInUseDevices()
-get floatingTimeout()
-get gracePeriod()
-get gracePeriodHoursRemaining()
-get id()
-get isAirGapped()
-get isBorrowed()
-get isControlledByFloatingServer()
-get isDeviceTransferAllowed()
-get isDeviceTransferLimited()
-get isExpired()
-get isFloating()
-get isFloatingExpired()
-get isGracePeriod()
-get isGracePeriodStarted()
-get isMaintenancePeriodExpired()
-get isSubcriptionGracePeriodStarted()
-get isTrial()
-get isValid()
-get isValidityPeriodExpired()
-get lastCheck()
-get lastUsage()
-get licenseActive()
-get licenseEnabled()
-get licenseKey()
-get licenseType()
-get licenseUser()
-get localConsumptions()
-get maintenanceDaysRemaining()
-get maintenancePeriod()
-get maxActivations()
-get maxConsumptions()
-get maxFloatingUsers()
-get maxOverages()
-get maxTransfers()
-get metadata()
-get policyID()
-get preventVm()
-get startDate()
-get subscriptionGracePeriod()
-get totalConsumptions()
-get transferCount()
-get validityPeriod()
-get validityWithGracePeriod()
-```
-## Hardware ID
-Both LicenseAPI and LicenseManager use the Hardware ID module to calculate a unique fingerprint for the local machine. The module provides multiple methods of determining the ID:
-```typescript
-export enum HardwareIdAlgorithm {
-  Default = 0,
-  WindowsHardwareFingerprintId = 1,
-  WindowsComputerSystemProductId = 2,
-  WindowsCryptographyId = 3,
-  LinuxMachineId = 4,
-  CloudPlatformsId = 5,
-};
-```
-The default method (0) covers all cases and fallbacks. If you override the default method, the method used should be consistent accross your project. For both LicenseAPI and LicenseManager, this can be overriden globally by setting the required value in the config object when initializing the LicenseAPI/LicenseManager, e.g.:
-```javascript
-const licenseAPI = new LicenseAPI({
-  apiKey: '12345678-4bfe-4e3a-8737-757004d6294c',
-  sharedKey: 'eYuHrlajvIVTiSFIXpxpKhw78f4Ewy-00-12345678',
-  appName: 'js-sdk-test-1',
-  appVersion: '0.0.1',
-  hardwareIDMethod: 5,
-});
-```
-## Proxy
-All calls to the server can be proxied by providing a proxy definition in either of the following two ways:
-A. By providing a proxy definition in the initialization config argument for `LicenseAPI`, `LicenseManager` and `FloatingAPI`, e.g.:
-```javascript
-const licenseAPI = new LicenseAPI({
-  apiKey: '12345678-4bfe-4e3a-8737-757004d6294c',
-  sharedKey: 'eYuHrlajvIVTiSFIXpxpKhw78f4Ewy-00-12345678',
-  appName: 'js-sdk-test-1',
-  appVersion: '0.0.1',
-  proxy: {
-    host: '127.0.0.1',
-    port: 9000,
-  },
-});
-```
-B. or by calling the `setProxy` method on an initialized `LicenseAPI`, `LicenseManager` or `FloatingAPI` object, e.g.:
-```javascript
-licenseAPI.setProxy({
-  host: '127.0.0.1',
-  port: 9000,
-});
-```
-For the type declaration of the proxy definition object, see `AxiosProxyConfig` in the following Types section.
-## Types
-The following are typescript definitions for all the types used in the SDK:
-```typescript
-/** Date string in ISO 8601 format (always in UTC timezone) with optional separators and optional time component, e.g.:
- *
- * "2024-09-27T23:30:48.016Z"
- *
- * "2024-09-27 23:30:48.016"
- *
- * "2024-09-27 23:30:48"
- *
- * "2024-09-27 23:30"
- *
- * "2024-09-27"
- *
- */
-export type DateInputString = string;
-/** Date string in full ISO 8601 format, e.g. "2024-09-27T23:30:48.016Z". Note: this is always in UTC timezone */
-export type DateISO8601UTC = string;
-/** Date string in RFC 7231 format, e.g. "Fri, 27 Sep 2024 23:30:48 GMT". Note: this is always in GMT timezone */
-export type DateRFC7231 = string;
-/** Length of time expressed in days, months or years, e.g. 5d, 2m, 3y */
-export type TimeLength = string;
-export type LicensespringConfig = {
-  apiKey: string,
-  sharedKey: string,
-  apiPath: string,
-  publicKey: string,
-  productCode: string,
-  appName: string,
-  appVersion: string,
-  filePath: string,
-  filename: string,
-  gracePeriod: number,
-  fileKey: string,
-  airGapKey?: string,
-  isGuardFileEnabled: boolean,
-  hardwareIDMethod: number,
-  sdkVersion: string,
-  proxy?: AxiosProxyConfig,
-};
-interface AxiosProxyConfig {
-  host: string,
-  port: number,
-  protocol?: string,
-  auth?: {
-    username: string,
-    password: string,
-  }
-}
-export type LicensespringAPIConfig = Omit<LicensespringConfig, 'productCode'>;
-export type LicensespringConfigDef = Omit<LicensespringConfig, 'apiPath'|'publicKey'|'filename'|'filePath'|'gracePeriod'|'fileKey'|'isGuardFileEnabled'|'hardwareIDMethod'|'sdkVersion'> & {
-  apiPath?: string,
-  publicKey?: string,
-  filename?: string,
-  filePath?: string,
-  gracePeriod?: number,
-  fileKey?: string,
-  isGuardFileEnabled?: boolean,
-  hardwareIDMethod?: number,
-  proxy?: AxiosProxyConfig,
-};
-export type LicensespringAPIConfigDef = Omit<LicensespringAPIConfig, 'apiPath'|'publicKey'|'filename'|'filePath'|'gracePeriod'|'fileKey'|'isGuardFileEnabled'|'hardwareIDMethod'|'sdkVersion'> & {
-  apiPath?: string,
-  publicKey?: string,
-  filename?: string,
-  filePath?: string,
-  gracePeriod?: number,
-  fileKey?: string,
-  isGuardFileEnabled?: boolean,
-  hardwareIDMethod?: number,
-  proxy?: AxiosProxyConfig,
-};
-export type LicensespringFloatingConfig = {
-  apiPath: string,
-  appVersion: string,
-  hardwareIDMethod: number,
-  sdkVersion: string,
-  proxy?: AxiosProxyConfig,
-};
-export type LicensespringFloatingConfigDef = Omit<LicensespringFloatingConfig, 'hardwareIDMethod'|'sdkVersion'> & {
-  hardwareIDMethod?: number,
-};
-export enum HardwareIdAlgorithm {
-  Default = 0,
-  WindowsHardwareFingerprintId = 1,
-  WindowsComputerSystemProductId = 2,
-  WindowsCryptographyId = 3,
-  LinuxMachineId = 4,
-  CloudPlatformsId = 5,
-};
-```
-## Logging
-The `Logger` class provides static properties which can be set to log events in the SDK. On the lowest level (`debug`), all function calls, function returns and exceptions are logged. You can also invoke logging functions manually. By default, all values are logged to both the js `console` and the log file. The log file is rotated after 5MB, with the last 5 files kept on disk. These values can be overriden by setting static properties on the `Logger` class.
-The following is a list of the exposed static properties of the Logger, with their default values:
-```typescript
-  /**
-   * Sets the minimum logged level. Valid values are: 'off', 'debug', 'info', 'warn', 'error'
-   */
-  static level: LogLevel = 'off';
-  /**
-   * Determines whether logged events are written to console
-   */
-  static consoleLog: boolean = true;
-  /**
-   * Determines whether logged events are written to the log file
-   */
-  static fileLog: boolean = true;
-  /**
-   * Path to the log file
-   */
-  static logPath: string = resolve(process.cwd(), 'node_sdk.log');
-  /**
-   * Log file maximum size, for rotation purposes. When rotated, older log filenames will be appended with a sequential number, e.g. node_sdk.1.log
-   */
-  static maxLogSize: number = 5 * 1024 * 1024;
-  /**
-   * Maximum number of old log files to keep
-   */
-  static maxLogFiles: number = 5;
-```
-The Logger provides the following static functions for manual logging:
-```typescript
-static debug(...args: any[]): void;
-static info(...args: any[]): void;
-static warn(...args: any[]): void;
-static error(...args: any[]): void;
-```
-Example usage:
-```typescript
-const { Logger } = require('@licensespring/node-sdk');
-Logger.level = 'error';
-Logger.consoleLog = false;
-Logger.logPath = resolve(process.cwd(), 'my_log_file.log');
-Logger.info('my custom logged value', { some_data: 123 });
-Logger.warn('my custom warning', 456);
-```
-## License
+### License
 * node.js SDK license: [LicenseSpring SDK Source Code License](LICENSE.md)

package/dist/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@licensespring/node-sdk",
-    "version": "1.3.10-alpha",
+    "version": "1.3.11",
     "main": "dist/src/index.js",
     "modules": "dist/src/index.js",
     "types": "dist/src/index.d.ts",

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@licensespring/node-sdk",
-  "version": "1.3.10-alpha",
+  "version": "1.3.11",
   "main": "dist/src/index.js",
   "modules": "dist/src/index.js",
   "types": "dist/src/index.d.ts",