@feugene/granularity 0.1.0 → 0.2.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@feugene/granularity",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "sideEffects": [
     "**/*.css"
@@ -15,6 +15,10 @@
       "types": "./types/src/i18n/index.d.ts",
       "import": "./i18n.js"
     },
+    "./vue": {
+      "types": "./types/src/vue/index.d.ts",
+      "import": "./vue.js"
+    },
     "./fileValidation": {
       "types": "./types/src/fileValidation/index.d.ts",
       "import": "./fileValidation.js"

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

@@ -0,0 +1,2 @@
+export { createGranularity, defineInstallable, installGranularity, } from './plugin';
+export type { CreateGranularityOptions, GranularityInstallableComponent, GranularityInstallableDirective, } from './plugin';

package/dist/types/src/vue/plugin.d.ts

@@ -0,0 +1,92 @@
+import type { App, Component, Directive, Plugin } from 'vue';
+/**
+ * Лёгкий контейнер, который может быть зарегистрирован в Vue:
+ * - SFC-компонент (Vue сам компилирует `__name` из имени файла) — достаточно просто передать сам компонент,
+ * - SFC-компонент с опциональным `install` (по аналогии с Element Plus / Naive UI),
+ * - объект с собственным `install`,
+ * - либо объект `{ name, component }`, если имя нужно задать явно.
+ */
+export type GranularityInstallableComponent = (Component & {
+    name?: string;
+    __name?: string;
+    install?: (app: App) => void;
+}) | {
+    install: (app: App) => void;
+} | {
+    name: string;
+    component: Component;
+};
+/**
+ * Директива — либо пара `{ name, directive }`, либо объект с `install`.
+ */
+export type GranularityInstallableDirective = {
+    name: string;
+    directive: Directive;
+} | {
+    install: (app: App) => void;
+};
+export interface CreateGranularityOptions {
+    /**
+     * Список компонентов для глобальной регистрации.
+     * Пакет сам по себе ничего не импортирует — пользователь передаёт сюда только те компоненты,
+     * которые ему действительно нужны. За счёт этого tree-shaking остаётся полным.
+     */
+    components?: GranularityInstallableComponent[];
+    /**
+     * Список директив. Передавайте ровно те, что нужны, по аналогии с компонентами.
+     */
+    directives?: GranularityInstallableDirective[];
+    /**
+     * Произвольные `provide`-значения. Ключи могут быть `symbol` или строкой.
+     * Пакет не навязывает конкретные ключи (например, i18n) — выбор за пользователем.
+     */
+    provides?: Array<{
+        key: string | symbol;
+        value: unknown;
+    }>;
+    /**
+     * Произвольные `app.config.globalProperties` — по умолчанию ничего не ставим.
+     */
+    globalProperties?: Record<string, unknown>;
+}
+/**
+ * Вспомогательная обёртка: превращает произвольный компонент в `GranularityInstallableComponent`
+ * с явным именем регистрации.
+ *
+ * ```ts
+ * import { DsButton } from '@feugene/granularity/components/DsButton'
+ * import { defineInstallable } from '@feugene/granularity/vue'
+ *
+ * const installable = defineInstallable(DsButton, 'DsButton')
+ * ```
+ */
+export declare function defineInstallable<T extends Component>(component: T, name: string): GranularityInstallableComponent;
+/**
+ * Применяет опции к переданному приложению. Экспортируется отдельно от фабрики —
+ * удобно, когда плагин не нужен (например, в тестах).
+ */
+export declare function installGranularity(app: App, options?: CreateGranularityOptions): void;
+/**
+ * Создаёт Vue-плагин `{ install }`, который при `app.use(...)` зарегистрирует переданные
+ * компоненты, директивы и provide-значения. Сам модуль НЕ импортирует ни компонентов,
+ * ни директив из пакета — всё приходит снаружи. Это сохраняет гранулярность:
+ * бандлер увидит только те символы, которые вы реально передали.
+ *
+ * ```ts
+ * import { createApp } from 'vue'
+ * import { createGranularity } from '@feugene/granularity/vue'
+ * import { DsButton } from '@feugene/granularity/components/DsButton'
+ * import { DsInput }  from '@feugene/granularity/components/DsInput'
+ * import { vHotkey }  from '@feugene/granularity/directives/hotkey'
+ *
+ * createApp(App)
+ *   .use(createGranularity({
+ *     // Достаточно передать сами компоненты — имя будет взято из `__name` (Vue SFC)
+ *     // или из `name`; можно также указать явно через `{ name, component }`.
+ *     components: [DsButton, DsInput],
+ *     directives: [{ name: 'hotkey', directive: vHotkey }],
+ *   }))
+ *   .mount('#app')
+ * ```
+ */
+export declare function createGranularity(options?: CreateGranularityOptions): Plugin;

package/dist/vue.js

@@ -0,0 +1,43 @@
+//#region src/vue/plugin.ts
+function e(e, t) {
+	return { install(n) {
+		n.component(t, e);
+	} };
+}
+function t(e, t) {
+	if (typeof t.install == "function") {
+		t.install(e);
+		return;
+	}
+	if (typeof t.name == "string" && t.component && typeof t.component == "object") {
+		let { name: n, component: r } = t;
+		e.component(n, r);
+		return;
+	}
+	let n = t.name ?? t.__name;
+	if (n) {
+		e.component(n, t);
+		return;
+	}
+	console.warn("[granularity] component passed to createGranularity has no `install`, `name`, or `__name` — skipped.");
+}
+function n(e, t) {
+	if ("install" in t && typeof t.install == "function") {
+		t.install(e);
+		return;
+	}
+	"name" in t && "directive" in t && e.directive(t.name, t.directive);
+}
+function r(e, r = {}) {
+	for (let n of r.components ?? []) t(e, n);
+	for (let t of r.directives ?? []) n(e, t);
+	for (let { key: t, value: n } of r.provides ?? []) e.provide(t, n);
+	if (r.globalProperties) for (let [t, n] of Object.entries(r.globalProperties)) e.config.globalProperties[t] = n;
+}
+function i(e = {}) {
+	return { install(t) {
+		r(t, e);
+	} };
+}
+//#endregion
+export { i as createGranularity, e as defineInstallable, r as installGranularity };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@feugene/granularity",
   "description": "Granularity design system package with Vue 3 components, styles, and UnoCSS preset.",
-  "version": "0.1.0",
-  "license": "Apache-2.0",
+  "version": "0.2.0",
+  "license": "SEE LICENSE IN LICENSE",
   "author": {
     "name": "Evgeniy Fureev",
     "url": "https://github.com/efureev"
@@ -57,6 +57,10 @@
       "types": "./dist/types/src/i18n/index.d.ts",
       "import": "./dist/i18n.js"
     },
+    "./vue": {
+      "types": "./dist/types/src/vue/index.d.ts",
+      "import": "./dist/vue.js"
+    },
     "./fileValidation": {
       "types": "./dist/types/src/fileValidation/index.d.ts",
       "import": "./dist/fileValidation.js"