bb26 2.0.0 → 2.2.0

package/dist/increment.js

@@ -20,6 +20,6 @@ const to_decimal_1 = __importDefault(require("./to-decimal"));
  * @return Incremented string
  */
 function increment(string) {
-    return to_bb26_1.default(to_decimal_1.default(string) + 1);
+    return (0, to_bb26_1.default)((0, to_decimal_1.default)(string) + 1);
 }
 exports.default = increment;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import increment from './increment';
 import random from './random';
 import range from './range';
-import toDecimal from './to-decimal';
 import toBb26 from './to-bb26';
-export { increment, random, range, toDecimal, toBb26 };
+import toDecimal from './to-decimal';
+export { increment, random, range, toBb26, toDecimal };

package/dist/index.js

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toBb26 = exports.toDecimal = exports.range = exports.random = exports.increment = void 0;
+exports.toDecimal = exports.toBb26 = exports.range = exports.random = exports.increment = void 0;
 const increment_1 = __importDefault(require("./increment"));
 exports.increment = increment_1.default;
 const random_1 = __importDefault(require("./random"));
 exports.random = random_1.default;
 const range_1 = __importDefault(require("./range"));
 exports.range = range_1.default;
-const to_decimal_1 = __importDefault(require("./to-decimal"));
-exports.toDecimal = to_decimal_1.default;
 const to_bb26_1 = __importDefault(require("./to-bb26"));
 exports.toBb26 = to_bb26_1.default;
+const to_decimal_1 = __importDefault(require("./to-decimal"));
+exports.toDecimal = to_decimal_1.default;

package/dist/random.d.ts

@@ -1,3 +1,2 @@
-declare function random(upper: string): string;
-declare function random(lower: string, upper: string): string;
-export default random;
+export default function random(upper: string): string;
+export default function random(lower: string, upper: string): string;

package/dist/random.js

@@ -1,10 +1,11 @@
 "use strict";
+/* eslint-disable @typescript-eslint/unified-signatures, no-redeclare */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const random_item_1 = __importDefault(require("random-item"));
 const range_1 = __importDefault(require("./range"));
-const sample_1 = __importDefault(require("./sample"));
 /**
  * Produces a random string between the inclusive `lower` and `upper` bounds. If
  * only one argument is provided, a string between `'A'` and the given string is
@@ -23,7 +24,7 @@ const sample_1 = __importDefault(require("./sample"));
  */
 function random(lower, upper) {
     const start = upper ? lower : 'A';
-    const end = upper || lower;
-    return sample_1.default(range_1.default(start, end));
+    const end = upper !== null && upper !== void 0 ? upper : lower;
+    return (0, random_item_1.default)((0, range_1.default)(start, end));
 }
 exports.default = random;

package/dist/range.d.ts

@@ -1,3 +1,2 @@
-declare function range(end: string): string[];
-declare function range(start: string, end: string): string[];
-export default range;
+export default function range(end: string): string[];
+export default function range(start: string, end: string): string[];

package/dist/range.js

@@ -1,4 +1,5 @@
 "use strict";
