brix-runtime-sdk-api-web 1.0.0

package/dist/index.js

@@ -0,0 +1,190 @@
+// src/types/capability.ts
+var CapabilityPriority = /* @__PURE__ */ ((CapabilityPriority2) => {
+  CapabilityPriority2[CapabilityPriority2["LOW"] = 0] = "LOW";
+  CapabilityPriority2[CapabilityPriority2["NORMAL"] = 50] = "NORMAL";
+  CapabilityPriority2[CapabilityPriority2["HIGH"] = 100] = "HIGH";
+  return CapabilityPriority2;
+})(CapabilityPriority || {});
+function createCapabilityType(meta) {
+  return {
+    ...meta,
+    id: Symbol.for(meta.id)
+  };
+}
+
+// src/types/plugin.ts
+var PluginLoadError = class extends Error {
+  constructor(message, pluginId, phase, cause) {
+    super(message);
+    this.pluginId = pluginId;
+    this.phase = phase;
+    this.cause = cause;
+    this.name = "PluginLoadError";
+  }
+};
+
+// src/types/navigation.ts
+var NavigationCapabilityType = /* @__PURE__ */ Symbol.for("NavigationCapability");
+var RouterCapabilityType = NavigationCapabilityType;
+
+// src/types/state.ts
+var PluginStateCapabilityType = /* @__PURE__ */ Symbol.for("PluginStateCapability");
+var StateStoreCapabilityType = PluginStateCapabilityType;
+
+// src/types/event.ts
+var EventBusCapabilityType = /* @__PURE__ */ Symbol.for("EventBusCapability");
+var GovernedEventBusCapabilityType = /* @__PURE__ */ Symbol.for("GovernedEventBusCapability");
+var BackpressureError = class extends Error {
+  eventType;
+  queueDepth;
+  maxQueueDepth;
+  constructor(eventType, queueDepth, maxQueueDepth) {
+    super(
+      `Backpressure limit reached for event type '${eventType}': queue depth ${queueDepth} >= max ${maxQueueDepth}`
+    );
+    this.name = "BackpressureError";
+    this.eventType = eventType;
+    this.queueDepth = queueDepth;
+    this.maxQueueDepth = maxQueueDepth;
+  }
+};
+
+// src/types/module.ts
+var ModuleState = /* @__PURE__ */ ((ModuleState2) => {
+  ModuleState2["UNLOADED"] = "UNLOADED";
+  ModuleState2["LOADING"] = "LOADING";
+  ModuleState2["LOADED"] = "LOADED";
+  ModuleState2["ACTIVE"] = "ACTIVE";
+  ModuleState2["ERROR"] = "ERROR";
+  return ModuleState2;
+})(ModuleState || {});
+var ModuleLifecycleEvent = /* @__PURE__ */ ((ModuleLifecycleEvent2) => {
+  ModuleLifecycleEvent2["BEFORE_LOAD"] = "BEFORE_LOAD";
+  ModuleLifecycleEvent2["AFTER_LOAD"] = "AFTER_LOAD";
+  ModuleLifecycleEvent2["BEFORE_ACTIVATE"] = "BEFORE_ACTIVATE";
+  ModuleLifecycleEvent2["AFTER_ACTIVATE"] = "AFTER_ACTIVATE";
+  ModuleLifecycleEvent2["BEFORE_DEACTIVATE"] = "BEFORE_DEACTIVATE";
+  ModuleLifecycleEvent2["AFTER_DEACTIVATE"] = "AFTER_DEACTIVATE";
+  ModuleLifecycleEvent2["ERROR"] = "ERROR";
+  return ModuleLifecycleEvent2;
+})(ModuleLifecycleEvent || {});
+
+// src/types/http.ts
+var HttpCapabilityType = /* @__PURE__ */ Symbol.for("HttpCapability");
+
+// src/types/auth.ts
+var AuthCapabilityType = /* @__PURE__ */ Symbol.for("AuthCapability");
+
+// src/types/config.ts
+var ConfigCapabilityType = /* @__PURE__ */ Symbol.for("ConfigCapability");
+var ConfigStoreCapabilityType = /* @__PURE__ */ Symbol.for("ConfigStoreCapability");
+
+// src/types/i18n.ts
+var I18nCapabilityType = /* @__PURE__ */ Symbol.for("I18nCapability");
+
+// src/types/theme.ts
+var ThemeCapabilityType = /* @__PURE__ */ Symbol.for("ThemeCapability");
+
+// src/types/layout.ts
+var LayoutCapabilityType = /* @__PURE__ */ Symbol.for("LayoutCapability");
+
+// src/types/ui/theme-tokens.ts
+var MUI_THEME_TOKENS = {
+  // Brand Colors
+  primary: "#1976d2",
+  primaryLight: "#42a5f5",
+  primaryDark: "#1565c0",
+  primaryContrastText: "#ffffff",
+  secondary: "#9c27b0",
+  secondaryLight: "#ba68c8",
+  secondaryDark: "#7b1fa2",
+  secondaryContrastText: "#ffffff",
+  // Semantic Colors
+  error: "#d32f2f",
+  warning: "#ed6c02",
+  info: "#0288d1",
+  success: "#2e7d32",
+  // Neutral Colors
+  background: "#f5f5f5",
+  paper: "#ffffff",
+  textPrimary: "rgba(0, 0, 0, 0.87)",
+  textSecondary: "rgba(0, 0, 0, 0.6)",
+  textDisabled: "rgba(0, 0, 0, 0.38)",
+  divider: "rgba(0, 0, 0, 0.12)",
+  // Layout Colors
+  sidebarBackground: "#1e293b",
+  sidebarText: "rgba(255, 255, 255, 0.87)",
+  sidebarActiveBackground: "#3b82f6",
+  sidebarHoverBackground: "rgba(255, 255, 255, 0.08)",
+  headerBackground: "#ffffff",
+  headerText: "rgba(0, 0, 0, 0.87)",
+  // Shape Tokens
+  borderRadiusSmall: 4,
+  borderRadiusMedium: 8,
+  borderRadiusLarge: 12
+};
+var MUI_DARK_THEME_TOKENS = {
+  // Brand Colors (same as light)
+  primary: "#90caf9",
+  primaryLight: "#e3f2fd",
+  primaryDark: "#42a5f5",
+  primaryContrastText: "rgba(0, 0, 0, 0.87)",
+  secondary: "#ce93d8",
+  secondaryLight: "#f3e5f5",
+  secondaryDark: "#ab47bc",
+  secondaryContrastText: "rgba(0, 0, 0, 0.87)",
+  // Semantic Colors (adjusted for dark mode)
+  error: "#f44336",
+  warning: "#ffa726",
+  info: "#29b6f6",
+  success: "#66bb6a",
+  // Neutral Colors (inverted)
+  background: "#121212",
+  paper: "#1e1e1e",
+  textPrimary: "rgba(255, 255, 255, 0.87)",
+  textSecondary: "rgba(255, 255, 255, 0.6)",
+  textDisabled: "rgba(255, 255, 255, 0.38)",
+  divider: "rgba(255, 255, 255, 0.12)",
+  // Layout Colors (adjusted for dark mode)
+  sidebarBackground: "#0f172a",
+  sidebarText: "rgba(255, 255, 255, 0.87)",
+  sidebarActiveBackground: "#1e40af",
+  sidebarHoverBackground: "rgba(255, 255, 255, 0.08)",
+  headerBackground: "#1e1e1e",
+  headerText: "rgba(255, 255, 255, 0.87)",
+  // Shape Tokens (same as light)
+  borderRadiusSmall: 4,
+  borderRadiusMedium: 8,
+  borderRadiusLarge: 12
+};
+
+// src/types/ui/adapter.ts
+var UICapabilityType = /* @__PURE__ */ Symbol.for("UICapability");
+
+// src/types/plugin-loader-capability.ts
+var PluginLoaderCapabilityType = /* @__PURE__ */ Symbol.for("PluginLoaderCapability");
+export {
+  AuthCapabilityType,
+  BackpressureError,
+  CapabilityPriority,
+  ConfigCapabilityType,
+  ConfigStoreCapabilityType,
+  EventBusCapabilityType,
+  GovernedEventBusCapabilityType,
+  HttpCapabilityType,
+  I18nCapabilityType,
+  LayoutCapabilityType,
+  MUI_DARK_THEME_TOKENS,
+  MUI_THEME_TOKENS,
+  ModuleLifecycleEvent,
+  ModuleState,
+  NavigationCapabilityType,
+  PluginLoadError,
+  PluginLoaderCapabilityType,
+  PluginStateCapabilityType,
+  RouterCapabilityType,
+  StateStoreCapabilityType,
+  ThemeCapabilityType,
+  UICapabilityType,
+  createCapabilityType
+};

