@neurodevs/node-tdd 0.2.5 → 1.0.1

package/src/workspace/widgets.types.ts

@@ -0,0 +1,102 @@
+import { EventEmitter } from 'events'
+
+export interface EventSignatureMap {
+    [eventName: string]: {
+        emitPayloadSchema?: any
+    }
+}
+
+export interface EventContract {
+    eventSignatures: EventSignatureMap
+}
+
+export type MercuryEventEmitter<Contract extends EventContract = any> =
+    EventEmitter & {
+        emit(
+            eventName: keyof Contract['eventSignatures'] & string,
+            payload?: any
+        ): any
+        on(
+            eventName: keyof Contract['eventSignatures'] & string,
+            listener: (payload?: any) => void | Promise<void>
+        ): any
+    }
+
+export interface WidgetPadding {
+    top?: number
+    left?: number
+    bottom?: number
+    right?: number
+}
+
+export interface WidgetButton {
+    label: string
+    onClick?: (cb: () => void) => void
+}
+
+export interface BaseWidget<
+    Contract extends EventContract = any,
+> extends MercuryEventEmitter<Contract> {
+    type: string
+    getId(): string | null
+    getFrame(): WidgetFrameCalculated
+    setFrame(frame: Partial<WidgetFrame>): void
+    getParent(): BaseWidget | null
+    destroy(): Promise<void>
+    getChildById(id?: string): BaseWidget | null
+    getChildren(): BaseWidget[]
+    addChild(child: BaseWidget): void
+    removeChild(child: BaseWidget): void
+}
+
+export type Color =
+    | 'black'
+    | 'red'
+    | 'green'
+    | 'yellow'
+    | 'blue'
+    | 'magenta'
+    | 'cyan'
+    | 'white'
+    | 'gray'
+    | 'brightRed'
+    | 'brightGreen'
+    | 'brightYellow'
+    | 'brightBlue'
+    | 'brightMagenta'
+    | 'brightCyan'
+    | 'brightWhite'
+
+export interface UniversalWidgetOptions {
+    id?: string
+    width?: WidgetFrameAttribute
+    height?: WidgetFrameAttribute
+    left?: WidgetFrameAttribute
+    top?: WidgetFrameAttribute
+    parent?: BaseWidget
+    padding?: WidgetPadding
+    shouldLockWidthWithParent?: boolean
+    shouldLockHeightWithParent?: boolean
+    shouldLockRightWithParent?: boolean
+    shouldLockBottomWithParent?: boolean
+    eventContract?: EventContract
+    backgroundColor?: Color
+    foregroundColor?: Color
+    focusable?: boolean
+}
+
+export interface WidgetFrame {
+    left: WidgetFrameAttribute
+    top: WidgetFrameAttribute
+    width: WidgetFrameAttribute
+    height: WidgetFrameAttribute
+}
+
+export interface WidgetFrameCalculated {
+    left: number
+    top: number
+    width: number
+    height: number
+}
+
+export type WidgetFrameAttribute = number | string

package/src/workspace/window.types.ts

@@ -0,0 +1,22 @@
+import { BaseWidget } from './widgets.types.js'
+
+// ** Window Widget ** //
+export const windowEventContract = {
+    eventSignatures: {
+        key: {},
+        kill: {},
+        resize: {},
+    },
+}
+
+export type WindowEventContract = typeof windowEventContract
+
+export interface WindowWidgetOptions {}
+
+export interface WindowWidget extends BaseWidget<WindowEventContract> {
+    readonly type: 'window'
+    hideCursor: () => void
+    showCursor: () => void
+    setTitle: (title: string) => void
+    getFocusedWidget(): BaseWidget | null
+}

package/tsconfig.json

