npm - vovk - Versions diffs - 3.0.0-draft.74 → 3.0.0-draft.76 - Mend

vovk 3.0.0-draft.74 → 3.0.0-draft.76

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

package/package.json +1 -1
package/src/HttpException.ts +0 -16
package/src/StreamJSONResponse.ts +0 -61
package/src/VovkApp.ts +0 -240
package/src/client/createRPC.ts +0 -120
package/src/client/defaultFetcher.ts +0 -69
package/src/client/defaultHandler.ts +0 -23
package/src/client/defaultStreamHandler.ts +0 -88
package/src/client/index.ts +0 -9
package/src/client/types.ts +0 -120
package/src/createDecorator.ts +0 -61
package/src/createVovkApp.ts +0 -168
package/src/index.ts +0 -71
package/src/openapi/fromSchema.ts +0 -33
package/src/openapi/index.ts +0 -1
package/src/openapi/openapi.ts +0 -85
package/src/types.ts +0 -200
package/src/utils/generateStaticAPI.ts +0 -18
package/src/utils/getSchema.ts +0 -35
package/src/utils/parseQuery.ts +0 -160
package/src/utils/reqForm.ts +0 -16
package/src/utils/reqMeta.ts +0 -16
package/src/utils/reqQuery.ts +0 -6
package/src/utils/serializeQuery.ts +0 -69
package/src/utils/setHandlerValidation.ts +0 -35
package/src/utils/shim.ts +0 -17

package/src/types.ts DELETED Viewed

