@moonbase.sh/licensing 1.0.4 → 1.0.7

package/README.md

@@ -0,0 +1,97 @@
+# @moonbase.sh/licensing
+
+Node.js licensing SDK for Moonbase products.
+
+Use it to request activation, validate licenses locally and online, persist licenses, and revoke activations.
+
+Learn more in our official documentation here: https://moonbase.sh/docs/licensing/sdks/node/
+
+## Install
+
+```bash
+pnpm add @moonbase.sh/licensing
+```
+
+## Create a licensing client
+
+```ts
+import { FileLicenseStore, MoonbaseLicensing } from '@moonbase.sh/licensing'
+
+const licensing = new MoonbaseLicensing({
+  endpoint: 'https://demo.moonbase.sh',
+  productId: 'demo-app',
+  publicKey: process.env.MOONBASE_PUBLIC_KEY!,
+  accountId: process.env.MOONBASE_ACCOUNT_ID,
+
+  // Optionally adjust the license store with path
+  // to where the license should be stored, or use
+  // alternate storage mechanisms to persist the token.
+  licenseStore: new FileLicenseStore(),
+})
+```
+
+- `publicKey` is the Moonbase public key used to verify signed license tokens.
+- `FileLicenseStore` persists the license locally (`license.mb` by default).
+
+## Activation flow
+
+```ts
+const request = await licensing.client.requestActivation()
+
+console.log('Open this URL in a browser:', request.browser)
+
+let license = null
+while (!license) {
+  await new Promise(resolve => setTimeout(resolve, 1000))
+  license = await licensing.client.getRequestedActivation(request)
+}
+
+await licensing.store.storeLocalLicense(license)
+console.log('License stored locally')
+```
+
+## Validate on startup
+
+```ts
+const localLicense = await licensing.store.loadLocalLicense()
+
+if (localLicense) {
+  // Validate token signature + device binding locally
+  const locallyValidated = await licensing.validator.validateLicense(localLicense.token)
+
+  // Re-validate against Moonbase (recommended for online activations)
+  const refreshed = await licensing.client.validateLicense(locallyValidated)
+  await licensing.store.storeLocalLicense(refreshed)
+}
+```
+
+## Revoke a license activation
+
+```ts
+const localLicense = await licensing.store.loadLocalLicense()
+
+if (localLicense) {
+  await licensing.client.revokeLicense(localLicense)
+  await licensing.store.deleteLocalLicense()
+}
+```
+
+## Offline helpers
+
+Generate a device token to support offline activation workflows:
+
+```ts
+const deviceToken = await licensing.generateDeviceToken()
+```
+
+Read and validate raw license bytes (for example from a file):
+
+```ts
+const license = await licensing.readRawLicense(rawLicenseBuffer)
+```
+
+## Custom stores and device resolvers
+
+You can inject your own `ILicenseStore` and `IDeviceIdResolver` implementations.
+
+Note: the current configuration property name for custom device resolver is `deivceIdResolver`.

package/dist/index.cjs

@@ -127,6 +127,22 @@ var LicenseClient = class {
     if (response.status === 204 || response.status === 404) return null;
     return await this.handleLicenseResponse(response);
   }
