mulesoft-labs / raml-javascript-generator Goto Github PK

See mulesoft-labs/raml-client-generator#15 for using Popsicle plugins.

We need to support OAuth 1.0 clients in the JavaScript generator. That means a promise-based reusable OAuth 1.0 library like https://github.com/mulesoft/js-client-oauth2. There also needs to be associated documentation generated in the JavaScript client README.

• Create OAuth 1.0 client library
• Integrate OAuth 1.0 with RAML settings and generated client
• Support OAuth 1.0 access tokens (users)
• Add dynamically generated documentation to README

Migrated from mulesoft-labs/raml-client-generator#5.

Hi there, thanks for your work on this awesome library. I'm successfully instantiating the client in the Chrome, but I've noticed two inconsistencies between the generated client in node and browser environments.

TypeError: client.request is not a function

try to make a request (e.g. client.resources.Resource.get()), I'm getting an error saying client.request is not a function.
**
I don't get this error in node however.**

It turns out in the browser, the request property on client is an Object and there is a request method on that object (which is the method needed in this instance). My temporary solution is to change line 70 of the generated client's index.js to:

return client.request.request(reqOpts)

When providing headers, the key 'content-type' header is case sensitive in browser

For example, when I call in the browser: client.resources.Resource.post({ foo: bar }, {headers: { 'Content-Type': 'application/x-www-form-urlencoded' }}), my Content-Type header doesn't get sent and I get an error from my server. However, using content-type (lowercase) sends the correct header.

However, both uppercase/lowercase works fine in node.

The devDependency @commitlint/cli was updated from 7.1.2 to 7.2.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@commitlint/cli is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency @commitlint/prompt was updated from 7.1.2 to 7.2.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@commitlint/prompt is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

this file has

Client.prototype.request = popsicle
Client.prototype.form = Client.form = popsicle.form
Client.prototype.version  = {{{stringify version}}}

Maybe first line should be
Client.prototype.request = popsicle.request or similar?

I'm using raml-javascript-generator to generate resources on my client side that is written in Typescript.
What is missing is the type safety on raml client resources.
Generate an extra d.ts file the describe client should be enough and probably a trivial task.

The devDependency eslint-plugin-import was updated from 2.16.0 to 2.17.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-import is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Global headers provided on client init do not work.
Reason: Every function call uses something like
{code}
var options = extend({ body: body, headers: {} }, opts)
{code}
i.e. forcefully defines a "headers" attribute. On the used "xtend" version of extend this is therefore overriding any global options set:
{code}
var options = extend({}, client._options, opts)
{code}

Resolution: Use version of "extend" supporting recursive extension.

There is a bug regarding the securitySchemes. If they are not specified the generation fails at support/api.js line 6.

Function call for REST URL like "/foo/{foo}" are documented as "client.foo({foo})" - which I would interpret as String value for the parameter.

Implementation shows a wrapper object is assumed:
client.foo({foo : "value"})
to add the value to URL (via "template" function).

2 Options:

• Improve readme.MD and stick to object - though I believe this is not common-sense as URLs only support plain text strings
• Do not use "template" but directly use provided value.

Lets put some more content.. a lot more in the README. I dont have a good idea of what this project does, why you would use it, examples of how to use it, etc. The README is the place for this sort of stuff (or at least links to examples, etc). The current README leaves a lot to be desired as to the purpose and use of this project.

Right now in the request method the cert, key, and ca attribues are not copied.
In general it would be good to have control of the entitre options object, for agent setting proxies, etc. Let me know if u want to take care of it yourself or a via pull request

