@sricsl/sunflower-client v2.1.2

@sricsl/sunflower-client

sunflower_client - JavaScript client for @sricsl/sunflower-client Sunflower Server This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.0.0
• Package version: 2.1.2
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @sricsl/sunflower-client --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @sricsl/sunflower-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var sunflower_client = require('@sricsl/sunflower-client');

var defaultClient = sunflower_client.ApiClient.instance;
// Configure Bearer (jwt) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new sunflower_client.SunflowerServiceApi()
var docId = "docId_example"; // {String} document id
var id = "id_example"; // {String} subject
var arrowType = new sunflower_client.ArrowType(); // {ArrowType} arrowType
var frameType = new sunflower_client.FrameType(); // {FrameType} frameType
var prop = "prop_example"; // {String} prop
api.addBooleanProperty(docId, id, arrowType, frameType, prop).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation for Models

• sunflower_client.ArrowType
• sunflower_client.BindingValue
• sunflower_client.BooleanPropertyFact
• sunflower_client.BooleanPropertyInfo
• sunflower_client.Directive
• sunflower_client.DirectiveInfo
• sunflower_client.Fact
• sunflower_client.FrameType
• sunflower_client.HilogFact
• sunflower_client.HilogFactInfo
• sunflower_client.Import
• sunflower_client.InstanceOf
• sunflower_client.InstanceOfInfo
• sunflower_client.Justification
• sunflower_client.JustificationType
• sunflower_client.LatentQuery
• sunflower_client.LatentQueryAbbrevInfo
• sunflower_client.LatentQueryInfo
• sunflower_client.NLRequest
• sunflower_client.NLResult
• sunflower_client.Namespace
• sunflower_client.NamespaceInfo
• sunflower_client.NamespaceSpec
• sunflower_client.OntologyAdd
• sunflower_client.OntologyChange
• sunflower_client.OntologyDelete
• sunflower_client.PropertyFact
• sunflower_client.Query
• sunflower_client.QueryInfo
• sunflower_client.QueryRequest
• sunflower_client.QueryResult
• sunflower_client.QueryStatus
• sunflower_client.QueryType
• sunflower_client.Rule
• sunflower_client.RuleAbbrevInfo
• sunflower_client.RuleInfo
• sunflower_client.Solution
• sunflower_client.SubclassOf
• sunflower_client.SubclassOfInfo
• sunflower_client.TraceNode
• sunflower_client.TraceNodeJustification
• sunflower_client.TraceResult
• sunflower_client.TriplePropertyFact
• sunflower_client.TriplePropertyInfo
• sunflower_client.UDF
• sunflower_client.UDFInfo

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (jwt)