@telesign/boreal-web-components 0.1.0-alpha.0

package/dist/types/types/alignment.d.ts

@@ -0,0 +1,8 @@
+export declare const ALIGNMENT: {
+    readonly START: "start";
+    readonly CENTER: "center";
+    readonly END: "end";
+    readonly INHERIT: "inherit";
+};
+export type Alignment = (typeof ALIGNMENT)[keyof typeof ALIGNMENT];
+//# sourceMappingURL=alignment.d.ts.map

package/dist/types/types/form.d.ts

@@ -0,0 +1,7 @@
+export type ValidationTiming = 'blur' | 'input' | 'submit';
+export interface IFormValidator {
+    key: keyof ValidityStateFlags;
+    isValid: (el: HTMLElement) => boolean;
+    message: string;
+}
+//# sourceMappingURL=form.d.ts.map

package/dist/types/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './alignment';
+export * from './form';
+export * from './size';
+export * from './states';
+export * from './stylesMap';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/position.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Define the possible positions of the floating element.
+ * This could be used to position the floating element relative to the trigger element.
+ * Are blocked posittions like 'top-start', 'top-end', 'bottom-start', and 'bottom-end'.
+ */
+export declare const POSITION: {
+    readonly TOP: "top";
+    readonly BOTTOM: "bottom";
+    readonly LEFT: "left";
+    readonly RIGHT: "right";
+};
+export type Position = (typeof POSITION)[keyof typeof POSITION];
+//# sourceMappingURL=position.d.ts.map

package/dist/types/types/size.d.ts

@@ -0,0 +1,9 @@
+export declare const SIZES: {
+    readonly XS: "xs";
+    readonly S: "sm";
+    readonly M: "md";
+    readonly L: "lg";
+    readonly XL: "xl";
+};
+export type Size = (typeof SIZES)[keyof typeof SIZES];
+//# sourceMappingURL=size.d.ts.map

package/dist/types/types/states.d.ts

@@ -0,0 +1,26 @@
+export declare const STATES: {
+    readonly DEFAULT: "default";
+    readonly ERROR: "error";
+    readonly DISABLED: "disabled";
+    readonly HOVER: "hover";
+    readonly ACTIVE: "active";
+    readonly FOCUS: "focus";
+    readonly VISITED: "visited";
+};
+export type State = (typeof STATES)[keyof typeof STATES];
+export declare const PROCESS_STATUS: {
+    readonly NEUTRAL: "neutral";
+    readonly PENDING: "pending";
+    readonly IN_PROGRESS: "in-progress";
+    readonly COMPLETE: "complete";
+    readonly CANCEL: "cancel";
+};
+export type Status = (typeof PROCESS_STATUS)[keyof typeof PROCESS_STATUS];
+export declare const STATUS_VARIANT: {
+    readonly INFO: "info";
+    readonly SUCCESS: "success";
+    readonly WARNING: "warning";
+    readonly DANGER: "danger";
+};
+export type StatusVariant = (typeof STATUS_VARIANT)[keyof typeof STATUS_VARIANT];
+//# sourceMappingURL=states.d.ts.map

package/dist/types/types/stylesMap.d.ts

@@ -0,0 +1,2 @@
+export type StyleModifiers = Record<string, boolean>;
+//# sourceMappingURL=stylesMap.d.ts.map

package/dist/types/utils/a11y/attributes.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Taken from StencilJS Ionic team
+ * This helper pass the attributes passed to components directly to the inner element
+ * e.g. <my-component aria-hidden="true">Text</my-component>
+ * will pass the aria-hidden to the inner element inside my-component
+ * <span { ...myComponentAttr }>Hidden</span>
+ */
+export interface Attributes {
+    [key: string]: string;
+}
+export declare const inheritAttributes: (el: HTMLElement, attributes?: readonly string[]) => Attributes;
+export declare const inheritAriaAttributes: (el: HTMLElement, ignoreList?: readonly string[]) => Attributes;
+//# sourceMappingURL=attributes.d.ts.map

