brix-runtime-sdk-api-web 1.0.0

package/src/types/capability.d.ts

@@ -0,0 +1,218 @@
+/**
+ * Copyright 2026 Brix Platform Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @file Capability Related Type Definitions
+ * @description Defines core types for the capability system, including capability metadata, status, registry, etc.
+ * @module @brix/runtime-sdk-api-web/types/capability
+ * @version 3.2.0
+ *
+ * [v3.2 Changes]
+ * Extracted from index.ts into a standalone type file to keep the contract layer clean.
+ *
+ * [Design Principles]
+ * - All type definitions use readonly properties
+ * - Use Symbol as capability unique identifier (type-safe)
+ * - Support lazy initialization and scope control for capabilities
+ */
+/**
+ * Capability Priority Enum
+ *
+ * <p>Used to determine which implementation to use when multiple capability providers conflict.</p>
+ */
+export declare enum CapabilityPriority {
+    /** Low Priority (fallback implementation) */
+    LOW = 0,
+    /** Normal Priority (default) */
+    NORMAL = 50,
+    /** High Priority (overrides default implementation) */
+    HIGH = 100
+}
+/**
+ * Capability Metadata (Simplified)
+ */
+export interface CapabilityMetadata {
+    /** Capability Name */
+    readonly name: string;
+    /** Capability Version */
+    readonly version: string;
+    /** Priority */
+    readonly priority: CapabilityPriority;
+    /** Whether Required */
+    readonly required: boolean;
+}
+/**
+ * Capability ID Type
+ *
+ * <p>Supports string or Symbol, recommend using Symbol.for() to ensure uniqueness.</p>
+ */
+export type CapabilityId = string | symbol;
+/**
+ * Capability Meta Information (Full Version)
+ *
+ * <p>Contains complete metadata for capability registration and discovery.</p>
+ */
+export interface CapabilityMeta {
+    /** Capability Unique Identifier */
+    readonly id: CapabilityId;
+    /** Capability Name (Human-readable) */
+    readonly name: string;
+    /** Capability Description */
+    readonly description?: string;
+    /** Capability Version */
+    readonly version?: string;
+    /** Dependent Capability ID List */
+    readonly dependencies?: CapabilityId[];
+    /** Tags (for filtering and categorization) */
+    readonly tags?: string[];
+}
+/**
+ * Capability Status
+ *
+ * <p>Describes the current status of a capability in its lifecycle.</p>
+ */
+export type CapabilityStatus = 'registered' | 'initializing' | 'ready' | 'error' | 'disposed';
+/**
+ * Capability Type Identifier (Generic Interface)
+ *
+ * <p>Used to identify and create capability instances, containing capability metadata.
+ * Uses phantom property `_phantom` for type inference.</p>
+ *
+ * @example
+ * ```typescript
+ * interface MyCapability {
+ *   doSomething(): void;
+ * }
+ *
+ * const MyCapabilityType = createCapabilityType<MyCapability>({
+ *   id: 'my-capability',
+ *   name: 'My Capability',
+ * });
+ * ```
+ */
+export interface CapabilityType<T = unknown> extends CapabilityMeta {
+    /**
+     * Phantom property for type inference
+     * Does not exist at runtime, only for TypeScript type system
+     */
+    readonly _phantom?: T;
+}
+/**
+ * Create Capability Type Identifier
+ *
+ * @param meta - Capability meta information
+ * @returns Capability type identifier object
+ */
+export declare function createCapabilityType<T>(meta: Omit<CapabilityMeta, 'id'> & {
+    id: string;
+}): CapabilityType<T>;
+/**
+ * Capability Provider Interface
+ *
+ * <p>Encapsulates the creation and disposal logic of capability instances.</p>
+ */
+export interface CapabilityProvider<T = unknown> {
+    /** Get capability instance */
+    provide(): T;
+    /** Dispose capability instance (optional) */
+    dispose?(): void;
+}
+/**
+ * Simple Capability Provider
+ *
+ * <p>Can be the capability instance itself, or a factory function that returns the capability instance.</p>
+ */
+export type SimpleCapabilityProvider<T> = T | (() => T);
+/**
+ * Capability Registration Options
+ */
+export interface CapabilityRegisterOptions {
+    /**
+     * Whether to override existing capability
+     */
+    override?: boolean;
+    /**
+     * Capability priority
+     */
+    priority?: CapabilityPriority;
+    /**
+     * Capability scope
+     * - 'global': Global scope, shared by all modules
+     * - 'module': Module scope, only available in current module
+     * @default 'global'
+     */
+    scope?: 'global' | 'module';
+    /**
+     * Lazy initialization
+     * When true, capability is instantiated on first use
+     * @default false
+     */
+    lazy?: boolean;
+}
+/**
+ * Capability Runtime Information
+ *
+ * <p>Describes the detailed status of a capability at runtime.</p>
+ */
+export interface CapabilityRuntimeInfo {
+    /** Capability Metadata */
+    readonly meta: CapabilityMeta;
+    /** Current Status */
+    readonly status: CapabilityStatus;
+    /** Registration Timestamp */
+    readonly registeredAt: number;
+    /** Initialization Timestamp */
+    readonly initializedAt?: number;
+    /** Error Information (when status is error) */
+    readonly error?: Error;
+    /** Invocation Count Statistics */
+    readonly invocationCount: number;
+}
+/**
+ * Capability Registry Interface
+ *
+ * <p>Manages registration, retrieval, initialization, and disposal of capabilities.</p>
+ */
+export interface CapabilityRegistry {
+    /** Get capability instance */
+    get<T>(capabilityType: CapabilityType<T>): T | undefined;
+    /** Get required capability (throws exception if not found) */
+    getRequired<T>(capabilityType: CapabilityType<T>): T;
+    /** Register capability */
+    register<T>(capabilityType: CapabilityType<T>, provider: CapabilityProvider<T>, options?: CapabilityRegisterOptions): void;
+    /** Unregister capability */
+    unregister<T>(capabilityType: CapabilityType<T>): boolean;
+    /** Check if capability is registered */
+    has<T>(capabilityType: CapabilityType<T>): boolean;
+    /** Check if capability is ready */
+    isReady<T>(capabilityType: CapabilityType<T>): boolean;
+    /** Get capability runtime information */
+    getInfo<T>(capabilityType: CapabilityType<T>): CapabilityRuntimeInfo | undefined;
+    /** Get all registered capability IDs */
+    getRegisteredIds(): CapabilityId[];
+    /** Get runtime information for all capabilities */
+    getAllInfo(): Map<CapabilityId, CapabilityRuntimeInfo>;
+    /** Filter capabilities by status */
+    getByStatus(status: CapabilityStatus): CapabilityId[];
+    /** Filter capabilities by tag */
+    getByTag(tag: string): CapabilityId[];
+    /** Initialize all registered capabilities */
+    initializeAll(): Promise<boolean>;
+    /** Dispose all capabilities */
+    disposeAll(): Promise<void>;
+    /** Reset registry */
+    reset(): void;
+}
+//# sourceMappingURL=capability.d.ts.map

