@logto/cloud 0.2.5-adb5eaf → 0.2.5-af943a1

package/lib/routes/index.d.ts

@@ -104,30 +104,31 @@ declare const publicRegionNames: readonly [
 ];
 /** 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.
-	 */
+declare enum DatabaseRegionAccessRole {
+	/** Instance administrator - can manage collaborators and create tenants */
+	Admin = "admin",
+	/** Collaborator user - can only create tenants in the instance */
+	Collaborator = "collaborator"
+}
+declare const Regions: import("@withtyped/server/lib/model/index.js").default<"regions", {
+	createdAt: Date;
 	name: string;
-	/**
-	 * The country where the region is located.
-	 */
-	country: string;
-	/**
-	 * Indicates whether the region is private.
-	 */
 	isPrivate: boolean;
+	displayName: string;
+	country: string;
+	dbUrl: string;
+	redisUrl: string | null;
+	tags: TenantTag[];
+}, "createdAt" | "tags" | "isPrivate", "createdAt">;
+export type Region = InferModelType<typeof Regions>;
+export type AffiliateData = Affiliate & {
+	properties: Array<Pick<AffiliateProperty, "type" | "value">>;
+};
+export type RegionResponse = Pick<Region, "name" | "displayName" | "country" | "isPrivate" | "tags"> & {
 	/**
-	 * Tenant tags available for selection when creating tenants in this region.
+	 * @deprecated Temporary field for backward compatibility, will be removed in the future.
 	 */
-	tags: TenantTag[];
+	id: string;
 };
 export type WithAuthContext<Context = RequestContext> = Context & {
 	auth: {
@@ -137,9 +138,6 @@ export type WithAuthContext<Context = RequestContext> = Context & {
 		scopes: string[];
 	};
 };
-export type AffiliateData = Affiliate & {
-	properties: Array<Pick<AffiliateProperty, "type" | "value">>;
-};
 declare const router: import("@withtyped/server").Router<RequestContext, WithAuthContext<Omit<import("@withtyped/server").BaseContext & {
 	request: {
 		id?: string | undefined;
@@ -159,7 +157,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 		body?: Json | undefined;
 		bodyRaw?: Buffer | undefined;
 	};
-}>, import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").BaseRoutes, import("@withtyped/server").RoutesWithPrefix<{
+}>, import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").MergeRoutes<import("@withtyped/server").BaseRoutes, import("@withtyped/server").RoutesWithPrefix<{
 	patch: {
 		"/tenants/:tenantId": import("@withtyped/server").PathGuard<"/:tenantId", unknown, {
 			name?: string | undefined;
@@ -209,7 +207,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				subscriptionId: string | null;
 				hostedInvoiceUrl: string | null;
 				invoicePdf: string | null;
+				collectionMethod: "charge_automatically" | "send_invoice" | null;
+				dueDate: Date | null;
 			}[];
+			featureFlags?: {
+				isMultipleCustomDomainsEnabled?: boolean | undefined;
+			} | undefined;
 		}>;
 	};
 	options: {};
@@ -260,15 +263,20 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				subscriptionId: string | null;
 				hostedInvoiceUrl: string | null;
 				invoicePdf: string | null;
+				collectionMethod: "charge_automatically" | "send_invoice" | null;
+				dueDate: Date | null;
 			}[];
+			featureFlags?: {
+				isMultipleCustomDomainsEnabled?: boolean | undefined;
+			} | undefined;
 		}[]>;
 	};
 	post: {
 		"/tenants": import("@withtyped/server").PathGuard<"/", unknown, {
 			id?: string | undefined;
 			name?: string | undefined;
-			tag?: TenantTag | undefined;
 			regionName?: string | undefined;
+			tag?: TenantTag | undefined;
 		}, {
 			id: string;
 			name: string;
@@ -315,8 +323,23 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				subscriptionId: string | null;
 				hostedInvoiceUrl: string | null;
 				invoicePdf: string | null;
+				collectionMethod: "charge_automatically" | "send_invoice" | null;
+				dueDate: Date | null;
 			}[];
+			featureFlags?: {
+				isMultipleCustomDomainsEnabled?: boolean | undefined;
+			} | undefined;
 		}>;
+	} & {
+		"/tenants/subscriptions/plan": import("@withtyped/server").PathGuard<"/subscriptions/plan", unknown, {
+			planId: string;
+			tenantIds: string[];
+		}, {
+			tenantId: string;
+			success: boolean;
+			error?: string | undefined;
+			updatedLineItems?: unknown[] | undefined;
+		}[]>;
 	};
 	put: {};
 	delete: {
@@ -368,6 +391,26 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				total: number;
 				totalExcludingTax: number | null;
 			} | null | undefined;
