@wildo-ai/saas-backend-lib 1.0.1

package/dist/esm/resources/services/resources-registry.backend.service.d.ts

@@ -0,0 +1,151 @@
+import { ResourcesRegistry, ResourceRelationship, NotificationBadgeDefinition, UserNotificationDefinition, ResourceConfiguration_Operation, ResourceConfiguration_OperationPath, AnyResourceConfiguration, ResourceConfiguration_InitializationFactoryMap, ResourceType } from '@wildo-ai/saas-models';
+import type { LoggerService } from '../../monitoring/logger/services/logger.service.js';
+import type { AppConfigurationService } from '../../config/services/app-configuration.backend.service.js';
+import { ErrorBuilderBackendService } from '../../errors/services/error-builder.backend.service.js';
+import type { z } from 'zod';
+export declare class ResourcesRegistryBackendService {
+    protected readonly logger: LoggerService;
+    protected readonly configService: AppConfigurationService;
+    protected readonly errorBuilder: ErrorBuilderBackendService;
+    protected logDebug: (message: string, context?: Record<string, unknown>) => void;
+    protected registry: ResourcesRegistry | null;
+    protected isInitialized: boolean;
+    constructor(logger: LoggerService, configService: AppConfigurationService, errorBuilder: ErrorBuilderBackendService);
+    /**
+     * W5.1: Returns organizationTypes config when app config is initialized.
+     * Used by organization create validation to ensure Organization.type is a valid key.
+     * Returns undefined when config is not initialized (e.g. platform mode).
+     */
+    getOrganizationTypesConfig(): Record<string, unknown> | undefined;
+    /**
+     * W5.9: Returns userTypes config when app config is initialized.
+     * Used by user type revocation to check requiresOrgMembership constraints.
+     */
+    getUserTypesConfig(): Record<string, unknown> | undefined;
+    initialize<CustomShared_ResourceType extends ResourceType | undefined = undefined, CustomBackend_ResourceType extends ResourceType | undefined = undefined>(customShared_ResourcesConfigurationsFactoryMap: ResourceConfiguration_InitializationFactoryMap<CustomShared_ResourceType>, customShared_ResourceFieldIdentifier: {
+        [key: string]: string;
+    } | undefined, customShared_ResourcesRelationships: ResourceRelationship[], customBackend_ResourcesConfigurationsFactoryMap: ResourceConfiguration_InitializationFactoryMap<CustomBackend_ResourceType>, customBackend_ResourceFieldIdentifier: {
+        [key: string]: string;
+    } | undefined, customBackend_ResourcesRelationships: ResourceRelationship[], customNotificationBadgeDefinitions?: NotificationBadgeDefinition[], customAdditionalUserNotificationDefinitions?: UserNotificationDefinition[], excludedResourceTypes?: ReadonlySet<string>): Promise<void>;
+    getResourcesRegistry(): ResourcesRegistry;
+    getResourceTypes(): ResourceType[];
+    /**
+     * Get the map of resource types to their standard field identifiers.
+     * Used for FK field resolution without string manipulation.
+     *
+     * @example USERS -> userId, ORGANIZATIONS -> organizationId, USER_SELF -> userId
+     */
+    getAllResourceFieldIdentifiers(): Record<ResourceType, string>;
+    /**
+     * Resolve the foreign key field name for a relationship.
+     *
+     * Priority:
+     * 1. Explicit foreignKeyField from relationship (for disambiguation)
+     * 2. Lookup in allResourceFieldIdentifiers map (authoritative source)
+     * 3. Throws error if not found (no string manipulation fallback)
+     *
+     * @param relationship - The resource relationship
+     * @returns The FK field name
+     * @throws Error if resource type not found in allResourceFieldIdentifiers
+     */
+    resolveForeignKeyField(relationship: {
+        resourceType1: ResourceType;
+        foreignKeyField?: string;
+    }): string;
+    /**
+     * Get the reverse map of field identifiers to resource types.
+     * Used for quick lookup of resource type from a FK field name.
+     *
+     * @example userId -> USERS, organizationId -> ORGANIZATIONS
+     */
+    getFieldIdentifierToResourceType(): Record<string, ResourceType>;
+    /**
+     * Resolve the resource type from a FK field name.
+     *
+     * @param fkField - The foreign key field name (e.g., 'userId', 'organizationId')
+     * @returns The resource type or undefined if not found
+     */
+    resolveResourceTypeFromForeignKeyField(fkField: string): ResourceType | undefined;
+    getOperationPathDefault(resourceType: ResourceType, operationIdentifier: string): ResourceConfiguration_OperationPath<any, any>;
+    /**
+     * Get operation path for a specific variant.
+     * @param resourceType - The resource type
+     * @param operationIdentifier - The operation identifier (e.g., CoreResourceOperation.READ)
+     * @param variantKey - The variant key (e.g., 'summary', 'context')
+     */
+    getOperationPath(resourceType: ResourceType, operationIdentifier: string, variantKey: string): ResourceConfiguration_OperationPath<any, any>;
+    getOperationFromPath(operationPath: ResourceConfiguration_OperationPath<any, any>): ResourceConfiguration_Operation<any, any, any>;
+    getRequestDtoFromPath(operationPath: ResourceConfiguration_OperationPath<any, any>): z.ZodTypeAny;
+    getResponseDtoFromPath(operationPath: ResourceConfiguration_OperationPath<any, any>): z.ZodTypeAny;
+    getMainSchemaFromPath(operationPath: ResourceConfiguration_OperationPath<any, any>): z.ZodTypeAny;
+    getDatabaseSchemaFromPath(operationPath: ResourceConfiguration_OperationPath<any, any>): z.ZodTypeAny;
+    getResourceConfiguration(resourceType: ResourceType): AnyResourceConfiguration;
+    /**
+     * Safe variant that returns undefined for unregistered resource types
+     * instead of throwing. Use when the caller handles missing configs gracefully.
+     */
+    tryGetResourceConfiguration(resourceType: ResourceType): AnyResourceConfiguration | undefined;
+    protected ensureInitialized(): void;
+    /**
+     * Validate that all relationships can resolve their FK fields at startup.
+     * This catches configuration errors early (e.g., missing resourceFieldIdentifier).
+     */
+    protected validateRelationshipForeignKeyFields(allResourceRelationships: ResourceRelationship[], allResourceFieldIdentifiers: Record<string, string>): void;
+    /**
+     * Validate the relationship graph for cycles at startup (fail-fast).
+     *
+     * Builds a directed graph from all relationships (resourceType1 → resourceType2)
+     * and runs DFS-based cycle detection. Self-loops (resourceType1 === resourceType2)
+     * and transitive cycles (A → B → C → A) are both detected.
+     *
+     * When a cycle is found, every edge in the cycle must have `allowCycle: true`.
+     * If any edge lacks the flag, a configuration error is thrown listing the cycle path.
+     *
+     * Performance: O(V + E) where V = distinct resource types, E = relationship count.
+     * Typical: V ≈ 50, E ≈ 80. Runs once at startup — negligible cost.
+     */
+    protected validateRelationshipGraph(allResourceRelationships: ResourceRelationship[]): void;
+    /**
+     * Validate that all resources using PostgreSQL have it enabled in app config.
+     * This catches configuration mismatches early at startup.
+     *
+     * Checks:
+     * - Resources with persistenceAdapter: 'postgresql' require postgresql.enabled = true
+     * - Warns if defaultAdapter is 'postgresql' but it's not enabled
+     *
+     * NOTE: In platform mode, AppConfigurationService may not be initialized yet
+     * (platform apps initialize config later in the startup sequence).
+     * In this case, we skip validation and rely on defaults.
+     */
+    protected validatePersistenceAdapterConfiguration(allResourceConfigurations: {
+        [key: string]: AnyResourceConfiguration;
+    }): void;
+    protected generateUrlsForAllResourceConfigurations(allResourceConfigurations: {
+        [key: string]: AnyResourceConfiguration;
+    }, registry: ResourcesRegistry, allResourceFieldIdentifiers: Record<string, string>): void;
+    /**
+      * Enhance DTOs for all operations in resource configurations
+      */
+    protected enhanceDtosForAllResourceConfigurations(allResourceConfigurations: {
+        [key: string]: AnyResourceConfiguration;
+    }, registry: ResourcesRegistry, allResourceFieldIdentifiers: Record<string, string>): void;
+    debugDisplayGeneratedUrls(): void;
+    debugDisplayResourceUrls(resourceType: ResourceType): void;
+    debugDisplayGeneratedDtos(resourceFilter?: ResourceType[]): void;
+    /**
+     * Auto-register a limitCheck on a resource's CREATE default variant.
+     * Called by FeatureDefinitionRegistryBackendService during startup for
+     * limit features with `countResource`.
+     *
+     * Only adds the limitCheck if:
+     * - The resource exists in the registry
+     * - The resource has a CREATE operation
+     * - No explicit limitChecks already references this featureId
+     *
+     * @param resourceType - The resource type whose CREATE operation should get the limitCheck
+     * @param featureId - The feature identifier for the limit check
+     * @returns true if the limitCheck was added, false if skipped
+     */
+    addAutoLimitCheck(resourceType: string, featureId: string): boolean;
+}
+//# sourceMappingURL=resources-registry.backend.service.d.ts.map

