SDK Generation

Author: fern

.github/workflows/ci.yml

@@ -11,10 +11,16 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Install dependencies
+        run: pnpm install
 
       - name: Compile
-        run: yarn && yarn build
+        run: pnpm build
 
   test:
     runs-on: ubuntu-latest
@@ -24,34 +30,13 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
+                
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
 
-      - name: Compile
-        run: yarn && yarn test    
-
-  publish:
-    needs: [ compile, test ]
-    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-      - name: Set up node
-        uses: actions/setup-node@v3
       - name: Install dependencies
-        run: yarn install
-      - name: Build
-        run: yarn build
-
-      - name: Publish to npm
-        run: |
-          npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
-          if [[ ${GITHUB_REF} == *alpha* ]]; then
-            npm publish --access public --tag alpha
-          elif [[ ${GITHUB_REF} == *beta* ]]; then
-            npm publish --access public --tag beta
-          else
-            npm publish --access public
-          fi
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: pnpm install
+
+      - name: Test
+        run: pnpm test

.npmignore

@@ -5,6 +5,7 @@ tests
 .github
 .fernignore
 .prettierrc.yml
+biome.json
 tsconfig.json
 yarn.lock
 pnpm-lock.yaml

.prettierrc.yml

@@ -0,0 +1,133 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js 20 or higher
+- pnpm package manager
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+pnpm install
+```
+
+### Building
+
+Build the project:
+
+```bash
+pnpm build
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+pnpm test
+```
+
+Run specific test types:
+- `pnpm test:unit` - Run unit tests
+- `pnpm test:wire` - Run wire/integration tests
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+pnpm run lint
+pnpm run format:check
+```
+
+Fix code style issues:
+
+```bash
+pnpm run lint:fix
+pnpm run format:fix
+```
+
+Or use the combined check command:
+
+```bash
+pnpm run check:fix
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `src/api/` - API client classes and types
+- `src/serialization/` - Serialization/deserialization logic
+- Most TypeScript files in `src/`
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The TypeScript SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/typescript/sdk/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `pnpm test`
+4. Run linting and formatting: `pnpm run check:fix`
+5. Build the project: `pnpm build`
+6. Commit your changes with a clear commit message
+7. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses automated code formatting and linting. Run `pnpm run check:fix` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

CONTRIBUTING.md

@@ -186,4 +186,4 @@ of any court action, you agree to submit to the exclusive jurisdiction of the co
 Notwithstanding this, you agree that Anduril shall still be allowed to apply for injunctive remedies (or an equivalent type of urgent legal 
 relief) in any jurisdiction.  
 
-**April 14, 2025**
+**April 14, 2025**

LICENSE

@@ -28,7 +28,7 @@ For support with this library, please reach out to your Anduril representative.
 
 ## Reference
 
-A full reference for this library is available [here](https://github.com/anduril/lattice-sdk-javascript/blob/HEAD/./reference.md).
+A full reference for this library is available [here](https://github.com/fern-api/lattice-sdk-javascript/blob/HEAD/./reference.md).
 
 ## Usage
 
@@ -39,7 +39,7 @@ import { LatticeClient } from "@anduril-industries/lattice-sdk";
 
 const client = new LatticeClient({ token: "YOUR_TOKEN" });
 await client.entities.longPollEntityEvents({
-    sessionToken: "sessionToken",
+    sessionToken: "sessionToken"
 });
 ```
 
@@ -76,6 +76,21 @@ try {
 }
 ```
 
+## Streaming Response
+
+Some endpoints return streaming responses instead of returning the full response at once.
+The SDK uses async iterators, so you can consume the responses using a `for await...of` loop.
+
+```typescript
+import { LatticeClient } from "@anduril-industries/lattice-sdk";
+
+const client = new LatticeClient({ token: "YOUR_TOKEN" });
+const response = await client.entities.streamEntities();
+for await (const item of response) {
+    console.log(item);
+}
+```
+
 ## File Uploads
 
 You can upload files using the client:
@@ -91,39 +106,36 @@ await client.objects.uploadObject(new File(['binary data'], 'file.mp3'), ...);
 await client.objects.uploadObject(new ArrayBuffer(8), ...);
 await client.objects.uploadObject(new Uint8Array([0, 1, 2]), ...);
 ```
-
 The client accepts a variety of types for file upload parameters:
-
-- Stream types: `fs.ReadStream`, `stream.Readable`, and `ReadableStream`
-- Buffered types: `Buffer`, `Blob`, `File`, `ArrayBuffer`, `ArrayBufferView`, and `Uint8Array`
+* Stream types: `fs.ReadStream`, `stream.Readable`, and `ReadableStream`
+* Buffered types: `Buffer`, `Blob`, `File`, `ArrayBuffer`, `ArrayBufferView`, and `Uint8Array`
 
 ### Metadata
 
 You can configure metadata when uploading a file:
-
 ```typescript
 const file: Uploadable.WithMetadata = {
     data: createReadStream("path/to/file"),
-    filename: "my-file", // optional
+    filename: "my-file",       // optional
     contentType: "audio/mpeg", // optional
-    contentLength: 1949, // optional
+    contentLength: 1949,       // optional
 };
 ```
 
 Alternatively, you can upload a file directly from a file path:
-
 ```typescript
-const file: Uploadable.FromPath = {
+const file : Uploadable.FromPath = {
     path: "path/to/file",
-    filename: "my-file", // optional
-    contentType: "audio/mpeg", // optional
-    contentLength: 1949, // optional
+    filename: "my-file",        // optional
+    contentType: "audio/mpeg",  // optional
+    contentLength: 1949,        // optional
 };
 ```
 
 The metadata is used to set the `Content-Length`, `Content-Type`, and `Content-Disposition` headers. If not provided, the client will attempt to determine them automatically.
 For example, `fs.ReadStream` has a `path` property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.
 
+
 ## Binary Response
 
 You can consume binary data from endpoints using the `BinaryResponse` type which lets you choose how to consume the data:
@@ -138,7 +150,6 @@ const stream: ReadableStream<Uint8Array> = response.stream();
 // If you want to check if the response body has been used, you can use the following property.
 const bodyUsed = response.bodyUsed;
 ```
-
 <details>
 <summary>Save binary response to a file</summary>
 
@@ -522,13 +533,13 @@ List endpoints are paginated. The SDK provides an iterator so that you can simpl
 import { LatticeClient } from "@anduril-industries/lattice-sdk";
 
 const client = new LatticeClient({ token: "YOUR_TOKEN" });
-const response = await client.objects.listObjects({
+const pageableResponse = await client.objects.listObjects({
     prefix: "prefix",
     sinceTimestamp: "2024-01-15T09:30:00Z",
     pageToken: "pageToken",
-    allObjectsInMesh: true,
+    allObjectsInMesh: true
 });
-for await (const item of response) {
+for await (const item of pageableResponse) {
     console.log(item);
 }
 
@@ -537,11 +548,14 @@ let page = await client.objects.listObjects({
     prefix: "prefix",
     sinceTimestamp: "2024-01-15T09:30:00Z",
     pageToken: "pageToken",
-    allObjectsInMesh: true,
+    allObjectsInMesh: true
 });
 while (page.hasNextPage()) {
     page = page.getNextPage();
 }
+
+// You can also access the underlying response
+const response = page.response;
 ```
 
 ## Advanced
@@ -626,8 +640,11 @@ console.log(rawResponse.headers['X-My-Header']);
 
 ### Runtime Compatibility
 
+
 The SDK works in the following runtimes:
 
+
+
 - Node.js 18+
 - Vercel
 - Cloudflare Workers