@zyno-io/dk-server-foundation 26.216.430

package/dist/src/types/index.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__ΩEmailAddress = exports.EMAIL_REGEX = exports.__ΩNonEmptyTrimmedString = exports.__ΩTrimmedString = exports.__ΩValidDate = exports.__ΩOnUpdate = exports.__ΩDateString = exports.__ΩMethodKeys = exports.__ΩMethodsOf = exports.__ΩVoidFunction = exports.__ΩArrowFunctionNoArgs = exports.__ΩArrowFunction = exports.__ΩObjectKeysMatching = exports.__ΩRequireFields = exports.__ΩSerializable = exports.__ΩNestedKVObject = exports.__ΩKVObject = exports.__ΩStrictBool = exports.__ΩPrimitive = exports.__ΩDefinedPrimitive = exports.__ΩConcretePrimitive = void 0;
+const tslib_1 = require("tslib");
+const __ΩRecord = ['K', 'T', 'Record', 'l\'e#"Rb!b"Pde"!N#!w#y'];
+function __assignType(fn, args) {
+    fn.__type = args;
+    return fn;
+}
+/*@ts-ignore*/
+var { __ΩTypeAnnotation } = require('@deepkit/core');
+/*@ts-ignore*/
+var { __ΩPattern, __ΩDatabaseField, __ΩValidate, __ΩMinLength } = require('@deepkit/type');
+const type_1 = require("@deepkit/type");
+tslib_1.__exportStar(require("./phone"), exports);
+const __ΩConcretePrimitive = ['ConcretePrimitive', 'P&\')Jw!y'];
+exports.__ΩConcretePrimitive = __ΩConcretePrimitive;
+const __ΩDefinedPrimitive = [() => __ΩConcretePrimitive, 'DefinedPrimitive', 'Pn!,Jw"y'];
+exports.__ΩDefinedPrimitive = __ΩDefinedPrimitive;
+const __ΩPrimitive = [() => __ΩDefinedPrimitive, 'Primitive', 'Pn!-Jw"y'];
+exports.__ΩPrimitive = __ΩPrimitive;
+const __ΩStrictBool = [true, false, 'StrictBool', 'P.!."Jw#y'];
+exports.__ΩStrictBool = __ΩStrictBool;
+const __ΩKVObject = ['T', () => __ΩRecord, 'KVObject', '"c!&e!!o"#w#y'];
+exports.__ΩKVObject = __ΩKVObject;
+const __ΩNestedKVObject = ['T', () => __ΩKVObject, () => __ΩKVObject, 'NestedKVObject', '"c!Pe"!e"!Fe"!o#"Jo""w$y'];
+exports.__ΩNestedKVObject = __ΩNestedKVObject;
+const __ΩSerializable = [() => __ΩConcretePrimitive, 'T', () => __ΩNestedKVObject, () => __ΩNestedKVObject, 'Serializable', 'n!c"Pe"!e"!Fe"!o#"e"!o$"FJw%y'];
+exports.__ΩSerializable = __ΩSerializable;
+const __ΩRequireFields = ['T', 'K', 'RequireFields', 'l+e$!e"!fRb!b"Pe"!Pde#"N##Kw#y'];
+exports.__ΩRequireFields = __ΩRequireFields;
+const __ΩObjectKeysMatching = ['O', 'V', 'ObjectKeysMatching', 'lWe$!Re(!R!RPe#!e(!e\'!fqk\'+QRPde&"p-RPe$!e#!fe$"qk#>QRb!b"Pde"!gNF!e!!gfw#y'];
+exports.__ΩObjectKeysMatching = __ΩObjectKeysMatching;
+const __ΩArrowFunction = ['args', '', 'ArrowFunction', 'P"@2!"/"w#y'];
+exports.__ΩArrowFunction = __ΩArrowFunction;
+const __ΩArrowFunctionNoArgs = ['', 'ArrowFunctionNoArgs', 'P"/!w"y'];
+exports.__ΩArrowFunctionNoArgs = __ΩArrowFunctionNoArgs;
+const __ΩVoidFunction = ['', 'VoidFunction', 'P$/!w"y'];
+exports.__ΩVoidFunction = __ΩVoidFunction;
+const __ΩIfAny = ['T', 'Y', 'N', 0, 1, 'IfAny', 'l+e#"Re##Rb!b"b#P.$P.%e#!Kqk#\'Qw&y'];
+const __ΩDefinitelyFunction = ['T', () => __ΩIfAny, 'args', '', 'DefinitelyFunction', 'l;e$!R!RPe#!P"@2#"/$qk#\'QRb!e!!!Pde"!p)o"$w%y'];
+const __ΩMethodsOf = ['T', () => __ΩDefinitelyFunction, 'MethodsOf', 'lL!Re\'!RPe#!!qk#%QRPe$!e#!fPde%!e$!fo""p)GRb!Pde"!gt4!w#y'];
+exports.__ΩMethodsOf = __ΩMethodsOf;
+const __ΩMethodKeys = ['T', () => __ΩMethodsOf, 'MethodKeys', 'b!e!!o""gw#y'];
+exports.__ΩMethodKeys = __ΩMethodKeys;
+const _dateStringPattern = /^\d{4}-\d{2}-\d{2}$/;
+const __ΩDateString = [() => __ΩPattern, () => _dateStringPattern, () => __ΩDatabaseField, "DATE", 'type', () => __ΩTypeAnnotation, "dksf:type", "date", 'DateString', 'P&i"o!"P.$4%Mo#".\'.(o&#Kw)y'];
+exports.__ΩDateString = __ΩDateString;
+const __ΩOnUpdate = ['T', () => __ΩTypeAnnotation, "dksf:onUpdate", 'OnUpdate', 'b!.#e!!o"#w$y'];
+exports.__ΩOnUpdate = __ΩOnUpdate;
+const __ΩValidDate = [() => __ΩValidate, () => _validateDate, 'ValidDate', 'PTi"o!"Kw#y'];
+exports.__ΩValidDate = __ΩValidDate;
+function _validateDate(value) {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    if (!(value instanceof Date) || isNaN(value)) {
+        return new type_1.ValidatorError('invalidDate', 'The date invalid.');
+    }
+}
+_validateDate.__type = ['value', '_validateDate', 'P#2!"/"'];
+const __ΩTrimmedString = [() => __ΩTypeAnnotation, "dksf:trim", 'TrimmedString', 'P&."o!"Kw#y'];
+exports.__ΩTrimmedString = __ΩTrimmedString;
+const __ΩNonEmptyTrimmedString = [() => __ΩTrimmedString, () => __ΩMinLength, 1, 'NonEmptyTrimmedString', 'Pn!.#o""Kw$y'];
+exports.__ΩNonEmptyTrimmedString = __ΩNonEmptyTrimmedString;
+type_1.serializer.deserializeRegistry.addDecorator(__assignType(t => type_1.typeAnnotation.getType(t, 'dksf:trim') !== undefined, ['t', '', 'P"2!"/"']), __assignType((_type, state) => {
+    state.addSetter(`${state.accessor}.trim()`);
+}, ['_type', 'state', '', 'P"2!"2""/#']));
+// email
+// DK's doesn't do a full FQDN w/TLD check
+// https://github.com/deepkit/deepkit-framework/pull/558
+exports.EMAIL_REGEX = /^[a-z0-9_+.-]+@[a-z0-9-.]+\.[a-z]+$/i;
+const __ΩEmailAddress = [() => __ΩPattern, () => exports.EMAIL_REGEX, 'EmailAddress', 'P&i"o!"Kw#y'];
+exports.__ΩEmailAddress = __ΩEmailAddress;
+//# sourceMappingURL=index.js.map

