@bajustone/fortress 1.0.0-rc.1

package/dist/index-CxEkfCA0.d.cts

@@ -0,0 +1,77 @@
+/** Core operators that all DatabaseAdapter implementations MUST support */
+type CoreOperator = '=' | '!=' | 'in' | 'gt' | 'lt' | 'gte' | 'lte' | 'isNull';
+/** A single condition in a database query, joined with AND by the adapter. */
+interface WhereClause {
+    field: string;
+    /**
+     * Open string — core uses CoreOperator values.
+     *  Adapters MAY support additional operators: 'like', 'between', etc.
+     *  Adapters throw on unsupported operators at runtime.
+     */
+    operator: CoreOperator | (string & {});
+    value: unknown;
+}
+/** Scope rules for row-level data isolation */
+interface ScopeRule {
+    /** WHERE clauses auto-injected on findOne, findMany, count, update, delete */
+    filters: WhereClause[];
+    /** Default values auto-injected on create (e.g., { siteId: 3 }) */
+    defaults: Record<string, unknown>;
+}
+
+/**
+ * Generic CRUD database adapter interface fortress uses to talk to any
+ * datastore. Implement seven required methods (create, findOne, findMany,
+ * update, delete, count, transaction) and optionally `rawQuery` for
+ * performance-critical multi-table operations.
+ */
+interface DatabaseAdapter {
+    create: <T>(params: {
+        model: string;
+        data: Record<string, unknown>;
+    }) => Promise<T>;
+    findOne: <T>(params: {
+        model: string;
+        where: WhereClause[];
+    }) => Promise<T | null>;
+    findMany: <T>(params: {
+        model: string;
+        where?: WhereClause[];
+        limit?: number;
+        offset?: number;
+        sortBy?: {
+            field: string;
+            direction: 'asc' | 'desc';
+        };
+    }) => Promise<T[]>;
+    /**
+     * Update rows matching the where clause.
+     * Returns the updated row, or null if no rows matched the where clause.
+     */
+    update: <T>(params: {
+        model: string;
+        where: WhereClause[];
+        data: Record<string, unknown>;
+    }) => Promise<T | null>;
+    delete: (params: {
+        model: string;
+        where: WhereClause[];
+    }) => Promise<void>;
+    count: (params: {
+        model: string;
+        where?: WhereClause[];
+    }) => Promise<number>;
+    transaction: <T>(fn: (tx: DatabaseAdapter) => Promise<T>) => Promise<T>;
+    /**
+     * Optional: raw query for performance-critical multi-table operations.
+     *  Adapters that implement this get optimized IAM queries.
+     *  Others fall back to multiple findMany calls.
+     *  @param sql SQL string using `?` positional placeholders on every dialect
+     *  @param params Positional parameters matching the `?` placeholders
+     */
+    rawQuery?: <T>(sql: string, params?: unknown[]) => Promise<T[]>;
+    /** Database dialect hint for adapters that implement rawQuery */
+    readonly dialect?: 'sqlite' | 'pg';
+}
+
+export type { CoreOperator as C, DatabaseAdapter as D, ScopeRule as S, WhereClause as W };

package/dist/index-CxEkfCA0.d.ts

@@ -0,0 +1,77 @@
+/** Core operators that all DatabaseAdapter implementations MUST support */
+type CoreOperator = '=' | '!=' | 'in' | 'gt' | 'lt' | 'gte' | 'lte' | 'isNull';
+/** A single condition in a database query, joined with AND by the adapter. */
+interface WhereClause {
+    field: string;
+    /**
+     * Open string — core uses CoreOperator values.
+     *  Adapters MAY support additional operators: 'like', 'between', etc.
+     *  Adapters throw on unsupported operators at runtime.
+     */
+    operator: CoreOperator | (string & {});
+    value: unknown;
+}
+/** Scope rules for row-level data isolation */
+interface ScopeRule {
+    /** WHERE clauses auto-injected on findOne, findMany, count, update, delete */
+    filters: WhereClause[];
+    /** Default values auto-injected on create (e.g., { siteId: 3 }) */
+    defaults: Record<string, unknown>;
+}
+
+/**
+ * Generic CRUD database adapter interface fortress uses to talk to any
+ * datastore. Implement seven required methods (create, findOne, findMany,
+ * update, delete, count, transaction) and optionally `rawQuery` for
+ * performance-critical multi-table operations.
+ */
+interface DatabaseAdapter {
+    create: <T>(params: {
+        model: string;
+        data: Record<string, unknown>;
+    }) => Promise<T>;
+    findOne: <T>(params: {
+        model: string;
+        where: WhereClause[];
+    }) => Promise<T | null>;
+    findMany: <T>(params: {
+        model: string;
+        where?: WhereClause[];
+        limit?: number;
+        offset?: number;
+        sortBy?: {
+            field: string;
+            direction: 'asc' | 'desc';
+        };
+    }) => Promise<T[]>;
+    /**
+     * Update rows matching the where clause.
+     * Returns the updated row, or null if no rows matched the where clause.
+     */
+    update: <T>(params: {
+        model: string;
+        where: WhereClause[];
+        data: Record<string, unknown>;
+    }) => Promise<T | null>;
+    delete: (params: {
+        model: string;
+        where: WhereClause[];
+    }) => Promise<void>;
+    count: (params: {
+        model: string;
+        where?: WhereClause[];
+    }) => Promise<number>;
+    transaction: <T>(fn: (tx: DatabaseAdapter) => Promise<T>) => Promise<T>;
+    /**
+     * Optional: raw query for performance-critical multi-table operations.
+     *  Adapters that implement this get optimized IAM queries.
+     *  Others fall back to multiple findMany calls.
+     *  @param sql SQL string using `?` positional placeholders on every dialect
+     *  @param params Positional parameters matching the `?` placeholders
+     */
+    rawQuery?: <T>(sql: string, params?: unknown[]) => Promise<T[]>;
+    /** Database dialect hint for adapters that implement rawQuery */
+    readonly dialect?: 'sqlite' | 'pg';
+}
+
+export type { CoreOperator as C, DatabaseAdapter as D, ScopeRule as S, WhereClause as W };

