@moonbase.sh/licensing 1.0.33 → 1.0.34

package/README.md

@@ -23,6 +23,13 @@ const licensing = new MoonbaseLicensing({
   publicKey: process.env.MOONBASE_PUBLIC_KEY!,
   accountId: process.env.MOONBASE_ACCOUNT_ID,
 
+  // Optional analytics reported with every activation and validation.
+  appVersion: '1.2.3',
+  metadata: {
+    Host: 'Console',
+    User: process.env.USER ?? '',
+  },
+
   // Optionally adjust the license store with path
   // to where the license should be stored, or use
   // alternate storage mechanisms to persist the token.
@@ -65,6 +72,18 @@ if (localLicense) {
 }
 ```
 
+## Metadata, platform, and app version
+
+The SDK can report analytics with every activation, trial request, and validation. These are configured once on the `MoonbaseLicensing` config and sent automatically — there's no per-call parameter.
+
+- `appVersion` and `platform` are first-class fields and sent as plain query params. `metadata` is for arbitrary customer-defined keys, sent as `meta[key]=value`.
+- `platform` auto-detects from `process.platform` (`darwin` → `Mac`, `win32` → `Windows`, `linux` → `Linux`). Set it explicitly to override, or pass `null` to suppress.
+- All three are sent on `requestActivation`, `requestTrial`, and `validateLicense` — never on `revokeLicense`.
+- `metadata` accepts string keys and string values only; empty values are dropped client-side.
+- Server-side, the metadata on the activation is **replaced on every call** (not merged) and surfaced in `LicenseActivatedEvent` / `LicenseValidatedEvent` webhooks.
+- The config object is re-read on every call — mutate `metadata` between calls (e.g. to rotate a session id) and the next request picks it up.
+- Keep payloads small; query-string length limits apply.
+
 ## Revoke a license activation
 
 ```ts

package/dist/index.cjs

@@ -107,7 +107,7 @@ var LicenseClient = class {
       deviceName: await this.deviceIdResolver.resolveDeviceName(),
       deviceSignature: await this.deviceIdResolver.resolveDeviceId()
     };
-    const response = await (0, import_cross_fetch.default)(this.configuration.endpoint + `/api/client/activations/${this.configuration.productId}/request?format=JWT`, {
+    const response = await (0, import_cross_fetch.default)(this.configuration.endpoint + `/api/client/activations/${this.configuration.productId}/request${this.buildQueryString()}`, {
       ...defaultFetchOptions,
       method: "POST",
       body: JSON.stringify(content)
@@ -137,7 +137,7 @@ var LicenseClient = class {
       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`, {
+    const response = await (0, import_cross_fetch.default)(this.configuration.endpoint + `/api/client/trials/${this.configuration.productId}/request${this.buildQueryString()}`, {
       ...defaultFetchOptions,
       method: "POST",
       headers: {
@@ -149,7 +149,7 @@ var LicenseClient = class {
     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`, {
+    const response = await (0, import_cross_fetch.default)(this.configuration.endpoint + `/api/client/licenses/${this.configuration.productId}/validate${this.buildQueryString()}`, {
       ...defaultFetchOptions,
       method: "POST",
       headers: {
@@ -185,6 +185,19 @@ var LicenseClient = class {
     }
     return await this.licenseValidator.validateLicense(await response.text());
   }
+  buildQueryString() {
+    const parts = ["format=JWT"];
+    const { platform, appVersion, metadata } = this.configuration;
+    if (platform) parts.push(`platform=${encodeURIComponent(platform)}`);
+    if (appVersion) parts.push(`appVersion=${encodeURIComponent(appVersion)}`);
+    if (metadata) {
+      for (const [key, value] of Object.entries(metadata)) {
+        if (value === null || value === void 0 || value === "") continue;
+        parts.push(`meta[${encodeURIComponent(key)}]=${encodeURIComponent(value)}`);
+      }
+    }
+    return `?${parts.join("&")}`;
+  }
 };
 
 // src/deviceIdResolver.ts
@@ -412,12 +425,26 @@ var LicenseValidator = class {
 };
 
 // src/index.ts
+function detectPlatform() {
+  if (typeof process === "undefined") return void 0;
+  switch (process.platform) {
+    case "darwin":
+      return "Mac";
+    case "win32":
+      return "Windows";
+    case "linux":
+      return "Linux";
+    default:
+      return void 0;
+  }
+}
 var MoonbaseLicensing = class {
   constructor(configuration) {
     var _a, _b;
     this.configuration = {
       ...configuration,
-      endpoint: configuration.endpoint.replace(/\/$/, "")
+      endpoint: configuration.endpoint.replace(/\/$/, ""),
+      platform: configuration.platform === void 0 ? detectPlatform() : configuration.platform
     };
     this.store = (_a = configuration.licenseStore) != null ? _a : new InMemoryLicenseStore();
     this.deviceIdResolver = (_b = configuration.deivceIdResolver) != null ? _b : new DefaultDeviceIdResolver();

package/dist/index.d.cts

@@ -149,6 +149,8 @@ declare enum ActivationMethod {
     Online = "Online",
     Offline = "Offline"
 }
+type Metadata = Record<string, string>;
+type Platform = 'Windows' | 'Linux' | 'Mac';
 type License = z.infer<typeof licenseSchema>;
 type Product = z.infer<typeof productSchema>;
 type User = z.infer<typeof userSchema>;
@@ -233,6 +235,7 @@ declare class LicenseClient implements ILicenseClient {
     validateRawLicense(rawLicense: Buffer): Promise<License>;
     revokeLicense(license: License): Promise<void>;
     private handleLicenseResponse;
+    private buildQueryString;
 }
 
 interface ILicenseStore {
@@ -291,6 +294,29 @@ interface MoonbaseConfiguration {
     publicKey: string;
     productId: string;
     accountId?: string;
+    /**
+     * Optional analytics key/value pairs sent with every activation,
+     * trial request, and license validation. Recorded on the activation
+     * server-side and surfaced in LicenseActivatedEvent /
+     * LicenseValidatedEvent webhooks. Strings only; empty values are
+     * dropped on the wire. The object is re-read on every call, so
+     * mutating it (e.g. to rotate a sessionId) takes effect on the
+     * next request.
+     */
+    metadata?: Metadata;
+    /**
+     * Reported as ?platform=... on activation, trial, and validation
+     * requests. Defaults to auto-detection from `process.platform`
+     * (`darwin` → `Mac`, `win32` → `Windows`, `linux` → `Linux`). Set
+     * explicitly to override, or pass `null` to suppress.
+     */
+    platform?: Platform | null;
+    /**
+     * Reported as ?appVersion=... (semver expected by backend). No
+     * reliable auto-detection in Node, so callers must set this
+     * explicitly to opt in.
+     */
+    appVersion?: string;
     licenseStore?: ILicenseStore;
     deivceIdResolver?: IDeviceIdResolver;
 }
@@ -305,4 +331,4 @@ declare class MoonbaseLicensing {
     readRawLicense(license: Buffer): Promise<License>;
 }
 
-export { ActivationMethod, type ActivationRequestResponse, DefaultDeviceIdResolver, type DeviceToken, ErrorType, FileLicenseStore, type IDeviceIdResolver, type ILicenseClient, type ILicenseStore, type ILicenseValidator, InMemoryLicenseStore, type License, LicenseClient, LicenseValidator, type MoonbaseConfiguration, MoonbaseError, MoonbaseLicensing, type Product, type User };
+export { ActivationMethod, type ActivationRequestResponse, DefaultDeviceIdResolver, type DeviceToken, ErrorType, FileLicenseStore, type IDeviceIdResolver, type ILicenseClient, type ILicenseStore, type ILicenseValidator, InMemoryLicenseStore, type License, LicenseClient, LicenseValidator, type Metadata, type MoonbaseConfiguration, MoonbaseError, MoonbaseLicensing, type Platform, type Product, type User };

package/dist/index.d.ts

@@ -149,6 +149,8 @@ declare enum ActivationMethod {
     Online = "Online",
     Offline = "Offline"
 }
+type Metadata = Record<string, string>;
+type Platform = 'Windows' | 'Linux' | 'Mac';
 type License = z.infer<typeof licenseSchema>;
 type Product = z.infer<typeof productSchema>;
 type User = z.infer<typeof userSchema>;
@@ -233,6 +235,7 @@ declare class LicenseClient implements ILicenseClient {
     validateRawLicense(rawLicense: Buffer): Promise<License>;
     revokeLicense(license: License): Promise<void>;
     private handleLicenseResponse;
+    private buildQueryString;
 }
 
 interface ILicenseStore {
@@ -291,6 +294,29 @@ interface MoonbaseConfiguration {
     publicKey: string;
     productId: string;
     accountId?: string;
+    /**
+     * Optional analytics key/value pairs sent with every activation,
+     * trial request, and license validation. Recorded on the activation
+     * server-side and surfaced in LicenseActivatedEvent /
+     * LicenseValidatedEvent webhooks. Strings only; empty values are
+     * dropped on the wire. The object is re-read on every call, so
+     * mutating it (e.g. to rotate a sessionId) takes effect on the
+     * next request.
+     */
+    metadata?: Metadata;
+    /**
+     * Reported as ?platform=... on activation, trial, and validation
+     * requests. Defaults to auto-detection from `process.platform`
+     * (`darwin` → `Mac`, `win32` → `Windows`, `linux` → `Linux`). Set
+     * explicitly to override, or pass `null` to suppress.
+     */
+    platform?: Platform | null;
+    /**
+     * Reported as ?appVersion=... (semver expected by backend). No
+     * reliable auto-detection in Node, so callers must set this
+     * explicitly to opt in.
+     */
+    appVersion?: string;
     licenseStore?: ILicenseStore;
     deivceIdResolver?: IDeviceIdResolver;
 }
@@ -305,4 +331,4 @@ declare class MoonbaseLicensing {
     readRawLicense(license: Buffer): Promise<License>;
 }
 
-export { ActivationMethod, type ActivationRequestResponse, DefaultDeviceIdResolver, type DeviceToken, ErrorType, FileLicenseStore, type IDeviceIdResolver, type ILicenseClient, type ILicenseStore, type ILicenseValidator, InMemoryLicenseStore, type License, LicenseClient, LicenseValidator, type MoonbaseConfiguration, MoonbaseError, MoonbaseLicensing, type Product, type User };
+export { ActivationMethod, type ActivationRequestResponse, DefaultDeviceIdResolver, type DeviceToken, ErrorType, FileLicenseStore, type IDeviceIdResolver, type ILicenseClient, type ILicenseStore, type ILicenseValidator, InMemoryLicenseStore, type License, LicenseClient, LicenseValidator, type Metadata, type MoonbaseConfiguration, MoonbaseError, MoonbaseLicensing, type Platform, type Product, type User };

package/dist/index.js

@@ -63,7 +63,7 @@ var LicenseClient = class {
       deviceName: await this.deviceIdResolver.resolveDeviceName(),
       deviceSignature: await this.deviceIdResolver.resolveDeviceId()
     };
-    const response = await fetch(this.configuration.endpoint + `/api/client/activations/${this.configuration.productId}/request?format=JWT`, {
+    const response = await fetch(this.configuration.endpoint + `/api/client/activations/${this.configuration.productId}/request${this.buildQueryString()}`, {
       ...defaultFetchOptions,
       method: "POST",
       body: JSON.stringify(content)
@@ -93,7 +93,7 @@ var LicenseClient = class {
       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`, {
+    const response = await fetch(this.configuration.endpoint + `/api/client/trials/${this.configuration.productId}/request${this.buildQueryString()}`, {
       ...defaultFetchOptions,
       method: "POST",
       headers: {
@@ -105,7 +105,7 @@ var LicenseClient = class {
     return await this.handleLicenseResponse(response);
   }
   async validateLicense(license) {
-    const response = await fetch(this.configuration.endpoint + `/api/client/licenses/${this.configuration.productId}/validate?format=JWT`, {
+    const response = await fetch(this.configuration.endpoint + `/api/client/licenses/${this.configuration.productId}/validate${this.buildQueryString()}`, {
       ...defaultFetchOptions,
       method: "POST",
       headers: {
@@ -141,6 +141,19 @@ var LicenseClient = class {
     }
     return await this.licenseValidator.validateLicense(await response.text());
   }
+  buildQueryString() {
+    const parts = ["format=JWT"];
+    const { platform, appVersion, metadata } = this.configuration;
+    if (platform) parts.push(`platform=${encodeURIComponent(platform)}`);
+    if (appVersion) parts.push(`appVersion=${encodeURIComponent(appVersion)}`);
+    if (metadata) {
+      for (const [key, value] of Object.entries(metadata)) {
+        if (value === null || value === void 0 || value === "") continue;
+        parts.push(`meta[${encodeURIComponent(key)}]=${encodeURIComponent(value)}`);
+      }
+    }
+    return `?${parts.join("&")}`;
+  }
 };
 
 // src/deviceIdResolver.ts
@@ -368,12 +381,26 @@ var LicenseValidator = class {
 };
 
 // src/index.ts
+function detectPlatform() {
+  if (typeof process === "undefined") return void 0;
+  switch (process.platform) {
+    case "darwin":
+      return "Mac";
+    case "win32":
+      return "Windows";
+    case "linux":
+      return "Linux";
+    default:
+      return void 0;
+  }
+}
 var MoonbaseLicensing = class {
   constructor(configuration) {
     var _a, _b;
     this.configuration = {
       ...configuration,
-      endpoint: configuration.endpoint.replace(/\/$/, "")
+      endpoint: configuration.endpoint.replace(/\/$/, ""),
+      platform: configuration.platform === void 0 ? detectPlatform() : configuration.platform
     };
     this.store = (_a = configuration.licenseStore) != null ? _a : new InMemoryLicenseStore();
     this.deviceIdResolver = (_b = configuration.deivceIdResolver) != null ? _b : new DefaultDeviceIdResolver();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@moonbase.sh/licensing",
   "type": "module",
-  "version": "1.0.33",
+  "version": "1.0.34",
   "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",