@@ -1,200 +0,0 @@
-import type { NextRequest } from 'next/server';
-import type { OperationObject } from 'openapi3-ts/oas31';
-import type { StreamJSONResponse } from './StreamJSONResponse';
-import { VovkStreamAsyncIterable } from './client/types';
-export type KnownAny = any; // eslint-disable-line @typescript-eslint/no-explicit-any
-export type StaticClass = Function; // eslint-disable-line @typescript-eslint/no-unsafe-function-type
-export type VovkHandlerSchema = {
-  path: string;
-  httpMethod: string; // HttpMethod type makes JSON incompatible with VovkHandlerSchema type
-  validation?: { query?: KnownAny; body?: KnownAny; output?: KnownAny };
-  openapi?: OperationObject;
-  custom?: Record<string, KnownAny>;
-};
-export type VovkControllerSchema = {
-  controllerName: string;
-  originalControllerName: string;
-  prefix?: string;
-  handlers: Record<string, VovkHandlerSchema>;
-};
-export type VovkSchema = {
-  emitSchema: boolean;
-  segmentName: string;
-  controllers: Record<string, VovkControllerSchema>;
-};
-export type VovkErrorResponse = {
-  cause?: unknown;
-  statusCode: HttpStatus;
-  message: string;
-  isError: true;
-};
-export type VovkControllerInternal = {
-  _controllerName?: VovkControllerSchema['controllerName'];
-  _prefix?: VovkControllerSchema['prefix'];
-  _handlers: VovkControllerSchema['handlers'];
-  _activated?: true;
-  _onError?: (err: Error, req: VovkRequest) => void | Promise<void>;
-};
-export type VovkController = StaticClass &
-  VovkControllerInternal & {
-    [key: string]: unknown;
-  };
-export type DecoratorOptions = {
-  cors?: boolean;
-  headers?: Record<string, string>;
-};
-export type RouteHandler = ((
-  req: VovkRequest,
-  params: Record<string, string>
-) => Response | Promise<Response> | Iterable<unknown> | AsyncIterable<unknown>) & {
-  _options?: DecoratorOptions;
-};
-export interface VovkRequest<BODY = undefined, QUERY extends object | undefined = undefined>
-  extends Omit<NextRequest, 'json' | 'nextUrl'> {
-  json: () => Promise<BODY>;
-  nextUrl: Omit<NextRequest['nextUrl'], 'searchParams'> & {
-    searchParams: Omit<
-      NextRequest['nextUrl']['searchParams'],
-      'get' | 'getAll' | 'entries' | 'forEach' | 'keys' | 'values'
-    > & {
-      get: <KEY extends keyof QUERY>(key: KEY) => QUERY[KEY] extends readonly (infer ITEM)[] ? ITEM : QUERY[KEY];
-      getAll: <KEY extends keyof QUERY>(key: KEY) => QUERY[KEY] extends KnownAny[] ? QUERY[KEY] : QUERY[KEY][];
-      entries: () => IterableIterator<[keyof QUERY, QUERY[keyof QUERY]]>;
-      forEach: (
-        callbackfn: (
-          value: QUERY[keyof QUERY],
-          key: keyof QUERY,
-          searchParams: NextRequest['nextUrl']['searchParams'] // original searchParams
-        ) => void
-      ) => void;
-      keys: () => IterableIterator<keyof QUERY>;
-      values: () => IterableIterator<QUERY[keyof QUERY]>;
-      // TODO (?) append, delete, set
-    };
-  };
-  vovk: {
-    body: () => Promise<BODY>;
-    query: () => QUERY;
-    meta: <T = Record<KnownAny, KnownAny>>(meta?: T | null) => T;
-    form: <T = KnownAny>() => Promise<T>;
-  };
-}
-export type ControllerStaticMethod<
-  REQ extends VovkRequest<KnownAny, KnownAny> = VovkRequest<undefined, Record<string, KnownAny>>,
-  PARAMS extends { [key: string]: string } = KnownAny,
-> = ((req: REQ, params: PARAMS) => unknown) & {
-  _controller?: VovkController;
-};
-export type VovkControllerBody<T extends (...args: KnownAny) => KnownAny> = Awaited<
-  ReturnType<Parameters<T>[0]['vovk']['body']>
->;
-export type VovkControllerQuery<T extends (...args: KnownAny) => KnownAny> = ReturnType<
-  Parameters<T>[0]['vovk']['query']
->;
-export type VovkControllerParams<T extends (...args: KnownAny) => KnownAny> = Parameters<T>[1];
-export type VovkControllerYieldType<T extends (req: VovkRequest<KnownAny, KnownAny>) => KnownAny> = T extends (
-  ...args: KnownAny[]
-) => AsyncGenerator<infer Y, KnownAny, KnownAny>
-  ? Y
-  : T extends (...args: KnownAny[]) => Generator<infer Y, KnownAny, KnownAny>
-    ? Y
-    : T extends (...args: KnownAny[]) => Promise<StreamJSONResponse<infer Y>> | StreamJSONResponse<infer Y>
-      ? Y
-      : never;
-export type VovkBody<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['body'];
-export type VovkQuery<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['query'];
-export type VovkParams<T extends (...args: KnownAny[]) => unknown> = Parameters<T>[0]['params'];
-export type VovkYieldType<T extends (...args: KnownAny[]) => unknown> = T extends (
-  ...args: KnownAny[]
-) => Promise<VovkStreamAsyncIterable<infer Y>>
-  ? Y
-  : never;
-export type VovkReturnType<T extends (...args: KnownAny) => unknown> = Awaited<ReturnType<T>>;
-export type StreamAbortMessage = {
-  isError: true;
-  reason: KnownAny;
-};
-export enum HttpMethod {
-  GET = 'GET',
-  POST = 'POST',
-  PUT = 'PUT',
-  PATCH = 'PATCH',
-  DELETE = 'DELETE',
-  HEAD = 'HEAD',
-  OPTIONS = 'OPTIONS',
-}
-export enum HttpStatus {
-  NULL = 0,
-  CONTINUE = 100,
-  SWITCHING_PROTOCOLS = 101,
-  PROCESSING = 102,
-  EARLYHINTS = 103,
-  OK = 200,
-  CREATED = 201,
-  ACCEPTED = 202,
-  NON_AUTHORITATIVE_INFORMATION = 203,
-  NO_CONTENT = 204,
-  RESET_CONTENT = 205,
-  PARTIAL_CONTENT = 206,
-  AMBIGUOUS = 300,
-  MOVED_PERMANENTLY = 301,
-  FOUND = 302,
-  SEE_OTHER = 303,
-  NOT_MODIFIED = 304,
-  TEMPORARY_REDIRECT = 307,
-  PERMANENT_REDIRECT = 308,
-  BAD_REQUEST = 400,
-  UNAUTHORIZED = 401,
-  PAYMENT_REQUIRED = 402,
-  FORBIDDEN = 403,
-  NOT_FOUND = 404,
-  METHOD_NOT_ALLOWED = 405,
-  NOT_ACCEPTABLE = 406,
-  PROXY_AUTHENTICATION_REQUIRED = 407,
-  REQUEST_TIMEOUT = 408,
-  CONFLICT = 409,
-  GONE = 410,
-  LENGTH_REQUIRED = 411,
-  PRECONDITION_FAILED = 412,
-  PAYLOAD_TOO_LARGE = 413,
-  URI_TOO_LONG = 414,
-  UNSUPPORTED_MEDIA_TYPE = 415,
-  REQUESTED_RANGE_NOT_SATISFIABLE = 416,
-  EXPECTATION_FAILED = 417,
-  I_AM_A_TEAPOT = 418,
-  MISDIRECTED = 421,
-  UNPROCESSABLE_ENTITY = 422,
-  FAILED_DEPENDENCY = 424,
-  PRECONDITION_REQUIRED = 428,
-  TOO_MANY_REQUESTS = 429,
-  INTERNAL_SERVER_ERROR = 500,
-  NOT_IMPLEMENTED = 501,
-  BAD_GATEWAY = 502,
-  SERVICE_UNAVAILABLE = 503,
-  GATEWAY_TIMEOUT = 504,
-  HTTP_VERSION_NOT_SUPPORTED = 505,
-}

