@jphil/bookwhen-client 0.0.4 → 0.0.9
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 +4 -27
- package/dist/index.d.ts +1 -3
- package/dist/index.js +3 -6
- package/package.json +12 -10
package/README.md
CHANGED
|
@@ -34,6 +34,8 @@ pnpm add @jphil/bookwhen-client
|
|
|
34
34
|
|
|
35
35
|
## Usage
|
|
36
36
|
|
|
37
|
+
\[wip\]!
|
|
38
|
+
|
|
37
39
|
```typescript
|
|
38
40
|
// ... todo
|
|
39
41
|
```
|
|
@@ -46,33 +48,11 @@ Required configuration options:
|
|
|
46
48
|
|
|
47
49
|
API requests to the Bookwhen API are authenticated using Basic Authentication with the API Key as the username and a blank password.
|
|
48
50
|
|
|
49
|
-
API keys can be generated in the [https://YOUR-ACCOUNT-NAME.bookwhen.com/settings/api_access_permission_sets
|
|
51
|
+
API keys can be generated in the [API tokens setup area of your Bookwhen account](https://YOUR-ACCOUNT-NAME.bookwhen.com/settings/api_access_permission_sets).
|
|
50
52
|
|
|
51
53
|
## Contributing
|
|
52
54
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
### Setting Up Husky for Contributions
|
|
56
|
-
|
|
57
|
-
This project uses Husky for Git hooks and Commitlint to enforce commit message standards.
|
|
58
|
-
|
|
59
|
-
Install Dependencies: First, clone the repository and install the project dependencies, which include Husky:
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
git clone <repository-url>
|
|
63
|
-
cd <repository-directory>
|
|
64
|
-
pnpm install
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
Activate Husky Hooks: After installing dependencies, you need to initialize Husky's Git hooks. Run the following command:
|
|
68
|
-
|
|
69
|
-
```bash
|
|
70
|
-
pnpm husky install
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
This command sets up a .husky/ directory in the project, linking the necessary scripts to Git’s hook system. Once activated, Husky will automatically enforce commit message standards during commits.
|
|
74
|
-
|
|
75
|
-
Thank you for helping maintain commit quality and consistency!
|
|
55
|
+
Please see the docs in the CONTRIBUTIONS.md file, thanks!
|
|
76
56
|
|
|
77
57
|
## Roadmap
|
|
78
58
|
|
|
@@ -82,6 +62,3 @@ Thank you for helping maintain commit quality and consistency!
|
|
|
82
62
|
|
|
83
63
|
ISC License. See [LICENSE](LICENSE) for more information.
|
|
84
64
|
|
|
85
|
-
## Notice
|
|
86
|
-
|
|
87
|
-
This software is "unofficial" - its development is not affiliated with or funded by Bookwhen.
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jphil/bookwhen-client",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.9",
|
|
4
4
|
"description": "",
|
|
5
5
|
"private": false,
|
|
6
|
-
"main": "
|
|
7
|
-
"module": "
|
|
8
|
-
"types": "
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"module": "dist/index.mjs",
|
|
8
|
+
"types": "dist/index.d.ts",
|
|
9
9
|
"keywords": [
|
|
10
10
|
"bookwhen",
|
|
11
11
|
"booking",
|
|
@@ -55,16 +55,18 @@
|
|
|
55
55
|
},
|
|
56
56
|
"scripts": {
|
|
57
57
|
"dev": "vitest",
|
|
58
|
-
"build": "
|
|
58
|
+
"build": "tsc",
|
|
59
59
|
"lint": "tsc",
|
|
60
60
|
"test": "vitest run",
|
|
61
|
-
"ci": "pnpm lint && pnpm test && pnpm build",
|
|
62
|
-
"release": "pnpm lint && pnpm test && pnpm build && changeset publish",
|
|
63
|
-
"commit": "cz",
|
|
64
61
|
"type-check": "tsc --noEmit",
|
|
62
|
+
"check-exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
|
|
63
|
+
"prettier-check": "prettier --check 'src/**/*.ts'",
|
|
64
|
+
"format": "prettier --write 'src/**/*.ts' README.md",
|
|
65
65
|
"pre-commit": "pnpm lint && pnpm build",
|
|
66
|
+
"commit": "cz",
|
|
66
67
|
"prepush": "pnpm test",
|
|
67
|
-
"
|
|
68
|
-
"
|
|
68
|
+
"local-release": "changeset version && changeset publish",
|
|
69
|
+
"release": "pnpm lint && pnpm test && pnpm build && changeset publish",
|
|
70
|
+
"ci": "pnpm test && pnpm check-exports && pnpm build"
|
|
69
71
|
}
|
|
70
72
|
}
|