@logto/cloud 0.2.5-a21a38a → 0.2.5-a7eedce

package/lib/routes/index.d.ts

@@ -37,6 +37,20 @@ declare enum OrganizationInvitationStatus {
 	Expired = "Expired",
 	Revoked = "Revoked"
 }
+/** The scopes (permissions) defined by the organization template. */
+export type OrganizationScope = {
+	tenantId: string;
+	/** The globally unique identifier of the organization scope. */
+	id: string;
+	/** The organization scope's name, unique within the organization template. */
+	name: string;
+	/** A brief description of the organization scope. */
+	description: string | null;
+};
+declare enum LogtoJwtTokenKeyType {
+	AccessToken = "access-token",
+	ClientCredentials = "client-credentials"
+}
 /**
  * The simplified organization role entity that is returned in the `roles` field
  * of the organization.
@@ -52,8 +66,8 @@ declare enum TenantTag {
 declare enum TenantRole {
 	/** Admin of the tenant, who has all permissions. */
 	Admin = "admin",
-	/** Member of the tenant, who has permissions to operate the tenant data, but not the tenant settings. */
-	Member = "member"
+	/** Collaborator of the tenant, who has permissions to operate the tenant data, but not the tenant settings. */
+	Collaborator = "collaborator"
 }
 declare const AffiliateProperties: import("@withtyped/server/lib/model/index.js").default<"affiliate_properties", {
 	createdAt: Date;
@@ -63,16 +77,21 @@ declare const AffiliateProperties: import("@withtyped/server/lib/model/index.js"
 }, "createdAt", "createdAt">;
 export type AffiliateProperty = InferModelType<typeof AffiliateProperties>;
 declare const Affiliates: import("@withtyped/server/lib/model/index.js").default<"affiliates", {
-	id: string;
-	createdAt: Date;
 	name: string;
-}, "createdAt" | "id", "createdAt" | "id">;
+	createdAt: Date;
+	id: string;
+}, "id" | "createdAt", "id" | "createdAt">;
 export type Affiliate = InferModelType<typeof Affiliates>;
+declare enum RegionName {
+	EU = "EU",
+	US = "US"
+}
 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;
 		method?: import("@withtyped/server").RequestMethod | undefined;
 		headers: import("http").IncomingHttpHeaders;
 		url: URL;
@@ -80,6 +99,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	};
 }, "request"> & {
 	request: Record<string, unknown> & {
+		id?: string | undefined;
 		method?: import("@withtyped/server").RequestMethod | undefined;
 		headers: import("http").IncomingHttpHeaders;
 		url: URL;
@@ -88,14 +108,14 @@ 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<{
-	options: {};
+}>, 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;
 		}, {
 			id: string;
 			name: string;
+			createdAt: Date;
 			usage: {
 				activeUsers: number;
 				cost: number;
@@ -110,11 +130,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				currentPeriodStart: Date;
 				currentPeriodEnd: Date;
 			};
+			regionName: RegionName;
 			tag: TenantTag;
 			openInvoices: {
 				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
-				createdAt: Date;
 				id: string;
+				createdAt: Date;
 				updatedAt: Date;
 				customerId: string | null;
 				billingReason: string | null;
@@ -128,10 +149,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			}[];
 		}>;
 	};
