Chore: add OpenApi encoded

[HeverFarber]

Readme API docs - enforce open API standard that <,> are invalid characters and uniqe operationId.

• This package usets-json-schema-generator to generate the schema - however ts-json-schema-generator generate <,> when your types include generic types.
• This package is integrated with @conqa/serverless-openapi-documentation to enrich data. openapi-documentation uses the function name for the operation id.

Solutions:

• Encode the characters <,> to _
• Add docs title to each operation id - this is needed when you combine multi openApi files to one (from multi service with the same methods names)

Breaking changes

operationId was change

[HeverFarber]

This field is also responsible for the url also - for example, https://docs.env0.com/reference/project-updatefunc

[roni-frantchi]

1. I would add a comment about what we're doing here and why (how generics are generated with > and how these aren't legal character's in openapi 3.1 spec (with link)
2. %3C and %3E don't mean much - I would atob('>') to better capture the intent here, and also rename to INVALID_CHARACTERS_ENCODED

[HeverFarber]

btoa - is to encode it to base 64.
Maybe you mean encodeURI

I can change it to something like that - But I prefer to keep it simple. I can add comment about it

new RegExp(`${encodeURI('<')}|${encodeURI('>')/g`)

[HeverFarber]

8036b4b

[roni-frantchi]

I think isString(value) is superfluous.
If key === '$ref', what else could it be?

[HeverFarber]

For safety - but we don't need it

[HeverFarber]

8036b4b

[roni-frantchi]

Matter of personal of style so your call - I think the interim value of mapObject does nothing but make this method a little more verbose than it needs to be.
Of course it makes sense to avoid nested functions like f(g(x)).

Deepdash, like lodash does offer a way to chain functions which make it easier to follow the functional path:

_(openApi)
  .mapKeysDeep(stubGenerics)
  .mapValuesDeep(stubBase64EncodedGenerics)
  .value();

[HeverFarber]

I didn't see they offer this chain - they offer to put the functions on the lodash object _ but I think not in the chain (more complex to do it) But I will try. I searched after that in the docs

[HeverFarber]

I don't like how they mix it with lodash and it will not work with the chain also we have typescript problem.

// or cherry-pick method you only need and mix it into lodash
require('deepdash/addFilterDeep')(_);
// or cherry-pick method separately if you don't want to mutate Lodash instance
const filterDeep = require('deepdash/getFilterDeep')(_);

I tried to do something with flow - but it just complex it and increase the code

[HeverFarber]

I changed major version because we broke the API.
operationId value will be different after this version