Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-01-06 20:40:08 -05:00
Code Issues Activity

feat(toolkit): define optional keys for connector.getUserInfo (#2716)

Browse source
This commit is contained in:
wangsijie 2023-01-04 15:43:54 +08:00 committed by GitHub
parent 61f4e7fd2d
commit e38cd36579
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 18 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
packages/core/src/connectors/types.ts
View file

@ -1,21 +1,10 @@
import type { AllConnector, CreateConnector, VerificationCodeType } from '@logto/connector-kit';
import type { Connector } from '@logto/schemas';
import { z } from 'zod';
export { ConnectorType } from '@logto/schemas';
export type TemplateType = VerificationCodeType;
export const socialUserInfoGuard = z.object({
id: z.string(),
email: z.string().optional(),
phone: z.string().optional(),
name: z.string().optional(),
avatar: z.string().optional(),
});
export type SocialUserInfo = z.infer<typeof socialUserInfoGuard>;
/**
* Dynamic loaded connector type.
*/

5
packages/core/src/libraries/social.ts
View file

@ -1,4 +1,5 @@
import type { GetSession } from '@logto/connector-kit';
import type { GetSession, SocialUserInfo } from '@logto/connector-kit';
import { socialUserInfoGuard } from '@logto/connector-kit';
import type { User } from '@logto/schemas';
import { ConnectorType } from '@logto/schemas';
import type { Nullable } from '@silverhand/essentials';
@ -6,8 +7,6 @@ import type { InteractionResults } from 'oidc-provider';
import { z } from 'zod';
import { getLogtoConnectorById } from '#src/connectors/index.js';
import type { SocialUserInfo } from '#src/connectors/types.js';
import { socialUserInfoGuard } from '#src/connectors/types.js';
import RequestError from '#src/errors/RequestError/index.js';
import { findUserByEmail, findUserByPhone } from '#src/queries/user.js';
import assertThat from '#src/utils/assert-that.js';

3
packages/core/src/routes/interaction/types/guard.ts
View file

@ -1,9 +1,8 @@
import { socialUserInfoGuard } from '@logto/connector-kit';
import { emailRegEx, phoneRegEx, validateRedirectUrl } from '@logto/core-kit';
import { eventGuard, profileGuard, InteractionEvent } from '@logto/schemas';
import { z } from 'zod';
import { socialUserInfoGuard } from '#src/connectors/types.js';
// Passcode Send Route Payload Guard
export const sendPasscodePayloadGuard = z.union([
z.object({

3
packages/core/src/routes/interaction/types/index.ts
View file

@ -1,3 +1,4 @@
import type { SocialUserInfo } from '@logto/connector-kit';
import type {
UsernamePasswordPayload,
EmailPasswordPayload,
@ -8,8 +9,6 @@ import type {
} from '@logto/schemas';
import type { z } from 'zod';
import type { SocialUserInfo } from '#src/connectors/types.js';
import type {
sendPasscodePayloadGuard,
socialAuthorizationUrlPayloadGuard,

3
packages/core/src/routes/interaction/utils/social-verification.ts
View file

@ -1,10 +1,9 @@
import type { ConnectorSession } from '@logto/connector-kit';
import type { ConnectorSession, SocialUserInfo } from '@logto/connector-kit';
import type { SocialConnectorPayload } from '@logto/schemas';
import { ConnectorType } from '@logto/schemas';
import type { Provider } from 'oidc-provider';
import { getLogtoConnectorById } from '#src/connectors/index.js';
import type { SocialUserInfo } from '#src/connectors/types.js';
import { getUserInfoByAuthCode } from '#src/libraries/social.js';
import type { WithLogContext } from '#src/middleware/koa-audit-log.js';
import {

2
packages/core/src/routes/profile.test.ts
View file

@ -1,3 +1,4 @@
import type { SocialUserInfo } from '@logto/connector-kit';
import type { CreateUser, User } from '@logto/schemas';
import { ConnectorType } from '@logto/schemas';
import { createMockUtils } from '@logto/shared/esm';
@ -9,7 +10,6 @@ import {
mockUser,
mockUserResponse,
} from '#src/__mocks__/index.js';
import type { SocialUserInfo } from '#src/connectors/types.js';
import { createMockProvider } from '#src/test-utils/oidc-provider.js';
import { createRequester } from '#src/utils/test-utils.js';

2
packages/core/src/routes/session/social.test.ts
View file

@ -1,10 +1,10 @@
import { ConnectorType } from '@logto/connector-kit';
import type { SocialUserInfo } from '@logto/connector-kit';
import type { User } from '@logto/schemas';
import { Provider } from 'oidc-provider';
import { mockLogtoConnectorList, mockSignInExperience, mockUser } from '#src/__mocks__/index.js';
import { getLogtoConnectorById } from '#src/connectors/index.js';
import type { SocialUserInfo } from '#src/connectors/types.js';
import RequestError from '#src/errors/RequestError/index.js';
import { createRequester } from '#src/utils/test-utils.js';

12
packages/toolkit/connector-kit/src/types.ts
View file

@ -171,7 +171,17 @@ export type GetAuthorizationUri = (
setSession?: SetSession
) => Promise<string>;
export const socialUserInfoGuard = z.object({
id: z.string(),
email: z.string().optional(),
phone: z.string().optional(),
name: z.string().optional(),
avatar: z.string().optional(),
});
export type SocialUserInfo = z.infer<typeof socialUserInfoGuard>;
export type GetUserInfo = (
data: unknown,
getSession?: GetSession
) => Promise<{ id: string } & Record<string, string | boolean | number | undefined>>;
) => Promise<SocialUserInfo & Record<string, string | boolean | number | undefined>>;