@loadstrike/loadstrike-sdk 1.0.16101 → 1.0.17301

package/README.md

@@ -1,6 +1,15 @@
-# LoadStrike for TypeScript and JavaScript
+# LoadStrike SDK for TypeScript and JavaScript
 
-LoadStrike for TypeScript and JavaScript lets you define, run, and report load scenarios directly from your application or test suite.
+LoadStrike is a developer-first load testing SDK for Node.js applications, services, and test suites. Use it when you want to model real transactions in code, execute them in-process, and capture structured results without moving into a separate runner or DSL.
+
+## What This SDK Is For
+
+- Author scenario-based load tests in TypeScript or JavaScript.
+- Exercise HTTP and event-driven workflows across multiple steps.
+- Apply load simulations, thresholds, and custom metrics to real transactions.
+- Generate local reports and, on eligible plans, publish observability data to supported sinks.
+
+Built-in transport coverage includes HTTP, Kafka, RabbitMQ, NATS, Redis Streams, Azure Event Hubs, Push Diffusion, and delegate-based custom streams. Local report output supports HTML, Markdown, TXT, and CSV, and eligible plans can publish to InfluxDB, TimescaleDB, Grafana Loki, Datadog, Splunk HEC, and OpenTelemetry Collector.
 
 ## Requirements
 
@@ -12,33 +21,6 @@ LoadStrike for TypeScript and JavaScript lets you define, run, and report load s
 npm install @loadstrike/loadstrike-sdk
 ```
 
-## What You Can Do
-
-- Define scenarios, steps, load simulations, thresholds, and metrics in code
-- Run workloads in-process and collect structured results
-- Generate HTML, Markdown, TXT, and CSV reports
-- Extend runs with correlation, distributed execution, and reporting sinks when needed
-
-## Supported Transports
-
-- HTTP
-- Kafka
-- RabbitMQ
-- NATS
-- Redis Streams
-- Azure Event Hubs
-- Push Diffusion
-- Delegate and custom stream endpoints
-
-## Supported Reporting Sinks
-
-- InfluxDB
-- TimescaleDB
-- Grafana Loki
-- Datadog
-- Splunk HEC
-- OpenTelemetry Collector
-
 ## Quick Start
 
 ```ts
@@ -47,7 +29,7 @@ import {
   LoadStrikeRunner,
   LoadStrikeScenario,
   LoadStrikeSimulation,
-  LoadStrikeStep
+  LoadStrikeStep,
 } from "@loadstrike/loadstrike-sdk";
 
 const scenario = LoadStrikeScenario
@@ -58,7 +40,9 @@ const scenario = LoadStrikeScenario
       async () => LoadStrikeResponse.ok("200")
     );
   })
-  .withLoadSimulations(LoadStrikeSimulation.inject(10, 1, 20));
+  .withLoadSimulations(
+    LoadStrikeSimulation.inject(10, 1, 20)
+  );
 
 const result = await LoadStrikeRunner
   .registerScenarios(scenario)