+			systemLimit?: {
+				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;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				organizationsLimit?: number | null | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+				usersPerOrganizationLimit?: number | null | undefined;
+				organizationUserRolesLimit?: number | null | undefined;
+				organizationMachineToMachineRolesLimit?: number | null | undefined;
+				organizationScopesLimit?: number | null | undefined;
+			} | undefined;
 		}>;
 	} & {
 		"/tenants/my/subscription-usage": import("@withtyped/server").PathGuard<"/my/subscription-usage", unknown, unknown, {
@@ -626,6 +669,8 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				subscriptionId: string | null;
 				hostedInvoiceUrl: string | null;
 				invoicePdf: string | null;
+				collectionMethod: "charge_automatically" | "send_invoice" | null;
+				dueDate: Date | null;
 				planName: string | null;
 				skuId?: string | null | undefined;
 			}[];
@@ -707,6 +752,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 					link?: string | undefined;
 					code?: string | undefined;
 					locale?: string | undefined;
+					uiLocales?: string | undefined;
 				} & {
 					[k: string]: unknown;
 				} & {
@@ -726,6 +772,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 					code?: string | undefined;
 					link?: string | undefined;
 					locale?: string | undefined;
+					uiLocales?: string | undefined;
 				} & {
 					[k: string]: unknown;
 				};
@@ -811,7 +858,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	};
 	post: {
 		"/skus": import("@withtyped/server").PathGuard<"/", unknown, {
-			type: LogtoSkuType.AddOn;
+			type: LogtoSkuType;
 			quota: {
 				tokenLimit?: number | null | undefined;
 				machineToMachineLimit?: number | null | undefined;
@@ -839,46 +886,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				collectUserProfileEnabled?: boolean | undefined;
 				idpInitiatedSsoEnabled?: boolean | undefined;
 			};
-			isDefault?: boolean | undefined;
-		} | {
-			type: LogtoSkuType.Basic;
-			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;
-			};
-			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;
-			};
+			id?: string | undefined;
 			isDefault?: boolean | undefined;
 		}, {
 			id: string;
@@ -924,8 +932,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			productId: string;
 		}>;
 	} & {
-		"/skus/basic-sku-usage-add-on-relations": import("@withtyped/server").PathGuard<"/basic-sku-usage-add-on-relations", unknown, {
-			basicSkuId: string;
+		"/skus/:basicSkuId/usage-add-on-relations": import("@withtyped/server").PathGuard<"/:basicSkuId/usage-add-on-relations", unknown, {
 			usageKey: "tokenLimit" | "machineToMachineLimit" | "resourcesLimit" | "enterpriseSsoLimit" | "hooksLimit" | "tenantMembersLimit" | "mfaEnabled" | "organizationsEnabled" | "organizationsLimit" | "securityFeaturesEnabled" | "userRolesLimit" | "machineToMachineRolesLimit" | "thirdPartyApplicationsLimit" | "samlApplicationsLimit";
 			addOnSkuId: string;
 		}, {
@@ -938,7 +945,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	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>;
+		"/skus/:basicSkuId/usage-add-on-relations/:usageKey": import("@withtyped/server").PathGuard<"/:basicSkuId/usage-add-on-relations/:usageKey", unknown, unknown, unknown>;
 	};
 	copy: {};
 	head: {};
@@ -1088,8 +1095,9 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				id: string;
 				name: string;
 				country: string;
-				isPrivate: boolean;
+				displayName: string;
 				tags: TenantTag[];
+				isPrivate: boolean;
 			}[];
 		}>;
 	};
@@ -1100,6 +1108,216 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	};
 	copy: {};
 	head: {};