let reqOpts = {
url: baseUri.replace(//$/, '') + template(path, options.uriParameters),
json: !Buffer.isBuffer(options.body),
method,
headers,
formData: options.formData,
body: options.body,
qs: options.query,
options: options.options,
resolveWithFullResponse: true
};

The devDependency watchify was updated from 3.11.0 to 3.11.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

watchify is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

The devDependency eslint was updated from 5.13.0 to 5.14.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Continuing from mulesoft-labs/raml-client-generator#12, we should be able to configure options using the data object:

• Git url
• Author name
• Issues url
• License name
• License file
• Publishing options for each language package (e.g. will the JS client go to NPM, Bower or just local)
• Module name

The devDependency @commitlint/config-angular was updated from 7.1.2 to 7.3.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@commitlint/config-angular is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

If you npm install raml-javascript-generator and try to use it you get the following traceback:

module.js:338
    throw err;
          ^
Error: Cannot find module 'camel-case'
    at Function.Module._resolveFilename (module.js:336:15)
    at Function.Module._load (module.js:278:25)
    at Module.require (module.js:365:17)
    at require (module.js:384:17)
    at Object.<anonymous> (c:\Users\wfaust\Desktop\Development_git\specs\node_modules\raml-javascript-generator\lib\helpers\request-snippet.js:1:79)
    at Module._compile (module.js:460:26)
    at Object.Module._extensions..js (module.js:478:10)
    at Module.load (module.js:355:32)
    at Function.Module._load (module.js:310:12)
    at Module.require (module.js:365:17)
    at require (module.js:384:17)

This is because the fix for #4 did not add camel-case to the dependencies in package.json.

Probably is more related to Typescript than Javascript, but what about schema objects generation?
Actually I'm doing this task in java whit jaxrs generator (based on json schema used in raml).
I would like do to the same on client side.
Have you got any idea, how to achieve this extending this generator?

The dependency @types/node was updated from 10.9.4 to 10.10.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

The devDependency browserify was updated from 16.2.2 to 16.2.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

browserify is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

We have detected a problem with your Greenkeeper config file 🚨

Greenkeeper currently can’t work with your greenkeeper.json config file because it is invalid. We found the following issue:

1. The package path src/templates/package.json.ts in the group default must end with package.json.

Please correct this and commit the fix to your default branch (usually master). Greenkeeper will pick up your changes and try again. If in doubt, please consult the config documentation.

Here’s an example of a valid greenkeeper.json:

{
  groups: {
    frontend: {
      packages: [
        'webapp/package.json',
        'cms/package.json',
        'analytics/package.json'
      ]
    },
    build: {
      packages: [
        'package.json'
      ]
    }
  },
  ignore: [
    'standard',
    'eslint'
  ]
}

This files tells Greenkeeper to handle all dependency updates in two groups. All files in the frontend group will receive updates together, in one issue or PR, and the root-level package.json in the build group will be treated separately. In addition, Greenkeeper will never send updates for the standard and eslint packages.

🤖 🌴

The devDependency tslint-config-airbnb was updated from 5.11.0 to 5.11.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

tslint-config-airbnb is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Hi,

I have done npm install raml-javascript-generator, however, when I attempt to actually require in the library in a script, it is failing:

This:

jsGen = require('raml-javascript-generator');
var output = jsGen.client("raw.raml");

Fails with this:

C:\devel\raml-generator-test
λ node .\index.js
module.js:341
    throw err;
    ^

Error: Cannot find module 'raml-javascript-generator'
    at Function.Module._resolveFilename (module.js:339:15)
    at Function.Module._load (module.js:290:25)
    at Module.require (module.js:367:17)
    at require (internal/module.js:16:19)
    at Object.<anonymous> (C:\devel\raml-generator-test\index.js:1:71)
    at Module._compile (module.js:413:34)
    at Object.Module._extensions..js (module.js:422:10)
    at Module.load (module.js:357:32)
    at Function.Module._load (module.js:314:12)

require('raml-javascript-generator/dist') appears to work (followed by other errors), but it not what the readme says, so seems incorrect.

Any help would be appreciated.

In case the RAML file ONLY has URLs with URL parameters (i.e. "/foo/{foo}") the generator is only spitting out in constructor.
{code}
setprototypeof(client, this)
{code}
but NO specific mappings like
{code}
this.bazz = new Resource5(client, '/bazz')
setprototypeof(client, this)
{code}

However, this causes this._client to be never set as the "client" created here is never injected.

Workaround:
Add setter in constructor:
{code}
this._client=client;
setprototypeof(client, this)
{code}

I have a URL /parse-order in my API. For this URL the following documentation is generated:

resources.parse-order

var resource = client.resources.parse-order;

However the actual code that is generated uses camelCase, so the documentation should instead read:

var resource = client.resources.parseOrder;