D'ni Cavern And Surface Time Converters

This software package facilitates the following:

1. Conversion of "Earth/Surface" DateTime Objects or Strings to "Cyan's Myst's D'ni" Formatted DateTime Strings.
2. Conversion of "Cyan's Myst's D'ni" DateTime Strings to an object containing "Earth/Surface" Formatted DateTime Strings.
3. Class Settings For Controlling String Output To Another Specified Format, Including the Pahrtahvo or "nth Bell", or returning Strings that support D'ni Font Mapping.
4. Printing Important "D'ni" Dates such as holidays or miscellaneous dates.
5. Base 25 Conversion for D'ni Font Mapping Output.

Wikipedia - Myst & The D'ni

Table of Contents

• Installation
• Usage
• Contributing
• Jest Test Suites
• More Resources
• About
• Contact and Issues
• License

Installation

This package is available through the npm registry. Before installing, download and install Node.js. Node.js 20 or higher is suggested.

If this is a new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command: $ npm install dni-cavern-time

Usage

The D'ni Cavern Time Converter Package exports a default function called initDniGorahyan which once called, returns a new instance of a DniGorahyan Class.

The following methods become available to run:

1. surfaceToCavern(surfaceDateTime?: Date | string | null | undefined, useDniFontMapping?: boolean): string
   • Function Parameters
     • Returns: string - Dn'i Datetime Formatted

ES6 Import Syntax - surfaceToCavern(surfaceDateTime?):

import {BuildDniGorahyan} from 'dni-cavern-time';

const
    dniClock = BuildDniGorahyan(),
    {surfaceToCavern} = dniClock.converters,
    surfaceTimestampToConvertToDniDT = "1991-04-21T09:54:00"; // Dn'i Date Time Calendar Convergence, Provided time should be local.

const 
    usingString = surfaceToCavern(surfaceTimestampToConvertToDniDT),
    usingDate = surfaceToCavern(new Date(surfaceTimestampToConvertToDniDT)),
    usingDateAndDniFontMapping = surfaceToCavern(new Date(surfaceTimestampToConvertToDniDT), true),
    usingCallWithNoParams = surfaceToCavern();

console.log(usingString.systemProvidedSurfaceTS); // => 1991-04-21T09:54:00 Always returns Leefo 1 9647 DE 0:00:00:00
console.log(usingDate.systemProvidedSurfaceTS); // => 1991-04-21T09:54:00 Always returns Leefo 1 9647 DE 0:00:00:00
console.log(usingDateAndDniFontMapping.systemProvidedSurfaceTS); // => 1991-04-21T09:54:00 Always returns lEfo 1 9647 de 0:0:0:0
console.log(usingCallWithNoParams.systemProvidedSurfaceTS) // => Returns the user's system's current date-time in D'ni;

CommonJs Import Syntax - surfaceToCavern(surfaceDateTime?):

const { BuildDniGorahyan } = require('dni-cavern-time');

let dniClock = BuildDniGorahyan();

let { surfaceToCavern } = dniClock.converters,
    surfaceTimestampToConvertToDniDT = "1991-04-21T09:54:00"; // Dn'i Date Time Calendar Convergence, Provided time should be local.

const 
    usingString = surfaceToCavern(surfaceTimestampToConvertToDniDT),
    usingDate = surfaceToCavern(new Date(surfaceTimestampToConvertToDniDT)),
    usingDate = surfaceToCavern(new Date(surfaceTimestampToConvertToDniDT), true),
    usingCallWithNoParams = surfaceToCavern();

console.log(dniClock.systemProvidedSurfaceTS); // => 1991-04-21T09:54:00 Always returns Leefo 1 9647 DE 0:00:00:00
console.log(dniClock.systemProvidedSurfaceTS); // => 1991-04-21T09:54:00 Always returns Leefo 1 9647 DE 0:00:00:00
console.log(dniClock.systemProvidedSurfaceTS); // => 1991-04-21T09:54:00 Always returns lEfo 1 9647 de 0:0:0:0
console.log(dniClock.systemProvidedSurfaceTS) // => Returns the user's system's current date-time in D'ni;

