@logto/schemas 1.0.0-beta.11

package/lib/types/log.d.ts

@@ -0,0 +1,577 @@
+import { z } from 'zod';
+import { Log } from '../db-entries';
+export declare enum LogResult {
+    Success = "Success",
+    Error = "Error"
+}
+export declare const logResultGuard: z.ZodNativeEnum<typeof LogResult>;
+export declare const baseLogPayloadGuard: z.ZodObject<{
+    result: z.ZodOptional<z.ZodNativeEnum<typeof LogResult>>;
+    error: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    ip: z.ZodOptional<z.ZodString>;
+    userAgent: z.ZodOptional<z.ZodString>;
+    applicationId: z.ZodOptional<z.ZodString>;
+    sessionId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    error?: Record<string, unknown> | undefined;
+    applicationId?: string | undefined;
+    result?: LogResult | undefined;
+    ip?: string | undefined;
+    userAgent?: string | undefined;
+    sessionId?: string | undefined;
+}, {
+    error?: Record<string, unknown> | undefined;
+    applicationId?: string | undefined;
+    result?: LogResult | undefined;
+    ip?: string | undefined;
+    userAgent?: string | undefined;
+    sessionId?: string | undefined;
+}>;
+export declare type BaseLogPayload = z.infer<typeof baseLogPayloadGuard>;
+declare const arbitraryLogPayloadGuard: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export declare type ArbitraryLogPayload = z.infer<typeof arbitraryLogPayloadGuard>;
+export declare enum TokenType {
+    AccessToken = "AccessToken",
+    RefreshToken = "RefreshToken",
+    IdToken = "IdToken"
+}
+export declare const tokenTypeGuard: z.ZodNativeEnum<typeof TokenType>;
+declare const logPayloadsGuard: z.ZodObject<{
+    RegisterUsernamePassword: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        userId: z.ZodOptional<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        userId?: string | undefined;
+        username?: string | undefined;
+    }, {
+        userId?: string | undefined;
+        username?: string | undefined;
+    }>>;
+    RegisterEmailSendPasscode: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        email: z.ZodOptional<z.ZodString>;
+        connectorId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    }, {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    }>>;
+    RegisterEmail: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        email: z.ZodOptional<z.ZodString>;
+        code: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    }, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    }>>;
+    RegisterSmsSendPasscode: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        phone: z.ZodOptional<z.ZodString>;
+        connectorId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    }, {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    }>>;
+    RegisterSms: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        phone: z.ZodOptional<z.ZodString>;
+        code: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    }, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    }>>;
+    RegisterSocialBind: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        connectorId: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+        userInfo: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    }, {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    }>>;
+    RegisterSocial: z.ZodIntersection<z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        connectorId: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+        userInfo: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    }, {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    }>>, z.ZodObject<{
+        code: z.ZodOptional<z.ZodString>;
+        state: z.ZodOptional<z.ZodString>;
+        redirectUri: z.ZodOptional<z.ZodString>;
+        redirectTo: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | undefined;
+        state?: string | undefined;
+        redirectUri?: string | undefined;
+        redirectTo?: string | undefined;
+    }, {
+        code?: string | undefined;
+        state?: string | undefined;
+        redirectUri?: string | undefined;
+        redirectTo?: string | undefined;
+    }>>;
+    SignInUsernamePassword: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        userId: z.ZodOptional<z.ZodString>;
+        username: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        userId?: string | undefined;
+        username?: string | undefined;
+    }, {
+        userId?: string | undefined;
+        username?: string | undefined;
+    }>>;
+    SignInEmailSendPasscode: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        email: z.ZodOptional<z.ZodString>;
+        connectorId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    }, {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    }>>;
+    SignInEmail: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        email: z.ZodOptional<z.ZodString>;
+        code: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    }, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    }>>;
+    SignInSmsSendPasscode: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        phone: z.ZodOptional<z.ZodString>;
+        connectorId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    }, {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    }>>;
+    SignInSms: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        phone: z.ZodOptional<z.ZodString>;
+        code: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    }, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    }>>;
+    SignInSocialBind: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        connectorId: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+        userInfo: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    }, {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    }>>;
+    SignInSocial: z.ZodIntersection<z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        connectorId: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+        userInfo: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    }, {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    }>>, z.ZodObject<{
+        code: z.ZodOptional<z.ZodString>;
+        state: z.ZodOptional<z.ZodString>;
+        redirectUri: z.ZodOptional<z.ZodString>;
+        redirectTo: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | undefined;
+        state?: string | undefined;
+        redirectUri?: string | undefined;
+        redirectTo?: string | undefined;
+    }, {
+        code?: string | undefined;
+        state?: string | undefined;
+        redirectUri?: string | undefined;
+        redirectTo?: string | undefined;
+    }>>;
+    ForgotPasswordSmsSendPasscode: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        phone: z.ZodOptional<z.ZodString>;
+        connectorId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    }, {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    }>>;
+    ForgotPasswordSms: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        phone: z.ZodOptional<z.ZodString>;
+        code: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    }, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    }>>;
+    ForgotPasswordEmailSendPasscode: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        email: z.ZodOptional<z.ZodString>;
+        connectorId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    }, {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    }>>;
+    ForgotPasswordEmail: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        email: z.ZodOptional<z.ZodString>;
+        code: z.ZodOptional<z.ZodString>;
+        userId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    }, {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    }>>;
+    ForgotPasswordReset: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        userId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        userId?: string | undefined;
+    }, {
+        userId?: string | undefined;
+    }>>;
+    CodeExchangeToken: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        userId: z.ZodOptional<z.ZodString>;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        issued: z.ZodOptional<z.ZodArray<z.ZodNativeEnum<typeof TokenType>, "many">>;
+        scope: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        params?: Record<string, unknown> | undefined;
+        userId?: string | undefined;
+        issued?: TokenType[] | undefined;
+        scope?: string | undefined;
+    }, {
+        params?: Record<string, unknown> | undefined;
+        userId?: string | undefined;
+        issued?: TokenType[] | undefined;
+        scope?: string | undefined;
+    }>>;
+    RefreshTokenExchangeToken: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        userId: z.ZodOptional<z.ZodString>;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        issued: z.ZodOptional<z.ZodArray<z.ZodNativeEnum<typeof TokenType>, "many">>;
+        scope: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        params?: Record<string, unknown> | undefined;
+        userId?: string | undefined;
+        issued?: TokenType[] | undefined;
+        scope?: string | undefined;
+    }, {
+        params?: Record<string, unknown> | undefined;
+        userId?: string | undefined;
+        issued?: TokenType[] | undefined;
+        scope?: string | undefined;
+    }>>;
+    RevokeToken: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodObject<{
+        userId: z.ZodOptional<z.ZodString>;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        tokenType: z.ZodOptional<z.ZodNativeEnum<typeof TokenType>>;
+        grantId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        params?: Record<string, unknown> | undefined;
+        grantId?: string | undefined;
+        userId?: string | undefined;
+        tokenType?: TokenType | undefined;
+    }, {
+        params?: Record<string, unknown> | undefined;
+        grantId?: string | undefined;
+        userId?: string | undefined;
+        tokenType?: TokenType | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    RegisterUsernamePassword: Record<string, unknown> & {
+        userId?: string | undefined;
+        username?: string | undefined;
+    };
+    RegisterEmailSendPasscode: Record<string, unknown> & {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    RegisterEmail: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    };
+    RegisterSmsSendPasscode: Record<string, unknown> & {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    RegisterSms: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    };
+    RegisterSocialBind: Record<string, unknown> & {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    };
+    RegisterSocial: Record<string, unknown> & {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    } & {
+        code?: string | undefined;
+        state?: string | undefined;
+        redirectUri?: string | undefined;
+        redirectTo?: string | undefined;
+    };
+    SignInUsernamePassword: Record<string, unknown> & {
+        userId?: string | undefined;
+        username?: string | undefined;
+    };
+    SignInEmailSendPasscode: Record<string, unknown> & {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    SignInEmail: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    };
+    SignInSmsSendPasscode: Record<string, unknown> & {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    SignInSms: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    };
+    SignInSocialBind: Record<string, unknown> & {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    };
+    SignInSocial: Record<string, unknown> & {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    } & {
+        code?: string | undefined;
+        state?: string | undefined;
+        redirectUri?: string | undefined;
+        redirectTo?: string | undefined;
+    };
+    ForgotPasswordSmsSendPasscode: Record<string, unknown> & {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    ForgotPasswordSms: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    };
+    ForgotPasswordEmailSendPasscode: Record<string, unknown> & {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    ForgotPasswordEmail: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    };
+    ForgotPasswordReset: Record<string, unknown> & {
+        userId?: string | undefined;
+    };
+    CodeExchangeToken: Record<string, unknown> & {
+        params?: Record<string, unknown> | undefined;
+        userId?: string | undefined;
+        issued?: TokenType[] | undefined;
+        scope?: string | undefined;
+    };
+    RefreshTokenExchangeToken: Record<string, unknown> & {
+        params?: Record<string, unknown> | undefined;
+        userId?: string | undefined;
+        issued?: TokenType[] | undefined;
+        scope?: string | undefined;
+    };
+    RevokeToken: Record<string, unknown> & {
+        params?: Record<string, unknown> | undefined;
+        grantId?: string | undefined;
+        userId?: string | undefined;
+        tokenType?: TokenType | undefined;
+    };
+}, {
+    RegisterUsernamePassword: Record<string, unknown> & {
+        userId?: string | undefined;
+        username?: string | undefined;
+    };
+    RegisterEmailSendPasscode: Record<string, unknown> & {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    RegisterEmail: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    };
+    RegisterSmsSendPasscode: Record<string, unknown> & {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    RegisterSms: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    };
+    RegisterSocialBind: Record<string, unknown> & {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    };
+    RegisterSocial: Record<string, unknown> & {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    } & {
+        code?: string | undefined;
+        state?: string | undefined;
+        redirectUri?: string | undefined;
+        redirectTo?: string | undefined;
+    };
+    SignInUsernamePassword: Record<string, unknown> & {
+        userId?: string | undefined;
+        username?: string | undefined;
+    };
+    SignInEmailSendPasscode: Record<string, unknown> & {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    SignInEmail: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    };
+    SignInSmsSendPasscode: Record<string, unknown> & {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    SignInSms: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    };
+    SignInSocialBind: Record<string, unknown> & {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    };
+    SignInSocial: Record<string, unknown> & {
+        userId?: string | undefined;
+        connectorId?: string | undefined;
+        userInfo?: unknown;
+    } & {
+        code?: string | undefined;
+        state?: string | undefined;
+        redirectUri?: string | undefined;
+        redirectTo?: string | undefined;
+    };
+    ForgotPasswordSmsSendPasscode: Record<string, unknown> & {
+        phone?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    ForgotPasswordSms: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        phone?: string | undefined;
+    };
+    ForgotPasswordEmailSendPasscode: Record<string, unknown> & {
+        email?: string | undefined;
+        connectorId?: string | undefined;
+    };
+    ForgotPasswordEmail: Record<string, unknown> & {
+        code?: string | undefined;
+        userId?: string | undefined;
+        email?: string | undefined;
+    };
+    ForgotPasswordReset: Record<string, unknown> & {
+        userId?: string | undefined;
+    };
+    CodeExchangeToken: Record<string, unknown> & {
+        params?: Record<string, unknown> | undefined;
+        userId?: string | undefined;
+        issued?: TokenType[] | undefined;
+        scope?: string | undefined;
+    };
+    RefreshTokenExchangeToken: Record<string, unknown> & {
+        params?: Record<string, unknown> | undefined;
+        userId?: string | undefined;
+        issued?: TokenType[] | undefined;
+        scope?: string | undefined;
+    };
+    RevokeToken: Record<string, unknown> & {
+        params?: Record<string, unknown> | undefined;
+        grantId?: string | undefined;
+        userId?: string | undefined;
+        tokenType?: TokenType | undefined;
+    };
+}>;
+export declare type LogPayloads = z.infer<typeof logPayloadsGuard>;
+export declare const logTypeGuard: z.ZodEnum<["RegisterUsernamePassword", "RegisterEmailSendPasscode", "RegisterEmail", "RegisterSmsSendPasscode", "RegisterSms", "RegisterSocialBind", "RegisterSocial", "SignInUsernamePassword", "SignInEmailSendPasscode", "SignInEmail", "SignInSmsSendPasscode", "SignInSms", "SignInSocialBind", "SignInSocial", "ForgotPasswordSmsSendPasscode", "ForgotPasswordSms", "ForgotPasswordEmailSendPasscode", "ForgotPasswordEmail", "ForgotPasswordReset", "CodeExchangeToken", "RefreshTokenExchangeToken", "RevokeToken"]>;
+export declare type LogType = z.infer<typeof logTypeGuard>;
+export declare type LogPayload = LogPayloads[LogType];
+export declare type LogDto = Omit<Log, 'payload'> & {
+    payload: {
+        userId?: string;
+        applicationId?: string;
+        result?: string;
+        userAgent?: string;
+        ip?: string;
+    };
+};
+export {};