custom-permutation 1.0.3 → 1.0.6

package/README.md

@@ -1,43 +1,60 @@
 # Custom Permutation Generator
 
 ```typescript
-CustomPermutation(elList: array, choices: { index: array }, nonChoices: { index: array })
+CustomPermutation(elList:[els...], choices:{ index: [els...]] }, nonChoices:{ index: [els...]] })
 ```
 
-_example:_ `CustomPermutation(['a', 'b', 'c'], {1: ['a', 'b']}, {0: ['a']})`
+_example:_\
+`CustomPermutation(['a', 'b', 'c'], {1: ['a', 'b']}, {0: ['a']})`
 
-_Meaning:_ Permutate 3 elements which are 'a', 'b' and 'c' with below rules
+Permutate 3 elements which are 'a', 'b' and 'c' with below rules
 
-__choices rule: {1: ['a', 'b']}__   For index=1 there can be just 'a' and 'b'
-__nonChoices rule: {0: ['a']}__     For index=0 ther can not be element 'a'
+__1. choices rule:__ `{ 1: ['a', 'b'] }`
+
+    At index=1 there can be just 'a' or 'b'
+
+__2. nonChoices rule:__ `{ 0: ['a'] }`
+
+    At index=0 there can NOT be element 'a'
 
 _Note: given index are considered as 0 based: [index=0, index=1, etc]_
 
-What result to be expected in this case:
+__Result set:__
 
-Let's see all permutations, and which ones are valid and not.
-- a, b, c : violates nonChoices rule: _first element is 'a', but shouldn't be 'a'_
-- a, c, b : violates nonChoices rule: _first element is 'a', but shouldn't be 'a'_
-- b, a, c : ok
-- b, c, a : violates choices rule: _second element is 'c' but 'a' or 'b' is desired_
-- c, a, b : ok
-- c, b, a : ok
+Let's see all permutations, and which ones are valid or not.
+- `['a', 'b', 'c']` : violates nonChoices rule: _first element is `'a'`, but shouldn't be `'a'`
+- `['a', 'c', 'b']` : violates nonChoices rule: _first element is `'a'`, but shouldn't be `'a'`_
+- `['b', 'a', 'c']` : ok
+- `['b', 'c', 'a']` : violates choices rule: _second element is `'c'` but `'a'` or `'b'` is desired_
+- `['c', 'a', 'b']` : ok
+- `['c', 'b', 'a']` : ok
 
-So there is just 3 result should be generated for this parameters.
+So there are just 3 results that should be generated with this parameters.
+```javascript
+    let customPerm = new CustomPermutation(['a', 'b', 'c'], { 1: ['a', 'b'] }, { 0: ['a'] });
+    let gen = customPerm.generator();
+    while (true) {
+        let next = gen.next();
+        if (next.done) {
+            break;
+        }
+        console.log(next.value)
+    }
 
+```
+or
 ```javascript
     let customPerm = new CustomPermutation(['a', 'b', 'c'], { 1: ['a', 'b'] }, { 0: ['a'] });
-    let next;
     while (true) {
-        next = customPerm.customPermGen.next();
-        console.log(next);
+        let next = customPerm.next();
         if (!next) {
             break;
         }
+        console.log(next)
     }
 ```
 
-__Console__
-['b', 'a', 'c']
-['c', 'a', 'b']
+__Console__\
+['b', 'a', 'c']\
+['c', 'a', 'b']\
 ['c', 'b', 'a']

package/lib/CustomPermutation.d.ts

@@ -8,4 +8,6 @@ export default class CustomPermutation {
     private passFn?;
     customPermGen: CustomPermutationGenerator;
     constructor(listToPermutate: any[], choices: object, nonChoices: object, elementsOrderAbsolute?: any[], elementsOrderRelative?: any[], passFn?: Function);
+    next(): any;
+    generator(): Generator<any, void, unknown>;
 }

package/lib/CustomPermutation.js

