ose-plugin 0.1.2 → 0.1.4

package/README.md

@@ -311,10 +311,11 @@ npx ose-plugin check <папка> --json # для скриптов и CI
 
 ## Ограничения
 
-- Пакет исполняется в странице оверлея с полными правами: ставить можно только
-  доверенный код, песочницы пока нет.
-- Только 2D-виджеты; 3D-наборы и `threeDWidgets` у тем ещё не читаются.
-- Установка — папкой; zip, обновления и подписи — следующий этап.
+- Код пакета живёт в рамке-песочнице (`iframe` без доступа к странице оверлея),
+  но сеть ей доступна — ставить можно только доверенный код.
+- 3D-виджет и его тема — два пакета: в одном каталоге один манифест, а тема
+  ссылается на тип виджета через `threeDWidgets`.
+- Установка — папкой или zip; обновления и подписи — следующий этап.
 
 ## Публикация в npm
 

package/index.d.ts

@@ -122,8 +122,11 @@ declare namespace Ose {
     readCssVar?: (name: string) => string;
     t?: (key: string, params?: Record<string, unknown>) => string;
     escapeHtml?: (text: string) => string;
+    escapeAttr?: (text: string) => string;
+    formatMoney?: (value: number) => string;
+    currencySymbol?: (code: string) => string;
     resolveMediaUrl?: (path: string) => string;
-    state?: Record<string, unknown>;
+    ICONS?: Record<string, string>;
     [key: string]: unknown;
   }
 
@@ -257,6 +260,10 @@ declare namespace Ose {
     entry: string;
     styles?: string[];
     icon?: string;
+    /** 3D-виджет: canvas или 3d-webgl. По умолчанию — обычный DOM-виджет. */
+    renderType?: "2d" | "canvas" | "3d-webgl";
+    /** Семейство темы; обязательно для 3D-виджета. */
+    theme?: string;
     defaultGeometry?: Partial<Pick<Geometry, "x" | "y" | "w" | "h">>;
     minW?: number;
     minH?: number;
@@ -267,6 +274,8 @@ declare namespace Ose {
     kind: "theme";
     tokens: Record<`--${string}`, string>;
     css?: string;
+    /** Типы 3D-виджетов этой темы: включаются тумблером «3D» на карточке. */
+    threeDWidgets?: string[];
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ose-plugin",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Scaffold and validate Open Stream Environment widget and theme packages, with types for window.OSE.",
   "license": "GPL-3.0-or-later",
   "type": "module",

package/schema/theme.schema.json

@@ -52,6 +52,11 @@
       "type": "string",
       "pattern": "\\.css$",
       "description": "CSS-файл внутри пакета; правила пишутся под [data-theme=\"plugin:<id>\"]."
+    },
+    "threeDWidgets": {
+      "type": "array",
+      "description": "Типы 3D-виджетов этой темы (plugin:<id>): на карточке появится тумблер «3D», и они включатся вместе с ним.",
+      "items": { "type": "string" }
     }
   },
   "additionalProperties": true

package/schema/widget.schema.json

@@ -55,6 +55,15 @@
       "type": "string",
       "description": "Ключ из shared/icons.js; неизвестный заменяется на widgetCustom."
     },
+    "renderType": {
+      "enum": ["2d", "canvas", "3d-webgl"],
+      "description": "canvas и 3d-webgl — 3D-виджет: он попадает в набор темы и рисуется на холсте внутри песочницы."
+    },
+    "theme": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Семейство темы. Обязательно для 3D-виджета: по нему он включается и выключается вместе с набором."
+    },
     "defaultGeometry": {
       "type": "object",
       "description": "Положение и размер в процентах холста (0–100).",

package/templates/widget/widget.css

@@ -1,7 +1,7 @@
 /*
-  Стили пакета действуют на всю страницу оверлея. Корневой элемент виджета
-  помечен data-type="plugin:{{id}}" — по нему и ограничивайте правила, иначе
-  они заденут встроенные виджеты.
+  Стили пакета действуют только внутри рамки виджета: они не заденут ни
+  встроенные виджеты, ни остальную страницу. Корневой элемент виджета помечен
+  data-type="plugin:{{id}}" — по нему и ограничивайте правила.
 */
 .widget-instance[data-type="plugin:{{id}}"] {
   text-shadow: 0 1px 2px rgba(0, 0, 0, 0.45);

package/validate.mjs

@@ -179,6 +179,15 @@ function checkWidget(packageDir, manifest, errors, warnings) {
 
   checkGeometry(manifest, errors, warnings);
   checkSettings(manifest, errors, warnings);
+
+  // 3D-виджет рисует на canvas: приложение отличит его от обычного по этим
+  // полям и включит вместе с набором темы.
+  const renderType = manifest.renderType === undefined ? "2d" : manifest.renderType;
+  if (!["2d", "canvas", "3d-webgl"].includes(renderType)) {
+    errors.push(`renderType «${String(manifest.renderType)}» неизвестен: 2d, canvas или 3d-webgl`);
+  } else if (renderType !== "2d" && !text(manifest.theme)) {
+    errors.push("3D-виджету (canvas или 3d-webgl) нужно поле theme — семейство темы");
+  }
 }
 
 function checkTheme(packageDir, manifest, errors, warnings) {
@@ -200,6 +209,17 @@ function checkTheme(packageDir, manifest, errors, warnings) {
       checkFile(packageDir, manifest.css, ".css", "css", errors);
     }
   }
+
+  if (manifest.threeDWidgets !== undefined) {
+    if (!Array.isArray(manifest.threeDWidgets)) {
+      errors.push("threeDWidgets должен быть массивом типов");
+    } else {
+      manifest.threeDWidgets.forEach((kind) => {
+        if (typeof kind !== "string") errors.push("threeDWidgets содержит не строку");
+        else if (!text(kind)) warnings.push("пустой тип в threeDWidgets пропускается");
+      });
+    }
+  }
 }
 
 /** Проверить один пакет: папку с widget.json или theme.json. */