package/src/utils/generateStaticAPI.ts DELETED Viewed

@@ -1,18 +0,0 @@
-import type { VovkController, StaticClass } from '../types';
-export function generateStaticAPI(c: Record<string, StaticClass>, slug = 'vovk') {
-  const controllers = c as Record<string, VovkController>;
-  return [
-    { [slug]: ['_schema_'] },
-    ...Object.values(controllers)
-      .map((controller) => {
-        const handlers = controller._handlers;
-        const splitPrefix = controller._prefix?.split('/') ?? [];
-        return Object.values(handlers).map((handler) => {
-          return { [slug]: [...splitPrefix, ...handler.path.split('/')].filter(Boolean) };
-        });
-      })
-      .flat(),
-  ];
-}

package/src/utils/getSchema.ts DELETED Viewed

@@ -1,35 +0,0 @@
-import type { VovkSchema, VovkController, StaticClass } from '../types';
-export default function getSchema(options: {
-  emitSchema?: boolean;
-  segmentName?: string;
-  controllers: Record<string, StaticClass>;
-  exposeValidation?: boolean;
-}) {
-  const exposeValidation = options?.exposeValidation ?? true;
-  const emitSchema = options.emitSchema ?? true;
-  const schema: VovkSchema = {
-    emitSchema,
-    segmentName: options.segmentName ?? '',
-    controllers: {},
-  };
-  if (!emitSchema) return schema;
-  for (const [controllerName, controller] of Object.entries(options.controllers) as [string, VovkController][]) {
-    schema.controllers[controllerName] = {
-      controllerName: controllerName,
-      originalControllerName: controller.name,
-      prefix: controller._prefix ?? '',
-      handlers: {
-        ...(exposeValidation
-          ? controller._handlers
-          : Object.fromEntries(
-              Object.entries(controller._handlers ?? {}).map(([key, value]) => [key, { ...value, validation: {} }])
-            )),
-      },
-    };
-  }
-  return schema;
-}

package/src/utils/parseQuery.ts DELETED Viewed