@@ -66,8 +50,12 @@ const result = await LoadStrikeRunner
   .run();
 ```
 
-Use a runner key from your LoadStrike portal account when executing live workloads.
+`run()` returns the detailed run result, including generated report files, scenario statistics, metrics, and sink status.
+
+## Runner Keys
+
+Runnable workloads require a `RunnerKey`. Supply it with `.withRunnerKey(...)` or through your application configuration before calling `run()`.
 
-## Documentation And Examples
+## Documentation
 
-https://loadstrike.com/documentation
+- Product documentation: https://loadstrike.com/documentation

package/dist/cjs/local.js

@@ -44,6 +44,7 @@ const node_crypto_1 = require("node:crypto");
 const correlation_js_1 = require("./correlation.js");
 const transports_js_1 = require("./transports.js");
 const DEFAULT_LICENSING_API_BASE_URL = "https://licensing.loadstrike.com";
+const INTERNAL_BLACKBOX_LICENSING_API_BASE_URL_ENVIRONMENT_VARIABLE = "LOADSTRIKE_INTERNAL_BLACKBOX_API_BASE_URL";
 let developmentLicensingApiBaseUrlOverride;
 const BUILT_IN_WORKER_PLUGIN_NAMES = new Set([
     "loadstrike failed responses",
@@ -404,8 +405,25 @@ function normalizeLicensingApiBaseUrl(value) {
     const normalized = (value ?? "").trim();
     return normalized || DEFAULT_LICENSING_API_BASE_URL;
 }
+function resolveInternalBlackboxLicensingApiBaseUrlOverride(value) {
+    const normalized = String(value ?? "").trim();
+    if (!normalized) {
+        return undefined;
+    }
+    try {
+        const parsed = new URL(normalized);
+        const host = parsed.hostname.replace(/^\[|\]$/g, "").toLowerCase();
+        if (["http:", "https:"].includes(parsed.protocol) && ["127.0.0.1", "localhost", "::1"].includes(host)) {
+            return normalized.replace(/\/+$/, "");
+        }
+    }
+    catch {
+        return undefined;
+    }
+    return undefined;
+}
 function resolveLicensingApiBaseUrl() {
-    return normalizeLicensingApiBaseUrl(process.env.LOADSTRIKE_LICENSING_API_BASE_URL ?? developmentLicensingApiBaseUrlOverride);
+    return normalizeLicensingApiBaseUrl(resolveInternalBlackboxLicensingApiBaseUrlOverride(process.env[INTERNAL_BLACKBOX_LICENSING_API_BASE_URL_ENVIRONMENT_VARIABLE]) ?? developmentLicensingApiBaseUrlOverride);
 }
 function setDevelopmentLicensingApiBaseUrlOverride(value) {
     developmentLicensingApiBaseUrlOverride = value;

package/dist/esm/local.js

@@ -5,6 +5,7 @@ import { createHash, createVerify, randomUUID } from "node:crypto";
 import { CorrelationStoreConfiguration, CrossPlatformTrackingRuntime, RedisCorrelationStoreOptions, RedisCorrelationStore, TrackingFieldSelector } from "./correlation.js";
 import { EndpointAdapterFactory } from "./transports.js";
 const DEFAULT_LICENSING_API_BASE_URL = "https://licensing.loadstrike.com";
+const INTERNAL_BLACKBOX_LICENSING_API_BASE_URL_ENVIRONMENT_VARIABLE = "LOADSTRIKE_INTERNAL_BLACKBOX_API_BASE_URL";
 let developmentLicensingApiBaseUrlOverride;
 const BUILT_IN_WORKER_PLUGIN_NAMES = new Set([
     "loadstrike failed responses",
@@ -364,8 +365,25 @@ function normalizeLicensingApiBaseUrl(value) {
     const normalized = (value ?? "").trim();
     return normalized || DEFAULT_LICENSING_API_BASE_URL;
 }
+function resolveInternalBlackboxLicensingApiBaseUrlOverride(value) {
+    const normalized = String(value ?? "").trim();
+    if (!normalized) {
+        return undefined;
+    }
+    try {
+        const parsed = new URL(normalized);
+        const host = parsed.hostname.replace(/^\[|\]$/g, "").toLowerCase();
+        if (["http:", "https:"].includes(parsed.protocol) && ["127.0.0.1", "localhost", "::1"].includes(host)) {
+            return normalized.replace(/\/+$/, "");
+        }
+    }
+    catch {
+        return undefined;
+    }
+    return undefined;
+}
 function resolveLicensingApiBaseUrl() {
-    return normalizeLicensingApiBaseUrl(process.env.LOADSTRIKE_LICENSING_API_BASE_URL ?? developmentLicensingApiBaseUrlOverride);
+    return normalizeLicensingApiBaseUrl(resolveInternalBlackboxLicensingApiBaseUrlOverride(process.env[INTERNAL_BLACKBOX_LICENSING_API_BASE_URL_ENVIRONMENT_VARIABLE]) ?? developmentLicensingApiBaseUrlOverride);
 }
 function setDevelopmentLicensingApiBaseUrlOverride(value) {
     developmentLicensingApiBaseUrlOverride = value;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loadstrike/loadstrike-sdk",
-  "version": "1.0.16101",
+  "version": "1.0.17301",
   "description": "TypeScript and JavaScript SDK for in-process load execution, traffic correlation, and reporting.",
   "keywords": [
     "load-testing",
@@ -9,14 +9,6 @@
     "reporting"
   ],
   "homepage": "https://loadstrike.com/documentation",
-  "bugs": {
-    "url": "https://github.com/loadstrike/LoadStrike/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/loadstrike/LoadStrike.git",
-    "directory": "sdk/ts"
-  },
   "type": "module",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",