@nebulahome/package-sdk 0.0.0-stage → 1.0.1

package/dist/components.js

@@ -0,0 +1,210 @@
+import { r as hostMember, t as COMPONENTS_MODULE } from "./chunks/host.js";
+import { createElement } from "react";
+//#region src/components/index.ts
+/**
+* `@nebulahome/package-sdk/components`: the part of the interface's design system a package may
+* draw with (PACKAGES_DOCS.md 7.1), lent at run time like React. A convenience, never a
+* constraint: a package may draw anything, with any CSS.
+*/
+/**
+* An action.
+*
+* @param props - A native button's attributes, a variant and a size.
+* @returns The button.
+*/
+function Button(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Button", "1.0"), props);
+}
+/**
+* An action with an icon and no text.
+*
+* @param props - What it does, its glyph, its variant and size.
+* @returns The button.
+*/
+function IconButton(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "IconButton", "1.0"), props);
+}
+/**
+* A catalogue icon.
+*
+* @param props - Its id and size.
+* @returns The icon.
+*/
+function Icon(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Icon", "1.0"), props);
+}
+/**
+* A short state.
+*
+* @param props - Its tone, size and text.
+* @returns The badge.
+*/
+function Badge(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Badge", "1.0"), props);
+}
+/**
+* A titled section.
+*
+* @param props - Its title, action and content.
+* @returns The panel.
+*/
+function Panel(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Panel", "1.0"), props);
+}
+/**
+* A row of a panel.
+*
+* @param props - Its title, note and control.
+* @returns The row.
+*/
+function PanelRow(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "PanelRow", "1.0"), props);
+}
+/**
+* A note under a panel.
+*
+* @param props - What it says.
+* @returns The note.
+*/
+function PanelNote(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "PanelNote", "1.0"), props);
+}
+/**
+* A card's two-line heading, as the dashboard's own cards draw it.
+*
+* @param props - Its title, subtitle and tail.
+* @returns The heading.
+*/
+function CardHeading(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "CardHeading", "1.0"), props);
+}
+/**
+* A reading as a number and its unit.
+*
+* @param props - The number, its unit and size.
+* @returns The figure.
+*/
+function Figure(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Figure", "1.0"), props);
+}
+/**
+* A state at a glance.
+*
+* @param props - Its tone and meaning.
+* @returns The dot.
+*/
+function StatusDot(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "StatusDot", "1.0"), props);
+}
+/**
+* How far something has come.
+*
+* @param props - The percentage and what it is.
+* @returns The bar.
+*/
+function ProgressBar(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "ProgressBar", "1.0"), props);
+}
+/**
+* An explanation behind a small `i`.
+*
+* @param props - The explanation.
+* @returns The hint.
+*/
+function Hint(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Hint", "1.0"), props);
+}
+/**
+* A labelled text input.
+*
+* @param props - An input's attributes, its label and what it says under it.
+* @returns The field.
+*/
+function TextField(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "TextField", "1.0"), props);
+}
+/**
+* A labelled choice from a list.
+*
+* @param props - Its label, options and value.
+* @returns The field.
+*/
+function SelectField(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "SelectField", "1.0"), props);
+}
+/**
+* On or off.
+*
+* @param props - Its label and state.
+* @returns The switch.
+*/
+function Switch(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Switch", "1.0"), props);
+}
+/**
+* One of a few, side by side.
+*
+* @param props - Its label, options and value.
+* @returns The control.
+*/
+function Segmented(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Segmented", "1.0"), {
+		...props,
+		/**
+		* Hands the choice on, as the value it is.
+		*
+		* @param value - The choice.
+		*/
+		onChange: (value) => {
+			const chosen = props.options.find((option) => option.value === value);
+			if (chosen !== void 0) props.onChange(chosen.value);
+		}
+	});
+}
+/**
+* A value in a range.
+*
+* @param props - Its label, range, value and how it is written.
+* @returns The slider.
+*/
+function Slider(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Slider", "1.0"), props);
+}
+/**
+* A value by steps.
+*
+* @param props - Its label, range, step and how it is written.
+* @returns The stepper.
+*/
+function Stepper(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Stepper", "1.0"), props);
+}
+/**
+* A coloured tag.
+*
+* @param props - Its colour and text.
+* @returns The tag.
+*/
+function TagChip(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "TagChip", "1.0"), props);
+}
+/**
+* A dialog, drawn inside the package's scope.
+*
+* @param props - Whether it is open, its title, content and buttons.
+* @returns The dialog.
+*/
+function Modal(props) {
+	return createElement(hostMember(COMPONENTS_MODULE, "Modal", "1.0"), props);
+}
+/**
+* Joins class names, resolving Tailwind conflicts: the later class wins.
+*
+* @param classes - Classes, conditions, lists of them.
+* @returns The class names.
+*/
+function cn(...classes) {
+	return hostMember(COMPONENTS_MODULE, "cn", "1.0")(...classes);
+}
+//#endregion
+export { Badge, Button, CardHeading, Figure, Hint, Icon, IconButton, Modal, Panel, PanelNote, PanelRow, ProgressBar, Segmented, SelectField, Slider, StatusDot, Stepper, Switch, TagChip, TextField, cn };

