@forklaunch/core 0.1.5 → 0.1.6

package/dist/http/types/forklaunch.types.d.ts

@@ -1,13 +1,30 @@
 import { AnySchemaValidator } from '@forklaunch/validator';
 import { HttpContractDetails, PathParamHttpContractDetails } from './primitive.types';
+/**
+ * Interface representing a Forklaunch router.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export interface ForklaunchRouter<SV extends AnySchemaValidator> {
+    /** The base path for the router */
     basePath: string;
+    /** The routes associated with the router */
     routes: ForklaunchRoute<SV>[];
 }
+/**
+ * Interface representing a Forklaunch route.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export interface ForklaunchRoute<SV extends AnySchemaValidator> {
+    /** The base path for the route */
     basePath: string;
+    /** The path for the route, which can be a string, RegExp, or an array of strings or RegExps */
     path: string | RegExp | (string | RegExp)[];
+    /** The SDK path for the route */
     sdkPath: string;
+    /** The HTTP method for the route */
     method: 'get' | 'post' | 'put' | 'patch' | 'delete';
+    /** The contract details for the route */
     contractDetails: PathParamHttpContractDetails<SV> | HttpContractDetails<SV>;
 }

package/dist/http/types/primitive.types.d.ts

@@ -1,27 +1,89 @@
 import { AnySchemaValidator } from '@forklaunch/validator';
 import { UnboxedObjectSchema } from '@forklaunch/validator/types';
+/**
+ * Dictionary type for URL parameters.
+ */
 export type ParamsDictionary = {
     [key: string]: string;
 };
+/**
+ * Type representing an object with only string keys.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export type StringOnlyObject<SV extends AnySchemaValidator> = Omit<UnboxedObjectSchema<SV>, number | symbol>;
+/**
+ * Type representing an object with only number keys.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export type NumberOnlyObject<SV extends AnySchemaValidator> = Omit<UnboxedObjectSchema<SV>, string | symbol>;
+/**
+ * Type representing the body object in a request.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export type BodyObject<SV extends AnySchemaValidator> = StringOnlyObject<SV> & unknown;
+/**
+ * Type representing the parameters object in a request.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export type ParamsObject<SV extends AnySchemaValidator> = StringOnlyObject<SV> & unknown;
+/**
+ * Type representing the query object in a request.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export type QueryObject<SV extends AnySchemaValidator> = StringOnlyObject<SV> & unknown;
+/**
+ * Type representing the headers object in a request.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export type HeadersObject<SV extends AnySchemaValidator> = StringOnlyObject<SV> & unknown;
+/**
+ * Type representing the responses object in a request.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export type ResponsesObject<SV extends AnySchemaValidator> = {
     [key: number]: SV['_ValidSchemaObject'] | UnboxedObjectSchema<SV> | string | SV['string'];
 } & unknown;
+/**
+ * Type representing the body in a request.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
 export type Body<SV extends AnySchemaValidator> = BodyObject<SV> | SV['_ValidSchemaObject'] | SV['_SchemaCatchall'];
+/**
+ * Type representing the authentication method.
+ */
 export type AuthMethod = 'jwt' | 'session';
+/**
+ * Interface representing HTTP contract details for path parameters.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template ParamSchemas - A type for parameter schemas, defaulting to ParamsObject.
+ * @template ResponseSchemas - A type for response schemas, defaulting to ResponsesObject.
+ * @template QuerySchemas - A type for query schemas, defaulting to QueryObject.
+ */
 export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, ParamSchemas extends ParamsObject<SV> = ParamsObject<SV>, ResponseSchemas extends ResponsesObject<SV> = ResponsesObject<SV>, QuerySchemas extends QueryObject<SV> = QueryObject<SV>> {
+    /** Name of the contract */
     name: string;
+    /** Summary of the contract */
     summary: string;
+    /** Response schemas for the contract */
     responses: ResponseSchemas;
+    /** Optional request headers for the contract */
     requestHeaders?: HeadersObject<SV>;
+    /** Optional response headers for the contract */
     responseHeaders?: HeadersObject<SV>;
+    /** Optional parameter schemas for the contract */
     params?: ParamSchemas;
+    /** Optional query schemas for the contract */
     query?: QuerySchemas;
+    /** Optional authentication details for the contract */
     auth?: {
         method: AuthMethod;
         allowedSlugs?: Set<string>;
@@ -30,7 +92,18 @@ export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, Par
         forbiddenRoles?: Set<string>;
     };
 }
+/**
+ * Interface representing HTTP contract details.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template ParamSchemas - A type for parameter schemas, defaulting to ParamsObject.
+ * @template ResponseSchemas - A type for response schemas, defaulting to ResponsesObject.
+ * @template BodySchema - A type for the body schema, defaulting to Body.
+ * @template QuerySchemas - A type for query schemas, defaulting to QueryObject.
+ */
 export interface HttpContractDetails<SV extends AnySchemaValidator, ParamSchemas extends ParamsObject<SV> = ParamsObject<SV>, ResponseSchemas extends ResponsesObject<SV> = ResponsesObject<SV>, BodySchema extends Body<SV> = Body<SV>, QuerySchemas extends QueryObject<SV> = QueryObject<SV>> extends PathParamHttpContractDetails<SV, ParamSchemas, ResponseSchemas, QuerySchemas> {
+    /** Optional body schema for the contract */
     body?: BodySchema;
+    /** Optional content type for the contract */
     contentType?: 'application/json' | 'multipart/form-data' | 'application/x-www-form-urlencoded';
 }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@forklaunch/core",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "forklaunch-js core package. Contains useful building blocks.",
   "files": [
     "dist"
   ],
+  "types": "dist/index.d.ts",
   "scripts": {
     "test": "jest",
     "build": "tsc",
@@ -24,7 +25,7 @@
   },
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "dependencies": {
-    "@forklaunch/validator": "^0.2.9",
+    "@forklaunch/validator": "^0.3.0",
     "@mikro-orm/core": "^6.2.9",
     "jose": "^5.6.2",
     "redis": "^4.6.14",