chore(package): add typing

Author: blond

globals.d.ts

@@ -0,0 +1,109 @@
+declare namespace BemSDK {
+    export namespace EntityName {
+        /**
+         * Types of BEM entities.
+         */
+        export type TYPE = 'block' | 'blockMod' | 'elem' | 'elemMod';
+
+        /**
+         * Abstract object to represent entity name
+         */
+        interface AbstractEntityRepresentation {
+            /**
+             * The block name of entity.
+             */
+            block: string;
+            /**
+             * The element name of entity.
+             */
+            elem?: string;
+            mod?: any;
+        }
+
+        /**
+         * Object to represent modifier of entity name.
+         */
+        export interface ModifierRepresentation {
+            /**
+             * The modifier name of entity.
+             */
+            name: string;
+            /**
+             * The modifier value of entity.
+             */
+            val: string | true;
+        }
+
+        /**
+         * Strict object to represent entity name.
+         */
+        export interface StrictRepresentation extends AbstractEntityRepresentation {
+            /**
+             * The modifier of entity.
+             */
+            mod?: ModifierRepresentation;
+        }
+
+        /**
+         * Object to create representation of entity name.
+         */
+        export interface Options extends AbstractEntityRepresentation {
+            /**
+             * The modifier of entity.
+             */
+            mod?: string | {
+                /**
+                 * The modifier name of entity.
+                 */
+                name: string;
+                /**
+                 * The modifier value of entity.
+                 */
+                val?: string | boolean;
+            };
+            /**
+             * The modifier name of entity. Used if `mod.name` wasn't specified.
+             * @deprecated use `mod.name` instead.
+             */
+            modName?: string;
+            /**
+             * The modifier value of entity. Used if neither `mod.val` nor `val` were not specified.
+             * @deprecated use `mod.name` instead.
+             */
+            modVal?: string;
+        }
+
+        /**
+         * Non-strict object to represent entity name.
+         *
+         * Contains old field: `val`, `modName` and `modVal.
+         */
+        export interface NonStrictRepresentation extends AbstractEntityRepresentation {
+            /**
+             * The modifier of entity.
+             */
+            mod?: string | {
+                /**
+                 * The modifier name of entity.
+                 */
+                name: string;
+                /**
+                 * The modifier value of entity.
+                 */
+                val?: string | boolean;
+            };
+            /**
+             * The modifier value of entity. Used if neither `mod.val` were not specified.
+             */
+            val?: string;
+            /**
+             * The modifier name of entity. Used if `mod.name` wasn't specified.
+             */
+            modName?: string;
+            /**
+             * The modifier value of entity. Used if neither `mod.val` nor `val` were not specified.
+             */
+            modVal?: string;
+        }
+    }
+}

index.d.ts

@@ -0,0 +1,25 @@
+import './globals.d';
+
+declare class BemEntityName {
+    constructor(obj: BemSDK.EntityName.Options);
+
+    readonly block: string;
+    readonly elem: string | undefined;
+    readonly mod: BemSDK.EntityName.ModifierRepresentation | undefined;
+    readonly modName: string | undefined;
+    readonly modVal: string | true | undefined;
+    readonly id: string;
+    readonly type: BemSDK.EntityName.TYPE;
+
+    isSimpleMod(): boolean | null;
+    toString(): string;
+    valueOf(): BemSDK.EntityName.StrictRepresentation;
+    inspect(depth: number, options: object): string;
+    toJSON(): BemSDK.EntityName.StrictRepresentation;
+    isEqual(entityName: BemEntityName): boolean;
+
+    static isBemEntityName(entityName: any): boolean;
+    static create(obj: BemSDK.EntityName.NonStrictRepresentation | string): BemEntityName;
+}
+
+export = BemEntityName;

index.js

@@ -33,7 +33,7 @@ class EntityTypeError extends ExtendableError {
     }
 }
 
-module.exports = class BemEntityName {
+class BemEntityName {
     /**
      * @param {object} obj — representation of entity name.
      * @param {string} obj.block  — the block name of entity.
@@ -378,4 +378,11 @@ module.exports = class BemEntityName {
 
         return new BemEntityName(data);
     }
-};
+}
+
+module.exports = BemEntityName;
+
+// TypeScript imports the `default` property for
+// an ES2015 default import (`import BemEntityName from '@bem/entity-name'`)
+// See: https://github.com/Microsoft/TypeScript/issues/2242#issuecomment-83694181
+module.exports.default = BemEntityName;

jsconfig.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+        "target": "ES6",
+        "module": "commonjs"
+    },
+    "files": [
+        "index.js",
+        "index.d.ts"
+    ]
+}

package.json

@@ -22,8 +22,10 @@
     "equal"
   ],
   "main": "index.js",
+  "typings": "index.d.ts",
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "engines": {
     "node": ">= 4.0"
@@ -33,13 +35,15 @@
     "es6-error": "4.0.2"
   },
   "devDependencies": {
+    "@types/proxyquire": "^1.3.27",
+    "@types/sinon": "^2.1.2",
     "ava": "^0.19.0",
     "coveralls": "^2.11.9",
     "eslint": "^3.0.0",
     "eslint-config-pedant": "^0.8.0",
     "nyc": "^10.0.0",
     "proxyquire": "^1.7.7",
-    "sinon": "^2.0.0"
+    "sinon": "^2.1.0"
   },
   "scripts": {
     "test": "npm run lint && npm run cover",