@vnejs/plugins.views.screens.settings.contract 0.0.2

package/dist/events.d.ts

@@ -0,0 +1,8 @@
+export declare const SUBSCRIBE_EVENTS: {
+    readonly SHOW: "vne:settings_view:show";
+    readonly HIDE: "vne:settings_view:hide";
+    readonly UPDATE: "vne:settings_view:update";
+    readonly PRELOAD: "vne:settings_view:preload";
+    readonly TAB_SET: "vne:settings_view:tab_set";
+};
+export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/dist/events.js

@@ -0,0 +1,7 @@
+export const SUBSCRIBE_EVENTS = {
+    SHOW: "vne:settings_view:show",
+    HIDE: "vne:settings_view:hide",
+    UPDATE: "vne:settings_view:update",
+    PRELOAD: "vne:settings_view:preload",
+    TAB_SET: "vne:settings_view:tab_set",
+};

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import "@vnejs/shared";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import { PARAMS } from "./params.js";
+export declare const PLUGIN_NAME: "SETTINGS_VIEW";
+export type PluginName = typeof PLUGIN_NAME;
+export { SUBSCRIBE_EVENTS };
+export type { SubscribeEvents } from "./events.js";
+export { PARAMS };
+export type { Params, SettingsAction, SettingsActionContext, SettingsField, SettingsFieldOption, SettingsTab, SettingsValueMap, ViewProps, } from "./params.js";
+declare module "@vnejs/shared" {
+    interface VnePluginEventsMap extends Record<typeof PLUGIN_NAME, typeof SUBSCRIBE_EVENTS> {
+    }
+    interface VnePluginParamsMap extends Record<typeof PLUGIN_NAME, typeof PARAMS> {
+    }
+}

package/dist/index.js

@@ -0,0 +1,6 @@
+import "@vnejs/shared";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import { PARAMS } from "./params.js";
+export const PLUGIN_NAME = "SETTINGS_VIEW";
+export { SUBSCRIBE_EVENTS };
+export { PARAMS };

package/dist/params.d.ts

@@ -0,0 +1,160 @@
+import type { Module } from "@vnejs/module";
+import type { Widen } from "@vnejs/shared";
+export type SettingsValueMap = (value: number) => string;
+export type SettingsActionContext = Pick<Module, "emit" | "emitOne" | "emitReal">;
+export type SettingsAction = (context: SettingsActionContext, locs: Record<string, string>) => void;
+export type SettingsFieldOption = {
+    locKey?: string;
+    text?: string;
+    value?: unknown;
+    action?: string;
+};
+export type SettingsField = {
+    locKey?: string;
+    type?: string;
+    settingKey?: string;
+    options?: SettingsFieldOption[];
+    titleToggledLocKey?: string;
+    titleUntoggledLocKey?: string;
+    valueMap?: string;
+    step?: number;
+    min?: number;
+    max?: number;
+    [key: string]: unknown;
+};
+export type SettingsTab = {
+    titleLocKey: string;
+    acceptLocKey?: string;
+    showInSettings?: boolean;
+    showTextExample?: boolean;
+    fields: SettingsField[];
+};
+export declare const TRANSITION: number;
+export declare const ZINDEX: number;
+export declare const LOC_LABEL: string;
+export declare const BACKGROUND: string;
+export declare const TABS: Record<string, SettingsTab>;
+export declare const VALUE_MAPS: Record<string, SettingsValueMap>;
+export declare const ACTIONS: Record<string, SettingsAction>;
+declare const VIEW_PROPS_DEFAULT: {
+    readonly screen: {
+        readonly withBackgroundDark: true;
+        readonly withBackgroundBlur: false;
+        readonly transition: number;
+        readonly zIndex: number;
+    };
+    readonly background: {
+        readonly withDark: true;
+        readonly withBlur: false;
+    };
+    readonly cross: {
+        readonly position: {
+            readonly bottom: 90;
+            readonly right: 120;
+        };
+        readonly svg: {
+            readonly size: 60;
+        };
+    };
+    readonly exampleText: {
+        readonly size: 60;
+        readonly height: 300;
+        readonly color: "var(--vne-color-active)";
+        readonly transition: 300;
+    };
+    readonly fieldsGap: 48;
+    readonly fieldProps: {
+        readonly widthTitle: 1440;
+        readonly width: 3120;
+        readonly sizeTitle: 96;
+        readonly sizeText: 72;
+        readonly gapBetweenItems: 48;
+        readonly gapBetweenTitleAndContent: 120;
+        readonly gapBetweenInnerItems: 120;
+        readonly rangeHeight: 24;
+        readonly widthInnerLeft: 960;
+        readonly widthInnerRight: 240;
+    };
+    readonly controls: {
+        readonly position: {
+            readonly top: 90;
+            readonly left: 120;
+        };
+        readonly props: {
+            readonly textWidth: 660;
+            readonly wrapWidth: 3600;
+            readonly flexGap: 36;
+            readonly flexWithWrap: false;
+            readonly textSize: 96;
+            readonly textAlign: "center";
+        };
+    };
+};
+export type ViewProps = Widen<typeof VIEW_PROPS_DEFAULT>;
+export declare const VIEW_PROPS: ViewProps;
+declare const PARAMS_DEFAULT: {
+    TRANSITION: number;
+    ZINDEX: number;
+    LOC_LABEL: string;
+    BACKGROUND: string;
+    TABS: Record<string, SettingsTab>;
+    VALUE_MAPS: Record<string, SettingsValueMap>;
+    ACTIONS: Record<string, SettingsAction>;
+    VIEW_PROPS: {
+        screen: {
+            withBackgroundDark: boolean;
+            withBackgroundBlur: boolean;
+            transition: number;
+            zIndex: number;
+        };
+        background: {
+            withDark: boolean;
+            withBlur: boolean;
+        };
+        cross: {
+            position: {
+                bottom: number;
+                right: number;
+            };
+            svg: {
+                size: number;
+            };
+        };
+        exampleText: {
+            size: number;
+            height: number;
+            color: "var(--vne-color-active)";
+            transition: number;
+        };
+        fieldsGap: number;
+        fieldProps: {
+            widthTitle: number;
+            width: number;
+            sizeTitle: number;
+            sizeText: number;
+            gapBetweenItems: number;
+            gapBetweenTitleAndContent: number;
+            gapBetweenInnerItems: number;
+            rangeHeight: number;
+            widthInnerLeft: number;
+            widthInnerRight: number;
+        };
+        controls: {
+            position: {
+                top: number;
+                left: number;
+            };
+            props: {
+                textWidth: number;
+                wrapWidth: number;
+                flexGap: number;
+                flexWithWrap: boolean;
+                textSize: number;
+                textAlign: "center";
+            };
+        };
+    };
+};
+export type Params = Widen<typeof PARAMS_DEFAULT>;
+export declare const PARAMS: Params;
+export {};

