@lightningjs/blits 1.7.1 → 1.8.1

package/src/application.d.ts

@@ -1,174 +0,0 @@
-
-/*
- * Copyright 2023 Comcast Cable Communications Management, LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {default as Component} from './component'
-
-declare namespace Application {
-
-  interface Transition {
-    /**
-     * Name of the prop to transition (i.e. 'x', 'y', 'alpha', 'color')
-     */
-    prop: string,
-    /**
-     * Value the prop should transition to (i.e. 0, 100, '#223388')
-     */
-    value: any,
-    /**
-     * Duration of the transition in milliseconds, defaults to 300
-     */
-    duration?: number,
-    /**
-     * Easing function to apply to the transition
-     */
-    easing?: string,
-    /**
-     * Delay before the transition starts in milliseconds
-     */
-    delay?: number
-  }
-
-  interface Before {
-    /**
-    * Name of the prop to set before the transition starts
-    */
-    prop: string,
-    /**
-     * Value the prop to set before the transition starts
-     */
-    value: any,
-  }
-
-  interface RouteTransition {
-    /**
-     * Setting or Array of Settings before new view enters into the router view
-     */
-    before: Before | Before[],
-    /**
-     * Transition or Array of Transitions for new view to enters into the router view
-     */
-    in: Transition | Transition[],
-    /**
-     * Transition or Array of Transitions for old view to leave the router view
-     */
-    out: Transition | Transition[],
-  }
-
-  type RouteTransitionFunction = (previousRoute: Route, currentRoute: Route) => RequireAtLeastOne<RouteTransition>
-
-  interface RouteAnnounce {
-    /**
-     * Message to be announced
-     */
-    message: String,
-    /**
-     * Politeness level
-     *
-     * Defaults to 'off'
-     */
-    politeness?: 'off' | 'polite' | 'assertive'
-  }
-
-  type RequireAtLeastOne<T> = {
-    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>
-  }[keyof T]
-
-  interface RouteHooks {
-    before?: (to: Route, from: Route) => string | Route;
-  }
-
-  type Route = {
-    /**
-     * URI path for the route
-     */
-    path: string,
-    /**
-     * Component to load when activating the route
-     */
-    component: Component,
-    /**
-     * Transition configuration for the route
-     */
-    transition?: RequireAtLeastOne<RouteTransition> | RouteTransitionFunction,
-    /**
-     * Extra route options
-     */
-    options?: object // todo: specify which options are available,
-    /**
-     * Message to be announced when visiting the route (often used for accessibility purposes)
-     *
-     * Can be either a `String` with the message or an object that defines the message and the
-     * politeness level
-     */
-    announce?: String | RouteAnnounce
-    /**
-     * Register hooks for the route
-     */
-    hooks?: RouteHooks
-    /**
-     * Route path parameters
-     */
-    readonly params?: {
-      [key: string]: string | number
-    }
-    /**
-     * Allows for attaching custom data to a route, either hardcoded in the
-     * route definition or asigned to the route object in a before hook
-     *
-     * Will be merged with the route params and navigation data and passed as
-     * props into the route component
-     */
-    data?: {
-      [key: string]: any
-    }
-  }
-
-  export interface ApplicationInstance extends Component.ComponentInstance {}
-
-  export interface ApplicationConfig<Props extends string, S, M> extends Component.ComponentConfig<Props, S, M> {
-    /**
-     * Routes definition
-     *
-     * @example
-     *
-     * ```js
-     * routes: [
-     *  { path: '/', component: Home },
-     *  { path: '/details', component: Details },
-     *  { path: '/account', component: Account },
-     * ]
-     * ```
-     */
-    routes?: Route[]
-  }
-}
-
-/**
- * Blits.Application()
- *
- * Root App component
- */
-declare function Application<
-  Props extends string,
-  S extends Component.State,
-  M extends Component.Methods
-  >(
-    config: Application.ApplicationConfig<Props, S, M>
-) : Application.ApplicationInstance
-
-export default Application;

package/src/component.d.ts

