starlight-server 1.2.0 → 1.5.0

package/dist/swagger/factory.d.ts

@@ -1,97 +0,0 @@
-/**
- * 把路由定义转换成 swagger API 定义的工具函数
- */
-import type { RouteDefinition, ResponseDataType, BasicParameter } from '../router/index.js';
-import type { Schema, Reference, PathItem } from './openapi-spec.js';
-type AnyObject = {
-    [k: string]: unknown;
-};
-/**
- * 基本数据类型
- */
-export declare function string(description?: string, options?: AnyObject): {
-    type: string;
-    description: string | undefined;
-};
-export declare function number(description?: string, options?: AnyObject): {
-    type: string;
-    description: string | undefined;
-};
-export declare function boolean(description?: string, options?: AnyObject): {
-    type: string;
-    description: string | undefined;
-};
-export declare function object(properties: Record<string, Schema>, extra?: AnyObject): {
-    type: "object";
-    properties: Record<string, Schema>;
-};
-export declare function array(items: Schema, extra?: AnyObject): {
-    type: "array";
-    items: Schema;
-};
-/**
- * 对 components/schemas 中定义的数据类型的引用
- */
-export declare function ref(name: string, summary?: string, description?: string): Reference;
-/**
- * 可放置于 components/schemas 中的数据类型定义（用于响应内容）
- */
-export declare function responseSchema(type: ResponseDataType | ResponseDataType[]): Schema | Reference;
-/**
- * 可放置于 components/schemas 中的数据类型定义（用于请求内容）
- */
-export declare function parameterSchema(parameter: BasicParameter): Schema;
-/**
- * 生成 JSON 形式的 content
- */
-export declare function jsonMedia(schema: string | Schema): {
-    content: {
-        'application/json': {
-            schema: Schema | Reference;
-        };
-    };
-};
-/**
- * 把一系列路由转换成 swagger API 定义
- */
-export declare function paths(routes: RouteDefinition[]): Record<string, PathItem>;
-/**
- * 单个路由定义
- */
-export declare function operation(route: RouteDefinition): {
-    tags: string[];
-    summary: string;
-    operationId: string;
-    requestBody: {
-        content: {
-            'application/json': {
-                schema: Schema | Reference;
-            };
-        };
-    } | undefined;
-    responses: {
-        default: {
-            content: {
-                'application/json': {
-                    schema: Schema | Reference;
-                };
-            };
-            description: string;
-        };
-    };
-};
-/**
- * 生成路由的唯一 ID
- */
-export declare function operationId(route: RouteDefinition): string;
-/**
- * 路由请求参数转为 swagger 定义
- */
-export declare function requestBody(route: RouteDefinition): {
-    content: {
-        'application/json': {
-            schema: Schema | Reference;
-        };
-    };
-} | undefined;
-export {};

package/dist/swagger/factory.js

