@lafrae/specification 0.0.2

package/README.md

@@ -0,0 +1,84 @@
+# Specs
+
+Definição de pipeline de especificações
+
+## Instalando
+
+Via npm
+
+```bash
+npm i @sintese/specification
+```
+
+## Usando
+
+* Defina um conjunto de especificações
+
+```javascript
+// IsEvenNumber.js
+class IsEvenNumber {
+  isSatisfiedBy(candidate) {
+    const isEven = candidate % 2 == 0;
+    return {
+      ok: isEven,
+      details: !isEven
+        ? [`candidate is not an even number`]
+        : [`candidate is an even number`],
+    };
+  }
+}
+
+module.exports = { IsEvenNumber };
+
+
+// IsBiggerThan.js
+class IsBiggerThan {
+  constructor(ref) {
+    this.ref = ref;
+  }
+  isSatisfiedBy(candidate) {
+    const isBigger = candidate > this.ref;
+    return {
+      ok: isBigger,
+      details: !isBigger
+        ? [`candidate is not bigger than ${this.ref}`]
+        : [`candidate is not bigger than ${this.ref}`],
+    };
+  }
+}
+
+module.exports = { IsBiggerThan };
+```
+
+* Aplique as especificações em uma pipeline
+
+```javascript
+// index.js
+const { And } = require("@sintese/specs");
+
+const { IsEvenNumber } = require("./IsEvenNumber.js");
+const { IsBiggerThan } = require("./IsBiggerThan.js");
+
+const specAnd = new And(
+  new IsEvenNumber(),
+  new IsBiggerThan(10),
+);
+const result = specAnd.isSatisfiedBy(2);
+
+console.log(result);
+```
+
+* Ao executar o conjunto podemos validar o resultado
+
+```bash
+$ node index.js
+
+{
+  ok: false,
+  details: [ 'candidate is an even number', 'candidate is not bigger than 10' ]
+}
+```
+
+## Contribuindo
+
+Dúvidas, contribuições e sugestões são muito bem vidas.

package/dist/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from "./specs/index.js";

package/dist/cjs/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./specs/index.js"), exports);

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type": "commonjs"}

package/dist/cjs/specs/And.d.ts

@@ -0,0 +1,6 @@
+import { IResult, ISpec } from "./ISpec";
+export declare class And<T> implements ISpec<T> {
+    private specs;
+    constructor(...specs: ISpec<T>[]);
+    isSatisfiedBy(v: T): IResult;
+}

package/dist/cjs/specs/And.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.And = void 0;
+class And {
+    constructor(...specs) {
+        this.specs = specs;
+    }
+    isSatisfiedBy(v) {
+        const details = [];
+        let ok = true;
+        for (const spec of this.specs) {
+            const result = spec.isSatisfiedBy(v);
+            details.push(...(result.details || []));
+            if (result.ok) {
+                continue;
+            }
+            ok = false;
+        }
+        return { ok, details };
+    }
+}
+exports.And = And;

package/dist/cjs/specs/ISpec.d.ts

@@ -0,0 +1,7 @@
+export type IResult = {
+    ok: boolean;
+    details?: string[];
+};
+export interface ISpec<T> {
+    isSatisfiedBy(candidate: T): IResult;
+}

package/dist/cjs/specs/ISpec.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/specs/Not.d.ts

@@ -0,0 +1,6 @@
+import { IResult, ISpec } from "./ISpec";
+export declare class Not<T> implements ISpec<T> {
+    private readonly spec;
+    constructor(spec: ISpec<T>);
+    isSatisfiedBy(candidate: T): IResult;
+}

package/dist/cjs/specs/Not.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Not = void 0;
+class Not {
+    constructor(spec) {
+        this.spec = spec;
+    }
+    isSatisfiedBy(candidate) {
+        const result = this.spec.isSatisfiedBy(candidate);
+        return { ok: result.ok === false, details: result.details };
+    }
+}
+exports.Not = Not;

package/dist/cjs/specs/Or.d.ts

@@ -0,0 +1,6 @@
+import { IResult, ISpec } from "./ISpec";
+export declare class Or<T> implements ISpec<T> {
+    private specs;
+    constructor(...specs: ISpec<T>[]);
+    isSatisfiedBy(v: T): IResult;
+}

