targetj 1.0.258 → 1.0.259

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "targetj",
-  "version": "1.0.258",
+  "version": "1.0.259",
   "description": "TargetJS: JavaScript UI framework where state includes the journey and code order defines the UI sequence",
   "keywords": [
     "targetjs",

package/types/app.d.ts

@@ -0,0 +1,56 @@
+import type { TargetDefinition } from "./core.js";
+
+import type { TModel } from "./tmodel.js";
+
+export function App(targets: TargetDefinition): TModel;
+
+export function App(tmodel: TModel): TModel;
+
+export namespace App { function unmount(): Promise<void>; }
+
+export const tApp: any;
+
+export function tRoot(): TModel | undefined;
+
+export function isRunning(): boolean;
+
+export function getEvents(): any;
+
+export function getPager(): any;
+
+export function getLoader(): any;
+
+export function getManager(): any;
+
+export function getTargetManager(): any;
+
+export function getAnimationManager(): any;
+
+export function getRunScheduler(): any;
+
+export function getLocationManager(): any;
+
+export function getScreenWidth(): number;
+
+export function getScreenHeight(): number;
+
+export function getVisibles(): any;
+
+export function getResizeLastUpdate(): number | undefined;
+
+export function getTModelById(id: string): TModel | undefined;
+
+export function getDomTModelById(id: string): TModel | undefined;
+
+export function fetch(
+  tmodel: TModel,
+  url: string,
+  query?: unknown,
+  cacheId?: string
+): unknown;
+
+export function fetchImage(
+  tmodel: TModel,
+  src: string,
+  cacheId?: string
+): unknown;

package/types/attributes.d.ts

@@ -0,0 +1,37 @@
+export type AttributeTargetName =
+  | "lang"
+  | "autoFocus"
+  | "placeholder"
+  | "autoComplete"
+  | "name"
+  | "type"
+  | "src"
+  | "href"
+  | "method"
+  | "size"
+  | "value"
+  | "maxLength"
+  | "minLength"
+  | "max"
+  | "min"
+  | "readOnly"
+  | "required"
+  | "alt"
+  | "disabled"
+  | "action"
+  | "accept"
+  | "selected"
+  | "rows"
+  | "cols"
+  | "tabIndex"
+  | "role"
+  | "ariaLabel"
+  | "ariaCurrent"
+  | "ariaPressed";
+
+export type AttributeTargetValue =
+  | string
+  | number
+  | boolean
+  | null
+  | undefined;

package/types/core.d.ts

@@ -0,0 +1,154 @@
+import type {
+  TModel
+} from "./tmodel.js";
+
+import type {
+  StyleTargetName
+} from "./styles.js";
+
+import type {
+  AttributeTargetName,
+  AttributeTargetValue
+} from "./attributes.js";
+
+import type {
+  StandardEventTargetName
+} from "./events.js";
+
+export type TargetFunction<TResult = unknown> = (
+  this: TModel,
+  ...args: any[]
+) => TResult;
+
+export type EventTargets = {
+  [TName in StandardEventTargetName]?:
+    | boolean
+    | TargetFunction<unknown>;
+} & {
+  onResize?:
+    | boolean
+    | readonly string[]
+    | TargetFunction<unknown>;
+};
+
+export type EasingFunction = (
+  progress: number
+) => number;
+
+export type EasingValue =
+  | string
+  | EasingFunction;
+
+export type TargetOptions<T = unknown> = {
+  value?:
+    | T
+    | readonly T[]
+    | TargetFunction<T>;
+
+  list?: readonly T[];
+
+  steps?:
+    | number
+    | readonly number[];
+
+  interval?:
+    | number
+    | readonly number[]
+    | TargetFunction<number | readonly number[]>;
+
+  cycles?:
+    | number
+    | TargetFunction<number>;
+
+  loop?:
+    | boolean
+    | "passive";
+
+  active?: boolean;
+
+  enabledOn?:
+    | boolean
+    | string
+    | TargetFunction<boolean>;
+
+  pauseOn?:
+    | boolean
+    | string
+    | TargetFunction<boolean>;
+
+  easing?:
+    | EasingValue
+    | readonly EasingValue[];
+
+  onComplete?: TargetFunction<void>;
+  onValueChange?: TargetFunction<void>;
+} & ThisType<TModel>;
+
+export type TargetInput<T = unknown> =
+  | T
+  | readonly T[]
+  | TargetFunction<T>
+  | TargetOptions<T>;
+
+export type ExecutionName<
+  TName extends string
+> =
+  | TName
+  | `${TName}$`
+  | `${TName}$$`;
+
+export type StyleTargetValue =
+  | string
+  | number
+  | boolean
+  | Record<string, unknown>;
+
+export type StyleTargets = {
+  [TName in ExecutionName<StyleTargetName>]?:
+    TargetInput<StyleTargetValue>;
+};
+
+export type AttributeTargets = {
+  [TName in ExecutionName<AttributeTargetName>]?:
+    TargetInput<AttributeTargetValue>;
+};
+
+export type TargetEntry =
+  | string
+  | number
+  | boolean
+  | null
+  | undefined
+  | readonly unknown[]
+  | TargetFunction
+  | TargetOptions
+  | TargetDefinition
+  | readonly TargetDefinition[];
+
+export type ChildrenTargetOptions =
+  Omit<
+    TargetOptions<readonly TargetDefinition[]>,
+    "value"
+  > & {
+    value?:
+      | readonly TargetDefinition[]
+      | TargetFunction<readonly TargetDefinition[]>;
+
+    onVisibleComplete?: TargetFunction<void>;
+  } &
+  ThisType<TModel>;
+
+export type TargetDefinition =
+  StyleTargets &
+  AttributeTargets &
+  EventTargets & {
+    addChildren?: ChildrenTargetOptions;
+    children?: ChildrenTargetOptions;
+
+    [targetName: string]: TargetEntry;
+  } &
+  ThisType<TModel>;
+
+export interface SetTargetMap {
+  [targetName: string]: TargetInput;
+}

package/types/events.d.ts

@@ -0,0 +1,41 @@
+export type UserEventTargetName =
+| "onStart"
+| "onEnd"
+| "onKey"
+| "onKeyDown"
+| "onAnyKey"
+| "onBlur"
+| "onFocus"
+| "onClick"
+| "onAnyClick"
+| "onHover"
+| "onSwipe"
+| "onAnySwipe"
+| "onPinch"
+| "onEnter"
+| "onLeave"
+| "onScroll"
+| "onScrollLeft"
+| "onScrollTop"
+| "onScrollLeftEnd"
+| "onScrollTopEnd"
+| "onWindowScroll"
+| "onWindowScrollTopEnd"
+| "onWindowScrollLeftEnd"
+| "onPopState"
+| "onChange"
+| "onInput"
+| "onSubmit";
+
+export type InternalEventTargetName =
+| "onDomEvent"
+| "onVisible"
+| "onInvisible";
+
+export type EventTargetName =
+| UserEventTargetName
+| InternalEventTargetName
+| "onResize";
+
+export type StandardEventTargetName =
+Exclude<EventTargetName, "onResize">;

package/types/index.d.ts

@@ -1,290 +1,31 @@
-export type TargetFunction<TResult = unknown> = (
-  this: TModel,
-  ...args: any[]
-) => TResult;
-
-export type EasingFunction = (
-  progress: number
-) => number;
-
-export type EasingValue =
-  | string
-  | EasingFunction;
-
-export interface TargetOptions<T = unknown> {
-  value?:
-    | T
-    | readonly T[]
-    | TargetFunction<T>;
-
-  list?: readonly T[];
-
-  steps?:
-    | number
-    | readonly number[];
-
-  interval?:
-    | number
-    | readonly number[];
-
-  cycles?:
-    | number
-    | TargetFunction<number>;
-
-  loop?:
-    | boolean
-    | "passive";
-
-  active?: boolean;
-
-  enabledOn?:
-    | boolean
-    | string
-    | TargetFunction<boolean>;
-
-  pauseOn?:
-    | boolean
-    | string
-    | TargetFunction<boolean>;
-
-  easing?:
-    | EasingValue
-    | readonly EasingValue[];
-
-  onComplete?: TargetFunction<void>;
-  onValueChange?: TargetFunction<void>;
-}
-
-export type TargetInput<T = unknown> =
-  | T
-  | readonly T[]
-  | TargetFunction<T>
-  | TargetOptions<T>;
-
-export type ExecutionName<TName extends string> =
-  | TName
-  | `${TName}$`
-  | `${TName}$$`;
-
-export type StyleTargetName =
-  | "width"
-  | "height"
-  | "opacity"
-  | "x"
-  | "y"
-  | "z"
-  | "scale"
-  | "rotate"
-  | "backgroundColor"
-  | "color";
-
-export type StyleTargets = {
-  [TName in ExecutionName<StyleTargetName>]?:
-    TargetInput<number | string>;
-};
-
-export interface EventTargets {
-  onClick?: (
-    this: TModel,
-    event: MouseEvent
-  ) => void;
-
-  onKey?: (
-    this: TModel,
-    event: KeyboardEvent
-  ) => void;
-
-  onKeyDown?: (
-    this: TModel,
-    event: KeyboardEvent
-  ) => void;
-
-  onInput?: (
-    this: TModel,
-    event: InputEvent
-  ) => void;
-
-  onSubmit?: (
-    this: TModel,
-    event: SubmitEvent
-  ) => void;
-
-  onResize?:
-    | readonly string[]
-    | TargetFunction<void>;
-
-  onEnter?: TargetFunction<void>;
-  onLeave?: TargetFunction<void>;
-}
-
-export type TargetEntry =
-  | string
-  | number
-  | boolean
-  | null
-  | undefined
-  | readonly unknown[]
-  | TargetFunction
-  | TargetOptions
-  | TargetDefinition
-  | readonly TargetDefinition[];
-
-/*
- * Declare TargetDefinition only once.
- */
-export type TargetDefinition =
-  StyleTargets &
-  EventTargets & {
-    [targetName: string]: TargetEntry;
-  } &
-  ThisType<TModel>;
-
-export interface SetTargetMap {
-  [targetName: string]: TargetInput;
-}
-
-export class TModel<
-  TTargets extends TargetDefinition = TargetDefinition
-> {
-  constructor(
-    type: string,
-    targets: TTargets,
-    oid?: string,
-    options?: unknown
-  );
-
-  oid: string;
-  targets: TTargets;
-
-  mount(element: string | Element): this;
-
-  val<T = unknown>(targetName: string): T;
-  val<T = unknown>(targetName: string, value: T): T;
-
-  pval<T = unknown>(targetName: string): T;
-
-  setTarget<T>(
-    targetName: string,
-    value: TargetInput<T>,
-    steps?: number,
-    interval?: number,
-    easing?: EasingValue
-  ): this;
-
-  setTarget(
-    targets: SetTargetMap,
-    steps?: number,
-    interval?: number,
-    easing?: EasingValue
-  ): this;
-
-  activateTarget(
-    targetName: string,
-    ...args: any[]
-  ): unknown;
-
-  getChild(
-    id: string | number
-  ): TModel | undefined;
-
-  getParent(): TModel | undefined;
-
-  getWidth(): number;
-  getHeight(): number;
-  getX(): number;
-  getY(): number;
-
-  addChild(
-    definition: TargetDefinition | TModel
-  ): TModel;
-
-  removeChildren(): void;
-}
-
-export function App<
-  TTargets extends TargetDefinition
->(
-  targets: TTargets & ThisType<TModel<TTargets>>
-): TModel<TTargets>;
-
-export function App(
-  tmodel: TModel
-): TModel;
-
-export namespace App {
-  function unmount(): Promise<void>;
-}
-
-export interface StateManager {
-  store(key?: string): unknown;
-  restore(key?: string): Promise<boolean>;
-  toggle(key?: string): Promise<unknown>;
-}
-
-export function state(): StateManager;
-
-export function tRoot(): TModel | undefined;
-export function isRunning(): boolean;
-
-export function getScreenWidth(): number;
-export function getScreenHeight(): number;
-
-export function getTModelById(
-  id: string
-): TModel | undefined;
-
-export function getDomTModelById(
-  id: string
-): TModel | undefined;
-
-/*
- * These exports exist at runtime. They can be typed more precisely later.
- */
-export const tApp: any;
-
-export const Moves: any;
-export const SearchUtil: any;
-export const TargetData: any;
-export const TargetUtil: any;
-export const TargetParser: any;
-export const TModelUtil: any;
-export const TUtil: any;
-export const DomInit: any;
-export const $Dom: any;
-export const Bracket: any;
-export const BracketGenerator: any;
-export const ColorUtil: any;
-export const Easing: any;
-export const TargetExecutor: any;
-export const AnimationManager: any;
-export const AnimationUtil: any;
-export const VisibilityUtil: any;
-export const ScheduleUtil: any;
-export const StateUtil: any;
-
-export function getEvents(): any;
-export function getPager(): any;
-export function getLoader(): any;
-export function getManager(): any;
-export function getTargetManager(): any;
-export function getAnimationManager(): any;
-export function getRunScheduler(): any;
-export function getLocationManager(): any;
-export function getVisibles(): any;
-export function getResizeLastUpdate(): number | undefined;
-
-export function fetch(
-  tmodel: TModel,
-  url: string,
-  query?: unknown,
-  cacheId?: string
-): unknown;
-
-export function fetchImage(
-  tmodel: TModel,
-  src: string,
-  cacheId?: string
-): unknown;
+export * from "./styles.js";
+export * from "./events.js";
+export * from "./attributes.js";
+export * from "./core.js";
+export * from "./tmodel.js";
+export * from "./app.js";
+export * from "./state.js";
+export * from "./utilities.js";
+
+import {
+  App
+} from "./app.js";
+
+import {
+  state
+} from "./state.js";
+
+import {
+  TModel
+} from "./tmodel.js";
+
+import {
+  Easing,
+  Moves,
+  StateUtil,
+  TModelUtil,
+  TUtil
+} from "./utilities.js";
 
 declare const TargetJS: {
   [exportName: string]: any;
@@ -295,6 +36,7 @@ declare const TargetJS: {
 
   Moves: typeof Moves;
   Easing: typeof Easing;
+
   TUtil: typeof TUtil;
   TModelUtil: typeof TModelUtil;
   StateUtil: typeof StateUtil;

package/types/state.d.ts

@@ -0,0 +1,48 @@
+export interface StateCheckpoint {
+  key: string;
+  capturedAt: number;
+
+  html: string;
+  domState: unknown;
+
+  oids: Record<string, unknown>;
+  rootSnapshot: unknown;
+  loaderSnapshot: unknown;
+
+  visibleOids: string[];
+
+  scrollLeft: number;
+  scrollTop: number;
+
+  runSnapshot: unknown;
+}
+
+export interface StateManager {
+  store(
+    key?: string
+  ): Promise<StateCheckpoint>;
+
+  restore(
+    key?: string
+  ): Promise<boolean>;
+
+  toggle(
+    key?: string
+  ): Promise<StateCheckpoint | boolean>;
+
+  has(
+    key?: string
+  ): boolean;
+
+  get(
+    key?: string
+  ): StateCheckpoint | undefined;
+
+  clear(
+    key?: string
+  ): boolean;
+
+  clearAll(): void;
+}
+
+export function state(): StateManager;