kidscipher 0.5.0 → 0.7.0

package/dist/types/cipher/Cipher.d.ts

@@ -2,6 +2,13 @@ import { CipherOptions } from '../core/cipher-options/CipherOptions';
 export type CipherConfigurationsRecord = Record<string, any>;
 declare abstract class Cipher {
     abstract encodeToken(token: string, configuration?: CipherConfigurationsRecord): string;
+    /**
+     * Tokenize input using a dictionary of valid tokens.
+     * Longest tokens win.
+     */
+    protected tokenize(input: string, tokens: string[]): string[];
+    abstract getEncodeTokens(): string[];
+    abstract getDecodeTokens(): string[];
     encode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;
     abstract decodeToken(token: string, configuration?: CipherConfigurationsRecord): string;
     decode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;

package/dist/types/cipher/morsecode/MorseCodeAlphabet.d.ts

@@ -0,0 +1,16 @@
+export declare const MORSE_CODE_ALPHABETS: {
+    intl: Record<string, string>;
+    cs: {
+        CH: string;
+    };
+    de: {
+        Ä: string;
+        Ö: string;
+        Ü: string;
+        ß: string;
+    };
+    es: {
+        Ñ: string;
+    };
+};
+export type MorseCodeAlphabetKey = keyof typeof MORSE_CODE_ALPHABETS;

package/dist/types/cipher/morsecode/MorseCodeCipher.d.ts

@@ -1,16 +1,34 @@
 import SubstitutionCipher from '../substitution/SubstitutionCipher';
 import { CipherOptions } from '../../core/cipher-options/CipherOptions';
 import { CipherConfigurationsRecord } from '../Cipher';
-export type MorseCodeCipherOptions = CipherConfigurationsRecord | {
-    dotDashMapping?: {
-        dot?: string;
-        dash?: string;
-    };
+import { MorseCodeAlphabetKey } from './MorseCodeAlphabet';
+type DotDashMapping = {
+    dot: string;
+    dash: string;
+};
+type MorseCodeCipherProps = {
+    alphabetVariant?: MorseCodeAlphabetKey;
+    dotDashMapping?: Partial<DotDashMapping>;
 };
 declare class MorseCodeCipher extends SubstitutionCipher {
-    static MORSE_CODE_MAP: Record<string, string>;
-    constructor();
-    encode(input: string, configuration?: MorseCodeCipherOptions, opts?: CipherOptions): string;
-    decode(input: string, configuration?: MorseCodeCipherOptions, opts?: CipherOptions): string;
+    private readonly dotDashMapping;
+    static readonly ALPHABETS: {
+        intl: Record<string, string>;
+        cs: {
+            CH: string;
+        };
+        de: {
+            Ä: string;
+            Ö: string;
+            Ü: string;
+            ß: string;
+        };
+        es: {
+            Ñ: string;
+        };
+    };
+    constructor({ alphabetVariant, dotDashMapping, }?: MorseCodeCipherProps);
+    encode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;
+    decode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;
 }
 export default MorseCodeCipher;

package/dist/types/cipher/number/LetterNumberCipher.d.ts

@@ -0,0 +1,11 @@
+import SubstitutionCipher from '../substitution/SubstitutionCipher';
+import { CipherOptions } from '../../core/cipher-options/CipherOptions';
+import { CipherConfigurationsRecord } from '../Cipher';
+export type LetterNumberCipherOptions = CipherConfigurationsRecord;
+declare class LetterNumberCipher extends SubstitutionCipher {
+    static readonly ALPHABET: Record<string, string>;
+    constructor();
+    encode(input: string, configuration?: LetterNumberCipherOptions, opts?: CipherOptions): string;
+    decode(input: string, configuration?: LetterNumberCipherOptions, opts?: CipherOptions): string;
+}
+export default LetterNumberCipher;

package/dist/types/cipher/shift/ShiftAlphabetCipher.d.ts

@@ -1,6 +1,5 @@
 import ShiftCipher from './ShiftCipher';
 declare class ShiftAlphabetCipher extends ShiftCipher {
-    static DEFAULT_ALPHABET: string[];
-    constructor();
+    constructor(shift?: number);
 }
 export default ShiftAlphabetCipher;

package/dist/types/cipher/shift/ShiftCipher.d.ts

@@ -1,17 +1,12 @@
 import { CipherOptions } from '../../core/cipher-options/CipherOptions';
-import Cipher, { CipherConfigurationsRecord } from '../Cipher';
-export type ShiftCipherOptions = CipherConfigurationsRecord | {
-    shift: number;
-    outputAsIndex?: boolean;
-    inputAsIndex?: boolean;
-};
-declare class ShiftCipher extends Cipher {
+import { CipherConfigurationsRecord } from '../Cipher';
+import SubstitutionCipher from '../substitution/SubstitutionCipher';
+declare class ShiftCipher extends SubstitutionCipher {
     private alphabet;
-    constructor(alphabet: string[]);
-    encodeToken(token: string, configuration: ShiftCipherOptions): string;
-    decodeToken(token: string, configuration: ShiftCipherOptions): string;
-    getAllTokenIndexes(token: string, shift: number): number[];
-    encode(input: string, configuration?: ShiftCipherOptions, opts?: CipherOptions): string;
-    decode(input: string, configuration?: ShiftCipherOptions, opts?: CipherOptions): string;
+    private inputMode;
+    private outputMode;
+    constructor(alphabet: string[], shift: number, inputMode?: 'letter' | 'index', outputMode?: 'letter' | 'index');
+    encode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;
+    decode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;
 }
 export default ShiftCipher;

package/dist/types/cipher/shift/ShiftRotorABCDCipher.d.ts

@@ -4,6 +4,6 @@ declare class ShiftRotorABCDCipher extends ShiftRotorCipher {
     static REPEAT_ALPHABET: string[];
     private static generateRepeatRotorAlphabet;
     static ROTOR_ALPHABETS: string[][];
-    constructor();
+    constructor(shifts: number[]);
 }
 export default ShiftRotorABCDCipher;

package/dist/types/cipher/shift/ShiftRotorCipher.d.ts

@@ -1,18 +1,9 @@
 import { CipherOptions } from '../../core/cipher-options/CipherOptions';
-import Cipher, { CipherConfigurationsRecord } from '../Cipher';
-import ShiftCipher from './ShiftCipher';
-export type ShiftRotorCipherOptions = CipherConfigurationsRecord | {
-    shifts: number[];
-    outputAsIndex?: boolean;
-    inputAsIndex?: boolean;
-};
-declare class ShiftRotorCipher extends Cipher {
-    baseAlphabet: ShiftCipher;
-    rotors: ShiftCipher[];
-    constructor(baseAlphabet: ShiftCipher, rotors: ShiftCipher[]);
-    encodeToken(token: string, configuration: ShiftRotorCipherOptions): string;
-    decodeToken(token: string, configuration: ShiftRotorCipherOptions): string;
-    encode(input: string, configuration?: ShiftRotorCipherOptions, opts?: CipherOptions): string;
-    decode(input: string, configuration?: ShiftRotorCipherOptions, opts?: CipherOptions): string;
+import { CipherConfigurationsRecord } from '../Cipher';
+import SubstitutionCipher from '../substitution/SubstitutionCipher';
+declare class ShiftRotorCipher extends SubstitutionCipher {
+    constructor(baseAlphabet: string[], rotors: string[][], shifts: number[]);
+    encode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;
+    decode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;
 }
 export default ShiftRotorCipher;

package/dist/types/cipher/substitution/SubstitutionCipher.d.ts

@@ -2,7 +2,11 @@ import Cipher from '../Cipher';
 declare class SubstitutionCipher extends Cipher {
     protected encodeMap: Record<string, string>;
     protected decodeMap: Record<string, string>;
+    protected encodeTokens: string[];
+    protected decodeTokens: string[];
     constructor(encodeMap: Record<string, string>);
+    getEncodeTokens(): string[];
+    getDecodeTokens(): string[];
     encodeToken(token: string): string;
     decodeToken(token: string): string;
 }

package/dist/types/cipher/substitution/SubstitutionCyclicCipher.d.ts

@@ -4,7 +4,11 @@ declare class SubstitutionCyclicCipher extends Cipher {
     protected encodeMap: Record<string, string[]>;
     protected decodeMap: Record<string, string>;
     protected counters: Record<string, number>;
+    protected encodeTokens: string[];
+    protected decodeTokens: string[];
     constructor(encodeMap: Record<string, string | string[]>);
+    getEncodeTokens(): string[];
+    getDecodeTokens(): string[];
     resetCounters: () => void;
     encodeToken(token: string): string;
     encode(input: string, configuration?: CipherConfigurationsRecord, opts?: CipherOptions): string;

package/dist/types/core/alphabet/MapCz.d.ts

@@ -0,0 +1,47 @@
+export declare const ALPHABET_CZ: {
+    readonly A: "A";
+    readonly Á: "Á";
+    readonly B: "B";
+    readonly C: "C";
+    readonly Č: "Č";
+    readonly D: "D";
+    readonly Ď: "Ď";
+    readonly E: "E";
+    readonly É: "É";
+    readonly Ě: "Ě";
+    readonly F: "F";
+    readonly G: "G";
+    readonly H: "H";
+    readonly CH: "CH";
+    readonly I: "I";
+    readonly Í: "Í";
+    readonly J: "J";
+    readonly K: "K";
+    readonly L: "L";
+    readonly M: "M";
+    readonly N: "N";
+    readonly Ň: "Ň";
+    readonly O: "O";
+    readonly Ó: "Ó";
+    readonly P: "P";
+    readonly Q: "Q";
+    readonly R: "R";
+    readonly Ř: "Ř";
+    readonly S: "S";
+    readonly Š: "Š";
+    readonly T: "T";
+    readonly Ť: "Ť";
+    readonly U: "U";
+    readonly Ú: "Ú";
+    readonly Ů: "Ů";
+    readonly V: "V";
+    readonly W: "W";
+    readonly X: "X";
+    readonly Y: "Y";
+    readonly Ý: "Ý";
+    readonly Z: "Z";
+    readonly Ž: "Ž";
+};
+export type AlphabetCz = (typeof ALPHABET_CZ)[keyof typeof ALPHABET_CZ];
+export declare const ALPHABET_CZ_ARRAY: AlphabetCz[];
+export declare const ALPHABET_CZ_NO_PUNCTUATION_ARRAY: AlphabetCz[];

package/dist/types/core/alphabet/MapEn.d.ts

@@ -0,0 +1,30 @@
+export declare const ALPHABET_EN: {
+    readonly A: "A";
+    readonly B: "B";
+    readonly C: "C";
+    readonly D: "D";
+    readonly E: "E";
+    readonly F: "F";
+    readonly G: "G";
+    readonly H: "H";
+    readonly I: "I";
+    readonly J: "J";
+    readonly K: "K";
+    readonly L: "L";
+    readonly M: "M";
+    readonly N: "N";
+    readonly O: "O";
+    readonly P: "P";
+    readonly Q: "Q";
+    readonly R: "R";
+    readonly S: "S";
+    readonly T: "T";
+    readonly U: "U";
+    readonly V: "V";
+    readonly W: "W";
+    readonly X: "X";
+    readonly Y: "Y";
+    readonly Z: "Z";
+};
+export type AlphabetEn = (typeof ALPHABET_EN)[keyof typeof ALPHABET_EN];
+export declare const ALPHABET_EN_ARRAY: AlphabetEn[];

package/dist/types/core/alphabet/MapNumbers.d.ts

@@ -0,0 +1,14 @@
+export declare const ALPHABET_NUMBERS: {
+    '0': string;
+    '1': string;
+    '2': string;
+    '3': string;
+    '4': string;
+    '5': string;
+    '6': string;
+    '7': string;
+    '8': string;
+    '9': string;
+};
+export type AlphabetNumber = (typeof ALPHABET_NUMBERS)[keyof typeof ALPHABET_NUMBERS];
+export declare const ALPHABET_NUMBERS_ARRAY: AlphabetNumber[];

package/dist/types/font.d.ts

@@ -1,2 +1,5 @@
 import './fonts/Kidscipher.css';
+import './fonts/Kidscipher.ttf';
+import './fonts/Kidscipher.woff';
+import './fonts/Kidscipher.woff2';
 export { KidscipherGlyphs } from './fonts/KidscipherGlyphs';

package/dist/types/index.d.ts

@@ -15,3 +15,4 @@ export { default as ShiftRotorABCDCipher } from './cipher/shift/ShiftRotorABCDCi
 export { default as Substitution2DCipher } from './cipher/substitution/Substitution2DCipher';
 export { default as TableKeyFiveToFiveCipher } from './cipher/table/TableKeyFiveToFiveCipher';
 export { default as ChessCipher } from './cipher/table/ChessCipher';
+export { default as LetterNumberCipher } from './cipher/number/LetterNumberCipher';

package/package.json

@@ -1,19 +1,26 @@
 {
   "name": "kidscipher",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "license": "MIT",
   "homepage": "https://github.com/fandau1/kidscipher",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fandau1/kidscipher.git"
+  },
   "type": "module",
   "types": "dist/types/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/index.esm.js",
-      "require": "./dist/index.cjs.js"
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/types/index.d.ts"
     },
     "./font": {
       "import": "./dist/font.esm.js",
-      "require": "./dist/font.cjs.js"
+      "require": "./dist/font.cjs.js",
+      "types": "./dist/types/font.d.ts"
     },
+    "./assets/*": "./dist/assets/*",
     "./kidscipher.css": "./dist/kidscipher.css"
   },
   "scripts": {