@platformos/platformos-check-common 0.0.2

package/src/types/schemas/setting.ts

@@ -0,0 +1,320 @@
+export declare namespace Setting {
+  /** Setting values are  */
+  export type Values = Record<string, string | number | boolean | string[]>;
+
+  /** Union type of all setting types */
+  export type Any = InputSetting | SideBarSetting;
+
+  /** Settings used for display */
+  export type SideBarSetting = Header | Paragraph;
+
+  /** Settings with data */
+  export type InputSetting =
+    | Article
+    | Blog
+    | Collection
+    | Page
+    | Product
+    | CollectionList
+    | ProductList
+    | MetaobjectList
+    | Text
+    | Textarea
+    | Richtext
+    | InlineRichtext
+    | Html
+    | Url
+    | TextAlignment
+    | Number
+    | Range
+    | Checkbox
+    | Radio
+    | Select
+    | Color
+    | ColorBackground
+    | ColorScheme
+    | ColorSchemeGroup
+    | ImagePicker
+    | Video
+    | VideoUrl
+    | FontPicker
+    | LinkList
+    | Liquid
+    | Metaobject
+    | StyleLayoutPanel
+    | StyleSizePanel
+    | StyleSpacingPanel;
+
+  export enum Type {
+    // Resource Settings
+    Article = 'article',
+    Blog = 'blog',
+    Collection = 'collection',
+    Page = 'page',
+    Product = 'product',
+
+    // Resource List Settings
+    CollectionList = 'collection_list',
+    ProductList = 'product_list',
+    MetaobjectList = 'metaobject_list',
+
+    // Text Settings
+    Text = 'text',
+    Textarea = 'textarea',
+    Richtext = 'richtext',
+    InlineRichtext = 'inline_richtext',
+    Html = 'html',
+    Url = 'url',
+    TextAlignment = 'text_alignment',
+
+    // Number Settings
+    Number = 'number',
+    Range = 'range',
+
+    // Choice Settings
+    Checkbox = 'checkbox',
+    Radio = 'radio',
+    Select = 'select',
+
+    // Color Settings
+    Color = 'color',
+    ColorBackground = 'color_background',
+    ColorScheme = 'color_scheme',
+    ColorSchemeGroup = 'color_scheme_group',
+
+    // Media Settings
+    ImagePicker = 'image_picker',
+    Video = 'video',
+    VideoUrl = 'video_url',
+
+    // Special Settings
+    FontPicker = 'font_picker',
+    LinkList = 'link_list',
+    Liquid = 'liquid',
+    Metaobject = 'metaobject',
+
+    // Style Panel Settings
+    StyleLayoutPanel = 'style.layout_panel',
+    StyleSizePanel = 'style.size_panel',
+    StyleSpacingPanel = 'style.spacing_panel',
+
+    // Sidebar Settings
+    Header = 'header',
+    Paragraph = 'paragraph',
+  }
+
+  // Base Setting Interface
+  export interface Base<T extends Type> {
+    type: T;
+    id: string;
+    label?: string;
+    info?: string;
+  }
+
+  // Sidebar Settings
+  export interface Header extends Base<Type.Header> {
+    content: string;
+  }
+
+  export interface Paragraph extends Base<Type.Paragraph> {
+    content: string;
+  }
+
+  // Resource Settings
+  export interface Resource<T extends Type> extends Base<T> {
+    default?: string;
+  }
+
+  export interface Article extends Resource<Type.Article> {}
+  export interface Blog extends Resource<Type.Blog> {}
+  export interface Collection extends Resource<Type.Collection> {}
+  export interface Page extends Resource<Type.Page> {}
+  export interface Product extends Resource<Type.Product> {}
+
+  // Resource List Settings
+  export interface ResourceList<T extends Type> extends Base<T> {
+    limit?: number;
+  }
+
+  export interface CollectionList extends ResourceList<Type.CollectionList> {}
+  export interface ProductList extends ResourceList<Type.ProductList> {}
+  export interface MetaobjectList extends ResourceList<Type.MetaobjectList> {
+    metaobject_type: string;
+  }
+
+  // Text Settings
+  export interface TextBase<T extends Type> extends Base<T> {
+    default?: string;
+    placeholder?: string;
+  }
+
+  export interface Text extends TextBase<Type.Text> {}
+  export interface Textarea extends TextBase<Type.Textarea> {}
+  export interface Richtext extends TextBase<Type.Richtext> {}
+  export interface InlineRichtext extends TextBase<Type.InlineRichtext> {}
+  export interface Html extends TextBase<Type.Html> {}
+  export interface Url extends TextBase<Type.Url> {}
+
+  export interface TextAlignment extends Base<Type.TextAlignment> {
+    default?: 'left' | 'center' | 'right' | 'justify';
+  }
+
+  // Number Settings
+  export interface NumberBase<T extends Type> extends Base<T> {
+    default?: number;
+    min?: number;
+    max?: number;
+    step?: number;
+    unit?: string;
+  }
+
+  export interface Number extends NumberBase<Type.Number> {}
+  export interface Range extends NumberBase<Type.Range> {}
+
+  // Choice Settings
+  export interface Checkbox extends Base<Type.Checkbox> {
+    default?: boolean;
+  }
+
+  export interface ChoiceOption {
+    value: string;
+    label: string;
+  }
+
+  export interface ChoiceBase<T extends Type> extends Base<T> {
+    options: ChoiceOption[];
+    default?: string;
+  }
+
+  export interface Radio extends ChoiceBase<Type.Radio> {}
+  export interface Select extends ChoiceBase<Type.Select> {}
+
+  // Color Settings
+  export interface ColorBase<T extends Type> extends Base<T> {
+    default?: string;
+  }
+
+  export interface Color extends ColorBase<Type.Color> {}
+  export interface ColorBackground extends ColorBase<Type.ColorBackground> {}
+  export interface ColorScheme extends Base<Type.ColorScheme> {
+    default?: string;
+  }
+  export interface ColorSchemeGroup extends Base<Type.ColorSchemeGroup> {}
+
+  // Media Settings
+  export interface ImagePicker extends Base<Type.ImagePicker> {
+    default?: string;
+  }
+
+  export interface Video extends Base<Type.Video> {
+    default?: string;
+  }
+
+  export interface VideoUrl extends Base<Type.VideoUrl> {
+    default?: string;
+    accept: Array<'youtube' | 'vimeo'>;
+  }
+
+  // Special Settings
+  export interface FontPicker extends Base<Type.FontPicker> {
+    default?: string;
+  }
+
+  export interface LinkList extends Base<Type.LinkList> {
+    default?: string;
+  }
+
+  export interface Liquid extends Base<Type.Liquid> {
+    default?: string;
+  }
+
+  export interface Metaobject extends Base<Type.Metaobject> {
+    metaobject_type: string;
+  }
+
+  // Style Panel Settings
+  export interface StyleLayoutPanel extends Base<Type.StyleLayoutPanel> {
+    default?: {
+      'flex-direction'?: 'row' | 'row-reverse' | 'column' | 'column-reverse';
+      'flex-wrap'?: 'nowrap' | 'wrap' | 'wrap-reverse';
+      'justify-content'?:
+        | 'flex-start'
+        | 'flex-end'
+        | 'start'
+        | 'end'
+        | 'left'
+        | 'right'
+        | 'center'
+        | 'space-between'
+        | 'space-around'
+        | 'space-evenly';
+      'align-items'?:
+        | 'stretch'
+        | 'flex-start'
+        | 'start'
+        | 'self-start'
+        | 'flex-end'
+        | 'end'
+        | 'self-end'
+        | 'center'
+        | 'baseline';
+      'align-content'?:
+        | 'stretch'
+        | 'flex-start'
+        | 'start'
+        | 'flex-end'
+        | 'end'
+        | 'center'
+        | 'space-between'
+        | 'space-around'
+        | 'space-evenly';
+      gap?: string;
+      'row-gap'?: string;
+      'column-gap'?: string;
+      '@media (--mobile)'?: Partial<StyleLayoutPanel['default']>;
+    };
+  }
+
+  export interface StyleSizePanel extends Base<Type.StyleSizePanel> {
+    default?: {
+      width?: string;
+      'min-width'?: string;
+      'max-width'?: string;
+      height?: string;
+      'min-height'?: string;
+      'max-height'?: string;
+      'flex-grow'?: string;
+      'flex-shrink'?: string;
+      'flex-basis'?: string;
+      '@media (--mobile)'?: Partial<StyleSizePanel['default']>;
+    };
+  }
+
+  export interface StyleSpacingPanel extends Base<Type.StyleSpacingPanel> {
+    default?: {
+      padding?: string;
+      'padding-top'?: string;
+      'padding-right'?: string;
+      'padding-bottom'?: string;
+      'padding-left'?: string;
+      'padding-block'?: string;
+      'padding-block-start'?: string;
+      'padding-block-end'?: string;
+      'padding-inline'?: string;
+      'padding-inline-start'?: string;
+      'padding-inline-end'?: string;
+      margin?: string;
+      'margin-top'?: string;
+      'margin-right'?: string;
+      'margin-bottom'?: string;
+      'margin-left'?: string;
+      'margin-block'?: string;
+      'margin-block-start'?: string;
+      'margin-block-end'?: string;
+      'margin-inline'?: string;
+      'margin-inline-start'?: string;
+      'margin-inline-end'?: string;
+      '@media (--mobile)'?: Partial<StyleSpacingPanel['default']>;
+    };
+  }
+}

package/src/types/schemas/template.ts

@@ -0,0 +1,34 @@
+import { Setting } from './setting';
+
+export namespace Template {
+  export interface Template {
+    layout?: string | false;
+    wrapper?: string;
+    sections: Record<string, Template.Section>;
+    order: string[];
+  }
+
+  export interface Section {
+    type: string;
+    settings?: Setting.Values;
+    disabled?: boolean;
+    blocks?: Record<string, Template.Block>;
+    block_order?: string[];
+  }
+
+  export interface Block {
+    type: string;
+    settings?: Setting.Values;
+    disabled?: boolean;
+    blocks?: Record<string, Template.Block>;
+    block_order?: string[];
+    static?: boolean;
+  }
+
+  export interface SectionGroup {
+    type: string;
+    name: string;
+    sections: Record<string, Template.Section>;
+    order: string[];
+  }
+}

package/src/types/schemas/theme-block.ts

@@ -0,0 +1,34 @@
+import { Setting } from './setting';
+import { Preset } from './preset';
+
+export declare namespace ThemeBlock {
+  /** Typed content of {% schema %} after passing validation */
+  export interface Schema {
+    name?: string;
+    settings?: Setting.Any[];
+    blocks?: Block[];
+    presets?: Preset.Preset[];
+    class?: string;
+    tag?: string | null;
+  }
+
+  export type ThemeBlock = {
+    type: '@theme';
+  };
+
+  export type AppBlock = {
+    type: '@app';
+  };
+
+  export type SpecificThemeBlock = {
+    /** blocks/{type}.liquid */
+    type: string;
+  };
+
+  // prettier-ignore
+  export type Block = (
+    | ThemeBlock
+    | AppBlock
+    | SpecificThemeBlock
+  );
+}

