@platformos/platformos-check-docs-updater 0.0.7 → 0.0.9

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

package/data/app_block_entry.json

@@ -1,13 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$comment": "An @app block entry",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "type": {
-      "const": "@app",
-      "description": "The \"@app\" type is used to denote that this container accepts app blocks. App blocks enable app developers to create blocks for merchants to add app content to their theme without having to directly edit theme code.",
-      "markdownDescription": "The `@app` type is used to denote that this container accepts app blocks. [App blocks](/docs/themes/architecture/sections/app-blocks) enable app developers to create blocks for merchants to add app content to their theme without having to directly edit theme code.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/app-blocks#supporting-app-blocks)"
-    }
-  }
-}

package/data/default_setting_values.json

@@ -1,24 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "description": "A list of default values for any settings that you might want to populate. Each entry should include the setting name and the value.",
-  "additionalProperties": {
-    "anyOf": [
-      {
-        "type": "number"
-      },
-      {
-        "type": "boolean"
-      },
-      {
-        "type": "string"
-      },
-      {
-        "type": "array",
-        "items": {
-          "type": "string"
-        }
-      }
-    ]
-  }
-}

package/data/local_block_entry.json

@@ -1,25 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$comment": "For block definitions that are local to the file.",
-  "type": "object",
-  "required": ["type", "name"],
-  "additionalProperties": false,
-  "properties": {
-    "type": {
-      "type": "string",
-      "description": "The block type. This is a free-form string that you can use as an identifier.",
-      "markdownDescription": "The block type. This is a free-form string that you can use as an identifier.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#blocks)"
-    },
-    "name": {
-      "type": "string",
-      "description": "The block name, which will show as the block title in the theme editor."
-    },
-    "limit": {
-      "type": "integer",
-      "description": "The number of blocks of this type that can be used."
-    },
-    "settings": {
-      "$ref": "./settings.json"
-    }
-  }
-}

package/data/manifest_theme.json

@@ -1,19 +0,0 @@
-{
-  "$schema": "manifest_schema.json",
-  "$comment": "Declares all the JSON schemas you need to validate themes",
-  "schemas": [
-    { "fileMatch": ["locales/*.json"], "uri": "theme/translations.json" },
-    { "fileMatch": ["blocks/*.liquid"], "uri": "theme/theme_block.json" },
-    { "fileMatch": ["config/settings_schema.json"], "uri": "theme/theme_settings.json" },
-    { "fileMatch": ["sections/*.liquid"], "uri": "theme/section.json" },
-    { "uri": "theme/settings.json" },
-    { "uri": "theme/setting.json" },
-    { "uri": "theme/default_setting_values.json" },
-    { "uri": "theme/app_block_entry.json" },
-    { "uri": "theme/theme_block_entry.json" },
-    { "uri": "theme/targetted_block_entry.json" },
-    { "uri": "theme/preset_blocks.json" },
-    { "uri": "theme/preset.json" },
-    { "uri": "theme/local_block_entry.json" }
-  ]
-}

package/data/manifest_theme_app_extension.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "manifest_schema.json",
-  "$comment": "Declares all the JSON schemas you need to validate themes",
-  "schemas": [
-    {
-      "uri": "theme/translations.json",
-      "fileMatch": ["locales/*.json"]
-    }
-  ]
-}

package/data/preset.json

@@ -1,72 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Shopify Liquid Section or Block Preset Schema",
-  "oneOf": [
-    {
-      "$ref": "#/definitions/presetWithBlocksArray"
-    },
-    {
-      "$ref": "#/definitions/presetWithBlocksHash"
-    }
-  ],
-  "definitions": {
-    "presetBase": {
-      "type": "object",
-      "required": ["name"],
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "The preset name, which will show in the 'Add section' or 'Add block' picker of the theme editor.",
-          "markdownDescription": "The preset name, which will show in the 'Add section' or 'Add block' picker of the theme editor.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#presets)"
-        },
-        "category": {
-          "type": "string",
-          "description": "The category of the preset, which will show in the 'Add section' or 'Add block' picker of the theme editor.",
-          "markdownDescription": "The category of the preset, which will show in the 'Add section' or 'Add block' picker of the theme editor.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#presets)"
-        },
-        "settings": {
-          "$ref": "./default_setting_values.json"
-        }
-      }
-    },
-    "presetWithBlocksArray": {
-      "type": "object",
-      "allOf": [
-        {
-          "$ref": "#/definitions/presetBase"
-        }
-      ],
-      "properties": {
-        "name": true,
-        "category": true,
-        "settings": true,
-        "blocks": {
-          "$ref": "./preset_blocks.json#/definitions/blocksArray"
-        }
-      },
-      "additionalProperties": false
-    },
-    "presetWithBlocksHash": {
-      "type": "object",
-      "allOf": [
-        {
-          "$ref": "#/definitions/presetBase"
-        }
-      ],
-      "required": ["blocks"],
-      "properties": {
-        "name": true,
-        "settings": true,
-        "blocks": {
-          "$ref": "./preset_blocks.json#/definitions/blocksHash"
-        },
-        "block_order": {
-          "type": "array",
-          "description": "The order of blocks in the preset.",
-          "markdownDescription": "The order of blocks in the preset."
-        },
-        "additionalProperties": false
-      }
-    }
-  }
-}

