@h3ravel/shared 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @h3ravel/shared
 
+## 0.7.0
+
+### Minor Changes
+
+- b0d1b7c: feat: flip @h3ravel/shared dependency on @h3ravel/support as it should be.
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -0,0 +1,29 @@
+<p align="center"><a href="https://h3ravel.toneflix.net" target="_blank"><img src="https://raw.githubusercontent.com/h3ravel/assets/refs/heads/main/logo-full.svg" width="400" alt="H3ravel Logo"></a></p>
+
+[![Framework][ix]][lx]
+[![Shared Package Version][i1]][l1]
+
+# About H3ravel/shared
+
+This package provides first reusable interfaces and contracts used across the [H3ravel](https://h3ravel.toneflix.net) ecosystem.
+
+## Contributing
+
+Thank you for considering contributing to the H3ravel framework! The contribution guide can be found in the [H3ravel documentation](#!).
+
+## Code of Conduct
+
+In order to ensure that the H3ravel community is welcoming to all, please review and abide by the [Code of Conduct](#).
+
+## Security Vulnerabilities
+
+If you discover a security vulnerability within H3ravel, please send an e-mail to Legacy via hamzas.legacy@toneflix.ng. All security vulnerabilities will be promptly addressed.
+
+## License
+
+The H3ravel framework is open-sourced software licensed under the [MIT license](LICENSE).
+
+[ix]: https://img.shields.io/npm/v/%40h3ravel%2Fcore?style=flat-square&label=Framework&color=%230970ce
+[lx]: https://www.npmjs.com/package/@h3ravel/core
+[i1]: https://img.shields.io/npm/v/%40h3ravel%2Fshared?style=flat-square&label=@h3ravel/shared&color=%230970ce
+[l1]: https://www.npmjs.com/package/@h3ravel/shared

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @file Automatically generated by barrelsby.\n */\n\nexport * from './Contracts/IApplication';\nexport * from './Contracts/IHttp';\nexport * from './Contracts/IRequest';\nexport * from './Contracts/IResponse';\nexport * from './Contracts/IServiceProvider';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @file Automatically generated by barrelsby.\n */\n\nexport * from './Contracts/IApplication';\nexport * from './Contracts/IHttp';\nexport * from './Contracts/IRequest';\nexport * from './Contracts/IResponse';\nexport * from './Contracts/IServiceProvider';\nexport * from './Contracts/ObjContract';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;;","names":[]}

package/dist/index.d.cts

@@ -1,5 +1,4 @@
 import { H3Event, Middleware, MiddlewareOptions } from 'h3';
-import { DotNestedKeys, DotNestedValue } from '@h3ravel/support';
 
 interface IServiceProvider {
     /**
@@ -69,6 +68,35 @@ interface IApplication {
     getVersion(key: 'app' | 'ts'): string | undefined;
 }
 
+/**
+ * Adds a dot prefix to nested keys
+ */
+type DotPrefix<T extends string, U extends string> = T extends '' ? U : `${T}.${U}`;
+/**
+ * Converts a union of objects into a single merged object
+ */
+type MergeUnion<T> = (T extends any ? (k: T) => void : never) extends (k: infer I) => void ? {
+    [K in keyof I]: I[K];
+} : never;
+/**
+ * Flattens nested objects into dotted keys
+ */
+type DotFlatten<T, Prefix extends string = ''> = MergeUnion<{
+    [K in keyof T & string]: T[K] extends Record<string, any> ? DotFlatten<T[K], DotPrefix<Prefix, K>> : {
+        [P in DotPrefix<Prefix, K>]: T[K];
+    };
+}[keyof T & string]>;
+/**
+ * Builds "nested.key" paths for autocompletion
+ */
+type DotNestedKeys<T> = {
+    [K in keyof T & string]: T[K] extends object ? `${K}` | `${K}.${DotNestedKeys<T[K]>}` : `${K}`;
+}[keyof T & string];
+/**
+ * Retrieves type at a given dot-path
+ */
+type DotNestedValue<T, Path extends string> = Path extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? DotNestedValue<T[Key], Rest> : never : Path extends keyof T ? T[Path] : never;
+
 /**
  * Interface for the Request contract, defining methods for handling HTTP request data.
  */
@@ -253,4 +281,4 @@ interface IMiddleware {
     handle(context: HttpContext, next: () => Promise<any>): Promise<any>;
 }
 
-export type { EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider };
+export type { DotFlatten, DotNestedKeys, DotNestedValue, EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider };

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { H3Event, Middleware, MiddlewareOptions } from 'h3';
-import { DotNestedKeys, DotNestedValue } from '@h3ravel/support';
 
 interface IServiceProvider {
     /**
@@ -69,6 +68,35 @@ interface IApplication {
     getVersion(key: 'app' | 'ts'): string | undefined;
 }
 
+/**
+ * Adds a dot prefix to nested keys
+ */
+type DotPrefix<T extends string, U extends string> = T extends '' ? U : `${T}.${U}`;
+/**
+ * Converts a union of objects into a single merged object
+ */
+type MergeUnion<T> = (T extends any ? (k: T) => void : never) extends (k: infer I) => void ? {
+    [K in keyof I]: I[K];
+} : never;
+/**
+ * Flattens nested objects into dotted keys
+ */
+type DotFlatten<T, Prefix extends string = ''> = MergeUnion<{
+    [K in keyof T & string]: T[K] extends Record<string, any> ? DotFlatten<T[K], DotPrefix<Prefix, K>> : {
+        [P in DotPrefix<Prefix, K>]: T[K];
+    };
+}[keyof T & string]>;
+/**
+ * Builds "nested.key" paths for autocompletion
+ */
+type DotNestedKeys<T> = {
+    [K in keyof T & string]: T[K] extends object ? `${K}` | `${K}.${DotNestedKeys<T[K]>}` : `${K}`;
+}[keyof T & string];
+/**
+ * Retrieves type at a given dot-path
+ */
+type DotNestedValue<T, Path extends string> = Path extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? DotNestedValue<T[Key], Rest> : never : Path extends keyof T ? T[Path] : never;
+
 /**
  * Interface for the Request contract, defining methods for handling HTTP request data.
  */
@@ -253,4 +281,4 @@ interface IMiddleware {
     handle(context: HttpContext, next: () => Promise<any>): Promise<any>;
 }
 
-export type { EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider };
+export type { DotFlatten, DotNestedKeys, DotNestedValue, EventHandler, HttpContext, IApplication, IController, IMiddleware, IPathName, IRequest, IResponse, IRouter, IServiceProvider };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/shared",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Shared Utilities.",
   "type": "module",
   "main": "dist/index.js",
@@ -8,9 +8,18 @@
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "h3ravel",
+    "modern",
+    "web",
+    "H3",
+    "framework",
+    "nodejs",
+    "typescript",
+    "laravel"
+  ],
   "dependencies": {
-    "h3": "^2.0.0-beta.1",
-    "@h3ravel/support": "0.6.0"
+    "h3": "^2.0.0-beta.1"
   },
   "scripts": {
     "build": "tsup",

package/src/Contracts/IRequest.ts

@@ -1,4 +1,4 @@
-import { DotNestedKeys, DotNestedValue } from '@h3ravel/support'
+import { DotNestedKeys, DotNestedValue } from './ObjContract'
 
 import type { H3Event } from 'h3'
 

package/src/Contracts/IResponse.ts

@@ -1,4 +1,4 @@
-import { DotNestedKeys, DotNestedValue } from '@h3ravel/support'
+import { DotNestedKeys, DotNestedValue } from './ObjContract'
 
 import type { H3Event } from 'h3'
 

package/src/Contracts/ObjContract.ts

@@ -0,0 +1,44 @@
+/**
+ * Adds a dot prefix to nested keys
+ */
+type DotPrefix<T extends string, U extends string> =
+    T extends '' ? U : `${T}.${U}`
+
+/**
+ * Converts a union of objects into a single merged object
+ */
+type MergeUnion<T> =
+    (T extends any ? (k: T) => void : never) extends
+    (k: infer I) => void ? { [K in keyof I]: I[K] } : never
+
+/**
+ * Flattens nested objects into dotted keys
+ */
+export type DotFlatten<T, Prefix extends string = ''> = MergeUnion<{
+    [K in keyof T & string]:
+    T[K] extends Record<string, any>
+    ? DotFlatten<T[K], DotPrefix<Prefix, K>>
+    : { [P in DotPrefix<Prefix, K>]: T[K] }
+}[keyof T & string]>
+
+/**
+ * Builds "nested.key" paths for autocompletion
+ */
+export type DotNestedKeys<T> = {
+    [K in keyof T & string]:
+    T[K] extends object
+    ? `${K}` | `${K}.${DotNestedKeys<T[K]>}`
+    : `${K}`
+}[keyof T & string]
+
+/**
+ * Retrieves type at a given dot-path
+ */
+export type DotNestedValue<T, Path extends string> =
+    Path extends `${infer Key}.${infer Rest}`
+    ? Key extends keyof T
+    ? DotNestedValue<T[Key], Rest>
+    : never
+    : Path extends keyof T
+    ? T[Path]
+    : never 

package/src/index.ts

@@ -7,3 +7,4 @@ export * from './Contracts/IHttp';
 export * from './Contracts/IRequest';
 export * from './Contracts/IResponse';
 export * from './Contracts/IServiceProvider';
+export * from './Contracts/ObjContract';