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

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

@@ -0,0 +1,124 @@
+import type { ShowcaseConfig } from '../decorator/showcase.types.js';
+/** How a service reaches the injector: on its own, or through a providers array. */
+export type ServiceProvision = 'auto' | 'manual';
+/** Where a panel appears: on component pages, on service pages, on pipe pages, or on several. */
+export type PanelTarget = 'component' | 'service' | 'pipe';
+/** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+export interface ApiDocTags {
+    deprecated?: string | true;
+    since?: string;
+    /** From `@version`. */
+    version?: string;
+    see?: string[];
+    example?: string[];
+    /** From `@default`. Prose such as "Default `x`." is not read. */
+    default?: string;
+}
+/**
+ * A type as written, plus the ids of documented types it mentions.
+ *
+ * @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release.
+ */
+export interface ApiTypeRef {
+    /** Display text, e.g. `ToastOptions`, `Signal<boolean>`, `number | null`. */
+    text: string;
+    /** Ids of the entries in the page's `types` (service, pipe or component) whose names occur in `text`. Omitted when none. */
+    links?: string[];
+}
+/** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+export interface ApiParam {
+    name: string;
+    type: ApiTypeRef;
+    optional: boolean;
+    rest?: true;
+    /** The initializer as written, e.g. `{}`. */
+    defaultValue?: string;
+    /** From `@param`. */
+    description?: string;
+}
+/** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+export interface ApiMethod {
+    name: string;
+    params: ApiParam[];
+    returnType: ApiTypeRef;
+    description?: string;
+    tags: ApiDocTags;
+}
+/** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+export interface ApiProperty {
+    name: string;
+    type: ApiTypeRef;
+    readonly: boolean;
+    /** `?` on an interface member. */
+    optional?: true;
+    description?: string;
+    tags: ApiDocTags;
+}
+/** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+export interface ApiTypeDoc {
+    /** Unique within one page's `types` (service, pipe or component): the name, or `${name}@${importPath}` when two reachable types share a name. */
+    id: string;
+    name: string;
+    kind: 'interface' | 'class' | 'type' | 'enum';
+    importPath: string;
+    description?: string;
+    tags: ApiDocTags;
+    /** Interfaces, classes and object-literal type aliases. */
+    properties?: ApiProperty[];
+    /** Interfaces and classes. */
+    methods?: ApiMethod[];
+    /** A type alias of a literal union: each member as written, e.g. `'top-left'`. */
+    union?: string[];
+    /** Any other type alias: the aliased type as written. */
+    text?: string;
+    /** Enums. */
+    members?: {
+        name: string;
+        value?: string;
+        description?: string;
+    }[];
+    /** Where the type was first reached, e.g. `parameter of show()`, `via options.action`. */
+    reachedFrom?: string;
+}
+/** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+export interface ApiSetupEntry {
+    name: string;
+    kind: 'function' | 'token';
+    importPath: string;
+    description?: string;
+    tags: ApiDocTags;
+    /** Functions only. */
+    params?: ApiParam[];
+    returnType?: ApiTypeRef;
+    /** Tokens only: `InjectionToken<T>` as written. */
+    tokenType?: ApiTypeRef;
+    /** The properties of the first parameter's object type (function) or of `T` (token). */
+    config?: ApiProperty[];
+}
+/** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+export interface ServiceApi {
+    description?: string;
+    tags: ApiDocTags;
+    properties: ApiProperty[];
+    methods: ApiMethod[];
+    setup: ApiSetupEntry[];
+    types: ApiTypeDoc[];
+}
+export interface ScannedService {
+    className: string;
+    filePath: string;
+    /** Import path of the entry point that exports the service. */
+    importPath?: string;
+    /** Only the fields that apply to services: title, description, category, categoryOrder, componentOrder, section, sectionOrder, tags, meta, status. */
+    showcaseConfig: ShowcaseConfig;
+    provision: ServiceProvision;
+    /** @experimental Experimental until 23.0.0: the shape may change in a 22.x minor release. */
+    api: ServiceApi;
+    /** Arbitrary plugin metadata */
+    meta?: Record<string, unknown>;
+}
+/** A service in the runtime manifest. Carries data only: the class is never imported into the styleguide. */
+export interface RuntimeService {
+    meta: ScannedService;
+}
+//# sourceMappingURL=service.types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"service.types.d.ts","sourceRoot":"","sources":["../../src/plugin/service.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAErE,oFAAoF;AACpF,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEjD,iGAAiG;AACjG,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,SAAS,GAAG,MAAM,CAAC;AAE3D,6FAA6F;AAC7F,MAAM,WAAW,UAAU;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACvB,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,4HAA4H;IAC5H,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,6FAA6F;AAC7F,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qBAAqB;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,6FAA6F;AAC7F,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;CACpB;AAED,6FAA6F;AAC7F,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;CACpB;AAED,6FAA6F;AAC7F,MAAM,WAAW,UAAU;IACvB,iJAAiJ;IACjJ,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC;IAC3B,8BAA8B;IAC9B,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IACtB,kFAAkF;IAClF,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa;IACb,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACnE,0FAA0F;IAC1F,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,6FAA6F;AAC7F,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,sBAAsB;IACtB,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,mDAAmD;IACnD,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,wFAAwF;IACxF,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED,6FAA6F;AAC7F,MAAM,WAAW,UAAU;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,KAAK,EAAE,UAAU,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sJAAsJ;IACtJ,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,6FAA6F;IAC7F,GAAG,EAAE,UAAU,CAAC;IAChB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,6GAA6G;AAC7G,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,cAAc,CAAC;CACxB"}

