add readme and fix pattern bug

Author: Su-Yong

packages/scope-validator/README.md

@@ -0,0 +1,34 @@
+# Scope Validator
+Pattern matching based Oauth2.0 scope validation library
+
+[![CodeFactor](https://www.codefactor.io/repository/github/CourseDesign/scope-validator/badge)](https://www.codefactor.io/repository/github/CourseDesign/scope-validator)
+
+# Installation
+```shell script
+$ npm install scope-validator
+```
+
+# Documentation
+[Documentation / scope-validator](https://github.com/CourseDesign/scope-validator/wiki/Documentation%3A-scope-validator)
+
+# Example
+```typescript
+import { ScopeValidatorFactory, ScopeValidatorManager } from 'scope-vallidator'
+
+const ParameterValidator = ScopeValidatorFactory.create(
+  'create_test:${custom_param}',
+  (name: string, { parameters }) => {
+    const { custom_param } = parameters;
+    if (custom_param === 'hello') {
+      return true
+    }
+
+    return false
+  }
+)
+
+const validatorManager = new ScopeValidatorManager();
+validatorManager.use(ParameterValidator);
+
+validatorManager.validate(['create_test:hello']);
+```

packages/scope-validator/lib/pattern.ts

@@ -24,6 +24,10 @@ export default class Pattern {
     let parameterNames = this.str.split(/(?:\${|})/g);
     parameterNames = parameterNames.filter((value, index) => index % 2);
 
+    if (parameterNames.length !== new Set(parameterNames).size) {
+      throw new Error('Parameter name must be different');
+    }
+
     const regexStr = this.str
       .replace(/(\${\w+})/g, '*')
       .replace(/[$^.+?]/g, '\\$&')

packages/scope-validator/package.json

@@ -1,8 +1,8 @@
 {
   "name": "scope-validator",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Pattern matching based Oauth2.0 scope validation library",
-  "main": "dist/index.js",
+  "main": "dist/lib/index.js",
   "scripts": {
     "test": "jest",
     "build": "npm run clean && npm run compile",
@@ -24,5 +24,5 @@
     "ts-jest": "^26.3.0",
     "typescript": "^4.0.2"
   },
-  "types": "dist/index.d.ts"
+  "types": "dist/lib/index.d.ts"
 }

packages/scope-validator/test/integration/single-parameter.spec.ts

@@ -23,6 +23,12 @@ const TestValidator3 = ScopeValidatorFactory.create<string>(
   (name, { received }) => received === 'test'
 );
 
+const TestValidator4 = ScopeValidatorFactory.create(
+  // eslint-disable-next-line no-template-curly-in-string
+  'create:${param}:${param}',
+  () => true
+);
+
 describe('success', () => {
   it('validate scope', () => {
     const scopeValidatorManager = new ScopeValidatorManager();
@@ -93,6 +99,19 @@ describe('success', () => {
 });
 
 describe('failed', () => {
+  it('same parameter name', () => {
+    const scopeValidatorManager = new ScopeValidatorManager();
+    scopeValidatorManager.use(TestValidator4);
+
+    expect(() => {
+      scopeValidatorManager.validate([
+        'create:client:all',
+        'create:client:me',
+        'create:client:other',
+      ]);
+    }).toThrow(Error);
+  });
+
   it('not match ownerId', () => {
     const scopeValidatorManager = new ScopeValidatorManager();
     scopeValidatorManager.use(TestValidator1);