@cdmbase/wiki-browser 12.0.18-alpha.5

package/lib/templates/content/docs/tests/test-setup.md

@@ -0,0 +1,93 @@
+---
+meta:
+    title: Test Setup
+    description: Test Setup
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Test Setup...
+headers:
+    Cache-Control: no-cache
+---
+
+## Test Setup
+
+## Jest Configuration
+
+There is base jest configuration in the root folder as `jest.config.base.js`. All other packages need to extend this base jest configuration and customize the path so they relative to the package location.
+
+for example in package
+`package/sample-core`
+
+`jest.config.js` file content has
+
+```
+const merge = require('merge')
+const baseConfig = require('../../jest.config.base');
+const mergeData = merge.recursive(
+    baseConfig,
+    {
+        testEnvironment: "jsdom",
+        "transform": {
+            "\\.(js|jsx)?$": "../../transform.js",
+        },
+        moduleNameMapper: {
+            // '^__mocks__/(.*)$': '<rootDir>/../__mocks__/$1',
+            // we'll use commonjs version of lodash for tests 👌
+            // because we don't need to use any kind of tree shaking right?!
+            '^lodash-es$': '<rootDir>../../node_modules/lodash/index.js'
+        },
+        roots: [
+            "src"
+        ],
+    },
+    {
+        globals: {
+
+        }
+    });
+
+module.exports = mergeData;
+```
+
+It extends the base jest configuration and add customize `transform` path relative to the package directory. Set `testEnvironment` to `jsdom` for browser testing and to `node` for node tests.
+
+Check the `package.json` both in the root and packages have path to the environment file. For example
+
+```
+   // from packages
+    "test": "cross-env ENV_FILE=../../../config/test/test.env yarn jest",
+
+```
+
+## Test case
+
+Add following two lines in all test cases where we using `inversify` and `envalid` in the files we testing or somewhere in its dependencies.
+
+```
+import 'reflect-metadata';
+require('dotenv').config({ path: process.env.ENV_FILE });
+```
+
+## Commands
+
+Command to run `test` in all packages
+
+```
+yarn jest
+```
+
+Command to run `test` on a specific packages
+
+```
+lerna exec --scope <package-name> yarn test
+```
+
+Run test on a specific file
+
+```
+lerna exec --scope <package-name> yarn test <file-name.test>
+```
+
+### Known Issues
+
+[Click here for know issues](./known-errors.md)

package/lib/templates/content/docs/xstate.md

@@ -0,0 +1,23 @@
+---
+meta:
+    title: Xstate
+    description: Xstate
+date: '2023-06-02T00:00:00'
+updated: '2024-06-02T00:00:00'
+excerpt: Xstate...
+headers:
+    Cache-Control: no-cache
+---
+
+## Xstate
+
+for example we name actions in such a way that common one are shared ...
+
+`updateXXXX` -> updates the context, uses assign function
+
+`saveXXXX` -> Save to database; it is unique to server and client
+
+`handleXXX` -> it is some third party calls, it is unique to server and client
+
+and we have context `processing` this is where changes that need for next action dependency.
+For example we need to save some updates to reservation will be saved as `processing.changesToSave` and if action sequence has saveToDatabase then it will look for it and save.

package/lib/types.d.ts

@@ -0,0 +1,37 @@
+export type BlogPost = {
+    attributes: BlogPostAttributes;
+    body: string;
+    url: string;
+};
+export type BlogPostAttributes = {
+    meta: {
+        [key: string]: string;
+    };
+    headers: {
+        [key: string]: string;
+    };
+    date: string;
+    hero: string;
+    excerpt: string;
+};
+export type FrontMatterBlogPost = {
+    attributes: BlogPostAttributes;
+    body: string;
+};
+export type NonNullProperties<Type> = {
+    [Key in keyof Type]-?: Exclude<Type[Key], null | undefined>;
+};
+export type SitemapEntry = {
+    route: string;
+    lastmod?: string;
+    changefreq?: 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
+    priority?: 0.0 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1.0;
+};
+export type Handle = {
+    /** this just allows us to identify routes more directly rather than relying on pathnames */
+    id?: string;
+    /** this is here to allow us to disable scroll restoration until Remix gives us better control */
+    restoreScroll?: false;
+    getSitemapEntries?: (request: Request) => Promise<Array<SitemapEntry | null> | null> | Array<SitemapEntry | null> | null;
+};
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,QAAQ,GAAG;IACtB,UAAU,EAAE,kBAAkB,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KACrB,CAAA;IACD,OAAO,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KACrB,CAAA;IACD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IACjC,UAAU,EAAE,kBAAkB,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,IAAI,IAAI;KACnC,GAAG,IAAI,MAAM,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC5D,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EACP,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,OAAO,CAAA;IACX,QAAQ,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;CAC3E,CAAA;AAEH,MAAM,MAAM,MAAM,GAAG;IACjB,4FAA4F;IAC5F,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,iGAAiG;IACjG,aAAa,CAAC,EAAE,KAAK,CAAA;IACrB,iBAAiB,CAAC,EAAE,CAClB,OAAO,EAAE,OAAO,KAEd,OAAO,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAC1C,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,GAC1B,IAAI,CAAA;CACT,CAAA"}

