vovk-hello-world 0.0.1

package/README.md

@@ -0,0 +1,97 @@
+
+
+# vovk-hello-world v0.0.1 ![TypeScript](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555) ![Vovk.ts](https://badgen.net/badge/Built%20with/Vovk.ts/333333?icon=https://vovk.dev/icon-white.svg)
+
+> A showcase for Next.js + Vovk.ts + Zod, demonstrating its capabilities with TypeScript, Rust, and Python RPC.
+
+License: **MIT**
+
+```bash
+# Install the package
+npm install vovk-hello-world
+```
+
+
+
+## UserRPC
+        
+### UserRPC.updateUser
+> Update user
+
+Update user by ID
+
+`POST http://localhost:3000/api/users/{id}`
+
+```ts
+import { UserRPC } from 'vovk-hello-world';
+
+const response = await UserRPC.updateUser({
+    params: {
+        id: "123e4567-e89b-12d3-a456-426614174000"
+    },
+    body: {
+        email: "john@example.com",
+        profile: {
+          name: "John Doe",
+          age: 25
+        }
+    },
+    query: {
+        notify: "email"
+    },
+});
+
+console.log(response); 
+/* 
+{
+    success: true
+}
+*/
+```
+        
+    
+
+## StreamRPC
+        
+### StreamRPC.streamTokens
+> Stream tokens
+
+Stream tokens to the client
+
+`GET http://localhost:3000/api/streams/tokens`
+
+```ts
+import { StreamRPC } from 'vovk-hello-world';
+
+using response = await StreamRPC.streamTokens();
+
+for await (const item of response) {
+    console.log(item); 
+    /*
+    {
+        message: "string"
+    }
+    */
+}
+```
+        
+    
+
+
+## OpenApiRPC
+        
+### OpenApiRPC.getSpec
+> OpenAPI spec
+
+Get the OpenAPI spec for the "Hello World" app API
+
+`GET http://localhost:3000/api/static/openapi/spec.json`
+
+```ts
+import { OpenApiRPC } from 'vovk-hello-world';
+
+const response = await OpenApiRPC.getSpec();
+```
+        
+    
+

package/index.cjs

