@notur/sdk 1.4.5 → 1.4.7

package/dist/hooks/useUserContext.d.ts

@@ -1,12 +1,20 @@
-interface UserContext {
+/**
+ * Current Pterodactyl user metadata returned by `useUserContext()`.
+ */
+export interface UserContext {
+    /** User UUID. */
     uuid: string;
+    /** Username shown in the panel. */
     username: string;
+    /** User email address. */
     email: string;
+    /** True when the user is a root/admin user. */
     isAdmin: boolean;
 }
 /**
  * Hook to access the current user context from the Pterodactyl panel.
+ *
+ * Returns `null` while loading or when the user cannot be resolved.
  */
 export declare function useUserContext(): UserContext | null;
-export {};
 //# sourceMappingURL=useUserContext.d.ts.map

package/dist/hooks/useUserContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useUserContext.d.ts","sourceRoot":"","sources":["../../src/hooks/useUserContext.ts"],"names":[],"mappings":"AAEA,UAAU,WAAW;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,WAAW,GAAG,IAAI,CAiDnD"}
+{"version":3,"file":"useUserContext.d.ts","sourceRoot":"","sources":["../../src/hooks/useUserContext.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,WAAW,GAAG,IAAI,CAiDnD"}

package/dist/hooks/useUserContext.js

@@ -1,6 +1,8 @@
 import { useState, useEffect } from 'react';
 /**
  * Hook to access the current user context from the Pterodactyl panel.
+ *
+ * Returns `null` while loading or when the user cannot be resolved.
  */
 export function useUserContext() {
     const [user, setUser] = useState(null);

package/dist/hooks/useUserContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"useUserContext.js","sourceRoot":"","sources":["../../src/hooks/useUserContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAS5C;;GAEG;AACH,MAAM,UAAU,cAAc;IAC1B,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAqB,IAAI,CAAC,CAAC;IAE3D,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,8CAA8C;QAC9C,MAAM,UAAU,GAAI,MAAc,CAAC,eAAe,CAAC;QACnD,IAAI,UAAU,EAAE,CAAC;YACb,OAAO,CAAC,UAAU,CAAC,CAAC;YACpB,OAAO;QACX,CAAC;QAED,2BAA2B;QAC3B,KAAK,CAAC,qBAAqB,EAAE;YACzB,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;YACvC,WAAW,EAAE,aAAa;SAC7B,CAAC;aACG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACnB,IAAI,CAAC,IAAI,CAAC,EAAE;YACT,IAAI,SAAS;gBAAE,OAAO;YACtB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,OAAO,CAAC;oBACJ,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;oBAC1B,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ;oBAClC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;oBAC5B,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,KAAK;iBAC1C,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;;YACX,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAC;YAC1D,MAAM,KAAK,GAAI,MAAc,CAAC,SAAS,CAAC;YACxC,IAAI,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,0CAAE,MAAM,EAAE,CAAC;gBAC7B,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;oBAC1B,WAAW,EAAE,cAAc;oBAC3B,OAAO,EAAE,gCAAgC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,KAAI,MAAM,CAAC,GAAG,CAAC,EAAE;oBACtE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;iBACjC,CAAC,CAAC;gBACH,IAAI,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBACxC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC;gBAC9E,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;QAEP,OAAO,GAAG,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,IAAI,CAAC;AAChB,CAAC"}
+{"version":3,"file":"useUserContext.js","sourceRoot":"","sources":["../../src/hooks/useUserContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAgB5C;;;;GAIG;AACH,MAAM,UAAU,cAAc;IAC1B,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAqB,IAAI,CAAC,CAAC;IAE3D,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,8CAA8C;QAC9C,MAAM,UAAU,GAAI,MAAc,CAAC,eAAe,CAAC;QACnD,IAAI,UAAU,EAAE,CAAC;YACb,OAAO,CAAC,UAAU,CAAC,CAAC;YACpB,OAAO;QACX,CAAC;QAED,2BAA2B;QAC3B,KAAK,CAAC,qBAAqB,EAAE;YACzB,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;YACvC,WAAW,EAAE,aAAa;SAC7B,CAAC;aACG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACnB,IAAI,CAAC,IAAI,CAAC,EAAE;YACT,IAAI,SAAS;gBAAE,OAAO;YACtB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBAClB,OAAO,CAAC;oBACJ,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;oBAC1B,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ;oBAClC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK;oBAC5B,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,KAAK;iBAC1C,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;;YACX,OAAO,CAAC,IAAI,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAC;YAC1D,MAAM,KAAK,GAAI,MAAc,CAAC,SAAS,CAAC;YACxC,IAAI,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,0CAAE,MAAM,EAAE,CAAC;gBAC7B,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;oBAC1B,WAAW,EAAE,cAAc;oBAC3B,OAAO,EAAE,gCAAgC,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO,KAAI,MAAM,CAAC,GAAG,CAAC,EAAE;oBACtE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;iBACjC,CAAC,CAAC;gBACH,IAAI,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBACxC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC;gBAC9E,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;QAEP,OAAO,GAAG,EAAE,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/index.d.ts

@@ -1,11 +1,16 @@
 export { createExtension } from './createExtension';
 export { getNoturApi } from './types';
-export type { ExtensionConfig, SlotConfig, RouteConfig, ExtensionDefinition, SimpleExtensionDefinition, NoturApi, SlotComponentProps, } from './types';
+export type { ExtensionConfig, CssIsolationConfig, SlotId, RouteArea, SlotRenderContext, SlotRenderWhen, SlotRenderCondition, SlotConfig, RouteConfig, ExtensionDefinition, SimpleExtensionDefinition, SlotRegistration, RouteRegistration, NoturApi, SlotComponentProps, } from './types';
 export { useServerContext } from './hooks/useServerContext';
+export type { ServerContext } from './hooks/useServerContext';
 export { useUserContext } from './hooks/useUserContext';
+export type { UserContext } from './hooks/useUserContext';
 export { usePermission } from './hooks/usePermission';
 export { useExtensionConfig } from './hooks/useExtensionConfig';
+export type { UseExtensionConfigOptions, ExtensionConfigState } from './hooks/useExtensionConfig';
 export { useNoturEvent, useEmitEvent } from './hooks/useNoturEvent';
 export { useNavigate } from './hooks/useNavigate';
+export type { UseNavigateOptions, NavigateOptions, NavigateFunction } from './hooks/useNavigate';
 export { createScopedEventChannel } from './events';
+export type { ScopedEventChannel } from './events';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EACR,eAAe,EACf,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,yBAAyB,EACzB,QAAQ,EACR,kBAAkB,GACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,YAAY,EACR,eAAe,EACf,kBAAkB,EAClB,MAAM,EACN,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,mBAAmB,EACnB,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,iBAAiB,EACjB,QAAQ,EACR,kBAAkB,GACrB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,YAAY,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,YAAY,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClG,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,YAAY,EAAE,kBAAkB,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACjG,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AACpD,YAAY,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAUtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAkBtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAE5D,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC"}

package/dist/types.d.ts

@@ -1,127 +1,272 @@
+/**
+ * Known frontend slot IDs provided by the Notur bridge.
+ *
+ * Slot IDs are stable mount points patched into the Pterodactyl UI. Use these
+ * strings in `SlotConfig.slot` to render React components in a specific panel
+ * location.
+ *
+ * @example
+ * ```ts
+ * createExtension({
+ *   id: 'acme/red-button',
+ *   slots: [{ slot: 'server.header', component: RedButton }],
+ * });
+ * ```
+ */
+export type SlotId = 'navbar' | 'navbar.left' | 'navbar.before' | 'navbar.after' | 'server.subnav' | 'server.subnav.before' | 'server.subnav.after' | 'server.header' | 'server.page' | 'server.footer' | 'server.terminal.buttons' | 'server.console.header' | 'server.console.info.before' | 'server.console.info.after' | 'server.console.sidebar' | 'server.console.command' | 'server.console.footer' | 'server.files.actions' | 'server.files.header' | 'server.files.footer' | 'server.files.dropdown' | 'server.files.edit.before' | 'server.files.edit.after' | 'server.databases.before' | 'server.databases.after' | 'server.schedules.before' | 'server.schedules.after' | 'server.schedules.edit.before' | 'server.schedules.edit.after' | 'server.users.before' | 'server.users.after' | 'server.backups.before' | 'server.backups.after' | 'server.backups.dropdown' | 'server.network.before' | 'server.network.after' | 'server.startup.before' | 'server.startup.after' | 'server.settings.before' | 'server.settings.after' | 'dashboard.header' | 'dashboard.widgets' | 'dashboard.serverlist.before' | 'dashboard.serverlist.after' | 'dashboard.serverrow.name.before' | 'dashboard.serverrow.name.after' | 'dashboard.serverrow.description.before' | 'dashboard.serverrow.description.after' | 'dashboard.serverrow.limits' | 'dashboard.footer' | 'dashboard.page' | 'account.header' | 'account.page' | 'account.footer' | 'account.subnav' | 'account.subnav.before' | 'account.subnav.after' | 'account.overview.before' | 'account.overview.after' | 'account.api.before' | 'account.api.after' | 'account.ssh.before' | 'account.ssh.after' | 'auth.container.before' | 'auth.container.after';
+/**
+ * Panel route area for extension pages.
+ *
+ * Routes are scoped by area so pages are mounted in the correct Pterodactyl
+ * router surface and navigation context.
+ */
+export type RouteArea = 'server' | 'dashboard' | 'account';
 /**
  * Extension identity configuration.
  *
- * Only `id` is required. `name` and `version` are auto-resolved from
- * the extension.yaml manifest if omitted.
+ * Only `id` is required for most extensions. `name` and `version` are normally
+ * resolved from `extension.yaml`, which is injected into the bridge runtime by
+ * the Notur PHP package.
  */
 export interface ExtensionConfig {
-    /** Unique extension identifier in vendor/name format (e.g. "acme/analytics"). */
+    /** Unique extension identifier in vendor/name format, for example `acme/analytics`. */
     id: string;
-    /** Human-readable name. Auto-resolved from extension.yaml if omitted. */
+    /** Human-readable display name. Omit this when it is present in `extension.yaml`. */
     name?: string;
-    /** Semantic version string. Auto-resolved from extension.yaml if omitted. */
+    /** Semantic version string. Omit this when it is present in `extension.yaml`. */
     version?: string;
 }
+/**
+ * CSS isolation options for components rendered by this extension.
+ *
+ * Root-class isolation wraps rendered slot/route components in a stable class so
+ * extension CSS can be scoped without Shadow DOM.
+ *
+ * @example
+ * ```ts
+ * createExtension({
+ *   id: 'acme/theme-tools',
+ *   cssIsolation: { mode: 'root-class', className: 'notur-ext--theme-tools' },
+ * });
+ * ```
+ */
 export interface CssIsolationConfig {
+    /** Isolation strategy. Currently only root class wrapping is supported. */
     mode: 'root-class';
+    /** Optional class name. If omitted, the bridge derives one from the extension id. */
     className?: string;
 }
+/**
+ * Runtime context passed to `when` predicate functions for conditional slot rendering.
+ */
 export interface SlotRenderContext {
+    /** Current `window.location.pathname`, for example `/server/abc123`. */
     path: string;
+    /** High-level panel area inferred from the current path. */
     area: 'server' | 'dashboard' | 'account' | 'admin' | 'auth' | 'other';
+    /** True when the current URL is a server-scoped page. */
     isServer: boolean;
+    /** True when the current URL is the dashboard area. */
     isDashboard: boolean;
+    /** True when the current URL is an account page. */
     isAccount: boolean;
+    /** True when the current URL is an admin page. */
     isAdmin: boolean;
+    /** True when the current URL is an auth/login page. */
     isAuth: boolean;
+    /** Current server permission list when available, otherwise `null`. */
     permissions: string[] | null;
 }
+/**
+ * Declarative conditions that decide whether a slot registration should render.
+ *
+ * All provided conditions must match. Use this to keep a component limited to
+ * specific panel areas, paths, or permissions.
+ *
+ * @example
+ * ```ts
+ * { slot: 'server.header', component: Button, when: { server: true } }
+ * { slot: 'server.files.actions', component: Tool, when: { pathIncludes: '/files' } }
+ * ```
+ */
 export interface SlotRenderWhen {
+    /** Render only in one panel area. */
     area?: SlotRenderContext['area'];
+    /** Render only in one of several panel areas. */
     areas?: Array<SlotRenderContext['area']>;
+    /** Alias for `pathStartsWith`; render when the current path starts with this value. */
     path?: string | string[];
+    /** Render when the current path starts with one of these prefixes. */
     pathStartsWith?: string | string[];
+    /** Render when the current path contains one of these fragments. */
     pathIncludes?: string | string[];
+    /** Render when the current path matches this regular expression. */
     pathMatches?: string | RegExp;
+    /** Require one of these server permissions. `*` grants access. */
     permission?: string | string[];
+    /** Render only when `context.isServer` equals this value. */
     server?: boolean;
+    /** Render only when `context.isDashboard` equals this value. */
     dashboard?: boolean;
+    /** Render only when `context.isAccount` equals this value. */
     account?: boolean;
+    /** Render only when `context.isAdmin` equals this value. */
     admin?: boolean;
+    /** Render only when `context.isAuth` equals this value. */
     auth?: boolean;
 }
+/**
+ * Conditional render rule for a slot registration.
+ *
+ * - `false` disables rendering.
+ * - an object uses declarative path/area/permission checks.
+ * - a function receives `SlotRenderContext` for custom logic.
+ */
 export type SlotRenderCondition = boolean | SlotRenderWhen | ((context: SlotRenderContext) => boolean);
+/**
+ * Register a React component into a Notur frontend slot.
+ */
 export interface SlotConfig {
-    slot: string;
+    /** Slot mount point. Known values autocomplete through `SlotId`; custom strings are accepted for forward compatibility. */
+    slot: SlotId | (string & {});
+    /** React component rendered into the slot. Receives at least `{ extensionId }` plus any `props`. */
     component: React.ComponentType<any>;
+    /** Sort order within the same priority. Lower values render first. Defaults to `0`. */
     order?: number;
+    /** Priority across registrations. Higher values render before lower values. Defaults to `0`. */
     priority?: number;
+    /** Optional label used by navigation-style slots such as `server.subnav`. */
     label?: string;
+    /** Optional icon name used by navigation-style slots when the bridge supports icons. */
     icon?: string;
+    /** Server permission required to render this slot. Checked against current server permissions when available. */
     permission?: string;
+    /** Static props merged into the component props every time it renders. */
     props?: Record<string, any>;
+    /** Optional condition controlling whether the component renders for the current page/context. */
     when?: SlotRenderCondition;
 }
+/**
+ * Register a full React page inside a Notur route area.
+ *
+ * Route paths are extension-local. A server route with `path: '/analytics'` is
+ * mounted under the extension namespace rather than replacing Pterodactyl's
+ * built-in routes.
+ */
 export interface RouteConfig {
-    area: 'server' | 'dashboard' | 'account';
+    /** Panel area where the route belongs. */
+    area: RouteArea;
+    /** Extension-local path. Must start with `/`, for example `/analytics`. */
     path: string;
+    /** Display name used by navigation/debug tooling. */
     name: string;
+    /** React page component rendered for this route. */
     component: React.ComponentType<any>;
+    /** Optional icon name for navigation entries. */
     icon?: string;
+    /** Optional permission required before showing or using the route. */
     permission?: string;
 }
 /**
  * Full extension definition passed to `createExtension()`.
  *
+ * Most new extensions should use the simpler top-level `id` form instead.
+ *
  * @example
  * ```ts
  * createExtension({
- *     config: { id: 'acme/analytics' },
- *     slots: [{ slot: 'dashboard.widgets', component: Widget }],
+ *   config: { id: 'acme/analytics' },
+ *   slots: [{ slot: 'dashboard.widgets', component: Widget }],
  * });
  * ```
  */
 export interface ExtensionDefinition {
+    /** Extension identity. `id` must match `extension.yaml`. */
     config: ExtensionConfig;
+    /** Components to render into existing Pterodactyl UI slots. */
     slots?: SlotConfig[];
+    /** Full extension pages to register in supported panel areas. */
     routes?: RouteConfig[];
+    /** Enable or configure root-class CSS isolation for this extension. */
     cssIsolation?: CssIsolationConfig | boolean;
+    /** Called after registration succeeds. Keep this lightweight. */
     onInit?: () => void;
+    /** Called when the bridge unregisters this extension. Use it for cleanup. */
     onDestroy?: () => void;
 }
 /**
  * Simplified extension definition with `id` at the top level.
  *
- * Name and version are auto-resolved from the extension.yaml manifest.
- * This is the recommended format for most extensions.
+ * Name and version are auto-resolved from `extension.yaml`. This is the
+ * recommended format for most extensions.
  *
  * @example
  * ```ts
  * createExtension({
- *     id: 'acme/analytics',
- *     slots: [{ slot: 'dashboard.widgets', component: Widget }],
+ *   id: 'acme/analytics',
+ *   slots: [{ slot: 'dashboard.widgets', component: Widget }],
  * });
  * ```
  */
 export type SimpleExtensionDefinition = Omit<ExtensionDefinition, 'config'> & {
-    /** Unique extension identifier in vendor/name format (e.g. "acme/analytics"). */
+    /** Unique extension identifier in vendor/name format, for example `acme/analytics`. */
     id: string;
 };
+/** Internal registration shape stored by the bridge registry after a slot is registered. */
 export interface SlotRegistration {
+    /** Extension that owns this registration. */
     extensionId: string;
-    slot: string;
+    /** Slot mount point. */
+    slot: SlotId | (string & {});
+    /** Component rendered by the bridge. */
     component: React.ComponentType<any>;
+    /** Sort order within priority. */
     order?: number;
+    /** Higher priority renders earlier. */
     priority?: number;
+    /** Navigation label for nav slots. */
     label?: string;
+    /** Navigation icon for nav slots. */
     icon?: string;
+    /** Required permission, if any. */
     permission?: string;
+    /** CSS isolation wrapper class resolved by the bridge. */
     scopeClass?: string;
+    /** Static props passed into the component. */
     props?: Record<string, any>;
+    /** Conditional render rule. */
     when?: SlotRenderCondition;
 }
+/** Internal registration shape stored by the bridge registry after a route is registered. */
 export interface RouteRegistration {
+    /** Extension that owns this route. */
     extensionId: string;
-    area: 'server' | 'dashboard' | 'account';
+    /** Panel area where the route belongs. */
+    area: RouteArea;
+    /** Extension-local route path. */
     path: string;
+    /** Display name. */
     name: string;
+    /** Route page component. */
     component: React.ComponentType<any>;
+    /** Optional navigation icon. */
     icon?: string;
+    /** Optional permission requirement. */
     permission?: string;
+    /** CSS isolation wrapper class resolved by the bridge. */
     scopeClass?: string;
 }
+/**
+ * Low-level Notur bridge API exposed on `window.__NOTUR__`.
+ *
+ * Most extensions should use `createExtension()` and hooks instead of calling
+ * this directly. It is exported as an escape hatch for advanced integrations and
+ * debugging tools.
+ */
 export interface NoturApi {
+    /** Notur bridge/runtime version. */
     version: string;
+    /** Runtime registry for slots, routes, themes, lifecycle callbacks, and events. */
     registry: {
         registerSlot: (registration: Omit<SlotRegistration, 'extensionId'> & {
             extensionId?: string;
@@ -149,6 +294,7 @@ export interface NoturApi {
         emitEvent: (event: string, data?: unknown) => void;
         onEvent: (event: string, callback: (data?: unknown) => void) => () => void;
     };
+    /** Bridge-provided hooks for advanced consumers. Prefer direct SDK hook exports. */
     hooks: {
         useSlot: (slotId: string) => SlotRegistration[];
         useExtensionApi: (options: {
@@ -168,8 +314,11 @@ export interface NoturApi {
         useExtensionState: <T extends Record<string, any>>(extensionId: string, initialState: T) => [T, (partial: Partial<T>) => void, () => void];
         useNoturTheme: () => Record<string, string>;
     };
+    /** Bridge slot constants. */
     SLOT_IDS: Record<string, string>;
+    /** Unregister an extension by id. Mostly useful for development tooling. */
     unregisterExtension: (id: string) => void;
+    /** Enabled extension metadata injected by the PHP runtime. */
     extensions?: Array<{
         id: string;
         name?: string;
@@ -181,19 +330,29 @@ export interface NoturApi {
 }
 /**
  * Base props received by components registered in Notur slots.
- * Extension developers can use this to type their slot components:
+ *
+ * Extend this interface for your own static props:
  *
  * ```tsx
- * import { SlotComponentProps } from '@notur/sdk';
- * const MyWidget: React.FC<SlotComponentProps> = ({ extensionId }) => { ... };
+ * import type { SlotComponentProps } from '@notur/sdk';
+ *
+ * type Props = SlotComponentProps & { label: string };
+ * const MyWidget: React.FC<Props> = ({ extensionId, label }) => <button>{label}</button>;
  * ```
  */
 export interface SlotComponentProps {
+    /** Owning extension id, for example `acme/red-button`. */
     extensionId: string;
+    /** Additional props supplied by `SlotConfig.props` or the bridge. */
     [key: string]: any;
 }
 /**
- * Get the Notur API from the window global.
+ * Get the Notur API from the browser global.
+ *
+ * This is an advanced escape hatch. Use `createExtension()` and exported hooks
+ * for normal extension development.
+ *
+ * @throws If the Notur bridge runtime has not loaded yet.
  */
 export declare function getNoturApi(): NoturApi;
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC5B,iFAAiF;IACjF,EAAE,EAAE,MAAM,CAAC;IACX,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IACtE,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,cAAc;IAC3B,IAAI,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IACzC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,mBAAmB,GACzB,OAAO,GACP,cAAc,GACd,CAAC,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,CAAC;AAEhD,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,mBAAmB;IAChC,MAAM,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,YAAY,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAC5C,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,GAAG;IAC1E,iFAAiF;IACjF,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAiB;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,QAAQ;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE;QACN,YAAY,EAAE,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,GAAG;YAAE,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,IAAI,CAAC;QACvG,aAAa,EAAE,CAAC,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,MAAM,CAAC,GAAG;YAAE,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,IAAI,CAAC;QAC5I,iBAAiB,EAAE,CAAC,GAAG,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;YAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC;YAAC,KAAK,CAAC,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;aAAE,CAAC;YAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;SAAE,KAAK,IAAI,CAAC;QAC7O,uBAAuB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;QAC7E,mBAAmB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;QACnD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,gBAAgB,EAAE,CAAC;QAChD,SAAS,EAAE,CAAC,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC,KAAK,iBAAiB,EAAE,CAAC;QACpE,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC;QACxD,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;QACnD,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,KAAK,MAAM,IAAI,CAAC;KAC9E,CAAC;IACF,KAAK,EAAE;QACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,gBAAgB,EAAE,CAAC;QAChD,eAAe,EAAE,CAAC,OAAO,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK;YACrE,IAAI,EAAE,OAAO,CAAC;YACd,OAAO,EAAE,OAAO,CAAC;YACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YACrB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YACzD,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YACxD,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YAC1D,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3C,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;SACtE,CAAC;QACF,iBAAiB,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7C,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,CAAC,KACd,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC;QACpD,aAAa,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC/C,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1C,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;KAAE,CAAC,CAAC;CAC5I;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAMtC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,MAAM,GACZ,QAAQ,GACR,aAAa,GACb,eAAe,GACf,cAAc,GACd,eAAe,GACf,sBAAsB,GACtB,qBAAqB,GACrB,eAAe,GACf,aAAa,GACb,eAAe,GACf,yBAAyB,GACzB,uBAAuB,GACvB,4BAA4B,GAC5B,2BAA2B,GAC3B,wBAAwB,GACxB,wBAAwB,GACxB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,qBAAqB,GACrB,uBAAuB,GACvB,0BAA0B,GAC1B,yBAAyB,GACzB,yBAAyB,GACzB,wBAAwB,GACxB,yBAAyB,GACzB,wBAAwB,GACxB,8BAA8B,GAC9B,6BAA6B,GAC7B,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,GACvB,sBAAsB,GACtB,yBAAyB,GACzB,uBAAuB,GACvB,sBAAsB,GACtB,uBAAuB,GACvB,sBAAsB,GACtB,wBAAwB,GACxB,uBAAuB,GACvB,kBAAkB,GAClB,mBAAmB,GACnB,6BAA6B,GAC7B,4BAA4B,GAC5B,iCAAiC,GACjC,gCAAgC,GAChC,wCAAwC,GACxC,uCAAuC,GACvC,4BAA4B,GAC5B,kBAAkB,GAClB,gBAAgB,GAChB,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,yBAAyB,GACzB,wBAAwB,GACxB,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,mBAAmB,GACnB,uBAAuB,GACvB,sBAAsB,CAAC;AAE7B;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AAE3D;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC5B,uFAAuF;IACvF,EAAE,EAAE,MAAM,CAAC;IACX,qFAAqF;IACrF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iFAAiF;IACjF,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,kBAAkB;IAC/B,2EAA2E;IAC3E,IAAI,EAAE,YAAY,CAAC;IACnB,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;IACtE,yDAAyD;IACzD,QAAQ,EAAE,OAAO,CAAC;IAClB,uDAAuD;IACvD,WAAW,EAAE,OAAO,CAAC;IACrB,oDAAoD;IACpD,SAAS,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;IACjB,uDAAuD;IACvD,MAAM,EAAE,OAAO,CAAC;IAChB,uEAAuE;IACvE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,cAAc;IAC3B,qCAAqC;IACrC,IAAI,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACjC,iDAAiD;IACjD,KAAK,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IACzC,uFAAuF;IACvF,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACzB,sEAAsE;IACtE,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACnC,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjC,oEAAoE;IACpE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,kEAAkE;IAClE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B,6DAA6D;IAC7D,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GACzB,OAAO,GACP,cAAc,GACd,CAAC,CAAC,OAAO,EAAE,iBAAiB,KAAK,OAAO,CAAC,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,2HAA2H;IAC3H,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAC7B,oGAAoG;IACpG,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gGAAgG;IAChG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6EAA6E;IAC7E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wFAAwF;IACxF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iHAAiH;IACjH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,iGAAiG;IACjG,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IACxB,0CAA0C;IAC1C,IAAI,EAAE,SAAS,CAAC;IAChB,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,mBAAmB;IAChC,4DAA4D;IAC5D,MAAM,EAAE,eAAe,CAAC;IACxB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;IACrB,iEAAiE;IACjE,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,uEAAuE;IACvE,YAAY,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC;IAC5C,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CAC1B;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,GAAG;IAC1E,uFAAuF;IACvF,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,4FAA4F;AAC5F,MAAM,WAAW,gBAAgB;IAC7B,6CAA6C;IAC7C,WAAW,EAAE,MAAM,CAAC;IACpB,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAC7B,wCAAwC;IACxC,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B,+BAA+B;IAC/B,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,6FAA6F;AAC7F,MAAM,WAAW,iBAAiB;IAC9B,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,IAAI,EAAE,SAAS,CAAC;IAChB,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACrB,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,mFAAmF;IACnF,QAAQ,EAAE;QACN,YAAY,EAAE,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,GAAG;YAAE,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,IAAI,CAAC;QACvG,aAAa,EAAE,CAAC,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,MAAM,CAAC,GAAG;YAAE,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,IAAI,CAAC;QAC5I,iBAAiB,EAAE,CAAC,GAAG,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;YAAC,MAAM,EAAE,iBAAiB,EAAE,CAAC;YAAC,KAAK,CAAC,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;aAAE,CAAC;YAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;SAAE,KAAK,IAAI,CAAC;QAC7O,uBAAuB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;QAC7E,mBAAmB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;QACnD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,gBAAgB,EAAE,CAAC;QAChD,SAAS,EAAE,CAAC,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC,KAAK,iBAAiB,EAAE,CAAC;QACpE,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC;QACxD,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;QACnD,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,KAAK,MAAM,IAAI,CAAC;KAC9E,CAAC;IACF,oFAAoF;IACpF,KAAK,EAAE;QACH,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,gBAAgB,EAAE,CAAC;QAChD,eAAe,EAAE,CAAC,OAAO,EAAE;YAAE,WAAW,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK;YACrE,IAAI,EAAE,OAAO,CAAC;YACd,OAAO,EAAE,OAAO,CAAC;YACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YACrB,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YACxC,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YACzD,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YACxD,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YAC1D,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3C,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;SACtE,CAAC;QACF,iBAAiB,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7C,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,CAAC,KACd,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC;QACpD,aAAa,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC/C,CAAC;IACF,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,4EAA4E;IAC5E,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1C,8DAA8D;IAC9D,UAAU,CAAC,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,kBAAkB,CAAA;KAAE,CAAC,CAAC;CAC5I;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAkB;IAC/B,0DAA0D;IAC1D,WAAW,EAAE,MAAM,CAAC;IACpB,qEAAqE;IACrE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CAMtC"}

package/dist/types.js

@@ -1,5 +1,10 @@
 /**
- * Get the Notur API from the window global.
+ * Get the Notur API from the browser global.
+ *
+ * This is an advanced escape hatch. Use `createExtension()` and exported hooks
+ * for normal extension development.
+ *
+ * @throws If the Notur bridge runtime has not loaded yet.
  */
 export function getNoturApi() {
     const api = window.__NOTUR__;

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA4LA;;GAEG;AACH,MAAM,UAAU,WAAW;IACvB,MAAM,GAAG,GAAI,MAAc,CAAC,SAAS,CAAC;IACtC,IAAI,CAAC,GAAG,EAAE,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAyZA;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW;IACvB,MAAM,GAAG,GAAI,MAAc,CAAC,SAAS,CAAC;IACtC,IAAI,CAAC,GAAG,EAAE,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,GAAG,CAAC;AACf,CAAC"}

package/examples/red-button/.env.example

@@ -0,0 +1,2 @@
+NOTUR_HOST=https://panel.example.com
+NOTUR_PUSH_KEY=notur_xxx

package/examples/red-button/README.md

@@ -0,0 +1,30 @@
+# Red Button Example
+
+A minimal Notur frontend extension that renders a red button in the server header.
+
+## Local Build
+
+```bash
+npm install
+npm run build
+```
+
+## Package
+
+```bash
+npx notur-pack
+```
+
+## Push To A Remote Panel
+
+Create `.env` from `.env.example`, then run:
+
+```bash
+npm run push
+```
+
+The remote panel must have Notur remote push enabled:
+
+```bash
+php artisan notur:remote-key
+```

package/examples/red-button/extension.yaml

@@ -0,0 +1,9 @@
+notur: "1.0"
+id: "acme/red-button"
+name: "Red Button"
+version: "1.0.0"
+description: "Adds a red button to the server header"
+license: "MIT"
+
+frontend:
+  bundle: "resources/frontend/dist/extension.js"

package/examples/red-button/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "acme-red-button",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "build": "webpack-cli --mode production --config webpack.config.js",
+    "dev": "webpack-cli --mode development --watch --config webpack.config.js",
+    "pack": "notur-pack",
+    "push": "notur-push",
+    "sync": "notur-sync",
+    "validate": "notur-validate",
+    "doctor": "notur-doctor"
+  },
+  "peerDependencies": {
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0"
+  },
+  "devDependencies": {
+    "@notur/sdk": "^1.4.7",
+    "@types/react": "^16.14.0",
+    "@types/react-dom": "^16.9.0",
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0",
+    "ts-loader": "^9.5.0",
+    "typescript": "^5.3.0",
+    "webpack": "^5.90.0",
+    "webpack-cli": "^6.0.0"
+  }
+}

package/examples/red-button/resources/frontend/src/index.tsx

@@ -0,0 +1,32 @@
+import * as React from 'react';
+import { createExtension } from '@notur/sdk';
+
+const RedButton: React.FC = () => {
+    return (
+        <button
+            style={{
+                background: '#dc2626',
+                color: '#fff',
+                border: 0,
+                borderRadius: '6px',
+                padding: '8px 12px',
+                fontWeight: 600,
+                cursor: 'pointer',
+            }}
+            onClick={() => alert('Hello from Notur')}
+        >
+            Red Button
+        </button>
+    );
+};
+
+createExtension({
+    id: 'acme/red-button',
+    slots: [
+        {
+            slot: 'server.header',
+            component: RedButton,
+            order: 10,
+        },
+    ],
+});

package/examples/red-button/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ES2019",
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "jsx": "react",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["resources/frontend/src/**/*"]
+}

package/examples/red-button/webpack.config.js

@@ -0,0 +1,17 @@
+const path = require('path');
+const base = require('@notur/sdk/webpack.extension.config');
+
+module.exports = {
+    ...base,
+    entry: './resources/frontend/src/index.tsx',
+    output: {
+        ...base.output,
+        filename: 'extension.js',
+        path: path.resolve(__dirname, 'resources/frontend/dist'),
+        library: {
+            ...base.output.library,
+            name: '__NOTUR_EXT_AcmeRedButton__',
+            type: 'umd',
+        },
+    },
+};