diff --git a/packages/connector-alipay-native/docs/config-template.md b/packages/connector-alipay-native/docs/config-template.json similarity index 88% rename from packages/connector-alipay-native/docs/config-template.md rename to packages/connector-alipay-native/docs/config-template.json index 4b4c74fc5..8ccabf50b 100644 --- a/packages/connector-alipay-native/docs/config-template.md +++ b/packages/connector-alipay-native/docs/config-template.json @@ -1,7 +1,5 @@ -```json { "appId": "", "signType": "", "privateKey": "" } -``` diff --git a/packages/connector-alipay-native/src/constant.ts b/packages/connector-alipay-native/src/constant.ts index a266f0da0..00ea1d0b8 100644 --- a/packages/connector-alipay-native/src/constant.ts +++ b/packages/connector-alipay-native/src/constant.ts @@ -17,9 +17,9 @@ export const alipaySigningAlgorithms = ['RSA', 'RSA2'] as const; // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'alipay-native', diff --git a/packages/connector-alipay/docs/config-template.md b/packages/connector-alipay/docs/config-template.json similarity index 88% rename from packages/connector-alipay/docs/config-template.md rename to packages/connector-alipay/docs/config-template.json index 4b4c74fc5..8ccabf50b 100644 --- a/packages/connector-alipay/docs/config-template.md +++ b/packages/connector-alipay/docs/config-template.json @@ -1,7 +1,5 @@ -```json { "appId": "", "signType": "", "privateKey": "" } -``` diff --git a/packages/connector-alipay/src/constant.ts b/packages/connector-alipay/src/constant.ts index 239714681..bd50c288e 100644 --- a/packages/connector-alipay/src/constant.ts +++ b/packages/connector-alipay/src/constant.ts @@ -18,9 +18,9 @@ export const alipaySigningAlgorithms = ['RSA', 'RSA2'] as const; // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'alipay-web', diff --git a/packages/connector-aliyun-dm/docs/config-template.md b/packages/connector-aliyun-dm/docs/config-template.json similarity index 97% rename from packages/connector-aliyun-dm/docs/config-template.md rename to packages/connector-aliyun-dm/docs/config-template.json index 16e332592..91da9fccd 100644 --- a/packages/connector-aliyun-dm/docs/config-template.md +++ b/packages/connector-aliyun-dm/docs/config-template.json @@ -1,4 +1,3 @@ -```json { "accessKeyId": "", "accessKeySecret": "", @@ -22,4 +21,3 @@ } ] } -``` diff --git a/packages/connector-aliyun-dm/src/constant.ts b/packages/connector-aliyun-dm/src/constant.ts index c563fb94f..b0b9e235c 100644 --- a/packages/connector-aliyun-dm/src/constant.ts +++ b/packages/connector-aliyun-dm/src/constant.ts @@ -15,9 +15,9 @@ export const staticConfigs = { // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'aliyun-direct-mail', diff --git a/packages/connector-aliyun-sms/docs/config-template.md b/packages/connector-aliyun-sms/docs/config-template.json similarity index 97% rename from packages/connector-aliyun-sms/docs/config-template.md rename to packages/connector-aliyun-sms/docs/config-template.json index dbd2ebdc7..2936fc66c 100644 --- a/packages/connector-aliyun-sms/docs/config-template.md +++ b/packages/connector-aliyun-sms/docs/config-template.json @@ -1,4 +1,3 @@ -```json { "accessKeyId": "", "accessKeySecret": "", @@ -27,7 +26,6 @@ "name": "", "content": "", "remark": "" - }, + } ] } -``` diff --git a/packages/connector-aliyun-sms/src/constant.ts b/packages/connector-aliyun-sms/src/constant.ts index 9a343d02f..8208473a0 100644 --- a/packages/connector-aliyun-sms/src/constant.ts +++ b/packages/connector-aliyun-sms/src/constant.ts @@ -31,9 +31,9 @@ export enum SmsTemplateType { // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'aliyun-short-message-service', diff --git a/packages/connector-apple/docs/config-template.json b/packages/connector-apple/docs/config-template.json new file mode 100644 index 000000000..f3280408f --- /dev/null +++ b/packages/connector-apple/docs/config-template.json @@ -0,0 +1,3 @@ +{ + "clientId": "" +} diff --git a/packages/connector-apple/src/constant.ts b/packages/connector-apple/src/constant.ts index 936beb1f6..117a75ed7 100644 --- a/packages/connector-apple/src/constant.ts +++ b/packages/connector-apple/src/constant.ts @@ -15,9 +15,9 @@ export const scope = ''; // Note: `openid` is required when adding more scope(s) // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'apple-universal', diff --git a/packages/connector-github/docs/config-template.md b/packages/connector-facebook/docs/config-template.json similarity index 85% rename from packages/connector-github/docs/config-template.md rename to packages/connector-facebook/docs/config-template.json index 6e9deec3a..081079e46 100644 --- a/packages/connector-github/docs/config-template.md +++ b/packages/connector-facebook/docs/config-template.json @@ -1,6 +1,4 @@ -```json { "clientId": "", "clientSecret": "" } -``` diff --git a/packages/connector-facebook/docs/config-template.md b/packages/connector-facebook/docs/config-template.md deleted file mode 100644 index 6e9deec3a..000000000 --- a/packages/connector-facebook/docs/config-template.md +++ /dev/null @@ -1,6 +0,0 @@ -```json -{ - "clientId": "", - "clientSecret": "" -} -``` diff --git a/packages/connector-facebook/src/constant.ts b/packages/connector-facebook/src/constant.ts index 1d3d94b1a..a60294530 100644 --- a/packages/connector-facebook/src/constant.ts +++ b/packages/connector-facebook/src/constant.ts @@ -20,9 +20,9 @@ export const scope = 'email,public_profile'; // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'facebook-universal', diff --git a/packages/connector-google/docs/config-template.md b/packages/connector-github/docs/config-template.json similarity index 85% rename from packages/connector-google/docs/config-template.md rename to packages/connector-github/docs/config-template.json index 6e9deec3a..081079e46 100644 --- a/packages/connector-google/docs/config-template.md +++ b/packages/connector-github/docs/config-template.json @@ -1,6 +1,4 @@ -```json { "clientId": "", "clientSecret": "" } -``` diff --git a/packages/connector-github/src/constant.ts b/packages/connector-github/src/constant.ts index 2bccb45e0..f107c1d82 100644 --- a/packages/connector-github/src/constant.ts +++ b/packages/connector-github/src/constant.ts @@ -11,9 +11,9 @@ export const userInfoEndpoint = 'https://api.github.com/user'; // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'github-universal', diff --git a/packages/connector-apple/docs/config-template.md b/packages/connector-google/docs/config-template.json similarity index 85% rename from packages/connector-apple/docs/config-template.md rename to packages/connector-google/docs/config-template.json index 6e9deec3a..081079e46 100644 --- a/packages/connector-apple/docs/config-template.md +++ b/packages/connector-google/docs/config-template.json @@ -1,6 +1,4 @@ -```json { "clientId": "", "clientSecret": "" } -``` diff --git a/packages/connector-google/src/constant.ts b/packages/connector-google/src/constant.ts index 4ed878009..44769e79e 100644 --- a/packages/connector-google/src/constant.ts +++ b/packages/connector-google/src/constant.ts @@ -11,9 +11,9 @@ export const scope = 'openid profile email'; // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'google-universal', diff --git a/packages/connector-sendgrid-mail/docs/config-template.md b/packages/connector-sendgrid-mail/docs/config-template.json similarity index 89% rename from packages/connector-sendgrid-mail/docs/config-template.md rename to packages/connector-sendgrid-mail/docs/config-template.json index b1c410264..8d5bed3a2 100644 --- a/packages/connector-sendgrid-mail/docs/config-template.md +++ b/packages/connector-sendgrid-mail/docs/config-template.json @@ -1,4 +1,3 @@ -```json { "apiKey": "", "fromEmail": "noreply@logto.test.io", @@ -7,20 +6,19 @@ "usageType": "SignIn", "type": "text/plain", "subject": "Logto SignIn Template", - "content": "This is for sign-in purposes only. Your passcode is {{code}}.", + "content": "This is for sign-in purposes only. Your passcode is {{code}}." }, { "usageType": "Register", "type": "text/plain", "subject": "Logto Register Template", - "content": "This is for registering purposes only. Your passcode is {{code}}.", + "content": "This is for registering purposes only. Your passcode is {{code}}." }, { "usageType": "Test", "type": "text/plain", "subject": "Logto Test Template", - "content": "This is for testing purposes only. Your passcode is {{code}}.", + "content": "This is for testing purposes only. Your passcode is {{code}}." } ] } -``` diff --git a/packages/connector-sendgrid-mail/src/constant.ts b/packages/connector-sendgrid-mail/src/constant.ts index b442799c7..13af3c3c1 100644 --- a/packages/connector-sendgrid-mail/src/constant.ts +++ b/packages/connector-sendgrid-mail/src/constant.ts @@ -8,9 +8,9 @@ export const endpoint = 'https://api.sendgrid.com/v3/mail/send'; // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'sendgrid-email-service', diff --git a/packages/connector-twilio-sms/docs/config-template.md b/packages/connector-twilio-sms/docs/config-template.json similarity index 86% rename from packages/connector-twilio-sms/docs/config-template.md rename to packages/connector-twilio-sms/docs/config-template.json index 50d4646bf..32e9a6236 100644 --- a/packages/connector-twilio-sms/docs/config-template.md +++ b/packages/connector-twilio-sms/docs/config-template.json @@ -1,4 +1,3 @@ -```json { "accountSID": "", "authToken": "", @@ -6,16 +5,15 @@ "templates": [ { "usageType": "SignIn", - "content": "This is for sign-in purposes only. Your passcode is {{code}}.", + "content": "This is for sign-in purposes only. Your passcode is {{code}}." }, { "usageType": "Register", - "content": "This is for registering purposes only. Your passcode is {{code}}.", + "content": "This is for registering purposes only. Your passcode is {{code}}." }, { "usageType": "Test", - "content": "This is for testing purposes only. Your passcode is {{code}}.", + "content": "This is for testing purposes only. Your passcode is {{code}}." } ] } -``` diff --git a/packages/connector-twilio-sms/src/constant.ts b/packages/connector-twilio-sms/src/constant.ts index 655b39a93..d886d8845 100644 --- a/packages/connector-twilio-sms/src/constant.ts +++ b/packages/connector-twilio-sms/src/constant.ts @@ -8,9 +8,9 @@ export const endpoint = 'https://api.twilio.com/2010-04-01/Accounts/{{accountSID // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'twilio-short-message-service', diff --git a/packages/connector-wechat-native/docs/config-template.json b/packages/connector-wechat-native/docs/config-template.json new file mode 100644 index 000000000..803ed5d85 --- /dev/null +++ b/packages/connector-wechat-native/docs/config-template.json @@ -0,0 +1,5 @@ +{ + "appId": "", + "appSecret": "", + "universalLinks": "" +} diff --git a/packages/connector-wechat-native/src/constant.ts b/packages/connector-wechat-native/src/constant.ts index bdcefd00a..707eee432 100644 --- a/packages/connector-wechat-native/src/constant.ts +++ b/packages/connector-wechat-native/src/constant.ts @@ -11,9 +11,9 @@ export const scope = 'snsapi_userinfo'; // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'wechat-native', diff --git a/packages/connector-wechat-native/docs/config-template.md b/packages/connector-wechat/docs/config-template.json similarity index 82% rename from packages/connector-wechat-native/docs/config-template.md rename to packages/connector-wechat/docs/config-template.json index 7a650980e..f458087c9 100644 --- a/packages/connector-wechat-native/docs/config-template.md +++ b/packages/connector-wechat/docs/config-template.json @@ -1,6 +1,4 @@ -```json { "appId": "", "appSecret": "" } -``` diff --git a/packages/connector-wechat/docs/config-template.md b/packages/connector-wechat/docs/config-template.md deleted file mode 100644 index 7a650980e..000000000 --- a/packages/connector-wechat/docs/config-template.md +++ /dev/null @@ -1,6 +0,0 @@ -```json -{ - "appId": "", - "appSecret": "" -} -``` diff --git a/packages/connector-wechat/src/constant.ts b/packages/connector-wechat/src/constant.ts index b5932c953..afcb183f1 100644 --- a/packages/connector-wechat/src/constant.ts +++ b/packages/connector-wechat/src/constant.ts @@ -11,9 +11,9 @@ export const scope = 'snsapi_login'; // eslint-disable-next-line unicorn/prefer-module const currentPath = __dirname; const pathToReadmeFile = path.join(currentPath, '..', 'README.md'); -const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.md'); +const pathToConfigTemplate = path.join(currentPath, '..', 'docs', 'config-template.json'); const readmeContentFallback = 'Please check README.md file directory.'; -const configTemplateFallback = 'Please check config-template.md file directory.'; +const configTemplateFallback = 'Please check config-template.json file directory.'; export const defaultMetadata: ConnectorMetadata = { id: 'wechat-web', diff --git a/packages/core/src/__mocks__/connector.ts b/packages/core/src/__mocks__/connector.ts index 4bdf1c7c6..dbddaec8b 100644 --- a/packages/core/src/__mocks__/connector.ts +++ b/packages/core/src/__mocks__/connector.ts @@ -16,7 +16,7 @@ export const mockMetadata: ConnectorMetadata = { 'zh-CN': '连接器', }, readme: 'README.md', - configTemplate: 'config-template.md', + configTemplate: 'config-template.json', }; export const mockConnector: Connector = {