Add links to doc in jsdocs (#3)

scripts/src/templates/mod.ts

@@ -7,6 +7,36 @@ import {
 } from "./utils.ts";
 import { FunctionRecord } from "../types.ts";
 
+const renderJSdoc = (
+  namespace: string,
+  callback_id: string,
+): string => {
+  const typescript: string[] = [];
+  typescript.push("/**");
+  typescript.push(
+    `* @see The {@link https://api.slack.com/reference/connectors/${namespace}/${callback_id} ${
+      getFunctionName(callback_id)
+    }} documentation.`,
+  );
+  typescript.push("*/");
+  return typescript.join("\n");
+};
+
+const renderFunctions = (
+  namespace: string,
+  functionRecords: FunctionRecord[],
+): string => {
+  const typescript: string[] = [];
+  functionRecords.forEach((functionRecord: FunctionRecord) => {
+    typescript.push(
+      `${renderJSdoc(namespace, functionRecord.callback_id)}\n${
+        getFunctionName(functionRecord.callback_id)
+      }`,
+    );
+  });
+  return `{${typescript.join(",\n")}}`;
+};
+
 export const ConnectorModTemplate = (
   namespace: string,
   functionRecords: FunctionRecord[],
@@ -21,10 +51,9 @@ export const ConnectorModTemplate = (
 
   typescript.push("");
   typescript.push(
-    `const ${objectName} = { functions: {${
-      functionRecords.map((dfi) => `${getFunctionName(dfi.callback_id)}`)
-        .join(",")
-    }}} as const;`,
+    `const ${objectName} = { functions: ${
+      renderFunctions(namespace, functionRecords)
+    }} as const;`,
   );
   typescript.push("");
   typescript.push(`export default ${objectName};`);

src/connectors/calendly/mod.ts

@@ -1,6 +1,13 @@
 /** This file was autogenerated. Follow the steps in src/schema/slack/functions/README.md to rebuild **/
 import GetMeetingLink from "./functions/get_meeting_link.ts";
 
-const Calendly = { functions: { GetMeetingLink } } as const;
+const Calendly = {
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/calendly/get_meeting_link GetMeetingLink} documentation.
+     */
+    GetMeetingLink,
+  },
+} as const;
 
 export default Calendly;

src/connectors/giphy/mod.ts

@@ -2,6 +2,17 @@
 import GetRandomGif from "./functions/get_random_gif.ts";
 import GetTranslatedGif from "./functions/get_translated_gif.ts";
 
-const Giphy = { functions: { GetRandomGif, GetTranslatedGif } } as const;
+const Giphy = {
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/giphy/get_random_gif GetRandomGif} documentation.
+     */
+    GetRandomGif,
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/giphy/get_translated_gif GetTranslatedGif} documentation.
+     */
+    GetTranslatedGif,
+  },
+} as const;
 
 export default Giphy;

src/connectors/github.cloud/mod.ts

@@ -1,6 +1,13 @@
 /** This file was autogenerated. Follow the steps in src/schema/slack/functions/README.md to rebuild **/
 import CreateIssue from "./functions/create_issue.ts";
 
-const GithubCloud = { functions: { CreateIssue } } as const;
+const GithubCloud = {
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/github.cloud/create_issue CreateIssue} documentation.
+     */
+    CreateIssue,
+  },
+} as const;
 
 export default GithubCloud;

src/connectors/gitlab/mod.ts

@@ -1,6 +1,13 @@
 /** This file was autogenerated. Follow the steps in src/schema/slack/functions/README.md to rebuild **/
 import CreateIssue from "./functions/create_issue.ts";
 
-const Gitlab = { functions: { CreateIssue } } as const;
+const Gitlab = {
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/gitlab/create_issue CreateIssue} documentation.
+     */
+    CreateIssue,
+  },
+} as const;
 
 export default Gitlab;

src/connectors/google.sheets/mod.ts

@@ -1,6 +1,13 @@
 /** This file was autogenerated. Follow the steps in src/schema/slack/functions/README.md to rebuild **/
 import AddSpreadsheetRow from "./functions/add_spreadsheet_row.ts";
 
-const GoogleSheets = { functions: { AddSpreadsheetRow } } as const;
+const GoogleSheets = {
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/google.sheets/add_spreadsheet_row AddSpreadsheetRow} documentation.
+     */
+    AddSpreadsheetRow,
+  },
+} as const;
 
 export default GoogleSheets;

src/connectors/jira.cloud/mod.ts

@@ -2,6 +2,17 @@
 import CreateIssue from "./functions/create_issue.ts";
 import EditIssue from "./functions/edit_issue.ts";
 
-const JiraCloud = { functions: { CreateIssue, EditIssue } } as const;
+const JiraCloud = {
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/jira.cloud/create_issue CreateIssue} documentation.
+     */
+    CreateIssue,
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/jira.cloud/edit_issue EditIssue} documentation.
+     */
+    EditIssue,
+  },
+} as const;
 
 export default JiraCloud;

src/connectors/mod.ts

@@ -1,4 +1,4 @@
-/** This file was autogenerated on Tue Jun 20 2023. Follow the steps in src/schema/slack/functions/README.md to rebuild **/
+/** This file was autogenerated on Wed Jun 21 2023. Follow the steps in src/schema/slack/functions/README.md to rebuild **/
 import Calendly from "./calendly/mod.ts";
 import Giphy from "./giphy/mod.ts";
 import GithubCloud from "./github.cloud/mod.ts";

src/connectors/pagerduty/mod.ts

@@ -5,7 +5,24 @@ import EscalateIncident from "./functions/escalate_incident.ts";
 import ResolveIncident from "./functions/resolve_incident.ts";
 
 const Pagerduty = {
-  functions: { AddANote, CreateIncident, EscalateIncident, ResolveIncident },
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/pagerduty/add_a_note AddANote} documentation.
+     */
+    AddANote,
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/pagerduty/create_incident CreateIncident} documentation.
+     */
+    CreateIncident,
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/pagerduty/escalate_incident EscalateIncident} documentation.
+     */
+    EscalateIncident,
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/pagerduty/resolve_incident ResolveIncident} documentation.
+     */
+    ResolveIncident,
+  },
 } as const;
 
 export default Pagerduty;

src/connectors/salesforce/mod.ts

@@ -4,7 +4,20 @@ import RunFlow from "./functions/run_flow.ts";
 import UpdateRecord from "./functions/update_record.ts";
 
 const Salesforce = {
-  functions: { CreateRecord, RunFlow, UpdateRecord },
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/salesforce/create_record CreateRecord} documentation.
+     */
+    CreateRecord,
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/salesforce/run_flow RunFlow} documentation.
+     */
+    RunFlow,
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/salesforce/update_record UpdateRecord} documentation.
+     */
+    UpdateRecord,
+  },
 } as const;
 
 export default Salesforce;

src/connectors/zoom/mod.ts

@@ -1,6 +1,13 @@
 /** This file was autogenerated. Follow the steps in src/schema/slack/functions/README.md to rebuild **/
 import CreateMeeting from "./functions/create_meeting.ts";
 
-const Zoom = { functions: { CreateMeeting } } as const;
+const Zoom = {
+  functions: {
+    /**
+     * @see The {@link https://api.slack.com/reference/connectors/zoom/create_meeting CreateMeeting} documentation.
+     */
+    CreateMeeting,
+  },
+} as const;
 
 export default Zoom;