element-vir 20.0.0 → 20.0.1

package/README.md

@@ -28,7 +28,7 @@ Make sure to install this as a normal dependency (not just a dev dependency) bec
 
 # Usage
 
-Most usage of this package is done through the `defineElement` or `defineElementNoInputs` functions. See the [`DeclarativeElementInit`](https://github.com/electrovir/element-vir/blob/main/src/declarative-element/declarative-element-init.ts) type for that function's full inputs. The inputs are also described below with examples.
+Most usage of this package is done through the `defineElement` or `defineElementNoInputs` functions. See the [`DeclarativeElementInit`](https://github.com/electrovir/element-vir/blob/dev/packages/src/declarative-element/declarative-element-init.ts) type for that function's full inputs. The inputs are also described below with examples.
 
 All of [`lit`](https://lit.dev)'s syntax and functionality is available for use if you wish.
 

package/dist/declarative-element/declarative-element.d.ts

@@ -1,4 +1,5 @@
-import { RequiredAndNotNullBy } from '@augment-vir/common';
+import { AnyFunction, RequiredAndNotNullBy } from '@augment-vir/common';
+import { IsAny, IsEmptyObject } from 'type-fest';
 import { CSSResult, LitElement } from '../lit-exports/all-lit-exports';
 import { MinimalDefinitionWithInputs } from '../template-transforms/minimal-element-definition';
 import { CustomElementTagName } from './custom-tag-name';
@@ -43,11 +44,13 @@ export declare abstract class DeclarativeElement<TagName extends CustomElementTa
     abstract readonly instanceInputs: Inputs;
     abstract assignInputs(inputs: {} extends Required<Inputs> ? never : Partial<Inputs>): void;
     abstract _haveInputsBeenSet: boolean;
+    /** The element definition for this element instance. */
     abstract readonly definition: DeclarativeElementDefinition<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>;
 }
-export interface StaticDeclarativeElementProperties<TagName extends CustomElementTagName, Inputs extends PropertyInitMapBase, StateInit extends PropertyInitMapBase, EventsInit extends EventsInitMap, HostClassKeys extends BaseCssPropertyName<TagName>, CssVarKeys extends BaseCssPropertyName<TagName>, SlotNames extends ReadonlyArray<string>> {
+export type AssignMethod<Inputs extends PropertyInitMapBase> = IsAny<Inputs> extends true ? AnyFunction : IsEmptyObject<Required<Inputs>> extends true ? (inputsObject: never) => never : (inputsObject: IsEmptyObject<Required<Inputs>> extends true ? never : Inputs) => MinimalDefinitionWithInputs;
+export type StaticDeclarativeElementProperties<TagName extends CustomElementTagName, Inputs extends PropertyInitMapBase, StateInit extends PropertyInitMapBase, EventsInit extends EventsInitMap, HostClassKeys extends BaseCssPropertyName<TagName>, CssVarKeys extends BaseCssPropertyName<TagName>, SlotNames extends ReadonlyArray<string>> = {
     /** Assign inputs to an element directly on its interpolated tag. */
-    readonly assign: (inputsObject: {} extends Required<Inputs> ? never : Inputs) => MinimalDefinitionWithInputs;
+    readonly assign: AssignMethod<Inputs>;
     assignedInputs: Inputs | undefined;
     /** Pass through the render callback for direct unit testability */
     readonly renderCallback: RenderCallback<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>;
@@ -64,4 +67,4 @@ export interface StaticDeclarativeElementProperties<TagName extends CustomElemen
     readonly cssVars: CssVars<TagName, CssVarKeys>;
     readonly tagName: string;
     readonly styles: CSSResult;
-}
+};

package/dist/declarative-element/define-element-no-inputs.d.ts

@@ -5,4 +5,4 @@ import { BaseCssPropertyName } from './properties/css-properties';
 import { EventsInitMap } from './properties/element-events';
 import { PropertyInitMapBase } from './properties/element-properties';
 export type VerifiedElementNoInputsInit<TagName extends CustomElementTagName, Inputs extends PropertyInitMapBase, StateInit extends PropertyInitMapBase, EventsInit extends EventsInitMap, HostClassKeys extends BaseCssPropertyName<TagName>, CssVarKeys extends BaseCssPropertyName<TagName>, SlotNames extends ReadonlyArray<string>> = Extract<keyof StateInit, keyof HTMLElement> extends never ? DeclarativeElementInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames> : 'ERROR: Cannot define an element state property that clashes with native HTMLElement properties.';
-export declare function defineElementNoInputs<const TagName extends CustomElementTagName = '-', Inputs extends PropertyInitMapBase = {}, StateInit extends PropertyInitMapBase = {}, EventsInit extends EventsInitMap = {}, const HostClassKeys extends BaseCssPropertyName<TagName> = `${TagName}-`, const CssVarKeys extends BaseCssPropertyName<TagName> = `${TagName}-`, const SlotNames extends ReadonlyArray<string> = []>(initInput: VerifiedElementNoInputsInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>): DeclarativeElementDefinition<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>;
+export declare function defineElementNoInputs<const TagName extends CustomElementTagName = '-', Inputs extends PropertyInitMapBase = {}, StateInit extends PropertyInitMapBase = {}, EventsInit extends EventsInitMap = {}, const HostClassKeys extends BaseCssPropertyName<TagName> = `${TagName}-`, const CssVarKeys extends BaseCssPropertyName<TagName> = `${TagName}-`, const SlotNames extends ReadonlyArray<string> = Readonly<[]>>(initInput: VerifiedElementNoInputsInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>): DeclarativeElementDefinition<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>;

package/dist/declarative-element/define-element.d.ts

@@ -5,4 +5,4 @@ import { BaseCssPropertyName } from './properties/css-properties';
 import { EventsInitMap } from './properties/element-events';
 import { PropertyInitMapBase } from './properties/element-properties';
 export type VerifiedElementInit<TagName extends CustomElementTagName, Inputs extends PropertyInitMapBase, StateInit extends PropertyInitMapBase, EventsInit extends EventsInitMap, HostClassKeys extends BaseCssPropertyName<TagName>, CssVarKeys extends BaseCssPropertyName<TagName>, SlotNames extends ReadonlyArray<string>> = Extract<keyof StateInit, keyof Inputs> extends never ? Extract<keyof Inputs, keyof HTMLElement> extends never ? VerifiedElementNoInputsInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames> : 'ERROR: Cannot define an element input property that clashes with native HTMLElement properties.' : "ERROR: Cannot define an element state property that clashes with the element's input properties.";
-export declare function defineElement<Inputs extends PropertyInitMapBase = {}>(): <TagName extends `${string}-${string}`, StateInit extends PropertyInitMapBase = {}, EventsInit extends EventsInitMap = {}, HostClassKeys extends `${TagName}-${string}` = `${TagName}-`, CssVarKeys extends `${TagName}-${string}` = `${TagName}-`, SlotNames extends readonly string[] = []>(initInput: VerifiedElementInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>) => DeclarativeElementDefinition<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>;
+export declare function defineElement<Inputs extends PropertyInitMapBase = {}>(): <TagName extends `${string}-${string}`, StateInit extends PropertyInitMapBase = {}, EventsInit extends EventsInitMap = {}, HostClassKeys extends `${TagName}-${string}` = `${TagName}-`, CssVarKeys extends `${TagName}-${string}` = `${TagName}-`, SlotNames extends readonly string[] = readonly []>(initInput: VerifiedElementInit<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>) => DeclarativeElementDefinition<TagName, Inputs, StateInit, EventsInit, HostClassKeys, CssVarKeys, SlotNames>;

package/dist/template-transforms/vir-html/html-interpolation.d.ts

@@ -12,4 +12,4 @@ export type DirectiveOutput = EmptyObject;
  * This is used in order to block accidental object interpolations into HTML, which get stringified
  * into `'[object Object]'`, which nobody ever wants that.
  */
-export type HtmlInterpolation = null | undefined | string | number | boolean | bigint | CSSResult | TemplateResult | MinimalDefinitionWithInputs | DeclarativeElementDefinition | DirectiveOutput | AnyFunction | HtmlInterpolation[];
+export type HtmlInterpolation = null | undefined | string | number | boolean | bigint | CSSResult | Element | TemplateResult | MinimalDefinitionWithInputs | DeclarativeElementDefinition | DirectiveOutput | AnyFunction | HtmlInterpolation[];

package/package.json

@@ -1,15 +1,18 @@
 {
     "name": "element-vir",
-    "version": "20.0.0",
+    "version": "20.0.1",
     "keywords": [
         "custom",
         "web",
         "components",
         "elements",
         "declarative",
-        "lit"
+        "reactive",
+        "lit",
+        "lit-html",
+        "html"
     ],
-    "homepage": "https://github.com/electrovir/element-vir",
+    "homepage": "https://electrovir.github.io/element-vir/element-vir",
     "bugs": {
         "url": "https://github.com/electrovir/element-vir/issues"
     },
@@ -25,19 +28,14 @@
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {
-        "compile": "virmator compile",
+        "build:pages": "npm run docs",
+        "compile": "rm -rf dist && tsc -b -f --pretty",
         "docs": "virmator docs",
-        "format": "virmator format",
-        "publish": "virmator publish \"npm run compile && npm run test:all\"",
-        "start": "npm run compile && npm install && virmator frontend",
+        "start": "cd ../element-vir-example && npm start",
         "test": "virmator test-web",
-        "test:all": "concurrently -c auto --kill-others-on-fail --colors --names types,tests,spelling,format,docs \"npm run test:types\" \"npm run test:coverage\" \"npm run test:spelling\" \"npm run test:format\" \"npm run test:docs\"",
-        "test:coverage": "virmator test-web coverage",
-        "test:deps": "virmator deps check",
+        "test:coverage": "npm run test coverage",
         "test:docs": "virmator docs check",
-        "test:format": "virmator format check",
-        "test:spelling": "virmator spellcheck",
-        "test:types": "tsc --noEmit"
+        "test:types": "npm run compile"
     },
     "dependencies": {
         "@augment-vir/common": "^22.4.0",
@@ -60,37 +58,12 @@
         "@web/test-runner-commands": "^0.9.0",
         "@web/test-runner-playwright": "^0.11.0",
         "@web/test-runner-visual-regression": "^0.9.0",
-        "ansi-colors": "^4.1.3",
-        "concurrently": "^8.2.2",
-        "cspell": "^8.3.2",
-        "dependency-cruiser": "^16.0.0",
-        "element-book": "^10.1.10",
-        "element-vir": "file:./",
-        "esbuild": "^0.19.11",
         "istanbul-smart-text-reporter": "^1.1.3",
         "markdown-code-example-inserter": "^0.3.3",
-        "mocha-spec-reporter-with-file-names": "^0.0.3",
-        "npm-check-updates": "~16.12.3",
-        "nyc": "^15.1.0",
-        "prettier": "^3.2.1",
-        "prettier-plugin-interpolated-html-tags": "^1.0.3",
-        "prettier-plugin-jsdoc": "^1.3.0",
-        "prettier-plugin-multiline-arrays": "^3.0.1",
-        "prettier-plugin-organize-imports": "^3.2.4",
-        "prettier-plugin-packagejson": "^2.4.9",
-        "prettier-plugin-sort-json": "^3.1.0",
-        "prettier-plugin-toml": "^2.0.1",
-        "ts-node": "^10.9.2",
         "type-fest": "^4.9.0",
         "typedoc": "^0.25.7",
         "typescript": "^5.3.3",
-        "vira": "^2.5.5",
-        "virmator": "^11.2.0",
         "vite": "^4.5.0",
         "vite-tsconfig-paths": "^4.2.3"
-    },
-    "overrides": {
-        "lit": "^3.1.1",
-        "element-vir": "*"
     }
 }

package/cspell.config.cjs

@@ -1,11 +0,0 @@
-const {baseConfig} = require('virmator/base-configs/base-cspell.js');
-
-module.exports = {
-    ...baseConfig,
-    ignorePaths: [
-        ...baseConfig.ignorePaths,
-    ],
-    words: [
-        ...baseConfig.words,
-    ],
-};