@platforma-sdk/model 1.61.1 → 1.63.0

package/src/plugin_model.ts

@@ -8,6 +8,7 @@
  */
 
 import type { BlockCodeKnownFeatureFlags, OutputWithStatus } from "@milaboratories/pl-model-common";
+import type { ResolveModelServices, ResolveUiServices } from "./services/service_resolve";
 import {
   type DataModel,
   DataModelBuilder,
@@ -22,6 +23,30 @@ import type { PluginRenderCtx } from "./render";
 /** Symbol for internal builder creation method */
 const FROM_BUILDER = Symbol("fromBuilder");
 
+/** Output function signature for plugin render context. */
+type PluginOutputFn<
+  Data extends PluginData,
+  Params extends PluginParams,
+  ModelServices,
+  UiServices,
+  T,
+> = (
+  ctx: PluginRenderCtx<
+    PluginFactoryLike<Data, Params, Record<string, unknown>, ModelServices, UiServices>
+  >,
+) => T;
+
+/** Mapped output functions for a plugin's outputs. */
+type PluginOutputFns<
+  Data extends PluginData,
+  Params extends PluginParams,
+  Outputs extends PluginOutputs,
+  ModelServices,
+  UiServices,
+> = {
+  [K in keyof Outputs]: PluginOutputFn<Data, Params, ModelServices, UiServices, Outputs[K]>;
+};
+
 /** Symbol for internal plugin model creation — not accessible to external consumers */
 export const CREATE_PLUGIN_MODEL = Symbol("createPluginModel");
 
@@ -282,45 +307,68 @@ export class PluginInstance<
   Params extends PluginParams = undefined,
   Outputs extends PluginOutputs = PluginOutputs,
   TransferData = never,
+  ModelServices = unknown,
+  UiServices = unknown,
 > implements TransferTarget<Id, TransferData> {
   readonly id: Id;
   readonly transferVersion: string;
-  /** @internal Phantom for type inference of Data/Params/Outputs; never set at runtime. */
-  readonly __instanceTypes?: { data: Data; params: Params; outputs: Outputs };
-  private readonly factory: PluginModelFactory<Data, Params, Outputs, any, any>;
-  private readonly config: any;
+  /** @internal Phantom for type inference; never set at runtime. */
+  readonly __instanceTypes?: {
+    data: Data;
+    params: Params;
+    outputs: Outputs;
+    modelServices: ModelServices;
+    uiServices: UiServices;
+  };
+  /** Bound closure that creates the PluginModel. Config is captured at factory.create() time. */
+  private readonly createPluginModel: () => PluginModel<
+    Data,
+    Params,
+    Outputs,
+    ModelServices,
+    UiServices
+  >;
 
   private constructor(
     id: Id,
-    factory: PluginModelFactory<Data, Params, Outputs, any, any>,
+    createPluginModel: () => PluginModel<Data, Params, Outputs, ModelServices, UiServices>,
     transferVersion: string,
-    config?: any,
   ) {
     this.id = id;
-    this.factory = factory;
+    this.createPluginModel = createPluginModel;
     this.transferVersion = transferVersion;
-    this.config = config;
   }
 
-  /** @internal */
+  /** @internal Accepts concrete Config — binds it into a closure, avoiding Config variance issues. */
   static [FROM_BUILDER]<
     Id extends string,
     Data extends PluginData,
     Params extends PluginParams,
     Outputs extends PluginOutputs,
     TransferData,
+    Config extends PluginConfig = PluginConfig,
+    ModelServices = unknown,
+    UiServices = unknown,
   >(
     id: Id,
-    factory: PluginModelFactory<Data, Params, Outputs, any, any>,
+    factory: PluginModelFactory<
+      Data,
+      Params,
+      Outputs,
+      Config,
+      Record<string, unknown>,
+      ModelServices,
+      UiServices
+    >,
     transferVersion: string,
-    config?: any,
-  ): PluginInstance<Id, Data, Params, Outputs, TransferData> {
-    return new PluginInstance(id, factory, transferVersion, config);
+    config?: Config,
+  ): PluginInstance<Id, Data, Params, Outputs, TransferData, ModelServices, UiServices> {
+    return new PluginInstance(id, () => factory[CREATE_PLUGIN_MODEL](config), transferVersion);
   }
 
   /** @internal Create a PluginModel from this instance. Used by BlockModelV3.plugin(). */
-  [CREATE_PLUGIN_MODEL](): PluginModel<Data, Params, Outputs> {
-    return this.factory[CREATE_PLUGIN_MODEL](this.config);
+  [CREATE_PLUGIN_MODEL](): PluginModel<Data, Params, Outputs, ModelServices, UiServices> {
+    return this.createPluginModel();
   }
 }
 
@@ -332,15 +380,15 @@ export class PluginModel<
   Data extends PluginData = PluginData,
   Params extends PluginParams = undefined,
   Outputs extends PluginOutputs = PluginOutputs,
+  ModelServices = {},
+  UiServices = {},
 > {
   /** Globally unique plugin name */
   readonly name: PluginName;
   /** Data model instance for this plugin */
   readonly dataModel: DataModel<Data>;
   /** Output definitions - functions that compute outputs from plugin context */
-  readonly outputs: {
-    [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-  };
+  readonly outputs: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
   /** Per-output flags (e.g. withStatus) */
   readonly outputFlags: Record<string, { withStatus: boolean }>;
   /** Feature flags declared by this plugin */
@@ -351,9 +399,7 @@ export class PluginModel<
   private constructor(options: {
     name: PluginName;
     dataModel: DataModel<Data>;
-    outputs: {
-      [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-    };
+    outputs: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
     outputFlags: Record<string, { withStatus: boolean }>;
     featureFlags?: BlockCodeKnownFeatureFlags;
     getDefaultData: () => DataVersioned<Data>;
@@ -375,17 +421,17 @@ export class PluginModel<
     Data extends PluginData,
     Params extends PluginParams,
     Outputs extends PluginOutputs,
+    ModelServices = {},
+    UiServices = {},
   >(options: {
     name: PluginName;
     dataModel: DataModel<Data>;
-    outputs: {
-      [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-    };
+    outputs: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
     outputFlags: Record<string, { withStatus: boolean }>;
     featureFlags?: BlockCodeKnownFeatureFlags;
     getDefaultData: () => DataVersioned<Data>;
-  }): PluginModel<Data, Params, Outputs> {
-    return new PluginModel<Data, Params, Outputs>(options);
+  }): PluginModel<Data, Params, Outputs, ModelServices, UiServices> {
+    return new PluginModel<Data, Params, Outputs, ModelServices, UiServices>(options);
   }
 
   /**
@@ -409,11 +455,19 @@ export class PluginModel<
     Params extends PluginParams = undefined,
     Versions extends Record<string, unknown> = {},
     Config extends PluginConfig = undefined,
+    Flags extends BlockCodeKnownFeatureFlags = {},
   >(options: {
     name: PluginName;
     data: PluginDataModel<Data, Versions, Config>;
-    featureFlags?: BlockCodeKnownFeatureFlags;
-  }): PluginModelBuilder<Data, Params, {}, Config, Versions>;
+    featureFlags?: Flags;
+  }): PluginModelInitialBuilder<
+    Data,
+    Params,
+    Config,
+    Versions,
+    ResolveModelServices<Flags>,
+    ResolveUiServices<Flags>
+  >;
   /**
    * Creates a new PluginModelBuilder with a data model factory function (backward compatible).
    *
@@ -427,26 +481,34 @@ export class PluginModel<
     Data extends PluginData,
     Params extends PluginParams = undefined,
     Config extends PluginConfig = undefined,
+    Flags extends BlockCodeKnownFeatureFlags = {},
   >(options: {
     name: PluginName;
     data: (config?: Config) => DataModel<Data>;
-    featureFlags?: BlockCodeKnownFeatureFlags;
-  }): PluginModelBuilder<Data, Params, {}, Config, {}>;
+    featureFlags?: Flags;
+  }): PluginModelInitialBuilder<
+    Data,
+    Params,
+    Config,
+    {},
+    ResolveModelServices<Flags>,
+    ResolveUiServices<Flags>
+  >;
   static define(options: {
     name: PluginName;
     data: PluginDataModel<any, any, any> | ((config?: any) => DataModel<any>);
     featureFlags?: BlockCodeKnownFeatureFlags;
-  }): PluginModelBuilder {
+  }): PluginModelInitialBuilder {
     if (options.data instanceof PluginDataModel) {
       const pdm = options.data;
-      return PluginModelBuilder[FROM_BUILDER]({
+      return PluginModelInitialBuilder.create({
         name: options.name,
         dataFn: () => pdm.dataModel,
         getDefaultDataFn: (config: any) => pdm.getDefaultData(config),
         featureFlags: options.featureFlags,
       });
     }
-    return PluginModelBuilder[FROM_BUILDER]({
+    return PluginModelInitialBuilder.create({
       name: options.name,
       dataFn: options.data,
       featureFlags: options.featureFlags,
@@ -461,13 +523,15 @@ export interface PluginFactory<
   Outputs extends PluginOutputs = PluginOutputs,
   Config extends PluginConfig = undefined,
   Versions extends Record<string, unknown> = {},
-> extends PluginFactoryLike<Data, Params, Outputs> {
+  ModelServices = {},
+  UiServices = {},
+> extends PluginFactoryLike<Data, Params, Outputs, ModelServices, UiServices> {
   /** Create a named plugin instance, optionally with transfer at a specific version. */
   create<const Id extends string, const V extends string & keyof Versions = never>(options: {
     pluginId: Id;
     transferAt?: V;
     config?: Config;
-  }): PluginInstance<Id, Data, Params, Outputs, Versions[V]>;
+  }): PluginInstance<Id, Data, Params, Outputs, Versions[V], ModelServices, UiServices>;
 
   /**
    * @internal Phantom field for structural type extraction.
@@ -477,6 +541,8 @@ export interface PluginFactory<
     data: Data;
     params: Params;
     outputs: Outputs;
+    modelServices: ModelServices;
+    uiServices: UiServices;
     config: Config;
     versions: Versions;
   };
@@ -488,13 +554,13 @@ class PluginModelFactory<
   Outputs extends PluginOutputs = PluginOutputs,
   Config extends PluginConfig = undefined,
   Versions extends Record<string, unknown> = {},
-> implements PluginFactory<Data, Params, Outputs, Config, Versions> {
+  ModelServices = {},
+  UiServices = {},
+> implements PluginFactory<Data, Params, Outputs, Config, Versions, ModelServices, UiServices> {
   private readonly name: PluginName;
   private readonly dataFn: (config?: Config) => DataModel<Data>;
   private readonly getDefaultDataFn?: (config?: Config) => DataVersioned<Data>;
-  readonly outputs: {
-    [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-  };
+  readonly outputs: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
   private readonly outputFlags: Record<string, { withStatus: boolean }>;
   private readonly featureFlags?: BlockCodeKnownFeatureFlags;
 
@@ -502,9 +568,7 @@ class PluginModelFactory<
     name: PluginName;
     dataFn: (config?: Config) => DataModel<Data>;
     getDefaultDataFn?: (config?: Config) => DataVersioned<Data>;
-    outputs: {
-      [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-    };
+    outputs: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
     outputFlags: Record<string, { withStatus: boolean }>;
     featureFlags?: BlockCodeKnownFeatureFlags;
   }) {
@@ -523,16 +587,16 @@ class PluginModelFactory<
     Outputs extends PluginOutputs,
     Config extends PluginConfig,
     Versions extends Record<string, unknown>,
+    ModelServices = {},
+    UiServices = {},
   >(options: {
     name: PluginName;
     dataFn: (config?: Config) => DataModel<Data>;
     getDefaultDataFn?: (config?: Config) => DataVersioned<Data>;
-    outputs: {
-      [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-    };
+    outputs: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
     outputFlags: Record<string, { withStatus: boolean }>;
     featureFlags?: BlockCodeKnownFeatureFlags;
-  }): PluginModelFactory<Data, Params, Outputs, Config, Versions> {
+  }): PluginModelFactory<Data, Params, Outputs, Config, Versions, ModelServices, UiServices> {
     return new PluginModelFactory(options);
   }
 
@@ -540,21 +604,27 @@ class PluginModelFactory<
     pluginId: Id;
     transferAt?: V;
     config?: Config;
-  }): PluginInstance<Id, Data, Params, Outputs, Versions[V]> {
+  }): PluginInstance<Id, Data, Params, Outputs, Versions[V], ModelServices, UiServices> {
     const transferVersion = options.transferAt ?? NO_TRANSFER_VERSION;
-    return PluginInstance[FROM_BUILDER]<Id, Data, Params, Outputs, Versions[V]>(
-      options.pluginId as Id,
-      this as any,
-      transferVersion,
-      options.config,
-    );
+    return PluginInstance[FROM_BUILDER]<
+      Id,
+      Data,
+      Params,
+      Outputs,
+      Versions[V],
+      Config,
+      ModelServices,
+      UiServices
+    >(options.pluginId as Id, this, transferVersion, options.config);
   }
 
   /** @internal Create a PluginModel from config. Config is captured in getDefaultData closure. */
-  [CREATE_PLUGIN_MODEL](config?: Config): PluginModel<Data, Params, Outputs> {
+  [CREATE_PLUGIN_MODEL](
+    config?: Config,
+  ): PluginModel<Data, Params, Outputs, ModelServices, UiServices> {
     const dataModel = this.dataFn(config);
     const getDefaultDataFn = this.getDefaultDataFn;
-    return PluginModel[FROM_BUILDER]<Data, Params, Outputs>({
+    return PluginModel[FROM_BUILDER]<Data, Params, Outputs, ModelServices, UiServices>({
       name: this.name,
       dataModel,
       outputs: this.outputs,
@@ -592,23 +662,21 @@ class PluginModelBuilder<
   Outputs extends PluginOutputs = PluginOutputs,
   Config extends PluginConfig = undefined,
   Versions extends Record<string, unknown> = {},
+  ModelServices = {},
+  UiServices = {},
 > {
-  private readonly name: PluginName;
-  private readonly dataFn: (config?: Config) => DataModel<Data>;
-  private readonly getDefaultDataFn?: (config?: Config) => DataVersioned<Data>;
-  private readonly outputs: {
-    [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-  };
+  protected readonly name: PluginName;
+  protected readonly dataFn: (config?: Config) => DataModel<Data>;
+  protected readonly getDefaultDataFn?: (config?: Config) => DataVersioned<Data>;
+  private readonly outputs: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
   private readonly outputFlags: Record<string, { withStatus: boolean }>;
-  private readonly featureFlags?: BlockCodeKnownFeatureFlags;
+  protected readonly featureFlags?: BlockCodeKnownFeatureFlags;
 
-  private constructor(options: {
+  protected constructor(options: {
     name: PluginName;
     dataFn: (config?: Config) => DataModel<Data>;
     getDefaultDataFn?: (config?: Config) => DataVersioned<Data>;
-    outputs?: {
-      [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-    };
+    outputs?: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
     outputFlags?: Record<string, { withStatus: boolean }>;
     featureFlags?: BlockCodeKnownFeatureFlags;
   }) {
@@ -616,10 +684,7 @@ class PluginModelBuilder<
     this.dataFn = options.dataFn;
     this.getDefaultDataFn = options.getDefaultDataFn;
     this.outputs =
-      options.outputs ??
-      ({} as {
-        [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-      });
+      options.outputs ?? ({} as PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>);
     this.outputFlags = options.outputFlags ?? {};
     this.featureFlags = options.featureFlags;
   }
@@ -631,16 +696,16 @@ class PluginModelBuilder<
     Outputs extends PluginOutputs,
     Config extends PluginConfig,
     Versions extends Record<string, unknown> = {},
+    ModelServices = {},
+    UiServices = {},
   >(options: {
     name: PluginName;
     dataFn: (config?: Config) => DataModel<Data>;
     getDefaultDataFn?: (config?: Config) => DataVersioned<Data>;
-    outputs?: {
-      [K in keyof Outputs]: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => Outputs[K];
-    };
+    outputs?: PluginOutputFns<Data, Params, Outputs, ModelServices, UiServices>;
     outputFlags?: Record<string, { withStatus: boolean }>;
     featureFlags?: BlockCodeKnownFeatureFlags;
-  }): PluginModelBuilder<Data, Params, Outputs, Config, Versions> {
+  }): PluginModelBuilder<Data, Params, Outputs, Config, Versions, ModelServices, UiServices> {
     return new PluginModelBuilder(options);
   }
 
@@ -657,9 +722,29 @@ class PluginModelBuilder<
    */
   output<const Key extends string, T>(
     key: Key,
-    fn: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => T,
-  ): PluginModelBuilder<Data, Params, Outputs & { [K in Key]: T }, Config, Versions> {
-    return new PluginModelBuilder<Data, Params, Outputs & { [K in Key]: T }, Config, Versions>({
+    fn: (
+      ctx: PluginRenderCtx<
+        PluginFactoryLike<Data, Params, Record<string, unknown>, ModelServices, UiServices>
+      >,
+    ) => T,
+  ): PluginModelBuilder<
+    Data,
+    Params,
+    Outputs & { [K in Key]: T },
+    Config,
+    Versions,
+    ModelServices,
+    UiServices
+  > {
+    return new PluginModelBuilder<
+      Data,
+      Params,
+      Outputs & { [K in Key]: T },
+      Config,
+      Versions,
+      ModelServices,
+      UiServices
+    >({
       name: this.name,
       dataFn: this.dataFn,
       getDefaultDataFn: this.getDefaultDataFn,
@@ -669,7 +754,9 @@ class PluginModelBuilder<
         [key]: fn,
       } as {
         [K in keyof (Outputs & { [P in Key]: T })]: (
-          ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>,
+          ctx: PluginRenderCtx<
+            PluginFactoryLike<Data, Params, Record<string, unknown>, ModelServices, UiServices>
+          >,
         ) => (Outputs & { [P in Key]: T })[K];
       },
       outputFlags: { ...this.outputFlags, [key]: { withStatus: false } },
@@ -695,20 +782,28 @@ class PluginModelBuilder<
    */
   outputWithStatus<const Key extends string, T>(
     key: Key,
-    fn: (ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>) => T,
+    fn: (
+      ctx: PluginRenderCtx<
+        PluginFactoryLike<Data, Params, Record<string, unknown>, ModelServices, UiServices>
+      >,
+    ) => T,
   ): PluginModelBuilder<
     Data,
     Params,
     Outputs & { [K in Key]: OutputWithStatus<T> },
     Config,
-    Versions
+    Versions,
+    ModelServices,
+    UiServices
   > {
     return new PluginModelBuilder<
       Data,
       Params,
       Outputs & { [K in Key]: OutputWithStatus<T> },
       Config,
-      Versions
+      Versions,
+      ModelServices,
+      UiServices
     >({
       name: this.name,
       dataFn: this.dataFn,
@@ -719,7 +814,9 @@ class PluginModelBuilder<
         [key]: fn,
       } as {
         [K in keyof (Outputs & { [P in Key]: OutputWithStatus<T> })]: (
-          ctx: PluginRenderCtx<PluginFactoryLike<Data, Params>>,
+          ctx: PluginRenderCtx<
+            PluginFactoryLike<Data, Params, Record<string, unknown>, ModelServices, UiServices>
+          >,
         ) => (Outputs & { [P in Key]: OutputWithStatus<T> })[K];
       },
       outputFlags: { ...this.outputFlags, [key]: { withStatus: true } },
@@ -739,8 +836,16 @@ class PluginModelBuilder<
    * // Create a named instance:
    * const table = myPlugin.create({ pluginId: 'mainTable', config: { ... } });
    */
-  build(): PluginFactory<Data, Params, Outputs, Config, Versions> {
-    return PluginModelFactory[FROM_BUILDER]<Data, Params, Outputs, Config, Versions>({
+  build(): PluginFactory<Data, Params, Outputs, Config, Versions, ModelServices, UiServices> {
+    return PluginModelFactory[FROM_BUILDER]<
+      Data,
+      Params,
+      Outputs,
+      Config,
+      Versions,
+      ModelServices,
+      UiServices
+    >({
       name: this.name,
       dataFn: this.dataFn,
       getDefaultDataFn: this.getDefaultDataFn,
@@ -750,3 +855,66 @@ class PluginModelBuilder<
     });
   }
 }
+
+/**
+ * Initial builder returned by PluginModel.define(). Extends PluginModelBuilder with .params().
+ * Once .params() or .output() is called, transitions to PluginModelBuilder (no second .params()).
+ */
+class PluginModelInitialBuilder<
+  Data extends PluginData = PluginData,
+  Params extends PluginParams = undefined,
+  Config extends PluginConfig = undefined,
+  Versions extends Record<string, unknown> = {},
+  ModelServices = {},
+  UiServices = {},
+> extends PluginModelBuilder<Data, Params, {}, Config, Versions, ModelServices, UiServices> {
+  /** @internal */
+  static create<
+    Data extends PluginData,
+    Config extends PluginConfig,
+    Versions extends Record<string, unknown> = {},
+    ModelServices = {},
+    UiServices = {},
+  >(options: {
+    name: PluginName;
+    dataFn: (config?: Config) => DataModel<Data>;
+    getDefaultDataFn?: (config?: Config) => DataVersioned<Data>;
+    featureFlags?: BlockCodeKnownFeatureFlags;
+  }): PluginModelInitialBuilder<Data, undefined, Config, Versions, ModelServices, UiServices> {
+    return new PluginModelInitialBuilder(options);
+  }
+
+  /**
+   * Sets the Params type for this plugin — the shape of data derived from the block's
+   * render context and passed into plugin output functions via `ctx.params`.
+   * Must be called before .output(). Available only on the initial builder.
+   *
+   * @example
+   * .params<{ title: string }>()
+   * .output('displayText', (ctx) => ctx.params.title)
+   */
+  params<P extends PluginParams>(): PluginModelBuilder<
+    Data,
+    P,
+    {},
+    Config,
+    Versions,
+    ModelServices,
+    UiServices
+  > {
+    return PluginModelBuilder[FROM_BUILDER]<
+      Data,
+      P,
+      {},
+      Config,
+      Versions,
+      ModelServices,
+      UiServices
+    >({
+      name: this.name,
+      dataFn: this.dataFn,
+      getDefaultDataFn: this.getDefaultDataFn,
+      featureFlags: this.featureFlags,
+    });
+  }
+}