@windingtree/org.id-utils - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

dist/errors/index.d.ts

 import { Status, Code } from '../http';
-declare type ErrorArgs = [string, Status?];
+export declare type ErrorArgs = [string, Status?];
 export interface HttpError {
@@ -15,2 +15,1 @@ code: Code;
 }
-export {};

dist/index.d.ts

 export * as uid from './uid';
 export * as http from './http';
 export * as errors from './errors';
+export * as regexp from './regexp';

dist/index.js

@@ -22,6 +22,7 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.errors = exports.http = exports.uid = void 0;
+exports.regexp = exports.errors = exports.http = exports.uid = void 0;
 exports.uid = __importStar(require("./uid"));
 exports.http = __importStar(require("./http"));
 exports.errors = __importStar(require("./errors"));
+exports.regexp = __importStar(require("./regexp"));
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "@windingtree/org.id-utils",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Shared ORGiD utilities",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
-    "/dist"
+    "dist"
   ],
+  "publishConfig":{
+    "access": "public"
+  },
   "scripts": {
@@ -14,3 +17,3 @@ "lint": "npx eslint . --ext .ts",
     "build": "rm -rf dist && npx tsc -p tsconfig-build.json",
-    "build:docs": "rm -rf docs && npx typedoc --plugin typedoc-plugin-markdown --entryDocument docs/modules.md --out docs src/index.ts",
+    "build:docs": "rm -rf docs && npx typedoc --plugin typedoc-plugin-markdown --readme none --out docs src/index.ts",
     "test": "npx jest",
@@ -39,2 +42,4 @@ "test:coverage": "npx jest --coverage"
   "devDependencies": {
+    "jest": "26.6.3",
+    "ts-jest": "26.5.6",
     "@types/jest": "26.0.23",
@@ -44,3 +49,2 @@ "eslint": "7.26.0",
     "@typescript-eslint/parser": "4.24.0",
-    "ts-jest": "26.5.6",
     "typedoc": "0.20.36",
@@ -47,0 +51,0 @@ "typedoc-plugin-markdown": "3.8.1",

README.md

@@ -0,1 +1,2 @@
+[![@windingtree/org.id-utils](https://img.shields.io/npm/v/@windingtree/org.id-utils.svg)](https://www.npmjs.com/package/@windingtree/org.id-utils)
 # @windingtree/org.id-utils
@@ -12,2 +13,6 @@ Shared ORGiD utilities
 
+### simpleUid(length)
+
+Creates a unique Id. Length is an optional parameter with a value from 5 to 11.
+
 ```javascript
@@ -23,10 +28,58 @@ import {
 
-## Utilities
+### Regular expressions
 
-### simpleUid(length)
+RegExp collection for some validation cases
 
-Creates a unique Id. Length is an optional parameter with a value from 5 to 11.
+```javascript
+import { regexp } from '@windingtree/org.id-utils';
 
+console.log(Object.keys(regexp));
+/*
+[
+  phone,
+  uri,
+  email,
+  ethereumAddress,
+  bitcoinAddress,
+  X25519,          // <-- X25519 pub key
+  secp256k1,       // <-- secp256k1 pub key
+  bytes32,
+  swift,
+  iban
+]
+*/
+```
+
+### HTTP response codes
+
+HTTP-related constants and utilities
+
+```javascript
+import {
+  http: {
+    HTTP_STATUS,
+    HTTP_STATUS_CODES,
+    HTTP_METHODS
+  }
+} from '@windingtree/org.id-utils';
+
+console.log(HTTP_STATUS_CODES);
+/*
+{
+  OK: 200,
+  BAD_REQUEST: 400,
+  UNAUTHORIZED: 401,
+  FORBIDDEN: 403,
+  NOT_FOUND: 404,
+  METHOD_NOT_ALLOWED: 405,
+  INTERNAL_SERVER_ERROR: 500,
+  NOT_IMPLEMENTED: 501,
+  BAD_GATEWAY: 502,
+  SERVICE_UNAVAILABLE: 503
+}
+*/
+```
+
 ## Documentation
 
-[Generated docs](docs/docs/modules.md)
+[Generated docs](docs#readme)

No alert changes

Improved metrics

Total package byte prevSize

12558

increased by37.79%

Number of package files

20

increased by17.65%

Lines of code

185

increased by20.92%

Number of lines in readme file

84

increased by170.97%

Worsened metrics

Dev dependency count

9

increased by12.5%

No dependency changes