@salesforcedevs/docs-components 0.54.0 → 0.54.1-a01

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

@@ -0,0 +1,76 @@
+const NAVIGATION_ITEMS = [
+    {
+        label: "Summary",
+        name: "summary",
+        childrenPropertyName: undefined,
+        type: "summary"
+    },
+    {
+        label: "Endpoints",
+        name: "endpoints",
+        childrenPropertyName: "endpoints",
+        type: "endpoint"
+    },
+    {
+        label: "Documentation",
+        name: "documentation",
+        childrenPropertyName: "docs",
+        type: "documentation"
+    },
+    {
+        label: "Types",
+        name: "types",
+        childrenPropertyName: "types",
+        type: "type"
+    },
+    {
+        label: "Security",
+        name: "security",
+        childrenPropertyName: "security",
+        type: "security"
+    }
+];
+
+const URL_CONFIG = {
+    summary: {
+        urlIdentifer: "label"
+    },
+    endpoint: {
+        urlIdentifer: "path"
+    },
+    method: {
+        urlIdentifer: "label"
+    },
+    documentation: {
+        urlIdentifer: "label"
+    },
+    type: {
+        urlIdentifer: "label",
+        prefix: "type:"
+    },
+    security: {
+        urlIdentifer: "label",
+        prefix: "security:"
+    }
+};
+
+export const REFERENCE_TYPES = {
+    markdown: "markdown",
+    raml: "rest-raml",
+    oa2: "rest-oa2",
+    oa3: "rest-oa3"
+};
+
+const oldReferenceIdNewReferenceIdMap: Record<string, string> = {
+    "commerce-api-assignments": "assignments",
+    "commerce-api-campaigns": "campaigns",
+    "commerce-api-catalogs": "catalogs",
+    "cdn-zones": "cdn-api-process-apis",
+    "inventory-impex": "impex",
+    "inventory-reservations": "inventory-reservation-service",
+    "shopper-login-and-api-access-service": "shopper-login",
+    "shopper-login-and-api-access-service-admin": "slas-admin",
+    "einstein-recommendations": "einstein-api-quick-start-guide"
+};
+
+export { NAVIGATION_ITEMS, URL_CONFIG, oldReferenceIdNewReferenceIdMap };

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

@@ -0,0 +1,133 @@
+import { Json } from "typings/custom";
+
+export interface AmfTopicType {
+    referenceId: string;
+    parentReferencePath: string;
+    amfId: string;
+    elementId: string;
+    type: string;
+}
+
+export interface AmfMetadataTopic extends AmfTopicType {
+    meta: string;
+    identifier: string;
+    navTitle?: 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 type ReferenceType = "markdown" | "rest-raml" | "rest-oa2" | "rest-oa3";
+
+/**
+ * Represents parsed topic for the sidebar.
+ */
+export interface ParsedMarkdownTopic {
+    label: string;
+    name: string;
+    children: ParsedMarkdownTopic[];
+    link?: {
+        href: string;
+        target?: string;
+    };
+}
+
+export interface AmfConfig {
+    id: string;
+    version?: string;
+    docPhase?: DocPhaseEntry;
+    title: string;
+    href: string;
+    referenceType: ReferenceType;
+
+    // determines if a reference config is the current active and selected one.
+    isSelected: boolean;
+
+    // required for spec based references
+    amf?: string;
+
+    // required for markdown based references
+    topic?: ParsedMarkdownTopic;
+}
+
+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;
+    link: {
+        href: string;
+    };
+}
+
+export interface ReferenceSetConfig {
+    refId?: string;
+    versionToRefMap?: Map<string, Array<AmfConfig>>;
+    refList: Array<AmfConfig>;
+    versions: Array<ReferenceVersion>;
+}
+
+export interface RouteMeta {
+    meta: string;
+    referenceId: string;
+    topicId: string;
+    //type is only for spec based references
+    type?: string;
+}