@@ -1,455 +0,0 @@
-/*
- * Copyright 2023 Comcast Cable Communications Management, LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-declare namespace Component {
-
-  /**
-   * Name of the Component
-   */
-  type Name = string
-
-
-  interface Announcer {
-    /**
-     * Announce a message to screen readers by specifying the politeness level
-    */
-    speak: (message: string, politeness?: 'polite' | 'assertive') => void
-
-    /**
-     * Announce a message to screen readers with a polite politeness level
-    */
-    polite: (message: string) => void
-
-    /**
-     * Announce a message to screen readers with an assertive politeness level
-    */
-    assertive: (message: string) => void
-
-    /**
-     * Stop all announcements
-    */
-    stop: () => void
-  }
-
-  interface Log {
-    /**
-    * Log an info message
-    */
-    info(...args): typeof console.info
-    /**
-    * Log an error message
-    */
-    error(...args): typeof console.error
-    /**
-    * Log a warning
-    */
-    warn(...args): typeof console.warn
-    /**
-    * Log a debug message
-    */
-    debug(...args): typeof console.debug
-  }
-  interface AdvancedProp {
-    /**
-     * Name of the prop
-     */
-    key: string,
-    /**
-     * Whether the prop is required to be passed
-     */
-    required?: boolean,
-    /**
-     * Default value for the prop when omited
-     */
-    default?: any,
-    /**
-     * Cast the value of the prop
-     *
-     * @example
-     * ```js
-     * {
-     *   cast: Number, // casts to a number
-     *   cast: (v) => v.toUpperCase() // casts to uppercase
-     * }
-     * ```
-     */
-    cast?: () => any
-  }
-  type PropsArray<T extends string> = T[]
-  type AdvancedProps = AdvancedProp[]
-  type MixedProps<T extends string> = (T | AdvancedProp)[];
-
-  // type ExtractPropNames<T extends Prop[]> = T extends (infer U)[]
-  // ? U extends string
-  //   ? U
-  //   : U extends AdvancedProp
-  //   ? U['key']
-  //   : never
-  // : never;
-
-  type NotFunction<T> = T extends Function ? never : T;
-
-  /**
-   * Internal state of a Component instance
-   */
-  interface State {
-    [key: string]: any
-  }
-
-  interface Computed<S, M, P> {
-    [key: string]: (this: ComponentInstance & S & M & P) => any
-  }
-
-  interface Watch<S, M, P> {
-    [key: string]: (this: ComponentInstance & S & M & P, value: any, oldValue: any) => void
-  }
-
-  interface Methods {
-    [key: string]: (this: ComponentInstance & State & Methods, ...args: any) => any;
-  }
-
-  // interface MethodsExtended<S, M, P> extends Methods {
-  //   [key: string]: (this: ComponentInstance & S & M & P) => any;
-  // }
-
-  interface Input<S, M, P> {
-    [key: string]: ((this: ComponentInstance & S & M & P, event: KeyboardEvent) => void) | undefined,
-
-    /**
-     * Catch all input function
-     *
-     * Will be invoked when there is no dedicated function for a certain key
-    */
-    any?: (this: ComponentInstance & S & M & P, event: KeyboardEvent) => void,
-  }
-
-  interface Log {
-    /**
-    * Log an info message
-    */
-    info(...args): typeof console.info
-    /**
-    * Log an error message
-    */
-    error(...args): typeof console.error
-    /**
-    * Log a warning
-    */
-    warn(...args): typeof console.warn
-    /**
-    * Log a debug message
-    */
-    debug(...args): typeof console.debug
-  }
-
-  interface Hooks<S, M, P> {
-    /**
-    * Fires when the Component is being instantiated.
-    * At this moment child elements will not be available yet
-    */
-    init?: (this: ComponentInstance & S & M & P, ...args: any) => void
-    /**
-    * Fires when the Component is fully initialized and ready for interaction.
-    */
-    ready?: (this: ComponentInstance & S & M & P, ...args: any) => void
-    /**
-    * Triggers when the Component receives focus.
-    *
-    * This event can fire multiple times during the component's lifecycle
-    */
-    focus?: (this: ComponentInstance & S & M & P, ...args: any) => void
-    /**
-    * Triggers when the Component loses focus.
-    *
-    * This event can fire multiple times during the component's lifecycle
-    */
-    unfocus?: (this: ComponentInstance & S & M & P, ...args: any) => void
-    /**
-    * Fires when the Component is being destroyed and removed.
-    */
-    destroy?: (this: ComponentInstance & S & M & P, ...args: any) => void,
-    /**
-    * Fires upon each frame start  (allowing you to tap directly into the renderloop)
-    *
-    * Note: This hook will fire continuously, multiple times per second!
-    */
-    frameTick?: (this: ComponentInstance & S & M & P, ...args: any) => void,
-    /**
-    * Fires when the component enters the viewport _margin_ and is attached to the render tree
-    *
-    * This event can fire multiple times during the component's lifecycle
-    */
-    attach?: (this: ComponentInstance & S & M & P, ...args: any) => void,
-    /**
-    * Fires when the component leaves the viewport _margin_ and is detached from the render tree
-    *
-    * This event can fire multiple times during the component's lifecycle
-    */
-    detach?: (this: ComponentInstance & S & M & P, ...args: any) => void,
-    /**
-    * Fires when the component enters the visible viewport
-    *
-    * This event can fire multiple times during the component's lifecycle
-    */
-    enter?: (this: ComponentInstance & S & M & P, ...args: any) => void,
-    /**
-    * Fires when the component leaves the visible viewport
-    *
-    * This event can fire multiple times during the component's lifecycle
-    */
-    exit?: (this: ComponentInstance & S & M & P, ...args: any) => void,
-  }
-
-  /**
-   * Route object
-  */
-  interface Route {
-    path: string,
-    params: Record<string, string>,
-    options?: {
-      inHistory?: boolean,
-      keepAlive?: boolean,
-      [key: string]: any,
-    },
-    data?: Record<string, any>,
-    component?: (args: { props: any }, holder: any, context: any) => Promise<any>,
-    hooks?: {
-      before?: (route: Route, previousRoute: Route) => Promise<string | Route | void>,
-    }
-  }
-
-
-  interface Router {
-    /**
-     * Navigate to a different location
-    */
-    to(location: string, data?: Record<string, any>, options?: Record<string, any>): void;
-
-    /**
-     * Navigate to the previous location
-    */
-    back(): boolean;
-
-    /**
-     * Get the current route read-only
-    */
-    readonly currentRoute: Route;
-
-    /**
-     * Get the list of all routes
-     */
-    readonly routes: Route[];
-
-    /**
-     * Get navigating state
-     */
-    readonly navigating: boolean;
-
-  }
-
-  export interface ComponentInstance {
-    /**
-    * Listen to events emitted by other components
-    */
-    $listen: {
-      (event: string, callback: (args: any) => void, priority?: number): void;
-    }
-
-    /**
-    * Emit events that other components can listen to
-    */
-    $emit: (event: string, args?: any) => void
-
-    /**
-    * Set a timeout that is automatically cleaned upon component destroy
-    */
-    $setTimeout: (callback: (args: any) => void, ms?: number | undefined) => ReturnType<typeof setTimeout>
-
-    /**
-    * Clear a timeout
-    */
-    $clearTimeout: (id: ReturnType<typeof setTimeout>) => void
-
-    /**
-    * Set an interval that is automatically cleaned upon component destroy
-    */
-    $setInterval: (callback: (args: any) => void, ms?: number | undefined) => ReturnType<typeof setInterval>
-
-    /**
-    * Clear a interval
-    */
-    $clearInterval: (id: ReturnType<typeof setInterval>) => void
-
-    /**
-    * Log to the console with prettier output and configurable debug levels in Settings
-    */
-    $log: Log
-
-    /**
-    * Set focus to the Component, optionally pass a KeyboardEvent for instant event bubbling
-    */
-    $focus: (event?: KeyboardEvent) => void
-    /**
-     * @deprecated
-     * Deprecated:  use `this.$focus()` instead
-     */
-    focus: (event?: KeyboardEvent) => void
-
-    /**
-    * Select a child Element or Component by ref
-    *
-    * Elements and Components in the template can have an optional ref argument.
-    * Returns an Element Instance or Component Instance.
-    * Useful for passing on the focus to a Child component.
-    *
-    * @example
-    * ```js
-    * const menu = this.select('Menu')
-    * if(menu) {
-    *   menu.focus()
-    * }
-    * ```
-    */
-    $select: (ref: string) => ComponentInstance | ElementInstance
-
-    /**
-     * @deprecated
-     * Deprecated: use `this.$select()` instead
-     */
-    select: (ref: string) => ComponentInstance | ElementInstance
-
-    /**
-     * Announcer methods for screen reader support
-     */
-    $announcer: Announcer
-
-    /**
-     * Triggers a forced update on state variables.
-     */
-    $trigger: (key: string) => void
-    /**
-     * @deprecated
-     *
-     * Triggers a forced update on state variables.
-     * Deprecated: use `this.$trigger()` instead
-     */
-    trigger: (key: string) => void
-
-    /**
-     * Router instance
-     */
-    $router: Router
-
-  }
-
-  export interface ElementInstance {
-    focus?: () => void
-    $focus?: () => void
-  }
-
-  export interface ComponentConfig<Props extends string, S, M> {
-    components?: any,
-    /**
-     * XML-based template string of the Component
-     *
-     * @example
-     * ```xml
-     * <Element :x="$x" w="400" h="1080" color="#64748b">
-     *  <Element x="50" y="40">
-     *   <Button color="#e4e4e7" />
-     *   <Button color="#e4e4e7" y="100" />
-     *   <Button color="#e4e4e7" y="200" />
-     *   <Button color="#e4e4e7" y="300" />
-     *  </Element>
-     * </Element>
-     * ```
-     */
-    template?: String,
-    /**
-     * Reactive internal state of the Component instance
-     *
-     * Should return an object (literal) with key value pairs.
-     * Can contain nested objects, but beware that too deep nesting can have
-     * a negative impact on performance
-     *
-     * @example
-     * ```js
-     * state() {
-     *  return {
-     *    items: [],
-     *    color: 'red',
-     *    alpha: 0.1
-     *  }
-     * }
-     * ```
-     */
-    state?: (this: { [K in Props]: any}) => S,
-    /**
-     * Allowed props to be passed into the Component by the parent
-     *
-     * Can be a simple array with `prop` keys as strings.
-     * Alternatively objects can be used to specify `required` props and `default` values
-     *
-     * @example
-     * ```js
-     * props: ['index', {
-     *  key: 'alpha',
-     *  required: true
-     * }, {
-     *  key: 'color',
-     *  default: 'red'
-     * }]
-     * ```
-     */
-    props?: PropsArray<Props> | AdvancedProps | MixedProps<Props>
-    /**
-     * Computed properties
-     */
-    computed?: Computed<S, M, { [K in Props]: any}>,
-    /**
-     * Watchers for changes to state variables, props or computed properties
-     */
-    watch?: Watch<S, M, { [K in Props]: any}>,
-    /**
-     * Hooking into Lifecycle events
-     */
-    hooks?: Hooks<S, M, { [K in Props]: any}>,
-    /**
-     * Methods for abstracting more complex business logic into separate function
-     */
-    methods?: M //MethodsExtended<S, M, { [K in Props]: any}>,
-    /**
-     * Tapping into user input
-     */
-    input?: Input<S, M, { [K in Props]: any}>
-  }
-}
-
-
- /**
- * Blits.Component()
- */
-declare function Component<
-    Props extends string,
-    S extends Component.State,
-    M extends Component.Methods
-  >(
-  name: Component.Name,
-  config: Component.ComponentConfig<Props, S, M>
-) : Component.ComponentInstance
-
-export default Component;