+  async requestTrial() {
+    const content = {
+      deviceName: await this.deviceIdResolver.resolveDeviceName(),
+      deviceSignature: await this.deviceIdResolver.resolveDeviceId()
+    };
+    const response = await (0, import_cross_fetch.default)(this.configuration.endpoint + `/api/client/trials/${this.configuration.productId}/request?format=JWT`, {
+      ...defaultFetchOptions,
+      method: "POST",
+      headers: {
+        ...defaultFetchOptions.headers,
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify(content)
+    });
+    return await this.handleLicenseResponse(response);
+  }
   async validateLicense(license) {
     const response = await (0, import_cross_fetch.default)(this.configuration.endpoint + `/api/client/licenses/${this.configuration.productId}/validate?format=JWT`, {
       ...defaultFetchOptions,

package/dist/index.d.cts

@@ -159,6 +159,15 @@ interface ILicenseClient {
      * @returns A license if the request has been fulfilled, else null
      */
     getRequestedActivation(request: ActivationRequestResponse): Promise<License | null>;
+    /**
+     * Requests a trial license for the product.
+     * This can only be done once per product per device, and skips
+     * the browser activation process. This currently requires that
+     * the product allows anonymous trials, since there is no authentication.
+     *
+     * @returns The allocated trial license, throws if the trial license cannot be allocated (e.g. user already had a trial) or if the request failed
+     */
+    requestTrial(): Promise<License>;
     /**
      * Checks if the given license is still valid, not revoked
      * and returns an updated license if still active.
@@ -194,6 +203,7 @@ declare class LicenseClient implements ILicenseClient {
     constructor(configuration: MoonbaseConfiguration, deviceIdResolver: IDeviceIdResolver, licenseValidator: ILicenseValidator);
     requestActivation(): Promise<ActivationRequestResponse>;
     getRequestedActivation(request: ActivationRequestResponse): Promise<License | null>;
+    requestTrial(): Promise<License>;
     validateLicense(license: License): Promise<License>;
     validateRawLicense(rawLicense: Buffer): Promise<License>;
     revokeLicense(license: License): Promise<void>;

package/dist/index.d.ts

@@ -159,6 +159,15 @@ interface ILicenseClient {
      * @returns A license if the request has been fulfilled, else null
      */
     getRequestedActivation(request: ActivationRequestResponse): Promise<License | null>;
+    /**
+     * Requests a trial license for the product.
+     * This can only be done once per product per device, and skips
+     * the browser activation process. This currently requires that
+     * the product allows anonymous trials, since there is no authentication.
+     *
+     * @returns The allocated trial license, throws if the trial license cannot be allocated (e.g. user already had a trial) or if the request failed
+     */
+    requestTrial(): Promise<License>;
     /**
      * Checks if the given license is still valid, not revoked
      * and returns an updated license if still active.
@@ -194,6 +203,7 @@ declare class LicenseClient implements ILicenseClient {
     constructor(configuration: MoonbaseConfiguration, deviceIdResolver: IDeviceIdResolver, licenseValidator: ILicenseValidator);
     requestActivation(): Promise<ActivationRequestResponse>;
     getRequestedActivation(request: ActivationRequestResponse): Promise<License | null>;
+    requestTrial(): Promise<License>;
     validateLicense(license: License): Promise<License>;
     validateRawLicense(rawLicense: Buffer): Promise<License>;
     revokeLicense(license: License): Promise<void>;

package/dist/index.js

@@ -83,6 +83,22 @@ var LicenseClient = class {
     if (response.status === 204 || response.status === 404) return null;
     return await this.handleLicenseResponse(response);
   }
+  async requestTrial() {
+    const content = {
+      deviceName: await this.deviceIdResolver.resolveDeviceName(),
+      deviceSignature: await this.deviceIdResolver.resolveDeviceId()
+    };
+    const response = await fetch(this.configuration.endpoint + `/api/client/trials/${this.configuration.productId}/request?format=JWT`, {
+      ...defaultFetchOptions,
+      method: "POST",
+      headers: {
+        ...defaultFetchOptions.headers,
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify(content)
+    });
+    return await this.handleLicenseResponse(response);
+  }
   async validateLicense(license) {
     const response = await fetch(this.configuration.endpoint + `/api/client/licenses/${this.configuration.productId}/validate?format=JWT`, {
       ...defaultFetchOptions,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@moonbase.sh/licensing",
   "type": "module",
-  "version": "1.0.4",
+  "version": "1.0.7",
   "description": "Package to add sotftware licensing using Moonbase.sh to your node.js apps",
   "author": "Tobias Lønnerød Madsen <m@dsen.tv>",
   "license": "MIT",