@orthacms/content-server 0.4.2 → 0.5.0

package/dist/index.d.ts

@@ -1,6 +1,12 @@
 /** Public API of @orthacms/content-server. */
 export { ContentPlugin } from './lib/utils/content-plugin';
 export type { ContentPluginOptions, ContentServerPlugin } from './lib/utils/content-plugin';
+export { ContentViewsPlugin } from './lib/utils/content-views-plugin';
+export type { ContentViewsPluginOptions } from './lib/utils/content-views-plugin';
+export { ContentViewsModule } from './lib/views/content-views.module';
+export { savedViews, savedViewDefaults, viewVisibility } from './lib/views/infrastructure/schema';
+export { VIEW_VISIBILITY, VIEW_VISIBILITY_VALUES } from './lib/views/domain/saved-view';
+export type { SavedView, SavedViewPayload, ViewVisibility } from './lib/views/domain/saved-view';
 export { collection, single, joinTableOf } from './lib/collection/define';
 export { field } from './lib/fields';
 export { ContentModule } from './lib/content.module';
@@ -12,12 +18,21 @@ export { ContentGrantGuard } from './lib/entries/http/guards/content-grant.guard
 export { CONTENT_ENTRY_EXTENSION } from './lib/extension/entry-extension';
 export type { ContentEntryExtension, EntryFilterContext, EntryFilterExtension, EntryScopeParams, EntryTransaction, EntryWriteContext, EntryWriteFanout } from './lib/extension/entry-extension';
 export { RELATION_LOCALE_SYNC, relationLocaleSync, isPerLocaleField, isJoinBackedRelation, type RelationLocaleSync } from './lib/extension/relation-locale-sync';
+export { ContentReadScopeRegistry, contentReadScopeRegistrar } from './lib/extension/read-scope';
+export type { ContentReadScope, ContentReadScopeContext } from './lib/extension/read-scope';
+export { EntryWriteExtensionRegistry, entryWriteExtensionRegistrar } from './lib/extension/entry-write-extension';
+export type { EntryWriteExtension, EntryWriteExtensionInput, EntryWriteExtensionTarget } from './lib/extension/entry-write-extension';
+export { EntryFilterProviderRegistry, entryFilterProviderRegistrar } from './lib/extension/entry-filter-provider';
+export type { EntryFilterProvider } from './lib/extension/entry-filter-provider';
+export type { DbTransaction } from './lib/entries/infrastructure/persistence/relation-link.service';
 export { MEDIA_ASSET_RESOLVER, InjectMediaAssetResolver } from './lib/extension/media-asset-resolver';
 export type { MediaAssetResolver, ResolvedMediaAsset } from './lib/extension/media-asset-resolver';
 export { toColumns, toRecord } from './lib/entries/infrastructure/persistence/entry-row';
 export type { EntryListView, EntryMediaView, EntryRecord, MediaRef } from './lib/entries/types/entry-list-view';
 export { ContentTypeRegistry } from './lib/registry/content-type-registry';
 export type { SerializedContentType, SerializedContentTypeSummary, SerializedField } from './lib/registry/content-type-registry';
+export { EntryMatchQuery } from './lib/entries/infrastructure/queries/entry-match.query';
+export type { EntryMatchOptions } from './lib/entries/infrastructure/queries/entry-match.query';
 export { EntryValidationService } from './lib/validation/services/entry-validation.service';
 export type { ValidationIssue, ValidationResult } from './lib/validation/services/entry-validation.service';
 export { CONTENT_TYPE_KIND, ENTRY_STATUS } from './lib/types/content-type';
@@ -46,4 +61,5 @@ export type { PublicMediaFieldView, PublicMediaRef, PublicRelationFieldView } fr
 export { DEFAULT_PAGE_SIZE, MAX_PAGE_SIZE, BULK_MAX_SAVE_ITEMS } from './lib/entries/entries.constants';
 export { RELATION_DELTA_ADDRESSING } from './lib/entries/types/entry-list-view';
 export type { RelationDelta, RelationDeltaAddressing } from './lib/entries/types/entry-list-view';
