@dudousxd/nestjs-catalog 0.14.0 → 0.15.0

package/dist/catalog.store.js

@@ -1,11 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CATALOG_STORE = exports.CatalogColumnCollisionError = exports.UnsafeIdentifierError = exports.CATALOG_RESERVED_COLUMNS = exports.CATALOG_SNAPSHOT_MODES = void 0;
+exports.CATALOG_STORE = exports.CatalogColumnCollisionError = exports.UnsafeIdentifierError = exports.physicalColumn = exports.outputAlias = exports.isSafeIdentifier = exports.assertSafeIdentifier = exports.CATALOG_RESERVED_COLUMNS = exports.CATALOG_SNAPSHOT_MODES = void 0;
 exports.isCatalogStoreCapabilities = isCatalogStoreCapabilities;
 exports.supportsObjectFilters = supportsObjectFilters;
 exports.isReservedColumn = isReservedColumn;
-exports.isSafeIdentifier = isSafeIdentifier;
-exports.assertSafeIdentifier = assertSafeIdentifier;
 exports.findColumnCollisions = findColumnCollisions;
 exports.assertNoColumnCollisions = assertNoColumnCollisions;
 exports.isWriteStore = isWriteStore;
@@ -81,72 +79,36 @@ function isReservedColumn(column) {
     return exports.CATALOG_RESERVED_COLUMNS.some((reserved) => reserved === column.toLowerCase());
 }
 /**
- * What a name has to look like before a store will write it into SQL.
- *
- * Identifiers are *rejected*, never escaped and never sanitised. Every table
- * and column name a store emits arrives from another application over HTTP and
- * ends up in DDL and in SELECT lists, where no placeholder can stand in for it,
- * so anything outside this character set never becomes SQL at all.
- *
- * Here, beside {@link CATALOG_RESERVED_COLUMNS}, for the same reason: it is
- * part of what the catalog promises a *publisher*. Refuse a property name and
- * the sentence explaining why is the only statement of the rule most people
- * will ever read, so it belongs to the contract rather than to whichever
- * adapter happens to be mounted.
- *
- * And for one more reason. It used to be two copies — `store-mikro-orm` and
- * `store-clickhouse` each carried this pattern and this sentence, byte for
- * byte — and the publish-time refusal in the pipeline package borrowed the
- * MySQL one so that publish-time and DDL-time could not disagree about the
- * character set, the length or the wording. That bought the guarantee for a
- * MySQL deployment and left a ClickHouse-only one trusting two files to be
- * edited together. One definition is the guarantee; two identical ones are a
- * habit.
- *
- * 63 characters because it is under MySQL's 64-character ceiling and no engine
- * a store here targets refuses a name that short, and because the number is
- * quoted in the refusal below: a per-store limit would mean a publisher being
- * told a different rule depending on what is mounted, for a name the catalog
- * would then be unable to promise anything about across a fan-out.
- *
- * Not exported. A `RegExp` is mutable and shared state, and the two questions
- * anyone has of it — "may I?" and "why not?" — are {@link isSafeIdentifier} and
- * {@link UnsafeIdentifierError}.
- */
-const SAFE_IDENTIFIER = /^[A-Za-z_][A-Za-z0-9_]{0,62}$/;
-/**
- * Why a name cannot be written into SQL, in the words a publisher is given.
- *
- * One class for the whole ecosystem rather than one per adapter, so
- * `instanceof` is a usable question across packages. The publish-time check in
- * the pipeline package catches this to tell "that name cannot be an identifier"
- * from "something else failed inside the store", and with a class per adapter
- * that check would re-throw the moment the mounted store was not the one it
- * imported — turning a 400 that names the property into a 500 that names
- * nothing.
+ * The whole naming rule, which used to be written out here.
+ *
+ * `isSafeIdentifier` and friends, the {@link physicalColumn} cleaning and the
+ * {@link outputAlias} it feeds all moved to `catalog.identifiers.ts` — a file
+ * that imports nothing — and are re-exported here so that every caller that
+ * reached them from this module still does.
+ *
+ * The move was not tidying. This file imports `BadRequestException` at module
+ * scope, so a browser importing a *value* from it would pull NestJS into its
+ * bundle, and a console proposing to replicate a table has to be able to ask,
+ * before it draws anything, whether the source's column spellings could be
+ * published as property names. The question a publisher is refused on is
+ * `isSafeIdentifier(physicalColumn(name))`, so both halves had to become
+ * reachable from `/client`, answered by the same two functions the DDL runs
+ * rather than by a copy of either. See the docblock on `catalog.identifiers.ts`.
+ *
+ * A bare `export … from` and not `import` + `export`, which is safe here for a
+ * reason worth writing down: nothing left in this file *calls* any of them.
+ * A re-export forwards a name without binding it locally, and while `outputAlias`
+ * still lived here — one line, calling `isSafeIdentifier` — that difference was
+ * a `ReferenceError` at the first read of any type, compiled and shipped by a
+ * rebase that had nothing to conflict on. Adding a caller here means turning
+ * this back into an import.
  */
