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

package/data/targetted_block_entry.json

@@ -1,15 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$comment": "A targetted private or public theme block from the blocks/ folder.",
-  "type": "object",
-  "required": ["type"],
-  "additionalProperties": false,
-  "properties": {
-    "type": {
-      "type": "string",
-      "pattern": "^[a-zA-Z0-9_-]+$",
-      "description": "The name of a theme block found in the blocks/ folder of the theme.",
-      "markdownDescription": "The name of a theme block found in the `blocks/` folder of the theme.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#blocks)"
-    }
-  }
-}

package/data/theme_block.json

@@ -1,91 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Shopify Liquid Theme Block Schema",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "The name attribute determines the block title that's shown in the theme editor.",
-      "markdownDescription": "The `name` attribute determines the block title that's shown in the theme editor.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#name)"
-    },
-
-    "settings": {
-      "$ref": "./settings.json"
-    },
-
-    "blocks": {
-      "type": "array",
-      "description": "Theme blocks can accept other app and theme blocks as children using the blocks attribute of their schema.",
-      "markdownDescription": "Theme blocks can accept other app and theme blocks as children using the `blocks` attribute of their schema.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#blocks)",
-      "items": {
-        "type": "object",
-        "additionalProperties": false,
-        "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": { "$ref": "./targetted_block_entry.json" }
-          }
-        ]
-      }
-    },
-
-    "presets": {
-      "type": "array",
-      "description": "Presets are default configurations of blocks that enable merchants to easily add a block to a JSON template through the theme editor.",
-      "markdownDescription": "Presets are default configurations of blocks that enable merchants to easily add a block to a JSON template through the theme editor.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#presets)",
-      "items": {
-        "$ref": "./preset.json"
-      }
-    },
-
-    "tag": {
-      "description": "The HTML element that is used to wrap the rendered block. Accepts any string up to 50 characters. Can be used to render custom HTML elements. Use null to render without a wrapping element.",
-      "markdownDescription": "The HTML element that is used to wrap the rendered block. Accepts any string up to 50 characters. Can be used to render custom HTML elements.\n\nUse `null` to render without a wrapping element.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#tag)",
-      "oneOf": [
-        {
-          "description": "If you don't want to use a <div>, then you can specify which kind of HTML element to use.",
-          "markdownDescription": "If you don't want to use a `<div>`, then you can specify which kind of HTML element to use.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#tag)",
-          "type": "string",
-          "maxLength": 50
-        },
-        {
-          "description": "Used to render the block without a wrapping element.",
-          "markdownDescription": "Used to render the block without a wrapping element.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#rendering-blocks-without-a-wrapper)",
-          "type": "null"
-        }
-      ]
-    },
-
-    "class": {
-      "type": "string",
-      "description": "When Shopify renders a block, it's wrapped in an HTML element with the shopify-block class. You can append other classes by using the class attribute.",
-      "markdownDescription": "When Shopify renders a block, it's wrapped in an HTML element with the `shopify-block` class. You can append other classes by using the class attribute.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#class)"
-    }
-  }
-}

package/data/theme_block_entry.json

@@ -1,14 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$comment": "A @theme block entry",
-  "type": "object",
-  "additionalProperties": false,
-  "required": ["type"],
-  "properties": {
-    "type": {
-      "const": "@theme",
-      "description": "The \"@theme\" type denotes that this container accepts theme blocks that live in the blocks/ folder of the theme.",
-      "markdownDescription": "The `@theme` type denotes that this container accepts theme blocks that live in the `blocks/` folder of the theme.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/blocks/theme-blocks/schema#blocks)"
-    }
-  }
-}

package/data/theme_settings.json

