-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1d68c05
commit 51e3c74
Showing
29 changed files
with
90 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
configured_endpoints: 12 | ||
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/maestro%2Fmaestro-arch-rpc-a04ce538c803bb8fd64c905a15cf7a02063faa72addd34cb7f31086f434fa666.yml | ||
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/maestro%2Fmaestro-arch-rpc-8a4099d01f990ae9bca950c4779cb86460aafd58569bd1cb975bfba53d47e347.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -42,25 +42,25 @@ If you’d like to use the repository from source, you can either install from g | |
To install via git: | ||
|
||
```sh | ||
$ npm install git+ssh://[email protected]:maestro-org/maestro-arch-rpc-node-sdk.git | ||
$ npm install git+ssh://[email protected]:stainless-sdks/maestro-arch-rpc-node.git | ||
``` | ||
|
||
Alternatively, to link a local copy of the repo: | ||
|
||
```sh | ||
# Clone | ||
$ git clone https://www.github.com/maestro-org/maestro-arch-rpc-node-sdk | ||
$ cd maestro-arch-rpc-node-sdk | ||
$ git clone https://www.github.com/stainless-sdks/maestro-arch-rpc-node | ||
$ cd maestro-arch-rpc-node | ||
|
||
# With yarn | ||
$ yarn link | ||
$ cd ../my-package | ||
$ yarn link maestro-arch-rpc-sdk | ||
$ yarn link maestro-arch-rpc | ||
|
||
# With pnpm | ||
$ pnpm link --global | ||
$ cd ../my-package | ||
$ pnpm link -—global maestro-arch-rpc-sdk | ||
$ pnpm link -—global maestro-arch-rpc | ||
``` | ||
|
||
## Running tests | ||
|
@@ -99,7 +99,7 @@ the changes aren't made through the automated pipeline, you may want to make rel | |
|
||
### Publish with a GitHub workflow | ||
|
||
You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/maestro-org/maestro-arch-rpc-node-sdk/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up. | ||
You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/stainless-sdks/maestro-arch-rpc-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up. | ||
|
||
### Publish manually | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Maestro Arch Rpc Node API Library | ||
|
||
[![NPM version](https://img.shields.io/npm/v/maestro-arch-rpc-sdk.svg)](https://npmjs.org/package/maestro-arch-rpc-sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/maestro-arch-rpc-sdk) | ||
[![NPM version](https://img.shields.io/npm/v/maestro-arch-rpc.svg)](https://npmjs.org/package/maestro-arch-rpc) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/maestro-arch-rpc) | ||
|
||
This library provides convenient access to the Maestro Arch Rpc REST API from server-side TypeScript or JavaScript. | ||
|
||
|
@@ -11,16 +11,19 @@ It is generated with [Stainless](https://www.stainlessapi.com/). | |
## Installation | ||
|
||
```sh | ||
npm install maestro-arch-rpc-sdk | ||
npm install git+ssh://[email protected]:stainless-sdks/maestro-arch-rpc-node.git | ||
``` | ||
|
||
> [!NOTE] | ||
> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install maestro-arch-rpc` | ||
## Usage | ||
|
||
The full API of this library can be found in [api.md](api.md). | ||
|
||
<!-- prettier-ignore --> | ||
```js | ||
import MaestroArchRpc from 'maestro-arch-rpc-sdk'; | ||
import MaestroArchRpc from 'maestro-arch-rpc'; | ||
|
||
const client = new MaestroArchRpc(); | ||
|
||
|
@@ -39,7 +42,7 @@ This library includes TypeScript definitions for all request params and response | |
|
||
<!-- prettier-ignore --> | ||
```ts | ||
import MaestroArchRpc from 'maestro-arch-rpc-sdk'; | ||
import MaestroArchRpc from 'maestro-arch-rpc'; | ||
|
||
const client = new MaestroArchRpc(); | ||
|
||
|
@@ -207,12 +210,12 @@ add the following import before your first import `from "MaestroArchRpc"`: | |
```ts | ||
// Tell TypeScript and the package to use the global web fetch instead of node-fetch. | ||
// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed. | ||
import 'maestro-arch-rpc-sdk/shims/web'; | ||
import MaestroArchRpc from 'maestro-arch-rpc-sdk'; | ||
import 'maestro-arch-rpc/shims/web'; | ||
import MaestroArchRpc from 'maestro-arch-rpc'; | ||
``` | ||
|
||
To do the inverse, add `import "maestro-arch-rpc-sdk/shims/node"` (which does import polyfills). | ||
This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/maestro-org/maestro-arch-rpc-node-sdk/tree/main/src/_shims#readme)). | ||
To do the inverse, add `import "maestro-arch-rpc/shims/node"` (which does import polyfills). | ||
This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/stainless-sdks/maestro-arch-rpc-node/tree/main/src/_shims#readme)). | ||
|
||
### Logging and middleware | ||
|
||
|
@@ -221,7 +224,7 @@ which can be used to inspect or alter the `Request` or `Response` before/after e | |
|
||
```ts | ||
import { fetch } from 'undici'; // as one example | ||
import MaestroArchRpc from 'maestro-arch-rpc-sdk'; | ||
import MaestroArchRpc from 'maestro-arch-rpc'; | ||
|
||
const client = new MaestroArchRpc({ | ||
fetch: async (url: RequestInfo, init?: RequestInit): Promise<Response> => { | ||
|
@@ -268,7 +271,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con | |
|
||
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience. | ||
|
||
We are keen for your feedback; please open an [issue](https://www.github.com/maestro-org/maestro-arch-rpc-node-sdk/issues) with questions, bugs, or suggestions. | ||
We are keen for your feedback; please open an [issue](https://www.github.com/stainless-sdks/maestro-arch-rpc-node/issues) with questions, bugs, or suggestions. | ||
|
||
## Requirements | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,12 @@ | ||
{ | ||
"name": "maestro-arch-rpc-sdk", | ||
"name": "maestro-arch-rpc", | ||
"version": "0.0.1-alpha.1", | ||
"description": "The official TypeScript library for the Maestro Arch Rpc API", | ||
"author": "Maestro Arch Rpc <[email protected]>", | ||
"types": "dist/index.d.ts", | ||
"main": "dist/index.js", | ||
"type": "commonjs", | ||
"repository": "github:maestro-org/maestro-arch-rpc-node-sdk", | ||
"repository": "github:stainless-sdks/maestro-arch-rpc-node", | ||
"license": "Apache-2.0", | ||
"packageManager": "[email protected]", | ||
"files": [ | ||
|
@@ -60,8 +60,8 @@ | |
"./shims/web.mjs" | ||
], | ||
"imports": { | ||
"maestro-arch-rpc-sdk": ".", | ||
"maestro-arch-rpc-sdk/*": "./src/*" | ||
"maestro-arch-rpc": ".", | ||
"maestro-arch-rpc/*": "./src/*" | ||
}, | ||
"exports": { | ||
"./_shims/auto/*": { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
export const VERSION = '0.0.1-alpha.1'; // x-release-please-version | ||
export const VERSION = '0.0.1-alpha.1'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.