@k8slens/drop-down-menu-contracts 1.0.0

package/dist/src/drop-down-menu-kind-injection-token.d.ts

@@ -0,0 +1,51 @@
+import type { DropDownMenuKind } from "./drop-down-menu-kind";
+/**
+ * One drop-down menu that exists, announced so it can be discovered rather
+ * than found by reading the source.
+ */
+export interface DropDownMenuKindDeclaration {
+    /** The kind itself, as `dropDownMenuItemInjectionToken.for(kind)` takes it. */
+    readonly kind: DropDownMenuKind<any>;
+    /** One line on what the menu is, for a reader deciding whether to contribute. */
+    readonly description: string;
+}
+/** Produces one declaration, possibly later. */
+export type DropDownMenuKindDeclarationFactory = () => DropDownMenuKindDeclaration;
+/**
+ * Every drop-down menu kind the running build knows about.
+ *
+ * Injecting many of these is how a surface enumerates the menus that exist —
+ * the extension-development instructions render their list from it, so a new
+ * menu becomes documented by registering here rather than by someone
+ * remembering to edit prose.
+ */
+export declare const dropDownMenuKindInjectionToken: import("@k8slens/injectable").InjectionToken2Base<DropDownMenuKindDeclarationFactory, () => DropDownMenuKindDeclaration[], "zero-or-many", () => import("@k8slens/injectable").InjectionInstanceWithMeta<DropDownMenuKindDeclaration>, () => import("@k8slens/injectable").InjectionInstanceWithMeta<DropDownMenuKindDeclaration>[]> & {
+    readonly __abstract?: never;
+};
+export interface DropDownMenuKindInjectableParams {
+    /** Unique id for the registered injectable. */
+    readonly id: string;
+    /** The kind being announced. */
+    readonly kind: DropDownMenuKind<any>;
+    /** One line on what the menu is. */
+    readonly description: string;
+}
+/**
+ * Announce a drop-down menu kind, so anything enumerating the menus finds it.
+ *
+ * Register this wherever the menu's own surface is registered — a contracts
+ * package exports the kind, but not the registration.
+ *
+ * @example
+ * ```ts
+ * export default getDropDownMenuKindInjectableBunch({
+ *   id: "ai-tool-top-bar-menu-kind",
+ *   kind: aiToolTopBarMenuKind,
+ *   description: "The menu of the AI tool button in the top bar.",
+ * });
+ * ```
+ */
+export declare const getDropDownMenuKindInjectableBunch: (params: DropDownMenuKindInjectableParams) => {
+    dropDownMenuKind: import("@k8slens/injectable").Injectable2<() => DropDownMenuKindDeclaration>;
+};
+//# sourceMappingURL=drop-down-menu-kind-injection-token.d.ts.map

package/dist/src/drop-down-menu-kind-injection-token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drop-down-menu-kind-injection-token.d.ts","sourceRoot":"","sources":["../../src/drop-down-menu-kind-injection-token.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9D;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,+EAA+E;IAC/E,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACrC,iFAAiF;IACjF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,gDAAgD;AAChD,MAAM,MAAM,kCAAkC,GAAG,MAAM,2BAA2B,CAAC;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B;;CAKvC,CAAC;AAEL,MAAM,WAAW,gCAAgC;IAC/C,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACrC,oCAAoC;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kCAAkC,WAAY,gCAAgC;sEAK9D,2BAA2B;CAOpD,CAAC"}

package/dist/src/drop-down-menu-kind.d.ts

@@ -0,0 +1,36 @@
+import { type TypedSpecifier, type TypedSpecifierType } from "@k8slens/injectable";
+/**
+ * Identifies one family of drop-down menu items. Items are contributed against
+ * a kind via `dropDownMenuItemInjectionToken.for(kind)`, and a host element
+ * opens the menu of a kind with `$dropDownMenu={dropDownMenu(kind)}`.
+ *
+ * `TData` is the data the host element supplies when opening the menu; item
+ * factories of the kind receive it. A kind created without `TData` needs no
+ * data.
+ *
+ * At runtime a kind is a branded string, so it is usable as a `.for()` key.
+ */
+export type DropDownMenuKind<TData = void> = TypedSpecifier<string, {
+    dropDownMenuData: TData;
+}>;
+/**
+ * Recovers the data type bound to a {@link DropDownMenuKind}.
+ */
+export type DropDownMenuData<K extends DropDownMenuKind<any>> = TypedSpecifierType<"dropDownMenuData", K>;
+/**
+ * Curried creator for a {@link DropDownMenuKind}. The first call binds the data
+ * type; the second the globally unique specifier string.
+ *
+ * @example
+ * ```ts
+ * // A menu whose items need no data:
+ * export const aiToolsMenuKind = getDropDownMenuKind()("ai-tools-menu");
+ *
+ * // A menu whose items derive from the host element's data:
+ * export const podActionsMenuKind = getDropDownMenuKind<{ podName: string }>()("pod-actions-menu");
+ * ```
+ */
+export declare const getDropDownMenuKind: <TData = void>() => <S extends string>(specifier: S) => TypedSpecifier<S, {
+    dropDownMenuData: TData;
+}>;
+//# sourceMappingURL=drop-down-menu-kind.d.ts.map

package/dist/src/drop-down-menu-kind.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drop-down-menu-kind.d.ts","sourceRoot":"","sources":["../../src/drop-down-menu-kind.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,cAAc,EAAE,KAAK,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEtG;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,IAAI,IAAI,cAAc,CAAC,MAAM,EAAE;IAAE,gBAAgB,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AAEjG;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,IAAI,kBAAkB,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC;AAE1G;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,mBAAmB,GAC7B,KAAK,GAAG,IAAI,QACZ,CAAC,SAAS,MAAM,aAAa,CAAC;sBACS,KAAK;EAAgB,CAAC"}

