brix-runtime-sdk-api-web 1.0.0

package/dist/types/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/dist/types/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/types/common.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH;;;;;;;;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,yBAAyB;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,oBAAoB;IACpB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClB,wBAAwB;IACxB,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,iBAAiB;IACjB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oBAAoB;IACpB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,cAAc;IACd,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C;AAMD;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,gBAAgB;IAChB,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC;IACpB,kBAAkB;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gBAAgB;IAChB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,kBAAkB;IAClB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gBAAgB;IAChB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,iBAAiB;IACjB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB;IACrB,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACjC"}

package/dist/types/types/config.d.ts

@@ -0,0 +1,85 @@
+/**
+ * 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 Configuration Capability Type Definitions
+ * @description Defines core types for the configuration management system
+ * @module @brix/runtime-sdk-api-web/types/config
+ * @version 3.2.0
+ *
+ * [v3.2 Changes]
+ * Extracted from index.ts into a standalone type file.
+ *
+ * [v3.1 Changes]
+ * Added ConfigStoreCapability alias for Java/TS naming alignment.
+ * ConfigCapability is now deprecated, use ConfigStoreCapability instead.
+ */
+/**
+ * Configuration Capability Type Identifier
+ */
+export declare const ConfigCapabilityType: unique symbol;
+/**
+ * Configuration Store Capability Type Identifier (Aligned with Java naming)
+ * @since 3.1.0
+ */
+export declare const ConfigStoreCapabilityType: unique symbol;
+/**
+ * Configuration Store Capability Contract
+ *
+ * <p>Provides runtime configuration reading capability for plugins.</p>
+ *
+ * <p>This is the canonical name aligned with Java SDK (ConfigStoreCapability).</p>
+ *
+ * <h3>Usage Example</h3>
+ * ```typescript
+ * const config = context.getCapability<ConfigStoreCapability>(ConfigStoreCapabilityType);
+ * const apiBase = config.get<string>('api.baseUrl', '/api/v1');
+ * const timeout = config.get<number>('http.timeout', 30000);
+ * ```
+ *
+ * <h3>Configuration Sources</h3>
+ * <ul>
+ *   <li>Environment Variables</li>
+ *   <li>Configuration Center</li>
+ *   <li>Manifest Files</li>
+ * </ul>
+ *
+ * @since 3.1.0
+ */
+export interface ConfigStoreCapability {
+    /**
+     * Get configuration item
+     *
+     * @param key Configuration key
+     * @param defaultValue Default value
+     * @returns Configuration value
+     */
+    get<T>(key: string, defaultValue?: T): T;
+    /**
+     * Get all configurations
+     *
+     * @returns Configuration object (supports sync/async)
+     */
+    getAll<T = Record<string, unknown>>(): T | Promise<T>;
+}
+/**
+ * Configuration Capability Contract
+ *
+ * @deprecated Use ConfigStoreCapability instead for Java/TS naming alignment.
+ * Will be removed in v4.0.0.
+ */
+export interface ConfigCapability extends ConfigStoreCapability {
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/types/types/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/types/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH;;;;;;;;;;;;GAYG;AAMH;;GAEG;AACH,eAAO,MAAM,oBAAoB,eAAiC,CAAC;AAEnE;;;GAGG;AACH,eAAO,MAAM,yBAAyB,eAAsC,CAAC;AAM7E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAEzC;;;;OAIG;IACH,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAiB,SAAQ,qBAAqB;CAAG"}