@nocobase/plugin-verification 0.8.0-alpha.8 → 0.8.1-alpha.3

package/server.js

@@ -0,0 +1,30 @@
+"use strict";
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+var _index = _interopRequireWildcard(require("./lib/server"));
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {};
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _index.default;
+  }
+});
+
+Object.keys(_index).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _index[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index[key];
+    }
+  });
+});

package/src/client/ProviderOptions.tsx

@@ -0,0 +1,22 @@
+import React, { useEffect, useState } from 'react';
+import { FormLayout } from '@formily/antd';
+import { Field } from '@formily/core';
+import { observer, RecursionField, Schema, useField, useForm } from '@formily/react';
+
+import providerTypes from './providerTypes';
+
+
+export default observer((props) => {
+  const form = useForm();
+  const field = useField<Field>();
+  const [s, setSchema] = useState(new Schema({}));
+  useEffect(() => {
+    form.clearFormGraph('options.*');
+    setSchema(new Schema(providerTypes.get(form.values.type) || {}));
+  }, [form.values.type]);
+  return (
+    <FormLayout layout={'vertical'}>
+      <RecursionField key={form.values.type || 'sms-aliyun'} basePath={field.address} onlyRenderProperties schema={s} />
+    </FormLayout>
+  );
+});

package/src/client/Shortcut.tsx

@@ -0,0 +1,20 @@
+import React from 'react';
+import { useHistory } from 'react-router-dom';
+import { useTranslation } from 'react-i18next';
+import { CheckCircleOutlined } from '@ant-design/icons';
+import { PluginManager } from '@nocobase/client';
+import { NAMESPACE } from './locale';
+
+export const Shortcut = () => {
+  const { t } = useTranslation();
+  const history = useHistory();
+  return (
+    <PluginManager.Toolbar.Item
+      icon={<CheckCircleOutlined />}
+      title={t('Verification', { ns: NAMESPACE })}
+      onClick={() => {
+        history.push('/admin/settings/verification/providers');
+      }}
+    />
+  );
+};

package/src/client/VerificationProviders.tsx

@@ -0,0 +1,19 @@
+import { SchemaComponent } from "@nocobase/client";
+import React from "react";
+import { Card } from 'antd';
+
+import providers from "./schemas/providers";
+import ProviderOptions from "./ProviderOptions";
+
+export function VerificationProviders() {
+  return (
+    <Card bordered={false}>
+      <SchemaComponent
+        schema={providers}
+        components={{
+          ProviderOptions
+        }}
+      />
+    </Card>
+  );
+};

package/src/client/index.tsx

@@ -0,0 +1,41 @@
+import React, { useContext } from 'react';
+
+import { PluginManagerContext, SettingsCenterProvider } from '@nocobase/client';
+
+import { NAMESPACE } from './locale';
+
+import { VerificationProviders } from './VerificationProviders';
+
+export { default as verificationProviderTypes } from './providerTypes';
+
+export default function(props) {
+  const ctx = useContext(PluginManagerContext);
+  return (
+    <SettingsCenterProvider
+      settings={{
+        verification: {
+          icon: 'CheckCircleOutlined',
+          title: `{{t("Verification", { ns: "${NAMESPACE}" })}}`,
+          tabs: {
+            providers: {
+              title: `{{t("Verification providers", { ns: "${NAMESPACE}" })}}`,
+              component: VerificationProviders,
+            },
+          },
+        },
+      }}
+    >
+      <PluginManagerContext.Provider
+        value={{
+          components: {
+            ...ctx?.components,
+          },
+        }}
+      >
+        {props.children}
+      </PluginManagerContext.Provider>
+    </SettingsCenterProvider>
+  );
+};
+
+

package/src/client/locale/index.ts

@@ -0,0 +1,16 @@
+import { useTranslation } from 'react-i18next';
+import { i18n } from '@nocobase/client';
+
+import zhCN from './zh-CN';
+
+export const NAMESPACE = 'verification';
+
+i18n.addResources('zh-CN', NAMESPACE, zhCN);
+
+export function lang(key: string) {
+  return i18n.t(key, { ns: NAMESPACE });
+}
+
+export function useVerificationTranslation() {
+  return useTranslation(NAMESPACE);
+}