@@ -1,28 +1,24 @@
 {
-	"compilerOptions": {
-		"module": "nodenext",
-		"moduleResolution": "nodenext",
-		"target": "ES2022",
-		"lib": ["ES2022"],
-		"types": ["node"],
-		"baseUrl": "src",
-		"outDir": "build",
-		"sourceMap": false,
-		"strict": true,
-		"noImplicitAny": true,
-		"noImplicitReturns": true,
-		"noUnusedLocals": true,
-		"forceConsistentCasingInFileNames": true,
-		"declaration": true,
-		"skipLibCheck": true,
-		"esModuleInterop": true,
-		"moduleDetection": "force",
-		"allowJs": true,
-		"resolveJsonModule": true,
-		"experimentalDecorators": true
-	},
-	"include": [
-		"./src/*.ts",
-		"./src/**/*.ts"
-	]
-}
+  "compilerOptions": {
+    "module": "nodenext",
+    "target": "esnext",
+    "lib": ["esnext"],
+    "types": ["node", "jest"],
+    "rootDir": "src",
+    "outDir": "build",
+    "sourceMap": false,
+    "strict": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "moduleDetection": "force",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "experimentalDecorators": true
+  },
+  "include": ["./src/*.ts", "./src/**/*.ts"]
+}

package/build/__tests__/AbstractPackageTest.d.ts

@@ -1,4 +0,0 @@
-import AbstractModuleTest from '../impl/AbstractModuleTest.js';
-export default abstract class AbstractPackageTest extends AbstractModuleTest {
-    protected static beforeEach(): Promise<void>;
-}

package/build/__tests__/AbstractPackageTest.js

@@ -1,7 +0,0 @@
-import AbstractModuleTest from '../impl/AbstractModuleTest.js';
-export default class AbstractPackageTest extends AbstractModuleTest {
-    static async beforeEach() {
-        await super.beforeEach();
-    }
-}
-//# sourceMappingURL=AbstractPackageTest.js.map

package/build/__tests__/AbstractPackageTest.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AbstractPackageTest.js","sourceRoot":"","sources":["../../src/__tests__/AbstractPackageTest.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,+BAA+B,CAAA;AAE9D,MAAM,CAAC,OAAO,OAAgB,mBAAoB,SAAQ,kBAAkB;IAC9D,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;IAC5B,CAAC;CACJ"}

package/build/__tests__/functions/assertFunction.test.d.ts

@@ -1,5 +0,0 @@
-import AbstractPackageTest from '../AbstractPackageTest.js';
-export default class AssertFunctionTest extends AbstractPackageTest {
-    protected static beforeEach(): Promise<void>;
-    protected static returnsAssertObjectFromSpruceTestUtils(): Promise<void>;
-}

package/build/__tests__/functions/assertFunction.test.js

@@ -1,23 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-import assert from '../../functions/assert.js';
-import AbstractPackageTest from '../AbstractPackageTest.js';
-const { test, assert: spruceAssert } = require('@sprucelabs/test-utils');
-export default class AssertFunctionTest extends AbstractPackageTest {
-    static async beforeEach() {
-        await super.beforeEach();
-    }
-    static async returnsAssertObjectFromSpruceTestUtils() {
-        spruceAssert.isEqualDeep(assert, spruceAssert, 'Did not return expected assert object!');
-    }
-}
-__decorate([
-    test()
-], AssertFunctionTest, "returnsAssertObjectFromSpruceTestUtils", null);
-//# sourceMappingURL=assertFunction.test.js.map

package/build/__tests__/functions/assertFunction.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"assertFunction.test.js","sourceRoot":"","sources":["../../../src/__tests__/functions/assertFunction.test.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE9C,OAAO,MAAM,MAAM,2BAA2B,CAAA;AAC9C,OAAO,mBAAmB,MAAM,2BAA2B,CAAA;AAE3D,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAA;AAExE,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,mBAAmB;IACrD,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;IAC5B,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,sCAAsC;QACzD,YAAY,CAAC,WAAW,CACpB,MAAM,EACN,YAAY,EACZ,wCAAwC,CAC3C,CAAA;IACL,CAAC;CACJ;AAP0B;IADtB,IAAI,EAAE;sEAON"}

package/build/__tests__/functions/testFunction.test.d.ts