package/src/types/capability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capability.d.ts","sourceRoot":"","sources":["capability.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH;;;;GAIG;AACH,oBAAY,kBAAkB;IAC5B,iBAAiB;IACjB,GAAG,IAAI;IACP,gBAAgB;IAChB,MAAM,KAAK;IACX,mBAAmB;IACnB,IAAI,MAAM;CACX;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,WAAW;IACX,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,WAAW;IACX,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,UAAU;IACV,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC;IACtC,WAAW;IACX,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3C;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,aAAa;IACb,QAAQ,CAAC,EAAE,EAAE,YAAY,CAAC;IAE1B,iBAAiB;IACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,WAAW;IACX,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B,WAAW;IACX,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAE1B,kBAAkB;IAClB,QAAQ,CAAC,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;IAEvC,iBAAiB;IACjB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAMD;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,YAAY,GACZ,cAAc,GACd,OAAO,GACP,OAAO,GACP,UAAU,CAAC;AAMf;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,cAAc;IACjE;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;CACvB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAChD,cAAc,CAAC,CAAC,CAAC,CAKnB;AAMD;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,OAAO;IAC7C,aAAa;IACb,OAAO,IAAI,CAAC,CAAC;IAEb,iBAAiB;IACjB,OAAO,CAAC,IAAI,IAAI,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AAMxD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAE9B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAMD;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,YAAY;IACZ,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAE9B,WAAW;IACX,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC,YAAY;IACZ,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAE9B,aAAa;IACb,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEhC,wBAAwB;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IAEvB,aAAa;IACb,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAMD;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,aAAa;IACb,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAEzD,uBAAuB;IACvB,WAAW,CAAC,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAErD,WAAW;IACX,QAAQ,CAAC,CAAC,EACR,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,EACjC,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAC/B,OAAO,CAAC,EAAE,yBAAyB,GAClC,IAAI,CAAC;IAER,WAAW;IACX,UAAU,CAAC,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;IAE1D,gBAAgB;IAChB,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;IAEnD,eAAe;IACf,OAAO,CAAC,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;IAEvD,gBAAgB;IAChB,OAAO,CAAC,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,qBAAqB,GAAG,SAAS,CAAC;IAEjF,oBAAoB;IACpB,gBAAgB,IAAI,YAAY,EAAE,CAAC;IAEnC,mBAAmB;IACnB,UAAU,IAAI,GAAG,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;IAEvD,cAAc;IACd,WAAW,CAAC,MAAM,EAAE,gBAAgB,GAAG,YAAY,EAAE,CAAC;IAEtD,cAAc;IACd,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,EAAE,CAAC;IAEtC,kBAAkB;IAClB,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAElC,aAAa;IACb,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B,YAAY;IACZ,KAAK,IAAI,IAAI,CAAC;CACf"}

