logto/packages/toolkit/connector-kit/CHANGELOG.md

Change Log

4.1.0

Minor Changes

• 7ebef18e3: add account api

  Introduce the new Account API, designed to give end users direct API access without needing to go through the Management API, here is the highlights:

  1. Direct access: The Account API empowers end users to directly access and manage their own account profile without requiring the relay of Management API.
  2. User profile and identities management: Users can fully manage their profiles and security settings, including the ability to update identity information like email, phone, and password, as well as manage social connections. MFA and SSO support are coming soon.
  3. Global access control: Admin has full, global control over access settings, can customize each fields.
  4. Seamless authorization: Authorizing is easier than ever! Simply use client.getAccessToken() to obtain an opaque access token for OP (Logto), and attach it to the Authorization header as Bearer <access_token>.

  Get started

  ![Note] Go to the Logto Docs to find full API reference.

  1. Use /api/account-center endpoint to enable the feature, for security reason, it is disabled by default. And set fields permission for each field.
  2. Use client.getAccessToken() to get the access token.
  3. Attach the access token to the Authorization header of your request, and start interacting with the Account API directly from the frontend.
  4. You may need to setup logto-verification-id header as an additional verification for some requests related to identity verification.

  What you can do with Account API

  1. Get user account profile
  2. Update basic information including name, avatar, username and other profile information
  3. Update password
  4. Update primary email
  5. Update primary phone
  6. Manage social identities

4.0.0

Major Changes