+export { toTokenActor, toToolEventActor } from './lib/public-api/infrastructure/token-actor';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,YAAY,EACR,oBAAoB,EACpB,mBAAmB,EACtB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAO/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,oDAAoD,CAAC;AAO1F,OAAO,EAAE,kBAAkB,EAAE,MAAM,+DAA+D,CAAC;AAInG,OAAO,EAAE,mBAAmB,EAAE,MAAM,gEAAgE,CAAC;AAOrG,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,YAAY,EACR,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,KAAK,kBAAkB,EAC1B,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EACH,oBAAoB,EACpB,wBAAwB,EAC3B,MAAM,sCAAsC,CAAC;AAC9C,YAAY,EACR,kBAAkB,EAClB,kBAAkB,EACrB,MAAM,sCAAsC,CAAC;AAI9C,OAAO,EACH,SAAS,EACT,QAAQ,EACX,MAAM,oDAAoD,CAAC;AAC5D,YAAY,EACR,aAAa,EACb,cAAc,EACd,WAAW,EACX,QAAQ,EACX,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,YAAY,EACR,qBAAqB,EACrB,4BAA4B,EAC5B,eAAe,EAClB,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,oDAAoD,CAAC;AAC5F,YAAY,EACR,eAAe,EACf,gBAAgB,EACnB,MAAM,oDAAoD,CAAC;AAE5D,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC3E,YAAY,EACR,cAAc,EACd,WAAW,EACX,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,WAAW,EACX,aAAa,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,YAAY,EACR,UAAU,EACV,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,eAAe,EACf,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACf,MAAM,oBAAoB,CAAC;AAO5B,YAAY,EACR,WAAW,EACX,mBAAmB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EAAE,yBAAyB,EAAE,MAAM,mEAAmE,CAAC;AACnH,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,wDAAwD,CAAC;AAChG,OAAO,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAC;AAC/F,YAAY,EACR,eAAe,EACf,cAAc,EACjB,MAAM,yCAAyC,CAAC;AAQjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sDAAsD,CAAC;AAC1F,YAAY,EAAE,YAAY,EAAE,MAAM,sDAAsD,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,6DAA6D,CAAC;AAGvG,OAAO,EAAE,kBAAkB,EAAE,MAAM,wDAAwD,CAAC;AAC5F,YAAY,EACR,mBAAmB,EACnB,WAAW,EACd,MAAM,wDAAwD,CAAC;AAChE,OAAO,EACH,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,OAAO,EACP,uBAAuB,EAC1B,MAAM,yDAAyD,CAAC;AACjE,YAAY,EAAE,eAAe,EAAE,MAAM,yDAAyD,CAAC;AAC/F,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AAKrF,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACxB,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,YAAY,EACR,UAAU,EACV,eAAe,EACf,wBAAwB,EACxB,oBAAoB,EACvB,MAAM,oCAAoC,CAAC;AAC5C,YAAY,EACR,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EAC1B,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACH,iBAAiB,EACjB,aAAa,EAIb,mBAAmB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,YAAY,EACR,aAAa,EACb,uBAAuB,EAC1B,MAAM,qCAAqC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8CAA8C;AAE9C,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,YAAY,EACR,oBAAoB,EACpB,mBAAmB,EACtB,MAAM,4BAA4B,CAAC;AAKpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,YAAY,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAClF,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EACH,UAAU,EACV,iBAAiB,EACjB,cAAc,EACjB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACH,eAAe,EACf,sBAAsB,EACzB,MAAM,+BAA+B,CAAC;AACvC,YAAY,EACR,SAAS,EACT,gBAAgB,EAChB,cAAc,EACjB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC1E,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAO/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,oDAAoD,CAAC;AAO1F,OAAO,EAAE,kBAAkB,EAAE,MAAM,+DAA+D,CAAC;AAInG,OAAO,EAAE,mBAAmB,EAAE,MAAM,gEAAgE,CAAC;AAOrG,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,YAAY,EACR,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACH,oBAAoB,EACpB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,KAAK,kBAAkB,EAC1B,MAAM,sCAAsC,CAAC;AAK9C,OAAO,EACH,wBAAwB,EACxB,yBAAyB,EAC5B,MAAM,4BAA4B,CAAC;AACpC,YAAY,EACR,gBAAgB,EAChB,uBAAuB,EAC1B,MAAM,4BAA4B,CAAC;AAKpC,OAAO,EACH,2BAA2B,EAC3B,4BAA4B,EAC/B,MAAM,uCAAuC,CAAC;AAC/C,YAAY,EACR,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EAC5B,MAAM,uCAAuC,CAAC;AAI/C,OAAO,EACH,2BAA2B,EAC3B,4BAA4B,EAC/B,MAAM,uCAAuC,CAAC;AAC/C,YAAY,EAAE,mBAAmB,EAAE,MAAM,uCAAuC,CAAC;AAIjF,YAAY,EAAE,aAAa,EAAE,MAAM,gEAAgE,CAAC;AAEpG,OAAO,EACH,oBAAoB,EACpB,wBAAwB,EAC3B,MAAM,sCAAsC,CAAC;AAC9C,YAAY,EACR,kBAAkB,EAClB,kBAAkB,EACrB,MAAM,sCAAsC,CAAC;AAI9C,OAAO,EACH,SAAS,EACT,QAAQ,EACX,MAAM,oDAAoD,CAAC;AAC5D,YAAY,EACR,aAAa,EACb,cAAc,EACd,WAAW,EACX,QAAQ,EACX,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,YAAY,EACR,qBAAqB,EACrB,4BAA4B,EAC5B,eAAe,EAClB,MAAM,sCAAsC,CAAC;AAK9C,OAAO,EAAE,eAAe,EAAE,MAAM,wDAAwD,CAAC;AACzF,YAAY,EAAE,iBAAiB,EAAE,MAAM,wDAAwD,CAAC;AAChG,OAAO,EAAE,sBAAsB,EAAE,MAAM,oDAAoD,CAAC;AAC5F,YAAY,EACR,eAAe,EACf,gBAAgB,EACnB,MAAM,oDAAoD,CAAC;AAE5D,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC3E,YAAY,EACR,cAAc,EACd,WAAW,EACX,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,WAAW,EACX,aAAa,EAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,YAAY,EACR,UAAU,EACV,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,SAAS,EACT,eAAe,EACf,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACf,MAAM,oBAAoB,CAAC;AAO5B,YAAY,EACR,WAAW,EACX,mBAAmB,EACtB,MAAM,qCAAqC,CAAC;AAC7C,YAAY,EAAE,yBAAyB,EAAE,MAAM,mEAAmE,CAAC;AACnH,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,MAAM,wDAAwD,CAAC;AAChG,OAAO,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAC;AAC/F,YAAY,EACR,eAAe,EACf,cAAc,EACjB,MAAM,yCAAyC,CAAC;AAQjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sDAAsD,CAAC;AAC1F,YAAY,EAAE,YAAY,EAAE,MAAM,sDAAsD,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,6DAA6D,CAAC;AAGvG,OAAO,EAAE,kBAAkB,EAAE,MAAM,wDAAwD,CAAC;AAC5F,YAAY,EACR,mBAAmB,EACnB,WAAW,EACd,MAAM,wDAAwD,CAAC;AAChE,OAAO,EACH,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,OAAO,EACP,uBAAuB,EAC1B,MAAM,yDAAyD,CAAC;AACjE,YAAY,EAAE,eAAe,EAAE,MAAM,yDAAyD,CAAC;AAC/F,OAAO,EAAE,kBAAkB,EAAE,MAAM,iDAAiD,CAAC;AAKrF,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACxB,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,YAAY,EACR,UAAU,EACV,eAAe,EACf,wBAAwB,EACxB,oBAAoB,EACvB,MAAM,oCAAoC,CAAC;AAC5C,YAAY,EACR,oBAAoB,EACpB,cAAc,EACd,uBAAuB,EAC1B,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACH,iBAAiB,EACjB,aAAa,EAIb,mBAAmB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,YAAY,EACR,aAAa,EACb,uBAAuB,EAC1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACH,YAAY,EACZ,gBAAgB,EACnB,MAAM,6CAA6C,CAAC"}

package/dist/index.js

