Skip to content

Commit 3ddc010

Browse files
committed
Initial TypeScript SDK release
0 parents  commit 3ddc010

56 files changed

Lines changed: 87916 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.

.env.example

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
RM_CORP_ID=your-corp-id
2+
RM_USERNAME=your-api-user
3+
RM_PASSWORD=your-password
4+
RM_LOCATION_ID=1
5+
RM_TOKEN_FILE=.rentmanager-token.json

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @azero
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Bug report
2+
description: Report a reproducible SDK defect
3+
title: "[Bug]: "
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Do not include credentials, API tokens, tenant data, customer data, or unredacted API responses.
9+
- type: input
10+
id: node-version
11+
attributes:
12+
label: Node.js version
13+
placeholder: 22.18.0
14+
validations:
15+
required: true
16+
- type: input
17+
id: commit
18+
attributes:
19+
label: Package version or commit
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: What happened?
26+
description: Include expected and actual behavior.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: reproduction
31+
attributes:
32+
label: Minimal reproduction
33+
render: typescript
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: checks
38+
attributes:
39+
label: Validation
40+
description: Include relevant test output with sensitive values removed.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security vulnerability
4+
url: https://github.com/azero/RentManager-TypeScript/security/advisories/new
5+
about: Report vulnerabilities privately. Do not open a public issue.
6+
- name: Rent Manager product or API support
7+
url: https://www.rentmanager.com/support/
8+
about: Contact Rent Manager for account, subscription, or service support.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Feature request
2+
description: Suggest an SDK improvement
3+
title: "[Feature]: "
4+
labels: [enhancement]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Problem
10+
description: What problem or API workflow should this solve?
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: proposal
15+
attributes:
16+
label: Proposed solution
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: alternatives
21+
attributes:
22+
label: Alternatives considered

.github/SUPPORT.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Support
2+
3+
Use GitHub Issues for reproducible SDK bugs and focused feature requests.
4+
Include the Node.js version, package version or commit, a minimal reproduction,
5+
and redacted output.
6+
7+
Do not include Rent Manager credentials, API tokens, tenant information,
8+
customer data, or unredacted API responses in an issue.
9+
10+
- Report SDK security vulnerabilities through [GitHub private vulnerability reporting](https://github.com/azero/RentManager-TypeScript/security/advisories/new).
11+
- Contact [Rent Manager Support](https://www.rentmanager.com/support/) for account access, subscriptions, service availability, or questions about Rent Manager itself.

.github/dependabot.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: "/"
5+
schedule:
6+
interval: weekly
7+
open-pull-requests-limit: 5
8+
- package-ecosystem: github-actions
9+
directory: "/"
10+
schedule:
11+
interval: weekly
12+
open-pull-requests-limit: 5

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Summary
2+
3+
Describe what changed and why.
4+
5+
## Validation
6+
7+
- [ ] `npm run check`
8+
- [ ] `npm run test:coverage`
9+
- [ ] `npm audit --audit-level=low`
10+
- [ ] No credentials, tokens, tenant data, customer data, or generated exports are included
11+
12+
## Compatibility and risk
13+
14+
Describe API or behavior changes, live-account effects, write operations, and
15+
whether the change is backward-compatible.

.github/workflows/ci.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
test:
14+
name: Node.js ${{ matrix.node-version }}
15+
runs-on: ubuntu-latest
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
node-version: [18, 20, 22, 24]
20+
21+
steps:
22+
- name: Check out source
23+
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
24+
25+
- name: Set up Node.js
26+
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
27+
with:
28+
node-version: ${{ matrix.node-version }}
29+
cache: npm
30+
31+
- name: Install dependencies
32+
run: npm ci
33+
34+
- name: Verify generated sources, types, tests, and package build
35+
run: npm run check
36+
37+
- name: Audit dependencies
38+
if: matrix.node-version == 24
39+
run: npm audit --audit-level=low

0 commit comments

Comments
 (0)