package/dist/cjs/specs/Or.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Or = void 0;
+class Or {
+    constructor(...specs) {
+        this.specs = specs;
+    }
+    isSatisfiedBy(v) {
+        const details = [];
+        let ok = true;
+        for (const spec of this.specs) {
+            const result = spec.isSatisfiedBy(v);
+            details.push(...(result.details || []));
+            if (result.ok)
+                return { ok, details };
+            ok = false;
+        }
+        return { ok, details };
+    }
+}
+exports.Or = Or;

package/dist/cjs/specs/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ISpec";
+export * from "./And";
+export * from "./Not";
+export * from "./Or";

package/dist/cjs/specs/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ISpec"), exports);
+__exportStar(require("./And"), exports);
+__exportStar(require("./Not"), exports);
+__exportStar(require("./Or"), exports);

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+export * from "./specs/index.js";

package/dist/esm/index.js

@@ -0,0 +1 @@
+export * from "./specs/index.js";

package/dist/esm/package.json

@@ -0,0 +1 @@
+{"type": "module"}

package/dist/esm/specs/And.d.ts

@@ -0,0 +1,6 @@
+import { IResult, ISpec } from "./ISpec";
+export declare class And<T> implements ISpec<T> {
+    private specs;
+    constructor(...specs: ISpec<T>[]);
+    isSatisfiedBy(v: T): IResult;
+}

package/dist/esm/specs/And.js

@@ -0,0 +1,18 @@
+export class And {
+    constructor(...specs) {
+        this.specs = specs;
+    }
+    isSatisfiedBy(v) {
+        const details = [];
+        let ok = true;
+        for (const spec of this.specs) {
+            const result = spec.isSatisfiedBy(v);
+            details.push(...(result.details || []));
+            if (result.ok) {
+                continue;
+            }
+            ok = false;
+        }
+        return { ok, details };
+    }
+}

package/dist/esm/specs/ISpec.d.ts

@@ -0,0 +1,7 @@
+export type IResult = {
+    ok: boolean;
+    details?: string[];
+};
+export interface ISpec<T> {
+    isSatisfiedBy(candidate: T): IResult;
+}

package/dist/esm/specs/ISpec.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/specs/Not.d.ts

@@ -0,0 +1,6 @@
+import { IResult, ISpec } from "./ISpec";
+export declare class Not<T> implements ISpec<T> {
+    private readonly spec;
+    constructor(spec: ISpec<T>);
+    isSatisfiedBy(candidate: T): IResult;
+}

package/dist/esm/specs/Not.js

@@ -0,0 +1,9 @@
+export class Not {
+    constructor(spec) {
+        this.spec = spec;
+    }
+    isSatisfiedBy(candidate) {
+        const result = this.spec.isSatisfiedBy(candidate);
+        return { ok: result.ok === false, details: result.details };
+    }
+}

package/dist/esm/specs/Or.d.ts

@@ -0,0 +1,6 @@
+import { IResult, ISpec } from "./ISpec";
+export declare class Or<T> implements ISpec<T> {
+    private specs;
+    constructor(...specs: ISpec<T>[]);
+    isSatisfiedBy(v: T): IResult;
+}

package/dist/esm/specs/Or.js

@@ -0,0 +1,17 @@
+export class Or {
+    constructor(...specs) {
+        this.specs = specs;
+    }
+    isSatisfiedBy(v) {
+        const details = [];
+        let ok = true;
+        for (const spec of this.specs) {
+            const result = spec.isSatisfiedBy(v);
+            details.push(...(result.details || []));
+            if (result.ok)
+                return { ok, details };
+            ok = false;
+        }
+        return { ok, details };
+    }
+}

package/dist/esm/specs/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ISpec";
+export * from "./And";
+export * from "./Not";
+export * from "./Or";

package/dist/esm/specs/index.js

@@ -0,0 +1,4 @@
+export * from "./ISpec";
+export * from "./And";
+export * from "./Not";
+export * from "./Or";

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@lafrae/specification",
+  "version": "0.0.2",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "rm -rf ./dist",
+    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -b ./tsconfig.esm.json && echo '{\"type\": \"module\"}' > dist/esm/package.json",
+    "build:cjs": "tsc -b ./tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json"
+  },
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  }
+}