package/dist/types/utils/a11y/index.d.ts

@@ -0,0 +1,2 @@
+export * from './attributes';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/utils/constants/common/Events.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Type to add events to the component.
+ */
+type Events = {
+    [key: string]: string;
+};
+/**
+ * Centralize list of events to add listeners to the component.
+ * Add Native or Custom events to the `EVENTS` object.
+ * This prevent typing errors when using the event name in the component, creating listeners, etc.
+ */
+export declare const EVENTS: Events;
+export {};
+//# sourceMappingURL=Events.d.ts.map

package/dist/types/utils/constants/common/Keys.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Type to add keyboard keys to the component.
+ */
+type Key = {
+    [key: string]: {
+        key: string;
+        code: number;
+    };
+};
+/**
+ * Default keyboard keys.
+ * Add more keys to the `KEYBOARD` object to add more keyboard shortcuts.
+ * This prevents key name typing errors and provides a centralized definition of the keys available for implementation.
+ * Can use this page to find the keycodes: https://keycode.info/
+ */
+export declare const KEYBOARD: Key;
+export {};
+//# sourceMappingURL=Keys.d.ts.map

package/dist/types/utils/dom/elements.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Detects whether a slot has assigned content in the host element's light DOM.
+ *
+ * Whitespace-only text nodes and comment nodes are ignored — only element nodes
+ * and non-empty text nodes are considered meaningful slot content.
+ *
+ * @param el - The host element to query.
+ * @param slotName - Named slot to check. Omit to check the default slot.
+ * @returns `true` if the slot has meaningful content, `false` otherwise.
+ */
+export declare function hasSlotContent(el: HTMLElement, slotName?: string): boolean;
+//# sourceMappingURL=elements.d.ts.map

package/dist/types/utils/dom/index.d.ts

@@ -0,0 +1,2 @@
+export * from './elements';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/utils/form/index.d.ts

@@ -0,0 +1,2 @@
+export * from './internals';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/utils/form/internals.d.ts

@@ -0,0 +1,66 @@
+import type { IFormValidator } from "../../types/form";
+/**
+ * Registers the component's current value with the browser's form machinery.
+ *
+ * Wraps `ElementInternals.setFormValue()` so the value appears in `FormData`
+ * under the component's `name` attribute when the form is submitted.
+ * Pass `null` to remove the component's contribution from `FormData`
+ * (e.g. an unchecked checkbox).
+ *
+ * @param internals - The component's `ElementInternals` instance (from `@AttachInternals()`).
+ * @param value - The value to register, or `null` to deregister.
+ *
+ * @example
+ * ```typescript
+ * // Register a string value on every value change
+ * @Watch('value')
+ * onValueChange(next: string) {
+ *   setFormValue(this.internals, next);
+ * }
+ *
+ * // Deregister when unchecked
+ * setFormValue(this.internals, null);
+ * ```
+ */
+export declare function setFormValue(internals: ElementInternals, value: FormDataEntryValue | null): void;
+/**
+ * Runs an array of validators against the host element and reports the combined
+ * result to `ElementInternals.setValidity()`.
+ *
+ * All validators are evaluated regardless of order. The first failing validator's
+ * message is used as the validation message, matching native browser behaviour
+ * (one message surfaced at a time). When all validators pass, the component is
+ * marked valid and any previous invalid state is cleared.
+ *
+ * @param internals - The component's `ElementInternals` instance (from `@AttachInternals()`).
+ * @param validators - Array of `IFormValidator` objects to evaluate.
+ * @param el - The host element passed to each validator's `isValid` function.
+ * @returns `true` if all validators pass, `false` if any fail.
+ *
+ * @example
+ * ```typescript
+ * private get validators(): IFormValidator[] {
+ *   return [
+ *     {
+ *       key: 'valueMissing',
+ *       isValid: (el) => !(el as BdsTextField).required || (el as BdsTextField).value !== '',
+ *       message: 'This field is required.',
+ *     },
+ *     {
+ *       key: 'tooShort',
+ *       isValid: (el) => {
+ *         const { value, minLength } = el as BdsTextField;
+ *         return minLength === undefined || value.length >= minLength;
+ *       },
+ *       message: `Minimum length not reached.`,
+ *     },
+ *   ];
+ * }
+ *
+ * private updateValidity() {
+ *   runValidators(this.internals, this.validators, this.el);
+ * }
+ * ```
+ */
+export declare function runValidators(internals: ElementInternals, validators: IFormValidator[], el: HTMLElement): boolean;
+//# sourceMappingURL=internals.d.ts.map

package/dist/types/utils/helpers/common/BaseAttributes.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Ensure the given component instance has an auto-generated id if one wasn't provided.
+ * Designed to be called from `componentWillLoad` on a Stencil component.
+ */
+export declare function createId(component: {
+    idComponent?: string;
+}): void;
+/**
+ * Components can spread the result into their host.
+ */
+export declare function getBaseAttributes(component: {
+    idComponent: string;
+}): {
+    id: string;
+};
+//# sourceMappingURL=BaseAttributes.d.ts.map

package/dist/types/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './a11y';
+export * from './dom';
+export * from './form';
+//# sourceMappingURL=index.d.ts.map

package/loader/cdn.js

@@ -0,0 +1,2 @@
+module.exports = require('../dist/cjs/loader.cjs.js');
+module.exports.applyPolyfills = function() { return Promise.resolve() };

package/loader/index.cjs.js

@@ -0,0 +1,2 @@
+module.exports = require('../dist/cjs/loader.cjs.js');
+module.exports.applyPolyfills = function() { return Promise.resolve() };

package/loader/index.d.ts

@@ -0,0 +1,24 @@
+export * from '../dist/types/components';
+export interface CustomElementsDefineOptions {
+  exclude?: string[];
+  resourcesUrl?: string;
+  syncQueue?: boolean;
+  jmp?: (c: Function) => any;
+  raf?: (c: FrameRequestCallback) => number;
+  ael?: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
+  rel?: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
+}
+export declare function defineCustomElements(win?: Window, opts?: CustomElementsDefineOptions): void;
+/**
+ * @deprecated
+ */
+export declare function applyPolyfills(): Promise<void>;
+
+/**
+ * Used to specify a nonce value that corresponds with an application's CSP.
+ * When set, the nonce will be added to all dynamically created script and style tags at runtime.
+ * Alternatively, the nonce value can be set on a meta tag in the DOM head
+ * (<meta name="csp-nonce" content="{ nonce value here }" />) which
+ * will result in the same behavior.
+ */
+export declare function setNonce(nonce: string): void;

package/loader/index.es2017.js

@@ -0,0 +1,2 @@
+export * from '../dist/esm/polyfills/index.js';
+export * from '../dist/esm/loader.js';

package/loader/index.js