@@ -1,144 +0,0 @@
-/**
- * 基本数据类型
- */
-export function string(description, options) {
-    return { type: 'string', description, ...(options ?? {}) };
-}
-export function number(description, options) {
-    return { type: 'number', description, ...(options ?? {}) };
-}
-export function boolean(description, options) {
-    return { type: 'boolean', description, ...(options ?? {}) };
-}
-export function object(properties, extra) {
-    return { type: 'object', properties, ...(extra ?? {}) };
-}
-export function array(items, extra) {
-    return { type: 'array', items, ...(extra ?? {}) };
-}
-/**
- * 对 components/schemas 中定义的数据类型的引用
- */
-export function ref(name, summary, description) {
-    return { $ref: '#/components/schemas/' + name, summary, description };
-}
-/**
- * 可放置于 components/schemas 中的数据类型定义（用于响应内容）
- */
-export function responseSchema(type) {
-    if (Array.isArray(type)) {
-        return {
-            oneOf: type
-                .filter((subType) => subType !== 'null')
-                .map(responseSchema),
-            nullable: type.includes('null'),
-        };
-    }
-    if (typeof type === 'string')
-        return { type };
-    if ('ref' in type)
-        return ref(type.ref, type.summary, type.description);
-    if ('array' in type)
-        return array(responseSchema(type.array));
-    if ('object' in type) {
-        return object(type.object.reduce((properties, property) => ({
-            ...properties,
-            [property.name]: { ...responseSchema(property.type), description: property.description },
-        }), {}));
-    }
-    return {};
-}
-/**
- * 可放置于 components/schemas 中的数据类型定义（用于请求内容）
- */
-export function parameterSchema(parameter) {
-    const schema = {
-        description: parameter.description,
-        nullable: parameter.nullable,
-        default: parameter.defaults,
-    };
-    if (typeof parameter.type === 'string') {
-        schema.type = parameter.type;
-    }
-    else if ('array' in parameter.type) {
-        const arraySchema = array(parameterSchema(parameter.type.array));
-        Object.assign(schema, arraySchema);
-    }
-    else if ('record' in parameter.type) {
-        const innerSchema = parameterSchema(parameter.type.record);
-        Object.assign(schema, object({}, { additionalProperties: innerSchema }));
-    }
-    else if ('object' in parameter.type) {
-        const objectSchema = object(Object.entries(parameter.type.object).reduce((properties, [name, subParameter]) => ({
-            ...properties,
-            [name]: parameterSchema(subParameter),
-        }), {}));
-        Object.assign(schema, objectSchema);
-    }
-    return schema;
-}
-/**
- * 生成 JSON 形式的 content
- */
-export function jsonMedia(schema) {
-    return {
-        content: {
-            'application/json': {
-                schema: typeof schema === 'string' ? ref(schema) : schema,
-            },
-        },
-    };
-}
-/**
- * 把一系列路由转换成 swagger API 定义
- */
-export function paths(routes) {
-    const paths = {};
-    for (const route of routes) {
-        if (route.category === 'swagger')
-            continue;
-        if (!paths[route.path])
-            paths[route.path] = {};
-        const pathItem = paths[route.path];
-        const method = route.method.toLowerCase();
-        pathItem[method] = operation(route);
-    }
-    return paths;
-}
-/**
- * 单个路由定义
- */
-export function operation(route) {
-    return {
-        tags: route.category ? [route.category] : [],
-        summary: route.description,
-        operationId: operationId(route),
-        requestBody: requestBody(route),
-        responses: {
-            default: {
-                description: 'OK',
-                ...jsonMedia(route.response !== undefined ? responseSchema(route.response) : object({})),
-            },
-        },
-    };
-}
-/**
- * 生成路由的唯一 ID
- */
-export function operationId(route) {
-    return `${route.method}-${route.path}`;
-}
-/**
- * 路由请求参数转为 swagger 定义
- */
-export function requestBody(route) {
-    if (!route.body)
-        return;
-    return jsonMedia({
-        type: 'object',
-        properties: route.body.reduce((properties, parameter) => ({
-            ...properties,
-            [parameter.name]: parameterSchema(parameter),
-        }), {}),
-    });
-}

package/dist/swagger/openapi-spec.d.ts