@@ -1,9 +1,24 @@
 "use strict";
 /** Public API of @orthacms/content-server. */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RELATION_DELTA_ADDRESSING = exports.BULK_MAX_SAVE_ITEMS = exports.MAX_PAGE_SIZE = exports.DEFAULT_PAGE_SIZE = exports.BULK_SAVE_OP = exports.PublicBulkSaveItemDto = exports.PublicBulkSaveDto = exports.PublicBulkIdsDto = exports.PublicSaveEntryDto = exports.DEFAULT_EXPANSION_LIMIT = exports.PREVIEW = exports.ENTRY_VISIBILITY = exports.PublicListEntriesQueryDto = exports.PublicEntryQueryDto = exports.resolveGrantedType = exports.PublicEntryWritesService = exports.PublicEntriesQuery = exports.CurrentApiToken = exports.ApiTokenWorkspaceGuard = exports.ApiTokenGuard = exports.MEDIA_KIND_VALUES = exports.CONTENT_FIELD_TYPE = exports.ENTRY_STATUS = exports.CONTENT_TYPE_KIND = exports.EntryValidationService = exports.ContentTypeRegistry = exports.toRecord = exports.toColumns = exports.InjectMediaAssetResolver = exports.MEDIA_ASSET_RESOLVER = exports.isJoinBackedRelation = exports.isPerLocaleField = exports.relationLocaleSync = exports.RELATION_LOCALE_SYNC = exports.CONTENT_ENTRY_EXTENSION = exports.ContentGrantGuard = exports.RelationLinkService = exports.EntryWriterService = exports.WorkspaceGrantsQuery = exports.InjectContentRegistry = exports.CONTENT_REGISTRY = exports.ContentModule = exports.field = exports.joinTableOf = exports.single = exports.collection = exports.ContentPlugin = void 0;
+exports.ENTRY_VISIBILITY = exports.PublicListEntriesQueryDto = exports.PublicEntryQueryDto = exports.resolveGrantedType = exports.PublicEntryWritesService = exports.PublicEntriesQuery = exports.CurrentApiToken = exports.ApiTokenWorkspaceGuard = exports.ApiTokenGuard = exports.MEDIA_KIND_VALUES = exports.CONTENT_FIELD_TYPE = exports.ENTRY_STATUS = exports.CONTENT_TYPE_KIND = exports.EntryValidationService = exports.EntryMatchQuery = exports.ContentTypeRegistry = exports.toRecord = exports.toColumns = exports.InjectMediaAssetResolver = exports.MEDIA_ASSET_RESOLVER = exports.entryFilterProviderRegistrar = exports.EntryFilterProviderRegistry = exports.entryWriteExtensionRegistrar = exports.EntryWriteExtensionRegistry = exports.contentReadScopeRegistrar = exports.ContentReadScopeRegistry = exports.isJoinBackedRelation = exports.isPerLocaleField = exports.relationLocaleSync = exports.RELATION_LOCALE_SYNC = exports.CONTENT_ENTRY_EXTENSION = exports.ContentGrantGuard = exports.RelationLinkService = exports.EntryWriterService = exports.WorkspaceGrantsQuery = exports.InjectContentRegistry = exports.CONTENT_REGISTRY = exports.ContentModule = exports.field = exports.joinTableOf = exports.single = exports.collection = exports.VIEW_VISIBILITY_VALUES = exports.VIEW_VISIBILITY = exports.viewVisibility = exports.savedViewDefaults = exports.savedViews = exports.ContentViewsModule = exports.ContentViewsPlugin = exports.ContentPlugin = void 0;
+exports.toToolEventActor = exports.toTokenActor = exports.RELATION_DELTA_ADDRESSING = exports.BULK_MAX_SAVE_ITEMS = exports.MAX_PAGE_SIZE = exports.DEFAULT_PAGE_SIZE = exports.BULK_SAVE_OP = exports.PublicBulkSaveItemDto = exports.PublicBulkSaveDto = exports.PublicBulkIdsDto = exports.PublicSaveEntryDto = exports.DEFAULT_EXPANSION_LIMIT = exports.PREVIEW = void 0;
 var content_plugin_1 = require("./lib/utils/content-plugin");
 Object.defineProperty(exports, "ContentPlugin", { enumerable: true, get: function () { return content_plugin_1.ContentPlugin; } });
+// Saved list views. A second `ServerPlugin` entry from this package because
+// `ServerPlugin.migrations` holds one descriptor and content's is already the
+// HOST's generated collection tables — see `content-views-plugin.ts`.
+var content_views_plugin_1 = require("./lib/utils/content-views-plugin");
+Object.defineProperty(exports, "ContentViewsPlugin", { enumerable: true, get: function () { return content_views_plugin_1.ContentViewsPlugin; } });
+var content_views_module_1 = require("./lib/views/content-views.module");
+Object.defineProperty(exports, "ContentViewsModule", { enumerable: true, get: function () { return content_views_module_1.ContentViewsModule; } });
+var schema_1 = require("./lib/views/infrastructure/schema");
+Object.defineProperty(exports, "savedViews", { enumerable: true, get: function () { return schema_1.savedViews; } });
+Object.defineProperty(exports, "savedViewDefaults", { enumerable: true, get: function () { return schema_1.savedViewDefaults; } });
+Object.defineProperty(exports, "viewVisibility", { enumerable: true, get: function () { return schema_1.viewVisibility; } });
+var saved_view_1 = require("./lib/views/domain/saved-view");
+Object.defineProperty(exports, "VIEW_VISIBILITY", { enumerable: true, get: function () { return saved_view_1.VIEW_VISIBILITY; } });
+Object.defineProperty(exports, "VIEW_VISIBILITY_VALUES", { enumerable: true, get: function () { return saved_view_1.VIEW_VISIBILITY_VALUES; } });
 var define_1 = require("./lib/collection/define");
 Object.defineProperty(exports, "collection", { enumerable: true, get: function () { return define_1.collection; } });
 Object.defineProperty(exports, "single", { enumerable: true, get: function () { return define_1.single; } });