@@ -1,83 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "JSON schema for config/settings_schema.json files.",
-  "description": "The settings that merchants can configure in the theme editor.",
-  "markdownDescription": "The settings that merchants can configure in the theme editor.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/config/settings-schema-json)",
-  "type": "array",
-  "items": {
-    "anyOf": [
-      {
-        "title": "Theme metadata",
-        "markdownDescription": "Additional metadata for your theme that shows up in the Theme actions menu of the theme editor.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/config/settings-schema-json#add-theme-metadata)",
-        "type": "object",
-        "properties": {
-          "name": {
-            "description": "You may use the 'theme_info' object for theme metadata.",
-            "markdownDescription": "[Shopify reference](https://shopify.dev/docs/themes/architecture/config/settings-schema-json#add-theme-metadata)",
-            "const": "theme_info"
-          },
-          "theme_name": {
-            "type": "string",
-            "description": "The name of the theme."
-          },
-          "theme_author": {
-            "type": "string",
-            "description": "The author of the theme."
-          },
-          "theme_version": {
-            "type": "string",
-            "description": "The version number of the theme."
-          },
-          "theme_documentation_url": {
-            "type": "string",
-            "format": "uri",
-            "description": "A URL where merchants can find documentation for the theme."
-          },
-          "theme_support_email": {
-            "type": "string",
-            "format": "email",
-            "description": "An email address that merchants can contact for support for the theme."
-          },
-          "theme_support_url": {
-            "type": "string",
-            "format": "uri",
-            "description": "A URL where merchants can find support for the theme."
-          }
-        },
-        "required": [
-          "name",
-          "theme_name",
-          "theme_author",
-          "theme_version",
-          "theme_documentation_url"
-        ],
-        "oneOf": [
-          {
-            "required": ["theme_support_email"],
-            "not": { "required": ["theme_support_url"] }
-          },
-          {
-            "required": ["theme_support_url"],
-            "not": { "required": ["theme_support_email"] }
-          }
-        ]
-      },
-      {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string",
-            "description": "The name of the category of settings.",
-            "markdownDescription": "The name of the category of settings.\n\n---\n\n[Shopify reference](https://shopify.dev/docs/themes/architecture/config/settings-schema-json#schema)",
-            "not": {
-              "const": "theme_info"
-            }
-          },
-          "settings": {
-            "$ref": "./settings.json"
-          }
-        }
-      }
-    ]
-  }
-}

package/src/themeLiquidDocsDownloader.ts

