@colixsystems/widget-sdk 0.198.0 → 0.199.0

package/dist/manifest.cjs

@@ -329,6 +329,7 @@ function validateManifest(m) {
 }
 
 module.exports = {
+  TRANSLATIONS_MAX_KEYS,
   validateManifest,
   validateManifestTranslations,
   canonicalCategory,

package/dist/manifest.js

@@ -375,6 +375,7 @@ function validateManifest(m) {
 }
 
 export {
+  TRANSLATIONS_MAX_KEYS,
   validateManifest,
   validateManifestTranslations,
   canonicalCategory,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colixsystems/widget-sdk",
-  "version": "0.198.0",
+  "version": "0.199.0",
   "description": "Common widget interface for AppStudio. Implements WidgetManifest, WidgetContext, property schema, and helper hooks.",
   "homepage": "https://github.com/Colix-AB/AppStudio",
   "type": "module",
@@ -35,6 +35,12 @@
       "import": "./dist/contract.js",
       "default": "./dist/contract.cjs"
     },
+    "./bundled-assets": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/bundled-assets.cjs",
+      "import": "./dist/bundled-assets.js",
+      "default": "./dist/bundled-assets.cjs"
+    },
     "./src/webbundle.js": "./src/webbundle.js"
   },
   "bin": {

package/src/contract.js

@@ -1171,6 +1171,20 @@ const HOOKS = [
     requiredContextSlice: ["assets.list"],
     scopes: null,
   },
+  {
+    name: "useBundledAsset",
+    signature: "useBundledAsset(fileName)",
+    description:
+      "Returns the URL of an image or sound file the widget package ships in " +
+      "its assets/ directory, or null when the package has no file with that " +
+      "name. Only an uploaded package can bundle files; a widget written in " +
+      "the Studio has none.",
+    returnShape: {
+      "(returns)": "string | null",
+    },
+    requiredContextSlice: ["widget.assets"],
+    scopes: null,
+  },
   {
     name: "useFilestoreFiles",
     signature: "useFilestoreFiles({ spaceType, recordId, folderId, q, type })",
@@ -2884,6 +2898,19 @@ const ACTION_SCRIPT_GLOBALS = [
 // Mirrors action.service.js SCRIPT_MAX_BYTES.
 const ACTION_SCRIPT_MAX_BYTES = 200 * 1024;
 
+// The one package size limit; the backend derives its upload caps from it.
+const PACKAGE_MAX_BYTES = 12 * 1024 * 1024;
+
+const BUNDLED_ASSETS = {
+  directory: "assets",
+  maxFiles: 50,
+  maxNameLength: 64,
+  types: {
+    image: { extensions: ["png", "jpg", "jpeg", "gif", "webp"] },
+    audio: { extensions: ["mp3", "m4a", "wav"] },
+  },
+};
+
 /**
  * sc-4915 — the trigger set a manifest action declares, canonically ordered.
  *
@@ -3067,9 +3094,15 @@ const WIDGET_CONTEXT_SHAPE = {
   },
   widget: {
     description:
-      "Identity of the currently rendered widget instance ({ id, version }).",
+      "Identity of the currently rendered widget instance ({ id, version }) " +
+      "and the files its package bundles.",
     required: true,
-    fields: { id: "manifest.id", version: "manifest.version" },
+    fields: {
+      id: "manifest.id",
+      version: "manifest.version",
+      assets:
+        "{ [fileName]: string } — bundled file name → absolute URL; {} when the package bundles nothing",
+    },
   },
   // REQ-LAY-08 — optional host layout hint backing useFill(). True when the
   // host sized this widget to fill its layout slot's available height (a
@@ -5264,7 +5297,11 @@ const CONTRACT = deepFreeze({
   //    asset carrying `durationMs`. New `useHardwareBack(handler)` walks a
   //    widget's own pages on Android's back button (optional
   //    `ctx.navigation.onHardwareBack`; unsupported on the web).
-  version: "1.158.0",
+  // 1.159.0: additive (sc-10721) — a package may ship images and sounds in a
+  //    flat `assets/` directory (`bundledAssets`, within `packageMaxBytes`).
+  //    New `useBundledAsset(fileName)` resolves one through the new
+  //    `widget.assets` map; linter rule `bundled-asset-missing` (error).
+  version: "1.159.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,
@@ -5274,6 +5311,8 @@ const CONTRACT = deepFreeze({
   actionTriggerTypes: ACTION_TRIGGER_TYPES,
   actionScriptGlobals: ACTION_SCRIPT_GLOBALS,
   actionScriptMaxBytes: ACTION_SCRIPT_MAX_BYTES,
+  packageMaxBytes: PACKAGE_MAX_BYTES,
+  bundledAssets: BUNDLED_ASSETS,
   themeTokens: DEFAULT_THEME_TOKENS,
   themeColorTokens: THEME_COLOR_TOKENS,
   themeComponents: THEME_COMPONENTS,