@platformos/platformos-check-docs-updater 0.0.6 → 0.0.8

package/src/{themeLiquidDocsManager.ts → platformOSLiquidDocsManager.ts}

@@ -1,34 +1,25 @@
 import {
   FilterEntry,
   JsonValidationSet,
-  Mode,
   ObjectEntry,
   SchemaDefinition,
   TagEntry,
-  ThemeDocset,
-  Translations,
+  PlatformOSDocset,
 } from '@platformos/platformos-check-common';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import {
-  Manifests,
   Resource,
-  ThemeCustomSchemas,
-  ThemeLiquidDocsRoot,
-  ThemeLiquidDocsRootFallback,
   downloadResource,
-  downloadThemeLiquidDocs,
+  downloadPlatformOSLiquidDocs,
   exists,
   graphQLPath,
   resourcePath,
   root,
-  schemaPath,
-} from './themeLiquidDocsDownloader';
-import { Logger, identity, memo, memoize, noop, tap } from './utils';
+} from './platformOSLiquidDocsDownloader';
+import { Logger, memo, noop, tap } from './utils';
 
-type JSONSchemaManifest = { schemas: { uri: string; fileMatch?: string[] }[] };
-
-export class ThemeLiquidDocsManager implements ThemeDocset, JsonValidationSet {
+export class PlatformOSLiquidDocsManager implements PlatformOSDocset, JsonValidationSet {
   constructor(private log: Logger = noop) {}
 
   filters = memo(async (): Promise<FilterEntry[]> => {
@@ -48,54 +39,15 @@ export class ThemeLiquidDocsManager implements ThemeDocset, JsonValidationSet {
   });
 
   graphQL = memo(async (): Promise<string | null> => {
-    return findSuitableResource(this.graphQLLoaders(), (x: string) => x, null, this.log);
+    return findSuitableResource(this.graphqlLoaders(), (x: string) => x, null, this.log);
   });
 
-  systemTranslations = memo(async (): Promise<Translations> => {
-    return findSuitableResource(
-      this.loaders('shopify_system_translations'),
-      JSON.parse,
-      {},
-      this.log,
-    );
-  });
-
-  schemas = memoize(
-    (mode: Mode) =>
-      findSuitableResource<JSONSchemaManifest>(
-        this.loaders(Manifests[mode]),
-        JSON.parse,
-        {
-          schemas: [],
-        },
-        this.log,
-      ).then((manifest) => {
-        return Promise.all(
-          manifest.schemas.map(async (schemaDefinition): Promise<SchemaDefinition> => {
-            let schemaRoot = `${ThemeLiquidDocsRootFallback}/schemas`;
-
-            if (ThemeCustomSchemas.includes(schemaDefinition.uri)) {
-              schemaRoot = ThemeLiquidDocsRoot;
-            }
-            return {
-              uri: `${schemaRoot}/${schemaDefinition.uri}`,
-              fileMatch: schemaDefinition.fileMatch,
-              schema: await findSuitableResource(
-                this.schemaLoaders(schemaDefinition.uri),
-                identity,
-                '',
-                this.log,
-              ),
-            };
-          }),
-        );
-      }),
-    identity<Mode>,
-  );
+  // platformOS does not use JSON schemas for sections/blocks/settings.
+  schemas = memo(async (): Promise<SchemaDefinition[]> => []);
 
   /**
    * The setup method checks that the latest revision matches the one from
-   * Shopify/theme-liquid-docs. If there's a diff in revision, it means
+   * the platformOS liquid docs. If there's a diff in revision, it means
    * that the documentations that you have locally are out of date.
    *
    * The setup method then downloads the other files.
@@ -110,7 +62,7 @@ export class ThemeLiquidDocsManager implements ThemeDocset, JsonValidationSet {
       await downloadResource('latest', root, this.log);
       const remote = await this.latestRevision();
       if (local !== remote) {
-        await downloadThemeLiquidDocs(root, this.log);
+        await downloadPlatformOSLiquidDocs(root, this.log);
       }
     } catch (error) {
       if (error instanceof Error) {
@@ -141,12 +93,6 @@ export class ThemeLiquidDocsManager implements ThemeDocset, JsonValidationSet {
     return fs.readFile(resourcePath(name), 'utf8');
   }
 
-  private async loadSchema(relativeUri: string) {
-    return fs
-      .readFile(schemaPath(relativeUri), 'utf8')
-      .then(tap(() => this.log(`Loaded schema from ${schemaPath(relativeUri)}`)));
-  }
-
   private async loadGraphQL() {
     return fs.readFile(graphQLPath(), 'utf8').then(tap(() => this.log(`Loaded graphQL`)));
   }
@@ -158,14 +104,7 @@ export class ThemeLiquidDocsManager implements ThemeDocset, JsonValidationSet {
     ];
   }
 
-  private schemaLoaders(relativeUri: string): Loader<string>[] {
-    return [
-      loader(() => this.loadSchema(relativeUri), `loadSchema(${relativeUri})`),
-      loader(() => fallbackSchema(relativeUri, this.log), `fallbackSchema(${relativeUri})`),
-    ];
-  }
-
-  private graphQLLoaders(): Loader<string>[] {
+  private graphqlLoaders(): Loader<string>[] {
     return [
       loader(() => this.loadGraphQL(), `loadGraphQL()`),
       loader(() => fallbackGraphQL(this.log), `fallbackSchema()`),
@@ -235,18 +174,6 @@ async function fallbackResource(name: Resource, log: Logger): Promise<string> {
     .then(tap(() => log(`Loaded fallback resource\n\t${name} from\n\t${sourcePath}`)));
 }
 
-/** Returns the at-build-time path to the fallback schema file. */
-async function fallbackSchema(
-  /** e.g. themes/section.json */
-  relativeUri: string,
-  log: Logger,
-): Promise<string> {
-  const sourcePath = path.resolve(dataRoot(), path.basename(relativeUri));
-  return fs
-    .readFile(sourcePath, 'utf8')
-    .then(tap(() => log(`Loaded fallback schema\n\t${relativeUri} from\n\t${sourcePath}`)));
-}
-
 async function fallbackGraphQL(log: Logger): Promise<string> {
   const sourcePath = path.resolve(dataRoot(), `graphql.graphql`);
   return fs