diff --git a/README.md b/README.md index 1756924..16fc2bc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ -# Anduril Lattice SDK TypeScript +# Anduril TypeScript Library ![](https://www.anduril.com/lattice-sdk/) +[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fanduril%2Flattice-sdk-javascript) [![npm shield](https://img.shields.io/npm/v/@anduril-industries/lattice-sdk)](https://www.npmjs.com/package/@anduril-industries/lattice-sdk) The Anduril TypeScript library provides convenient access to the Anduril API from TypeScript. @@ -626,3 +627,13 @@ const client = new LatticeClient({ fetcher: // provide your implementation here }); ``` + +## Contributing + +While we value open-source contributions to this SDK, this library is generated programmatically. +Additions made directly to this library would have to be moved over to our generation code, +otherwise they would be overwritten upon the next generated release. Feel free to open a PR as +a proof of concept, but know that we will not be able to merge it as-is. We suggest opening +an issue first to discuss with us! + +On the other hand, contributions to the README are always very welcome! diff --git a/package.json b/package.json index 73ee226..0384524 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@anduril-industries/lattice-sdk", - "version": "2.0.0", + "version": "2.0.1", "private": false, "repository": "github:anduril/lattice-sdk-javascript", "license": "See LICENSE", diff --git a/reference.md b/reference.md index 4a207c9..b42843a 100644 --- a/reference.md +++ b/reference.md @@ -348,7 +348,7 @@ await client.entities.longPollEntityEvents({ -
client.entities.sseEntityEvents({ ...params }) -> core.Stream +
client.entities.streamEntities({ ...params }) -> core.Stream
@@ -360,7 +360,7 @@ await client.entities.longPollEntityEvents({
-This SSE API establishes a persistent connection to stream entity events as they occur. +Establishes a persistent connection to stream entity events as they occur.
@@ -376,7 +376,7 @@ This SSE API establishes a persistent connection to stream entity events as they
```typescript -const response = await client.entities.sseEntityEvents(); +const response = await client.entities.streamEntities(); for await (const item of response) { console.log(item); } diff --git a/src/Client.ts b/src/Client.ts index f2ebf49..36f1f41 100644 --- a/src/Client.ts +++ b/src/Client.ts @@ -44,8 +44,8 @@ export class LatticeClient { { "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@anduril-industries/lattice-sdk", - "X-Fern-SDK-Version": "2.0.0", - "User-Agent": "@anduril-industries/lattice-sdk/2.0.0", + "X-Fern-SDK-Version": "2.0.1", + "User-Agent": "@anduril-industries/lattice-sdk/2.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version, }, diff --git a/src/api/resources/entities/client/Client.ts b/src/api/resources/entities/client/Client.ts index 30f101c..060b8ac 100644 --- a/src/api/resources/entities/client/Client.ts +++ b/src/api/resources/entities/client/Client.ts @@ -483,19 +483,19 @@ export class Entities { } /** - * This SSE API establishes a persistent connection to stream entity events as they occur. + * Establishes a persistent connection to stream entity events as they occur. */ - public sseEntityEvents( + public streamEntities( request: Lattice.EntityStreamRequest = {}, requestOptions?: Entities.RequestOptions, - ): core.HttpResponsePromise> { - return core.HttpResponsePromise.fromPromise(this.__sseEntityEvents(request, requestOptions)); + ): core.HttpResponsePromise> { + return core.HttpResponsePromise.fromPromise(this.__streamEntities(request, requestOptions)); } - private async __sseEntityEvents( + private async __streamEntities( request: Lattice.EntityStreamRequest = {}, requestOptions?: Entities.RequestOptions, - ): Promise>> { + ): Promise>> { const _response = await core.fetcher({ url: core.url.join( (await core.Supplier.get(this._options.baseUrl)) ?? diff --git a/src/api/resources/entities/types/SseEntityEventsResponse.ts b/src/api/resources/entities/types/StreamEntitiesResponse.ts similarity index 62% rename from src/api/resources/entities/types/SseEntityEventsResponse.ts rename to src/api/resources/entities/types/StreamEntitiesResponse.ts index 1b6b3e2..cd7391e 100644 --- a/src/api/resources/entities/types/SseEntityEventsResponse.ts +++ b/src/api/resources/entities/types/StreamEntitiesResponse.ts @@ -5,13 +5,11 @@ import * as Lattice from "../../../index.js"; /** - * stream event response. + * The stream event response. */ -export type SseEntityEventsResponse = - | Lattice.SseEntityEventsResponse.Heartbeat - | Lattice.SseEntityEventsResponse.Entity; +export type StreamEntitiesResponse = Lattice.StreamEntitiesResponse.Heartbeat | Lattice.StreamEntitiesResponse.Entity; -export namespace SseEntityEventsResponse { +export namespace StreamEntitiesResponse { export interface Heartbeat extends Lattice.EntityStreamHeartbeat { event: "heartbeat"; } diff --git a/src/api/resources/entities/types/index.ts b/src/api/resources/entities/types/index.ts index 4e6c253..10e51b1 100644 --- a/src/api/resources/entities/types/index.ts +++ b/src/api/resources/entities/types/index.ts @@ -1 +1 @@ -export * from "./SseEntityEventsResponse.js"; +export * from "./StreamEntitiesResponse.js"; diff --git a/src/api/types/EntityStreamEvent.ts b/src/api/types/EntityStreamEvent.ts index e69008f..65ea721 100644 --- a/src/api/types/EntityStreamEvent.ts +++ b/src/api/types/EntityStreamEvent.ts @@ -4,6 +4,4 @@ import * as Lattice from "../index.js"; -export interface EntityStreamEvent { - data: Lattice.EntityEvent; -} +export interface EntityStreamEvent extends Lattice.EntityEvent {} diff --git a/src/api/types/EntityStreamHeartbeat.ts b/src/api/types/EntityStreamHeartbeat.ts index 14e6fb9..d9b48dc 100644 --- a/src/api/types/EntityStreamHeartbeat.ts +++ b/src/api/types/EntityStreamHeartbeat.ts @@ -2,13 +2,4 @@ * This file was auto-generated by Fern from our API Definition. */ -export interface EntityStreamHeartbeat { - data: EntityStreamHeartbeat.Data; -} - -export namespace EntityStreamHeartbeat { - export interface Data { - /** timestamp of the heartbeat */ - timestamp?: string; - } -} +export interface EntityStreamHeartbeat {} diff --git a/src/api/types/HeartbeatObject.ts b/src/api/types/HeartbeatObject.ts new file mode 100644 index 0000000..6aaca1f --- /dev/null +++ b/src/api/types/HeartbeatObject.ts @@ -0,0 +1,8 @@ +/** + * This file was auto-generated by Fern from our API Definition. + */ + +export interface HeartbeatObject { + /** timestamp of the heartbeat */ + timestamp?: string; +} diff --git a/src/api/types/index.ts b/src/api/types/index.ts index c53216d..3eb9a37 100644 --- a/src/api/types/index.ts +++ b/src/api/types/index.ts @@ -1,7 +1,9 @@ export * from "./Timestamp.js"; export * from "./EntityEventResponse.js"; export * from "./EntityStreamHeartbeat.js"; +export * from "./HeartbeatObject.js"; export * from "./EntityStreamEvent.js"; +export * from "./EntityEvent.js"; export * from "./GoogleProtobufAny.js"; export * from "./Status.js"; export * from "./Position.js"; @@ -114,7 +116,6 @@ export * from "./MeanKeplerianElements.js"; export * from "./TleParameters.js"; export * from "./OrbitMeanElements.js"; export * from "./Orbit.js"; -export * from "./EntityEvent.js"; export * from "./TaskQueryResults.js"; export * from "./EntityIdsSelector.js"; export * from "./AgentRequest.js"; diff --git a/src/version.ts b/src/version.ts index 478f50d..85cbd4f 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const SDK_VERSION = "2.0.0"; +export const SDK_VERSION = "2.0.1"; diff --git a/yarn.lock b/yarn.lock index 479e3a6..d157244 100644 --- a/yarn.lock +++ b/yarn.lock @@ -575,9 +575,9 @@ "@jridgewell/sourcemap-codec" "^1.4.14" "@mswjs/interceptors@^0.39.1": - version "0.39.3" - resolved "https://registry.yarnpkg.com/@mswjs/interceptors/-/interceptors-0.39.3.tgz#d27886db295c9a7dbc41aa229a644bc7bbb04723" - integrity sha512-9bw/wBL7pblsnOCIqvn1788S9o4h+cC5HWXg0Xhh0dOzsZ53IyfmBM+FYqpDDPbm0xjCqEqvCITloF3Dm4TXRQ== + version "0.39.5" + resolved "https://registry.yarnpkg.com/@mswjs/interceptors/-/interceptors-0.39.5.tgz#6f0571493bf76291a60b62234ed0add2c4bd970e" + integrity sha512-B9nHSJYtsv79uo7QdkZ/b/WoKm20IkVSmTc/WCKarmDtFwM0dRx2ouEniqwNkzCSLn3fydzKmnMzjtfdOWt3VQ== dependencies: "@open-draft/deferred-promise" "^2.2.0" "@open-draft/logger" "^0.3.0" @@ -655,11 +655,11 @@ "@babel/types" "^7.0.0" "@types/babel__traverse@*", "@types/babel__traverse@^7.0.6": - version "7.20.7" - resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.20.7.tgz#968cdc2366ec3da159f61166428ee40f370e56c2" - integrity sha512-dkO5fhS7+/oos4ciWxyEyjWe48zmG6wbCheo/G2ZnHx4fs3EU6YC6UM8rk56gAjNJ9P3MTH2jo5jb92/K6wbng== + version "7.28.0" + resolved "https://registry.yarnpkg.com/@types/babel__traverse/-/babel__traverse-7.28.0.tgz#07d713d6cce0d265c9849db0cbe62d3f61f36f74" + integrity sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q== dependencies: - "@babel/types" "^7.20.7" + "@babel/types" "^7.28.2" "@types/cookie@^0.6.0": version "0.6.0" @@ -743,9 +743,9 @@ undici-types "~7.8.0" "@types/node@^18.19.70": - version "18.19.120" - resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.120.tgz#07b3bd73875956d5281fa27e6d77a66415f7d455" - integrity sha512-WtCGHFXnVI8WHLxDAt5TbnCM4eSE+nI0QN2NJtwzcgMhht2eNz6V9evJrk+lwC8bCY8OWV5Ym8Jz7ZEyGnKnMA== + version "18.19.121" + resolved "https://registry.yarnpkg.com/@types/node/-/node-18.19.121.tgz#c50d353ea2d1fb1261a8bbd0bf2850306f5af2b3" + integrity sha512-bHOrbyztmyYIi4f1R0s17QsPs1uyyYnGcXeZoGEd227oZjry0q6XQBQxd82X1I57zEfwO8h9Xo+Kl5gX1d9MwQ== dependencies: undici-types "~5.26.4" @@ -1052,9 +1052,9 @@ babel-plugin-jest-hoist@^29.6.3: "@types/babel__traverse" "^7.0.6" babel-preset-current-node-syntax@^1.0.0: - version "1.1.0" - resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.1.0.tgz#9a929eafece419612ef4ae4f60b1862ebad8ef30" - integrity sha512-ldYss8SbBlWva1bs28q78Ju5Zq1F+8BrqBZZ0VFhLBvhh6lCpC2o3gDJi/5DRLs9FgYZCnmPYIVFU4lRXCkyUw== + version "1.2.0" + resolved "https://registry.yarnpkg.com/babel-preset-current-node-syntax/-/babel-preset-current-node-syntax-1.2.0.tgz#20730d6cdc7dda5d89401cab10ac6a32067acde6" + integrity sha512-E/VlAEzRrsLEb2+dv8yp3bo4scof3l9nR4lrld+Iy5NyVqgVYUJnDAmunkhPMisRI32Qc4iRiz425d8vM++2fg== dependencies: "@babel/plugin-syntax-async-generators" "^7.8.4" "@babel/plugin-syntax-bigint" "^7.8.3" @@ -1160,9 +1160,9 @@ camelcase@^6.2.0: integrity sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA== caniuse-lite@^1.0.30001726: - version "1.0.30001727" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001727.tgz#22e9706422ad37aa50556af8c10e40e2d93a8b85" - integrity sha512-pB68nIHmbN6L/4C6MH1DokyR3bYqFwjaSs/sWDHGj4CTcFtQUQMuJftVwWkXq7mNWOybD3KhUv3oWHoGxgP14Q== + version "1.0.30001731" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001731.tgz#277c07416ea4613ec564e5b0ffb47e7b60f32e2f" + integrity sha512-lDdp2/wrOmTRWuoB5DpfNkC0rJDU8DqRa6nYL6HK6sytw70QMopt/NIc/9SM7ylItlBWfACXk0tEn37UWM/+mg== chalk@^4.0.0, chalk@^4.0.2, chalk@^4.1.0: version "4.1.2" @@ -1364,9 +1364,9 @@ ejs@^3.1.10: jake "^10.8.5" electron-to-chromium@^1.5.173: - version "1.5.190" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.190.tgz#f0ac8be182291a45e8154dbb12f18d2b2318e4ac" - integrity sha512-k4McmnB2091YIsdCgkS0fMVMPOJgxl93ltFzaryXqwip1AaxeDqKCGLxkXODDA5Ab/D+tV5EL5+aTx76RvLRxw== + version "1.5.194" + resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.5.194.tgz#05e541c3373ba8d967a65c92bc14d60608908236" + integrity sha512-SdnWJwSUot04UR51I2oPD8kuP2VI37/CADR1OHsFOUzZIvfWJBO6q11k5P/uKNyTT3cdOsnyjkrZ+DDShqYqJA== emittery@^0.13.1: version "0.13.1" @@ -2494,9 +2494,9 @@ npm-run-path@^4.0.1: path-key "^3.0.0" nwsapi@^2.2.2: - version "2.2.20" - resolved "https://registry.yarnpkg.com/nwsapi/-/nwsapi-2.2.20.tgz#22e53253c61e7b0e7e93cef42c891154bcca11ef" - integrity sha512-/ieB+mDe4MrrKMT8z+mQL8klXydZWGR5Dowt4RAGKbJ3kIGEx3X4ljUo+6V73IXtUPWgfOlU5B9MlGxFO5T+cA== + version "2.2.21" + resolved "https://registry.yarnpkg.com/nwsapi/-/nwsapi-2.2.21.tgz#8df7797079350adda208910d8c33fc4c2d7520c3" + integrity sha512-o6nIY3qwiSXl7/LuOU0Dmuctd34Yay0yeuZRLFmDPrrdHpXKFndPj3hM+YEPVHYC5fx2otBx4Ilc/gyYSAUaIA== once@^1.3.0: version "1.4.0" @@ -3074,9 +3074,9 @@ webpack-sources@^3.3.3: integrity sha512-yd1RBzSGanHkitROoPFd6qsrxt+oFhg/129YzheDGqeustzX0vTZJZsSsQjVQC4yzBQ56K55XU8gaNCtIzOnTg== webpack@^5.97.1: - version "5.100.2" - resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.100.2.tgz#e2341facf9f7de1d702147c91bcb65b693adf9e8" - integrity sha512-QaNKAvGCDRh3wW1dsDjeMdDXwZm2vqq3zn6Pvq4rHOEOGSaUMgOOjG2Y9ZbIGzpfkJk9ZYTHpDqgDfeBDcnLaw== + version "5.101.0" + resolved "https://registry.yarnpkg.com/webpack/-/webpack-5.101.0.tgz#4b81407ffad9857f81ff03f872e3369b9198cc9d" + integrity sha512-B4t+nJqytPeuZlHuIKTbalhljIFXeNRqrUGAQgTGlfOl2lXXKXw+yZu6bicycP+PUlM44CxBjCFD6aciKFT3LQ== dependencies: "@types/eslint-scope" "^3.7.7" "@types/estree" "^1.0.8"