package/src/types/theme-liquid-docs.ts

@@ -0,0 +1,184 @@
+import { Mode, Translations } from '..';
+
+/**
+ * Shopify themes docset.
+ */
+export interface ThemeDocset {
+  /** Whether it was augmented prior to being passed. */
+  isAugmented?: boolean;
+
+  /** Returns Liquid filters available on themes. */
+  filters(): Promise<FilterEntry[]>;
+
+  /** Returns objects (or Liquid variables) available on themes. */
+  objects(): Promise<ObjectEntry[]>;
+
+  /** Returns objects (excluding global variables, hidden objects, and deprecated objects) available on themes. */
+  liquidDrops(): Promise<ObjectEntry[]>;
+
+  /** Returns Liquid tags available on themes. */
+  tags(): Promise<TagEntry[]>;
+
+  /** Returns graphql root query */
+  graphQL(): Promise<string | null>;
+
+  /** Returns system translations available on themes. */
+  systemTranslations(): Promise<Translations>;
+}
+
+/** A URI that will uniquely describe the schema */
+export type JSONSchemaURI = string;
+
+export interface SchemaDefinition {
+  /** A URI that will uniquely describe the schema */
+  uri: JSONSchemaURI;
+
+  /** A JSON Schema as string */
+  schema: string;
+
+  /**
+   * When absent, does not match on file. Assumed to be used by other
+   * schemas.
+   *
+   * e.g. '\*\*\/sections\/\*.liquid', '\*\*\/locales\/*.json'
+   */
+  fileMatch?: string[];
+}
+
+/** Source of JSON schemas for themes. */
+export interface JsonValidationSet {
+  /** All relevant SchemaDefinitions. */
+  schemas: (mode: Mode) => Promise<SchemaDefinition[]>;
+}
+
+export interface DocsetEntry {
+  /** The name of the entry. */
+  name: string;
+
+  /** A brief summary of the entry. */
+  summary?: string;
+
+  /** A detailed description of the entry. */
+  description?: string;
+
+  /** Whether the entry is deprecated or not. */
+  deprecated?: boolean;
+
+  /** The reason why the entry is deprecated. */
+  deprecation_reason?: string;
+
+  /** documentation examples */
+  examples?: Example[];
+}
+
+export interface ObjectEntry extends DocsetEntry {
+  /**
+   * Holds the information on whether an ObjectEntry refers to a type or global variable.
+   *
+   * When not defined, we assume it's a global.
+   */
+  access?: Access;
+
+  /**
+   * Object properties and their types
+   */
+  properties?: ObjectEntry[];
+
+  /**
+   * The return type of the variable.
+   * When multiple, it's because the return value is an enum (e.g. video | image).
+   */
+  return_type?: ReturnType[];
+
+  /** Don't care about this */
+  json_data?: JsonData;
+}
+
+export interface FilterEntry extends DocsetEntry {
+  /** Used for categorization on the docs website */
+  category?: string;
+
+  /** Argument types */
+  parameters?: Parameter[];
+
+  /** Return type */
+  return_type?: ReturnType[];
+
+  /** e.g. cart | item_count_for_variant: {variant_id} */
+  syntax?: string;
+}
+
+export interface TagEntry extends DocsetEntry {
+  /** Used for categorization on the docs website */
+  category?: string;
+
+  /** Argument types */
+  parameters?: Parameter[];
+
+  /** e.g. {% for item in array %}\n  expression{% endfor %} */
+  syntax?: string;
+
+  /** e.g. item, array, expression */
+  syntax_keywords?: SyntaxKeyword[];
+}
+
+export interface Access {
+  /** Whether the ObjectEntry is a global variable or a type */
+  global: boolean;
+  parents: Parent[];
+  template: string[];
+}
+
+export interface Parent {
+  object: string;
+  property: string;
+}
+
+export interface Parameter {
+  description: string;
+  name: string;
+  positional: boolean;
+  required: boolean;
+  types: string[];
+}
+
+export interface SyntaxKeyword {
+  description: string;
+  keyword: string;
+}
+
+export interface Example {
+  /* don't care about this */
+  // description: string;
+  // display_type: string;
+  // name: string;
+  // parameter: boolean;
+  // path: string;
+  // raw_liquid: string;
+  // show_data_tab: boolean;
+  // syntax: string;
+}
+
+export interface JsonData {
+  /* don't care about those */
+  // data_from_file: string;
+  // handle: string;
+  // path: string;
+}
+
+export type ReturnType = EnumReturnType | ArrayReturnType | OtherReturnType;
+
+export interface EnumReturnType {
+  type: 'string';
+  name: string;
+}
+
+export interface ArrayReturnType {
+  type: 'array';
+  array_value: string;
+}
+
+export interface OtherReturnType {
+  type: 'string' | 'number' | 'untyped' | string;
+  name: '';
+}

