Move Typescript SDK to use our API v2 #500

andresgutgon · 2024-10-23T13:55:08Z

What?

This change is incremental and everyone in v1 should be able to work without any changes. If they opt-in to use API v2, they need to pass apiVersion: 'v2'. And if they want to run a prompt without streaming they need to pass stream: false

TODO

~~Maybe test somehow v2 and streaming: false~~ I did an ./examples playground in the monorepo to use our sdk
Fix gateway tests v2 with errors
Fix gateway tests v2 with valid response. I changed the output to match the stream version that the SDK is already returning
Implement v2 run method
Add new tests for non-streaming
Undo refactor of different sdk versions
QA playground keeps working with v1
Document stream: boolean in docs

IMPORTANT

Test production build. I introduced a new package @latitude-data/constants. In tired of not being able to have a unified source of truth for enums and types. This is the first stone

andresgutgon · 2024-10-24T09:31:04Z

packages/sdks/typescript/src/tests/common/chat.test.ts

+    beforeAll(() => {
+      sdk = new Latitude(FAKE_LATITUDE_SDK_KEY, {
+        __internal: {
+          retryMs: 10,


Faster test. We were spending 3 seconds in the retry test.

packages/sdks/typescript/src/versions/LatitudeSdkV1.ts

andresgutgon · 2024-10-24T16:41:26Z

examples/nodejs-sdk-usage/src/run.ts

@@ -0,0 +1,29 @@
+import { Latitude } from '@latitude-data/sdk'
+
+async function makeSdkRequest() {


A playground to test in the development of the SDK. This makes our job easier

andresgutgon · 2024-10-25T15:12:44Z

packages/constants/src/errors.ts

+  errorCode: ApiResponseCode
+  dbErrorRef?: DbErrorRef
+}
+export type ApiResponseCode = RunErrorCodes | ApiErrorCodes | LatitudeErrorCodes


Unified list of codes of all the things that can go wrong in an api call

andresgutgon · 2024-10-25T15:19:42Z

packages/core/package.json

@@ -52,6 +52,7 @@
    "@faker-js/faker": "^8.4.1",
    "@latitude-data/compiler": "workspace:^",
    "@latitude-data/env": "workspace:*",
+    "@latitude-data/constants": "workspace:*",


import * as AI from '@latitude-data/constants/ai'

Next step in another moment is to move all constants that are from

Vercel AI

Compiler

Into constants so sharing this types between gateway and sdk and core is perfect and no one depends on the others

andresgutgon · 2024-10-25T15:22:56Z

packages/sdks/typescript/tsconfig.json

@@ -3,11 +3,12 @@
  "compilerOptions": {
    "moduleResolution": "Bundler",
    "outDir": "./dist",
-    "rootDir": ".",
+    "rootDir": "../../",


This makes .d.ts generated file not complain. It can find constants

andresgutgon · 2024-10-25T15:23:28Z

packages/web-ui/src/example-file.ts

Not used, please confirm @geclos I think this was created by you

andresgutgon · 2024-10-28T12:03:45Z

...eway/src/routes/api/v2/projects/[projectId]/versions/[versionUuid]/documents/handlers/run.ts

-    return c.json(data)
+    const response = await result.response.then((r) => r.unwrap())
+    const body = documentRunPresenter(response).unwrap()
+    return c.json(body)


This is an important change. The meet is in documentRunPresenter

andresgutgon · 2024-10-28T12:04:37Z

apps/gateway/tsup.config.ts

+  noExternal: [
+    '@latitude-data/env',
+    '@latitude-data/core',
+    '@latitude-data/constants',


I added @latitude-data/constants to all our apps. This package would be the common package without other dependencies where we put all the shared constants and types.

apps/web/src/actions/copilot/requestSuggestion.ts

andresgutgon · 2024-10-28T12:07:54Z

packages/sdks/typescript/src/tests/run.test.ts

+      )
+    })
+  })
+})


I think I covered all the new code here

andresgutgon · 2024-10-28T12:32:39Z

packages/sdks/typescript/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@latitude-data/sdk",
-  "version": "0.0.18",
+  "version": "1.0.0-beta.0",


changed with this: pnpm version premajor --preid beta

geclos

LGTM

apps/web/src/actions/copilot/refinePrompt.ts

API v2 is the new version and from now on our typescript sdk will use it. This change is necessary to allow users call the gateway in a non-streaming way which in most cases is what they need

andresgutgon changed the title ~~Allow SKD users use our API v2~~ Allow LSD users use our API v2 Oct 23, 2024

