@ng-prism/plugin-jsdoc 21.5.2 → 21.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/jsdoc-extractor.js +3 -0
  2. package/dist/jsdoc-panel.component.d.ts +1 -0
  3. package/dist/jsdoc-panel.component.d.ts.map +1 -1
  4. package/dist/jsdoc-panel.component.js +26 -6
  5. package/dist/jsdoc.types.d.ts +1 -0
  6. package/dist/jsdoc.types.d.ts.map +1 -1
  7. package/package.json +1 -1
package/dist/jsdoc-extractor.js CHANGED
@@ -57,6 +57,9 @@ function buildTagsFromList(tags) {
57
57
  else if (tagName === 'since') {
58
58
  result.since = comment;
59
59
  }
60
+ else if (tagName === 'version') {
61
+ result.version = comment;
62
+ }
60
63
  else if (tagName === 'see') {
61
64
  const seeRef = extractSeeReference(tag, comment);
62
65
  if (seeRef)
package/dist/jsdoc-panel.component.d.ts CHANGED
@@ -11,6 +11,7 @@ export declare class JsDocPanelComponent {
11
11
  protected readonly isDeprecated: import("@angular/core").Signal<boolean>;
12
12
  protected readonly deprecatedMessage: import("@angular/core").Signal<string | undefined>;
13
13
  protected readonly since: import("@angular/core").Signal<string | undefined>;
14
+ protected readonly version: import("@angular/core").Signal<string | undefined>;
14
15
  protected readonly seeRefs: import("@angular/core").Signal<string[]>;
15
16
  protected readonly examples: import("@angular/core").Signal<string[]>;
16
17
  protected readonly methods: import("@angular/core").Signal<MethodDoc[]>;
package/dist/jsdoc-panel.component.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"jsdoc-panel.component.d.ts","sourceRoot":"","sources":["../src/jsdoc-panel.component.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;;AAE7D,qBAgSa,mBAAmB;IAC9B,QAAQ,CAAC,eAAe,+CAAwB;IAEhD,SAAS,CAAC,QAAQ,CAAC,SAAS,mDAGzB;IAEH,SAAS,CAAC,QAAQ,CAAC,MAAM,8CAGtB;IAEH,SAAS,CAAC,QAAQ,CAAC,OAAO,+CAGvB;IAEH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,qDAEjC;IAEF,SAAS,CAAC,QAAQ,CAAC,SAAS,uEAE1B;IAEF,SAAS,CAAC,QAAQ,CAAC,YAAY,0CAE7B;IAEF,SAAS,CAAC,QAAQ,CAAC,iBAAiB,qDAGjC;IAEH,SAAS,CAAC,QAAQ,CAAC,KAAK,qDAA0C;IAElE,SAAS,CAAC,QAAQ,CAAC,OAAO,2CAA8C;IAExE,SAAS,CAAC,QAAQ,CAAC,QAAQ,2CAAkD;IAE7E,SAAS,CAAC,QAAQ,CAAC,OAAO,8CAExB;IAEF,SAAS,CAAC,QAAQ,CAAC,OAAO,0CAExB;IAEF,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInD,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1D,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM;IAQtE,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;yCAjEpC,mBAAmB;2CAAnB,mBAAmB;CAqE/B"}
1
+ {"version":3,"file":"jsdoc-panel.component.d.ts","sourceRoot":"","sources":["../src/jsdoc-panel.component.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;;AAE7D,qBAqSa,mBAAmB;IAC9B,QAAQ,CAAC,eAAe,+CAAwB;IAEhD,SAAS,CAAC,QAAQ,CAAC,SAAS,mDAGzB;IAEH,SAAS,CAAC,QAAQ,CAAC,MAAM,8CAGtB;IAEH,SAAS,CAAC,QAAQ,CAAC,OAAO,+CAGvB;IAEH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,qDAEjC;IAEF,SAAS,CAAC,QAAQ,CAAC,SAAS,uEAE1B;IAEF,SAAS,CAAC,QAAQ,CAAC,YAAY,0CAE7B;IAEF,SAAS,CAAC,QAAQ,CAAC,iBAAiB,qDAGjC;IAEH,SAAS,CAAC,QAAQ,CAAC,KAAK,qDAA0C;IAElE,SAAS,CAAC,QAAQ,CAAC,OAAO,qDAA4C;IAEtE,SAAS,CAAC,QAAQ,CAAC,OAAO,2CAA8C;IAExE,SAAS,CAAC,QAAQ,CAAC,QAAQ,2CAAkD;IAE7E,SAAS,CAAC,QAAQ,CAAC,OAAO,8CAExB;IAEF,SAAS,CAAC,QAAQ,CAAC,OAAO,0CAExB;IAEF,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInD,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI1D,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM;IAQtE,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;yCAnEpC,mBAAmB;2CAAnB,mBAAmB;CAuE/B"}
package/dist/jsdoc-panel.component.js CHANGED
@@ -26,6 +26,17 @@ function JsDocPanelComponent_Conditional_2_Conditional_1_Conditional_1_Template(
26
26
  i0.ɵɵtextInterpolate1(" Deprecated", ctx_r0.deprecatedMessage() ? ": " + ctx_r0.deprecatedMessage() : "", " ");
27
27
  } }
28
28
  function JsDocPanelComponent_Conditional_2_Conditional_1_Conditional_2_Template(rf, ctx) { if (rf & 1) {
29
+ i0.ɵɵelementStart(0, "span", 6)(1, "span", 7);
30
+ i0.ɵɵtext(2, "Version:");
31
+ i0.ɵɵelementEnd();
32
+ i0.ɵɵtext(3);
33
+ i0.ɵɵelementEnd();
34
+ } if (rf & 2) {
35
+ const ctx_r0 = i0.ɵɵnextContext(3);
36
+ i0.ɵɵadvance(3);
37
+ i0.ɵɵtextInterpolate1(" ", ctx_r0.version(), " ");
38
+ } }
39
+ function JsDocPanelComponent_Conditional_2_Conditional_1_Conditional_3_Template(rf, ctx) { if (rf & 1) {
29
40
  i0.ɵɵelementStart(0, "span", 6)(1, "span", 7);
30
41
  i0.ɵɵtext(2, "Since:");
31
42
  i0.ɵɵelementEnd();
@@ -36,7 +47,7 @@ function JsDocPanelComponent_Conditional_2_Conditional_1_Conditional_2_Template(
36
47
  i0.ɵɵadvance(3);
37
48
  i0.ɵɵtextInterpolate1(" ", ctx_r0.since(), " ");
38
49
  } }
39
- function JsDocPanelComponent_Conditional_2_Conditional_1_For_4_Template(rf, ctx) { if (rf & 1) {
50
+ function JsDocPanelComponent_Conditional_2_Conditional_1_For_5_Template(rf, ctx) { if (rf & 1) {
40
51
  i0.ɵɵelementStart(0, "span", 6)(1, "span", 7);
41
52
  i0.ɵɵtext(2, "See:");
42
53
  i0.ɵɵelementEnd();
@@ -51,14 +62,17 @@ function JsDocPanelComponent_Conditional_2_Conditional_1_Template(rf, ctx) { if
51
62
  i0.ɵɵelementStart(0, "div", 3);
52
63
  i0.ɵɵconditionalCreate(1, JsDocPanelComponent_Conditional_2_Conditional_1_Conditional_1_Template, 2, 1, "span", 5);
53
64
  i0.ɵɵconditionalCreate(2, JsDocPanelComponent_Conditional_2_Conditional_1_Conditional_2_Template, 4, 1, "span", 6);
54
- i0.ɵɵrepeaterCreate(3, JsDocPanelComponent_Conditional_2_Conditional_1_For_4_Template, 4, 1, "span", 6, i0.ɵɵrepeaterTrackByIndex);
65
+ i0.ɵɵconditionalCreate(3, JsDocPanelComponent_Conditional_2_Conditional_1_Conditional_3_Template, 4, 1, "span", 6);
66
+ i0.ɵɵrepeaterCreate(4, JsDocPanelComponent_Conditional_2_Conditional_1_For_5_Template, 4, 1, "span", 6, i0.ɵɵrepeaterTrackByIndex);
55
67
  i0.ɵɵelementEnd();
56
68
  } if (rf & 2) {
57
69
  const ctx_r0 = i0.ɵɵnextContext(2);
58
70
  i0.ɵɵadvance();
59
71
  i0.ɵɵconditional(ctx_r0.isDeprecated() ? 1 : -1);
60
72
  i0.ɵɵadvance();
61
- i0.ɵɵconditional(ctx_r0.since() ? 2 : -1);
73
+ i0.ɵɵconditional(ctx_r0.version() ? 2 : -1);
74
+ i0.ɵɵadvance();
75
+ i0.ɵɵconditional(ctx_r0.since() ? 3 : -1);
62
76
  i0.ɵɵadvance();
63
77
  i0.ɵɵrepeater(ctx_r0.seeRefs());
64
78
  } }
@@ -311,7 +325,7 @@ function JsDocPanelComponent_Conditional_2_Conditional_5_Template(rf, ctx) { if
311
325
  } }
312
326
  function JsDocPanelComponent_Conditional_2_Template(rf, ctx) { if (rf & 1) {
313
327
  i0.ɵɵconditionalCreate(0, JsDocPanelComponent_Conditional_2_Conditional_0_Template, 2, 1, "p", 2);
314
- i0.ɵɵconditionalCreate(1, JsDocPanelComponent_Conditional_2_Conditional_1_Template, 5, 2, "div", 3);
328
+ i0.ɵɵconditionalCreate(1, JsDocPanelComponent_Conditional_2_Conditional_1_Template, 6, 3, "div", 3);
315
329
  i0.ɵɵconditionalCreate(2, JsDocPanelComponent_Conditional_2_Conditional_2_Template, 5, 0, "div", 4);
316
330
  i0.ɵɵconditionalCreate(3, JsDocPanelComponent_Conditional_2_Conditional_3_Template, 19, 0, "div", 4);
317
331
  i0.ɵɵconditionalCreate(4, JsDocPanelComponent_Conditional_2_Conditional_4_Template, 13, 0, "div", 4);
@@ -352,10 +366,11 @@ export class JsDocPanelComponent {
352
366
  return typeof d === 'string' ? d : undefined;
353
367
  }, ...(ngDevMode ? [{ debugName: "deprecatedMessage" }] : []));
354
368
  since = computed(() => this.classTags().since, ...(ngDevMode ? [{ debugName: "since" }] : []));
369
+ version = computed(() => this.classTags().version, ...(ngDevMode ? [{ debugName: "version" }] : []));
355
370
  seeRefs = computed(() => this.classTags().see ?? [], ...(ngDevMode ? [{ debugName: "seeRefs" }] : []));
356
371
  examples = computed(() => this.classTags().example ?? [], ...(ngDevMode ? [{ debugName: "examples" }] : []));
357
372
  methods = computed(() => this.jsdocData()?.methods ?? [], ...(ngDevMode ? [{ debugName: "methods" }] : []));
358
- hasTags = computed(() => this.isDeprecated() || !!this.since() || this.seeRefs().length > 0, ...(ngDevMode ? [{ debugName: "hasTags" }] : []));
373
+ hasTags = computed(() => this.isDeprecated() || !!this.since() || !!this.version() || this.seeRefs().length > 0, ...(ngDevMode ? [{ debugName: "hasTags" }] : []));
359
374
  isMemberDeprecated(name) {
360
375
  return !!this.jsdocData()?.memberTags[name]?.deprecated;
361
376
  }
@@ -404,6 +419,11 @@ export class JsDocPanelComponent {
404
419
  >
405
420
  Deprecated{{ deprecatedMessage() ? ': ' + deprecatedMessage() : '' }}
406
421
  </span>
422
+ } @if (version()) {
423
+ <span class="prism-jsdoc-panel__meta-item">
424
+ <span class="prism-jsdoc-panel__meta-label">Version:</span>
425
+ {{ version() }}
426
+ </span>
407
427
  } @if (since()) {
408
428
  <span class="prism-jsdoc-panel__meta-item">
409
429
  <span class="prism-jsdoc-panel__meta-label">Since:</span>
@@ -576,4 +596,4 @@ export class JsDocPanelComponent {
576
596
  </div>
577
597
  `, styles: ["\n :host { display: block; height: 100%; overflow: auto; }\n .prism-jsdoc-panel {\n padding: 20px 24px;\n max-width: 880px;\n font-family: var(--font-sans);\n font-size: var(--fs-md);\n color: var(--prism-text);\n }\n .prism-jsdoc-panel__empty {\n display: flex; align-items: center; justify-content: center;\n min-height: 120px; color: var(--prism-text-muted);\n }\n .prism-jsdoc-panel__description {\n margin: 0 0 18px;\n font-size: 14px;\n line-height: 1.7;\n color: var(--prism-text-2);\n }\n .prism-jsdoc-panel__meta {\n display: flex; flex-wrap: wrap; gap: 6px; margin-bottom: 18px;\n }\n .prism-jsdoc-panel__meta-item {\n display: flex; align-items: center; gap: 6px;\n padding: 3px 9px; border-radius: 4px;\n background: var(--prism-input-bg);\n border: 1px solid var(--prism-border);\n font-size: var(--fs-sm); color: var(--prism-text-2);\n }\n .prism-jsdoc-panel__meta-label {\n font-weight: 500; color: var(--prism-primary);\n font-family: var(--font-mono);\n }\n .prism-jsdoc-panel__badge {\n display: inline-flex; align-items: center;\n padding: 2px 8px; border-radius: 10px;\n font-size: 12px; font-weight: 600;\n }\n .prism-jsdoc-panel__badge--deprecated {\n background: color-mix(in srgb, var(--prism-warn) 15%, transparent);\n color: var(--prism-warn);\n }\n .prism-jsdoc-panel__badge--required {\n color: var(--prism-accent); font-weight: 700; margin-left: 4px;\n }\n .prism-jsdoc-panel__badge--small { padding: 1px 5px; font-size: 10px; margin-left: 4px; }\n .prism-jsdoc-panel__section { margin-bottom: 20px; }\n .prism-jsdoc-panel__heading {\n font-size: 11px; font-weight: 700; text-transform: uppercase;\n letter-spacing: 0.08em; margin: 22px 0 10px;\n color: var(--prism-text-ghost);\n }\n .prism-jsdoc-panel__code {\n margin: 0 0 8px; padding: 0;\n background: var(--prism-bg-surface);\n border: 1px solid var(--prism-border);\n border-radius: 8px; overflow: auto;\n }\n .prism-jsdoc-panel__code code {\n font-family: var(--font-mono);\n font-size: var(--fs-sm); line-height: 1.5;\n padding: 8px 12px; display: block;\n }\n .prism-jsdoc-panel__table {\n width: 100%; border-collapse: collapse;\n font-size: var(--fs-md);\n border: 1px solid var(--prism-border);\n border-radius: 8px; overflow: hidden;\n }\n .prism-jsdoc-panel__table th {\n text-align: left; padding: 8px 12px;\n background: var(--prism-bg-surface);\n font-size: 10.5px; text-transform: uppercase;\n letter-spacing: 0.06em; font-weight: 700;\n color: var(--prism-text-ghost);\n border-bottom: 1px solid var(--prism-border);\n }\n .prism-jsdoc-panel__table td {\n padding: 10px 12px;\n border-bottom: 1px solid var(--prism-border);\n vertical-align: top;\n }\n .prism-jsdoc-panel__table tr:last-child td { border-bottom: 0; }\n .prism-jsdoc-panel__row--deprecated td { opacity: 0.6; }\n .prism-jsdoc-panel__cell--name code,\n .prism-jsdoc-panel__cell--type code,\n .prism-jsdoc-panel__cell--default code {\n font-family: var(--font-mono);\n font-size: var(--fs-sm); color: var(--prism-primary);\n background: color-mix(in srgb, var(--prism-primary) 8%, transparent);\n padding: 1px 5px; border-radius: var(--radius-xs);\n }\n .prism-jsdoc-panel__muted { color: var(--prism-text-muted); }\n .prism-jsdoc-panel__cell--doc { color: var(--prism-text); line-height: 1.4; }\n "] }]
578
598
  }], null, { activeComponent: [{ type: i0.Input, args: [{ isSignal: true, alias: "activeComponent", required: false }] }] }); })();
579
- (() => { (typeof ngDevMode === "undefined" || ngDevMode) && i0.ɵsetClassDebugInfo(JsDocPanelComponent, { className: "JsDocPanelComponent", filePath: "jsdoc-panel.component.ts", lineNumber: 299 }); })();
599
+ (() => { (typeof ngDevMode === "undefined" || ngDevMode) && i0.ɵsetClassDebugInfo(JsDocPanelComponent, { className: "JsDocPanelComponent", filePath: "jsdoc-panel.component.ts", lineNumber: 304 }); })();
package/dist/jsdoc.types.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  export interface JsDocTags {
2
2
  deprecated?: string | true;
3
3
  since?: string;
4
+ version?: string;
4
5
  see?: string[];
5
6
  example?: string[];
6
7
  }
package/dist/jsdoc.types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"jsdoc.types.d.ts","sourceRoot":"","sources":["../src/jsdoc.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB"}
1
+ {"version":3,"file":"jsdoc.types.d.ts","sourceRoot":"","sources":["../src/jsdoc.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,SAAS,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ng-prism/plugin-jsdoc",
3
- "version": "21.5.2",
3
+ "version": "21.5.4",
4
4
  "description": "JSDoc API documentation panel for ng-prism.",
5
5
  "keywords": [
6
6
  "@ng-prism/core",