package/dist/plugin/service.types.js

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

package/dist/plugin/status.d.ts

@@ -0,0 +1,27 @@
+/**
+ * One grading rule for every key figure the styleguide shows.
+ *
+ * Framework-free on purpose: plugins grade at build time in Node
+ * (`onComponentScanned` writes the sidebar's verdict into the meta) and the app
+ * grades live values in the browser, and the two must never disagree about
+ * the same number. Thresholds come from whoever owns the figure: the a11y
+ * config, the coverage plugin, the visual regression plugin.
+ */
+export type StatusTone = 'ok' | 'warn' | 'danger';
+/** How far below a single target a value may fall before it is critical. */
+export declare const STATUS_DANGER_RATIO = 0.75;
+/**
+ * `higher` (default): ok from `ok` up, warn from `warn` up, below that danger.
+ * `lower`: ok up to `ok`, warn up to `warn`, above that danger.
+ */
+export interface StatusThreshold {
+    ok: number;
+    warn: number;
+    direction?: 'higher' | 'lower';
+}
+export declare function statusFor(value: number, threshold: StatusThreshold): StatusTone;
+/** A threshold from a single target: ok at the target, warn down to {@link STATUS_DANGER_RATIO} of it. */
+export declare function thresholdFromTarget(target: number): StatusThreshold;
+/** The most severe of several verdicts; `ok` when there are none. */
+export declare function worstTone(tones: Iterable<StatusTone>): StatusTone;
+//# sourceMappingURL=status.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../src/plugin/status.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,MAAM,GAAG,QAAQ,CAAC;AAElD,4EAA4E;AAC5E,eAAO,MAAM,mBAAmB,OAAO,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;CAClC;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,GAAG,UAAU,CAO/E;AAED,0GAA0G;AAC1G,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAEnE;AAID,qEAAqE;AACrE,wBAAgB,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,GAAG,UAAU,CAOjE"}

package/dist/plugin/status.js

@@ -0,0 +1,26 @@
+/** How far below a single target a value may fall before it is critical. */
+export const STATUS_DANGER_RATIO = 0.75;
+export function statusFor(value, threshold) {
+    if (threshold.direction === 'lower') {
+        if (value <= threshold.ok)
+            return 'ok';
+        return value <= threshold.warn ? 'warn' : 'danger';
+    }
+    if (value >= threshold.ok)
+        return 'ok';
+    return value >= threshold.warn ? 'warn' : 'danger';
+}
+/** A threshold from a single target: ok at the target, warn down to {@link STATUS_DANGER_RATIO} of it. */
+export function thresholdFromTarget(target) {
+    return { ok: target, warn: target * STATUS_DANGER_RATIO };
+}
+const SEVERITY = { ok: 0, warn: 1, danger: 2 };
+/** The most severe of several verdicts; `ok` when there are none. */
+export function worstTone(tones) {
+    let worst = 'ok';
+    for (const tone of tones) {
+        if (SEVERITY[tone] > SEVERITY[worst])
+            worst = tone;
+    }
+    return worst;
+}

package/dist/shared/composition.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Where the subject element of a composition takes the attributes and bindings ng-prism gives it: the end of its start
+ * tag, in `CompositionCase.template`. Snippets replace it with the current values, the generated wrapper with the
+ * bindings. A private-use character, so that it cannot occur in the markup an author wrote. Since 22.7.0.
+ *
+ * @experimental Experimental until 23.0.0: it may change in a 22.x minor release.
+ */
+export declare const COMPOSITION_SUBJECT_SLOT = "\uE000";
+/**
+ * Attribute the generated wrapper puts on the subject element, which is how the styleguide finds it in the rendered
+ * composition. Since 22.7.0.
+ *
+ * @experimental Experimental until 23.0.0: it may change in a 22.x minor release.
+ */
+export declare const COMPOSITION_SUBJECT_ATTR = "data-prism-subject";
+/**
+ * Attribute an author puts on the one of several elements matching the subject's selector that is the subject. It is
+ * removed from the generated template and from snippets. Since 22.7.0.
+ *
+ * @experimental Experimental until 23.0.0: it may change in a 22.x minor release.
+ */
+export declare const SUBJECT_MARKER_ATTR = "prism-subject";
+/**
+ * The input a composition wrapper declares to switch between its cases: the index of the variant, which the wrapper
+ * maps onto a case. Since 22.7.0.
+ *
+ * @experimental Experimental until 23.0.0: it may change in a 22.x minor release.
+ */
+export declare const PRISM_VARIANT_INPUT = "__prismVariant__";
+//# sourceMappingURL=composition.d.ts.map

