chore: Update docs

case-contract-testing · Oct 17, 2024 · 021a4d7 · 021a4d7
1 parent 6fefba5
commit 021a4d7
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 7 deletions.
diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
     "build": "lerna run build",
     "lint": "lerna run lint",
     "lint:fix": "lerna run lint:fix",
-    "update-docs": "rimraf packages/documentation/docs/examples/generated && example-extractor -o packages/documentation/docs/examples/generated && lerna run build:docs",
+    "update-docs": "rimraf packages/documentation/docs/examples/generated && example-extractor -o packages/documentation/docs/examples/generated && lerna run build:docs:local",
     "test": "lerna run test",
     "test:verify": "lerna run test:verify",
     "coverage": "lcov-result-merger 'packages/*/*/lcov.info' combined-coverage.info --prepend-source-files"

diff --git a/packages/case-plugin-dsl-types/api-extractor/case-plugin-dsl-types.api.json b/packages/case-plugin-dsl-types/api-extractor/case-plugin-dsl-types.api.json
@@ -448,7 +448,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    variables: "
+              "text": "{\n    stateVariables: "
             },
             {
               "kind": "Reference",
@@ -466,7 +466,34 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n}"
+              "text": ">;\n    mock: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, "
+            },
+            {
+              "kind": "Reference",
+              "text": "VariableValue",
+              "canonicalReference": "@contract-case/case-plugin-dsl-types!~VariableValue:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n    functions: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Record",
+              "canonicalReference": "!Record:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<string, (...args: string[]) => string>;\n}"
             },
             {
               "kind": "Content",
@@ -478,7 +505,7 @@
           "name": "BaseSetupInfo",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 6
+            "endIndex": 12
           }
         },
         {

diff --git a/packages/case-plugin-dsl-types/api-extractor/case-plugin-dsl-types.api.md b/packages/case-plugin-dsl-types/api-extractor/case-plugin-dsl-types.api.md
@@ -43,7 +43,9 @@ export type AnyStateType = typeof SETUP_NAMED_STATE | typeof SETUP_VARIABLE_STAT
 
 // @public
 export type BaseSetupInfo = {
-    variables: Record<string, VariableValue>;
+    stateVariables: Record<string, VariableValue>;
+    mock: Record<string, VariableValue>;
+    functions: Record<string, (...args: string[]) => string>;
 };
 
 // @public

diff --git a/packages/case-plugin-dsl-types/docs/case-plugin-dsl-types.basesetupinfo.md b/packages/case-plugin-dsl-types/docs/case-plugin-dsl-types.basesetupinfo.md
@@ -10,7 +10,9 @@ The base SetupInfo provided to all mock setup functions and triggers.
 
 ```typescript
 export type BaseSetupInfo = {
-    variables: Record<string, VariableValue>;
+    stateVariables: Record<string, VariableValue>;
+    mock: Record<string, VariableValue>;
+    functions: Record<string, (...args: string[]) => string>;
 };
 ```
 

diff --git a/packages/case-plugin-dsl-types/temp/case-plugin-dsl-types.api.md b/packages/case-plugin-dsl-types/temp/case-plugin-dsl-types.api.md
@@ -43,7 +43,9 @@ export type AnyStateType = typeof SETUP_NAMED_STATE | typeof SETUP_VARIABLE_STAT
 
 // @public
 export type BaseSetupInfo = {
-    variables: Record<string, VariableValue>;
+    stateVariables: Record<string, VariableValue>;
+    mock: Record<string, VariableValue>;
+    functions: Record<string, (...args: string[]) => string>;
 };
 
 // @public