@skyramp/skyramp 2025.8.11 → 2025.12.19

package/src/function.d.ts

@@ -0,0 +1,20 @@
+import { ResponseV2 } from "./classes/ResponseV2";
+
+/**
+ * Checks if the response's status code matches the expected status code (with support for wildcards).
+ *
+ * The expected status can include 'x' as a wildcard for a single digit.
+ * Examples:
+ *   - "200" matches exactly 200
+ *   - "20x" matches any status code in the range 200 to 209
+ *   - "2xx" matches any status code in the range 200 to 299
+ *
+ * @param response - The response object containing a `status_code` attribute.
+ * @param expectedStatus - The expected status code as a string with optional 'x' wildcards.
+ * @returns True if the status code matches, false otherwise.
+ * @throws Error if the response object lacks a 'status_code' attribute.
+ */
+export function checkStatusCode(
+  response: ResponseV2,
+  expectedStatus: string
+): boolean;

package/src/index.d.ts

@@ -1,19 +1,21 @@
-export * from './classes/Endpoint';
-export * from './classes/GrpcEndpoint';
-export * from './classes/RestEndpoint';
-export * from './classes/Scenario';
-export * from './classes/SkyrampClient';
-export * from './classes/RequestValue';
-export * from './classes/ResponseValue';
-export * from './classes/RestParam';
-export * from './classes/MultipartParam';
-export * from './classes/TrafficConfig';
-export * from './classes/DelayConfig';
-export * from './classes/Protocol';
-export * from './classes/RequestV2';
-export * from './classes/ResponseV2';
-export * from './classes/AsyncScenario';
-export * from './classes/LoadTestConfig';
-export * from './classes/AsyncTestStatus';
-export * from './utils';
-export * from './function';
+export * from "./classes/Endpoint";
+export * from "./classes/GrpcEndpoint";
+export * from "./classes/RestEndpoint";
+export * from "./classes/Scenario";
+export * from "./classes/SkyrampClient";
+export * from "./classes/RequestValue";
+export * from "./classes/ResponseValue";
+export * from "./classes/RestParam";
+export * from "./classes/MultipartParam";
+export * from "./classes/TrafficConfig";
+export * from "./classes/DelayConfig";
+export * from "./classes/Protocol";
+export * from "./classes/RequestV2";
+export * from "./classes/ResponseV2";
+export * from "./classes/MockV2";
+export * from "./classes/AsyncScenario";
+export * from "./classes/LoadTestConfig";
+export * from "./classes/AsyncTestStatus";
+export * from "./utils";
+export * from "./function";
+export * from "./classes/SmartPlaywright";

package/src/index.js

@@ -16,13 +16,16 @@ const ResponseV2 = require('./classes/ResponseV2');
 const { AsyncScenario, AsyncRequest } = require('./classes/AsyncScenario');
 const { LoadTestConfig } = require('./classes/LoadTestConfig');
 const AsyncTestStatus = require('./classes/AsyncTestStatus');
-const { getValue, checkSchema, iterate } = require('./utils');
+const MockV2 = require('./classes/MockV2');
+const { getValue, checkSchema, iterate, pushToolEvent } = require('./utils');
 const { checkStatusCode } = require('./function');
