{ "typeDocModel": { "id": 0, "name": "@wix/authentication", "variant": "project", "kind": 1, "flags": {}, "children": [ { "id": 1, "name": "AuthenticationError", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 2, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "src/headless/errors.ts", "line": 29, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/headless/errors.ts#L29" } ], "signatures": [ { "id": 3, "name": "new AuthenticationError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "src/headless/errors.ts", "line": 29, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/headless/errors.ts#L29" } ], "parameters": [ { "id": 4, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 5, "name": "loginState", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/@wix/sdk-runtime/build/login-state.d.ts", "qualifiedName": "LoginState" }, "name": "LoginState", "package": "@wix/sdk-runtime" } }, { "id": 6, "name": "errorCode", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 89, "name": "AuthenticationErrorCodes", "package": "@wix/authentication" } } ], "type": { "type": "reference", "target": 1, "name": "AuthenticationError", "package": "@wix/authentication" }, "overwrites": { "type": "reference", "target": -1, "name": "Error.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "Error.constructor" } }, { "id": 8, "name": "errorCode", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "src/headless/errors.ts", "line": 28, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/headless/errors.ts#L28" } ], "type": { "type": "reference", "target": 89, "name": "AuthenticationErrorCodes", "package": "@wix/authentication" } }, { "id": 7, "name": "loginState", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "src/headless/errors.ts", "line": 27, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/headless/errors.ts#L27" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/@wix/sdk-runtime/build/login-state.d.ts", "qualifiedName": "LoginState" }, "name": "LoginState", "package": "@wix/sdk-runtime" } } ], "groups": [ { "title": "Constructors", "children": [ 2 ] }, { "title": "Properties", "children": [ 8, 7 ] } ], "sources": [ { "fileName": "src/headless/errors.ts", "line": 26, "character": 13, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/headless/errors.ts#L26" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Error" }, "name": "Error", "package": "typescript" } ] }, { "id": 58, "name": "AuthenticationApi", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 70, "name": "applySessionToken", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 52, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L52" } ], "signatures": [ { "id": 71, "name": "applySessionToken", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 52, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L52" } ], "parameters": [ { "id": 72, "name": "token", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 73, "name": "loggedIn", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 53, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L53" } ], "signatures": [ { "id": 74, "name": "loggedIn", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 53, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L53" } ], "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 64, "name": "login", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 50, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L50" } ], "signatures": [ { "id": 65, "name": "login", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 50, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L50" } ], "parameters": [ { "id": 66, "name": "email", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 67, "name": "password", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 68, "name": "logout", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 51, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L51" } ], "signatures": [ { "id": 69, "name": "logout", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 51, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L51" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 75, "name": "onLogin", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L54" } ], "signatures": [ { "id": 76, "name": "onLogin", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L54" } ], "parameters": [ { "id": 77, "name": "handler", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 78, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 19, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L54" } ], "signatures": [ { "id": 79, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 54, "character": 19, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L54" } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/@wix/sdk-runtime/build/nanoevents.d.ts", "qualifiedName": "Unsubscribe" }, "name": "Unsubscribe", "package": "@wix/sdk-runtime" } } ] }, { "id": 84, "name": "onLogout", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L56" } ], "signatures": [ { "id": 85, "name": "onLogout", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L56" } ], "parameters": [ { "id": 86, "name": "handler", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 87, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 20, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L56" } ], "signatures": [ { "id": 88, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 56, "character": 20, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L56" } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/@wix/sdk-runtime/build/nanoevents.d.ts", "qualifiedName": "Unsubscribe" }, "name": "Unsubscribe", "package": "@wix/sdk-runtime" } } ] }, { "id": 59, "name": "register", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 45, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L45" } ], "signatures": [ { "id": 60, "name": "register", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 45, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L45" } ], "parameters": [ { "id": 61, "name": "email", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 62, "name": "password", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 63, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 45, "name": "RegistrationOptions", "package": "@wix/authentication" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 56, "name": "RegistrationResult", "package": "@wix/authentication" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 80, "name": "sendPasswordResetEmail", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 55, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L55" } ], "signatures": [ { "id": 81, "name": "sendPasswordResetEmail", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/types.ts", "line": 55, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L55" } ], "parameters": [ { "id": 82, "name": "email", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 83, "name": "redirectUri", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Methods", "children": [ 70, 73, 64, 68, 75, 84, 59, 80 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 44, "character": 17, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L44" } ] }, { "id": 45, "name": "RegistrationOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Optional settings passed when registering a new member." } ] }, "children": [ { "id": 46, "name": "contactInfo", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contact information for the new member." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 11, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L11" } ], "type": { "type": "reflection", "declaration": { "id": 47, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 54, "name": "customFields", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Custom fields to store with the member profile." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 25, "character": 4, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L25" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" }, { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Date" }, "name": "Date", "package": "typescript" } ] } ], "name": "Record", "package": "typescript" } }, { "id": 51, "name": "emails", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "List of email addresses." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 19, "character": 4, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L19" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 48, "name": "firstName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Member's first name." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 13, "character": 4, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L13" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 53, "name": "language", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The member's preferred language code (for example, " }, { "kind": "code", "text": "`en`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`es`" }, { "kind": "text", "text": ")." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 23, "character": 4, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L23" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 49, "name": "lastName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Member's last name." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 15, "character": 4, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L15" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 52, "name": "phones", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "List of phone numbers." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 21, "character": 4, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L21" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 50, "name": "picture", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "URL of the member's profile picture." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 17, "character": 4, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L17" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 54, 51, 48, 53, 49, 52, 50 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 11, "character": 15, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L11" } ] } } }, { "id": 55, "name": "privacyStatus", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Member profile's publicity status:\n- " }, { "kind": "code", "text": "`PUBLIC`" }, { "kind": "text", "text": ": Visible to other members.\n- " }, { "kind": "code", "text": "`PRIVATE`" }, { "kind": "text", "text": ": Not visible to other members." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 30, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L30" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "PUBLIC" }, { "type": "literal", "value": "PRIVATE" } ] } } ], "groups": [ { "title": "Properties", "children": [ 46, 55 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 9, "character": 17, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L9" } ] }, { "id": 56, "name": "RegistrationResult", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Result returned after a successful member registration." } ] }, "children": [ { "id": 57, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The member's status after registration.\n- 'PENDING': Requires email verification or admin approval.\n- 'ACTIVE': The member is logged in." } ] }, "sources": [ { "fileName": "src/types.ts", "line": 41, "character": 2, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L41" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "PENDING" }, { "type": "literal", "value": "ACTIVE" } ] } } ], "groups": [ { "title": "Properties", "children": [ 57 ] } ], "sources": [ { "fileName": "src/types.ts", "line": 36, "character": 17, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L36" } ] }, { "id": 89, "name": "AuthenticationErrorCodes", "variant": "declaration", "kind": 4194304, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error codes when login or registration fails." } ], "blockTags": [ { "tag": "@remarks", "content": [ { "kind": "text", "text": "- " }, { "kind": "code", "text": "`invalidEmail`" }, { "kind": "text", "text": ": The email address format is invalid.\n- " }, { "kind": "code", "text": "`invalidPassword`" }, { "kind": "text", "text": ": The password is incorrect.\n- " }, { "kind": "code", "text": "`resetPassword`" }, { "kind": "text", "text": ": The member must reset their password before logging in.\n- " }, { "kind": "code", "text": "`missingCaptchaToken`" }, { "kind": "text", "text": ": A CAPTCHA token is required but was not provided.\n- " }, { "kind": "code", "text": "`emailAlreadyExists`" }, { "kind": "text", "text": ": An account with this email already exists.\n- " }, { "kind": "code", "text": "`invalidCaptchaToken`" }, { "kind": "text", "text": ": The CAPTCHA token is invalid or expired." } ] } ] }, "sources": [ { "fileName": "src/types.ts", "line": 70, "character": 12, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/types.ts#L70" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "invalidEmail" }, { "type": "literal", "value": "invalidPassword" }, { "type": "literal", "value": "resetPassword" }, { "type": "literal", "value": "missingCaptchaToken" }, { "type": "literal", "value": "emailAlreadyExists" }, { "type": "literal", "value": "invalidCaptchaToken" } ] } }, { "id": 20, "name": "applySessionToken", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 232, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L232" } ], "signatures": [ { "id": 21, "name": "applySessionToken", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Applies a session token to establish a member session.\n\nThis function authenticates a member using a session token. The token is usually obtained from [Register](https://dev.wix.com/docs/sdk/host-modules/site/authentication/register), [Login](https://dev.wix.com/docs/sdk/host-modules/site/authentication/login) methods,\nor a 3rd-party authentication provider. After applying the token, the member is logged in and has access to member-only content." } ], "blockTags": [ { "tag": "@requiredField", "content": [ { "kind": "text", "text": "token" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise that resolves when the session token is applied successfully." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Apply a session token received from the backend\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\n// Token received from your backend authentication flow\nconst sessionToken = 'your-session-token-from-backend';\n\ntry {\n await authentication.applySessionToken(sessionToken);\n console.log('Session established successfully');\n} catch (error) {\n console.error('Failed to apply session token:', error);\n}\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Apply a session token from a custom OAuth flow\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nasync function handleOAuthCallback(tokenFromOAuth: string) {\n try {\n await authentication.applySessionToken(tokenFromOAuth);\n\n if (authentication.loggedIn()) {\n console.log('OAuth login successful');\n // Redirect to member dashboard\n window.location.href = '/dashboard';\n }\n } catch (error) {\n console.error('OAuth login failed:', error);\n }\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 232, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L232" } ], "parameters": [ { "id": 22, "name": "token", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Session token to apply." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 39, "name": "getWixManagedLoginUrl", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 460, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L460" } ], "signatures": [ { "id": 40, "name": "getWixManagedLoginUrl", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Returns the login URL for sites that use Wix as their identity provider.\n\nUse this function when your site uses a [Wix login page](https://dev.wix.com/docs/go-headless/develop-your-project/self-managed-headless/authentication/members/wix-login-page/about-wix-login-pages)\nto handle member authentication. Wix manages the login experience and redirects the member back to your site after authentication.\nThe returned URL points to the " }, { "kind": "code", "text": "`/api/auth/login`" }, { "kind": "text", "text": " route." } ], "blockTags": [ { "tag": "@requiredField", "content": [ { "kind": "text", "text": "returnToUrl" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "The Wix-managed login URL with the " }, { "kind": "code", "text": "`returnToUrl`" }, { "kind": "text", "text": " query parameter." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Redirect to the Wix login page\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nconst loginUrl = authentication.getWixManagedLoginUrl('https://example.com/members-area');\nwindow.location.href = loginUrl;\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Use with a login button\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nfunction setupLoginButton() {\n const button = document.getElementById('loginButton');\n button.onclick = () => {\n window.location.href = authentication.getWixManagedLoginUrl(window.location.href);\n };\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 460, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L460" } ], "parameters": [ { "id": 41, "name": "returnToUrl", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The URL to redirect to after login." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 42, "name": "getWixManagedLogoutUrl", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 497, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L497" } ], "signatures": [ { "id": 43, "name": "getWixManagedLogoutUrl", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Returns the logout URL for sites that use Wix as their identity provider.\n\nUse this function when your site uses a [Wix login page](https://dev.wix.com/docs/go-headless/develop-your-project/self-managed-headless/authentication/members/wix-login-page/about-wix-login-pages)\nto handle member authentication. Wix manages the logout flow and redirects the member back to your site afterward.\nThe returned URL points to the " }, { "kind": "code", "text": "`/api/auth/logout`" }, { "kind": "text", "text": " route." } ], "blockTags": [ { "tag": "@requiredField", "content": [ { "kind": "text", "text": "returnToUrl" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "The Wix-managed logout URL with the " }, { "kind": "code", "text": "`returnToUrl`" }, { "kind": "text", "text": " query parameter." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Redirect to the Wix logout page\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nconst logoutUrl = authentication.getWixManagedLogoutUrl('https://example.com/');\nwindow.location.href = logoutUrl;\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Use with a logout button\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nfunction setupLogoutButton() {\n const button = document.getElementById('logoutButton');\n button.onclick = () => {\n window.location.href = authentication.getWixManagedLogoutUrl('/');\n };\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 497, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L497" } ], "parameters": [ { "id": 44, "name": "returnToUrl", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The URL to redirect to after logout." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 23, "name": "loggedIn", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 275, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L275" } ], "signatures": [ { "id": 24, "name": "loggedIn", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Checks if a member is currently logged in to the site.\n\nUse this function to determine the current authentication state and to show or hide content based on login status." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "code", "text": "`true`" }, { "kind": "text", "text": " if a member is currently logged in, " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " otherwise." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Check if a member is logged in\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nif (authentication.loggedIn()) {\n console.log('Member is logged in');\n // Show member-only content\n} else {\n console.log('No member is logged in');\n // Show login prompt\n}\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Conditionally render UI based on login status\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nfunction renderAuthButton() {\n const button = document.getElementById('authButton');\n\n if (authentication.loggedIn()) {\n button.textContent = 'Logout';\n button.onclick = () => authentication.logout();\n } else {\n button.textContent = 'Login';\n button.onclick = () => {\n // Show login form\n };\n }\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 275, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L275" } ], "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 14, "name": "login", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 141, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L141" } ], "signatures": [ { "id": 15, "name": "login", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Logs in a registered member with the provided email and password.\n\nUpon successful login, the member's session is established and they gain access to member-only content and features." } ], "blockTags": [ { "tag": "@requiredField", "content": [ { "kind": "text", "text": "email" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "password" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise that resolves when login is successful." } ] }, { "tag": "@throws", "content": [ { "kind": "text", "text": "Error if the email or password is invalid, or if the member account requires a password reset." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Log in a member\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\ntry {\n await authentication.login('user@example.com', 'password123');\n console.log('Login successful');\n} catch (error) {\n console.error('Login failed:', error);\n}\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Log in with error handling for specific cases\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\ntry {\n await authentication.login('user@example.com', 'password123');\n // Redirect to member area or refresh page\n window.location.href = '/members-area';\n} catch (error) {\n if (error.code === 'invalidPassword') {\n console.error('Incorrect password');\n } else if (error.code === 'resetPassword') {\n console.error('Password reset required');\n } else {\n console.error('Login failed:', error);\n }\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 141, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L141" } ], "parameters": [ { "id": 16, "name": "email", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Member's email address." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 17, "name": "password", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Member's password." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 18, "name": "logout", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 182, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L182" } ], "signatures": [ { "id": 19, "name": "logout", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Logs out the current member from the site." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise that resolves when logout is complete." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Log out the current member\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\ntry {\n await authentication.logout();\n console.log('Logout successful');\n // Redirect to home page or login page\n window.location.href = '/';\n} catch (error) {\n console.error('Logout failed:', error);\n}\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Log out with a confirmation dialog\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nasync function handleLogoutClick() {\n if (!authentication.loggedIn()) {\n console.log('No member is currently logged in');\n return;\n }\n\n const confirmed = window.confirm('Are you sure you want to log out?');\n if (confirmed) {\n await authentication.logout();\n window.location.reload();\n }\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 182, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L182" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 25, "name": "onLogin", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 328, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L328" } ], "signatures": [ { "id": 26, "name": "onLogin", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Registers a callback function to be called when a member logs in.\n\nUse this function to run code after a member successfully logs in, such as updating the UI, loading member-specific data,\nor tracking login events." } ], "blockTags": [ { "tag": "@requiredField", "content": [ { "kind": "text", "text": "handler" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A function that removes the event listener when called." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Subscribe to login events\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nconst unsubscribe = authentication.onLogin(() => {\n console.log('Member logged in');\n // Update UI to show member content\n document.getElementById('memberGreeting').style.display = 'block';\n});\n\n// Later, to stop listening:\n// unsubscribe();\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Track login events and clean up on component unmount\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nfunction initAuthTracking() {\n const unsubscribeLogin = authentication.onLogin(() => {\n console.log('Login event tracked');\n // Send analytics event\n });\n\n const unsubscribeLogout = authentication.onLogout(() => {\n console.log('Logout event tracked');\n // Send analytics event\n });\n\n // Return cleanup function\n return () => {\n unsubscribeLogin();\n unsubscribeLogout();\n };\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 328, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L328" } ], "parameters": [ { "id": 27, "name": "handler", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Callback function to run when a member logs in." } ] }, "type": { "type": "reflection", "declaration": { "id": 28, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 328, "character": 33, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L328" } ], "signatures": [ { "id": 29, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 328, "character": 33, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L328" } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/@wix/sdk-runtime/build/nanoevents.d.ts", "qualifiedName": "Unsubscribe" }, "name": "Unsubscribe", "package": "@wix/sdk-runtime" } } ] }, { "id": 30, "name": "onLogout", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 379, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L379" } ], "signatures": [ { "id": 31, "name": "onLogout", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Registers a callback function to be called when a member logs out.\n\nUse this function to run code after a member logs out, such as clearing cached data, updating the UI,\nor redirecting to a public page." } ], "blockTags": [ { "tag": "@requiredField", "content": [ { "kind": "text", "text": "handler" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A function that removes the event listener when called." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Subscribe to logout events\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nconst unsubscribe = authentication.onLogout(() => {\n console.log('Member logged out');\n // Clear any cached member data\n localStorage.removeItem('memberPreferences');\n // Redirect to home page\n window.location.href = '/';\n});\n\n// Later, to stop listening:\n// unsubscribe();\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Handle logout with UI updates\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nfunction setupLogoutHandler() {\n const unsubscribe = authentication.onLogout(() => {\n // Hide member-only content\n document.querySelectorAll('.member-only').forEach(el => {\n el.style.display = 'none';\n });\n\n // Show login prompt\n document.getElementById('loginPrompt').style.display = 'block';\n });\n\n return unsubscribe;\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 379, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L379" } ], "parameters": [ { "id": 32, "name": "handler", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Callback function to run when a member logs out." } ] }, "type": { "type": "reflection", "declaration": { "id": 33, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 379, "character": 34, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L379" } ], "signatures": [ { "id": 34, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 379, "character": 34, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L379" } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/@wix/sdk-runtime/build/nanoevents.d.ts", "qualifiedName": "Unsubscribe" }, "name": "Unsubscribe", "package": "@wix/sdk-runtime" } } ] }, { "id": 9, "name": "register", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 87, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L87" } ], "signatures": [ { "id": 10, "name": "register", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Registers a new site member.\n\nAfter registration, the member's status is either " }, { "kind": "code", "text": "`PENDING`" }, { "kind": "text", "text": " (which requires email verification or admin approval)\nor " }, { "kind": "code", "text": "`ACTIVE`" }, { "kind": "text", "text": " (member is immediately logged in). The status depends on your [site's member signup settings](https://support.wix.com/en/article/site-members-managing-signup-login-and-security-settings-for-your-site-members)." } ], "blockTags": [ { "tag": "@requiredField", "content": [ { "kind": "text", "text": "email" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "password" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise that resolves with the registration result containing the member's status." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Register a new member with email and password\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\ntry {\n const result = await authentication.register('user@example.com', 'securePassword123');\n\n if (result.status === 'ACTIVE') {\n console.log('Member registered and logged in');\n } else if (result.status === 'PENDING') {\n console.log('Member registered, awaiting approval or email verification');\n }\n} catch (error) {\n console.error('Registration failed:', error);\n}\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Register a new member with additional contact information\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nconst options = {\n contactInfo: {\n firstName: 'John',\n lastName: 'Doe',\n picture: 'https://example.com/photo.jpg',\n emails: ['john.doe@example.com'],\n phones: ['+1234567890'],\n language: 'en',\n customFields: {\n company: 'Acme Inc',\n },\n },\n privacyStatus: 'PUBLIC',\n};\n\nconst result = await authentication.register('john.doe@example.com', 'securePassword123', options);\nconsole.log('Registration status:', result.status);\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 87, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L87" } ], "parameters": [ { "id": 11, "name": "email", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The email address for the new member account." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 12, "name": "password", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The password for the new member account." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 13, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Registration options including contact information and privacy status." } ] }, "type": { "type": "reference", "target": 45, "name": "RegistrationOptions", "package": "@wix/authentication" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 56, "name": "RegistrationResult", "package": "@wix/authentication" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 35, "name": "sendPasswordResetEmail", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "src/authentication.ts", "line": 423, "character": 16, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L423" } ], "signatures": [ { "id": 36, "name": "sendPasswordResetEmail", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Sends a password reset email to a member.\n\nAfter sending the email, the member can click the link to reset their password. In headless environments the member is redirected\nto the provided " }, { "kind": "code", "text": "`redirectUri`" }, { "kind": "text", "text": " after resetting. In the Velo environment, the " }, { "kind": "code", "text": "`redirectUri`" }, { "kind": "text", "text": " parameter is ignored." } ], "blockTags": [ { "tag": "@requiredField", "content": [ { "kind": "text", "text": "email" } ] }, { "tag": "@requiredField", "content": [ { "kind": "text", "text": "redirectUri" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A promise that resolves when the password reset email is sent." } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Send a password reset email\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\ntry {\n await authentication.sendPasswordResetEmail('user@example.com', 'https://example.com/reset-callback');\n console.log('Password reset email sent');\n} catch (error) {\n console.error('Failed to send password reset email:', error);\n}\n```" } ] }, { "tag": "@example", "content": [ { "kind": "text", "text": "Send a password reset email with a login page redirect\n" }, { "kind": "code", "text": "```typescript\nimport { authentication } from '@wix/site';\n\nasync function handleForgotPassword(email: string) {\n try {\n await authentication.sendPasswordResetEmail(email, 'https://example.com/login');\n console.log('Check your email for a password reset link');\n } catch (error) {\n console.error('Failed to send password reset email:', error);\n }\n}\n```" } ] } ] }, "sources": [ { "fileName": "src/authentication.ts", "line": 423, "character": 0, "url": "https://github.com/wix-private/external-component-sdk/blob/a77b57a/packages/authentication/src/authentication.ts#L423" } ], "parameters": [ { "id": 37, "name": "email", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Login email of the member whose password will be reset." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 38, "name": "redirectUri", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The URI to redirect to after the password is reset. Used only in headless environments. In the Velo environment, this parameter is ignored." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Classes", "children": [ 1 ] }, { "title": "Interfaces", "children": [ 58, 45, 56 ] }, { "title": "Type Aliases", "children": [ 89 ] }, { "title": "Functions", "children": [ 20, 39, 42, 23, 14, 18, 25, 30, 9, 35 ] } ], "packageName": "@wix/authentication", "symbolIdMap": {} }, "appendices": {}, "standaloneTypes": {}, "metadata": {} }