[Issue #291] Website - Extend schema tab component to include links to source files (#295)

Author: DavidDudas-Intuitial

website/src/components/SchemaFormatTabs.astro

@@ -49,6 +49,57 @@ const jsonSchemaCode = jsonSchema ? extractCode(jsonSchema) : null;
 const typeSpecCode = typeSpec ? extractCode(typeSpec) : null;
 const pythonCode = python ? extractCode(python) : null;
 
+const jsonSchemaUrl = jsonSchema ? extractSchemaUrl(jsonSchema) : null;
+const typeSpecUrl = typeSpec ? extractGithubUrl(typeSpec) : null;
+const pythonUrl = python ? extractGithubUrl(python) : null;
+
+/**
+ * Constructs a schema URL from file path.
+ * @param props - The code block configuration
+ * @returns The schema URL for the file, or null if no file is specified
+ */
+function extractSchemaUrl(props: CodeBlockConfig): string | null {
+  if (!props.file) {
+    return null;
+  }
+
+  const baseUrl = "https://commongrants.org/";
+  const pathPrefix = "website/public/";
+  let filePath = props.file.path;
+  
+  // Trim public directory prefix if present
+  if (filePath.startsWith(pathPrefix)) {
+    filePath = filePath.substring(pathPrefix.length);
+  }
+  
+  return `${baseUrl}${filePath}`;
+}
+
+/**
+ * Extracts a GitHub URL from file configuration.
+ * @param props - The code block configuration
+ * @returns The GitHub URL for the file, or null if no file is specified
+ */
+function extractGithubUrl(props: CodeBlockConfig): string | null {
+  if (!props.file) {
+    return null;
+  }
+
+  const baseUrl = "https://github.com/HHS/simpler-grants-protocol/tree/main/";
+  let url = `${baseUrl}/${props.file.path}`;
+  
+  if (props.file.startLine || props.file.endLine) {
+    const start = props.file.startLine || 1;
+    const end = props.file.endLine || start;
+    url += `#L${start}`;
+    if (end > start) {
+      url += `-L${end}`;
+    }
+  }
+  
+  return url;
+}
+
 /**
  * Extracts code from either a literal string or a file.
  * @param props - The code block configuration
@@ -94,23 +145,23 @@ function extractCode(props: CodeBlockConfig): string {
   {
     jsonSchemaCode && (
       <TabItem label="JSON Schema">
-        <p>The JSON Schema for this model.</p>
+        <p>The {jsonSchemaUrl && <a href={jsonSchemaUrl} target="_blank" rel="noopener noreferrer">JSON Schema</a>} for this model.</p>
         <Code code={jsonSchemaCode} lang="yaml" />
       </TabItem>
     )
   }
   {
     typeSpecCode && (
       <TabItem label="TypeSpec">
-        <p>The TypeSpec code for this model.</p>
+        <p>The {typeSpecUrl ? <a href={typeSpecUrl} target="_blank" rel="noopener noreferrer">TypeSpec code</a> : "TypeSpec code"} for this model.</p>
         <Code code={typeSpecCode} lang="typespec" />
       </TabItem>
     )
   }
   {
     pythonCode && (
       <TabItem label="Python">
-        <p>The Python code for this model.</p>
+        <p>The {pythonUrl ? <a href={pythonUrl} target="_blank" rel="noopener noreferrer">Python code</a> : "Python code"} for this model.</p>
         <Code code={pythonCode} lang="python" />
       </TabItem>
     )

website/src/content/docs/protocol/filters/date.mdx

@@ -22,8 +22,8 @@ dateRangeFilter:
   python:
     file:
       path: "lib/python-sdk/common_grants_sdk/schemas/filters/date.py"
-      startLine: 26
-      endLine: 33
+      startLine: 37
+      endLine: 52
 dateComparisonFilter:
   example:
     code: |
@@ -42,8 +42,8 @@ dateComparisonFilter:
   python:
     file:
       path: "lib/python-sdk/common_grants_sdk/schemas/filters/date.py"
-      startLine: 36
-      endLine: 43
+      startLine: 55
+      endLine: 78
 ---
 
 import SchemaFormatTabs from "@/components/SchemaFormatTabs.astro";

website/src/content/docs/protocol/filters/money.mdx

@@ -51,8 +51,8 @@ moneyComparisonFilter:
   python:
     file:
       path: "lib/python-sdk/common_grants_sdk/schemas/filters/money.py"
-      startLine: 64
-      endLine: 71
+      startLine: 72
+      endLine: 87
 ---
 
 import SchemaFormatTabs from "@/components/SchemaFormatTabs.astro";

website/src/content/docs/protocol/filters/numeric.mdx

@@ -42,8 +42,8 @@ numberRangeFilter:
   python:
     file:
       path: "lib/python-sdk/common_grants_sdk/schemas/filters/numeric.py"
-      startLine: 38
-      endLine: 45
+      startLine: 46
+      endLine: 61
 numberArrayFilter:
   example:
     code: |
@@ -62,8 +62,8 @@ numberArrayFilter:
   python:
     file:
       path: "lib/python-sdk/common_grants_sdk/schemas/filters/numeric.py"
-      startLine: 48
-      endLine: 57
+      startLine: 64
+      endLine: 81
 ---
 
 import SchemaFormatTabs from "@/components/SchemaFormatTabs.astro";

website/src/content/docs/protocol/filters/string.mdx

@@ -19,8 +19,8 @@ stringComparisonFilter:
   python:
     file:
       path: "lib/python-sdk/common_grants_sdk/schemas/filters/string.py"
-      startLine: 23
-      endLine: 30
+      startLine: 31
+      endLine: 49
 stringArrayFilter:
   example:
     code: |
@@ -40,7 +40,7 @@ stringArrayFilter:
     file:
       path: "lib/python-sdk/common_grants_sdk/schemas/filters/string.py"
       startLine: 13
-      endLine: 20
+      endLine: 28
 ---
 
 import SchemaFormatTabs from "@/components/SchemaFormatTabs.astro";