@@ -0,0 +1,229 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+const vovk = __toESM(require("vovk"));
+const vovk_react_query = __toESM(require("vovk-react-query"));
+const vovk_ajv = __toESM(require("vovk-ajv"));
+
+//#region .vovk-schema/_meta.json
+var config = {
+	"$schema": "https://vovk.dev/api/spec/v3/config.json",
+	"libs": {}
+};
+var _meta_default = { config };
+
+//#endregion
+//#region .vovk-schema/root.json
+var $schema$1 = "https://vovk.dev/api/spec/v3/segment.json";
+var emitSchema$1 = true;
+var segmentName$1 = "";
+var segmentType$1 = "segment";
+var controllers$1 = {
+	"UserRPC": {
+		"rpcModuleName": "UserRPC",
+		"originalControllerName": "UserController",
+		"prefix": "users",
+		"handlers": { "updateUser": {
+			"validation": {
+				"body": {
+					"$schema": "https://json-schema.org/draft/2020-12/schema",
+					"description": "User data object",
+					"type": "object",
+					"properties": {
+						"email": {
+							"description": "User email",
+							"examples": ["john@example.com", "jane@example.com"],
+							"type": "string",
+							"format": "email",
+							"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
+						},
+						"profile": {
+							"description": "User profile object",
+							"type": "object",
+							"properties": {
+								"name": {
+									"description": "User full name",
+									"examples": ["John Doe", "Jane Smith"],
+									"type": "string"
+								},
+								"age": {
+									"description": "User age",
+									"examples": [25, 30],
+									"type": "integer",
+									"minimum": 16,
+									"maximum": 120
+								}
+							},
+							"required": ["name", "age"],
+							"additionalProperties": false
+						}
+					},
+					"required": ["email", "profile"],
+					"additionalProperties": false
+				},
+				"query": {
+					"$schema": "https://json-schema.org/draft/2020-12/schema",
+					"description": "Query parameters",
+					"type": "object",
+					"properties": { "notify": {
+						"description": "Notification type",
+						"type": "string",
+						"enum": [
+							"email",
+							"push",
+							"none"
+						]
+					} },
+					"required": ["notify"],
+					"additionalProperties": false
+				},
+				"params": {
+					"$schema": "https://json-schema.org/draft/2020-12/schema",
+					"description": "Path parameters",
+					"type": "object",
+					"properties": { "id": {
+						"description": "User ID",
+						"examples": ["123e4567-e89b-12d3-a456-426614174000"],
+						"type": "string",
+						"format": "uuid",
+						"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$"
+					} },
+					"required": ["id"],
+					"additionalProperties": false
+				},
+				"output": {
+					"$schema": "https://json-schema.org/draft/2020-12/schema",
+					"description": "Response object",
+					"type": "object",
+					"properties": { "success": {
+						"description": "Success status",
+						"type": "boolean"
+					} },
+					"required": ["success"],
+					"additionalProperties": false
+				}
+			},
+			"path": "{id}",
+			"httpMethod": "POST",
+			"openapi": {
+				"summary": "Update user",
+				"description": "Update user by ID"
+			}
+		} }
+	},
+	"StreamRPC": {
+		"rpcModuleName": "StreamRPC",
+		"originalControllerName": "StreamController",
+		"prefix": "streams",
+		"handlers": { "streamTokens": {
+			"validation": { "iteration": {
+				"$schema": "https://json-schema.org/draft/2020-12/schema",
+				"description": "Streamed token object",
+				"type": "object",
+				"properties": { "message": {
+					"description": "Message from the token",
+					"type": "string"
+				} },
+				"required": ["message"],
+				"additionalProperties": false
+			} },
+			"path": "tokens",
+			"httpMethod": "GET",
+			"openapi": {
+				"summary": "Stream tokens",
+				"description": "Stream tokens to the client"
+			}
+		} }
+	}
+};
+var root_default = {
+	$schema: $schema$1,
+	emitSchema: emitSchema$1,
+	segmentName: segmentName$1,
+	segmentType: segmentType$1,
+	controllers: controllers$1
+};
+
+//#endregion
+//#region .vovk-schema/static.json
+var $schema = "https://vovk.dev/api/spec/v3/segment.json";
+var emitSchema = true;
+var segmentName = "static";
+var segmentType = "segment";
+var controllers = { "OpenApiRPC": {
+	"rpcModuleName": "OpenApiRPC",
+	"originalControllerName": "OpenApiController",
+	"prefix": "openapi",
+	"handlers": { "getSpec": {
+		"path": "spec.json",
+		"httpMethod": "GET",
+		"openapi": {
+			"summary": "OpenAPI spec",
+			"description": "Get the OpenAPI spec for the \"Hello World\" app API"
+		}
+	} }
+} };
+var static_default = {
+	$schema,
+	emitSchema,
+	segmentName,
+	segmentType,
+	controllers
+};
+
+//#endregion
+//#region tmp_ts_rpc/schema.ts
+const segments = {
+	"": root_default,
+	"static": static_default
+};
+const schema = {
+	$schema: "https://vovk.dev/api/spec/v3/schema.json",
+	segments,
+	meta: {
+		$schema: "https://vovk.dev/api/spec/v3/meta.json",
+		apiRoot: "http://localhost:3000/api",
+		..._meta_default
+	}
+};
+
+//#endregion
+//#region tmp_ts_rpc/index.ts
+const UserRPC = (0, vovk_react_query.createRPC)(schema, "", "UserRPC", vovk.fetcher, {
+	validateOnClient: vovk_ajv.validateOnClient,
+	apiRoot: "http://localhost:3000/api"
+});
+const StreamRPC = (0, vovk_react_query.createRPC)(schema, "", "StreamRPC", vovk.fetcher, {
+	validateOnClient: vovk_ajv.validateOnClient,
+	apiRoot: "http://localhost:3000/api"
+});
+const OpenApiRPC = (0, vovk_react_query.createRPC)(schema, "static", "OpenApiRPC", vovk.fetcher, {
+	validateOnClient: vovk_ajv.validateOnClient,
+	apiRoot: "http://localhost:3000/api"
+});
+
+//#endregion
+exports.OpenApiRPC = OpenApiRPC;
+exports.StreamRPC = StreamRPC;
+exports.UserRPC = UserRPC;
+exports.schema = schema;

