@skyramp/skyramp 0.4.34 → 0.4.36

package/README.md

@@ -1,6 +1,6 @@
 # skyramp
 
-`skyramp` is an npm module that provides utility functions for leveraging [skyramp CLI](https://skyramp.dev/docs/commands/skyramp/) commands. The `skyramp` module provides functionalities to create and apply mock configurations for both gRPC and REST APIs. It also offers features for testing and asserting scenarios in various test environments. The module exports the following classes: `RestEndpoint`, `GrpcEndpoint`, `Scenario`, and `SkyrampClient`.
+`skyramp` is an npm module that provides utility functions for leveraging [skyramp CLI](https://skyramp.dev/docs/reference/cli-commands/) commands. The `skyramp` module provides functionalities to create and apply mock configurations for both gRPC and REST APIs. It also offers features for testing and asserting scenarios in various test environments. The module exports the following classes: `RestEndpoint`, `GrpcEndpoint`, `Scenario`, and `SkyrampClient`.
 
 ## Installation
 To install Skyramp, simply run the following command in your terminal:
@@ -11,7 +11,7 @@ npm install @skyramp/skyramp
 ## Usage
 Once you've installed Skyramp, you can import it into your project like this:
 
-```bash
+```javascript
 const { GrpcEndpoint, RestEndpoint, SkyrampClient, Scenario } = require('skyramp');
 ```
 
@@ -19,7 +19,7 @@ const { GrpcEndpoint, RestEndpoint, SkyrampClient, Scenario } = require('skyramp
 The `SkyrampClient` class is the main entry point to interact with the skyramp module. It allows you to apply configurations, start test scenarios, and deploy and delete workers. First, you must set up the `SkyrampClient` with a kubernetes cluster.
 
 **Example: Provision Local Cluster with Skyramp**
-```bash
+```javascript
 const skyrampClient = new SkyrampClient();
 skyrampClient.applyLocal().then(function() {
   // Local cluster provisioned
@@ -30,7 +30,7 @@ skyrampClient.applyLocal().then(function() {
 Once you have a `SkyrampClient` instance configured with a kubernetes cluster, you can deploy the Skyramp Worker in-cluster, for applying mocks and running tests.
 
 **Example: Deploy Skyramp Worker**
-```bash
+```javascript
 skyrampClient.deployWorker('my-namespace').then(function() {
   // Worker deployed successfully
 }).catch(function(error) {
@@ -42,7 +42,7 @@ skyrampClient.deployWorker('my-namespace').then(function() {
 The `RestEndpoint` class represents a REST API endpoint and provides methods to configure mock responses to apply them to the `SkyrampClient`.
 
 **Example: Create REST Mock Configuration**
-```bash
+```javascript
 restEndpoint = new RestEndpoint('artists', 'artists-GET', 50050, 'api/openapi/artists.yaml');
 restEndpoint.mockMethodFromFile('artists-GET', 'files/rest-values.yaml');
 skyrampClient.mockerApply('my-namespace', '', restEndpoint).then(function() {
@@ -56,7 +56,7 @@ skyrampClient.mockerApply('my-namespace', '', restEndpoint).then(function() {
 The `GrpcEndpoint` class represents a gRPC API endpoint and provides methods to configure mock responses to apply them to the `SkyrampClient`.
 
 **Example: Create gRPC Mock Configuration**
-```bash
+```javascript
 grpcEndpoint = new GrpcEndpoint('routeguide', 'RouteGuide', 50051, 'api/pb/routeguide.proto');
 grpcEndpoint.mockMethodFromFile('GetFeature', 'files/grpc-response.yaml');
 skyrampClient.mockerApply('my-namespace', '', grpcEndpoint).then(function() {
@@ -70,7 +70,7 @@ skyrampClient.mockerApply('my-namespace', '', grpcEndpoint).then(function() {
 The `Scenario` class allows you to define test scenarios by specifying a series of API requests and assertions to be made. Once a `Scenario` is created, you can start it using the `SkyrampClient` instance.
 
 **Example: Test Assert Scenario (REST)**
-```bash
+```javascript
 scenario = new Scenario('rest-test')
 step1 = scenario.addRequest(restEndpoint, 'artists-GET');
 step2 = scenario.addAssertEqual(`${step1}.res.items[0].artist_name`, 'abc');
@@ -82,7 +82,7 @@ skyrampClient.testerStart('test-worker', '', scenario).then(function() {
 ```
 
 **Example: Test Assert Scenario (gRPC)**
-```bash
+```javascript
 scenario = new Scenario('routeguide-assert-test')
 step1 = scenario.addRequestFromFile(grpcEndpoint, 'GetFeature', 'files/grpc-request.yaml');
 step2 = scenario.addAssertEqual(`${step1}.res.name`, 'test-feature');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/skyramp",
-  "version": "0.4.34",
+  "version": "0.4.36",
   "description": "module for leveraging skyramp cli functionality",
   "scripts": {
     "pack": "npm pack"
@@ -18,6 +18,6 @@
   "dependencies": {
     "fs": "^0.0.1-security",
     "js-yaml": "^4.1.0",
-    "koffi": "^2.5.3"
+    "koffi": "2.5.12"
   }
 }