@xylex-group/athena 2.8.2 → 2.9.0

package/dist/model-form-ByvyyvxB.d.ts

@@ -0,0 +1,96 @@
+import { d as AthenaGatewayErrorCode, Z as AthenaGatewayEndpointPath, _ as AthenaGatewayMethod, e as AthenaGatewayErrorDetails, W as AthenaGatewayResponse, N as AnyModelDef, r as InsertOf, H as RowOf, U as UpdateOf } from './types-BeZIHduP.js';
+
+interface AthenaGatewayErrorInput {
+    code: AthenaGatewayErrorCode;
+    message: string;
+    status?: number;
+    endpoint?: AthenaGatewayEndpointPath;
+    method?: AthenaGatewayMethod;
+    requestId?: string;
+    hint?: string;
+    cause?: string;
+}
+/**
+ * Canonical error for gateway failures.
+ * Holds request context and machine-readable classification.
+ */
+declare class AthenaGatewayError extends Error {
+    readonly code: AthenaGatewayErrorCode;
+    readonly status: number;
+    readonly endpoint?: AthenaGatewayEndpointPath;
+    readonly method?: AthenaGatewayMethod;
+    readonly requestId?: string;
+    readonly hint?: string;
+    readonly causeDetail?: string;
+    constructor(input: AthenaGatewayErrorInput);
+    toDetails(): AthenaGatewayErrorDetails;
+    static fromResponse<T>(response: AthenaGatewayResponse<T>, fallback: Omit<AthenaGatewayErrorInput, 'code' | 'message' | 'status'>): AthenaGatewayError;
+}
+declare function isAthenaGatewayError(error: unknown): error is AthenaGatewayError;
+
+type ModelFormNullishMode = 'empty-string' | 'undefined' | 'null';
+type NullishValueByMode = {
+    'empty-string': '';
+    undefined: undefined;
+    null: null;
+};
+type MapNullableToFormValue<TField, TMode extends ModelFormNullishMode> = null extends TField ? Exclude<TField, null> | NullishValueByMode[TMode] : TField;
+/**
+ * Form value shape derived from a model insert payload.
+ * Nullable fields are remapped to the selected nullish representation.
+ */
+type ModelFormValues<TModel extends AnyModelDef, TMode extends ModelFormNullishMode = 'empty-string'> = {
+    [K in keyof InsertOf<TModel>]: MapNullableToFormValue<InsertOf<TModel>[K], TMode>;
+};
+/**
+ * Alias for deriving form value types from any model contract.
+ */
+type FormValuesOf<TModel extends AnyModelDef, TMode extends ModelFormNullishMode = 'empty-string'> = ModelFormValues<TModel, TMode>;
+/**
+ * Default value shape for form initialization.
+ */
+type ModelFormDefaults<TModel extends AnyModelDef, TMode extends ModelFormNullishMode = 'empty-string'> = Partial<ModelFormValues<TModel, TMode>>;
+interface ToModelFormDefaultsOptions<TMode extends ModelFormNullishMode = 'empty-string'> {
+    /**
+     * Controls how nullable model values are represented in form defaults.
+     * - `empty-string` (default): `null -> ""`
+     * - `undefined`: `null -> undefined`
+     * - `null`: keeps `null`
+     */
+    nullishMode?: TMode;
+}
+interface ToModelPayloadOptions {
+    /**
+     * Converts `""` into `null` for nullable model fields.
+     * Defaults to `true`.
+     */
+    emptyStringAsNull?: boolean;
+    /**
+     * Omits `undefined` keys from the outgoing payload.
+     * Defaults to `true`.
+     */
+    stripUndefined?: boolean;
+}
+/**
+ * Normalizes model data into form-safe defaults using model nullability metadata.
+ */
+declare function toModelFormDefaults<TModel extends AnyModelDef, TMode extends ModelFormNullishMode = 'empty-string'>(model: TModel, values?: Partial<RowOf<TModel>> | Partial<InsertOf<TModel>> | null, options?: ToModelFormDefaultsOptions<TMode>): ModelFormDefaults<TModel, TMode>;
+/**
+ * Normalizes form values back into model-compatible insert/update payloads.
+ */
+declare function toModelPayload<TModel extends AnyModelDef>(model: TModel, formValues: Partial<ModelFormValues<TModel, 'empty-string' | 'undefined' | 'null'>>, options?: ToModelPayloadOptions): Partial<InsertOf<TModel>>;
+/**
+ * Runtime form adapter bound to a model contract.
+ */
+interface ModelFormAdapter<TModel extends AnyModelDef> {
+    model: TModel;
+    toDefaults<TMode extends ModelFormNullishMode = 'empty-string'>(values?: Partial<RowOf<TModel>> | Partial<InsertOf<TModel>> | null, options?: ToModelFormDefaultsOptions<TMode>): ModelFormDefaults<TModel, TMode>;
+    toInsert(values: Partial<ModelFormValues<TModel, 'empty-string' | 'undefined' | 'null'>>, options?: ToModelPayloadOptions): Partial<InsertOf<TModel>>;
+    toUpdate(values: Partial<ModelFormValues<TModel, 'empty-string' | 'undefined' | 'null'>>, options?: ToModelPayloadOptions): Partial<UpdateOf<TModel>>;
+}
+/**
+ * Creates a small model-aware adapter for form defaults and payload normalization.
+ */
+declare function createModelFormAdapter<TModel extends AnyModelDef>(model: TModel): ModelFormAdapter<TModel>;
+
+export { AthenaGatewayError as A, type FormValuesOf as F, type ModelFormAdapter as M, type ToModelFormDefaultsOptions as T, type ModelFormDefaults as a, type ModelFormNullishMode as b, type ModelFormValues as c, type ToModelPayloadOptions as d, createModelFormAdapter as e, toModelPayload as f, isAthenaGatewayError as i, toModelFormDefaults as t };