package/dist/index.d.ts

@@ -0,0 +1,205 @@
+import { $ as PlaybackState, A as SecretOptions, B as field, C as ListField, D as NumberOptions, E as NumberField, F as TextOptions, G as CapabilityState, H as CapabilityCommands, I as TimestampField, J as CustomValue, K as CapabilityStates, L as TimestampOptions, M as ShownWhen, N as Simplify, O as OptionField, P as TextField, Q as LawnMowerActivity, R as ValueField, S as FormValues, T as NoFields, U as CapabilityName, V as CapabilityCommand, W as CapabilityParams, X as EntityStateClass, Y as DeclaredCapabilities, Z as ImageContentType, _ as ChoiceOption, a as SettingsOf, at as VacuumActivity, b as Field, c as CommandDeclaration, ct as EntityDomain, d as EntityTypeDefinition, dt as isEntityId, et as ReportedCapabilityState, f as ValuesOf, ft as parseEntityId, g as ChoiceField, h as BooleanOptions, i as SettingsDefinition, it as ThermostatMode, j as SettingField, k as SecretField, l as CommandDeclarations, lt as EntityId, m as BooleanField, n as JsonPrimitive, nt as SelectOption, o as defineSettings, ot as VacuumRoom, p as defineEntityType, q as CommandableCapability, r as JsonValue, rt as ThermostatAction, s as ArgsOf, st as ENTITY_DOMAINS, t as JsonObject, tt as ReportedStates, u as CommandsOf, ut as ParsedEntityId, v as ChoiceOptions, w as ListOptions, x as Fields, y as EntityValues, z as ValueOfField } from "./chunks/json.js";
+import { a as PageProps, c as CardSize, d as defineCard, i as PackageComponent, l as OptionsOf, n as EntityViewProps, o as CardDefinition, r as Loader, s as CardPadding, t as CardProps, u as SizeOf } from "./chunks/props.js";
+//#region src/definitions/containers.d.ts
+/**
+ * `defineContainer` and `defineCompose`: what a package runs beside or instead of its process
+ * (PACKAGES_DOCS.md 4.7, 4.8). The supervisor runs them on the platform's network, keeps them up,
+ * and removes them with the package.
+ */
+/** A value one of the package's settings gives: `{setup.webPort}`. */
+type SettingPlaceholder = `{setup.${string}}`;
+/** An entry kept only while one of the settings holds one of the values. */
+type When = {
+  readonly key: string;
+  readonly equals: readonly (string | boolean)[];
+};
+/** A port: a number, or one of the settings. */
+type ContainerPort = number | SettingPlaceholder;
+/** How far a container must have come before one that depends on it starts. */
+type ContainerCondition = 'started' | 'healthy';
+/** A container, as declared. */
+type ContainerDefinition<TId extends string = string> = {
+  readonly kind: 'container';
+  /** Names the container and its folder: `^[a-z][a-z0-9-]{1,31}$`. */
+  readonly id: TId;
+  readonly name: string;
+  /** The image, without a tag: `koenkk/zigbee2mqtt`, `ghcr.io/owner/app`. */
+  readonly image: string;
+  /** The oldest release it works with: the newest of that major is installed. */
+  readonly minVersion: string;
+  /** Paths inside the container; where they live is the platform's, in its data directory. */
+  readonly volumes?: readonly {
+    readonly name: string;
+    readonly path: string;
+    /** Left out of backups: what can be made again. */
+    readonly isCache?: boolean;
+  }[];
+  /** Its environment; `{setup.x}` and `{platform.…}` are filled in. */
+  readonly env?: Readonly<Record<string, string | {
+    readonly value: string;
+    readonly when: When;
+  }>>;
+  /** Devices of the host it is given, under `/dev`. */
+  readonly devices?: readonly {
+    readonly host: string;
+    readonly container: string;
+    readonly when?: When;
+  }[];
+  /** Ports published when the platform is on a bridge network. */
+  readonly ports?: readonly {
+    readonly container: ContainerPort;
+    readonly host: ContainerPort;
+    readonly protocol?: 'tcp' | 'udp';
+    readonly when?: When;
+  }[];
+  /** Files written into a volume once, when missing. */
+  readonly seed?: readonly {
+    readonly volume: string;
+    readonly path: string;
+    readonly content: string;
+  }[];
+  /** The topics it uses on the house's broker, which a username of its own is held to. */
+  readonly mqttTopics?: readonly string[];
+  /** The port of its own web page, which the interface links to. */
+  readonly webPort?: ContainerPort;
+  readonly webPortWhen?: When;
+  /** The command, instead of the image's: each argument on its own. */
+  readonly command?: readonly string[];
+  /** How the platform knows it is ready: `test` is `CMD …` or `CMD-SHELL …`. */
+  readonly healthcheck?: {
+    readonly test: readonly string[];
+    readonly intervalMs?: number;
+    readonly timeoutMs?: number;
+    readonly retries?: number;
+    readonly startPeriodMs?: number;
+  };
+  /** Containers of the same package it starts after, and how far each must have come. */
+  readonly dependsOn?: Readonly<Record<string, ContainerCondition>>;
+};
+/** A compose file, as declared. */
+type ComposeDefinition = {
+  readonly kind: 'compose';
+  /** The file, next to the config: `./compose.yaml`. */
+  readonly file: string;
+};
+/**
+ * Declares a container the package runs.
+ *
+ * @param container - Its image, release, volumes, environment and the rest.
+ * @returns The container, for `definePackage`'s `containers`.
+ */
+export declare function defineContainer<const TId extends string>(container: Omit<ContainerDefinition<TId>, 'kind'>): ContainerDefinition<TId>;
+/**
+ * Declares a compose file the package runs instead of declared containers.
+ *
+ * @param compose - Where the file is.
+ * @returns The compose file, for `definePackage`'s `compose`.
+ */
+export declare function defineCompose(compose: Omit<ComposeDefinition, 'kind'>): ComposeDefinition;
+//#endregion
+//#region src/definitions/bound-props.d.ts
+/** The props of the component of the card with this id. */
+type CardPropsFor<TCards extends readonly CardDefinition[], TId extends string> = CardProps<Extract<TCards[number], {
+  readonly id: TId;
+}>>;
+/** The props of the view of the entity type with this id. */
+type EntityViewPropsFor<TTypes extends readonly EntityTypeDefinition[], TId extends string> = EntityViewProps<Extract<TTypes[number], {
+  readonly id: TId;
+}>>;
+//#endregion
+//#region src/definitions/page.d.ts
+/** An entry of the page in the interface's sidebar. */
+type SidebarEntry = {
+  /** What it says; the package's name when not given. At most 32 characters. */
+  readonly label?: string;
+  /** A catalogue icon id; the package's logo when not given. */
+  readonly icon?: string;
+};
+/** The package's page, as declared. */
+type PageDefinition = {
+  readonly kind: 'page';
+  readonly component: Loader<PageProps>;
+  readonly sidebar?: SidebarEntry;
+};
+/**
+ * Declares the package's page. A package has at most one: `ui.page` is a single field.
+ *
+ * @param page - Its component's loader, and its sidebar entry if any.
+ * @returns The page, for `definePackage`'s `ui.page`.
+ */
+export declare function definePage(page: Omit<PageDefinition, 'kind'>): PageDefinition;
+//#endregion
+//#region src/definitions/package.d.ts
+/** What the store files a package under. */
+type PackageCategory = 'protocol' | 'media' | 'security' | 'energy' | 'climate' | 'visualisation' | 'automation' | 'other';
+/** What a package needs besides itself. */
+type PackageRequires = {
+  /** The platform, by npm range. */
+  readonly platform?: string;
+  /** Packages, by id and range. */
+  readonly packages?: Readonly<Record<string, string>>;
+  /** Services, by name, whoever provides them. */
+  readonly services?: readonly string[];
+};
+/** The components a package draws, bound to what it declares. */
+type PackageUi<TCards extends readonly CardDefinition[], TTypes extends readonly EntityTypeDefinition[]> = {
+  /** Its own page. */
+  readonly page?: PageDefinition;
+  /** A component for every declared card, by its id. */
+  readonly cards?: { readonly [TId in TCards[number]['id']]: Loader<CardPropsFor<TCards, TId>>; };
+  /** Views of the entity types it draws itself, by their ids. */
+  readonly entityViews?: { readonly [TId in TTypes[number]['id']]?: Loader<EntityViewPropsFor<TTypes, TId>>; };
+};
+/** What every package says, whatever it runs. */
+type PackageBase<TCards extends readonly CardDefinition[], TTypes extends readonly EntityTypeDefinition[]> = {
+  /** `^[a-z][a-z0-9-]{1,63}$`, not one of the platform's names. */
+  readonly id: string;
+  readonly name: string;
+  readonly description: string;
+  readonly category: PackageCategory;
+  /** The NebulaHome versions it works with, as an npm range: `^1.4.0`. */
+  readonly platform: string;
+  /** Its colour in the store, `#RRGGBB`. */
+  readonly color?: `#${string}`;
+  /** A file next to the config: `./logo.svg`. */
+  readonly logo?: string | {
+    readonly path: string;
+    readonly padding?: number;
+  };
+  readonly url?: string;
+  /** `owner/name` on GitHub; read from `package.json` when not given. */
+  readonly repository?: string;
+  /** The server's entry module, next to the config: `./src/server/index.ts`. */
+  readonly server?: string;
+  readonly settings?: SettingsDefinition;
+  readonly cards?: TCards;
+  readonly entityTypes?: TTypes;
+  readonly requires?: PackageRequires;
+  readonly provides?: readonly string[];
+  readonly ui?: PackageUi<TCards, TTypes>;
+};
+/** What `definePackage` takes: declared containers, or a compose file, or neither. */
+type PackageConfig<TCards extends readonly CardDefinition[] = readonly CardDefinition[], TTypes extends readonly EntityTypeDefinition[] = readonly EntityTypeDefinition[]> = PackageBase<TCards, TTypes> & ({
+  readonly containers?: readonly ContainerDefinition[];
+  readonly compose?: never;
+} | {
+  readonly compose: ComposeDefinition;
+  readonly containers?: never;
+});
+/** A package, as declared. */
+type PackageDefinition<TCards extends readonly CardDefinition[] = readonly CardDefinition[], TTypes extends readonly EntityTypeDefinition[] = readonly EntityTypeDefinition[]> = PackageConfig<TCards, TTypes> & {
+  readonly kind: 'package';
+};
+/**
+ * Declares the package: `nebula.config.ts`'s default export.
+ *
+ * @param config - What it is, what it declares, and the components it draws.
+ * @returns The package, which the build writes the manifest from.
+ */
+export declare function definePackage<const TCards extends readonly CardDefinition[] = readonly [], const TTypes extends readonly EntityTypeDefinition[] = readonly []>(config: PackageConfig<TCards, TTypes>): PackageDefinition<TCards, TTypes>;
+//#endregion
+//#region src/version.d.ts
+/** The SDK's own version, `1.0.0`. */
+export declare const SDK_VERSION: string;
+//#endregion
+export { type ArgsOf, type BooleanField, type BooleanOptions, type CapabilityCommand, type CapabilityCommands, type CapabilityName, type CapabilityParams, type CapabilityState, type CapabilityStates, type CardDefinition, type CardPadding, type CardProps, type CardSize, type ChoiceField, type ChoiceOption, type ChoiceOptions, type CommandDeclaration, type CommandDeclarations, type CommandableCapability, type CommandsOf, type ComposeDefinition, type ContainerCondition, type ContainerDefinition, type ContainerPort, type CustomValue, type DeclaredCapabilities, ENTITY_DOMAINS, type EntityDomain, type EntityId, type EntityStateClass, type EntityTypeDefinition, type EntityValues, type EntityViewProps, type Field, type Fields, type FormValues, type ImageContentType, type JsonObject, type JsonPrimitive, type JsonValue, type LawnMowerActivity, type ListField, type ListOptions, type Loader, type NoFields, type NumberField, type NumberOptions, type OptionField, type OptionsOf, type PackageCategory, type PackageComponent, type PackageConfig, type PackageDefinition, type PackageRequires, type PackageUi, type PageDefinition, type PageProps, type ParsedEntityId, type PlaybackState, type ReportedCapabilityState, type ReportedStates, type SecretField, type SecretOptions, type SelectOption, type SettingField, type SettingPlaceholder, type SettingsDefinition, type SettingsOf, type ShownWhen, type SidebarEntry, type Simplify, type SizeOf, type TextField, type TextOptions, type ThermostatAction, type ThermostatMode, type TimestampField, type TimestampOptions, type VacuumActivity, type VacuumRoom, type ValueField, type ValueOfField, type ValuesOf, type When, defineCard, defineEntityType, defineSettings, field, isEntityId, parseEntityId };

