@ondoher/enigma 1.0.3 → 1.0.6

package/types/generator/CodeBook.d.ts

@@ -0,0 +1,82 @@
+/**
+ * Use this class to generate Enigma key sheets and messages using it. The
+ * procedures used were derived from the information at
+ * [Enigma Message Procedures](https://www.ciphermachinesandcryptology.com/en/enigmaproc.htm)
+ */
+export default class CodeBook {
+    /**
+     * Constructor for the `CodeBook` class.
+     * @param {Enigma} enigma - all encryption will be done using this configured Enigma
+     */
+    constructor(enigma: Enigma);
+    enigma: Enigma;
+    indicators: {};
+    generator: Generator;
+    /**
+     * Call this method to provide a new configuration to the enigma
+     *
+     * @param {SimplifiedConfiguration} config
+     */
+    configure(config: SimplifiedConfiguration): void;
+    reset(): void;
+    /**
+     * Call this method to create a three letter string as an identifier for a
+     * a day in a key sheet
+     *
+     * @returns {String} the string
+     */
+    makeIndicator(): string;
+    /**
+     * Call this method to create a single days configuration for a key sheet.
+     * This an Enigma configuration plus the other metadata.
+     *
+     * @param {number} day the day of the month
+     *
+     * @returns {KeySheetLine} One line of a key sheet
+     */
+    generateDay(day: number): KeySheetLine;
+    /**
+     * Call this method to construct a key sheet for the given number of days
+     *
+     * @param {Number} days the number of days on the key sheet
+     * @returns {KeySheetLine[]} the array of day objects
+     */
+    generateKeySheet(days: number): KeySheetLine[];
+    /**
+     * Call this method to process one sub-message from a longer message. This is
+     * part of code to generate a message as the Enigma would have been used.
+     *
+     * @param {string[]} indicators the three letter code that can be sent to
+     * 	reference the configuration of the Enigma. These will be used to cross
+     * reference the message to the machine configuration on the key sheet
+     * @param {String} text the cleaned up string to be encoded
+     *
+     * @returns {MessagePart} the encoded message segment
+     */
+    encodeOnePart(indicators: string[], text: string): MessagePart;
+    /**
+     * Call this method to generate a full message based on the data in a key
+     * sheet. The message constructed reflects an actual message as the Enigma
+     * was really used. An individual message cannot be more than 250
+     * characters, so longer messages are broken into multiple parts, each one
+     * encoded with a unique key
+     *
+     * @param {KeySheetLine[]} sheet a key sheet generated using generateKeySheet
+     * @param {number} [dayIdx] - if provided, specifies the day of the month for the message
+     * @param {string} [text] - if provided, this is the text of the message to generate
+     * @returns {KeyBookMessage} a list of encoded sub messages
+     */
+    generateMessage(sheet: KeySheetLine[], dayIdx?: number, text?: string): KeyBookMessage;
+    /**
+     * Call this method to generate a given number of messages based on a
+     * generated key sheet
+     *
+     * @param {Object} sheet  the generated key sheet
+     * @param {Number} count - the number of messages to generate
+     *
+     * @returns {Array} the list of generated messages
+     */
+    generateMessages(sheet: any, count: number): any[];
+}
+import Enigma from '../enigma/Enigma.js';
+import Generator from './Generator.js';

package/types/generator/Generator.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Use this class to generate random enigma configurations and messages. The
+ * methods in this class all the use the `Random` object, which can be seeded to
+ * produce a reproducible output
+ */
+export default class Generator {
+    /**
+     * Call this method to turn a string into valid characters for encryption,
+     * which is just the letters A-Z.
+     *
+     * @param {String} text the original text
+     * @returns {String} the text that has been normalized to what the Enigma
+     * 	can process
+     */
+    cleanMessage(text: string): string;
+    /**
+     * Call this method to break a string into groups of five letters with a
+     * space between them.
+     *
+     * @param {string} text - the original text
+     * @param {number} [size] - the size of the text groups, defaults to 5
+     *
+     * @returns {string} the segmented string
+     */
+    groupText(text: string, size?: number): string;
+    /**
+     * Call this method to generate the given number of sentences. The sentences
+     * are pulled from the text of Hamlet.
+     *
+     * @param {Number} count the number of sentences
+     * @returns {String} the sentences separated by a ' ';
+     */
+    generateSentences(count: number): string;
+    /**
+     * Call this method to get the possible setup and configuration options for
+     * the given model
+     *
+     * @param {Model} model
+     *
+     * @returns {ModelOptions}
+     */
+    getModelOptions(model: Model): ModelOptions;
+    /**
+     * Call this method to generate a random Enigma configuration
+     *
+     * @param {GeneratorSetup} [setup] options for settings
+
+     * @returns {SimplifiedConfiguration} the Enigma settings.
+     */
+    generateEnigmaConfiguration(setup?: GeneratorSetup): SimplifiedConfiguration;
+    /**
+     *
+     * @param {string[]} [reflectors] if given, specifies and alternate list of
+     * reflectors. Defaults to ['A', 'B', 'C'];
+     */
+    createRandomEnigma(model?: string, reflectors?: string[]): Enigma;
+    /**
+     * Call this method to generate a random message text encoded with the given
+     * Enigma. The random text will be a few sentences from Hamlet.
+     *
+     * @param {Enigma} enigma
+     *
+     * @returns {GeneratedMessage} details of the generated text
+     */
+    generateMessage(enigma: Enigma): GeneratedMessage;
+}
+import Enigma from '../enigma/Enigma.js';

package/types/generator/hamlet.d.ts

@@ -0,0 +1,2 @@
+export default sentences;
+declare const sentences: string[];

package/types/generator/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Generator } from "./Generator.js";
+export { default as CodeBook } from "./CodeBook.js";
+export { default as Random } from "../utils/Random.js";