@brix-sdk/runtime-sdk-api-web 1.0.0

package/src/context/RuntimeContext.ts

@@ -0,0 +1,75 @@
+/**
+ * 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 Runtime Context Abstract Definition
+ * @description Defines the core interface for runtime context (no React dependency)
+ * @module @brix-sdk/runtime-sdk-api-web/context/RuntimeContext
+ * @version 3.2.0
+ *
+ * [v3.2 Refactoring Notes]
+ * Extracted RuntimeContext abstraction from index.ts to keep the contract layer free of React dependencies.
+ * React-related Context and Hooks are migrated to @brix-sdk/runtime-sdk-react package.
+ *
+ * [Design Principles]
+ * - Pure abstract interface, no dependency on any UI framework
+ * - Can be used in React, Vue, native JS, and other environments
+ */
+
+// =========================================
+// Runtime Context Interface
+// =========================================
+
+/**
+ * Runtime Context Interface
+ *
+ * <p>Provides a unified entry point for plugins to access runtime capabilities.</p>
+ *
+ * <h3>Responsibilities</h3>
+ * <ul>
+ *   <li>Provides module ID identification</li>
+ *   <li>Provides tenant ID identification</li>
+ *   <li>Provides capability retrieval method</li>
+ * </ul>
+ *
+ * <h3>Usage Example</h3>
+ * ```typescript
+ * const http = context.getCapability<HttpCapability>(HttpCapabilityType);
+ * const nav = context.getCapability<NavigationCapability>(NavigationCapabilityType);
+ * ```
+ */
+export interface RuntimeContext {
+  /**
+   * Module/Plugin ID
+   *
+   * <p>Unique identifier for the current plugin.</p>
+   */
+  readonly moduleId: string;
+
+  /**
+   * Tenant ID
+   *
+   * <p>Tenant identifier for the current runtime environment.</p>
+   */
+  readonly tenantId: string;
+
+  /**
+   * Get capability instance
+   *
+   * @param capabilityType Capability type identifier (Symbol)
+   * @returns Capability instance, returns undefined if not found
+   */
+  getCapability<T>(capabilityType: symbol): T | undefined;
+}

package/src/context/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 Context Module Unified Export
+ * @description Exports runtime context related types
+ * @module @brix-sdk/runtime-sdk-api-web/context
+ * @version 3.2.0
+ */
+export * from './RuntimeContext';
+//# sourceMappingURL=index.d.ts.map

package/src/context/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,cAAc,kBAAkB,CAAC"}

package/src/context/index.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 Context Module Unified Export
+ * @description Exports runtime context related types
+ * @module @brix-sdk/runtime-sdk-api-web/context
+ * @version 3.2.0
+ */
+
+export * from './RuntimeContext';

package/src/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 @brix-sdk/runtime-sdk-api-web Unified Entry Point
+ * @description UI Capability Contract Definitions - Web Platform (Framework-agnostic)
+ * @module @brix-sdk/runtime-sdk-api-web
+ * @version 3.2.1
+ *
+ * [Module Responsibilities]
+ * Defines UI runtime capability contracts for plugins to obtain and use via RuntimeContext.
+ *
+ * [Capability Categories]
+ * - Navigation Capability: Page navigation, router management
+ * - Auth Capability: User identity, permission verification
+ * - State Capability: Plugin state management
+ * - EventBus Capability: Cross-plugin communication
+ * - Config Capability: Runtime configuration reading
+ * - Http Capability: Unified HTTP requests
+ *
+ * [Design Principles]
+ * - This module is a pure contract definition layer, containing no concrete implementations
+ * - Framework-agnostic: No dependency on React/Vue/Angular or other UI frameworks
+ * - Plugins only need to depend on this module
+ * - For React bindings, use @brix-sdk/runtime-sdk-react
+ *
+ * [v3.2.1 Refactoring Notes (v3.0.4 Architectural Constraint Fix)]
+ * - Removed all 963 lines of inline type declarations, eliminating duplicate type export issues
+ * - All type definitions are now exported uniformly from types/ directory
+ * - Context definitions are exported from context/ directory
+ * - Removed React dependency, achieving true framework independence
+ *
+ * [v3.2 Refactoring Notes]
+ * - Split into modular type files (types/)
+ * - Removed React dependency, React Hooks migrated to @brix-sdk/runtime-sdk-react
+ * - RouteContribution.component type changed to framework-agnostic ComponentType
+ */
+export * from './types';
+export * from './context';
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAKH,cAAc,SAAS,CAAC;AAKxB,cAAc,WAAW,CAAC"}

