@saasicat/nest 0.8.0 → 0.10.0

package/dist/catalog.module-Dw2Hrbyu.d.cts

@@ -0,0 +1,103 @@
+import { Type, CanActivate, DynamicModule, ForwardReference, Provider } from '@nestjs/common';
+import { BundleRepository, MarketingProjectionRepository, CatalogEntryRepository, PromotionRepository, MarketingSettingsRepository, PlanRepository, FeatureUiRegistry } from '@saasicat/types';
+import { P as ProviderSpec } from './di-CcNeq9v-.cjs';
+
+interface CatalogControllerConfig {
+    /**
+     * Class-level guards for `BundlesController` and `BundleVersionsController`.
+     * REQUIRED — otherwise `forRoot()` throws at boot. Pass `[]` explicitly
+     * if the endpoints should intentionally be auth-free.
+     */
+    guards: Array<Type<CanActivate>>;
+}
+interface CatalogModuleOptions {
+    /** Adapter for `bundles` + `bundle_versions` persistence. */
+    bundleRepository: ProviderSpec<BundleRepository>;
+    /**
+     * Adapter for `marketing_projections` persistence. Optional — if
+     * omitted, MarketingProjectionsService + controller are not
+     * registered.
+     */
+    marketingProjectionRepository?: ProviderSpec<MarketingProjectionRepository>;
+    /**
+     * Adapter for `capability_/feature_/quota_catalog_entries` persistence
+     * (discovery review, SPEC_V2 §6.3). Optional — if omitted,
+     * CatalogEntriesService + controller are not registered.
+     */
+    catalogEntryRepository?: ProviderSpec<CatalogEntryRepository>;
+    /**
+     * Adapter for `promotions` persistence (SPEC_V2 §9a). Optional — if
+     * omitted, PromotionsService + controller are not registered.
+     */
+    promotionRepository?: ProviderSpec<PromotionRepository>;
+    /**
+     * Adapter for `marketing_settings` persistence (SPEC_V2 §6.5 —
+     * `activeLocales`). Optional.
+     */
+    marketingSettingsRepository?: ProviderSpec<MarketingSettingsRepository>;
+    /**
+     * Auth-free pricing-page endpoint `GET /public/marketing-catalog`
+     * (SPEC_V2 §9). Registered only when plan-, marketingProjection-
+     * and promotionRepository are set. `guards` is usually `[]`.
+     */
+    publicMarketingCatalog?: {
+        guards: Array<Type<CanActivate>>;
+        projectKey: string;
+        currency: string;
+        vatRate: number;
+    };
+    /**
+     * SPEC_V2 §11.1 M6 (Pack 1) — adapter for `plans` master-record persistence.
+     * Optional; if omitted, PlansService + controller are not
+     * registered (apps without a need for the plan editor stay unchanged).
+     */
+    planRepository?: ProviderSpec<PlanRepository>;
+    /**
+     * Controller mount for `/admin/catalog/bundles` + `/admin/catalog/bundle-versions`.
+     * If omitted, the endpoints are not registered — but the services remain usable via DI.
+     */
+    controller?: CatalogControllerConfig;
+    /**
+     * Strict-mode mode. `blocking` (default, #12) throws HTTP 422 on
+     * violations and requires a DiscoverySnapshot; `warn-only` returns them
+     * only as a warning (transition until 100% discovery coverage).
+     */
+    strictModeCheckMode?: 'warn-only' | 'blocking';
+    /**
+     * Discovery→catalog auto-sync at boot (#12). Default `true` — as soon as a
+     * `catalogEntryRepository` is wired and a DiscoverySnapshot is available,
+     * `CatalogEntriesService` mirrors the discovery into the DB at startup. `false`
+     * disables the boot sync; the manual sync endpoint remains usable.
+     */
+    autoSyncDiscoveryAtBoot?: boolean;
+    /**
+     * Feature keys the catalog is deliberately allowed to carry without them
+     * existing in the discovery snapshot (marketed non-code features such as
+     * support SLAs, e.g. `['PRIORITY_SUPPORT']`). The strict-mode check excludes
+     * them from BUNDLE_/PLAN_FEATURE_UNKNOWN. Use sparingly.
+     */
+    marketedOnlyFeatures?: string[];
+    /**
+     * Optional consumer-curated FeatureUiRegistry (label/description/icon
+     * per feature — the same one passed to `PublicCatalogModule.forRoot`). The
+     * discovery auto-sync seeds EMPTY `FeatureCatalogEntry` fields
+     * (label/description/icon) from it at boot; SuperAdmin edits stay untouched. This
+     * makes `FeatureCatalogEntry` the SSOT for UI metadata (SPEC_V2 §6.3 / #12).
+     */
+    featureUiRegistry?: FeatureUiRegistry;
+    /**
+     * Modules whose providers must be visible in the DI scope of this
+     * DynamicModule — typically: `AuthModule`/`PlatformAdminModule`, because the
+     * controller guards come from there.
+     */
+    imports?: Array<Type<unknown> | DynamicModule | Promise<DynamicModule> | ForwardReference>;
+    /** Additional providers registered in the DynamicModule itself. */
+    extraProviders?: Provider[];
+    /** Register the module globally — default `false`. */
+    global?: boolean;
+}
+declare class CatalogModule {
+    static forRoot(options: CatalogModuleOptions): DynamicModule;
+}
+
+export { type CatalogControllerConfig as C, CatalogModule as a, type CatalogModuleOptions as b };