@smile-digital-health/crl 0.7.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -20,12 +20,17 @@ This is a private package. To install it, you need:
    - Each developer should use their own npm account
 
 2. Set up authentication:
+
    ```bash
    # Log in to npm - recommended for individual developers
    npm login
+   ```
+
+  Or create/edit `~/.npmrc` with your personal access token (note the second line is **NOT a comment**):
 
-   # Or create/edit ~/.npmrc with your personal access token
-   //registry.npmjs.org/:_authToken=YOUR_NPM_TOKEN
+  ```npmc
+@smile-digital-health:registry=https://registry.npmjs.org/
+//registry.npmjs.org/:_authToken=YOUR_NPM_TOKEN
    ```
 
    > **Security Note:** Always use your personal npm token. Do not share tokens between team members.
@@ -91,36 +96,57 @@ tar -ztvf <package-name>.tgz
 
 ## CLI Usage
 
-The CRL package includes command-line tools for processing CRL files. Each tool can be run with the `--raw` flag to output raw JSON data instead of formatted output.
+> **⚠️ WARNING:**
+> When using npm scripts and passing arguments to the underlying CLI, always use `--` before your arguments. Otherwise, npm will not pass them to your script.
+> 
+> **Example:**
+> ```bash
+> npm run cli:lexer -- --path path/to/your/file.crl --pretty
+> ```
+
+The CRL package includes command-line tools for processing CRL files. Each tool supports the following options:
+
+- `--path <file>`: Specify the path to a CRL file to process. If omitted, the main example file is used by default.
+- `--pretty`: Output formatted (pretty-printed) results instead of raw JSON.
 
 ### Lexer Tool
 
 ```bash
 npx ts-node src/cli/run-lexer.ts
-npx ts-node src/cli/run-lexer.ts --raw
+npx ts-node src/cli/run-lexer.ts --pretty
+npx ts-node src/cli/run-lexer.ts --path path/to/your/file.crl
+npx ts-node src/cli/run-lexer.ts --path path/to/your/file.crl --pretty
 ```
 
 ### Parser Tool
 
 ```bash
 npx ts-node src/cli/run-parser.ts
-npx ts-node src/cli/run-parser.ts --raw
+npx ts-node src/cli/run-parser.ts --pretty
+npx ts-node src/cli/run-parser.ts --path path/to/your/file.crl
+npx ts-node src/cli/run-parser.ts --path path/to/your/file.crl --pretty
 ```
 
 ### AST Tool
 
 ```bash
 npx ts-node src/cli/run-ast.ts
-npx ts-node src/cli/run-ast.ts --raw
+npx ts-node src/cli/run-ast.ts --pretty
+npx ts-node src/cli/run-ast.ts --path path/to/your/file.crl
+npx ts-node src/cli/run-ast.ts --path path/to/your/file.crl --pretty
 ```
 
 ### Validator Tool
 
 ```bash
 npx ts-node src/cli/run-validator.ts
-npx ts-node src/cli/run-validator.ts --raw
+npx ts-node src/cli/run-validator.ts --pretty
+npx ts-node src/cli/run-validator.ts --path path/to/your/file.crl
+npx ts-node src/cli/run-validator.ts --path path/to/your/file.crl --pretty
 ```
 
+By default, each command processes the main example CRL file. To process a different file, provide the file path using `--path`. Use `--pretty` for formatted output.
+
 ### FSH-to-CRL Transformer Tool
 
 The FSH-to-CRL transformer converts FHIR Shorthand (FSH) files into Clinical Reasoning Language (CRL) files. It supports advanced mapping and deduplication logic for activities, concepts, and terminology blocks.
@@ -134,6 +160,22 @@ The FSH-to-CRL transformer converts FHIR Shorthand (FSH) files into Clinical Rea
 
 For more details, see the [User Guide](./USER_GUIDE.md) and the technical mapping documentation.
 
+## CLI Tool Usage
+
+You can run specific CLI modules using the following command:
+
+```
+npm run cli:<module>
+```
+
+For example, to run the lexer CLI on a CRL file:
+
+```
+npm run cli:lexer
+```
+
+Replace `<module>` with the desired CLI module name (e.g., `lexer`, `parser`, etc.).
+
 ## API Usage & Reference
 
 **All API functions return a `ParseResult` object. If there are any lexical or syntax errors, these are collected and returned in the `errors` array (not just printed to the console). You should always check `result.success` and handle errors accordingly.**
@@ -146,10 +188,9 @@ The package provides four main functions for processing CRL code:
 import { tokenizeCRL } from '@smile-digital-health/crl';
 
 
