devflowinc · SaraVieira · Sep 5, 2024 · Sep 5, 2024
diff --git a/clients/search-component/typedoc.json b/clients/search-component/typedoc.json
diff --git a/clients/ts-sdk/package.json b/clients/ts-sdk/package.json
@@ -23,10 +23,11 @@
     "@vitest/ui": "^2.0.5",
     "esbuild": "^0.23.1",
     "esbuild-register": "^3.6.0",
+    "typedoc": "^0.26.0",
+    "typedoc-plugin-extras": "^3.1.0",
     "typedoc-plugin-mdn-links": "^3.2.9",
+    "typedoc-plugin-merge-modules": "^6.0.0",
     "typescript": "^5.5.4",
-    "vitest": "^2.0.5",
-    "typedoc": "^0.26.0",
-    "typedoc-plugin-merge-modules": "^6.0.0"
+    "vitest": "^2.0.5"
   }
 }
diff --git a/clients/ts-sdk/src/functions/analytics/index.ts b/clients/ts-sdk/src/functions/analytics/index.ts
@@ -1,7 +1,7 @@
 /**
  * This includes all the functions you can use to communicate with our analytics API
  *
- * @module Analytic Methods
+ * @module Analytics Methods
  */
 
 import {

diff --git a/clients/ts-sdk/src/functions/message/index.ts b/clients/ts-sdk/src/functions/message/index.ts
@@ -40,7 +40,7 @@ export async function createMessage(
 }
 
 /**
- * Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions.Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
+ * Create a message as a stream and returns a reader. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions.Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
  * 
  * Example:
  * ```js

diff --git a/clients/ts-sdk/theme/style.css b/clients/ts-sdk/theme/style.css
@@ -434,3 +434,11 @@ footer p {
 .tsd-accordion-summary svg {
   transition: transform 0.1s ease-in-out;
 }
+
+#tsd-search > div:nth-child(1) > label {
+  display: none;
+}
+
+body > footer > p.tsd-generator {
+  display: none;
+}
diff --git a/clients/ts-sdk/typedoc.json b/clients/ts-sdk/typedoc.json
@@ -7,15 +7,20 @@
   "excludeProtected": true,
   "includeVersion": true,
   "name": "Trieve Typescript SDK",
+  "favicon": "https://cdn.trieve.ai/favicon-32x32.png",
   "readme": "./README.md",
-  "searchInComments": true,
-  "searchInDocuments": true,
+  "customFooterHtml": "Please reach out if you'd like assistance; we are responsive! Contact <a href='mailto:humans@trieve.ai'>humans@trieve.ai</a> or see <a href='https://trieve.ai'>trieve.ai</a> for links to Discord and Matrix.",
+  "searchInComments": false,
+  "searchInDocuments": false,
   "navigationLinks": {
-    "Github": "http://example.com"
+    "Github": "https://github.com/devflowinc/trieve/tree/main/clients/ts-sdk"
   },
-
   "categorizeByGroup": true,
   "customCss": "./theme/style.css",
-  "plugin": ["typedoc-plugin-merge-modules", "typedoc-plugin-mdn-links"],
-  "mergeModulesMergeMode": "module" // NEW option of TypeDoc added by this plugin
+  "plugin": [
+    "typedoc-plugin-merge-modules",
+    "typedoc-plugin-mdn-links",
+    "typedoc-plugin-extras"
+  ],
+  "mergeModulesMergeMode": "module"
 }
diff --git a/yarn.lock b/yarn.lock
@@ -585,10 +585,10 @@
     commander "12.1.0"
     handlebars "4.7.8"
 
-"@hey-api/openapi-ts@^0.52.9":
-  version "0.52.11"
-  resolved "https://registry.yarnpkg.com/@hey-api/openapi-ts/-/openapi-ts-0.52.11.tgz#7875d3a56bf9996b35f1b2ae50b2e3f98e0fad58"
-  integrity sha512-S3NrCQDxy7AtW5sx8OVoBaqpaYNqYsD0y6YNwhUXPUahbrW7Wxm/N4RIEsRtXVbcjUqdAjo1FmFmeyEKYziJkw==
+"@hey-api/openapi-ts@^0.53":
+  version "0.53.0"
+  resolved "https://registry.yarnpkg.com/@hey-api/openapi-ts/-/openapi-ts-0.53.0.tgz#22396568d72ce1bdbe13bcec9400c1250adfbc4b"
+  integrity sha512-5pDd/s0yHJniruYyKYmEsAMbY10Nh/EwhHlgIrdpQ1KZWQdyTbH/tn8rVHT5Mopr1dMuYX0kq0TzpjcNlvrROQ==
   dependencies:
     "@apidevtools/json-schema-ref-parser" "11.7.0"
     c12 "1.11.1"
@@ -3194,8 +3194,6 @@ eslint-utils@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/eslint-utils/-/eslint-utils-3.0.0.tgz#8aebaface7345bb33559db0a1f13a1d2d48c3672"
   integrity sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==
-  dependencies:
-    eslint-visitor-keys "^2.0.0"
 
 eslint-visitor-keys@^1.1.0:
   version "1.3.0"
@@ -7416,7 +7414,7 @@ totalist@^3.0.0:
   integrity sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==
 
 "trieve-ts-sdk@file:clients/ts-sdk":
-  version "0.0.2"
+  version "0.0.5"
 
 trim-lines@^3.0.0:
   version "3.0.1"
@@ -7564,6 +7562,11 @@ typed-array-length@^1.0.6:
     is-typed-array "^1.1.13"
     possible-typed-array-names "^1.0.0"
 
+typedoc-plugin-extras@^3.1.0:
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/typedoc-plugin-extras/-/typedoc-plugin-extras-3.1.0.tgz#e435891ad87c796d23edb6929ceb6a1797f274f1"
+  integrity sha512-8tNeq2fgl2HCUZ6eZuAoLLKEvB/WrRS4He9MtTfo3X3Pa8Iw3TS5D0g8krDhUXUk1uHpXVAVHm8rSOMS2mdJRw==
+
 typedoc-plugin-mdn-links@^3.2.9:
   version "3.2.10"
   resolved "https://registry.yarnpkg.com/typedoc-plugin-mdn-links/-/typedoc-plugin-mdn-links-3.2.10.tgz#0f98e5e84475879f407d84b15d7ff4c60c3964d0"
-Original file line number
+Diff line change
@@ Expand Up / @@ -40,7 +40,7 @@ export async function createMessage( @@
     }
     /**
-     * Create a message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions.Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
+     * Create a message as a stream and returns a reader. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions.Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
      *
      * Example:
      * ```js
@@ Expand Down @@