@hexclave/shared 1.0.25 → 1.0.26

package/dist/interface/plan-usage.js

@@ -0,0 +1,39 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_chunk = require('../chunk-BE-pF4vm.js');
+let ___schema_fields_js = require("../schema-fields.js");
+let ___plans_js = require("../plans.js");
+
+//#region src/interface/plan-usage.ts
+const PLAN_IDS = Object.keys(___plans_js.PLAN_LIMITS);
+const UPGRADE_PLAN_IDS = PLAN_IDS.filter((id) => id !== "free");
+const planUsageKindSchema = (0, ___schema_fields_js.yupString)().oneOf([
+	"current",
+	"metered",
+	"capability"
+]).defined();
+const planUsageRowSchema = (0, ___schema_fields_js.yupObject)({
+	item_id: (0, ___schema_fields_js.yupString)().oneOf(Object.values(___plans_js.ITEM_IDS)).defined(),
+	display_name: (0, ___schema_fields_js.yupString)().defined(),
+	kind: planUsageKindSchema,
+	used: (0, ___schema_fields_js.yupNumber)().integer().nullable().defined(),
+	limit: (0, ___schema_fields_js.yupNumber)().integer().nullable().defined(),
+	remaining: (0, ___schema_fields_js.yupNumber)().integer().nullable().defined(),
+	overage: (0, ___schema_fields_js.yupNumber)().integer().nullable().defined(),
+	is_unlimited: (0, ___schema_fields_js.yupBoolean)().defined()
+}).defined();
+const planUsageResponseSchema = (0, ___schema_fields_js.yupObject)({
+	owner_team_id: (0, ___schema_fields_js.yupString)().uuid().defined(),
+	owner_team_display_name: (0, ___schema_fields_js.yupString)().defined(),
+	plan_id: (0, ___schema_fields_js.yupString)().oneOf(PLAN_IDS).defined(),
+	plan_display_name: (0, ___schema_fields_js.yupString)().defined(),
+	period_start_millis: (0, ___schema_fields_js.yupNumber)().integer().defined(),
+	period_end_millis: (0, ___schema_fields_js.yupNumber)().integer().defined(),
+	next_plan_id: (0, ___schema_fields_js.yupString)().oneOf(UPGRADE_PLAN_IDS).nullable().defined(),
+	rows: (0, ___schema_fields_js.yupArray)(planUsageRowSchema).defined()
+}).defined();
+
+//#endregion
+exports.planUsageKindSchema = planUsageKindSchema;
+exports.planUsageResponseSchema = planUsageResponseSchema;
+exports.planUsageRowSchema = planUsageRowSchema;
+//# sourceMappingURL=plan-usage.js.map

package/dist/interface/plan-usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan-usage.js","names":["PLAN_LIMITS","ITEM_IDS"],"sources":["../../src/interface/plan-usage.ts"],"sourcesContent":["import * as yup from \"yup\";\nimport { ITEM_IDS, PLAN_LIMITS } from \"../plans\";\nimport { yupArray, yupBoolean, yupNumber, yupObject, yupString } from \"../schema-fields\";\n\nconst PLAN_IDS = Object.keys(PLAN_LIMITS) as (keyof typeof PLAN_LIMITS)[];\nconst UPGRADE_PLAN_IDS = PLAN_IDS.filter((id): id is Exclude<keyof typeof PLAN_LIMITS, \"free\"> => id !== \"free\");\n\nexport const planUsageKindSchema = yupString().oneOf([\"current\", \"metered\", \"capability\"]).defined();\n\nexport const planUsageRowSchema = yupObject({\n  item_id: yupString().oneOf(Object.values(ITEM_IDS)).defined(),\n  display_name: yupString().defined(),\n  kind: planUsageKindSchema,\n  used: yupNumber().integer().nullable().defined(),\n  limit: yupNumber().integer().nullable().defined(),\n  remaining: yupNumber().integer().nullable().defined(),\n  overage: yupNumber().integer().nullable().defined(),\n  is_unlimited: yupBoolean().defined(),\n}).defined();\n\nexport const planUsageResponseSchema = yupObject({\n  owner_team_id: yupString().uuid().defined(),\n  owner_team_display_name: yupString().defined(),\n  plan_id: yupString().oneOf(PLAN_IDS).defined(),\n  plan_display_name: yupString().defined(),\n  period_start_millis: yupNumber().integer().defined(),\n  period_end_millis: yupNumber().integer().defined(),\n  next_plan_id: yupString().oneOf(UPGRADE_PLAN_IDS).nullable().defined(),\n  rows: yupArray(planUsageRowSchema).defined(),\n}).defined();\n\nexport type PlanUsageKind = yup.InferType<typeof planUsageKindSchema>;\nexport type PlanUsageRow = yup.InferType<typeof planUsageRowSchema>;\nexport type PlanUsageResponse = yup.InferType<typeof planUsageResponseSchema>;\n"],"mappings":";;;;;;AAIA,MAAM,WAAW,OAAO,KAAKA,wBAAY;AACzC,MAAM,mBAAmB,SAAS,QAAQ,OAAwD,OAAO,OAAO;AAEhH,MAAa,0DAAiC,CAAC,MAAM;CAAC;CAAW;CAAW;CAAa,CAAC,CAAC,SAAS;AAEpG,MAAa,wDAA+B;CAC1C,6CAAoB,CAAC,MAAM,OAAO,OAAOC,qBAAS,CAAC,CAAC,SAAS;CAC7D,kDAAyB,CAAC,SAAS;CACnC,MAAM;CACN,0CAAiB,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS;CAChD,2CAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS;CACjD,+CAAsB,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS;CACrD,6CAAoB,CAAC,SAAS,CAAC,UAAU,CAAC,SAAS;CACnD,mDAA0B,CAAC,SAAS;CACrC,CAAC,CAAC,SAAS;AAEZ,MAAa,6DAAoC;CAC/C,mDAA0B,CAAC,MAAM,CAAC,SAAS;CAC3C,6DAAoC,CAAC,SAAS;CAC9C,6CAAoB,CAAC,MAAM,SAAS,CAAC,SAAS;CAC9C,uDAA8B,CAAC,SAAS;CACxC,yDAAgC,CAAC,SAAS,CAAC,SAAS;CACpD,uDAA8B,CAAC,SAAS,CAAC,SAAS;CAClD,kDAAyB,CAAC,MAAM,iBAAiB,CAAC,UAAU,CAAC,SAAS;CACtE,wCAAe,mBAAmB,CAAC,SAAS;CAC7C,CAAC,CAAC,SAAS"}