@@ -1,4 +1,31 @@
 "use strict";
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var CustomPermutationGenerator_1 = require("./CustomPermutationGenerator");
 var CustomPermutation = /** @class */ (function () {
@@ -17,6 +44,30 @@ var CustomPermutation = /** @class */ (function () {
         }
         this.customPermGen = new CustomPermutationGenerator_1.CustomPermutationGenerator(listToPermutate, choices, nonChoices, elementsOrderAbsolute, elementsOrderRelative, passFn);
     }
+    CustomPermutation.prototype.next = function () {
+        return this.customPermGen.next();
+    };
+    CustomPermutation.prototype.generator = function () {
+        var nextPerm;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    nextPerm = null;
+                    _a.label = 1;
+                case 1:
+                    if (!true) return [3 /*break*/, 5];
+                    nextPerm = this.customPermGen.next();
+                    if (!nextPerm) return [3 /*break*/, 3];
+                    return [4 /*yield*/, nextPerm];
+                case 2:
+                    _a.sent();
+                    return [3 /*break*/, 4];
+                case 3: return [3 /*break*/, 5];
+                case 4: return [3 /*break*/, 1];
+                case 5: return [2 /*return*/];
+            }
+        });
+    };
     return CustomPermutation;
 }());
 exports.default = CustomPermutation;

package/lib/CustomPermutation.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomPermutation.js","sourceRoot":"","sources":["../src/CustomPermutation.ts"],"names":[],"mappings":";;AAAA,2EAA0E;AAE1E;IAGE,2BACU,eAAsB,EACtB,OAAe,EACf,UAAkB,EAClB,qBAA6B,EAC7B,qBAA6B,EAC7B,MAAiB;QALjB,oBAAe,GAAf,eAAe,CAAO;QACtB,YAAO,GAAP,OAAO,CAAQ;QACf,eAAU,GAAV,UAAU,CAAQ;QAClB,0BAAqB,GAArB,qBAAqB,CAAQ;QAC7B,0BAAqB,GAArB,qBAAqB,CAAQ;QAC7B,WAAM,GAAN,MAAM,CAAW;QAGzB,IAAI,CAAC,CAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,MAAM,CAAA,EAAE;YAClC,qBAAqB,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,EAAD,CAAC,CAAC,CAAC;SAC/E;QAED,IAAI,CAAC,CAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,MAAM,CAAA,EAAE;YAClC,qBAAqB,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,EAAD,CAAC,CAAC,CAAC;SAC/E;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,uDAA0B,CAAC,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAClJ,CAAC;IAEH,wBAAC;AAAD,CAAC,AAvBD,IAuBC"}
+{"version":3,"file":"CustomPermutation.js","sourceRoot":"","sources":["../src/CustomPermutation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2EAA0E;AAE1E;IAGE,2BACU,eAAsB,EACtB,OAAe,EACf,UAAkB,EAClB,qBAA6B,EAC7B,qBAA6B,EAC7B,MAAiB;QALjB,oBAAe,GAAf,eAAe,CAAO;QACtB,YAAO,GAAP,OAAO,CAAQ;QACf,eAAU,GAAV,UAAU,CAAQ;QAClB,0BAAqB,GAArB,qBAAqB,CAAQ;QAC7B,0BAAqB,GAArB,qBAAqB,CAAQ;QAC7B,WAAM,GAAN,MAAM,CAAW;QAGzB,IAAI,CAAC,CAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,MAAM,CAAA,EAAE;YAClC,qBAAqB,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,EAAD,CAAC,CAAC,CAAC;SAC/E;QAED,IAAI,CAAC,CAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,MAAM,CAAA,EAAE;YAClC,qBAAqB,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,EAAD,CAAC,CAAC,CAAC;SAC/E;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,uDAA0B,CAAC,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAClJ,CAAC;IAED,gCAAI,GAAJ;QACE,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC;IAEA,qCAAS,GAAV;;;;;oBACM,QAAQ,GAAG,IAAI,CAAC;;;yBAEb,IAAI;oBACT,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;yBACjC,QAAQ,EAAR,wBAAQ;oBACV,qBAAM,QAAQ,EAAA;;oBAAd,SAAc,CAAC;;wBAEf,wBAAM;;;;;KAGX;IAEH,wBAAC;AAAD,CAAC,AAxCD,IAwCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "custom-permutation",
-  "version": "1.0.3",
+  "version": "1.0.6",
   "description": "Permutation generator with custom options.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -10,8 +10,8 @@
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "tslint -p tsconfig.json",
     "prepare": "npm run build",
-    "prepublishOnly": "npm test",
-    "preversion": "",
+    "prepublishOnly": "npm test && npm run preversion",
+    "preversion": "true || npm run lint",
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"
   },