@dragcraft/widgets 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT hackycy <https://github.com/hackycy>
+
+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/dist/index.d.mts

@@ -0,0 +1,65 @@
+import { ContainerDefinition, CoreWidgetMeta, DesignerEngine, WidgetMeta } from "@dragcraft/core";
+import { Component } from "vue";
+//#region src/types.d.ts
+/**
+ * Complete widget definition combining metadata and Vue component.
+ * Used for registering widgets with the engine and renderer.
+ */
+interface WidgetDefinition<Meta extends CoreWidgetMeta = CoreWidgetMeta> {
+  /** Widget metadata for core registry */
+  meta: Meta;
+  /** Vue component for rendering in canvas */
+  component: Component;
+}
+/**
+ * Widget group name type.
+ * Accepts any string to support custom groups beyond built-in ones.
+ */
+type WidgetGroup = string;
+/**
+ * Widget group configuration with localized titles.
+ */
+interface WidgetGroupConfig {
+  name: string;
+  title: string;
+  /** i18n message key for title; overrides `title` when i18n is active */
+  titleKey?: string;
+}
+//#endregion
+//#region src/helpers.d.ts
+declare function defineContainerWidget<Meta extends WidgetMeta & {
+  container: ContainerDefinition;
+}>(definition: WidgetDefinition<Meta>): WidgetDefinition<Meta>;
+/**
+ * Registers a list of widget definitions with the given DesignerEngine.
+ *
+ * @example
+ * ```ts
+ * import { registerWidgets } from '@dragcraft/widgets'
+ *
+ * registerWidgets(engine, myWidgetDefinitions)
+ * ```
+ */
+declare function registerWidgets<Meta extends WidgetMeta>(engine: DesignerEngine, definitions: WidgetDefinition<Meta>[]): void;
+/**
+ * Builds a component map from widget definitions.
+ * Maps each widget's `type` to its Vue component.
+ *
+ * @example
+ * ```ts
+ * import { buildComponentMap } from '@dragcraft/widgets'
+ *
+ * const componentMap = buildComponentMap(myWidgetDefinitions)
+ * ```
+ */
+declare function buildComponentMap<Meta extends WidgetMeta>(definitions: WidgetDefinition<Meta>[]): Record<string, Component>;
+/**
+ * Extracts all WidgetMeta from widget definitions.
+ */
+declare function getWidgetMetas<Meta extends WidgetMeta>(definitions: WidgetDefinition<Meta>[]): Meta[];
+/**
+ * Filters widget definitions by group name.
+ */
+declare function filterByGroup<Meta extends WidgetMeta>(definitions: WidgetDefinition<Meta>[], group: string): WidgetDefinition<Meta>[];
+//#endregion
+export { type WidgetDefinition, type WidgetGroup, type WidgetGroupConfig, buildComponentMap, defineContainerWidget, filterByGroup, getWidgetMetas, registerWidgets };

package/dist/index.mjs

@@ -0,0 +1,47 @@
+//#region src/helpers.ts
+function defineContainerWidget(definition) {
+	return definition;
+}
+/**
+* Registers a list of widget definitions with the given DesignerEngine.
+*
+* @example
+* ```ts
+* import { registerWidgets } from '@dragcraft/widgets'
+*
+* registerWidgets(engine, myWidgetDefinitions)
+* ```
+*/
+function registerWidgets(engine, definitions) {
+	for (const def of definitions) engine.registerWidget(def.meta);
+}
+/**
+* Builds a component map from widget definitions.
+* Maps each widget's `type` to its Vue component.
+*
+* @example
+* ```ts
+* import { buildComponentMap } from '@dragcraft/widgets'
+*
+* const componentMap = buildComponentMap(myWidgetDefinitions)
+* ```
+*/
+function buildComponentMap(definitions) {
+	const map = {};
+	for (const def of definitions) map[def.meta.type] = def.component;
+	return map;
+}
+/**
+* Extracts all WidgetMeta from widget definitions.
+*/
+function getWidgetMetas(definitions) {
+	return definitions.map((def) => def.meta);
+}
+/**
+* Filters widget definitions by group name.
+*/
+function filterByGroup(definitions, group) {
+	return definitions.filter((def) => def.meta.group === group);
+}
+//#endregion
+export { buildComponentMap, defineContainerWidget, filterByGroup, getWidgetMetas, registerWidgets };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@dragcraft/widgets",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "@dragcraft/widgets",
+  "author": "hackycy <hackycy@outlook.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/hackycy/dragcraft#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hackycy/dragcraft.git"
+  },
+  "bugs": "https://github.com/hackycy/dragcraft/issues",
+  "keywords": [],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "vue": ">=3.0.0"
+  },
+  "dependencies": {
+    "@dragcraft/core": "0.0.1"
+  },
+  "devDependencies": {
+    "vitest": "^4.0.7",
+    "vue": "^3.5.27"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "eslint",
+    "release": "bumpp",
+    "start": "tsx src/index.ts",
+    "test": "vitest",
+    "typecheck": "tsc"
+  }
+}