@goodparty_org/sdk 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -0
- package/dist/index.d.mts +6 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +37 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +10 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +42 -0
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @goodparty_org/sdk
|
|
2
|
+
|
|
3
|
+
TypeScript SDK for interacting with the GoodParty API.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @goodparty_org/sdk
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GoodPartyClient } from '@goodparty_org/sdk'
|
|
15
|
+
|
|
16
|
+
const client = new GoodPartyClient()
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Development
|
|
20
|
+
|
|
21
|
+
### Prerequisites
|
|
22
|
+
|
|
23
|
+
- Node.js 22.12.0 (use `.nvmrc` with nvm)
|
|
24
|
+
|
|
25
|
+
### Setup
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm install
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Scripts
|
|
32
|
+
|
|
33
|
+
| Command | Description |
|
|
34
|
+
| -------------------- | ------------------------------------ |
|
|
35
|
+
| `npm run build` | Build the SDK with tsup |
|
|
36
|
+
| `npm run typecheck` | Run TypeScript type checking |
|
|
37
|
+
| `npm run lint` | Run ESLint |
|
|
38
|
+
| `npm run lint:fix` | Run ESLint with auto-fix |
|
|
39
|
+
| `npm run format` | Format code with Prettier |
|
|
40
|
+
| `npm run format:check` | Check code formatting |
|
|
41
|
+
|
|
42
|
+
### Publishing
|
|
43
|
+
|
|
44
|
+
The SDK is automatically published to npm when changes are merged to `master`:
|
|
45
|
+
|
|
46
|
+
1. Bump the version in `package.json`
|
|
47
|
+
2. Create a pull request
|
|
48
|
+
3. After merge, CI will create a GitHub Release and publish to npm
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
See [LICENSE](LICENSE) for details.
|
package/dist/index.d.mts
ADDED
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/index.ts
|
|
21
|
+
var index_exports = {};
|
|
22
|
+
__export(index_exports, {
|
|
23
|
+
GoodPartyClient: () => GoodPartyClient
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(index_exports);
|
|
26
|
+
|
|
27
|
+
// src/GoodPartyClient.ts
|
|
28
|
+
var GoodPartyClient = class {
|
|
29
|
+
constructor(_config) {
|
|
30
|
+
console.log("hello world!");
|
|
31
|
+
}
|
|
32
|
+
};
|
|
33
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
34
|
+
0 && (module.exports = {
|
|
35
|
+
GoodPartyClient
|
|
36
|
+
});
|
|
37
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/GoodPartyClient.ts"],"sourcesContent":["export { GoodPartyClient } from './GoodPartyClient'\nexport type { GoodPartyClientConfig } from './GoodPartyClient'\n","export type GoodPartyClientConfig = Record<string, never>\n\nexport class GoodPartyClient {\n constructor(_config?: GoodPartyClientConfig) {\n console.log('hello world!')\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEO,IAAM,kBAAN,MAAsB;AAAA,EAC3B,YAAY,SAAiC;AAC3C,YAAQ,IAAI,cAAc;AAAA,EAC5B;AACF;","names":[]}
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/GoodPartyClient.ts"],"sourcesContent":["export type GoodPartyClientConfig = Record<string, never>\n\nexport class GoodPartyClient {\n constructor(_config?: GoodPartyClientConfig) {\n console.log('hello world!')\n }\n}\n"],"mappings":";AAEO,IAAM,kBAAN,MAAsB;AAAA,EAC3B,YAAY,SAAiC;AAC3C,YAAQ,IAAI,cAAc;AAAA,EAC5B;AACF;","names":[]}
|
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@goodparty_org/sdk",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "TypeScript SDK for interacting with the GoodParty API",
|
|
5
|
+
"main": "./dist/index.js",
|
|
6
|
+
"module": "./dist/index.mjs",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"import": "./dist/index.mjs",
|
|
12
|
+
"require": "./dist/index.js"
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist"
|
|
17
|
+
],
|
|
18
|
+
"scripts": {
|
|
19
|
+
"build": "tsup",
|
|
20
|
+
"lint": "eslint \"src/**/*.ts\" --quiet",
|
|
21
|
+
"lint:fix": "eslint \"src/**/*.ts\" --fix",
|
|
22
|
+
"format": "prettier --write \"src/**/*.ts\"",
|
|
23
|
+
"format:check": "prettier --check \"src/**/*.ts\"",
|
|
24
|
+
"typecheck": "tsc --noEmit",
|
|
25
|
+
"prepublishOnly": "npm run build"
|
|
26
|
+
},
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"access": "public"
|
|
29
|
+
},
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"@types/node": "^22.0.0",
|
|
32
|
+
"@typescript-eslint/eslint-plugin": "^8.0.0",
|
|
33
|
+
"@typescript-eslint/parser": "^8.0.0",
|
|
34
|
+
"eslint": "^8.57.0",
|
|
35
|
+
"eslint-config-prettier": "^9.0.0",
|
|
36
|
+
"eslint-plugin-prettier": "^5.0.0",
|
|
37
|
+
"eslint-plugin-unused-imports": "^4.0.0",
|
|
38
|
+
"prettier": "^3.0.0",
|
|
39
|
+
"tsup": "^8.5.1",
|
|
40
|
+
"typescript": "^5.0.0"
|
|
41
|
+
}
|
|
42
|
+
}
|