@milaboratories/pl-model-common 1.34.1 → 1.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/dist/dialog/index.d.ts +34 -0
  2. package/dist/dialog/index.d.ts.map +1 -0
  3. package/dist/drivers/index.d.ts +1 -1
  4. package/dist/drivers/pframe/data_types.cjs +1 -0
  5. package/dist/drivers/pframe/data_types.cjs.map +1 -1
  6. package/dist/drivers/pframe/data_types.d.ts +27 -1
  7. package/dist/drivers/pframe/data_types.d.ts.map +1 -1
  8. package/dist/drivers/pframe/data_types.js +1 -1
  9. package/dist/drivers/pframe/data_types.js.map +1 -1
  10. package/dist/drivers/pframe/driver.cjs.map +1 -1
  11. package/dist/drivers/pframe/driver.d.ts +6 -1
  12. package/dist/drivers/pframe/driver.d.ts.map +1 -1
  13. package/dist/drivers/pframe/driver.js.map +1 -1
  14. package/dist/drivers/pframe/index.d.ts +1 -1
  15. package/dist/index.cjs +12 -3
  16. package/dist/index.d.ts +7 -6
  17. package/dist/index.js +6 -6
  18. package/dist/ref.cjs +16 -0
  19. package/dist/ref.cjs.map +1 -1
  20. package/dist/ref.d.ts +16 -12
  21. package/dist/ref.d.ts.map +1 -1
  22. package/dist/ref.js +15 -1
  23. package/dist/ref.js.map +1 -1
  24. package/dist/services/index.cjs +1 -1
  25. package/dist/services/index.d.ts +3 -3
  26. package/dist/services/index.js +1 -1
  27. package/dist/services/{service_injector_factory.js → node_service_handlers.cjs} +6 -5
  28. package/dist/services/node_service_handlers.cjs.map +1 -0
  29. package/dist/services/node_service_handlers.d.ts +8 -0
  30. package/dist/services/node_service_handlers.d.ts.map +1 -0
  31. package/dist/services/{service_injector_factory.cjs → node_service_handlers.js} +6 -5
  32. package/dist/services/node_service_handlers.js.map +1 -0
  33. package/dist/services/service_declarations.cjs +48 -2
  34. package/dist/services/service_declarations.cjs.map +1 -1
  35. package/dist/services/service_declarations.d.ts +2 -0
  36. package/dist/services/service_declarations.d.ts.map +1 -1
  37. package/dist/services/service_declarations.js +48 -2
  38. package/dist/services/service_declarations.js.map +1 -1
  39. package/dist/services/service_injectors.cjs +29 -25
  40. package/dist/services/service_injectors.cjs.map +1 -1
  41. package/dist/services/service_injectors.d.ts +21 -10
  42. package/dist/services/service_injectors.d.ts.map +1 -1
  43. package/dist/services/service_injectors.js +29 -26
  44. package/dist/services/service_injectors.js.map +1 -1
  45. package/dist/services/service_types.cjs +26 -2
  46. package/dist/services/service_types.cjs.map +1 -1
  47. package/dist/services/service_types.d.ts +6 -4
  48. package/dist/services/service_types.d.ts.map +1 -1
  49. package/dist/services/service_types.js +22 -3
  50. package/dist/services/service_types.js.map +1 -1
  51. package/package.json +3 -3
  52. package/src/dialog/index.ts +33 -0
  53. package/src/drivers/pframe/data_types.ts +30 -1
  54. package/src/drivers/pframe/driver.ts +17 -2
  55. package/src/index.ts +1 -0
  56. package/src/ref.test.ts +37 -0
  57. package/src/ref.ts +34 -1
  58. package/src/services/{service_injector_factory.ts → node_service_handlers.ts} +13 -6
  59. package/src/services/service_declarations.ts +60 -3
  60. package/src/services/service_injectors.ts +50 -34
  61. package/src/services/service_types.ts +38 -4
  62. package/dist/services/service_injector_factory.cjs.map +0 -1
  63. package/dist/services/service_injector_factory.d.ts +0 -8
  64. package/dist/services/service_injector_factory.d.ts.map +0 -1
  65. package/dist/services/service_injector_factory.js.map +0 -1
@@ -1,45 +1,48 @@
1
+ import { getServiceModelMethods, getServiceUiMethods } from "./service_types.js";
1
2
  import { Services } from "./service_declarations.js";
2
- import { getMethodNames, resolveRequiredServices } from "./service_capabilities.js";
3
- import { createUiServiceInjectors } from "./service_injector_factory.js";
3
+ import { resolveRequiredServices } from "./service_capabilities.js";
4
+ import { createNodeServiceHandlers } from "./node_service_handlers.js";
4
5
  //#region src/services/service_injectors.ts
5
6
  let cachedKit;