package/src/client/locale/zh-CN.ts

@@ -0,0 +1,13 @@
+export default {
+  'Verification': '验证码',
+  'Verification providers': '验证码提供商',
+  'Provider type': '提供商类型',
+
+  // aliyun sms
+  'Aliyun SMS': '阿里云短信服务',
+  'Access Key ID': 'Access Key ID',
+  'Access Key Secret': 'Access Key Secret',
+  'Endpoint': '接入点',
+  'Sign': '签名',
+  'Template code': '模板代码',
+};

package/src/client/providerTypes/index.ts

@@ -0,0 +1,9 @@
+import { ISchema } from '@formily/react';
+import { Registry } from "@nocobase/utils/client";
+import SMSAliyun from './sms-aliyun';
+
+const providerTypes: Registry<ISchema> = new Registry();
+
+providerTypes.register('sms-aliyun', SMSAliyun);
+
+export default providerTypes;

package/src/client/providerTypes/sms-aliyun.ts

@@ -0,0 +1,39 @@
+import { ISchema } from '@formily/react';
+
+import { NAMESPACE } from '../locale';
+
+export default {
+  type: 'object',
+  properties: {
+    accessKeyId: {
+      title: `{{t("Access Key ID", { ns: "${NAMESPACE}" })}}`,
+      type: 'string',
+      'x-decorator': 'FormItem',
+      'x-component': 'Input',
+    },
+    accessKeySecret: {
+      title: `{{t("Access Key Secret", { ns: "${NAMESPACE}" })}}`,
+      type: 'string',
+      'x-decorator': 'FormItem',
+      'x-component': 'Password',
+    },
+    endpoint: {
+      title: `{{t("Endpoint", { ns: "${NAMESPACE}" })}}`,
+      type: 'string',
+      'x-decorator': 'FormItem',
+      'x-component': 'Input',
+    },
+    sign: {
+      title: `{{t("Sign", { ns: "${NAMESPACE}" })}}`,
+      type: 'string',
+      'x-decorator': 'FormItem',
+      'x-component': 'Input',
+    },
+    template: {
+      title: `{{t("Template code", { ns: "${NAMESPACE}" })}}`,
+      type: 'string',
+      'x-decorator': 'FormItem',
+      'x-component': 'Input',
+    }
+  }
+} as ISchema;

package/src/client/schemas/providers.ts

