@platformos/platformos-check-common 0.0.2

package/dist/types/theme-liquid-docs.d.ts

@@ -0,0 +1,131 @@
+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 {
+}
+export interface JsonData {
+}
+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/dist/types/theme-liquid-docs.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=theme-liquid-docs.js.map

package/dist/types/theme-liquid-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme-liquid-docs.js","sourceRoot":"","sources":["../../src/types/theme-liquid-docs.ts"],"names":[],"mappings":""}

package/dist/types/theme-schemas.d.ts

@@ -0,0 +1,70 @@
+import { SourceCode, SourceCodeType } from '../types';
+import { Section, ThemeBlock } from './schemas';
+export * from './schemas';
+export declare 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> {
+}

package/dist/types/theme-schemas.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThemeSchemaType = void 0;
+__exportStar(require("./schemas"), exports);
+var ThemeSchemaType;
+(function (ThemeSchemaType) {
+    ThemeSchemaType["AppBlock"] = "app-block";
+    ThemeSchemaType["Block"] = "block";
+    ThemeSchemaType["Section"] = "section";
+})(ThemeSchemaType || (exports.ThemeSchemaType = ThemeSchemaType = {}));
+//# sourceMappingURL=theme-schemas.js.map

package/dist/types/theme-schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme-schemas.js","sourceRoot":"","sources":["../../src/types/theme-schemas.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAGA,4CAA0B;AAE1B,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,yCAAsB,CAAA;IACtB,kCAAe,CAAA;IACf,sCAAmB,CAAA;AACrB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B"}