@tinacms/cli 1.6.12 → 1.7.0

package/dist/index.js

@@ -31,7 +31,7 @@ module.exports = __toCommonJS(src_exports);
 var import_clipanion8 = require("clipanion");
 
 // package.json
-var version = "1.6.12";
+var version = "1.7.0";
 
 // src/next/commands/dev-command/index.ts
 var import_clipanion2 = require("clipanion");
@@ -355,17 +355,22 @@ var ConfigManager = class {
     );
   }
   getTinaGraphQLVersion() {
-    var _a, _b;
     if (this.tinaGraphQLVersionFromCLI) {
-      return this.tinaGraphQLVersionFromCLI;
+      const version2 = this.tinaGraphQLVersionFromCLI.split(".");
+      return {
+        fullVersion: this.tinaGraphQLVersionFromCLI,
+        major: version2[0] || "x",
+        minor: version2[1] || "x",
+        patch: version2[2] || "x"
+      };
     }
     const generatedSchema = import_fs_extra.default.readJSONSync(this.generatedSchemaJSONPath);
-    if (!generatedSchema || !(typeof (generatedSchema == null ? void 0 : generatedSchema.version) !== "undefined") || !(typeof ((_a = generatedSchema == null ? void 0 : generatedSchema.version) == null ? void 0 : _a.major) === "string") || !(typeof ((_b = generatedSchema == null ? void 0 : generatedSchema.version) == null ? void 0 : _b.minor) === "string")) {
+    if (!generatedSchema || !(typeof (generatedSchema == null ? void 0 : generatedSchema.version) !== "undefined")) {
       throw new Error(
         `Can not find Tina GraphQL version in ${this.generatedSchemaJSONPath}`
       );
     }
-    return `${generatedSchema.version.major}.${generatedSchema.version.minor}`;
+    return generatedSchema.version;
   }
   printGeneratedClientFilePath() {
     if (this.isUsingTs()) {
@@ -999,6 +1004,8 @@ var createConfig = async ({
   if (configManager.config.build.basePath) {
     basePath = configManager.config.build.basePath;
   }
+  const fullVersion = configManager.getTinaGraphQLVersion();
+  const version2 = `${fullVersion.major}.${fullVersion.minor}`;
   const config2 = {
     root: configManager.spaRootPath,
     base: `/${basePath ? `${(0, import_normalize_path2.default)(basePath)}/` : ""}${(0, import_normalize_path2.default)(
@@ -1014,7 +1021,7 @@ var createConfig = async ({
       "process.platform": `"${process.platform}"`,
       __API_URL__: `"${apiURL}"`,
       __BASE_PATH__: `"${((_e = (_d = configManager.config) == null ? void 0 : _d.build) == null ? void 0 : _e.basePath) || ""}"`,
-      __TINA_GRAPHQL_VERSION__: `"${configManager.getTinaGraphQLVersion()}"`
+      __TINA_GRAPHQL_VERSION__: version2
     },
     logLevel: "error",
     optimizeDeps: {
@@ -1788,7 +1795,8 @@ var Codegen = class {
     const branch = (_a = this.configManager.config) == null ? void 0 : _a.branch;
     const clientId = (_b = this.configManager.config) == null ? void 0 : _b.clientId;
     const token = (_c = this.configManager.config) == null ? void 0 : _c.token;
-    const version2 = this.configManager.getTinaGraphQLVersion();
+    const fullVersion = this.configManager.getTinaGraphQLVersion();
+    const version2 = `${fullVersion.major}.${fullVersion.minor}`;
     const baseUrl = ((_d = this.configManager.config.tinaioConfig) == null ? void 0 : _d.contentApiUrlOverride) || `https://${TINA_HOST}`;
     if ((!branch || !clientId || !token) && !this.port && !this.configManager.config.contentApiUrlOverride) {
       const missing = [];
@@ -2582,7 +2590,7 @@ var buildProductionSpa = async (configManager, database, apiURL) => {
 // src/next/commands/build-command/index.ts
 var import_schema_tools2 = require("@tinacms/schema-tools");
 var import_graphql12 = require("graphql");
-var import_core2 = require("@graphql-inspector/core");
+var import_core3 = require("@graphql-inspector/core");
 
 // src/next/commands/build-command/waitForDB.ts
 var import_progress = __toESM(require("progress"));
@@ -2684,6 +2692,20 @@ var waitForDB = async (config2, apiUrl, previewName, verbose) => {
 
 // src/next/commands/build-command/index.ts
 var import_search2 = require("@tinacms/search");
+
+// src/utils/index.ts
+var import_core2 = require("@graphql-inspector/core");
+var getFaqLink = (type) => {
+  switch (type) {
+    case import_core2.ChangeType.FieldRemoved: {
+      return "https://tina.io/docs/introduction/faq#how-do-i-resolve-the-local-graphql-schema-doesnt-match-the-remote-graphql-schema-errors";
+    }
+    default:
+      return null;
+  }
+};
+
+// src/next/commands/build-command/index.ts
 var BuildCommand = class extends BaseCommand {
   constructor() {
     super(...arguments);
@@ -2811,7 +2833,7 @@ ${dangerText(e.message)}
     }
     const skipCloudChecks = this.skipCloudChecks || configManager.hasSelfHostedConfig();
     if (!skipCloudChecks) {
-      const { hasUpstream } = await this.checkClientInfo(
+      const { hasUpstream, timestamp } = await this.checkClientInfo(
         configManager,
         codegen2.productionUrl,
         this.previewBaseBranch
@@ -2839,14 +2861,16 @@ ${dangerText(e.message)}
       await this.checkGraphqlSchema(
         configManager,
         database,
-        codegen2.productionUrl
+        codegen2.productionUrl,
+        timestamp
       );
       await this.checkTinaSchema(
         configManager,
         database,
         codegen2.productionUrl,
         this.previewName,
-        this.verbose
+        this.verbose,
+        timestamp
       );
     }
     await buildProductionSpa(configManager, database, codegen2.productionUrl);
@@ -2965,11 +2989,13 @@ ${dangerText(e.message)}
     const bar2 = new import_progress2.default("Checking clientId and token. :prog", 1);
     let branchKnown = false;
     let hasUpstream = false;
+    let timestamp;
     try {
       const res = await request({
         token,
         url
       });
+      timestamp = res.timestamp || 0;
       bar2.tick({
         prog: "\u2705"
       });
@@ -3011,7 +3037,8 @@ ${dangerText(e.message)}
         prog: "\u2705"
       });
       return {
-        hasUpstream
+        hasUpstream,
+        timestamp
       };
     }
     for (let i = 0; i <= 5; i++) {
@@ -3101,14 +3128,14 @@ ${dangerText(e.message)}
       throw e;
     }
   }
-  async checkGraphqlSchema(configManager, database, apiURL) {
+  async checkGraphqlSchema(configManager, database, apiURL, timestamp) {
     const bar2 = new import_progress2.default(
       "Checking local GraphQL Schema matches server. :prog",
       1
     );
     const { config: config2 } = configManager;
     const token = config2.token;
-    const remoteSchema = await fetchRemoteGraphqlSchema({
+    const { remoteSchema, remoteProjectVersion } = await fetchRemoteGraphqlSchema({
       url: apiURL,
       token
     });
@@ -3128,7 +3155,7 @@ Additional info: Branch: ${config2.branch}, Client ID: ${config2.clientId} `;
     const localSchemaDocument = await database.getGraphQLSchemaFromBridge();
     const localGraphqlSchema = (0, import_graphql12.buildASTSchema)(localSchemaDocument);
     try {
-      const diffResult = await (0, import_core2.diff)(localGraphqlSchema, remoteGqlSchema);
+      const diffResult = await (0, import_core3.diff)(localGraphqlSchema, remoteGqlSchema);
       if (diffResult.length === 0) {
         bar2.tick({
           prog: "\u2705"
@@ -3137,12 +3164,30 @@ Additional info: Branch: ${config2.branch}, Client ID: ${config2.clientId} `;
         bar2.tick({
           prog: "\u274C"
         });
-        let errorMessage = `The local GraphQL schema doesn't match the remote GraphQL schema. Please push up your changes to GitHub to update your remote GraphQL schema.`;
-        if (config2 == null ? void 0 : config2.branch) {
-          errorMessage += `
+        const type = diffResult[0].type;
+        const reason = diffResult[0].message;
+        const errorLevel = diffResult[0].criticality.level;
+        const faqLink = getFaqLink(type);
+        const tinaGraphQLVersion = configManager.getTinaGraphQLVersion();
+        let errorMessage = `The local GraphQL schema doesn't match the remote GraphQL schema. Please push up your changes to GitHub to update your remote GraphQL schema. ${faqLink && `
+Check out '${faqLink}' for possible solutions.`}`;
+        errorMessage += `
 
-Additional info: Branch: ${config2.branch}, Client ID: ${config2.clientId} `;
+Additional info:
+
+`;
+        if (config2 == null ? void 0 : config2.branch) {
+          errorMessage += `	Branch: ${config2.branch}, Client ID: ${config2.clientId}
+`;
         }
+        errorMessage += `	Local GraphQL version: ${tinaGraphQLVersion.fullVersion} / Remote GraphQL version: ${remoteProjectVersion}
+`;
+        errorMessage += `	Last indexed at: ${new Date(
+          timestamp
+        ).toUTCString()}
+`;
+        errorMessage += `	Reason: [${errorLevel} - ${type}] ${reason}
+`;
         throw new Error(errorMessage);
       }
     } catch (e) {
@@ -3157,7 +3202,7 @@ Additional info: Branch: ${config2.branch}, Client ID: ${config2.clientId} `;
       }
     }
   }
-  async checkTinaSchema(configManager, database, apiURL, previewName, verbose) {
+  async checkTinaSchema(configManager, database, apiURL, previewName, verbose, timestamp) {
     const bar2 = new import_progress2.default(
       "Checking local Tina Schema matches server. :prog",
       1
@@ -3206,11 +3251,19 @@ Additional info: Branch: ${config2.branch}, Client ID: ${config2.clientId} `;
         prog: "\u274C"
       });
       let errorMessage = `The local Tina schema doesn't match the remote Tina schema. Please push up your changes to GitHub to update your remote tina schema.`;
-      if (config2 == null ? void 0 : config2.branch) {
-        errorMessage += `
+      errorMessage += `
 
-Additional info: Branch: ${config2.branch}, Client ID: ${config2.clientId} `;
+Additional info:
+
+`;
+      if (config2 == null ? void 0 : config2.branch) {
+        errorMessage += `        Branch: ${config2.branch}, Client ID: ${config2.clientId}
+`;
       }
+      errorMessage += `        Last indexed at: ${new Date(
+        timestamp
+      ).toUTCString()}
+`;
       throw new Error(errorMessage);
     }
   }
@@ -3280,7 +3333,11 @@ var fetchRemoteGraphqlSchema = async ({
     body
   });
   const data = await res.json();
-  return data == null ? void 0 : data.data;
+  return {
+    remoteSchema: data == null ? void 0 : data.data,
+    remoteRuntimeVersion: res.headers.get("tinacms-grapqhl-version"),
+    remoteProjectVersion: res.headers.get("tinacms-graphql-project-version")
+  };
 };
 var fetchSchemaSha = async ({
   url,

package/dist/next/commands/build-command/index.d.ts

@@ -21,19 +21,24 @@ export declare class BuildCommand extends BaseCommand {
     execute(): Promise<number | void>;
     checkClientInfo(configManager: ConfigManager, apiURL: string, previewBaseBranch?: string): Promise<{
         hasUpstream: boolean;
+        timestamp: number;
     }>;
     syncProject(configManager: ConfigManager, apiURL: string, options?: {
         upstreamBranch?: string;
         previewBaseBranch?: string;
         previewName?: string;
     }): Promise<void>;
-    checkGraphqlSchema(configManager: ConfigManager, database: Database, apiURL: string): Promise<void>;
-    checkTinaSchema(configManager: ConfigManager, database: Database, apiURL: string, previewName: string, verbose: boolean): Promise<void>;
+    checkGraphqlSchema(configManager: ConfigManager, database: Database, apiURL: string, timestamp: number): Promise<void>;
+    checkTinaSchema(configManager: ConfigManager, database: Database, apiURL: string, previewName: string, verbose: boolean, timestamp: number): Promise<void>;
 }
 export declare const fetchRemoteGraphqlSchema: ({ url, token, }: {
     url: string;
     token?: string;
-}) => Promise<any>;
+}) => Promise<{
+    remoteSchema: any;
+    remoteRuntimeVersion: string;
+    remoteProjectVersion: string;
+}>;
 export declare const fetchSchemaSha: ({ url, token, }: {
     url: string;
     token?: string;

package/dist/next/config-manager.d.ts

@@ -55,7 +55,12 @@ export declare class ConfigManager {
     shouldSkipSDK(): boolean;
     processConfig(): Promise<void>;
     getTinaFolderPath(rootPath: any): Promise<string>;
-    getTinaGraphQLVersion(): string;
+    getTinaGraphQLVersion(): {
+        fullVersion: string;
+        major: string;
+        minor: string;
+        patch: string;
+    };
     printGeneratedClientFilePath(): string;
     printGeneratedTypesFilePath(): string;
     printoutputHTMLFilePath(): string;

package/dist/utils/index.d.ts

@@ -1,4 +1,6 @@
 /**
 
 */
+import { ChangeType } from '@graphql-inspector/core';
 export declare const parseMediaFolder: (str: string) => string;
+export declare const getFaqLink: (type: ChangeType) => string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinacms/cli",
-  "version": "1.6.12",
+  "version": "1.7.0",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
@@ -84,12 +84,12 @@
     "vite": "^4.5.5",
     "yup": "^1.4.0",
     "zod": "^3.23.8",
-    "@tinacms/graphql": "1.5.8",
-    "@tinacms/app": "2.1.12",
-    "@tinacms/schema-tools": "1.6.8",
+    "@tinacms/app": "2.1.14",
+    "@tinacms/graphql": "1.5.9",
     "@tinacms/metrics": "1.0.8",
-    "tinacms": "2.5.0",
-    "@tinacms/search": "1.0.35"
+    "@tinacms/schema-tools": "1.6.9",
+    "tinacms": "2.5.2",
+    "@tinacms/search": "1.0.36"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"