@qualcomm-ui/mdx-vite 2.5.4 → 2.6.1

package/dist/docs-plugin/internal/config-schema.d.ts

@@ -9,6 +9,7 @@ export declare const configSchema: z.ZodObject<{
     hotUpdateIgnore: z.ZodOptional<z.ZodType<RegExp, z.ZodTypeDef, RegExp>>;
     navConfig: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodType<RouteMeta, z.ZodTypeDef, RouteMeta>, z.ZodObject<{}, z.UnknownKeysParam, z.ZodTypeAny, {}, {}>]>, "many">>;
     pageDirectory: z.ZodOptional<z.ZodString>;
+    pageTimestampMetadata: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"off">, z.ZodLiteral<"timestamp">, z.ZodLiteral<"user-and-timestamp">]>>;
     routingStrategy: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"vite-generouted">, z.ZodFunction<z.ZodTuple<[z.ZodString], null>, z.ZodArray<z.ZodString, "many">>]>>;
     typeDocProps: z.ZodOptional<z.ZodString>;
     typeDocPropsOptions: z.ZodOptional<z.ZodObject<{
@@ -24,6 +25,7 @@ export declare const configSchema: z.ZodObject<{
     disableCache?: boolean | undefined;
     headings?: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[] | undefined;
     navConfig?: (RouteMeta | {})[] | undefined;
+    pageTimestampMetadata?: "off" | "timestamp" | "user-and-timestamp" | undefined;
     routingStrategy?: "vite-generouted" | ((args_0: string) => string[]) | undefined;
     typeDocPropsOptions?: {
         includeInSearchIndex?: boolean | undefined;
@@ -36,6 +38,7 @@ export declare const configSchema: z.ZodObject<{
     disableCache?: boolean | undefined;
     headings?: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[] | undefined;
     navConfig?: (RouteMeta | {})[] | undefined;
+    pageTimestampMetadata?: "off" | "timestamp" | "user-and-timestamp" | undefined;
     routingStrategy?: "vite-generouted" | ((args_0: string) => string[]) | undefined;
     typeDocPropsOptions?: {
         includeInSearchIndex?: boolean | undefined;

package/dist/docs-plugin/internal/config-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-schema.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/config-schema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,CAAC,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAErD,OAAO,KAAK,EAIV,SAAS,EACV,MAAM,UAAU,CAAA;AAIjB,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,EAAE,CAItC,CAAA;AAEF,eAAO,MAAM,eAAe,EAAE,SAAS,CAAC,SAAS,CAmB7C,CAAA;AAMJ,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0BvB,CAAA"}
+{"version":3,"file":"config-schema.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/config-schema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,CAAC,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAErD,OAAO,KAAK,EAIV,SAAS,EACV,MAAM,UAAU,CAAA;AAIjB,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,EAAE,CAItC,CAAA;AAEF,eAAO,MAAM,eAAe,EAAE,SAAS,CAAC,SAAS,CAmB7C,CAAA;AAMJ,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiCvB,CAAA"}

package/dist/docs-plugin/internal/search-indexer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search-indexer.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/search-indexer.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,OAAO,EAEP,OAAO,EACP,WAAW,EACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,OAAO,KAAK,EAGV,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAEjB,OAAO,EACL,KAAK,eAAe,EAEpB,eAAe,EAQf,kBAAkB,EAClB,eAAe,EACf,UAAU,EACX,MAAM,YAAY,CAAA;AAInB,qBAAa,aAAa;IA4Cf,MAAM,EAAE,oBAAoB;IAC5B,WAAW;IA5CpB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAa;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA2C;IAExE,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,IAAI,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAE/D;IACD,OAAO,CAAC,aAAa,CAAmD;IAExE,IAAI,YAAY,IAAI,MAAM,CAEzB;IACD,OAAO,CAAC,aAAa,CAAY;IAEjC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAExB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IACD,OAAO,CAAC,QAAQ,CAAc;IAE9B,IAAI,WAAW,IAAI,WAAW,EAAE,CAE/B;IACD,OAAO,CAAC,YAAY,CAAoB;IAExC,KAAK,IAAI,IAAI;gBAOJ,MAAM,EAAE,oBAAoB,EAC5B,WAAW,UAAO,EAEzB,MAAM,GAAE;QACN,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,SAAS,CAAC,EAAE,kBAAkB,CAAA;QAC9B,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,UAAU,CAAC,EAAE,UAAU,CAAA;KACnB;IAwBR;;;OAGG;IACH,OAAO,CAAC,YAAY;IA4DpB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAiHtB,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,cAAc;IAqBtB,UAAU,CACR,aAAa,EAAE,MAAM,EAAE,EACvB,WAAW,GAAE,OAAc,GAC1B,eAAe,EAAE;CAmCrB"}
+{"version":3,"file":"search-indexer.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/search-indexer.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,OAAO,EAEP,OAAO,EACP,WAAW,EACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,OAAO,KAAK,EAGV,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAEjB,OAAO,EACL,KAAK,eAAe,EAEpB,eAAe,EAQf,kBAAkB,EAClB,eAAe,EACf,UAAU,EACX,MAAM,YAAY,CAAA;AAInB,qBAAa,aAAa;IA4Cf,MAAM,EAAE,oBAAoB;IAC5B,WAAW;IA5CpB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAa;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA2C;IAExE,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,IAAI,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAE/D;IACD,OAAO,CAAC,aAAa,CAAmD;IAExE,IAAI,YAAY,IAAI,MAAM,CAEzB;IACD,OAAO,CAAC,aAAa,CAAY;IAEjC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAExB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IACD,OAAO,CAAC,QAAQ,CAAc;IAE9B,IAAI,WAAW,IAAI,WAAW,EAAE,CAE/B;IACD,OAAO,CAAC,YAAY,CAAoB;IAExC,KAAK,IAAI,IAAI;gBAOJ,MAAM,EAAE,oBAAoB,EAC5B,WAAW,UAAO,EAEzB,MAAM,GAAE;QACN,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,SAAS,CAAC,EAAE,kBAAkB,CAAA;QAC9B,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,UAAU,CAAC,EAAE,UAAU,CAAA;KACnB;IAyBR;;;OAGG;IACH,OAAO,CAAC,YAAY;IA8DpB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAiHtB,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,cAAc;IAqBtB,UAAU,CACR,aAAa,EAAE,MAAM,EAAE,EACvB,WAAW,GAAE,OAAc,GAC1B,eAAe,EAAE;CAmCrB"}

package/dist/docs-plugin/internal/services/markdown/markdown-file-reader.d.ts

@@ -1,6 +1,17 @@
 import type { PageFrontmatter } from "@qualcomm-ui/mdx-common";
 import type { QuiPropTypes } from "@qualcomm-ui/typedoc-common";
+import type { PageTimestampMetadataMode } from "../../../types";
 import type { IndexedPage, IndexedSection } from "./markdown.types";
+export interface GitMetadata {
+    updatedBy?: string;
+    updatedOn?: string;
+}
+/**
+ * Gets the last git commit metadata for a file.
+ * Returns undefined values if the file is not tracked by git or if git is
+ * unavailable.
+ */
+export declare function getGitMetadata(filePath: string, mode: PageTimestampMetadataMode): GitMetadata;
 interface PageCache {
     frontmatter: PageFrontmatter;
     md5: string;
@@ -10,10 +21,11 @@ interface PageCache {
 }
 export declare class MarkdownFileReader {
     enabled: boolean;
+    pageTimestampMetadata: PageTimestampMetadataMode;
     cachedFileCount: number;
     logWarnings: boolean;
     private mdxCache;
-    constructor(enabled: boolean);
+    constructor(enabled: boolean, pageTimestampMetadata?: PageTimestampMetadataMode);
     private hash;
     reset(): void;
     readCache(filePath: string): PageCache | null;

package/dist/docs-plugin/internal/services/markdown/markdown-file-reader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown-file-reader.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/markdown/markdown-file-reader.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAI7D,OAAO,KAAK,EAAC,WAAW,EAAE,cAAc,EAAC,MAAM,kBAAkB,CAAA;AAEjE,UAAU,SAAS;IACjB,WAAW,EAAE,eAAe,CAAA;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,WAAW,CAAA;IACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAC1C,mBAAmB,EAAE,cAAc,EAAE,CAAA;CACtC;AAED,qBAAa,kBAAkB;IAKV,OAAO,EAAE,OAAO;IAJnC,eAAe,SAAI;IACnB,WAAW,UAAO;IAClB,OAAO,CAAC,QAAQ,CAAgC;gBAE7B,OAAO,EAAE,OAAO;IAEnC,OAAO,CAAC,IAAI;IAIZ,KAAK,IAAI,IAAI;IAIb,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAI7C,OAAO,CAAC,UAAU;IAyBlB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG;QAC1B,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,GAAG,SAAS,CAAA;QAC1C,YAAY,EAAE,MAAM,CAAA;QACpB,WAAW,EAAE,eAAe,CAAA;KAC7B;IAuDD,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,GAChC,IAAI;CAKR"}
+{"version":3,"file":"markdown-file-reader.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/markdown/markdown-file-reader.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,OAAO,KAAK,EAAC,yBAAyB,EAAC,MAAM,gBAAgB,CAAA;AAG7D,OAAO,KAAK,EAAC,WAAW,EAAE,cAAc,EAAC,MAAM,kBAAkB,CAAA;AAEjE,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAQD;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,yBAAyB,GAC9B,WAAW,CA+Bb;AAED,UAAU,SAAS;IACjB,WAAW,EAAE,eAAe,CAAA;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,WAAW,CAAA;IACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAC1C,mBAAmB,EAAE,cAAc,EAAE,CAAA;CACtC;AAED,qBAAa,kBAAkB;IAMpB,OAAO,EAAE,OAAO;IAChB,qBAAqB,EAAE,yBAAyB;IANzD,eAAe,SAAI;IACnB,WAAW,UAAO;IAClB,OAAO,CAAC,QAAQ,CAAgC;gBAGvC,OAAO,EAAE,OAAO,EAChB,qBAAqB,GAAE,yBAAiC;IAGjE,OAAO,CAAC,IAAI;IAIZ,KAAK,IAAI,IAAI;IAIb,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAI7C,OAAO,CAAC,UAAU;IAyBlB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG;QAC1B,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,GAAG,SAAS,CAAA;QAC1C,YAAY,EAAE,MAAM,CAAA;QACpB,WAAW,EAAE,eAAe,CAAA;KAC7B;IAiED,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,GAChC,IAAI;CAKR"}

package/dist/docs-plugin/internal/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAI,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAMrC,eAAO,MAAM,SAAS,GACpB,OAAO,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,KAC3D,OAAyD,CAAA;AAE5D,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,CAAC,CAElE;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAcxC,CAAA;AAEJ;;GAEG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvD"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAI,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAMrC,eAAO,MAAM,SAAS,GACpB,OAAO,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,KAC3D,OAAyD,CAAA;AAE5D,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,CAAC,CAElE;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAgBxC,CAAA;AAEJ;;GAEG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvD"}

package/dist/docs-plugin/types.d.ts

@@ -1,6 +1,13 @@
 import type { PageFrontmatter, TocHeading } from "@qualcomm-ui/mdx-common";
 import type { QuiPropTypes } from "@qualcomm-ui/typedoc-common";
 export type RoutingStrategy = "vite-generouted" | ((filePath: string) => string[]);
+/**
+ * Controls how page timestamp metadata is populated from git history.
+ * - "off": No timestamp data is added
+ * - "timestamp": Only `updatedOn` is populated
+ * - "user-and-timestamp": Both `updatedOn` and `updatedBy` are populated
+ */
+export type PageTimestampMetadataMode = "off" | "timestamp" | "user-and-timestamp";
 /**
  * Side nav item data.
  */
@@ -117,6 +124,12 @@ export interface SearchIndexerOptions {
      * directory.
      */
     pageDirectory: string;
+    /**
+     * Controls how page timestamp metadata is populated from git history.
+     *
+     * @default "off"
+     */
+    pageTimestampMetadata?: PageTimestampMetadataMode;
     /**
      * Strategy to use for building each route's path segments.  Omit this property if
      * you are using the default {@link https://github.com/kiliman/remix-flat-routes

package/dist/docs-plugin/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,eAAe,EAAE,UAAU,EAAC,MAAM,yBAAyB,CAAA;AACxE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC,CAAA;AAEpC;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,CAAC,EAAE,KAAK,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,sBACf,SAAQ,IAAI,CACV,eAAe,EACb,OAAO,GACP,SAAS,GACT,aAAa,GACb,gBAAgB,GAChB,iBAAiB,GACjB,eAAe,GACf,QAAQ,GACR,cAAc,CACjB;IACD;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAA;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;AAEtE,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;AAE3C,MAAM,WAAW,SACf,SAAQ,IAAI,CAAC,sBAAsB,EAAE,UAAU,GAAG,OAAO,CAAC;IAC1D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;IAEtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC3C;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAA;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,EAAE,CAAA;IAEvB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAA;IAEjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAE3C;;OAEG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAA;CAC5C;AAED,MAAM,WAAW,aACf,SAAQ,IAAI,CACV,oBAAoB,EACpB,QAAQ,GAAG,eAAe,GAAG,cAAc,CAC5C;IACD;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAA;CAC5C"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,eAAe,EAAE,UAAU,EAAC,MAAM,yBAAyB,CAAA;AACxE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC,CAAA;AAEpC;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GACjC,KAAK,GACL,WAAW,GACX,oBAAoB,CAAA;AAExB;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,CAAC,EAAE,KAAK,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,sBACf,SAAQ,IAAI,CACV,eAAe,EACb,OAAO,GACP,SAAS,GACT,aAAa,GACb,gBAAgB,GAChB,iBAAiB,GACjB,eAAe,GACf,QAAQ,GACR,cAAc,CACjB;IACD;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAA;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;AAEtE,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;AAE3C,MAAM,WAAW,SACf,SAAQ,IAAI,CAAC,sBAAsB,EAAE,UAAU,GAAG,OAAO,CAAC;IAC1D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;IAEtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC3C;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAA;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,EAAE,CAAA;IAEvB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,yBAAyB,CAAA;IAEjD;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAA;IAEjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAE3C;;OAEG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAA;CAC5C;AAED,MAAM,WAAW,aACf,SAAQ,IAAI,CACV,oBAAoB,EACpB,QAAQ,GAAG,eAAe,GAAG,cAAc,CAC5C;IACD;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAA;CAC5C"}

package/dist/index.js

@@ -6,7 +6,7 @@ import { watch } from "chokidar";
 import { glob as glob2 } from "glob";
 import { existsSync } from "node:fs";
 import { readFile as readFile2, stat } from "node:fs/promises";
-import { basename, dirname, join as join2, relative, resolve as resolve2 } from "node:path";
+import { basename, dirname, join as join2, relative as relative2, resolve as resolve2 } from "node:path";
 import {
   createHighlighter
 } from "shiki";
@@ -82,6 +82,11 @@ var configSchema = implement().with({
   hotUpdateIgnore: z2.instanceof(RegExp).optional(),
   navConfig: z2.array(z2.union([routeMetaSchema, navMetaSchema])).optional(),
   pageDirectory: z2.string().optional(),
+  pageTimestampMetadata: z2.union([
+    z2.literal("off"),
+    z2.literal("timestamp"),
+    z2.literal("user-and-timestamp")
+  ]).optional(),
   routingStrategy: z2.union([
     z2.literal("vite-generouted"),
     z2.function(z2.tuple([z2.string()]), z2.array(z2.string()))
@@ -107,7 +112,9 @@ var frontmatterSchema = implement().with({
   id: z3.string().optional(),
   restricted: z3.boolean().optional(),
   sideNavTitle: z3.string().optional(),
-  title: z3.string()
+  title: z3.string(),
+  updatedBy: z3.string().optional(),
+  updatedOn: z3.string().optional()
 });
 function fixPath(str) {
   return str.replaceAll("\\", "/");
@@ -383,16 +390,52 @@ var DocPropsIndexer = class {
 
 // src/docs-plugin/internal/services/markdown/markdown-file-reader.ts
 import chalk from "chalk";
+import { execSync } from "node:child_process";
 import { createHash } from "node:crypto";
 import { readFileSync } from "node:fs";
+import { relative } from "node:path";
 import remarkFrontmatter from "remark-frontmatter";
 import remarkParse2 from "remark-parse";
 import remarkParseFrontmatter from "remark-parse-frontmatter";
 import remarkStringify2 from "remark-stringify";
 import { unified as unified2 } from "unified";
+function getRepoRoot() {
+  return execSync("git rev-parse --show-toplevel", {
+    encoding: "utf-8"
+  }).trim();
+}
+function getGitMetadata(filePath, mode) {
+  if (mode === "off") {
+    return {};
+  }
+  try {
+    const repoRoot = getRepoRoot();
+    const relativePath = relative(repoRoot, filePath);
+    const format = mode === "user-and-timestamp" ? "%cI%n%aN" : "%cI";
+    const result = execSync(
+      `git log -1 --format=${format} -- "${relativePath}"`,
+      {
+        cwd: repoRoot,
+        encoding: "utf-8",
+        stdio: ["pipe", "pipe", "pipe"]
+      }
+    ).trim();
+    if (!result) {
+      return {};
+    }
+    if (mode === "user-and-timestamp") {
+      const [updatedOn, updatedBy] = result.split("\n");
+      return { updatedBy, updatedOn };
+    }
+    return { updatedOn: result };
+  } catch {
+    return {};
+  }
+}
 var MarkdownFileReader = class {
-  constructor(enabled) {
+  constructor(enabled, pageTimestampMetadata = "off") {
     this.enabled = enabled;
+    this.pageTimestampMetadata = pageTimestampMetadata;
   }
   cachedFileCount = 0;
   logWarnings = true;
@@ -458,6 +501,15 @@ var MarkdownFileReader = class {
         console.debug(`- ${issue.path.join(".")}`);
       });
     }
+    if (!frontmatter.updatedOn || !frontmatter.updatedBy) {
+      const gitMetadata = getGitMetadata(filepath, this.pageTimestampMetadata);
+      if (!frontmatter.updatedOn && gitMetadata.updatedOn) {
+        frontmatter.updatedOn = gitMetadata.updatedOn;
+      }
+      if (!frontmatter.updatedBy && gitMetadata.updatedBy) {
+        frontmatter.updatedBy = gitMetadata.updatedBy;
+      }
+    }
     return { cached, fileContents, frontmatter };
   }
   updateCache(filepath, fileContents, cacheData) {
@@ -1414,7 +1466,8 @@ var SearchIndexer = class {
     this.navBuilder = addons.navBuilder || new NavBuilder(this.metaJson, this.routeMetaNav);
     this.docPropsIndexer = addons.docPropsIndexer || new DocPropsIndexer(this.config.typeDocProps ?? {});
     this.fileCache = addons.fileCache || new MarkdownFileReader(
-      process.env.NODE_ENV === "development" && !this.config.disableCache
+      process.env.NODE_ENV === "development" && !this.config.disableCache,
+      this.config.pageTimestampMetadata
     );
   }
   docPropsIndexer;
@@ -1483,7 +1536,9 @@ var SearchIndexer = class {
       pathname,
       pathSegments,
       restricted: defined(routeMeta.restricted) ? routeMeta.restricted : frontmatter.restricted,
-      title: defined(routeMeta.title) ? routeMeta.title || "" : frontmatter.title || ""
+      title: defined(routeMeta.title) ? routeMeta.title || "" : frontmatter.title || "",
+      updatedBy: frontmatter.updatedBy,
+      updatedOn: frontmatter.updatedOn
     };
   }
   /**
@@ -3259,7 +3314,7 @@ function angularDemoPlugin({
         return null;
       }
       const demoId = componentClass;
-      const importPath = relative(process.cwd(), filePath).replace(/\\/g, "/");
+      const importPath = relative2(process.cwd(), filePath).replace(/\\/g, "/");
       const fileName = basename(filePath);
       const importsWithoutStrip = stripImports(code, filePath);
       const sourceCode = [];
@@ -3808,7 +3863,7 @@ var NODE_BUILTINS = [
 import chalk5 from "chalk";
 import { existsSync as existsSync2, readFileSync as readFileSync3 } from "node:fs";
 import { readFile as readFile3 } from "node:fs/promises";
-import { dirname as dirname2, join as join3, relative as relative2, resolve as resolve3, sep } from "node:path";
+import { dirname as dirname2, join as join3, relative as relative3, resolve as resolve3, sep } from "node:path";
 import * as ts2 from "typescript";
 import { pascalCase } from "@qualcomm-ui/utils/change-case";
 function createDemoName(filePath) {
@@ -4082,7 +4137,7 @@ function resolvePathAlias2(source, pathAliases) {
   return null;
 }
 function extractPageId(filePath, routesDir) {
-  const relativePath = relative2(routesDir, filePath);
+  const relativePath = relative3(routesDir, filePath);
   const pathParts = relativePath.split(sep);
   if (pathParts.includes("demos")) {
     const demosIndex = pathParts.indexOf("demos");