package/dist/model-form-DACdBLYG.d.cts

@@ -0,0 +1,96 @@
+import { d as AthenaGatewayErrorCode, Z as AthenaGatewayEndpointPath, _ as AthenaGatewayMethod, e as AthenaGatewayErrorDetails, W as AthenaGatewayResponse, N as AnyModelDef, r as InsertOf, H as RowOf, U as UpdateOf } from './types-BeZIHduP.cjs';
+
+interface AthenaGatewayErrorInput {
+    code: AthenaGatewayErrorCode;
+    message: string;
+    status?: number;
+    endpoint?: AthenaGatewayEndpointPath;
+    method?: AthenaGatewayMethod;
+    requestId?: string;
+    hint?: string;
+    cause?: string;
+}
+/**
+ * Canonical error for gateway failures.
+ * Holds request context and machine-readable classification.
+ */
+declare class AthenaGatewayError extends Error {
+    readonly code: AthenaGatewayErrorCode;
+    readonly status: number;
+    readonly endpoint?: AthenaGatewayEndpointPath;
+    readonly method?: AthenaGatewayMethod;
+    readonly requestId?: string;
+    readonly hint?: string;
+    readonly causeDetail?: string;
+    constructor(input: AthenaGatewayErrorInput);
+    toDetails(): AthenaGatewayErrorDetails;
+    static fromResponse<T>(response: AthenaGatewayResponse<T>, fallback: Omit<AthenaGatewayErrorInput, 'code' | 'message' | 'status'>): AthenaGatewayError;
+}
+declare function isAthenaGatewayError(error: unknown): error is AthenaGatewayError;
+
+type ModelFormNullishMode = 'empty-string' | 'undefined' | 'null';
+type NullishValueByMode = {
+    'empty-string': '';
+    undefined: undefined;
+    null: null;
+};
+type MapNullableToFormValue<TField, TMode extends ModelFormNullishMode> = null extends TField ? Exclude<TField, null> | NullishValueByMode[TMode] : TField;
+/**
+ * Form value shape derived from a model insert payload.
+ * Nullable fields are remapped to the selected nullish representation.
+ */
+type ModelFormValues<TModel extends AnyModelDef, TMode extends ModelFormNullishMode = 'empty-string'> = {
+    [K in keyof InsertOf<TModel>]: MapNullableToFormValue<InsertOf<TModel>[K], TMode>;
+};
+/**
+ * Alias for deriving form value types from any model contract.
+ */
+type FormValuesOf<TModel extends AnyModelDef, TMode extends ModelFormNullishMode = 'empty-string'> = ModelFormValues<TModel, TMode>;
+/**
+ * Default value shape for form initialization.
+ */
+type ModelFormDefaults<TModel extends AnyModelDef, TMode extends ModelFormNullishMode = 'empty-string'> = Partial<ModelFormValues<TModel, TMode>>;
+interface ToModelFormDefaultsOptions<TMode extends ModelFormNullishMode = 'empty-string'> {
+    /**
+     * Controls how nullable model values are represented in form defaults.
+     * - `empty-string` (default): `null -> ""`
+     * - `undefined`: `null -> undefined`
+     * - `null`: keeps `null`
+     */
+    nullishMode?: TMode;
+}
+interface ToModelPayloadOptions {
+    /**
+     * Converts `""` into `null` for nullable model fields.
+     * Defaults to `true`.
+     */
+    emptyStringAsNull?: boolean;
+    /**
+     * Omits `undefined` keys from the outgoing payload.
+     * Defaults to `true`.
+     */
+    stripUndefined?: boolean;
+}
+/**
+ * Normalizes model data into form-safe defaults using model nullability metadata.
+ */
+declare function toModelFormDefaults<TModel extends AnyModelDef, TMode extends ModelFormNullishMode = 'empty-string'>(model: TModel, values?: Partial<RowOf<TModel>> | Partial<InsertOf<TModel>> | null, options?: ToModelFormDefaultsOptions<TMode>): ModelFormDefaults<TModel, TMode>;
+/**
+ * Normalizes form values back into model-compatible insert/update payloads.
+ */
+declare function toModelPayload<TModel extends AnyModelDef>(model: TModel, formValues: Partial<ModelFormValues<TModel, 'empty-string' | 'undefined' | 'null'>>, options?: ToModelPayloadOptions): Partial<InsertOf<TModel>>;
+/**
+ * Runtime form adapter bound to a model contract.
+ */
+interface ModelFormAdapter<TModel extends AnyModelDef> {
+    model: TModel;
+    toDefaults<TMode extends ModelFormNullishMode = 'empty-string'>(values?: Partial<RowOf<TModel>> | Partial<InsertOf<TModel>> | null, options?: ToModelFormDefaultsOptions<TMode>): ModelFormDefaults<TModel, TMode>;
+    toInsert(values: Partial<ModelFormValues<TModel, 'empty-string' | 'undefined' | 'null'>>, options?: ToModelPayloadOptions): Partial<InsertOf<TModel>>;
+    toUpdate(values: Partial<ModelFormValues<TModel, 'empty-string' | 'undefined' | 'null'>>, options?: ToModelPayloadOptions): Partial<UpdateOf<TModel>>;
+}
+/**
+ * Creates a small model-aware adapter for form defaults and payload normalization.
+ */
+declare function createModelFormAdapter<TModel extends AnyModelDef>(model: TModel): ModelFormAdapter<TModel>;
+
+export { AthenaGatewayError as A, type FormValuesOf as F, type ModelFormAdapter as M, type ToModelFormDefaultsOptions as T, type ModelFormDefaults as a, type ModelFormNullishMode as b, type ModelFormValues as c, type ToModelPayloadOptions as d, createModelFormAdapter as e, toModelPayload as f, isAthenaGatewayError as i, toModelFormDefaults as t };