+/* eslint-disable @typescript-eslint/unified-signatures, no-redeclare */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -25,12 +26,12 @@ const increment_1 = __importDefault(require("./increment"));
  * @param end - The end of the range
  */
 function range(start, end) {
-    const range = [];
-    const _end = end || start;
+    const _range = [];
+    const _end = end !== null && end !== void 0 ? end : start;
     const _start = end ? start : 'A';
-    for (let i = _start; to_decimal_1.default(i) < to_decimal_1.default(_end); i = increment_1.default(i)) {
-        range.push(i);
+    for (let i = _start; (0, to_decimal_1.default)(i) < (0, to_decimal_1.default)(_end); i = (0, increment_1.default)(i)) {
+        _range.push(i);
     }
-    return range;
+    return _range;
 }
 exports.default = range;

package/dist/to-bb26.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/** @ignore */
 function toChar(number) {
     return String.fromCharCode('A'.charCodeAt(0) - 1 + number);
 }

package/dist/to-decimal.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/** @ignore */
 function charToDecimal(letter) {
     return letter.charCodeAt(0) - 'A'.charCodeAt(0) + 1;
 }

package/license.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Patrik Csak
+Copyright (c) 2021 Patrik Csak
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,43 +1,45 @@
 {
   "name": "bb26",
-  "version": "2.0.0",
-  "description": "Bijective base-26 utility functions",
+  "version": "2.2.0",
+  "description": "Bijective base-26 utility functions for converting numbers to/from spreadsheet column letters",
   "repository": "github:ptrkcsk/BB26",
-  "author": "Patrik Csak <patrik@csak.email>",
+  "author": "Patrik Csak <p@trikcsak.com>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/ptrkcsk/BB26/issues"
   },
   "homepage": "https://github.com/ptrkcsk/BB26#readme",
   "keywords": [
-    "base-26",
-    "bijective-base-26",
+    "base 26",
+    "bijective base 26",
     "hexavigesimal",
-    "spreadsheet"
+    "spreadsheet",
+    "spreadsheet column",
+    "spreadsheet column letters"
   ],
   "main": "dist",
   "files": [
-    "dist",
-    "!dist/*.js.map"
+    "dist"
   ],
   "scripts": {
     "build": "tsc",
-    "lint": "eslint",
-    "prepublishOnly": "npm run build",
-    "test": "jest",
-    "test:coverage": "jest --coverage"
+    "format": "xo --fix",
+    "prepare": "del-cli dist && npm run build",
+    "test": "xo && ava",
+    "test:coverage": "del-cli coverage && xo && c8 ava",
+    "test:coverage:lcov": "del-cli coverage && xo && c8 --reporter=lcovonly ava"
+  },
+  "dependencies": {
+    "random-item": "^3.1.0"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@sindresorhus/tsconfig": "^0.7.0",
-    "@types/jest": "^25.2.3",
-    "@types/lodash.sample": "^4.2.6",
-    "@typescript-eslint/eslint-plugin": "^3.0.2",
-    "@typescript-eslint/parser": "^3.0.2",
-    "eslint": "^7.1.0",
-    "jest": "^26.0.1",
-    "ts-jest": "^26.0.0",
-    "typescript": "^3.9.3"
+    "@tsconfig/recommended": "^1.0.1",
+    "ava": "^3.15.0",
+    "c8": "^7.10.0",
+    "del-cli": "^4.0.1",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.0.5",
+    "xo": "^0.39.1"
   },
   "types": "dist"
 }

package/readme.md