package/index.d.cts

@@ -0,0 +1,373 @@
+import * as vovk0 from "vovk";
+import { VovkClientFetcher } from "vovk";
+import * as _tanstack_react_query8 from "@tanstack/react-query";
+import * as _tanstack_query_core9 from "@tanstack/query-core";
+import * as openapi3_ts_oas3139 from "openapi3-ts/oas31";
+
+//#region tmp_ts_rpc/schema.d.ts
+declare const schema: {
+  $schema: string;
+  segments: {
+    '': {
+      $schema: string;
+      emitSchema: boolean;
+      segmentName: string;
+      segmentType: string;
+      controllers: {
+        UserRPC: {
+          rpcModuleName: string;
+          originalControllerName: string;
+          prefix: string;
+          handlers: {
+            updateUser: {
+              validation: {
+                body: {
+                  $schema: string;
+                  description: string;
+                  type: string;
+                  properties: {
+                    email: {
+                      description: string;
+                      examples: string[];
+                      type: string;
+                      format: string;
+                      pattern: string;
+                    };
+                    profile: {
+                      description: string;
+                      type: string;
+                      properties: {
+                        name: {
+                          description: string;
+                          examples: string[];
+                          type: string;
+                        };
+                        age: {
+                          description: string;
+                          examples: number[];
+                          type: string;
+                          minimum: number;
+                          maximum: number;
+                        };
+                      };
+                      required: string[];
+                      additionalProperties: boolean;
+                    };
+                  };
+                  required: string[];
+                  additionalProperties: boolean;
+                };
+                query: {
+                  $schema: string;
+                  description: string;
+                  type: string;
+                  properties: {
+                    notify: {
+                      description: string;
+                      type: string;
+                      enum: string[];
+                    };
+                  };
+                  required: string[];
+                  additionalProperties: boolean;
+                };
+                params: {
+                  $schema: string;
+                  description: string;
+                  type: string;
+                  properties: {
+                    id: {
+                      description: string;
+                      examples: string[];
+                      type: string;
+                      format: string;
+                      pattern: string;
+                    };
+                  };
+                  required: string[];
+                  additionalProperties: boolean;
+                };
+                output: {
+                  $schema: string;
+                  description: string;
+                  type: string;
+                  properties: {
+                    success: {
+                      description: string;
+                      type: string;
+                    };
+                  };
+                  required: string[];
+                  additionalProperties: boolean;
+                };
+              };
+              path: string;
+              httpMethod: string;
+              openapi: {
+                summary: string;
+                description: string;
+              };
+            };
+          };
+        };
+        StreamRPC: {
+          rpcModuleName: string;
+          originalControllerName: string;
+          prefix: string;
+          handlers: {
+            streamTokens: {
+              validation: {
+                iteration: {
+                  $schema: string;
+                  description: string;
+                  type: string;
+                  properties: {
+                    message: {
+                      description: string;
+                      type: string;
+                    };
+                  };
+                  required: string[];
+                  additionalProperties: boolean;
+                };
+              };
+              path: string;
+              httpMethod: string;
+              openapi: {
+                summary: string;
+                description: string;
+              };
+            };
+          };
+        };
+      };
+    };
+    static: {
+      $schema: string;
+      emitSchema: boolean;
+      segmentName: string;
+      segmentType: string;
+      controllers: {
+        OpenApiRPC: {
+          rpcModuleName: string;
+          originalControllerName: string;
+          prefix: string;
+          handlers: {
+            getSpec: {
+              path: string;
+              httpMethod: string;
+              openapi: {
+                summary: string;
+                description: string;
+              };
+            };
+          };
+        };
+      };
+    };
+  };
+  meta: {
+    config: {
+      $schema: string;
+      libs: {};
+    };
+    $schema: string;
+    apiRoot: string;
+  };
+};
+//#endregion
+//#region tmp_ts_rpc/index.d.ts
+declare const UserRPC: {
+  updateUser: (<R, F extends unknown = vovk0.VovkDefaultFetcherOptions<{
+    apiRoot?: string;
+    disableClientValidation?: boolean;
+    validateOnClient?: vovk0.VovkValidateOnClient;
+    interpretAs?: string;
+    init?: RequestInit;
+  }>>(options: {
+    body: {
+      email: string;
+      profile: {
+        name: string;
+        age: number;
+      };
+    };
+    query: {
+      notify: "email" | "push" | "none";
+    };
+    params: {
+      id: string;
+    };
+    apiRoot?: string | undefined;
+    disableClientValidation?: boolean | undefined;
+    validateOnClient?: vovk0.VovkValidateOnClient | undefined;
+    interpretAs?: string | undefined;
+    init?: RequestInit | undefined;
+    transform?: ((staticMethodReturn: {
+      success: true;
+    }, resp: Response) => R) | undefined;
+    fetcher?: VovkClientFetcher<F> | undefined;
+  }) => R extends object ? Promise<Awaited<R>> : Promise<{
+    success: true;
+  }>) & {
+    isRPC: true;
+    schema: vovk0.VovkHandlerSchema;
+    controllerSchema: vovk0.VovkControllerSchema;
+    segmentSchema: vovk0.VovkSegmentSchema;
+    fullSchema: vovk0.VovkSchema;
+    __types: {
+      body: {
+        email: string;
+        profile: {
+          name: string;
+          age: number;
+        };
+      };
+      query: {
+        notify: "email" | "push" | "none";
+      };
+      params: {
+        id: string;
+      };
+      output: {
+        success: boolean;
+      };
+      iteration: unknown;
+      isForm: false;
+    };
+  } & {
+    useQuery: (input: {
+      body: {
+        email: string;
+        profile: {
+          name: string;
+          age: number;
+        };
+      };
+      query: {
+        notify: "email" | "push" | "none";
+      };
+      params: {
+        id: string;
+      };
+      apiRoot?: string | undefined;
+      disableClientValidation?: boolean | undefined;
+      validateOnClient?: vovk0.VovkValidateOnClient | undefined;
+      interpretAs?: string | undefined;
+      init?: RequestInit | undefined;
+      transform?: ((staticMethodReturn: {
+        success: true;
+      }, resp: Response) => unknown) | undefined;
+      fetcher?: VovkClientFetcher<unknown> | undefined;
+    }, options?: Omit<_tanstack_react_query8.UseQueryOptions<Promise<{
+      success: true;
+    }>, Error, Promise<{
+      success: true;
+    }>, readonly unknown[]>, "queryFn" | "queryKey"> | undefined, queryClient?: _tanstack_query_core9.QueryClient) => _tanstack_react_query8.UseQueryResult<{
+      success: true;
+    }, vovk0.HttpException>;
+    useMutation: (options?: Omit<_tanstack_react_query8.UseMutationOptions<Promise<{
+      success: true;
+    }>, Error, void, unknown>, "mutationFn"> | undefined, queryClient?: _tanstack_query_core9.QueryClient) => _tanstack_react_query8.UseMutationResult<{
+      success: true;
+    }, vovk0.HttpException, {
+      body: {
+        email: string;
+        profile: {
+          name: string;
+          age: number;
+        };
+      };
+      query: {
+        notify: "email" | "push" | "none";
+      };
+      params: {
+        id: string;
+      };
+      apiRoot?: string | undefined;
+      disableClientValidation?: boolean | undefined;
+      validateOnClient?: vovk0.VovkValidateOnClient | undefined;
+      interpretAs?: string | undefined;
+      init?: RequestInit | undefined;
+      transform?: ((staticMethodReturn: {
+        success: true;
+      }, resp: Response) => unknown) | undefined;
+      fetcher?: VovkClientFetcher<unknown> | undefined;
+    }, unknown>;
+  };
+};
+declare const StreamRPC: {
+  streamTokens: (<R, F extends unknown = vovk0.VovkDefaultFetcherOptions<{
+    apiRoot?: string;
+    disableClientValidation?: boolean;
+    validateOnClient?: vovk0.VovkValidateOnClient;
+    interpretAs?: string;
+    init?: RequestInit;
+  }>>(options?: {
+    apiRoot?: string | undefined;
+    disableClientValidation?: boolean | undefined;
+    validateOnClient?: vovk0.VovkValidateOnClient | undefined;
+    interpretAs?: string | undefined;
+    init?: RequestInit | undefined;
+    transform?: ((staticMethodReturn: AsyncGenerator<{
+      message: string;
+    }, void, unknown>, resp: Response) => R) | undefined;
+    fetcher?: VovkClientFetcher<F> | undefined;
+  } | undefined) => Promise<vovk0.VovkStreamAsyncIterable<{
+    message: string;
+  }>>) & {
+    isRPC: true;
+    schema: vovk0.VovkHandlerSchema;
+    controllerSchema: vovk0.VovkControllerSchema;
+    segmentSchema: vovk0.VovkSegmentSchema;
+    fullSchema: vovk0.VovkSchema;
+    __types: {
+      body: unknown;
+      query: unknown;
+      params: unknown;
+      output: unknown;
+      iteration: {
+        message: string;
+      };
+      isForm: false;
+    };
+  } & {
+    useQuery: (input?: {
+      apiRoot?: string | undefined;
+      disableClientValidation?: boolean | undefined;
+      validateOnClient?: vovk0.VovkValidateOnClient | undefined;
+      interpretAs?: string | undefined;
+      init?: RequestInit | undefined;
+      transform?: ((staticMethodReturn: AsyncGenerator<{
+        message: string;
+      }, void, unknown>, resp: Response) => unknown) | undefined;
+      fetcher?: VovkClientFetcher<unknown> | undefined;
+    } | undefined, options?: Omit<_tanstack_react_query8.UseQueryOptions<Promise<vovk0.VovkStreamAsyncIterable<{
+      message: string;
+    }>>, Error, Promise<vovk0.VovkStreamAsyncIterable<{
+      message: string;
+    }>>, readonly unknown[]>, "queryFn" | "queryKey"> | undefined, queryClient?: _tanstack_query_core9.QueryClient) => _tanstack_react_query8.UseQueryResult<{
+      message: string;
+    }[], vovk0.HttpException>;
+    useMutation: (options?: Omit<_tanstack_react_query8.UseMutationOptions<Promise<vovk0.VovkStreamAsyncIterable<{
+      message: string;
+    }>>, Error, void, unknown>, "mutationFn"> | undefined, queryClient?: _tanstack_query_core9.QueryClient) => _tanstack_react_query8.UseMutationResult<vovk0.VovkStreamAsyncIterable<{
+      message: string;
+    }>, vovk0.HttpException, {
+      apiRoot?: string | undefined;
+      disableClientValidation?: boolean | undefined;
+      validateOnClient?: vovk0.VovkValidateOnClient | undefined;
+      interpretAs?: string | undefined;
+      init?: RequestInit | undefined;
+      transform?: ((staticMethodReturn: AsyncGenerator<{
+        message: string;
+      }, void, unknown>, resp: Response) => unknown) | undefined;
+      fetcher?: VovkClientFetcher<unknown> | undefined;
+    } | undefined, unknown>;
+  };
+};
+declare const OpenApiRPC: {
+  getSpec: () => Promise<openapi3_ts_oas3139.OpenAPIObject>;
+};
+//#endregion
+export { OpenApiRPC, StreamRPC, UserRPC, schema };