Skip to content
Closed
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
18 changes: 15 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: '20'
node-version: '22'

- name: Bootstrap
run: ./scripts/bootstrap
Expand All @@ -46,7 +46,7 @@ jobs:
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: '20'
node-version: '22'

- name: Bootstrap
run: ./scripts/bootstrap
Expand All @@ -68,6 +68,15 @@ jobs:
AUTH: ${{ steps.github-oidc.outputs.github_token }}
SHA: ${{ github.sha }}
run: ./scripts/utils/upload-artifact.sh

- name: Upload MCP Server tarball
if: github.repository == 'stainless-sdks/deeprails-typescript'
env:
URL: https://pkg.stainless.com/s?subpackage=mcp-server
AUTH: ${{ steps.github-oidc.outputs.github_token }}
SHA: ${{ github.sha }}
BASE_PATH: packages/mcp-server
run: ./scripts/utils/upload-artifact.sh
test:
timeout-minutes: 10
name: test
Expand All @@ -79,10 +88,13 @@ jobs:
- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: '20'
node-version: '22'

- name: Bootstrap
run: ./scripts/bootstrap

- name: Build
run: ./scripts/build

- name: Run tests
run: ./scripts/test
20 changes: 19 additions & 1 deletion .github/workflows/publish-npm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
name: Publish NPM
on:
workflow_dispatch:
inputs:
path:
description: The path to run the release in, e.g. '.' or 'packages/mcp-server'
required: true

release:
types: [published]
Expand All @@ -12,6 +16,8 @@ jobs:
publish:
name: publish
runs-on: ubuntu-latest
permissions:
contents: write

steps:
- uses: actions/checkout@v4
Expand All @@ -27,6 +33,18 @@ jobs:

- name: Publish to NPM
run: |
bash ./bin/publish-npm
if [ -n "${{ github.event.inputs.path }}" ]; then
PATHS_RELEASED='[\"${{ github.event.inputs.path }}\"]'
else
PATHS_RELEASED='[\".\", \"packages/mcp-server\"]'
fi
yarn tsn scripts/publish-packages.ts "{ \"paths_released\": \"$PATHS_RELEASED\" }"
env:
NPM_TOKEN: ${{ secrets.DEEPRAILS_NPM_TOKEN || secrets.NPM_TOKEN }}

