@pylonts/dsl 1.1.12 → 1.1.13

package/src/utils.ts

@@ -1,75 +1,75 @@
-import type { Field, SchemaBase } from './dsl.js';
-import type { FrontAppSchema, ProjectApiSchema } from './project.js';
-
-// Base utility modules — business-agnostic helpers with full method
-// signatures (e.g. DateTimeUtils.format). Called at the service layer;
-// their args/results are own wire types, independent of business schemas.
-
-/** A utility method with a full signature. */
-export interface UtilsMethodSchema extends SchemaBase {
-  type: 'utilsMethod';
-  /** The utility module this method belongs to. */
-  schema: UtilsSchema;
-  /** Input fields. */
-  args: Record<string, Field>;
-  /** Output field. */
-  result: Field;
-}
-
-/** Method input for defineUtils: type/schema/name are set by the builder. */
-export type UtilsMethodDef = Omit<UtilsMethodSchema, 'type' | 'schema' | 'name'>;
-
-/** A base utility module (e.g. DateTimeUtils). */
-export interface UtilsSchema extends SchemaBase {
-  type: 'utils';
-  /** Backend binding — the api module this utils belongs to (shared instance
-   *  from project.config.ts apis). With `app` it serves that frontend
-   *  ({api}/{app}/utils/); alone it is the api's public module
-   *  ({api}/common/utils/). Unset = not backend-side. */
-  api?: ProjectApiSchema;
-  /** Optional binding — the frontend app this utils serves (shared instance
-   *  from project.config.ts apps). Empty means a shared public module. */
-  app?: FrontAppSchema;
-  /** Methods keyed by name — the map key is written back as the method name. */
-  methods: Record<string, UtilsMethodSchema>;
-}
-
-export function defineUtils(options: {
-  name: string;
-  api?: ProjectApiSchema;
-  app?: FrontAppSchema;
-  methods: Record<string, UtilsMethodDef>;
-  description?: string;
-}): UtilsSchema {
-  if (options.api !== undefined && options.app !== undefined && !options.api.apps.includes(options.app)) {
-    throw new Error(`utils ${options.name}: api '${options.api.name}' does not serve app '${options.app.name}'`);
-  }
-  const schema: UtilsSchema = {
-    type: 'utils',
-    name: options.name,
-    description: options.description,
-    api: options.api,
-    app: options.app,
-    methods: {},
-  };
-  for (const key of Object.keys(options.methods)) {
-    const method = options.methods[key] as UtilsMethodDef;
-    const methodSchema: UtilsMethodSchema = {
-      type: 'utilsMethod',
-      name: key,
-      description: method.description,
-      schema,
-      args: method.args,
-      result: method.result,
-    };
-    for (const argKey of Object.keys(methodSchema.args)) {
-      const field = methodSchema.args[argKey] as Field;
-      field.name = argKey;
-      field.schema = methodSchema;
-    }
-    methodSchema.result.name = key;
-    methodSchema.result.schema = methodSchema;
-    schema.methods[key] = methodSchema;
-  }
-  return schema;
+import type { CollectionSchemaBase, Field, SchemaBase } from './dsl.js';
+import type { FrontAppSchema, ProjectApiSchema } from './project.js';
+
+// Base utility modules — business-agnostic helpers with full method
+// signatures (e.g. DateTimeUtils.format). Called at the service layer;
+// their args/results are own wire types, independent of business schemas.
+
+/** A utility method with a full signature. */
+export interface UtilsMethodSchema extends SchemaBase {
+  type: 'utilsMethod';
+  /** The utility module this method belongs to. */
+  schema: UtilsSchema;
+  /** Input fields. */
+  args: Record<string, Field>;
+  /** Output field. */
+  result: Field;
+}
+
+/** Method input for defineUtils: type/schema/name are set by the builder. */
+export type UtilsMethodDef = Omit<UtilsMethodSchema, 'type' | 'schema' | 'name'>;
+
+/** A base utility module (e.g. DateTimeUtils). */
+export interface UtilsSchema extends CollectionSchemaBase {
+  type: 'utils';
+  /** Backend binding — the api module this utils belongs to (shared instance
+   *  from project.config.ts apis). With `app` it serves that frontend
+   *  ({api}/{app}/utils/); alone it is the api's public module
+   *  ({api}/common/utils/). Unset = not backend-side. */
+  api?: ProjectApiSchema;
+  /** Optional binding — the frontend app this utils serves (shared instance
+   *  from project.config.ts apps). Empty means a shared public module. */
+  app?: FrontAppSchema;
+  /** Methods keyed by name — the map key is written back as the method name. */
+  methods: Record<string, UtilsMethodSchema>;
+}
+
+export function defineUtils(options: {
+  name: string;
+  api?: ProjectApiSchema;
+  app?: FrontAppSchema;
+  methods: Record<string, UtilsMethodDef>;
+  description?: string;
+}): UtilsSchema {
+  if (options.api !== undefined && options.app !== undefined && !options.api.apps.includes(options.app)) {
+    throw new Error(`utils ${options.name}: api '${options.api.name}' does not serve app '${options.app.name}'`);
+  }
+  const schema: UtilsSchema = {
+    type: 'utils',
+    name: options.name,
+    description: options.description,
+    api: options.api,
+    app: options.app,
+    methods: {},
+  };
+  for (const key of Object.keys(options.methods)) {
+    const method = options.methods[key] as UtilsMethodDef;
+    const methodSchema: UtilsMethodSchema = {
+      type: 'utilsMethod',
+      name: key,
+      description: method.description,
+      schema,
+      args: method.args,
+      result: method.result,
+    };
+    for (const argKey of Object.keys(methodSchema.args)) {
+      const field = methodSchema.args[argKey] as Field;
+      field.name = argKey;
+      field.schema = methodSchema;
+    }
+    methodSchema.result.name = key;
+    methodSchema.result.schema = methodSchema;
+    schema.methods[key] = methodSchema;
+  }
+  return schema;
 }