File tree Expand file tree Collapse file tree 13 files changed +66
-59
lines changed Expand file tree Collapse file tree 13 files changed +66
-59
lines changed Original file line number Diff line number Diff line change 1- # Anduril Lattice SDK TypeScript
1+ # Anduril TypeScript Library
22
33![ ] ( https://www.anduril.com/lattice-sdk/ )
44
5+ [ ![ 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 )
56[ ![ npm shield] ( https://img.shields.io/npm/v/@anduril-industries/lattice-sdk )] ( https://www.npmjs.com/package/@anduril-industries/lattice-sdk )
67
78The Anduril TypeScript library provides convenient access to the Anduril API from TypeScript.
@@ -626,3 +627,13 @@ const client = new LatticeClient({
626627 fetcher : // provide your implementation here
627628});
628629```
630+
631+ ## Contributing
632+
633+ While we value open-source contributions to this SDK, this library is generated programmatically.
634+ Additions made directly to this library would have to be moved over to our generation code,
635+ otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
636+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
637+ an issue first to discuss with us!
638+
639+ On the other hand, contributions to the README are always very welcome!
Original file line number Diff line number Diff line change 11{
22 "name" : " @anduril-industries/lattice-sdk" ,
3- "version" : " 2.0.0 " ,
3+ "version" : " 2.0.1 " ,
44 "private" : false ,
55 "repository" : " github:anduril/lattice-sdk-javascript" ,
66 "license" : " See LICENSE" ,
Original file line number Diff line number Diff line change @@ -348,7 +348,7 @@ await client.entities.longPollEntityEvents({
348348</dl >
349349</details >
350350
351- <details ><summary ><code >client.entities.<a href =" /src/api/resources/entities/client/Client.ts " >sseEntityEvents </a >({ ...params }) -> core.Stream<Lattice.SseEntityEventsResponse ></code ></summary >
351+ <details ><summary ><code >client.entities.<a href =" /src/api/resources/entities/client/Client.ts " >streamEntities </a >({ ...params }) -> core.Stream<Lattice.StreamEntitiesResponse ></code ></summary >
352352<dl >
353353<dd >
354354
@@ -360,7 +360,7 @@ await client.entities.longPollEntityEvents({
360360<dl >
361361<dd >
362362
363- This SSE API establishes a persistent connection to stream entity events as they occur.
363+ Establishes a persistent connection to stream entity events as they occur.
364364
365365</dd >
366366</dl >
@@ -376,7 +376,7 @@ This SSE API establishes a persistent connection to stream entity events as they
376376<dd >
377377
378378``` typescript
379- const response = await client .entities .sseEntityEvents ();
379+ const response = await client .entities .streamEntities ();
380380for await (const item of response ) {
381381 console .log (item );
382382}
Original file line number Diff line number Diff line change @@ -44,8 +44,8 @@ export class LatticeClient {
4444 {
4545 "X-Fern-Language" : "JavaScript" ,
4646 "X-Fern-SDK-Name" : "@anduril-industries/lattice-sdk" ,
47- "X-Fern-SDK-Version" : "2.0.0 " ,
48- "User-Agent" : "@anduril-industries/lattice-sdk/2.0.0 " ,
47+ "X-Fern-SDK-Version" : "2.0.1 " ,
48+ "User-Agent" : "@anduril-industries/lattice-sdk/2.0.1 " ,
4949 "X-Fern-Runtime" : core . RUNTIME . type ,
5050 "X-Fern-Runtime-Version" : core . RUNTIME . version ,
5151 } ,
Original file line number Diff line number Diff line change @@ -483,19 +483,19 @@ export class Entities {
483483 }
484484
485485 /**
486- * This SSE API establishes a persistent connection to stream entity events as they occur.
486+ * Establishes a persistent connection to stream entity events as they occur.
487487 */
488- public sseEntityEvents (
488+ public streamEntities (
489489 request : Lattice . EntityStreamRequest = { } ,
490490 requestOptions ?: Entities . RequestOptions ,
491- ) : core . HttpResponsePromise < core . Stream < Lattice . SseEntityEventsResponse > > {
492- return core . HttpResponsePromise . fromPromise ( this . __sseEntityEvents ( request , requestOptions ) ) ;
491+ ) : core . HttpResponsePromise < core . Stream < Lattice . StreamEntitiesResponse > > {
492+ return core . HttpResponsePromise . fromPromise ( this . __streamEntities ( request , requestOptions ) ) ;
493493 }
494494
495- private async __sseEntityEvents (
495+ private async __streamEntities (
496496 request : Lattice . EntityStreamRequest = { } ,
497497 requestOptions ?: Entities . RequestOptions ,
498- ) : Promise < core . WithRawResponse < core . Stream < Lattice . SseEntityEventsResponse > > > {
498+ ) : Promise < core . WithRawResponse < core . Stream < Lattice . StreamEntitiesResponse > > > {
499499 const _response = await core . fetcher < ReadableStream > ( {
500500 url : core . url . join (
501501 ( await core . Supplier . get ( this . _options . baseUrl ) ) ??
Original file line number Diff line number Diff line change 55import * as Lattice from "../../../index.js" ;
66
77/**
8- * stream event response.
8+ * The stream event response.
99 */
10- export type SseEntityEventsResponse =
11- | Lattice . SseEntityEventsResponse . Heartbeat
12- | Lattice . SseEntityEventsResponse . Entity ;
10+ export type StreamEntitiesResponse = Lattice . StreamEntitiesResponse . Heartbeat | Lattice . StreamEntitiesResponse . Entity ;
1311
14- export namespace SseEntityEventsResponse {
12+ export namespace StreamEntitiesResponse {
1513 export interface Heartbeat extends Lattice . EntityStreamHeartbeat {
1614 event : "heartbeat" ;
1715 }
Original file line number Diff line number Diff line change 1- export * from "./SseEntityEventsResponse .js" ;
1+ export * from "./StreamEntitiesResponse .js" ;
Original file line number Diff line number Diff line change 44
55import * as Lattice from "../index.js" ;
66
7- export interface EntityStreamEvent {
8- data : Lattice . EntityEvent ;
9- }
7+ export interface EntityStreamEvent extends Lattice . EntityEvent { }
Original file line number Diff line number Diff line change 22 * This file was auto-generated by Fern from our API Definition.
33 */
44
5- export interface EntityStreamHeartbeat {
6- data : EntityStreamHeartbeat . Data ;
7- }
8-
9- export namespace EntityStreamHeartbeat {
10- export interface Data {
11- /** timestamp of the heartbeat */
12- timestamp ?: string ;
13- }
14- }
5+ export interface EntityStreamHeartbeat { }
Original file line number Diff line number Diff line change 1+ /**
2+ * This file was auto-generated by Fern from our API Definition.
3+ */
4+
5+ export interface HeartbeatObject {
6+ /** timestamp of the heartbeat */
7+ timestamp ?: string ;
8+ }
You can’t perform that action at this time.
0 commit comments