@zaflun/lumio-extension-types 0.3.3 → 0.4.1

package/CHANGELOG.md

@@ -0,0 +1,119 @@
+# Changelog
+
+All notable changes to `@zaflun/lumio-extension-types` are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.4.1
+
+### Added
+
+- **`CHANGELOG.md` in the package** — the npm tarball ships this changelog.
+
+### Changed
+
+- **zod `^4.6.7`** — the `zod` dependency range moves up from `^4.3.6`. The
+  exported schemas and types are unchanged.
+
+## 0.4.0
+
+### Removed
+
+- **The `interactive` target** — `lumioExtensionConfigBaseSchema` accepts
+  only `editor` and `layer` in `targets`; a config that lists `interactive`
+  no longer validates. Viewers interact with an extension through chat
+  commands and channel point rewards handled by a bot module. Breaking.
+
+## 0.3.3
+
+### Changed
+
+- **Stricter `sounds` entries** — a sound's `file` is 1 to 255 characters and
+  may not contain `..` or `\` or start with `/` ("Invalid sound file path");
+  `name` is 1 to 255 characters. A config declares at most 200 sounds.
+- **The config schema documents its layer** — `lumioExtensionConfigBaseSchema`
+  describes the stored, snake_case extension config. The `lumio.config.json`
+  that `lumio init` writes and `lumio deploy` uploads is camelCase and is
+  validated by the server, not by this schema. The enum lists
+  (`VALID_PLATFORMS`, `VALID_ROLES`, `NODE_TYPES`, `TRIGGER_MODES`) are
+  casing-agnostic and apply to both.
+
+### Removed
+
+- **`trovo` in `VALID_PLATFORMS`** — the platform list is `twitch`,
+  `youtube`, `kick` and `discord`. A bot module that lists `trovo` in
+  `platforms` no longer validates. Breaking.
+
+## 0.3.2
+
+### Added
+
+- **Automation nodes** — the `automation_node` extension category, with
+  `node_type` (`NODE_TYPES`: `trigger`, `action`, `logic`) and a `node` object
+  (`automationNodeSchema`: `input_schema`, `output_schema`, `trigger_mode`,
+  `poll_interval_seconds` 10 to 300, `icon`, `color`). An automation node must
+  set `node_type`, `node` and `server: true` and include `editor` in
+  `targets`; a trigger node must set `node.trigger_mode`, and only trigger
+  nodes may set `trigger_mode` or `poll_interval_seconds`. Other categories
+  may not set `node_type` or `node`.
+- **Bundled sounds** — `sounds` in the extension config, each entry
+  `{ file, name, default_volume? }` (`lumioExtensionSoundSchema`,
+  `LumioExtensionSound`), with `default_volume` from 0 to 1.
+- **More config fields** — `icon`, `default_install` and `designer_schema`
+  on the extension config. `default_install` is reserved for system
+  extensions: a config that sets it fails validation.
+- **More config field types** — `textarea`, `slider`, `font`, `icon`,
+  `image`, `sound`, `multiselect`, `group`, `divider`, `info`, `channel`,
+  `designer` and `presets`. A field can carry `min`, `max`, `step`,
+  `placeholder`, `rows`, `unit`, `collapsed`, `visible_when`, `content`,
+  `multiple`, and nested `fields` for groups.
+- **Developer profile and team fields** — `description`, `github_url`,
+  `website_url` and `avatar_key` on profiles and teams, plus `slug` on
+  profiles. New `developerTeamMemberSchema` / `DeveloperTeamMember` and
+  `developerTeamPermissionSchema` / `DeveloperTeamPermission`.
+
+### Changed
+
+- **`default_value` is optional** on a config field.
+- **Team roles are objects** — `developerTeamRoleSchema` describes a team
+  role record (`id`, `team_id`, `name`, `slug`, `is_default`, `is_system`,
+  `color`, counts, timestamps) instead of the `owner` / `admin` / `member`
+  enum, because team roles are defined per team. Breaking.
+
+### Removed
+
+- **`DEVELOPER_TEAM_ROLES`** — fetch a team's roles from the API instead.
+  Breaking.
+
+## 0.3.0
+
+### Added
+
+- **Bot module configs** — `platforms` (`VALID_PLATFORMS`) and `triggers` on
+  the extension config. `triggers` holds `commands` (up to 20; name, cooldowns,
+  `min_role` from `VALID_ROLES`, Discord options), `keywords`, `patterns`,
+  `events` and `timers` (interval of at least 60 seconds). New exports:
+  `triggerCommandSchema`, `triggerTimerSchema`, `triggerConfigSchema`,
+  `TriggerConfig`, `TriggerCommand`.
+- **`lumioExtensionConfigBaseSchema`** — the object schema without the
+  cross-field rules, exported next to `lumioExtensionConfigSchema`.
+
+### Changed
+
+- **`targets` is optional** and defaults to `[]`. Every category except
+  `bot_module` still needs at least one target.
+- **Bot module rules** — only `bot_module` extensions may set `triggers`, and
+  a `bot_module` must list at least one platform. A `bot_module` config
+  without `platforms` no longer validates. Breaking.
+
+## 0.1.0
+
+### Added
+
+- **Initial release** — zod schemas and types for the Lumio extension store
+  (`Extension`, `ExtensionVersion`, `ExtensionInstall`, `ExtensionReview`),
+  the extension config (`lumioExtensionConfigSchema`,
+  `LumioExtensionConfig`, config fields and pricing) and developer accounts
+  (`DeveloperProfile`, `DeveloperTeam`), plus the category, visibility,
+  status and developer enums.

package/dist/index.d.ts

@@ -325,7 +325,6 @@ declare const lumioExtensionConfigBaseSchema: z.ZodObject<{
     targets: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodEnum<{
         editor: "editor";
         layer: "layer";
-        interactive: "interactive";
     }>>>>;
     server: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     permissions: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
@@ -427,7 +426,6 @@ declare const lumioExtensionConfigSchema: z.ZodObject<{
     targets: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodEnum<{
         editor: "editor";
         layer: "layer";
-        interactive: "interactive";
     }>>>>;
     server: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     permissions: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
@@ -582,4 +580,5 @@ declare const developerTeamPermissionSchema: z.ZodObject<{
 }, z.core.$strip>;
 type DeveloperTeamPermission = z.infer<typeof developerTeamPermissionSchema>;
 
-export { type AutomationNode, type AutomationNodeType, CONFIG_FIELD_TYPES, type ConfigField, type ConfigSchema, DEVELOPER_TYPES, DEVELOPER_VERIFICATION_STATUSES, type DeveloperProfile, type DeveloperTeam, type DeveloperTeamMember, type DeveloperTeamPermission, type DeveloperTeamRole, type DeveloperType, type DeveloperVerificationStatus, EXTENSION_CATEGORIES, EXTENSION_STATUSES, EXTENSION_VISIBILITIES, type Extension, type ExtensionCategory, type ExtensionInstall, type ExtensionPricing, type ExtensionReview, type ExtensionStatus, type ExtensionVersion, type ExtensionVisibility, type LumioExtensionConfig, type LumioExtensionSound, NODE_TYPES, PRICING_TYPES, type PricingType, TRIGGER_MODES, type TriggerCommand, type TriggerConfig, type TriggerMode, VALID_PLATFORMS, VALID_ROLES, VERSION_STATUSES, type VersionStatus, automationNodeSchema, configFieldSchema, configSchemaSchema, developerProfileSchema, developerTeamMemberSchema, developerTeamPermissionSchema, developerTeamRoleSchema, developerTeamSchema, developerTypeSchema, developerVerificationStatusSchema, extensionCategorySchema, extensionInstallSchema, extensionPricingSchema, extensionReviewSchema, extensionSchema, extensionStatusSchema, extensionVersionSchema, extensionVisibilitySchema, lumioExtensionConfigBaseSchema, lumioExtensionConfigSchema, lumioExtensionSoundSchema, nodeTypeSchema, pricingTypeSchema, triggerCommandSchema, triggerConfigSchema, triggerModeSchema, triggerTimerSchema, versionStatusSchema };
+export { CONFIG_FIELD_TYPES, DEVELOPER_TYPES, DEVELOPER_VERIFICATION_STATUSES, EXTENSION_CATEGORIES, EXTENSION_STATUSES, EXTENSION_VISIBILITIES, NODE_TYPES, PRICING_TYPES, TRIGGER_MODES, VALID_PLATFORMS, VALID_ROLES, VERSION_STATUSES, automationNodeSchema, configFieldSchema, configSchemaSchema, developerProfileSchema, developerTeamMemberSchema, developerTeamPermissionSchema, developerTeamRoleSchema, developerTeamSchema, developerTypeSchema, developerVerificationStatusSchema, extensionCategorySchema, extensionInstallSchema, extensionPricingSchema, extensionReviewSchema, extensionSchema, extensionStatusSchema, extensionVersionSchema, extensionVisibilitySchema, lumioExtensionConfigBaseSchema, lumioExtensionConfigSchema, lumioExtensionSoundSchema, nodeTypeSchema, pricingTypeSchema, triggerCommandSchema, triggerConfigSchema, triggerModeSchema, triggerTimerSchema, versionStatusSchema };
+export type { AutomationNode, AutomationNodeType, ConfigField, ConfigSchema, DeveloperProfile, DeveloperTeam, DeveloperTeamMember, DeveloperTeamPermission, DeveloperTeamRole, DeveloperType, DeveloperVerificationStatus, Extension, ExtensionCategory, ExtensionInstall, ExtensionPricing, ExtensionReview, ExtensionStatus, ExtensionVersion, ExtensionVisibility, LumioExtensionConfig, LumioExtensionSound, PricingType, TriggerCommand, TriggerConfig, TriggerMode, VersionStatus };

package/dist/index.js

@@ -223,7 +223,7 @@ var lumioExtensionConfigBaseSchema = z2.object({
   version: z2.string(),
   node_type: nodeTypeSchema.optional(),
   node: automationNodeSchema.optional(),
-  targets: z2.array(z2.enum(["editor", "layer", "interactive"])).optional().default([]),
+  targets: z2.array(z2.enum(["editor", "layer"])).optional().default([]),
   server: z2.boolean().optional().default(false),
   permissions: z2.array(z2.string()).optional().default([]),
   egress: z2.object({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zaflun/lumio-extension-types",
-  "version": "0.3.3",
+  "version": "0.4.1",
   "description": "Shared TypeScript types for Lumio extensions, store, and config",
   "type": "module",
   "main": "dist/index.js",
@@ -12,14 +12,15 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "dependencies": {
-    "zod": "^4.3.6"
+    "zod": "^4.6.7"
   },
   "devDependencies": {
     "typescript": "^6.0.2",
-    "tsup": "^8.4.0"
+    "tsup": "^9.0.0"
   },
   "publishConfig": {
     "access": "public"