package/dist/src/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;oCAA+B,eAAe;;0EAC0D,eAAe;AAAvH,wCAAwH;AAExH,kDAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCxB,MAAM,kBAAkB,GAAG,qBAAqB,CAAC;;;;;;;AAMjD,SAAS,aAAa,CAAC,KAAc;IACjC,8DAA8D;IAC9D,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,IAAI,KAAK,CAAC,KAAY,CAAC,EAAE,CAAC;QAClD,OAAO,IAAI,qBAAc,CAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;IAClE,CAAC;AACL,CAAC;;;;;;AAKD,iBAAU,CAAC,mBAAmB,CAAC,YAAY,cACvC,CAAC,CAAC,EAAE,CAAC,qBAAc,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,KAAK,SAAS,sCACzD,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;IACb,KAAK,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,QAAQ,SAAS,CAAC,CAAC;AAChD,CAAC,wCACJ,CAAC;AAEF,QAAQ;AACR,0CAA0C;AAC1C,wDAAwD;AAC3C,QAAA,WAAW,GAAG,sCAAsC,CAAC"}

package/dist/src/types/phone.d.ts

@@ -0,0 +1,11 @@
+import { TypeAnnotation } from '@deepkit/core';
+import { Validate, ValidatorError } from '@deepkit/type';
+export declare function cleanPhone(value: string, country?: string): string | null;
+export declare function formatPhoneFriendly(value: string, country?: string): string | null;
+declare function _validatePhone(value: unknown): ValidatorError | undefined;
+export type PhoneNumber = string & Validate<typeof _validatePhone> & TypeAnnotation<'dksf:type', 'phone'>;
+export type PhoneNumberNANP = string & Validate<typeof _validatePhone> & TypeAnnotation<'dksf:type', 'phoneNanp'>;
+export {};
+export declare type __ΩPhoneNumber = any[];
+export declare type __ΩPhoneNumberNANP = any[];
+//# sourceMappingURL=phone.d.ts.map

