feat: initial docs for tigris sdk #262

designcode · 2025-09-11T13:53:08Z

Closes TIG-5879

vercel · 2025-09-11T13:53:12Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
docs-redirect	Ready	Preview	Comment	Sep 22, 2025 7:04pm
tigris-os-docs	Ready	Preview	Comment	Sep 22, 2025 7:04pm

greptile-apps

Greptile Summary

This PR introduces comprehensive documentation for a new Tigris Storage SDK, a simplified wrapper around the Tigris Data API designed specifically for JavaScript/Node.js developers. The changes add a new "Tigris Storage SDK" section to the documentation sidebar, positioned strategically between "Examples" and "AWS S3 SDKs" sections.

The new SDK provides a more developer-friendly alternative to the existing S3-compatible APIs by offering:

A Promise-based TypeScript interface with full type definitions
Simplified configuration with optional properties and sensible defaults
Common storage operations (get, put, list, head, remove) wrapped in consistent TigrisStorageResponse objects for error handling
Multiple format support for retrieving objects (string, file, stream)
Built-in pagination support for listing operations

The documentation includes three key components:

Sidebar integration (sidebars.js) - Adds the new SDK section following established patterns
Getting started guide (docs/sdks/tigris/index.mdx) - Provides installation, configuration, and practical usage examples
API reference (docs/sdks/tigris/api-reference.mdx) - Comprehensive TypeScript type definitions and function documentation

This addition fits into Tigris's broader strategy of offering multiple integration paths: maintaining S3 compatibility for existing workflows while providing a native SDK optimized for new applications that prefer a more opinionated, simplified interface.

Confidence score: 4/5

This PR is safe to merge with only minor documentation inconsistencies that don't affect functionality
Score reflects well-structured documentation with comprehensive coverage, but minor type inconsistencies in the API reference reduce confidence slightly
Pay close attention to docs/sdks/tigris/api-reference.mdx for return type inconsistencies in head() and remove() functions

_{3 files reviewed, 5 comments}

_{Edit Code Review Bot Settings | Greptile}

docs/sdks/tigris/api-reference.mdx

docs/sdks/tigris/index.mdx

Xe

I committed some minor fixes. LGTM!

ovaistariq

It's a good start. Needs some improvement.

sidebars.js

docs/sdks/tigris/index.mdx

ovaistariq · 2025-09-15T19:32:05Z

docs/sdks/tigris/index.mdx

+quickly and integrate Tigris into your application. It offers all the
+functionality of the Tigris Data, but with a simpler interface.
+
+Tigris Storage SDK is geared towards application developers who needs to store


When I read it this seems too much text. I want to immediately know how it is better. Show me what the functions look like and how they are better than AWS S3 sdk.

docs/sdks/tigris/index.mdx

Signed-off-by: Xe Iaso <[email protected]>

docs/sdks/tigris/index.mdx

ovaistariq

The structure of the documentation can be improved. See how the documentation is structured here: https://vercel.com/docs/vercel-blob/using-blob-sdk - documents all the main functions, only showing the relevant code for each functions

docs/sdks/tigris/index.mdx

docs/sdks/tigris/api-reference.mdx

ovaistariq · 2025-09-22T17:48:04Z

docs/sdks/tigris/index.mdx

+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+Tigris Storage SDK is a simplified wrapper around Tigris Object Storage API. It


Tigris Storage SDK provides a simple interface and minimal configuration that lets you get started quickly and integrate Tigris into your application. It is built on top of Tigris Object Storage API and offers all the functionality of Tigris.

docs/sdks/tigris/index.mdx

ovaistariq · 2025-09-22T17:50:08Z

docs/sdks/tigris/index.mdx

+- Are larger and not practical to store in the database, such as images, videos,
+  documents, etc.
+- That needs to be retrieved frequently across different regions
+- break your wallet by paying egress fees


remove this line

ovaistariq · 2025-09-22T17:53:12Z

docs/sdks/tigris/client-uploads.mdx

+- `body`: (Required) A blob object as File or Blob
+- `options`: (Optional) A JSON object with the following optional parameters:
+
+| **Parameter**    | **Required** | **Values**                                                                                                  |


This section confused me a little bit. I thought these were top level options as well. How can we make it more clear that these are part of the options object

I've added a h4 before options to make it clearer that these params are part of config and not top level

ovaistariq · 2025-09-22T17:55:44Z

docs/sdks/tigris/examples.mdx

