Skip to content

Commit 507b2e1

Browse files
timdesmtimdesm
committed
Initial commit
0 parents  commit 507b2e1

71 files changed

Lines changed: 7727 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This allows generated code to be indexed correctly
2+
*.ts linguist-generated=false

‎.github/workflows/lint.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Lint
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
lint:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
19+
- name: Setup Node
20+
uses: actions/setup-node@v4
21+
with:
22+
node-version: "20"
23+
24+
- name: Install
25+
run: npm ci
26+
27+
- name: Lint
28+
run: npm run lint

‎.github/workflows/publish.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Publish to npm
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*.*.*"
7+
8+
permissions:
9+
contents: read
10+
11+
jobs:
12+
publish:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Node
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: "20"
22+
registry-url: "https://registry.npmjs.org"
23+
24+
- name: Install
25+
run: npm ci
26+
27+
- name: Build
28+
run: npm run build
29+
30+
- name: Publish
31+
run: npm publish
32+
env:
33+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.gitignore‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/models
2+
/models/errors
3+
/types
4+
/node_modules
5+
/examples/node_modules
6+
/lib
7+
/sdk
8+
/funcs
9+
/react-query
10+
/mcp-server
11+
/hooks
12+
/index.*
13+
/core.*
14+
/bin
15+
/cjs
16+
/esm
17+
/dist
18+
/.tsbuildinfo
19+
/.eslintcache
20+
/.tshy
21+
/.tshy-*
22+
/__tests__
23+
.idea/
24+
.DS_Store
25+
**/.speakeasy/temp/
26+
**/.speakeasy/logs/
27+
.DS_Store
28+
/.speakeasy/reports
29+
.env
30+
.env.local
31+
.env.*.local

‎.npmignore‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
**/*
2+
!/FUNCTIONS.md
3+
!/RUNTIMES.md
4+
!/REACT_QUERY.md
5+
!/**/*.ts
6+
!/**/*.js
7+
!/**/*.mjs
8+
!/**/*.json
9+
!/**/*.map
10+
11+
/eslint.config.mjs
12+
/cjs
13+
/.tshy
14+
/.tshy-*
15+
/__tests__

‎CONTRIBUTING.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to This Repository
2+
3+
Thank you for your interest in contributing to this repository. This SDK is
4+
manually maintained and we welcome pull requests, issues, and feedback.
5+
6+
## How to Report Issues
7+
8+
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
9+
10+
- A clear and descriptive title
11+
- Steps to reproduce the issue
12+
- Expected and actual behavior
13+
- Any relevant logs, screenshots, or error messages
14+
- Information about your environment (e.g., operating system, software versions)
15+
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
16+
17+
## Pull Requests
18+
19+
We welcome PRs for bug fixes, improvements, and new SDK features. Please:
20+
21+
- Open an issue first if the change is significant.
22+
- Keep changes focused and scoped to a single concern.
23+
- Include tests or examples where it makes sense.
24+
- Run `npm run lint` before submitting.
25+
26+
## Issue Triage and Fixes
27+
28+
We will review and triage issues as quickly as possible. Our goal is to address
29+
bugs and incorporate improvements in future releases.
30+
31+
## Contact
32+
33+
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
34+
35+
Thank you for your understanding and cooperation!
36+
37+
The Maintainers

‎FUNCTIONS.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Standalone Functions
2+
3+
> [!NOTE]
4+
> This section is useful if you are using a bundler and targetting browsers and
5+
> runtimes where the size of an application affects performance and load times.
6+
7+
Standalone functions are not yet available. This SDK currently focuses on the
8+
class-based client and the generic `http` helper while the typed endpoints are
9+
being implemented.
10+
11+
## Example
12+
13+
```typescript
14+
// Standalone functions will be documented here once they are introduced.
15+
```
16+
17+
## Result types
18+
19+
Standalone functions differ from SDK methods in that they return a
20+
`Result<Value, Error>` type to capture _known errors_ and document them using
21+
the type system. By avoiding throwing errors, application code maintains clear
22+
control flow and error-handling become part of the regular flow of application
23+
code.
24+
25+
> We use the term "known errors" because standalone functions, and JavaScript
26+
> code in general, can still throw unexpected errors such as `TypeError`s,
27+
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
28+
> something this SDK addresses in the future. Nevertheless, there is still a lot
29+
> of benefit from capturing most errors and turning them into values.
30+
31+
The second reason for this style of programming is because these functions will
32+
typically be used in front-end applications where exception throwing is
33+
sometimes discouraged or considered unidiomatic. React and similar ecosystems
34+
and libraries tend to promote this style of programming so that components
35+
render useful content under all states (loading, success, error and so on).
36+
37+
Once standalone functions are added, this guide will show how to use the core
38+
client with tree-shakable function imports.

‎LICENSE.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Copyright (c) 2026, Ominity
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
6+
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
8+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

0 commit comments

Comments
 (0)