package/dist/index.js

@@ -0,0 +1,243 @@
+import { t as SDK_VERSION } from "./chunks/version.js";
+//#region src/definitions/card.ts
+/**
+* Declares a card.
+*
+* @param card - Its id, name, icon, sizes and options.
+* @returns The card, for `definePackage`'s `cards` and for its component's props.
+*/
+/* @__NO_SIDE_EFFECTS__ */
+function defineCard(card) {
+	return {
+		...card,
+		kind: "card"
+	};
+}
+//#endregion
+//#region src/definitions/containers.ts
+/**
+* Declares a container the package runs.
+*
+* @param container - Its image, release, volumes, environment and the rest.
+* @returns The container, for `definePackage`'s `containers`.
+*/
+/* @__NO_SIDE_EFFECTS__ */
+function defineContainer(container) {
+	return {
+		...container,
+		kind: "container"
+	};
+}
+/**
+* Declares a compose file the package runs instead of declared containers.
+*
+* @param compose - Where the file is.
+* @returns The compose file, for `definePackage`'s `compose`.
+*/
+/* @__NO_SIDE_EFFECTS__ */
+function defineCompose(compose) {
+	return {
+		...compose,
+		kind: "compose"
+	};
+}
+//#endregion
+//#region src/definitions/entity-type.ts
+/**
+* Declares an entity type.
+*
+* @param type - Its id, name, icon, state and commands.
+* @returns The type, for `definePackage`'s `entityTypes`, the server's `ctx.custom` and its view.
+*/
+/* @__NO_SIDE_EFFECTS__ */
+function defineEntityType(type) {
+	return {
+		...type,
+		kind: "entityType"
+	};
+}
+//#endregion
+//#region src/definitions/package.ts
+/**
+* Declares the package: `nebula.config.ts`'s default export.
+*
+* @param config - What it is, what it declares, and the components it draws.
+* @returns The package, which the build writes the manifest from.
+*/
+/* @__NO_SIDE_EFFECTS__ */
+function definePackage(config) {
+	return {
+		...config,
+		kind: "package"
+	};
+}
+//#endregion
+//#region src/definitions/page.ts
+/**
+* Declares the package's page. A package has at most one: `ui.page` is a single field.
+*
+* @param page - Its component's loader, and its sidebar entry if any.
+* @returns The page, for `definePackage`'s `ui.page`.
+*/
+/* @__NO_SIDE_EFFECTS__ */
+function definePage(page) {
+	return {
+		...page,
+		kind: "page"
+	};
+}
+//#endregion
+//#region src/definitions/settings.ts
+/**
+* Declares a package's settings, at most 32 fields, by their keys.
+*
+* @param fields - The fields, built with `field`.
+* @returns The settings, for `definePackage` and for the types of `ctx.settings`.
+*/
+/* @__NO_SIDE_EFFECTS__ */
+function defineSettings(fields) {
+	return {
+		kind: "settings",
+		fields
+	};
+}
+//#endregion
+//#region src/entities.ts
+/**
+* Entity identifiers: `<domain>.<object id>`, as the platform writes them everywhere - in its
+* API, on its bus, in automations. A package never composes one by hand: the server's
+* `ctx.entityId` does, and these read one back.
+*/
+/** The kinds of thing an entity is. */
+const ENTITY_DOMAINS = [
+	"light",
+	"switch",
+	"sensor",
+	"binary_sensor",
+	"cover",
+	"lock",
+	"climate",
+	"media_player",
+	"camera",
+	"button",
+	"update",
+	"lawn_mower",
+	"select",
+	"number",
+	"vacuum",
+	"image",
+	"custom",
+	"alias"
+];
+/** The shape of an entity identifier: a domain, a dot, an object id. */
+const ENTITY_ID_PATTERN = /^([a-z][a-z0-9_]{0,31})\.([a-z][a-z0-9_]{0,63})$/;
+/**
+* Says whether a word is one of the platform's domains.
+*
+* @param value - The word.
+* @returns True when it is.
+*/
+function isDomain(value) {
+	return ENTITY_DOMAINS.some((domain) => domain === value);
+}
+/**
+* Reads an entity identifier.
+*
+* @param entityId - The identifier.
+* @returns Its domain and object id, or undefined when it is not one.
+*/
+function parseEntityId(entityId) {
+	const match = ENTITY_ID_PATTERN.exec(entityId);
+	const domain = match?.[1];
+	const objectId = match?.[2];
+	return domain === void 0 || objectId === void 0 || !isDomain(domain) ? void 0 : {
+		domain,
+		objectId
+	};
+}
+/**
+* Says whether a value is an entity identifier.
+*
+* @param value - The value.
+* @returns True when it is a string the platform would take as one.
+*/
+function isEntityId(value) {
+	return typeof value === "string" && parseEntityId(value) !== void 0;
+}
+//#endregion
+//#region src/fields.ts
+/** The field builders. */
+const field = {
+	/**
+	* A text: free, or held to a length and a pattern.
+	*
+	* @param options - Its label and limits.
+	* @returns The field.
+	*/
+	text: (options) => ({
+		...options,
+		kind: "text"
+	}),
+	/**
+	* A secret: stored sealed, handed to the process open, never sent to a browser.
+	*
+	* @param options - Its label and limits.
+	* @returns The field.
+	*/
+	secret: (options) => ({
+		...options,
+		kind: "secret"
+	}),
+	/**
+	* A number, optionally whole and within a range.
+	*
+	* @param options - Its label, range and unit.
+	* @returns The field.
+	*/
+	number: (options) => ({
+		...options,
+		kind: "number"
+	}),
+	/**
+	* On or off.
+	*
+	* @param options - Its label.
+	* @returns The field.
+	*/
+	boolean: (options) => ({
+		...options,
+		kind: "boolean"
+	}),
+	/**
+	* One of a fixed list.
+	*
+	* @param options - Its label and its choices, 1 to 64.
+	* @returns The field.
+	*/
+	choice: (options) => ({
+		...options,
+		kind: "choice"
+	}),
+	/**
+	* Several texts - addresses, topics - each held to the same pattern.
+	*
+	* @param options - Its label and limits.
+	* @returns The field.
+	*/
+	list: (options) => ({
+		...options,
+		kind: "list"
+	}),
+	/**
+	* An instant, as ISO 8601 text: an entity's state or a command's argument, never a form's.
+	*
+	* @param options - Its label.
+	* @returns The field.
+	*/
+	timestamp: (options) => ({
+		...options,
+		kind: "timestamp"
+	})
+};
+//#endregion
+export { ENTITY_DOMAINS, SDK_VERSION, defineCard, defineCompose, defineContainer, defineEntityType, definePackage, definePage, defineSettings, field, isEntityId, parseEntityId };