package/dist/index-D054pcb-.d.cts

@@ -0,0 +1,146 @@
+import { J as JSONSchema, E as EndpointDefinition, C as ComponentSchemas, F as FortressPlugin } from './config-GtlVt6ZD.cjs';
+
+/** Minimal OpenAPI 3.1 spec shape produced by {@link buildOpenAPISpec}. */
+interface OpenAPISpec {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+    tags?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    paths: Record<string, Record<string, OpenAPIOperation>>;
+    components: {
+        schemas: Record<string, JSONSchema>;
+        securitySchemes: Record<string, OpenAPISecurityScheme>;
+    };
+}
+interface OpenAPIOperation {
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    deprecated?: boolean;
+    security?: Array<Record<string, string[]>>;
+    parameters?: OpenAPIParameter[];
+    requestBody?: {
+        required?: boolean;
+        content: {
+            'application/json': {
+                schema: JSONSchema;
+            };
+        };
+    };
+    responses: Record<string, {
+        description: string;
+        content?: {
+            'application/json': {
+                schema: JSONSchema;
+            };
+        };
+    }>;
+}
+interface OpenAPIParameter {
+    name: string;
+    in: 'query' | 'path';
+    required?: boolean;
+    description?: string;
+    schema: JSONSchema;
+}
+interface OpenAPISecurityScheme {
+    type: string;
+    scheme?: string;
+    bearerFormat?: string;
+    name?: string;
+    in?: string;
+}
+/** Options accepted by {@link buildOpenAPISpec}. */
+interface SpecBuilderOptions {
+    title: string;
+    version: string;
+    description?: string;
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+    /** Optional top-level OpenAPI tags. */
+    tags?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    /**
+     * Operation ID strategy. Defaults to the historical Fortress method+path
+     * generator. `fortress.toOpenAPI()` defaults this to `'handler'` so host
+     * specs match the endpoint contract names consumers already chose.
+     */
+    operationId?: 'methodPath' | 'handler' | ((endpoint: EndpointDefinition) => string | undefined);
+}
+
+/**
+ * OpenAPI 3.1 generator plugin for fortress.
+ *
+ * Walks every registered endpoint definition (auth, IAM, and any plugin
+ * routes), folds in their JSON Schema component definitions, and emits a
+ * complete OpenAPI 3.1 specification. Pairs with Scalar UI for an
+ * interactive docs page mounted by the framework adapters.
+ *
+ * @module
+ */
+
+interface OpenAPIConfig {
+    /** API title (default: 'Fortress Auth API') */
+    title?: string;
+    /** API version (default: '1.0.0') */
+    version?: string;
+    /** API description */
+    description?: string;
+    /** Server URL(s) for the spec */
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+    /** Optional top-level OpenAPI tags. */
+    tags?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    /** Operation ID strategy. Default: historical method+path IDs. */
+    operationId?: SpecBuilderOptions['operationId'];
+    /** Path to serve the JSON spec (default: '/openapi.json') */
+    specPath?: string;
+    /** Path to serve the Scalar UI (default: '/openapi') */
+    uiPath?: string;
+    /** Disable Scalar UI (default: false) */
+    disableUI?: boolean;
+    /** Include core auth endpoints in spec (default: true) */
+    includeCoreAuth?: boolean;
+    /** Include core IAM endpoints in spec (default: true) */
+    includeCoreIam?: boolean;
+    /** Additional component schemas to include */
+    additionalSchemas?: ComponentSchemas;
+    /** Additional endpoint definitions to include in the spec (for app-specific routes) */
+    additionalEndpoints?: EndpointDefinition[];
+}
+interface OpenAPIMethods {
+    [key: string]: (...args: any[]) => any;
+    generateSpec: () => Promise<OpenAPISpec>;
+    getSpec: () => Promise<Record<string, unknown>>;
+    getUI: () => string;
+}
+/**
+ * OpenAPI plugin factory. Returns a {@link FortressPlugin} that walks every
+ * registered endpoint definition and emits a complete OpenAPI 3.1 spec,
+ * pairable with Scalar UI for interactive documentation.
+ */
+declare function openapi(config?: OpenAPIConfig): FortressPlugin & {
+    readonly name: 'openapi';
+};
+
+export { type OpenAPISpec as O, type SpecBuilderOptions as S, type OpenAPIMethods as a, type OpenAPIConfig as b, openapi as o };