@@ -1,5 +0,0 @@
-import AbstractPackageTest from '../AbstractPackageTest.js';
-export default class TestFunctionTest extends AbstractPackageTest {
-    protected static beforeEach(): Promise<void>;
-    protected static returnsTestObjectFromSpruceTestUtils(): Promise<void>;
-}

package/build/__tests__/functions/testFunction.test.js

@@ -1,23 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-import test from '../../functions/test.js';
-import AbstractPackageTest from '../AbstractPackageTest.js';
-const { test: spruceTest, assert } = require('@sprucelabs/test-utils');
-export default class TestFunctionTest extends AbstractPackageTest {
-    static async beforeEach() {
-        await super.beforeEach();
-    }
-    static async returnsTestObjectFromSpruceTestUtils() {
-        assert.isEqualDeep(test, spruceTest, 'Did not return expected test object!');
-    }
-}
-__decorate([
-    test()
-], TestFunctionTest, "returnsTestObjectFromSpruceTestUtils", null);
-//# sourceMappingURL=testFunction.test.js.map

package/build/__tests__/functions/testFunction.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"testFunction.test.js","sourceRoot":"","sources":["../../../src/__tests__/functions/testFunction.test.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE9C,OAAO,IAAI,MAAM,yBAAyB,CAAA;AAC1C,OAAO,mBAAmB,MAAM,2BAA2B,CAAA;AAE3D,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAA;AAEtE,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,mBAAmB;IACnD,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;IAC5B,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,oCAAoC;QACvD,MAAM,CAAC,WAAW,CACd,IAAI,EACJ,UAAU,EACV,sCAAsC,CACzC,CAAA;IACL,CAAC;CACJ;AAP0B;IADtB,IAAI,EAAE;kEAON"}

package/build/__tests__/impl/AbstractModuleTest.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"AbstractModuleTest.test.js","sourceRoot":"","sources":["../../../src/__tests__/impl/AbstractModuleTest.test.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAE9C,OAAO,kBAAkB,MAAM,kCAAkC,CAAA;AACjE,OAAO,mBAAmB,MAAM,2BAA2B,CAAA;AAE3D,MAAM,EACF,OAAO,EAAE,kBAAkB,EAC3B,IAAI,EACJ,MAAM,GACT,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAA;AAErC,MAAM,CAAC,OAAO,OAAO,2BAA4B,SAAQ,mBAAmB;IAC9D,MAAM,CAAC,KAAK,CAAC,UAAU;QAC7B,MAAM,KAAK,CAAC,UAAU,EAAE,CAAA;IAC5B,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,yBAAyB;QAC5C,MAAM,CAAC,YAAY,CACf,IAAI,kBAAkB,EAAE,EACxB,kBAAkB,EAClB,oCAAoC,CACvC,CAAA;IACL,CAAC;IAGsB,AAAb,MAAM,CAAC,KAAK,CAAC,kCAAkC;QACrD,aAAa;QACb,MAAM,QAAQ,GAAG,kBAAkB,CAAC,UAAU,EAAE,CAAA;QAEhD,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,kCAAkC,CAAC,CAAA;IACjE,CAAC;CACJ;AAf0B;IADtB,IAAI,EAAE;kEAON;AAGsB;IADtB,IAAI,EAAE;2EAMN"}

package/build/functions/assert.d.ts

@@ -1,3 +0,0 @@
-import testUtils from '@sprucelabs/test-utils';
-declare const assert: testUtils.ISpruceAssert;
-export default assert;

package/build/functions/assert.js

@@ -1,4 +0,0 @@
-import testUtils from '@sprucelabs/test-utils';
-const { assert } = testUtils;
-export default assert;
-//# sourceMappingURL=assert.js.map

package/build/functions/assert.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"assert.js","sourceRoot":"","sources":["../../src/functions/assert.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,wBAAwB,CAAA;AAC9C,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;AAE5B,eAAe,MAAM,CAAA"}

package/build/functions/test.d.ts

