hubg-app-shell 0.1.0 → 0.1.2

package/dist/platform/createPlatformAPI.d.ts

@@ -0,0 +1,21 @@
+import type { ModuleContext } from "../types/context.js";
+import type { PlatformAPI } from "../types/platform.js";
+import type { EventBus } from "../events/EventBus.js";
+export interface PlatformAPIOptions {
+    moduleId: string;
+    getContext: () => ModuleContext;
+    navigate: (path: string) => void;
+    eventBus: EventBus;
+    /**
+     * Optional fetch override (e.g. an axios-backed shim). Defaults to the
+     * global `fetch` with credentials included.
+     */
+    fetchFn?: (url: string, init: RequestInit) => Promise<Response>;
+}
+/**
+ * Creates a scoped PlatformAPI instance for a single module.
+ * The module receives this object at mount time and uses it as its sole
+ * integration surface with the shell.
+ */
+export declare function createPlatformAPI(options: PlatformAPIOptions): PlatformAPI;
+//# sourceMappingURL=createPlatformAPI.d.ts.map

package/dist/platform/createPlatformAPI.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPlatformAPI.d.ts","sourceRoot":"","sources":["../../src/platform/createPlatformAPI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EAA4B,WAAW,EAAiB,MAAM,sBAAsB,CAAC;AACjG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,aAAa,CAAC;IAChC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,QAAQ,EAAE,QAAQ,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CACjE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,kBAAkB,GAAG,WAAW,CAuC1E"}

package/dist/registry/ModuleRegistry.d.ts

@@ -0,0 +1,20 @@
+import type { ApplicationModule, ModuleLoader } from "../types/module.js";
+export interface ModuleDefinition {
+    id: string;
+    load: ModuleLoader;
+}
+/**
+ * Central registry that maps a module ID to its loader function.
+ * The registry is framework-agnostic — it does not know whether the module
+ * is implemented in React, Vue, Angular, or as a Web Component.
+ */
+export declare class ModuleRegistry {
+    private readonly registry;
+    register(definition: ModuleDefinition): this;
+    registerMany(definitions: ModuleDefinition[]): this;
+    resolve(moduleId: string): ModuleDefinition | undefined;
+    load(moduleId: string): Promise<ApplicationModule>;
+    isRegistered(moduleId: string): boolean;
+    get registeredIds(): string[];
+}
+//# sourceMappingURL=ModuleRegistry.d.ts.map

package/dist/registry/ModuleRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleRegistry.d.ts","sourceRoot":"","sources":["../../src/registry/ModuleRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE1E,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,YAAY,CAAC;CACpB;AAED;;;;GAIG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuC;IAEhE,QAAQ,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI;IAQ5C,YAAY,CAAC,WAAW,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAKnD,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAIjD,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQxD,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAIvC,IAAI,aAAa,IAAI,MAAM,EAAE,CAE5B;CACF"}

package/dist/types/context.d.ts

@@ -0,0 +1,26 @@
+export interface UserContext {
+    id: number | null;
+    name: string;
+    email: string;
+    role: string;
+    avatar: string;
+}
+export interface TenantContext {
+    id: string;
+    name: string;
+    communityUrl: string;
+    controlUrl: string;
+}
+export interface ThemeContext {
+    mode: "light" | "dark" | "legacy";
+    /** CSS custom property overrides applied at the shell root */
+    overrides?: Record<string, string>;
+}
+export interface ModuleContext {
+    user: UserContext;
+    tenant: TenantContext;
+    permissions: string[];
+    locale: string;
+    theme: ThemeContext;
+}
+//# sourceMappingURL=context.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/types/context.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;IAClC,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,YAAY,CAAC;CACrB"}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export type { UserContext, TenantContext, ThemeContext, ModuleContext } from "./context.js";
+export type { ModuleLifecycleState, ModuleInstance, ApplicationModule, ModuleLoader, } from "./module.js";
+export type { PlatformEvent, EventHandler, APIRequest, PlatformAPI, } from "./platform.js";
+export type { NavItem, NavigationGroup, NavigationConfig } from "./navigation.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC5F,YAAY,EACV,oBAAoB,EACpB,cAAc,EACd,iBAAiB,EACjB,YAAY,GACb,MAAM,aAAa,CAAC;AACrB,YAAY,EACV,aAAa,EACb,YAAY,EACZ,UAAU,EACV,WAAW,GACZ,MAAM,eAAe,CAAC;AACvB,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/types/module.d.ts

@@ -0,0 +1,22 @@
+import type { ModuleContext } from "./context.js";
+import type { PlatformAPI } from "./platform.js";
+export type ModuleLifecycleState = "loading" | "loaded" | "mounted" | "active" | "unmounted" | "failed";
+export interface ModuleInstance {
+    /** Called by the shell when navigating away from this module. */
+    unmount(): void;
+}
+/**
+ * The contract every module must implement, regardless of its internal
+ * framework (React, Vue, Angular, Web Component, etc.).
+ */
+export interface ApplicationModule {
+    readonly id: string;
+    /**
+     * Mount the module into `container`. The module owns everything inside
+     * that element for as long as it is active.
+     */
+    mount(container: HTMLElement, context: ModuleContext, platform: PlatformAPI): ModuleInstance;
+}
+/** Factory shape expected in the module registry. */
+export type ModuleLoader = () => Promise<ApplicationModule>;
+//# sourceMappingURL=module.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/types/module.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GACT,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,WAAW,GACX,QAAQ,CAAC;AAEb,MAAM,WAAW,cAAc;IAC7B,iEAAiE;IACjE,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,KAAK,CACH,SAAS,EAAE,WAAW,EACtB,OAAO,EAAE,aAAa,EACtB,QAAQ,EAAE,WAAW,GACpB,cAAc,CAAC;CACnB;AAED,qDAAqD;AACrD,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,iBAAiB,CAAC,CAAC"}

