@aldi/ralma 1.0.0

package/types/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * A Ractive component definition as accepted by `Ractive.extend()`.
+ *
+ * @typedef {object} RalmaComponentDefinition
+ * @property {string} template
+ * @property {boolean} [isolated]
+ * @property {() => Record<string, unknown>} [data]
+ * @property {() => void} [oninit]
+ * @property {Record<string, () => unknown>} [computed]
+ */
+export type RalmaComponentDefinition = {
+    template: string;
+    isolated?: boolean;
+    data?: () => Record<string, unknown>;
+    oninit?: () => void;
+    computed?: Record<string, () => unknown>;
+};
+export type RactiveLike = {
+    extend: (definition: RalmaComponentDefinition) => unknown;
+    components: Record<string | symbol, unknown>;
+};
+export type RactiveInstance = {
+    get: (keypath: string) => any;
+    set: (keypath: string, value: unknown) => unknown;
+    observe: (keypath: string, handler: (value: any) => void, options?: {
+        init?: boolean;
+    }) => unknown;
+};
+/**
+ * Component names whose `href` runs through {@link sanitizeHref}. A component that renders
+ * an `href` and is missing from this set skips sanitizing entirely.
+ */
+export declare const hrefAwareComponentNames: Set<string>;
+export declare const componentNames: readonly string[];
+/**
+ * Registers Ralma components onto a Ractive constructor.
+ *
+ * @param {unknown} ractive - The `Ractive` constructor (global or imported).
+ * @param {{overwrite?: boolean, warnOnCollision?: boolean}} [options]
+ *  - `overwrite`: overwrite already-registered component names.
+ *  - `warnOnCollision`: emit console warnings when a name is skipped.
+ * @returns {unknown} The same `Ractive` reference.
+ */
+export declare function registerRalma(ractive: unknown, options?: {
+    overwrite?: boolean;
+    warnOnCollision?: boolean;
+}): unknown;