@bleedingdev/modern-js-bff-core 3.2.0-ultramodern.0 → 3.2.0-ultramodern.2

package/package.json

@@ -17,7 +17,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "3.2.0-ultramodern.0",
+  "version": "3.2.0-ultramodern.2",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.js",
   "exports": {
@@ -35,7 +35,7 @@
     "koa-compose": "^4.1.0",
     "reflect-metadata": "^0.2.2",
     "type-fest": "5.6.0",
-    "@modern-js/utils": "npm:@bleedingdev/modern-js-utils@3.2.0-ultramodern.0"
+    "@modern-js/utils": "npm:@bleedingdev/modern-js-utils@3.2.0-ultramodern.2"
   },
   "devDependencies": {
     "@rslib/core": "0.21.5",
@@ -44,7 +44,7 @@
     "@typescript/native-preview": "7.0.0-dev.20260516.1",
     "tsconfig-paths": "^4.2.0",
     "zod": "^4.4.3",
-    "@modern-js/types": "npm:@bleedingdev/modern-js-types@3.2.0-ultramodern.0",
+    "@modern-js/types": "npm:@bleedingdev/modern-js-types@3.2.0-ultramodern.2",
     "@scripts/rstest-config": "2.66.0"
   },
   "peerDependencies": {

package/dist/types/api.d.ts

@@ -1,6 +0,0 @@
-import 'reflect-metadata';
-import type { ApiRunner, ArrayToObject, ExtractInputType, ExtractOuputType, MaybeAsync, Operator } from './types';
-export declare function Api<Operators extends Operator<any, any>[], Res extends MaybeAsync<any>>(...args: [
-    ...operators: Operators,
-    handler: (arg: ArrayToObject<ExtractOuputType<Operators>>) => Res
-]): ApiRunner<ExtractInputType<Operators> extends void[] ? void : ArrayToObject<ExtractInputType<Operators>>, Res>;

package/dist/types/client/generateClient.d.ts

@@ -1,21 +0,0 @@
-import type { HttpMethodDecider } from '@modern-js/types';
-import { type Result } from './result';
-export type GenClientResult = Result<string>;
-export type GenClientOptions = {
-    resourcePath: string;
-    source: string;
-    appDir: string;
-    apiDir: string;
-    lambdaDir: string;
-    prefix: string;
-    port: number;
-    requestCreator?: string;
-    fetcher?: string;
-    target?: string;
-    requireResolve?: typeof require.resolve;
-    httpMethodDecider?: HttpMethodDecider;
-    domain?: string;
-    requestId?: string;
-};
-export declare const INNER_CLIENT_REQUEST_CREATOR = "@modern-js/plugin-bff/client";
-export declare const generateClient: ({ appDir, resourcePath, apiDir, lambdaDir, prefix, port, target, requestCreator, fetcher, requireResolve, httpMethodDecider, domain, requestId, }: GenClientOptions) => Promise<GenClientResult>;

package/dist/types/client/index.d.ts

@@ -1 +0,0 @@
-export * from './generateClient';

package/dist/types/client/result.d.ts

@@ -1,15 +0,0 @@
-export type Err<T = unknown> = {
-    kind: 'Err';
-    value: T;
-    isErr: true;
-    isOk: false;
-};
-export type Ok<T = unknown> = {
-    kind: 'Ok';
-    value: T;
-    isErr: false;
-    isOk: true;
-};
-export type Result<T = unknown, E = string> = Err<E> | Ok<T>;
-export declare const Err: <E = string>(value: E) => Err<E>;
-export declare const Ok: <T, E = string>(value: T) => Result<T, E>;

package/dist/types/compatible.d.ts

@@ -1,9 +0,0 @@
-export type RequestOption<TQuery = never, TData = never> = ClearRecord<{
-    query: TQuery;
-    data: TData;
-}> & {
-    dataType?: string;
-};
-export type ClearRecord<O extends Record<string, any>> = {
-    [K in keyof O as O[K] extends never ? never : K]: O[K];
-};

package/dist/types/contracts/eventContracts.d.ts

@@ -1,22 +0,0 @@
-export type EventContract<Name extends string = string, Payload = unknown> = {
-    name: Name;
-    version: number;
-    schemaHash: string;
-    description?: string;
-};
-export type EventEnvelope<TContract extends EventContract = EventContract, TMeta extends Record<string, unknown> = Record<string, unknown>> = {
-    name: TContract['name'];
-    version: TContract['version'];
-    schemaHash: TContract['schemaHash'];
-    timestamp: number;
-    payload: TContract extends EventContract<string, infer TPayload> ? TPayload : unknown;
-    meta?: TMeta;
-};
-export declare const defineEventContract: <Name extends string, Payload = unknown>(input: {
-    name: Name;
-    version: number;
-    schemaHash: string;
-    description?: string;
-}) => EventContract<Name, Payload>;
-export declare const createEventEnvelope: <TContract extends EventContract, TMeta extends Record<string, unknown> = Record<string, unknown>>(contract: TContract, payload: TContract extends EventContract<string, infer TPayload> ? TPayload : unknown, meta?: TMeta) => EventEnvelope<TContract, TMeta>;
-export declare const isEventEnvelope: (value: unknown) => value is EventEnvelope<EventContract, Record<string, unknown>>;

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

@@ -1,8 +0,0 @@
-export declare class HttpError extends Error {
-    status: number;
-    constructor(status: number, message: string);
-}
-export declare class ValidationError extends HttpError {
-    private code;
-    constructor(status: number, message: string);
-}

package/dist/types/index.d.ts

@@ -1,11 +0,0 @@
-export { Api } from './api';
-export * from './client';
-export type * from './compatible';
-export * from './contracts/eventContracts';
-export { HttpError, ValidationError } from './errors/http';
-export * from './operators/http';
-export * from './router';
-export * from './security/crossProjectPolicy';
-export * from './security/operationContracts';
-export * from './types';
-export { createStorage, getRelativeRuntimePath, HANDLER_WITH_META, INPUT_PARAMS_DECIDER, isInputParamsDeciderHandler, isWithMetaHandler, registerPaths, } from './utils';

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

@@ -1,44 +0,0 @@
-import type { z } from 'zod';
-import { HttpMethod, type Operator, ResponseMetaType } from '../types';
-export interface ResponseMeta {
-    type: ResponseMetaType;
-    value: unknown;
-}
-export declare const createHttpOperator: (method: HttpMethod) => (urlPath: string) => Operator<void>;
-export declare const Get: (urlPath: string) => Operator<void>;
-export declare const Post: (urlPath: string) => Operator<void>;
-export declare const Put: (urlPath: string) => Operator<void>;
-export declare const Delete: (urlPath: string) => Operator<void>;
-export declare const Connect: (urlPath: string) => Operator<void>;
-export declare const Trace: (urlPath: string) => Operator<void>;
-export declare const Patch: (urlPath: string) => Operator<void>;
-export declare const Options: (urlPath: string) => Operator<void>;
-export declare const Head: (urlPath: string) => Operator<void>;
-export declare const Data: <Schema extends z.ZodType>(schema: Schema) => Operator<{
-    data: z.input<Schema>;
-}, {
-    data: z.output<Schema>;
-}>;
-export declare const Query: <Schema extends z.ZodType>(schema: Schema) => Operator<{
-    query: z.input<Schema>;
-}, {
-    query: z.output<Schema>;
-}>;
-export declare const Params: <Schema extends z.ZodType>(schema: Schema) => Operator<{
-    params: z.input<Schema>;
-}, {
-    params: z.output<Schema>;
-}>;
-export declare const Headers: <Schema extends z.ZodType>(schema: Schema) => Operator<{
-    headers: z.input<Schema>;
-}, {
-    headers: z.output<Schema>;
-}>;
-export declare const HttpCode: (statusCode: number) => Operator<void>;
-export declare const SetHeaders: (headers: Record<string, string>) => Operator<void>;
-export declare const Redirect: (url: string) => Operator<void>;
-export declare const Upload: <Schema extends z.ZodType>(urlPath: string, schema?: Schema) => Operator<{
-    files: z.input<Schema>;
-}, {
-    formData: z.output<Schema>;
-}>;

package/dist/types/router/constants.d.ts

@@ -1,6 +0,0 @@
-export declare const AllHttpMethods: string[];
-export declare const FRAMEWORK_MODE_LAMBDA_DIR = "lambda";
-export declare const FRAMEWORK_MODE_APP_DIR = "app";
-export declare const INDEX_SUFFIX = "index";
-export declare const API_DIR = "api";
-export declare const API_FILE_RULES: string[];

package/dist/types/router/index.d.ts

@@ -1,49 +0,0 @@
-import 'reflect-metadata';
-import type { HttpMethodDecider } from '@modern-js/types';
-import { HttpMethod } from '../types';
-import type { APIHandlerInfo, ApiHandler } from './types';
-export * from './constants';
-export * from './types';
-export declare class ApiRouter {
-    private appDir?;
-    private apiDir;
-    private existLambdaDir;
-    private httpMethodDecider;
-    private lambdaDir;
-    private prefix;
-    private apiFiles;
-    private isBuild?;
-    constructor({ appDir, apiDir, lambdaDir, prefix, isBuild, httpMethodDecider, }: {
-        appDir?: string;
-        apiDir: string;
-        lambdaDir?: string;
-        prefix?: string;
-        isBuild?: boolean;
-        httpMethodDecider?: HttpMethodDecider;
-    });
-    isExistLambda(): boolean;
-    getLambdaDir(): string;
-    isApiFile(filename: string): boolean;
-    getSingleModuleHandlers(filename: string): Promise<APIHandlerInfo[] | null>;
-    getHandlerInfo(filename: string, originFuncName: string, handler: ApiHandler): APIHandlerInfo | null;
-    getSafeRoutePath(filename: string, handler?: ApiHandler): string;
-    getRouteName(filename: string, handler?: ApiHandler): string;
-    getHttpMethod(originHandlerName: string, handler?: ApiHandler): HttpMethod | null;
-    getAction(handler?: ApiHandler): string | undefined;
-    loadApiFiles(): string[];
-    getApiFiles(): string[];
-    getApiHandlers(): Promise<APIHandlerInfo[]>;
-    /**
-     * 如果用户未传入或传入空串，默认为 /api
-     * 如果传入 /，则 prefix 为 /
-     */
-    private initPrefix;
-    private validateAbsolute;
-    private getExactLambdaDir;
-    private getModuleInfos;
-    private getModuleInfo;
-    private getHandlerInfos;
-    private getModuleHandlerInfos;
-    private validateValidApifile;
-    private getRoutePath;
-}

package/dist/types/router/types.d.ts

@@ -1,18 +0,0 @@
-import type { HttpMethod } from '../types';
-export type ModuleInfo = {
-    filename: string;
-    module: HandlerModule;
-};
-type Handler = (...args: any) => any | Promise<any>;
-export type ApiHandler = Handler;
-export type HandlerModule = Record<string, ApiHandler>;
-export type APIHandlerInfo = {
-    handler: ApiHandler;
-    name: string;
-    httpMethod: HttpMethod;
-    filename: string;
-    routeName: string;
-    routePath: string;
-    action?: string;
-};
-export {};

package/dist/types/router/utils.d.ts

@@ -1,10 +0,0 @@
-import type { APIHandlerInfo } from './types';
-type MaybeAsync<I> = I | Promise<I>;
-export type NormalHandler = (...args: any[]) => any;
-export type Handler<I, O> = (input: I) => MaybeAsync<O>;
-export declare const getFiles: (lambdaDir: string, rules: string | string[]) => string[];
-export declare const getPathFromFilename: (baseDir: string, filename: string) => string;
-export declare const isHandler: (input: any) => input is Handler<any, any>;
-export declare const requireHandlerModule: (modulePath: string) => Promise<any>;
-export declare const sortRoutes: (apiHandlers: APIHandlerInfo[]) => APIHandlerInfo[];
-export {};

package/dist/types/security/crossProjectPolicy.d.ts

@@ -1,30 +0,0 @@
-export declare const BFF_ENVELOPE_HEADER = "x-modernjs-bff-envelope";
-export declare const BFF_OPERATION_CONTEXT_HEADER = "x-operation-id";
-export declare const BFF_OPERATION_CONTEXT_DETAIL_HEADER = "x-modernjs-bff-operation-context";
-export type CrossProjectOperationContract = {
-    schemaHash?: string;
-    operationVersion?: number;
-};
-export type CrossProjectPolicyViolationReason = 'missing_envelope' | 'invalid_envelope' | 'missing_request_id' | 'namespace_not_allowed' | 'missing_operation_context' | 'operation_context_mismatch' | 'missing_operation_context_details' | 'invalid_operation_context_details' | 'operation_context_details_request_id_mismatch' | 'missing_operation_schema_hash' | 'missing_operation_version' | 'unknown_operation_contract' | 'operation_schema_hash_mismatch' | 'operation_version_mismatch';
-export type CrossProjectPolicyViolation = {
-    code: 'BFF_CROSS_PROJECT_POLICY_DENIED';
-    reason: CrossProjectPolicyViolationReason;
-    message: string;
-    status: number;
-};
-export interface CrossProjectPolicyConfig {
-    enabled?: boolean;
-    requireEnvelope?: boolean;
-    requireOperationContext?: boolean;
-    requireOperationContextDetails?: boolean;
-    requireOperationSchemaHash?: boolean;
-    requireOperationVersion?: boolean;
-    allowedNamespaces?: string[];
-    envelopeHeader?: string;
-    operationContextHeader?: string;
-    operationContextDetailHeader?: string;
-    expectedOperationContracts?: Record<string, CrossProjectOperationContract>;
-    allowUnknownOperations?: boolean;
-    denyStatus?: number;
-}
-export declare const evaluateCrossProjectPolicy: (headers: Record<string, unknown>, policy?: CrossProjectPolicyConfig) => CrossProjectPolicyViolation | null;

package/dist/types/security/operationContracts.d.ts

@@ -1,28 +0,0 @@
-import type { APIHandlerInfo } from '../router/types';
-export type OperationContractEntry = {
-    name: string;
-    httpMethod: string;
-    routePath: string;
-};
-export type OperationContractDefinition = {
-    requestId: string;
-    operationVersion: number;
-    schemaHash: string;
-    method: string;
-    routePath: string;
-    operationId: string;
-    handlerName: string;
-    filename?: string;
-};
-export type OperationContractMap = Record<string, OperationContractDefinition>;
-export declare const DEFAULT_OPERATION_VERSION = 1;
-export declare const createOperationEntries: (handlers: Array<{
-    name: string;
-    httpMethod: string;
-    routePath: string;
-}>) => OperationContractEntry[];
-export declare const createOperationSchemaHash: (operationEntries: OperationContractEntry[], requestId: string) => string;
-export declare const buildOperationContractMap: ({ handlers, requestId, }: {
-    handlers: APIHandlerInfo[];
-    requestId?: string;
-}) => OperationContractMap;

package/dist/types/types.d.ts

@@ -1,64 +0,0 @@
-type Merge<T, U> = T & Omit<U, keyof T>;
-export declare enum OperatorType {
-    Trigger = 0,
-    Middleware = 1
-}
-export declare enum TriggerType {
-    Http = 0
-}
-export declare enum HttpMetadata {
-    Method = "METHOD",
-    Data = "DATA",
-    Query = "QUERY",
-    Params = "PARAMS",
-    Headers = "HEADERS",
-    Response = "RESPONSE",
-    Files = "Files"
-}
-export declare enum ResponseMetaType {
-    StatusCode = 0,
-    Redirect = 1,
-    Headers = 2
-}
-export declare enum HttpMethod {
-    Get = "GET",
-    Post = "POST",
-    Put = "PUT",
-    Delete = "DELETE",
-    Connect = "CONNECT",
-    Trace = "TRACE",
-    Patch = "PATCH",
-    Options = "OPTIONS",
-    Head = "HEAD"
-}
-export type InputSchemaMeata = Extract<HttpMetadata, HttpMetadata.Data | HttpMetadata.Query | HttpMetadata.Headers | HttpMetadata.Params | HttpMetadata.Files>;
-export type ExecuteFunc<Outputs> = (helper: ExecuteHelper<Outputs>, next: () => Promise<any>) => Promise<any>;
-export type ExecuteHelper<Outputs> = {
-    result?: any;
-    inputs: Outputs;
-};
-export type MetadataHelper = {
-    setMetadata: <T = any>(key: any, value: T) => void;
-    getMetadata: <T = any>(key: any) => T;
-};
-export type Operator<Input = any, Output = Input> = {
-    name: string;
-    inputType?: Input;
-    outputType?: Output;
-    metadata?: (helper: MetadataHelper) => void;
-    validate?: ExecuteFunc<Output>;
-    execute?: ExecuteFunc<Output>;
-};
-export type MaybeAsync<T> = Promise<T> | T;
-export type ApiRunner<Input extends object | void | unknown, Output extends MaybeAsync<any>> = (...args: Input extends void ? [] : [input: Input]) => Output;
-export type NonNullable<T> = Exclude<T, null | undefined>;
-export type ExtractInputType<T> = {
-    [key in keyof T]: T[key] extends Operator<any, any> ? NonNullable<T[key]['inputType']> : void;
-};
-export type ExtractOuputType<T> = {
-    [key in keyof T]: T[key] extends Operator<any, any> ? NonNullable<T[key]['outputType']> : void;
-};
-export type ArrayToObject<T, R = {}> = T extends [infer First, ...infer Rest] ? First extends PromiseLike<infer PromiseValue> ? PromiseValue : First extends object ? Merge<First, ArrayToObject<Rest, R>> : ArrayToObject<Rest, R> : R;
-export type AsyncFunction = (...args: any[]) => Promise<any>;
-export declare const httpMethods: HttpMethod[];
-export {};

package/dist/types/utils/alias.d.ts

@@ -1,7 +0,0 @@
-interface Paths {
-    [key: string]: string[] | string;
-}
-export declare const getRelativeRuntimePath: (appDirectory: string, serverRuntimePath: string) => string;
-export declare const createMatchPath: (paths: Paths) => (request: string) => string | null;
-export declare const registerPaths: (paths: Paths) => () => void;
-export {};

package/dist/types/utils/debug.d.ts

@@ -1 +0,0 @@
-export declare const debug: (...args: unknown[]) => void;

package/dist/types/utils/index.d.ts

@@ -1,5 +0,0 @@
-export * from './alias';
-export { debug } from './debug';
-export * from './meta';
-export * from './storage';
-export * from './validate';

package/dist/types/utils/meta.d.ts

@@ -1,4 +0,0 @@
-export declare const HANDLER_WITH_META = "HANDLER_WITH_META";
-export declare const INPUT_PARAMS_DECIDER = "INPUT_PARAMS_DECIDER";
-export declare const isWithMetaHandler: (handler: any) => any;
-export declare const isInputParamsDeciderHandler: (handler: any) => any;

package/dist/types/utils/storage.d.ts

@@ -1,5 +0,0 @@
-declare const createStorage: <T>() => {
-    run: <O>(context: T, cb: () => O | Promise<O>) => Promise<O>;
-    useContext: () => T;
-};
-export { createStorage };

package/dist/types/utils/validate.d.ts

@@ -1,5 +0,0 @@
-export declare const getTypeErrorMessage: (actual: unknown) => string;
-export declare class ERR_INVALID_ARG_TYPE extends Error {
-    constructor(funcName: string, expectedType: string, actual: unknown);
-}
-export declare const validateFunction: (maybeFunc: unknown, name: string) => boolean;