@salesforcedevs/docs-components 0.54.0-alpha04 → 0.54.5

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforcedevs/docs-components",
3
- "version": "0.54.0-alpha04",
3
+ "version": "0.54.5",
4
4
  "description": "Docs Lightning web components for DSC",
5
5
  "license": "MIT",
6
6
  "main": "index.js",
@@ -12,7 +12,6 @@
12
12
  },
13
13
  "dependencies": {
14
14
  "@api-components/amf-helper-mixin": "^4.5.17",
15
- "@lwrjs/types": "^0.6.5",
16
15
  "classnames": "^2.2.6",
17
16
  "kagekiri": "^1.4.1",
18
17
  "lodash.orderby": "^4.6.0",
@@ -1,4 +1,4 @@
1
- import { Json } from "@lwrjs/types";
1
+ import { Json } from "typings/custom";
2
2
 
3
3
  export interface AmfTopicType {
4
4
  referenceId: string;
@@ -20,7 +20,12 @@ export interface NavItem {
20
20
  name: string;
21
21
  label: string;
22
22
  // TODO: Better type here
23
- children?: ({ id: string; label?: string; method: string; domId: string } & {
23
+ children?: ({
24
+ id: string;
25
+ label?: string;
26
+ method: string;
27
+ domId: string;
28
+ } & {
24
29
  name: string;
25
30
  label: string;
26
31
  })[];
@@ -1,4 +1,4 @@
1
- import { Json } from "@lwrjs/types";
1
+ import { Json } from "typings/custom";
2
2
 
3
3
  export type ApiSummaryElement = HTMLElement & {
4
4
  amf: Json;
@@ -6,8 +6,7 @@ import type {
6
6
  ApiSummaryElement,
7
7
  ApiTypeElement
8
8
  } from "./types";
9
-
10
- import { Json } from "@lwrjs/types";
9
+ import { Json } from "typings/custom";
11
10
 
12
11
  export function createSummaryElement(amf: Json): HTMLElement {
13
12
  const summaryElement: ApiSummaryElement = document.createElement(
@@ -78,7 +77,10 @@ export function createMethodElement(
78
77
  * Creates a documentation element for Security AMF type
79
78
  *
80
79
  */
81
- export function createSecurityElement(amf: Json, securityModel: Json): HTMLElement {
80
+ export function createSecurityElement(
81
+ amf: Json,
82
+ securityModel: Json
83
+ ): HTMLElement {
82
84
  const el: ApiSecurityElement = document.createElement(
83
85
  "api-security-documentation"
84
86
  ) as ApiSecurityElement;
@@ -94,8 +96,14 @@ export function createSecurityElement(amf: Json, securityModel: Json): HTMLEleme
94
96
  * @param {string} amfId Reference ID as passed in from amfConfig
95
97
  * @param {string} selected Currently selected `@id`.
96
98
  */
97
- export function createTypeElement(amf: Json, typeModel: Json, mediaTypes: Json): HTMLElement {
98
- const el: ApiTypeElement = document.createElement("api-type-documentation") as ApiTypeElement;
99
+ export function createTypeElement(
100
+ amf: Json,
101
+ typeModel: Json,
102
+ mediaTypes: Json
103
+ ): HTMLElement {
104
+ const el: ApiTypeElement = document.createElement(
105
+ "api-type-documentation"
106
+ ) as ApiTypeElement;
99
107
  el.setAttribute("exportparts", ["type-title"].join(","));
100
108
  el.amf = amf;
101
109
  el.type = typeModel;
@@ -109,8 +117,13 @@ export function createTypeElement(amf: Json, typeModel: Json, mediaTypes: Json):
109
117
  * @param {string} amfId Reference ID as passed in from amfConfig
110
118
  * @param {string} selected Currently selected `@id`.
111
119
  */
112
- export function createDocumentationElement(amf: Json, docsModel: Json): HTMLElement {
113
- const el: ApiDocElement = document.createElement("api-documentation-document") as ApiDocElement;
120
+ export function createDocumentationElement(
121
+ amf: Json,
122
+ docsModel: Json
123
+ ): HTMLElement {
124
+ const el: ApiDocElement = document.createElement(
125
+ "api-documentation-document"
126
+ ) as ApiDocElement;
114
127
  el.amf = amf;
115
128
  el.shape = docsModel;
116
129
  return el;