package/dist/params.js

@@ -0,0 +1,33 @@
+export const TRANSITION = 500;
+export const ZINDEX = 4000;
+export const LOC_LABEL = "settings";
+export const BACKGROUND = "save";
+export const TABS = {};
+export const VALUE_MAPS = {};
+export const ACTIONS = {};
+const VIEW_PROPS_DEFAULT = {
+    screen: { withBackgroundDark: true, withBackgroundBlur: false, transition: TRANSITION, zIndex: ZINDEX },
+    background: { withDark: true, withBlur: false },
+    cross: { position: { bottom: 90, right: 120 }, svg: { size: 60 } },
+    exampleText: { size: 60, height: 300, color: "var(--vne-color-active)", transition: 300 },
+    fieldsGap: 48,
+    fieldProps: {
+        widthTitle: 1440,
+        width: 3120,
+        sizeTitle: 96,
+        sizeText: 72,
+        gapBetweenItems: 48,
+        gapBetweenTitleAndContent: 120,
+        gapBetweenInnerItems: 120,
+        rangeHeight: 24,
+        widthInnerLeft: 960,
+        widthInnerRight: 240,
+    },
+    controls: {
+        position: { top: 90, left: 120 },
+        props: { textWidth: 660, wrapWidth: 3600, flexGap: 36, flexWithWrap: false, textSize: 96, textAlign: "center" },
+    },
+};
+export const VIEW_PROPS = VIEW_PROPS_DEFAULT;
+const PARAMS_DEFAULT = { TRANSITION, ZINDEX, LOC_LABEL, BACKGROUND, TABS, VALUE_MAPS, ACTIONS, VIEW_PROPS };
+export const PARAMS = PARAMS_DEFAULT;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@vnejs/plugins.views.screens.settings.contract",
+  "version": "0.0.2",
+  "description": "Contracts for @vnejs/plugins.views.screens.settings",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "tsconfig.json"
+  ],
+  "scripts": {
+    "build": "npx @vnejs/monorepo package",
+    "publish:major": "npx @vnejs/monorepo publish major --access public",
+    "publish:minor": "npx @vnejs/monorepo publish minor --access public",
+    "publish:patch": "npx @vnejs/monorepo publish patch --access public"
+  },
+  "author": "",
+  "license": "ISC",
+  "peerDependencies": {
+    "@vnejs/shared": "~0.0.9",
+    "@vnejs/module": "~0.0.1"
+  },
+  "devDependencies": {
+    "@vnejs/configs.ts-common": "~0.0.1"
+  }
+}

