@lcas58/esmi-api-types 1.0.3 → 1.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2024 w3cj
+
+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
+(including the next paragraph) 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.

package/README.md

@@ -1,24 +1,136 @@
-# ESMI API Types
+## Esmi API
 
-Shared TypeScript types for ESMI frontend and backend applications.
+Type-safe JSON API built with Hono, OpenAPI, Drizzle ORM, and Better Auth. Runs locally via Cloudflare Wrangler with Node.js compatibility.
 
-## Installation
+### Features
+
+- **OpenAPI docs**: `@hono/zod-openapi` + Scalar UI
+- **Auth**: Better Auth routes proxied under `/api/auth/*`
+- **Database**: PostgreSQL via Drizzle ORM
+- **Logging**: Pino + `hono-pino`
+
+---
+
+## Quick start
+
+### Prerequisites
+
+- Node.js 20+
+- Bun (for `bunx` used by db scripts)
+- Cloudflare Wrangler (`npm i -g wrangler`)
+- A PostgreSQL database (e.g. Neon) and `DATABASE_URL`
+
+### Install
+
+```bash
+npm install
+```
+
+### Environment
+
+Create a `.env` file with:
+
+```bash
+NODE_ENV=development
+LOG_LEVEL=info
+DATABASE_URL=postgres://user:pass@host/db
+# Only required in production when using Neon auth token
+DATABASE_AUTH_TOKEN=
+
+BETTER_AUTH_SECRET=replace-me
+BETTER_AUTH_URL=http://localhost:8787
+BETTER_AUTH_TRUSTED_ORIGINS=http://localhost:3000
+
+# OAuth (Google) for Better Auth
+AUTH_GOOGLE_ID=
+AUTH_GOOGLE_SECRET=
+```
+
+### Database
+
+Generate and run migrations:
 
 ```bash
-bun add @lcas58/esmi-api-types
-# or
-npm install @lcas58/esmi-api-types
+npm run db:generate
+npm run db:migrate
 ```
 
-## Usage
+Optional seed:
 
