@mintlify/common 1.0.1329 → 1.0.1331

package/dist/databases/formula/lower.js

@@ -28,6 +28,7 @@ const KINDS = {
     url: 'text',
     email: 'text',
     person: 'text',
+    page: 'text',
     number: 'number',
     boolean: 'boolean',
     date: 'date',

package/dist/databases/formula/schema.js

@@ -6,6 +6,7 @@ const STORED_TYPES = {
     text: STRING,
     url: STRING,
     email: STRING,
+    page: STRING,
     select: STRING,
     multi_select: STRING,
     json: STRING,

package/dist/databases/formula/values.js

@@ -1,4 +1,4 @@
-import { normalizeDate } from '../query/values.js';
+import { normalizeDate, pageTitle } from '../query/values.js';
 import { isFormulaError } from './errors.js';
 const isValidDate = (value) => value instanceof Date && !Number.isNaN(value.getTime());
 const formatNumber = (value) => {
@@ -85,6 +85,8 @@ export const cellReader = (column, options) => {
         case 'email':
         case 'person':
             return toText;
+        case 'page':
+            return pageTitle;
         default:
             return (raw) => raw instanceof Date
                 ? isValidDate(raw)

package/dist/databases/query/evaluate.js

@@ -1,11 +1,12 @@
 import { CLIENT_ONLY, QUERY_LIMITS, } from './types.js';
 import { validateQueryExpr, validateQueryRequest } from './validate.js';
-import { asciiLower, compareCodePoints, normalizeDate } from './values.js';
+import { asciiLower, compareCodePoints, normalizeDate, pageTitle } from './values.js';
 const KINDS = {
     text: 'text',
     url: 'text',
     email: 'text',
     person: 'text',
+    page: 'text',
     number: 'number',
     boolean: 'boolean',
     date: 'date',
@@ -253,7 +254,9 @@ class Compiler {
             id: column.id,
             type: column.type,
             kind,
-            read: (row) => readScalar(kind, row.columns[column.id]),
+            read: column.type === 'page'
+                ? (row) => readScalar(kind, pageTitle(row.columns[column.id]))
+                : (row) => readScalar(kind, row.columns[column.id]),
         };
     }
     operand(expr, path) {

package/dist/databases/query/index.d.ts

@@ -1,4 +1,4 @@
 export { compensatedSum, compileQueryFilter, evaluateQuery, type EvaluateQueryOptions, measureQuery, type QueryError, type QueryResult, type RowPredicate, } from './evaluate.js';
 export * from './types.js';
 export { isValidQueryRequest, validateQueryExpr, validateQueryRequest } from './validate.js';
-export { asciiLower, compareCodePoints, isEmptyValue, normalizeDate } from './values.js';
+export { asciiLower, compareCodePoints, isEmptyValue, normalizeDate, pageTitle } from './values.js';

package/dist/databases/query/index.js

@@ -1,4 +1,4 @@
 export { compensatedSum, compileQueryFilter, evaluateQuery, measureQuery, } from './evaluate.js';
 export * from './types.js';
 export { isValidQueryRequest, validateQueryExpr, validateQueryRequest } from './validate.js';
-export { asciiLower, compareCodePoints, isEmptyValue, normalizeDate } from './values.js';
+export { asciiLower, compareCodePoints, isEmptyValue, normalizeDate, pageTitle } from './values.js';

package/dist/databases/query/values.d.ts

@@ -1,4 +1,5 @@
 export declare const normalizeDate: (value: unknown) => string | null;
+export declare const pageTitle: (value: unknown) => string | null;
 export declare const isEmptyValue: (value: unknown) => boolean;
 export declare const asciiLower: (value: string) => string;
 export declare const compareCodePoints: (a: string, b: string) => -1 | 0 | 1;

package/dist/databases/query/values.js

@@ -13,6 +13,10 @@ export const normalizeDate = (value) => {
     const time = Date.parse(value);
     return valid && !Number.isNaN(time) ? new Date(time).toISOString() : null;
 };
+// A page cell is stored as { pageId, title, href }; filters, sorts and formulas read its title.
+export const pageTitle = (value) => typeof value === 'object' && value !== null && 'title' in value && typeof value.title === 'string'
+    ? value.title
+    : null;
 export const isEmptyValue = (value) => value === null ||
     value === undefined ||
     value === '' ||

package/dist/databases/view.d.ts

@@ -1,14 +1,15 @@
 import { type QuerySort } from './query/types.js';
 export { columnReference } from './formula/format.js';
-export declare const DATABASE_VIEWS: readonly ['table', 'board'];
+export declare const DATABASE_VIEWS: readonly ['table', 'board', 'calendar'];
 export type DatabaseView = (typeof DATABASE_VIEWS)[number];
 export type DatabaseViewProps = {
     view?: string | null;
     sort?: string | null;
     filter?: string | null;
     groupBy?: string | null;
+    calendarBy?: string | null;
 };
-export type DatabaseViewPropChanges = Pick<DatabaseViewProps, 'view' | 'sort' | 'filter' | 'groupBy'>;
+export type DatabaseViewPropChanges = Pick<DatabaseViewProps, 'view' | 'sort' | 'filter' | 'groupBy' | 'calendarBy'>;
 export type DatabaseViewColumn = {
     id: string;
     name: string;
@@ -79,13 +80,18 @@ export type DatabaseViewWarning = {
     kind: 'group_by_unsupported';
     column: string;
     type: string;
+} | {
+    kind: 'calendar_by_unsupported';
+    column: string;
+    type: string;
 };
-export type DatabaseViewPropName = 'sort' | 'filter' | 'groupBy';
+export type DatabaseViewPropName = 'sort' | 'filter' | 'groupBy' | 'calendarBy';
 export type DatabaseFilterKind = 'text' | 'number' | 'select' | 'multi' | 'checkbox' | 'date';
 export declare const filterKindOf: (type: string) => DatabaseFilterKind | null;
 export declare const isViewableColumn: (column: Pick<DatabaseViewColumn, 'type'>) => boolean;
 export declare const isSortableColumn: (column: Pick<DatabaseViewColumn, 'type'>) => boolean;
 export declare const isGroupableColumn: (column: Pick<DatabaseViewColumn, 'type'>) => boolean;
+export declare const isCalendarColumn: (column: Pick<DatabaseViewColumn, 'type'>) => boolean;
 export declare const filterOpsFor: (type: string) => readonly DatabaseFilterOp[];
 export declare const isKnownView: (value: unknown) => value is DatabaseView;
 export declare const resolveView: (value: unknown) => DatabaseView;
@@ -119,11 +125,13 @@ export declare const renameColumnsInViewProps: (props: DatabaseViewProps, rename
 export declare const renameColumnInViewProps: (props: DatabaseViewProps, from: string, to: string) => DatabaseViewPropChanges;
 export declare const aliasRenames: (columns: readonly DatabaseViewColumn[]) => DatabaseColumnRenames;
 export declare const ambiguousAliases: (columns: readonly DatabaseViewColumn[]) => ReadonlySet<string>;
-export type ResolvedGroupBy = {
+export type ResolvedColumnProp = {
     column: DatabaseViewColumn | null;
     warnings: DatabaseViewWarning[];
 };
+export type ResolvedGroupBy = ResolvedColumnProp;
 export declare const resolveGroupBy: (written: string | null | undefined, columns: readonly DatabaseViewColumn[]) => ResolvedGroupBy;
+export declare const resolveCalendarBy: (written: string | null | undefined, columns: readonly DatabaseViewColumn[]) => ResolvedColumnProp;
 export type DatabaseInvalidFilter = 'show-all' | 'hide-all';
 export type ResolveViewOptions = {
     onInvalidFilter?: DatabaseInvalidFilter;
@@ -133,6 +141,7 @@ export type ResolvedDatabaseView = {
     sort: DatabaseSortRule[];
     filter: DatabaseFilter;
     groupBy: string | null;
+    calendarBy: string | null;
     warnings: DatabaseViewWarning[];
     healed: DatabaseViewPropChanges;
     filterSource: string | null;

package/dist/databases/view.js

@@ -9,7 +9,7 @@ import { evaluateQuery } from './query/evaluate.js';
 import { QUERY_LIMITS } from './query/types.js';
 import { normalizeDate } from './query/values.js';
 export { columnReference } from './formula/format.js';
-export const DATABASE_VIEWS = ['table', 'board'];
+export const DATABASE_VIEWS = ['table', 'board', 'calendar'];
 export const DATABASE_FILTER_OPS = [
     'eq',
     'neq',
@@ -29,6 +29,7 @@ const FILTER_KINDS = {
     url: 'text',
     email: 'text',
     person: 'text',
+    page: 'text',
     number: 'number',
     select: 'select',
     multi_select: 'multi',
@@ -39,6 +40,7 @@ export const filterKindOf = (type) => { var _a; return (_a = FILTER_KINDS[type])
 export const isViewableColumn = (column) => filterKindOf(column.type) !== null;
 export const isSortableColumn = (column) => isViewableColumn(column) && column.type !== 'multi_select';
 export const isGroupableColumn = (column) => column.type === 'select';
+export const isCalendarColumn = (column) => column.type === 'date';
 const OPS_BY_KIND = {
     text: ['contains', 'not_contains', 'eq', 'neq', 'empty', 'not_empty'],
     number: ['eq', 'neq', 'lt', 'lte', 'gt', 'gte', 'empty', 'not_empty'],
@@ -362,7 +364,7 @@ export const resolveColumnName = (written, candidates) => {
     return { column: null, reason: loose.length > 1 ? 'ambiguous' : 'unknown' };
 };
 export const matchColumnName = (written, candidates) => { var _a; return (_a = resolveColumnName(written, candidates).column) !== null && _a !== void 0 ? _a : undefined; };
-const renamedGroupBy = (written, renames) => { var _a; return (_a = matchColumnName(written, [...renames].map(([name, to]) => ({ name, to })))) === null || _a === void 0 ? void 0 : _a.to; };
+const renamedColumnProp = (written, renames) => { var _a; return (_a = matchColumnName(written, [...renames].map(([name, to]) => ({ name, to })))) === null || _a === void 0 ? void 0 : _a.to; };
 export const renameColumnsInViewProps = (props, renames) => {
     const changes = {};
     if (renames.size === 0)
@@ -374,7 +376,10 @@ export const renameColumnsInViewProps = (props, renames) => {
     };
     const filter = props.filter ? renameFormula(props.filter, renames) : props.filter;
     const groupBy = props.groupBy
-        ? renamedGroupBy(normalizeColumnName(props.groupBy), renames)
+        ? renamedColumnProp(normalizeColumnName(props.groupBy), renames)
+        : undefined;
+    const calendarBy = props.calendarBy
+        ? renamedColumnProp(normalizeColumnName(props.calendarBy), renames)
         : undefined;
     if (keys.some(({ rule }) => rule && renames.has(rule.column))) {
         changes.sort = keys.map(renamedKey).join(', ');
@@ -383,6 +388,8 @@ export const renameColumnsInViewProps = (props, renames) => {
         changes.filter = filter;
     if (groupBy !== undefined)
         changes.groupBy = groupBy;
+    if (calendarBy !== undefined)
+        changes.calendarBy = calendarBy;
     return changes;
 };
 export const renameColumnInViewProps = (props, from, to) => renameColumnsInViewProps(props, new Map([[from, to]]));
@@ -413,24 +420,26 @@ export const ambiguousAliases = (columns) => new Set([...aliasTargets(columns)].
 const nameWarning = (prop, column, reason, columns) => reason === 'ambiguous' || ambiguousAliases(columns).has(column)
     ? { kind: 'ambiguous_column', prop, column }
     : { kind: 'unknown_column', prop, column };
-export const resolveGroupBy = (written, columns) => {
+const resolveColumnProp = (prop, written, columns, accepts, unsupported) => {
     var _a;
     const name = written ? normalizeColumnName(written) : '';
     if (!name)
-        return { column: (_a = columns.find(isGroupableColumn)) !== null && _a !== void 0 ? _a : null, warnings: [] };
+        return { column: (_a = columns.find(accepts)) !== null && _a !== void 0 ? _a : null, warnings: [] };
     const match = resolveColumnName(name, columns);
     if (!match.column) {
-        return { column: null, warnings: [nameWarning('groupBy', name, match.reason, columns)] };
+        return { column: null, warnings: [nameWarning(prop, name, match.reason, columns)] };
     }
     const { column } = match;
-    if (!isGroupableColumn(column)) {
+    if (!accepts(column)) {
         return {
             column: null,
-            warnings: [{ kind: 'group_by_unsupported', column: column.name, type: column.type }],
+            warnings: [{ kind: unsupported, column: column.name, type: column.type }],
         };
     }
     return { column, warnings: [] };
 };
+export const resolveGroupBy = (written, columns) => resolveColumnProp('groupBy', written, columns, isGroupableColumn, 'group_by_unsupported');
+export const resolveCalendarBy = (written, columns) => resolveColumnProp('calendarBy', written, columns, isCalendarColumn, 'calendar_by_unsupported');
 const ALL_ROWS = () => true;
 const NO_ROWS = () => false;
 const canonicalNames = (source, columns, warn) => {
@@ -451,11 +460,13 @@ const canonicalNames = (source, columns, warn) => {
     return canonical;
 };
 export const resolveViewProps = (written, columns, { onInvalidFilter = 'show-all' } = {}) => {
-    var _a, _b;
-    var _c, _d;
+    var _a, _b, _c;
+    var _d, _e, _f;
     const healed = renameColumnsInViewProps(written, aliasRenames(columns));
     if (written.groupBy && matchColumnName(written.groupBy, columns))
         delete healed.groupBy;
+    if (written.calendarBy && matchColumnName(written.calendarBy, columns))
+        delete healed.calendarBy;
     const props = Object.assign(Object.assign({}, written), healed);
     const warnings = [];
     let filterInvalid = false;
@@ -479,7 +490,7 @@ export const resolveViewProps = (written, columns, { onInvalidFilter = 'show-all
             continue;
         }
         const column = known('sort', key.rule.column);
-        const rule = { column: (_c = column === null || column === void 0 ? void 0 : column.name) !== null && _c !== void 0 ? _c : key.rule.column, direction: key.rule.direction };
+        const rule = { column: (_d = column === null || column === void 0 ? void 0 : column.name) !== null && _d !== void 0 ? _d : key.rule.column, direction: key.rule.direction };
         sort.push(rule);
         if (!column)
             continue;
@@ -542,11 +553,14 @@ export const resolveViewProps = (written, columns, { onInvalidFilter = 'show-all
     const stored = filterSource ? toStoredFormula(filterSource, columns) : null;
     const group = resolveGroupBy(props.groupBy, columns);
     warnings.push(...group.warnings);
+    const calendar = resolveCalendarBy(props.calendarBy, columns);
+    warnings.push(...calendar.warnings);
     return {
         view: resolveView(rawView),
         sort,
         filter,
-        groupBy: (_d = (_b = group.column) === null || _b === void 0 ? void 0 : _b.name) !== null && _d !== void 0 ? _d : null,
+        groupBy: (_e = (_b = group.column) === null || _b === void 0 ? void 0 : _b.name) !== null && _e !== void 0 ? _e : null,
+        calendarBy: (_f = (_c = calendar.column) === null || _c === void 0 ? void 0 : _c.name) !== null && _f !== void 0 ? _f : null,
         warnings,
         healed,
         filterSource: matches === ALL_ROWS || matches === NO_ROWS ? null : filterSource,

package/dist/mdx/remark-core.js

@@ -6,6 +6,7 @@ import remarkMdx from 'remark-mdx';
 import remarkStringify from 'remark-stringify';
 import { preprocessCustomHeadingIds } from './preprocessCustomHeadingIds.js';
 import { preprocessMdxFragmentCode } from './preprocessMdxFragmentCode.js';
+import { remarkMdasticParse } from './remarkMdasticParse.js';
 import { getJsxEsmTree } from './snippets/getJsxEsmTree.js';
 import { isJsxOrTsx } from './snippets/isJsxOrTsx.js';
 export const coreRemarkMdxPlugins = [
@@ -13,6 +14,7 @@ export const coreRemarkMdxPlugins = [
     remarkGfm,
     [remarkFrontmatter, ['yaml', 'toml']],
     remarkMath,
+    remarkMdasticParse,
 ];
 export const coreRemark = remark().use(coreRemarkMdxPlugins).freeze();
 const agentRemarkMdxPlugins = [

package/dist/mdx/remarkMdasticParse.d.ts

@@ -0,0 +1,2 @@
+import type { Processor } from 'unified';
+export declare function remarkMdasticParse(this: Processor): void;

package/dist/mdx/remarkMdasticParse.js

@@ -0,0 +1,37 @@
+import { parse } from 'mdastic';
+import { frontmatter } from 'mdastic/frontmatter';
+import { gfm } from 'mdastic/gfm';
+import { math } from 'mdastic/math';
+import { mdx } from 'mdastic/mdx';
+import { visit } from 'unist-util-visit';
+const syntax = [
+    gfm({ singleTilde: true }),
+    mdx({ estree: true }),
+    math({ singleDollarTextMath: true }),
+    frontmatter(['yaml', 'toml']),
+];
+export function remarkMdasticParse() {
+    var _a;
+    var _b;
+    const fallback = this.parser;
+    const extensions = (_b = (_a = this.data('micromarkExtensions')) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
+    if (!fallback)
+        return;
+    this.parser = (document, file) => {
+        var _a;
+        var _b;
+        if (((_b = (_a = this.data('micromarkExtensions')) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) === extensions) {
+            const tree = parse(document, { syntax });
+            if (!(tree instanceof Error)) {
+                const root = tree;
+                visit(root, ['mdxJsxFlowElement', 'mdxJsxTextElement'], (node) => {
+                    if ('attributes' in node)
+                        for (const attribute of node.attributes)
+                            delete attribute.position;
+                });
+                return root;
+            }
+        }
+        return fallback(document, file);
+    };
+}

package/dist/navigation/index.d.ts

@@ -12,6 +12,7 @@ export * from './groupAccess.js';
 export * from './filterDivisions.js';
 export * from './updateFirstHrefInDivision.js';
 export * from './scopeNavToPath.js';
+export { trimNavPagesToClientFields } from './trimScopedNavPages.js';
 export * from './getVersionOrLanguageFromPath.js';
 export * from './isCommonPage.js';
 export * from './getFirstPageFromNavConfig.js';

package/dist/navigation/index.js

@@ -12,6 +12,7 @@ export * from './groupAccess.js';
 export * from './filterDivisions.js';
 export * from './updateFirstHrefInDivision.js';
 export * from './scopeNavToPath.js';
+export { trimNavPagesToClientFields } from './trimScopedNavPages.js';
 export * from './getVersionOrLanguageFromPath.js';
 export * from './isCommonPage.js';
 export * from './getFirstPageFromNavConfig.js';

package/dist/navigation/trimScopedNavPages.d.ts

@@ -1,3 +1,4 @@
 type NavNode = Record<string, unknown>;
 export declare function trimScopedNavPages(nav: NavNode, currentPath: string): NavNode;
+export declare function trimNavPagesToClientFields(nav: NavNode): NavNode;
 export {};

package/dist/navigation/trimScopedNavPages.js

@@ -95,7 +95,7 @@ function trimNode(node, keepDescription) {
     if (!isNavNode(node))
         return node;
     if (isPageNode(node))
-        return trimPage(node, keepDescription.has(node));
+        return trimPage(node, keepDescription(node));
     const trimmed = {};
     for (const [key, value] of Object.entries(node)) {
         trimmed[key] = key === 'global' ? value : trimNode(value, keepDescription);
@@ -107,6 +107,13 @@ export function trimScopedNavPages(nav, currentPath) {
     const target = normalizeComparablePath(replaceSlashIndex(currentPath));
     addPaginationNeighbors(nav, target, keepDescription);
     addDirectoryChildren(nav, target, keepDescription);
-    const trimmed = trimNode(nav, keepDescription);
+    const trimmed = trimNode(nav, (page) => keepDescription.has(page));
+    return isNavNode(trimmed) ? trimmed : nav;
+}
+// static export renders one layout nav into every page, so it can't know which
+// pages need descriptions; keep them all and drop everything else the client
+// doesn't read (keywords, custom frontmatter)
+export function trimNavPagesToClientFields(nav) {
+    const trimmed = trimNode(nav, () => true);
     return isNavNode(trimmed) ? trimmed : nav;
 }

package/dist/navigation/trimScopedNavPages.test.js

@@ -1,4 +1,4 @@
-import { trimScopedNavPages } from './trimScopedNavPages.js';
+import { trimNavPagesToClientFields, trimScopedNavPages } from './trimScopedNavPages.js';
 const page = (slug, extra = {}) => (Object.assign({ title: slug, href: `/${slug}`, description: `${slug} description` }, extra));
 function descriptions(nav) {
     const out = {};
@@ -192,3 +192,28 @@ describe('trimScopedNavPages', () => {
         expect(nav).toEqual(before);
     });
 });
+describe('trimNavPagesToClientFields', () => {
+    it('keeps client fields and every description', () => {
+        const nav = {
+            groups: [
+                {
+                    group: 'G',
+                    root: page('g', { keywords: ['k'] }),
+                    pages: [page('a', { icon: 'book', customFrontmatter: 'x' }), page('b', { tag: 'New' })],
+                },
+            ],
+        };
+        expect(trimNavPagesToClientFields(nav)).toEqual({
+            groups: [
+                {
+                    group: 'G',
+                    root: { title: 'g', href: '/g', description: 'g description' },
+                    pages: [
+                        { title: 'a', href: '/a', description: 'a description', icon: 'book' },
+                        { title: 'b', href: '/b', description: 'b description', tag: 'New' },
+                    ],
+                },
+            ],
+        });
+    });
+});