@@ -1,160 +0,0 @@
-import type { KnownAny } from '../types';
-/**
- * Parse a bracket-based key (e.g. "z[d][0][x]" or "arr[]")
- * into an array of path segments (strings or special push-markers).
- *
- * Example: "z[d][0][x]" => ["z", "d", "0", "x"]
- * Example: "arr[]"      => ["arr", "" ]  // "" indicates "push" onto array
- */
-function parseKey(key: string): string[] {
-  // The first segment is everything up to the first '[' (or the entire key if no '[')
-  const segments: string[] = [];
-  const topKeyMatch = key.match(/^([^[\]]+)/);
-  if (topKeyMatch) {
-    segments.push(topKeyMatch[1]);
-  } else {
-    // If it starts with brackets, treat it as empty? (edge case)
-    segments.push('');
-  }
-  // Now capture all bracket parts: [something], [0], []
-  const bracketRegex = /\[([^[\]]*)\]/g;
-  let match: RegExpExecArray | null;
-  while ((match = bracketRegex.exec(key)) !== null) {
-    // match[1] is the content inside the brackets
-    segments.push(match[1]);
-  }
-  return segments;
-}
-/**
- * Recursively set a value in a nested object/array, given a path of segments.
- * - If segment is numeric => treat as array index
- * - If segment is empty "" => push to array
- * - Else => object property
- */
-function setValue(obj: Record<string, KnownAny>, path: string[], value: KnownAny): void {
-  let current: KnownAny = obj;
-  for (let i = 0; i < path.length; i++) {
-    const segment = path[i];
-    // If we're at the last segment, set the value
-    if (i === path.length - 1) {
-      if (segment === '') {
-        // Empty bracket => push
-        if (!Array.isArray(current)) {
-          current = [];
-        }
-        current.push(value);
-      } else if (!isNaN(Number(segment))) {
-        // Numeric segment => array index
-        const idx = Number(segment);
-        if (!Array.isArray(current)) {
-          current = [];
-        }
-        current[idx] = value;
-      } else {
-        // Object property
-        current[segment] = value;
-      }
-    } else {
-      // Not the last segment: descend into existing structure or create it
-      const nextSegment = path[i + 1];
-      if (segment === '') {
-        // Empty bracket => push
-        if (!Array.isArray(current)) {
-          // Convert the current node into an array, if not one
-          current = [];
-        }
-        // If we are not at the last path, we need a placeholder object or array
-        // for the next segment. We'll push something and move current to that.
-        if (current.length === 0) {
-          // nothing in array yet
-          current.push(typeof nextSegment === 'string' && !isNaN(Number(nextSegment)) ? [] : {});
-        } else if (typeof nextSegment === 'string' && !isNaN(Number(nextSegment))) {
-          // next is numeric => we want an array
-          if (!Array.isArray(current[current.length - 1])) {
-            current[current.length - 1] = [];
-          }
-        } else {
-          // next is not numeric => we want an object
-          if (typeof current[current.length - 1] !== 'object') {
-            current[current.length - 1] = {};
-          }
-        }
-        current = current[current.length - 1];
-      } else if (!isNaN(Number(segment))) {
-        // segment is numeric => array index
-        const idx = Number(segment);
-        if (!Array.isArray(current)) {
-          current = [];
-        }
-        if (current[idx] === undefined) {
-          // Create placeholder for next segment
-          current[idx] = typeof nextSegment === 'string' && !isNaN(Number(nextSegment)) ? [] : {};
-        }
-        current = current[idx];
-      } else {
-        // segment is an object key
-        if (current[segment] === undefined) {
-          // Create placeholder
-          current[segment] = typeof nextSegment === 'string' && !isNaN(Number(nextSegment)) ? [] : {};
-        }
-        current = current[segment];
-      }
-    }
-  }
-}
-/**
- * Deserialize a bracket-based query string into an object.
- *
- * Supports:
- *   - Key/value pairs with nested brackets (e.g. "a[b][0]=value")
- *   - Arrays with empty bracket (e.g. "arr[]=1&arr[]=2")
- *   - Mixed arrays of objects, etc.
- *
- * @example
- *   parseQuery("x=xx&y[0]=yy&y[1]=uu&z[f]=x&z[u][0]=uu&z[u][1]=xx&z[d][x]=ee")
- *   => {
- *        x: "xx",
- *        y: ["yy", "uu"],
- *        z: {
- *          f: "x",
- *          u: ["uu", "xx"],
- *          d: { x: "ee" }
- *        }
- *      }
- *
- * @param queryString - The raw query string (e.g. location.search.slice(1))
- * @returns           - A nested object representing the query params
- */
-export default function parseQuery(queryString: string): Record<string, KnownAny> {
-  const result: Record<string, KnownAny> = {};
-  if (!queryString) return result;
-  // Split into key=value pairs
-  const pairs = queryString
-    .replace(/^\?/, '') // Remove leading "?" if present
-    .split('&');
-  for (const pair of pairs) {
-    const [rawKey, rawVal = ''] = pair.split('=');
-    const decodedKey = decodeURIComponent(rawKey || '');
-    const decodedVal = decodeURIComponent(rawVal);
-    // Parse bracket notation
-    const pathSegments = parseKey(decodedKey);
-    // Insert into the result object
-    setValue(result, pathSegments, decodedVal);
-  }
-  return result;
-}

package/src/utils/reqForm.ts DELETED Viewed

@@ -1,16 +0,0 @@
-import type { KnownAny, VovkRequest } from '../types';
-const formMap = new WeakMap();
-export default async function reqForm<T = KnownAny>(req: VovkRequest<KnownAny, KnownAny>): Promise<T> {
-  if (formMap.has(req)) {
-    return formMap.get(req) as T;
-  }
-  const body = await req.formData();
-  const formData = Object.fromEntries(body.entries()) as T;
-  formMap.set(req, formData);
-  return formData;
-}

package/src/utils/reqMeta.ts DELETED Viewed

@@ -1,16 +0,0 @@
-import type { KnownAny, VovkRequest } from '../types';
-const metaMap = new WeakMap();
-export default function reqMeta<T = Record<KnownAny, KnownAny>>(
-  req: VovkRequest<KnownAny, KnownAny>,
-  meta?: T | null
-): T {
-  if (meta) {
-    metaMap.set(req, { ...metaMap.get(req), ...meta });
-  } else if (meta === null) {
-    metaMap.delete(req);
-  }
-  return (metaMap.get(req) ?? {}) as T;
-}