@@ -48,6 +63,23 @@ Object.defineProperty(exports, "RELATION_LOCALE_SYNC", { enumerable: true, get:
 Object.defineProperty(exports, "relationLocaleSync", { enumerable: true, get: function () { return relation_locale_sync_1.relationLocaleSync; } });
 Object.defineProperty(exports, "isPerLocaleField", { enumerable: true, get: function () { return relation_locale_sync_1.isPerLocaleField; } });
 Object.defineProperty(exports, "isJoinBackedRelation", { enumerable: true, get: function () { return relation_locale_sync_1.isJoinBackedRelation; } });
+// The read-scope port. Separate from CONTENT_ENTRY_EXTENSION on purpose — that
+// one is single-binding and i18n holds it; see the file header for why a
+// composite was the wrong shape here.
+var read_scope_1 = require("./lib/extension/read-scope");
+Object.defineProperty(exports, "ContentReadScopeRegistry", { enumerable: true, get: function () { return read_scope_1.ContentReadScopeRegistry; } });
+Object.defineProperty(exports, "contentReadScopeRegistrar", { enumerable: true, get: function () { return read_scope_1.contentReadScopeRegistrar; } });
+// The entry-write extension port — how a plugin stores state *about* an entry
+// inside the entry's own write transaction, and has it captured by (and restored
+// from) the entry's own version history.
+var entry_write_extension_1 = require("./lib/extension/entry-write-extension");
+Object.defineProperty(exports, "EntryWriteExtensionRegistry", { enumerable: true, get: function () { return entry_write_extension_1.EntryWriteExtensionRegistry; } });
+Object.defineProperty(exports, "entryWriteExtensionRegistrar", { enumerable: true, get: function () { return entry_write_extension_1.entryWriteExtensionRegistrar; } });
+// The virtual filter-field registry — how a plugin other than the single bound
+// `CONTENT_ENTRY_EXTENSION` adds fields to a type's `?filter=` surface.
+var entry_filter_provider_1 = require("./lib/extension/entry-filter-provider");
+Object.defineProperty(exports, "EntryFilterProviderRegistry", { enumerable: true, get: function () { return entry_filter_provider_1.EntryFilterProviderRegistry; } });
+Object.defineProperty(exports, "entryFilterProviderRegistrar", { enumerable: true, get: function () { return entry_filter_provider_1.entryFilterProviderRegistrar; } });
 var media_asset_resolver_1 = require("./lib/extension/media-asset-resolver");
 Object.defineProperty(exports, "MEDIA_ASSET_RESOLVER", { enumerable: true, get: function () { return media_asset_resolver_1.MEDIA_ASSET_RESOLVER; } });
 Object.defineProperty(exports, "InjectMediaAssetResolver", { enumerable: true, get: function () { return media_asset_resolver_1.InjectMediaAssetResolver; } });
@@ -58,6 +90,11 @@ Object.defineProperty(exports, "toColumns", { enumerable: true, get: function ()
 Object.defineProperty(exports, "toRecord", { enumerable: true, get: function () { return entry_row_1.toRecord; } });
 var content_type_registry_1 = require("./lib/registry/content-type-registry");
 Object.defineProperty(exports, "ContentTypeRegistry", { enumerable: true, get: function () { return content_type_registry_1.ContentTypeRegistry; } });
+// Filter evaluation over a content type, exported for `@orthacms/alarms-server`:
+// an alarm rule IS a records-list filter, so it must be parsed and translated
+// by the same surface the list uses rather than by a second implementation.
+var entry_match_query_1 = require("./lib/entries/infrastructure/queries/entry-match.query");
+Object.defineProperty(exports, "EntryMatchQuery", { enumerable: true, get: function () { return entry_match_query_1.EntryMatchQuery; } });
 var entry_validation_service_1 = require("./lib/validation/services/entry-validation.service");
 Object.defineProperty(exports, "EntryValidationService", { enumerable: true, get: function () { return entry_validation_service_1.EntryValidationService; } });
 var content_type_1 = require("./lib/types/content-type");
@@ -114,3 +151,6 @@ Object.defineProperty(exports, "MAX_PAGE_SIZE", { enumerable: true, get: functio
 Object.defineProperty(exports, "BULK_MAX_SAVE_ITEMS", { enumerable: true, get: function () { return entries_constants_1.BULK_MAX_SAVE_ITEMS; } });
 var entry_list_view_1 = require("./lib/entries/types/entry-list-view");
 Object.defineProperty(exports, "RELATION_DELTA_ADDRESSING", { enumerable: true, get: function () { return entry_list_view_1.RELATION_DELTA_ADDRESSING; } });
+var token_actor_1 = require("./lib/public-api/infrastructure/token-actor");
+Object.defineProperty(exports, "toTokenActor", { enumerable: true, get: function () { return token_actor_1.toTokenActor; } });
+Object.defineProperty(exports, "toToolEventActor", { enumerable: true, get: function () { return token_actor_1.toToolEventActor; } });

package/dist/lib/content.module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"content.module.d.ts","sourceRoot":"","sources":["../../src/lib/content.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAU,MAAM,gBAAgB,CAAC;AAOvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AA4D5E;;;;;;;;;;;;;GAaG;AACH,qBACa,aAAa;IACtB,qEAAqE;IACrE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,mBAAmB,GAAG,aAAa;CA0L/D"}
+{"version":3,"file":"content.module.d.ts","sourceRoot":"","sources":["../../src/lib/content.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAU,MAAM,gBAAgB,CAAC;AAOvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAiE5E;;;;;;;;;;;;;GAaG;AACH,qBACa,aAAa;IACtB,qEAAqE;IACrE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,mBAAmB,GAAG,aAAa;CAmN/D"}

package/dist/lib/content.module.js

@@ -10,6 +10,9 @@ const list_content_schema_controller_1 = require("./content-types/controllers/li
 const get_content_schema_controller_1 = require("./content-types/controllers/get-content-schema.controller");
 const get_filter_fields_controller_1 = require("./content-types/controllers/get-filter-fields.controller");
 const workspace_grants_query_1 = require("./content-types/queries/workspace-grants.query");
+const read_scope_1 = require("./extension/read-scope");
+const entry_write_extension_1 = require("./extension/entry-write-extension");
+const entry_filter_provider_1 = require("./extension/entry-filter-provider");
 const content_grant_guard_1 = require("./entries/http/guards/content-grant.guard");
 const list_entries_controller_1 = require("./entries/http/controllers/list-entries.controller");
 const bulk_entries_controller_1 = require("./entries/http/controllers/bulk-entries.controller");
@@ -26,6 +29,7 @@ const entry_proposal_provider_1 = require("./copilot/entry-proposal.provider");
 const entry_proposal_applier_1 = require("./copilot/entry-proposal.applier");
 const entry_validation_service_1 = require("./validation/services/entry-validation.service");
 const entries_service_1 = require("./entries/infrastructure/queries/entries.service");
+const entry_match_query_1 = require("./entries/infrastructure/queries/entry-match.query");
 const media_refs_query_1 = require("./entries/infrastructure/queries/media-refs.query");
 const entry_writer_service_1 = require("./entries/infrastructure/persistence/entry-writer.service");
 const entry_counter_service_1 = require("./entries/infrastructure/persistence/entry-counter.service");
@@ -40,6 +44,7 @@ const drizzle_revision_store_1 = require("./revisions/infrastructure/persistence
 const restore_revision_use_case_1 = require("./revisions/application/use-cases/restore-revision.use-case");
 const publish_revision_use_case_1 = require("./revisions/application/use-cases/publish-revision.use-case");
 const revision_refs_query_1 = require("./revisions/infrastructure/queries/revision-refs.query");
+const revisions_workspace_purger_1 = require("./revisions/infrastructure/purge/revisions-workspace.purger");
 const revisions_controller_1 = require("./revisions/http/controllers/revisions.controller");
 const restore_revision_controller_1 = require("./revisions/http/controllers/restore-revision.controller");
 const publish_revision_controller_1 = require("./revisions/http/controllers/publish-revision.controller");
@@ -150,10 +155,20 @@ let ContentModule = ContentModule_1 = class ContentModule {
                 },
                 entry_validation_service_1.EntryValidationService,
                 workspace_grants_query_1.WorkspaceGrantsQuery,
+                // Holds the read scopes a downstream plugin registers. Provided
+                // (and exported) unconditionally: an empty registry is what an
+                // installation with no scoping plugin has, and it costs a
+                // length check per read.
+                read_scope_1.ContentReadScopeRegistry,
+                entry_write_extension_1.EntryWriteExtensionRegistry,
+                entry_filter_provider_1.EntryFilterProviderRegistry,
                 // Every registry-driven `content/:typeName` route is guarded by
                 // it, so it is resolved from this module's context.
                 content_grant_guard_1.ContentGrantGuard,
                 entries_service_1.EntriesService,
+                // Filter evaluation as a reusable question ('which entries match
+                // this tree?'), exported for `@orthacms/alarms-server`.
+                entry_match_query_1.EntryMatchQuery,
                 content_insights_query_1.ContentInsightsQuery,
                 // Resolves media field ids → display refs (thumbnails); injected
                 // by the entry-media read endpoint and the revision refs query.
@@ -170,6 +185,13 @@ let ContentModule = ContentModule_1 = class ContentModule {
                 // Resolves a previewed revision's relation ids to display refs
                 // (the "exact linked records" the diff shows).
                 revision_refs_query_1.RevisionRefsQuery,
+                // Removes a deleted workspace's revision history. Content
+                // otherwise refuses rather than purges, but revisions escape
+                // that protection in both directions: no FK to `workspaces`,
+                // and `countWorkspaceEntries` sums live entry tables only — so
+                // a workspace whose entries were all deleted counts as empty,
+                // deletes cleanly, and strands its whole version timeline.
+                revisions_workspace_purger_1.RevisionsWorkspacePurger,
                 entry_writer_service_1.EntryWriterService,
                 relation_link_service_1.RelationLinkService,
                 // Entries feature, layered per ADR-0003: the publish-lifecycle
@@ -239,6 +261,9 @@ let ContentModule = ContentModule_1 = class ContentModule {
                 // workspace's grants — and there must be exactly one
                 // implementation of that check, not one per binder.
                 workspace_grants_query_1.WorkspaceGrantsQuery,
+                read_scope_1.ContentReadScopeRegistry,
+                entry_write_extension_1.EntryWriteExtensionRegistry,
+                entry_filter_provider_1.EntryFilterProviderRegistry,
                 public_entries_query_1.PublicEntriesQuery,
                 public_entry_writes_service_1.PublicEntryWritesService,
                 api_token_guard_1.ApiTokenGuard,
@@ -253,7 +278,12 @@ let ContentModule = ContentModule_1 = class ContentModule {
                 // and it has to be through the same service the entries
                 // pipeline writes with — a second implementation of the join
                 // table's ordering and de-duplication is how the two drift.
-                relation_link_service_1.RelationLinkService
+                relation_link_service_1.RelationLinkService,
+                // Filter evaluation, for the alarms plugin: a stored rule is a
+                // records-list filter, and it has to keep meaning exactly what
+                // the list showed when it was saved. Sharing the query is what
+                // makes that structural instead of aspirational.
+                entry_match_query_1.EntryMatchQuery
             ]
         };
     }

package/dist/lib/copilot/entry-proposal.applier.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entry-proposal.applier.d.ts","sourceRoot":"","sources":["../../../src/lib/copilot/entry-proposal.applier.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACR,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,cAAc,EACjB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4DAA4D,CAAC;AAChG,OAAO,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AA8CvF;;;;;;;;;;;;;;;GAeG;AACH,qBACa,0BAA2B,YAAW,eAAe;IAK1D,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAN3B,QAAQ,CAAC,IAAI,yBAAsC;gBAI9B,QAAQ,EAAE,mBAAmB,EAC7B,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,oBAAoB;IAG3C,KAAK,CACP,KAAK,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EACjE,KAAK,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC;CAiClC;AAED;;;;;;;;;;;;;;GAcG;AACH,qBACa,0BAA2B,YAAW,eAAe;IAK1D,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAN3B,QAAQ,CAAC,IAAI,yBAAsC;gBAI9B,QAAQ,EAAE,mBAAmB,EAC7B,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,oBAAoB;IAG3C,KAAK,CACP,KAAK,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EACjE,KAAK,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC;CAwClC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBACa,8BAA+B,YAAW,eAAe;IAK9D,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAN3B,QAAQ,CAAC,IAAI,4BAA0C;gBAIlC,QAAQ,EAAE,mBAAmB,EAC7B,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,oBAAoB;IAG3C,KAAK,CACP,KAAK,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EACjE,KAAK,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC;CAqFlC"}
+{"version":3,"file":"entry-proposal.applier.d.ts","sourceRoot":"","sources":["../../../src/lib/copilot/entry-proposal.applier.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACR,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,cAAc,EACjB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4DAA4D,CAAC;AAChG,OAAO,EAAE,oBAAoB,EAAE,MAAM,iDAAiD,CAAC;AA8CvF;;;;;;;;;;;;;;;GAeG;AACH,qBACa,0BAA2B,YAAW,eAAe;IAK1D,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAN3B,QAAQ,CAAC,IAAI,yBAAsC;gBAI9B,QAAQ,EAAE,mBAAmB,EAC7B,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,oBAAoB;IAG3C,KAAK,CACP,KAAK,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EACjE,KAAK,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC;CAiClC;AAED;;;;;;;;;;;;;;GAcG;AACH,qBACa,0BAA2B,YAAW,eAAe;IAK1D,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAN3B,QAAQ,CAAC,IAAI,yBAAsC;gBAI9B,QAAQ,EAAE,mBAAmB,EAC7B,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,oBAAoB;IAG3C,KAAK,CACP,KAAK,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EACjE,KAAK,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC;CAwClC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBACa,8BAA+B,YAAW,eAAe;IAK9D,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAN3B,QAAQ,CAAC,IAAI,4BAA0C;gBAIlC,QAAQ,EAAE,mBAAmB,EAC7B,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,oBAAoB;IAG3C,KAAK,CACP,KAAK,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,EACjE,KAAK,EAAE,aAAa,GACrB,OAAO,CAAC,mBAAmB,CAAC;CAqFlC"}

package/dist/lib/copilot/entry-proposal.applier.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BulkSaveEntriesProposalApplier = exports.UpdateEntryProposalApplier = exports.CreateEntryProposalApplier = void 0;
 const tslib_1 = require("tslib");
+const copilot_server_1 = require("@orthacms/copilot-server");
 const common_1 = require("@nestjs/common");
 const content_tokens_1 = require("../content.tokens");
 const entry_writer_service_1 = require("../entries/infrastructure/persistence/entry-writer.service");
@@ -83,7 +84,7 @@ let CreateEntryProposalApplier = class CreateEntryProposalApplier {
         // The human who accepted is the actor on the write, on its revision
         // and on the domain event it raises — never a copilot identity,
         // which does not exist.
-        { id: actor.userId, email: actor.actorEmail });
+        (0, copilot_server_1.proposalEventActor)(actor));
         return {
             entityId: entry.id,
             detail: { typeName: type.name, status: entry.status ?? 'draft' }
@@ -134,7 +135,7 @@ let UpdateEntryProposalApplier = class UpdateEntryProposalApplier {
         const current = await this.writer.getOne(type, entryId, actor.workspaceId);
         const patch = (input.patch['values'] ?? {});
         const merged = { ...(current.values ?? {}), ...patch };
-        const entry = await this.writer.update(type, entryId, merged, actor.workspaceId, undefined, { id: actor.userId, email: actor.actorEmail });
+        const entry = await this.writer.update(type, entryId, merged, actor.workspaceId, undefined, (0, copilot_server_1.proposalEventActor)(actor));
         return {
             entityId: entry.id,
             detail: {
@@ -201,7 +202,7 @@ let BulkSaveEntriesProposalApplier = class BulkSaveEntriesProposalApplier {
                     // become — the same merge rule the single-entry applier
                     // states at length.
                     const current = await this.writer.getOne(type, id, actor.workspaceId);
-                    const entry = await this.writer.update(type, id, { ...(current.values ?? {}), ...values }, actor.workspaceId, undefined, { id: actor.userId, email: actor.actorEmail });
+                    const entry = await this.writer.update(type, id, { ...(current.values ?? {}), ...values }, actor.workspaceId, undefined, (0, copilot_server_1.proposalEventActor)(actor));
                     updated.push(entry.id);
                 }
                 else {
@@ -210,7 +211,7 @@ let BulkSaveEntriesProposalApplier = class BulkSaveEntriesProposalApplier {
                         ? item.locale
                         : undefined, 
                     // No group to join — see `assertStartsItsOwnGroup`.
-                    undefined, { id: actor.userId, email: actor.actorEmail });
+                    undefined, (0, copilot_server_1.proposalEventActor)(actor));
                     created.push(entry.id);
                 }
             }

package/dist/lib/docs/describe-content-api.d.ts

@@ -11,6 +11,13 @@
  *
  * Pure: it takes the document and the serialized types, and mutates only the
  * paths this plugin owns.
+ *
+ * Two surfaces, described separately. `/api/content/...` is the admin's and
+ * `/api/v1/content/...` is the published one, and they answer in different
+ * shapes where their spellings agree — a public relation preview carries whole
+ * entries, the admin's carries refs. Describing both from one table is not a
+ * shortcut but a bug, and was one: the public routes were reported with the
+ * admin's schemas until {@link PUBLIC_ENTRY_ROUTES} existed.
  */
 import type { OpenApiDocument } from '@orthacms/bootstrap-server';
 import type { SerializedContentType } from '../registry/content-type-registry';

package/dist/lib/docs/describe-content-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"describe-content-api.d.ts","sourceRoot":"","sources":["../../../src/lib/docs/describe-content-api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAuJ/E;;;GAGG;AACH,wBAAgB,kBAAkB,CAC9B,QAAQ,EAAE,eAAe,EACzB,KAAK,EAAE,SAAS,qBAAqB,EAAE,GACxC,IAAI,CA2EN"}
+{"version":3,"file":"describe-content-api.d.ts","sourceRoot":"","sources":["../../../src/lib/docs/describe-content-api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAqP/E;;;GAGG;AACH,wBAAgB,kBAAkB,CAC9B,QAAQ,EAAE,eAAe,EACzB,KAAK,EAAE,SAAS,qBAAqB,EAAE,GACxC,IAAI,CAgIN"}

package/dist/lib/docs/describe-content-api.js

@@ -12,10 +12,19 @@
  *
  * Pure: it takes the document and the serialized types, and mutates only the
  * paths this plugin owns.
+ *
+ * Two surfaces, described separately. `/api/content/...` is the admin's and
+ * `/api/v1/content/...` is the published one, and they answer in different
+ * shapes where their spellings agree — a public relation preview carries whole
+ * entries, the admin's carries refs. Describing both from one table is not a
+ * shortcut but a bug, and was one: the public routes were reported with the
+ * admin's schemas until {@link PUBLIC_ENTRY_ROUTES} existed.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.describeContentApi = describeContentApi;
 const content_schemas_1 = require("./content-schemas");
+const public_api_schemas_1 = require("./public-api-schemas");
+const openapi_writer_1 = require("./openapi-writer");
 /** The entry read/write shorthands, since most operations return one. */
 const ENTRY = { response: { kind: 'entry' } };
 const VALIDATED_ENTRY = {
@@ -23,6 +32,25 @@ const VALIDATED_ENTRY = {
     validated: true
 };
 const EMPTY = { response: { kind: 'empty' } };
+/**
+ * A route another plugin mounts under one of this plugin's `{typeName}`
+ * prefixes — transfer's export/import, segments' `/access`.
+ *
+ * Listed so the `typeName` parameter still gets the registered-name enum: which
+ * names are valid there is *this* plugin's contract, and the registry is the
+ * only thing that knows them, so leaving the parameter an opaque string would
+ * be leaving a gap nothing else can fill.
+ *
+ * Nothing else is touched. The response body and the failure codes belong to
+ * whichever plugin serves the route, and they genuinely differ — transfer 404s
+ * an unknown type, the public `/access` route answers 400 — so writing this
+ * plugin's usual 404 onto them from here would publish something the API does
+ * not do.
+ */
+const FOREIGN = {
+    response: { kind: 'empty' },
+    ownedElsewhere: true
+};
 /** An operation returning one of the fixed shared schemas. */
 function shared(name) {
     return { response: { kind: 'schema', name } };
@@ -50,7 +78,14 @@ const ENTRY_ROUTES = {
     '/bulk/unpublish': { post: shared('BulkActionResult') },
     '/bulk/delete': { post: shared('BulkActionResult') },
     '/bulk/restore': { post: shared('BulkActionResult') },
-    '/bulk/purge': { post: shared('BulkActionResult') }
+    '/bulk/purge': { post: shared('BulkActionResult') },
+    // Mounted here by `@orthacms/transfer-server`, which describes their
+    // bodies; see {@link FOREIGN}.
+    '/export': { post: FOREIGN },
+    '/export/preview': { post: FOREIGN },
+    '/import': { post: FOREIGN },
+    '/import/preview': { post: FOREIGN },
+    '/import/template': { get: FOREIGN }
 };
 /** Schema routes, keyed by what follows `/content-schema`. */
 const SCHEMA_ROUTES = {
@@ -58,58 +93,107 @@ const SCHEMA_ROUTES = {
     '/{name}': { get: shared('ContentTypeSchema') },
     '/{name}/filter-fields': { get: shared('FilterFields') }
 };
-/** Matches `<prefix>/content/{typeName}<rest>`. */
+/**
+ * Public entry routes, keyed by what follows `/v1/content/{typeName}`.
+ *
+ * A separate table from {@link ENTRY_ROUTES} rather than an extension of it,
+ * because the two surfaces answer in **different shapes** on the paths they
+ * spell the same way: a public relation page carries whole entries where the
+ * admin's carries `RelationRef`s, and a public media read is keyed to
+ * `{ items, total }` where the admin's is keyed to a bare array. One table
+ * matching both spellings is what put the admin's answer on the public routes
+ * in the first place.
+ *
+ * Every read exists twice — once under `/{id}`, once under
+ * `/group/{localeGroupId}` — because a localized front-end carries the stable
+ * group id and a `?locale=`, not a per-locale id map. The two spellings funnel
+ * into one handler, so they are listed with one shape apiece and cannot drift.
+ */
+const PUBLIC_ENTRY_ROUTES = {
+    '': { get: { response: { kind: 'listPage' } }, post: VALIDATED_ENTRY },
+    '/{id}': { get: ENTRY, patch: VALIDATED_ENTRY, delete: EMPTY },
+    '/{id}/media': { get: shared('PublicEntryMedia') },
+    '/{id}/relations/{field}': { get: shared('PublicRelationFieldPage') },
+    '/{id}/translations': { get: shared('PublicEntryTranslations') },
+    '/{id}/publish': { post: VALIDATED_ENTRY },
+    '/{id}/unpublish': { post: ENTRY },
+    '/group/{localeGroupId}': {
+        get: ENTRY,
+        patch: VALIDATED_ENTRY,
+        delete: EMPTY
+    },
+    '/group/{localeGroupId}/media': { get: shared('PublicEntryMedia') },
+    '/group/{localeGroupId}/relations/{field}': {
+        get: shared('PublicRelationFieldPage')
+    },
+    '/group/{localeGroupId}/translations': {
+        get: shared('PublicEntryTranslations')
+    },
+    '/group/{localeGroupId}/publish': { post: VALIDATED_ENTRY },
+    '/group/{localeGroupId}/unpublish': { post: ENTRY },
+    '/bulk': { post: shared('PublicBulkSaveResult') },
+    // The batch publish/unpublish/delete run the very same use-cases the
+    // admin's do, so they answer in the admin's shapes — deliberately, and
+    // documented as such in `types/public-bulk.ts`.
+    '/bulk/publish': { post: shared('BulkPublishResult') },
+    '/bulk/unpublish': { post: shared('BulkActionResult') },
+    '/bulk/delete': { post: shared('BulkActionResult') },
+    // Mounted here by `@orthacms/segments-server`, which describes its bodies;
+    // see {@link FOREIGN}.
+    '/{id}/access': { get: FOREIGN, put: FOREIGN }
+};
+/** Public discovery routes, keyed by what follows `/v1/content-types`. */
+const PUBLIC_TYPES_ROUTES = {
+    '': { get: shared('PublicContentTypeList') },
+    '/{name}': { get: shared('ContentTypeSchema') }
+};
+/** Matches `<prefix>/v1/content/{typeName}<rest>`. */
+const PUBLIC_ENTRY_ROUTE_RE = /\/v1\/content\/\{typeName\}(.*)$/;
+/** Matches `<prefix>/v1/content-types<rest>`. */
+const PUBLIC_TYPES_ROUTE_RE = /\/v1\/content-types(.*)$/;
+/**
+ * Matches `<prefix>/content/{typeName}<rest>`.
+ *
+ * It matches the `/v1/` spelling too, which is why the public patterns are
+ * tried **first** and win: this pattern silently claiming the public routes is
+ * exactly how the admin's schemas ended up on the published contract.
+ */
 const ENTRY_ROUTE_RE = /\/content\/\{typeName\}(.*)$/;
 /** Matches `<prefix>/content-schema<rest>`. */
 const SCHEMA_ROUTE_RE = /\/content-schema(.*)$/;
 /**
- * Writes a success response's schema onto whichever 2xx key the scanner already
- * emitted (Nest's default is 201 for `@Post`, 200 elsewhere, and a `@HttpCode`
- * moves it), so this never invents a status code the API doesn't return.
+ * Constrains the `typeName` path param to the registered type names.
+ *
+ * The note about what an unknown name answers is only added for this plugin's
+ * own routes: on a {@link FOREIGN} one the owning plugin decides, and two of
+ * them do not agree with each other, let alone with this one.
  */
-function setSuccessResponse(operation, schema, description) {
-    const responses = operation.responses ?? {};
-    const key = Object.keys(responses).find((code) => /^2\d\d$/.test(code));
-    if (!key || key === '204') {
-        return;
-    }
-    responses[key] = {
-        description,
-        content: { 'application/json': { schema } }
-    };
-    operation.responses = responses;
-}
-/** Adds a documented failure response, leaving any existing one alone. */
-function addErrorResponse(operation, code, description, schema) {
-    const responses = operation.responses ?? {};
-    if (responses[code]) {
-        return;
-    }
-    responses[code] = {
-        description,
-        ...(schema ? { content: { 'application/json': { schema } } } : {})
-    };
-    operation.responses = responses;
-}
-/** Constrains the `typeName` path param to the registered type names. */
-function describeTypeNameParam(operation, typeNames) {
+function describeTypeNameParam(operation, typeNames, ownedElsewhere = false) {
     const parameter = operation.parameters?.find((candidate) => candidate.name === 'typeName' && candidate.in === 'path');
     if (!parameter) {
         return;
     }
     parameter.schema = { type: 'string', enum: typeNames };
-    parameter.description =
-        'Machine name of the content type. Unknown (or not granted to the workspace) is a 404.';
+    parameter.description = ownedElsewhere
+        ? 'Machine name of the content type, resolved through the same registry the content routes use.'
+        : 'Machine name of the content type. Unknown (or not granted to the workspace) is a 404.';
 }
 /**
- * `oneOf` the per-type schemas — the response shape depends on `typeName`,
- * which OpenAPI can't express as a dependency, so the alternatives are listed.
+ * The per-type schemas as alternatives — the response shape depends on
+ * `typeName`, which OpenAPI cannot express as a dependency, so they are listed.
  * A single registered type needs no union.
+ *
+ * `anyOf`, **not** `oneOf`: the alternatives are not mutually exclusive. Two
+ * content types with compatible envelopes both validate the same page (an empty
+ * `items` array matches every list schema there is), and `oneOf` means *exactly
+ * one*, so the honest-looking operator turns a correct response into a
+ * validation failure. Measured: `GET /api/v1/content/home_page` matched two
+ * branches and was therefore rejected by its own document.
  */
 function unionOf(names) {
     return names.length === 1
         ? (0, content_schemas_1.ref)(names[0])
-        : { oneOf: names.map((name) => (0, content_schemas_1.ref)(name)) };
+        : { anyOf: names.map((name) => (0, content_schemas_1.ref)(name)) };
 }
 /**
  * Adds this plugin's schemas to `document` and describes its own operations:
@@ -119,18 +203,49 @@ function describeContentApi(document, types) {
     document.components ??= {};
     document.components.schemas ??= {};
     Object.assign(document.components.schemas, (0, content_schemas_1.buildContentSchemas)(types));
+    Object.assign(document.components.schemas, (0, public_api_schemas_1.buildPublicApiSchemas)(types));
     const typeNames = types.map((type) => type.name);
-    const entryUnion = unionOf(types.map((type) => (0, content_schemas_1.schemaNamesOf)(type).entry));
-    const listUnion = unionOf(types.map((type) => (0, content_schemas_1.schemaNamesOf)(type).listPage));
+    /** The admin surface's per-type unions. */
+    const admin = {
+        routes: ENTRY_ROUTES,
+        entryUnion: unionOf(types.map((type) => (0, content_schemas_1.schemaNamesOf)(type).entry)),
+        listUnion: unionOf(types.map((type) => (0, content_schemas_1.schemaNamesOf)(type).listPage)),
+        typed: true
+    };
+    /** The public surface's, which are a different set of schemas entirely. */
+    const publicEntries = {
+        routes: PUBLIC_ENTRY_ROUTES,
+        entryUnion: (0, public_api_schemas_1.publicUnionOf)(types.map((type) => (0, public_api_schemas_1.publicSchemaNamesOf)(type).entry)),
+        listUnion: (0, public_api_schemas_1.publicUnionOf)(types.map((type) => (0, public_api_schemas_1.publicSchemaNamesOf)(type).listPage)),
+        typed: true
+    };
+    const adminSchema = { routes: SCHEMA_ROUTES, typed: false };
+    const publicSchema = { routes: PUBLIC_TYPES_ROUTES, typed: false };
+    // Order matters: the public patterns are tried first because
+    // `ENTRY_ROUTE_RE` also matches the `/v1/` spelling, and letting it win
+    // there is what used to write the admin's relation and media shapes onto
+    // the published contract.
+    const surfaces = [
+        [PUBLIC_ENTRY_ROUTE_RE, publicEntries],
+        [PUBLIC_TYPES_ROUTE_RE, publicSchema],
+        [ENTRY_ROUTE_RE, admin],
+        [SCHEMA_ROUTE_RE, adminSchema]
+    ];
     for (const [route, item] of Object.entries(document.paths)) {
-        const entryMatch = ENTRY_ROUTE_RE.exec(route);
-        const schemaMatch = SCHEMA_ROUTE_RE.exec(route);
-        const rest = (entryMatch ?? schemaMatch)?.[1];
-        if (rest === undefined) {
+        let rest;
+        let surface;
+        for (const [pattern, candidate] of surfaces) {
+            const match = pattern.exec(route);
+            if (match) {
+                rest = match[1];
+                surface = candidate;
+                break;
+            }
+        }
+        if (rest === undefined || !surface) {
             continue;
         }
-        const routes = entryMatch ? ENTRY_ROUTES : SCHEMA_ROUTES;
-        const byMethod = routes[rest];
+        const byMethod = surface.routes[rest];
         if (!byMethod) {
             continue;
         }
@@ -139,11 +254,16 @@ function describeContentApi(document, types) {
             if (!spec || !operation || typeof operation !== 'object') {
                 continue;
             }
-            if (entryMatch) {
-                describeTypeNameParam(operation, typeNames);
-                addErrorResponse(operation, '404', 'Unknown content type, or no entry with this id in the workspace.');
+            if (surface.typed) {
+                describeTypeNameParam(operation, typeNames, spec.ownedElsewhere);
+            }
+            if (spec.ownedElsewhere) {
+                continue;
+            }
+            if (surface.typed) {
+                (0, openapi_writer_1.addErrorResponse)(operation, '404', 'Unknown content type, or no entry with this id in the workspace.');
                 if (spec.validated) {
-                    addErrorResponse(operation, '422', 'The values failed the content type’s field validation.', {
+                    (0, openapi_writer_1.addErrorResponse)(operation, '422', 'The values failed the content type’s field validation.', {
                         type: 'object',
                         properties: {
                             message: { type: 'string' },
@@ -159,14 +279,18 @@ function describeContentApi(document, types) {
             // With no registered types there is no entry shape to describe —
             // and every one of these routes 404s anyway.
             const { response } = spec;
-            if (response.kind === 'entry' && typeNames.length) {
-                setSuccessResponse(operation, entryUnion, 'The entry.');
+            if (response.kind === 'entry' &&
+                typeNames.length &&
+                surface.entryUnion) {
+                (0, openapi_writer_1.setSuccessResponse)(operation, surface.entryUnion, 'The entry.');
             }
-            else if (response.kind === 'listPage' && typeNames.length) {
-                setSuccessResponse(operation, listUnion, 'One page of entries.');
+            else if (response.kind === 'listPage' &&
+                typeNames.length &&
+                surface.listUnion) {
+                (0, openapi_writer_1.setSuccessResponse)(operation, surface.listUnion, 'One page of entries.');
             }
             else if (response.kind === 'schema') {
-                setSuccessResponse(operation, (0, content_schemas_1.ref)(response.name), 'OK.');
+                (0, openapi_writer_1.setSuccessResponse)(operation, (0, content_schemas_1.ref)(response.name), 'OK.');
             }
         }
     }