package/dist/esm/resources/services/resources-registry.backend.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources-registry.backend.service.d.ts","sourceRoot":"","sources":["../../../../src/resources/services/resources-registry.backend.service.ts"],"names":[],"mappings":"AACA,OAAO,EACH,iBAAiB,EACjB,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,EAC1B,+BAA+B,EAC/B,mCAAmC,EACnC,wBAAwB,EACxB,8CAA8C,EAK9C,YAAY,EAef,MAAM,uBAAuB,CAAC;AAM/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8DAA8D,CAAC;AAClG,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sEAAsE,CAAC;AACpH,OAAO,EAAE,0BAA0B,EAAE,MAAM,kEAAkE,CAAC;AAC9G,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,qBACa,+BAA+B;IAOD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa;IAC9B,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,uBAAuB;IACtD,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,0BAA0B;IAR/G,SAAS,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IACjF,SAAS,CAAC,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAQ;IAEpD,SAAS,CAAC,aAAa,UAAS;gBAG0B,MAAM,EAAE,aAAa,EACX,aAAa,EAAE,uBAAuB,EACnC,YAAY,EAAE,0BAA0B;IAQ/G;;;;OAIG;IACI,0BAA0B,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAMxE;;;OAGG;IACI,kBAAkB,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAUnD,UAAU,CACnB,yBAAyB,SAAS,YAAY,GAAG,SAAS,GAAG,SAAS,EACtE,0BAA0B,SAAS,YAAY,GAAG,SAAS,GAAG,SAAS,EAEvE,8CAA8C,EAAG,8CAA8C,CAAC,yBAAyB,CAAC,EAC1H,oCAAoC,EAAE;QAAE,CAAE,GAAG,EAAE,MAAM,GAAI,MAAM,CAAA;KAAE,GAAG,SAAS,EAC7E,mCAAmC,EAAE,oBAAoB,EAAE,EAC3D,+CAA+C,EAAG,8CAA8C,CAAC,0BAA0B,CAAC,EAC5H,qCAAqC,EAAE;QAAE,CAAE,GAAG,EAAE,MAAM,GAAI,MAAM,CAAA;KAAE,GAAG,SAAS,EAC9E,oCAAoC,EAAE,oBAAoB,EAAE,EAC5D,kCAAkC,CAAC,EAAE,2BAA2B,EAAE,EAClE,2CAA2C,CAAC,EAAE,0BAA0B,EAAE,EAC1E,qBAAqB,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,GAC5C,OAAO,CAAC,IAAI,CAAC;IAkOT,oBAAoB,IAAI,iBAAiB;IAMzC,gBAAgB,IAAI,YAAY,EAAE;IAKzC;;;;;OAKG;IACI,8BAA8B,IAAI,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC;IAKrE;;;;;;;;;;;OAWG;IACI,sBAAsB,CAAC,YAAY,EAAE;QAAE,aAAa,EAAE,YAAY,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IA4B9G;;;;;OAKG;IACI,gCAAgC,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAKvE;;;;;OAKG;IACI,sCAAsC,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAKjF,uBAAuB,CAAC,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,GAAG,mCAAmC,CAAC,GAAG,EAAE,GAAG,CAAC;IAkBtI;;;;;OAKG;IACI,gBAAgB,CAAC,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,mCAAmC,CAAC,GAAG,EAAE,GAAG,CAAC;IAwB5I,oBAAoB,CAAE,aAAa,EAAE,mCAAmC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAI,+BAA+B,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IAuDpI,qBAAqB,CAAC,aAAa,EAAE,mCAAmC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAI,CAAC,CAAC,UAAU;IAMlG,sBAAsB,CAAC,aAAa,EAAE,mCAAmC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAI,CAAC,CAAC,UAAU;IAMnG,qBAAqB,CAAC,aAAa,EAAE,mCAAmC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAI,CAAC,CAAC,UAAU;IAMlG,yBAAyB,CAAC,aAAa,EAAE,mCAAmC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAI,CAAC,CAAC,UAAU;IAOtG,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,wBAAwB;IAWrF;;;OAGG;IACI,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,wBAAwB,GAAG,SAAS;IASpG,SAAS,CAAC,iBAAiB,IAAI,IAAI;IAMnC;;;OAGG;IACH,SAAS,CAAC,oCAAoC,CAC1C,wBAAwB,EAAE,oBAAoB,EAAE,EAChD,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACpD,IAAI;IAmCP;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,yBAAyB,CAAC,wBAAwB,EAAE,oBAAoB,EAAE,GAAG,IAAI;IAwG3F;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,uCAAuC,CAC7C,yBAAyB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAA;KAAE,GACvE,IAAI;IAkFP,SAAS,CAAC,wCAAwC,CAC9C,yBAAyB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAA;KAAE,EACtE,QAAQ,EAAE,iBAAiB,EAC3B,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACpD,IAAI;IAyCP;;QAEI;IACJ,SAAS,CAAC,uCAAuC,CAC7C,yBAAyB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAA;KAAE,EACtE,QAAQ,EAAE,iBAAiB,EAC3B,2BAA2B,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACpD,IAAI;IAwCA,yBAAyB,IAAI,IAAI;IAoFjC,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IA4D1D,yBAAyB,CAAC,cAAc,GAAE,YAAY,EAAO,GAAG,IAAI;IAW3E;;;;;;;;;;;;;OAaG;IACI,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;CA4C7E"}