Add publish keyword

apps/docs/docs/user/core-concepts.md

@@ -29,6 +29,7 @@ pipeline CarsPipeline {
 A _block_ is a processing step within a _pipeline_.
 It can have a default input and a default output.
 We differentiate the following types of _blocks_:
+
 - _Extractor blocks_ do not have a default input but only a default output. They model a **data source**.
 - _Transformator blocks_ have a default input and a default output. They model a **transformation**.
 - _Loader blocks_ do have a default input but nor a default output. They model a **data sink**.
@@ -49,7 +50,7 @@ The availability of property keys and their respective _value types_ is determin
 block GasReserveHttpExtractor oftype HttpExtractor {
     // key: value
     url: "https://www.bundesnetzagentur.de/_tools/SVG/js2/_functions/csv_export.html?view=renderCSV&id=1089590";
-} 
+}
 ```
 
 In the example above, the `url` property of type `text` is defined by the corresponding `HttpExtractor` _block type_.
@@ -61,10 +62,11 @@ _Blocks_ can be either defined as part of the language, called _built-in_ or def
 A _value type_ is the definition of a data type of the processed data.
 Some _blocks_ use _value types_ to define logic (like filtering or assessing the data type in a data sink).
 We differentiate the following kinds of _value types_:
+
 - _Built-in value types_ come with the basic version of Jayvee. See [built-in value types](./value-types/built-in-value-types).
 - _Primitive value types_ can be defined by the user to model domain-specific data types and represent a single value.
   _Constraints_ can be added to a _primitive value types_.
-See [primitive value types](./value-types/primitive-value-types).
+  See [primitive value types](./value-types/primitive-value-types).
 - _Compound value types_: UPCOMING.
 
 ```jayvee
@@ -77,6 +79,7 @@ constraint GasFillLevelRange on decimal:
 ```
 
 ## Transforms
+
 _Transforms_ are used to transform data from one _value type_ to a different one. For more details, see [transforms](./transforms.md).
 
 ```jayvee
@@ -86,4 +89,36 @@ transform CelsiusToKelvin {
 
   tempKelvin: tempCelsius + 273.15;
 }
-```
+```
+
+## Publishing / using model elements
+
+If you want to use a model element in a different file other than the one you define it, you need to _publish_ and _use_ it.
+
+1. Publish the element to make it usable in other files.
+
+```jayvee
+// Either publish right away when defining an element
+publish constraint GasFillLevelRange on decimal:
+    value >= 0 and value <= 100;
+
+// Or define first and publish separately
+constraint GasFillLevelRange on decimal:
+    value >= 0 and value <= 100;
+
+publish GasFillLevelRange;
+```
+
+2. Use the element in another file
+
+```jayvee
+// Define from where you want to take elements
+use * from './relative/path/to/file.jv';
+
+// Then just use them as if they were defined on root level
+valuetype GasFillLevel oftype integer {
+    constraints: [ GasFillLevelRange ]; // GasFillLevelRange is defined in another file
+}
+```
+
+Currently, only root-level elements can be published, so elements defined within a pipeline cannot be used in other files.

libs/execution/src/lib/constraints/executors/allowlist-constraint-executor.spec.ts

