@evercam/ui 0.0.61 → 0.0.62

package/dist/{src/types.d.ts → types.d.ts}

@@ -25,10 +25,25 @@ export declare enum BaseColor {
     brand = "brand",
     default = "default"
 }
+/**
+ * {@link Size}
+ * */
 export type TBadgeSize = (typeof BadgeSizes)[number];
+/**
+ * {@link Size}
+ * */
 export type TAvatarSize = (typeof AvatarSizes)[number];
+/**
+ * {@link Size}
+ * */
 export type TIconSize = (typeof IconSizes)[number];
+/**
+ * {@link Size}
+ * */
 export type TToggleSwitchSize = (typeof ToggleSwitchSizes)[number];
+/**
+ * {@link BaseColor}
+ * */
 export type TBadgeColor = (typeof BadgeColors)[number];
 export type TailwindColorClass = string;
 export type FlexJustifyContent = "around" | "between" | "center" | "end" | "evenly" | "normal" | "start" | "stretch";
@@ -45,6 +60,10 @@ export type TimelineTicksConfig = {
     interval: any;
     format: string | ((d: Date) => string);
 };
+/**
+ * {@link TimelineAxis}
+ * {@link TimelineTicksConfig}
+ * */
 export type TimelineAxesConfig = {
     [key in TimelineAxis]: TimelineTicksConfig[];
 };
@@ -77,6 +96,12 @@ export type TimelineMilestoneEvent = {
     size?: number;
     [key: string]: any;
 };
