@kontrolia/shared 1.0.0 → 1.2.0

package/dist/types.d.ts

@@ -19,10 +19,18 @@ export interface KontroliaMembership {
     status: "active" | "invited" | "suspended";
     roles: string[];
 }
+/** A membership with its organization resolved — what a "switch company" selector needs to render. */
+export interface KontroliaMembershipWithOrganization extends KontroliaMembership {
+    organization: KontroliaOrganization;
+}
 /**
- * Shape of the custom claims injected by kontrolia.custom_access_token_hook
- * (see packages/db/migrations/0007_custom_access_token_hook.sql). Present
- * under the top-level JWT claims, decoded by @kontrolia/auth.
+ * Shape of the custom claims injected by kontrolia_auth.custom_access_token_hook
+ * (see packages/db/migrations/0007_custom_access_token_hook.sql), plus the
+ * standard GoTrue claims every Supabase-issued access token already carries
+ * (`email`, `user_metadata`) — present under the top-level JWT claims,
+ * decoded by @kontrolia/auth. `user_metadata` is whatever was passed at
+ * signup / `updateProfile()`; only the keys @kontrolia/auth itself reads and
+ * writes are typed here.
  */
 export interface KontroliaTokenClaims {
     sub: string;
@@ -31,7 +39,31 @@ export interface KontroliaTokenClaims {
     organization_id: string | null;
     roles: string[];
     permissions: string[];
+    /**
+     * True for a user granted platform-admin status (see
+     * kontrolia_auth.platform_admins) — a reserved claim outside the app
+     * permission-key namespace, for support/ops tooling that needs to see
+     * across every organization instead of just the active one. Not
+     * something an app's own role/permission catalog can grant.
+     */
+    is_platform_admin?: boolean;
+    /**
+     * `{ "<application slug>": "<plan slug>" }` for every live subscription
+     * of the active organization. Informational (show "Plan Pro" without a
+     * round trip) — the actual gate is that `permissions` above is already
+     * intersected with the plan for applications that require one. Limits
+     * and usage are never in the token; see KontroliaEntitlements.
+     */
+    plans?: Record<string, string>;
     exp: number;
+    email?: string | null;
+    user_metadata?: {
+        full_name?: string | null;
+        avatar_url?: string | null;
+        locale?: string | null;
+        timezone?: string | null;
+        [key: string]: unknown;
+    } | null;
     [key: string]: unknown;
 }
 export interface KontroliaInvitation {
@@ -43,4 +75,71 @@ export interface KontroliaInvitation {
 }
 /** A single "resource.action" permission key, e.g. "facturacion.facturas.crear". */
 export type PermissionKey = string;
+export type KontroliaBillingInterval = "month" | "year" | "one_time";
+export type KontroliaLimitPeriod = "day" | "month" | "year" | "lifetime";
+export type KontroliaSubscriptionStatus = "trialing" | "active" | "past_due" | "canceled" | "expired";
+export interface KontroliaPlanLimit {
+    key: string;
+    /** null = unlimited. */
+    limit: number | null;
+    period: KontroliaLimitPeriod;
+    description: string | null;
+}
+/** A commercial tier of an application, as an app shows it on its pricing screen. */
+export interface KontroliaPlan {
+    id: string;
+    applicationId: string;
+    slug: string;
+    name: string;
+    description: string | null;
+    /** Minor units (centavos/cents). */
+    priceAmount: number;
+    currency: string;
+    billingInterval: KontroliaBillingInterval;
+    trialDays: number;
+    features: string[];
+    isDefault: boolean;
+    isActive: boolean;
+    sortOrder: number;
+    /** Permission keys this plan unlocks. */
+    permissions: string[];
+    limits: KontroliaPlanLimit[];
+}
+export interface KontroliaSubscription {
+    id: string;
+    organizationId: string;
+    applicationId: string;
+    planId: string;
+    planSlug: string;
+    planName: string;
+    status: KontroliaSubscriptionStatus;
+    /** Whether it currently grants access (active/trialing, or past_due inside the grace window). */
+    isLive: boolean;
+    currentPeriodStart: string | null;
+    currentPeriodEnd: string | null;
+    cancelAtPeriodEnd: boolean;
+    provider: "manual" | "stripe";
+}
+export interface KontroliaUsage extends KontroliaPlanLimit {
+    used: number;
+    /** null when the limit is unlimited. */
+    remaining: number | null;
+    periodStart: string;
+}
+/**
+ * What the caller's active organization is entitled to in one application:
+ * its live plan (if any), why access might be blocked, the permissions that
+ * survive the role ∩ plan intersection, and every limit with its current
+ * usage.
+ */
+export interface KontroliaEntitlements {
+    applicationId: string;
+    applicationSlug: string;
+    plansRequired: boolean;
+    subscription: KontroliaSubscription | null;
+    /** "ok" when access is granted; otherwise why not. */
+    access: "ok" | "no_subscription" | "past_due" | "canceled" | "expired";
+    permissions: string[];
+    usage: KontroliaUsage[];
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IAC3C,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,+FAA+F;IAC/F,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,oFAAoF;AACpF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IAC3C,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,sGAAsG;AACtG,MAAM,WAAW,mCAAoC,SAAQ,mBAAmB;IAC9E,YAAY,EAAE,qBAAqB,CAAC;CACrC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,+FAA+F;IAC/F,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,aAAa,CAAC,EAAE;QACd,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,GAAG,IAAI,CAAC;IACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,oFAAoF;AACpF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,wBAAwB,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AACrE,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;AACzE,MAAM,MAAM,2BAA2B,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;AAEtG,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,wBAAwB;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,EAAE,oBAAoB,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,qFAAqF;AACrF,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,wBAAwB,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,kBAAkB,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,2BAA2B,CAAC;IACpC,iGAAiG;IACjG,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC/B;AAED,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC3C,sDAAsD;IACtD,MAAM,EAAE,IAAI,GAAG,iBAAiB,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAC;IACvE,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kontrolia/shared",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "license": "MIT",
   "description": "Shared TypeScript types and utilities used across every KontrolIA Auth package and app.",
   "keywords": [