package/data/preset_blocks.json

@@ -1,91 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Shopify Liquid Preset Blocks Schema",
-  "definitions": {
-    "blocksArray": {
-      "type": "array",
-      "description": "A list of child blocks that you might want to include.",
-      "markdownDescription": "A list of child blocks that you might want to include.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#presets)",
-      "items": {
-        "type": "object",
-        "allOf": [
-          {
-            "$ref": "#/definitions/commonBlockAttributes"
-          }
-        ],
-        "properties": {
-          "static": true,
-          "type": true,
-          "name": true,
-          "settings": true,
-          "blocks": {
-            "$ref": "#/definitions/blocksArray"
-          },
-          "id": {
-            "type": "string",
-            "description": "A unique identifier for the block."
-          }
-        },
-        "additionalProperties": false,
-        "if": {
-          "properties": {
-            "static": {
-              "const": true
-            }
-          },
-          "required": ["static"]
-        },
-        "then": {
-          "required": ["id"]
-        }
-      }
-    },
-    "blocksHash": {
-      "type": "object",
-      "description": "A list of child blocks that you might want to include.",
-      "markdownDescription": "A list of child blocks that you might want to include.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#presets)",
-      "additionalProperties": {
-        "allOf": [
-          {
-            "$ref": "#/definitions/commonBlockAttributes"
-          }
-        ],
-        "properties": {
-          "static": true,
-          "type": true,
-          "name": true,
-          "settings": true,
-          "blocks": {
-            "$ref": "#/definitions/blocksHash"
-          },
-          "block_order": {
-            "type": "array",
-            "description": "The order of the blocks in the section."
-          }
-        },
-        "additionalProperties": false
-      }
-    },
-    "commonBlockAttributes": {
-      "type": "object",
-      "required": ["type"],
-      "properties": {
-        "type": {
-          "type": "string",
-          "description": "The block type."
-        },
-        "name": {
-          "type": "string",
-          "description": "The block name."
-        },
-        "settings": {
-          "$ref": "./default_setting_values.json"
-        },
-        "static": {
-          "type": "boolean",
-          "description": "If the block is rendered statically or not."
-        }
-      }
-    }
-  }
-}

package/data/section.json