package/dist/types/api-exports.test.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 Public API Snapshot Test (Golden File)
+ * @description Validates stability of public API exports to prevent accidental breaking changes
+ * @module @brix/runtime-sdk-api-web/test
+ * @version 3.2.0
+ *
+ * [Test Description]
+ * Golden File tests ensure the following by creating API export snapshots:
+ * 1. Public APIs are not accidentally modified
+ * 2. Type exports remain stable
+ * 3. Any API changes require explicit confirmation
+ *
+ * [Update Snapshot]
+ * When intentionally modifying the API, run:
+ * pnpm test -- -u
+ */
+export {};
+//# sourceMappingURL=api-exports.test.d.ts.map

package/dist/types/api-exports.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-exports.test.d.ts","sourceRoot":"","sources":["../../src/api-exports.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH;;;;;;;;;;;;;;;GAeG"}

package/dist/types/context/RuntimeContext.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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/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/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
+ *
+ * <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;
+}
+//# sourceMappingURL=RuntimeContext.d.ts.map

package/dist/types/context/RuntimeContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RuntimeContext.d.ts","sourceRoot":"","sources":["../../../src/context/RuntimeContext.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH;;;;;;;;;;;;;GAaG;AAMH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IACH,aAAa,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;CACzD"}

package/dist/types/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/runtime-sdk-api-web/context
+ * @version 3.2.0
+ */
+export * from './RuntimeContext';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/context/index.d.ts.map

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

package/dist/types/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/runtime-sdk-api-web Unified Entry Point
+ * @description UI Capability Contract Definitions - Web Platform (Framework-agnostic)
+ * @module @brix/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/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/runtime-sdk-react
+ * - RouteContribution.component type changed to framework-agnostic ComponentType
+ */
+export * from './types';
+export * from './context';
+//# sourceMappingURL=index.d.ts.map

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

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