@@ -1,261 +0,0 @@
-/**
- * OpenAPI Specification
- * https://swagger.io/specification/
- */
-export interface OpenAPI {
-    openapi: '3.1.0';
-    info: Info;
-    servers?: Server[];
-    paths: Paths;
-    components?: Components;
-    security?: SecurityRequirement[];
-    tags?: Tag[];
-    externalDocs?: ExternalDocumentation;
-}
-export interface Info extends Extendable {
-    title: string;
-    summary?: string;
-    description?: string;
-    termsOfService?: string;
-    contact?: Contact;
-    license?: License;
-    version: string;
-}
-export interface Contact extends Extendable {
-    name?: string;
-    url?: string;
-    email?: string;
-}
-export interface License extends Extendable {
-    name: string;
-    url?: string;
-}
-export interface Server extends Extendable {
-    url: string;
-    description?: CommonMark;
-    variables?: Record<string, ServerVariable>;
-}
-export interface ServerVariable extends Extendable {
-    enum?: [string] & string[];
-    default: string;
-    description: CommonMark;
-}
-export interface Components extends Extendable {
-    schemas?: Record<string, Schema>;
-    responses?: Record<string, Response | Reference>;
-    parameters?: Record<string, Parameter | Reference>;
-    examples?: Record<string, Example | Reference>;
-    requestBodies?: Record<string, RequestBody | Reference>;
-    headers?: Record<string, Header | Reference>;
-    securitySchemes?: Record<string, SecurityScheme | Reference>;
-    links?: Record<string, Link | Reference>;
-    callbacks?: Record<string, Callback | Reference>;
-    pathItems?: Record<string, PathItem | Reference>;
-}
-export interface Paths extends Extendable {
-    [path: string]: PathItem;
-}
-export interface PathItem extends Extendable {
-    $ref?: string;
-    summary?: string;
-    description?: CommonMark;
-    get?: Operation;
-    put?: Operation;
-    post?: Operation;
-    delete?: Operation;
-    options?: Operation;
-    head?: Operation;
-    patch?: Operation;
-    trace?: Operation;
-    servers?: Server[];
-    parameters?: (Parameter | Reference)[];
-}
-export interface Operation {
-    tags?: string[];
-    summary?: string;
-    description?: CommonMark;
-    externalDocs?: ExternalDocumentation;
-    operationId?: string;
-    parameters?: (Parameter | Reference)[];
-    requestBody?: RequestBody | Reference;
-    responses: Responses;
-    callbacks?: Record<string, Callback | Reference>;
-    deprecated?: boolean;
-}
-export interface ExternalDocumentation {
-    description?: CommonMark;
-    url: string;
-}
-export interface Parameter extends Extendable {
-    name: string;
-    in: ParameterLocation;
-    description?: CommonMark;
-    required?: boolean;
-    deprecated?: boolean;
-    allowEmptyValue?: boolean;
-    style?: ParameterStyle;
-    explode?: boolean;
-    allowReserved?: boolean;
-    schema?: Schema | Reference;
-    example?: unknown;
-    examples?: Record<string, Example | Reference>;
-    content?: Record<string, MediaType>;
-}
-export type ParameterLocation = 'query' | 'header' | 'path' | 'cookie';
-export type ParameterStyle = string;
-export interface RequestBody extends Extendable {
-    description?: CommonMark;
-    content: Record<string, MediaType>;
-    required?: boolean;
-}
-export interface MediaType extends Extendable {
-    schema?: Schema | Reference;
-    example?: unknown;
-    examples?: Record<string, Example | Reference>;
-    encoding?: Record<string, Encoding>;
-}
-export interface Encoding extends Extendable {
-    contentType?: string;
-    headers?: Record<string, Header | Reference>;
-    style?: ParameterStyle;
-    explode?: boolean;
-    allowReserved?: boolean;
-}
-export interface Responses extends Extendable {
-    default: Response | Reference;
-    [HTTPStatus: string]: Response | Reference;
-}
-export interface Response extends Extendable {
-    description: CommonMark;
-    headers?: Record<string, Header | Reference>;
-    content?: Record<string, MediaType>;
-    links?: Record<string, Link | Reference>;
-}
-export interface Callback extends Extendable {
-    [expression: Expression]: PathItem;
-}
-export interface Example extends Extendable {
-    summary?: string;
-    description?: CommonMark;
-    value?: unknown;
-    externalValue?: string;
-}
-export interface Link extends Extendable {
-    operationRef?: string;
-    operationId?: string;
-    parameters?: Record<string, unknown>;
-    requestBody?: unknown;
-    description?: string;
-    server?: Server;
-}
-export type Header = Omit<Parameter, 'name' | 'in'>;
-export interface Tag extends Extendable {
-    name: string;
-    description?: CommonMark;
-    externalDocs?: ExternalDocumentation;
-}
-export interface Reference {
-    $ref: string;
-    summary?: string;
-    description?: string;
-}
-export interface Schema extends Extendable {
-    nullable?: boolean;
-    discriminator?: Discriminator;
-    readonly?: boolean;
-    writeOnly?: boolean;
-    xml?: XML;
-    externalDocs?: ExternalDocumentation;
-    example?: unknown;
-    deprecated?: boolean;
-    multipleOf?: number;
-    maximum?: number;
-    exclusiveMaximum?: boolean;
-    minimum?: number;
-    exclusiveMinimum?: boolean;
-    maxLength?: number;
-    minLength?: number;
-    pattern?: string;
-    items?: Schema;
-    maxItems?: number;
-    minItems?: number;
-    uniqueItems?: boolean;
-    maxProperties?: number;
-    minProperties?: string;
-    required?: [string] & string[];
-    properties?: Record<string, Schema>;
-    additionalProperties?: boolean | Schema;
-    enum?: unknown[];
-    type?: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object' | 'null';
-    allOf?: Schema[];
-    anyOf?: Schema[];
-    oneOf?: Schema[];
-    not?: Schema;
-    title?: string;
-    description?: CommonMark;
-    default?: unknown;
-    format?: string;
-}
-export interface Discriminator {
-    propertyName?: string;
-    mapping?: Record<string, string>;
-}
-export interface XML extends Extendable {
-    name?: string;
-    namespace?: string;
-    prefix?: string;
-    attribute?: boolean;
-    wrapped?: boolean;
-}
-export interface SecurityScheme extends Extendable {
-    type: string;
-    description?: string;
-    name: string;
-    in: string;
-    schema: string;
-    bearerFormat?: string;
-    flows: OAuthFlows;
-    openIdConnectUrl: string;
-}
-export interface OAuthFlows extends Extendable {
-    implicit?: OAuthFlow;
-    password?: OAuthFlow;
-    clientCredentials?: OAuthFlow;
-    authorizationCode?: OAuthFlow;
-}
-export interface OAuthFlow extends Extendable {
-    authorizationUrl: string;
-    tokenUrl: string;
-    refreshUrl?: string;
-    scopes: Record<string, string>;
-}
-export interface SecurityRequirement {
-    [name: string]: string;
-}
-export type Extendable = {};
-export type CommonMark = string;
-export type Expression = string;
-export interface TypedSchema<T> extends Schema {
-    allOf?: TypedSchema<T>[];
-    anyOf?: TypedSchema<T>[];
-    oneOf?: TypedSchema<T>[];
-    not?: TypedSchema<T>;
-    example?: T;
-    enum?: T[];
-    default?: T;
-}
-export interface StringSchema extends TypedSchema<string> {
-    type: 'string';
-}
-export interface NumberSchema extends TypedSchema<number> {
-    type: 'number';
-}
-export interface BooleanSchema extends TypedSchema<boolean> {
-    type: 'boolean';
-}
-export interface ObjectSchema extends TypedSchema<Record<string, unknown>> {
-    type: 'object';
-}
-export interface ArraySchema extends TypedSchema<unknown[]> {
-    type: 'array';
-}

