@pylonts/dsl 1.1.4 → 1.1.5

package/src/project.ts

@@ -1,98 +1,98 @@
-import { SchemaBase } from './dsl.js';
-import type { TableSchema } from './db.js';
-
-// Project topology definitions: describe the applications (frontends) and
-// backend APIs of a repository, and which frontends each API serves.
-
-/** Frontend form factor. Closed enum, extend when new form factors appear. */
-export type FrontType = 'admin' | 'wxmini';
-
-/** A frontend application (e.g. admin console, wechat mini program). */
-export interface FrontAppSchema extends SchemaBase {
-  type: FrontType;
-  /** Source directory relative to project root, e.g. 'web-admin/'. */
-  dir: string;
-  /**
-   * Tenant table for this app. When set, all tables with a foreign key
-   * pointing to this table get automatic tenant scoping: the tenant PK
-   * value is injected from `user.id` into all curd operations.
-   */
-  tenant?: TableSchema;
-}
-
-/** A backend API service. apps references shared FrontAppSchema instances. */
-export interface ProjectApiSchema extends SchemaBase {
-  /** Source directory relative to project root, e.g. 'api/'. */
-  dir: string;
-  /** Frontends this API serves. Direct instance references (see defineProject). */
-  apps: FrontAppSchema[];
-  /** API base URL prefix shared by all apps it serves, e.g. '/mall'. '' = no prefix. */
-  contextPath?: string;
-  /** API service base URL for node clients, e.g. 'http://127.0.0.1:3000'. */
-  baseUrl?: string;
-}
-
-/** A third-party system (e.g. wechat pay, unionpay). Owns its own
- *  implementation dir and contract (controller_types), just like an API,
- *  but is not part of this repo's served surface. */
-export interface ThirdApiSchema extends SchemaBase {
-  /** Source directory relative to project root, e.g. 'wechat/'. */
-  dir: string;
-}
-
-export interface ProjectSchema extends SchemaBase {
-  apps: FrontAppSchema[];
-  apis: ProjectApiSchema[];
-  thirdApis: ThirdApiSchema[];
-}
-
-/**
- * Defines the project topology. FrontAppSchema instances are shared value objects:
- * api.apps references the same instances from project.apps, so an app served
- * by multiple APIs is defined once and referenced many times.
- *
- * Runtime-validates app type whitelist, unique names and api.apps reference
- * integrity (same style as defineTable/defineCurd).
- */
-export function defineProject(
-  name: string,
-  schema: {
-    description?: string;
-    apps: FrontAppSchema[];
-    apis: ProjectApiSchema[];
-    thirdApis?: ThirdApiSchema[];
-  },
-): ProjectSchema {
-  const project: ProjectSchema = { name, ...schema, thirdApis: schema.thirdApis ?? [] };
-
-  const appNames = new Set<string>();
-  for (const app of project.apps) {
-    if (!app.name) throw new Error(`project ${name}: app name is required`);
-    if (appNames.has(app.name)) throw new Error(`project ${name}: duplicate app name '${app.name}'`);
-    appNames.add(app.name);
-    if (app.type !== 'admin' && app.type !== 'wxmini') {
-      throw new Error(`project ${name}: app '${app.name}' must be type 'admin' or 'wxmini' (got '${app.type}')`);
-    }
-    if (!app.dir) throw new Error(`project ${name}: app '${app.name}' dir is required`);
-  }
-
-  const apiNames = new Set<string>();
-  for (const api of project.apis) {
-    if (!api.name) throw new Error(`project ${name}: api name is required`);
-    if (apiNames.has(api.name)) throw new Error(`project ${name}: duplicate api name '${api.name}'`);
-    apiNames.add(api.name);
-    if (!api.dir) throw new Error(`project ${name}: api '${api.name}' dir is required`);
-    for (const ref of api.apps) {
-      if (!project.apps.includes(ref)) {
-        throw new Error(`project ${name}: api '${api.name}' references app '${ref.name}' that is not a shared instance in project.apps (define once and reference it)`);
-      }
-    }
-  }
-
-  for (const third of project.thirdApis) {
-    if (!third.name) throw new Error(`project ${name}: thirdApi name is required`);
-    if (!third.dir) throw new Error(`project ${name}: thirdApi '${third.name}' dir is required`);
-  }
-
-  return project;
+import { SchemaBase } from './dsl.js';
+import type { TableSchema } from './db.js';
+
+// Project topology definitions: describe the applications (frontends) and
+// backend APIs of a repository, and which frontends each API serves.
+
+/** Frontend form factor. Closed enum, extend when new form factors appear. */
+export type FrontType = 'admin' | 'wxmini';
+
+/** A frontend application (e.g. admin console, wechat mini program). */
+export interface FrontAppSchema extends SchemaBase {
+  type: FrontType;
+  /** Source directory relative to project root, e.g. 'web-admin/'. */
+  dir: string;
+  /**
+   * Tenant table for this app. When set, all tables with a foreign key
+   * pointing to this table get automatic tenant scoping: the tenant PK
+   * value is injected from `user.id` into all curd operations.
+   */
+  tenant?: TableSchema;
+}
+
+/** A backend API service. apps references shared FrontAppSchema instances. */
+export interface ProjectApiSchema extends SchemaBase {
+  /** Source directory relative to project root, e.g. 'api/'. */
+  dir: string;
+  /** Frontends this API serves. Direct instance references (see defineProject). */
+  apps: FrontAppSchema[];
+  /** API base URL prefix shared by all apps it serves, e.g. '/mall'. '' = no prefix. */
+  contextPath?: string;
+  /** API service base URL for node clients, e.g. 'http://127.0.0.1:3000'. */
+  baseUrl?: string;
+}
+
+/** A third-party system (e.g. wechat pay, unionpay). Owns its own
+ *  implementation dir and contract (controller_types), just like an API,
+ *  but is not part of this repo's served surface. */
+export interface ThirdApiSchema extends SchemaBase {
+  /** Source directory relative to project root, e.g. 'wechat/'. */
+  dir: string;
+}
+
+export interface ProjectSchema extends SchemaBase {
+  apps: FrontAppSchema[];
+  apis: ProjectApiSchema[];
+  thirdApis: ThirdApiSchema[];
+}
+
+/**
+ * Defines the project topology. FrontAppSchema instances are shared value objects:
+ * api.apps references the same instances from project.apps, so an app served
+ * by multiple APIs is defined once and referenced many times.
+ *
+ * Runtime-validates app type whitelist, unique names and api.apps reference
+ * integrity (same style as defineTable/defineCurd).
+ */
+export function defineProject(
+  name: string,
+  schema: {
+    description?: string;
+    apps: FrontAppSchema[];
+    apis: ProjectApiSchema[];
+    thirdApis?: ThirdApiSchema[];
+  },
+): ProjectSchema {
+  const project: ProjectSchema = { name, ...schema, thirdApis: schema.thirdApis ?? [] };
+
+  const appNames = new Set<string>();
+  for (const app of project.apps) {
+    if (!app.name) throw new Error(`project ${name}: app name is required`);
+    if (appNames.has(app.name)) throw new Error(`project ${name}: duplicate app name '${app.name}'`);
+    appNames.add(app.name);
+    if (app.type !== 'admin' && app.type !== 'wxmini') {
+      throw new Error(`project ${name}: app '${app.name}' must be type 'admin' or 'wxmini' (got '${app.type}')`);
+    }
+    if (!app.dir) throw new Error(`project ${name}: app '${app.name}' dir is required`);
+  }
+
+  const apiNames = new Set<string>();
+  for (const api of project.apis) {
+    if (!api.name) throw new Error(`project ${name}: api name is required`);
+    if (apiNames.has(api.name)) throw new Error(`project ${name}: duplicate api name '${api.name}'`);
+    apiNames.add(api.name);
+    if (!api.dir) throw new Error(`project ${name}: api '${api.name}' dir is required`);
+    for (const ref of api.apps) {
+      if (!project.apps.includes(ref)) {
+        throw new Error(`project ${name}: api '${api.name}' references app '${ref.name}' that is not a shared instance in project.apps (define once and reference it)`);
+      }
+    }
+  }
+
+  for (const third of project.thirdApis) {
+    if (!third.name) throw new Error(`project ${name}: thirdApi name is required`);
+    if (!third.dir) throw new Error(`project ${name}: thirdApi '${third.name}' dir is required`);
+  }
+
+  return project;
 }

package/src/provider.ts

@@ -1,73 +1,73 @@
-import type { ImportBase } from './import-base.js';
-import type { ImportableSchemaBase } from './dsl.js';
-import type { DtoField, DtoMessage, DtoArrayField, DtoObjectField } from './dto.js';
-import type { ActionSchema } from './action.js';
-import type { RefSchema } from './ref.js';
-import type { ConvertSchema } from './convert.js';
-
-// ProviderSchema: an API function signature (args DTO + results DTO).
-
-/** Parameter data source for a call argument. */
-export type DataRef =
-  | { type: 'route'; key: string }
-  | { type: 'data';  key: string }
-  | { type: 'value'; value: unknown };
-
-/** Create a route-parameter reference. */
-export function route(key: string): DataRef {
-  return { type: 'route', key };
-}
-
-/** Create a page-data reference. */
-export function data(key: string): DataRef {
-  return { type: 'data', key };
-}
-
-export interface CallAction extends ActionSchema {
-  type: 'call';
-  func: ProviderSchema;
-  args?: Record<string, DtoField | DtoMessage | DtoArrayField | DtoObjectField | RefSchema | string>;
-}
-
-
-export function call(func: ProviderSchema, args?: Record<string, DtoField | DtoMessage | DtoArrayField | DtoObjectField | RefSchema | string>): CallAction {
-  return { name: func.name, type: 'call', func, args };
-}
-
-/** Provider function signature. The generated API client exposes one function
- *  per endpoint; ProviderSchema gives that function a name and types. */
-export interface ProviderSchema extends ImportableSchemaBase {
-  isAsync: boolean;
-  /** Input DTO (buildInput / buildQuery / buildPk result). */
-  args: DtoMessage;
-  /** Output DTO (buildOutput result) or primitive. */
-  results: DtoMessage | number | boolean | string;
-}
-
-/** Define a provider function. */
-export function defineProvider(
-  name: string,
-  schema: {
-    isAsync: boolean;
-    args: DtoMessage;
-    results: DtoMessage | number | boolean | string;
-    description?: string;
-    importRef?: ImportBase;
-  },
-): ProviderSchema {
-  return { name, ...schema };
-}
-
-/** Assign a call's result to a page data field.
- *  React: setState({ [field]: await ... }). Mini-program: this.setData({ [field]: ... }). */
-export interface SetDataAction extends ActionSchema {
-  type: 'setData';
-  call: CallAction;
-  field: DtoField;
-  /** Optional field-level transform before assignment. */
-  convert?: ConvertSchema;
-}
-
-export function setData(call: CallAction, field: DtoField, convert?: ConvertSchema): SetDataAction {
-  return { name: 'setData', type: 'setData', call, field, convert };
+import type { ImportBase } from './import-base.js';
+import type { ImportableSchemaBase } from './dsl.js';
+import type { DtoField, DtoMessage, DtoArrayField, DtoObjectField } from './dto.js';
+import type { ActionSchema } from './action.js';
+import type { RefSchema } from './ref.js';
+import type { ConvertSchema } from './convert.js';
+
+// ProviderSchema: an API function signature (args DTO + results DTO).
+
+/** Parameter data source for a call argument. */
+export type DataRef =
+  | { type: 'route'; key: string }
+  | { type: 'data';  key: string }
+  | { type: 'value'; value: unknown };
+
+/** Create a route-parameter reference. */
+export function route(key: string): DataRef {
+  return { type: 'route', key };
+}
+
+/** Create a page-data reference. */
+export function data(key: string): DataRef {
+  return { type: 'data', key };
+}
+
+export interface CallAction extends ActionSchema {
+  type: 'call';
+  func: ProviderSchema;
+  args?: Record<string, DtoField | DtoMessage | DtoArrayField | DtoObjectField | RefSchema | string>;
+}
+
+
+export function call(func: ProviderSchema, args?: Record<string, DtoField | DtoMessage | DtoArrayField | DtoObjectField | RefSchema | string>): CallAction {
+  return { name: func.name, type: 'call', func, args };
+}
+
+/** Provider function signature. The generated API client exposes one function
+ *  per endpoint; ProviderSchema gives that function a name and types. */
+export interface ProviderSchema extends ImportableSchemaBase {
+  isAsync: boolean;
+  /** Input DTO (buildInput / buildQuery / buildPk result). */
+  args: DtoMessage;
+  /** Output DTO (buildOutput result) or primitive. */
+  results: DtoMessage | number | boolean | string;
+}
+
+/** Define a provider function. */
+export function defineProvider(
+  name: string,
+  schema: {
+    isAsync: boolean;
+    args: DtoMessage;
+    results: DtoMessage | number | boolean | string;
+    description?: string;
+    importRef?: ImportBase;
+  },
+): ProviderSchema {
+  return { name, ...schema };
+}
+
+/** Assign a call's result to a page data field.
+ *  React: setState({ [field]: await ... }). Mini-program: this.setData({ [field]: ... }). */
+export interface SetDataAction extends ActionSchema {
+  type: 'setData';
+  call: CallAction;
+  field: DtoField;
+  /** Optional field-level transform before assignment. */
+  convert?: ConvertSchema;
+}
+
+export function setData(call: CallAction, field: DtoField, convert?: ConvertSchema): SetDataAction {
+  return { name: 'setData', type: 'setData', call, field, convert };
 }

package/src/ref.ts

@@ -1,19 +1,19 @@
-import type { CollectionSchemaBase } from './dsl.js';
-import type { DtoField } from './dto.js';
-
-/** A reference to a field within another schema. Carries a .schema back-reference
- *  so the driver knows where the data comes from (route params, page data, etc.). */
-export interface RefSchema {
-  name: string;
-  /** Schema back-reference — tells driver the data source. */
-  schema: CollectionSchemaBase;
-  /** The referenced field instance. */
-  field: DtoField;
-}
-
-/** Create a reference to a field in a source schema.
- *  Writes back field.schema to the source so the driver can trace origin. */
-export function defineRef(source: CollectionSchemaBase, field: DtoField): RefSchema {
-  field.schema = source;
-  return { name: field.name, schema: source, field };
+import type { CollectionSchemaBase } from './dsl.js';
+import type { DtoField } from './dto.js';
+
+/** A reference to a field within another schema. Carries a .schema back-reference
+ *  so the driver knows where the data comes from (route params, page data, etc.). */
+export interface RefSchema {
+  name: string;
+  /** Schema back-reference — tells driver the data source. */
+  schema: CollectionSchemaBase;
+  /** The referenced field instance. */
+  field: DtoField;
+}
+
+/** Create a reference to a field in a source schema.
+ *  Writes back field.schema to the source so the driver can trace origin. */
+export function defineRef(source: CollectionSchemaBase, field: DtoField): RefSchema {
+  field.schema = source;
+  return { name: field.name, schema: source, field };
 }

package/src/route.ts

@@ -1,12 +1,12 @@
-import type { CollectionSchemaBase } from './dsl.js';
-import type { DtoField } from './dto.js';
-
-/** Route params: data that arrives from the navigation URL / route. */
-export interface RouteDataSchema extends CollectionSchemaBase {
-  type: 'route';
-  fields: Record<string, DtoField>;
-}
-
-export function defineRouteData(name: string, fields: RouteDataSchema['fields']): RouteDataSchema {
-  return { name, type: 'route', fields };
+import type { CollectionSchemaBase } from './dsl.js';
+import type { DtoField } from './dto.js';
+
+/** Route params: data that arrives from the navigation URL / route. */
+export interface RouteDataSchema extends CollectionSchemaBase {
+  type: 'route';
+  fields: Record<string, DtoField>;
+}
+
+export function defineRouteData(name: string, fields: RouteDataSchema['fields']): RouteDataSchema {
+  return { name, type: 'route', fields };
 }

package/src/service.ts

@@ -1,21 +1,21 @@
-import { SchemaBase } from './dsl.js';
-import { FrontAppSchema } from './project.js';
-import type { DtoArrayField, DtoField, DtoMessage, DtoObjectField } from './dto.js';
-
-/** A frontend service bound to exactly one frontend app. */
-export interface ServiceSchema extends SchemaBase {
-  type: 'service';
-  /** The frontend app this service belongs to (shared instance from project.config). */
-  app: FrontAppSchema;
-}
-
-export function defineService(name: string, app: FrontAppSchema, description?: string): ServiceSchema {
-  return { name, type: 'service', app, description };
-}
-
-/** A method exposed by a service. */
-export interface ServiceMethodSchema extends SchemaBase {
-  type: 'method';
-  name: string;
-  fields: Record<string, DtoField | DtoMessage | DtoArrayField | DtoObjectField>;
+import { SchemaBase } from './dsl.js';
+import { FrontAppSchema } from './project.js';
+import type { DtoArrayField, DtoField, DtoMessage, DtoObjectField } from './dto.js';
+
+/** A frontend service bound to exactly one frontend app. */
+export interface ServiceSchema extends SchemaBase {
+  type: 'service';
+  /** The frontend app this service belongs to (shared instance from project.config). */
+  app: FrontAppSchema;
+}
+
+export function defineService(name: string, app: FrontAppSchema, description?: string): ServiceSchema {
+  return { name, type: 'service', app, description };
+}
+
+/** A method exposed by a service. */
+export interface ServiceMethodSchema extends SchemaBase {
+  type: 'method';
+  name: string;
+  fields: Record<string, DtoField | DtoMessage | DtoArrayField | DtoObjectField>;
 }