@dynamic-entity/server 2.5.0 → 3.0.0-rc.1

package/express.d.mts

@@ -1,14 +1,17 @@
 import { EntityFormConfig, FormRule, ImportLookups, DateOrder } from '@dynamic-entity/core';
-import { Request, Router, Response } from 'express';
-import { B as BatchInfo, I as ImportLimits, T as TemplateFormat } from './write-template-Dqu5b00D.mjs';
-import 'node:stream';
+import { Request, Router } from 'express';
+import { sendFailure as sendFailure$1, templateFilename as templateFilename$1 } from 'sheet-to-schema/node';
+import { B as BatchInfo, I as ImportLimits } from './run-import-BUClq6BR.mjs';
 
 /**
- * express.ts — four routes over the framework-neutral core, and no privileges.
+ * express.ts — four routes, and no privileges.
  *
- * Everything this file does, a Fastify, Nest or Next route could do in the same few lines:
- * find the config, read the upload, call `previewSheet` / `runImport` / `writeTemplate`, and
- * answer. It is one caller of the package rather than the package's shape.
+ * Since 3.0 the routes are sheet-to-schema's (`createImportRouter` in `sheet-to-schema/node`),
+ * which resolves a schema adapter by the name in the path. This is that router with a config
+ * behind each name: it finds the config, checks its lookups were supplied, turns it into
+ * `entityFormConfigAdapter` with the entity's rules, and answers a preview with the same
+ * suggestion the browser makes. Reading the upload, the limits, the timeouts and the failure
+ * envelope are the router's own, and are the code this file had until 3.0.
  *
  * **Not this router's job, said out loud.** Concurrency limiting, authentication and
  * authorization are the consumer's. The router is mounted inside their app, behind their
@@ -76,20 +79,17 @@ declare function listNamesOf(config: EntityFormConfig): string[];
  *
  * The caller passes `config.entity`, not the route segment. They are usually the same string,
  * and when they are not — a consumer mounting a plural route, `{ employees: employeeConfig }` —
- * the config is the one that names the data. Reading the route key instead made the map key
- * carry meaning it was never given, which is a footgun with no upside: the key is a route
- * segment and nothing else.
+ * the config is the one that names the data.
  */
-declare function templateFilename(entity: string, format: TemplateFormat): string;
+declare const templateFilename: typeof templateFilename$1;
 /**
  * Send whatever went wrong as the envelope, unless the response has already started.
  *
- * Exported so it can be tested against a response that has already begun: a template that
- * failed part-way is already partly on the wire, and the only honest thing left is to end the
- * connection abruptly. A 200 with a truncated body is a corrupt file that looks like a good
- * one, which is the worst of the available outcomes.
+ * A template that failed part-way is already partly on the wire, and the only honest thing
+ * left is to end the connection abruptly. A 200 with a truncated body is a corrupt file that
+ * looks like a good one, which is the worst of the available outcomes.
  */
-declare function sendFailure(response: Response, error: unknown): void;
+declare const sendFailure: typeof sendFailure$1;
 declare function createImportRouter(options: ImportRouterOptions): Router;
 
 export { type ConfigSource, type ImportRouterOptions, type OnImport, createImportRouter, listNamesOf, sendFailure, templateFilename };

package/express.d.ts

@@ -1,14 +1,17 @@
 import { EntityFormConfig, FormRule, ImportLookups, DateOrder } from '@dynamic-entity/core';
-import { Request, Router, Response } from 'express';
-import { B as BatchInfo, I as ImportLimits, T as TemplateFormat } from './write-template-Dqu5b00D.js';
-import 'node:stream';
+import { Request, Router } from 'express';
+import { sendFailure as sendFailure$1, templateFilename as templateFilename$1 } from 'sheet-to-schema/node';
+import { B as BatchInfo, I as ImportLimits } from './run-import-BUClq6BR.js';
 
 /**
- * express.ts — four routes over the framework-neutral core, and no privileges.
+ * express.ts — four routes, and no privileges.
  *
- * Everything this file does, a Fastify, Nest or Next route could do in the same few lines:
- * find the config, read the upload, call `previewSheet` / `runImport` / `writeTemplate`, and
- * answer. It is one caller of the package rather than the package's shape.
+ * Since 3.0 the routes are sheet-to-schema's (`createImportRouter` in `sheet-to-schema/node`),
+ * which resolves a schema adapter by the name in the path. This is that router with a config
+ * behind each name: it finds the config, checks its lookups were supplied, turns it into
+ * `entityFormConfigAdapter` with the entity's rules, and answers a preview with the same
+ * suggestion the browser makes. Reading the upload, the limits, the timeouts and the failure
+ * envelope are the router's own, and are the code this file had until 3.0.
  *
  * **Not this router's job, said out loud.** Concurrency limiting, authentication and
  * authorization are the consumer's. The router is mounted inside their app, behind their
@@ -76,20 +79,17 @@ declare function listNamesOf(config: EntityFormConfig): string[];
  *
  * The caller passes `config.entity`, not the route segment. They are usually the same string,
  * and when they are not — a consumer mounting a plural route, `{ employees: employeeConfig }` —
- * the config is the one that names the data. Reading the route key instead made the map key
- * carry meaning it was never given, which is a footgun with no upside: the key is a route
- * segment and nothing else.
+ * the config is the one that names the data.
  */
-declare function templateFilename(entity: string, format: TemplateFormat): string;
+declare const templateFilename: typeof templateFilename$1;
 /**
  * Send whatever went wrong as the envelope, unless the response has already started.
  *
- * Exported so it can be tested against a response that has already begun: a template that
- * failed part-way is already partly on the wire, and the only honest thing left is to end the
- * connection abruptly. A 200 with a truncated body is a corrupt file that looks like a good
- * one, which is the worst of the available outcomes.
+ * A template that failed part-way is already partly on the wire, and the only honest thing
+ * left is to end the connection abruptly. A 200 with a truncated body is a corrupt file that
+ * looks like a good one, which is the worst of the available outcomes.
  */
-declare function sendFailure(response: Response, error: unknown): void;
+declare const sendFailure: typeof sendFailure$1;
 declare function createImportRouter(options: ImportRouterOptions): Router;
 
 export { type ConfigSource, type ImportRouterOptions, type OnImport, createImportRouter, listNamesOf, sendFailure, templateFilename };