+const { newSkyrampPlaywrightPage, expect } = require('./classes/SmartPlaywright');
 
 module.exports = {
   SkyrampClient,
   RequestV2,
   ResponseV2,
+  MockV2,
   GrpcEndpoint,
   RestEndpoint,
   Scenario,
@@ -43,4 +46,7 @@ module.exports = {
   checkStatusCode,
   checkSchema,
   iterate,
+  pushToolEvent,
+  newSkyrampPlaywrightPage,
+  expect,
 }

package/src/utils.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Checks if the given value is a JSON string.
+ * @param value - The value to check
+ * @returns True if the value is a JSON string, false otherwise
+ */
+export function isJSONString(value: string): boolean;
+
+/**
+ * Safely converts a value to a JSON string.
+ * @param value - The value to stringify
+ * @returns The JSON string representation
+ */
+export function safeStringify(value: string): string;
+
+/**
+ * Creates a test description from a scenario.
+ * @param scenario - The scenario object
+ * @returns The test description
+ */
+export function createTestDescriptionFromScenario(scenario: object): object;
+
+/**
+ * Gets YAML bytes from a configuration.
+ * @param config - The configuration object
+ * @returns The YAML bytes
+ */
+export function getYamlBytes(config: object): string;
+
+/**
+ * Reads data from a file.
+ * @param filePath - The path to the file
+ * @returns The file data
+ */
+export function readDataFromFile(
+  filename: string
+): [string, false] | [string, true];
+
+/**
+ * Extracts a value from JSON using JSONPath syntax.
+ * @param jsonInput - The JSON object or string to extract from
+ * @param path - The JSONPath expression (e.g., "$.value", "$.data[0].name")
+ * @returns The extracted value or null if not found
+ */
+export function getValue(
+  jsonInput: object,
+  path: string
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+): any;
+
+/**
+ * Validates JSON against a schema.
+ * @param jsonInput - The JSON to validate
+ * @param schema - The schema to validate against
+ * @returns The validation result
+ */
+export function checkSchema(jsonInput: object, schema: object): boolean;
+
+/**
+ * Iterates over JSON data structure.
+ * @param jsonInput - The JSON data to iterate
+ * @returns The iteration result
+ */
+export function iterate(jsonInput: object): object;
+
+/**
+ * Send telemetry of tool event
+ * @param {string} entryPoint - entrypoint of event, either MCP or vscode
+ * @param {string} toolName - name of the tool
+ * @param {string} error - error message if it failed
+ * @param {Object} params - any parameters associated with the tool call. Disctionary
+ */
+export function pushToolEvent(entryPoint: string, toolName: string, err: string, params: object): void;
+
+/**
+ * check for update
+ */
+export function checkForUpdate(component: string): void;
+
+/**
+ * The Skyramp YAML version constant.
+ */
+export const SKYRAMP_YAML_VERSION: string;

package/src/utils.js

@@ -13,6 +13,8 @@ const responseType = koffi.struct({
 const getJSONValueWrapper = lib.func('getJSONValueWrapper', responseType, ['string', 'string']);
 const checkSchemaWrapper = lib.func('checkSchemaWrapper', responseType, ['string', 'string']);
 const iterateWrapper = lib.func('generateJsonTreePathsFromBlob', 'string', ['string']);
+const pushToolEventWrapper = lib.func('pushToolEvent', 'void', ['string', 'string', 'string', 'string']);
+const checkForUpdateWrapper = lib.func('checkForUpdateWrapper', 'void', ['string']);
 
 function isJSONString(value) {
   if (typeof value !== "string") {
@@ -196,6 +198,29 @@ function iterate(fuzz_body) {
     return parsed
 }
 
+/**
+ * Send telemetry of tool event
+ *
+ * @param {string} entryPoint - entrypoint of event, either MCP or vscode
+ * @param {string} toolName - name of the tool
+ * @param {string} error - error message if it failed
+ * @param {Object} params - any parameters associated with the tool call. Disctionary
+ */
+function pushToolEvent(entryPoint, toolName, err, params) {
+    const paramsStr = JSON.stringify(params);
+
+    pushToolEventWrapper(entryPoint, toolName, err, paramsStr);
+}
+
+/**
+ * check if new library is available
+ *
+ * @param {string} component - NAme of component
+ */
+function checkForUpdate(component) {
+    checkForUpdateWrapper(component)
+}
+
 module.exports = {
   createTestDescriptionFromScenario,
   getYamlBytes,
@@ -203,5 +228,7 @@ module.exports = {
   getValue,
   checkSchema,
   iterate,
+  pushToolEvent,
+  checkForUpdate,
   SKYRAMP_YAML_VERSION
 }