@@ -0,0 +1,330 @@
+import { uid } from '@formily/shared';
+import { useActionContext, useRequest } from '@nocobase/client';
+import { NAMESPACE } from '../locale';
+
+const collection = {
+  name: 'verifications_providers',
+  fields: [
+    {
+      type: 'string',
+      name: 'id',
+      interface: 'input',
+      uiSchema: {
+        title: '{{t("ID")}}',
+        type: 'string',
+        'x-component': 'Input',
+        required: true,
+      }
+    },
+    {
+      type: 'string',
+      name: 'title',
+      interface: 'input',
+      uiSchema: {
+        title: '{{t("Title")}}',
+        type: 'string',
+        'x-component': 'Input',
+        required: true,
+      }
+    },
+    {
+      type: 'string',
+      name: 'type',
+      interface: 'select',
+      uiSchema: {
+        title: `{{t("Provider type", { ns: "${NAMESPACE}" })}}`,
+        type: 'string',
+        'x-component': 'Select',
+        required: true,
+        enum: [
+          { label: `{{t("Aliyun SMS", { ns: "${NAMESPACE}" })}}`, value: 'sms-aliyun' },
+        ],
+      },
+    },
+    {
+      type: 'radio',
+      name: 'default',
+      interface: 'checkbox',
+      uiSchema: {
+        title: '{{t("Default")}}',
+        type: 'boolean',
+        'x-component': 'Checkbox',
+      }
+    }
+  ]
+};
+
+export default {
+  type: 'void',
+  name: 'providers',
+  'x-decorator': 'ResourceActionProvider',
+  'x-decorator-props': {
+    collection,
+    resourceName: 'verifications_providers',
+    request: {
+      resource: 'verifications_providers',
+      action: 'list',
+      params: {
+        pageSize: 50,
+        sort: ['-default', 'id'],
+        appends: [],
+      },
+    },
+  },
+  'x-component': 'CollectionProvider',
+  'x-component-props': {
+    collection,
+  },
+  properties: {
+    actions: {
+      type: 'void',
+      'x-component': 'ActionBar',
+      'x-component-props': {
+        style: {
+          marginBottom: 16,
+        },
+      },
+      properties: {
+        delete: {
+          type: 'void',
+          title: '{{t("Delete")}}',
+          'x-component': 'Action',
+          'x-component-props': {
+            useAction: '{{ cm.useBulkDestroyAction }}',
+            confirm: {
+              title: "{{t('Delete')}}",
+              content: "{{t('Are you sure you want to delete it?')}}",
+            },
+          },
+        },
+        create: {
+          type: 'void',
+          title: '{{t("Add new")}}',
+          'x-component': 'Action',
+          'x-component-props': {
+            type: 'primary',
+          },
+          properties: {
+            drawer: {
+              type: 'void',
+              'x-component': 'Action.Drawer',
+              'x-decorator': 'Form',
+              'x-decorator-props': {
+                useValues(options) {
+                  const ctx = useActionContext();
+                  return useRequest(
+                    () =>
+                      Promise.resolve({
+                        data: {
+                          name: `s_${uid()}`,
+                        },
+                      }),
+                    { ...options, refreshDeps: [ctx.visible] },
+                  );
+                },
+              },
+              title: '{{t("Add new")}}',
+              properties: {
+                id: {
+                  'x-component': 'CollectionField',
+                  'x-decorator': 'FormItem',
+                  description: '{{t("Identifier for program usage. Support letters, numbers and underscores, must start with an letter.")}}',
+                },
+                title: {
+                  'x-component': 'CollectionField',
+                  'x-decorator': 'FormItem',
+                },
+                type: {
+                  'x-component': 'CollectionField',
+                  'x-decorator': 'FormItem',
+                },
+                options: {
+                  type: 'object',
+                  'x-component': 'ProviderOptions',
+                },
+                default: {
+                  'x-component': 'CollectionField',
+                  'x-decorator': 'FormItem',
+                },
+                footer: {
+                  type: 'void',
+                  'x-component': 'Action.Drawer.Footer',
+                  properties: {
+                    cancel: {
+                      title: '{{t("Cancel")}}',
+                      'x-component': 'Action',
+                      'x-component-props': {
+                        useAction: '{{ cm.useCancelAction }}',
+                      },
+                    },
+                    submit: {
+                      title: '{{t("Submit")}}',
+                      'x-component': 'Action',
+                      'x-component-props': {
+                        type: 'primary',
+                        useAction: '{{ cm.useCreateAction }}',
+                      },
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    table: {
+      type: 'void',
+      'x-uid': 'input',
+      'x-component': 'Table.Void',
+      'x-component-props': {
+        rowKey: 'id',
+        rowSelection: {
+          type: 'checkbox',
+        },
+        useDataSource: '{{ cm.useDataSourceFromRAC }}',
+      },
+      properties: {
+        id: {
+          type: 'void',
+          'x-decorator': 'Table.Column.Decorator',
+          'x-component': 'Table.Column',
+          properties: {
+            id: {
+              type: 'string',
+              'x-component': 'CollectionField',
+              'x-read-pretty': true,
+            },
+          },
+        },
+        title: {
+          type: 'void',
+          'x-decorator': 'Table.Column.Decorator',
+          'x-component': 'Table.Column',
+          properties: {
+            title: {
+              type: 'string',
+              'x-component': 'CollectionField',
+              'x-read-pretty': true,
+            },
+          },
+        },
+        type: {
+          type: 'void',
+          'x-decorator': 'Table.Column.Decorator',
+          'x-component': 'Table.Column',
+          properties: {
+            type: {
+              type: 'string',
+              'x-component': 'CollectionField',
+              'x-read-pretty': true,
+            },
+          },
+        },
+        default: {
+          type: 'void',
+          'x-decorator': 'Table.Column.Decorator',
+          'x-component': 'Table.Column',
+          properties: {
+            default: {
+              type: 'boolean',
+              'x-component': 'CollectionField',
+              'x-read-pretty': true,
+            }
+          }
+        },
+        actions: {
+          type: 'void',
+          title: '{{t("Actions")}}',
+          'x-component': 'Table.Column',
+          properties: {
+            actions: {
+              type: 'void',
+              'x-component': 'Space',
+              'x-component-props': {
+                split: '|',
+              },
+              properties: {
+                update: {
+                  type: 'void',
+                  title: '{{t("Edit")}}',
+                  'x-component': 'Action.Link',
+                  'x-component-props': {
+                    type: 'primary',
+                  },
+                  properties: {
+                    drawer: {
+                      type: 'void',
+                      'x-component': 'Action.Drawer',
+                      'x-decorator': 'Form',
+                      'x-decorator-props': {
+                        useValues: '{{ cm.useValuesFromRecord }}',
+                      },
+                      title: '{{t("Edit")}}',
+                      properties: {
+                        id: {
+                          'x-component': 'CollectionField',
+                          'x-decorator': 'FormItem',
+                        },
+                        title: {
+                          'x-component': 'CollectionField',
+                          'x-decorator': 'FormItem',
+                        },
+                        type: {
+                          'x-component': 'CollectionField',
+                          'x-decorator': 'FormItem',
+                          'x-disabled': true,
+                        },
+                        options: {
+                          type: 'object',
+                          'x-component': 'ProviderOptions',
+                        },
+                        default: {
+                          'x-component': 'CollectionField',
+                          'x-decorator': 'FormItem',
+                        },
+                        footer: {
+                          type: 'void',
+                          'x-component': 'Action.Drawer.Footer',
+                          properties: {
+                            cancel: {
+                              title: '{{t("Cancel")}}',
+                              'x-component': 'Action',
+                              'x-component-props': {
+                                useAction: '{{ cm.useCancelAction }}',
+                              },
+                            },
+                            submit: {
+                              title: '{{t("Submit")}}',
+                              'x-component': 'Action',
+                              'x-component-props': {
+                                type: 'primary',
+                                useAction: '{{ cm.useUpdateAction }}',
+                              },
+                            },
+                          },
+                        },
+                      },
+                    },
+                  },
+                },
+                delete: {
+                  type: 'void',
+                  title: '{{ t("Delete") }}',
+                  'x-component': 'Action.Link',
+                  'x-component-props': {
+                    confirm: {
+                      title: "{{t('Delete record')}}",
+                      content: "{{t('Are you sure you want to delete it?')}}",
+                    },
+                    useAction: '{{cm.useDestroyAction}}',
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};

package/src/index.ts

@@ -1,5 +1 @@
-export * from './constants';
-export { Provider } from './providers';
-export { Interceptor, default } from './Plugin';
-
-export const namespace = require('../package.json').name;
+export { default } from './server';

package/src/{Plugin.ts → server/Plugin.ts}

@@ -14,7 +14,6 @@ import initProviders, { Provider } from './providers';
 
 export interface Interceptor {
   manual?: boolean;
-  provider: string;
   expiresIn?: number;
   getReceiver(ctx): string;
   getCode?(ctx): string;
@@ -56,7 +55,7 @@ export default class VerificationPlugin extends Plugin {
     });
 
     if (!item) {
-      return context.throw(400, { code: 'InvalidSMSCode', message: 'verify by sms code failed' });
+      return context.throw(400, { code: 'InvalidVerificationCode', message: context.t('Verification code is invalid', { ns: namespace }) });
     }
 
     // TODO: code should be removed if exists in values
@@ -85,6 +84,7 @@ export default class VerificationPlugin extends Plugin {
     } = process.env;
 
     if (
+      DEFAULT_SMS_VERIFY_CODE_PROVIDER &&
       INIT_ALI_SMS_ACCESS_KEY &&
       INIT_ALI_SMS_ACCESS_KEY_SECRET &&
       INIT_ALI_SMS_VERIFY_CODE_TEMPLATE &&
@@ -103,6 +103,7 @@ export default class VerificationPlugin extends Plugin {
             sign: INIT_ALI_SMS_VERIFY_CODE_SIGN,
             template: INIT_ALI_SMS_VERIFY_CODE_TEMPLATE,
           },
+          default: true
         },
       });
     }
@@ -133,5 +134,15 @@ export default class VerificationPlugin extends Plugin {
     });
 
     app.acl.allow('verifications', 'create');
+    app.acl.allow('verifications_providers', '*', 'allowConfigure');
+  }
+
+  async getDefault() {
+    const providerRepo = this.db.getRepository('verifications_providers');
+    return providerRepo.findOne({
+      filter: {
+        default: true,
+      }
+    });
   }
 }

package/src/{__tests__ → server/__tests__}/Plugin.test.ts

@@ -32,6 +32,7 @@ describe('verification > Plugin', () => {
     provider = await VerificationProviderModel.create({
       id: 'fake1',
       type: 'fake',
+      default: true
     });
   });
 
@@ -40,7 +41,6 @@ describe('verification > Plugin', () => {
   describe('auto intercept', () => {
     beforeEach(async () => {
       plugin.interceptors.register('authors:create', {
-        provider: 'fake1',
         getReceiver(ctx) {
           return ctx.action.params.values.phone;
         },
@@ -103,7 +103,6 @@ describe('verification > Plugin', () => {
     beforeEach(async () => {
       plugin.interceptors.register('authors:create', {
         manual: true,
-        provider: 'fake1',
         getReceiver(ctx) {
           return ctx.action.params.values.phone;
         },
@@ -131,7 +130,6 @@ describe('verification > Plugin', () => {
   describe('validate', () => {
     beforeEach(async () => {
       plugin.interceptors.register('authors:create', {
-        provider: 'fake1',
         getReceiver(ctx) {
           return ctx.action.params.values.phone;
         },

package/src/{actions → server/actions}/verifications.ts

@@ -21,7 +21,9 @@ export async function create(context: Context, next: Next) {
 
   const ProviderRepo = context.db.getRepository('verifications_providers');
   const providerItem = await ProviderRepo.findOne({
-    filterByTk: interceptor.provider
+    filter: {
+      default: true
+    }
   });
   if (!providerItem) {
     console.error(`[verification] no provider for action (${values.type}) provided`);
@@ -30,7 +32,7 @@ export async function create(context: Context, next: Next) {
 
   const receiver = interceptor.getReceiver(context);
   if (!receiver) {
-    return context.throw(400, { code: 'InvalidReceiver', message: 'Invalid receiver' });
+    return context.throw(400, { code: 'InvalidReceiver', message: context.t('Not a valid cellphone number, please re-enter', {ns: namespace }) });
   }
   const VerificationModel = context.db.getModel('verifications');
   const record = await VerificationModel.findOne({
@@ -68,7 +70,7 @@ export async function create(context: Context, next: Next) {
     switch (error.name) {
       case 'InvalidReceiver':
         // TODO: message should consider email and other providers, maybe use "receiver"
-        return context.throw(400, context.t('Not a valid cellphone number, please re-enter', {ns: namespace }));
+        return context.throw(400, { code: 'InvalidReceiver', message: context.t('Not a valid cellphone number, please re-enter', {ns: namespace })});
       case 'RateLimit':
         return context.throw(429, context.t('You are trying so frequently, please slow down', { ns: namespace }));
       default: