Merge pull request #438 from phase2/feature/dependency-detangler

Dependency Updates

.gitignore

@@ -24,6 +24,7 @@ log.txt
 
 ## Types & Maps
 *.d.ts
+!component.d.ts
 *.d.ts.map
 *.js.map
 *.map

.storybook/main.js

@@ -30,11 +30,15 @@ module.exports = {
     modernInlineRender: false,
   },
   framework: {
-    name: '@storybook/web-components-vite',
+    name: getAbsolutePath('@storybook/web-components-vite'),
     options: {},
   },
   docs: {
     autodocs: true,
     defaultName: 'Documentation', // set to change the name of generated docs entries
   },
 };
+
+function getAbsolutePath(value) {
+  return dirname(require.resolve(join(value, 'package.json')));
+}

LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright (c) 2024 Phase2 Technology
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package.json

@@ -44,7 +44,7 @@
     "clean:storybook": "rimraf storybook-static",
     "clean:css": "rimraf packages/**/*.lit.*",
     "clean:maps": "rimraf packages/**/*.map",
-    "clean:types": "rimraf packages/**/*.d.ts",
+    "clean:types": "rimraf 'packages/**/!(component).d.ts'",
     "dev": "yarn watch",
     "fix": "yarn format && yarn lint",
     "format": "npm-run-all -s format:*",
@@ -85,12 +85,12 @@
     "@commitlint/cli": "^17.4.0",
     "@commitlint/config-conventional": "^17.4.0",
     "@open-wc/testing": "^3.0.0-next.2",
-    "@storybook/addon-actions": "^7.6.16",
-    "@storybook/addon-docs": "^7.6.16",
-    "@storybook/addon-essentials": "^7.6.16",
-    "@storybook/addon-links": "^7.6.16",
-    "@storybook/web-components": "^7.6.16",
-    "@storybook/web-components-vite": "^7.6.16",
+    "@storybook/addon-actions": "^7.6.17",
+    "@storybook/addon-docs": "^7.6.17",
+    "@storybook/addon-essentials": "^7.6.17",
+    "@storybook/addon-links": "^7.6.17",
+    "@storybook/web-components": "^7.6.17",
+    "@storybook/web-components-vite": "^7.6.17",
     "@types/estree": "^0.0.47",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
@@ -119,7 +119,7 @@
     "react-syntax-highlighter": "^15.5.0",
     "rimraf": "^3.0.2",
     "rsync": "^0.6.1",
-    "storybook": "^7.6.16",
+    "storybook": "^7.6.17",
     "svgo": "^2.8.0",
     "tailwindcss": "3.0.0",
     "ts-lit-plugin": "^1.2.1",

packages/components/outline-core-accordion/src/outline-core-accordion.ts

@@ -1,9 +1,6 @@
-import { html, TemplateResult } from 'lit';
+import { html, TemplateResult, LitElement } from 'lit';
 import { customElement } from 'lit/decorators.js';
 
-// Our base component, which all others extend.
-import { OutlineElement } from '@phase2/outline-core';
-
 // import componentStyles from './outline-core-accordion.css.lit';
 
 /** The element name, reused throughout the codebase */
@@ -14,7 +11,7 @@ const componentName = 'outline-core-accordion';
  * The Outline Core Accordion component
  *
  * @element outline-core-accordion
- * @extends OutlineElement
+ * @extends LitElement
  * @slot - The default slot for this element.
  *
  * @todo: Complete component.
@@ -25,14 +22,19 @@ const componentName = 'outline-core-accordion';
  * @todo: Create PR for updated and completed component.
  */
 @customElement(componentName)
