@mhmo91/schmancy 0.9.6 → 0.9.8

package/mixins/discovery.service.ts

@@ -1,221 +0,0 @@
-import { fromEvent, timer, race, Observable } from 'rxjs'
-import { takeUntil, map, defaultIfEmpty, take } from 'rxjs/operators'
-
-/**
- * Global discovery event names
- */
-const DISCOVER_EVENT = 'schmancy-discover'
-const DISCOVER_RESPONSE_EVENT = 'schmancy-discover-response'
-
-/**
- * Discovery request detail
- */
-interface DiscoverRequest {
-	selector: string
-	requestId: string
-}
-
-/**
- * Discovery response detail
- */
-interface DiscoverResponse {
-	requestId: string
-	element: HTMLElement
-}
-
-/**
- * Discover a component in the DOM using the WhereAreYou/HereIAm pattern.
- *
- * @param componentTag - The tag name of the component to discover (e.g., 'schmancy-navigation-rail')
- * @param timeout - How long to wait for a response in milliseconds (default: 100)
- * @returns Observable that emits the discovered component or null if not found
- */
-export function discoverComponent<T extends HTMLElement>(
-	componentTag: string,
-	timeout = 100,
-): Observable<T | null> {
-	const whereAreYouEvent = `${componentTag}-where-are-you`
-	const hereIAmEvent = `${componentTag}-here-i-am`
-
-	return new Observable(subscriber => {
-		// Listen for response first (you were right!)
-		const subscription = fromEvent<CustomEvent>(window, hereIAmEvent)
-			.pipe(
-				takeUntil(timer(timeout)),
-				map(e => e.detail.component as T),
-				defaultIfEmpty(null),
-			)
-			.subscribe(component => {
-				subscriber.next(component)
-				subscriber.complete()
-			})
-
-		// Then dispatch discovery request
-		window.dispatchEvent(
-			new CustomEvent(whereAreYouEvent, {
-				bubbles: true,
-				composed: true,
-			}),
-		)
-
-		// Return cleanup function
-		return () => subscription.unsubscribe()
-	})
-}
-
-/**
- * Discover any of multiple components using race.
- * Returns the first component that responds.
- *
- * @param componentTags - Array of component tag names to discover
- * @returns Observable that emits the first discovered component or null if none found
- */
-export function discoverAnyComponent<T extends HTMLElement>(...componentTags: string[]): Observable<T | null> {
-	if (componentTags.length === 0) {
-		return new Observable(subscriber => {
-			subscriber.next(null)
-			subscriber.complete()
-		})
-	}
-
-	return race(...componentTags.map(tag => discoverComponent<T>(tag)))
-}
-
-/**
- * Universal element discovery - finds ANY element by CSS selector across shadow DOM boundaries.
- * Uses event-based discovery pattern - no DOM traversal needed.
- *
- * How it works:
- * 1. Broadcasts a discovery request event on window
- * 2. All $LitElement components receive this event and check their shadow DOM
- * 3. If a match is found, they respond with the element
- *
- * @param selector - CSS selector (e.g., '#my-id', '.my-class', '[data-attr]')
- * @param timeout - How long to wait for a response in milliseconds (default: 150)
- * @returns Observable that emits the discovered element or null if not found
- *
- * @example
- * ```typescript
- * // Find element by ID across shadow boundaries
- * discoverElement('#app-card').subscribe(el => {
- *   if (el) console.log('Found:', el)
- * })
- *
- * // Find element by class
- * discoverElement('.special-button').subscribe(el => {...})
- * ```
- */
-export function discoverElement<T extends HTMLElement>(
-	selector: string,
-	timeout = 150,
-): Observable<T | null> {
-	const requestId = `discover-${Date.now()}-${Math.random().toString(36).slice(2)}`
-
-	return new Observable(subscriber => {
-		// Listen for response first
-		const subscription = fromEvent<CustomEvent<DiscoverResponse>>(window, DISCOVER_RESPONSE_EVENT)
-			.pipe(
-				takeUntil(timer(timeout)),
-				map(e => e.detail),
-				// Filter for our specific request
-				map(detail => (detail.requestId === requestId ? (detail.element as T) : null)),
-				// Only take the first non-null response
-				take(1),
-				defaultIfEmpty(null),
-			)
-			.subscribe(element => {
-				subscriber.next(element)
-				subscriber.complete()
-			})
-
-		// Broadcast discovery request
-		window.dispatchEvent(
-			new CustomEvent<DiscoverRequest>(DISCOVER_EVENT, {
-				detail: { selector, requestId },
-				bubbles: true,
-				composed: true,
-			}),
-		)
-
-		return () => subscription.unsubscribe()
-	})
-}
-
-/**
- * Discover multiple elements matching a selector.
- * Collects all responses within the timeout period.
- *
- * @param selector - CSS selector
- * @param timeout - How long to collect responses (default: 150ms)
- * @returns Observable that emits array of discovered elements
- */
-export function discoverAllElements<T extends HTMLElement>(
-	selector: string,
-	timeout = 150,
-): Observable<T[]> {
-	const requestId = `discover-all-${Date.now()}-${Math.random().toString(36).slice(2)}`
-	const elements: T[] = []
-
-	return new Observable(subscriber => {
-		// Collect all responses
-		const subscription = fromEvent<CustomEvent<DiscoverResponse>>(window, DISCOVER_RESPONSE_EVENT)
-			.pipe(takeUntil(timer(timeout)))
-			.subscribe({
-				next: e => {
-					if (e.detail.requestId === requestId) {
-						elements.push(e.detail.element as T)
-					}
-				},
-				complete: () => {
-					subscriber.next(elements)
-					subscriber.complete()
-				},
-			})
-
-		// Broadcast discovery request
-		window.dispatchEvent(
-			new CustomEvent<DiscoverRequest>(DISCOVER_EVENT, {
-				detail: { selector, requestId },
-				bubbles: true,
-				composed: true,
-			}),
-		)
-
-		return () => subscription.unsubscribe()
-	})
-}
-
-/**
- * Smart discovery - automatically detects if input is a CSS selector or component tag.
- *
- * @param query - CSS selector (starts with #, ., [) OR component tag name
- * @param timeout - How long to wait (default: 150ms)
- * @returns Observable that emits the discovered element or null
- *
- * @example
- * ```typescript
- * // CSS selector - uses discoverElement
- * discover('#my-element').subscribe(...)
- *
- * // Component tag - uses discoverComponent
- * discover('schmancy-fancy').subscribe(...)
- * ```
- */
-export function discover<T extends HTMLElement>(
-	query: string,
-	timeout = 150,
-): Observable<T | null> {
-	// Check if it's a CSS selector (starts with #, ., or [)
-	const isCssSelector = /^[#.\[]/.test(query)
-
-	if (isCssSelector) {
-		return discoverElement<T>(query, timeout)
-	}
-
-	// Otherwise treat as component tag name
-	return discoverComponent<T>(query, timeout)
-}
-
-// Export event names for use in baseElement
-export { DISCOVER_EVENT, DISCOVER_RESPONSE_EVENT }
-export type { DiscoverRequest, DiscoverResponse }

package/mixins/formField.mixin.ts

@@ -1,255 +0,0 @@
-import { CSSResult, LitElement, PropertyValueMap } from 'lit'
-import { property } from 'lit/decorators.js'
-import { IBaseMixin } from './baseElement'
-import { Constructor } from './constructor'
-import { ITailwindElementMixin, TailwindElement } from './tailwind.mixin'
-
-/**
- * Cross-realm brand used by `<schmancy-form>` to discover form fields by
- * inheritance rather than tag-name allowlists. `Symbol.for` puts the symbol in
- * the global registry so detection works across module realms/bundles.
- */
-export const SCHMANCY_FORM_FIELD = Symbol.for('schmancy.form-field')
-
-/**
- * Interface defining the properties and methods that the FormFieldMixin adds.
- */
-export interface IFormFieldMixin extends Element {
-	name: string
-	value: string | string[] | boolean | number | undefined
-	label: string
-	required: boolean
-	disabled: boolean
-	readonly: boolean
-	error: boolean
-	validationMessage: string
-	hint?: string
-	id: string
-
-	form: HTMLFormElement | null
-
-	checkValidity(): boolean
-	reportValidity(): boolean
-	setCustomValidity(message: string): void
-
-	toFormEntries(): Array<[string, FormDataEntryValue]>
-	resetForm(): void
-
-	emitChange(detail: any): void
-}
-
-/** Predicate used by `<schmancy-form>` to detect mixin descendants. */
-export function isSchmancyFormField(el: unknown): el is IFormFieldMixin {
-	return !!el && typeof el === 'object' && (el as any).constructor?.[SCHMANCY_FORM_FIELD] === true
-}
-
-/**
- * A mixin that adds form field capabilities to a LitElement class.
- * Components that extend this mixin are automatically discovered and
- * collected by `<schmancy-form>` — no tag-name registration needed.
- *
- * Subclasses may override `toFormEntries()` to contribute multiple
- * name/value pairs to FormData (e.g. date-range, tag-input).
- *
- * @example
- * ```ts
- * class MyInput extends FormFieldMixin(TailwindElement(css`...`)) {
- *   // Your component code here
- * }
- * ```
- */
-export function FormFieldMixin<T extends Constructor<LitElement>>(superClass: T) {
-	class FormFieldMixinClass extends superClass {
-		static formAssociated = true
-
-		/** Brand for cross-realm detection by `<schmancy-form>`. */
-		static readonly [SCHMANCY_FORM_FIELD] = true
-
-		// Element internals for form association
-		internals: ElementInternals | undefined
-
-		/** Value snapshot captured at first render, used by `resetForm()`. */
-		protected _defaultValue: string | string[] | boolean | number | undefined = undefined
-
-		@property({ type: String })
-		name: string = ''
-
-		@property({ reflect: true })
-		value: string | string[] | boolean | number | undefined = ''
-
-		@property({ type: String })
-		label: string = ''
-
-		@property({ type: Boolean, reflect: true })
-		required: boolean = false
-
-		@property({ type: Boolean, reflect: true })
-		disabled: boolean = false
-
-		@property({ type: Boolean, reflect: true })
-		readonly: boolean = false
-
-		@property({ type: Boolean, reflect: true })
-		error: boolean = false
-
-		@property({ type: String })
-		validationMessage: string = ''
-
-		@property({ type: String })
-		hint?: string
-
-		@property({ reflect: true })
-		override id: string = `schmancy-field-${Date.now()}-${Math.floor(Math.random() * 1000)}`
-
-		constructor(...args: any[]) {
-			super(...args)
-			try {
-				this.internals = this.attachInternals()
-			} catch {
-				this.internals = undefined
-			}
-		}
-
-		/** The form this element is associated with (native FACE behavior). */
-		get form(): HTMLFormElement | null {
-			return this.internals?.form ?? null
-		}
-
-		protected firstUpdated(changedProps: PropertyValueMap<any>): void {
-			super.firstUpdated?.(changedProps)
-			if (this._defaultValue === undefined) this._defaultValue = this.value
-		}
-
-		protected willUpdate(changedProps: PropertyValueMap<any>): void {
-			super.willUpdate(changedProps)
-
-			if (changedProps.has('value')) {
-				this.internals?.setFormValue(this.value as string | File | FormData | null)
-			}
-
-			if (changedProps.has('error') || changedProps.has('validationMessage')) {
-				if (this.error && this.validationMessage) {
-					this.internals?.setValidity({ customError: true }, this.validationMessage)
-				} else {
-					this.internals?.setValidity({})
-				}
-			}
-
-			// Broadcast standard field states for consumer CSS: :state(invalid),
-			// :state(required), :state(disabled), :state(readonly).
-			if (changedProps.has('error')) {
-				if (this.error) this.internals?.states.add('invalid')
-				else this.internals?.states.delete('invalid')
-			}
-			if (changedProps.has('required')) {
-				if (this.required) this.internals?.states.add('required')
-				else this.internals?.states.delete('required')
-			}
-			if (changedProps.has('disabled')) {
-				if (this.disabled) this.internals?.states.add('disabled')
-				else this.internals?.states.delete('disabled')
-			}
-			if (changedProps.has('readonly')) {
-				if (this.readonly) this.internals?.states.add('readonly')
-				else this.internals?.states.delete('readonly')
-			}
-		}
-
-		/**
-		 * Native FACE lifecycle — called by the browser when the owning form
-		 * is reset. Delegates to `resetForm()` so subclasses have one
-		 * override point for both programmatic and user-initiated resets.
-		 */
-		formResetCallback(): void {
-			this.resetForm()
-		}
-
-		/** Native FACE lifecycle — called when the form's disabled state changes. */
-		formDisabledCallback(disabled: boolean): void {
-			this.disabled = disabled
-		}
-
-		/**
-		 * Native FACE lifecycle — restore value after bfcache / form autofill.
-		 */
-		formStateRestoreCallback(state: string | File | FormData | null): void {
-			if (state == null) return
-			this.value = state as any
-		}
-
-		/** Override to customize reset behavior; default restores `_defaultValue`. */
-		resetForm(): void {
-			this.value = this._defaultValue ?? ''
-			this.error = false
-			this.validationMessage = ''
-			this.internals?.setValidity({})
-		}
-
-		/**
-		 * Contribute entries to a parent FormData. Default: a single
-		 * `[name, value]` pair when `name` is set and value is meaningful.
-		 * Override for multi-entry controls (e.g. date range).
-		 */
-		toFormEntries(): Array<[string, FormDataEntryValue]> {
-			if (!this.name || this.disabled) return []
-			const v = this.value
-			if (v === undefined || v === null || v === '') return []
-			if (Array.isArray(v)) return v.map(item => [this.name, String(item)] as [string, FormDataEntryValue])
-			if (typeof v === 'boolean') return v ? [[this.name, 'on']] : []
-			return [[this.name, String(v)]]
-		}
-
-		checkValidity(): boolean {
-			if (this.disabled) return true
-			if (this.required && (this.value === '' || this.value === undefined || this.value === null)) {
-				this.error = true
-				this.validationMessage = 'This field is required'
-				return false
-			}
-			return this.internals?.checkValidity() ?? true
-		}
-
-		reportValidity(): boolean {
-			const isValid = this.checkValidity()
-			if (!isValid) this.internals?.reportValidity()
-			return isValid
-		}
-
-		setCustomValidity(message: string): void {
-			this.validationMessage = message
-			this.error = message !== ''
-			if (message) {
-				this.internals?.setValidity({ customError: true }, message)
-			} else {
-				this.internals?.setValidity({})
-			}
-		}
-
-		emitChange(detail: any): void {
-			if ('dispatchScopedEvent' in this && typeof this.dispatchScopedEvent === 'function') {
-				this.dispatchScopedEvent('change', detail, { bubbles: true })
-			} else {
-				this.dispatchEvent(
-					new CustomEvent('change', {
-						detail,
-						bubbles: true,
-						composed: true,
-					}),
-				)
-			}
-		}
-	}
-
-	return FormFieldMixinClass as Constructor<IFormFieldMixin> & T
-}
-
-/**
- * A convenience function that composes FormFieldMixin with TailwindElement
- * to create a base class for Schmancy form components.
- */
-export function SchmancyFormField<T extends CSSResult>(componentStyle?: T) {
-	return FormFieldMixin(TailwindElement(componentStyle)) as Constructor<IFormFieldMixin> &
-		Constructor<ITailwindElementMixin> &
-		Constructor<LitElement> &
-		Constructor<IBaseMixin>
-}

package/mixins/index.ts

@@ -1,7 +0,0 @@
-export * from './baseElement';
-export * from './constructor';
-export * from './discovery.service';
-export * from './formField.mixin';
-export * from './litElement.mixin';
-export * from './surface.mixin';
-export * from './tailwind.mixin';

package/mixins/litElement.mixin.ts

@@ -1,15 +0,0 @@
-import { CSSResult, LitElement } from 'lit'
-import { TailwindElement } from './tailwind.mixin'
-import { BaseElement, IBaseMixin } from './baseElement'
-import { Constructor } from './constructor'
-
-export const $LitElement = <T extends CSSResult>(componentStyle?: T) => {
-	class TailwindMixinClass extends BaseElement(TailwindElement(componentStyle)) {
-		disconnectedCallback = () => {
-			super.disconnectedCallback()
-		}
-	}
-	return TailwindMixinClass as CustomElementConstructor &
-		Constructor<LitElement> &
-		Constructor<IBaseMixin> /* see "typing the subclass" below */
-}

package/mixins/scss.d.ts

@@ -1,21 +0,0 @@
-declare module '*.scss?inline' {
-	import { type CSSResult } from 'lit'
-	const styles: CSSResult
-	export default styles
-}
-
-declare module '*.module.scss' {
-	const classes: Record<string, string>
-	export default classes
-}
-
-declare module '*.css?inline' {
-	import { type CSSResult } from 'lit'
-	const styles: CSSResult
-	export default styles
-}
-
-declare module '*.module.css' {
-	const classes: Record<string, string>
-	export default classes
-}

package/mixins/surface.mixin.ts

@@ -1,93 +0,0 @@
-import type { Constructor } from './constructor'
-import { CSSResultGroup, CSSResultOrNative, LitElement } from 'lit'
-import { property } from 'lit/decorators.js'
-import type { TSurfaceColor } from '../src/types/surface'
-import { surfaceStyles } from '../src/surface/surface.styles'
-
-export type SchmancySurfaceFill = 'all' | 'width' | 'height' | 'auto'
-export type SchmancySurfaceRounded = 'none' | 'top' | 'left' | 'right' | 'bottom' | 'all'
-export type SchmancySurfaceElevation = 0 | 1 | 2 | 3 | 4 | 5
-
-export declare class ISurfaceMixin {
-	fill: SchmancySurfaceFill
-	rounded: SchmancySurfaceRounded
-	elevation: SchmancySurfaceElevation
-	type: TSurfaceColor
-	clickable: boolean
-}
-
-/**
- * SurfaceMixin - Adds surface styling properties AND styles to any LitElement
- *
- * Uses Lit's finalizeStyles hook to inject surfaceStyles CSS for all surface type selectors.
- * This is the recommended pattern for mixins that need to add styles.
- *
- * Provides these reflected properties:
- * - `fill`: 'all' | 'width' | 'height' | 'auto' - Controls element dimensions
- * - `rounded`: 'none' | 'top' | 'left' | 'right' | 'bottom' | 'all' - Corner rounding
- * - `elevation`: 0-5 - Shadow depth level
- * - `type`: TSurfaceColor - Surface color variant (26+ options)
- *
- * Usage:
- * ```typescript
- * import { SurfaceMixin } from '@mixins/surface.mixin'
- *
- * @customElement('my-component')
- * class MyComponent extends SurfaceMixin(TailwindElement(css`
- *   :host { display: block; }
- * `)) {
- *   // Component now has type, fill, rounded, elevation properties
- *   // AND surfaceStyles are automatically included
- * }
- * ```
- */
-export const SurfaceMixin = <T extends Constructor<LitElement>>(superClass: T) => {
-	class SurfaceMixinClass extends superClass {
-		/**
-		 * Override finalizeStyles to inject surfaceStyles.
-		 * This is the Lit-recommended way for mixins to add styles.
-		 */
-		protected static finalizeStyles(styles?: CSSResultGroup): CSSResultOrNative[] {
-			// Get parent's finalized styles using LitElement's method
-			const parentStyles = (superClass as unknown as typeof LitElement).finalizeStyles(styles)
-			// Append surfaceStyles at the end (higher specificity)
-			return [...parentStyles, surfaceStyles as CSSResultOrNative]
-		}
-
-		/**
-		 * Fill the width and/or height of the parent container.
-		 * @default 'auto'
-		 */
-		@property({ type: String, reflect: true })
-		fill: SchmancySurfaceFill = 'auto'
-
-		/**
-		 * Specifies the rounding style of the component's corners.
-		 * @default 'none'
-		 */
-		@property({ reflect: true })
-		rounded: SchmancySurfaceRounded = 'none'
-
-		/**
-		 * Defines the elevation level (shadow depth) of the surface.
-		 * @default 0
-		 */
-		@property({ type: Number, reflect: true })
-		elevation: SchmancySurfaceElevation = 0
-
-		/**
-		 * Specifies the surface type for styling.
-		 * @default 'container'
-		 */
-		@property({ reflect: true })
-		type: TSurfaceColor = 'subtle'
-
-		/**
-		 * Makes the surface interactive with hover, active states and cursor pointer.
-		 * @default false
-		 */
-		@property({ type: Boolean, reflect: true })
-		clickable = false
-	}
-	return SurfaceMixinClass as Constructor<ISurfaceMixin> & T
-}