@checkcourt/sdk 0.6.0 → 0.8.0

package/README.md

@@ -210,6 +210,7 @@ with the matching builder; each throws when the answer would break CheckCourt's
 | `booking_plan.action` | `ext.date`, `ext.courts` (and the day as subject) | `ui.doc([...])`, shown in a dialog after a click; `ui.hidden()` closes it |
 | `sidebar.action` | nothing extra | `ui.doc([...])`, shown in a dialog after a click; `ui.hidden()` closes it |
 | `member.settings.section` | nothing extra | `ui.doc([...])`, a card on the member's own settings page |
+| `nav.page` | nothing extra | `ui.doc([...])` (or an iframe), the content of the app's own page |
 
 ```ts
 if (ext.kind === "render" && ext.point === "court.annotation" && ext.date && ext.courts) {
@@ -227,6 +228,24 @@ if (ext.kind === "render" && ext.point === "court.annotation" && ext.date && ext
 manifest and may set an `icon` from `APP_ACTION_ICONS`. In every declarative document,
 CheckCourt places content first, then the buttons, then the links of each level.
 
+`nav.page` gives your app an entry in the main navigation and a full page of its own at
+`/apps/<installation id>/<index>`. It needs a `label` (at most 24 characters, also the page
+title) and an `icon` from `APP_ACTION_ICONS`, may be declarative or an iframe, and appears at
+most once per manifest. A club installation's entry is shown to every member of the club, a
+member installation's entry only to that member:
+
+```ts
+defineManifest({
+  installTargets: ["tenant"],
+  extensions: [{ point: "nav.page", kind: "declarative", url: "https://app.example.de/ext/page", label: "Trainingsplan", icon: "calendar" }],
+  dataProcessing: { categories: ["Trainingsdaten"], purpose: "Zeigt den Trainingsplan", storageLocation: "EU", avvRequired: false },
+});
+
+if (ext.point === "nav.page") {
+  return Response.json(ui.doc([ui.heading("Diese Woche"), ui.text("Dienstag 18 Uhr: Jugendtraining")]));
+}
+```
+
 ### OAuth with PKCE (member apps)
 
 ```ts

package/dist/extensions.d.ts

