@ng-prism/core 22.5.0 → 22.7.0-beta.0

package/dist/builder/shared/prism-pipeline.js

@@ -3,12 +3,13 @@ import { dirname, join } from 'path';
 import ts from 'typescript';
 import { checkA11yThresholds, DEFAULT_A11Y_REPORT_PATH, readA11yForComponents, readA11yMeta } from '../a11y/a11y-report-reader.js';
 import { loadConfig } from '../config-loader/config-loader.js';
+import { describeDeprecatedOptions } from '../config-loader/deprecated-options.js';
 import { generateRuntimeManifest } from '../manifest/runtime-manifest.generator.js';
 import { runPluginHooks } from '../plugin-runner/plugin-runner.js';
-import { discoverSecondaryEntryPoints } from '../scanner/entry-point-discovery.js';
+import { discoverSecondaryEntryPoints, findPrimaryEntryFile } from '../scanner/entry-point-discovery.js';
 import { createScanner } from '../scanner/scanner.js';
 export function createPipelineState() {
-    return { scanner: undefined, lastEntrySetKey: undefined };
+    return { scanner: undefined, lastEntrySetKey: undefined, hints: new Set() };
 }
 export async function runPrismPipeline(options, context, state) {
     const { workspaceRoot } = context;
@@ -17,14 +18,47 @@ export async function runPrismPipeline(options, context, state) {
         workspaceRoot,
         configFileName: options.configFile
     });
+    for (const notice of describeDeprecatedOptions(config, options.configFile)) {
+        console.warn(`⚠ ng-prism: ${notice}`);
+    }
+    // A service or pipe page is made by a plugin's view panel that applies to it: such a page has no
+    // addon area. Without one the services or pipes would go into the manifest and be shown nowhere,
+    // so the scan only counts them. The API of a component is read for a plugin that asks for it.
+    const plugins = config.plugins ?? [];
+    const showsTarget = (target) => plugins.some((plugin) => plugin.panels?.some((panel) => panel.placement === 'view' && panel.appliesTo?.includes(target)));
+    const showsServices = showsTarget('service');
+    const showsPipes = showsTarget('pipe');
     context.reportStatus('Scanning components...');
-    const { components, diagnostics } = scanEntryPoints(workspaceRoot, options, state);
+    const { components, services: scannedServices, pipes: scannedPipes, unread, diagnostics } = scanEntryPoints(workspaceRoot, options, state, {
+        componentApi: plugins.some((plugin) => plugin.componentApi),
+        services: showsServices,
+        pipes: showsPipes
+    });
     if (config.strictShowcase && diagnostics.length > 0) {
         throw new Error(`ng-prism: strictShowcase is enabled and ${diagnostics.length} @Showcase value(s) were dropped; see the warnings above.`);
     }
+    // A hint rather than a diagnostic: the library is fine. It names the version because a plugin-jsdoc from
+    // before 22.7.0 is no such panel, so a config that has jsDocPlugin() can still get the hint.
+    const hint = (message) => {
+        if (state.hints.has(message))
+            return;
+        state.hints.add(message);
+        context.logger.info(message);
+    };
+    if (unread.services > 0) {
+        hint(`ng-prism: ${unread.services} service(s) with @Showcase found, but no plugin shows services; add jsDocPlugin() from @ng-prism/plugin-jsdoc 22.7.0 or newer to ng-prism.config.ts to list them.`);
+    }
+    if (unread.pipes > 0) {
+        hint(`ng-prism: ${unread.pipes} pipe(s) with @Showcase found, but no plugin shows pipes; add jsDocPlugin() from @ng-prism/plugin-jsdoc 22.7.0 or newer to ng-prism.config.ts to list them.`);
+    }
     const pages = config.pages ? [...config.pages] : [];
+    const scanned = { components, pages };
+    if (showsServices)
+        scanned.services = scannedServices;
+    if (showsPipes)
+        scanned.pipes = scannedPipes;
     context.reportStatus('Running plugin hooks...');
-    let manifest = await runPluginHooks({ components, pages }, config.plugins ?? []);
+    let manifest = await runPluginHooks(scanned, plugins);
     const a11yReportPath = config.a11y?.reportPath ?? DEFAULT_A11Y_REPORT_PATH;
     const a11yReportPathAbs = join(workspaceRoot, a11yReportPath);
     const a11yMeta = readA11yMeta(a11yReportPathAbs, config.a11y?.thresholds);