package/lib/utils/docsNavigation.d.ts

@@ -0,0 +1,9 @@
+export interface NavItem {
+    title: string;
+    path: string;
+    children?: NavItem[];
+    isFile: boolean;
+}
+export declare function buildDocsNavigation(): NavItem[];
+export declare function getDocsNavigation(): NavItem[];
+//# sourceMappingURL=docsNavigation.d.ts.map

package/lib/utils/docsNavigation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsNavigation.d.ts","sourceRoot":"","sources":["../../src/utils/docsNavigation.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,OAAO;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACnB;AAGD,wBAAgB,mBAAmB,IAAI,OAAO,EAAE,CA+B/C;AAKD,wBAAgB,iBAAiB,IAAI,OAAO,EAAE,CAK7C"}

package/lib/utils/docsNavigation.js

@@ -0,0 +1,37 @@
+import {getAllCategoriesMetadata}from'./markdownLoader.js';// Utility to build navigation tree from category metadata (not folder structure)
+// Build navigation tree from category metadata
+function buildDocsNavigation() {
+  const categories = getAllCategoriesMetadata();
+  const navItems = [];
+  for (const category of categories) {
+    // Create category node
+    const categoryItem = {
+      title: category.title,
+      path: `/help/${category.id}`,
+      children: [],
+      isFile: false
+    };
+    // Create a flat list of articles under each category
+    // Path format: /help/:categoryId/:slug (e.g., /help/adminide-modules/adminide-modules-account-auth0-login)
+    const articleItems = category.articles.map(article => ({
+      title: article.title,
+      path: `/help/${category.id}/${article.slug}`,
+      children: [],
+      isFile: true
+    }));
+    // If there are articles, add them as children
+    if (articleItems.length > 0) {
+      categoryItem.children = articleItems;
+    }
+    navItems.push(categoryItem);
+  }
+  return navItems;
+}
+// Get navigation tree (cached)
+let cachedNavigation = null;
+function getDocsNavigation() {
+  if (!cachedNavigation) {
+    cachedNavigation = buildDocsNavigation();
+  }
+  return cachedNavigation;
+}export{buildDocsNavigation,getDocsNavigation};//# sourceMappingURL=docsNavigation.js.map

package/lib/utils/docsNavigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsNavigation.js","sources":["../../src/utils/docsNavigation.ts"],"sourcesContent":[null],"names":[],"mappings":"2DAAA;AAWA;SACgB,mBAAmB,GAAA;AAC/B,EAAA,MAAA,UAAgB,GAAA,wBAA2B,EAAA;QACrC,QAAA,GAAsB,EAAA;AAE5B,EAAA,KAAA,MAAW,QAAA,IAAY,UAAA,EAAU;;AAE7B,IAAA,MAAA;aACS,QAAU,CAAA,KAAA;AACf,MAAA,IAAA,EAAA,CAAA,MAAM,EAAA,QAAiB,CAAA,EAAA,CAAA,CAAA;AACvB,MAAA,QAAA,EAAA,EAAA;AACA,MAAA,MAAA,EAAA;;;;AAKJ,IAAA,MAAA,YAAkB,GAAA,QAAsB,CAAA,QAAS,CAAA,GAAA,CAAC,OAAK,KAAgB;aAC9D,OAAS,CAAA,KAAA;YACd,CAAI,gBAAmB,CAAA,EAAA,CAAA,CAAA,EAAC,OAAM,CAAA,IAAA,CAAO,CAAC;AACtC,MAAA,QAAA,EAAA,EAAA;AACA,MAAA,MAAA,EAAA;AACH,KAAA,CAAA,CAAA;;AAGD,IAAA,IAAA,mBAAiB,GAAA,CAAM,EAAG;AACtB,MAAA,YAAA,CAAA,QAAa,GAAA,YAAW;;AAG5B,IAAA,QAAA,CAAA,IAAS,CAAA,YAAK,CAAA;;AAGlB,EAAA,OAAA;AACJ;AAEA;AACA,IAAI,gBAAgB,GAAqB,IAAI;SAE7B,iBAAiB,GAAA;MACzB,CAAA,gBAAiB,EAAA;oBACD,GAAA,mBAAsB,EAAA;;AAE1C,EAAA,OAAA;AACJ"}

package/lib/utils/helpCenterUtils.d.ts

@@ -0,0 +1,26 @@
+export interface Article {
+    id: string;
+    title: string;
+    description: string;
+    slug: string;
+    author: string;
+    updatedAt: string;
+    content: string;
+    categoryId: string;
+}
+export interface Category {
+    id: string;
+    title: string;
+    description: string;
+    iconType: string;
+    articles: Article[];
+}
+export declare const generateRoutes: (categories: Category[]) => string[];
+export declare const getCategoryById: (categoryId: string, categories: Category[]) => Category | null;
+export declare const getArticleBySlug: (articleSlug: string, categories: Category[]) => Article | null;
+export declare const getArticlesByCategory: (categoryId: string, categories: Category[]) => Article[];
+export declare const generateBreadcrumbs: (categoryId: string, categories: Category[], articleSlug?: string) => {
+    label: string;
+    path: string;
+}[];
+//# sourceMappingURL=helpCenterUtils.d.ts.map