@@ -1,191 +0,0 @@
-import { Mode } from '@platformos/platformos-check-common';
-import envPaths from 'env-paths';
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import { Logger, noop, tap } from './utils';
-import he from 'he';
-const paths = envPaths('theme-liquid-docs');
-export const root = paths.cache;
-
-export const ThemeLiquidDocsRootFallback =
-  'https://raw.githubusercontent.com/Shopify/theme-liquid-docs/main';
-export const ThemeLiquidDocsRoot = 'https://documentation.platformos.com/api/liquid';
-export const ThemeCustomSchemas = ['tags', 'latest', 'objects', 'filters'];
-export const ThemeGraphQLSchema = 'https://documentation.platformos.com/api/graphql/schema';
-
-export type Resource = (typeof Resources)[number];
-export const Resources = [
-  'filters',
-  'objects',
-  'tags',
-  'shopify_system_translations',
-  'manifest_theme',
-  'manifest_theme_app_extension',
-] as const;
-
-export const Manifests = {
-  app: 'manifest_theme_app_extension',
-  theme: 'manifest_theme',
-} as const satisfies Record<Mode, Resource>;
-
-const THEME_LIQUID_DOCS: Record<Resource | 'latest', string> = {
-  filters: 'filters.json',
-  objects: 'objects.json',
-  tags: 'tags.json',
-  latest: 'latest.json',
-  shopify_system_translations: 'data/shopify_system_translations.json',
-  manifest_theme: 'schemas/manifest_theme.json',
-  manifest_theme_app_extension: 'schemas/manifest_theme_app_extension.json',
-};
-
-export async function downloadSchema(
-  relativeUri: string,
-  destination: string = root,
-  log: Logger = noop,
-) {
-  const remotePath = schemaUrl(relativeUri);
-  const localPath = schemaPath(relativeUri, destination);
-  const text = await download(remotePath, log);
-  await fs.writeFile(localPath, text, 'utf8');
-  return text;
-}
-
-export async function downloadResource(
-  resource: Resource | 'latest',
-  destination: string = root,
-  log: Logger = noop,
-) {
-  const remotePath = resourceUrl(resource);
-  const localPath = resourcePath(resource, destination);
-  const text = await download(remotePath, log);
-  await fs.writeFile(localPath, text, 'utf8');
-  return text;
-}
-
-export async function downloadGraphQLSchema(destination: string = root, log: Logger = noop) {
-  const localPath = graphQLPath(destination);
-  const text = await download(ThemeGraphQLSchema, log);
-  await fs.writeFile(localPath, he.decode(text), 'utf8');
-  return text;
-}
-
-export function graphQLPath(destination: string = root) {
-  return path.join(destination, `graphql.graphql`);
-}
-
-export async function download(path: string, log: Logger) {
-  if (path.startsWith('file:')) {
-    return await fs
-      .readFile(path.replace(/^file:/, ''), 'utf8')
-      .then(tap(() => log(`Using local file: ${path}`)))
-      .catch((error) => {
-        log(`Failed to read local file: ${path}`);
-        throw error;
-      });
-  } else {
-    log(path);
-    const res = await fetch(path);
-    return res.text();
-  }
-}
-
-export function resourcePath(resource: Resource | 'latest', destination: string = root) {
-  return path.join(destination, `${resource}.json`);
-}
-
-export function resourceUrl(resource: Resource | 'latest') {
-  let resourceRoot = `${ThemeLiquidDocsRootFallback}`;
-
-  if (ThemeCustomSchemas.includes(resource)) {
-    resourceRoot = ThemeLiquidDocsRoot;
-  }
-  const relativePath = THEME_LIQUID_DOCS[resource];
-  return `${resourceRoot}/${relativePath}`;
-}
-
-export function schemaPath(relativeUri: string, destination: string = root) {
-  return path.resolve(destination, path.basename(relativeUri));
-}
-
-export function schemaUrl(relativeUri: string) {
-  const schemaRoot = process.env.SHOPIFY_TLD_ROOT
-    ? `file:${process.env.SHOPIFY_TLD_ROOT}`
-    : ThemeLiquidDocsRootFallback;
-  return `${schemaRoot}/schemas/${relativeUri}`;
-}
-
-export async function exists(path: string) {
-  try {
-    await fs.stat(path);
-    return true;
-  } catch (e) {
-    return false;
-  }
-}
-
-export async function downloadThemeLiquidDocs(destination: string, log: Logger) {
-  if (!(await exists(destination))) {
-    await fs.mkdir(destination);
-  }
-
-  const resources = ['latest'].concat(Resources) as (Resource | 'latest')[];
-  const resourceContents = await Promise.all(
-    resources.map((file) => {
-      return downloadResource(file, destination, log)
-        .then(
-          tap(() =>
-            log(
-              `Successfully downloaded latest resource:\n\t${resourceUrl(file)}\n\t> ${resourcePath(
-                file,
-                destination,
-              )}`,
-            ),
-          ),
-        )
-        .catch((error) => {
-          log(
-            `Failed to download latest resource:\n\t${resourceUrl(file)} to\n\t${resourcePath(
-              file,
-              destination,
-            )}\n${error}`,
-          );
-          throw error;
-        });
-    }),
-  );
-
-  const manifests = Object.values(Manifests)
-    .map((resource) => resources.indexOf(resource))
-    .map((index) => resourceContents[index])
-    .map((manifest) => JSON.parse(manifest));
-
-  const relativeUris = manifests.flatMap((manifest) =>
-    manifest.schemas.map((schema: { uri: string }) => schema.uri),
-  );
-
-  await Promise.all(
-    unique(relativeUris).map((uri) =>
-      downloadSchema(uri, destination, log)
-        .then(
-          tap(() =>
-            log(
-              `Successfully downloaded schema:\n\t${schemaUrl(uri)}\n\t> ${schemaPath(
-                uri,
-                destination,
-              )}`,
-            ),
-          ),
-        )
-        .catch((error) => {
-          log(`Failed to download schema: ${uri}, ${error}`);
-          throw error;
-        }),
-    ),
-  );
-
-  await downloadGraphQLSchema(destination, log);
-}
-
-function unique<T>(array: T[]): T[] {
-  return [...new Set(array).values()];
-}