andresgutgon changed the title ~~Allow LSD users use our API v2~~ Allow SDK users use our API v2 Oct 23, 2024

andresgutgon commented Oct 24, 2024

View reviewed changes

packages/sdks/typescript/src/versions/LatitudeSdkV1.ts Outdated Show resolved Hide resolved

andresgutgon force-pushed the feature/enable-api-v2-call-from-sdk branch from 14e1d1f to 591e040 Compare October 24, 2024 14:33

andresgutgon commented Oct 24, 2024

View reviewed changes

andresgutgon force-pushed the feature/enable-api-v2-call-from-sdk branch 2 times, most recently from acc73cc to c21921e Compare October 25, 2024 09:59

andresgutgon commented Oct 25, 2024

View reviewed changes

packages/web-ui/src/example-file.ts Outdated

Copy link

Contributor Author

andresgutgon Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not used, please confirm @geclos I think this was created by you

andresgutgon changed the title ~~Allow SDK users use our API v2~~ Move Typescript SDK to use our API v2 Oct 28, 2024

andresgutgon force-pushed the feature/enable-api-v2-call-from-sdk branch 2 times, most recently from 6eacf54 to 2beea93 Compare October 28, 2024 12:02

andresgutgon commented Oct 28, 2024

View reviewed changes

apps/web/src/actions/copilot/requestSuggestion.ts Outdated Show resolved Hide resolved

andresgutgon commented Oct 28, 2024

View reviewed changes

packages/sdks/typescript/src/tests/run.test.ts

)

})

})

})

Copy link

Contributor Author

andresgutgon Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I covered all the new code here

andresgutgon force-pushed the feature/enable-api-v2-call-from-sdk branch from 2beea93 to 900bccc Compare October 28, 2024 12:31

andresgutgon commented Oct 28, 2024

View reviewed changes

andresgutgon requested review from geclos and csansoon October 28, 2024 13:10

geclos previously approved these changes Oct 28, 2024

View reviewed changes

csansoon reviewed Oct 28, 2024

View reviewed changes

apps/web/src/actions/copilot/refinePrompt.ts Outdated Show resolved Hide resolved

csansoon previously approved these changes Oct 28, 2024

View reviewed changes

andresgutgon dismissed stale reviews from csansoon and geclos via 053c483 October 28, 2024 16:02

andresgutgon force-pushed the feature/enable-api-v2-call-from-sdk branch 2 times, most recently from 053c483 to 47f8b17 Compare October 28, 2024 16:04

andresgutgon force-pushed the feature/enable-api-v2-call-from-sdk branch 2 times, most recently from 60384f1 to aeeaab4 Compare October 28, 2024 16:11

Move typescript SKD to use v2 of API

cfa27cd

API v2 is the new version and from now on our typescript sdk will use it. This change is necessary to allow users call the gateway in a non-streaming way which in most cases is what they need

andresgutgon force-pushed the feature/enable-api-v2-call-from-sdk branch from aeeaab4 to cfa27cd Compare October 29, 2024 08:22

andresgutgon merged commit 712fbdf into main Oct 29, 2024
3 checks passed

andresgutgon deleted the feature/enable-api-v2-call-from-sdk branch October 29, 2024 09:53

github-actions bot locked and limited conversation to collaborators Oct 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move Typescript SDK to use our API v2 #500

Move Typescript SDK to use our API v2 #500

andresgutgon commented Oct 23, 2024 •

edited

Loading

andresgutgon Oct 24, 2024 •

edited

Loading

andresgutgon Oct 24, 2024

andresgutgon Oct 25, 2024

andresgutgon Oct 25, 2024 •

edited

Loading

andresgutgon Oct 25, 2024

andresgutgon Oct 25, 2024

andresgutgon Oct 28, 2024

andresgutgon Oct 28, 2024

andresgutgon Oct 28, 2024

andresgutgon Oct 28, 2024

geclos left a comment

		@@ -0,0 +1,29 @@
		import { Latitude } from '@latitude-data/sdk'

		async function makeSdkRequest() {

Move Typescript SDK to use our API v2 #500

Move Typescript SDK to use our API v2 #500

Conversation

andresgutgon commented Oct 23, 2024 • edited Loading

What?

TODO

IMPORTANT

andresgutgon Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andresgutgon Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

geclos left a comment

Choose a reason for hiding this comment

andresgutgon commented Oct 23, 2024 •

edited

Loading

andresgutgon Oct 24, 2024 •

edited

Loading

andresgutgon Oct 25, 2024 •

edited

Loading