package/dist/shared/composition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"composition.d.ts","sourceRoot":"","sources":["../../src/shared/composition.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,WAAW,CAAC;AAEjD;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,uBAAuB,CAAC;AAE7D;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AAEnD;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,qBAAqB,CAAC"}

package/dist/shared/composition.js

@@ -0,0 +1,29 @@
+/**
+ * Where the subject element of a composition takes the attributes and bindings ng-prism gives it: the end of its start
+ * tag, in `CompositionCase.template`. Snippets replace it with the current values, the generated wrapper with the
+ * bindings. A private-use character, so that it cannot occur in the markup an author wrote. Since 22.7.0.
+ *
+ * @experimental Experimental until 23.0.0: it may change in a 22.x minor release.
+ */
+export const COMPOSITION_SUBJECT_SLOT = '\uE000';
+/**
+ * Attribute the generated wrapper puts on the subject element, which is how the styleguide finds it in the rendered
+ * composition. Since 22.7.0.
+ *
+ * @experimental Experimental until 23.0.0: it may change in a 22.x minor release.
+ */
+export const COMPOSITION_SUBJECT_ATTR = 'data-prism-subject';
+/**
+ * Attribute an author puts on the one of several elements matching the subject's selector that is the subject. It is
+ * removed from the generated template and from snippets. Since 22.7.0.
+ *
+ * @experimental Experimental until 23.0.0: it may change in a 22.x minor release.
+ */
+export const SUBJECT_MARKER_ATTR = 'prism-subject';
+/**
+ * The input a composition wrapper declares to switch between its cases: the index of the variant, which the wrapper
+ * maps onto a case. Since 22.7.0.
+ *
+ * @experimental Experimental until 23.0.0: it may change in a 22.x minor release.
+ */
+export const PRISM_VARIANT_INPUT = '__prismVariant__';

package/dist/shared/pseudo-state.type.d.ts

@@ -14,7 +14,8 @@ export declare const PSEUDO_STATES: readonly PseudoState[];
  *
  * `true` puts it on every element of the rendered component, the host
  * included. A selector, or a list of them, limits it to the matching elements,
- * resolved against the host and everything inside it.
+ * 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.
  */
 export type PseudoTarget = true | string | readonly string[];
 /** The pseudo states a variant forces, each with the elements it applies to. */

package/dist/shared/pseudo-state.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pseudo-state.type.d.ts","sourceRoot":"","sources":["../../src/shared/pseudo-state.type.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,eAAe,GAAG,cAAc,CAAC;AAE1F,uFAAuF;AACvF,eAAO,MAAM,aAAa,EAAE,SAAS,WAAW,EAA2E,CAAC;AAE5H;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;AAE7D,gFAAgF;AAChF,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC"}
+{"version":3,"file":"pseudo-state.type.d.ts","sourceRoot":"","sources":["../../src/shared/pseudo-state.type.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,eAAe,GAAG,cAAc,CAAC;AAE1F,uFAAuF;AACvF,eAAO,MAAM,aAAa,EAAE,SAAS,WAAW,EAA2E,CAAC;AAE5H;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,CAAC;AAE7D,gFAAgF;AAChF,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC"}

package/dist/shared/void-elements.d.ts

@@ -0,0 +1,3 @@
+/** The HTML elements that take no content and no end tag: `<input>` and `<input />` are valid, `<input></input>` is not. */
+export declare const VOID_ELEMENTS: ReadonlySet<string>;
+//# sourceMappingURL=void-elements.d.ts.map

package/dist/shared/void-elements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"void-elements.d.ts","sourceRoot":"","sources":["../../src/shared/void-elements.ts"],"names":[],"mappings":"AAAA,4HAA4H;AAC5H,eAAO,MAAM,aAAa,EAAE,WAAW,CAAC,MAAM,CAAmH,CAAC"}

package/dist/shared/void-elements.js

@@ -0,0 +1,2 @@
+/** The HTML elements that take no content and no end tag: `<input>` and `<input />` are valid, `<input></input>` is not. */
+export const VOID_ELEMENTS = new Set(['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'source', 'track', 'wbr']);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-prism/core",
-  "version": "22.6.0",
+  "version": "22.7.0-beta.0",
   "description": "ng-prism: the Angular-native Storybook alternative. Lightweight component showcase with @Showcase decorator, no story files needed.",
   "keywords": [
     "ng-prism",