package/dist/types/navigation.d.ts

@@ -0,0 +1,53 @@
+import type * as React from "react";
+/** One entry in the "Create" collapsible inside the sidebar. */
+export interface CreateOption {
+    label: string;
+    /** Lucide-compatible icon component. */
+    icon?: React.ComponentType<{
+        className?: string;
+    }>;
+    route: string;
+}
+/**
+ * A named group of children rendered inside an expandable nav item.
+ * Used when children need section labels (e.g. "MODERATION", "CONTENT TYPES").
+ */
+export interface NavChildGroup {
+    id: string;
+    /** Uppercase section label shown above the group's items. */
+    label: string;
+    items: NavItem[];
+}
+export interface NavItem {
+    /** Unique identifier, also used to look up the module in the registry. */
+    id: string;
+    label: string;
+    /** Top-level route owned by this nav item (e.g. "/customers"). */
+    route: string;
+    /** Module ID resolved via the ModuleRegistry. */
+    moduleId: string;
+    /** Lucide-compatible icon component — receives a `className` prop. */
+    icon?: React.ComponentType<{
+        className?: string;
+    }>;
+    /** Hides the item from the nav without unregistering the module. */
+    enabled: boolean;
+    /**
+     * All listed permissions must be present in the module context for this
+     * item to be visible. Frontend-only gate — backend APIs are authoritative.
+     */
+    permissions?: string[];
+    /** Flat second-level items (no group labels). */
+    children?: NavItem[];
+    /** Grouped second-level items with section labels (takes precedence over children). */
+    childGroups?: NavChildGroup[];
+}
+export interface NavigationGroup {
+    id: string;
+    label?: string;
+    items: NavItem[];
+}
+export interface NavigationConfig {
+    groups: NavigationGroup[];
+}
+//# sourceMappingURL=navigation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.d.ts","sourceRoot":"","sources":["../../src/types/navigation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,KAAK,MAAM,OAAO,CAAC;AAEpC,gEAAgE;AAChE,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,0EAA0E;IAC1E,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,KAAK,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,uFAAuF;IACvF,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,eAAe,EAAE,CAAC;CAC3B"}

package/dist/types/platform.d.ts

@@ -0,0 +1,39 @@
+import type { ModuleContext, ThemeContext } from "./context.js";
+export interface PlatformEvent {
+    type: string;
+    payload?: unknown;
+}
+export type EventHandler = (event: PlatformEvent) => void;
+export interface APIRequest {
+    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    url: string;
+    data?: unknown;
+    headers?: Record<string, string>;
+}
+/**
+ * The primary integration surface between the shell and a module.
+ * Modules interact with shell capabilities exclusively through this API —
+ * they must not access shell internals, React Context, or routing directly.
+ */
+export interface PlatformAPI {
+    /** Returns a snapshot of the current module context. */
+    getContext(): ModuleContext;
+    /** Returns the active theme. */
+    getTheme(): ThemeContext;
+    /**
+     * Request application-level navigation. The shell resolves the route and
+     * loads the appropriate module; the calling module need not know what
+     * handles the route.
+     */
+    navigate(path: string): void;
+    /** Publish a typed event to the shell event bus. */
+    publish(event: PlatformEvent): void;
+    /**
+     * Subscribe to events from the shell or other modules.
+     * Returns an unsubscribe function.
+     */
+    subscribe(eventType: string, handler: EventHandler): () => void;
+    /** Proxy an API call through the shell (auth headers are injected by the shell). */
+    apiRequest(request: APIRequest): Promise<Response>;
+}
+//# sourceMappingURL=platform.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"platform.d.ts","sourceRoot":"","sources":["../../src/types/platform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEhE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;AAE1D,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,wDAAwD;IACxD,UAAU,IAAI,aAAa,CAAC;IAE5B,gCAAgC;IAChC,QAAQ,IAAI,YAAY,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,oDAAoD;IACpD,OAAO,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,MAAM,IAAI,CAAC;IAEhE,oFAAoF;IACpF,UAAU,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACpD"}

package/dist/utils/cn.d.ts

@@ -0,0 +1,7 @@
+import { type ClassValue } from "clsx";
+/**
+ * Merges Tailwind classes safely — later classes override earlier ones,
+ * and conflicting utilities (e.g. p-2 + p-4) are correctly resolved.
+ */
+export declare function cn(...inputs: ClassValue[]): string;
+//# sourceMappingURL=cn.d.ts.map

package/dist/utils/cn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cn.d.ts","sourceRoot":"","sources":["../../src/utils/cn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAQ,MAAM,MAAM,CAAC;AAG7C;;;GAGG;AACH,wBAAgB,EAAE,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAElD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubg-app-shell",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Application Shell — layout, module registry, platform API, and framework-agnostic module contract for the Gainsight Community Hub.",
   "type": "module",
   "sideEffects": ["dist/styles.css"],
@@ -50,6 +50,7 @@
     "vitest": "^4.1.0"
   },
   "files": ["dist"],
+  "types": "./dist/index.d.ts",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"