chore(connectors): config template md files to json files (#987)

* chore(connectors): config template md files to json files

* chore(connectors): fix path of reading config-template files

packages/connector-alipay-native/docs/config-template.json

@@ -1,7 +1,5 @@
-```json
 {
   "appId": "<app-id>",
   "signType": "<signing-algorithm>",
   "privateKey": "<private-key>"
 }
-```

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',

packages/connector-alipay/docs/config-template.json

@@ -1,7 +1,5 @@
-```json
 {
   "appId": "<app-id>",
   "signType": "<signing-algorithm>",
   "privateKey": "<private-key>"
 }
-```

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',

packages/connector-aliyun-dm/docs/config-template.json

@@ -1,4 +1,3 @@
-```json
 {
   "accessKeyId": "<access-key-id>",
   "accessKeySecret": "<access-key-secret>",
@@ -22,4 +21,3 @@
     }
   ]
 }
-```

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',

packages/connector-aliyun-sms/docs/config-template.json

@@ -1,4 +1,3 @@
-```json
 {
   "accessKeyId": "<access-key-id>",
   "accessKeySecret": "<access-key-secret>",
@@ -27,7 +26,6 @@
       "name": "<test-template-name>",
       "content": "<test-template-content>",
       "remark": "<test-template-remark>"
-    },
+    }
   ]
 }
-```

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',

packages/connector-apple/docs/config-template.json

@@ -0,0 +1,3 @@
+{
+  "clientId": "<client-id>"
+}

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',

packages/connector-facebook/docs/config-template.json

@@ -1,6 +1,4 @@
-```json
 {
   "clientId": "<client-id>",
   "clientSecret": "<client-secret>"
 }
-```

packages/connector-facebook/docs/config-template.md

@@ -1,6 +0,0 @@
-```json
-{
-  "clientId": "<client-id>",
-  "clientSecret": "<client-secret>"
-}
-```

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',

packages/connector-github/docs/config-template.json

@@ -1,6 +1,4 @@
-```json
 {
   "clientId": "<client-id>",
   "clientSecret": "<client-secret>"
 }
-```

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',

packages/connector-google/docs/config-template.json

@@ -1,6 +1,4 @@
-```json
 {
   "clientId": "<client-id>",
   "clientSecret": "<client-secret>"
 }
-```

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',

packages/connector-sendgrid-mail/docs/config-template.json

@@ -1,4 +1,3 @@
-```json
 {
   "apiKey": "<api-key>",
   "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}}."
     }
   ]
 }
-```

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',

packages/connector-twilio-sms/docs/config-template.json

@@ -1,4 +1,3 @@
-```json
 {
   "accountSID": "<account-sid>",
   "authToken": "<auth-token>",
@@ -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}}."
     }
   ]
 }
-```

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',

packages/connector-wechat-native/docs/config-template.json

@@ -0,0 +1,5 @@
+{
+  "appId": "<app-id>",
+  "appSecret": "<app-secret>",
+  "universalLinks": "<optional-universal-links>"
+}

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',

packages/connector-wechat/docs/config-template.json

@@ -1,6 +1,4 @@
-```json
 {
   "appId": "<app-id>",
   "appSecret": "<app-secret>"
 }
-```

packages/connector-wechat/docs/config-template.md

@@ -1,6 +0,0 @@
-```json
-{
-  "appId": "<app-id>",
-  "appSecret": "<app-secret>"
-}
-```

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',

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 = {