-export class OutlineCoreAccordion extends OutlineElement {
+export class OutlineCoreAccordion extends LitElement {
   // static styles: CSSResultGroup = [componentStyles];
 
   render(): TemplateResult {
     return html` <slot></slot> `;
   }
 }
 
+/**
+ * TypeScript declaration extends the HTMLElementTagNameMap interface, adding
+ * the web component. This enhances type checking and autocompletion in IDEs.
+ * @see {@link https://lit.dev/docs/components/defining/#typescript-typings | Providing good TypeScript typings}
+ */
 declare global {
   interface HTMLElementTagNameMap {
     [componentName]: OutlineCoreAccordion;

packages/components/outline-core-alert/package.json

@@ -9,9 +9,12 @@
     "image",
     "picture"
   ],
-  "main": "index.ts",
-  "types": "index.ts",
-  "typings": "index.d.ts",
+  "engines": {
+    "node": ">=20"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/src/outline-core-alert.d.ts",
   "files": [
     "/dist/",
     "/src/",
@@ -29,17 +32,20 @@
     "build": "node ../../../scripts/build.js",
     "package": "yarn publish"
   },
-  "dependencies": {
-    "lit": "^3.1.2"
-  },
   "publishConfig": {
     "access": "public"
   },
   "exports": {
-    ".": "./index.ts"
+    ".": {
+      "import": "./index.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "lit": "^3.1.2",
+    "@phase2/outline-adopted-stylesheets-controller": "^1.0.2"
   },
-  "devDependencies": {
-    "@phase2/outline-adopted-stylesheets-controller": "^1.0.2",
-    "@phase2/outline-core": "^0.2.7"
-  }
+  "devDependencies": {}
 }

packages/components/outline-core-alert/src/outline-core-alert.ts

@@ -1,7 +1,6 @@
-import { html, TemplateResult } from 'lit';
+import { html, TemplateResult, LitElement } from 'lit';
 import { customElement, property } from 'lit/decorators.js';
 import { ifDefined } from 'lit/directives/if-defined.js';
-import { OutlineElement } from '@phase2/outline-core';
 import {
   CoreAlertStatusType,
   OutlineCoreAlertInterface,
@@ -18,7 +17,7 @@ const componentName = 'outline-core-alert';
  * The Outline Core Alert component
  *
  * @element outline-core-alert
- * @extends OutlineElement
+ * @extends LitElement
  * @slot header - The header in the alert.
  * @slot icon-start - The icon to display at the start of the alert.
  * @slot default - The alert contents.
@@ -39,7 +38,7 @@ const componentName = 'outline-core-alert';
  */
 @customElement(componentName)
 export class OutlineCoreAlert
-  extends OutlineElement
+  extends LitElement
   implements OutlineCoreAlertInterface
 {
   GlobalStylesheets: AdoptedStylesheets | undefined = new AdoptedStylesheets(
@@ -89,6 +88,11 @@ export class OutlineCoreAlert
   }
 }
 
+/**
+ * TypeScript declaration extends the HTMLElementTagNameMap interface, adding
+ * the web component. This enhances type checking and autocompletion in IDEs.
+ * @see {@link https://lit.dev/docs/components/defining/#typescript-typings | Providing good TypeScript typings}
+ */
 declare global {
   interface HTMLElementTagNameMap {
     [componentName]: OutlineCoreAlert;

packages/components/outline-core-alert/tsconfig.build.json

@@ -1,9 +1,9 @@
 {
-  "extends": "../../../tsconfig.json",
+  "extends": "../../../tsconfig.build.json",
   "compilerOptions": {
     "rootDir": ".",
     "outDir": "./dist"
   },
-  "include": ["index.ts", "src/**/*", "tests/**/*"],
-  "references": [{ "path": "../../outline-core/tsconfig.build.json" }]
+  "include": ["index.ts", "src/**/*", "tests/**/*", "../../env.d.ts"],
+  "exclude": ["**/*.js"]
 }

packages/components/outline-core-breadcrumb/src/outline-core-breadcrumb.ts

@@ -1,9 +1,6 @@
-import { html, TemplateResult } from 'lit';
+import { html, TemplateResult, LitElement } from 'lit';
 import { customElement } from 'lit/decorators.js';
 
-// Our base component, which all others extend.
-import { OutlineElement } from '@phase2/outline-core';
-
 // import componentStyles from './outline-core-breadcrumb.css.lit';
 
 /** The element name, reused throughout the codebase */
@@ -14,7 +11,7 @@ const componentName = 'outline-core-breadcrumb';
  * The Outline Core Breadcrumb component
  *
  * @element outline-core-breadcrumb
- * @extends OutlineElement
+ * @extends LitElement
  * @slot - The default slot for this element.
  *
  * @todo: Complete component.
@@ -25,14 +22,19 @@ const componentName = 'outline-core-breadcrumb';
  * @todo: Create PR for updated and completed component.
  */
 @customElement(componentName)
-export class OutlineCoreBreadcrumb extends OutlineElement {
+export class OutlineCoreBreadcrumb extends LitElement {
   // static styles: CSSResultGroup = [componentStyles];
 
   render(): TemplateResult {
     return html` <slot></slot> `;
   }
 }
 
+/**
+ * TypeScript declaration extends the HTMLElementTagNameMap interface, adding
+ * the web component. This enhances type checking and autocompletion in IDEs.
+ * @see {@link https://lit.dev/docs/components/defining/#typescript-typings | Providing good TypeScript typings}
+ */
 declare global {
   interface HTMLElementTagNameMap {
     [componentName]: OutlineCoreBreadcrumb;

packages/components/outline-core-card/src/outline-core-card.ts

@@ -1,9 +1,6 @@
-import { html, TemplateResult } from 'lit';
+import { html, TemplateResult, LitElement } from 'lit';
 import { customElement } from 'lit/decorators.js';
 
-// Our base component, which all others extend.
-import { OutlineElement } from '@phase2/outline-core';
-
 // import componentStyles from './outline-core-card.css.lit';
 
 /** The element name, reused throughout the codebase */
@@ -14,7 +11,7 @@ const componentName = 'outline-core-card';
  * The Outline Core Card component
  *
  * @element outline-core-card
- * @extends OutlineElement
+ * @extends LitElement
  * @slot - The default slot for this element.
  *
  * @todo: Complete component.
@@ -25,14 +22,19 @@ const componentName = 'outline-core-card';
  * @todo: Create PR for updated and completed component.
  */
 @customElement(componentName)
-export class OutlineCoreCard extends OutlineElement {
+export class OutlineCoreCard extends LitElement {
   // static styles: CSSResultGroup = [componentStyles];
 
   render(): TemplateResult {
     return html` <slot></slot> `;
   }
 }
 
+/**
+ * TypeScript declaration extends the HTMLElementTagNameMap interface, adding
+ * the web component. This enhances type checking and autocompletion in IDEs.
+ * @see {@link https://lit.dev/docs/components/defining/#typescript-typings | Providing good TypeScript typings}
+ */
 declare global {
   interface HTMLElementTagNameMap {
     [componentName]: OutlineCoreCard;

packages/components/outline-core-container/src/outline-core-container.ts

@@ -1,9 +1,6 @@
-import { html, TemplateResult } from 'lit';
+import { html, TemplateResult, LitElement } from 'lit';
 import { customElement } from 'lit/decorators.js';
 
-// Our base component, which all others extend.
-import { OutlineElement } from '@phase2/outline-core';
-
 // import componentStyles from './outline-core-container.css.lit';
 
 /** The element name, reused throughout the codebase */
@@ -14,7 +11,7 @@ const componentName = 'outline-core-container';
  * The Outline Core Container component
  *
  * @element outline-core-container
- * @extends OutlineElement
+ * @extends LitElement
  * @slot - The default slot for this element.
  *
  * @todo: Complete component.
@@ -25,14 +22,19 @@ const componentName = 'outline-core-container';
  * @todo: Create PR for updated and completed component.
  */
 @customElement(componentName)
-export class OutlineCoreContainer extends OutlineElement {
+export class OutlineCoreContainer extends LitElement {
   // static styles: CSSResultGroup = [componentStyles];
 
   render(): TemplateResult {
     return html` <slot></slot> `;
   }
 }
 
+/**
+ * TypeScript declaration extends the HTMLElementTagNameMap interface, adding
+ * the web component. This enhances type checking and autocompletion in IDEs.
+ * @see {@link https://lit.dev/docs/components/defining/#typescript-typings | Providing good TypeScript typings}
+ */
 declare global {
   interface HTMLElementTagNameMap {
     [componentName]: OutlineCoreContainer;