@salesforcedevs/docs-components 0.53.6 → 0.54.0-alpha01

package/src/modules/doc/amfReference/route-meta.ts

@@ -0,0 +1,22 @@
+/**
+ * Represents the URL reference meta on Reference page.
+ * Contains information on selected Reference ID, Topic ID, and Topic Type
+ * separated by ":"
+ */
+export class RouteMeta {
+    meta: string;
+    referenceId = "";
+    topicId = "";
+    type = "";
+
+    constructor(meta: string) {
+        this.meta = meta;
+
+        if (meta && meta.includes(":")) {
+            const [referenceId, type, topicId] = meta.split(":");
+            this.referenceId = referenceId;
+            this.topicId = topicId || type;
+            this.type = type;
+        }
+    }
+}

package/src/modules/doc/amfReference/types.ts

@@ -0,0 +1,88 @@
+import { Json } from "@lwrjs/types";
+
+export interface AmfTopicType {
+    referenceId: string;
+    amfId: string;
+    elementId: string;
+    type: string;
+}
+
+export interface AmfMetadataTopic extends AmfTopicType {
+    meta: string;
+    identifier: string;
+}
+
+export interface AmfMetaTopicType extends AmfTopicType {
+    meta: string;
+}
+
+export interface NavItem {
+    name: string;
+    label: string;
+    // TODO: Better type here
+    children?: ({ id: string; label?: string; method: string; domId: string } & {
+        name: string;
+        label: string;
+    })[];
+    isExpanded?: boolean;
+}
+
+export type AmfModel = Json;
+
+export interface AmfParser {
+    parse(): void;
+    parsedModel: any;
+}
+
+export interface AmfModelRecord {
+    model: AmfModel;
+    parser: AmfParser;
+    parsedModel: Json;
+}
+
+export type DocPhase = "pilot" | "dev-preview" | "beta";
+
+export type DocPhaseEntry = {
+    phase: DocPhase;
+    title: string;
+    body: string;
+};
+
+export interface AmfConfig extends AmfModelRecord {
+    id: string;
+    amf: string;
+    version?: string;
+    docPhase?: DocPhaseEntry;
+}
+
+export interface ParsedTopicModel {
+    id: string;
+    label: string;
+    domId: string;
+    indent?: number;
+    methods?: {
+        id: string;
+        label?: string;
+        method: string;
+        domId: string;
+    }[];
+}
+export interface TopicModel {
+    id: string;
+    type: string;
+    amf: AmfModel;
+    parser: AmfParser;
+}
+
+export interface ReferenceVersion {
+    id: string;
+    label: string;
+    deprecated?: boolean;
+    selected?: boolean;
+}
+
+export interface ReferenceSetConfig {
+    versionToRefMap?: Map<string, Array<AmfConfig>>;
+    refList: Array<AmfConfig>;
+    versions?: Array<ReferenceVersion>;
+}