@jphil/bookwhen-client 0.0.2 → 0.0.8

package/LICENSE

@@ -0,0 +1,7 @@
+ISC License
+
+Copyright 2024 Justin Philpott
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,122 @@
+# `@jphil/bookwhen-client`
+
+\[wip\]!
+
+An API client library for the [Bookwhen](www.bookwhen.com) booking platform [API (v2)](https://api.bookwhen.com/v2), written in Typescript for NodeJS. Intended for server-side environments.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Contributing](#contributing)
+- [Roadmap](#roadmap)
+- [License](#license)
+
+## Overview
+
+You'll likely be at least somewhat familiar with the [Bookwhen](www.bookwhen.com) booking platform if you've landed here. But if not, you'll want to have a look at their [API (v2) documentation](https://api.bookwhen.com/v2). There's also a nice [Swagger style layout of the Bookwhen API v2 docs](https://petstore.swagger.io/?url=https://api.bookwhen.com/v2/openapi.yaml)
+
+## Features
+
+- Lightweight and easy to integrate
+- Fully typed for TypeScript support
+
+## Installation
+
+Install via pnpm:
+
+```bash
+pnpm add @jphil/bookwhen-client
+```
+
+## Usage
+
+\[wip\]!
+
+```typescript
+// ... todo
+```
+
+## Configuration
+
+Required configuration options:
+
+- **apiKey**: Your Bookwhen API key (required)
+
+API requests to the Bookwhen API are authenticated using Basic Authentication with the API Key as the username and a blank password.
+
+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).
+
+## Contributing
+
+### How to Contribute
+
+Thank you for your interest in contributing! 
+
+This library follows the standard Github Flow contribution workflow, have a read of the guide to [Github Flow](https://docs.github.com/en/get-started/using-github/github-flow#following-github-flow) from the Github docs, if you're not familiar.
+
+### Contribution Requirements
+
+- Use the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) style when writing your commit messages.
+- Ensure you create a [changeset](https://github.com/changesets/changesets) as the final commit before creating a new PR (or updating one).
+
+#### Setting Up Husky for Contributions
+
+This project uses Husky for Git hooks and Commitlint to enforce commit message standards.
+
+Install Dependencies: First, clone the repository and install the project dependencies, which include Husky:
+
+```bash
+git clone <repository-url>
+cd <repository-directory>
+pnpm install
+```
+
+Activate Husky Hooks: After installing dependencies, you need to initialize Husky's Git hooks. Run the following command:
+
+```bash
+pnpm husky install
+```
+
+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.
+
+Thank you for helping maintain commit quality and consistency!
+
+\[wip\]!
+
+## CI 
+
+>>> consider changesets in the following?
+
+### Contrib flow
+
+- Contrib user clones repo locally
+- Contrib user creates a feature branch
+- Contrib user generates commits to feature branch
+- Contrib user create a PR back to the origin/[default branch]
+- CI pipeline activates and runs at least tests && build
+-> On success PR can be merged to main by Maintainer
+-> On fail PR needs updating until tests and build success 
+
+
+### Maintainer flow
+
+- Maintainer decides that code on main is ready to release
+- Mt pulls main
+- Mt checks out new "release" branch
+- Mt runs: pnpm changeset add
+- Mt commits results when happy with the change set
+- Mt run changeset version 
+[WIP]
+
+## Roadmap
+
+- Keep up with any future changes or additions to the [Bookwhen API](https://api.bookwhen.com/v2).
+
+## License
+
+ISC License. See [LICENSE](LICENSE) for more information.
+

package/dist/index.d.ts

@@ -1,3 +1 @@
-declare const test: () => void;
-
-export { test };
+export declare const test: () => void;

package/dist/index.js

@@ -1,7 +1,4 @@
-// src/index.ts
-var test = () => {
-  console.log("hello test");
-};
-export {
-  test
+export const test = () => {
+    console.log('hello test');
 };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,EAAE;IACvB,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAC5B,CAAC,CAAC"}

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,7 @@
+import { describe, it, expect } from 'vitest';
+describe('something', () => {
+    it('should pass CI', () => {
+        expect(1).toBe(1);
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE9C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,16 +1,35 @@
 {
   "name": "@jphil/bookwhen-client",
-  "version": "0.0.2",
+  "version": "0.0.8",
   "description": "",
   "private": false,
-  "main": "/dist/index.js",
-  "module": "/dist/index.mjs",
-  "types": "/dist/index.d.ts",
-  "keywords": [],
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "bookwhen",
+    "booking",
+    "api client"
+  ],
   "type": "module",
-  "author": "Justin Philpott",
+  "author": {
+    "name": "Justin Philpott",
+    "email": "justin@jphil.dev"
+  },
+  "homepage": "https://github.com/justinphilpott/bookwhen-client",
+  "bugs": {
+    "url": "https://github.com/justinphilpott/bookwhen-client/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/justinphilpott/bookwhen-client.git"
+  },
+  "files": [
+    "dist"
+  ],
   "license": "ISC",
   "devDependencies": {
+    "@arethetypeswrong/cli": "^0.16.4",
     "@changesets/cli": "^2.27.9",
     "@commitlint/cli": "^19.5.0",
     "@commitlint/config-conventional": "^19.5.0",
@@ -36,14 +55,18 @@
   },
   "scripts": {
     "dev": "vitest",
-    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build": "tsc",
     "lint": "tsc",
     "test": "vitest run",
-    "ci": "pnpm lint && pnpm test && pnpm build",
-    "release": "pnpm lint && pnpm test && pnpm build && changeset publish",
-    "commit": "cz",
     "type-check": "tsc --noEmit",
-    "pre-commit": "pnpm lint",
-    "prepush": "pnpm test"
+    "check-exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+    "prettier-check": "prettier --check 'src/**/*.ts'",
+    "format": "prettier --write 'src/**/*.ts' README.md",
+    "pre-commit": "pnpm lint && pnpm build",
+    "commit": "cz",
+    "prepush": "pnpm test",
+    "local-release": "changeset version && changeset publish",
+    "release": "pnpm lint && pnpm test && pnpm build && changeset publish",
+    "ci": "pnpm test && pnpm check-exports && pnpm build"
   }
 }

package/.changeset/README.md

@@ -1,8 +0,0 @@
-# Changesets
-
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.0.3/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "public",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

package/.eslintrc.json

@@ -1,14 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es6": true,
-    "node": true
-  },
-  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
-  "parserOptions": {
-    "ecmaVersion": 2021
-  },
-  "rules": {
-    // Add any custom rules here
-  }
-}

package/.github/workflows/main.yml

@@ -1,29 +0,0 @@
-name: CI
-on:
-  push:
-    branches:
-      - '**'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Run CI
-        run: pnpm run ci

package/.github/workflows/publish.yml

@@ -1,37 +0,0 @@
-name: Publish
-on:
-  push:
-    branches:
-      - 'main'
-
-concurrency: ${{ github.workflow }}-${{ github.ref }}
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Set up pnpm
-        uses: pnpm/action-setup@v4
-        with:
-          version: 9
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          cache: 'pnpm'
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Create Release Pull Request or Publish
-        id: changesets
-        uses: changesets/action@v1
-        with:
-          publish: pnpm release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.husky/commit-msg

@@ -1 +0,0 @@
-pnpx commitlint --edit "$1"

package/.husky/pre-commit

@@ -1,2 +0,0 @@
-# .husky/pre-commit
-pnpm lint

package/.nvmrc

@@ -1 +0,0 @@
-v18

package/.prettierrc.json

@@ -1,5 +0,0 @@
-{
-  "singleQuote": true,
-  "trailingComma": "all",
-  "printWidth": 80
-}

package/CHANGELOG.md

@@ -1,7 +0,0 @@
-# @jphil/bookwhen-client
-
-## 0.0.2
-
-### Patch Changes
-
-- 3dee093: Initial setup - changesets -> npm publishing (wip)

package/README

@@ -1,29 +0,0 @@
-# Bookwhen Client
-
-[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-
-## About this Repo
-
-bookwhen-client exist to provide an easy interface for pulling data from the bookwhen API (V2)
-
-## Setting Up Husky for Contributions
-
-This project uses Husky for Git hooks and Commitlint to enforce commit message standards.
-
-    Install Dependencies: First, clone the repository and install the project dependencies, which include Husky:
-
-    bash
-
-git clone <repository-url>
-cd <repository-directory>
-pnpm install
-
-Activate Husky Hooks: After installing dependencies, you need to initialize Husky's Git hooks. Run the following command:
-
-bash
-
-    pnpm husky install
-
-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.
-
-Thank you for helping maintain commit quality and consistency!

package/commitlint.config.cjs

@@ -1 +0,0 @@
-module.exports = { extends: ['@commitlint/config-conventional'] };

package/dist/index.cjs

@@ -1,32 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  test: () => test
-});
-module.exports = __toCommonJS(src_exports);
-var test = () => {
-  console.log("hello test");
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  test
-});

package/dist/index.d.cts

@@ -1,3 +0,0 @@
-declare const test: () => void;
-
-export { test };

package/eslint.config.js

@@ -1,26 +0,0 @@
-// eslint.config.js
-import eslintPluginPrettier from "eslint-plugin-prettier";
-import eslintConfigPrettier from "eslint-config-prettier";
-
-export default [
-  {
-    files: ["**/*.js", "**/*.ts", "**/*.tsx"],
-    languageOptions: {
-      ecmaVersion: 2021,
-      sourceType: "module",
-      globals: {
-        browser: true,
-        es6: true,
-        node: true,
-      },
-    },
-    plugins: {
-      prettier: eslintPluginPrettier,
-    },
-    rules: {
-      ...eslintConfigPrettier.rules, // integrates Prettier rules
-      // Add any custom rules here, e.g.:
-      // "semi": ["error", "always"]
-    },
-  },
-];

package/src/index.test.ts

@@ -1,7 +0,0 @@
-import { describe, it, expect } from 'vitest';
-
-describe('something', () => {
-  it('should pass CI', () => {
-    expect(1).toBe(1);
-  });
-});

package/src/index.ts

@@ -1,3 +0,0 @@
-export const test = () => {
-  console.log('hello test');
-};

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2021",
-    "module": "nodenext",
-    "moduleResolution": "nodenext",
-    "noEmit": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "outDir": "./dist",
-    "baseUrl": "./" 
-  },
-  "include": ["src/**/*"], // Include your source files
-  "exclude": ["node_modules", "dist"] // Exclude unnecessary directories
-}

package/vite.config.ts

@@ -1,5 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-  test: {},
-});