• 6308ee185: remove .catchall() for connectorMetadataGuard

  .catchall() allows unknown keys to be parsed as metadata. This is troublesome when we want to strip out unknown keys (Zod provides .strip() for this purpose but somehow it doesn't work with .catchall()).

  For data extensibility, we added customData field to ConnectorMetadata type to store unknown keys. For example, the fromEmail field in connector-logto-email is not part of the standard metadata, so it should be stored in customData in the future.

Minor Changes

• 15953609b: add OIDC prompt enum, prompt guard, and multi-select typed configuration field

• 6308ee185: support Google One Tap

  • support parsing and validating Google One Tap data in connector-google
  • add Google connector constants in connector-kit for reuse

3.0.0

Major Changes

• 57d97a4df: update SocialUserInfo and GetUserInfo types

  • Added rawData?: Json to SocialUserInfo
  • GetUserInfo now does not accept unknown keys in the return object, since the raw data is now stored in SocialUserInfo

• 57d97a4df: guard results of parseJson and parseJsonObject

  Now parseJson and parseJsonObject are type safe.

Minor Changes

• 57d97a4df: add jsonGuard() and jsonObjectGuard()

Patch Changes

• 2c10c2423: allow unknown properties in send message payload

2.1.0

Minor Changes

• 31e60811d: use Node 20 LTS for engine requirement.

  Note: We mark it as minor because Logto is shipping with Docker image and it's not a breaking change for users.

• 570a4ea9e: add replaceSendMessageHandlebars() for replacing SendMessagePayload handlebars in a message template

• 570a4ea9e: support magic link feature

  • Removed VerificationCodeType: Since we are adding the magic link feature, VerificationCodeType is no longer precise for our use cases.
  • Replaced VerificationCodeType with TemplateType.
  • Removed TemplateNotSupported error code since it is useless for dynamic template checking.
  • Added link property to SendMessagePayload.

• 6befe6014: add mockConnectorFilePaths and deprecate mockSmsVerificationCodeFileName

Patch Changes

• 9089dbf84: upgrade TypeScript to 5.3.3
• Updated dependencies [9089dbf84]
• Updated dependencies [31e60811d]
  • @logto/language-kit@1.1.0

2.0.0

Major Changes

• d24aaedf5: major: Remove the deprecated enum MessageType, should all migrate using the new enum VerificationCodeType. patch: Split the types for connectors into separate files.

1.1.1

Patch Changes

• 30033421c: - connector-kit: add DemoConnector type and demo connector ids
  • core-kit: remove nanoid utils, add tenant model utils
  • shared: remove models, add database types and universal export

1.1.0

Minor Changes

• 343b1090f: Allow admin tenant admin to create tenants without limitation

1.0.0

Minor Changes

• 8658827ca: Add optional formItems to connector's metadata.

  If set, the admin console's connector page (both create and update) will use it to generate a form to input config instead of raw JSON.

• 738675a7d: ## Improvements

  • Exported seed constants and schemas.
  • Add ID generation utilities buildIdGenerator() and generateStandardId().

• c0526d931: Pass user agent to connector

Patch Changes

• 69ac13e3a: Add description and tooltip for connector config's formItems.

• 69af8a381: 1. Add connectorId, connectorFactoryId and jti to GetAuthorizationUri. 2. Make ConnectorSession compatible for arbitrary keys.

• c2d36b1c8: Add optional setSession method and getSession method as input parameters of getAuthorizationUri and getUserInfo respectively.

  This change enabled stateless connectors to utilize Logto session to pass parameters between APIs.

• ad3611f5a: Remove connector database storage column and its corresponding access.

• Updated dependencies [738675a7d]

  • @logto/language-kit@1.0.0

1.0.0-rc.3

Patch Changes

• ad3611f5a: Remove connector database storage column and its corresponding access.

1.0.0-rc.2

Patch Changes

• 69ac13e3: Add description and tooltip for connector config's formItems.

1.0.0-rc.1

Minor Changes

• 8658827c: Add optional formItems to connector's metadata.

  If set, the admin console's connector page (both create and update) will use it to generate a form to input config instead of raw JSON.

1.0.0-beta.33

Patch Changes

• 69af8a38: 1. Add connectorId, connectorFactoryId and jti to GetAuthorizationUri. 2. Make ConnectorSession compatible for arbitrary keys.

1.0.0-beta.32

Minor Changes

• c0526d93: Pass user agent to connector

1.0.0-beta.31

Minor Changes

• 738675a7: ## Improvements

  • Exported seed constants and schemas.
  • Add ID generation utilities buildIdGenerator() and generateStandardId().

Patch Changes

• Updated dependencies [738675a7]
  • @logto/core-kit@1.0.0-beta.30
  • @logto/language-kit@1.0.0-beta.30

1.0.0-beta.30

Patch Changes

• c2d36b1c: Add optional setSession method and getSession method as input parameters of getAuthorizationUri and getUserInfo respectively.

  This change enabled stateless connectors to utilize Logto session to pass parameters between APIs.

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.0.0-beta.29 (2022-12-07)

Bug Fixes

• exports info and lock dep version (#45) (2ac83b4)

1.0.0-beta.28 (2022-12-06)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.27 (2022-11-29)

Features

• connector: add continue message type (#41) (78f1eb0)

1.0.0-beta.26 (2022-11-23)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.25 (2022-11-22)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.24 (2022-11-22)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.23 (2022-11-18)

Bug Fixes

• hot fix the check on whether an element exists in array (#37) (889a577)

1.0.0-beta.22 (2022-11-16)

Bug Fixes

• make standard connectors display name configurable (#36) (da431bf)

1.0.0-beta.21 (2022-11-11)

Features

• update connector metadata types and add corresponding type guards (#35) (4e7cd12)

1.0.0-beta.20 (2022-10-21)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.19 (2022-10-19)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.18 (2022-10-12)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.17 (2022-10-12)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.16 (2022-09-28)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.15 (2022-09-27)

Features

• language,core,connector: init language-kit package (#14) (9a74fc4)

1.0.0-beta.14 (2022-09-23)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.13 (2022-09-19)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.12 (2022-09-17)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.11 (2022-09-16)

Note: Version bump only for package @logto/connector-kit

1.0.0-beta.10 (2022-09-16)

Features

• initial commit (56a4968)

1.0.0-beta.9 (2022-09-07)

Note: Version bump only for package @logto/connector-core

1.0.0-beta.8 (2022-09-01)

Note: Version bump only for package @logto/connector-core

1.0.0-beta.6 (2022-08-30)

Note: Version bump only for package @logto/connector-core