@@ -8,7 +8,9 @@ import {
   type JayveeServices,
   type TypedConstraintDefinition,
   createJayveeServices,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
+import { extractTestElements } from '@jvalue/jayvee-language-server/test';
 import {
   type ParseHelperOptions,
   expectNoParserAndLexerErrors,
@@ -51,10 +53,12 @@ describe('Validation of AllowlistConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = extractTestElements(
+      document,
+      (x): x is TypedConstraintDefinition => isTypedConstraintDefinition(x),
+    )[0]!;
 
     return new AllowlistConstraintExecutor().isValid(
       value,

libs/execution/src/lib/constraints/executors/denylist-constraint-executor.spec.ts

@@ -8,10 +8,12 @@ import {
   type JayveeServices,
   type TypedConstraintDefinition,
   createJayveeServices,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
   expectNoParserAndLexerErrors,
+  extractTestElements,
   parseHelper,
   readJvTestAssetHelper,
 } from '@jvalue/jayvee-language-server/test';
@@ -51,10 +53,12 @@ describe('Validation of DenylistConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = extractTestElements(
+      document,
+      (x): x is TypedConstraintDefinition => isTypedConstraintDefinition(x),
+    )[0]!;
 
     return new DenylistConstraintExecutor().isValid(
       value,

libs/execution/src/lib/constraints/executors/expression-constraint-executor.spec.ts

@@ -8,10 +8,12 @@ import {
   type InternalValueRepresentation,
   type JayveeServices,
   createJayveeServices,
+  isExpressionConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
   expectNoParserAndLexerErrors,
+  extractTestElements,
   parseHelper,
   readJvTestAssetHelper,
 } from '@jvalue/jayvee-language-server/test';
@@ -51,10 +53,13 @@ describe('Validation of AllowlistConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<ExpressionConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as ExpressionConstraintDefinition;
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = extractTestElements(
+      document,
+      (x): x is ExpressionConstraintDefinition =>
+        isExpressionConstraintDefinition(x),
+    )[0]!;
 
     return new ExpressionConstraintExecutor(constraint).isValid(
       value,

libs/execution/src/lib/constraints/executors/length-constraint-executor.spec.ts

@@ -8,10 +8,12 @@ import {
   type JayveeServices,
   type TypedConstraintDefinition,
   createJayveeServices,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
   expectNoParserAndLexerErrors,
+  extractTestElements,
   parseHelper,
   readJvTestAssetHelper,
 } from '@jvalue/jayvee-language-server/test';
@@ -51,10 +53,12 @@ describe('Validation of LengthConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = extractTestElements(
+      document,
+      (x): x is TypedConstraintDefinition => isTypedConstraintDefinition(x),
+    )[0]!;
 
     return new LengthConstraintExecutor().isValid(
       value,

libs/execution/src/lib/constraints/executors/range-constraint-executor.spec.ts

@@ -9,10 +9,12 @@ import {
   type TypedConstraintDefinition,
   createJayveeServices,
   initializeWorkspace,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
   expectNoParserAndLexerErrors,
+  extractTestElements,
   parseHelper,
   readJvTestAssetHelper,
 } from '@jvalue/jayvee-language-server/test';
@@ -52,10 +54,12 @@ describe('Validation of RangeConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = extractTestElements(
+      document,
+      (x): x is TypedConstraintDefinition => isTypedConstraintDefinition(x),
+    )[0]!;
 
     return new RangeConstraintExecutor().isValid(
       value,

libs/execution/src/lib/constraints/executors/regex-constraint-executor.spec.ts

@@ -8,10 +8,12 @@ import {
   type JayveeServices,
   type TypedConstraintDefinition,
   createJayveeServices,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
   expectNoParserAndLexerErrors,
+  extractTestElements,
   parseHelper,
   readJvTestAssetHelper,
 } from '@jvalue/jayvee-language-server/test';
@@ -51,10 +53,12 @@ describe('Validation of RegexConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = extractTestElements(
+      document,
+      (x): x is TypedConstraintDefinition => isTypedConstraintDefinition(x),
+    )[0]!;
 
     return new RegexConstraintExecutor().isValid(
       value,

libs/execution/src/lib/transforms/transform-executor.spec.ts

@@ -11,10 +11,12 @@ import {
   type JayveeServices,
   type TransformDefinition,
   createJayveeServices,
+  isTransformDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
   expectNoParserAndLexerErrors,
+  extractTestElements,
   loadTestExtensions,
   parseHelper,
   readJvTestAssetHelper,
@@ -77,10 +79,11 @@ describe('Validation of TransformExecutor', () => {
     const document = await parse(input, { validation: true });
     expectNoParserAndLexerErrors(document);
 
-    const transform = locator.getAstNode<TransformDefinition>(
-      document.parseResult.value,
-      'transforms@0',
-    ) as TransformDefinition;
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const transform = extractTestElements(
+      document,
+      (x): x is TransformDefinition => isTransformDefinition(x),
+    )[0]!;
 
     const executionContext = getTestExecutionContext(
       locator,

libs/execution/test/assets/transform-executor/test-extension/TestBlockTypes.jv

@@ -2,17 +2,17 @@
 //
 // SPDX-License-Identifier: AGPL-3.0-only
 
-builtin blocktype TestFileExtractor {
+publish builtin blocktype TestFileExtractor {
     input inPort oftype None;
     output outPort oftype File;
 }
 
-builtin blocktype TestFileLoader {
+publish builtin blocktype TestFileLoader {
     input inPort oftype File;
     output outPort oftype None;
 }
 
-builtin blocktype TestTableLoader {
+publish builtin blocktype TestTableLoader {
     input inPort oftype Table;
     output outPort oftype None;
 }

libs/extensions/rdbms/exec/test/test-extension/TestBlockTypes.jv

@@ -2,7 +2,7 @@
 //
 // SPDX-License-Identifier: AGPL-3.0-only
 
-builtin blocktype TestTableExtractor {
+publish builtin blocktype TestTableExtractor {
     input inPort oftype None;
     output outPort oftype Table;
 }

libs/extensions/std/exec/test/test-extension/TestBlockTypes.jv

@@ -2,22 +2,22 @@
 //
 // SPDX-License-Identifier: AGPL-3.0-only
 
-builtin blocktype TestFileExtractor {
+publish builtin blocktype TestFileExtractor {
     input inPort oftype None;
     output outPort oftype File;
 }
 
-builtin blocktype TestFileLoader {
+publish builtin blocktype TestFileLoader {
     input inPort oftype File;
     output outPort oftype None;
 }
 
-builtin blocktype TestSheetLoader {
+publish builtin blocktype TestSheetLoader {
     input inPort oftype Sheet;
     output outPort oftype None;
 }
 
-builtin blocktype TestTextFileLoader {
+publish builtin blocktype TestTextFileLoader {
     input inPort oftype TextFile;
     output outPort oftype None;
 }

libs/extensions/tabular/exec/test/test-extension/TestBlockTypes.jv

@@ -2,42 +2,42 @@
 //
 // SPDX-License-Identifier: AGPL-3.0-only
 
-builtin blocktype TestSheetExtractor {
+publish builtin blocktype TestSheetExtractor {
     input inPort oftype None;
     output outPort oftype Sheet;
 }
 
-builtin blocktype TestSheetLoader {
+publish builtin blocktype TestSheetLoader {
     input inPort oftype Sheet;
     output outPort oftype None;
 }
 
-builtin blocktype TestTextFileExtractor {
+publish builtin blocktype TestTextFileExtractor {
     input inPort oftype None;
     output outPort oftype TextFile;
 }
 
-builtin blocktype TestFileExtractor {
+publish builtin blocktype TestFileExtractor {
     input inPort oftype None;
     output outPort oftype File;
 }
 
-builtin blocktype TestWorkbookExtractor {
+publish builtin blocktype TestWorkbookExtractor {
     input inPort oftype None;
     output outPort oftype Workbook;
 }
 
-builtin blocktype TestWorkbookLoader {
+publish builtin blocktype TestWorkbookLoader {
     input inPort oftype Workbook;
     output outPort oftype None;
 }
 
-builtin blocktype TestTableExtractor {
+publish builtin blocktype TestTableExtractor {
     input inPort oftype None;
     output outPort oftype Table;
 }
 
-builtin blocktype TestTableLoader {
+publish builtin blocktype TestTableLoader {
     input inPort oftype Table;
     output outPort oftype None;
 }