package/dist/index-jAMbbUAY.d.ts

@@ -0,0 +1,146 @@
+import { J as JSONSchema, E as EndpointDefinition, C as ComponentSchemas, F as FortressPlugin } from './config-B2366s_G.js';
+
+/** Minimal OpenAPI 3.1 spec shape produced by {@link buildOpenAPISpec}. */
+interface OpenAPISpec {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+    };
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+    tags?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    paths: Record<string, Record<string, OpenAPIOperation>>;
+    components: {
+        schemas: Record<string, JSONSchema>;
+        securitySchemes: Record<string, OpenAPISecurityScheme>;
+    };
+}
+interface OpenAPIOperation {
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    deprecated?: boolean;
+    security?: Array<Record<string, string[]>>;
+    parameters?: OpenAPIParameter[];
+    requestBody?: {
+        required?: boolean;
+        content: {
+            'application/json': {
+                schema: JSONSchema;
+            };
+        };
+    };
+    responses: Record<string, {
+        description: string;
+        content?: {
+            'application/json': {
+                schema: JSONSchema;
+            };
+        };
+    }>;
+}
+interface OpenAPIParameter {
+    name: string;
+    in: 'query' | 'path';
+    required?: boolean;
+    description?: string;
+    schema: JSONSchema;
+}
+interface OpenAPISecurityScheme {
+    type: string;
+    scheme?: string;
+    bearerFormat?: string;
+    name?: string;
+    in?: string;
+}
+/** Options accepted by {@link buildOpenAPISpec}. */
+interface SpecBuilderOptions {
+    title: string;
+    version: string;
+    description?: string;
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+    /** Optional top-level OpenAPI tags. */
+    tags?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    /**
+     * Operation ID strategy. Defaults to the historical Fortress method+path
+     * generator. `fortress.toOpenAPI()` defaults this to `'handler'` so host
+     * specs match the endpoint contract names consumers already chose.
+     */
+    operationId?: 'methodPath' | 'handler' | ((endpoint: EndpointDefinition) => string | undefined);
+}
+
+/**
+ * OpenAPI 3.1 generator plugin for fortress.
+ *
+ * Walks every registered endpoint definition (auth, IAM, and any plugin
+ * routes), folds in their JSON Schema component definitions, and emits a
+ * complete OpenAPI 3.1 specification. Pairs with Scalar UI for an
+ * interactive docs page mounted by the framework adapters.
+ *
+ * @module
+ */
+
+interface OpenAPIConfig {
+    /** API title (default: 'Fortress Auth API') */
+    title?: string;
+    /** API version (default: '1.0.0') */
+    version?: string;
+    /** API description */
+    description?: string;
+    /** Server URL(s) for the spec */
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+    /** Optional top-level OpenAPI tags. */
+    tags?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    /** Operation ID strategy. Default: historical method+path IDs. */
+    operationId?: SpecBuilderOptions['operationId'];
+    /** Path to serve the JSON spec (default: '/openapi.json') */
+    specPath?: string;
+    /** Path to serve the Scalar UI (default: '/openapi') */
+    uiPath?: string;
+    /** Disable Scalar UI (default: false) */
+    disableUI?: boolean;
+    /** Include core auth endpoints in spec (default: true) */
+    includeCoreAuth?: boolean;
+    /** Include core IAM endpoints in spec (default: true) */
+    includeCoreIam?: boolean;
+    /** Additional component schemas to include */
+    additionalSchemas?: ComponentSchemas;
+    /** Additional endpoint definitions to include in the spec (for app-specific routes) */
+    additionalEndpoints?: EndpointDefinition[];
+}
+interface OpenAPIMethods {
+    [key: string]: (...args: any[]) => any;
+    generateSpec: () => Promise<OpenAPISpec>;
+    getSpec: () => Promise<Record<string, unknown>>;
+    getUI: () => string;
+}
+/**
+ * OpenAPI plugin factory. Returns a {@link FortressPlugin} that walks every
+ * registered endpoint definition and emits a complete OpenAPI 3.1 spec,
+ * pairable with Scalar UI for interactive documentation.
+ */
+declare function openapi(config?: OpenAPIConfig): FortressPlugin & {
+    readonly name: 'openapi';
+};
+
+export { type OpenAPISpec as O, type SpecBuilderOptions as S, type OpenAPIMethods as a, type OpenAPIConfig as b, openapi as o };