package/dist/known-errors.d.ts

@@ -518,7 +518,7 @@ declare const KnownErrors: {
   CustomerDoesNotExist: KnownErrorConstructor<KnownError & KnownErrorBrand<"CUSTOMER_DOES_NOT_EXIST">, [customerId: string]> & {
     errorCode: "CUSTOMER_DOES_NOT_EXIST";
   };
-  ProductDoesNotExist: KnownErrorConstructor<KnownError & KnownErrorBrand<"PRODUCT_DOES_NOT_EXIST">, [productId: string, context: "server_only" | "item_exists" | null]> & {
+  ProductDoesNotExist: KnownErrorConstructor<KnownError & KnownErrorBrand<"PRODUCT_DOES_NOT_EXIST">, [productId: string, context: "item_exists" | "server_only" | null]> & {
     errorCode: "PRODUCT_DOES_NOT_EXIST";
   };
   ProductCustomerTypeDoesNotMatch: KnownErrorConstructor<KnownError & KnownErrorBrand<"PRODUCT_CUSTOMER_TYPE_DOES_NOT_MATCH">, [productId: string | undefined, customerId: string, productCustomerType: "team" | "user" | "custom" | undefined, actualCustomerType: "team" | "user" | "custom"]> & {

package/dist/schema-fields.d.ts

@@ -314,8 +314,8 @@ declare const inlineProductSchema: yup$1.ObjectSchema<{
     free_trial?: DayInterval | undefined;
   }>;
   included_items: Record<string, {
-    repeat?: "never" | DayInterval | undefined;
     quantity?: number | undefined;
+    repeat?: "never" | DayInterval | undefined;
     expires?: "never" | "when-purchase-expires" | "when-repeated" | undefined;
   }>;
   client_metadata: {} | null | undefined;

package/dist/sessions.d.ts

@@ -9,24 +9,24 @@ declare class AccessToken {
   private constructor();
   get payload(): {
     exp?: number | undefined;
+    project_id: string;
+    refresh_token_id: string;
+    email: string | null;
+    restricted_reason: {
+      type: "anonymous" | "email_not_verified" | "restricted_by_administrator";
+    } | null;
+    branch_id: string;
     sub: string;
     iat: number;
     iss: string;
     aud: string;
-    project_id: string;
-    branch_id: string;
-    refresh_token_id: string;
     role: "authenticated";
     name: string | null;
-    email: string | null;
     email_verified: boolean;
     selected_team_id: string | null;
     signed_up_at: number;
     is_anonymous: boolean;
     is_restricted: boolean;
-    restricted_reason: {
-      type: "anonymous" | "email_not_verified" | "restricted_by_administrator";
-    } | null;
     requires_totp_mfa: boolean;
   };
   get expiresAt(): Date;

package/dist/utils/passkey.d.ts

@@ -1,2 +1,2 @@
-import { a as RegistrationResponseJSON, i as PublicKeyCredentialRequestOptionsJSON, n as AuthenticatorAttestationResponseJSON, r as PublicKeyCredentialCreationOptionsJSON, t as AuthenticationResponseJSON } from "../index-fQbeILq7.js";
+import { a as RegistrationResponseJSON, i as PublicKeyCredentialRequestOptionsJSON, n as AuthenticatorAttestationResponseJSON, r as PublicKeyCredentialCreationOptionsJSON, t as AuthenticationResponseJSON } from "../index-nCRuFJTF.js";
 export { type AuthenticationResponseJSON, type AuthenticatorAttestationResponseJSON, type PublicKeyCredentialCreationOptionsJSON, type PublicKeyCredentialRequestOptionsJSON, type RegistrationResponseJSON };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hexclave/shared",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "repository": "https://github.com/hexclave/hexclave",
   "files": [
     "README.md",

package/src/config-authoring.ts

@@ -31,7 +31,9 @@ export function defineStackConfig(config: StrictStackConfig<StackConfig>): Stack
   return config;
 }
 
-// Hexclave alias — separate function so it does not inherit the deprecation tag.
+/**
+ * Defines a Hexclave project configuration as code. See the documentation at https://skill.hexclave.com for more information.
+ */
 export function defineHexclaveConfig(config: StrictStackConfig<HexclaveConfig>): HexclaveConfig {
   return config;
 }

package/src/interface/admin-interface.ts

@@ -6,6 +6,7 @@ import type { MoneyAmount } from "../utils/currency-constants";
 import type { Json } from "../utils/json";
 import { Result } from "../utils/results";
 import { urlString } from "../utils/urls";
+import type { PlanUsageResponse } from "./plan-usage";
 import type { AnalyticsClickmapDevice, AnalyticsClickmapKind, AnalyticsClickmapResponse, AnalyticsClickmapTokenResponse, MetricsResponse, MetricsUserCounts, UserActivityResponse } from "./admin-metrics";
 import type { AnalyticsQueryOptions, AnalyticsQueryResponse } from "./crud/analytics";
 import { EmailOutboxCrud } from "./crud/email-outbox";
@@ -27,6 +28,8 @@ import { TeamPermissionDefinitionsCrud } from "./crud/team-permissions";
 import type { Transaction, TransactionType } from "./crud/transactions";
 import { ServerAuthApplicationOptions, HexclaveServerInterface } from "./server-interface";
 
+export type { PlanUsageResponse } from "./plan-usage";
+
 type BranchConfigSourceApi = yup.InferType<typeof branchConfigSourceSchema>;
 
 export type ChatContent = Array<
@@ -424,6 +427,17 @@ export class HexclaveAdminInterface extends HexclaveServerInterface {
     };
   }
 
+  async getPlanUsage(): Promise<PlanUsageResponse> {
+    const response = await this.sendAdminRequest(
+      "/internal/plan-usage",
+      {
+        method: "GET",
+      },
+      null,
+    );
+    return await response.json();
+  }
+
   async getUserActivity(userId: string): Promise<UserActivityResponse> {
     const response = await this.sendAdminRequest(
       urlString`/internal/user-activity?user_id=${userId}`,

package/src/interface/plan-usage.ts

@@ -0,0 +1,34 @@
+import * as yup from "yup";
+import { ITEM_IDS, PLAN_LIMITS } from "../plans";
+import { yupArray, yupBoolean, yupNumber, yupObject, yupString } from "../schema-fields";
+
+const PLAN_IDS = Object.keys(PLAN_LIMITS) as (keyof typeof PLAN_LIMITS)[];
+const UPGRADE_PLAN_IDS = PLAN_IDS.filter((id): id is Exclude<keyof typeof PLAN_LIMITS, "free"> => id !== "free");
+
+export const planUsageKindSchema = yupString().oneOf(["current", "metered", "capability"]).defined();
+
+export const planUsageRowSchema = yupObject({
+  item_id: yupString().oneOf(Object.values(ITEM_IDS)).defined(),
+  display_name: yupString().defined(),
+  kind: planUsageKindSchema,
+  used: yupNumber().integer().nullable().defined(),
+  limit: yupNumber().integer().nullable().defined(),
+  remaining: yupNumber().integer().nullable().defined(),
+  overage: yupNumber().integer().nullable().defined(),
+  is_unlimited: yupBoolean().defined(),
+}).defined();
+
+export const planUsageResponseSchema = yupObject({
+  owner_team_id: yupString().uuid().defined(),
+  owner_team_display_name: yupString().defined(),
+  plan_id: yupString().oneOf(PLAN_IDS).defined(),
+  plan_display_name: yupString().defined(),
+  period_start_millis: yupNumber().integer().defined(),
+  period_end_millis: yupNumber().integer().defined(),
+  next_plan_id: yupString().oneOf(UPGRADE_PLAN_IDS).nullable().defined(),
+  rows: yupArray(planUsageRowSchema).defined(),
+}).defined();
+
+export type PlanUsageKind = yup.InferType<typeof planUsageKindSchema>;
+export type PlanUsageRow = yup.InferType<typeof planUsageRowSchema>;
+export type PlanUsageResponse = yup.InferType<typeof planUsageResponseSchema>;