package/src/index.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 @brix-sdk/runtime-sdk-api-web Unified Entry Point
+ * @description UI Capability Contract Definitions - Web Platform (Framework-agnostic)
+ * @module @brix-sdk/runtime-sdk-api-web
+ * @version 3.2.1
+ *
+ * [Module Responsibilities]
+ * Defines UI runtime capability contracts for plugins to obtain and use via RuntimeContext.
+ *
+ * [Capability Categories]
+ * - Navigation Capability: Page navigation, router management
+ * - Auth Capability: User identity, permission verification
+ * - State Capability: Plugin state management
+ * - EventBus Capability: Cross-plugin communication
+ * - Config Capability: Runtime configuration reading
+ * - Http Capability: Unified HTTP requests
+ *
+ * [Design Principles]
+ * - This module is a pure contract definition layer, containing no concrete implementations
+ * - Framework-agnostic: No dependency on React/Vue/Angular or other UI frameworks
+ * - Plugins only need to depend on this module
+ * - For React bindings, use @brix-sdk/runtime-sdk-react
+ *
+ * [v3.2.1 Refactoring Notes (v3.0.4 Architectural Constraint Fix)]
+ * - Removed all 963 lines of inline type declarations, eliminating duplicate type export issues
+ * - All type definitions are now exported uniformly from types/ directory
+ * - Context definitions are exported from context/ directory
+ * - Removed React dependency, achieving true framework independence
+ *
+ * [v3.2 Refactoring Notes]
+ * - Split into modular type files (types/)
+ * - Removed React dependency, React Hooks migrated to @brix-sdk/runtime-sdk-react
+ * - RouteContribution.component type changed to framework-agnostic ComponentType
+ */
+
+// =========================================
+// Re-export all type definitions from types/ directory
+// =========================================
+export * from './types';
+
+// =========================================
+// Re-export runtime context from context/ directory
+// =========================================
+export * from './context';

package/src/types/auth.d.ts

@@ -0,0 +1,146 @@
+/**
+ * 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 Authentication Capability Type Definitions
+ * @description Defines core types for the authentication system, including user info, auth info, permission verification, etc.
+ * @module @brix-sdk/runtime-sdk-api-web/types/auth
+ * @version 3.2.0
+ *
+ * [v3.2 Changes]
+ * Extracted from index.ts into a standalone type file.
+ */
+/**
+ * Authentication Capability Type Identifier
+ */
+export declare const AuthCapabilityType: unique symbol;
+/**
+ * Basic User Information
+ */
+export interface BaseUser {
+    /** User ID */
+    readonly id: string;
+    /** Username */
+    readonly username: string;
+    /** Email */
+    readonly email?: string;
+    /** Display Name */
+    readonly displayName?: string;
+    /** Avatar URL */
+    readonly avatar?: string;
+    /** Created At */
+    readonly createdAt: string;
+    /** Updated At */
+    readonly updatedAt?: string;
+}
+/**
+ * Authenticated User Information
+ *
+ * <p>User object containing roles and permissions.</p>
+ */
+export interface AuthUser {
+    /** User ID */
+    id: string;
+    /** Username */
+    username: string;
+    /** Email */
+    email?: string;
+    /** Display Name */
+    displayName?: string;
+    /** Role List */
+    roles: string[];
+    /** Permission List */
+    permissions: string[];
+}
+/**
+ * Authentication Information
+ *
+ * <p>Contains access token and refresh token.</p>
+ */
+export interface AuthInfo {
+    /** Access Token */
+    readonly accessToken: string;
+    /** Refresh Token */
+    readonly refreshToken?: string;
+    /** Token Expiration Time (seconds) */
+    readonly expiresIn: number;
+    /** Token Type */
+    readonly tokenType: string;
+}
+/**
+ * Authentication Capability Contract
+ *
+ * <p>Provides user identity verification and permission checking capabilities for plugins.</p>
+ *
+ * <h3>Usage Example</h3>
+ * ```typescript
+ * const auth = context.getCapability<AuthCapability>(AuthCapabilityType);
+ *
+ * if (auth.isAuthenticated()) {
+ *   const user = auth.getCurrentUser();
+ *   if (auth.hasPermission('booking:create')) {
+ *     // Create booking
+ *   }
+ * }
+ * ```
+ */
+export interface AuthCapability {
+    /**
+     * Get current logged-in user
+     *
+     * @returns Current user, returns null if not logged in (supports sync/async)
+     */
+    getCurrentUser(): AuthUser | null | Promise<AuthUser | null>;
+    /**
+     * Check if authenticated
+     *
+     * @returns Whether logged in
+     */
+    isAuthenticated(): boolean;
+    /**
+     * User login
+     *
+     * @param credentials Login credentials (optional, depends on auth method)
+     * @returns Promise, resolved when login succeeds
+     */
+    login(credentials?: unknown): Promise<void>;
+    /**
+     * User logout
+     *
+     * @returns Promise, resolved when logout succeeds
+     */
+    logout(): Promise<void>;
+    /**
+     * Check if has specified permission
+     *
+     * @param permission Permission identifier
+     * @returns Whether has permission
+     */
+    hasPermission(permission: string): boolean;
+    /**
+     * Check if has specified role
+     *
+     * @param role Role identifier
+     * @returns Whether has role
+     */
+    hasRole(role: string): boolean;
+    /**
+     * Get current access token
+     *
+     * @returns Access token, returns null if not logged in
+     */
+    getToken(): string | null;
+}
+//# sourceMappingURL=auth.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["auth.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH;;GAEG;AACH,eAAO,MAAM,kBAAkB,eAA+B,CAAC;AAM/D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,YAAY;IACZ,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,UAAU;IACV,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,SAAS;IACT,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW;IACX,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,aAAa;IACb,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW;IACX,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,WAAW;IACX,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,YAAY;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,UAAU;IACV,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW;IACX,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW;IACX,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAMD;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,WAAW;IACX,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,WAAW;IACX,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,eAAe;IACf,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,WAAW;IACX,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAMD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,cAAc,IAAI,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAE7D;;;;OAIG;IACH,eAAe,IAAI,OAAO,CAAC;IAE3B;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAExB;;;;;OAKG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAE3C;;;;;OAKG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,IAAI,MAAM,GAAG,IAAI,CAAC;CAC3B"}