@@ -1,208 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Shopify Liquid Theme Section Schema",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "The name attribute determines the section title that is shown in the theme editor.",
-      "markdownDescription": "The `name` attribute determines the section title that is shown in the theme editor.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#name)"
-    },
-
-    "tag": {
-      "type": "string",
-      "description": "The HTML element that is used to wrap the section.",
-      "markdownDescription": "The HTML element that is used to wrap the section.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#tag)",
-      "enum": ["article", "aside", "div", "footer", "header", "section"]
-    },
-
-    "class": {
-      "type": "string",
-      "description": "Additional CSS class for the section.",
-      "markdownDescription": "Additional CSS class for the section.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#class)"
-    },
-
-    "limit": {
-      "type": "integer",
-      "description": "The number of times a section can be added to a template or section group.",
-      "markdownDescription": "The number of times a section can be added to a template or section group.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#limit)",
-      "minimum": 1,
-      "maximum": 2
-    },
-
-    "settings": {
-      "$ref": "./settings.json"
-    },
-
-    "max_blocks": {
-      "type": "integer",
-      "description": "There's a limit of 50 blocks per section. You can specify a lower limit with the max_blocks attribute",
-      "markdownDescription": "There's a limit of 50 blocks per section. You can specify a lower limit with the `max_blocks` attribute.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#max_blocks)",
-      "minimum": 1,
-      "maximum": 50
-    },
-
-    "blocks": {
-      "type": "array",
-      "description": "Blocks are reusable modules of content that can be added, removed, and reordered within a section.",
-      "markdownDescription": "Blocks are reusable modules of content that can be added, removed, and reordered within a section.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#blocks)",
-      "properties": {
-        "type": {
-          "description": "The block type. Can be one of the following values: @theme, @app, or a custom block type.",
-          "markdownDescription": "The block type. Can be one of the following values: @theme, @app, or a custom block type.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#blocks)"
-        }
-      },
-      "items": {
-        "type": "object",
-        "required": ["type"],
-        "properties": {
-          "type": {
-            "type": "string",
-            "description": "The type of block that can be added to this block.",
-            "markdownDescription": "The type of block that can be added to this block.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#blocks)"
-          }
-        },
-        "$comment": "The allOf rule here exists because that's how we do discriminated unions in JSON schemas. If a rule matches, that rule will be used to document the type property. Otherwise we fallback to the docs above.",
-        "allOf": [
-          {
-            "if": { "required": ["type"], "properties": { "type": { "const": "@theme" } } },
-            "then": { "$ref": "./theme_block_entry.json" }
-          },
-          {
-            "if": { "required": ["type"], "properties": { "type": { "const": "@app" } } },
-            "then": { "$ref": "./app_block_entry.json" }
-          },
-          {
-            "if": {
-              "required": ["type"],
-              "properties": {
-                "type": {
-                  "type": "string",
-                  "not": { "enum": ["@app", "@theme"] }
-                }
-              }
-            },
-            "then": {
-              "oneOf": [
-                { "$ref": "./targetted_block_entry.json" },
-                { "$ref": "./local_block_entry.json" }
-              ]
-            }
-          }
-        ]
-      }
-    },
-
-    "presets": {
-      "type": "array",
-      "description": "Presets are default configurations of sections that enable users to easily add a section to a JSON template through the theme editor.",
-      "markdownDescription": "Presets are default configurations of sections that enable users to easily add a section to a [JSON template](https://shopify.dev/docs/themes/architecture/templates/json-templates) through the theme editor.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#presets)",
-      "items": {
-        "$ref": "./preset.json"
-      }
-    },
-
-    "default": {
-      "type": "object",
-      "description": "Default configuration for statically rendered sections.",
-      "markdownDescription": "Default configuration for statically rendered sections.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#default)",
-      "properties": {
-        "settings": {
-          "$ref": "./default_setting_values.json"
-        },
-        "blocks": {
-          "type": "array",
-          "description": "Default blocks configurations to ship with this default.",
-          "markdownDescription": "Default blocks configurations to ship with this default.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#default)",
-          "items": {
-            "type": "object",
-            "required": ["type"],
-            "properties": {
-              "type": {
-                "type": "string",
-                "description": "The block type."
-              },
-              "settings": {
-                "$ref": "./default_setting_values.json"
-              }
-            }
-          }
-        }
-      }
-    },
-
-    "locales": {
-      "type": "object",
-      "description": "Sections can provide their own set of translated strings through the locales object. This is separate from the locales directory of the theme, which makes it a useful feature for sections that are meant to be installed on multiple themes or shops.",
-      "markdownDescription": "Sections can provide their own set of translated strings through the `locales` object. This is separate from the `locales` directory of the theme, which makes it a useful feature for sections that are meant to be installed on multiple themes or shops.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#locales)",
-      "additionalProperties": {
-        "type": "object",
-        "additionalProperties": {
-          "type": "string"
-        }
-      }
-    },
-
-    "enabled_on": {
-      "description": "Restrict the section to certain template page types and section group types.",
-      "markdownDescription": "Restrict the section to certain template page types and section group types.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#enabled_on)",
-      "$ref": "#/definitions/sectionToggle"
-    },
-
-    "disabled_on": {
-      "description": "Prevent the section from being used on certain template page types and section group types.",
-      "markdownDescription": "Prevent the section from being used on certain template page types and section group types.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/sections/section-schema#disabled_on)",
-      "$ref": "#/definitions/sectionToggle"
-    }
-  },
-
-  "definitions": {
-    "sectionToggle": {
-      "type": "object",
-      "description": "Restrict the section to certain template page types and section group types.",
-      "additionalProperties": false,
-      "properties": {
-        "templates": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "enum": [
-              "*",
-              "404",
-              "article",
-              "blog",
-              "captcha",
-              "cart",
-              "collection",
-              "customers/account",
-              "customers/activate_account",
-              "customers/addresses",
-              "customers/login",
-              "customers/order",
-              "customers/register",
-              "customers/reset_password",
-              "gift_card",
-              "index",
-              "list-collections",
-              "metaobject",
-              "page",
-              "password",
-              "policy",
-              "product",
-              "search"
-            ]
-          },
-          "uniqueItems": true
-        },
-        "groups": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "uniqueItems": true
-        }
-      }
-    }
-  }
-}