package/dist/src/types/phone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone.d.ts","sourceRoot":"","sources":["../../../src/types/phone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAA8C,QAAQ,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAQrG,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,MAAa,GAAG,MAAM,GAAG,IAAI,CAG/E;AAWD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAKlF;AAED,iBAAS,cAAc,CAAC,KAAK,EAAE,OAAO,8BAIrC;AA4BD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC,OAAO,cAAc,CAAC,GAAG,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;AAC1G,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,QAAQ,CAAC,OAAO,cAAc,CAAC,GAAG,cAAc,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC"}

package/dist/src/types/phone.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__ΩPhoneNumberNANP = exports.__ΩPhoneNumber = void 0;
+exports.cleanPhone = cleanPhone;
+exports.formatPhoneFriendly = formatPhoneFriendly;
+function __assignType(fn, args) {
+    fn.__type = args;
+    return fn;
+}
+/*@ts-ignore*/
+var { __ΩTypeAnnotation } = require('@deepkit/core');
+/*@ts-ignore*/
+var { __ΩValidate } = require('@deepkit/type');
+const type_1 = require("@deepkit/type");
+const google_libphonenumber_1 = require("google-libphonenumber");
+const helpers_1 = require("../helpers");
+const PhoneFormatter = google_libphonenumber_1.PhoneNumberUtil.getInstance();
+const InvalidPhoneSymbol = '¡InvalidPhone¡'; //Symbol('InvalidPhone');
+function cleanPhone(value, country = 'US') {
+    const cleaned = cleanPhoneInternal(value, country);
+    return cleaned === InvalidPhoneSymbol ? null : cleaned;
+}
+cleanPhone.__type = ['value', 'country', () => "US", 'cleanPhone', 'P&2!&2">#P&,J/$'];
+function cleanPhoneInternal(value, country = 'US', stripUSPrefix = false) {
+    if (typeof value !== 'string')
+        return InvalidPhoneSymbol;
+    const number = (0, helpers_1.tryOrErrorSync)(() => PhoneFormatter.parseAndKeepRawInput(value, country));
+    if (number instanceof Error)
+        return InvalidPhoneSymbol;
+    if (!PhoneFormatter.isValidNumber(number))
+        return InvalidPhoneSymbol;
+    const result = PhoneFormatter.format(number, google_libphonenumber_1.PhoneNumberFormat.E164);
+    return stripUSPrefix ? result.replace(/^\+1/, '') : result;
+}
+cleanPhoneInternal.__type = ['value', 'country', () => "US", 'stripUSPrefix', 'cleanPhoneInternal', 'P&2!&2">#"2$&/%'];
+function formatPhoneFriendly(value, country) {
+    const number = (0, helpers_1.tryOrErrorSync)(() => PhoneFormatter.parse(value, country));
+    if (number instanceof Error)
+        return null;
+    if (!PhoneFormatter.isValidNumber(number))
+        return null;
+    return PhoneFormatter.format(number, google_libphonenumber_1.PhoneNumberFormat.NATIONAL);
+}
+formatPhoneFriendly.__type = ['value', 'country', 'formatPhoneFriendly', 'P&2!&2"8P&,J/#'];
+function _validatePhone(value) {
+    if (value === InvalidPhoneSymbol) {
+        return new type_1.ValidatorError('invalidPhone', 'The phone number is invalid.');
+    }
+}
+_validatePhone.__type = ['value', '_validatePhone', 'P#2!"/"'];
+type_1.serializer.deserializeRegistry.addDecorator(__assignType(t => {
+    const typeType = type_1.typeAnnotation.getType(t, 'dksf:type');
+    return typeType?.kind === type_1.ReflectionKind.literal && typeType.literal === 'phone';
+}, ['t', '', 'P"2!"/"']), __assignType((_type, state) => {
+    state.setContext({ cleanPhoneInternal });
+    state.addCodeForSetter(`
+            ${state.setter} = cleanPhoneInternal(${state.accessor});
+        `);
+}, ['_type', 'state', '', 'P"2!"2""/#']));
+type_1.serializer.deserializeRegistry.addDecorator(__assignType(t => {
+    const typeType = type_1.typeAnnotation.getType(t, 'dksf:type');
+    return typeType?.kind === type_1.ReflectionKind.literal && typeType.literal === 'phoneNanp';
+}, ['t', '', 'P"2!"/"']), __assignType((_type, state) => {
+    state.setContext({ cleanPhoneInternal });
+    state.addCodeForSetter(`
+            ${state.setter} = cleanPhoneInternal(${state.accessor}, 'US', true);
+        `);
+}, ['_type', 'state', '', 'P"2!"2""/#']));
+const __ΩPhoneNumber = [() => __ΩValidate, () => _validatePhone, () => __ΩTypeAnnotation, "dksf:type", "phone", 'PhoneNumber', 'P&i"o!".$.%o##Kw&y'];
+exports.__ΩPhoneNumber = __ΩPhoneNumber;
+const __ΩPhoneNumberNANP = [() => __ΩValidate, () => _validatePhone, () => __ΩTypeAnnotation, "dksf:type", "phoneNanp", 'PhoneNumberNANP', 'P&i"o!".$.%o##Kw&y'];
+exports.__ΩPhoneNumberNANP = __ΩPhoneNumberNANP;
+//# sourceMappingURL=phone.js.map

