@skyramp/skyramp 1.3.17 → 1.3.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/skyramp",
-  "version": "1.3.17",
+  "version": "1.3.19",
   "description": "module for leveraging skyramp cli functionality",
   "scripts": {
     "lint": "eslint 'src/**/*.js' 'src/**/*.ts' --fix",

package/src/classes/SkyrampClient.d.ts

@@ -146,6 +146,9 @@ interface GenerateRestTestOptions {
   consumerMode?: boolean;
   providerOutput?: string;
   consumerOutput?: string;
+  skipProvisionParents?: boolean;
+  mockPort?: number;
+  optionalFields?: boolean;
 }
 
 interface GenerateRestMockOptions {
@@ -172,6 +175,8 @@ interface GenerateRestMockOptions {
   apiSchema?: string[];
   traceFilePath?: string;
   entrypoint?: string;
+  mockPort?: number;
+  optionalFields?: boolean;
 }
 
 interface SendScenarioOptions {

package/src/classes/SkyrampClient.js

@@ -111,7 +111,8 @@ const generateRestTestWrapper = lib.func('generateRestTestWrapper', 'string', [
     'string',       // providerOutput (contract test)
     'string',       // consumerOutput (contract test)
     'bool',         // skipProvisionParents
-    'int'           // mockPort
+    'int',          // mockPort
+    'bool'          // optionalFields
 ]);
 const generateRestMockWrapper = lib.func('generateRestMockWrapper', 'string', [
     'string',       // uri
@@ -136,7 +137,8 @@ const generateRestMockWrapper = lib.func('generateRestMockWrapper', 'string', [
     'string',       // apiSchema
     'string',       // traceFilePath
     'string',       // entryPoint
-    'int'           // mockPort
+    'int',          // mockPort
+    'bool'          // optionalFields
 ]);
 const traceCollectWrapper = lib.func('traceCollectWrapper', 'string', ['string', 'string', 'bool', 'string', 'string']);
 const analyzeOpenapiWrapper = lib.func('analyzeOpenapiWrapper', 'string', ['string', 'string']);
@@ -960,6 +962,7 @@ class SkyrampClient {
         options.consumerOutput || "",
         options.skipProvisionParents || false,
         options.mockPort || 0,
+        options.optionalFields || false,
         (err, res) => {
           if (err) {
             reject(err);
@@ -997,6 +1000,7 @@ class SkyrampClient {
         options.traceFilePath || "",
         options.entrypoint || "",
         options.mockPort || 0,
+        options.optionalFields || false,
         (err, res) => {
           if (err) {
             reject(err);

package/src/lib.js

@@ -1,5 +1,6 @@
 const koffi = require('koffi');
 const path = require('path');
+const fs = require('fs');
 
 const platform = process.platform;
 const arch = process.arch;
@@ -26,7 +27,63 @@ if (platform === 'linux') {
 if (!libPath) {
   throw new Error(`Unsupported platform or architecture: ${platform}-${arch}`);
 }
+
 const libFullPath = path.join(__dirname, '..', 'lib', libPath);
+
+/**
+ * Wait for library file to be available (handles case where npm module is used
+ * before library file is fully downloaded during installation).
+ * Uses synchronous polling since Node.js module loading is synchronous.
+ *
+ * @param {string} filePath - Path to the library file
+ * @param {number} timeoutMs - Maximum time to wait in milliseconds
+ * @param {number} intervalMs - Check interval in milliseconds
+ */
+function waitForFileSync(filePath, timeoutMs = 180000, intervalMs = 500) {
+  const startTime = Date.now();
+  let warningShown = false;
+  const { execSync } = require('child_process');
+
+  while (Date.now() - startTime < timeoutMs) {
+    if (fs.existsSync(filePath)) {
+      if (warningShown) {
+        console.log(`Library file is now available: ${filePath}`);
+      }
+      return;
+    }
+
+    // Show warning on first check if file is missing
+    if (!warningShown) {
+      console.warn(
+        `Warning: Library file not yet available: ${filePath}\n` +
+        `Waiting for up to ${timeoutMs / 1000} seconds for the file to become available...\n` +
+        `This may happen if the module is used before installation is fully complete.`
+      );
+      warningShown = true;
+    }
+
+    // Synchronous sleep using platform-specific commands
+    try {
+      if (platform === 'win32') {
+        execSync(`timeout /t ${Math.ceil(intervalMs / 1000)} /nobreak >nul 2>&1`, { stdio: 'ignore' });
+      } else {
+        execSync(`sleep ${intervalMs / 1000}`, { stdio: 'ignore' });
+      }
+    } catch (e) {
+      // If sleep command fails, fall back to a simple check without delay
+      // This prevents the loop from running too fast
+    }
+  }
+
+  throw new Error(
+    `Library file not found after waiting ${timeoutMs / 1000} seconds: ${filePath}\n` +
+    `This may happen if the npm module is used before the native library is fully downloaded.\n` +
+    `Please ensure the installation completed successfully.`
+  );
+}
+
+// Wait for the library file to be available before loading
+waitForFileSync(libFullPath, 180000); // Wait up to 3 minutes
 const lib = koffi.load(libFullPath);
 
 module.exports = lib;