Ability to provide a custom record context besides the standard record Id (#220)

Author: cesarParra

.idea/copilot.data.migration.agent.xml

@@ -1,53 +1,53 @@
-import {readFileSync, writeFileSync} from "fs";
-import {defineMarkdownConfig, skip} from "@cparra/apexdocs";
+import { readFileSync, writeFileSync } from "fs";
+import { defineMarkdownConfig, skip } from "@cparra/apexdocs";
 
 export default defineMarkdownConfig({
-    sourceDir: 'expression-src',
-    targetDir: 'docs/src/app/docs/api',
-    scope: ['global'],
-    namespace: 'expression',
-    transformReference: (reference) => {
-        return {
-            outputDocPath: reference.outputDocPath.replace('.md', '/page.md'),
-            referencePath: reference.referencePath.replace('.md', ''),
-        };
-    },
-    transformReferenceGuide: () => {
-        return skip();
-    },
-    transformDocPage: (docPage) => {
-        return {
-            frontmatter: {
-                nextjs: {
-                    metadata: {
-                        title: docPage.source.name,
-                        description: `Api documentation for the ${docPage.source.name} ${docPage.source.type}}`,
-                    }
-                }
-            },
-        };
-    },
-    transformDocs: (docs) => {
-        const navFileContents = readFileSync("docs/src/lib/navigation.json", "utf8");
-        const navItems = JSON.parse(navFileContents);
-        // Find an object whose title is "Api"
-        let apiNavObject = navItems.find((navObject: any) => navObject.title === "Api");
-        apiNavObject = apiNavObject ?? {title: "Api", links: []};
+  sourceDir: "expression-src",
+  targetDir: "docs/src/app/docs/api",
+  scope: ["global"],
+  namespace: "expression",
+  transformReference: (reference) => {
+    return {
+      outputDocPath: reference.outputDocPath.replace(".md", "/page.md"),
+      referencePath: reference.referencePath.replace(".md", ""),
+    };
+  },
+  transformReferenceGuide: () => {
+    return skip();
+  },
+  transformDocPage: (docPage) => {
+    return {
+      frontmatter: {
+        nextjs: {
+          metadata: {
+            title: docPage.source.name,
+            description: `Api documentation for the ${ docPage.source.name } ${ docPage.source.type }`,
+          }
+        }
+      },
+    };
+  },
+  transformDocs: (docs) => {
+    const navFileContents = readFileSync("docs/src/lib/navigation.json", "utf8");
+    const navItems = JSON.parse(navFileContents);
+    // Find an object whose title is "Api"
+    let apiNavObject = navItems.find((navObject: any) => navObject.title === "Api");
+    apiNavObject = apiNavObject ?? { title: "Api", links: [] };
 
-        apiNavObject.links = docs.map((doc) => {
-            return {
-                title: doc.source.name, href: `/docs/api/${doc.outputDocPath.replace('page.md', '').replace(/\/$/, '')}`
-            };
-        });
+    apiNavObject.links = docs.map((doc) => {
+      return {
+        title: doc.source.name, href: `/docs/api/${ doc.outputDocPath.replace("page.md", "").replace(/\/$/, "") }`
+      };
+    });
 
-        // replace the Api object with the new one (or add it if it didn't exist)
-        const newNavItems = navItems.filter((navObject: any) => navObject.title !== "Api");
-        newNavItems.push(apiNavObject);
+    // replace the Api object with the new one (or add it if it didn't exist)
+    const newNavItems = navItems.filter((navObject: any) => navObject.title !== "Api");
+    newNavItems.push(apiNavObject);
 
-        // Write the new navigation.json file
-        const newNavFileContents = JSON.stringify(newNavItems, null, 2);
-        writeFileSync("docs/src/lib/navigation.json", newNavFileContents);
+    // Write the new navigation.json file
+    const newNavFileContents = JSON.stringify(newNavItems, null, 2);
+    writeFileSync("docs/src/lib/navigation.json", newNavFileContents);
 
-        return docs;
-    },
+    return docs;
+  },
 });

.idea/copilot.data.migration.ask.xml

@@ -10,7 +10,7 @@ test = "sf apex test run --test-level RunLocalTests --wait 20"
 docs = "apexdocs markdown"
 generate-library-docs = "bun scripts/generate-library-docs.mjs"
 prep-package = "bun scripts/prepare-for-packaging.mjs"
-package = "cirrus package -p Expression -t minor -x -c --promote -w 60"
+run-package = "cirrus package create -p Expression -t minor -x -c --promote -w 60"
 post-package = "bun scripts/post-packaging.mjs"
 
 [flow.start-dev]
@@ -25,6 +25,6 @@ steps = [
 description = "Create a managed package version for Expression"
 steps = [
     { type = "command", name = "prep-package" },
-    { type = "command", name = "package" },
+    { type = "command", name = "run-package" },
     { type = "command", name = "post-package" },
 ]

.idea/copilot.data.migration.ask2agent.xml

@@ -1,4 +1,4 @@
 {
-  "packageId": "04tRb000003UxfFIAS",
+  "packageId": "04tRb000003tVPdIAM",
   "componentPackageId": "04tRb0000012Mv8IAE"
 }

.idea/copilot.data.migration.edit.xml

@@ -2,7 +2,7 @@
 nextjs:
   metadata:
     title: Configuration
-    description: Api documentation for the Configuration class}
+    description: Api documentation for the Configuration class
 ---
 
 # Configuration Class
@@ -13,6 +13,18 @@ Configuration class for the evaluator.
 expression
 
 ## Fields
+### `globalContextVariablePrefix`
+
+#### Signature
+```apex
+global globalContextVariablePrefix
+```
+
+#### Type
+String
+
+---
+
 ### `sharing`
 
 #### Signature
@@ -104,6 +116,23 @@ global Configuration withCustomContext(Map<String,Object> objectsByStrings)
 #### Return Type
 **[Configuration](Configuration)**
 
+---
+
+### `withGlobalContextVariablePrefix(prefix)`
+
+#### Signature
+```apex
+global Configuration withGlobalContextVariablePrefix(String prefix)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| prefix | String |  |
+
+#### Return Type
+**[Configuration](Configuration)**
+
 ## Enums
 ### SharingMode Enum
 

apexdocs.config.ts

@@ -0,0 +1,76 @@
+---
+nextjs:
+  metadata:
+    title: CustomRecordContext
+    description: Api documentation for the CustomRecordContext class
+---
+
+# CustomRecordContext Class
+
+## Namespace
+expression
+
+## Fields
+### `key`
+
+#### Signature
+```apex
+global final key
+```
+
+#### Type
+String
+
+---
+
+### `recordId`
+
+#### Signature
+```apex
+global final recordId
+```
+
+#### Type
+Id
+
+---
+
+### `prequeriedRecord`
+
+#### Signature
+```apex
+global final prequeriedRecord
+```
+
+#### Type
+SObject
+
+## Constructors
+### `CustomRecordContext(key, recordId)`
+
+#### Signature
+```apex
+global CustomRecordContext(String key, Id recordId)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| key | String |  |
+| recordId | Id |  |
+
+---
+
+### `CustomRecordContext(key, recordId, prequeriedRecord)`
+
+#### Signature
+```apex
+global CustomRecordContext(String key, Id recordId, SObject prequeriedRecord)
+```
+
+#### Parameters
+| Name | Type | Description |
+|------|------|-------------|
+| key | String |  |
+| recordId | Id |  |
+| prequeriedRecord | SObject |  |