2. cavernToSurface(cavernDateTimeString!: string): {}
   • Function Parameters
     • Required: Dn'i Datetime Formatted String do not pass a D'ni Font Mapping Value - This will be handled in a later release. "Leetar 29 9680 DE 4:11:16:08"
     • Returns: object { utc: string, cavern: string, local: string }

Example: ES6 Import Syntax - cavernToSurface(surfaceDateTime: string):

import {BuildDniGorahyan} from 'dni-cavern-time';

let
    dniTimeConverter = BuildDniGorahyan(),
    { cavernToSurface } = dniTimeConverter.converters,
    dniTimestampToConvertToSurfaceDT = "Leefo 1 9647 DE 0:00:00:00";

const convertedTS = cavernToSurface(dniTimestampToConvertToSurfaceDT);

console.log(convertedTS.systemProvidedCavernTS);

Example: CommonJs Import Syntax - cavernToSurface(surfaceDateTime: string):

const { BuildDniGorahyan } = require('dni-cavern-time');

let dniClock = BuildDniGorahyan();

let { cavernToSurface } = dniClock.converters,
    dniTimestampToConvertToSurfaceDT = "Leefo 1 9647 DE 0:00:00:00";

const convertedTS = cavernToSurface(dniTimestampToConvertToSurfaceDT);

console.log(dniClock.systemProvidedCavernTS);

3. simulateCatastrophicObjectFailure(): Thrown Error
   • This function:
     • Accepts: No Parameters
     • Returns: Thrown Error

     Error: cavernToSurface(), surfaceToCavern(), or gorahyan{} is not initialized
       at DniGorahyan._handleUninitializedConstructorArtifact

     • Purpose:
       • To test the error handling when any of the DniGorahyan properties or methods are somehow overwritten.

ES6 Import Syntax - Simulate Catastrophic Failure:

import {BuildDniGorahyan} from 'dni-cavern-time';

let
    dniTimeConverter = BuildDniGorahyan(),
    { simulateCatastrophicInitFailure } = dniTimeConverter.tests;

console.log(simulateCatastrophicInitFailure());

CommonJs Import Syntax - Simulate Catastrophic Failure:

const {} = require('dni-cavern-time');

let { simulateCatastrophicInitFailure } = dniTimeConverter.tests;

console.log(simulateCatastrophicInitFailure());

4. runControlTests(): {}
   • This function:
     • Accepts: No Parameters
     • Returns: Object { runtimeMetrics, generated: { first_test_results: string, second_test_results: string, third_test_results: string, fourth_test_results: { utc: string, cavern: string, local: string }, fifth_test_results: { utc: string, cavern: string, local: string }, sixth_test_results: { utc: string, cavern: string, local: string }, seventh_test_results: string, eighth_test_results: string, ninth_test_results: string, tenth_test_results: string, eleventh_test_results: string, twelfth_test_results: string, } }
     • Purpose:
       • To Execute Associated DniGorahyan Functions And Confirm Return Values of Known Date Conversions.
     • Functions Executed:
       • first_test_results: surfaceToCavern() => Date defaults to new Date(), Returns formatted to D'ni DateTime,
       • second_test_results: surfaceToCavern('1991-04-21T09:54:00') => Returns string formatted to D'ni DateTime,
       • third_test_results: surfaceToCavern(new Date('1991-04-21T09:54:00')) => Returns string formatted to D'ni DateTime,
       • fourth_test_results: cavernToSurface('Leefo 1 9647 DE 0:00:00:00') => Returns object with UTC, Cavern, and Local DateTimes,
       • fifth_test_results: cavernToSurface('Leevofo 8 9798 DE 2:13:00:00') => Returns object with UTC, Cavern, and Local DateTimes,
       • sixth_test_results: cavernToSurface('Leevosahn 5 9000 BE 1:05:06:07') => Returns object with UTC, Cavern, and Local DateTimes
       • seventh_test_results: surfaceToCavern('1991-04-21T09:54:00') => Returns String Using Guild of Archivist Format Type 1
       • eighth_test_results: surfaceToCavern('1991-04-21T09:54:00') => Returns String Using Guild of Archivist Format Type 2
       • ninth_test_results: surfaceToCavern('1991-04-21T09:54:00') => Returns String Using Default Timestamp Format (Trove of Gems) and D'ni Font Mapping Output
       • tenth_test_results: surfaceToCavern('1991-04-21T09:54:00') => Returns String Using Guild of Archivist Format Type 1 and D'ni Font Mapping Output
       • eleventh_test_results: surfaceToCavern('1991-04-21T09:54:00') => Returns String Using Guild of Archivist Format Type 2 and D'ni Font Mapping Output
       • twelfth_test_results: surfaceToCavern('1991-04-21T09:54:00') => Returns String Using Invalid Format Type and Including nth Bell

