Merge pull request #171 from webitel/feature/ws-validator

23.12.31: ws validator [WTEL-3986]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webitel/ui-sdk",
-  "version": "23.12.30",
+  "version": "23.12.31",
   "private": false,
   "scripts": {
     "build": "vue-cli-service build --target lib --name ui-sdk ./src/install.js",

src/validators/websocketValidator/Readme.md

@@ -0,0 +1,7 @@
+Validator for WebSocket URL string
+```javascript
+import websocketValidator from '@webitel/ui-sdk/src/validators/websocketValidator/websocketValidator';
+
+websocketValidator('wss://example.com') // true
+websocketValidator('krokoziabra') // false
+```

src/validators/websocketValidator/__tests__/websocketValidator.spec.js

@@ -0,0 +1,28 @@
+import websocketValidator from '../websocketValidator';
+
+describe('websocketValidator', () => {
+  it('truthy case 1: localhost ws', () => {
+    expect(websocketValidator('ws://localhost:8080')).toBe(true);
+  });
+  it('truthy case 2: localhost wss', () => {
+    expect(websocketValidator('wss://localhost:8080')).toBe(true);
+  });
+  it('truthy case 3: ip ws', () => {
+    expect(websocketValidator('ws://10.10.10.10:8080')).toBe(true);
+  });
+  it('truthy case 4: dns name', () => {
+    expect(websocketValidator('wss://example.com')).toBe(true);
+  });
+  it('truthy case 5: dns name', () => {
+    expect(websocketValidator('wss://example.com/ws')).toBe(true);
+  });
+  it('truthy case 6: dns name', () => {
+    expect(websocketValidator('wss://socket.socket.com/v3/channel_123?api_key=123')).toBe(true);
+  });
+  it('falsy case 1: empty string', () => {
+    expect(websocketValidator('')).toBe(false);
+  });
+  it('falsy case 2: ws+ws', () => {
+    expect(websocketValidator('wss://example.com/wswss://example.com/ws')).toBe(false);
+  });
+});

src/validators/websocketValidator/websocketValidator.js

@@ -0,0 +1,2 @@
+// That's strange but i haven't found any npm package with websocket validator
+export default (value) => (/^(wss?:\/\/)([0-9]{1,3}(?:\.[0-9]{1,3}){3}|[^\/]+)(\:[0-9]{1,5})?(.*)$/i).test(value);

styleguide.config.js

@@ -19,13 +19,21 @@ module.exports = {
     // StyleGuideRenderer: path.join(__dirname, 'styleguide/components/style-guide'),
     LogoRenderer: path.join(__dirname, 'styleguide/components/logo'),
   },
-  // defaultExample: true,
-  // sections: [
-  //   {
-  //     name: 'First Section',
-  //     components: 'src/components/**/[A-Z]*.vue'
-  //   }
-  // ],
+  sections: [
+    {
+      name: 'Components',
+      components: 'src/components/**/*.vue',
+    },
+    {
+      name: 'Validators',
+      sections: [
+        {
+          name: 'Websocket Validator',
+          content: 'src/validators/websocketValidator/Readme.md',
+        },
+      ],
+    },
+  ],
   // eslint-disable-next-line global-require,import/extensions
   // webpackConfig: { ...output /* Custom config options */ },
   // webpackConfig: {