- Notifications
You must be signed in to change notification settings - Fork0
scalar/scalar-node
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Developer-friendly, idiomatic Typescript SDK for theaccess-service-typescript API.
Scalar API: Public facing api to manage all scalar platform entities
The SDK can be installed with eithernpm,pnpm,bun oryarn package managers.
npm add @scalar/sdk
pnpm add @scalar/sdk
bun add @scalar/sdk
yarn add @scalar/sdk zod# Note that Yarn does not install peer dependencies automatically. You will need# to install zod as shown above.
Note
This package is published with CommonJS and ES Modules (ESM) support.
For supported JavaScript runtimes, please consultRUNTIMES.md.
import{Scalar}from"@scalar/sdk";constscalar=newScalar({bearerAuth:"<YOUR_BEARER_TOKEN_HERE>",});asyncfunctionrun(){constresult=awaitscalar.apiDocs.getv1ApisNamespace({namespace:"<value>",});console.log(result);}run();
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
bearerAuth | http | HTTP Bearer |
To authenticate with the API thebearerAuth parameter must be set when initializing the SDK client instance. For example:
import{Scalar}from"@scalar/sdk";constscalar=newScalar({bearerAuth:"<YOUR_BEARER_TOKEN_HERE>",});asyncfunctionrun(){constresult=awaitscalar.apiDocs.getv1ApisNamespace({namespace:"<value>",});console.log(result);}run();
Available methods
- getv1ApisNamespace - List all APIs
- postv1ApisNamespace - Create an API
- patchv1ApisNamespaceSlug - Update metadata
- deletev1ApisNamespaceSlug - Delete an API
- getv1ApisNamespaceSlugVersionSemver - Get API document
- deletev1ApisNamespaceSlugVersionSemver - Delete version
- postv1ApisNamespaceSlugVersion - Create version
- postv1ApisNamespaceSlugAccessGroup - Add API access group
- deletev1ApisNamespaceSlugAccessGroup - Delete API access group
- getv1Guides - List all projects
- postv1Guides - Create new project
- postv1GuidesSlugPublish - Publish project
- getv1LoginPortalsSlug - Get a login portal
- patchv1LoginPortalsSlug - Update metadata
- deletev1LoginPortalsSlug - Delete a login portal
- postv1LoginPortals - Create a portal
- getv1LoginPortals - List all portals
- getv1RulesetsNamespace - List all rules
- postv1RulesetsNamespace - Create a rule
- patchv1RulesetsNamespaceSlug - Update rule metadata
- deletev1RulesetsNamespaceSlug - Delete a rule
- getv1RulesetsNamespaceSlug - Get a rule
- postv1RulesetsNamespaceSlugAccessGroup - Add rule access group
- deletev1RulesetsNamespaceSlugAccessGroup - Remove rule access group
- getv1SchemasNamespace - List all shared components
- postv1SchemasNamespace - Create a shared component
- patchv1SchemasNamespaceSlug - Update shared component metadata
- deletev1SchemasNamespaceSlug - Delete a shared component
- getv1SchemasNamespaceSlugVersionSemver - Get a shared component document
- deletev1SchemasNamespaceSlugVersionSemver - Delete a shared component version
- postv1SchemasNamespaceSlugVersion - Create a shared component version
- postv1SchemasNamespaceSlugAccessGroup - Add shared component access group
- deletev1SchemasNamespaceSlugAccessGroup - Remove shared component access group
- getv1Themes - List all themes
- postv1Themes - Create a theme
- patchv1ThemesSlug - Update theme metadata
- putv1ThemesSlug - Update theme document
- deletev1ThemesSlug - Delete a theme
- getv1ThemesSlug - Get a theme
All the methods listed above are available as standalone functions. Thesefunctions are ideal for use in applications running in the browser, serverlessruntimes or other environments where application bundle size is a primaryconcern. When using a bundler to build your application, all unusedfunctionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, checkFUNCTIONS.md.
Available standalone functions
apiDocsDeletev1ApisNamespaceSlug- Delete an APIapiDocsDeletev1ApisNamespaceSlugAccessGroup- Delete API access groupapiDocsDeletev1ApisNamespaceSlugVersionSemver- Delete versionapiDocsGetv1ApisNamespace- List all APIsapiDocsGetv1ApisNamespaceSlugVersionSemver- Get API documentapiDocsPatchv1ApisNamespaceSlug- Update metadataapiDocsPostv1ApisNamespace- Create an APIapiDocsPostv1ApisNamespaceSlugAccessGroup- Add API access groupapiDocsPostv1ApisNamespaceSlugVersion- Create versionguidesGetv1Guides- List all projectsguidesPostv1Guides- Create new projectguidesPostv1GuidesSlugPublish- Publish projectloginPortalsDeletev1LoginPortalsSlug- Delete a login portalloginPortalsGetv1LoginPortals- List all portalsloginPortalsGetv1LoginPortalsSlug- Get a login portalloginPortalsPatchv1LoginPortalsSlug- Update metadataloginPortalsPostv1LoginPortals- Create a portalrulesDeletev1RulesetsNamespaceSlug- Delete a rulerulesDeletev1RulesetsNamespaceSlugAccessGroup- Remove rule access grouprulesGetv1RulesetsNamespace- List all rulesrulesGetv1RulesetsNamespaceSlug- Get a rulerulesPatchv1RulesetsNamespaceSlug- Update rule metadatarulesPostv1RulesetsNamespace- Create a rulerulesPostv1RulesetsNamespaceSlugAccessGroup- Add rule access groupschemasDeletev1SchemasNamespaceSlug- Delete a shared componentschemasDeletev1SchemasNamespaceSlugAccessGroup- Remove shared component access groupschemasDeletev1SchemasNamespaceSlugVersionSemver- Delete a shared component versionschemasGetv1SchemasNamespace- List all shared componentsschemasGetv1SchemasNamespaceSlugVersionSemver- Get a shared component documentschemasPatchv1SchemasNamespaceSlug- Update shared component metadataschemasPostv1SchemasNamespace- Create a shared componentschemasPostv1SchemasNamespaceSlugAccessGroup- Add shared component access groupschemasPostv1SchemasNamespaceSlugVersion- Create a shared component versionthemesDeletev1ThemesSlug- Delete a themethemesGetv1Themes- List all themesthemesGetv1ThemesSlug- Get a themethemesPatchv1ThemesSlug- Update theme metadatathemesPostv1Themes- Create a themethemesPutv1ThemesSlug- Update theme document
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import{Scalar}from"@scalar/sdk";constscalar=newScalar({bearerAuth:"<YOUR_BEARER_TOKEN_HERE>",});asyncfunctionrun(){constresult=awaitscalar.apiDocs.getv1ApisNamespace({namespace:"<value>",},{retries:{strategy:"backoff",backoff:{initialInterval:1,maxInterval:50,exponent:1.1,maxElapsedTime:100,},retryConnectionErrors:false,},});console.log(result);}run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import{Scalar}from"@scalar/sdk";constscalar=newScalar({retryConfig:{strategy:"backoff",backoff:{initialInterval:1,maxInterval:50,exponent:1.1,maxElapsedTime:100,},retryConnectionErrors:false,},bearerAuth:"<YOUR_BEARER_TOKEN_HERE>",});asyncfunctionrun(){constresult=awaitscalar.apiDocs.getv1ApisNamespace({namespace:"<value>",});console.log(result);}run();
ScalarError is the base class for all HTTP error responses. It has the following properties:
| Property | Type | Description |
|---|---|---|
error.message | string | Error message |
error.statusCode | number | HTTP response status code eg404 |
error.headers | Headers | HTTP response headers |
error.body | string | HTTP body. Can be empty string if no body is returned. |
error.rawResponse | Response | Raw HTTP response |
error.data$ | Optional. Some errors may contain structured data.See Error Classes. |
import{Scalar}from"@scalar/sdk";import*aserrorsfrom"@scalar/sdk/models/errors";constscalar=newScalar({bearerAuth:"<YOUR_BEARER_TOKEN_HERE>",});asyncfunctionrun(){try{constresult=awaitscalar.apiDocs.getv1ApisNamespace({namespace:"<value>",});console.log(result);}catch(error){// The base class for HTTP error responsesif(errorinstanceoferrors.ScalarError){console.log(error.message);console.log(error.statusCode);console.log(error.body);console.log(error.headers);// Depending on the method different errors may be thrownif(errorinstanceoferrors.FourHundred){console.log(error.data$.message);// stringconsole.log(error.data$.code);// string}}}}run();
Primary errors:
ScalarError: The base class for HTTP error responses.FourHundred: Bad request. Status code400.FourHundredAndOne: No auth. Status code401.FourHundredAndThree: Forbidden. Status code403.FourHundredAndFour: Not found. Status code404.FourHundredAndTwentyTwo: Invalid payload. Status code422.FiveHundred: Uncaught error. Status code500.
Less common errors (6)
Network errors:
ConnectionError: HTTP client was unable to make a request to a server.RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.RequestAbortedError: HTTP request was aborted by the client.InvalidRequestError: Any input used to create a request is invalid.UnexpectedClientError: Unrecognised or unexpected error.
Inherit fromScalarError:
ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValuefor the raw value anderror.pretty()for a nicely formatted multi-line string.
The default server can be overridden globally by passing a URL to theserverURL: string optional parameter when initializing the SDK client instance. For example:
import{Scalar}from"@scalar/sdk";constscalar=newScalar({serverURL:"https://access.scalar.com",bearerAuth:"<YOUR_BEARER_TOKEN_HERE>",});asyncfunctionrun(){constresult=awaitscalar.apiDocs.getv1ApisNamespace({namespace:"<value>",});console.log(result);}run();
The TypeScript SDK makes API calls using anHTTPClient that wraps the nativeFetch API. Thisclient is a thin wrapper aroundfetch and provides the ability to attach hooksaround the request lifecycle that can be used to modify the request or handleerrors and response.
TheHTTPClient constructor takes an optionalfetcher argument that can beused to integrate a third-party HTTP client or when writing tests to mock outthe HTTP client and feed in fixtures.
The following example shows how to use the"beforeRequest" hook to to add acustom header and a timeout to requests and how to use the"requestError" hookto log errors:
import{Scalar}from"@scalar/sdk";import{HTTPClient}from"@scalar/sdk/lib/http";consthttpClient=newHTTPClient({// fetcher takes a function that has the same signature as native `fetch`.fetcher:(request)=>{returnfetch(request);}});httpClient.addHook("beforeRequest",(request)=>{constnextRequest=newRequest(request,{signal:request.signal||AbortSignal.timeout(5000)});nextRequest.headers.set("x-custom-header","custom value");returnnextRequest;});httpClient.addHook("requestError",(error,request)=>{console.group("Request Error");console.log("Reason:",`${error}`);console.log("Endpoint:",`${request.method}${request.url}`);console.groupEnd();});constsdk=newScalar({ httpClient});
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matchesconsole's interface as an SDK option.
Warning
Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import{Scalar}from"@scalar/sdk";constsdk=newScalar({debugLogger:console});
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
SDK Created byScalar
About
Official JavaScript / TypeScript library for the Scalar API
Resources
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Releases
Packages0
Contributors4
Uh oh!
There was an error while loading.Please reload this page.