@logto/cloud 0.2.5-50ff8fe → 0.2.5-590fbce

package/lib/routes/index.d.ts

@@ -3,21 +3,27 @@
 import { Json, JsonObject, RequestContext } from '@withtyped/server';
 import { InferModelType } from '@withtyped/server/model';
 
-export type WithAuthContext<Context = RequestContext> = Context & {
-	auth: {
-		/** The ID of the authenticated subject (`sub`). */
-		id: string;
-		/** The scopes that the subject has (`scope`). */
-		scopes: string[];
-	};
-};
-declare enum VerificationCodeType {
-	SignIn = "SignIn",
-	Register = "Register",
-	ForgotPassword = "ForgotPassword",
-	Generic = "Generic",
-	/** @deprecated Use `Generic` type template for sending test sms/email use case */
-	Test = "Test"
+declare const availableReportableUsageKeys: readonly [
+	"tokenLimit",
+	"machineToMachineLimit",
+	"resourcesLimit",
+	"enterpriseSsoLimit",
+	"hooksLimit",
+	"tenantMembersLimit",
+	"mfaEnabled",
+	"organizationsEnabled",
+	"organizationsLimit",
+	"securityFeaturesEnabled",
+	"userRolesLimit",
+	"machineToMachineRolesLimit",
+	"thirdPartyApplicationsLimit",
+	"samlApplicationsLimit"
+];
+export type ReportableUsageKey = (typeof availableReportableUsageKeys)[number];
+export type RealtimeReportableUsageKey = Exclude<ReportableUsageKey, "tokenLimit">;
+declare enum LogtoSkuType {
+	Basic = "Basic",
+	AddOn = "AddOn"
 }
 declare enum TemplateType {
 	/** The template for sending verification code when user is signing in. */
@@ -29,7 +35,13 @@ declare enum TemplateType {
 	/** The template for sending organization invitation. */
 	OrganizationInvitation = "OrganizationInvitation",
 	/** The template for generic usage. */
-	Generic = "Generic"
+	Generic = "Generic",
+	/** The template for validating user permission for sensitive operations. */
+	UserPermissionValidation = "UserPermissionValidation",
+	/** The template for binding a new identifier to an existing account. */
+	BindNewIdentifier = "BindNewIdentifier",
+	/** The template for sending MFA verification code. */
+	MfaVerification = "MfaVerification"
 }
 declare enum OrganizationInvitationStatus {
 	Pending = "Pending",
@@ -69,10 +81,6 @@ declare enum TenantRole {
 	/** Collaborator of the tenant, who has permissions to operate the tenant data, but not the tenant settings. */
 	Collaborator = "collaborator"
 }
-declare enum LogtoSkuType {
-	Basic = "Basic",
-	AddOn = "AddOn"
-}
 declare const AffiliateProperties: import("@withtyped/server/lib/model/index.js").default<"affiliate_properties", {
 	createdAt: Date;
 	affiliateId: string;
@@ -86,10 +94,47 @@ declare const Affiliates: import("@withtyped/server/lib/model/index.js").default
 	id: string;
 }, "id" | "createdAt", "id" | "createdAt">;
 export type Affiliate = InferModelType<typeof Affiliates>;
-declare enum RegionName {
-	EU = "EU",
-	US = "US"
-}
+declare const publicRegionNames: readonly [
+	"EU",
+	"US",
+	"AU",
+	"JP"
+];
+/** The type of region names for the public cloud. */
+export type PublicRegionName = (typeof publicRegionNames)[number];
+/**
+ * Data structure representing a Logto Cloud region.
+ */
+export type Region = {
+	/**
+	 * The unique identifier for the region.
+	 */
+	id: string;
+	/**
+	 * A human-readable name for the region.
+	 */
+	name: string;
+	/**
+	 * The country where the region is located.
+	 */
+	country: string;
+	/**
+	 * Indicates whether the region is private.
+	 */
+	isPrivate: boolean;
+	/**
+	 * Tenant tags available for selection when creating tenants in this region.
+	 */
+	tags: TenantTag[];
+};
+export type WithAuthContext<Context = RequestContext> = Context & {
+	auth: {
+		/** The ID of the authenticated subject (`sub`). */
+		id: string;
+		/** The scopes that the subject has (`scope`). */
+		scopes: string[];
+	};
+};
 export type AffiliateData = Affiliate & {
 	properties: Array<Pick<AffiliateProperty, "type" | "value">>;
 };
@@ -120,9 +165,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			id: string;
 			name: string;
 			createdAt: Date;
+			quota: {
+				mauLimit: number | null;
+				tokenLimit: number | null;
+			};
 			usage: {
 				activeUsers: number;
-				cost: number;
 				tokenUsage: number;
 			};
 			indicator: string;
@@ -133,6 +181,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				planId: string;
 				currentPeriodStart: Date;
 				currentPeriodEnd: Date;
+				isEnterprisePlan: boolean;
 				id?: string | undefined;
 				upcomingInvoice?: {
 					subtotal: number;
@@ -141,12 +190,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 					totalExcludingTax: number | null;
 				} | null | undefined;
 			};
-			regionName: RegionName;
+			regionName: string;
 			tag: TenantTag;
 			openInvoices: {
-				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
 				id: string;
 				createdAt: Date;
+				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
 				updatedAt: Date;
 				customerId: string | null;
 				billingReason: string | null;
@@ -154,6 +203,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				periodEnd: Date;
 				amountDue: number;
 				amountPaid: number;
+				basicSkuId: string | null;
 				subscriptionId: string | null;
 				hostedInvoiceUrl: string | null;
 				invoicePdf: string | null;
@@ -166,9 +216,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			id: string;
 			name: string;
 			createdAt: Date;
+			quota: {
+				mauLimit: number | null;
+				tokenLimit: number | null;
+			};
 			usage: {
 				activeUsers: number;
-				cost: number;
 				tokenUsage: number;
 			};
 			indicator: string;
@@ -179,6 +232,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				planId: string;
 				currentPeriodStart: Date;
 				currentPeriodEnd: Date;
+				isEnterprisePlan: boolean;
 				id?: string | undefined;
 				upcomingInvoice?: {
 					subtotal: number;
@@ -187,12 +241,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 					totalExcludingTax: number | null;
 				} | null | undefined;
 			};
-			regionName: RegionName;
+			regionName: string;
 			tag: TenantTag;
 			openInvoices: {
-				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
 				id: string;
 				createdAt: Date;
+				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
 				updatedAt: Date;
 				customerId: string | null;
 				billingReason: string | null;
@@ -200,6 +254,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				periodEnd: Date;
 				amountDue: number;
 				amountPaid: number;
+				basicSkuId: string | null;
 				subscriptionId: string | null;
 				hostedInvoiceUrl: string | null;
 				invoicePdf: string | null;
@@ -208,16 +263,20 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	};
 	post: {
 		"/tenants": import("@withtyped/server").PathGuard<"/", unknown, {
+			id?: string | undefined;
 			name?: string | undefined;
 			tag?: TenantTag | undefined;
-			regionName?: RegionName | undefined;
+			regionName?: string | undefined;
 		}, {
 			id: string;
 			name: string;
 			createdAt: Date;
+			quota: {
+				mauLimit: number | null;
+				tokenLimit: number | null;
+			};
 			usage: {
 				activeUsers: number;
-				cost: number;
 				tokenUsage: number;
 			};
 			indicator: string;
@@ -228,6 +287,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				planId: string;
 				currentPeriodStart: Date;
 				currentPeriodEnd: Date;
+				isEnterprisePlan: boolean;
 				id?: string | undefined;
 				upcomingInvoice?: {
 					subtotal: number;
@@ -236,12 +296,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 					totalExcludingTax: number | null;
 				} | null | undefined;
 			};
-			regionName: RegionName;
+			regionName: string;
 			tag: TenantTag;
 			openInvoices: {
-				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
 				id: string;
 				createdAt: Date;
+				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
 				updatedAt: Date;
 				customerId: string | null;
 				billingReason: string | null;
@@ -249,6 +309,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				periodEnd: Date;
 				amountDue: number;
 				amountPaid: number;
+				basicSkuId: string | null;
 				subscriptionId: string | null;
 				hostedInvoiceUrl: string | null;
 				invoicePdf: string | null;
@@ -267,9 +328,37 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	get: {
 		"/tenants/my/subscription": import("@withtyped/server").PathGuard<"/my/subscription", unknown, unknown, {
 			status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused";
+			quota: {
+				auditLogsRetentionDays: number | null;
+				mauLimit: number | null;
+				applicationsLimit: number | null;
+				thirdPartyApplicationsLimit: number | null;
+				scopesPerResourceLimit: number | null;
+				socialConnectorsLimit: number | null;
+				userRolesLimit: number | null;
+				machineToMachineRolesLimit: number | null;
+				scopesPerRoleLimit: number | null;
+				hooksLimit: number | null;
+				customJwtEnabled: boolean;
+				subjectTokenEnabled: boolean;
+				bringYourUiEnabled: boolean;
+				collectUserProfileEnabled: boolean;
+				tokenLimit: number | null;
+				machineToMachineLimit: number | null;
+				resourcesLimit: number | null;
+				enterpriseSsoLimit: number | null;
+				tenantMembersLimit: number | null;
+				mfaEnabled: boolean;
+				organizationsEnabled: boolean;
+				organizationsLimit: number | null;
+				securityFeaturesEnabled: boolean;
+				idpInitiatedSsoEnabled: boolean;
+				samlApplicationsLimit: number | null;
+			};
 			planId: string;
 			currentPeriodStart: Date;
 			currentPeriodEnd: Date;
+			isEnterprisePlan: boolean;
 			id?: string | undefined;
 			upcomingInvoice?: {
 				subtotal: number;
@@ -279,60 +368,110 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			} | null | undefined;
 		}>;
 	} & {
-		"/tenants/my/subscription/quota": import("@withtyped/server").PathGuard<"/my/subscription/quota", unknown, unknown, {
-			mauLimit: number | null;
-			tokenLimit: number | null;
-			applicationsLimit: number | null;
-			machineToMachineLimit: number | null;
-			resourcesLimit: number | null;
-			scopesPerResourceLimit: number | null;
-			socialConnectorsLimit: number | null;
-			machineToMachineRolesLimit: number | null;
-			scopesPerRoleLimit: number | null;
-			hooksLimit: number | null;
-			auditLogsRetentionDays: number | null;
-			mfaEnabled: boolean;
-			organizationsEnabled: boolean;
-			thirdPartyApplicationsLimit: number | null;
-			tenantMembersLimit: number | null;
-			customJwtEnabled: boolean;
-			subjectTokenEnabled: boolean;
-			bringYourUiEnabled: boolean;
-			userRolesLimit: number | null;
-			enterpriseSsoLimit: number | null;
+		"/tenants/my/subscription-usage": import("@withtyped/server").PathGuard<"/my/subscription-usage", unknown, unknown, {
+			usage: {
+				applicationsLimit: number;
+				thirdPartyApplicationsLimit: number;
+				scopesPerResourceLimit: number;
+				socialConnectorsLimit: number;
+				userRolesLimit: number;
+				machineToMachineRolesLimit: number;
+				scopesPerRoleLimit: number;
+				hooksLimit: number;
+				customJwtEnabled: boolean;
+				subjectTokenEnabled: boolean;
+				bringYourUiEnabled: boolean;
+				collectUserProfileEnabled: boolean;
+				machineToMachineLimit: number;
+				resourcesLimit: number;
+				enterpriseSsoLimit: number;
+				tenantMembersLimit: number;
+				mfaEnabled: boolean;
+				organizationsEnabled: boolean;
+				organizationsLimit: number;
+				securityFeaturesEnabled: boolean;
+				idpInitiatedSsoEnabled: boolean;
+				samlApplicationsLimit: number;
+			};
+			resources: Record<string, number>;
+			roles: Record<string, number>;
+			quota: {
+				auditLogsRetentionDays: number | null;
+				mauLimit: number | null;
+				applicationsLimit: number | null;
+				thirdPartyApplicationsLimit: number | null;
+				scopesPerResourceLimit: number | null;
+				socialConnectorsLimit: number | null;
+				userRolesLimit: number | null;
+				machineToMachineRolesLimit: number | null;
+				scopesPerRoleLimit: number | null;
+				hooksLimit: number | null;
+				customJwtEnabled: boolean;
+				subjectTokenEnabled: boolean;
+				bringYourUiEnabled: boolean;
+				collectUserProfileEnabled: boolean;
+				tokenLimit: number | null;
+				machineToMachineLimit: number | null;
+				resourcesLimit: number | null;
+				enterpriseSsoLimit: number | null;
+				tenantMembersLimit: number | null;
+				mfaEnabled: boolean;
+				organizationsEnabled: boolean;
+				organizationsLimit: number | null;
+				securityFeaturesEnabled: boolean;
+				idpInitiatedSsoEnabled: boolean;
+				samlApplicationsLimit: number | null;
+			};
+			basicQuota: {
+				auditLogsRetentionDays: number | null;
+				mauLimit: number | null;
+				applicationsLimit: number | null;
+				thirdPartyApplicationsLimit: number | null;
+				scopesPerResourceLimit: number | null;
+				socialConnectorsLimit: number | null;
+				userRolesLimit: number | null;
+				machineToMachineRolesLimit: number | null;
+				scopesPerRoleLimit: number | null;
+				hooksLimit: number | null;
+				customJwtEnabled: boolean;
+				subjectTokenEnabled: boolean;
+				bringYourUiEnabled: boolean;
+				collectUserProfileEnabled: boolean;
+				tokenLimit: number | null;
+				machineToMachineLimit: number | null;
+				resourcesLimit: number | null;
+				enterpriseSsoLimit: number | null;
+				tenantMembersLimit: number | null;
+				mfaEnabled: boolean;
+				organizationsEnabled: boolean;
+				organizationsLimit: number | null;
+				securityFeaturesEnabled: boolean;
+				idpInitiatedSsoEnabled: boolean;
+				samlApplicationsLimit: number | null;
+			};
 		}>;
-	} & {
-		"/tenants/my/subscription/usage": import("@withtyped/server").PathGuard<"/my/subscription/usage", unknown, unknown, {
-			mauLimit: number;
-			tokenLimit: number;
-			applicationsLimit: number;
-			machineToMachineLimit: number;
-			resourcesLimit: number;
-			scopesPerResourceLimit: number;
-			socialConnectorsLimit: number;
-			machineToMachineRolesLimit: number;
-			scopesPerRoleLimit: number;
-			hooksLimit: number;
-			mfaEnabled: boolean;
-			organizationsEnabled: boolean;
-			thirdPartyApplicationsLimit: number;
-			tenantMembersLimit: number;
-			customJwtEnabled: boolean;
-			subjectTokenEnabled: boolean;
-			bringYourUiEnabled: boolean;
-			userRolesLimit: number;
-			enterpriseSsoLimit: number;
+	};
+	post: {
+		"/tenants/my/subscription/item-updates": import("@withtyped/server").PathGuard<"/my/subscription/item-updates", unknown, {
+			usageKey: RealtimeReportableUsageKey;
+		}, {
+			message: string;
 		}>;
-	} & {
-		"/tenants/my/subscription/usage/:entityName/scopes": import("@withtyped/server").PathGuard<"/my/subscription/usage/:entityName/scopes", {
-			entityId?: string | undefined;
-		}, unknown, Record<string, number>>;
-	} & {
+	};
+	put: {};
+	delete: {};
+	copy: {};
+	head: {};
+}, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
+	patch: {};
+	options: {};
+	get: {
 		"/tenants/:tenantId/subscription": import("@withtyped/server").PathGuard<"/:tenantId/subscription", unknown, unknown, {
 			status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused";
 			planId: string;
 			currentPeriodStart: Date;
 			currentPeriodEnd: Date;
+			isEnterprisePlan: boolean;
 			id?: string | undefined;
 			upcomingInvoice?: {
 				subtotal: number;
@@ -342,60 +481,138 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			} | null | undefined;
 		}>;
 	} & {
-		"/tenants/:tenantId/subscription/quota": import("@withtyped/server").PathGuard<"/:tenantId/subscription/quota", unknown, unknown, {
-			mauLimit: number | null;
-			tokenLimit: number | null;
-			applicationsLimit: number | null;
-			machineToMachineLimit: number | null;
-			resourcesLimit: number | null;
-			scopesPerResourceLimit: number | null;
-			socialConnectorsLimit: number | null;
-			machineToMachineRolesLimit: number | null;
-			scopesPerRoleLimit: number | null;
-			hooksLimit: number | null;
-			auditLogsRetentionDays: number | null;
-			mfaEnabled: boolean;
-			organizationsEnabled: boolean;
-			thirdPartyApplicationsLimit: number | null;
-			tenantMembersLimit: number | null;
-			customJwtEnabled: boolean;
-			subjectTokenEnabled: boolean;
-			bringYourUiEnabled: boolean;
-			userRolesLimit: number | null;
-			enterpriseSsoLimit: number | null;
+		"/tenants/:tenantId/subscription-usage": import("@withtyped/server").PathGuard<"/:tenantId/subscription-usage", unknown, unknown, {
+			usage: {
+				applicationsLimit: number;
+				thirdPartyApplicationsLimit: number;
+				scopesPerResourceLimit: number;
+				socialConnectorsLimit: number;
+				userRolesLimit: number;
+				machineToMachineRolesLimit: number;
+				scopesPerRoleLimit: number;
+				hooksLimit: number;
+				customJwtEnabled: boolean;
+				subjectTokenEnabled: boolean;
+				bringYourUiEnabled: boolean;
+				collectUserProfileEnabled: boolean;
+				machineToMachineLimit: number;
+				resourcesLimit: number;
+				enterpriseSsoLimit: number;
+				tenantMembersLimit: number;
+				mfaEnabled: boolean;
+				organizationsEnabled: boolean;
+				organizationsLimit: number;
+				securityFeaturesEnabled: boolean;
+				idpInitiatedSsoEnabled: boolean;
+				samlApplicationsLimit: number;
+			};
+			resources: Record<string, number>;
+			roles: Record<string, number>;
+			quota: {
+				auditLogsRetentionDays: number | null;
+				mauLimit: number | null;
+				applicationsLimit: number | null;
+				thirdPartyApplicationsLimit: number | null;
+				scopesPerResourceLimit: number | null;
+				socialConnectorsLimit: number | null;
+				userRolesLimit: number | null;
+				machineToMachineRolesLimit: number | null;
+				scopesPerRoleLimit: number | null;
+				hooksLimit: number | null;
+				customJwtEnabled: boolean;
+				subjectTokenEnabled: boolean;
+				bringYourUiEnabled: boolean;
+				collectUserProfileEnabled: boolean;
+				tokenLimit: number | null;
+				machineToMachineLimit: number | null;
+				resourcesLimit: number | null;
+				enterpriseSsoLimit: number | null;
+				tenantMembersLimit: number | null;
+				mfaEnabled: boolean;
+				organizationsEnabled: boolean;
+				organizationsLimit: number | null;
+				securityFeaturesEnabled: boolean;
+				idpInitiatedSsoEnabled: boolean;
+				samlApplicationsLimit: number | null;
+			};
+			basicQuota: {
+				auditLogsRetentionDays: number | null;
+				mauLimit: number | null;
+				applicationsLimit: number | null;
+				thirdPartyApplicationsLimit: number | null;
+				scopesPerResourceLimit: number | null;
+				socialConnectorsLimit: number | null;
+				userRolesLimit: number | null;
+				machineToMachineRolesLimit: number | null;
+				scopesPerRoleLimit: number | null;
+				hooksLimit: number | null;
+				customJwtEnabled: boolean;
+				subjectTokenEnabled: boolean;
+				bringYourUiEnabled: boolean;
+				collectUserProfileEnabled: boolean;
+				tokenLimit: number | null;
+				machineToMachineLimit: number | null;
+				resourcesLimit: number | null;
+				enterpriseSsoLimit: number | null;
+				tenantMembersLimit: number | null;
+				mfaEnabled: boolean;
+				organizationsEnabled: boolean;
+				organizationsLimit: number | null;
+				securityFeaturesEnabled: boolean;
+				idpInitiatedSsoEnabled: boolean;
+				samlApplicationsLimit: number | null;
+			};
 		}>;
 	} & {
-		"/tenants/:tenantId/subscription/usage": import("@withtyped/server").PathGuard<"/:tenantId/subscription/usage", unknown, unknown, {
+		"/tenants/:tenantId/subscription/periodic-usage": import("@withtyped/server").PathGuard<"/:tenantId/subscription/periodic-usage", unknown, unknown, {
 			mauLimit: number;
 			tokenLimit: number;
-			applicationsLimit: number;
-			machineToMachineLimit: number;
-			resourcesLimit: number;
-			scopesPerResourceLimit: number;
-			socialConnectorsLimit: number;
-			machineToMachineRolesLimit: number;
-			scopesPerRoleLimit: number;
-			hooksLimit: number;
-			mfaEnabled: boolean;
-			organizationsEnabled: boolean;
-			thirdPartyApplicationsLimit: number;
-			tenantMembersLimit: number;
-			customJwtEnabled: boolean;
-			subjectTokenEnabled: boolean;
-			bringYourUiEnabled: boolean;
-			userRolesLimit: number;
-			enterpriseSsoLimit: number;
 		}>;
 	} & {
-		"/tenants/:tenantId/subscription/usage/:entityName/scopes": import("@withtyped/server").PathGuard<"/:tenantId/subscription/usage/:entityName/scopes", {
-			entityId?: string | undefined;
-		}, unknown, Record<string, number>>;
+		"/tenants/:tenantId/subscription/add-on-skus": import("@withtyped/server").PathGuard<"/:tenantId/subscription/add-on-skus", unknown, unknown, Partial<Record<"tokenLimit" | "machineToMachineLimit" | "resourcesLimit" | "enterpriseSsoLimit" | "hooksLimit" | "tenantMembersLimit" | "mfaEnabled" | "organizationsEnabled" | "organizationsLimit" | "securityFeaturesEnabled" | "userRolesLimit" | "machineToMachineRolesLimit" | "thirdPartyApplicationsLimit" | "samlApplicationsLimit", {
+			id: string;
+			name: string | null;
+			createdAt: Date;
+			defaultPriceId: string | null;
+			unitPrice: number | null;
+			type: LogtoSkuType;
+			quota: {
+				auditLogsRetentionDays?: number | null | undefined;
+				mauLimit?: number | null | undefined;
+				applicationsLimit?: number | null | undefined;
+				thirdPartyApplicationsLimit?: number | null | undefined;
+				scopesPerResourceLimit?: number | null | undefined;
+				socialConnectorsLimit?: number | null | undefined;
+				userRolesLimit?: number | null | undefined;
+				machineToMachineRolesLimit?: number | null | undefined;
+				scopesPerRoleLimit?: number | null | undefined;
+				hooksLimit?: number | null | undefined;
+				customJwtEnabled?: boolean | undefined;
+				subjectTokenEnabled?: boolean | undefined;
+				bringYourUiEnabled?: boolean | undefined;
+				collectUserProfileEnabled?: boolean | undefined;
+				tokenLimit?: number | null | undefined;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				mfaEnabled?: boolean | undefined;
+				organizationsEnabled?: boolean | undefined;
+				organizationsLimit?: number | null | undefined;
+				securityFeaturesEnabled?: boolean | undefined;
+				idpInitiatedSsoEnabled?: boolean | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+			};
+			isDefault: boolean;
+			updatedAt: Date;
+			productId: string | null;
+		}>>>;
 	} & {
 		"/tenants/:tenantId/invoices": import("@withtyped/server").PathGuard<"/:tenantId/invoices", unknown, unknown, {
 			invoices: {
-				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
 				id: string;
 				createdAt: Date;
+				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
 				updatedAt: Date;
 				customerId: string | null;
 				billingReason: string | null;
@@ -403,6 +620,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				periodEnd: Date;
 				amountDue: number;
 				amountPaid: number;
+				basicSkuId: string | null;
 				subscriptionId: string | null;
 				hostedInvoiceUrl: string | null;
 				invoicePdf: string | null;
@@ -410,24 +628,53 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				skuId?: string | null | undefined;
 			}[];
 		}>;
+	} & {
+		"/tenants/:tenantId/available-skus": import("@withtyped/server").PathGuard<"/:tenantId/available-skus", {
+			type?: LogtoSkuType | undefined;
+		}, unknown, {
+			id: string;
+			name: string | null;
+			createdAt: Date;
+			defaultPriceId: string | null;
+			unitPrice: number | null;
+			type: LogtoSkuType;
+			quota: {
+				auditLogsRetentionDays?: number | null | undefined;
+				mauLimit?: number | null | undefined;
+				applicationsLimit?: number | null | undefined;
+				thirdPartyApplicationsLimit?: number | null | undefined;
+				scopesPerResourceLimit?: number | null | undefined;
+				socialConnectorsLimit?: number | null | undefined;
+				userRolesLimit?: number | null | undefined;
+				machineToMachineRolesLimit?: number | null | undefined;
+				scopesPerRoleLimit?: number | null | undefined;
+				hooksLimit?: number | null | undefined;
+				customJwtEnabled?: boolean | undefined;
+				subjectTokenEnabled?: boolean | undefined;
+				bringYourUiEnabled?: boolean | undefined;
+				collectUserProfileEnabled?: boolean | undefined;
+				tokenLimit?: number | null | undefined;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				mfaEnabled?: boolean | undefined;
+				organizationsEnabled?: boolean | undefined;
+				organizationsLimit?: number | null | undefined;
+				securityFeaturesEnabled?: boolean | undefined;
+				idpInitiatedSsoEnabled?: boolean | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+			};
+			isDefault: boolean;
+			updatedAt: Date;
+			productId: string | null;
+		}[]>;
 	} & {
 		"/tenants/:tenantId/invoices/:invoiceId/hosted-invoice-url": import("@withtyped/server").PathGuard<"/:tenantId/invoices/:invoiceId/hosted-invoice-url", unknown, unknown, {
 			hostedInvoiceUrl: string;
 		}>;
-	} & {
-		"/tenants/:tenantId/usage": import("@withtyped/server").PathGuard<"/:tenantId/usage", unknown, unknown, {
-			activeUsers: number;
-			cost: number;
-			tokenUsage: number;
-		}>;
 	};
 	post: {
-		"/tenants/my/subscription/item-updates": import("@withtyped/server").PathGuard<"/my/subscription/item-updates", unknown, {
-			usageKey: "tokenLimit" | "machineToMachineLimit" | "resourcesLimit" | "enterpriseSsoLimit" | "tenantMembersLimit" | "mfaEnabled" | "organizationsEnabled";
-		}, {
-			message: string;
-		}>;
-	} & {
 		"/tenants/:tenantId/stripe-customer-portal": import("@withtyped/server").PathGuard<"/:tenantId/stripe-customer-portal", unknown, {
 			callbackUrl?: string | undefined;
 		}, {
@@ -453,11 +700,14 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	post: {
 		"/services/mails": import("@withtyped/server").PathGuard<"/mails", unknown, {
 			data: {
-				type: TemplateType | VerificationCodeType;
+				type: TemplateType;
 				payload: {
-					code?: string | undefined;
 					link?: string | undefined;
-				} & Record<string, string> & {
+					code?: string | undefined;
+					locale?: string | undefined;
+				} & {
+					[k: string]: unknown;
+				} & {
 					senderName?: string | undefined;
 					companyInformation?: string | undefined;
 					appLogo?: string | undefined;
@@ -468,27 +718,30 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	} & {
 		"/services/send-sms": import("@withtyped/server").PathGuard<"/send-sms", unknown, {
 			data: {
-				type: TemplateType | VerificationCodeType;
+				type: TemplateType;
 				to: string;
 				payload: {
 					code?: string | undefined;
 					link?: string | undefined;
-				} & Record<string, string>;
+					locale?: string | undefined;
+				} & {
+					[k: string]: unknown;
+				};
 			};
 		}, unknown>;
 	} & {
 		"/services/custom-jwt": import("@withtyped/server").PathGuard<"/custom-jwt", {
 			isTest?: string | undefined;
 		}, {
+			token: Record<string, Json>;
 			context: Record<string, Json>;
-			script: string;
 			tokenType: LogtoJwtTokenKeyType.AccessToken;
-			token: Record<string, Json>;
+			script: string;
 			environmentVariables?: Record<string, string> | undefined;
 		} | {
-			script: string;
-			tokenType: LogtoJwtTokenKeyType.ClientCredentials;
 			token: Record<string, Json>;
+			tokenType: LogtoJwtTokenKeyType.ClientCredentials;
+			script: string;
 			environmentVariables?: Record<string, string> | undefined;
 		}, Record<string, unknown>>;
 	};
@@ -513,96 +766,178 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	patch: {};
 	options: {};
 	get: {
-		"/subscription-plans": import("@withtyped/server").PathGuard<"/", unknown, unknown, {
+		"/skus": import("@withtyped/server").PathGuard<"/", {
+			type?: LogtoSkuType | undefined;
+		}, unknown, {
 			id: string;
+			name: string | null;
 			createdAt: Date;
-			name: string;
+			defaultPriceId: string | null;
+			unitPrice: number | null;
+			type: LogtoSkuType;
+			quota: {
+				auditLogsRetentionDays?: number | null | undefined;
+				mauLimit?: number | null | undefined;
+				applicationsLimit?: number | null | undefined;
+				thirdPartyApplicationsLimit?: number | null | undefined;
+				scopesPerResourceLimit?: number | null | undefined;
+				socialConnectorsLimit?: number | null | undefined;
+				userRolesLimit?: number | null | undefined;
+				machineToMachineRolesLimit?: number | null | undefined;
+				scopesPerRoleLimit?: number | null | undefined;
+				hooksLimit?: number | null | undefined;
+				customJwtEnabled?: boolean | undefined;
+				subjectTokenEnabled?: boolean | undefined;
+				bringYourUiEnabled?: boolean | undefined;
+				collectUserProfileEnabled?: boolean | undefined;
+				tokenLimit?: number | null | undefined;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				mfaEnabled?: boolean | undefined;
+				organizationsEnabled?: boolean | undefined;
+				organizationsLimit?: number | null | undefined;
+				securityFeaturesEnabled?: boolean | undefined;
+				idpInitiatedSsoEnabled?: boolean | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+			};
+			isDefault: boolean;
 			updatedAt: Date;
+			productId: string | null;
+		}[]>;
+	};
+	post: {
+		"/skus": import("@withtyped/server").PathGuard<"/", unknown, {
+			type: LogtoSkuType.AddOn;
+			quota: {
+				tokenLimit?: number | null | undefined;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				hooksLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				mfaEnabled?: boolean | undefined;
+				organizationsEnabled?: boolean | undefined;
+				organizationsLimit?: number | null | undefined;
+				securityFeaturesEnabled?: boolean | undefined;
+				userRolesLimit?: number | null | undefined;
+				machineToMachineRolesLimit?: number | null | undefined;
+				thirdPartyApplicationsLimit?: number | null | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+				auditLogsRetentionDays?: number | null | undefined;
+				mauLimit?: number | null | undefined;
+				applicationsLimit?: number | null | undefined;
+				scopesPerResourceLimit?: number | null | undefined;
+				socialConnectorsLimit?: number | null | undefined;
+				scopesPerRoleLimit?: number | null | undefined;
+				customJwtEnabled?: boolean | undefined;
+				subjectTokenEnabled?: boolean | undefined;
+				bringYourUiEnabled?: boolean | undefined;
+				collectUserProfileEnabled?: boolean | undefined;
+				idpInitiatedSsoEnabled?: boolean | undefined;
+			};
+			isDefault?: boolean | undefined;
+		} | {
+			type: LogtoSkuType.Basic;
 			quota: {
+				auditLogsRetentionDays: number | null;
 				mauLimit: number | null;
-				tokenLimit: number | null;
 				applicationsLimit: number | null;
-				machineToMachineLimit: number | null;
-				resourcesLimit: number | null;
+				thirdPartyApplicationsLimit: number | null;
 				scopesPerResourceLimit: number | null;
-				customDomainEnabled: boolean;
-				omniSignInEnabled: boolean;
-				builtInEmailConnectorEnabled: boolean;
 				socialConnectorsLimit: number | null;
-				standardConnectorsLimit: number | null;
-				rolesLimit: number | null;
+				userRolesLimit: number | null;
 				machineToMachineRolesLimit: number | null;
 				scopesPerRoleLimit: number | null;
 				hooksLimit: number | null;
-				auditLogsRetentionDays: number | null;
-				mfaEnabled: boolean;
-				organizationsEnabled: boolean;
-				ssoEnabled: boolean;
-				thirdPartyApplicationsLimit: number | null;
-				tenantMembersLimit: number | null;
 				customJwtEnabled: boolean;
 				subjectTokenEnabled: boolean;
 				bringYourUiEnabled: boolean;
+				collectUserProfileEnabled: boolean;
+				tokenLimit: number | null;
+				machineToMachineLimit: number | null;
+				resourcesLimit: number | null;
+				enterpriseSsoLimit: number | null;
+				tenantMembersLimit: number | null;
+				mfaEnabled: boolean;
+				organizationsEnabled: boolean;
+				organizationsLimit: number | null;
+				securityFeaturesEnabled: boolean;
+				idpInitiatedSsoEnabled: boolean;
+				samlApplicationsLimit: number | null;
 			};
-			stripeProducts: {
-				type: "flat" | "tier1" | "tier2" | "tier3";
-				id: string;
-				name: string;
-				price: {
-					id: string;
-					unitAmountDecimal: string;
-					quantity?: 1 | undefined;
-					unitAmount?: number | null | undefined;
-				};
-				description?: string | undefined;
-			}[];
-		}[]>;
-	};
-	post: {};
-	put: {};
-	delete: {};
-	copy: {};
-	head: {};
-}, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
-	patch: {};
-	options: {};
-	get: {
-		"/skus": import("@withtyped/server").PathGuard<"/", {
-			type?: LogtoSkuType | undefined;
-		}, unknown, {
-			type: LogtoSkuType;
+			addOnRelations: {
+				tokenLimit?: string | undefined;
+				machineToMachineLimit?: string | undefined;
+				resourcesLimit?: string | undefined;
+				enterpriseSsoLimit?: string | undefined;
+				tenantMembersLimit?: string | undefined;
+				mfaEnabled?: string | undefined;
+				organizationsLimit?: string | undefined;
+				securityFeaturesEnabled?: string | undefined;
+			};
+			isDefault?: boolean | undefined;
+		}, {
 			id: string;
-			name: string | null;
+			createdAt: Date;
+			type: LogtoSkuType;
+			isDefault: boolean;
+			updatedAt: Date;
 			quota: {
+				auditLogsRetentionDays?: number | null | undefined;
 				mauLimit?: number | null | undefined;
-				tokenLimit?: number | null | undefined;
 				applicationsLimit?: number | null | undefined;
-				machineToMachineLimit?: number | null | undefined;
-				resourcesLimit?: number | null | undefined;
+				thirdPartyApplicationsLimit?: number | null | undefined;
 				scopesPerResourceLimit?: number | null | undefined;
 				socialConnectorsLimit?: number | null | undefined;
+				userRolesLimit?: number | null | undefined;
 				machineToMachineRolesLimit?: number | null | undefined;
 				scopesPerRoleLimit?: number | null | undefined;
 				hooksLimit?: number | null | undefined;
-				auditLogsRetentionDays?: number | null | undefined;
-				mfaEnabled?: boolean | undefined;
-				organizationsEnabled?: boolean | undefined;
-				thirdPartyApplicationsLimit?: number | null | undefined;
-				tenantMembersLimit?: number | null | undefined;
 				customJwtEnabled?: boolean | undefined;
 				subjectTokenEnabled?: boolean | undefined;
 				bringYourUiEnabled?: boolean | undefined;
-				userRolesLimit?: number | null | undefined;
+				collectUserProfileEnabled?: boolean | undefined;
+				tokenLimit?: number | null | undefined;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
 				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				mfaEnabled?: boolean | undefined;
+				organizationsEnabled?: boolean | undefined;
+				organizationsLimit?: number | null | undefined;
+				securityFeaturesEnabled?: boolean | undefined;
+				idpInitiatedSsoEnabled?: boolean | undefined;
+				samlApplicationsLimit?: number | null | undefined;
 			};
-			createdAt: Date;
-			updatedAt: Date;
-			unitPrice: number | null;
-		}[]>;
+		}>;
+	} & {
+		"/skus/:skuId/products": import("@withtyped/server").PathGuard<"/:skuId/products", {
+			isOneTime?: string | undefined;
+		}, {
+			name: string;
+			unitPrice: number;
+		}, {
+			productId: string;
+		}>;
+	} & {
+		"/skus/basic-sku-usage-add-on-relations": import("@withtyped/server").PathGuard<"/basic-sku-usage-add-on-relations", unknown, {
+			basicSkuId: string;
+			usageKey: "tokenLimit" | "machineToMachineLimit" | "resourcesLimit" | "enterpriseSsoLimit" | "hooksLimit" | "tenantMembersLimit" | "mfaEnabled" | "organizationsEnabled" | "organizationsLimit" | "securityFeaturesEnabled" | "userRolesLimit" | "machineToMachineRolesLimit" | "thirdPartyApplicationsLimit" | "samlApplicationsLimit";
+			addOnSkuId: string;
+		}, {
+			basicSkuId: string;
+			usageKey: "tokenLimit" | "machineToMachineLimit" | "resourcesLimit" | "enterpriseSsoLimit" | "hooksLimit" | "tenantMembersLimit" | "mfaEnabled" | "organizationsEnabled" | "organizationsLimit" | "securityFeaturesEnabled" | "userRolesLimit" | "machineToMachineRolesLimit" | "thirdPartyApplicationsLimit" | "samlApplicationsLimit";
+			addOnSkuId: string;
+		}>;
 	};
-	post: {};
 	put: {};
-	delete: {};
+	delete: {
+		"/skus/:skuId": import("@withtyped/server").PathGuard<"/:skuId", unknown, unknown, unknown>;
+	} & {
+		"/skus/basic-sku-usage-add-on-relations/:basicSkuId/:usageKey": import("@withtyped/server").PathGuard<"/basic-sku-usage-add-on-relations/:basicSkuId/:usageKey", unknown, unknown, unknown>;
+	};
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
@@ -616,19 +951,18 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			status: "open" | "complete" | "expired";
 			tenantId: string | null;
 			updatedAt: Date;
-			planId: string;
 			skuId: string | null;
+			planId: string | null;
 		}>;
 	};
 	post: {
 		"/checkout-session": import("@withtyped/server").PathGuard<"/", unknown, {
-			planId: string;
 			successCallbackUrl: string;
 			tenantId?: string | undefined;
 			skuId?: string | undefined;
 			tenantName?: string | undefined;
 			tenantTag?: TenantTag | undefined;
-			tenantRegionName?: RegionName | undefined;
+			tenantRegionName?: string | undefined;
 			cancelCallbackUrl?: string | undefined;
 		}, {
 			sessionId: string;
@@ -746,7 +1080,17 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
 	patch: {};
 	options: {};
-	get: {};
+	get: {
+		"/me/regions": import("@withtyped/server").PathGuard<"/regions", unknown, unknown, {
+			regions: {
+				id: string;
+				name: string;
+				country: string;
+				isPrivate: boolean;
+				tags: TenantTag[];
+			}[];
+		}>;
+	};
 	post: {};
 	put: {};
 	delete: {
@@ -813,7 +1157,7 @@ export declare const tenantAuthRouter: import("@withtyped/server").Router<Reques
 	};
 	post: {
 		"/:tenantId/invitations": import("@withtyped/server").PathGuard<"/:tenantId/invitations", unknown, {
-			invitee: string;
+			invitee: string | string[];
 			roleName: TenantRole;
 			expiresAt?: number | undefined;
 		}, {
@@ -828,7 +1172,19 @@ export declare const tenantAuthRouter: import("@withtyped/server").Router<Reques
 			organizationId: string;
 			expiresAt: number;
 			organizationRoles: OrganizationRoleEntity[];
-		}>;
+		} | {
+			id: string;
+			createdAt: number;
+			status: OrganizationInvitationStatus;
+			tenantId: string;
+			updatedAt: number;
+			inviterId: string | null;
+			invitee: string;
+			acceptedUserId: string | null;
+			organizationId: string;
+			expiresAt: number;
+			organizationRoles: OrganizationRoleEntity[];
+		}[]>;
 	} & {
 		"/:tenantId/invitations/:invitationId/message": import("@withtyped/server").PathGuard<"/:tenantId/invitations/:invitationId/message", unknown, unknown, unknown>;
 	};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/cloud",
-  "version": "0.2.5-50ff8fe",
+  "version": "0.2.5-590fbce",
   "description": "Logto Cloud service.",
   "main": "build/index.js",
   "author": "Silverhand Inc. <contact@silverhand.io>",
@@ -21,7 +21,7 @@
     "@types/accepts": "^1.3.5",
     "@types/http-proxy": "^1.17.9",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^20.0.0",
+    "@types/node": "^22.14.0",
     "@types/yargs": "^17.0.24",
     "dts-bundle-generator": "^9.3.1",
     "eslint": "^8.57.0",
@@ -29,11 +29,11 @@
     "nodemon": "^3.0.0",
     "prettier": "^3.0.0",
     "typescript": "^5.3.3",
-    "vite-tsconfig-paths": "^4.3.1",
-    "vitest": "^2.0.0"
+    "vite-tsconfig-paths": "^5.0.0",
+    "vitest": "^3.1.1"
   },
   "engines": {
-    "node": "^20.9.0"
+    "node": "^22.14.0"
   },
   "eslintConfig": {
     "extends": "@silverhand",
@@ -49,8 +49,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@silverhand/essentials": "^2.9.1",
-    "@withtyped/server": "^0.13.6"
+    "@silverhand/essentials": "^2.9.2",
+    "@withtyped/server": "^0.14.0"
   },
   "scripts": {
     "precommit": "lint-staged",
@@ -63,6 +63,7 @@
     "start": "NODE_ENV=production node .",
     "test": "vitest && pnpm build:lib && pnpm test:types",
     "test:types": "tsc -p tsconfig.test.types.json",
+    "test:only": "vitest",
     "cli": "node ./build/cli/index.js"
   }
 }