chilean-plate-validator 0.5.3 → 0.6.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Gabriel Galilea
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Gabriel Galilea
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,23 +1,44 @@
-# chilean-plate-validator
-
-## Description
-
-This module will help you to verify if a chilean registration plate is valid
-
-## Code Example
-
-```typescript
-import { plateValid } from 'chilean-plate-validator';
-
-plateValid('BBCC02');
-```
-
-## Installation
-
-```shell
-npm i chilean-plate-validator --save
-```
-
-## License
-
-Read LICENCE.md
+# chilean-plate-validator
+
+## Description
+
+This module will help you to verify if a chilean registration plate is valid.
+
+The RegExes built in code follows the chilean civil registration specifications.
+
+[«Instructivo para Validación de Patentes - Servicio de Registro Civil e Identificación»](https://www.registrocivil.cl/PortalOI/Manuales/ValidacionPatentes.pdf)
+
+## Code Example
+
+#### Example 1:
+```typescript
+import { plateValid } from 'chilean-plate-validator';
+
+plateValid('BBCC12'); // returns true
+plateType('BBCC12');  // returns 'NEW_VEHICLE_PLATE'
+```
+
+#### Example 2:
+```typescript
+import { CLPlate } from 'chilean-plate-validator';
+
+const plate = new CLPlate('BBCC12');
+
+plate.valid // returns true
+plate.type  // returns 'NEW_VEHICLE_PLATE'
+```
+
+## Installation
+
+```shell
+$ npm i chilean-plate-validator --save
+```
+
+## License
+
+Read LICENCE.md
+
+## Author
+
+- GitHub: [Gabo2151](https://github.com/gabo2151)
+- Twitter: [gabriel_galilea](https://twitter.com/gabriel_galilea)

package/dist/index.d.ts

@@ -1,32 +1,32 @@
-/**
- * Verifies if the plate is valid in Chile.
- *
- * @param plate Plate to validate.
- *
- * @returns True if the plate is valid in any of the RegEx saved,
- * false otherwise.
- */
-export declare function plateValid(plate: string): boolean;
-/**
- * Get the plate type according to the RegEx associated.
- *
- * @param plate Plate to check the type.
- *
- * @returns The type according to the RegEx that matches the plate submitted.
- */
-export declare function plateType(plate: string): string;
-/**
- * Plate class... Working on this...
- */
-export declare class Plate {
-    validState: boolean;
-    plateType: string;
-    /**
-     * Creates a new Plate instance.
-     *
-     * @param plate Plate required to check validity and type
-     */
-    constructor(plate: string);
-    get valid(): boolean;
-    get type(): string;
-}
+/**
+ * Verifies if the plate is valid in Chile.
+ *
+ * @param plate Plate to validate.
+ *
+ * @returns True if the plate is valid in any of the RegEx saved,
+ * false otherwise.
+ */
+export declare function plateValid(plate: string): boolean;
+/**
+ * Get the plate type according to the RegEx associated.
+ *
+ * @param plate Plate to check the type.
+ *
+ * @returns The type according to the RegEx that matches the plate submitted.
+ */
+export declare function plateType(plate: string): string;
+/**
+ * Plate class... Working on this...
+ */
+export declare class CLPlate {
+    private readonly validState;
+    private readonly plateType;
+    /**
+     * Creates a new Plate instance.
+     *
+     * @param plate Plate required to check validity and type
+     */
+    constructor(plate: string);
+    get valid(): boolean;
+    get type(): string;
+}

package/dist/index.js

@@ -1,80 +1,80 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Plate = exports.plateType = exports.plateValid = void 0;
-/**
- * RegExes build by chilean civil registration specifications.<br>
- * [«Instructivo para Validación de Patentes - Servicio de Registro Civil e Identificación»](https://www.registrocivil.cl/PortalOI/Manuales/ValidacionPatentes.pdf)
- */
-var REGEX_LIST = [
-    { name: 'OLD_PLATE', regex: /^(?=.{6}$)[A-Z]{2}\d{4}[^s]*$/ },
-    { name: 'NEW_VEHICLE_PLATE', regex: /^(?=.{6}$)[B-DF-HJ-LPR-TV-Z]{4}[1-9]\d[^s]*$/ },
-    { name: 'NEW_MOTORCYCLE_PLATE', regex: /^(?=.{6}$)[B-DF-HJ-LPR-TV-Z]{3}\d{3}[^s]*$/ },
-];
-/**
- * Verifies if the plate is valid in Chile.
- *
- * @param plate Plate to validate.
- *
- * @returns True if the plate is valid in any of the RegEx saved,
- * false otherwise.
- */
-function plateValid(plate) {
-    var state = false;
-    if (plate == null)
-        return state;
-    REGEX_LIST.forEach(function (reg) {
-        if ("".concat(plate).match(reg.regex) != null)
-            state = true;
-    });
-    return state;
-}
-exports.plateValid = plateValid;
-/**
- * Get the plate type according to the RegEx associated.
- *
- * @param plate Plate to check the type.
- *
- * @returns The type according to the RegEx that matches the plate submitted.
- */
-function plateType(plate) {
-    var type = 'INVALID';
-    if (plate == null)
-        return type;
-    REGEX_LIST.forEach(function (reg) {
-        if ("".concat(plate).match(reg.regex) != null)
-            type = reg.name;
-    });
-    return type;
-}
-exports.plateType = plateType;
-/**
- * Plate class... Working on this...
- */
-var Plate = /** @class */ (function () {
-    /**
-     * Creates a new Plate instance.
-     *
-     * @param plate Plate required to check validity and type
-     */
-    function Plate(plate) {
-        this.validState = plateValid(plate);
-        this.plateType = plateType(plate);
-    }
-    Object.defineProperty(Plate.prototype, "valid", {
-        get: function () {
-            return this.validState;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Plate.prototype, "type", {
-        get: function () {
-            return this.plateType;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return Plate;
-}());
-exports.Plate = Plate;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLPlate = exports.plateType = exports.plateValid = void 0;
+/**
+ * RegExes build by chilean civil registration specifications.<br>
+ * [«Instructivo para Validación de Patentes - Servicio de Registro Civil e Identificación»](https://www.registrocivil.cl/PortalOI/Manuales/ValidacionPatentes.pdf)
+ */
+var REGEX_LIST = [
+    { name: 'OLD_PLATE', regex: /^(?=.{6}$)[A-Z]{2}\d{4}[^s]*$/ },
+    { name: 'NEW_VEHICLE_PLATE', regex: /^(?=.{6}$)[B-DF-HJ-LPR-TV-Z]{4}[1-9]\d[^s]*$/ },
+    { name: 'NEW_MOTORCYCLE_PLATE', regex: /^(?=.{6}$)[B-DF-HJ-LPR-TV-Z]{3}\d{3}[^s]*$/ },
+];
+/**
+ * Verifies if the plate is valid in Chile.
+ *
+ * @param plate Plate to validate.
+ *
+ * @returns True if the plate is valid in any of the RegEx saved,
+ * false otherwise.
+ */
+function plateValid(plate) {
+    var state = false;
+    if (plate == null)
+        return state;
+    REGEX_LIST.forEach(function (reg) {
+        if (reg.regex.test("".concat(plate)))
+            state = true;
+    });
+    return state;
+}
+exports.plateValid = plateValid;
+/**
+ * Get the plate type according to the RegEx associated.
+ *
+ * @param plate Plate to check the type.
+ *
+ * @returns The type according to the RegEx that matches the plate submitted.
+ */
+function plateType(plate) {
+    var type = 'INVALID';
+    if (plate == null)
+        return type;
+    REGEX_LIST.forEach(function (reg) {
+        if (reg.regex.test("".concat(plate)))
+            type = reg.name;
+    });
+    return type;
+}
+exports.plateType = plateType;
+/**
+ * Plate class... Working on this...
+ */
+var CLPlate = /** @class */ (function () {
+    /**
+     * Creates a new Plate instance.
+     *
+     * @param plate Plate required to check validity and type
+     */
+    function CLPlate(plate) {
+        this.validState = plateValid(plate);
+        this.plateType = plateType(plate);
+    }
+    Object.defineProperty(CLPlate.prototype, "valid", {
+        get: function () {
+            return this.validState;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(CLPlate.prototype, "type", {
+        get: function () {
+            return this.plateType;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return CLPlate;
+}());
+exports.CLPlate = CLPlate;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAM,UAAU,GAAG;IACjB,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,+BAA+B,EAAE;IAC7D,EAAE,IAAI,EAAE,mBAAmB,EAAE,KAAK,EAAE,8CAA8C,EAAE;IACpF,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,4CAA4C,EAAE;CACtF,CAAA;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAC,KAAa;IACtC,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAChC,UAAU,CAAC,OAAO,CAAC,UAAA,GAAG;QACpB,IAAK,UAAG,KAAK,CAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI;YAAG,KAAK,GAAG,IAAI,CAAC;IAC1D,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAPD,gCAOC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,KAAa;IACrC,IAAI,IAAI,GAAG,SAAS,CAAC;IACrB,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IAC/B,UAAU,CAAC,OAAO,CAAC,UAAA,GAAG;QACpB,IAAK,UAAG,KAAK,CAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI;YAAG,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IAC7D,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC;AAPD,8BAOC;AAED;;GAEG;AACH;IAIE;;;;OAIG;IACH,eAAY,KAAa;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,sBAAI,wBAAK;aAAT;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAED,sBAAI,uBAAI;aAAR;YACE,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;;;OAAA;IAEH,YAAC;AAAD,CAAC,AAtBD,IAsBC;AAtBY,sBAAK"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAM,UAAU,GAAG;IACjB,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,+BAA+B,EAAE;IAC7D,EAAE,IAAI,EAAE,mBAAmB,EAAE,KAAK,EAAE,8CAA8C,EAAE;IACpF,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,4CAA4C,EAAE;CACtF,CAAA;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAC,KAAa;IACtC,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAChC,UAAU,CAAC,OAAO,CAAC,UAAA,GAAG;QACpB,IAAK,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAG,KAAK,CAAE,CAAC;YAAG,KAAK,GAAG,IAAI,CAAC;IACjD,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAPD,gCAOC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,KAAa;IACrC,IAAI,IAAI,GAAG,SAAS,CAAC;IACrB,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IAC/B,UAAU,CAAC,OAAO,CAAC,UAAA,GAAG;QACpB,IAAK,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,UAAG,KAAK,CAAE,CAAC;YAAG,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACpD,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC;AAPD,8BAOC;AAED;;GAEG;AACH;IAIE;;;;OAIG;IACH,iBAAY,KAAa;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,sBAAI,0BAAK;aAAT;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAED,sBAAI,yBAAI;aAAR;YACE,OAAO,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC;;;OAAA;IAEH,cAAC;AAAD,CAAC,AAtBD,IAsBC;AAtBY,0BAAO"}

package/package.json

@@ -1,28 +1,28 @@
-{
-  "name": "chilean-plate-validator",
-  "version": "0.5.3",
-  "description": "Simple chilean plate validator",
-  "author": "Gabriel Galilea",
-  "license": "MIT License",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/gabo2151/chilean-plate-validator"
-  },
-  "keywords": [
-    "patente",
-    "plate",
-    "Chile",
-    "validator",
-    "validar"
-  ],
-  "dependencies": {},
-  "devDependencies": {
-    "typescript": "^4.7.4"
-  }
-}
+{
+  "name": "chilean-plate-validator",
+  "version": "0.6.0",
+  "description": "Simple chilean plate validator",
+  "author": "Gabriel Galilea",
+  "license": "MIT License",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gabo2151/chilean-plate-validator"
+  },
+  "keywords": [
+    "patente",
+    "plate",
+    "Chile",
+    "validator",
+    "validar"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^4.7.4"
+  }
+}