@@ -53,6 +53,7 @@ export interface PointCapabilities {
     "booking.hint": Record<string, never>;
     "booking_plan.action": BookingPlanCapabilities;
     "sidebar.action": Record<string, never>;
+    "nav.page": Record<string, never>;
 }
 export interface PointSubject {
     "app.settings": {
@@ -83,6 +84,7 @@ export interface PointSubject {
         id: string;
     };
     "sidebar.action": null;
+    "nav.page": null;
 }
 interface ContextClaimsOf<P extends ExtensionPoint> {
     iss: typeof CONTEXT_ISSUER;

package/dist/generated/schema.d.ts

@@ -242,11 +242,11 @@ export interface paths {
          * @description **Required scope:** `members:invite`
          *
          *     Adds a member to the club. Three flows, decided by the input:
-         *     1. **Email already has an account** (in no other club): the existing user is added to this club.
+         *     1. **Email already has an account** (in no other club): the account owner is invited. The membership stays pending (`awaitingAcceptance: true`) until they accept after their next login; until then the club cannot change the account's name, email, phone or password, and deleting the member only withdraws the invitation. `sendEmail` controls the invitation mail.
          *     2. **New email**: a new account is created and, unless `sendEmail=false`, a welcome mail with a claim link is sent.
          *     3. **`noOwnEmail=true`**: for members without their own mailbox. Creates an account with a synthetic address, stores the given email as forwarding address and requires a `password` (min 8 chars) the member uses to log in.
          *
-         *     `roleIds` (optional) assigns roles besides the base role Mitglied (member) and requires `roles:manage`, which only personal keys can hold: the caller must outrank each role and hold all of its scopes (403). Unknown ids fail with 404 before anything is created.
+         *     `roleIds` (optional) assigns roles besides the base role Mitglied and requires `roles:manage`, which only personal keys can hold: the caller must outrank each role and hold all of its scopes (403). Unknown ids fail with 404 before anything is created.
          *
          *     Fails with 422 when the club's member limit is reached, the member number is taken, the email already belongs to this club, or the data processing agreement (AVV) has not been signed yet.
          */
@@ -302,7 +302,7 @@ export interface paths {
          * End a membership
          * @description **Required scope:** `members:delete`
          *
-         *     Removes the member from the club with a full cascade: future bookings are cancelled (with email notification), open guest fees are resolved according to `orphanedFeeAction`, and if this was the user's only club the account is anonymized. Members who lead a team cannot be deleted until leadership is handed over, and the club's last administrator cannot be deleted (422). The response summarizes what happened.
+         *     Removes the member from the club with a full cascade: future bookings are cancelled (with email notification), open guest fees are resolved according to `orphanedFeeAction`, and if this was the user's only club the account is anonymized (not for a pending invitation, which only withdraws the invitation). The caller must outrank the member (403): only administrators may delete members holding an equal or higher role; management keys act with their creator's rank but never on administrators. Members who lead a team cannot be deleted until leadership is handed over, and the club's last administrator cannot be deleted (422). The response summarizes what happened.
          */
         delete: operations["deleteMember"];
         options?: never;
@@ -311,7 +311,7 @@ export interface paths {
          * Update a member
          * @description **Required scope:** `members:write`
          *
-         *     `name` and `email` are required (send the current values to keep them); `phone` and `memberNumber` are optional. For forwarding-only accounts the email update changes the forwarding address, not the login address. If the user is also a member of another club, name/email/phone are left untouched (they are account-level) and only the member number changes. Sessions cannot edit their own account; management keys are exempt from that rule. Member numbers are unique per club (422 on collision). Roles are not part of this endpoint: use `PUT /members/{id}/roles`. Sending `role` fails with 400.
+         *     `name` and `email` are required (send the current values to keep them); `phone` and `memberNumber` are optional. For forwarding-only accounts the email update changes the forwarding address, not the login address. If the user is also a member of another club, name/email/phone are left untouched (they are account-level) and only the member number changes. Sessions cannot edit their own account; management keys are exempt from that rule. Changing the email requires outranking the member (403): only administrators may change the email of members holding an equal or higher role; management keys act with their creator's rank but never on administrators. While the member's invitation is pending, changing name, email or phone fails with 422. Member numbers are unique per club (422 on collision). Roles are not part of this endpoint: use `PUT /members/{id}/roles`. Sending `role` fails with 400.
          */
         patch: operations["updateMember"];
         trace?: never;
@@ -3586,7 +3586,12 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["Success"];
+                    "application/json": {
+                        /** @constant */
+                        success: true;
+                        /** @description True when an existing account was invited and its owner still has to accept */
+                        awaitingAcceptance: boolean;
+                    };
                 };
             };
             400: components["responses"]["ValidationError"];

package/dist/generated/spec-hash.d.ts

@@ -1 +1 @@
-export declare const OPENAPI_SPEC_SHA256 = "b01c1f9ed8ee89d62dc6daaf41f3f27f55fe06a524660f9790c4981785eed8da";
+export declare const OPENAPI_SPEC_SHA256 = "838f8beb1f933593ea8eea8ea14eb78b12e0e8d61109254f5e72bec10b57e58a";

package/dist/generated/spec-hash.js

@@ -1,2 +1,2 @@
 // Generated by scripts/generate.mjs from the CheckCourt OpenAPI spec. Do not edit.
-export const OPENAPI_SPEC_SHA256 = "b01c1f9ed8ee89d62dc6daaf41f3f27f55fe06a524660f9790c4981785eed8da";
+export const OPENAPI_SPEC_SHA256 = "838f8beb1f933593ea8eea8ea14eb78b12e0e8d61109254f5e72bec10b57e58a";

package/dist/manifest.d.ts

@@ -56,6 +56,10 @@ export declare const EXTENSION_POINTS: {
         readonly targets: readonly ["tenant", "user"];
         readonly kinds: readonly ["declarative"];
     };
+    readonly "nav.page": {
+        readonly targets: readonly ["tenant", "user"];
+        readonly kinds: readonly ["declarative", "iframe"];
+    };
 };
 export type ExtensionPoint = keyof typeof EXTENSION_POINTS;
 /** Scope the installation needs (in `tenantScopes` or `userScopes`) before the point hands it a subject id. */
@@ -72,13 +76,14 @@ export declare const EXTENSION_POINT_SCOPE: {
     readonly "booking.hint": "bookings:read";
     readonly "booking_plan.action": "courts:read";
     readonly "sidebar.action": null;
+    readonly "nav.page": null;
 };
 /** Buttons CheckCourt draws from the manifest alone, before the app is ever called. */
 export declare const STATIC_ACTION_POINTS: readonly ["booking_plan.action", "sidebar.action"];
 export type StaticActionPoint = (typeof STATIC_ACTION_POINTS)[number];
 /** Longest `label` of a static action. */
 export declare const STATIC_ACTION_LABEL_MAX = 24;
-/** lucide icon names a static action may use as `icon`. */
+/** lucide icon names a static action or `nav.page` may use as `icon`. */
 export declare const APP_ACTION_ICONS: readonly ["bell", "calendar", "calendar-check", "camera", "chart-column", "circle-help", "clipboard-list", "clock", "cloud-rain", "door-open", "file-text", "flag", "heart-pulse", "info", "key-round", "lightbulb", "link", "list-checks", "lock-open", "map-pin", "megaphone", "message-square", "receipt", "send", "sparkles", "star", "sun", "thermometer", "ticket", "triangle-alert", "trophy", "user-round", "users", "wallet", "wrench"];
 export type AppActionIcon = (typeof APP_ACTION_ICONS)[number];
 /** Every scope an app may request. Role, app, webhook, key, billing and AVV management are reserved for people. */
@@ -93,6 +98,10 @@ type ExtensionOf<P extends ExtensionPoint> = {
     /** Button text, 1 to 24 characters (`STATIC_ACTION_LABEL_MAX`). */
     label: string;
     icon?: AppActionIcon;
+} : P extends "nav.page" ? {
+    /** Navigation entry and page title, 1 to 24 characters (`STATIC_ACTION_LABEL_MAX`). */
+    label: string;
+    icon: AppActionIcon;
 } : P extends "booking.action" ? {
     label: string;
     icon?: never;
@@ -105,7 +114,7 @@ type ExtensionOf<P extends ExtensionPoint> = {
 });
 /**
  * One entry of `extensions`; `kind`, `label` and `icon` are checked per point at compile time.
- * Every point may appear once, except `booking.action`.
+ * Every point may appear once, except `booking.action`; an app has at most one `nav.page`.
  */
 export type ManifestExtension = {
     [P in ExtensionPoint]: ExtensionOf<P>;

package/dist/manifest.js

@@ -16,6 +16,7 @@ export const EXTENSION_POINTS = {
     "booking.hint": { targets: ["tenant"], kinds: ["declarative"] },
     "booking_plan.action": { targets: ["tenant"], kinds: ["declarative"] },
     "sidebar.action": { targets: ["tenant", "user"], kinds: ["declarative"] },
+    "nav.page": { targets: ["tenant", "user"], kinds: ["declarative", "iframe"] },
 };
 /** Scope the installation needs (in `tenantScopes` or `userScopes`) before the point hands it a subject id. */
 export const EXTENSION_POINT_SCOPE = {
@@ -31,12 +32,13 @@ export const EXTENSION_POINT_SCOPE = {
     "booking.hint": "bookings:read",
     "booking_plan.action": "courts:read",
     "sidebar.action": null,
+    "nav.page": null,
 };
 /** Buttons CheckCourt draws from the manifest alone, before the app is ever called. */
 export const STATIC_ACTION_POINTS = ["booking_plan.action", "sidebar.action"];
 /** Longest `label` of a static action. */
 export const STATIC_ACTION_LABEL_MAX = 24;
-/** lucide icon names a static action may use as `icon`. */
+/** lucide icon names a static action or `nav.page` may use as `icon`. */
 export const APP_ACTION_ICONS = [
     "bell",
     "calendar",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkcourt/sdk",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Official TypeScript SDK for the CheckCourt app platform",
   "private": false,
   "license": "MIT",