-```typescript
-import type { AppType } from "@lcas58/esmi-api-types";
+```bash
+npm run db:seed
+```
+
+### Run locally
 
-// Use AppType in your Hono client
-const client = hc<AppType>("/api");
+```bash
+npm run dev
+# Wrangler serves on http://localhost:8787 by default
 ```
 
-## Development
+### Build & deploy
+
+```bash
+npm run build
+npm run deploy
+```
+
+---
+
+## API
+
+### Docs
+
+- `GET /doc` OpenAPI spec (JSON)
+- `GET /reference` Scalar API UI
+
+### Auth
+
+- `GET|POST /api/auth/*` handled by Better Auth
+
+### Index
+
+- `GET /` health/info
+
+### Organizations (requires auth)
+
+- `GET /organizations/{ownerId}` list organizations for a user
+- `POST /organizations` create organization
+- `PATCH /organizations/{id}` update by id
+- `DELETE /organizations/{id}` delete by id
+
+### Leagues
+
+- `GET /leagues/{locationId}` list leagues for a location
+
+### Marketing
+
+- `GET /marketing/email` list email signups
+- `POST /marketing/email` create email signup
+
+### Tags
+
+- `GET /tags?type={type}` list tags (optional filter by `type`)
+
+---
+
+## Project structure
+
+- App bootstrap: `src/app.ts`
+- OpenAPI config & UI: `src/lib/configure-open-api.ts`
+- Routes: `src/routes/**`
+- DB schema: `src/db/schema/**`
+- Drizzle config: `drizzle.config.ts`
+
+For the current database model overview, see `DB_SCHEMA.md`.
+
+---
+
+## Scripts
 
-This package is automatically updated when the backend API types change.
+- `dev`: Wrangler dev server
+- `build`: TypeScript build + path aliasing
+- `deploy`: Wrangler deploy
+- `test`: Vitest
+- `lint` / `lint:fix`
+- `db:generate` / `db:migrate` / `db:studio` / `db:seed`

package/dist/src/db/schema/event.d.ts

@@ -0,0 +1,264 @@
+declare const event: import("drizzle-orm/pg-core").PgTableWithColumns<{
+    name: "event";
+    schema: undefined;
+    columns: {
+        id: import("drizzle-orm/pg-core").PgColumn<{
+            name: "id";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: true;
+            isAutoincrement: false;
+            hasRuntimeDefault: true;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        name: import("drizzle-orm/pg-core").PgColumn<{
+            name: "name";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgVarchar";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        description: import("drizzle-orm/pg-core").PgColumn<{
+            name: "description";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        locationId: import("drizzle-orm/pg-core").PgColumn<{
+            name: "location_id";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgVarchar";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        type: import("drizzle-orm/pg-core").PgColumn<{
+            name: "type";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgVarchar";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        organizationId: import("drizzle-orm/pg-core").PgColumn<{
+            name: "organizationId";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        creatorId: import("drizzle-orm/pg-core").PgColumn<{
+            name: "creatorId";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        mode: import("drizzle-orm/pg-core").PgColumn<{
+            name: "mode";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgVarchar";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        ageGroup: import("drizzle-orm/pg-core").PgColumn<{
+            name: "age_group";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgVarchar";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        gender: import("drizzle-orm/pg-core").PgColumn<{
+            name: "gender";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgVarchar";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        status: import("drizzle-orm/pg-core").PgColumn<{
+            name: "status";
+            tableName: "event";
+            dataType: "string";
+            columnType: "PgVarchar";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        createdAt: import("drizzle-orm/pg-core").PgColumn<{
+            name: "created_at";
+            tableName: "event";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+        updatedAt: import("drizzle-orm/pg-core").PgColumn<{
+            name: "updated_at";
+            tableName: "event";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "pg";
+}>;
+export declare const eventRelations: import("drizzle-orm").Relations<"event", {
+    creator: import("drizzle-orm").One<"user", false>;
+    organization: import("drizzle-orm").One<"organization", true>;
+    location: import("drizzle-orm").One<"location", false>;
+}>;
+export declare const selectEventSchema: import("zod").ZodObject<{
+    id: import("zod").ZodString;
+    name: import("zod").ZodString;
+    description: import("zod").ZodNullable<import("zod").ZodString>;
+    locationId: import("zod").ZodNullable<import("zod").ZodString>;
+    type: import("zod").ZodString;
+    organizationId: import("zod").ZodString;
+    creatorId: import("zod").ZodNullable<import("zod").ZodString>;
+    mode: import("zod").ZodString;
+    ageGroup: import("zod").ZodString;
+    gender: import("zod").ZodString;
+    status: import("zod").ZodString;
+    createdAt: import("zod").ZodDate;
+    updatedAt: import("zod").ZodDate;
+}, import("zod").UnknownKeysParam, import("zod").ZodTypeAny, {
+    id: string;
+    status: string;
+    type: string;
+    description: string | null;
+    name: string;
+    locationId: string | null;
+    organizationId: string;
+    mode: string;
+    createdAt: Date;
+    updatedAt: Date;
+    creatorId: string | null;
+    ageGroup: string;
+    gender: string;
+}, {
+    id: string;
+    status: string;
+    type: string;
+    description: string | null;
+    name: string;
+    locationId: string | null;
+    organizationId: string;
+    mode: string;
+    createdAt: Date;
+    updatedAt: Date;
+    creatorId: string | null;
+    ageGroup: string;
+    gender: string;
+}>;
+export default event;

package/dist/src/db/schema/event.js

@@ -0,0 +1,38 @@
+import { relations } from "drizzle-orm";
+import { pgTable, text, timestamp, varchar } from "drizzle-orm/pg-core";
+import { createSelectSchema } from "drizzle-zod";
+import { randomUUID } from "node:crypto";
+import location from "./location.js";
+import organization from "./organization.js";
+import { user } from "./user.js";
+const event = pgTable("event", {
+    id: text("id").primaryKey().$defaultFn(() => randomUUID()),
+    name: varchar("name", { length: 255 }).notNull(),
+    description: text("description"),
+    locationId: varchar("location_id").references(() => location.id),
+    type: varchar("type").notNull(),
+    organizationId: text("organizationId").references(() => organization.id, { onDelete: "cascade" }).notNull(),
+    creatorId: text("creatorId").references(() => user.id, { onDelete: "set null" }),
+    mode: varchar("mode").notNull(), // Adult, Youth
+    ageGroup: varchar("age_group").notNull(),
+    gender: varchar("gender").notNull(),
+    status: varchar("status").notNull(), // IN_PROGRESS, COMPLETED, CANCELLED
+    createdAt: timestamp("created_at").defaultNow().notNull(),
+    updatedAt: timestamp("updated_at").defaultNow().notNull(),
+});
+export const eventRelations = relations(event, ({ one }) => ({
+    creator: one(user, {
+        fields: [event.creatorId],
+        references: [user.id],
+    }),
+    organization: one(organization, {
+        fields: [event.organizationId],
+        references: [organization.id],
+    }),
+    location: one(location, {
+        fields: [event.locationId],
+        references: [location.id],
+    }),
+}));
+export const selectEventSchema = createSelectSchema(event);
+export default event;

package/dist/src/db/schema/index.d.ts

@@ -0,0 +1,8 @@
+export { default as event, eventRelations, selectEventSchema } from "./event.js";
+export { default as leagues, insertLeaguesSchema, leagueRelations, selectLeaguesSchema } from "./league.js";
+export { default as location, insertLocationSchema, locationRelations, selectLocationSchema } from "./location.js";
+export { emailCampaign, insertEmailCampaignSchema, selectEmailCampaignSchema } from "./marketing.js";
+export { createOrganizationWithDetailsSchema, default as organization, generateSocialMediaUrl, getOrganizationWithDetailsSchema, insertOrganizationSchema, insertOrganizationSocialMediaSchema, insertOrganizationTagSchema, insertOrganizationWebsiteSchema, organizationRelations, organizationSocialMedia, organizationSocialMediaRelations, organizationTagsRelations, organizationWebsites, organizationWebsitesRelations, patchOrganizationSchema, selectOrganizationSchema, SOCIAL_MEDIA_PLATFORMS, type SocialMediaPlatform } from "./organization.js";
+export { default as pickup, eventPickupRelations, pickupRelations, selectPickupSchema } from "./pickup.js";
+export { default as tags, eventTags, organizationTags, selectTagsSchema } from "./tag.js";
+export { account, selectUserSchema, session, user, verification } from "./user.js";

package/dist/src/db/schema/index.js

@@ -0,0 +1,8 @@
+export { default as event, eventRelations, selectEventSchema } from "./event.js";
+export { default as leagues, insertLeaguesSchema, leagueRelations, selectLeaguesSchema } from "./league.js";
+export { default as location, insertLocationSchema, locationRelations, selectLocationSchema } from "./location.js";
+export { emailCampaign, insertEmailCampaignSchema, selectEmailCampaignSchema } from "./marketing.js";
+export { createOrganizationWithDetailsSchema, default as organization, generateSocialMediaUrl, getOrganizationWithDetailsSchema, insertOrganizationSchema, insertOrganizationSocialMediaSchema, insertOrganizationTagSchema, insertOrganizationWebsiteSchema, organizationRelations, organizationSocialMedia, organizationSocialMediaRelations, organizationTagsRelations, organizationWebsites, organizationWebsitesRelations, patchOrganizationSchema, selectOrganizationSchema, SOCIAL_MEDIA_PLATFORMS } from "./organization.js";
+export { default as pickup, eventPickupRelations, pickupRelations, selectPickupSchema } from "./pickup.js";
+export { default as tags, eventTags, organizationTags, selectTagsSchema } from "./tag.js";
+export { account, selectUserSchema, session, user, verification } from "./user.js";