@@ -1,3 +0,0 @@
-import testUtils from '@sprucelabs/test-utils';
-declare const test: typeof testUtils.test;
-export default test;

package/build/functions/test.js

@@ -1,4 +0,0 @@
-import testUtils from '@sprucelabs/test-utils';
-const { test } = testUtils;
-export default test;
-//# sourceMappingURL=test.js.map

package/build/functions/test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["../../src/functions/test.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,wBAAwB,CAAA;AAC9C,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAA;AAE1B,eAAe,IAAI,CAAA"}

package/eslint.config.mjs

@@ -1,3 +0,0 @@
-import eslintConfigSpruce from 'eslint-config-spruce'
-
-export default eslintConfigSpruce

package/src/__tests__/AbstractPackageTest.ts

@@ -1,7 +0,0 @@
-import AbstractModuleTest from '../impl/AbstractModuleTest.js'
-
-export default abstract class AbstractPackageTest extends AbstractModuleTest {
-    protected static async beforeEach() {
-        await super.beforeEach()
-    }
-}

package/src/__tests__/functions/assertFunction.test.ts

@@ -1,22 +0,0 @@
-import { createRequire } from 'module'
-const require = createRequire(import.meta.url)
-
-import assert from '../../functions/assert.js'
-import AbstractPackageTest from '../AbstractPackageTest.js'
-
-const { test, assert: spruceAssert } = require('@sprucelabs/test-utils')
-
-export default class AssertFunctionTest extends AbstractPackageTest {
-    protected static async beforeEach() {
-        await super.beforeEach()
-    }
-
-    @test()
-    protected static async returnsAssertObjectFromSpruceTestUtils() {
-        spruceAssert.isEqualDeep(
-            assert,
-            spruceAssert,
-            'Did not return expected assert object!'
-        )
-    }
-}

package/src/__tests__/functions/testFunction.test.ts

@@ -1,22 +0,0 @@
-import { createRequire } from 'module'
-const require = createRequire(import.meta.url)
-
-import test from '../../functions/test.js'
-import AbstractPackageTest from '../AbstractPackageTest.js'
-
-const { test: spruceTest, assert } = require('@sprucelabs/test-utils')
-
-export default class TestFunctionTest extends AbstractPackageTest {
-    protected static async beforeEach() {
-        await super.beforeEach()
-    }
-
-    @test()
-    protected static async returnsTestObjectFromSpruceTestUtils() {
-        assert.isEqualDeep(
-            test,
-            spruceTest,
-            'Did not return expected test object!'
-        )
-    }
-}

package/src/__tests__/impl/AbstractModuleTest.test.ts

@@ -1,34 +0,0 @@
-import { createRequire } from 'module'
-const require = createRequire(import.meta.url)
-
-import AbstractModuleTest from '../../impl/AbstractModuleTest.js'
-import AbstractPackageTest from '../AbstractPackageTest.js'
-
-const {
-    default: AbstractSpruceTest,
-    test,
-    assert,
-} = require('@sprucelabs/test-utils')
-
-export default class AbstractModuleTestClassTest extends AbstractPackageTest {
-    protected static async beforeEach() {
-        await super.beforeEach()
-    }
-
-    @test()
-    protected static async extendsAbstractSpruceTest() {
-        assert.isInstanceOf(
-            new AbstractModuleTest(),
-            AbstractSpruceTest,
-            'Did not extend AbstractSpruceTest!'
-        )
-    }
-
-    @test()
-    protected static async hasProtectedStaticGenerateIdMethod() {
-        // @ts-ignore
-        const randomId = AbstractModuleTest.generateId()
-
-        assert.isTruthy(randomId, 'generateId did not return an id!')
-    }
-}

package/src/functions/assert.ts

@@ -1,4 +0,0 @@
-import testUtils from '@sprucelabs/test-utils'
-const { assert } = testUtils
-
-export default assert

package/src/functions/test.ts

@@ -1,4 +0,0 @@
-import testUtils from '@sprucelabs/test-utils'
-const { test } = testUtils
-
-export default test