package/src/types/theme-schemas.ts

@@ -0,0 +1,80 @@
+import { SourceCode, SourceCodeType } from '../types';
+import { Section, ThemeBlock } from './schemas';
+
+export * from './schemas';
+
+export enum ThemeSchemaType {
+  AppBlock = 'app-block',
+  Block = 'block',
+  Section = 'section',
+}
+
+/** {% content_for 'block', type: type, id: id %}*/
+export type StaticBlockDef = { type: string; id: string };
+
+/**
+ * A ThemeSchema represents the `{% schema %}` contents of a block or section file.
+ *
+ * `ast` and `parsed` will be instances of `Error` if there was an error parsing
+ * the Liquid file or the JSON.
+ *
+ * There is no guarantee that the `ast` or `parsed` fields are backend-valid.
+ */
+export interface ThemeSchema<T extends ThemeSchemaType> {
+  /** section or block */
+  type: T;
+
+  /** `section/${name}.liquid` */
+  name: string;
+
+  /** Parsed as an AST (with position information) or an Error */
+  ast: SourceCode<SourceCodeType.JSON>['ast'] | Error;
+
+  /** Parsed as a JavaScript object or an Error */
+  parsed: any | Error;
+
+  /** 0-based index of the start of JSON object in the document */
+  offset: number;
+
+  /** schema node value */
+  value: string;
+}
+
+/** See {@link ThemeSchema} */
+export interface ThemeBlockSchema extends ThemeSchema<ThemeSchemaType.Block> {
+  /**
+   * @example
+   * const schema = await context.getBlockSchema('product');
+   * const validSchema = schema?.validSchema;
+   * if (!validSchema || validSchema instanceof Error) return;
+   *
+   * for (const block of validSchema.blocks ?? []) {
+   *  // do something
+   * }
+   */
+  validSchema: ThemeBlock.Schema | Error;
+
+  /** type/id pairs found in the body of the file */
+  staticBlockDefs: StaticBlockDef[];
+}
+
+/** See {@link ThemeSchema} */
+export interface SectionSchema extends ThemeSchema<ThemeSchemaType.Section> {
+  /**
+   * @example
+   * const schema = await context.getSectionSchema('product');
+   * const validSchema = schema?.validSchema;
+   * if (!validSchema || validSchema instanceof Error) return;
+   *
+   * for (const block of validSchema.blocks ?? []) {
+   *  // do something
+   * }
+   */
+  validSchema: Section.Schema | Error;
+
+  /** type/id pairs found in the body of the file */
+  staticBlockDefs: StaticBlockDef[];
+}
+
+/** TODO setup validSchema like the other ones. */
+export interface AppBlockSchema extends ThemeSchema<ThemeSchemaType.AppBlock> {}