Merge branch 'master' of https://github.com/aidenybai/lucia

.github/dependabot.yml

@@ -8,5 +8,5 @@ updates:
   - package-ecosystem: 'npm' # See documentation for possible values
     directory: '/' # Location of package manifests
     schedule:
-      interval: 'daily'
-    target-branch: 'staging'
+      interval: 'weekly'
+    target-branch: 'master'

docs/codebase/CORE.md

@@ -61,7 +61,7 @@ The values of the `directives` object are `DirectiveData`, which contain propert
 
 ```ts
 interface DirectiveData {
-  compute: (state: UnknownKV, event?: Event) => any;
+  compute: (state: KV<unknown>, event?: Event) => any;
   value: string;
   deps: string[];
 }

src/component.ts

@@ -1,12 +1,12 @@
 /* istanbul ignore file */
 
-import { COMPONENT_FLAG } from './models/generics';
-import compile from './core/compile';
-import { directives } from './core/directive';
-import reactive from './core/reactive';
-import render from './core/render';
-import { setElementCustomProp } from './core/utils/elementCustomProp';
-import { ASTNode, DirectiveProps, Directives, State, Watchers } from './models/structs';
+import { COMPONENT_FLAG } from '@models/generics';
+import compile from '@core/compile';
+import { directives } from '@core/directive';
+import reactive from '@core/reactive';
+import render from '@core/render';
+import { setElementCustomProp } from '@core/utils/elementCustomProp';
+import { ASTNode, DirectiveProps, Directives, State, Watchers } from '@models/structs';
 
 export class Component {
   public state: State;

src/core/__test__/reactive.spec.ts

@@ -1,4 +1,4 @@
-import { StringKV } from '../../models/generics';
+import { KV } from '../../models/generics';
 import { reactive } from '../reactive';
 
 describe('.reactive', () => {
@@ -63,7 +63,7 @@ describe('.reactive', () => {
     const callback = (deps: string[]) => (result = deps[0]);
     const proxy = reactive(state, callback);
 
-    (proxy.foo as StringKV).bar = '1';
+    (proxy.foo as KV<string>).bar = '1';
 
     expect(result).toEqual('bar');
   });

src/core/compile.ts

@@ -3,12 +3,12 @@ import {
   DIRECTIVE_PREFIX,
   DIRECTIVE_SHORTHANDS,
   FOR_TEMPLATE_FLAG,
-} from '../models/generics';
-import { ASTNode, ASTNodeType, DirectiveKV, Refs, State } from '../models/structs';
-import compute from './utils/computeExpression';
-import { getElementCustomProp, setElementCustomProp } from './utils/elementCustomProp';
-import { eventDirectivePrefixRE, expressionPropRE, hasDirectiveRE } from './utils/patterns';
-import removeDupesFromArray from './utils/removeDupesFromArray';
+} from '@models/generics';
+import { ASTNode, ASTNodeType, DirectiveKV, Refs, State } from '@models/structs';
+import compute from '@utils/computeExpression';
+import { getElementCustomProp, setElementCustomProp } from '@utils/elementCustomProp';
+import { eventDirectivePrefixRE, expressionPropRE, hasDirectiveRE } from '@utils/patterns';
+import removeDupesFromArray from '@utils/removeDupesFromArray';
 
 export const isListRenderScope = (el: HTMLElement): boolean => {
   return el.hasAttribute(`${DIRECTIVE_PREFIX}for`);

src/core/directive.ts

@@ -1,11 +1,11 @@
-import { DirectiveProps, Directives } from '../models/structs';
-import { bindDirective } from './directives/bind';
-import { forDirective } from './directives/for';
-import { htmlDirective } from './directives/html';
-import { modelDirective } from './directives/model';
-import { onDirective } from './directives/on';
-import { showDirective } from './directives/show';
-import { textDirective } from './directives/text';
+import { DirectiveProps, Directives } from '@models/structs';
+import { bindDirective } from '@directives/bind';
+import { forDirective } from '@directives/for';
+import { htmlDirective } from '@directives/html';
+import { modelDirective } from '@directives/model';
+import { onDirective } from '@directives/on';
+import { showDirective } from '@directives/show';
+import { textDirective } from '@directives/text';
 
 export const directives: Directives = {
   BIND: bindDirective,

src/core/directives/bind.ts

@@ -1,4 +1,4 @@
-import { DirectiveProps } from '../../models/structs';
+import { DirectiveProps } from '@models/structs';
 
 export const formatAcceptableWhitespace = (expression: string): string => {
   const whitespaceRE = /\s+/gim;

src/core/directives/for.ts

@@ -1,14 +1,14 @@
 /* istanbul ignore file */
 
-import compile from '../../core/compile';
-import { directives } from '../../core/directive';
-import render from '../../core/render';
-import { COMPONENT_FLAG, DIRECTIVE_PREFIX, FOR_TEMPLATE_FLAG } from '../../models/generics';
-import { ASTNode, DirectiveProps } from '../../models/structs';
-import adjustDeps from '../utils/adjustDeps';
-import computeExpression from '../utils/computeExpression';
-import { getElementCustomProp, setElementCustomProp } from '../utils/elementCustomProp';
-import { expressionPropRE, parenthesisWrapReplaceRE } from '../utils/patterns';
+import compile from '@core/compile';
+import { directives } from '@core/directive';
+import render from '@core/render';
+import { COMPONENT_FLAG, DIRECTIVE_PREFIX, FOR_TEMPLATE_FLAG } from '@models/generics';
+import { ASTNode, DirectiveProps } from '@models/structs';
+import adjustDeps from '@utils/adjustDeps';
+import computeExpression from '@utils/computeExpression';
+import { getElementCustomProp, setElementCustomProp } from '@utils/elementCustomProp';
+import { expressionPropRE, parenthesisWrapReplaceRE } from '@utils/patterns';
 
 // This directive is size-based, not content-based, since everything is compiled and rerendered
 export const forDirective = ({ el, data, state, node }: DirectiveProps): void => {

src/core/directives/html.ts

@@ -1,11 +1,11 @@
-import compile from '../../core/compile';
-import { directives } from '../../core/directive';
-import render from '../../core/render';
-import { COMPONENT_FLAG } from '../../models/generics';
-import { ASTNode, DirectiveProps } from '../../models/structs';
-import adjustDeps from '../utils/adjustDeps';
-import { getElementCustomProp, setElementCustomProp } from '../utils/elementCustomProp';
-import { hasDirectiveRE } from '../utils/patterns';
+import compile from '@core/compile';
+import { directives } from '@core/directive';
+import render from '@core/render';
+import { COMPONENT_FLAG } from '@models/generics';
+import { ASTNode, DirectiveProps } from '@models/structs';
+import adjustDeps from '@utils/adjustDeps';
+import { getElementCustomProp, setElementCustomProp } from '@utils/elementCustomProp';
+import { hasDirectiveRE } from '@utils/patterns';
 
 export const htmlDirective = ({ el, data, state, node }: DirectiveProps): void => {
   node = node!;

src/core/directives/model.ts

@@ -1,7 +1,7 @@
-import { MODEL_REGISTERED_FLAG } from '../../models/generics';
-import { DirectiveData, DirectiveProps, State } from '../../models/structs';
-import computeExpression from '../utils/computeExpression';
-import { getElementCustomProp, setElementCustomProp } from '../utils/elementCustomProp';
+import { MODEL_REGISTERED_FLAG } from '@models/generics';
+import { DirectiveData, DirectiveProps, State } from '@models/structs';
+import computeExpression from '@utils/computeExpression';
+import { getElementCustomProp, setElementCustomProp } from '@utils/elementCustomProp';
 
 export const inputCallback = (
   el: HTMLInputElement,

src/core/directives/on.ts

@@ -1,5 +1,5 @@
-import { DirectiveProps } from '../../models/structs';
-import { getElementCustomProp, setElementCustomProp } from '../utils/elementCustomProp';
+import { DirectiveProps } from '@models/structs';
+import { getElementCustomProp, setElementCustomProp } from '@utils/elementCustomProp';
 
 export const onDirective = ({ el, parts, data, state }: DirectiveProps): void => {
   const options: Record<string, boolean> = {};

src/core/directives/show.ts

@@ -1,4 +1,4 @@
-import { DirectiveProps } from '../../models/structs';
+import { DirectiveProps } from '@models/structs';
 
 export const showDirective = ({ el, data, state }: DirectiveProps): void => {
   const ret = data.compute(state);

src/core/directives/text.ts

@@ -1,4 +1,4 @@
-import { DirectiveProps } from '../../models/structs';
+import { DirectiveProps } from '@models/structs';
 
 export const textDirective = ({ el, data, state }: DirectiveProps): void => {
   const ret = data.compute(state) ?? data.value;

src/core/reactive.ts

@@ -1,5 +1,5 @@
-import { UnknownKV } from '../models/generics';
-import { State, Watchers } from '../models/structs';
+import { KV } from '@models/generics';
+import { State, Watchers } from '@models/structs';
 
 export const arrayEquals = (firstArray: unknown[], secondArray: unknown[]): boolean => {
   // Deep Array equality check
@@ -17,7 +17,7 @@ export const reactive = (
   watchers: Watchers = {}
 ): State => {
   const handler = {
-    get(target: UnknownKV, key: string): unknown {
+    get(target: KV<unknown>, key: string): unknown {
       const ret = target[key];
 
       if (typeof ret === 'object' && ret !== null) {
@@ -27,7 +27,7 @@ export const reactive = (
         return ret;
       }
     },
-    set(target: UnknownKV, key: string, value: unknown): boolean {
+    set(target: KV<unknown>, key: string, value: unknown): boolean {
       // Currently double renderes - bad perf
       const hasArrayMutationKey = !isNaN(Number(key)) || key === 'length';
       const props = hasArrayMutationKey ? [] : [key];

src/core/render.ts

@@ -1,13 +1,13 @@
-import { DIRECTIVE_PREFIX, UnknownKV } from '../models/generics';
-import { ASTNode, ASTNodeType, Directives } from '../models/structs';
+import { DIRECTIVE_PREFIX, KV } from '@models/generics';
+import { ASTNode, ASTNodeType, Directives } from '@models/structs';
 import { renderDirective } from './directive';
-import lazy from './utils/lazy';
-import { rawDirectiveSplitRE } from './utils/patterns';
+import lazy from '@utils/lazy';
+import { rawDirectiveSplitRE } from '@utils/patterns';
 
 const render = (
   ast: ASTNode[],
   directives: Directives,
-  state: UnknownKV = {},
+  state: KV<unknown> = {},
   changedProps: string[] = []
 ): void => {
   const legalDirectiveNames = Object.keys(directives);

src/core/utils/adjustDeps.ts

@@ -1,4 +1,4 @@
-import { ASTNode } from '../../models/structs';
+import { ASTNode } from '@models/structs';
 import removeDupesFromArray from './removeDupesFromArray';
 
 export const adjustDeps = (

src/core/utils/computeExpression.ts

@@ -1,5 +1,5 @@
-import { UnknownKV } from '../../models/generics';
-import { Refs } from '../../models/structs';
+import { KV } from '@models/generics';
+import { Refs } from '@models/structs';
 import { expressionPropRE } from './patterns';
 
 export const resolveStateInExpression = (
@@ -22,7 +22,7 @@ export const computeExpression = (
   refs: Refs = {},
   deps?: string[]
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-): ((state: UnknownKV, event?: Event) => any) => {
+): ((state: KV<unknown>, event?: Event) => any) => {
   const formattedExpression = `${returnable ? `return ${expression}` : expression}`;
   const resolvedExpression = resolveStateInExpression(formattedExpression, deps);
   const specialPropertiesNames = ['$state', '$el', '$emit', '$event', '$refs'];
@@ -39,7 +39,7 @@ export const computeExpression = (
     target.dispatchEvent(event);
   };
 
-  return (state: UnknownKV, event?: Event) => {
+  return (state: KV<unknown>, event?: Event) => {
     try {
       const value = state[expression];
       if (value) {

src/core/utils/patterns.ts

@@ -1,4 +1,4 @@
-import { DIRECTIVE_PREFIX, DIRECTIVE_SHORTHANDS } from '../../models/generics';
+import { DIRECTIVE_PREFIX, DIRECTIVE_SHORTHANDS } from '@models/generics';
 
 // Split directive:modifier.property
 export const rawDirectiveSplitRE = (): RegExp => /:|\./gim;

src/index.ts

@@ -1,12 +1,12 @@
 // Exports wrapped in Lucia namespace
 import component from './component';
-import compile from './core/compile';
-import { directives } from './core/directive';
-import reactive from './core/reactive';
-import render from './core/render';
-import computeExpression from './core/utils/computeExpression';
-import { getElementCustomProp } from './core/utils/elementCustomProp';
-import { COMPONENT_FLAG, DIRECTIVE_PREFIX } from './models/generics';
+import compile from '@core/compile';
+import { directives } from '@core/directive';
+import reactive from '@core/reactive';
+import render from '@core/render';
+import computeExpression from '@core/utils/computeExpression';
+import { getElementCustomProp } from '@core/utils/elementCustomProp';
+import { COMPONENT_FLAG, DIRECTIVE_PREFIX } from '@models/generics';
 
 export { component, compile, render, reactive, directives, computeExpression };
 

src/models/generics.ts

@@ -6,6 +6,4 @@ export enum DIRECTIVE_SHORTHANDS {
   '@' = 'on',
   ':' = 'bind',
 }
-
-export type UnknownKV = Record<string, unknown>;
-export type StringKV = Record<string, string>;
+export type KV<T> = Record<string, T>;

src/models/structs.ts

@@ -1,15 +1,15 @@
-import { UnknownKV } from './generics';
+import { KV } from './generics';
 
-export type Directives = Record<string, (props: DirectiveProps) => void>;
-export type Watchers = Record<string, () => void>;
-export type Refs = Record<string, HTMLElement>;
-export type State = UnknownKV;
+export type Directives = KV<(props: DirectiveProps) => void>;
+export type Watchers = KV<() => void>;
+export type Refs = KV<HTMLElement>;
+export type State = KV<unknown>;
 
-export type DirectiveKV = Record<string, DirectiveData>;
+export type DirectiveKV = KV<DirectiveData>;
 
 export interface DirectiveData {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  compute: (state: UnknownKV, event?: Event) => any;
+  compute: (state: KV<unknown>, event?: Event) => any;
   value: string;
   deps: string[];
 }