[{"_1":2,"_169":-5,"_170":-5},"loaderData",{"_3":4,"_91":92},"root",{"_5":6,"_34":35,"_64":65},"ctx",{"_7":8,"_23":-5,"_24":25,"_26":27,"_28":20,"_29":20,"_30":20,"_31":32,"_33":20},"auth",{"_9":-5,"_10":-5,"_11":-5,"_12":-5,"_13":-5,"_14":-5,"_15":-5,"_16":-5,"_17":-5,"_18":-5,"_19":20,"_21":22},"sessionClaims","sessionId","sessionStatus","userId","actor","orgId","orgRole","orgSlug","orgPermissions","factorVerificationAge","isAuthenticated",false,"tokenType","session_token","user","preferencesKeybindings","default","preferencesTheme","light","preferencesFixers","preferencesCopilot","preferencesSelectionAi","notificationCount",0,"flagDenols","ENV",{"_36":37,"_38":39,"_40":41,"_42":43,"_44":45,"_46":47,"_48":49,"_50":51,"_52":53,"_54":55,"_56":57,"_58":59,"_60":61,"_62":63},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","VAL_RUNTIME_NAME","prod","RENDER_GIT_COMMIT","40390002a9f23719e5ece4788ed87655b391d648","RENDER_GIT_BRANCH","main","CLERK_PUBLISHABLE_KEY","pk_live_Y2xlcmsudmFsLnRvd24k","POSTHOG_API_TOKEN","phc_nmoyuAkStEZuUp69rYlg1DZgrIt19Gx0Y4Hwf8tGgJP","POSTHOG_API_HOST","https://wart.val.town","WEB_API_TEMPLATE","https://{val}.web.val.run","APP_URL","https://www.val.town","MODULE_URL","https://esm.town","VANITY_WEB_API_TEMPLATE","https://{label}.val.run/","DENOLS_URL","https://lsp.val.town","NODE_ENV","production","API_URL","https://api.val.town","clerkState",{"_66":67},"__internal_clerk_state",{"_68":69,"_70":45,"_71":72,"_73":72,"_74":20,"_75":72,"_76":72,"_77":72,"_78":72,"_79":80,"_89":20,"_90":20},"__clerk_ssr_state",{"_21":22,"_9":-5,"_10":-5,"_11":-5,"_12":-5,"_13":-5,"_14":-5,"_15":-5,"_16":-5,"_17":-5,"_18":-5,"_19":20},"__publishableKey","__proxyUrl","","__domain","__isSatellite","__signInUrl","__signUpUrl","__afterSignInUrl","__afterSignUpUrl","__clerk_debug",{"_81":20,"_19":20,"_82":72,"_83":84,"_85":72,"_86":45,"_87":20,"_88":72},"isSignedIn","proxyUrl","reason","session-token-and-uat-missing","message","publishableKey","isSatellite","domain","__telemetryDisabled","__telemetryDebug","routes/embed.x.$handle.$name.$",{"_93":94,"_95":96,"_97":98,"_99":100,"_148":149,"_166":167,"_168":-5},"handle","xkonti","name","gptApiFramework","path","main.tsx","project",{"_101":102,"_95":96,"_103":104,"_105":-5,"_106":107,"_108":109,"_110":-5,"_111":-5,"_12":112,"_113":-5,"_114":107,"_115":-5,"_116":117,"_14":118,"_119":120,"_121":120,"_122":123,"_124":123,"_125":123,"_126":120,"_127":120,"_23":128,"_131":132,"_134":135,"_147":20},"id","4976065c-279c-11f0-9d52-569c3dd06744","createdAt",["D",1746221264932],"deletedAt","legacyEnvVars",true,"privacy","public","description","imageUrl","c183ed03-e3c2-419d-bb34-16caedc74b26","pinnedFileId","pinPreview","screenshotVersion","likeCount",2,"5e5de42a-e7ad-44f1-bdfc-fb2991b3e132","userPerm","r","valPerm","blobPerm","rw","emailPerm","sqlitePerm","projectPerm","telemetryPerm",{"_93":94,"_129":130},"profileImageUrl","https://img.clerk.com/eyJ0eXBlIjoicHJveHkiLCJzcmMiOiJodHRwczovL2ltYWdlcy5jbGVyay5kZXYvb2F1dGhfZ2l0aHViL2ltZ18yVHI5VU1vZnR6eGE0c0FTaThzTEtZTUxNMVYuanBlZyJ9","org",{"_93":94,"_133":130},"avatar","branch",{"_136":137,"_95":43,"_101":138,"_139":102,"_140":-5,"_141":-5,"_142":-5,"_143":-5,"_144":-5,"_145":96,"_146":94},"version",68,"4976529c-279c-11f0-9d52-569c3dd06744","projectId","forkedBranchId","forkedBranchVersion","forkedProjectPrivacy","forkedProjectId","forkedProjectOrgId","projectName","userHandle","isOwned","file",{"_101":150,"_95":98,"_151":152,"_153":-5,"_154":138,"_155":137,"_156":107,"_103":157,"_136":158,"_159":160,"_161":162,"_163":20,"_164":-5,"_97":165},"4aebf230-279c-11f0-9d52-569c3dd06744","fileId","497909b0-279c-11f0-9d52-569c3dd06744","parentId","branchId","branchVersion","latest",["D",1716959237147],67,"fileType","script","content","import type { Context } from \"npm:hono@3\";\nimport { Hono } from \"npm:hono@3\";\nimport { z } from \"npm:zod\";\nimport { zodToJsonSchema } from \"npm:zod-to-json-schema\";\n\nexport type HttpVerb = \"get\" | \"post\" | \"put\" | \"delete\" | \"patch\";\n\n/**\n * Base interface for defining an endpoint.\n * This does not include request or response schemas.\n */\nexport interface EndpointDefBase {\n verb: HttpVerb;\n path: string;\n desc: string;\n operationId: string;\n}\n\n/**\n * Used o define an endpoint with request and response schemas\n * along with descriptions for each.\n */\nexport interface EndpointDefinition extends EndpointDefBase {\n requestSchema: z.Schema | null;\n requestDesc: string | null;\n responseSchema: z.Schema | null;\n responseDesc: string | null;\n}\n\n/**\n * Used to define an input-only endpoint with a request schema,\n * but no response schema.\n */\nexport interface InEndpointDefinition extends EndpointDefBase {\n requestSchema: TRequestSchema;\n}\n\n/**\n * Used to define an output-only endpoint with a response schema,\n * but no request schema.\n */\nexport interface OutEndpointDefinition extends EndpointDefBase {\n responseSchema: TResponseSchema;\n}\n\n/**\n * Used to define an input/output endpoint with both a request and\n * response schema.\n */\nexport interface InOutEndpointDefinition\n extends EndpointDefBase {\n requestSchema: TRequestSchema;\n responseSchema: TResponseSchema;\n}\n\n/**\n * The API info object that is used to describe the API to the GPT.\n */\nexport interface ApiInfo {\n /**\n * The URL of the API. This should match the URL of your Val.\n */\n url: string;\n\n /**\n * The name of the API. It gives the GPT an idea about the purpose of the API.\n */\n title: string;\n\n /**\n * A short description of the API. It gives the GPT an idea about the purpose of the API.\n */\n description: string;\n\n /**\n * The version of the API. Required by the OpenAPI spec.\n */\n version: string;\n\n /**\n * An optional function that returns the policy to be used available at `/privacypolicy`.\n */\n policyGetter?: (() => string) | (() => Promise);\n}\n\n/**\n * Returns the JSON schema for a Zod schema.\n * @param schema The Zod schema to convert.\n * @returns The generated JSON schema.\n */\nfunction getSchemaDesc(schema: z.Schema | null) {\n if (!schema) return null;\n return zodToJsonSchema(schema, {\n name: \"schema\",\n target: \"openApi3\",\n }).definitions?.schema ?? null;\n}\n\n/**\n * Describes the schema of an endpoint.\n */\ninterface EndpointSchema {\n description: string;\n operationId: string;\n requestBody?: {\n description: string;\n required: boolean;\n content: {\n [key: string]: {\n schema: ReturnType;\n };\n };\n } | null;\n responses: {\n [key: string]: {\n description: string;\n content: {\n [key: string]: {\n schema: ReturnType;\n };\n };\n };\n };\n}\n\n/**\n * Describes the paths of an OpenAPI spec.\n */\ntype Paths = {\n [key: string]: Partial<\n {\n [key in HttpVerb]: EndpointSchema;\n }\n >;\n};\n\n/**\n * Assembles the paths of an OpenAPI spec from endpoint definitions.\n * @param endpoints The endpoint definitions to use.\n * @returns The paths of the OpenAPI spec.\n */\nfunction getPathsDesc(endpoints: EndpointDefinition[]): Paths {\n const paths: Paths = {};\n for (const endpoint of endpoints) {\n // This is to allow multiple endpoints with the same path but different verbs\n if (!paths[endpoint.path]) {\n paths[endpoint.path] = {};\n }\n paths[endpoint.path][endpoint.verb] = {\n description: endpoint.desc,\n operationId: endpoint.operationId,\n requestBody: endpoint.requestSchema\n ? {\n description: endpoint.requestDesc ?? \"Request body\",\n required: true,\n content: {\n \"application/json\": {\n schema: getSchemaDesc(endpoint.requestSchema),\n },\n },\n }\n : undefined,\n responses: {\n \"200\": {\n description: endpoint.responseDesc ?? \"Success\",\n content: {\n \"application/json\": {\n schema: getSchemaDesc(endpoint.responseSchema),\n },\n },\n },\n },\n };\n }\n\n return paths;\n}\n\n/**\n * Generates an OpenAPI spec for the defined API.\n * @param url The URL of the API.\n * @param title The title of the API.\n * @param description The description of the API.\n * @param version The version of the API.\n * @param endpoints The endpoint definitions to use.\n * @returns The OpenAPI spec.\n */\nfunction getOpenApiSpec(\n url: string,\n title: string,\n description: string,\n version: string,\n endpoints: EndpointDefinition[],\n) {\n return {\n openapi: \"3.1.0\",\n info: {\n title,\n description,\n version,\n },\n servers: [\n {\n url,\n },\n ],\n paths: getPathsDesc(endpoints),\n };\n}\n\n/**\n * A class representing a GPT API. It provides methods for registering\n * endpoints and serving the API.\n */\nexport class GptApi {\n private app = new Hono();\n private info: ApiInfo;\n private endpoints: EndpointDefinition[] = [];\n\n /**\n * Creates a new GptApi instance.\n * @param info Configuration for the API.\n */\n constructor(info: ApiInfo) {\n this.info = info;\n this.app.get(\"/gpt/schema\", (ctx) => {\n const spec = getOpenApiSpec(\n this.info.url,\n this.info.title,\n this.info.description,\n this.info.version,\n this.endpoints,\n );\n return ctx.text(JSON.stringify(spec, null, 2));\n });\n\n if (info.policyGetter != null) {\n const policyGetter = info.policyGetter;\n this.app.get(\"/privacypolicy\", async (ctx) => {\n let content = await policyGetter();\n content = content.trim();\n if (content.endsWith(\"\")) {\n return ctx.html(content);\n }\n else {\n return ctx.text(content);\n }\n });\n }\n\n this.app.get(\"/\", (ctx) => {\n return ctx.text(`OpenAPI spec: ${this.info.url}/gpt/schema\\nPrivacy policy: ${this.info.url}/privacypolicy\\n`);\n });\n }\n\n /**\n * Register an endpoint that accepts JSON input and returns\n * only a status code.\n * @param endpointDef Definition of the endpoint.\n * @param handler Function that handles the request.\n */\n jsonToNothing(\n endpointDef: InEndpointDefinition,\n handler: (ctx: Context, reqBody: z.infer, apiKey: string | null) => Promise,\n ) {\n const handlerWrapper = async (ctx: Context) => {\n const requestBody = await ctx.req.json();\n\n // Validate request data\n const parsedRequestData = endpointDef.requestSchema.parse(requestBody) as z.infer;\n // TODO: Handle invalid data format\n\n const apiKey = this.extractApiKey(ctx);\n const statusCode = await handler(ctx, parsedRequestData, apiKey);\n return ctx.body(null, statusCode as StatusCode);\n };\n\n // Transform to EndpointDefinition\n const eDef = endpointDef as unknown as EndpointDefinition;\n eDef.requestDesc = endpointDef.requestSchema.description ?? \"Request body\";\n eDef.responseSchema = null;\n eDef.responseDesc = null;\n\n // TODO: Verify request schema is in place\n this.registerHandler(eDef, handlerWrapper);\n }\n\n /**\n * Register an endpoint that ignores all inputs and\n * returns a specific JSON response.\n * @param endpointDef Definition of the endpoint.\n * @param handler Function that handles the request.\n */\n nothingToJson(\n endpointDef: OutEndpointDefinition,\n handler: (ctx: Context, apiKey: string | null) => Promise>,\n ) {\n const handlerWrapper = async (ctx: Context) => {\n const apiKey = this.extractApiKey(ctx);\n const response = await handler(ctx, apiKey);\n\n // Validate response data\n const parsedResponseData = endpointDef.responseSchema.parse(response) as z.infer;\n\n return ctx.json(parsedResponseData);\n };\n\n // Transform to EndpointDefinition\n const eDef = endpointDef as unknown as EndpointDefinition;\n eDef.requestSchema = null;\n eDef.requestDesc = null;\n eDef.responseDesc = endpointDef.responseSchema.description ?? \"Response body\";\n\n // TODO: Verify response stuff is in place\n this.registerHandler(eDef, handlerWrapper);\n }\n\n /**\n * Register an endpoint that accepts a JSON request and\n * returns a specific JSON response.\n * @param endpointDef Definition of the endpoint.\n * @param handler Function that handles the request.\n */\n jsonToJson(\n endpointDef: InOutEndpointDefinition,\n handler: (\n ctx: Context,\n reqBody: z.infer,\n apiKey: string | null,\n ) => Promise>,\n ) {\n // TODO: Verify request and response is in place\n const handlerWrapper = async (ctx: Context) => {\n const requestBody = await ctx.req.json();\n\n // Validate request data\n const parsedRequestData = endpointDef.requestSchema.parse(requestBody) as z.infer;\n // TODO: Handle invalid data format\n\n const apiKey = this.extractApiKey(ctx);\n const response = await handler(ctx, parsedRequestData, apiKey);\n\n // Validate response data\n const parsedResponseData = endpointDef.responseSchema.parse(response) as z.infer;\n return ctx.json(parsedResponseData);\n };\n\n // Transform to EndpointDefinition\n const eDef = endpointDef as unknown as EndpointDefinition;\n eDef.requestDesc = endpointDef.requestSchema.description ?? \"Request body\";\n eDef.responseDesc = endpointDef.responseSchema.description ?? \"Response body\";\n this.registerHandler(eDef, handlerWrapper);\n }\n\n /**\n * Regusters a handler for a verb + path combo.\n * @param endpointDef Definition of the endpoint.\n * @param handler Function that handles the request.\n */\n private registerHandler(\n endpointDef: EndpointDefinition,\n handler: (ctx: Context) => Response | Promise,\n ) {\n this.endpoints.push(endpointDef);\n\n const verb = endpointDef.verb;\n const path = endpointDef.path;\n switch (verb) {\n case \"get\":\n this.app.get(path, handler);\n break;\n case \"post\":\n this.app.post(path, handler);\n break;\n case \"put\":\n this.app.put(path, handler);\n break;\n case \"delete\":\n this.app.delete(path, handler);\n break;\n case \"patch\":\n this.app.patch(path, handler);\n break;\n default:\n throw new Error(`HTTP verb ${verb} not supported`);\n }\n }\n\n /**\n * Returns a function that can be used to serve the API.\n * \n * @example ValTown usage:\n * ```ts\n * export default gptApi.serve();\n * ```\n * \n * @example Deno usage:\n * ```\n * const { fetch } = gptApi.serve();\n * export default { fetch };\n * ```\n */\n serve(): typeof Hono.prototype.fetch {\n return this.app.fetch;\n }\n\n /**\n * Extracts API key from Bearer Auth header.\n */\n private extractApiKey(ctx: Context): string | null {\n const authHeader = ctx.req.header(\"Authorization\");\n if (!authHeader || !authHeader.startsWith(\"Bearer \")) {\n return null;\n }\n\n const apiKey = authHeader.split(\" \")[1];\n return apiKey;\n }\n}","deleted","label",[98],"permalink","https://www.val.town/x/xkonti/gptApiFramework/code/main.tsx","extension","actionData","errors"]