package/dist/src/types/phone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone.js","sourceRoot":"","sources":["../../../src/types/phone.ts"],"names":[],"mappings":";;;AASA,gCAGC;AAWD,kDAKC;;;;;;oCA5B8B,eAAe;;8BACuC,eAAe;AAApG,wCAAqG;AACrG,iEAA2E;AAE3E,wCAA4C;AAE5C,MAAM,cAAc,GAAG,uCAAe,CAAC,WAAW,EAAE,CAAC;AACrD,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,CAAC,yBAAyB;AAEtE,SAAgB,UAAU,CAAC,KAAa,EAAE,UAAkB,IAAI;IAC5D,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACnD,OAAO,OAAO,KAAK,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;AAC3D,CAAC;;AAED,SAAS,kBAAkB,CAAC,KAAa,EAAE,UAAkB,IAAI,EAAE,aAAa,GAAG,KAAK;IACpF,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,kBAAkB,CAAC;IACzD,MAAM,MAAM,GAAG,IAAA,wBAAc,EAAC,GAAG,EAAE,CAAC,cAAc,CAAC,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACzF,IAAI,MAAM,YAAY,KAAK;QAAE,OAAO,kBAAkB,CAAC;IACvD,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,MAAM,CAAC;QAAE,OAAO,kBAAkB,CAAC;IACrE,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,yCAAiB,CAAC,IAAI,CAAC,CAAC;IACrE,OAAO,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AAC/D,CAAC;;AAED,SAAgB,mBAAmB,CAAC,KAAa,EAAE,OAAgB;IAC/D,MAAM,MAAM,GAAG,IAAA,wBAAc,EAAC,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1E,IAAI,MAAM,YAAY,KAAK;QAAE,OAAO,IAAI,CAAC;IACzC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC;IACvD,OAAO,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,yCAAiB,CAAC,QAAQ,CAAC,CAAC;AACrE,CAAC;;AAED,SAAS,cAAc,CAAC,KAAc;IAClC,IAAI,KAAK,KAAK,kBAAkB,EAAE,CAAC;QAC/B,OAAO,IAAI,qBAAc,CAAC,cAAc,EAAE,8BAA8B,CAAC,CAAC;IAC9E,CAAC;AACL,CAAC;;AAED,iBAAU,CAAC,mBAAmB,CAAC,YAAY,cACvC,CAAC,CAAC,EAAE;IACA,MAAM,QAAQ,GAAG,qBAAc,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IACxD,OAAO,QAAQ,EAAE,IAAI,KAAK,qBAAc,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,KAAK,OAAO,CAAC;AACrF,CAAC,sCACD,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;IACb,KAAK,CAAC,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACzC,KAAK,CAAC,gBAAgB,CAAC;cACjB,KAAK,CAAC,MAAM,yBAAyB,KAAK,CAAC,QAAQ;SACxD,CAAC,CAAC;AACP,CAAC,wCACJ,CAAC;AAEF,iBAAU,CAAC,mBAAmB,CAAC,YAAY,cACvC,CAAC,CAAC,EAAE;IACA,MAAM,QAAQ,GAAG,qBAAc,CAAC,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IACxD,OAAO,QAAQ,EAAE,IAAI,KAAK,qBAAc,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,KAAK,WAAW,CAAC;AACzF,CAAC,sCACD,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;IACb,KAAK,CAAC,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACzC,KAAK,CAAC,gBAAgB,CAAC;cACjB,KAAK,CAAC,MAAM,yBAAyB,KAAK,CAAC,QAAQ;SACxD,CAAC,CAAC;AACP,CAAC,wCACJ,CAAC"}