package/src/utils/reqQuery.ts DELETED Viewed

@@ -1,6 +0,0 @@
-import type { KnownAny, VovkRequest } from '../types';
-import parseQuery from './parseQuery';
-export default function reqQuery<T extends object | undefined>(req: VovkRequest<KnownAny, T>): T {
-  return parseQuery(req.nextUrl.search) as NonNullable<T>;
-}

package/src/utils/serializeQuery.ts DELETED Viewed

@@ -1,69 +0,0 @@
-import type { KnownAny } from '../types';
-/**
- * Recursively build query parameters from an object.
- *
- * @param key      - The query key so far (e.g. 'user', 'user[0]', 'user[0][name]')
- * @param value    - The current value to serialize
- * @returns        - An array of `key=value` strings
- */
-function buildParams(key: string, value: KnownAny): string[] {
-  if (value === null || value === undefined) {
-    return []; // skip null/undefined values entirely
-  }
-  // If value is an object or array, we need to recurse
-  if (typeof value === 'object') {
-    // Array case
-    if (Array.isArray(value)) {
-      /**
-       * We use index-based bracket notation here:
-       *   e.g. for value = ['aa', 'bb'] and key = 'foo'
-       *   => "foo[0]=aa&foo[1]=bb"
-       *
-       * If you prefer "foo[]=aa&foo[]=bb" style, replace:
-       *   `${key}[${i}]`
-       * with:
-       *   `${key}[]`
-       */
-      return value.flatMap((v, i) => {
-        const newKey = `${key}[${i}]`;
-        return buildParams(newKey, v);
-      });
-    }
-    // Plain object case
-    return Object.keys(value).flatMap((k) => {
-      const newKey = `${key}[${k}]`;
-      return buildParams(newKey, value[k]);
-    });
-  }
-  return [`${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`];
-}
-/**
- * Serialize a nested object (including arrays, arrays of objects, etc.)
- * into a bracket-based query string.
- *
- * @example
- *   serializeQuery({ x: 'xx', y: [1, 2], z: { f: 'x' } })
- *   => "x=xx&y[0]=1&y[1]=2&z[f]=x"
- *
- * @param obj - The input object to be serialized
- * @returns   - A bracket-based query string (without leading "?")
- */
-export default function serializeQuery(obj: Record<string, KnownAny>): string {
-  if (!obj || typeof obj !== 'object') return '';
-  // Collect query segments
-  const segments: string[] = [];
-  for (const key in obj) {
-    if (Object.prototype.hasOwnProperty.call(obj, key)) {
-      const value = obj[key];
-      segments.push(...buildParams(key, value));
-    }
-  }
-  return segments.join('&');
-}

package/src/utils/setHandlerValidation.ts DELETED Viewed

@@ -1,35 +0,0 @@
-import type { KnownAny, VovkController, VovkHandlerSchema } from '../types';
-export async function setHandlerValidation(
-  h: ((...args: KnownAny[]) => KnownAny) & { _onSettled?: (controller: VovkController) => void },
-  validation: Pick<Exclude<VovkHandlerSchema['validation'], undefined>, 'body' | 'query' | 'output'>
-) {
-  h._onSettled = (controller) => {
-    if (!controller) {
-      throw new Error(
-        'Error setting client validators. Controller not found. Did you forget to use an HTTP decorator?'
-      );
-    }
-    const handlerName = Object.getOwnPropertyNames(controller).find(
-      (key) =>
-        (
-          controller[key] as {
-            _sourceMethod?: unknown;
-          }
-        )._sourceMethod === h
-    );
-    if (!handlerName) {
-      throw new Error('Error setting client validators. Handler not found.');
-    }
-    controller._handlers = {
-      ...controller._handlers,
-      [handlerName]: {
-        ...controller._handlers?.[handlerName],
-        validation,
-      },
-    };
-  };
-}

package/src/utils/shim.ts DELETED Viewed

@@ -1,17 +0,0 @@
-if (typeof Symbol.dispose !== 'symbol') {
-  Object.defineProperty(Symbol, 'dispose', {
-    configurable: false,
-    enumerable: false,
-    writable: false,
-    value: Symbol.for('dispose'),
-  });
-}
-if (typeof Symbol.asyncDispose !== 'symbol') {
-  Object.defineProperty(Symbol, 'asyncDispose', {
-    configurable: false,
-    enumerable: false,
-    writable: false,
-    value: Symbol.for('asyncDispose'),
-  });
-}