+}, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
+	patch: {
+		"/system-limits/:id": import("@withtyped/server").PathGuard<"/:id", unknown, {
+			limits: {
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				hooksLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				organizationsLimit?: number | null | undefined;
+				userRolesLimit?: number | null | undefined;
+				machineToMachineRolesLimit?: number | null | undefined;
+				thirdPartyApplicationsLimit?: number | null | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+				applicationsLimit?: number | null | undefined;
+				scopesPerResourceLimit?: number | null | undefined;
+				socialConnectorsLimit?: number | null | undefined;
+				scopesPerRoleLimit?: number | null | undefined;
+				usersPerOrganizationLimit?: number | null | undefined;
+				organizationUserRolesLimit?: number | null | undefined;
+				organizationMachineToMachineRolesLimit?: number | null | undefined;
+				organizationScopesLimit?: number | null | undefined;
+			};
+		}, {
+			id: string;
+			createdAt: Date;
+			updatedAt: Date;
+			limits: {
+				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;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				organizationsLimit?: number | null | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+				usersPerOrganizationLimit?: number | null | undefined;
+				organizationUserRolesLimit?: number | null | undefined;
+				organizationMachineToMachineRolesLimit?: number | null | undefined;
+				organizationScopesLimit?: number | null | undefined;
+			};
+		}>;
+	};
+	options: {};
+	get: {
+		"/system-limits": import("@withtyped/server").PathGuard<"/", {
+			basicSkuId?: string | undefined;
+		}, unknown, {
+			id: string;
+			createdAt: Date;
+			updatedAt: Date;
+			limits: {
+				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;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				organizationsLimit?: number | null | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+				usersPerOrganizationLimit?: number | null | undefined;
+				organizationUserRolesLimit?: number | null | undefined;
+				organizationMachineToMachineRolesLimit?: number | null | undefined;
+				organizationScopesLimit?: number | null | undefined;
+			};
+			basicSkuIds: string[];
+		}[]>;
+	} & {
+		"/system-limits/:id": import("@withtyped/server").PathGuard<"/:id", unknown, unknown, {
+			id: string;
+			createdAt: Date;
+			updatedAt: Date;
+			limits: {
+				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;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				organizationsLimit?: number | null | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+				usersPerOrganizationLimit?: number | null | undefined;
+				organizationUserRolesLimit?: number | null | undefined;
+				organizationMachineToMachineRolesLimit?: number | null | undefined;
+				organizationScopesLimit?: number | null | undefined;
+			};
+			basicSkuIds: string[];
+		}>;
+	};
+	post: {
+		"/system-limits": import("@withtyped/server").PathGuard<"/", unknown, {
+			limits: {
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				hooksLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				organizationsLimit?: number | null | undefined;
+				userRolesLimit?: number | null | undefined;
+				machineToMachineRolesLimit?: number | null | undefined;
+				thirdPartyApplicationsLimit?: number | null | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+				applicationsLimit?: number | null | undefined;
+				scopesPerResourceLimit?: number | null | undefined;
+				socialConnectorsLimit?: number | null | undefined;
+				scopesPerRoleLimit?: number | null | undefined;
+				usersPerOrganizationLimit?: number | null | undefined;
+				organizationUserRolesLimit?: number | null | undefined;
+				organizationMachineToMachineRolesLimit?: number | null | undefined;
+				organizationScopesLimit?: number | null | undefined;
+			};
+			id?: string | undefined;
+		}, {
+			id: string;
+			createdAt: Date;
+			updatedAt: Date;
+			limits: {
+				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;
+				machineToMachineLimit?: number | null | undefined;
+				resourcesLimit?: number | null | undefined;
+				enterpriseSsoLimit?: number | null | undefined;
+				tenantMembersLimit?: number | null | undefined;
+				organizationsLimit?: number | null | undefined;
+				samlApplicationsLimit?: number | null | undefined;
+				usersPerOrganizationLimit?: number | null | undefined;
+				organizationUserRolesLimit?: number | null | undefined;
+				organizationMachineToMachineRolesLimit?: number | null | undefined;
+				organizationScopesLimit?: number | null | undefined;
+			};
+		}>;
+	} & {
+		"/system-limits/:systemLimitId/basic-sku-relations": import("@withtyped/server").PathGuard<"/:systemLimitId/basic-sku-relations", unknown, {
+			basicSkuIds: string[];
+		}, {
+			relations: {
+				createdAt: Date;
+				updatedAt: Date;
+				basicSkuId: string;
+				systemLimitId: string;
+			}[];
+		}>;
+	};
+	put: {};
+	delete: {
+		"/system-limits/:id": import("@withtyped/server").PathGuard<"/:id", unknown, unknown, unknown>;
+	} & {
+		"/system-limits/:systemLimitId/basic-sku-relations": import("@withtyped/server").PathGuard<"/:systemLimitId/basic-sku-relations", unknown, {
+			basicSkuIds: string[];
+		}, unknown>;
+	};
+	copy: {};
+	head: {};
+}, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
+	patch: {
+		"/regions/:regionName/users/:userId": import("@withtyped/server").PathGuard<"/:regionName/users/:userId", unknown, {
+			role: DatabaseRegionAccessRole;
+		}, {
+			role: DatabaseRegionAccessRole;
+			userId: string;
+		}>;
+	};
+	options: {};
+	get: {
+		"/regions/:regionName/users": import("@withtyped/server").PathGuard<"/:regionName/users", unknown, unknown, {
+			users: {
+				role: DatabaseRegionAccessRole;
+				userId: string;
+			}[];
+		}>;
+	};
+	post: {
+		"/regions/:regionName/users": import("@withtyped/server").PathGuard<"/:regionName/users", unknown, {
+			role: DatabaseRegionAccessRole;
+			userId: string;
+		}, {
+			role: DatabaseRegionAccessRole;
+			userId: string;
+		}>;
+	};
+	put: {};
+	delete: {
+		"/regions/:regionName/users/:userId": import("@withtyped/server").PathGuard<"/:regionName/users/:userId", unknown, unknown, unknown>;
+	};
+	copy: {};
+	head: {};
 }, "/api">>, "/api">;
 export declare const tenantAuthRouter: import("@withtyped/server").Router<RequestContext, import("@withtyped/server").WithBodyContext<import("@withtyped/server").BaseContext & {
 	request: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/cloud",
-  "version": "0.2.5-adb5eaf",
+  "version": "0.2.5-af943a1",
   "description": "Logto Cloud service.",
   "main": "build/index.js",
   "author": "Silverhand Inc. <contact@silverhand.io>",