package/docs/.vitepress/config.mts

@@ -0,0 +1,79 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  srcDir: 'content',
+  title: "@signal24/dk-server-foundation",
+  description: "TypeScript foundation library built on Deepkit for building server applications",
+  base: '/dk-server-foundation/',
+  
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Getting Started', link: '/getting-started' },
+      { text: 'Guide', link: '/guide/' }
+    ],
+
+    sidebar: [
+      {
+        text: 'Introduction',
+        items: [
+          { text: 'Getting Started', link: '/getting-started' },
+          { text: 'Configuration', link: '/configuration' }
+        ]
+      },
+      {
+        text: 'Core',
+        items: [
+          { text: 'Database', link: '/database' },
+          { text: 'HTTP', link: '/http' },
+          { text: 'Authentication', link: '/authentication' },
+          { text: 'Logging', link: '/logging' },
+          { text: 'Health Checks', link: '/health' },
+          { text: 'Types', link: '/types' }
+        ]
+      },
+      {
+        text: 'Services',
+        items: [
+          { text: 'Workers', link: '/worker' },
+          { text: 'SRPC', link: '/srpc' },
+          { text: 'Leader Service', link: '/leader-service' },
+          { text: 'Mesh Service', link: '/mesh-service' },
+          { text: 'Mail', link: '/mail' }
+        ]
+      },
+      {
+        text: 'Utilities',
+        items: [
+          { text: 'Redis', link: '/redis' },
+          { text: 'Helpers', link: '/helpers' },
+          { text: 'Telemetry', link: '/telemetry' },
+          { text: 'Testing', link: '/testing' },
+          { text: 'DevConsole', link: '/devconsole' },
+          { text: 'CLI Tools', link: '/cli' }
+        ]
+      },
+      {
+        text: 'Guides',
+        items: [
+          { text: 'Test Migration Guide', link: '/guides/test-migration-guide' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/signal24/dk-server-foundation' }
+    ],
+
+    search: {
+      provider: 'local'
+    },
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2024-present Signal 24'
+    }
+  }
+})

package/docs/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/docs/content/CONTRIBUTING.md