package/dist/src/drop-down-menu-spec.d.ts

@@ -0,0 +1,62 @@
+import type { DropDownMenuData, DropDownMenuKind } from "./drop-down-menu-kind";
+/**
+ * How the menu opens from its host element.
+ *
+ * - `"click"` (the default): clicking the element toggles the menu.
+ * - `"hover"`: the menu opens while the pointer is over the element or the menu.
+ * - `"right-click"`: right-clicking the element toggles the menu. The menu stays anchored to the
+ *   element; cursor-anchored right-click menus are the concern of `@lensapp/context-menu`.
+ */
+export type DropDownMenuOpenOn = "click" | "hover" | "right-click";
+/**
+ * Where the menu sits relative to its host element: a side of the host, optionally refined with how
+ * the menu extends along that side. A bare side centers the menu on it; `span-<direction>` aligns
+ * their edges and lets the menu extend toward that direction.
+ *
+ * Defaults to `"bottom span-right"`. When the menu would not fit the viewport, it falls back to the
+ * mirrored positions.
+ *
+ * Note: kept identical to `AnchorPosition` of `@k8slens/element-components`, which cannot be
+ * imported here — it depends on this package.
+ */
+export type DropDownMenuPosition = "top" | "bottom" | "left" | "right" | "top span-left" | "top span-right" | "bottom span-left" | "bottom span-right" | "left span-top" | "left span-bottom" | "right span-top" | "right span-bottom";
+/**
+ * How far from its host the menu sits, on the shared t-shirt scale. Defaults to `"xs"`.
+ *
+ * Note: kept identical to `TShirtSize` of `@k8slens/element-components`, which cannot be imported
+ * here — it depends on this package.
+ */
+export type DropDownMenuGap = "zero" | "4xs" | "3xs" | "xxs" | "xs" | "s" | "m" | "l" | "xl" | "xxl" | "3xl" | "4xl" | "5xl" | "6xl" | "7xl" | "8xl" | "9xl" | "10xl" | "11xl";
+/**
+ * The value of the `$dropDownMenu` element prop: which menu kind to open, the data its item
+ * factories receive, how the menu opens and where it sits. Create with {@link dropDownMenu} so the
+ * data is typed by the kind.
+ */
+export type DropDownMenuSpec = {
+    readonly kind: DropDownMenuKind<any>;
+    readonly data?: unknown;
+    readonly openOn?: DropDownMenuOpenOn;
+    readonly position?: DropDownMenuPosition;
+    readonly gap?: DropDownMenuGap;
+};
+export type DropDownMenuOptions = {
+    readonly openOn?: DropDownMenuOpenOn;
+    readonly position?: DropDownMenuPosition;
+    readonly gap?: DropDownMenuGap;
+};
+/**
+ * Typed constructor for a {@link DropDownMenuSpec}: a kind created for a data type makes `data`
+ * required and typed; a kind without data forbids it.
+ *
+ * @example
+ * ```tsx
+ * <Button $dropDownMenu={dropDownMenu(aiToolsMenuKind)}>Open</Button>
+ * <Button $dropDownMenu={dropDownMenu(podActionsMenuKind, { data: { podName } })}>Pod</Button>
+ * <Button $dropDownMenu={dropDownMenu(rowActionsMenuKind, { position: "bottom span-left" })}>⋮</Button>
+ * ```
+ */
+export declare function dropDownMenu<K extends DropDownMenuKind<void>>(kind: K, options?: DropDownMenuOptions): DropDownMenuSpec;
+export declare function dropDownMenu<K extends DropDownMenuKind<any>>(kind: K, options: DropDownMenuOptions & {
+    readonly data: DropDownMenuData<K>;
+}): DropDownMenuSpec;
+//# sourceMappingURL=drop-down-menu-spec.d.ts.map

package/dist/src/drop-down-menu-spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drop-down-menu-spec.d.ts","sourceRoot":"","sources":["../../src/drop-down-menu-spec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEhF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,OAAO,GAAG,aAAa,CAAC;AAEnE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,oBAAoB,GAC5B,KAAK,GACL,QAAQ,GACR,MAAM,GACN,OAAO,GACP,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,eAAe,GACf,kBAAkB,GAClB,gBAAgB,GAChB,mBAAmB,CAAC;AAExB;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,IAAI,GACJ,GAAG,GACH,GAAG,GACH,GAAG,GACH,IAAI,GACJ,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,MAAM,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACrC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IACzC,QAAQ,CAAC,GAAG,CAAC,EAAE,eAAe,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,QAAQ,CAAC,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IACzC,QAAQ,CAAC,GAAG,CAAC,EAAE,eAAe,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,gBAAgB,CAAC,IAAI,CAAC,EAC3D,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE,mBAAmB,GAC5B,gBAAgB,CAAC;AACpB,wBAAgB,YAAY,CAAC,CAAC,SAAS,gBAAgB,CAAC,GAAG,CAAC,EAC1D,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,mBAAmB,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAA;CAAE,GACpE,gBAAgB,CAAC"}

package/dist/src/menu-item-activated-context.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Told by an item when it is activated, so the menu it belongs to — and the menus it was opened
+ * from — can close. Items themselves know nothing of menus.
+ */
+export declare const menuItemActivatedContext: import("react").Context<VoidFunction | undefined>;
+//# sourceMappingURL=menu-item-activated-context.d.ts.map

package/dist/src/menu-item-activated-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"menu-item-activated-context.d.ts","sourceRoot":"","sources":["../../src/menu-item-activated-context.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,wBAAwB,mDAAqD,CAAC"}