- name: Upload MCP Server DXT GitHub release asset
run: |
gh release upload ${{ github.event.release.tag_name }} \
packages/mcp-server/deeprails_api.mcpb
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ dist-deno
/*.tgz
.idea/
.eslintcache

dist-bundle
*.mcpb
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ CHANGELOG.md
/deno

# don't format tsc output, will break source maps
/dist
dist
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "1.0.0"
".": "1.1.0"
}
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
configured_endpoints: 11
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/deeprails-inc%2Fdeeprails-96512c1b797f0943ff15a6f7af701c2c68c90f2db3a99bcad64a092924c39167.yml
openapi_spec_hash: 19d817d155ec2593b8af64e69a63375b
config_hash: ce7e997e94b56d2c2403f39c42b96a98
config_hash: 408016a962ebe53e936c4852f85d83fa
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## 1.1.0 (2025-10-07)

Full Changelog: [v1.0.0...v1.1.0](https://github.com/deeprails/deeprails-typescript-sdk/compare/v1.0.0...v1.1.0)

### Features

* **api:** manual updates ([8a5bb06](https://github.com/deeprails/deeprails-typescript-sdk/commit/8a5bb0669951aa87771073158032e029fd78c332))


### Chores

* configure new SDK language ([1726711](https://github.com/deeprails/deeprails-typescript-sdk/commit/17267115aacd1b5cadfcae447f39daa397318328))
* configure new SDK language ([1cccec5](https://github.com/deeprails/deeprails-typescript-sdk/commit/1cccec57666d11ac0b3e3e7de455aaa35c9a9c41))

## 1.0.0 (2025-10-07)

Full Changelog: [v0.0.1...v1.0.0](https://github.com/deeprails/deeprails-typescript-sdk/compare/v0.0.1...v1.0.0)
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This library provides convenient access to the Deeprails REST API from server-side TypeScript or JavaScript.

The full API of this library can be found in [api.md](api.md).
The REST API documentation can be found on [docs.deeprails.com](https://docs.deeprails.com). The full API of this library can be found in [api.md](api.md).

## Installation

Expand All @@ -26,7 +26,7 @@ const client = new Deeprails({

const defendResponse = await client.defend.createWorkflow({
improvement_action: 'fixit',
metrics: { completeness: 0.85, instruction_adherence: 0.75 },
metrics: { completeness: 0.8, instruction_adherence: 0.75 },
name: 'Push Alert Workflow',
type: 'custom',
});
Expand All @@ -48,7 +48,7 @@ const client = new Deeprails({

const params: Deeprails.DefendCreateWorkflowParams = {
improvement_action: 'fixit',
metrics: { completeness: 0.85, instruction_adherence: 0.75 },
metrics: { completeness: 0.8, instruction_adherence: 0.75 },
name: 'Push Alert Workflow',
type: 'custom',
};
Expand All @@ -68,7 +68,7 @@ a subclass of `APIError` will be thrown:
const defendResponse = await client.defend
.createWorkflow({
improvement_action: 'fixit',
metrics: { completeness: 0.85, instruction_adherence: 0.75 },
metrics: { completeness: 0.8, instruction_adherence: 0.75 },
name: 'Push Alert Workflow',
type: 'custom',
})
Expand Down Expand Up @@ -112,7 +112,7 @@ const client = new Deeprails({
});

// Or, configure per-request:
await client.defend.createWorkflow({ improvement_action: 'fixit', metrics: { completeness: 0.85, instruction_adherence: 0.75 }, name: 'Push Alert Workflow', type: 'custom' }, {
await client.defend.createWorkflow({ improvement_action: 'fixit', metrics: { completeness: 0.8, instruction_adherence: 0.75 }, name: 'Push Alert Workflow', type: 'custom' }, {
maxRetries: 5,
});
```
Expand All @@ -129,7 +129,7 @@ const client = new Deeprails({
});

// Override per-request:
await client.defend.createWorkflow({ improvement_action: 'fixit', metrics: { completeness: 0.85, instruction_adherence: 0.75 }, name: 'Push Alert Workflow', type: 'custom' }, {
await client.defend.createWorkflow({ improvement_action: 'fixit', metrics: { completeness: 0.8, instruction_adherence: 0.75 }, name: 'Push Alert Workflow', type: 'custom' }, {
timeout: 5 * 1000,
});
```
Expand All @@ -155,7 +155,7 @@ const client = new Deeprails();
const response = await client.defend
.createWorkflow({
improvement_action: 'fixit',
metrics: { completeness: 0.85, instruction_adherence: 0.75 },
metrics: { completeness: 0.8, instruction_adherence: 0.75 },
name: 'Push Alert Workflow',
type: 'custom',
})
Expand All @@ -166,7 +166,7 @@ console.log(response.statusText); // access the underlying Response object
const { data: defendResponse, response: raw } = await client.defend
.createWorkflow({
improvement_action: 'fixit',
metrics: { completeness: 0.85, instruction_adherence: 0.75 },
metrics: { completeness: 0.8, instruction_adherence: 0.75 },
name: 'Push Alert Workflow',
type: 'custom',
})
Expand Down
2 changes: 1 addition & 1 deletion eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export default tseslint.config(
},
},
{
files: ['tests/**', 'examples/**'],
files: ['tests/**', 'examples/**', 'packages/**'],
rules: {
'no-restricted-imports': 'off',
},
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "deeprails",
"version": "1.0.0",
"version": "1.1.0",
"description": "The official TypeScript library for the Deeprails API",
"author": {
"name": "DeepRails",
Expand Down
Loading