+	options: {};
 	get: {
 		"/tenants": import("@withtyped/server").PathGuard<"/", unknown, unknown, {
 			id: string;
 			name: string;
+			createdAt: Date;
 			usage: {
 				activeUsers: number;
 				cost: number;
@@ -146,11 +169,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				currentPeriodStart: Date;
 				currentPeriodEnd: Date;
 			};
+			regionName: RegionName;
 			tag: TenantTag;
 			openInvoices: {
 				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
-				createdAt: Date;
 				id: string;
+				createdAt: Date;
 				updatedAt: Date;
 				customerId: string | null;
 				billingReason: string | null;
@@ -168,9 +192,11 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 		"/tenants": import("@withtyped/server").PathGuard<"/", unknown, {
 			name?: string | undefined;
 			tag?: TenantTag | undefined;
+			regionName?: RegionName | undefined;
 		}, {
 			id: string;
 			name: string;
+			createdAt: Date;
 			usage: {
 				activeUsers: number;
 				cost: number;
@@ -185,11 +211,12 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				currentPeriodStart: Date;
 				currentPeriodEnd: Date;
 			};
+			regionName: RegionName;
 			tag: TenantTag;
 			openInvoices: {
 				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
-				createdAt: Date;
 				id: string;
+				createdAt: Date;
 				updatedAt: Date;
 				customerId: string | null;
 				billingReason: string | null;
@@ -210,8 +237,8 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
-	options: {};
 	patch: {};
+	options: {};
 	get: {
 		"/tenants/my/subscription": import("@withtyped/server").PathGuard<"/my/subscription", unknown, unknown, {
 			status: "incomplete" | "incomplete_expired" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "paused";
@@ -230,8 +257,8 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 		"/tenants/:tenantId/invoices": import("@withtyped/server").PathGuard<"/:tenantId/invoices", unknown, unknown, {
 			invoices: {
 				status: "void" | "open" | "draft" | "paid" | "uncollectible" | null;
-				createdAt: Date;
 				id: string;
+				createdAt: Date;
 				updatedAt: Date;
 				customerId: string | null;
 				billingReason: string | null;
@@ -270,8 +297,8 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
-	options: {};
 	patch: {};
+	options: {};
 	get: {
 		"/services/mails/usage": import("@withtyped/server").PathGuard<"/mails/usage", {
 			from?: string | undefined;
@@ -286,6 +313,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				payload: {
 					code?: string | undefined;
 					link?: string | undefined;
+				} & Record<string, string> & {
 					senderName?: string | undefined;
 					companyInformation?: string | undefined;
 					appLogo?: string | undefined;
@@ -301,22 +329,51 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				payload: {
 					code?: string | undefined;
 					link?: string | undefined;
-				};
+				} & Record<string, string>;
 			};
 		}, unknown>;
+	} & {
+		"/services/custom-jwt": import("@withtyped/server").PathGuard<"/custom-jwt", {
+			isTest?: string | undefined;
+		}, {
+			script: string;
+			tokenType: LogtoJwtTokenKeyType.AccessToken;
+			token: Record<string, Json>;
+			context: Record<string, Json>;
+			environmentVariables?: Record<string, string> | undefined;
+		} | {
+			script: string;
+			tokenType: LogtoJwtTokenKeyType.ClientCredentials;
+			token: Record<string, Json>;
+			environmentVariables?: Record<string, string> | undefined;
+		}, Record<string, unknown>>;
+	};
+	put: {
+		"/services/custom-jwt/worker": import("@withtyped/server").PathGuard<"/custom-jwt/worker", unknown, {
+			"jwt.accessToken"?: {
+				production?: string | undefined;
+				test?: string | undefined;
+			} | undefined;
+			"jwt.clientCredentials"?: {
+				production?: string | undefined;
+				test?: string | undefined;
+			} | undefined;
+		}, unknown>;
+	};
+	delete: {
+		"/services/custom-jwt/worker": import("@withtyped/server").PathGuard<"/custom-jwt/worker", unknown, unknown, unknown>;
 	};
-	put: {};
-	delete: {};
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
-	options: {};
 	patch: {};
+	options: {};
 	get: {
 		"/subscription-plans": import("@withtyped/server").PathGuard<"/", unknown, unknown, {
-			createdAt: Date;
 			id: string;
+			createdAt: Date;
 			name: string;
+			updatedAt: Date;
 			quota: {
 				mauLimit: number | null;
 				tokenLimit: number | null;
@@ -338,6 +395,8 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				organizationsEnabled: boolean;
 				ssoEnabled: boolean;
 				thirdPartyApplicationsLimit: number | null;
+				tenantMembersLimit: number | null;
+				customJwtEnabled: boolean;
 			};
 			stripeProducts: {
 				type: "flat" | "tier1" | "tier2" | "tier3";
@@ -351,7 +410,6 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 				};
 				description?: string | undefined;
 			}[];
-			updatedAt: Date;
 		}[]>;
 	};
 	post: {};
@@ -360,33 +418,16 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
-	options: {};
 	patch: {};
-	get: {
-		"/my/tenant": import("@withtyped/server").PathGuard<"/tenant", unknown, unknown, {
-			name: string;
-			id: string;
-			indicator: string;
-			isSuspended: boolean;
-			tag: TenantTag;
-		}>;
-	};
-	post: {};
-	put: {};
-	delete: {};
-	copy: {};
-	head: {};
-}, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
 	options: {};
-	patch: {};
 	get: {
 		"/checkout-session/:id": import("@withtyped/server").PathGuard<"/:id", unknown, unknown, {
-			status: "open" | "complete" | "expired";
-			createdAt: Date;
 			id: string;
+			createdAt: Date;
 			userId: string;
-			updatedAt: Date;
+			status: "open" | "complete" | "expired";
 			tenantId: string | null;
+			updatedAt: Date;
 			planId: string;
 		}>;
 	};
@@ -398,6 +439,7 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			cancelCallbackUrl?: string | undefined;
 			tenantTag?: TenantTag | undefined;
 			tenantName?: string | undefined;
+			tenantRegionName?: RegionName | undefined;
 		}, {
 			sessionId: string;
 			redirectUri?: string | null | undefined;
@@ -408,8 +450,8 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
-	options: {};
 	patch: {};
+	options: {};
 	get: {
 		"/affiliates": import("@withtyped/server").PathGuard<"/", unknown, unknown, AffiliateData[]>;
 	};
@@ -417,33 +459,33 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 		"/affiliates": import("@withtyped/server").PathGuard<"/", unknown, {
 			name: string;
 		}, {
-			createdAt: Date;
 			id: string;
+			createdAt: Date;
 			name: string;
 		}>;
 	} & {
 		"/affiliates/:id/properties": import("@withtyped/server").PathGuard<"/:id/properties", unknown, {
-			value: string;
 			type: "hostname" | "query";
-		}, {
 			value: string;
-			type: "hostname" | "query";
+		}, {
 			createdAt: Date;
 			affiliateId: string;
+			type: "hostname" | "query";
+			value: string;
 		}>;
 	};
 	put: {};
 	delete: {
 		"/affiliates/:id/properties": import("@withtyped/server").PathGuard<"/:id/properties", unknown, {
-			value: string;
 			type: "hostname" | "query";
+			value: string;
 		}, unknown>;
 	};
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
-	options: {};
 	patch: {};
+	options: {};
 	get: {};
 	post: {
 		"/affiliate-logs": import("@withtyped/server").PathGuard<"/", unknown, {
@@ -452,8 +494,8 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 			hostname?: string | undefined;
 			query?: string | undefined;
 		}, {
-			createdAt: Date;
 			id: string;
+			createdAt: Date;
 			affiliateId: string | null;
 			userId: string;
 			createdVia: {
@@ -468,100 +510,134 @@ declare const router: import("@withtyped/server").Router<RequestContext, WithAut
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
+	patch: {
+		"/invitations/:invitationId/status": import("@withtyped/server").PathGuard<"/:invitationId/status", unknown, {
+			status: OrganizationInvitationStatus.Accepted;
+		}, unknown>;
+	};
 	options: {};
-	patch: {};
-	get: {};
-	post: {};
-	put: {};
-	delete: {
-		"/logs/expired": import("@withtyped/server").PathGuard<"/expired", {
-			dryRun?: string | undefined;
-		}, unknown, {
-			affectedRows: number;
+	get: {
+		"/invitations": import("@withtyped/server").PathGuard<"/", unknown, unknown, ({
+			id: string;
+			createdAt: number;
+			status: OrganizationInvitationStatus;
+			tenantId: string;
+			updatedAt: number;
+			inviterId: string | null;
+			invitee: string;
+			acceptedUserId: string | null;
+			organizationId: string;
+			expiresAt: number;
+			organizationRoles: OrganizationRoleEntity[];
+		} & {
+			tenantName: string;
+			tenantTag: TenantTag;
+		})[]>;
+	} & {
+		"/invitations/:invitationId": import("@withtyped/server").PathGuard<"/:invitationId", unknown, unknown, {
+			id: string;
+			createdAt: number;
+			status: OrganizationInvitationStatus;
+			tenantId: string;
+			updatedAt: number;
+			inviterId: string | null;
+			invitee: string;
+			acceptedUserId: string | null;
+			organizationId: string;
+			expiresAt: number;
+			organizationRoles: OrganizationRoleEntity[];
 		}>;
 	};
+	post: {};
+	put: {};
+	delete: {};
 	copy: {};
 	head: {};
 }, "/api">>, import("@withtyped/server").RoutesWithPrefix<{
+	patch: {};
 	options: {};
-	patch: {
-		"/invitations/:invitationId/status": import("@withtyped/server").PathGuard<"/:invitationId/status", unknown, {
-			status: OrganizationInvitationStatus.Accepted;
-		}, unknown>;
-	};
 	get: {};
 	post: {};
 	put: {};
-	delete: {};
+	delete: {
+		"/me": import("@withtyped/server").PathGuard<"/", 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: {
+		id?: string | undefined;
 		method?: import("@withtyped/server").RequestMethod | undefined;
 		headers: import("http").IncomingHttpHeaders;
 		url: URL;
 		body?: unknown;
 	};
 }>, import("@withtyped/server").MergeRoutes<import("@withtyped/server").BaseRoutes, import("@withtyped/server").RoutesWithPrefix<{
-	options: {};
 	patch: {
 		"/:tenantId/invitations/:invitationId/status": import("@withtyped/server").PathGuard<"/:tenantId/invitations/:invitationId/status", unknown, {
 			status: OrganizationInvitationStatus.Revoked;
 		}, {
-			status: OrganizationInvitationStatus;
-			createdAt: number;
 			id: string;
-			updatedAt: number;
+			createdAt: number;
+			status: OrganizationInvitationStatus;
 			tenantId: string;
-			organizationId: string;
+			updatedAt: number;
 			inviterId: string | null;
-			expiresAt: number;
-			organizationRoles: OrganizationRoleEntity[];
 			invitee: string;
 			acceptedUserId: string | null;
+			organizationId: string;
+			expiresAt: number;
+			organizationRoles: OrganizationRoleEntity[];
 		}>;
 	};
+	options: {};
 	get: {
 		"/:tenantId/members": import("@withtyped/server").PathGuard<"/:tenantId/members", unknown, unknown, {
 			id: string;
 			name: string | null;
 			username: string | null;
 			primaryEmail: string | null;
+			primaryPhone: string | null;
+			avatar: string | null;
 			organizationRoles: OrganizationRoleEntity[];
 		}[]>;
 	} & {
-		"/:tenantId/invitations": import("@withtyped/server").PathGuard<"/:tenantId/invitations", unknown, unknown, {
-			status: OrganizationInvitationStatus;
-			createdAt: number;
+		"/:tenantId/members/:userId/scopes": import("@withtyped/server").PathGuard<"/:tenantId/members/:userId/scopes", unknown, unknown, OrganizationScope[]>;
+	} & {
+		"/:tenantId/invitations": import("@withtyped/server").PathGuard<"/:tenantId/invitations", unknown, unknown, ({
 			id: string;
-			updatedAt: number;
+			createdAt: number;
+			status: OrganizationInvitationStatus;
 			tenantId: string;
-			organizationId: string;
+			updatedAt: number;
 			inviterId: string | null;
-			expiresAt: number;
-			organizationRoles: OrganizationRoleEntity[];
 			invitee: string;
 			acceptedUserId: string | null;
-		}[]>;
+			organizationId: string;
+			expiresAt: number;
+			organizationRoles: OrganizationRoleEntity[];
+		} & {
+			inviterName?: string | undefined;
+		})[]>;
 	};
 	post: {
 		"/:tenantId/invitations": import("@withtyped/server").PathGuard<"/:tenantId/invitations", unknown, {
-			roleName: TenantRole;
 			invitee: string;
+			roleName: TenantRole;
 			expiresAt?: number | undefined;
 		}, {
-			status: OrganizationInvitationStatus;
-			createdAt: number;
 			id: string;
-			updatedAt: number;
+			createdAt: number;
+			status: OrganizationInvitationStatus;
 			tenantId: string;
-			organizationId: string;
+			updatedAt: number;
 			inviterId: string | null;
-			expiresAt: number;
-			organizationRoles: OrganizationRoleEntity[];
 			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-a21a38a",
+  "version": "0.2.5-a7eedce",
   "description": "Logto Cloud service.",
   "main": "build/index.js",
   "author": "Silverhand Inc. <contact@silverhand.io>",
@@ -16,23 +16,21 @@
     "#src/*": "./build/*"
   },
   "devDependencies": {
-    "@silverhand/eslint-config": "5.0.0",
-    "@silverhand/jest-config": "5.0.0",
-    "@silverhand/ts-config": "5.0.0",
+    "@silverhand/eslint-config": "6.0.1",
+    "@silverhand/ts-config": "6.0.0",
     "@types/accepts": "^1.3.5",
     "@types/http-proxy": "^1.17.9",
-    "@types/jest": "^29.4.0",
     "@types/mime-types": "^2.1.1",
     "@types/node": "^20.0.0",
     "@types/yargs": "^17.0.24",
     "dts-bundle-generator": "^9.3.1",
-    "eslint": "^8.44.0",
-    "jest": "^29.5.0",
+    "eslint": "^8.57.0",
     "lint-staged": "^15.0.0",
     "nodemon": "^3.0.0",
-    "p-map": "^7.0.1",
     "prettier": "^3.0.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vite-tsconfig-paths": "^4.3.1",
+    "vitest": "^1.5.0"
   },
   "engines": {
     "node": "^20.9.0"
@@ -51,22 +49,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@silverhand/essentials": "^2.9.0",
-    "@withtyped/server": "^0.13.3"
+    "@silverhand/essentials": "^2.9.1",
+    "@withtyped/server": "^0.13.6"
   },
   "scripts": {
     "precommit": "lint-staged",
     "build": "rm -rf build/ && tsc -p tsconfig.build.json && pnpm build:lib",
     "//": "It is not used to build the service itself.",
     "build:lib": "rm -rf lib/ && dts-bundle-generator src/routes/index.ts --project tsconfig.build.lib.json -o lib/routes/index.d.ts",
-    "build:test": "rm -rf build/ && tsc -p tsconfig.test.json --sourcemap",
     "lint": "eslint --ext .ts src",
     "lint:report": "pnpm lint --format json --output-file report.json",
     "dev": "rm -rf build/ && nodemon",
     "start": "NODE_ENV=production node .",
-    "test:only": "NODE_OPTIONS=\"--experimental-vm-modules --max_old_space_size=4096\" jest --logHeapUsage",
-    "test": "pnpm build:test && pnpm test:only && pnpm build:lib && pnpm test:types",
-    "test:ci": "pnpm test:only --coverage --silent",
+    "test": "vitest && pnpm build:lib && pnpm test:types",
     "test:types": "tsc -p tsconfig.test.types.json",
     "cli": "node ./build/cli/index.js"
   }