package/src/types/capability.ts

@@ -0,0 +1,302 @@
+/**
+ * Copyright 2026 Brix Platform Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @file Capability Related Type Definitions
+ * @description Defines core types for the capability system, including capability metadata, status, registry, etc.
+ * @module @brix/runtime-sdk-api-web/types/capability
+ * @version 3.2.0
+ *
+ * [v3.2 Changes]
+ * Extracted from index.ts into a standalone type file to keep the contract layer clean.
+ *
+ * [Design Principles]
+ * - All type definitions use readonly properties
+ * - Use Symbol as capability unique identifier (type-safe)
+ * - Support lazy initialization and scope control for capabilities
+ */
+
+// =========================================
+// Capability Priority
+// =========================================
+
+/**
+ * Capability Priority Enum
+ *
+ * <p>Used to determine which implementation to use when multiple capability providers conflict.</p>
+ */
+export enum CapabilityPriority {
+  /** Low Priority (fallback implementation) */
+  LOW = 0,
+  /** Normal Priority (default) */
+  NORMAL = 50,
+  /** High Priority (overrides default implementation) */
+  HIGH = 100,
+}
+
+// =========================================
+// Capability Metadata
+// =========================================
+
+/**
+ * Capability Metadata (Simplified)
+ */
+export interface CapabilityMetadata {
+  /** Capability Name */
+  readonly name: string;
+  /** Capability Version */
+  readonly version: string;
+  /** Priority */
+  readonly priority: CapabilityPriority;
+  /** Whether Required */
+  readonly required: boolean;
+}
+
+/**
+ * Capability ID Type
+ *
+ * <p>Supports string or Symbol, recommend using Symbol.for() to ensure uniqueness.</p>
+ */
+export type CapabilityId = string | symbol;
+
+/**
+ * Capability Meta Information (Full Version)
+ *
+ * <p>Contains complete metadata for capability registration and discovery.</p>
+ */
+export interface CapabilityMeta {
+  /** Capability Unique Identifier */
+  readonly id: CapabilityId;
+
+  /** Capability Name (Human-readable) */
+  readonly name: string;
+
+  /** Capability Description */
+  readonly description?: string;
+
+  /** Capability Version */
+  readonly version?: string;
+
+  /** Dependent Capability ID List */
+  readonly dependencies?: CapabilityId[];
+
+  /** Tags (for filtering and categorization) */
+  readonly tags?: string[];
+}
+
+// =========================================
+// Capability Status
+// =========================================
+
+/**
+ * Capability Status
+ *
+ * <p>Describes the current status of a capability in its lifecycle.</p>
+ */
+export type CapabilityStatus =
+  | 'registered'    // Registered, not initialized
+  | 'initializing'  // Initializing
+  | 'ready'         // Ready, available for use
+  | 'error'         // Error state
+  | 'disposed';     // Disposed
+
+// =========================================
+// Capability Type Identifier
+// =========================================
+
+/**
+ * Capability Type Identifier (Generic Interface)
+ *
+ * <p>Used to identify and create capability instances, containing capability metadata.
+ * Uses phantom property `_phantom` for type inference.</p>
+ *
+ * @example
+ * ```typescript
+ * interface MyCapability {
+ *   doSomething(): void;
+ * }
+ *
+ * const MyCapabilityType = createCapabilityType<MyCapability>({
+ *   id: 'my-capability',
+ *   name: 'My Capability',
+ * });
+ * ```
+ */
+export interface CapabilityType<T = unknown> extends CapabilityMeta {
+  /**
+   * Phantom property for type inference
+   * Does not exist at runtime, only for TypeScript type system
+   */
+  readonly _phantom?: T;
+}
+
+/**
+ * Create Capability Type Identifier
+ *
+ * @param meta - Capability meta information
+ * @returns Capability type identifier object
+ */
+export function createCapabilityType<T>(
+  meta: Omit<CapabilityMeta, 'id'> & { id: string }
+): CapabilityType<T> {
+  return {
+    ...meta,
+    id: Symbol.for(meta.id),
+  } as CapabilityType<T>;
+}
+
+// =========================================
+// Capability Provider
+// =========================================
+
+/**
+ * Capability Provider Interface
+ *
+ * <p>Encapsulates the creation and disposal logic of capability instances.</p>
+ */
+export interface CapabilityProvider<T = unknown> {
+  /** Get capability instance */
+  provide(): T;
+
+  /** Dispose capability instance (optional) */
+  dispose?(): void;
+}
+
+/**
+ * Simple Capability Provider
+ *
+ * <p>Can be the capability instance itself, or a factory function that returns the capability instance.</p>
+ */
+export type SimpleCapabilityProvider<T> = T | (() => T);
+
+// =========================================
+// Capability Registration Options
+// =========================================
+
+/**
+ * Capability Registration Options
+ */
+export interface CapabilityRegisterOptions {
+  /**
+   * Whether to override existing capability
+   */
+  override?: boolean;
+
+  /**
+   * Capability priority
+   */
+  priority?: CapabilityPriority;
+
+  /**
+   * Capability scope
+   * - 'global': Global scope, shared by all modules
+   * - 'module': Module scope, only available in current module
+   * @default 'global'
+   */
+  scope?: 'global' | 'module';
+
+  /**
+   * Lazy initialization
+   * When true, capability is instantiated on first use
+   * @default false
+   */
+  lazy?: boolean;
+}
+
+// =========================================
+// Capability Runtime Information
+// =========================================
+
+/**
+ * Capability Runtime Information
+ *
+ * <p>Describes the detailed status of a capability at runtime.</p>
+ */
+export interface CapabilityRuntimeInfo {
+  /** Capability Metadata */
+  readonly meta: CapabilityMeta;
+
+  /** Current Status */
+  readonly status: CapabilityStatus;
+
+  /** Registration Timestamp */
+  readonly registeredAt: number;
+
+  /** Initialization Timestamp */
+  readonly initializedAt?: number;
+
+  /** Error Information (when status is error) */
+  readonly error?: Error;
+
+  /** Invocation Count Statistics */
+  readonly invocationCount: number;
+}
+
+// =========================================
+// Capability Registry Interface
+// =========================================
+
+/**
+ * Capability Registry Interface
+ *
+ * <p>Manages registration, retrieval, initialization, and disposal of capabilities.</p>
+ */
+export interface CapabilityRegistry {
+  /** Get capability instance */
+  get<T>(capabilityType: CapabilityType<T>): T | undefined;
+
+  /** Get required capability (throws exception if not found) */
+  getRequired<T>(capabilityType: CapabilityType<T>): T;
+
+  /** Register capability */
+  register<T>(
+    capabilityType: CapabilityType<T>,
+    provider: CapabilityProvider<T>,
+    options?: CapabilityRegisterOptions
+  ): void;
+
+  /** Unregister capability */
+  unregister<T>(capabilityType: CapabilityType<T>): boolean;
+
+  /** Check if capability is registered */
+  has<T>(capabilityType: CapabilityType<T>): boolean;
+
+  /** Check if capability is ready */
+  isReady<T>(capabilityType: CapabilityType<T>): boolean;
+
+  /** Get capability runtime information */
+  getInfo<T>(capabilityType: CapabilityType<T>): CapabilityRuntimeInfo | undefined;
+
+  /** Get all registered capability IDs */
+  getRegisteredIds(): CapabilityId[];
+
+  /** Get runtime information for all capabilities */
+  getAllInfo(): Map<CapabilityId, CapabilityRuntimeInfo>;
+
+  /** Filter capabilities by status */
+  getByStatus(status: CapabilityStatus): CapabilityId[];
+
+  /** Filter capabilities by tag */
+  getByTag(tag: string): CapabilityId[];
+
+  /** Initialize all registered capabilities */
+  initializeAll(): Promise<boolean>;
+
+  /** Dispose all capabilities */
+  disposeAll(): Promise<void>;
+
+  /** Reset registry */
+  reset(): void;
+}