@@ -58,6 +92,8 @@ export async function runPrismPipeline(options, context, state) {
     context.reportStatus('Generating runtime manifest...');
     const source = generateRuntimeManifest({
         components: manifest.components,
+        services: manifest.services,
+        pipes: manifest.pipes,
         libraryImportPath: options.libraryImportPath,
         pages: manifest.pages,
         meta: manifest.meta
@@ -67,15 +103,21 @@ export async function runPrismPipeline(options, context, state) {
     const manifestPath = join(cacheDir, 'prism-manifest.ts');
     mkdirSync(cacheDir, { recursive: true });
     const written = writeManifestIfChanged(manifestPath, source);
+    const serviceCount = (manifest.services ?? []).length;
+    const pipeCount = (manifest.pipes ?? []).length;
     const pageCount = (manifest.pages ?? []).length;
     context.reportStatus('');
     context.logger.info(`ng-prism: ${written ? 'Generated' : 'Verified (unchanged)'} manifest ` +
         `with ${manifest.components.length} component(s)` +
+        (serviceCount > 0 ? `, ${serviceCount} service(s)` : '') +
+        (pipeCount > 0 ? `, ${pipeCount} pipe(s)` : '') +
         (pageCount > 0 ? ` and ${pageCount} page(s)` : '') +
         ` at ${manifestPath}`);
     return {
         manifestPath,
         componentCount: manifest.components.length,
+        serviceCount,
+        pipeCount,
         pageCount,
         written
     };
@@ -115,6 +157,18 @@ function findLibraryRoot(filePath) {
     }
     return undefined;
 }
+/**
+ * Reads config files, `extends` included, but lists no directories. Only
+ * `paths` and `baseUrl` are taken from the config, so enumerating the files it
+ * includes would only cost time: with no `include`, that is every source file
+ * below the config, on every rebuild.
+ */
+const CONFIG_HOST = {
+    useCaseSensitiveFileNames: ts.sys.useCaseSensitiveFileNames,
+    fileExists: ts.sys.fileExists,
+    readFile: ts.sys.readFile,
+    readDirectory: () => []
+};
 function resolveTsconfigPaths(entryPointDir) {
     const configPath = ts.findConfigFile(entryPointDir, ts.sys.fileExists, 'tsconfig.json');
     if (!configPath)
@@ -122,7 +176,7 @@ function resolveTsconfigPaths(entryPointDir) {
     const configFile = ts.readConfigFile(configPath, ts.sys.readFile);
     if (configFile.error)
         return {};
-    const parsed = ts.parseJsonConfigFileContent(configFile.config, ts.sys, dirname(configPath));
+    const parsed = ts.parseJsonConfigFileContent(configFile.config, CONFIG_HOST, dirname(configPath));
     const result = {};
     if (parsed.options.paths)
         result.paths = parsed.options.paths;
@@ -136,21 +190,20 @@ function resolveEntryPoints(workspaceRoot, options) {
     const entryIsDirectory = isDirectory(absoluteEntryPoint);
     const libraryRoot = entryIsDirectory ? absoluteEntryPoint : findLibraryRoot(absoluteEntryPoint);
     const discovered = libraryRoot ? discoverSecondaryEntryPoints(libraryRoot, options.libraryImportPath) : [];
-    // Fallback to a direct file scan when:
-    //  - the entry is a file and no ng-package.json was found above it, OR
-    //  - the entry is a file with an ng-package.json above it but discovery found nothing
-    //    (e.g. primary-only library, root ng-package.json carries `dest`).
-    const entryPoints = discovered.length === 0 && !entryIsDirectory
-        ? [
-            {
-                entryFile: absoluteEntryPoint,
-                importPath: options.libraryImportPath
-            }
-        ]
+    // The primary entry point is scanned after the secondary ones: a file entryPoint is
+    // the primary itself, a directory names it in its ng-package.json. A root
+    // ng-package.json without `dest` is already among the discovered ones.
+    const primaryEntryFile = entryIsDirectory ? findPrimaryEntryFile(absoluteEntryPoint) : absoluteEntryPoint;
+    const entryPoints = primaryEntryFile && !discovered.some((e) => e.entryFile === primaryEntryFile)
+        ? [...discovered, { entryFile: primaryEntryFile, importPath: options.libraryImportPath, primary: true }]
         : discovered;
+    if (entryPoints.length === 0) {
+        console.warn(`⚠ ng-prism: entryPoint "${options.entryPoint}" resolves to no entry file: no ng-package.json with a lib.entryFile ` +
+            `that exists, and no secondary entry points below it. Point entryPoint at the library's barrel file.`);
+    }
     return { entryPoints, compilerOptions };
 }
-function scanEntryPoints(workspaceRoot, options, state) {
+function scanEntryPoints(workspaceRoot, options, state, scanOptions) {
     const { entryPoints, compilerOptions } = resolveEntryPoints(workspaceRoot, options);
     const newKey = entryPoints
         .map((e) => e.entryFile)
@@ -162,5 +215,5 @@ function scanEntryPoints(workspaceRoot, options, state) {
         state.lastEntrySetKey = newKey;
     }
     state.scanner ??= createScanner({ entryPoints, compilerOptions });
-    return state.scanner.scan();
+    return state.scanner.scan(scanOptions);
 }

package/dist/decorator/index.d.ts

@@ -1,3 +1,3 @@
-export type { ComponentStatus, InputsOf, ShowcaseConfig, Variant } from './showcase.types.js';
+export type { ComponentStatus, DirectiveHost, HostTemplate, InputsOf, ShowcaseConfig, ShowcaseImport, ShowcaseSetupRef, ShowcaseState, Variant } from './showcase.types.js';
 export { Showcase } from './showcase.decorator.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/decorator/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorator/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9F,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorator/index.ts"],"names":[],"mappings":"AACA,YAAY,EACR,eAAe,EACf,aAAa,EACb,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,OAAO,EACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/decorator/showcase.types.d.ts

@@ -1,16 +1,41 @@
-import type { InputSignalWithTransform, Provider } from '@angular/core';
+import type { InjectionToken, InputSignalWithTransform, Provider } from '@angular/core';
 import type { CanvasBg } from '../shared/canvas-bg.type.js';
 import type { CanvasLayout } from '../shared/canvas-layout.type.js';
 import type { ForcedPseudoStates } from '../shared/pseudo-state.type.js';
 export type ComponentStatus = 'stable' | 'beta' | 'wip' | 'deprecated';
+/**
+ * The object form of `ShowcaseConfig.host`: an Angular component whose element a directive renders on. Exported
+ * since 22.7.0.
+ */
 export interface DirectiveHost {
+    /** The component's element, e.g. `'lib-button'`. */
     selector: string;
+    /** The component's class, which the generated host imports: its exported name and its module. */
     import: {
         name: string;
         from: string;
     };
+    /** Static inputs of the component, written as attributes on its element. */
     inputs?: Record<string, unknown>;
 }
+/**
+ * A class that the templates of a showcase use and ng-prism cannot find in the library on its own, listed in
+ * `ShowcaseConfig.imports`. Strings, not a class reference, so that `ng-prism-strip` leaves no import behind in the
+ * published library. Since 22.7.0.
+ */
+export interface ShowcaseImport {
+    /** Exported name, e.g. `'CdkTextareaAutosize'`. */
+    name: string;
+    /** Module specifier, e.g. `'@angular/cdk/text-field'`. */
+    from: string;
+}
+/**
+ * The markup the showcased component or directive renders in, compiled as an Angular template: the element that
+ * matches its selector is the subject. Since 22.7.0.
+ */
+export interface HostTemplate {
+    template: string;
+}
 type UnwrapSignalInput<S> = S extends InputSignalWithTransform<any, infer WriteT> ? WriteT : never;
 /**
  * Maps a component class `T` to a record of its signal-input properties
@@ -24,6 +49,22 @@ type UnwrapSignalInput<S> = S extends InputSignalWithTransform<any, infer WriteT
 export type InputsOf<T> = [unknown] extends [T] ? Record<string, unknown> : {
     [K in keyof T as T[K] extends InputSignalWithTransform<any, any> ? K : never]: UnwrapSignalInput<T[K]>;
 };
+/**
+ * A named combination of forced pseudo states, combined with every variant of
+ * the component that does not opt out with `Variant.states: false`, and forced
+ * where it fits: only on targets the browser could put into the state.
+ */
+export interface ShowcaseState {
+    /** Column title in the Overview, chip label in the tools menu. Unique within the component. */
+    name: string;
+    /** Same shape and semantics as `Variant.pseudo`. */
+    pseudo: ForcedPseudoStates;
+}
+/**
+ * A function or injection token that configures a service or pipe, listed in
+ * `ShowcaseConfig.setup`. ng-prism only reads its name, signature and type.
+ */
+export type ShowcaseSetupRef = ((...args: never[]) => unknown) | InjectionToken<unknown>;
 export interface ShowcaseConfig<T = unknown> {
     /** Display name in the ng-prism UI */
     title: string;
@@ -37,18 +78,30 @@ export interface ShowcaseConfig<T = unknown> {
     componentOrder?: number;
     /**
      * Top-level section in the sidebar. Auto-detected if omitted:
-     * 'Directives' for a `@Directive`, otherwise 'Components'. Free-form string:
-     * any value creates a new top-level section (e.g. 'Pipes', 'Utilities').
+     * 'Directives' for a `@Directive`, 'Services' for a service, 'Pipes' for a
+     * pipe, otherwise 'Components'. Free-form string: any value creates a new
+     * top-level section (e.g. 'Forms', 'Utilities').
      */
     section?: string;
     /**
      * Sort order of this section in the sidebar (lower = higher in list).
      * The section's effective order is the minimum `sectionOrder` of all its items.
-     * Defaults: 'Components' 0, 'Directives' 10, all others 100.
+     * Defaults: 'Components' 0, 'Directives' 10, 'Services' 20, 'Pipes' 30, all others 100.
      */
     sectionOrder?: number;
-    /** Predefined variants shown as tabs */
+    /** Predefined variants shown as tabs. Not for services or pipes: it still keeps an `@Injectable`, `@Service` or `@Pipe` class a component, deprecated since 22.7.0, removed in 23.0.0. */
     variants?: Variant<T>[];
+    /**
+     * Named pseudo-state combinations, e.g. `{ name: 'Hover', pseudo: { hover: '.btn' } }`.
+     * Each one is combined with every variant and forced where it fits, so the Overview shows
+     * a column per state and a variant can be viewed in any of them. A variant opts out with
+     * `states: false`.
+     * Not combinable with `renderPage`: a component page has no Overview.
+     * Not for services or pipes: it still keeps an `@Injectable`, `@Service` or `@Pipe` class a component, deprecated since 22.7.0, removed in 23.0.0.
+     *
+     * The position in the list identifies a state, so keep the order stable.
+     */
+    states?: ShowcaseState[];
     /** Tags for search and filtering */
     tags?: string[];
     /**
@@ -61,11 +114,21 @@ export interface ShowcaseConfig<T = unknown> {
     providers?: Provider[];
     /** Arbitrary metadata for plugins (e.g. { figma: 'https://...' }) */
     meta?: Record<string, unknown>;
+    /**
+     * Services and pipes only: the functions and tokens that configure the service
+     * or pipe, for example `provideToasts` and `TOAST_CONFIG`. The styleguide
+     * documents them next to the service or pipe. A function, not a list, so that
+     * a service and its `provide*` function can live in files that import each
+     * other without the list reading a binding that is not initialised yet.
+     * ng-prism never calls it. Since 22.7.0.
+     */
+    setup?: () => readonly ShowcaseSetupRef[];
     /**
      * Recommended canvas background for this component. Applied when the user
      * opens the component, unless a variant defines its own `bg`. The user
      * can override via the canvas toolbar; the override is transient and
      * resets when switching variants or components.
+     * Not for services or pipes: it still keeps an `@Injectable`, `@Service` or `@Pipe` class a component, deprecated since 22.7.0, removed in 23.0.0.
      */
     bg?: CanvasBg;
     /**
@@ -75,11 +138,29 @@ export interface ShowcaseConfig<T = unknown> {
      *   components without intrinsic width (e.g. horizontal dividers) and components that
      *   opt into `width: 100%` (e.g. full-width buttons) render correctly.
      * A `Variant.canvasLayout` overrides this.
+     * Not for services or pipes: it still keeps an `@Injectable`, `@Service` or `@Pipe` class a component, deprecated since 22.7.0, removed in 23.0.0.
      */
     canvasLayout?: CanvasLayout;
-    /** Host element for directive showcases. String = HTML element (e.g. '<button class="btn">'), object = Angular component. */
-    host?: string | DirectiveHost;
-    /** Title of a registered ComponentPage to render instead of the component itself. Use for complex components that need template projections or mock data. The page component can inject PrismRendererService to react to control panel changes. */
+    /**
+     * Host element for directive showcases. String = HTML element (e.g. '<button class="btn">'), object = Angular component.
+     * A string or an object has no effect on a component: the scan drops it with a warning.
+     * `{ template }` is an Angular template the subject renders in, for a component or a directive; the element that
+     * matches the subject's selector is the subject, and `prism-subject` names it where several match. A
+     * `Variant.host` overrides it for that variant. Since 22.7.0.
+     * Not for services or pipes: it still keeps an `@Injectable`, `@Service` or `@Pipe` class a component, deprecated since 22.7.0, removed in 23.0.0.
+     */
+    host?: string | DirectiveHost | HostTemplate;
+    /**
+     * What the templates of this showcase (`Variant.template`, `host: { template }`) use that ng-prism does not find
+     * in the library by itself: a class from a third-party package, a pipe or directive from Angular. Library classes
+     * that the template names are imported without being listed. Since 22.7.0.
+     * Not for services or pipes: it still keeps an `@Injectable`, `@Service` or `@Pipe` class a component, deprecated since 22.7.0, removed in 23.0.0.
+     */
+    imports?: ShowcaseImport[];
+    /**
+     * Title of a registered ComponentPage to render instead of the component itself. Use for complex components that need template projections or mock data. The page component can inject PrismRendererService to react to control panel changes.
+     * Not for services or pipes: it still keeps an `@Injectable`, `@Service` or `@Pipe` class a component, deprecated since 22.7.0, removed in 23.0.0.
+     */
     renderPage?: string;
     /**
      * Migration / maturity status. When unset, the component is treated as `stable`
@@ -100,6 +181,15 @@ export interface Variant<T = unknown> {
      * - Record<string, string>: keys are slot selectors (e.g. '[card-header]'), 'default' is the unnamed slot
      */
     content?: string | Record<string, string>;
+    /**
+     * Angular template, compiled as the content of the showcased component or directive: a component gets it projected
+     * into its `<ng-content>` slots by Angular's own selector matching, a directive renders it inside its host element.
+     * The counterpart of `content`, which stays HTML. Set together with `content`, it wins and `content` is dropped
+     * with a diagnostic. Since 22.7.0.
+     */
+    template?: string;
+    /** The template the subject renders in for this variant. Overrides `ShowcaseConfig.host`. Since 22.7.0. */
+    host?: HostTemplate;
     /** Optional description for this variant */
     description?: string;
     /** Arbitrary metadata for plugins (e.g. { figma: 'https://...?node-id=12-34' }) */
@@ -112,11 +202,14 @@ export interface Variant<T = unknown> {
      * Pseudo states forced on while this variant renders, e.g.
      * `{ 'focus-visible': '.btn' }` or `{ hover: true }`.
      * - `true`: the state is forced on every element of the rendered component, the host included.
-     * - A selector, or a list of them: only on the matching elements, resolved against the host and everything inside it.
+     * - A selector, or a list of them: only on the matching elements, resolved against what is rendered: the host and
+     *   everything inside it, or the whole composition for a variant with a `template` or a host template.
      *
      * The component's own CSS applies: every selector using the pseudo-class is widened to also match a stand-in class on the targeted elements.
      */
     pseudo?: ForcedPseudoStates;
+    /** `false` keeps this variant out of every combination with the component's `states`: it renders in its own pseudo states only, as a single cell in the Overview. */
+    states?: false;
 }
 export {};
 //# sourceMappingURL=showcase.types.d.ts.map

package/dist/decorator/showcase.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"showcase.types.d.ts","sourceRoot":"","sources":["../../src/decorator/showcase.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEzE,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,YAAY,CAAC;AAEvE,MAAM,WAAW,aAAa;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAOD,KAAK,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,wBAAwB,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;AAEnG;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GACzC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB;KACK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,wBAAwB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACzG,CAAC;AAER,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,OAAO;IACvC,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2IAA2I;IAC3I,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iJAAiJ;IACjJ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IACxB,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,qEAAqE;IACrE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B;;;;;OAKG;IACH,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,6HAA6H;IAC7H,IAAI,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAC9B,mPAAmP;IACnP,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED,MAAM,WAAW,OAAO,CAAC,CAAC,GAAG,OAAO;IAChC,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,0IAA0I;IAC1I,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,qFAAqF;IACrF,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,qIAAqI;IACrI,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;CAC/B"}
+{"version":3,"file":"showcase.types.d.ts","sourceRoot":"","sources":["../../src/decorator/showcase.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACxF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEzE,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,YAAY,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,iGAAiG;IACjG,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,4EAA4E;IAC5E,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,EAAE,MAAM,CAAC;CACpB;AAOD,KAAK,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,wBAAwB,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;AAEnG;;;;;;;;GAQG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,GACzC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB;KACK,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,wBAAwB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACzG,CAAC;AAER;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,+FAA+F;IAC/F,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,MAAM,EAAE,kBAAkB,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAEzF,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,OAAO;IACvC,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2IAA2I;IAC3I,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iJAAiJ;IACjJ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0LAA0L;IAC1L,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IACxB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,qEAAqE;IACrE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,SAAS,gBAAgB,EAAE,CAAC;IAC1C;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,YAAY,CAAC;IAC7C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED,MAAM,WAAW,OAAO,CAAC,CAAC,GAAG,OAAO;IAChC,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,0IAA0I;IAC1I,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2GAA2G;IAC3G,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,qFAAqF;IACrF,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd,qIAAqI;IACrI,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,qKAAqK;IACrK,MAAM,CAAC,EAAE,KAAK,CAAC;CAClB"}

package/dist/plugin/index.d.ts

@@ -1,5 +1,8 @@
-export type { ControlDefinition, DiscoveryComponent, DiscoveryManifest, DiscoveryPage, DiscoveryVariant, HeaderWidgetDefinition, InputMeta, NavigationDecoration, NavigationDecorationDefinition, NgPrismConfig, NgPrismPlugin, OutputMeta, PanelBadge, PanelDefinition, PrismManifest, RuntimeComponent, RuntimeManifest, ScannedComponent } from './plugin.types.js';
+export type { ComponentApi, ComponentComposition, CompositionCase, ControlDefinition, DiscoveryComponent, DiscoveryManifest, DiscoveryPage, DiscoveryState, DiscoveryVariant, HeaderWidgetDefinition, InputMeta, NavigationDecoration, NavigationDecorationDefinition, NgPrismConfig, NgPrismPlugin, OutputMeta, PanelBadge, PanelDefinition, PrismManifest, RuntimeComponent, RuntimeManifest, ScannedComponent } from './plugin.types.js';
 export type { ComponentPage, CustomPage, StyleguidePage } from './page.types.js';
+export type { PipeApi, RuntimePipe, ScannedPipe } from './pipe.types.js';
+export type { ApiDocTags, ApiMethod, ApiParam, ApiProperty, ApiSetupEntry, ApiTypeDoc, ApiTypeRef, PanelTarget, RuntimeService, ScannedService, ServiceApi, ServiceProvision } from './service.types.js';
+export { COMPOSITION_SUBJECT_ATTR, COMPOSITION_SUBJECT_SLOT, PRISM_VARIANT_INPUT, SUBJECT_MARKER_ATTR } from '../shared/composition.js';
 export type { CanvasBg } from '../shared/canvas-bg.type.js';
 export { CANVAS_BGS } from '../shared/canvas-bg.type.js';
 export { DEFAULT_VARIANT_BG, resolveVariantBg } from '../shared/variant-bg.js';
@@ -9,6 +12,8 @@ export { PSEUDO_STATES } from '../shared/pseudo-state.type.js';
 export { componentPage, customPage } from './page-helpers.js';
 export type { ComponentPageOptions } from './page-helpers.js';
 export { defineConfig } from './define-config.js';
+export { STATUS_DANGER_RATIO, statusFor, thresholdFromTarget, worstTone } from './status.js';
+export type { StatusThreshold, StatusTone } from './status.js';
 export { ICON_NAMES } from '../app/icons/icon-registry.js';
 export { PRISM_CONFIG, PRISM_MANIFEST, PRISM_RENDERER_HOOKS } from '../app/tokens/prism-tokens.js';
 export type { PrismRendererHooks } from '../app/tokens/prism-tokens.js';

package/dist/plugin/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":"AACA,YAAY,EACR,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,sBAAsB,EACtB,SAAS,EACT,oBAAoB,EACpB,8BAA8B,EAC9B,aAAa,EACb,aAAa,EACb,UAAU,EACV,UAAU,EACV,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EACnB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAKjF,YAAY,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC/E,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAK/D,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACpG,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC9D,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMlD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACnG,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":"AACA,YAAY,EACR,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,SAAS,EACT,oBAAoB,EACpB,8BAA8B,EAC9B,aAAa,EACb,aAAa,EACb,UAAU,EACV,UAAU,EACV,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EACnB,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjF,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzE,YAAY,EACR,UAAU,EACV,SAAS,EACT,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,UAAU,EACV,WAAW,EACX,cAAc,EACd,cAAc,EACd,UAAU,EACV,gBAAgB,EACnB,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAKxI,YAAY,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC/E,YAAY,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAK/D,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AACpG,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC9D,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7F,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAM/D,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACnG,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/plugin/index.js

@@ -1,8 +1,12 @@
+// What a showcase's compositions put into the manifest. Plugins that show the markup of a variant (a snippet, a usage
+// example) replace the slot, and the constants name what ng-prism puts into and takes out of a composition.
+export { COMPOSITION_SUBJECT_ATTR, COMPOSITION_SUBJECT_SLOT, PRISM_VARIANT_INPUT, SUBJECT_MARKER_ATTR } from '../shared/composition.js';
 export { CANVAS_BGS } from '../shared/canvas-bg.type.js';
 export { DEFAULT_VARIANT_BG, resolveVariantBg } from '../shared/variant-bg.js';
 export { PSEUDO_STATES } from '../shared/pseudo-state.type.js';
 export { componentPage, customPage } from './page-helpers.js';
 export { defineConfig } from './define-config.js';
+export { STATUS_DANGER_RATIO, statusFor, thresholdFromTarget, worstTone } from './status.js';
 // Imported from the dependency-free registry module, not from
 // `prism-icon.component.js`. The builder evaluates plugin config in Node.js,
 // and importing the component module would run its `@Component` decorator

package/dist/plugin/pipe.types.d.ts

@@ -0,0 +1,36 @@
+import type { ShowcaseConfig } from '../decorator/showcase.types.js';
+import type { ApiDocTags, ApiMethod, ApiSetupEntry, ApiTypeDoc } from './service.types.js';
+export interface ScannedPipe {
+    className: string;
+    filePath: string;
+    /** Import path of the entry point that exports the pipe. */
+    importPath?: string;
+    /** Only the fields that apply to pipes: title, description, category, categoryOrder, componentOrder, section, sectionOrder, tags, meta, status. */
+    showcaseConfig: ShowcaseConfig;
+    /** The name used in templates, from `@Pipe({ name })`. */
+    pipeName: string;
+    /** From `@Pipe({ pure })`, `true` when omitted; absent when it cannot be read. */
+    pure?: boolean;
+    /** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+    api: PipeApi;
+    /** Arbitrary plugin metadata */
+    meta?: Record<string, unknown>;
+}
+/**
+ * What the API page of a pipe shows.
+ *
+ * @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release.
+ */
+export interface PipeApi {
+    description?: string;
+    tags: ApiDocTags;
+    /** One entry per overload signature of `transform()`, or the implementation when there are none. */
+    transform: ApiMethod[];
+    setup: ApiSetupEntry[];
+    types: ApiTypeDoc[];
+}
+/** A pipe in the runtime manifest. Carries data only: the class is never imported into the styleguide. */
+export interface RuntimePipe {
+    meta: ScannedPipe;
+}
+//# sourceMappingURL=pipe.types.d.ts.map

package/dist/plugin/pipe.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipe.types.d.ts","sourceRoot":"","sources":["../../src/plugin/pipe.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE3F,MAAM,WAAW,WAAW;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mJAAmJ;IACnJ,cAAc,EAAE,cAAc,CAAC;IAC/B,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,kFAAkF;IAClF,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6FAA6F;IAC7F,GAAG,EAAE,OAAO,CAAC;IACb,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,oGAAoG;IACpG,SAAS,EAAE,SAAS,EAAE,CAAC;IACvB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,KAAK,EAAE,UAAU,EAAE,CAAC;CACvB;AAED,0GAA0G;AAC1G,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,WAAW,CAAC;CACrB"}

package/dist/plugin/pipe.types.js

@@ -0,0 +1 @@
+export {};