package/src/events.ts

@@ -0,0 +1,9 @@
+export const SUBSCRIBE_EVENTS = {
+  SHOW: "vne:settings_view:show",
+  HIDE: "vne:settings_view:hide",
+  UPDATE: "vne:settings_view:update",
+  PRELOAD: "vne:settings_view:preload",
+  TAB_SET: "vne:settings_view:tab_set",
+} as const;
+
+export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/src/index.ts

@@ -0,0 +1,24 @@
+import "@vnejs/shared";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import { PARAMS } from "./params.js";
+
+export const PLUGIN_NAME = "SETTINGS_VIEW" as const;
+export type PluginName = typeof PLUGIN_NAME;
+export { SUBSCRIBE_EVENTS };
+export type { SubscribeEvents } from "./events.js";
+export { PARAMS };
+export type {
+  Params,
+  SettingsAction,
+  SettingsActionContext,
+  SettingsField,
+  SettingsFieldOption,
+  SettingsTab,
+  SettingsValueMap,
+  ViewProps,
+} from "./params.js";
+
+declare module "@vnejs/shared" {
+  interface VnePluginEventsMap extends Record<typeof PLUGIN_NAME, typeof SUBSCRIBE_EVENTS> {}
+  interface VnePluginParamsMap extends Record<typeof PLUGIN_NAME, typeof PARAMS> {}
+}

package/src/params.ts

@@ -0,0 +1,76 @@
+import type { Module } from "@vnejs/module";
+import type { Widen } from "@vnejs/shared";
+
+export type SettingsValueMap = (value: number) => string;
+
+export type SettingsActionContext = Pick<Module, "emit" | "emitOne" | "emitReal">;
+export type SettingsAction = (context: SettingsActionContext, locs: Record<string, string>) => void;
+
+export type SettingsFieldOption = {
+  locKey?: string;
+  text?: string;
+  value?: unknown;
+  action?: string;
+};
+
+export type SettingsField = {
+  locKey?: string;
+  type?: string;
+  settingKey?: string;
+  options?: SettingsFieldOption[];
+  titleToggledLocKey?: string;
+  titleUntoggledLocKey?: string;
+  valueMap?: string;
+  step?: number;
+  min?: number;
+  max?: number;
+  [key: string]: unknown;
+};
+
+export type SettingsTab = {
+  titleLocKey: string;
+  acceptLocKey?: string;
+  showInSettings?: boolean;
+  showTextExample?: boolean;
+  fields: SettingsField[];
+};
+
+export const TRANSITION: number = 500;
+export const ZINDEX: number = 4000;
+export const LOC_LABEL: string = "settings";
+export const BACKGROUND: string = "save";
+
+export const TABS: Record<string, SettingsTab> = {};
+export const VALUE_MAPS: Record<string, SettingsValueMap> = {};
+export const ACTIONS: Record<string, SettingsAction> = {};
+
+const VIEW_PROPS_DEFAULT = {
+  screen: { withBackgroundDark: true, withBackgroundBlur: false, transition: TRANSITION, zIndex: ZINDEX },
+  background: { withDark: true, withBlur: false },
+  cross: { position: { bottom: 90, right: 120 }, svg: { size: 60 } },
+  exampleText: { size: 60, height: 300, color: "var(--vne-color-active)", transition: 300 },
+  fieldsGap: 48,
+  fieldProps: {
+    widthTitle: 1440,
+    width: 3120,
+    sizeTitle: 96,
+    sizeText: 72,
+    gapBetweenItems: 48,
+    gapBetweenTitleAndContent: 120,
+    gapBetweenInnerItems: 120,
+    rangeHeight: 24,
+    widthInnerLeft: 960,
+    widthInnerRight: 240,
+  },
+  controls: {
+    position: { top: 90, left: 120 },
+    props: { textWidth: 660, wrapWidth: 3600, flexGap: 36, flexWithWrap: false, textSize: 96, textAlign: "center" as const },
+  },
+} as const;
+
+export type ViewProps = Widen<typeof VIEW_PROPS_DEFAULT>;
+export const VIEW_PROPS: ViewProps = VIEW_PROPS_DEFAULT;
+
+const PARAMS_DEFAULT = { TRANSITION, ZINDEX, LOC_LABEL, BACKGROUND, TABS, VALUE_MAPS, ACTIONS, VIEW_PROPS };
+export type Params = Widen<typeof PARAMS_DEFAULT>;
+export const PARAMS: Params = PARAMS_DEFAULT;

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@vnejs/configs.ts-common/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist", "node_modules"]
+}