@@ -2,9 +2,7 @@
 
 [![Test Coverage](https://api.codeclimate.com/v1/badges/c56701b3968f3de65188/test_coverage)](https://codeclimate.com/github/ptrkcsk/BB26/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/c56701b3968f3de65188/maintainability)](https://codeclimate.com/github/ptrkcsk/BB26/maintainability) [![BB26 minified and gzipped size](https://badgen.net/bundlephobia/minzip/bb26)](https://bundlephobia.com/result?p=bb26)
 
-[Bijective base-26](https://en.wikipedia.org/wiki/Bijective_numeration#The_bijective_base-26_system) utility functions for JavaScript
-
----
+JavaScript [bijective base-26](https://en.wikipedia.org/wiki/Bijective_numeration#The_bijective_base-26_system) utility functions for converting numbers to/from spreadsheet column letters
 
 ## Installation
 
@@ -12,12 +10,8 @@
 npm install bb26
 ```
 
----
-
 ## Usage
 
----
-
 ### Increment
 
 ```
@@ -34,8 +28,6 @@ increment('Z')  // 'AA'
 increment('AA') // 'AB'
 ```
 
----
-
 ### Random
 
 ```
@@ -52,8 +44,6 @@ random('AAA')         // 'NE'
 random('AAA', 'AAAA') // 'KXZ'
 ```
 
----
-
 ### Range
 
 ```
@@ -75,8 +65,6 @@ range('B', 'D')  // ['B', 'C']
 range('Z', 'AC') // ['Z', 'AA', 'AB']
 ```
 
----
-
 ### Convert from decimal to BB26
 
 ```
@@ -95,8 +83,6 @@ toBb26(27) // 'AA'
 toBb26(28) // 'AB'
 ```
 
----
-
 ### Convert from BB26 to decimal
 
 ```

package/dist/bb26-increment.d.ts

@@ -1,15 +0,0 @@
-/**
- * Increments a bijective base-26 string by one numeral.
- *
- * ```
- * import { bb26Increment } from 'bb26'
- *
- * bb26Increment('A')  // 'B'
- * bb26Increment('Z')  // 'AA'
- * bb26Increment('AA') // 'AB'
- * ```
- *
- * @param string - String to increment
- * @return Incremented string
- */
-export default function bb26Increment(string: string): string;

package/dist/bb26-increment.js

@@ -1,25 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const decimal_to_bb26_1 = __importDefault(require("./decimal-to-bb26"));
-const bb26_to_decimal_1 = __importDefault(require("./bb26-to-decimal"));
-/**
- * Increments a bijective base-26 string by one numeral.
- *
- * ```
- * import { bb26Increment } from 'bb26'
- *
- * bb26Increment('A')  // 'B'
- * bb26Increment('Z')  // 'AA'
- * bb26Increment('AA') // 'AB'
- * ```
- *
- * @param string - String to increment
- * @return Incremented string
- */
-function bb26Increment(string) {
-    return decimal_to_bb26_1.default(bb26_to_decimal_1.default(string) + 1);
-}
-exports.default = bb26Increment;

package/dist/bb26-increment.test.d.ts

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

package/dist/bb26-increment.test.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bb26_increment_1 = __importDefault(require("./bb26-increment"));
-describe('bb26Increment', () => {
-    it('Should increment A to B', () => {
-        expect(bb26_increment_1.default('A')).toBe('B');
-    });
-    it('Should increment Z to AA', () => {
-        expect(bb26_increment_1.default('Z')).toBe('AA');
-    });
-    it('Should increment ZZ to AAA', () => {
-        expect(bb26_increment_1.default('ZZ')).toBe('AAA');
-    });
-    it('Should increment AA to AB', () => {
-        expect(bb26_increment_1.default('AA')).toBe('AB');
-    });
-    it('Should increment AB to AC', () => {
-        expect(bb26_increment_1.default('AB')).toBe('AC');
-    });
-    it('Should increment AAA to AAB', () => {
-        expect(bb26_increment_1.default('AAA')).toBe('AAB');
-    });
-    it('Should increment AAB to AAC', () => {
-        expect(bb26_increment_1.default('AAB')).toBe('AAC');
-    });
-    it('Should throw if passed non-bijective base-26 string', () => {
-        expect(() => bb26_increment_1.default('abc123')).toThrow();
-    });
-});

package/dist/bb26-random.d.ts

@@ -1,3 +0,0 @@
-declare function bb26Random(upper: string): string;
-declare function bb26Random(lower: string, upper: string): string;
-export default bb26Random;

package/dist/bb26-random.js

@@ -1,29 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bb26_range_1 = __importDefault(require("./bb26-range"));
-const sample_1 = __importDefault(require("./sample"));
-/**
- * Produces a random string between the inclusive `lower` and `upper` bounds. If
- * only one argument is provided, a string between `'A'` and the given string is
- * returned.
- *
- * ```
- * import { bb26Random } from 'bb26'
- *
- * bb26Random('AAA')         // 'NE'
- * bb26Random('AAA', 'AAAA') // 'KXZ'
- * ```
- *
- * @param lower
- * @param upper
- * @returns Random string
- */
-function bb26Random(lower, upper) {
-    const start = upper ? lower : 'A';
-    const end = upper || lower;
-    return sample_1.default(bb26_range_1.default(start, end));
-}
-exports.default = bb26Random;

package/dist/bb26-random.test.d.ts

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

package/dist/bb26-random.test.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = require("./index");
-describe('bb26Random', () => {
-    describe('Given an upper bound', () => {
-        test('Should return a valid random string', () => {
-            const validLetters = index_1.bb26Range('AAA');
-            const results = [];
-            for (let i = 0; i < 1000; ++i)
-                results.push(index_1.bb26Random('ZZ'));
-            for (const result of results)
-                expect(validLetters).toContain(result);
-        });
-    });
-    describe('Given an upper and lower bound', () => {
-        test('Should return a valid random string', () => {
-            const validLetters = index_1.bb26Range('AA', 'AAA');
-            const results = [];
-            for (let i = 0; i < 1000; ++i)
-                results.push(index_1.bb26Random('AA', 'ZZ'));
-            for (const result of results)
-                expect(validLetters).toContain(result);
-        });
-    });
-});

package/dist/bb26-range.d.ts

@@ -1,3 +0,0 @@
-declare function bb26Range(end: string): string[];
-declare function bb26Range(start: string, end: string): string[];
-export default bb26Range;

package/dist/bb26-range.js

@@ -1,36 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bb26_to_decimal_1 = __importDefault(require("./bb26-to-decimal"));
-const bb26_increment_1 = __importDefault(require("./bb26-increment"));
-/**
- * Creates an array of bijective base-26 numerals progressing from `start` up
- * to, but not including, `end`.
- *
- * If `end` is not specified, it's set to `start` with `start` then set to `'A'`.
- *
- * ```
- * import { bb26Range } from 'bb26'
- *
- * bb26Range('B')       // ['A']
- * bb26Range('C')       // ['A', 'B']
- * bb26Range('B', 'C')  // ['B']
- * bb26Range('B', 'D')  // ['B', 'C']
- * bb26Range('Z', 'AC') // ['Z', 'AA', 'AB']
- * ```
- *
- * @param start - The start of the range
- * @param end - The end of the range
- */
-function bb26Range(start, end) {
-    const range = [];
-    const _end = end || start;
-    const _start = end ? start : 'A';
-    for (let i = _start; bb26_to_decimal_1.default(i) < bb26_to_decimal_1.default(_end); i = bb26_increment_1.default(i)) {
-        range.push(i);
-    }
-    return range;
-}
-exports.default = bb26Range;

package/dist/bb26-range.test.d.ts

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

package/dist/bb26-range.test.js

@@ -1,22 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bb26_range_1 = __importDefault(require("./bb26-range"));
-describe('bb26Range', () => {
-    test('Should work with end', () => {
-        expect(bb26_range_1.default('A')).toEqual([]);
-        expect(bb26_range_1.default('B')).toEqual(['A']);
-        expect(bb26_range_1.default('C')).toEqual(['A', 'B']);
-        expect(bb26_range_1.default('AB')).toContain('AA');
-    });
-    test('Should work with start and end', () => {
-        expect(bb26_range_1.default('B', 'C')).toEqual(['B']);
-        expect(bb26_range_1.default('B', 'D')).toEqual(['B', 'C']);
-        expect(bb26_range_1.default('ZZ', 'AAC')).toEqual(['ZZ', 'AAA', 'AAB']);
-    });
-    test('Should throw if given a string with a non-upper-case letter', () => {
-        expect(() => bb26_range_1.default('a')).toThrow();
-    });
-});

package/dist/bb26-to-decimal.d.ts

@@ -1,16 +0,0 @@
-/**
- * Converts a bijective base-26 string to a decimal number.
- *
- * ```
- * import { bb26ToDecimal } from 'bb26'
- *
- * bb26ToDecimal('A')  // 1
- * bb26ToDecimal('B')  // 2
- * bb26ToDecimal('Z')  // 26
- * bb26ToDecimal('AA') // 27
- * bb26ToDecimal('AB') // 28
- * ```
- *
- * @param string
- */
-export default function bb26ToDecimal(string: string): number;

package/dist/bb26-to-decimal.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/** @ignore */
-function toDecimal(letter) {
-    return letter.charCodeAt(0) - 'A'.charCodeAt(0) + 1;
-}
-/**
- * Converts a bijective base-26 string to a decimal number.
- *
- * ```
- * import { bb26ToDecimal } from 'bb26'
- *
- * bb26ToDecimal('A')  // 1
- * bb26ToDecimal('B')  // 2
- * bb26ToDecimal('Z')  // 26
- * bb26ToDecimal('AA') // 27
- * bb26ToDecimal('AB') // 28
- * ```
- *
- * @param string
- */
-function bb26ToDecimal(string) {
-    if (!/[A-Z]/.test(string)) {
-        throw new Error('String must contain only upper-case characters');
-    }
-    let number = 0;
-    for (let i = 0; i < string.length; i++) {
-        const char = string[string.length - i - 1];
-        number += Math.pow(26, i) * toDecimal(char);
-    }
-    return number;
-}
-exports.default = bb26ToDecimal;

package/dist/bb26-to-decimal.test.d.ts

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

package/dist/bb26-to-decimal.test.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bb26_to_decimal_1 = __importDefault(require("./bb26-to-decimal"));
-describe('bb26ToDecimal', () => {
-    test('Should convert A to 1', () => {
-        expect(bb26_to_decimal_1.default('A')).toBe(1);
-    });
-    test('Should convert B to 2', () => {
-        expect(bb26_to_decimal_1.default('B')).toBe(2);
-    });
-    test('Should convert Z to 26', () => {
-        expect(bb26_to_decimal_1.default('Z')).toBe(26);
-    });
-    test('Should convert AA to 27', () => {
-        expect(bb26_to_decimal_1.default('AA')).toBe(27);
-    });
-    test('Should convert AB to 28', () => {
-        expect(bb26_to_decimal_1.default('AB')).toBe(28);
-    });
-    test('Should convert AC to 29', () => {
-        expect(bb26_to_decimal_1.default('AC')).toBe(29);
-    });
-    test('Should throw if given a non-upper-case character', () => {
-        expect(() => {
-            bb26_to_decimal_1.default('a');
-        }).toThrow();
-    });
-});

package/dist/decimal-to-bb26.d.ts

@@ -1,16 +0,0 @@
-/**
- * Converts a decimal number to a bijective base-26 string.
- *
- * ```
- * import { decimalToBb26 } from 'bb26'
- *
- * decimalToBb26(1)  // 'A'
- * decimalToBb26(2)  // 'B'
- * decimalToBb26(26) // 'Z'
- * decimalToBb26(27) // 'AA'
- * decimalToBb26(28) // 'AB'
- * ```
- *
- * @param number
- */
-export default function decimalToBb26(number: number): string;

package/dist/decimal-to-bb26.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/** @ignore */
-function toChar(number) {
-    return String.fromCharCode('A'.charCodeAt(0) - 1 + number);
-}
-/**
- * Converts a decimal number to a bijective base-26 string.
- *
- * ```
- * import { decimalToBb26 } from 'bb26'
- *
- * decimalToBb26(1)  // 'A'
- * decimalToBb26(2)  // 'B'
- * decimalToBb26(26) // 'Z'
- * decimalToBb26(27) // 'AA'
- * decimalToBb26(28) // 'AB'
- * ```
- *
- * @param number
- */
-function decimalToBb26(number) {
-    let string = '';
-    let _number = number;
-    while (_number > 0) {
-        string = toChar(_number % 26 || 26) + string;
-        _number = Math.floor((_number - 1) / 26);
-    }
-    return string;
-}
-exports.default = decimalToBb26;

package/dist/decimal-to-bb26.test.d.ts

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

package/dist/decimal-to-bb26.test.js

@@ -1,26 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const decimal_to_bb26_1 = __importDefault(require("./decimal-to-bb26"));
-describe('decimalToBb26', () => {
-    test('Should convert 1 to A', () => {
-        expect(decimal_to_bb26_1.default(1)).toBe('A');
-    });
-    test('Should convert 2 to B', () => {
-        expect(decimal_to_bb26_1.default(2)).toBe('B');
-    });
-    test('Should convert 26 to Z', () => {
-        expect(decimal_to_bb26_1.default(26)).toBe('Z');
-    });
-    test('Should convert 27 to AA', () => {
-        expect(decimal_to_bb26_1.default(27)).toBe('AA');
-    });
-    test('Should convert 28 to AB', () => {
-        expect(decimal_to_bb26_1.default(28)).toBe('AB');
-    });
-    test('Should convert 29 to AC', () => {
-        expect(decimal_to_bb26_1.default(29)).toBe('AC');
-    });
-});

package/dist/sample.d.ts

@@ -1,2 +0,0 @@
-/** @ignore */
-export default function sample(array: any[]): any;

package/dist/sample.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/** @ignore */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function sample(array) {
-    return array[Math.floor(Math.random() * array.length)];
-}
-exports.default = sample;