package/dist/swagger/openapi-spec.js

@@ -1,5 +0,0 @@
-/**
- * OpenAPI Specification
- * https://swagger.io/specification/
- */
-export {};

package/dist/validators/array.d.ts

@@ -1,9 +0,0 @@
-import { Validator } from './common.js';
-export interface ArrayOptions {
-    item: Validator;
-    min?: number;
-    max?: number;
-}
-export declare class ArrayValidator extends Validator<ArrayOptions> {
-    validate(fieldName: string, value: unknown): import("@anjianshi/utils").Success<unknown> | import("@anjianshi/utils").Failed<string>;
-}

package/dist/validators/array.js

@@ -1,28 +0,0 @@
-import { success, failed } from '@anjianshi/utils';
-import { Validator } from './common.js';
-export class ArrayValidator extends Validator {
-    validate(fieldName, value) {
-        const superResult = super.validate(fieldName, value);
-        if (!superResult.success)
-            return superResult;
-        value = superResult.data;
-        if (value === null || value === undefined)
-            return superResult;
-        const opt = this.options;
-        if (!Array.isArray(value))
-            return failed(`${fieldName} should be an array`);
-        if (typeof opt.min === 'number' && value.length < opt.min)
-            return failed(`array ${fieldName}'s length should >= ${opt.min}`);
-        if (typeof opt.max === 'number' && value.length > opt.max)
-            return failed(`array ${fieldName}'s length should <= ${opt.max}`);
-        const formatted = [];
-        for (let i = 0; i < value.length; i++) {
-            const itemResult = opt.item.validate(`${fieldName}[${i}]`, value[i]);
-            if (itemResult.success)
-                formatted.push(itemResult.data);
-            else
-                return itemResult;
-        }
-        return success(formatted);
-    }
-}

package/dist/validators/boolean.d.ts

@@ -1,4 +0,0 @@
-import { Validator } from './common.js';
-export declare class BooleanValidator extends Validator {
-    validate(fieldName: string, value: unknown): import("@anjianshi/utils").Success<unknown> | import("@anjianshi/utils").Failed<string>;
-}

package/dist/validators/boolean.js