+/**
+ * {@link TimelineBarEvent}
+ * {@link TimelineRangeEvent}
+ * {@link TimelineCountEvent}
+ * {@link TimelineMilestoneEvent}
+ */
 export type TimelineEvent = TimelineBarEvent | TimelineRangeEvent | TimelineCountEvent | TimelineMilestoneEvent;
 export declare enum TimelineChartType {
     bars = "bars",
@@ -85,6 +110,10 @@ export declare enum TimelineChartType {
     barChart = "barGraph",
     milestones = "milestones"
 }
+/**
+ * {@link TimelineEvent}
+ * {@link TimelineChartType}
+ * */
 export type TimelineEventsGroup = {
     events: Array<TimelineEvent>;
     label: string;
@@ -102,6 +131,9 @@ export type TimelineEventsGroup = {
     bottom?: boolean;
     barBorderRadius?: number;
 };
+/**
+ * {@link TimelineEventsGroup}
+ * */
 export type TimelineEventsByType = {
     [eventsType: string]: TimelineEventsGroup;
 };
@@ -140,16 +172,21 @@ export type GlobalSearchMatch = {
     path: Array<string>;
     value: string | number | boolean;
 };
+/**
+ * {@link GlobalSearchMatch}
+ * */
 export type GlobalSearchResult = {
     index: number;
     matches: Array<GlobalSearchMatch>;
 };
 export type GlobalSearchResultInput = Array<Record<any, any> | Array<any>>;
+/** @ignore */
 export interface FullscreenHTMLElement extends HTMLElement {
     mozRequestFullScreen?: () => Promise<void>;
     webkitRequestFullScreen?: () => Promise<void>;
     msRequestFullscreen?: () => Promise<void>;
 }
+/** @ignore */
 export interface FullscreenDocument extends Document {
     mozCancelFullScreen?: () => Promise<void>;
     webkitCancelFullScreen?: () => Promise<void>;
@@ -161,5 +198,14 @@ export interface FullscreenDocument extends Document {
     msFullscreenEnabled: boolean;
     mozFullScreenEnabled: boolean;
 }
+export type D3TimestampParams = {
+    timestamp: string | Date;
+    timezone: string;
+};
+export type D3DateParams = {
+    date: Date;
+    timezone: string;
+};
+export type TimelineDomain = Date[] | string[];
 declare const _default: {};
 export default _default;

package/dist/{src/utils.d.ts → utils.d.ts}

@@ -2,3 +2,4 @@ export declare function isFullScreen(): boolean;
 export declare function makeFullScreen(element: HTMLElement): Promise<unknown>;
 export declare function exitFullScreen(): Promise<void | null>;
 export declare function debounce<T extends (...args: any[]) => any>(func: T, wait?: number): (...args: Parameters<T>) => void;
+export declare function getRandomChars(length?: number): string;

package/dist/web-types.json

@@ -2,7 +2,7 @@
   "$schema": "http://json.schemastore.org/web-types",
   "framework": "vue",
   "name": "@evercam/ui",
-  "version": "0.0.61",
+  "version": "0.0.62",
   "contributions": {
     "html": {
       "types-syntax": "typescript",
@@ -691,7 +691,7 @@
             {
               "name": "x-axes-config",
               "doc-url": "https://www.npmjs.com/package/@evercam/ui",
-              "default": "() => c0",
+              "default": "() => Lt",
               "value": {
                 "kind": "expression",
                 "type": "object"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evercam/ui",
-  "version": "0.0.61",
+  "version": "0.0.62",
   "license": "MIT",
   "private": false,
   "author": "Evercam - Constuction Cameras.",
@@ -27,13 +27,16 @@
     "dist"
   ],
   "scripts": {
-    "story:dev": "histoire dev",
-    "story:build": "histoire build",
-    "story:preview": "histoire preview",
     "build": "yarn build:lib && yarn build:style && yarn generate-ide-docs",
     "build:lib": "vite build",
     "build:style": "postcss src/style/main.css --verbose -o dist/styles.css",
     "build-and-copy": "yarn build && rsync -av --delete ./dist/ ../../node_modules/@evercam/ui/dist/",
+    "story:dev": "yarn stroy:build:tailwind && yarn stroy:build:typedoc && yarn stroy:dev:styleguide",
+    "stroy:dev:styleguide": "vue-styleguidist --config docs/config/styleguide.config.js server",
+    "story:build": "yarn stroy:build:typedoc && yarn stroy:build:tailwind && yarn stroy:build:styleguide",
+    "stroy:build:styleguide": "vue-styleguidist --config docs/config/styleguide.config.js build",
+    "stroy:build:typedoc": "yarn typedoc --options docs/config/typedoc.config.js --out docs/assets/typedoc",
+    "stroy:build:tailwind": "tailwind-config-viewer export docs/assets/tailwind-config-viewer",
     "typecheck": "vue-tsc --declaration --emitDeclarationOnly",
     "generate-ide-docs": "node scripts/generateVetur.mjs && node scripts/generateWebTypes.mjs",
     "ci": "(cd ../..; yarn ci)",
@@ -42,27 +45,41 @@
   "devDependencies": {
     "@fontsource-variable/inter": "^5.0.8",
     "@fortawesome/fontawesome-free": "^5.15.3",
-    "@histoire/plugin-vue2": "^0.17.1",
-    "@histoire/vendors": "^0.17.0",
     "@types/d3": "^7.4.2",
     "@types/vue": "^2.0.0",
     "@vitejs/plugin-vue2": "^2.2.0",
     "autoprefixer": "^10.4.15",
+    "browser-sync": "^3.0.2",
+    "browser-sync-webpack-plugin": "^2.3.0",
+    "css-loader": "^6.11.0",
     "d3": "^7.8.5",
-    "histoire": "^0.17.0",
     "hls.js": "^1.5.6",
     "moment-timezone": "^0.5.43",
     "postcss": "^8.4.29",
     "postcss-cli": "^10.1.0",
-    "tailwindcss": "^3.3.3",
+    "postcss-loader": "^8.1.1",
+    "style-loader": "^3.3.4",
+    "tailwind-config-viewer": "^2.0.1",
+    "tailwindcss": "^3.4.3",
+    "ts-loader": "^9.5.1",
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-markdown": "^4.0.0-next.55",
+    "typedoc-theme-hierarchy": "^4.1.2",
     "typescript": "^5.2.2",
     "vite": "^4.4.9",
+    "vite-plugin-commonjs": "^0.10.1",
     "vite-plugin-dts": "^3.6.0",
     "vscode-oniguruma": "^1.6.1",
     "vscode-textmate": "^6.0.0",
     "vue": "^2.7.16",
+    "vue-loader": "^15.0.0",
+    "vue-style-loader": "^4.1.3",
+    "vue-styleguidist": "^4.72.4",
     "vue-template-compiler": "^2.7.16",
-    "vue-tsc": "^1.8.15"
+    "vue-tsc": "^1.8.15",
+    "webpack": "^5.91.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-shell-plugin-next": "^2.3.1"
   },
   "peerDependencies": {
     "@fontsource-variable/inter": "^5.0.8",
@@ -77,4 +94,4 @@
     "attributes": "dist/attributes.json"
   },
   "web-types": "dist/web-types.json"
-}
+}

package/CHANGELOG.md

@@ -1,25 +0,0 @@
-# Changelog 
-
-## 0.0.58-preview-evercam-ui-ci-8a95cf24a (2024-04-04)
-
-* updating package version to 0.0.58-preview-evercam-ui-ci-8a95cf24a ([0d10b1294](https://github.com/evercam/evercam-frontend/commit/0d10b1294b3cfc824d0dd63090bdeb1caeb00c24))
-* trigger new build ([8a95cf24a](https://github.com/evercam/evercam-frontend/commit/8a95cf24ad763ab2f4df098bf1c26b60772eea66))
-* updating @evercam/ui to 0.0.58-preview-evercam-ui-ci-d73244c2c ([0d337b326](https://github.com/evercam/evercam-frontend/commit/0d337b326d4021e849d976a1b19a9bffe9518edc))
-* updating @evercam/ui to 0.0.58-preview-evercam-ui-ci-d73244c2c ([ae32eb977](https://github.com/evercam/evercam-frontend/commit/ae32eb9774dce7c7db0f9afeb934cc55be03eea4))
-* updating package version to 0.0.58-preview-evercam-ui-ci-d73244c2c ([2c7f9738a](https://github.com/evercam/evercam-frontend/commit/2c7f9738a697adc10b789b0ec1cd13864afd6d0b))
-* trigger a build ([d73244c2c](https://github.com/evercam/evercam-frontend/commit/d73244c2c410d9bcc7df67abe84f4ac219fbc85d))
-* trigger build ([6ba99d20a](https://github.com/evercam/evercam-frontend/commit/6ba99d20a84aeee97cab918dc1f0207c7c68d624))
-* trigger build ([162216864](https://github.com/evercam/evercam-frontend/commit/1622168643afefad3bf51978616c44371a42a645))
-* updating @evercam/ui to 0.0.58-preview-evercam-ui-ci-1581e3229 ([2ab9d4eda](https://github.com/evercam/evercam-frontend/commit/2ab9d4eda6f9999c394a3038f6945a22d8ab8968))
-* updating package version to 0.0.58-preview-evercam-ui-ci-1581e3229 ([01f2a9f6b](https://github.com/evercam/evercam-frontend/commit/01f2a9f6b43e6a3778a638dcc0dc8e541d1e5a3d))
-* fix it ([1581e3229](https://github.com/evercam/evercam-frontend/commit/1581e322926ee979f505b27f5e950c7e534a4182))
-* updating @evercam/ui to 0.0.58-preview-evercam-ui-ci-00c612b81 ([ebe811d26](https://github.com/evercam/evercam-frontend/commit/ebe811d2656741da27c56d52a59c58aa0bcbc11e))
-* Update changelog for 0.0.58-preview-evercam-ui-ci-00c612b81 ([fa028fa2c](https://github.com/evercam/evercam-frontend/commit/fa028fa2cbc62539053320d0cd657b31b6bdda4f))
-* updating package version to 0.0.58-preview-evercam-ui-ci-00c612b81 ([b0c521577](https://github.com/evercam/evercam-frontend/commit/b0c5215773e22c06ae410a0974e6baf020374b27))
-* feat: create release script for evercam-ui ([00c612b81](https://github.com/evercam/evercam-frontend/commit/00c612b81e68653aaf6bc9dcfd5a098426089811))
-
-## 0.0.58-preview-evercam-ui-ci-00c612b81 (2024-04-04)
-
-* updating package version to 0.0.58-preview-evercam-ui-ci-00c612b81 ([b0c521577](https://github.com/evercam/evercam-frontend/commit/b0c5215773e22c06ae410a0974e6baf020374b27))
-* feat: create release script for evercam-ui ([00c612b81](https://github.com/evercam/evercam-frontend/commit/00c612b81e68653aaf6bc9dcfd5a098426089811))
-