@@ -0,0 +1,3 @@
+(function(){if("undefined"!==typeof window&&void 0!==window.Reflect&&void 0!==window.customElements){var a=HTMLElement;window.HTMLElement=function(){return Reflect.construct(a,[],this.constructor)};HTMLElement.prototype=a.prototype;HTMLElement.prototype.constructor=HTMLElement;Object.setPrototypeOf(HTMLElement,a)}})();
+export * from '../dist/esm/polyfills/index.js';
+export * from '../dist/esm-es5/loader.js';

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@telesign/boreal-web-components",
+  "version": "0.1.0-alpha.0",
+  "description": "Stencil Component Starter",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.js",
+  "types": "dist/types/index.d.ts",
+  "collection": "dist/collection/collection-manifest.json",
+  "collection:main": "dist/collection/index.js",
+  "unpkg": "dist/boreal-web-components/boreal-web-components.esm.js",
+  "exports": {
+    ".": {
+      "import": "./dist/boreal-web-components/boreal-web-components.esm.js",
+      "require": "./dist/boreal-web-components/boreal-web-components.cjs.js",
+      "types": "./dist/types/components.d.ts"
+    },
+    "./loader": {
+      "import": "./loader/index.js",
+      "require": "./loader/index.cjs",
+      "types": "./loader/index.d.ts"
+    },
+    "./components/*": {
+      "import": "./components-build/*"
+    },
+    "./types": {
+      "import": "./dist/collection/types/index.js",
+      "types": "./dist/types/types/index.d.ts"
+    },
+    "./css/*": "./dist/css/*",
+    "./scss/*": "./dist/scss/*",
+    "./styles/*": "./dist/boreal-web-components/*",
+    "./dist/*": "./dist/*",
+    "./scripts/copy-styles": "./scripts/copy-styles.js"
+  },
+  "bin": {
+    "boreal-copy-styles": "./scripts/copy-styles.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/stenciljs/component-starter.git"
+  },
+  "files": [
+    "dist/",
+    "loader/",
+    "components-build/",
+    "custom-elements.json",
+    "scripts/copy-styles.js",
+    "scripts/postbuild.js"
+  ],
+  "scripts": {
+    "build": "stencil build",
+    "postbuild": "node scripts/postbuild.js",
+    "dev": "stencil build --dev --watch --serve",
+    "test": "stencil test --spec",
+    "test:watch": "stencil test --spec --watchAll",
+    "test:coverage": "stencil test --spec --coverage",
+    "e2e": "stencil test --e2e",
+    "e2e:watch": "stencil test --e2e --watchAll",
+    "generate": "stencil generate",
+    "release": "release-it",
+    "check:cem": "tsx scripts/check-cem-changes.ts",
+    "test:scripts": "stencil test --spec --testPathPattern=scripts/",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "format": "prettier --write 'src/**/*.{ts,tsx,css,scss,json}'",
+    "format:check": "prettier --check 'src/**/*.{ts,tsx,css,scss,json}'"
+  },
+  "dependencies": {
+    "@braintree/sanitize-url": "^7.1.2",
+    "@floating-ui/dom": "^1.7.5"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@stencil/core": "^4.27.1",
+    "@stencil/eslint-plugin": "^1.1.0",
+    "@stencil/react-output-target": "^1.3.2",
+    "@stencil/sass": "^3.2.3",
+    "@stencil/vue-output-target": "^0.11.8",
+    "@telesign/boreal-style-guidelines": "workspace:*",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.13.5",
+    "eslint": "^9.39.2",
+    "eslint-plugin-jsdoc": "^62.7.1",
+    "jest": "^29.7.0",
+    "jest-cli": "^29.7.0",
+    "prettier": "3.8.0",
+    "puppeteer": "^24.3.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.50.0"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme.md

@@ -0,0 +1,111 @@
+[![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)](https://stenciljs.com)
+
+# Stencil Component Starter
+
+> This is a starter project for building a standalone Web Components using Stencil.
+
+Stencil is a compiler for building fast web apps using Web Components.
+
+Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than runtime tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements specification.
+
+Stencil components are just Web Components, so they work in any major framework or with no framework at all.
+
+## Getting Started
+
+To start building a new web component using Stencil, clone this repo to a new directory:
+
+```bash
+git clone https://github.com/stenciljs/component-starter.git my-component
+cd my-component
+git remote rm origin
+```
+
+and run:
+
+```bash
+npm install
+npm start
+```
+
+To build the component for production, run:
+
+```bash
+npm run build
+```
+
+To run the unit tests for the components, run:
+
+```bash
+npm test
+```
+
+Need help? Check out our docs [here](https://stenciljs.com/docs/my-first-component).
+
+## Naming Components
+
+When creating new component tags, we recommend _not_ using `stencil` in the component name (ex: `<stencil-datepicker>`). This is because the generated component has little to nothing to do with Stencil; it's just a web component!
+
+Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the [Ionic-generated](https://ionicframework.com/) web components use the prefix `ion`.
+
+## Using this component
+
+There are two strategies we recommend for using web components built with Stencil.
+
+The first step for all two of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+You can read more about these different approaches in the [Stencil docs](https://stenciljs.com/docs/publishing).
+
+### Lazy Loading
+
+If your Stencil project is built with the [`dist`](https://stenciljs.com/docs/distribution) output target, you can import a small bootstrap script that registers all components and allows you to load individual component scripts lazily.
+
+For example, given your Stencil project namespace is called `my-design-system`, to use `my-component` on any website, inject this into your HTML:
+
+```html
+<script type="module" src="https://unpkg.com/my-design-system"></script>
+<!--
+To avoid unpkg.com redirects to the actual file, you can also directly import:
+https://unpkg.com/foobar-design-system@0.0.1/dist/foobar-design-system/foobar-design-system.esm.js
+-->
+<my-component first="Stencil" middle="'Don't call me a framework'" last="JS"></my-component>
+```
+
+This will only load the necessary scripts needed to render `<my-component />`. Once more components of this package are used, they will automatically be loaded lazily.
+
+You can also import the script as part of your `node_modules` in your applications entry file:
+
+```tsx
+import 'foobar-design-system/dist/foobar-design-system/foobar-design-system.esm.js';
+```
+
+Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-y6v26a?file=src%2Fmain.tsx).
+
+### Standalone
+
+If you are using a Stencil component library with `dist-custom-elements`, we recommend importing Stencil components individually in those files where they are needed.
+
+To export Stencil components as standalone components make sure you have the [`dist-custom-elements`](https://stenciljs.com/docs/custom-elements) output target defined in your `stencil.config.ts`.
+
+For example, given you'd like to use `<my-component />` as part of a React component, you can import the component directly via:
+
+```tsx
+import 'foobar-design-system/my-component';
+
+function App() {
+  return (
+    <>
+      <div>
+        <my-component
+          first="Stencil"
+          middle="'Don't call me a framework'"
+          last="JS"
+        ></my-component>
+      </div>
+    </>
+  );
+}
+
+export default App;
+```
+
+Check out this [Live Demo](https://stackblitz.com/edit/vitejs-vite-b6zuds?file=src%2FApp.tsx).

package/scripts/copy-styles.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+'use strict';
+
+const { cpSync, existsSync } = require('fs');
+const { resolve } = require('path');
+
+// Primary source: boreal-web-components dist (populated by the Stencil build copy task).
+// Fallback source: boreal-styleguidelines dist (always available as a direct dependency).
+const wcDist = resolve(__dirname, '../dist');
+const sgDist = resolve(__dirname, '../node_modules/@telesign/boreal-style-guidelines/dist');
+
+const src = existsSync(`${wcDist}/css`) ? wcDist : sgDist;
+const label = src === wcDist ? '@telesign/boreal-web-components' : '@telesign/boreal-style-guidelines';
+
+cpSync(`${src}/css`, 'dist/css', { recursive: true });
+cpSync(`${src}/scss`, 'dist/scss', { recursive: true });
+
+console.log(`Styles copied from ${label}.`);

package/scripts/postbuild.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+'use strict';
+
+const { cpSync, rmSync, existsSync } = require('fs');
+const { resolve } = require('path');
+
+const distDir = resolve(__dirname, '../dist');
+const namespacedDir = resolve(distDir, 'boreal-web-components');
+
+for (const folder of ['css', 'scss']) {
+  const src = resolve(namespacedDir, folder);
+  const dest = resolve(distDir, folder);
+  if (!existsSync(src)) {
+    console.error(`postbuild: source not found: ${src}`);
+    process.exit(1);
+  }
+  if (existsSync(dest)) rmSync(dest, { recursive: true });
+  cpSync(src, dest, { recursive: true });
+}
+
+console.log('postbuild: css and scss promoted to dist/ root.');