@@ -1,28 +0,0 @@
-import { success, failed } from '@anjianshi/utils';
-import { Validator } from './common.js';
-export class BooleanValidator extends Validator {
-    validate(fieldName, value) {
-        const superResult = super.validate(fieldName, value);
-        if (!superResult.success)
-            return superResult;
-        value = superResult.data;
-        if (value === null || value === undefined)
-            return superResult;
-        if (typeof value === 'string') {
-            const str = value.trim().toLocaleLowerCase();
-            if (['1', 'true', 'on', 'yes'].includes(str))
-                value = true;
-            else if (['0', 'false', 'off', 'no'].includes(str))
-                value = false;
-        }
-        else if (typeof value === 'number') {
-            if (value === 1)
-                value = true;
-            else if (value === 0)
-                value = false;
-        }
-        if (typeof value !== 'boolean')
-            return failed(`${fieldName} must be true or false`);
-        return success(value);
-    }
-}

package/dist/validators/common.d.ts

@@ -1,23 +0,0 @@
-import { type MaySuccess } from '@anjianshi/utils';
-export interface CommonOptions {
-    /**
-     * allow `null`
-     * @default false
-     */
-    null: boolean;
-    /**
-     * allow `undefined`
-     * @default false
-     */
-    void: boolean;
-    /**
-     * 默认值，原值为 undefined 时生效（原值为 null 不会生效），指定后 void 选项将失去作用。
-     * default value，used when original value is `undefined`(not for null), and make `void` option no effect.
-     */
-    defaults: unknown;
-}
-export declare class Validator<Opt = unknown> {
-    readonly options: Opt & CommonOptions;
-    constructor(options: Opt & Partial<CommonOptions>);
-    validate(fieldName: string, value: unknown): MaySuccess<unknown>;
-}

package/dist/validators/common.js

@@ -1,25 +0,0 @@
-import { success, failed } from '@anjianshi/utils';
-export class Validator {
-    options;
-    constructor(options) {
-        this.options = {
-            null: false,
-            void: false,
-            defaults: undefined,
-            ...options,
-        };
-    }
-    validate(fieldName, value) {
-        if (typeof value === 'undefined') {
-            if (typeof this.options.defaults !== 'undefined') {
-                value = this.options.defaults;
-            }
-            else if (!this.options.void) {
-                return failed(`${fieldName} must have a value`);
-            }
-        }
-        if (value === null && !this.options.null)
-            return failed(`${fieldName} cannot be null`);
-        return success(value);
-    }
-}

package/dist/validators/index.d.ts

@@ -1,20 +0,0 @@
-/**
- * 实现数据验证、格式化
- * Implement data validation and formatting
- */
-import { ArrayValidator } from './array.js';
-import { BooleanValidator } from './boolean.js';
-import { Validator, type CommonOptions } from './common.js';
-import { NumberValidator } from './number.js';
-import { ObjectValidator } from './object.js';
-import { StringValidator } from './string.js';
-/**
- * 仅检查空值，不检查具体格式
- * Check only for empty values, not for specific formatting
- */
-export declare function any(options?: Partial<CommonOptions>): Validator<unknown>;
-export declare function string(...args: ConstructorParameters<typeof StringValidator>): StringValidator;
-export declare function number(...args: ConstructorParameters<typeof NumberValidator>): NumberValidator;
-export declare function boolean(options?: Partial<CommonOptions>): BooleanValidator;
-export declare function array(itemValidator: Validator, options?: Omit<ConstructorParameters<typeof ArrayValidator>[0], 'item'>): ArrayValidator;
-export declare function object(structOrValue: Record<string, Validator> | Validator, options?: Partial<CommonOptions>): ObjectValidator;

package/dist/validators/index.js

@@ -1,38 +0,0 @@
-/**
- * 实现数据验证、格式化
- * Implement data validation and formatting
- */
-import { ArrayValidator } from './array.js';
-import { BooleanValidator } from './boolean.js';
-import { Validator } from './common.js';
-import { NumberValidator } from './number.js';
-import { ObjectValidator } from './object.js';
-import { StringValidator } from './string.js';
-/**
- * 仅检查空值，不检查具体格式
- * Check only for empty values, not for specific formatting
- */
-export function any(options) {
-    return new Validator(options ?? {});
-}
-export function string(...args) {
-    return new StringValidator(...args);
-}
-export function number(...args) {
-    return new NumberValidator(...args);
-}
-export function boolean(options) {
-    return new BooleanValidator(options ?? {});
-}
-export function array(itemValidator, options) {
-    return new ArrayValidator({
-        item: itemValidator,
-        ...(options ?? {}),
-    });
-}
-export function object(structOrValue, options) {
-    return new ObjectValidator({
-        ...(structOrValue instanceof Validator ? { value: structOrValue } : { struct: structOrValue }),
-        ...options,
-    });
-}