@@ -0,0 +1,140 @@
+# Contributing to Documentation
+
+Thank you for contributing to the dk-server-foundation documentation!
+
+## Quick Start
+
+1. **Install dependencies**:
+   ```bash
+   yarn install
+   ```
+
+2. **Start the development server**:
+   ```bash
+   yarn docs:dev
+   ```
+   
+   This will start a local server with hot reload.
+
+3. **Make your changes** to the Markdown files in the `docs/` directory.
+
+4. **Preview your changes** in the browser - they'll update automatically.
+
+5. **Build to verify** (optional):
+   ```bash
+   yarn docs:build
+   ```
+
+## Adding a New Page
+
+1. Create a new Markdown file in the `docs/` directory (e.g., `docs/my-feature.md`)
+
+2. Add frontmatter if needed:
+   ```markdown
+   ---
+   title: My Feature
+   description: Description for SEO
+   ---
+   
+   # My Feature
+   
+   Content here...
+   ```
+
+3. Update the sidebar in `docs/.vitepress/config.mts`:
+   ```typescript
+   sidebar: [
+     {
+       text: 'My Section',
+       items: [
+         { text: 'My Feature', link: '/my-feature' }
+       ]
+     }
+   ]
+   ```
+
+## Adding Images
+
+1. Place images in `docs/public/images/` (organize in subdirectories as needed)
+
+2. Reference them in Markdown with an absolute path:
+   ```markdown
+   ![Alt text](/images/subfolder/image.png)
+   ```
+
+## Markdown Features
+
+VitePress supports standard Markdown plus these enhancements:
+
+### Code Blocks with Syntax Highlighting
+
+\```typescript
+const app = createApp({
+  config: AppConfig
+});
+\```
+
+### Custom Containers
+
+```markdown
+::: tip
+This is a tip
+:::
+
+::: warning
+This is a warning
+:::
+
+::: danger
+This is a dangerous warning
+:::
+
+::: info
+This is an info box
+:::
+```
+
+### Links
+
+- Internal links: `[Getting Started](/getting-started)`
+- External links: `[Deepkit](https://deepkit.io)`
+
+### Tables
+
+```markdown
+| Feature | Description |
+| ------- | ----------- |
+| Fast    | Built on Vite |
+| Simple  | Just Markdown |
+```
+
+## Deployment
+
+Documentation is automatically deployed to GitHub Pages when changes are merged to the `main` branch. The deployment workflow is in `.github/workflows/deploy-docs.yml`.
+
+## Testing Before Commit
+
+1. Build the docs: `yarn docs:build`
+2. Preview the build: `yarn docs:preview`
+3. Check for:
+   - Broken links
+   - Missing images
+   - Formatting issues
+   - Spelling/grammar
+
+## Style Guide
+
+- Use clear, concise language
+- Include code examples where helpful
+- Add links to related documentation
+- Use proper Markdown headings (# for h1, ## for h2, etc.)
+- Keep line length reasonable for readability
+- Use fenced code blocks with language specifiers
+
+## Questions?
+
+- Check the [VitePress documentation](https://vitepress.dev/)
+- Look at existing pages for examples
+- Open an issue on GitHub for questions
+
+Thank you for improving our documentation! 🎉

package/docs/content/README-DEV.md

@@ -0,0 +1,142 @@
+# Documentation Site Development
+
+This directory contains the VitePress-based documentation site for @zyno-io/dk-server-foundation.
+
+## Local Development
+
+### Prerequisites
+
+- Node.js 18+
+- Yarn package manager
+
+### Install Dependencies
+
+From the repository root:
+
+```bash
+yarn install
+```
+
+### Development Server
+
+Start the VitePress development server with hot reload:
+
+```bash
+yarn docs:dev
+```
+
+The site will be available at `http://localhost:5173`
+
+### Build
+
+Build the static site for production:
+
+```bash
+yarn docs:build
+```
+
+The built site will be in `docs/.vitepress/dist`
+
+### Preview
+
+Preview the production build locally:
+
+```bash
+yarn docs:preview
+```
+
+## Structure
+
+```
+docs/
+├── .vitepress/
+│   ├── config.mts          # VitePress configuration
+│   └── dist/               # Build output (generated)
+├── public/
+│   └── images/
+│       └── devconsole/     # DevConsole screenshots
+├── guides/                 # Guide documents
+├── index.md                # Home page (hero layout)
+├── getting-started.md      # Getting started guide
+├── configuration.md        # Configuration reference
+├── database.md             # Database documentation
+├── http.md                 # HTTP documentation
+├── authentication.md       # Authentication documentation
+├── worker.md               # Workers documentation
+├── srpc.md                 # SRPC documentation
+├── devconsole.md           # DevConsole documentation
+└── ...                     # Other documentation files
+```
+
+## Adding Documentation
+
+1. Create or edit Markdown files in `docs/`
+2. Update the sidebar in `.vitepress/config.mts` if adding new pages
+3. Use standard Markdown with VitePress enhancements
+
+## Adding Images
+
+Place images in `docs/public/images/` and reference them with `/images/...` in Markdown:
+
+```markdown
+![Alt text](/images/example.png)
+```
+
+## Capturing DevConsole Screenshots
+
+To update the DevConsole screenshots used in the documentation:
+
+### Prerequisites
+
+1. Install Playwright:
+
+    ```bash
+    npm install -D @playwright/test
+    npx playwright install chromium
+    ```
+
+2. Ensure MySQL and Redis are running
+
+### Capture Screenshots
+
+1. In one terminal, start the demo app:
+
+    ```bash
+    yarn demoapp
+    ```
+
+2. Wait for the server to start (you'll see "Server started" message)
+
+3. In another terminal, run the screenshot capture script:
+    ```bash
+    yarn docs:screenshots
+    ```
+
+This will automatically:
+
+- Navigate through all 10 DevConsole views
+- Wait for each page to load completely
+- Capture full-page screenshots
+- Save them to `docs/content/public/images/devconsole/`
+
+For headless mode (faster, no visible browser):
+
+```bash
+yarn docs:screenshots:headless
+```
+
+See `scripts/README-SCREENSHOTS.md` for detailed instructions and troubleshooting.
+
+## Deployment
+
+The documentation is automatically deployed to GitHub Pages when changes are pushed to the `main` branch. The workflow is defined in `.github/workflows/deploy-docs.yml`.
+
+### Manual Deployment
+
+To trigger a manual deployment, go to the Actions tab in GitHub and run the "Deploy Documentation" workflow.
+
+## Links
+
+- [VitePress Documentation](https://vitepress.dev/)
+- [Main Repository](https://github.com/zyno-io/dk-server-foundation)
+- [Published Documentation](https://zyno-io.github.io/dk-server-foundation/)

package/docs/content/README.md

@@ -0,0 +1,39 @@
+# Documentation
+
+## Getting Started
+
+| Document                                | Description                                                                                                 |
+| --------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
+| [Getting Started](./getting-started.md) | Installation, app creation with `createApp()`, AutoStart, dependency resolution, and environment detection. |
+| [Configuration](./configuration.md)     | Full reference for all built-in environment variables: database, auth, Redis, mail, telemetry, and more.    |
+
+## Core
+
+| Document                              | Description                                                                                                                                       |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Database](./database.md)             | MySQL/MariaDB ORM with transactions, hooks, session locks, raw queries, entity creation, dirty tracking, relationship resolution, and migrations. |
+| [HTTP](./http.md)                     | Custom HTTP kernel, middleware, CORS, error handling, file uploads, response helpers, and request-scoped caching.                                 |
+| [Authentication](./authentication.md) | JWT (HS256/EdDSA) and HTTP Basic Auth with entity resolution, password hashing, and reset tokens.                                                 |
+| [Logging](./logging.md)               | Scoped Pino logger with async context tracking, structured data, and error reporting integration.                                                 |
+| [Health Checks](./health.md)          | Extensible health check service with `/healthz` endpoint and automatic database health monitoring.                                                |
+| [Types](./types.md)                   | Custom validated types: phone numbers, dates, coordinates, emails, trimmed strings, and utility types.                                            |
+
+## Services
+
+| Document                              | Description                                                                                                                                                                            |
+| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Workers](./worker.md)                | BullMQ background job processing with `@WorkerJob()` decorator, cron scheduling, and leader-elected job recording.                                                                     |
+| [SRPC](./srpc.md)                     | Bidirectional WebSocket RPC with HMAC auth, ts-proto code generation, multiplexed binary streams, and tracing.                                                                         |
+| [Leader Service](./leader-service.md) | Distributed leader election via Redis. One instance holds the lock at a time, with TTL-based expiry, automatic renewal, and callbacks for leadership transitions.                      |
+| [Mesh Service](./mesh-service.md)     | Typed RPC between distributed instances. Nodes register handlers and invoke them across the mesh by instance ID, with automatic heartbeats, timeout management, and dead-node cleanup. |
+| [Mail](./mail.md)                     | Email sending via Postmark or SMTP with a template system.                                                                                                                             |
+
+## Utilities
+
+| Document                    | Description                                                                                                                            |
+| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
+| [Helpers](./helpers.md)     | Async context, Redis cache/mutex/broadcast, cryptography, data manipulation, transformers, process execution, and more.                |
+| [Telemetry](./telemetry.md) | OpenTelemetry auto-instrumentation for HTTP, database, Redis, DNS, BullMQ, and Sentry error tracking.                                  |
+| [Testing](./testing.md)     | Test facades with per-test database isolation, entity fixtures, mock requests, and SQL mocking.                                        |
+| [DevConsole](./devconsole.md) | Built-in web dashboard for development: HTTP inspector, SRPC monitor, database browser, REPL, worker/mutex/health views, and more.    |
+| [CLI Tools](./cli.md)       | `dksf-dev` workflow (clean/build/run/migrate/test), REPL, provider invoke, migration commands, proto generation, and standalone tools. |