(JavaScript) Inspect the Complete Set of Defined Variables

See more CURL Examples

Note: This example requires Chilkat v11.5.0 or greater.

For more information, see https://www.chilkatsoft.com/curl_dependency_engine.asp

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

// This example shows how to inspect the complete set of defined variables
// after executing the curl dependency plan.
// The code that enumerates and displays all variables is located at the end of the example.

var httpCurl = new CkHttpCurl();

// The final curl command we want to execute.
// It depends on {{drive_id}}, which is not yet known.
var targetCurl = "curl -X GET https://graph.microsoft.com/v1.0/drives/{{drive_id}}/root/children";

// Define a helper function that can produce drive_id.
// This function lists drives for a given site, which requires {{site_id}}.
var fnName = "getDrives";
httpCurl.AddFunction(fnName,"curl -X GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives");

// Define the output of getDrives.
// The JSON response contains an array named "value".
// We take the first element (value[0]) and extract its "id" as drive_id.
var jsonPath = "value[0].id";
httpCurl.AddOutput(fnName,jsonPath,"drive_id");

// drive_id depends on site_id, which is also not yet known.
// Define another helper function to obtain site_id.
fnName = "getSite";
httpCurl.AddFunction(fnName,"GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}");

// Map the "id" field from the getSite response to the variable site_id.
jsonPath = "id";
httpCurl.AddOutput(fnName,jsonPath,"site_id");

// Provide the initial known input.
// site_name is the starting value that allows the dependency chain to be resolved.
httpCurl.SetVar("site_name","test");

// ----------------------------------------------------------------------------------------------------------------------
// Configure OAuth2 authentication using the client credentials flow.
// Secrets (client_id, client_secret, token_endpoint) are retrieved from the
// local secrets manager because EnableSecrets is enabled.
var jsonOAuth2 = new CkJsonObject();
jsonOAuth2.EnableSecrets = true;
jsonOAuth2.UpdateString("oauth2.client_id","!!sharepoint|oauth2|client_id");
jsonOAuth2.UpdateString("oauth2.client_secret","!!sharepoint|oauth2|client_secret");
jsonOAuth2.UpdateString("oauth2.scope","https://graph.microsoft.com/.default");
jsonOAuth2.UpdateString("oauth2.token_endpoint","!!sharepoint|oauth2|token_endpoint");
httpCurl.SetAuth(jsonOAuth2);
// ----------------------------------------------------------------------------------------------------------------------

// Execute the target curl command.
// Internally, the system will:
// 
// 1) Detect that {{drive_id}} is required but not defined.
// 2) Find that "getDrives" can produce drive_id.
// 3) Detect that getDrives requires {{site_id}}, which is also not defined.
// 4) Find that "getSite" can produce site_id.
// 5) Verify that getSite requires {{site_name}}, which is already known.
// 6) Build a multi-step execution plan:
//      - First:  run getSite (produces site_id)
//      - Second: run getDrives (produces drive_id)
//      - Third:  run the target curl (uses drive_id)
success = httpCurl.DoYourThing(targetCurl);
if (success == false) {
    console.log(httpCurl.LastErrorText);
    return;
}

// Retrieve and display the HTTP response status code.
var statusCode = httpCurl.StatusCode;
console.log("response status code: " + statusCode);

// Load and display the JSON response from the final curl command.
var responseJson = new CkJsonObject();
responseJson.EmitCompact = false;
httpCurl.GetResponseJson(responseJson);
console.log(responseJson.Emit());

// ----------------------------------
// Examine all defined variables.
// ----------------------------------
var definedVarsJson = new CkJsonObject();
definedVarsJson.EmitCompact = false;

httpCurl.GetAllVars(definedVarsJson);
console.log(definedVarsJson.Emit());

// Sample output:

// {
//   "vars": [
//     {
//       "name": "site_name",
//       "value": "test"
//     },
//     {
//       "name": "site_id",
//       "value": "example.sharepoint.com,9b923c5e-5117-44ad-8b03-adbb8e19be85,b2451e19-290f-5f29-9f5d-674c2950a9f7"
//     },
//     {
//       "name": "drive_id",
//       "value": "b!XjySmxdRrrtLA827jhm-nRkeRbIPKSlPn11nTClQqfeVOj5VUvQMQae34rwOHdiP"
//     }
//   ]
// }

// Sample code to parse the above JSON.
var i = 0;
var numVars = definedVarsJson.SizeOfArray("vars");
while (i < numVars) {
    definedVarsJson.I = i;
    console.log("name: " + definedVarsJson.StringOf("vars[i].name"));
    console.log("value: " + definedVarsJson.StringOf("vars[i].value"));
    i = i+1;
}