@vendure-io/docs-provider 0.2.0 → 0.4.0

package/docs/mdx-components-reference.md

@@ -45,6 +45,36 @@ Embeds a Stackblitz editor for interactive code examples.
 <Stackblitz id="vendure-getting-started" />
 ```
 
+### LinkCard
+
+A card-style link that provides more visual prominence than a standard link. Useful for navigation and highlighting important pages.
+
+#### Props
+
+| Prop       | Type        | Required | Description                                  |
+| ---------- | ----------- | -------- | -------------------------------------------- |
+| `href`     | `string`    | Yes      | URL to navigate to (internal or external)    |
+| `title`    | `string`    | Yes      | Primary text displayed on the card           |
+| `subtitle` | `string`    | No       | Secondary text displayed below the title     |
+| `children` | `ReactNode` | No       | Additional content (alternative to subtitle) |
+
+#### Example
+
+```mdx
+<LinkCard
+  href="/guides/getting-started"
+  title="Getting Started"
+  subtitle="Learn how to set up your first project"
+/>
+
+<LinkCard
+  href="/reference/api"
+  title="API Reference"
+>
+  Complete API documentation including methods and examples.
+</LinkCard>
+```
+
 ---
 
 ## Reference Documentation Components
@@ -179,6 +209,71 @@ Shows required/optional status and type information for custom fields. Used in c
 />
 ```
 
+### GraphQLDoc
+
+Displays GraphQL schema definitions with syntax highlighting and clickable type links. Used in GraphQL API reference documentation.
+
+**Note:** The component automatically formats and indents the GraphQL SDL content. Since MDX strips leading whitespace from template literals, you don't need to worry about indentation in your source files - the component will add proper indentation based on GraphQL syntax (braces, etc.).
+
+#### Props
+
+| Prop         | Type                                                                                                                         | Required | Description                                                                             |
+| ------------ | ---------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------- |
+| `type`       | `'mutation' \| 'query' \| 'subscription' \| 'type' \| 'input' \| 'enum' \| 'scalar' \| 'interface' \| 'union' \| 'fragment'` | Yes      | The GraphQL definition kind                                                             |
+| `typeName`   | `string`                                                                                                                     | Yes      | The primary type/operation name                                                         |
+| `since`      | `string`                                                                                                                     | No       | Version when this API was introduced                                                    |
+| `deprecated` | `boolean \| string`                                                                                                          | No       | Mark as deprecated (string provides deprecation message)                                |
+| `typeLinks`  | `Record<string, string>`                                                                                                     | No       | Map of type names to their documentation URLs. Only types in this map become clickable. |
+| `children`   | `ReactNode`                                                                                                                  | Yes      | GraphQL SDL content                                                                     |
+
+#### Example
+
+```mdx
+{/* Simple mutation without type links */}
+
+<GraphQLDoc
+  type="mutation"
+  typeName="logout"
+  since="1.0.0"
+>
+  {`type Mutation {
+  logout: Success!
+}`}
+</GraphQLDoc>
+
+{/* Mutation with clickable type links */}
+
+<GraphQLDoc
+  type="mutation"
+  typeName="addCustomersToGroup"
+  since="1.0.0"
+  typeLinks={{
+    CustomerGroup: '/reference/graphql-api/admin/customer-group',
+    ID: '/reference/graphql-api/common/scalars#id',
+  }}
+>
+  {`"""
+Add Customers to a CustomerGroup
+"""
+type Mutation {
+  addCustomersToGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
+}`}
+</GraphQLDoc>
+
+{/* Deprecated type */}
+
+<GraphQLDoc
+  type="type"
+  typeName="OldProduct"
+  deprecated="Use Product instead"
+>
+  {`type OldProduct {
+  id: ID!
+  name: String!
+}`}
+</GraphQLDoc>
+```
+
 ---
 
 ## Complete Reference Page Example
@@ -271,6 +366,8 @@ All component props have TypeScript interfaces defined in `@vendure-io/docs-prov
 ```typescript
 import type {
   GenerationInfoProps,
+  GraphQLDocProps,
+  LinkCardProps,
   MemberInfoProps,
   MemberDescriptionProps,
   CustomFieldPropertyProps,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vendure-io/docs-provider",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Contract types and utilities for Vendure documentation packages",
   "private": false,
   "publishConfig": {

package/dist/manifest-B1CxKK1i.js

@@ -1,207 +0,0 @@
-var N = Object.defineProperty;
-var S = (r, e, n) => e in r ? N(r, e, { enumerable: !0, configurable: !0, writable: !0, value: n }) : r[e] = n;
-var l = (r, e, n) => S(r, typeof e != "symbol" ? e + "" : e, n);
-import g from "gray-matter";
-import { z as t } from "zod";
-const P = t.enum(["v1", "v2", "v3"]), j = t.object({
-  indexFields: t.array(t.enum(["title", "description", "content", "keywords"])),
-  boosts: t.record(t.string(), t.number()).optional()
-}), $ = t.object({
-  repository: t.string().regex(/^[^/]+\/[^/]+$/, 'Repository must be in format "owner/repo"'),
-  branch: t.string().optional(),
-  docsPath: t.string().optional()
-}), u = t.lazy(
-  () => t.object({
-    title: t.string().min(1, "Navigation title is required"),
-    slug: t.string().min(1, "Navigation slug is required"),
-    file: t.string().optional(),
-    children: t.array(u).optional(),
-    badge: t.string().optional()
-  })
-), f = t.object({
-  id: t.string().min(1, "Package ID is required"),
-  name: t.string().min(1, "Package name is required"),
-  version: t.string().regex(/^\d+\.\d+\.\d+/, "Version must be valid semver"),
-  vendureVersion: P,
-  navigation: t.array(u),
-  search: j.optional(),
-  github: $.optional()
-}), m = t.object({
-  title: t.string().min(1, "Page title is required"),
-  description: t.string().optional(),
-  keywords: t.array(t.string()).optional(),
-  sidebarLabel: t.string().optional(),
-  hidden: t.boolean().optional()
-}), M = t.object({
-  meta: m,
-  content: t.string(),
-  filePath: t.string()
-}), B = t.object({
-  manifest: f,
-  basePath: t.string()
-}), V = t.object({
-  title: t.string(),
-  slug: t.string(),
-  path: t.string()
-}), I = t.object({
-  title: t.string(),
-  slug: t.string(),
-  file: t.string().optional(),
-  children: t.array(t.lazy(() => u)).optional(),
-  badge: t.string().optional(),
-  path: t.string(),
-  depth: t.number().int().min(0),
-  parentPath: t.string().optional()
-});
-class d extends Error {
-  constructor(n, i, a) {
-    super(n);
-    l(this, "filePath");
-    l(this, "originalError");
-    this.name = "FrontmatterParseError", this.filePath = i, this.originalError = a;
-  }
-}
-function q(r, e) {
-  try {
-    const { data: n, content: i } = g(r);
-    return {
-      meta: y(n, e),
-      content: i.trim()
-    };
-  } catch (n) {
-    throw n instanceof d ? n : new d(
-      `Failed to parse frontmatter${e ? ` in ${e}` : ""}`,
-      e,
-      n
-    );
-  }
-}
-function y(r, e) {
-  const n = m.safeParse(r);
-  if (!n.success) {
-    const i = n.error.issues.map((a) => `  - ${a.path.join(".")}: ${a.message}`).join(`
-`);
-    throw new d(
-      `Invalid frontmatter${e ? ` in ${e}` : ""}:
-${i}`,
-      e,
-      n.error
-    );
-  }
-  return n.data;
-}
-function L(r) {
-  return r.trimStart().startsWith("---");
-}
-function z(r) {
-  const { data: e } = g(r);
-  return e;
-}
-class x extends Error {
-  constructor(n, i) {
-    super(n);
-    l(this, "issues");
-    this.name = "ManifestValidationError", this.issues = i;
-  }
-}
-function A(r) {
-  const e = f.safeParse(r);
-  if (!e.success) {
-    const n = e.error.issues.map((i) => `${i.path.join(".")}: ${i.message}`);
-    throw new x("Invalid manifest", n);
-  }
-  return e.data;
-}
-function C(r, e) {
-  const n = e.split("/").filter(Boolean);
-  return h(r.navigation, n);
-}
-function h(r, e) {
-  if (e.length === 0) return;
-  const [n, ...i] = e, a = r.find((s) => s.slug === n);
-  if (a) {
-    if (i.length === 0) return a;
-    if (a.children)
-      return h(a.children, i);
-  }
-}
-function p(r) {
-  const e = [];
-  return v(r.navigation, "", 0, void 0, e), e;
-}
-function v(r, e, n, i, a) {
-  for (const s of r) {
-    const o = e ? `${e}/${s.slug}` : s.slug;
-    a.push({
-      ...s,
-      path: o,
-      depth: n,
-      parentPath: i
-    }), s.children && s.children.length > 0 && v(s.children, o, n + 1, o, a);
-  }
-}
-function G(r, e) {
-  const n = e.split("/").filter(Boolean), i = [];
-  let a = r.navigation, s = "";
-  for (const o of n) {
-    const c = a.find((b) => b.slug === o);
-    if (!c) break;
-    s = s ? `${s}/${o}` : o, i.push({
-      title: c.title,
-      slug: c.slug,
-      path: s
-    }), a = c.children ?? [];
-  }
-  return i;
-}
-function w(r) {
-  return p(r).filter((e) => e.file !== void 0);
-}
-function H(r, e) {
-  const n = w(r), i = n.findIndex((a) => a.path === e);
-  return i === -1 ? {} : {
-    prev: i > 0 ? n[i - 1] : void 0,
-    next: i < n.length - 1 ? n[i + 1] : void 0
-  };
-}
-function F(r, e) {
-  const n = e.split("/").filter(Boolean);
-  if (n.length === 0) return !1;
-  if (r.slug === n[0]) {
-    if (n.length === 1) return !0;
-    if (r.children) {
-      const i = n.slice(1).join("/");
-      return r.children.some((a) => F(a, i));
-    }
-  }
-  return !1;
-}
-function R(r, e) {
-  return p(r).filter((n) => n.depth === e);
-}
-export {
-  V as B,
-  m as D,
-  I as F,
-  $ as G,
-  B as L,
-  x as M,
-  u as N,
-  j as S,
-  P as V,
-  M as a,
-  f as b,
-  d as c,
-  G as d,
-  z as e,
-  C as f,
-  p as g,
-  L as h,
-  w as i,
-  R as j,
-  H as k,
-  F as l,
-  A as m,
-  q as p,
-  y as v
-};

package/dist/manifest-D2yANQB-.cjs

@@ -1,3 +0,0 @@
-"use strict";var y=Object.defineProperty;var D=(r,e,n)=>e in r?y(r,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):r[e]=n;var d=(r,e,n)=>D(r,typeof e!="symbol"?e+"":e,n);const h=require("gray-matter"),t=require("zod"),z=t.z.enum(["v1","v2","v3"]),p=t.z.object({indexFields:t.z.array(t.z.enum(["title","description","content","keywords"])),boosts:t.z.record(t.z.string(),t.z.number()).optional()}),v=t.z.object({repository:t.z.string().regex(/^[^/]+\/[^/]+$/,'Repository must be in format "owner/repo"'),branch:t.z.string().optional(),docsPath:t.z.string().optional()}),g=t.z.lazy(()=>t.z.object({title:t.z.string().min(1,"Navigation title is required"),slug:t.z.string().min(1,"Navigation slug is required"),file:t.z.string().optional(),children:t.z.array(g).optional(),badge:t.z.string().optional()})),u=t.z.object({id:t.z.string().min(1,"Package ID is required"),name:t.z.string().min(1,"Package name is required"),version:t.z.string().regex(/^\d+\.\d+\.\d+/,"Version must be valid semver"),vendureVersion:z,navigation:t.z.array(g),search:p.optional(),github:v.optional()}),m=t.z.object({title:t.z.string().min(1,"Page title is required"),description:t.z.string().optional(),keywords:t.z.array(t.z.string()).optional(),sidebarLabel:t.z.string().optional(),hidden:t.z.boolean().optional()}),x=t.z.object({meta:m,content:t.z.string(),filePath:t.z.string()}),M=t.z.object({manifest:u,basePath:t.z.string()}),w=t.z.object({title:t.z.string(),slug:t.z.string(),path:t.z.string()}),E=t.z.object({title:t.z.string(),slug:t.z.string(),file:t.z.string().optional(),children:t.z.array(t.z.lazy(()=>g)).optional(),badge:t.z.string().optional(),path:t.z.string(),depth:t.z.number().int().min(0),parentPath:t.z.string().optional()});class l extends Error{constructor(n,i,a){super(n);d(this,"filePath");d(this,"originalError");this.name="FrontmatterParseError",this.filePath=i,this.originalError=a}}function k(r,e){try{const{data:n,content:i}=h(r);return{meta:b(n,e),content:i.trim()}}catch(n){throw n instanceof l?n:new l(`Failed to parse frontmatter${e?` in ${e}`:""}`,e,n)}}function b(r,e){const n=m.safeParse(r);if(!n.success){const i=n.error.issues.map(a=>`  - ${a.path.join(".")}: ${a.message}`).join(`
-`);throw new l(`Invalid frontmatter${e?` in ${e}`:""}:
-${i}`,e,n.error)}return n.data}function V(r){return r.trimStart().startsWith("---")}function B(r){const{data:e}=h(r);return e}class N extends Error{constructor(n,i){super(n);d(this,"issues");this.name="ManifestValidationError",this.issues=i}}function q(r){const e=u.safeParse(r);if(!e.success){const n=e.error.issues.map(i=>`${i.path.join(".")}: ${i.message}`);throw new N("Invalid manifest",n)}return e.data}function I(r,e){const n=e.split("/").filter(Boolean);return S(r.navigation,n)}function S(r,e){if(e.length===0)return;const[n,...i]=e,a=r.find(o=>o.slug===n);if(a){if(i.length===0)return a;if(a.children)return S(a.children,i)}}function f(r){const e=[];return P(r.navigation,"",0,void 0,e),e}function P(r,e,n,i,a){for(const o of r){const s=e?`${e}/${o.slug}`:o.slug;a.push({...o,path:s,depth:n,parentPath:i}),o.children&&o.children.length>0&&P(o.children,s,n+1,s,a)}}function L(r,e){const n=e.split("/").filter(Boolean),i=[];let a=r.navigation,o="";for(const s of n){const c=a.find(j=>j.slug===s);if(!c)break;o=o?`${o}/${s}`:s,i.push({title:c.title,slug:c.slug,path:o}),a=c.children??[]}return i}function F(r){return f(r).filter(e=>e.file!==void 0)}function A(r,e){const n=F(r),i=n.findIndex(a=>a.path===e);return i===-1?{}:{prev:i>0?n[i-1]:void 0,next:i<n.length-1?n[i+1]:void 0}}function $(r,e){const n=e.split("/").filter(Boolean);if(n.length===0)return!1;if(r.slug===n[0]){if(n.length===1)return!0;if(r.children){const i=n.slice(1).join("/");return r.children.some(a=>$(a,i))}}return!1}function C(r,e){return f(r).filter(n=>n.depth===e)}exports.BreadcrumbItemSchema=w;exports.DocPageMetaSchema=m;exports.DocPageSchema=x;exports.DocsPackageManifestSchema=u;exports.FlatNavigationNodeSchema=E;exports.FrontmatterParseError=l;exports.GitHubConfigSchema=v;exports.LoadedDocsPackageSchema=M;exports.ManifestValidationError=N;exports.NavigationNodeSchema=g;exports.SearchConfigSchema=p;exports.VendureVersionSchema=z;exports.buildBreadcrumbs=L;exports.extractFrontmatterData=B;exports.findNavigationNode=I;exports.flattenNavigation=f;exports.getLeafNodes=F;exports.getNodesAtDepth=C;exports.getPrevNextNodes=A;exports.hasFrontmatter=V;exports.isNodeActive=$;exports.parseFrontmatter=k;exports.validateFrontmatter=b;exports.validateManifest=q;