@suluk/builder - v0.1.11
    Preparing search index...

    Interface SulukModule

    interface SulukModule {
        name: string;
        version: string;
        provides: string[];
        requires?: string[];
        schemas: Record<string, SchemaOrRef>;
        paths?: Record<string, PathItem>;
        crud?: boolean;
        cost?: Record<string, ModuleCost>;
        securitySchemes?: Record<string, unknown>;
        providerSlots?: Record<string, string>;
    }
    Index

    Properties

    name version provides requires? schemas paths? crud? cost? securitySchemes? providerSlots?

    Properties

    name: string
    version: string
    provides: string[]

    Entity names this module OWNS (each must have a schema in schemas).

    requires?: string[]

    Entity names this module REFERENCES but does not own — must already be present at install time.

    schemas: Record<string, SchemaOrRef>

    components.schemas fragment (the provided entities; may $ref a required entity like User).

    paths?: Record<string, PathItem>

    Explicit operations beyond the auto-CRUD (e.g. checkout); keyed by v4 path.

    crud?: boolean

    Auto-generate CRUD operations for each provided entity (default true).

    cost?: Record<string, ModuleCost>

    x-suluk-cost per operation name (e.g. createOrder).

    securitySchemes?: Record<string, unknown>

    securitySchemes to merge.

    providerSlots?: Record<string, string>

    Declared provider slots a developer can swap (e.g. { payments: "stripe" }).

    Settings

    Member Visibility

    On This Page

    Properties