From 3488b771895bb2825311a16faf4ff8893979ea8a Mon Sep 17 00:00:00 2001 From: Jonathan-Casey <109082377+Jonathan-Casey@users.noreply.github.com> Date: Wed, 11 Oct 2023 00:25:01 +0100 Subject: [PATCH 1/2] feat(*): Add JSDoc for ModelManager `enableMapType` option (#731) * feat(map): add JSDoc to ModelManager for enableMapType Signed-off-by: Jonathan Casey * changelog update Signed-off-by: Jonathan Casey --------- Signed-off-by: Jonathan Casey --- packages/concerto-core/api.txt | 2 +- packages/concerto-core/changelog.txt | 3 +++ packages/concerto-core/lib/modelmanager.js | 1 + packages/concerto-core/types/lib/modelmanager.d.ts | 2 ++ 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/packages/concerto-core/api.txt b/packages/concerto-core/api.txt index d3d29dac79..3a415fb38c 100644 --- a/packages/concerto-core/api.txt +++ b/packages/concerto-core/api.txt @@ -323,7 +323,7 @@ class ModelLoader { + ModelManager[] loadModelManagerFromModelFiles(object[],string[],object,boolean?,boolean?,number?) } class ModelManager extends BaseModelManager { - + void constructor(object?,boolean?,Object?) + + void constructor(object?,boolean?,Object?,boolean?) + ModelFile addCTOModel(string,string?,boolean?) throws IllegalModelException } + object getRootModel() diff --git a/packages/concerto-core/changelog.txt b/packages/concerto-core/changelog.txt index 81a893ad0d..1f47d97731 100644 --- a/packages/concerto-core/changelog.txt +++ b/packages/concerto-core/changelog.txt @@ -24,6 +24,9 @@ # Note that the latest public API is documented using JSDocs and is available in api.txt. # +Version 3.13.1 {f435a20a00712e49c5cd32bc73ecb06a} 2023-10-03 +- Add JSDoc for enableMapType option on ModelManager + Version 3.13.1 {6b09c1c58abcc77eecbb44e375c2efb8} 2023-10-03 - Add enableMapType option to BaseModelManager options diff --git a/packages/concerto-core/lib/modelmanager.js b/packages/concerto-core/lib/modelmanager.js index dd8f8b7579..05d7c14a7b 100644 --- a/packages/concerto-core/lib/modelmanager.js +++ b/packages/concerto-core/lib/modelmanager.js @@ -59,6 +59,7 @@ class ModelManager extends BaseModelManager { * @param {object} [options] - ModelManager options, also passed to Serializer * @param {boolean} [options.strict] - require versioned namespaces and imports * @param {Object} [options.regExp] - An alternative regular expression engine. + * @param {boolean} [options.enableMapType] - When true, the Concerto Map Type feature is enabled */ constructor(options) { super(options, ctoProcessFile(options)); diff --git a/packages/concerto-core/types/lib/modelmanager.d.ts b/packages/concerto-core/types/lib/modelmanager.d.ts index b97477a996..8a5d1e81a3 100644 --- a/packages/concerto-core/types/lib/modelmanager.d.ts +++ b/packages/concerto-core/types/lib/modelmanager.d.ts @@ -19,10 +19,12 @@ declare class ModelManager extends BaseModelManager { * @param {object} [options] - ModelManager options, also passed to Serializer * @param {boolean} [options.strict] - require versioned namespaces and imports * @param {Object} [options.regExp] - An alternative regular expression engine. + * @param {boolean} [options.enableMapType] - When true, the Concerto Map Type feature is enabled */ constructor(options?: { strict?: boolean; regExp?: any; + enableMapType?: boolean; }); /** * Adds a model in CTO format to the ModelManager. From aca5c3e647406b0beb2203c4fe925265e666e136 Mon Sep 17 00:00:00 2001 From: Muskan B Date: Mon, 16 Oct 2023 14:09:30 +0530 Subject: [PATCH 2/2] fix(readme): Added correct link in readme (#734) Added correct link in readme Signed-off-by: Muskan Bararia fix(readme): Added correct link in readme Co-authored-by: Muskan Bararia --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 64abf52442..387c248be9 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ Infer models from other formats: ## Getting Started -- Install the [Command Line Tool](https://docs.accordproject.org/docs/ref-concerto-cli.html) +- Install the [Command Line Tool](https://concerto.accordproject.org/docs/tools/ref-concerto-cli) - Read the [Concerto specification](https://docs.accordproject.org/docs/model-concerto.html) ```console