+    if (file) {
+      const formData = new FormData();
+      formData.append("file", file);
+      fetch("/api/test", {


shouldn't this be /api/upload

Correct, updated

ovaistariq · 2025-09-22T17:57:05Z

docs/sdks/tigris/examples.mdx

+    setProgress(0);
+    if (file) {
+      const result = await upload(`${file.name}`, file, {
+        url: "/api/test",


where are we fetching the pre-signed url?

upload method does it behind the scene for users. It calls the endpoint provided in url param that returns a presigned url. Client upload then use that url to upload the object

Xe

Assuming these can be fixed, approved. Love to see this!

docs/sdks/tigris/client-uploads.mdx

Xe · 2025-09-22T18:21:19Z

docs/sdks/tigris/client-uploads.mdx

+<script>
+  function handleFileChange(event) {
+    const file = event.target.files[0];
+    upload("file.txt", file, {
+      url: "/api/upload",
+      access: "private",
+      onUploadProgress: ({ loaded, total, percentage }) => {
+        console.log(`Uploaded ${loaded} of ${total} bytes (${percentage}%)`);
+      },
+    });
+  }
+</script>


Does this assume upload is in the globalThis scope?

Not, it's not available on window or globalThis, it needs to be imported. I wanted to keep the example simpler but it would require es module like importing (that all the modern browsers support), it's a decision to not support UMD modules as it was requiring a lot of wiring and not bringing actual benefit

Xe · 2025-09-22T18:21:56Z

docs/sdks/tigris/examples.mdx

+<TabItem value="server" label="Server" default>
+
+```ts
+// app/api/avatar.ts


Are you sure that this is the right filename? I think it should be:

Suggested change

// app/api/avatar.ts

// app/api/avatar/route.ts

Updated, thanks for pointing 🙏

Xe · 2025-09-22T18:22:59Z

docs/sdks/tigris/examples.mdx

+<TabItem value="server" label="Server" default>
+
+```ts
+// app/api/upload.ts


Suggested change

// app/api/upload.ts

// app/api/upload/route.ts

Xe · 2025-09-22T18:25:43Z

docs/sdks/tigris/examples.mdx

+Amongst all the other great features of Tigris, free egress fees is another
+example of what makes us stand out from other providers. We care about the
+bandwidth costs and we want to make it as cheap as possible for you to use
+Tigris. That's why we've made it so that you can upload files directly to Tigris
+from the client side.


Suggested change

Amongst all the other great features of Tigris, free egress fees is another

example of what makes us stand out from other providers. We care about the

bandwidth costs and we want to make it as cheap as possible for you to use

Tigris. That's why we've made it so that you can upload files directly to Tigris

from the client side.

Tigris does not charge egress fees, but your hosting provider may charge them for

user uploads to Tigris. We care about your bandwidth costs, so we made it easy to

have the server and client work together to upload things. This lets you give a

presigned URL to the client and then have the client upload to Tigris instead of

your server needing to be in the middle.

Updated, thanks for suggestion

Xe · 2025-09-22T18:25:53Z

docs/sdks/tigris/examples.mdx

+<TabItem value="server" label="Server" default>
+
+```ts
+// app/api/signed.ts


Suggested change

// app/api/signed.ts

// app/api/signed/route.ts

Xe · 2025-09-22T18:26:52Z

docs/sdks/tigris/index.mdx

+Tigris Storage SDK is a simplified wrapper around Tigris Object Storage API. It
+provides a simpler interface and minimal configuration that lets you get started
+quickly and integrate Tigris into your application. It offers all the
+functionality of Tigris, but with a simpler interface.


Suggested change

Tigris Storage SDK is a simplified wrapper around Tigris Object Storage API. It

provides a simpler interface and minimal configuration that lets you get started

quickly and integrate Tigris into your application. It offers all the

functionality of Tigris, but with a simpler interface.

The Tigris Storage SDK provides a simple interface and minimal configuration

that lets you get started quickly and integrate Tigris into your application. It

is built on top of Tigris Object Storage API and offers all the functionality of

Tigris.

@ovaistariq made the suggestion about it too, so I've updated with what he suggestion, LMK if you have strong opinion about it

Xe · 2025-09-22T18:27:06Z

docs/sdks/tigris/index.mdx

+- Are larger and not practical to store in the database, such as images, videos,
+  documents, etc.
+- That needs to be retrieved frequently across different regions
+- break your wallet by paying egress fees


Suggested change

- break your wallet by paying egress fees

Xe · 2025-09-22T18:29:27Z

docs/sdks/tigris/using-sdk.mdx

+```bash
+TIGRIS_STORAGE_ACCESS_KEY_ID=tid_access_key_id
+TIGRIS_STORAGE_SECRET_ACCESS_KEY=tsec_secret_access_key
+TIGRIS_STORAGE_BUCKET=bucket_name


Not review-bearing, but TODO(Xe): standardize on this envvar name in the future

Xe · 2025-09-22T18:30:05Z

static/img/tigris-sdk.png

Convert to webp with ffmpeg -i tigris-sdk.png tigris-sdk.webp.

We need to update this image any way, right now it's a blank grey image. I'll ask Jocelyn if she can come up with a quick icon for SDK.

designcode requested a review from ovaistariq September 11, 2025 13:53

greptile-apps bot reviewed Sep 11, 2025

View reviewed changes

vercel bot deployed to Preview – tigris-os-docs September 12, 2025 11:55 View deployment

vercel bot deployed to Preview – docs-redirect September 12, 2025 11:55 View deployment

vercel bot deployed to Preview – docs-redirect September 13, 2025 08:19 View deployment

vercel bot deployed to Preview – tigris-os-docs September 13, 2025 08:20 View deployment

vercel bot deployed to Preview – docs-redirect September 15, 2025 16:49 View deployment

Xe previously approved these changes Sep 15, 2025

View reviewed changes

vercel bot deployed to Preview – tigris-os-docs September 15, 2025 16:50 View deployment

ovaistariq reviewed Sep 15, 2025

View reviewed changes

designcode dismissed Xe’s stale review via 7ad5030 September 19, 2025 14:16

vercel bot deployed to Preview – docs-redirect September 19, 2025 14:16 View deployment

vercel bot had a problem deploying to Preview – tigris-os-docs September 19, 2025 14:17 Failure

designcode and others added 6 commits September 19, 2025 20:24

feat: initial docs for tigris sdk

62200a3

feat: initial docs for tigris sdk

0c87b5a

feat: initial docs for tigris sdk

beb8ab3

fix(sdks/tigris): amend wording, tabify examples

20f9ee8

Signed-off-by: Xe Iaso <[email protected]>

fix(sdks/tigris/api-ref): amend wording to flow better

d7facd9

Signed-off-by: Xe Iaso <[email protected]>

feat: sdk docs

a3f1f5e

designcode force-pushed the ai/tigris-sdk branch from 7ad5030 to a3f1f5e Compare September 19, 2025 18:24

vercel bot deployed to Preview – docs-redirect September 19, 2025 18:24 View deployment

vercel bot had a problem deploying to Preview – tigris-os-docs September 19, 2025 18:25 Failure

fix: blog link

ad87196

vercel bot deployed to Preview – tigris-os-docs September 19, 2025 18:28 View deployment

vercel bot deployed to Preview – docs-redirect September 19, 2025 18:28 View deployment

fix: code formatting

80cdbfa

vercel bot deployed to Preview – docs-redirect September 19, 2025 18:29 View deployment

vercel bot deployed to Preview – tigris-os-docs September 19, 2025 18:30 View deployment

ovaistariq reviewed Sep 20, 2025

View reviewed changes

docs/sdks/tigris/index.mdx Outdated Show resolved Hide resolved

docs/sdks/tigris/index.mdx Outdated Show resolved Hide resolved

ovaistariq requested changes Sep 20, 2025

View reviewed changes

ovaistariq reviewed Sep 20, 2025

View reviewed changes

docs/sdks/tigris/index.mdx Outdated Show resolved Hide resolved

ovaistariq reviewed Sep 20, 2025

View reviewed changes

docs/sdks/tigris/api-reference.mdx Outdated Show resolved Hide resolved

chore: structured docs

8b055f1

vercel bot deployed to Preview – docs-redirect September 20, 2025 16:41 View deployment

vercel bot had a problem deploying to Preview – tigris-os-docs September 20, 2025 16:42 Failure

chore: structured docs

62454a7

vercel bot deployed to Preview – docs-redirect September 20, 2025 17:10 View deployment

vercel bot deployed to Preview – tigris-os-docs September 20, 2025 17:10 View deployment

chore: add presigned url examples

256fb99

vercel bot deployed to Preview – tigris-os-docs September 22, 2025 08:33 View deployment

vercel bot deployed to Preview – docs-redirect September 22, 2025 08:33 View deployment

ovaistariq reviewed Sep 22, 2025

View reviewed changes

Xe reviewed Sep 22, 2025

View reviewed changes

designcode added 2 commits September 22, 2025 20:41

chore: PR comments

39c2015

chore: PR comments

ad69d74

vercel bot deployed to Preview – tigris-os-docs September 22, 2025 18:52 View deployment

vercel bot deployed to Preview – docs-redirect September 22, 2025 18:52 View deployment

chore: typos

6a80b05

vercel bot deployed to Preview – tigris-os-docs September 22, 2025 19:01 View deployment

vercel bot deployed to Preview – docs-redirect September 22, 2025 19:01 View deployment

chore: remove homepage banner

0b5e1c4

vercel bot deployed to Preview – docs-redirect September 22, 2025 19:03 View deployment

vercel bot deployed to Preview – tigris-os-docs September 22, 2025 19:04 View deployment

ovaistariq approved these changes Sep 23, 2025

View reviewed changes

ovaistariq merged commit bf4e44b into main Sep 23, 2025
10 checks passed

ovaistariq deleted the ai/tigris-sdk branch September 23, 2025 00:27

feat: initial docs for tigris sdk #262

feat: initial docs for tigris sdk #262

Uh oh!

Conversation

designcode commented Sep 11, 2025 • edited by Xe Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Greptile Summary

Confidence score: 4/5

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Xe left a comment

Choose a reason for hiding this comment

Uh oh!

ovaistariq left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ovaistariq left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Xe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

designcode commented Sep 11, 2025 •

edited by Xe

Loading

vercel bot commented Sep 11, 2025 •

edited

Loading

Xe Sep 22, 2025 •

edited

Loading