Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,5 @@ jobs:

- run: pnpm install --frozen-lockfile
- run: pnpm fmt:check
- run: pnpm type-check:all
- run: pnpm test:all
- run: pnpm build:all
- run: pnpm type-check
- run: pnpm build
4 changes: 0 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Changelog

## Unreleased

- Add the beta `@depot/sandbox` package under `packages/sandbox`.

See [GitHub Releases](https://github.com/depot/sdk-node/releases) for the latest changes.
23 changes: 0 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ A Node.js SDK for the [Depot](https://depot.dev) API.

👉 [**API Documentation**](https://buf.build/depot/api)

This repository also contains the beta [`@depot/sandbox`](./packages/sandbox) package for the `depot.sandbox.v1` API.

## Installation

Use [pnpm](https://pnpm.io) or your favorite package manager:
Expand All @@ -18,12 +16,6 @@ Use [pnpm](https://pnpm.io) or your favorite package manager:
pnpm add @depot/sdk-node
```

After the sandbox beta is published, install it separately:

```bash
pnpm add @depot/sandbox@beta
```

## Usage

Each of the Depot API services is exposed on the main `depot` export. Authentication is provided via an `Authorization` header with an **Organization Token**, for each API request. The service paths match their corresponding gRPC service names.
Expand Down Expand Up @@ -51,21 +43,6 @@ async function example() {
}
```

### Sandbox Beta

```typescript
import {createClient, Sandbox} from '@depot/sandbox'

const client = createClient({token: process.env.DEPOT_TOKEN!})
const sandbox = await Sandbox.create(client)

const command = await sandbox.runCommand({cmd: 'echo', args: ['hello']})
await command.wait()

console.log(await command.stdout())
await sandbox.stop({blocking: true})
```

## License

MIT License, see `LICENSE`.
5 changes: 1 addition & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,12 @@
],
"scripts": {
"build": "tsup src/index.ts --format esm,cjs --dts --clean",
"build:all": "pnpm run build && pnpm --filter './packages/*' --if-present run build",
"clean": "rm -rf dist",
"fmt": "prettier --write .",
"fmt:check": "prettier --check .",
"generate": "buf generate buf.build/depot/api && prettier --write src/gen",
"prepack": "pnpm run build",
"test:all": "pnpm --filter './packages/*' --if-present run test",
"type-check": "tsc --noEmit",
"type-check:all": "pnpm run type-check && pnpm --filter './packages/*' --if-present run type-check"
"type-check": "tsc --noEmit"
},
"peerDependencies": {
"@bufbuild/protobuf": ">=2, <3"
Expand Down
67 changes: 0 additions & 67 deletions packages/sandbox/README.md

This file was deleted.

49 changes: 0 additions & 49 deletions packages/sandbox/package.json

This file was deleted.

65 changes: 0 additions & 65 deletions packages/sandbox/src/client.ts

This file was deleted.

Loading
Loading