@tinacms/schema-tools 2.8.0 → 2.8.2

package/dist/index.d.ts

@@ -4,3 +4,4 @@ export * from './validate';
 export * from './util/namer';
 export * from './util/parseURL';
 export * from './util/normalizePath';
+export * from './util/headingLevels';

package/dist/index.js

@@ -1627,7 +1627,7 @@ const parseURL = (url) => {
   if (!isTinaCloud) {
     return {
       branch: null,
-      isLocalClient: true,
+      isLocalClient: false,
       clientId: null,
       host: params.host
     };
@@ -1642,7 +1642,7 @@ const parseURL = (url) => {
   const clientId = result == null ? void 0 : result.clientId;
   if (!branch || !clientId) {
     throw new Error(
-      `Invalid URL format provided. Expected: https://content.tinajs.io/<Version>/content/<ClientID>/github/<Branch> but but received ${url}`
+      `Invalid URL format provided. Expected: https://content.tinajs.io/<Version>/content/<ClientID>/github/<Branch> but received ${url}`
     );
   }
   return {
@@ -2292,6 +2292,14 @@ const CONTENT_FORMATS = [
   "yml",
   "toml"
 ];
+const ALL_HEADING_LEVELS = [
+  "h1",
+  "h2",
+  "h3",
+  "h4",
+  "h5",
+  "h6"
+];
 const parseZodError = ({ zodError }) => {
   var _a, _b, _c, _d;
   const errors = zodError.flatten((issue) => {
@@ -2804,7 +2812,29 @@ const validateSchema = ({ schema }) => {
     throw new Error(e);
   }
 };
+const isHeadingLevel = (value) => {
+  switch (value) {
+    case "h1":
+    case "h2":
+    case "h3":
+    case "h4":
+    case "h5":
+    case "h6":
+      return true;
+    default:
+      return false;
+  }
+};
+const normalizeHeadingLevels = (configured) => {
+  const seen = /* @__PURE__ */ new Set();
+  for (const level of configured) {
+    if (isHeadingLevel(level))
+      seen.add(level);
+  }
+  return Array.from(seen);
+};
 export {
+  ALL_HEADING_LEVELS,
   CONTENT_FORMATS,
   NAMER,
   TINA_HOST,
@@ -2812,6 +2842,8 @@ export {
   TinaSchemaValidationError,
   addNamespaceToSchema,
   canonicalPath,
+  isHeadingLevel,
+  normalizeHeadingLevels,
   normalizePath,
   parseURL,
   resolveField,

package/dist/types/index.d.ts

@@ -255,6 +255,13 @@ export type DisplayOnlyField = BaseField & {
     };
 };
 export type ToolbarOverrideType = 'heading' | 'link' | 'image' | 'quote' | 'ul' | 'ol' | 'code' | 'codeBlock' | 'bold' | 'italic' | 'strikethrough' | 'highlight' | 'raw' | 'embed' | 'mermaid' | 'table' | 'hr';
+/**
+ * Heading node type as used by the rich-text editor. Mirrors
+ * `@udecode/plate-heading`'s `HEADING_KEYS` so consumers can pass these
+ * values straight through without translation.
+ */
+export type HeadingLevel = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+export declare const ALL_HEADING_LEVELS: readonly HeadingLevel[];
 type RichTextAst = {
     type: 'root';
     children: Record<string, unknown>[];
@@ -274,6 +281,16 @@ export type RichTextField<WithNamespace extends boolean = false> = (FieldGeneric
         toolbar?: ToolbarOverrideType[];
         /**Default set to true */
         showFloatingToolbar?: boolean;
+        /**
+         * Restricts which heading levels are offered in the editor UI
+         * (headings dropdown, "Turn into" menu, slash menu, and markdown
+         * autoformat shortcuts like `## `). When omitted, all levels are
+         * available. UI-only — existing content with disallowed levels is
+         * rendered as-is.
+         *
+         * @example headingLevels: ['h1', 'h2', 'h3']
+         */
+        headingLevels?: HeadingLevel[];
     };
     /**
      * By default, Tina parses markdown with MDX, this is a more strict parser
@@ -429,6 +446,14 @@ interface AuthHooks {
 }
 type AuthOptions = AuthHooks & AuthProvider;
 export interface Config<CMSCallback = undefined, FormifyCallback = undefined, DocumentCreatorCallback = undefined, Store = undefined, SearchClient = undefined> {
+    /**
+     * Points the admin UI at a custom/self-hosted content API instead of TinaCloud.
+     *
+     * Can be a relative URL, such as `/api/tina/gql`, or an absolute URL, such as
+     * `https://example.com/api/content`. When set, the admin UI will not show the
+     * Local Mode banner; Local Mode is only detected when this option is unset and
+     * the content API resolves to `localhost`.
+     */
     contentApiUrlOverride?: string;
     authProvider?: AuthProvider;
     admin?: {

package/dist/util/headingLevels.d.ts

@@ -0,0 +1,14 @@
+import { type HeadingLevel } from '../types/index';
+/**
+ * Cast-free type guard for HeadingLevel. The exhaustive switch lets TS
+ * narrow `string` → `HeadingLevel` without an `as` cast, so it doubles
+ * as a runtime validator for untrusted (pure-JS) schema input.
+ */
+export declare const isHeadingLevel: (value: string) => value is HeadingLevel;
+/**
+ * Filters out values that aren't real HeadingLevels (a JS schema can
+ * declare anything at runtime), dedupes, and preserves the order the
+ * user wrote. Returns an empty array when no valid levels remain — an
+ * explicit `[]` therefore means "no headings", not "fall back to all".
+ */
+export declare const normalizeHeadingLevels: (configured: readonly string[]) => readonly HeadingLevel[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tinacms/schema-tools",
   "type": "module",
-  "version": "2.8.0",
+  "version": "2.8.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -24,7 +24,7 @@
     "ts-jest": "^29.2.5",
     "typescript": "^5.7.3",
     "yup": "^1.6.1",
-    "@tinacms/scripts": "1.6.1"
+    "@tinacms/scripts": "1.6.2"
   },
   "peerDependencies": {
     "react": ">=16.14.0",