-class UnsafeIdentifierError extends Error {
-    constructor(value) {
-        super(`Refusing to use "${value}" as a SQL identifier: letters, digits and underscore only, starting with a letter or underscore, 63 characters max.`);
-    }
-}
-exports.UnsafeIdentifierError = UnsafeIdentifierError;
-/** Whether a name can be written into SQL as it stands. */
-function isSafeIdentifier(value) {
-    return SAFE_IDENTIFIER.test(value);
-}
-/**
- * Refuse a name that cannot be a SQL identifier.
- *
- * Throws rather than answering, because the caller's next line writes the value
- * into a statement: a boolean that can be ignored is a boolean that eventually
- * is. {@link isSafeIdentifier} is there for the callers that are asking rather
- * than about to build.
- */
-function assertSafeIdentifier(value) {
-    if (!isSafeIdentifier(value))
-        throw new UnsafeIdentifierError(value);
-}
+var catalog_identifiers_1 = require("./catalog.identifiers");
+Object.defineProperty(exports, "assertSafeIdentifier", { enumerable: true, get: function () { return catalog_identifiers_1.assertSafeIdentifier; } });
+Object.defineProperty(exports, "isSafeIdentifier", { enumerable: true, get: function () { return catalog_identifiers_1.isSafeIdentifier; } });
+Object.defineProperty(exports, "outputAlias", { enumerable: true, get: function () { return catalog_identifiers_1.outputAlias; } });
+Object.defineProperty(exports, "physicalColumn", { enumerable: true, get: function () { return catalog_identifiers_1.physicalColumn; } });
+Object.defineProperty(exports, "UnsafeIdentifierError", { enumerable: true, get: function () { return catalog_identifiers_1.UnsafeIdentifierError; } });
 /**
  * Every way a type's properties would fight over a physical column.
  *

package/dist/catalog.types.d.ts

@@ -299,13 +299,20 @@ export interface CatalogObjectPage {
          * How the source spells this column, when it is not how the property is
          * named.
          *
-         * Carried because on a published type the two really do differ: a source
-         * column called `Asset Id` cannot be a SQL identifier, so the property is
-         * `Asset_Id` and `columnName` keeps the original. A reader recognises the
-         * source spelling — it is what is on their spreadsheet — and a filter has to
-         * be built from the property name, so a screen that shows only one of the two
-         * either fails to be recognised or invites a filter on a name that resolves
-         * to nothing. Both are here so a screen can show one and send the other.
+         * Lineage, and only lineage — nothing reads a record through it. A reader
+         * recognises the source spelling because it is what is on their spreadsheet,
+         * and a filter has to be built from the property name, so both are here and a
+         * screen can show one and send the other.
+         *
+         * The two differ less often than they used to. A property may now be named
+         * `Asset Id` outright: a store cleans the name to reach its column and
+         * aliases its view to the cleaned form, so a name is no longer required to be
+         * a SQL identifier. Publishers were previously told to send `{ name:
+         * 'Asset_Id', columnName: 'Asset Id' }`, which is where most of the divergent
+         * pairs in an older catalog come from — and it was a costly instruction,
+         * because a load matches records to properties by NAME, so those columns
+         * loaded NULL. The two still differ whenever a publisher chooses different
+         * names for its own reasons, which is why the field stays.
          *
          * Optional: a page served by a version of this library that predates the
          * field simply does not say, and a screen falls back to the property name.

package/dist/client.d.ts

@@ -33,6 +33,36 @@ export type { CatalogGraph, CatalogObjectPage, CatalogObjectQuery, CatalogObject
 export { CATALOG_FILTER_LIMIT, CATALOG_FILTER_OPERATORS, coerceFilterValue, encodeObjectFilter, filterOperatorTakesValue, filterOperatorsFor, isCatalogFilterOperator, offeredFilterOperators, parseObjectFilter, resolveObjectFilters, VALUELESS_FILTER_OPERATORS, } from './catalog.filters';
 export type { CatalogFilterableColumn, CatalogFilterOperator, CatalogFilterResolution, CatalogObjectFilter, CatalogResolvedFilter, } from './catalog.filters';
 export type { SnapshotRef } from './catalog.store';
+/**
+ * How a name becomes a column, shipped to the browser deliberately.
+ *
+ * The second exception to "types only" on this entry point, and it is made for
+ * the same reason `validateWorkflow` is the first: the answer has to be the
+ * same one the server will give, and the only way to guarantee that is for both
+ * to run these functions.
+ *
+ * A console proposing to replicate a table has to be able to ask, *before* it
+ * draws anything, whether the source's own column spellings could be published
+ * as property names — because a property `name` is what the warehouse looks
+ * every field up by, `row[property.name]`, so a name the publisher then refuses
+ * has to be renamed, and a rename with nothing renaming the record's keys to
+ * match writes null into that column on every run and reports success. That is
+ * not a hypothesis; it is what happened to six types in one evening.
+ *
+ * **Both halves, because the composition is the rule.** A name no longer has to
+ * be an identifier itself — the view's output alias and the read's lookup key go
+ * through {@link outputAlias} together, so `Asset Id` is a perfectly good
+ * property name and lands in `Asset_Id`. What is still refused is a name whose
+ * *cleaned* form is not an identifier: `2024 Total` cleans to `2024_Total`, and
+ * no store will quote a name starting with a digit. So the question worth asking
+ * from a browser is `isSafeIdentifier(physicalColumn(name))` — the same two
+ * calls, in the same order, that `identifierRefusal` makes at publish time.
+ * Exporting only `isSafeIdentifier` would let a console answer the stricter,
+ * obsolete question and refuse a graph the server would have accepted.
+ *
+ * Safe to export because `catalog.identifiers.ts` imports nothing at all.
+ */
+export { isSafeIdentifier, outputAlias, physicalColumn, UnsafeIdentifierError, } from './catalog.identifiers';
 /** What a tier-0 edit to a type may change. */
 export interface TypePatch {
     displayName?: string;
@@ -123,8 +153,8 @@ export declare const catalogRoutes: {
     readonly traces: () => string;
     readonly trace: (id: string) => string;
 };
-export type { CatalogConnection, CatalogConnector, ConnectionCheck, CatalogTransform, CatalogWorkflow, CatalogWorkflowCapabilities, ConnectorKind, ConnectorRun, TransformLanguage, TransformResult, WorkflowEdge, WorkflowExecutionMode, WorkflowGraph, WorkflowIssueCode, WorkflowNode, WorkflowNodeKind, WorkflowNodeOutcome, WorkflowSinkNode, WorkflowSourceNode, WorkflowStageRef, WorkflowTransformNode, WorkflowValidationIssue, } from './catalog.pipeline';
-export { CONNECTOR_KINDS, isConnectorKind, isTransformLanguage, isWorkflowEdge, isWorkflowNode, TRANSFORM_LANGUAGES, } from './catalog.pipeline';
+export type { CatalogConnection, CatalogConnector, ConnectionCheck, CatalogTransform, CatalogWorkflow, CatalogWorkflowCapabilities, ConnectorKind, ConnectorRun, TransformLanguage, TransformResult, CallableWorkflowRef, WorkflowCallEnvelope, WorkflowCallNode, WorkflowCallOutput, WorkflowEdge, WorkflowExecutionMode, WorkflowGraph, WorkflowIssueCode, WorkflowNode, WorkflowNodeKind, WorkflowNodeOutcome, WorkflowSinkNode, WorkflowSourceNode, WorkflowStageRef, WorkflowTransformNode, WorkflowValidationIssue, } from './catalog.pipeline';
+export { CONNECTOR_KINDS, isConnectorKind, isTransformLanguage, isWorkflowEdge, isWorkflowNode, TRANSFORM_LANGUAGES, readWorkflowCallOutput, WORKFLOW_CALL_CONTRACT, } from './catalog.pipeline';
 /**
  * The workflow validator, shipped to the browser deliberately.
  *

package/dist/client.js

@@ -11,7 +11,7 @@
  * types are.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DELETE_RECONCILIATION_STRATEGIES = exports.isWorkflowStatus = exports.isWorkflowNodeKind = exports.isWorkflowExecutionMode = exports.workflowRunOrder = exports.workflowGraphHash = exports.WORKFLOW_STATUSES = exports.WORKFLOW_NODE_KINDS = exports.WORKFLOW_NODE_ID_PATTERN = exports.WORKFLOW_ISSUE_CODES = exports.WORKFLOW_EXECUTION_MODES = exports.validateWorkflow = exports.TRANSFORM_LANGUAGES = exports.isWorkflowNode = exports.isWorkflowEdge = exports.isTransformLanguage = exports.isConnectorKind = exports.CONNECTOR_KINDS = exports.catalogRoutes = exports.VALUELESS_FILTER_OPERATORS = exports.resolveObjectFilters = exports.parseObjectFilter = exports.offeredFilterOperators = exports.isCatalogFilterOperator = exports.filterOperatorsFor = exports.filterOperatorTakesValue = exports.encodeObjectFilter = exports.coerceFilterValue = exports.CATALOG_FILTER_OPERATORS = exports.CATALOG_FILTER_LIMIT = exports.CATALOG_REVISION_LIMIT = void 0;
+exports.DELETE_RECONCILIATION_STRATEGIES = exports.isWorkflowStatus = exports.isWorkflowNodeKind = exports.isWorkflowExecutionMode = exports.workflowRunOrder = exports.workflowGraphHash = exports.WORKFLOW_STATUSES = exports.WORKFLOW_NODE_KINDS = exports.WORKFLOW_NODE_ID_PATTERN = exports.WORKFLOW_ISSUE_CODES = exports.WORKFLOW_EXECUTION_MODES = exports.validateWorkflow = exports.WORKFLOW_CALL_CONTRACT = exports.readWorkflowCallOutput = exports.TRANSFORM_LANGUAGES = exports.isWorkflowNode = exports.isWorkflowEdge = exports.isTransformLanguage = exports.isConnectorKind = exports.CONNECTOR_KINDS = exports.catalogRoutes = exports.UnsafeIdentifierError = exports.physicalColumn = exports.outputAlias = exports.isSafeIdentifier = exports.VALUELESS_FILTER_OPERATORS = exports.resolveObjectFilters = exports.parseObjectFilter = exports.offeredFilterOperators = exports.isCatalogFilterOperator = exports.filterOperatorsFor = exports.filterOperatorTakesValue = exports.encodeObjectFilter = exports.coerceFilterValue = exports.CATALOG_FILTER_OPERATORS = exports.CATALOG_FILTER_LIMIT = exports.CATALOG_REVISION_LIMIT = void 0;
 exports.isDeleteReconciliationStrategy = isDeleteReconciliationStrategy;
 exports.pipelineExpectationRoutes = pipelineExpectationRoutes;
 // A value, not a type: a screen saying how far back the history goes should read
@@ -46,6 +46,40 @@ Object.defineProperty(exports, "offeredFilterOperators", { enumerable: true, get
 Object.defineProperty(exports, "parseObjectFilter", { enumerable: true, get: function () { return catalog_filters_1.parseObjectFilter; } });
 Object.defineProperty(exports, "resolveObjectFilters", { enumerable: true, get: function () { return catalog_filters_1.resolveObjectFilters; } });
 Object.defineProperty(exports, "VALUELESS_FILTER_OPERATORS", { enumerable: true, get: function () { return catalog_filters_1.VALUELESS_FILTER_OPERATORS; } });
+/**
+ * How a name becomes a column, shipped to the browser deliberately.
+ *
+ * The second exception to "types only" on this entry point, and it is made for
+ * the same reason `validateWorkflow` is the first: the answer has to be the
+ * same one the server will give, and the only way to guarantee that is for both
+ * to run these functions.
+ *
+ * A console proposing to replicate a table has to be able to ask, *before* it
+ * draws anything, whether the source's own column spellings could be published
+ * as property names — because a property `name` is what the warehouse looks
+ * every field up by, `row[property.name]`, so a name the publisher then refuses
+ * has to be renamed, and a rename with nothing renaming the record's keys to
+ * match writes null into that column on every run and reports success. That is
+ * not a hypothesis; it is what happened to six types in one evening.
+ *
+ * **Both halves, because the composition is the rule.** A name no longer has to
+ * be an identifier itself — the view's output alias and the read's lookup key go
+ * through {@link outputAlias} together, so `Asset Id` is a perfectly good
+ * property name and lands in `Asset_Id`. What is still refused is a name whose
+ * *cleaned* form is not an identifier: `2024 Total` cleans to `2024_Total`, and
+ * no store will quote a name starting with a digit. So the question worth asking
+ * from a browser is `isSafeIdentifier(physicalColumn(name))` — the same two
+ * calls, in the same order, that `identifierRefusal` makes at publish time.
+ * Exporting only `isSafeIdentifier` would let a console answer the stricter,
+ * obsolete question and refuse a graph the server would have accepted.
+ *
+ * Safe to export because `catalog.identifiers.ts` imports nothing at all.
+ */
+var catalog_identifiers_1 = require("./catalog.identifiers");
+Object.defineProperty(exports, "isSafeIdentifier", { enumerable: true, get: function () { return catalog_identifiers_1.isSafeIdentifier; } });
+Object.defineProperty(exports, "outputAlias", { enumerable: true, get: function () { return catalog_identifiers_1.outputAlias; } });
+Object.defineProperty(exports, "physicalColumn", { enumerable: true, get: function () { return catalog_identifiers_1.physicalColumn; } });
+Object.defineProperty(exports, "UnsafeIdentifierError", { enumerable: true, get: function () { return catalog_identifiers_1.UnsafeIdentifierError; } });
 /**
  * Builds the paths the catalog controller serves, relative to wherever it was
  * mounted. Kept as string builders rather than a fetch wrapper so the host
@@ -107,6 +141,10 @@ Object.defineProperty(exports, "isTransformLanguage", { enumerable: true, get: f
 Object.defineProperty(exports, "isWorkflowEdge", { enumerable: true, get: function () { return catalog_pipeline_1.isWorkflowEdge; } });
 Object.defineProperty(exports, "isWorkflowNode", { enumerable: true, get: function () { return catalog_pipeline_1.isWorkflowNode; } });
 Object.defineProperty(exports, "TRANSFORM_LANGUAGES", { enumerable: true, get: function () { return catalog_pipeline_1.TRANSFORM_LANGUAGES; } });
+// A screen that shows what a call node got back narrows it the same way the
+// runner does, so the two cannot disagree about what "no rows" looks like.
+Object.defineProperty(exports, "readWorkflowCallOutput", { enumerable: true, get: function () { return catalog_pipeline_1.readWorkflowCallOutput; } });
+Object.defineProperty(exports, "WORKFLOW_CALL_CONTRACT", { enumerable: true, get: function () { return catalog_pipeline_1.WORKFLOW_CALL_CONTRACT; } });
 /**
  * The workflow validator, shipped to the browser deliberately.
  *

package/dist/index.d.ts

@@ -1,16 +1,17 @@
 export { CatalogProperty, type CatalogPropertyOptions, CatalogType, type CatalogTypeOptions, } from './catalog.decorators';
 export { CATALOG_EVENT_PHASE, CATALOG_EVENT_PHASE_FALLBACK, CATALOG_EVENTS, CATALOG_LIB, type CatalogEvent, type CatalogEventPayloads, UNATTRIBUTED_PRINCIPAL_ID, catalogEventPhase, channelNameFor, curationActor, emitCatalog, } from './catalog.events';
 export { CatalogModule } from './catalog.module';
-export { assertReadOnlyShape, type CatalogQueryRelation, type CatalogQueryRequest, type CatalogQueryResult, type CatalogQueryStore, isQueryStore, } from './catalog.query';
+export { assertReadOnlyShape, type CatalogQueryRelation, type CatalogQueryRequest, type CatalogQueryResult, type CatalogQueryStore, type CatalogQueryStreamRequest, isQueryStore, isStreamingQueryStore, } from './catalog.query';
 export { CATALOG_OPTIONS, type CatalogModuleOptions } from './catalog.options';
 export * from './catalog.secrets';
 export { type CatalogOverlayStore, FileCatalogOverlayStore, InMemoryCatalogOverlayStore, } from './catalog.overlay-store';
 export { CATALOG_OVERLAY_STORE } from './catalog.overlay-store.token';
 export { MikroOrmCatalogRegistry } from './catalog.registry';
 export { CatalogRegistry } from './catalog.registry.base';
-export { CATALOG_PIPELINE_STORE, type CatalogConnection, type CatalogConnector, type ConnectionCheck, CONNECTOR_KINDS, type CatalogLoadExpectations, type CatalogLoadExpectationStore, type CatalogPipelineStore, type CatalogStageStore, type CatalogTransform, type CatalogWorkflow, type CatalogWorkflowCapabilities, type CatalogWorkflowStore, type ConnectorKind, type ConnectorRun, type DeleteReconciliation, isConnectorKind, isPipelineStore, isTransformLanguage, type LoadExpectation, type RowCountBound, type StoredLoadExpectation, supportsLoadExpectations, supportsTransformRevisions, isWorkflowEdge, isWorkflowExecutionMode, isWorkflowNode, isWorkflowNodeKind, isWorkflowStatus, supportsWorkflows, supportsWorkflowStages, TRANSFORM_RUNNER, TRANSFORM_LANGUAGES, type TransformLanguage, type TransformResult, type TransformRunner, validateWorkflow, WORKFLOW_EXECUTION_MODES, WORKFLOW_ISSUE_CODES, WORKFLOW_NODE_ID_PATTERN, WORKFLOW_NODE_KINDS, WORKFLOW_STATUSES, type WorkflowEdge, type WorkflowExecutionMode, type WorkflowGraph, workflowGraphHash, type WorkflowIssueCode, type WorkflowNode, type WorkflowNodeKind, type WorkflowNodeOutcome, type WorkflowNodeStepInput, type WorkflowNodeStepOutput, workflowRunOrder, type WorkflowSinkNode, type WorkflowSourceNode, type WorkflowStageRef, type WorkflowStatus, type WorkflowTransformNode, type WorkflowValidationIssue, } from './catalog.pipeline';
+export { CATALOG_PIPELINE_STORE, type CatalogConnection, type CatalogConnector, type ConnectionCheck, CONNECTOR_KINDS, type CatalogLoadExpectations, type CatalogLoadExpectationStore, type CatalogPipelineStore, type CatalogStageStore, type CatalogTransform, type CatalogWorkflow, type CatalogWorkflowCapabilities, type CatalogWorkflowStore, type CallableWorkflowRef, type ConnectorKind, type ConnectorRun, type DeleteReconciliation, isConnectorKind, isPipelineStore, isTransformLanguage, type LoadExpectation, type RowCountBound, type StoredLoadExpectation, readWorkflowCallOutput, supportsLoadExpectations, supportsTransformRevisions, isWorkflowEdge, isWorkflowExecutionMode, isWorkflowNode, isWorkflowNodeKind, isWorkflowStatus, supportsWorkflows, supportsWorkflowStages, TRANSFORM_RUNNER, TRANSFORM_LANGUAGES, type TransformLanguage, type TransformResult, type TransformRunner, validateWorkflow, WORKFLOW_CALL_CONTRACT, WORKFLOW_EXECUTION_MODES, WORKFLOW_ISSUE_CODES, WORKFLOW_NODE_ID_PATTERN, WORKFLOW_NODE_KINDS, WORKFLOW_STATUSES, type WorkflowCallEnvelope, type WorkflowCallNode, type WorkflowCallOutput, type WorkflowEdge, type WorkflowExecutionMode, type WorkflowGraph, workflowGraphHash, type WorkflowIssueCode, type WorkflowNode, type WorkflowNodeKind, type WorkflowNodeOutcome, type WorkflowNodeStepInput, type WorkflowNodeStepOutput, workflowRunOrder, type WorkflowSinkNode, type WorkflowSourceNode, type WorkflowStageRef, type WorkflowStatus, type WorkflowTransformNode, type WorkflowValidationIssue, } from './catalog.pipeline';
 export * from './catalog.environment';
-export { QueryCache, toCsv } from './catalog.query-cache';
+export { QueryCache } from './catalog.query-cache';
+export { type CsvRow, csvCell, csvLines, guardFormula, toCsv } from './catalog.csv';
 export { SubprocessTransformRunner, type TransformRunnerOptions, } from './transform-runner';
 export { CatalogService } from './catalog.service';
 export { DEFAULT_SEARCH_LIMIT, MAX_SEARCH_LIMIT, bestMatch, emptySearch, maySearch, type SearchInput, type SearchableDashboard, type SearchableSavedQuery, searchCatalog, visibleToPrincipal, } from './search';
@@ -19,7 +20,7 @@ export { type AuditQuery, CATALOG_REVISION_LIMIT, CATALOG_TRACE_OUTCOMES, CATALO
 export { CATALOG_PRINCIPAL_RESOLVER, type CatalogActor, type CatalogGrants, type CatalogPrincipal, type CatalogPrincipalResolver, type CatalogScope, composePrincipalId, delegatePrincipal, expandScopes, hasScope, parsePrincipalId, PRINCIPAL_ACTOR_SEPARATOR, maySeeClassification, mayRead, mayWrite, readableObjectPage, StaticKeyPrincipalResolver, } from './catalog.principal';
 export * from './catalog.access';
 export * from './catalog.filters';
-export { assertNoColumnCollisions, assertSafeIdentifier, CATALOG_RESERVED_COLUMNS, CATALOG_SNAPSHOT_MODES, CATALOG_STORE, type CarryForwardResult, type CatalogColumnCollision, CatalogColumnCollisionError, type CatalogFilteringReadStore, supportsObjectFilters, type CatalogMergeStore, type CatalogReadQuery, type CatalogReadResult, type CatalogReadStore, type CatalogReservedColumn, type CatalogSnapshotMode, type CatalogStoreCapabilities, type CatalogWriteStore, type ColumnCollisionOptions, findColumnCollisions, isCatalogStoreCapabilities, isReservedColumn, isSafeIdentifier, isWriteStore, type SnapshotRef, supportsCarryForward, UnsafeIdentifierError, } from './catalog.store';
+export { assertNoColumnCollisions, assertSafeIdentifier, CATALOG_RESERVED_COLUMNS, CATALOG_SNAPSHOT_MODES, CATALOG_STORE, type CarryForwardResult, type CatalogColumnCollision, CatalogColumnCollisionError, type CatalogFilteringReadStore, supportsObjectFilters, type CatalogMergeStore, type CatalogReadQuery, type CatalogReadResult, type CatalogReadStore, type CatalogReservedColumn, type CatalogSnapshotMode, type CatalogStoreCapabilities, type CatalogWriteStore, type ColumnCollisionOptions, findColumnCollisions, isCatalogStoreCapabilities, isReservedColumn, isSafeIdentifier, isWriteStore, outputAlias, physicalColumn, type SnapshotRef, supportsCarryForward, UnsafeIdentifierError, } from './catalog.store';
 export { MikroOrmReadStore } from './stores/mikro-orm-read.store';
 export type { CatalogGraph, CatalogObjectPage, CatalogObjectQuery, CatalogObjectTypeDef, CatalogOverlay, CatalogPropertyDef, CatalogRelationDef, CatalogSnapshot, RelationKind, ScalarType, } from './catalog.types';
 export { REQUIRED_SCOPES, REQUIRES_HUMAN, RequireHuman, RequireScopes, } from './catalog.route-auth';

package/dist/index.js

@@ -14,8 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAX_SEARCH_LIMIT = exports.DEFAULT_SEARCH_LIMIT = exports.CatalogService = exports.SubprocessTransformRunner = exports.toCsv = exports.QueryCache = exports.workflowRunOrder = exports.workflowGraphHash = exports.WORKFLOW_STATUSES = exports.WORKFLOW_NODE_KINDS = exports.WORKFLOW_NODE_ID_PATTERN = exports.WORKFLOW_ISSUE_CODES = exports.WORKFLOW_EXECUTION_MODES = exports.validateWorkflow = exports.TRANSFORM_LANGUAGES = exports.TRANSFORM_RUNNER = exports.supportsWorkflowStages = exports.supportsWorkflows = exports.isWorkflowStatus = exports.isWorkflowNodeKind = exports.isWorkflowNode = exports.isWorkflowExecutionMode = exports.isWorkflowEdge = exports.supportsTransformRevisions = exports.supportsLoadExpectations = exports.isTransformLanguage = exports.isPipelineStore = exports.isConnectorKind = exports.CONNECTOR_KINDS = exports.CATALOG_PIPELINE_STORE = exports.CatalogRegistry = exports.MikroOrmCatalogRegistry = exports.CATALOG_OVERLAY_STORE = exports.InMemoryCatalogOverlayStore = exports.FileCatalogOverlayStore = exports.CATALOG_OPTIONS = exports.isQueryStore = exports.assertReadOnlyShape = exports.CatalogModule = exports.emitCatalog = exports.curationActor = exports.channelNameFor = exports.catalogEventPhase = exports.UNATTRIBUTED_PRINCIPAL_ID = exports.CATALOG_LIB = exports.CATALOG_EVENTS = exports.CATALOG_EVENT_PHASE_FALLBACK = exports.CATALOG_EVENT_PHASE = exports.CatalogType = exports.CatalogProperty = void 0;
-exports.RequireScopes = exports.RequireHuman = exports.REQUIRES_HUMAN = exports.REQUIRED_SCOPES = exports.MikroOrmReadStore = exports.UnsafeIdentifierError = exports.supportsCarryForward = exports.isWriteStore = exports.isSafeIdentifier = exports.isReservedColumn = exports.isCatalogStoreCapabilities = exports.findColumnCollisions = exports.supportsObjectFilters = exports.CatalogColumnCollisionError = exports.CATALOG_STORE = exports.CATALOG_SNAPSHOT_MODES = exports.CATALOG_RESERVED_COLUMNS = exports.assertSafeIdentifier = exports.assertNoColumnCollisions = exports.StaticKeyPrincipalResolver = exports.readableObjectPage = exports.mayWrite = exports.mayRead = exports.maySeeClassification = exports.PRINCIPAL_ACTOR_SEPARATOR = exports.parsePrincipalId = exports.hasScope = exports.expandScopes = exports.delegatePrincipal = exports.composePrincipalId = exports.CATALOG_PRINCIPAL_RESOLVER = exports.traceOutcomeFilter = exports.supportsSavedQueryRevisions = exports.isWorkspaceStore = exports.isTraceStore = exports.isCatalogTraceOutcome = exports.embeddedVisualization = exports.CATALOG_WORKSPACE_STORE = exports.CATALOG_TRACE_STORE = exports.CATALOG_TRACE_OUTCOMES = exports.CATALOG_REVISION_LIMIT = exports.visibleToPrincipal = exports.searchCatalog = exports.maySearch = exports.emptySearch = exports.bestMatch = void 0;
+exports.csvLines = exports.csvCell = exports.QueryCache = exports.workflowRunOrder = exports.workflowGraphHash = exports.WORKFLOW_STATUSES = exports.WORKFLOW_NODE_KINDS = exports.WORKFLOW_NODE_ID_PATTERN = exports.WORKFLOW_ISSUE_CODES = exports.WORKFLOW_EXECUTION_MODES = exports.WORKFLOW_CALL_CONTRACT = exports.validateWorkflow = exports.TRANSFORM_LANGUAGES = exports.TRANSFORM_RUNNER = exports.supportsWorkflowStages = exports.supportsWorkflows = exports.isWorkflowStatus = exports.isWorkflowNodeKind = exports.isWorkflowNode = exports.isWorkflowExecutionMode = exports.isWorkflowEdge = exports.supportsTransformRevisions = exports.supportsLoadExpectations = exports.readWorkflowCallOutput = exports.isTransformLanguage = exports.isPipelineStore = exports.isConnectorKind = exports.CONNECTOR_KINDS = exports.CATALOG_PIPELINE_STORE = exports.CatalogRegistry = exports.MikroOrmCatalogRegistry = exports.CATALOG_OVERLAY_STORE = exports.InMemoryCatalogOverlayStore = exports.FileCatalogOverlayStore = exports.CATALOG_OPTIONS = exports.isStreamingQueryStore = exports.isQueryStore = exports.assertReadOnlyShape = exports.CatalogModule = exports.emitCatalog = exports.curationActor = exports.channelNameFor = exports.catalogEventPhase = exports.UNATTRIBUTED_PRINCIPAL_ID = exports.CATALOG_LIB = exports.CATALOG_EVENTS = exports.CATALOG_EVENT_PHASE_FALLBACK = exports.CATALOG_EVENT_PHASE = exports.CatalogType = exports.CatalogProperty = void 0;
+exports.MikroOrmReadStore = exports.UnsafeIdentifierError = exports.supportsCarryForward = exports.physicalColumn = exports.outputAlias = exports.isWriteStore = exports.isSafeIdentifier = exports.isReservedColumn = exports.isCatalogStoreCapabilities = exports.findColumnCollisions = exports.supportsObjectFilters = exports.CatalogColumnCollisionError = exports.CATALOG_STORE = exports.CATALOG_SNAPSHOT_MODES = exports.CATALOG_RESERVED_COLUMNS = exports.assertSafeIdentifier = exports.assertNoColumnCollisions = exports.StaticKeyPrincipalResolver = exports.readableObjectPage = exports.mayWrite = exports.mayRead = exports.maySeeClassification = exports.PRINCIPAL_ACTOR_SEPARATOR = exports.parsePrincipalId = exports.hasScope = exports.expandScopes = exports.delegatePrincipal = exports.composePrincipalId = exports.CATALOG_PRINCIPAL_RESOLVER = exports.traceOutcomeFilter = exports.supportsSavedQueryRevisions = exports.isWorkspaceStore = exports.isTraceStore = exports.isCatalogTraceOutcome = exports.embeddedVisualization = exports.CATALOG_WORKSPACE_STORE = exports.CATALOG_TRACE_STORE = exports.CATALOG_TRACE_OUTCOMES = exports.CATALOG_REVISION_LIMIT = exports.visibleToPrincipal = exports.searchCatalog = exports.maySearch = exports.emptySearch = exports.bestMatch = exports.MAX_SEARCH_LIMIT = exports.DEFAULT_SEARCH_LIMIT = exports.CatalogService = exports.SubprocessTransformRunner = exports.toCsv = exports.guardFormula = void 0;
+exports.RequireScopes = exports.RequireHuman = exports.REQUIRES_HUMAN = exports.REQUIRED_SCOPES = void 0;
 var catalog_decorators_1 = require("./catalog.decorators");
 Object.defineProperty(exports, "CatalogProperty", { enumerable: true, get: function () { return catalog_decorators_1.CatalogProperty; } });
 Object.defineProperty(exports, "CatalogType", { enumerable: true, get: function () { return catalog_decorators_1.CatalogType; } });
@@ -34,6 +35,7 @@ Object.defineProperty(exports, "CatalogModule", { enumerable: true, get: functio
 var catalog_query_1 = require("./catalog.query");
 Object.defineProperty(exports, "assertReadOnlyShape", { enumerable: true, get: function () { return catalog_query_1.assertReadOnlyShape; } });
 Object.defineProperty(exports, "isQueryStore", { enumerable: true, get: function () { return catalog_query_1.isQueryStore; } });
+Object.defineProperty(exports, "isStreamingQueryStore", { enumerable: true, get: function () { return catalog_query_1.isStreamingQueryStore; } });
 var catalog_options_1 = require("./catalog.options");
 Object.defineProperty(exports, "CATALOG_OPTIONS", { enumerable: true, get: function () { return catalog_options_1.CATALOG_OPTIONS; } });
 // Everything, deliberately, and here more than anywhere: this is a seam two
@@ -59,6 +61,7 @@ Object.defineProperty(exports, "CONNECTOR_KINDS", { enumerable: true, get: funct
 Object.defineProperty(exports, "isConnectorKind", { enumerable: true, get: function () { return catalog_pipeline_1.isConnectorKind; } });
 Object.defineProperty(exports, "isPipelineStore", { enumerable: true, get: function () { return catalog_pipeline_1.isPipelineStore; } });
 Object.defineProperty(exports, "isTransformLanguage", { enumerable: true, get: function () { return catalog_pipeline_1.isTransformLanguage; } });
+Object.defineProperty(exports, "readWorkflowCallOutput", { enumerable: true, get: function () { return catalog_pipeline_1.readWorkflowCallOutput; } });
 Object.defineProperty(exports, "supportsLoadExpectations", { enumerable: true, get: function () { return catalog_pipeline_1.supportsLoadExpectations; } });
 Object.defineProperty(exports, "supportsTransformRevisions", { enumerable: true, get: function () { return catalog_pipeline_1.supportsTransformRevisions; } });
 Object.defineProperty(exports, "isWorkflowEdge", { enumerable: true, get: function () { return catalog_pipeline_1.isWorkflowEdge; } });
@@ -71,6 +74,7 @@ Object.defineProperty(exports, "supportsWorkflowStages", { enumerable: true, get
 Object.defineProperty(exports, "TRANSFORM_RUNNER", { enumerable: true, get: function () { return catalog_pipeline_1.TRANSFORM_RUNNER; } });
 Object.defineProperty(exports, "TRANSFORM_LANGUAGES", { enumerable: true, get: function () { return catalog_pipeline_1.TRANSFORM_LANGUAGES; } });
 Object.defineProperty(exports, "validateWorkflow", { enumerable: true, get: function () { return catalog_pipeline_1.validateWorkflow; } });
+Object.defineProperty(exports, "WORKFLOW_CALL_CONTRACT", { enumerable: true, get: function () { return catalog_pipeline_1.WORKFLOW_CALL_CONTRACT; } });
 Object.defineProperty(exports, "WORKFLOW_EXECUTION_MODES", { enumerable: true, get: function () { return catalog_pipeline_1.WORKFLOW_EXECUTION_MODES; } });
 Object.defineProperty(exports, "WORKFLOW_ISSUE_CODES", { enumerable: true, get: function () { return catalog_pipeline_1.WORKFLOW_ISSUE_CODES; } });
 Object.defineProperty(exports, "WORKFLOW_NODE_ID_PATTERN", { enumerable: true, get: function () { return catalog_pipeline_1.WORKFLOW_NODE_ID_PATTERN; } });
@@ -83,7 +87,14 @@ Object.defineProperty(exports, "workflowRunOrder", { enumerable: true, get: func
 __exportStar(require("./catalog.environment"), exports);
 var catalog_query_cache_1 = require("./catalog.query-cache");
 Object.defineProperty(exports, "QueryCache", { enumerable: true, get: function () { return catalog_query_cache_1.QueryCache; } });
-Object.defineProperty(exports, "toCsv", { enumerable: true, get: function () { return catalog_query_cache_1.toCsv; } });
+// CSV. `toCsv` is the shape it always was; `csvLines` is the one the export
+// route uses, and `guardFormula` is exported because a host writing its own
+// export route needs the escaping and not the framing.
+var catalog_csv_1 = require("./catalog.csv");
+Object.defineProperty(exports, "csvCell", { enumerable: true, get: function () { return catalog_csv_1.csvCell; } });
+Object.defineProperty(exports, "csvLines", { enumerable: true, get: function () { return catalog_csv_1.csvLines; } });
+Object.defineProperty(exports, "guardFormula", { enumerable: true, get: function () { return catalog_csv_1.guardFormula; } });
+Object.defineProperty(exports, "toCsv", { enumerable: true, get: function () { return catalog_csv_1.toCsv; } });
 var transform_runner_1 = require("./transform-runner");
 Object.defineProperty(exports, "SubprocessTransformRunner", { enumerable: true, get: function () { return transform_runner_1.SubprocessTransformRunner; } });
 var catalog_service_1 = require("./catalog.service");
@@ -152,6 +163,8 @@ Object.defineProperty(exports, "isCatalogStoreCapabilities", { enumerable: true,
 Object.defineProperty(exports, "isReservedColumn", { enumerable: true, get: function () { return catalog_store_1.isReservedColumn; } });
 Object.defineProperty(exports, "isSafeIdentifier", { enumerable: true, get: function () { return catalog_store_1.isSafeIdentifier; } });
 Object.defineProperty(exports, "isWriteStore", { enumerable: true, get: function () { return catalog_store_1.isWriteStore; } });
+Object.defineProperty(exports, "outputAlias", { enumerable: true, get: function () { return catalog_store_1.outputAlias; } });
+Object.defineProperty(exports, "physicalColumn", { enumerable: true, get: function () { return catalog_store_1.physicalColumn; } });
 Object.defineProperty(exports, "supportsCarryForward", { enumerable: true, get: function () { return catalog_store_1.supportsCarryForward; } });
 Object.defineProperty(exports, "UnsafeIdentifierError", { enumerable: true, get: function () { return catalog_store_1.UnsafeIdentifierError; } });
 var mikro_orm_read_store_1 = require("./stores/mikro-orm-read.store");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dudousxd/nestjs-catalog",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "A metadata registry for NestJS: object types, properties and relations, derived from your ORM and enriched with decorators.",
   "license": "MIT",
   "author": "Davide Carvalho",