package/dist/server.d.ts

@@ -0,0 +1,30 @@
+import { i as SettingsDefinition } from "./chunks/json.js";
+import { A as StandardSchemaV1, C as StateChange, D as Schema, E as SafeParser, O as SchemaIssue, S as SettingsChange, T as Unsubscribe, _ as ServerContext, a as CustomEntityInput, b as ServiceCallFunction, c as EntityInput, d as Logger, f as ReportOptions, g as RpcMethod, h as RpcCaller, i as CustomEntities, k as StandardResult, l as EntitySnapshot, m as RpcCall, n as CapabilityEntityInput, o as DeviceInput, p as RpcAccess, r as CustomCommand, s as EntityFilter, t as Awaitable, u as LogMethod, v as ServerSettings, w as SyncResult, x as ServiceProvide, y as ServiceCall } from "./chunks/context.js";
+//#region src/server/index.d.ts
+/** What stops what `start` opened. */
+export type Stop = () => Awaitable<void>;
+/** What a server is: what it starts with, and the settings it reads. */
+export type ServerDefinition<TSettings extends SettingsDefinition | undefined = undefined> = {
+  /** Says to the runner what this is. */
+  readonly kind: 'nebula.server';
+  /** The SDK version it was built with: the runner refuses a newer major than its own. */
+  readonly sdk: string;
+  /** The package's settings, for the types of `ctx.settings`. */
+  readonly settings?: TSettings;
+  /**
+   * Starts the package: registers its devices, methods and services, and opens what it runs.
+   *
+   * @param ctx - What the platform hands it.
+   * @returns What stops it, when there is anything to stop.
+   */
+  readonly start: (ctx: ServerContext<TSettings>) => Awaitable<Stop | undefined>;
+};
+/**
+ * Declares a package's server: the default export of its entry module.
+ *
+ * @param server - Its settings, if it reads them, and its `start`.
+ * @returns The server, stamped with the SDK version it was built with.
+ */
+export declare function defineServer<TSettings extends SettingsDefinition | undefined = undefined>(server: Omit<ServerDefinition<TSettings>, 'kind' | 'sdk'>): ServerDefinition<TSettings>;
+//#endregion
+export type { Awaitable, CapabilityEntityInput, CustomCommand, CustomEntities, CustomEntityInput, DeviceInput, EntityFilter, EntityInput, EntitySnapshot, LogMethod, Logger, ReportOptions, RpcAccess, RpcCall, RpcCaller, RpcMethod, SafeParser, Schema, SchemaIssue, ServerContext, ServerSettings, ServiceCall, ServiceCallFunction, ServiceProvide, SettingsChange, StandardResult, StandardSchemaV1, StateChange, SyncResult, Unsubscribe };