ES6 Import Syntax - Run Control Tests:

import {BuildDniGorahyan} from 'dni-cavern-time';

let
    dniTimeConverter = initDniGorahyan(),
    { runControlTests } = dniTimeConverter.tests;

console.log(runControlTests());

CommonJs Import Syntax - Run Control Tests:

const {BuildDniGorahyan} = require('dni-cavern-time');

let dniClock = BuildDniGorahyan();

let { runControlTests } = dniClock.tests;

console.log(runControlTests());

DniGorahyan Class Options:

const {BuildDniGorahyan} = require('dni-cavern-time');

let dniClock = BuildDniGorahyan();

// Change to Trove of Gems Timestamp Format (Default):
dniClock.switchTimestampFormatter(0);
dniClock.converters.surfaceToCavern();
console.log(dniClock.systemProvidedSurfaceTS); // => 25th Bell, 4:22:13:05, Leevot 8, 9680 DE

// Change to Guild of Archivist Timestamp Format Type 1:
dniClock.includeNthBell = false;
dniClock.switchTimestampFormatter(1);
dniClock.converters.surfaceToCavern();
console.log(dniClock.systemProvidedSurfaceTS); // => Leevot 8, 9680 DE 4:22:13:05

// Change to Guild of Archivist Timestamp Format Type 2:
dniClock.switchTimestampFormatter(2);
dniClock.converters.surfaceToCavern();
console.log(dniClock.systemProvidedSurfaceTS); // => 4:22:13:05, Leevot 8, 9680 DE

// Include the Pahrtahvo or nth Bell as part of the DateTime String:
dniClock.switchTimestampFormatter(1);
dniClock.includeNthBell = true;
dniClock.converters.surfaceToCavern();
console.log(dniClock.systemProvidedSurfaceTS); // => 25th Bell, Leevot 8, 9680 DE 4:22:13:05

// Use D'ni Font Mapping:
dniClock.useDniFontMapping = true;
dniClock.converters.surfaceToCavern();
console.log(dniClock.systemProvidedSurfaceTS); // => 10 bell, lEvot 8, %@5 de 4:\:#:5

Jest Test Suites

The last run coverage test report may be viewed here.

This package utilizes the Jest Testing Framework to test the code contained within this package. All tests are found at the following directory structure and this is where all tests should be placed: src/test

The naming convention for test files should follow the format: src/test/<dot-notation-filename>.test.ts

To run package tests, use the following command: $ npm test

More Resources

Check out work done by others regarding D'ni Timekeeping!

1. D'ni Time Converter Program by @alahmnat (On Twitter). Based on work by RIUM+, Jehon the Scribe, and rokama. Additional contributions by Brett Middleton on the Guild of Archivists.
2. 25-Hour Digital Myst Clock/Chronometer by Real Of Rium+
3. General D'ni Time Wiki by the Guild of Archivists
4. D'ni Time Conversion Wiki
5. Original Source Code Based on work by RIUM+, Jehon the Scribe, and rokama. Additional contributions by Brett Middleton on the Guild of Archivists.

About

The first item in the More Resources Section is the inspiration for this npm package. I would not have been able to create this package without the efforts of those who came before me. I have stored their original work in the following location of this software package: src/archive/original.source.code.js for posterity's sake and to preserve their original work and my source.

The code has been updated and implemented using Node and TypeScript.

Contact And Bug Reporting

You can reach me at [email protected]

To report a Bug, please create an issue here.

License

This project is licensed under the MIT License.