package/src/types/common.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Copyright 2026 Brix Platform Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @file Common Type Definitions
+ * @description Defines utility types and API response types
+ * @module @brix/runtime-sdk-api-web/types/common
+ * @version 3.2.0
+ *
+ * [v3.2 Changes]
+ * Extracted from index.ts into a standalone type file.
+ */
+/**
+ * Optional Fields
+ *
+ * <p>Makes specified fields optional.</p>
+ */
+export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/**
+ * Required Fields
+ *
+ * <p>Makes specified fields required. Named to avoid conflict with built-in Required.</p>
+ */
+export type RequiredFields<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+/**
+ * Deep Readonly
+ *
+ * <p>Recursively makes all properties readonly.</p>
+ */
+export type DeepReadonly<T> = {
+    readonly [P in keyof T]: T[P] extends object ? DeepReadonly<T[P]> : T[P];
+};
+/**
+ * Standard API Response
+ */
+export interface ApiResponse<T = unknown> {
+    /** Whether Successful */
+    readonly success: boolean;
+    /** Response Data */
+    readonly data?: T;
+    /** Error Information */
+    readonly error?: ApiError;
+    /** Timestamp */
+    readonly timestamp: number;
+}
+/**
+ * API Error
+ */
+export interface ApiError {
+    /** Error Code */
+    readonly code: string;
+    /** Error Message */
+    readonly message: string;
+    /** Details */
+    readonly details?: Record<string, unknown>;
+}
+/**
+ * Paged Response
+ */
+export interface PagedResponse<T> {
+    /** Data List */
+    readonly items: T[];
+    /** Total Count */
+    readonly total: number;
+    /** Current Page */
+    readonly page: number;
+    /** Page Size */
+    readonly pageSize: number;
+    /** Total Pages */
+    readonly totalPages: number;
+}
+/**
+ * Paged Request
+ */
+export interface PagedRequest {
+    /** Current Page */
+    readonly page: number;
+    /** Page Size */
+    readonly pageSize: number;
+    /** Sort Field */
+    readonly sort?: string;
+    /** Sort Direction */
+    readonly order?: 'asc' | 'desc';
+}
+//# sourceMappingURL=common.d.ts.map

package/src/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["common.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAE9E;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAAG,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAE5E;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;IAC5B,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACzE,CAAC;AAMF;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO;IACtC,WAAW;IACX,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,WAAW;IACX,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,WAAW;IACX,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC;IAC1B,UAAU;IACV,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,WAAW;IACX,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,WAAW;IACX,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,WAAW;IACX,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C;AAMD;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,WAAW;IACX,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;IACpB,WAAW;IACX,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,WAAW;IACX,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,WAAW;IACX,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,UAAU;IACV,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,WAAW;IACX,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,WAAW;IACX,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,WAAW;IACX,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW;IACX,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC"}