Initial commit

Author: timdesm

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Lint
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint

.gitignore

@@ -0,0 +1,7 @@
+node_modules
+.DS_Store
+.dist
+.npm
+.tshy
+.eslintcache
+dist

.npmignore

@@ -0,0 +1,7 @@
+node_modules
+.DS_Store
+.dist
+.npm
+.tshy
+.eslintcache
+dist

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+Thanks for contributing! Please keep changes small and focused.
+
+## Development
+
+```bash
+npm install
+npm run lint
+npm run build
+```
+
+## Conventions
+
+- Mirror the core SDK structure: models, operations, funcs, sdk.
+- Use `zod/v4` and `.loose()` for forward compatibility.
+- Keep public types clean; transform HAL fields in schemas.

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ominity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MODULES.md

@@ -0,0 +1,25 @@
+# Module Template Notes
+
+This template mirrors the core SDK structure and conventions:
+
+- Models live in `src/models/**`
+- Operation types in `src/models/operations/**`
+- Funcs in `src/funcs/**`
+- SDK classes in `src/sdk/**`
+- Exports in `src/index.ts`
+
+## HAL Behavior
+
+- Public types should not expose `_links` or `_embedded`.
+- Use Zod `.transform()` to map `_links` -> `links` and `_embedded` to typed fields.
+- Use `.loose()` for forward compatibility.
+
+## Pagination
+
+- Use `buildPaginated()` and `applyPaginationParams()` from `@ominity/api-typescript/models`.
+- Page/limit are optional; API defaults to page 1 / limit 20.
+
+## Module Wiring
+
+- Export `bookingsModule()` (factory) and `BookingsModule` (prebuilt instance).
+- Use module augmentation so `ominity.modules.bookings` is typed.

README.md

@@ -0,0 +1,72 @@
+# Ominity API Module Template
+
+This is a template repo for creating a modular Ominity API package that plugs into `@ominity/api-typescript`.
+
+See `RENAME_CHECKLIST.md` for the exact rename steps.
+
+## What to Rename
+
+- Package name in `package.json`
+- Source dialect in `package.json` (`@ominity/api-modules-template/source`)
+- Module name inside `src/sdk/index.ts`
+- Folder names under `src/models` and `src/funcs`
+- README examples
+
+If you plan to publish, remove `"private": true` in `package.json`.
+
+## Install
+
+```bash
+npm install @ominity/api-typescript
+```
+
+## Usage (example)
+
+```ts
+import { Ominity } from "@ominity/api-typescript";
+import { bookingsModule, BookingsModule } from "@ominity/api-modules-bookings";
+
+const ominity = new Ominity({
+  serverURL: "https://tenant-a.ominity.com/api",
+  security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
+});
+
+// Either option is supported
+ominity.use(BookingsModule);
+// or
+ominity.use(bookingsModule());
+
+// Constructor option
+const ominity2 = new Ominity({
+  serverURL: "https://tenant-a.ominity.com/api",
+  security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
+  modules: [bookingsModule()],
+});
+
+const res = await ominity.modules.bookings.events.list({ page: 1, limit: 20 });
+console.log(res.items);
+```
+
+## Structure
+
+```
+src/
+  funcs/
+  models/
+  models/operations/
+  sdk/
+  index.ts
+```
+
+## Development
+
+```bash
+npm run lint
+npm run build
+```
+
+## Notes
+
+- This template mirrors the core SDK architecture (models, operations, funcs, sdk).
+- HAL responses are transformed; public types should not expose `_links` or `_embedded`.
+- Use `zod/v4` and `.loose()` for forward compatibility.

RENAME_CHECKLIST.md

@@ -0,0 +1,37 @@
+# Rename Checklist
+
+Use this when turning the template into a real module package.
+
+1. Update `package.json`:
+- `name`
+- `tshy.sourceDialects`
+- `exports` (source dialect keys)
+- `peerDependencies` target version if needed
+
+1. Update `jsr.json`:
+- `name`
+- `version`
+
+1. Rename module identifiers:
+- `src/sdk/index.ts`: module name string (e.g. `"bookings"`)
+- `src/sdk/index.ts`: type names (e.g. `BookingsModule`)
+- `src/sdk/bookings` folder name
+- `src/models/bookings` folder name
+- `src/funcs/bookings` folder name
+
+1. Update imports/exports:
+- `src/index.ts`
+- `src/models/index.ts`
+- `src/models/operations/index.ts`
+- `src/funcs/index.ts`
+- `src/sdk/index.ts`
+
+1. Update README examples:
+- Package name
+- Module name
+- Example paths
+
+1. Remove template markers:
+- Replace placeholder resource names (`BookingEvent`, `events`) with real ones
+- Replace `/modules/bookings/events` paths
+

RUNTIMES.md

@@ -0,0 +1,6 @@
+# Runtimes
+
+This SDK module targets Node.js and modern browsers.
+
+- Node.js 20+ recommended.
+- Browser usage depends on CORS restrictions (cannot set User-Agent header).

USAGE.md

@@ -0,0 +1,19 @@
+# Usage
+
+```ts
+import { Ominity } from "@ominity/api-typescript";
+import { bookingsModule } from "@ominity/api-modules-bookings";
+
+const ominity = new Ominity({
+  serverURL: "https://tenant-a.ominity.com/api",
+  security: { apiKey: process.env["OMINITY_API_KEY"] ?? "" },
+  modules: [bookingsModule()],
+});
+
+const res = await ominity.modules.bookings.events.list({
+  page: 1,
+  limit: 20,
+});
+
+console.log(res.items);
+```