@tolinax/ayoune-interfaces 2026.41.0 → 2026.43.0

package/data/modelNames.d.ts

@@ -234,6 +234,7 @@ export declare enum aMN {
     CustomFunctionLogs = "CustomFunctionLogs",
     CustomerDashboards = "CustomerDashboards",
     CustomerDatas = "CustomerDatas",
+    CustomerWidgets = "CustomerWidgets",
     Customers = "Customers",
     CustomerTokens = "CustomerTokens",
     CustomVariables = "CustomVariables",

package/data/modelNames.js

@@ -238,6 +238,7 @@ var aMN;
     aMN["CustomFunctionLogs"] = "CustomFunctionLogs";
     aMN["CustomerDashboards"] = "CustomerDashboards";
     aMN["CustomerDatas"] = "CustomerDatas";
+    aMN["CustomerWidgets"] = "CustomerWidgets";
     aMN["Customers"] = "Customers";
     aMN["CustomerTokens"] = "CustomerTokens";
     aMN["CustomVariables"] = "CustomVariables";

package/data/modelsAndRights.js

@@ -2985,6 +2985,52 @@ const modelsAndRights = [
         updateBy: "_id",
         availableInSDK: false,
     },
+    {
+        plural: "CustomerWidgets",
+        singular: "CustomerWidget",
+        module: "reporting",
+        right: "reports.customer-widgets",
+        childRights: [
+            "reports.customer-widgets.ai-create",
+            "reports.customer-widgets.public",
+        ],
+        readOnly: false,
+        importable: false,
+        allowDuplicate: true,
+        updateBy: "_id",
+        labelKey: "model.customerWidget.label",
+        labelPluralKey: "model.customerWidget.labelPlural",
+        descriptionKey: "model.customerWidget.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "count"],
+        allowStreaming: true,
+        actions: [
+            {
+                title: "Render now",
+                action: "render",
+                availability: "both",
+                method: "POST",
+                icon: "refresh",
+            },
+            {
+                title: "Duplicate",
+                action: "duplicate",
+                availability: "single",
+                method: "POST",
+                icon: "content_copy",
+            },
+            {
+                title: "Share public",
+                action: "share-public",
+                availability: "single",
+                method: "POST",
+                icon: "share",
+            },
+        ],
+        searchable: true,
+        searchableFields: ["title", "slug", "labels"],
+    },
     {
         plural: "Customers",
         singular: "Customer",

package/data/pageConfig/AyouneBasePage.interface.d.ts

@@ -1,6 +1,6 @@
 import { AyouneNewActions } from "./AyouneNewActions.interface";
 export type AyounePageTypes = 'list' | 'multi-list' | 'table' | 'detail' | 'component' | 'dashboard' | 'module-page' | 'grid' | 'i-frame' | 'sub-views';
-export type AyounePageViewModes = 'tabs' | 'accordion' | 'single' | 'stepper' | 'gridster' | 'chart-gridster';
+export type AyounePageViewModes = 'tabs' | 'accordion' | 'single' | 'stepper' | 'gridster' | 'chart-gridster' | 'form';
 export type AyounePageSubViewModes = 'tabs' | 'sidebar';
 export interface AyouneBasePage {
     pageType: AyounePageTypes;

package/interfaces/IComputingEntity.d.ts

@@ -156,12 +156,16 @@ export interface IComputingEntityConfig {
     binaries?: IComputingEntityBinary[];
     configFiles?: IComputingEntityConfigFile[];
 }
-export type RemoteCommandType = 'start-process' | 'stop-process' | 'restart-process' | 'deploy-config' | 'reboot' | 'restart-agent' | 'run-sequence' | 'remote-input';
+export type RemoteCommandType = 'start-process' | 'stop-process' | 'restart-process' | 'deploy-config' | 'reboot' | 'restart-agent' | 'run-sequence' | 'remote-input' | 'execute-cli';
 export interface IRemoteCommand {
     _id?: ObjectId;
     type: RemoteCommandType;
     programId?: string;
     payload?: any;
+    /** CLI args array for 'execute-cli' type (e.g. ['list', 'contacts', '-l', '10']) */
+    cliArgs?: string[];
+    /** Execution timeout in ms for 'execute-cli' type (default: 30000) */
+    cliTimeout?: number;
     timestamp?: Date;
     acknowledged?: boolean;
     acknowledgedAt?: Date;

package/interfaces/ICustomerWidget.d.ts

@@ -0,0 +1,57 @@
+import { IDefaultFields } from "./IDefaultFields";
+/**
+ * Customer-scoped widget instance. References a template from aYOUneWidgets
+ * (or carries an inline chartConfig for ad-hoc / AI-authored widgets) and
+ * holds resolved params plus the latest prerender URLs.
+ *
+ * Added 2026-04-17 as part of the widget prerender / chart-in-email foundation.
+ * See: C:\Users\maxim\.claude\plans\widget-foundation-echarts-ssr.md
+ */
+export interface ICustomerWidget extends IDefaultFields {
+    _customerID: ObjectId;
+    _clientID?: ObjectId[];
+    _subID?: ObjectId[];
+    /** Optional FK to aYOUneWidgets template. Null = ad-hoc / AI-authored. */
+    _widgetID?: ObjectId;
+    /** Customer-facing name. */
+    title?: string;
+    /** Stable customer-local slug. Unique per (customerID, slug). */
+    slug?: string;
+    /** Bound values for the template's paramSchema. */
+    params?: Record<string, any>;
+    /** Stable hash of (widgetID + sorted params) — cache key for prerenders. */
+    paramsHash?: string;
+    /**
+     * Optional overrides of the template's chartConfig / dataConfig.
+     * Under ECharts mode, chartConfig is an EChartsOption JSON.
+     */
+    chartConfig?: any;
+    dataConfig?: any;
+    /** Rendered image URLs. Populated by widget-prerender-worker. */
+    renderedImageUrl?: {
+        svg?: string;
+        png?: string;
+    };
+    /** When the last successful render completed. */
+    renderedAt?: Date;
+    /** Hash of the input data that produced the cached render. */
+    dataHash?: string;
+    /** How this widget came to exist — drives rights + audit. */
+    source?: "manual" | "ai-copilot" | "template" | "scheduled" | "custom-function";
+    /** Per-widget freshness policy (overrides mail template defaults). */
+    freshness?: {
+        /** Max acceptable age in seconds. */
+        maxAgeSeconds?: number;
+        /** Refresh on save of matching source collections (requires change-stream hook). */
+        refreshOnChangeOf?: string[];
+    };
+    /** Free-form tags — dashboards use these for filtering / grouping. */
+    labels?: string[];
+    /** Soft-delete flag — default true. */
+    active?: boolean;
+    /** Share-public URL token; set only when reports.customer-widgets.public granted + action invoked. */
+    publicToken?: string;
+    /** User-visible render status — surfaces failures in admin UI. */
+    renderStatus?: "pending" | "rendering" | "ready" | "failed";
+    renderError?: string;
+}

package/interfaces/ICustomerWidget.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IWidgetParamSchema.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Parameter schema for widget templates. Declared on IaYOUneWidget.paramSchema[]
+ * so instances (ICustomerWidget) can bind concrete values that the render
+ * pipeline substitutes into dataConfig filters.
+ *
+ * Added 2026-04-17 as part of the widget prerender / chart-in-email foundation.
+ */
+export interface IWidgetParamSchema {
+    /** Machine-readable key used in URL / dataConfig filter bindings. */
+    key: string;
+    /** Human-readable label for the authoring UI. Supports i18n via core's translate(). */
+    label?: string;
+    /** Declared value shape. Drives form control selection + validation. */
+    type: "string" | "number" | "boolean" | "date" | "daterange" | "locale" | "enum" | "objectid";
+    /** Must be supplied when instantiating a widget from this template. */
+    required?: boolean;
+    /** Default value substituted when an instance doesn't provide its own. */
+    default?: any;
+    /** For type: "enum" — allowed values with optional labels. */
+    enum?: {
+        value: any;
+        label?: string;
+    }[];
+    /** For type: "objectid" — which model the id points at (e.g. aMN.Markets). */
+    refModel?: string;
+    /** Longer description shown as help text in the authoring UI. */
+    description?: string;
+}

package/interfaces/IWidgetParamSchema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/IaYOUneWidget.d.ts

@@ -1,4 +1,5 @@
 import { IDefaultFields } from "./IDefaultFields";
+import { IWidgetParamSchema } from "./IWidgetParamSchema";
 export interface ILink {
     state?: string;
     params?: {
@@ -70,4 +71,24 @@ export interface IaYOUneWidget extends IDefaultFields {
     publicBeta?: boolean;
     percentageOfUsers?: number;
     GA?: boolean;
+    /**
+     * Optional customer scope. Null / absent = platform template visible to all
+     * customers. Set = customer-private template visible only to users of that
+     * customer. Added 2026-04-17.
+     */
+    _customerID?: ObjectId;
+    /**
+     * Chart render engine. When 'echarts', chartConfig holds a full
+     * EChartsOption JSON and is rendered browser-side via ngx-echarts + server
+     * -side via echarts SSR + @resvg/resvg-js. Default ('ngx-charts' or unset)
+     * preserves the legacy rendering path. Added 2026-04-17.
+     */
+    renderer?: "echarts" | "ngx-charts";
+    /**
+     * Parameter schema declaring which bindings an instance (ICustomerWidget)
+     * must / may supply (e.g. market, cadence, dateFrom). Consumed by the
+     * authoring UI, AI Copilot, and the prerender worker's param resolver.
+     * Added 2026-04-17.
+     */
+    paramSchema?: IWidgetParamSchema[];
 }

package/interfaces/index.d.ts

@@ -247,6 +247,7 @@ export * from "./ICustomConfigFile";
 export * from "./ICustomer";
 export * from "./ICustomerDashboard";
 export * from "./ICustomerData";
+export * from "./ICustomerWidget";
 export * from "./ICustomerToken";
 export * from "./ICustomVariable";
 export * from "./ICustomFunctionLog";
@@ -701,6 +702,7 @@ export * from "./IPageBlock";
 export * from "./IWhatsappLog";
 export * from "./IWidget";
 export * from "./IWidgetEmbedSite";
+export * from "./IWidgetParamSchema";
 export * from "./IWikiPage";
 export * from "./IWizard";
 export * from "./IWorkCenter";

package/interfaces/index.js

@@ -263,6 +263,7 @@ __exportStar(require("./ICustomConfigFile"), exports);
 __exportStar(require("./ICustomer"), exports);
 __exportStar(require("./ICustomerDashboard"), exports);
 __exportStar(require("./ICustomerData"), exports);
+__exportStar(require("./ICustomerWidget"), exports);
 __exportStar(require("./ICustomerToken"), exports);
 __exportStar(require("./ICustomVariable"), exports);
 __exportStar(require("./ICustomFunctionLog"), exports);
@@ -717,6 +718,7 @@ __exportStar(require("./IPageBlock"), exports);
 __exportStar(require("./IWhatsappLog"), exports);
 __exportStar(require("./IWidget"), exports);
 __exportStar(require("./IWidgetEmbedSite"), exports);
+__exportStar(require("./IWidgetParamSchema"), exports);
 __exportStar(require("./IWikiPage"), exports);
 __exportStar(require("./IWizard"), exports);
 __exportStar(require("./IWorkCenter"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-interfaces",
-  "version": "2026.41.0",
+  "version": "2026.43.0",
   "description": "Houses TypeScript interfaces for aYOUne",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",