-const result = tokenizeCRL(`
+const result = tokenizeCRL(`# Example
   decision "Test":
-    when "Condition" then do "Action".
-  done
+    - when "Condition" then recommend activity "Action".
 `);
 
 if (result.success) {
@@ -166,10 +207,9 @@ if (result.success) {
 ```typescript
 import { parseCRL } from '@smile-digital-health/crl';
 
-const result = parseCRL(`
+const result = parseCRL(`# Example
   decision "Test":
-    when "Condition" then do "Action".
-  done
+    - when "Condition" then recommend activity "Action".
 `);
 
 if (result.success) {
@@ -186,10 +226,9 @@ if (result.success) {
 ```typescript
 import { buildCRL } from '@smile-digital-health/crl';
 
-const result = buildCRL(`
+const result = buildCRL(`# Example
   decision "Test":
-    when "Condition" then do "Action".
-  done
+    - when "Condition" then recommend activity "Action".
 `);
 
 if (result.success) {
@@ -208,10 +247,9 @@ if (result.success) {
 ```typescript
 import { validateCRL } from '@smile-digital-health/crl';
 
-const result = validateCRL(`
+const result = validateCRL(`# Example
   decision "Test":
-    when "Condition" then do "Action".
-  done
+    - when "Condition" then recommend activity "Action".
 `);
 
 if (result.success) {
@@ -500,3 +538,13 @@ setupFilesAfterEnv: ['<rootDir>/jest.setup.js'],
 ```
 
 This ensures that error logs are visible during development and CLI runs, but do not clutter test output.
+
+## Editor Support: VS Code Extension
+
+We provide a Visual Studio Code extension for CRL files:
+
+- Syntax highlighting for `.crl` files
+- Comment support
+- Language basics for a better editing experience
+
+For installation instructions and full details, see [extension/README.md](./extension/README.md)

package/dist/ast/builder.d.ts

@@ -1,9 +1,10 @@
 import { ParserRuleContext } from "antlr4ts/ParserRuleContext";
 import { AbstractParseTreeVisitor } from "antlr4ts/tree/AbstractParseTreeVisitor";
-import { CrlContext, DecisionStatementContext, DecisionBodyContext, WhenWithBodyContext, WhenSingleActionContext, NestedWhenBlockContext, BlockActionContext, BlockBodyContext, SingleActionStatementContext, DoStatementContext, UseStatementContext, TerminologyStatementContext, TerminologyValuesetContext, TerminologySystemCodeContext, ActivityStatementContext, ConceptStatementContext, InferredFromLineContext, DefinitionConceptContext, DefinitionLogicContext, InferredFromExpressionContext, InformalOrContext, InformalAndContext, InformalNotContext, ConceptAtomContext, GroupExpressionContext } from "../grammar/generated/antlr/CRLParser";
+import { CrlContext, DecisionStatementContext, DecisionBodyContext, WhenBlockContext, BlockBodyContext, ActionStatementContext, RecommendStatementContext, UseStatementContext, TerminologyStatementContext, TerminologyValuesetContext, ActivityStatementContext, ConceptStatementContext, InferredFromBodyContext, InferredFromExpressionContext, InformalOrContext, InformalAndContext, InformalNotContext, AtomContext, WhenWithBodyContext, WhenSingleActionContext, NestedWhenBlockContext, BlockActionContext, BlockStatementContext } from "../grammar/generated/antlr/CRLParser";
 import { CRLParserVisitor } from "../grammar/generated/antlr/CRLParserVisitor";
-import { CRLError } from "../types/errors";
-import { ASTNode, CRL, Decision, DecisionBody, WhenBlock, BlockBody, SingleAction, ActionStatement, DoActivity, UseDecision, Terminology, TerminologyValueset, TerminologySystemCode, Activity, Concept, InferredFromDefinition, ConceptReference, InformalAnd, InformalOr, NotExpression, GroupExpression, InferredFromConcept, InferredFromExpression } from "./types";
+import type { CRLError } from "../types/errors";
+import { ASTNode, Decision, DecisionBody, WhenBlock, BlockBody, ActionStatement, RecommendActivity, UseDecision, Terminology, TerminologyValueset, TerminologySystem, TerminologyCode, Activity, ActivityBody, ActivityRequest, ActivityWith, ActivityBecause, Concept, ConceptReference, InformalAnd, InformalOr, NotExpression, GroupExpression, InferredFromConcept } from "./types";
+import type { CRL } from "./types";
 type InformalNode = GroupExpression | ConceptReference | InformalAnd | NotExpression | InformalOr;
 export declare class CRLAstBuilder extends AbstractParseTreeVisitor<ASTNode> implements CRLParserVisitor<ASTNode> {
     private readonly errors;
@@ -13,33 +14,37 @@ export declare class CRLAstBuilder extends AbstractParseTreeVisitor<ASTNode> imp
     visitCrl(ctx: CrlContext): CRL;
     visitDecisionStatement(ctx: DecisionStatementContext): Decision;
     visitDecisionBody(ctx: DecisionBodyContext): DecisionBody;
+    visitWhenBlock(ctx: WhenBlockContext): WhenBlock;
     visitWhenWithBody(ctx: WhenWithBodyContext): WhenBlock;
     visitWhenSingleAction(ctx: WhenSingleActionContext): WhenBlock;
     visitNestedWhenBlock(ctx: NestedWhenBlockContext): WhenBlock;
-    visitBlockAction(ctx: BlockActionContext): ActionStatement;
+    visitBlockStatement(ctx: BlockStatementContext): WhenBlock | ActionStatement;
     visitBlockBody(ctx: BlockBodyContext): BlockBody;
-    visitSingleActionStatement(ctx: SingleActionStatementContext): SingleAction;
-    visitActionStatement(ctx: import("../grammar/generated/antlr/CRLParser").ActionStatementContext): ActionStatement;
-    visitDoStatement(ctx: DoStatementContext): DoActivity;
+    visitBlockAction(ctx: BlockActionContext): ActionStatement;
+    visitActionStatement(ctx: ActionStatementContext): ActionStatement;
+    visitRecommendStatement(ctx: RecommendStatementContext): RecommendActivity;
     visitUseStatement(ctx: UseStatementContext): UseDecision;
     visitTerminologyStatement(ctx: TerminologyStatementContext): Terminology;
     visitTerminologyValueset(ctx: TerminologyValuesetContext): TerminologyValueset;
-    visitTerminologySystemCode(ctx: TerminologySystemCodeContext): TerminologySystemCode;
-    private parseWithClause;
-    private parseRationaleClause;
+    visitTerminologySystem(ctx: import("../grammar/generated/antlr/CRLParser").TerminologySystemContext): TerminologySystem;
+    visitTerminologyCode(ctx: import("../grammar/generated/antlr/CRLParser").TerminologyCodeContext): TerminologyCode;
     visitActivityStatement(ctx: ActivityStatementContext): Activity;
+    visitActivityBody(ctx: import("../grammar/generated/antlr/CRLParser").ActivityBodyContext): ActivityBody;
+    visitActivityRequest(ctx: import("../grammar/generated/antlr/CRLParser").ActivityRequestContext): ActivityRequest;
+    visitActivityWith(ctx: import("../grammar/generated/antlr/CRLParser").ActivityWithContext): ActivityWith;
+    visitActivityBecause(ctx: import("../grammar/generated/antlr/CRLParser").ActivityBecauseContext): ActivityBecause;
     private parseConceptTypes;
+    private parseMeta;
     private parseEvidence;
     private parseConceptDefinition;
     visitConceptStatement(ctx: ConceptStatementContext): Concept;
-    visitInferredFromLine(ctx: InferredFromLineContext): InferredFromDefinition;
-    visitDefinitionConcept(ctx: DefinitionConceptContext): InferredFromConcept;
-    visitDefinitionLogic(ctx: DefinitionLogicContext): GroupExpression;
+    visitDefinitionConcept(ctx: InferredFromBodyContext): InferredFromConcept;
+    visitDefinitionLogic(ctx: InferredFromBodyContext): GroupExpression | InferredFromConcept;
     visitInferredFromExpression(ctx: InferredFromExpressionContext): InformalNode;
     visitInformalOr(ctx: InformalOrContext): InformalOr;
     visitInformalAnd(ctx: InformalAndContext): InformalAnd | NotExpression | GroupExpression | ConceptReference;
-    visitInformalNot(ctx: InformalNotContext): InferredFromExpression;
-    visitConceptAtom(ctx: ConceptAtomContext): ConceptReference;
-    visitGroupExpression(ctx: GroupExpressionContext): GroupExpression;
+    visitInformalNot(ctx: InformalNotContext): import("./types").InferredFromExpression;
+    visitConceptAtom(ctx: AtomContext): ConceptReference;
+    visitGroupExpression(ctx: AtomContext): GroupExpression;
 }
 export {};