6
- let cachedInjectors;
7
- function getOrCreateInjectors(driverKit) {
8
- if (!cachedInjectors || cachedKit !== driverKit) {
7
+ let cachedHandlers;
8
+ function getOrCreateHandlers(driverKit) {
9
+ if (!cachedHandlers || cachedKit !== driverKit) {
9
10
  cachedKit = driverKit;
10
- cachedInjectors = createUiServiceInjectors(driverKit);
11
+ cachedHandlers = createNodeServiceHandlers(driverKit);
11
12
  }
12
- return cachedInjectors;
13
+ return cachedHandlers;
13
14
  }
14
- /** Resolve the injector for a given service ID. Caches injectors per DriverKit reference. */
15
- function resolveUiInjector(driverKit, serviceId) {
16
- const injectors = getOrCreateInjectors(driverKit);
15
+ /**
16
+ * Resolve the worker-side handler object for a given service ID. Caches
17
+ * per DriverKit reference. Called from the worker's IPC dispatch path.
18
+ */
19
+ function resolveNodeServiceHandler(driverKit, serviceId) {
20
+ const handlers = getOrCreateHandlers(driverKit);
17
21
  const key = Object.keys(Services).find((k) => Services[k] === serviceId);
18
22
  if (!key) return null;
19
- return injectors[key];
23
+ return handlers[key];
20
24
  }
21
- /**
22
- * Static map of ServiceName → method names, auto-derived from the injector shape.
23
- * Computed once at module load. The stub DriverKit is never called — it only
24
- * provides a target so the closures in createUiServiceInjectors have own-property
25
- * keys that getMethodNames can introspect.
26
- */
27
- const SERVICE_METHOD_MAP = (() => {
28
- const injectors = createUiServiceInjectors(new Proxy({}, { get: () => new Proxy({}, { get: () => () => {} }) }));
25
+ function buildMethodMap(pick) {
29
26
  const result = {};
30
- for (const key of Object.keys(Services)) {
31
- const serviceId = Services[key];
32
- const injector = injectors[key];
33
- result[serviceId] = injector ? getMethodNames(injector) : [];
34
- }
27
+ for (const id of Object.values(Services)) result[id] = [...pick(id)];
35
28
  return result;
36
- })();
29
+ }
30
+ /**
31
+ * UI-side method names per service. Drives ServiceProxy forwarder
32
+ * construction in the renderer.
33
+ */
34
+ const SERVICE_METHOD_MAP = buildMethodMap(getServiceUiMethods);
35
+ /**
36
+ * Model-side method names per service. Drives the workflow VM bridge
37
+ * (see pl-middle-layer js_render).
38
+ */
39
+ const MODEL_SERVICE_METHOD_MAP = buildMethodMap(getServiceModelMethods);
37
40
  /** Build service info for a block from its feature flags. */
38
41
  function buildServiceInfo(featureFlags) {
39
42
  const serviceIds = resolveRequiredServices(featureFlags);
40
43
  return Object.fromEntries(serviceIds.map((id) => [id, SERVICE_METHOD_MAP[id] ?? []]));
41
44
  }
42
45
  //#endregion
43
- export { SERVICE_METHOD_MAP, buildServiceInfo, resolveUiInjector };
46
+ export { MODEL_SERVICE_METHOD_MAP, SERVICE_METHOD_MAP, buildServiceInfo, resolveNodeServiceHandler };
44
47
 
45
48
  //# sourceMappingURL=service_injectors.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service_injectors.js","names":[],"sources":["../../src/services/service_injectors.ts"],"sourcesContent":["/**\n * UI service injectors — auto-derived types, method map, and service info builder.\n *\n * The factory (createUiServiceInjectors) lives in service_injector_factory.ts —\n * that's the only file to edit when adding a new node service.\n */\n\nimport type { InferServiceKind, InferServiceUi, ServiceBrand, ServiceName } from \"./service_types\";\nimport type { DriverKit } from \"../driver_kit\";\nimport { Services } from \"./service_declarations\";\nimport { getMethodNames, resolveRequiredServices } from \"./service_capabilities\";\nimport { createUiServiceInjectors } from \"./service_injector_factory\";\n\nexport { createUiServiceInjectors } from \"./service_injector_factory\";\n\ntype NodeServiceKeys = {\n [K in keyof typeof Services]: InferServiceKind<ServiceBrand<(typeof Services)[K]>> extends \"node\"\n ? K\n : never;\n}[keyof typeof Services];\n\n/** Auto-derived map of node service keys to their UI-side driver interfaces. */\nexport type UiServiceInjectorMap = {\n [K in NodeServiceKeys]: InferServiceUi<ServiceBrand<(typeof Services)[K]>>;\n};\n\nlet cachedKit: DriverKit | undefined;\nlet cachedInjectors: UiServiceInjectorMap | undefined;\n\nfunction getOrCreateInjectors(driverKit: DriverKit): UiServiceInjectorMap {\n if (!cachedInjectors || cachedKit !== driverKit) {\n cachedKit = driverKit;\n cachedInjectors = createUiServiceInjectors(driverKit);\n }\n return cachedInjectors;\n}\n\n/** Resolve the injector for a given service ID. Caches injectors per DriverKit reference. */\nexport function resolveUiInjector(\n driverKit: DriverKit,\n serviceId: ServiceName,\n): UiServiceInjectorMap[keyof UiServiceInjectorMap] | null {\n const injectors = getOrCreateInjectors(driverKit);\n const key = Object.keys(Services).find(\n (k) => Services[k as keyof typeof Services] === serviceId,\n ) as NodeServiceKeys | undefined;\n if (!key) return null;\n return injectors[key];\n}\n\n/**\n * Static map of ServiceName → method names, auto-derived from the injector shape.\n * Computed once at module load. The stub DriverKit is never called — it only\n * provides a target so the closures in createUiServiceInjectors have own-property\n * keys that getMethodNames can introspect.\n */\nexport const SERVICE_METHOD_MAP: Readonly<Record<string, string[]>> = (() => {\n const stubKit = new Proxy({} as DriverKit, {\n get: () => new Proxy({}, { get: () => () => {} }),\n });\n const injectors = createUiServiceInjectors(stubKit);\n const result: Record<string, string[]> = {};\n for (const key of Object.keys(Services) as (keyof typeof Services)[]) {\n const serviceId = Services[key];\n const injector = injectors[key as NodeServiceKeys];\n result[serviceId] = injector ? getMethodNames(injector) : [];\n }\n return result;\n})();\n\n/** Build service info for a block from its feature flags. */\nexport function buildServiceInfo(\n featureFlags: Record<string, unknown>,\n): Record<ServiceName, string[]> {\n const serviceIds = resolveRequiredServices(featureFlags);\n return Object.fromEntries(\n serviceIds.map((id) => [id, SERVICE_METHOD_MAP[id as string] ?? []]),\n ) as Record<ServiceName, string[]>;\n}\n"],"mappings":";;;;AA0BA,IAAI;AACJ,IAAI;AAEJ,SAAS,qBAAqB,WAA4C;AACxE,KAAI,CAAC,mBAAmB,cAAc,WAAW;AAC/C,cAAY;AACZ,oBAAkB,yBAAyB,UAAU;;AAEvD,QAAO;;;AAIT,SAAgB,kBACd,WACA,WACyD;CACzD,MAAM,YAAY,qBAAqB,UAAU;CACjD,MAAM,MAAM,OAAO,KAAK,SAAS,CAAC,MAC/B,MAAM,SAAS,OAAgC,UACjD;AACD,KAAI,CAAC,IAAK,QAAO;AACjB,QAAO,UAAU;;;;;;;;AASnB,MAAa,4BAAgE;CAI3E,MAAM,YAAY,yBAHF,IAAI,MAAM,EAAE,EAAe,EACzC,WAAW,IAAI,MAAM,EAAE,EAAE,EAAE,iBAAiB,IAAI,CAAC,EAClD,CAAC,CACiD;CACnD,MAAM,SAAmC,EAAE;AAC3C,MAAK,MAAM,OAAO,OAAO,KAAK,SAAS,EAA+B;EACpE,MAAM,YAAY,SAAS;EAC3B,MAAM,WAAW,UAAU;AAC3B,SAAO,aAAa,WAAW,eAAe,SAAS,GAAG,EAAE;;AAE9D,QAAO;IACL;;AAGJ,SAAgB,iBACd,cAC+B;CAC/B,MAAM,aAAa,wBAAwB,aAAa;AACxD,QAAO,OAAO,YACZ,WAAW,KAAK,OAAO,CAAC,IAAI,mBAAmB,OAAiB,EAAE,CAAC,CAAC,CACrE"}
1
+ {"version":3,"file":"service_injectors.js","names":[],"sources":["../../src/services/service_injectors.ts"],"sourcesContent":["/**\n * Service dispatch glue — auto-derived types, method maps, and service info builder.\n *\n * The worker-side handler factory (createNodeServiceHandlers) lives in\n * node_service_handlers.ts — that's the only file to edit when adding a\n * new node service. Method-name registries for UI and model sides are\n * derived directly from the `uiMethods` / `modelMethods` declarations in\n * service_declarations.ts — no factory introspection, no stubs.\n */\n\nimport type { InferServiceKind, InferServiceUi, ServiceBrand, ServiceName } from \"./service_types\";\nimport type { DriverKit } from \"../driver_kit\";\nimport { Services } from \"./service_declarations\";\nimport { getServiceModelMethods, getServiceUiMethods } from \"./service_types\";\nimport { resolveRequiredServices } from \"./service_capabilities\";\nimport { createNodeServiceHandlers } from \"./node_service_handlers\";\n\nexport { createNodeServiceHandlers } from \"./node_service_handlers\";\n\ntype NodeServiceKeys = {\n [K in keyof typeof Services]: InferServiceKind<ServiceBrand<(typeof Services)[K]>> extends \"node\"\n ? K\n : never;\n}[keyof typeof Services];\n\n/**\n * Auto-derived map of node service keys to their UI-facing interfaces.\n * Fulfilled by real driver wrappers in the worker. Main services are\n * dispatched by the Electron main-process router and never reach this\n * map; wasm services are instantiated locally on each consumer.\n */\nexport type NodeServiceHandlerMap = {\n [K in NodeServiceKeys]: InferServiceUi<ServiceBrand<(typeof Services)[K]>>;\n};\n\nlet cachedKit: DriverKit | undefined;\nlet cachedHandlers: NodeServiceHandlerMap | undefined;\n\nfunction getOrCreateHandlers(driverKit: DriverKit): NodeServiceHandlerMap {\n if (!cachedHandlers || cachedKit !== driverKit) {\n cachedKit = driverKit;\n cachedHandlers = createNodeServiceHandlers(driverKit);\n }\n return cachedHandlers;\n}\n\n/**\n * Resolve the worker-side handler object for a given service ID. Caches\n * per DriverKit reference. Called from the worker's IPC dispatch path.\n */\nexport function resolveNodeServiceHandler(\n driverKit: DriverKit,\n serviceId: ServiceName,\n): NodeServiceHandlerMap[keyof NodeServiceHandlerMap] | null {\n const handlers = getOrCreateHandlers(driverKit);\n const key = Object.keys(Services).find(\n (k) => Services[k as keyof typeof Services] === serviceId,\n ) as NodeServiceKeys | undefined;\n if (!key) return null;\n return handlers[key];\n}\n\nfunction buildMethodMap(\n pick: (id: ServiceName) => readonly string[],\n): Readonly<Record<string, string[]>> {\n const result: Record<string, string[]> = {};\n for (const id of Object.values(Services)) {\n result[id as string] = [...pick(id)];\n }\n return result;\n}\n\n/**\n * UI-side method names per service. Drives ServiceProxy forwarder\n * construction in the renderer.\n */\nexport const SERVICE_METHOD_MAP: Readonly<Record<string, string[]>> =\n buildMethodMap(getServiceUiMethods);\n\n/**\n * Model-side method names per service. Drives the workflow VM bridge\n * (see pl-middle-layer js_render).\n */\nexport const MODEL_SERVICE_METHOD_MAP: Readonly<Record<string, string[]>> =\n buildMethodMap(getServiceModelMethods);\n\n/** Build service info for a block from its feature flags. */\nexport function buildServiceInfo(\n featureFlags: Record<string, unknown>,\n): Record<ServiceName, string[]> {\n const serviceIds = resolveRequiredServices(featureFlags);\n return Object.fromEntries(\n serviceIds.map((id) => [id, SERVICE_METHOD_MAP[id as string] ?? []]),\n ) as Record<ServiceName, string[]>;\n}\n"],"mappings":";;;;;AAmCA,IAAI;AACJ,IAAI;AAEJ,SAAS,oBAAoB,WAA6C;AACxE,KAAI,CAAC,kBAAkB,cAAc,WAAW;AAC9C,cAAY;AACZ,mBAAiB,0BAA0B,UAAU;;AAEvD,QAAO;;;;;;AAOT,SAAgB,0BACd,WACA,WAC2D;CAC3D,MAAM,WAAW,oBAAoB,UAAU;CAC/C,MAAM,MAAM,OAAO,KAAK,SAAS,CAAC,MAC/B,MAAM,SAAS,OAAgC,UACjD;AACD,KAAI,CAAC,IAAK,QAAO;AACjB,QAAO,SAAS;;AAGlB,SAAS,eACP,MACoC;CACpC,MAAM,SAAmC,EAAE;AAC3C,MAAK,MAAM,MAAM,OAAO,OAAO,SAAS,CACtC,QAAO,MAAgB,CAAC,GAAG,KAAK,GAAG,CAAC;AAEtC,QAAO;;;;;;AAOT,MAAa,qBACX,eAAe,oBAAoB;;;;;AAMrC,MAAa,2BACX,eAAe,uBAAuB;;AAGxC,SAAgB,iBACd,cAC+B;CAC/B,MAAM,aAAa,wBAAwB,aAAa;AACxD,QAAO,OAAO,YACZ,WAAW,KAAK,OAAO,CAAC,IAAI,mBAAmB,OAAiB,EAAE,CAAC,CAAC,CACrE"}
@@ -1,20 +1,39 @@
1
1
  const require_errors = require("../errors.cjs");
2
2
  //#region src/services/service_types.ts
3
3
  const SERVICE_ID_PATTERN = /^[a-zA-Z][a-zA-Z0-9]*$/;
4
- const { service, isNodeService } = (() => {
4
+ const { service, isNodeService, isWasmService, isMainService, getServiceKind, getServiceModelMethods, getServiceUiMethods } = (() => {
5
5
  const typeMap = /* @__PURE__ */ new Map();
6
+ const modelMethodsMap = /* @__PURE__ */ new Map();
7
+ const uiMethodsMap = /* @__PURE__ */ new Map();
6
8
  return {
7
9
  service() {
8
10
  return (options) => {
9
- const { name, type } = options;
11
+ const { name, type, modelMethods, uiMethods } = options;
10
12
  if (!SERVICE_ID_PATTERN.test(name)) throw new require_errors.ServiceInvalidIdError(`Invalid service ID "${name}": must match ${SERVICE_ID_PATTERN}`);
11
13
  if (typeMap.has(name)) throw new require_errors.ServiceAlreadyRegisteredError(`Service "${name}" already registered`);
12
14
  typeMap.set(name, type);
15
+ modelMethodsMap.set(name, modelMethods);
16
+ uiMethodsMap.set(name, uiMethods);
13
17
  return name;
14
18
  };
15
19
  },
16
20
  isNodeService(id) {
17
21
  return typeMap.get(id) === "node";
22
+ },
23
+ isWasmService(id) {
24
+ return typeMap.get(id) === "wasm";
25
+ },
26
+ isMainService(id) {
27
+ return typeMap.get(id) === "main";
28
+ },
29
+ getServiceKind(id) {
30
+ return typeMap.get(id);
31
+ },
32
+ getServiceModelMethods(id) {
33
+ return modelMethodsMap.get(id) ?? [];
34
+ },
35
+ getServiceUiMethods(id) {
36
+ return uiMethodsMap.get(id) ?? [];
18
37
  }
19
38
  };
20
39
  })();
@@ -22,7 +41,12 @@ function serviceFnKey(serviceId, method = "") {
22
41
  return `service:${serviceId}:${method}`;
23
42
  }
24
43
  //#endregion
44
+ exports.getServiceKind = getServiceKind;
45
+ exports.getServiceModelMethods = getServiceModelMethods;
46
+ exports.getServiceUiMethods = getServiceUiMethods;
47
+ exports.isMainService = isMainService;
25
48
  exports.isNodeService = isNodeService;
49
+ exports.isWasmService = isWasmService;
26
50
  exports.service = service;
27
51
  exports.serviceFnKey = serviceFnKey;
28
52
 
@@ -1 +1 @@
1
- {"version":3,"file":"service_types.cjs","names":["ServiceInvalidIdError","ServiceAlreadyRegisteredError"],"sources":["../../src/services/service_types.ts"],"sourcesContent":["import { UnionToIntersection } from \"@milaboratories/helpers\";\nimport type { Branded } from \"../branding\";\nimport { ServiceAlreadyRegisteredError, ServiceInvalidIdError } from \"../errors\";\nimport type { Services } from \"./service_declarations\";\n\nexport type ServiceTypesLike<\n Model = unknown,\n Ui = unknown,\n Kind extends ServiceType = ServiceType,\n> = {\n readonly __types?: { model: Model; ui: Ui; kind: Kind };\n};\n\nexport type InferServiceModel<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<infer M, unknown, ServiceType> ? M : unknown;\n\nexport type InferServiceUi<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<unknown, infer U, ServiceType> ? U : unknown;\n\nexport type InferServiceKind<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<unknown, unknown, infer K> ? K : ServiceType;\n\nexport type ServiceName<S extends ServiceTypesLike = ServiceTypesLike> = Branded<string, S>;\n\nexport type ServiceType = \"node\" | \"wasm\";\n\nconst SERVICE_ID_PATTERN = /^[a-zA-Z][a-zA-Z0-9]*$/;\n\nexport const { service, isNodeService } = (() => {\n const typeMap = new Map<string, ServiceType>();\n return {\n service<Model, Ui>() {\n return <K extends ServiceType, N extends string>(options: {\n readonly type: K;\n readonly name: N;\n }): Branded<N, ServiceTypesLike<Model, Ui, K>> => {\n const { name, type } = options;\n if (!SERVICE_ID_PATTERN.test(name)) {\n throw new ServiceInvalidIdError(\n `Invalid service ID \"${name}\": must match ${SERVICE_ID_PATTERN}`,\n );\n }\n if (typeMap.has(name)) {\n throw new ServiceAlreadyRegisteredError(`Service \"${name}\" already registered`);\n }\n typeMap.set(name, type);\n return name as Branded<N, ServiceTypesLike<Model, Ui, K>>;\n };\n },\n isNodeService(id: ServiceName): boolean {\n return typeMap.get(id) === \"node\";\n },\n };\n})();\n\nexport function serviceFnKey(serviceId: string, method = \"\"): string {\n return `service:${serviceId}:${method}`;\n}\n\nexport type ServiceBrand<T> =\n T extends Branded<string, infer S extends ServiceTypesLike> ? S : never;\n\nexport type ModelServiceFactoryMap<SMap extends Record<string, ServiceName>> = {\n [K in keyof SMap]: (() => InferServiceModel<ServiceBrand<SMap[K]>>) | null;\n};\n\nexport type UiServiceFactoryMap<SMap extends Record<string, ServiceName>> = {\n [K in keyof SMap]: (() => InferServiceUi<ServiceBrand<SMap[K]>>) | null;\n};\n\n/** Contract between any service provider and any service consumer. */\nexport interface ServiceDispatch {\n getServiceNames(): ServiceName[];\n getServiceMethods(serviceId: ServiceName): string[];\n callServiceMethod(serviceId: ServiceName, method: string, ...args: unknown[]): unknown;\n}\n\n// Auto-derived types from the Services const in service_declarations.ts.\n// Adding a service to Services automatically updates all of these.\n\ntype TServices = typeof Services;\n\ntype ExtractServiceName<T> = T extends Branded<infer N extends string, any> ? N : never;\n\n/** Model-side service interfaces keyed by service name literal. */\nexport type ModelServices = {\n [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceModel<\n ServiceBrand<TServices[K]>\n >;\n};\n\n/** UI-side service interfaces keyed by service name literal. */\nexport type UiServices = {\n [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceUi<\n ServiceBrand<TServices[K]>\n >;\n};\n\n/** Map from Services keys to their unbranded string name literals. */\nexport type ServiceNameLiterals = {\n [K in keyof TServices]: ExtractServiceName<TServices[K]>;\n};\n\n/** Auto-derived requires* feature flags from Services keys. */\nexport type ServiceRequireFlags = {\n [K in keyof TServices as `requires${K & string}`]?: boolean;\n};\n\nexport type RequireServices<T extends ServiceName> = UnionToIntersection<\n T extends Branded<infer N extends string, infer S extends ServiceTypesLike>\n ? Record<N, InferServiceModel<S>>\n : never\n>;\n"],"mappings":";;AA0BA,MAAM,qBAAqB;AAE3B,MAAa,EAAE,SAAS,yBAAyB;CAC/C,MAAM,0BAAU,IAAI,KAA0B;AAC9C,QAAO;EACL,UAAqB;AACnB,WAAiD,YAGC;IAChD,MAAM,EAAE,MAAM,SAAS;AACvB,QAAI,CAAC,mBAAmB,KAAK,KAAK,CAChC,OAAM,IAAIA,eAAAA,sBACR,uBAAuB,KAAK,gBAAgB,qBAC7C;AAEH,QAAI,QAAQ,IAAI,KAAK,CACnB,OAAM,IAAIC,eAAAA,8BAA8B,YAAY,KAAK,sBAAsB;AAEjF,YAAQ,IAAI,MAAM,KAAK;AACvB,WAAO;;;EAGX,cAAc,IAA0B;AACtC,UAAO,QAAQ,IAAI,GAAG,KAAK;;EAE9B;IACC;AAEJ,SAAgB,aAAa,WAAmB,SAAS,IAAY;AACnE,QAAO,WAAW,UAAU,GAAG"}
1
+ {"version":3,"file":"service_types.cjs","names":["ServiceInvalidIdError","ServiceAlreadyRegisteredError"],"sources":["../../src/services/service_types.ts"],"sourcesContent":["import { UnionToIntersection } from \"@milaboratories/helpers\";\nimport type { Branded } from \"../branding\";\nimport { ServiceAlreadyRegisteredError, ServiceInvalidIdError } from \"../errors\";\nimport type { Services } from \"./service_declarations\";\n\nexport type ServiceTypesLike<\n Model = unknown,\n Ui = unknown,\n Kind extends ServiceType = ServiceType,\n> = {\n readonly __types?: { model: Model; ui: Ui; kind: Kind };\n};\n\nexport type InferServiceModel<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<infer M, unknown, ServiceType> ? M : unknown;\n\nexport type InferServiceUi<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<unknown, infer U, ServiceType> ? U : unknown;\n\nexport type InferServiceKind<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<unknown, unknown, infer K> ? K : ServiceType;\n\nexport type ServiceName<S extends ServiceTypesLike = ServiceTypesLike> = Branded<string, S>;\n\nexport type ServiceType = \"node\" | \"wasm\" | \"main\";\n\nconst SERVICE_ID_PATTERN = /^[a-zA-Z][a-zA-Z0-9]*$/;\n\nexport const {\n service,\n isNodeService,\n isWasmService,\n isMainService,\n getServiceKind,\n getServiceModelMethods,\n getServiceUiMethods,\n} = (() => {\n const typeMap = new Map<string, ServiceType>();\n const modelMethodsMap = new Map<string, readonly string[]>();\n const uiMethodsMap = new Map<string, readonly string[]>();\n return {\n service<Model, Ui>() {\n return <\n K extends ServiceType,\n N extends string,\n MM extends readonly (keyof Model & string)[],\n UM extends readonly (keyof Ui & string)[],\n >(options: {\n readonly type: K;\n readonly name: N;\n readonly modelMethods: MM;\n readonly uiMethods: UM;\n }): Branded<N, ServiceTypesLike<Model, Ui, K>> => {\n const { name, type, modelMethods, uiMethods } = options;\n if (!SERVICE_ID_PATTERN.test(name)) {\n throw new ServiceInvalidIdError(\n `Invalid service ID \"${name}\": must match ${SERVICE_ID_PATTERN}`,\n );\n }\n if (typeMap.has(name)) {\n throw new ServiceAlreadyRegisteredError(`Service \"${name}\" already registered`);\n }\n typeMap.set(name, type);\n modelMethodsMap.set(name, modelMethods);\n uiMethodsMap.set(name, uiMethods);\n return name as Branded<N, ServiceTypesLike<Model, Ui, K>>;\n };\n },\n isNodeService(id: ServiceName): boolean {\n return typeMap.get(id) === \"node\";\n },\n isWasmService(id: ServiceName): boolean {\n return typeMap.get(id) === \"wasm\";\n },\n isMainService(id: ServiceName): boolean {\n return typeMap.get(id) === \"main\";\n },\n getServiceKind(id: ServiceName): ServiceType | undefined {\n return typeMap.get(id);\n },\n getServiceModelMethods(id: ServiceName): readonly string[] {\n return modelMethodsMap.get(id) ?? [];\n },\n getServiceUiMethods(id: ServiceName): readonly string[] {\n return uiMethodsMap.get(id) ?? [];\n },\n };\n})();\n\nexport function serviceFnKey(serviceId: string, method = \"\"): string {\n return `service:${serviceId}:${method}`;\n}\n\nexport type ServiceBrand<T> =\n T extends Branded<string, infer S extends ServiceTypesLike> ? S : never;\n\nexport type ModelServiceFactoryMap<SMap extends Record<string, ServiceName>> = {\n [K in keyof SMap]: (() => InferServiceModel<ServiceBrand<SMap[K]>>) | null;\n};\n\nexport type UiServiceFactoryMap<SMap extends Record<string, ServiceName>> = {\n [K in keyof SMap]: (() => InferServiceUi<ServiceBrand<SMap[K]>>) | null;\n};\n\n/** Contract between any service provider and any service consumer. */\nexport interface ServiceDispatch {\n getServiceNames(): ServiceName[];\n getServiceMethods(serviceId: ServiceName): string[];\n callServiceMethod(serviceId: ServiceName, method: string, ...args: unknown[]): unknown;\n}\n\n// Auto-derived types from the Services const in service_declarations.ts.\n// Adding a service to Services automatically updates all of these.\n\ntype TServices = typeof Services;\n\ntype ExtractServiceName<T> = T extends Branded<infer N extends string, any> ? N : never;\n\n/** Model-side service interfaces keyed by service name literal. */\nexport type ModelServices = {\n [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceModel<\n ServiceBrand<TServices[K]>\n >;\n};\n\n/** UI-side service interfaces keyed by service name literal. */\nexport type UiServices = {\n [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceUi<\n ServiceBrand<TServices[K]>\n >;\n};\n\n/** Map from Services keys to their unbranded string name literals. */\nexport type ServiceNameLiterals = {\n [K in keyof TServices]: ExtractServiceName<TServices[K]>;\n};\n\n/** Auto-derived requires* feature flags from Services keys. */\nexport type ServiceRequireFlags = {\n [K in keyof TServices as `requires${K & string}`]?: boolean;\n};\n\nexport type RequireServices<T extends ServiceName> = UnionToIntersection<\n T extends Branded<infer N extends string, infer S extends ServiceTypesLike>\n ? Record<N, InferServiceModel<S>>\n : never\n>;\n"],"mappings":";;AA0BA,MAAM,qBAAqB;AAE3B,MAAa,EACX,SACA,eACA,eACA,eACA,gBACA,wBACA,+BACS;CACT,MAAM,0BAAU,IAAI,KAA0B;CAC9C,MAAM,kCAAkB,IAAI,KAAgC;CAC5D,MAAM,+BAAe,IAAI,KAAgC;AACzD,QAAO;EACL,UAAqB;AACnB,WAKE,YAKgD;IAChD,MAAM,EAAE,MAAM,MAAM,cAAc,cAAc;AAChD,QAAI,CAAC,mBAAmB,KAAK,KAAK,CAChC,OAAM,IAAIA,eAAAA,sBACR,uBAAuB,KAAK,gBAAgB,qBAC7C;AAEH,QAAI,QAAQ,IAAI,KAAK,CACnB,OAAM,IAAIC,eAAAA,8BAA8B,YAAY,KAAK,sBAAsB;AAEjF,YAAQ,IAAI,MAAM,KAAK;AACvB,oBAAgB,IAAI,MAAM,aAAa;AACvC,iBAAa,IAAI,MAAM,UAAU;AACjC,WAAO;;;EAGX,cAAc,IAA0B;AACtC,UAAO,QAAQ,IAAI,GAAG,KAAK;;EAE7B,cAAc,IAA0B;AACtC,UAAO,QAAQ,IAAI,GAAG,KAAK;;EAE7B,cAAc,IAA0B;AACtC,UAAO,QAAQ,IAAI,GAAG,KAAK;;EAE7B,eAAe,IAA0C;AACvD,UAAO,QAAQ,IAAI,GAAG;;EAExB,uBAAuB,IAAoC;AACzD,UAAO,gBAAgB,IAAI,GAAG,IAAI,EAAE;;EAEtC,oBAAoB,IAAoC;AACtD,UAAO,aAAa,IAAI,GAAG,IAAI,EAAE;;EAEpC;IACC;AAEJ,SAAgB,aAAa,WAAmB,SAAS,IAAY;AACnE,QAAO,WAAW,UAAU,GAAG"}
@@ -14,11 +14,13 @@ type InferServiceModel<S extends ServiceTypesLike> = S extends ServiceTypesLike<
14
14
  type InferServiceUi<S extends ServiceTypesLike> = S extends ServiceTypesLike<unknown, infer U, ServiceType> ? U : unknown;
15
15
  type InferServiceKind<S extends ServiceTypesLike> = S extends ServiceTypesLike<unknown, unknown, infer K> ? K : ServiceType;
16
16
  type ServiceName<S extends ServiceTypesLike = ServiceTypesLike> = Branded$1<string, S>;
17
- type ServiceType = "node" | "wasm";
18
- declare const service: <Model, Ui>() => <K extends ServiceType, N extends string>(options: {
17
+ type ServiceType = "node" | "wasm" | "main";
18
+ declare const service: <Model, Ui>() => <K extends ServiceType, N extends string, MM extends readonly (keyof Model & string)[], UM extends readonly (keyof Ui & string)[]>(options: {
19
19
  readonly type: K;
20
20
  readonly name: N;
21
- }) => Branded$1<N, ServiceTypesLike<Model, Ui, K>>, isNodeService: (id: ServiceName) => boolean;
21
+ readonly modelMethods: MM;
22
+ readonly uiMethods: UM;
23
+ }) => Branded$1<N, ServiceTypesLike<Model, Ui, K>>, isNodeService: (id: ServiceName) => boolean, isWasmService: (id: ServiceName) => boolean, isMainService: (id: ServiceName) => boolean, getServiceKind: (id: ServiceName) => ServiceType | undefined, getServiceModelMethods: (id: ServiceName) => readonly string[], getServiceUiMethods: (id: ServiceName) => readonly string[];
22
24
  declare function serviceFnKey(serviceId: string, method?: string): string;
23
25
  type ServiceBrand<T> = T extends Branded$1<string, infer S extends ServiceTypesLike> ? S : never;
24
26
  type ModelServiceFactoryMap<SMap extends Record<string, ServiceName>> = { [K in keyof SMap]: (() => InferServiceModel<ServiceBrand<SMap[K]>>) | null };
@@ -41,5 +43,5 @@ type ServiceNameLiterals = { [K in keyof TServices]: ExtractServiceName<TService
41
43
  type ServiceRequireFlags = { [K in keyof TServices as `requires${K & string}`]?: boolean };
42
44
  type RequireServices<T extends ServiceName> = UnionToIntersection<T extends Branded$1<infer N extends string, infer S extends ServiceTypesLike> ? Record<N, InferServiceModel<S>> : never>;
43
45
  //#endregion
44
- export { InferServiceKind, InferServiceModel, InferServiceUi, ModelServiceFactoryMap, ModelServices, RequireServices, ServiceBrand, ServiceDispatch, ServiceName, ServiceNameLiterals, ServiceRequireFlags, ServiceType, ServiceTypesLike, UiServiceFactoryMap, UiServices, isNodeService, service, serviceFnKey };
46
+ export { InferServiceKind, InferServiceModel, InferServiceUi, ModelServiceFactoryMap, ModelServices, RequireServices, ServiceBrand, ServiceDispatch, ServiceName, ServiceNameLiterals, ServiceRequireFlags, ServiceType, ServiceTypesLike, UiServiceFactoryMap, UiServices, getServiceKind, getServiceModelMethods, getServiceUiMethods, isMainService, isNodeService, isWasmService, service, serviceFnKey };
45
47
  //# sourceMappingURL=service_types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"service_types.d.ts","names":[],"sources":["../../src/services/service_types.ts"],"mappings":";;;;;KAKY,gBAAA,6CAGG,WAAA,GAAc,WAAA;EAAA,SAElB,OAAA;IAAY,KAAA,EAAO,KAAA;IAAO,EAAA,EAAI,EAAA;IAAI,IAAA,EAAM,IAAA;EAAA;AAAA;AAAA,KAGvC,iBAAA,WAA4B,gBAAA,IACtC,CAAA,SAAU,gBAAA,mBAAmC,WAAA,IAAe,CAAA;AAAA,KAElD,cAAA,WAAyB,gBAAA,IACnC,CAAA,SAAU,gBAAA,mBAAmC,WAAA,IAAe,CAAA;AAAA,KAElD,gBAAA,WAA2B,gBAAA,IACrC,CAAA,SAAU,gBAAA,8BAA8C,CAAA,GAAI,WAAA;AAAA,KAElD,WAAA,WAAsB,gBAAA,GAAmB,gBAAA,IAAoB,SAAA,SAAgB,CAAA;AAAA,KAE7E,WAAA;AAAA,cAIG,OAAA,8BAIS,WAAA,oBAA6B,OAAA;IAAA,SACpC,IAAA,EAAM,CAAA;IAAA,SACN,IAAA,EAAM,CAAA;EAAA,MACb,SAAA,CAAQ,CAAA,EAAG,gBAAA,CAAiB,KAAA,EAAO,EAAA,EAAI,CAAA,IAAA,aAAA,GAPZ,EAAA,EAqBf,WAAA;AAAA,iBAMN,YAAA,CAAa,SAAA,UAAmB,MAAA;AAAA,KAIpC,YAAA,MACV,CAAA,SAAU,SAAA,yBAAgC,gBAAA,IAAoB,CAAA;AAAA,KAEpD,sBAAA,cAAoC,MAAA,SAAe,WAAA,mBACjD,IAAA,UAAc,iBAAA,CAAkB,YAAA,CAAa,IAAA,CAAK,CAAA;AAAA,KAGpD,mBAAA,cAAiC,MAAA,SAAe,WAAA,mBAC9C,IAAA,UAAc,cAAA,CAAe,YAAA,CAAa,IAAA,CAAK,CAAA;;UAI5C,eAAA;EACf,eAAA,IAAmB,WAAA;EACnB,iBAAA,CAAkB,SAAA,EAAW,WAAA;EAC7B,iBAAA,CAAkB,SAAA,EAAW,WAAA,EAAa,MAAA,aAAmB,IAAA;AAAA;AAAA,KAM1D,SAAA,UAAmB,QAAA;AAAA,KAEnB,kBAAA,MAAwB,CAAA,SAAU,SAAA,gCAAuC,CAAA;;KAGlE,aAAA,iBACE,SAAA,IAAa,kBAAA,CAAmB,SAAA,CAAU,CAAA,KAAM,iBAAA,CAC1D,YAAA,CAAa,SAAA,CAAU,CAAA;;KAKf,UAAA,iBACE,SAAA,IAAa,kBAAA,CAAmB,SAAA,CAAU,CAAA,KAAM,cAAA,CAC1D,YAAA,CAAa,SAAA,CAAU,CAAA;;KAKf,mBAAA,iBACE,SAAA,GAAY,kBAAA,CAAmB,SAAA,CAAU,CAAA;AApFvD;AAAA,KAwFY,mBAAA,iBACE,SAAA,eAAwB,CAAA;AAAA,KAG1B,eAAA,WAA0B,WAAA,IAAe,mBAAA,CACnD,CAAA,SAAU,SAAA,yCAAgD,gBAAA,IACtD,MAAA,CAAO,CAAA,EAAG,iBAAA,CAAkB,CAAA"}
1
+ {"version":3,"file":"service_types.d.ts","names":[],"sources":["../../src/services/service_types.ts"],"mappings":";;;;;KAKY,gBAAA,6CAGG,WAAA,GAAc,WAAA;EAAA,SAElB,OAAA;IAAY,KAAA,EAAO,KAAA;IAAO,EAAA,EAAI,EAAA;IAAI,IAAA,EAAM,IAAA;EAAA;AAAA;AAAA,KAGvC,iBAAA,WAA4B,gBAAA,IACtC,CAAA,SAAU,gBAAA,mBAAmC,WAAA,IAAe,CAAA;AAAA,KAElD,cAAA,WAAyB,gBAAA,IACnC,CAAA,SAAU,gBAAA,mBAAmC,WAAA,IAAe,CAAA;AAAA,KAElD,gBAAA,WAA2B,gBAAA,IACrC,CAAA,SAAU,gBAAA,8BAA8C,CAAA,GAAI,WAAA;AAAA,KAElD,WAAA,WAAsB,gBAAA,GAAmB,gBAAA,IAAoB,SAAA,SAAgB,CAAA;AAAA,KAE7E,WAAA;AAAA,cAKV,OAAA,8BAcgB,WAAA,+CAEiB,KAAA,yCACA,EAAA,cAAc,OAAA;IAAA,SAEhC,IAAA,EAAM,CAAA;IAAA,SACN,IAAA,EAAM,CAAA;IAAA,SACN,YAAA,EAAc,EAAA;IAAA,SACd,SAAA,EAAW,EAAA;EAAA,MAClB,SAAA,CAAQ,CAAA,EAAG,gBAAA,CAAiB,KAAA,EAAO,EAAA,EAAI,CAAA,IAAA,aAAA,GAtBlC,EAAA,EAsCO,WAAA,cAAA,aAAA,GArCP,EAAA,EAwCO,WAAA,cAAA,aAAA,GAvCP,EAAA,EA0CO,WAAA,cAAA,cAAA,GAzCN,EAAA,EA4CO,WAAA,KAAc,WAAA,cAAA,sBAAA,GA3Cb,EAAA,EA8CO,WAAA,wBAAA,mBAAA,GA7CV,EAAA,EAgDO,WAAA;AAAA,iBAMZ,YAAA,CAAa,SAAA,UAAmB,MAAA;AAAA,KAIpC,YAAA,MACV,CAAA,SAAU,SAAA,yBAAgC,gBAAA,IAAoB,CAAA;AAAA,KAEpD,sBAAA,cAAoC,MAAA,SAAe,WAAA,mBACjD,IAAA,UAAc,iBAAA,CAAkB,YAAA,CAAa,IAAA,CAAK,CAAA;AAAA,KAGpD,mBAAA,cAAiC,MAAA,SAAe,WAAA,mBAC9C,IAAA,UAAc,cAAA,CAAe,YAAA,CAAa,IAAA,CAAK,CAAA;AAxF7D;AAAA,UA4FiB,eAAA;EACf,eAAA,IAAmB,WAAA;EACnB,iBAAA,CAAkB,SAAA,EAAW,WAAA;EAC7B,iBAAA,CAAkB,SAAA,EAAW,WAAA,EAAa,MAAA,aAAmB,IAAA;AAAA;AAAA,KAM1D,SAAA,UAAmB,QAAA;AAAA,KAEnB,kBAAA,MAAwB,CAAA,SAAU,SAAA,gCAAuC,CAAA;;KAGlE,aAAA,iBACE,SAAA,IAAa,kBAAA,CAAmB,SAAA,CAAU,CAAA,KAAM,iBAAA,CAC1D,YAAA,CAAa,SAAA,CAAU,CAAA;;KAKf,UAAA,iBACE,SAAA,IAAa,kBAAA,CAAmB,SAAA,CAAU,CAAA,KAAM,cAAA,CAC1D,YAAA,CAAa,SAAA,CAAU,CAAA;;KAKf,mBAAA,iBACE,SAAA,GAAY,kBAAA,CAAmB,SAAA,CAAU,CAAA;;KAI3C,mBAAA,iBACE,SAAA,eAAwB,CAAA;AAAA,KAG1B,eAAA,WAA0B,WAAA,IAAe,mBAAA,CACnD,CAAA,SAAU,SAAA,yCAAgD,gBAAA,IACtD,MAAA,CAAO,CAAA,EAAG,iBAAA,CAAkB,CAAA"}
@@ -1,20 +1,39 @@
1
1
  import { ServiceAlreadyRegisteredError, ServiceInvalidIdError } from "../errors.js";
2
2
  //#region src/services/service_types.ts
3
3
  const SERVICE_ID_PATTERN = /^[a-zA-Z][a-zA-Z0-9]*$/;
4
- const { service, isNodeService } = (() => {
4
+ const { service, isNodeService, isWasmService, isMainService, getServiceKind, getServiceModelMethods, getServiceUiMethods } = (() => {
5
5
  const typeMap = /* @__PURE__ */ new Map();
6
+ const modelMethodsMap = /* @__PURE__ */ new Map();
7
+ const uiMethodsMap = /* @__PURE__ */ new Map();
6
8
  return {
7
9
  service() {
8
10
  return (options) => {
9
- const { name, type } = options;
11
+ const { name, type, modelMethods, uiMethods } = options;
10
12
  if (!SERVICE_ID_PATTERN.test(name)) throw new ServiceInvalidIdError(`Invalid service ID "${name}": must match ${SERVICE_ID_PATTERN}`);
11
13
  if (typeMap.has(name)) throw new ServiceAlreadyRegisteredError(`Service "${name}" already registered`);
12
14
  typeMap.set(name, type);
15
+ modelMethodsMap.set(name, modelMethods);
16
+ uiMethodsMap.set(name, uiMethods);
13
17
  return name;
14
18
  };
15
19
  },
16
20
  isNodeService(id) {
17
21
  return typeMap.get(id) === "node";
22
+ },
23
+ isWasmService(id) {
24
+ return typeMap.get(id) === "wasm";
25
+ },
26
+ isMainService(id) {
27
+ return typeMap.get(id) === "main";
28
+ },
29
+ getServiceKind(id) {
30
+ return typeMap.get(id);
31
+ },
32
+ getServiceModelMethods(id) {
33
+ return modelMethodsMap.get(id) ?? [];
34
+ },
35
+ getServiceUiMethods(id) {
36
+ return uiMethodsMap.get(id) ?? [];
18
37
  }
19
38
  };
20
39
  })();
@@ -22,6 +41,6 @@ function serviceFnKey(serviceId, method = "") {
22
41
  return `service:${serviceId}:${method}`;
23
42
  }
24
43
  //#endregion
25
- export { isNodeService, service, serviceFnKey };
44
+ export { getServiceKind, getServiceModelMethods, getServiceUiMethods, isMainService, isNodeService, isWasmService, service, serviceFnKey };
26
45
 
27
46
  //# sourceMappingURL=service_types.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service_types.js","names":[],"sources":["../../src/services/service_types.ts"],"sourcesContent":["import { UnionToIntersection } from \"@milaboratories/helpers\";\nimport type { Branded } from \"../branding\";\nimport { ServiceAlreadyRegisteredError, ServiceInvalidIdError } from \"../errors\";\nimport type { Services } from \"./service_declarations\";\n\nexport type ServiceTypesLike<\n Model = unknown,\n Ui = unknown,\n Kind extends ServiceType = ServiceType,\n> = {\n readonly __types?: { model: Model; ui: Ui; kind: Kind };\n};\n\nexport type InferServiceModel<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<infer M, unknown, ServiceType> ? M : unknown;\n\nexport type InferServiceUi<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<unknown, infer U, ServiceType> ? U : unknown;\n\nexport type InferServiceKind<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<unknown, unknown, infer K> ? K : ServiceType;\n\nexport type ServiceName<S extends ServiceTypesLike = ServiceTypesLike> = Branded<string, S>;\n\nexport type ServiceType = \"node\" | \"wasm\";\n\nconst SERVICE_ID_PATTERN = /^[a-zA-Z][a-zA-Z0-9]*$/;\n\nexport const { service, isNodeService } = (() => {\n const typeMap = new Map<string, ServiceType>();\n return {\n service<Model, Ui>() {\n return <K extends ServiceType, N extends string>(options: {\n readonly type: K;\n readonly name: N;\n }): Branded<N, ServiceTypesLike<Model, Ui, K>> => {\n const { name, type } = options;\n if (!SERVICE_ID_PATTERN.test(name)) {\n throw new ServiceInvalidIdError(\n `Invalid service ID \"${name}\": must match ${SERVICE_ID_PATTERN}`,\n );\n }\n if (typeMap.has(name)) {\n throw new ServiceAlreadyRegisteredError(`Service \"${name}\" already registered`);\n }\n typeMap.set(name, type);\n return name as Branded<N, ServiceTypesLike<Model, Ui, K>>;\n };\n },\n isNodeService(id: ServiceName): boolean {\n return typeMap.get(id) === \"node\";\n },\n };\n})();\n\nexport function serviceFnKey(serviceId: string, method = \"\"): string {\n return `service:${serviceId}:${method}`;\n}\n\nexport type ServiceBrand<T> =\n T extends Branded<string, infer S extends ServiceTypesLike> ? S : never;\n\nexport type ModelServiceFactoryMap<SMap extends Record<string, ServiceName>> = {\n [K in keyof SMap]: (() => InferServiceModel<ServiceBrand<SMap[K]>>) | null;\n};\n\nexport type UiServiceFactoryMap<SMap extends Record<string, ServiceName>> = {\n [K in keyof SMap]: (() => InferServiceUi<ServiceBrand<SMap[K]>>) | null;\n};\n\n/** Contract between any service provider and any service consumer. */\nexport interface ServiceDispatch {\n getServiceNames(): ServiceName[];\n getServiceMethods(serviceId: ServiceName): string[];\n callServiceMethod(serviceId: ServiceName, method: string, ...args: unknown[]): unknown;\n}\n\n// Auto-derived types from the Services const in service_declarations.ts.\n// Adding a service to Services automatically updates all of these.\n\ntype TServices = typeof Services;\n\ntype ExtractServiceName<T> = T extends Branded<infer N extends string, any> ? N : never;\n\n/** Model-side service interfaces keyed by service name literal. */\nexport type ModelServices = {\n [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceModel<\n ServiceBrand<TServices[K]>\n >;\n};\n\n/** UI-side service interfaces keyed by service name literal. */\nexport type UiServices = {\n [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceUi<\n ServiceBrand<TServices[K]>\n >;\n};\n\n/** Map from Services keys to their unbranded string name literals. */\nexport type ServiceNameLiterals = {\n [K in keyof TServices]: ExtractServiceName<TServices[K]>;\n};\n\n/** Auto-derived requires* feature flags from Services keys. */\nexport type ServiceRequireFlags = {\n [K in keyof TServices as `requires${K & string}`]?: boolean;\n};\n\nexport type RequireServices<T extends ServiceName> = UnionToIntersection<\n T extends Branded<infer N extends string, infer S extends ServiceTypesLike>\n ? Record<N, InferServiceModel<S>>\n : never\n>;\n"],"mappings":";;AA0BA,MAAM,qBAAqB;AAE3B,MAAa,EAAE,SAAS,yBAAyB;CAC/C,MAAM,0BAAU,IAAI,KAA0B;AAC9C,QAAO;EACL,UAAqB;AACnB,WAAiD,YAGC;IAChD,MAAM,EAAE,MAAM,SAAS;AACvB,QAAI,CAAC,mBAAmB,KAAK,KAAK,CAChC,OAAM,IAAI,sBACR,uBAAuB,KAAK,gBAAgB,qBAC7C;AAEH,QAAI,QAAQ,IAAI,KAAK,CACnB,OAAM,IAAI,8BAA8B,YAAY,KAAK,sBAAsB;AAEjF,YAAQ,IAAI,MAAM,KAAK;AACvB,WAAO;;;EAGX,cAAc,IAA0B;AACtC,UAAO,QAAQ,IAAI,GAAG,KAAK;;EAE9B;IACC;AAEJ,SAAgB,aAAa,WAAmB,SAAS,IAAY;AACnE,QAAO,WAAW,UAAU,GAAG"}
1
+ {"version":3,"file":"service_types.js","names":[],"sources":["../../src/services/service_types.ts"],"sourcesContent":["import { UnionToIntersection } from \"@milaboratories/helpers\";\nimport type { Branded } from \"../branding\";\nimport { ServiceAlreadyRegisteredError, ServiceInvalidIdError } from \"../errors\";\nimport type { Services } from \"./service_declarations\";\n\nexport type ServiceTypesLike<\n Model = unknown,\n Ui = unknown,\n Kind extends ServiceType = ServiceType,\n> = {\n readonly __types?: { model: Model; ui: Ui; kind: Kind };\n};\n\nexport type InferServiceModel<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<infer M, unknown, ServiceType> ? M : unknown;\n\nexport type InferServiceUi<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<unknown, infer U, ServiceType> ? U : unknown;\n\nexport type InferServiceKind<S extends ServiceTypesLike> =\n S extends ServiceTypesLike<unknown, unknown, infer K> ? K : ServiceType;\n\nexport type ServiceName<S extends ServiceTypesLike = ServiceTypesLike> = Branded<string, S>;\n\nexport type ServiceType = \"node\" | \"wasm\" | \"main\";\n\nconst SERVICE_ID_PATTERN = /^[a-zA-Z][a-zA-Z0-9]*$/;\n\nexport const {\n service,\n isNodeService,\n isWasmService,\n isMainService,\n getServiceKind,\n getServiceModelMethods,\n getServiceUiMethods,\n} = (() => {\n const typeMap = new Map<string, ServiceType>();\n const modelMethodsMap = new Map<string, readonly string[]>();\n const uiMethodsMap = new Map<string, readonly string[]>();\n return {\n service<Model, Ui>() {\n return <\n K extends ServiceType,\n N extends string,\n MM extends readonly (keyof Model & string)[],\n UM extends readonly (keyof Ui & string)[],\n >(options: {\n readonly type: K;\n readonly name: N;\n readonly modelMethods: MM;\n readonly uiMethods: UM;\n }): Branded<N, ServiceTypesLike<Model, Ui, K>> => {\n const { name, type, modelMethods, uiMethods } = options;\n if (!SERVICE_ID_PATTERN.test(name)) {\n throw new ServiceInvalidIdError(\n `Invalid service ID \"${name}\": must match ${SERVICE_ID_PATTERN}`,\n );\n }\n if (typeMap.has(name)) {\n throw new ServiceAlreadyRegisteredError(`Service \"${name}\" already registered`);\n }\n typeMap.set(name, type);\n modelMethodsMap.set(name, modelMethods);\n uiMethodsMap.set(name, uiMethods);\n return name as Branded<N, ServiceTypesLike<Model, Ui, K>>;\n };\n },\n isNodeService(id: ServiceName): boolean {\n return typeMap.get(id) === \"node\";\n },\n isWasmService(id: ServiceName): boolean {\n return typeMap.get(id) === \"wasm\";\n },\n isMainService(id: ServiceName): boolean {\n return typeMap.get(id) === \"main\";\n },\n getServiceKind(id: ServiceName): ServiceType | undefined {\n return typeMap.get(id);\n },\n getServiceModelMethods(id: ServiceName): readonly string[] {\n return modelMethodsMap.get(id) ?? [];\n },\n getServiceUiMethods(id: ServiceName): readonly string[] {\n return uiMethodsMap.get(id) ?? [];\n },\n };\n})();\n\nexport function serviceFnKey(serviceId: string, method = \"\"): string {\n return `service:${serviceId}:${method}`;\n}\n\nexport type ServiceBrand<T> =\n T extends Branded<string, infer S extends ServiceTypesLike> ? S : never;\n\nexport type ModelServiceFactoryMap<SMap extends Record<string, ServiceName>> = {\n [K in keyof SMap]: (() => InferServiceModel<ServiceBrand<SMap[K]>>) | null;\n};\n\nexport type UiServiceFactoryMap<SMap extends Record<string, ServiceName>> = {\n [K in keyof SMap]: (() => InferServiceUi<ServiceBrand<SMap[K]>>) | null;\n};\n\n/** Contract between any service provider and any service consumer. */\nexport interface ServiceDispatch {\n getServiceNames(): ServiceName[];\n getServiceMethods(serviceId: ServiceName): string[];\n callServiceMethod(serviceId: ServiceName, method: string, ...args: unknown[]): unknown;\n}\n\n// Auto-derived types from the Services const in service_declarations.ts.\n// Adding a service to Services automatically updates all of these.\n\ntype TServices = typeof Services;\n\ntype ExtractServiceName<T> = T extends Branded<infer N extends string, any> ? N : never;\n\n/** Model-side service interfaces keyed by service name literal. */\nexport type ModelServices = {\n [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceModel<\n ServiceBrand<TServices[K]>\n >;\n};\n\n/** UI-side service interfaces keyed by service name literal. */\nexport type UiServices = {\n [K in keyof TServices as ExtractServiceName<TServices[K]>]: InferServiceUi<\n ServiceBrand<TServices[K]>\n >;\n};\n\n/** Map from Services keys to their unbranded string name literals. */\nexport type ServiceNameLiterals = {\n [K in keyof TServices]: ExtractServiceName<TServices[K]>;\n};\n\n/** Auto-derived requires* feature flags from Services keys. */\nexport type ServiceRequireFlags = {\n [K in keyof TServices as `requires${K & string}`]?: boolean;\n};\n\nexport type RequireServices<T extends ServiceName> = UnionToIntersection<\n T extends Branded<infer N extends string, infer S extends ServiceTypesLike>\n ? Record<N, InferServiceModel<S>>\n : never\n>;\n"],"mappings":";;AA0BA,MAAM,qBAAqB;AAE3B,MAAa,EACX,SACA,eACA,eACA,eACA,gBACA,wBACA,+BACS;CACT,MAAM,0BAAU,IAAI,KAA0B;CAC9C,MAAM,kCAAkB,IAAI,KAAgC;CAC5D,MAAM,+BAAe,IAAI,KAAgC;AACzD,QAAO;EACL,UAAqB;AACnB,WAKE,YAKgD;IAChD,MAAM,EAAE,MAAM,MAAM,cAAc,cAAc;AAChD,QAAI,CAAC,mBAAmB,KAAK,KAAK,CAChC,OAAM,IAAI,sBACR,uBAAuB,KAAK,gBAAgB,qBAC7C;AAEH,QAAI,QAAQ,IAAI,KAAK,CACnB,OAAM,IAAI,8BAA8B,YAAY,KAAK,sBAAsB;AAEjF,YAAQ,IAAI,MAAM,KAAK;AACvB,oBAAgB,IAAI,MAAM,aAAa;AACvC,iBAAa,IAAI,MAAM,UAAU;AACjC,WAAO;;;EAGX,cAAc,IAA0B;AACtC,UAAO,QAAQ,IAAI,GAAG,KAAK;;EAE7B,cAAc,IAA0B;AACtC,UAAO,QAAQ,IAAI,GAAG,KAAK;;EAE7B,cAAc,IAA0B;AACtC,UAAO,QAAQ,IAAI,GAAG,KAAK;;EAE7B,eAAe,IAA0C;AACvD,UAAO,QAAQ,IAAI,GAAG;;EAExB,uBAAuB,IAAoC;AACzD,UAAO,gBAAgB,IAAI,GAAG,IAAI,EAAE;;EAEtC,oBAAoB,IAAoC;AACtD,UAAO,aAAa,IAAI,GAAG,IAAI,EAAE;;EAEpC;IACC;AAEJ,SAAgB,aAAa,WAAmB,SAAS,IAAY;AACnE,QAAO,WAAW,UAAU,GAAG"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@milaboratories/pl-model-common",
3
- "version": "1.34.1",
3
+ "version": "1.36.0",
4
4
  "description": "Platforma SDK Model",
5
5
  "files": [
6
6
  "./dist/**/*",
@@ -27,8 +27,8 @@
27
27
  "typescript": "~5.9.3",
28
28
  "vitest": "^4.1.3",
29
29
  "@milaboratories/build-configs": "2.0.0",
30
- "@milaboratories/ts-builder": "1.3.2",
31
- "@milaboratories/ts-configs": "1.2.3"
30
+ "@milaboratories/ts-configs": "1.2.3",
31
+ "@milaboratories/ts-builder": "1.3.2"
32
32
  },
33
33
  "scripts": {
34
34
  "build": "ts-builder build --target node",
@@ -0,0 +1,33 @@
1
+ /**
2
+ * File filter passed to the native save dialog. Matches Electron's
3
+ * `FileFilter` shape so desktop runtimes can forward it verbatim.
4
+ */
5
+ export interface FileFilter {
6
+ name: string;
7
+ extensions: string[];
8
+ }
9
+
10
+ /**
11
+ * Options accepted by `Dialog.showSaveDialog`. The UI supplies only a
12
+ * default file name; the main-process handler decides the default
13
+ * directory (e.g. `~/Downloads`).
14
+ */
15
+ export interface ShowSaveDialogOptions {
16
+ defaultFileName?: string;
17
+ filters?: FileFilter[];
18
+ title?: string;
19
+ }
20
+
21
+ /** Result of `Dialog.showSaveDialog`. */
22
+ export interface ShowSaveDialogResult {
23
+ canceled: boolean;
24
+ path?: string;
25
+ }
26
+
27
+ /**
28
+ * UI-facing save-dialog service. Implemented by desktop runtimes that
29
+ * can open a native file picker; absent in web/preview environments.
30
+ */
31
+ export interface DialogService {
32
+ showSaveDialog(options: ShowSaveDialogOptions): Promise<ShowSaveDialogResult>;
33
+ }
@@ -48,7 +48,7 @@ function isBitSet(bitVector: Uint8Array, offset: number): boolean {
48
48
  return (bitVector[chunkIndex] & mask) > 0;
49
49
  }
50
50
 
51
- function isValueNA(vector: PTableVector, row: number): boolean {
51
+ export function isValueNA(vector: PTableVector, row: number): boolean {
52
52
  if (vector.isNA) return isBitSet(vector.isNA, row);
53
53
 
54
54
  // Check for legacy magic values to support old desktop versions
@@ -236,3 +236,32 @@ export type PTableShape = {
236
236
  /** Number of rows */
237
237
  rows: number;
238
238
  };
239
+
240
+ /** Supported formats for PTable file download. */
241
+ export type PTableDownloadFormat = "csv" | "tsv";
242
+
243
+ /** Compression applied to the written file. */
244
+ export type PTableDownloadCompression = "none" | "gzip";
245
+
246
+ /** Options for downloading PTable data to a file. */
247
+ export interface WritePTableToFsOptions {
248
+ path: string;
249
+ format: PTableDownloadFormat;
250
+ columnIndices: number[];
251
+ range?: TableRange;
252
+ chunkSize?: number;
253
+ includeHeader?: boolean;
254
+ bom?: boolean;
255
+ compression?: {
256
+ type: "gzip";
257
+ level?: number;
258
+ };
259
+ signal?: AbortSignal;
260
+ }
261
+
262
+ /** Result of a PTable file download. */
263
+ export interface WritePTableToFsResult {
264
+ path: string;
265
+ rowsWritten: number;
266
+ bytesWritten: number;
267
+ }
@@ -5,7 +5,13 @@ import type { PColumn } from "./spec/spec";
5
5
  import type { PColumnValues, DataInfo } from "./data_info";
6
6
  import type { PTableDef, PTableDefV2 } from "./table_calculate";
7
7
  import type { AddParameterToAllMethods } from "./type_util";
8
- import type { PTableShape, PTableVector, TableRange } from "./data_types";
8
+ import type {
9
+ WritePTableToFsOptions,
10
+ WritePTableToFsResult,
11
+ PTableShape,
12
+ PTableVector,
13
+ TableRange,
14
+ } from "./data_types";
9
15
  import type { FindColumnsRequest, FindColumnsResponse } from "./find_columns";
10
16
  import type { PObjectId } from "../../pool";
11
17
  import type { PColumnIdAndSpec, PColumnSpec } from "./spec/spec";
@@ -88,6 +94,15 @@ export interface PFrameDriver {
88
94
  columnIndices: number[],
89
95
  range?: TableRange,
90
96
  ): Promise<PTableVector[]>;
97
+
98
+ /**
99
+ * Stream the table to a file at the given path. Caller is responsible
100
+ * for producing the destination path (e.g. via the `Dialog` service).
101
+ */
102
+ writePTableToFs(
103
+ handle: PTableHandle,
104
+ options: WritePTableToFsOptions,
105
+ ): Promise<WritePTableToFsResult>;
91
106
  }
92
107
 
93
108
  //
@@ -102,4 +117,4 @@ type ExpectedPFrameDriverType = ExpectedPFrameDriverTypeF & ExpectedPFrameDriver
102
117
  type TypeEqualityGuard<A, B> = Exclude<A, B> | Exclude<B, A>;
103
118
  function assert<_T extends never>() {}
104
119
 
105
- assert<TypeEqualityGuard<PFrameDriver, ExpectedPFrameDriverType>>();
120
+ assert<TypeEqualityGuard<Omit<PFrameDriver, "writePTableToFs">, ExpectedPFrameDriverType>>();
package/src/index.ts CHANGED
@@ -4,6 +4,7 @@ export * from "./bmodel";
4
4
  export * from "./branding";
5
5
  export * from "./common_types";
6
6
  export * from "./driver_kit";
7
+ export * from "./dialog";
7
8
  export * from "./drivers";
8
9
  export * from "./errors";
9
10
  export * from "./flags";
@@ -0,0 +1,37 @@
1
+ import { describe, expect, it } from "vitest";
2
+ import { createPlRef, isPlRef, isPrimaryRef } from "./ref";
3
+
4
+ const sampleRef = createPlRef("block1", "output1", true);
5
+
6
+ describe("isPrimaryRef", () => {
7
+ it("returns true for a valid PrimaryRef", () => {
8
+ expect(isPrimaryRef({ __isPrimaryRef: "v1", column: sampleRef })).toBe(true);
9
+ });
10
+
11
+ it("returns true for PrimaryRef with filter", () => {
12
+ const filter = createPlRef("block1", "filter1");
13
+ expect(isPrimaryRef({ __isPrimaryRef: "v1", column: sampleRef, filter })).toBe(true);
14
+ });
15
+
16
+ it("returns false for a PlRef", () => {
17
+ expect(isPrimaryRef(sampleRef)).toBe(false);
18
+ });
19
+
20
+ it("returns false for null", () => {
21
+ expect(isPrimaryRef(null)).toBe(false);
22
+ });
23
+
24
+ it("returns false for a plain object", () => {
25
+ expect(isPrimaryRef({ foo: "bar" })).toBe(false);
26
+ });
27
+ });
28
+
29
+ describe("isPlRef", () => {
30
+ it("returns false for a PrimaryRef", () => {
31
+ expect(isPlRef({ __isPrimaryRef: "v1", column: sampleRef })).toBe(false);
32
+ });
33
+
34
+ it("returns true for a PlRef", () => {
35
+ expect(isPlRef(sampleRef)).toBe(true);
36
+ });
37
+ });
package/src/ref.ts CHANGED
@@ -60,7 +60,11 @@ export type Option = {
60
60
  * @param name - The name of the reference.
61
61
  * @param requireEnrichments - Whether the reference requires enrichments.
62
62
  */
63
- export function createPlRef(blockId: string, name: string, requireEnrichments: boolean = false) {
63
+ export function createPlRef(
64
+ blockId: string,
65
+ name: string,
66
+ requireEnrichments: boolean = false,
67
+ ): PlRef {
64
68
  if (requireEnrichments)
65
69
  return {
66
70
  __isRef: true,
@@ -97,6 +101,35 @@ export function withEnrichments(ref: PlRef, requireEnrichments: boolean = true):
97
101
  }
98
102
  }
99
103
 
104
+ /** Primary dataset reference with an optional filter. */
105
+ export type PrimaryRef = {
106
+ readonly __isPrimaryRef: "v1";
107
+ readonly column: PlRef;
108
+ readonly filter?: PlRef;
109
+ };
110
+
111
+ export function isPrimaryRef(value: unknown): value is PrimaryRef {
112
+ return (
113
+ typeof value === "object" &&
114
+ value !== null &&
115
+ (value as { __isPrimaryRef?: unknown }).__isPrimaryRef === "v1" &&
116
+ "column" in value
117
+ );
118
+ }
119
+
120
+ export function createPrimaryRef(column: PlRef, filter?: PlRef): PrimaryRef {
121
+ if (filter !== undefined) return { __isPrimaryRef: "v1", column, filter };
122
+ else return { __isPrimaryRef: "v1", column };
123
+ }
124
+
125
+ /** Block args accept either form — backward compatible. */
126
+ export type DatasetInput = PlRef | PrimaryRef;
127
+
128
+ /** Dataset option with optional filter choices. */
129
+ export type DatasetOption = Option & {
130
+ readonly filters?: readonly Option[];
131
+ };
132
+
100
133
  /** Compare two PlRefs and returns true if they are qual */
101
134
  export function plRefsEqual(ref1: PlRef, ref2: PlRef, ignoreEnrichments: boolean = false) {
102
135
  return (
@@ -1,15 +1,21 @@
1
1
  /**
2
- * UI service injector factory.
2
+ * Worker-side dispatch table for `node`-kind services.
3
3
  *
4
- * When adding a new node service, add its method wrappers here.
5
- * Everything else (SERVICE_METHOD_MAP, buildServiceInfo, UiServiceInjectorMap)
6
- * auto-derives from this factory + Services in service_declarations.ts.
4
+ * Each entry maps a method name to a closure that calls the real driver
5
+ * inside the worker process. Used by `callServiceMethod` in the worker
6
+ * (see `platforma-desktop-app/packages/worker/src/workerApi.ts`) to route
7
+ * incoming IPC calls to concrete driver methods.
8
+ *
9
+ * NOT used for:
10
+ * - `wasm` services — instantiated locally on each consumer (no IPC).
11
+ * - `main` services — dispatched in the Electron main process via its
12
+ * own router, never reaches the worker.
7
13
  */
8
14
 
9
15
  import type { DriverKit } from "../driver_kit";
10
- import type { UiServiceInjectorMap } from "./service_injectors";
16
+ import type { NodeServiceHandlerMap } from "./service_injectors";
11
17
 
12
- export function createUiServiceInjectors(driverKit: DriverKit): UiServiceInjectorMap {
18
+ export function createNodeServiceHandlers(driverKit: DriverKit): NodeServiceHandlerMap {
13
19
  const { pFrameDriver } = driverKit;
14
20
  return {
15
21
  PFrame: {
@@ -22,6 +28,7 @@ export function createUiServiceInjectors(driverKit: DriverKit): UiServiceInjecto
22
28
  getShape: (handle) => pFrameDriver.getShape(handle),
23
29
  getSpec: (handle) => pFrameDriver.getSpec(handle),
24
30
  getData: (handle, columnIndices, range) => pFrameDriver.getData(handle, columnIndices, range),
31
+ writePTableToFs: (handle, options) => pFrameDriver.writePTableToFs(handle, options),
25
32
  },
26
33
  };
27
34
  }