chore: import upstream snapshot with attribution

2026-07-13 12:22:32 +08:00
commit 39dbe3a57d
1131 changed files with 272709 additions and 0 deletions
@@ -0,0 +1,68 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package plugin
+
+type Connector interface {
+	Base
+
+	// ConnectorLogoSVG presents the logo in svg format
+	ConnectorLogoSVG() string
+
+	// ConnectorName presents the name of the connector
+	// e.g. Facebook, Twitter, Instagram
+	ConnectorName() Translator
+
+	// ConnectorSlugName presents the slug name of the connector
+	// Please use lowercase and hyphen as the separator
+	// e.g. facebook, twitter, instagram
+	ConnectorSlugName() string
+
+	// ConnectorSender presents the sender of the connector
+	// It handles the start endpoint of the connector
+	// receiverURL is the whole URL of the receiver
+	ConnectorSender(ctx *GinContext, receiverURL string) (redirectURL string)
+
+	// ConnectorReceiver presents the receiver of the connector
+	// It handles the callback endpoint of the connector, and returns the
+	ConnectorReceiver(ctx *GinContext, receiverURL string) (userInfo ExternalLoginUserInfo, err error)
+}
+
+// ExternalLoginUserInfo external login user info
+type ExternalLoginUserInfo struct {
+	// required. The unique user ID provided by the third-party login
+	ExternalID string
+	// optional. This name is used preferentially during registration
+	DisplayName string
+	// optional. This username is used preferentially during registration
+	Username string
+	// optional. If email exist will bind the existing user
+	// IMPORTANT: The email must have been verified. If the plugin can't guarantee the email is verified, please leave it empty.
+	Email string
+	// optional. The avatar URL provided by the third-party login platform
+	Avatar string
+	// optional. The original user information provided by the third-party login platform
+	MetaInfo string
+}
+
+var (
+	// CallConnector is a function that calls all registered connectors
+	CallConnector,
+	registerConnector = MakePlugin[Connector](false)
+)