package/lib/utils/helpCenterUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpCenterUtils.d.ts","sourceRoot":"","sources":["../../src/utils/helpCenterUtils.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACvB;AAGD,eAAO,MAAM,cAAc,GAAI,YAAY,QAAQ,EAAE,aAcpD,CAAC;AAGF,eAAO,MAAM,eAAe,GAAI,YAAY,MAAM,EAAE,YAAY,QAAQ,EAAE,KAAG,QAAQ,GAAG,IAEvF,CAAC;AAGF,eAAO,MAAM,gBAAgB,GAAI,aAAa,MAAM,EAAE,YAAY,QAAQ,EAAE,KAAG,OAAO,GAAG,IAMxF,CAAC;AAGF,eAAO,MAAM,qBAAqB,GAAI,YAAY,MAAM,EAAE,YAAY,QAAQ,EAAE,KAAG,OAAO,EAGzF,CAAC;AAGF,eAAO,MAAM,mBAAmB,GAAI,YAAY,MAAM,EAAE,YAAY,QAAQ,EAAE,EAAE,cAAc,MAAM;;;GAsBnG,CAAC"}

package/lib/utils/index.d.ts

@@ -0,0 +1,3 @@
+import { type ClassValue } from 'clsx';
+export declare function cn(...inputs: ClassValue[]): string;
+//# sourceMappingURL=index.d.ts.map

package/lib/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,UAAU,EAAE,MAAM,MAAM,CAAC;AAG7C,wBAAgB,EAAE,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,UAEzC"}

package/lib/utils/index.js

@@ -0,0 +1,3 @@
+import {clsx}from'clsx';import {twMerge}from'tailwind-merge';function cn(...inputs) {
+  return twMerge(clsx(inputs));
+}export{cn};//# sourceMappingURL=index.js.map

package/lib/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/utils/index.ts"],"sourcesContent":[null],"names":[],"mappings":"6DAGgB,SAAA,EAAE,CAAC,GAAG,MAAoB,EAAA;AACtC,EAAA,OAAA,YAAe,CAAA,MAAW,CAAA,CAAA;AAC9B"}

package/lib/utils/markdownLoader.d.ts

@@ -0,0 +1,36 @@
+export interface ArticleMetadata {
+    id: string;
+    title: string;
+    description: string;
+    slug: string;
+    author: string;
+    updatedAt: string;
+    categoryId: string;
+}
+export interface Heading {
+    id: string;
+    text: string;
+    level: number;
+}
+export interface Article extends ArticleMetadata {
+    content: string;
+    htmlContent: string;
+    headings: Heading[];
+}
+export interface Category {
+    id: string;
+    title: string;
+    description: string;
+    iconType: string;
+    articles: Article[];
+}
+export declare const getAllCategoriesMetadata: () => Category[];
+export declare const getCategoryById: (categoryId: string) => Category | null;
+export declare const getArticleBySlug: (articleSlug: string) => Article | null;
+export declare const loadArticleContent: (articleSlug: string) => Promise<Article | null>;
+export declare const loadDocContent: (docSlug: string) => Promise<Article | null>;
+export declare const loadBlogContent: (blogSlug: string) => Promise<Article | null>;
+export declare const parseMarkdownToHtml: (markdownContent: string) => string;
+export declare const searchArticles: (query: string) => Article[];
+export declare const getAllArticles: () => Article[];
+//# sourceMappingURL=markdownLoader.d.ts.map

package/lib/utils/markdownLoader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdownLoader.d.ts","sourceRoot":"","sources":["../../src/utils/markdownLoader.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,OAAQ,SAAQ,eAAe;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACvB;AAy3ED,eAAO,MAAM,wBAAwB,QAAO,QAAQ,EAEnD,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,YAAY,MAAM,KAAG,QAAQ,GAAG,IAE/D,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,aAAa,MAAM,KAAG,OAAO,GAAG,IAMhE,CAAC;AA6CF,eAAO,MAAM,kBAAkB,GAAU,aAAa,MAAM,KAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAuBpF,CAAC;AAGF,eAAO,MAAM,cAAc,GAAU,SAAS,MAAM,KAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAqD5E,CAAC;AAGF,eAAO,MAAM,eAAe,GAAU,UAAU,MAAM,KAAG,OAAO,CAAC,OAAO,GAAG,IAAI,CAwD9E,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,iBAAiB,MAAM,KAAG,MAE7D,CAAC;AAGF,eAAO,MAAM,cAAc,GAAI,OAAO,MAAM,KAAG,OAAO,EA+CrD,CAAC;AAGF,eAAO,MAAM,cAAc,QAAO,OAAO,EAMxC,CAAC"}