Transpilers for building BSON documents in any language. Current support
provided for shell
javascript
and python
as inputs. java
, c#
, node
, shell
and python
as
outputs.
See also the original presentation: https://drive.google.com/file/d/1jvwtR3k9oBUzIjL4z_VtpHvdWahfcjTK/view
const transpiler = require('bson-transpilers');
const input = 'javascript';
const output = 'java';
const string =`
{ item: "book", qty: Int32(10), tags: ["red", "blank"], dim_cm: [14, Int32("81")] }`;
try {
const compiledString = transpiler[input][output].compile(string);
console.log(compiledCode);
// new Document("item", "book").append("qty", 10)
// .append("tags", Arrays.asList("red", "blank"))
// .append("dim_cm", Arrays.asList(14L, 81")))
} catch (error) {
console.error(error);
}
Output a compiled string given input and output languages.
- inputLang: Input language of the code string.
shell
andjavascript
are currently supported. - outputLang: The language you would like the output to be.
java
,python
,shell
,javascript
, andcsharp
are currently supported. - codeString: The code string you would like to be compiled to your selected output language.
Output a string containing the set of import statements for the generated code to compile. These are all the packages that the compiled code could use so that the transpiler output will be runnable.
Any transpiler errors that occur will be thrown. To catch them, wrap the
transpiler
in a try/catch
block.
- error.message: Message
bson-transpilers
will send back letting you know the transpiler error. - error.stack: The usual error stacktrace.
- error.code: Error code that
bson-transpilers
adds to the error object to help you distinguish error types. - error.line: If it is a syntax error, will have the line.
- error.column: If it is a syntax error, will have the column.
- error.symbol: If it is a syntax error, will have the symbol associated with the error.
There are a few different error classes thrown by bson-transpilers
, each with
their own error code:
This will occur when you're using a method with a wrong number of arguments, or
the arguments are of the wrong type.
For example, ObjectId().equals()
requires one argument and it will throw if
anything other than one argument is provided:
// ✘: this will throw a BsonTranspilersArgumentError.
ObjectId().equals(ObjectId(), ObjectId());
// ✔: this won't throw
ObjectId().equals(ObjectId());
// ✘: this will throw a BsonTranspilersArgumentError.
ObjectId({});
// ✔: this won't throw
ObjectId();
Will be thrown if an invalid method or property is used on a BSON object. For
example, since new DBRef()
doesn't have a method .foo()
, transpiler will
throw:
// ✘: method foo doesn't exist, so this will throw a BsonTranspilersAttributeError .
new DBRef('newCollection', new ObjectId()).foo()
// ✔: this won't throw, since .toString() method exists
new DBRef('newCollection', new ObjectId()).toString(10)
This will throw if you have a syntax error. For example missing a colon in Object assignment, or forgetting a comma in array definition:
// ✘: this is not a proper object definition; will throw E_SYNTAX_GENERIC
{ key 'beep' }
// ✘: this is not a proper array definition, will throw E_SYNTAX_GENERIC
[ 'beep'; 'boop' 'beepBoop' ]
// ✔: neither of these will throw
{ key: 'beep' }
[ 'beep', 'boop', 'beepBoop' ]
This error will occur if a symbol is treated as the wrong type. For example, if a non-function is called:
// ✘: MAX_VALUE is a constant, not a function
Long.MAX_VALUE()
// ✔: MAX_VALUE without a call will not throw
Long.MAX_VALUE
If there is a feature in the input code that is not currently supported by the transpiler.
A generic runtime error will be thrown for all errors that are not covered by the
above list of errors. These are usually constructor requirements, for example
when using a RegExp()
an unsupported flag is given:
// ✘: these are not proper 'RegExp()' flags, a BsonTranspilersRuntimeError will be thrown.
new RegExp('ab+c', 'beep')
// ✔: 'im' are proper 'RegExp()' flags
new RegExp('ab+c', 'im')
In the case where something has gone wrong within compilation, and an error has occured. If you see this error, please create an issue on Github!
npm install -S bson-transpilers
Head over to the readme on contributing to find out more information on project structure and setting up your environment.
- aherlihy - Anna Herlihy herlihyap@gmail.com
- alenakhineika - Alena Khineika alena.khineika@mongodb.com
- lrlna - Irina Shestak shestak.irina@gmail.com