@platformos/platformos-check-common 0.0.17 → 0.0.18

package/dist/frontmatter/index.js

@@ -1,301 +1,9 @@
 "use strict";
-/**
- * Frontmatter schema definitions for platformOS Liquid file types.
- *
- * Each Liquid file type in platformOS has a YAML frontmatter section at the
- * top of the file that configures server-side behaviour. The schema for each
- * type is different — Pages have slug/layout, Emails have to/from/subject, etc.
- *
- * This module provides:
- *   - FrontmatterFieldSchema  — type definition for a single field
- *   - FrontmatterSchema       — type definition for a complete schema
- *   - FRONTMATTER_SCHEMAS     — per-type schemas keyed by PlatformOSFileType
- *   - getFrontmatterSchema()  — convenience lookup that returns undefined for
- *                               types without a frontmatter schema
- */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FRONTMATTER_SCHEMAS = void 0;
-exports.getFrontmatterSchema = getFrontmatterSchema;
-const platformos_common_1 = require("@platformos/platformos-common");
-// ─── Schemas ──────────────────────────────────────────────────────────────────
-/**
- * Per-type frontmatter schemas.
- *
- * Only Liquid file types are present here — GraphQL, YAML, and Asset types
- * do not use frontmatter.
- *
- * Field lists are based on real-world usage in platformOS apps. Set
- * `allowAdditionalFields: true` (the default) everywhere so that apps using
- * custom/undocumented keys don't get false-positive warnings until the schemas
- * are finalised.
- */
-exports.FRONTMATTER_SCHEMAS = {
-    // ── Page ─────────────────────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.Page]: {
-        name: 'Page',
-        fields: {
-            slug: {
-                type: 'string',
-                description: 'URL slug for this page. Supports dynamic segments (e.g. users/:id).',
-            },
-            layout: {
-                type: 'string',
-                description: 'Layout template to wrap this page (path relative to app root, no extension).',
-            },
-            layout_name: {
-                type: 'string',
-                description: 'Alias for layout.',
-                deprecated: true,
-                deprecatedMessage: 'Use `layout` instead of `layout_name`.',
-            },
-            method: {
-                type: 'string',
-                description: 'HTTP method this page responds to (get, post, put, patch, delete).',
-            },
-            authorization_policies: {
-                type: 'array',
-                description: 'List of authorization policy names that must pass before rendering.',
-            },
-            response_headers: {
-                type: 'string',
-                description: 'Liquid template that renders a JSON object of HTTP response headers.',
-            },
-            metadata: {
-                type: 'object',
-                description: 'Arbitrary metadata object (e.g. SEO title/description, robots directives).',
-            },
-            max_deep_level: {
-                type: 'integer',
-                description: 'Maximum number of dynamic URL segments to capture.',
-            },
-            searchable: {
-                type: 'boolean',
-                description: 'Whether this page is included in platformOS search indexes.',
-            },
-            format: {
-                type: 'string',
-                description: 'Response format (html, json, xml, csv, …). Often encoded in the filename.',
-            },
-        },
-        allowAdditionalFields: true,
-    },
-    // ── Layout ───────────────────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.Layout]: {
-        name: 'Layout',
-        fields: {
-            name: {
-                type: 'string',
-                description: 'Identifier used to reference this layout from pages.',
-            },
-        },
-        allowAdditionalFields: true,
-    },
-    // ── Partial ──────────────────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.Partial]: {
-        name: 'Partial',
-        fields: {
-            metadata: {
-                type: 'object',
-                description: 'Partial metadata. `metadata.params` declares accepted parameters; `metadata.name` is a human-readable label for the style guide.',
-            },
-        },
-        allowAdditionalFields: true,
-    },
-    // ── AuthorizationPolicy ──────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.Authorization]: {
-        name: 'AuthorizationPolicy',
-        fields: {
-            name: {
-                type: 'string',
-                required: true,
-                description: 'Unique identifier for this authorization policy.',
-            },
-            redirect_to: {
-                type: 'string',
-                description: 'URL to redirect the user to when the policy fails.',
-            },
-            flash_alert: {
-                type: 'string',
-                description: 'Flash alert message shown after a failed authorization redirect.',
-            },
-            flash_notice: {
-                type: 'string',
-                description: 'Flash notice message shown after a failed authorization redirect.',
-            },
-        },
-        allowAdditionalFields: true,
-    },
-    // ── Email ────────────────────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.Email]: {
-        name: 'Email',
-        fields: {
-            to: {
-                type: 'string',
-                required: true,
-                description: 'Recipient email address (may use Liquid).',
-            },
-            from: {
-                type: 'string',
-                description: 'Sender email address.',
-            },
-            reply_to: {
-                type: 'string',
-                description: 'Reply-to email address.',
-            },
-            cc: {
-                type: 'string',
-                description: 'Carbon-copy recipients.',
-            },
-            bcc: {
-                type: 'string',
-                description: 'Blind carbon-copy recipients.',
-            },
-            subject: {
-                type: 'string',
-                required: true,
-                description: 'Email subject line (may use Liquid).',
-            },
-            layout_path: {
-                type: 'string',
-                description: 'Layout partial to wrap the email body.',
-            },
-            delay: {
-                type: 'integer',
-                description: 'Seconds to delay delivery after being triggered.',
-            },
-            enabled: {
-                type: 'boolean',
-                description: 'When false, this email is never sent. Defaults to true.',
-            },
-            trigger_condition: {
-                type: ['boolean', 'string'],
-                description: 'Liquid expression or boolean; email is only sent when this evaluates to true.',
-            },
-        },
-        allowAdditionalFields: true,
-    },
-    // ── ApiCall ──────────────────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.ApiCall]: {
-        name: 'ApiCall',
-        fields: {
-            to: {
-                type: 'string',
-                required: true,
-                description: 'Target URL for the HTTP request (may use Liquid).',
-            },
-            request_type: {
-                type: 'string',
-                required: true,
-                description: 'HTTP method: GET, POST, PUT, PATCH, or DELETE.',
-            },
-            request_headers: {
-                type: 'string',
-                description: 'Liquid template rendering a JSON object of request headers.',
-            },
-            headers: {
-                type: 'string',
-                description: 'Alias for request_headers.',
-                deprecated: true,
-                deprecatedMessage: 'Use `request_headers` instead of `headers`.',
-            },
-            callback: {
-                type: 'string',
-                description: 'Liquid template executed after the HTTP response is received.',
-            },
-            delay: {
-                type: 'integer',
-                description: 'Seconds to delay the request after being triggered.',
-            },
-            enabled: {
-                type: 'boolean',
-                description: 'When false, this API call is never executed. Defaults to true.',
-            },
-            trigger_condition: {
-                type: ['boolean', 'string'],
-                description: 'Liquid expression or boolean; call is only made when this evaluates to true.',
-            },
-            format: {
-                type: 'string',
-                description: 'Request body encoding format (http, json, …).',
-            },
-        },
-        allowAdditionalFields: true,
-    },
-    // ── Sms ──────────────────────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.Sms]: {
-        name: 'SMS',
-        fields: {
-            to: {
-                type: 'string',
-                required: true,
-                description: 'Recipient phone number in E.164 format (may use Liquid).',
-            },
-            delay: {
-                type: 'integer',
-                description: 'Seconds to delay sending after being triggered.',
-            },
-            enabled: {
-                type: 'boolean',
-                description: 'When false, this SMS is never sent. Defaults to true.',
-            },
-            trigger_condition: {
-                type: ['boolean', 'string'],
-                description: 'Liquid expression or boolean; SMS is only sent when this evaluates to true.',
-            },
-        },
-        allowAdditionalFields: true,
-    },
-    // ── Migration ────────────────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.Migration]: {
-        name: 'Migration',
-        fields: {},
-        allowAdditionalFields: true,
-    },
-    // ── FormConfiguration ────────────────────────────────────────────────────────
-    [platformos_common_1.PlatformOSFileType.FormConfiguration]: {
-        name: 'FormConfiguration',
-        fields: {
-            name: {
-                type: 'string',
-                required: true,
-                description: 'Unique identifier for this form, used in include_form / function calls.',
-            },
-            resource: {
-                type: ['string', 'object'],
-                description: 'Model or resource type this form operates on.',
-            },
-            resource_owner: {
-                type: 'string',
-                description: 'Who owns the resource being created/updated.',
-            },
-            fields: {
-                type: 'object',
-                description: 'Field definitions — what data this form accepts and validates.',
-            },
-            redirect_to: {
-                type: 'string',
-                description: 'URL to redirect to after a successful form submission.',
-            },
-            flash_notice: {
-                type: 'string',
-                description: 'Flash notice message shown after a successful submission.',
-            },
-            flash_alert: {
-                type: 'string',
-                description: 'Flash alert message shown after a failed submission.',
-            },
-        },
-        allowAdditionalFields: true,
-    },
-};
-// ─── Lookup helper ────────────────────────────────────────────────────────────
-/**
- * Returns the frontmatter schema for a given file type, or undefined if no
- * schema is defined for that type (e.g. GraphQL, YAML, Asset types).
- */
-function getFrontmatterSchema(fileType) {
-    if (fileType === undefined)
-        return undefined;
-    return exports.FRONTMATTER_SCHEMAS[fileType];
-}
+exports.getFrontmatterSchema = exports.FRONTMATTER_SCHEMAS = void 0;
+// Frontmatter schemas and types live in platformos-common so they can be used
+// by other packages without depending on the full linting engine.
+var platformos_common_1 = require("@platformos/platformos-common");
+Object.defineProperty(exports, "FRONTMATTER_SCHEMAS", { enumerable: true, get: function () { return platformos_common_1.FRONTMATTER_SCHEMAS; } });
+Object.defineProperty(exports, "getFrontmatterSchema", { enumerable: true, get: function () { return platformos_common_1.getFrontmatterSchema; } });
 //# sourceMappingURL=index.js.map

package/dist/frontmatter/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/frontmatter/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;;;AAqUH,oDAKC;AAxUD,qEAAmE;AAkCnE,iFAAiF;AAEjF;;;;;;;;;;GAUG;AACU,QAAA,mBAAmB,GAA2D;IACzF,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,IAAI,CAAC,EAAE;QACzB,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,qEAAqE;aACnF;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,8EAA8E;aAC5F;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mBAAmB;gBAChC,UAAU,EAAE,IAAI;gBAChB,iBAAiB,EAAE,wCAAwC;aAC5D;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,oEAAoE;aAClF;YACD,sBAAsB,EAAE;gBACtB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,qEAAqE;aACnF;YACD,gBAAgB,EAAE;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sEAAsE;aACpF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,4EAA4E;aAC1F;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,oDAAoD;aAClE;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,6DAA6D;aAC3E;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,2EAA2E;aACzF;SACF;QACD,qBAAqB,EAAE,IAAI;KAC5B;IAED,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,MAAM,CAAC,EAAE;QAC3B,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sDAAsD;aACpE;SACF;QACD,qBAAqB,EAAE,IAAI;KAC5B;IAED,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,OAAO,CAAC,EAAE;QAC5B,IAAI,EAAE,SAAS;QACf,MAAM,EAAE;YACN,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,kIAAkI;aACrI;SACF;QACD,qBAAqB,EAAE,IAAI;KAC5B;IAED,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,aAAa,CAAC,EAAE;QAClC,IAAI,EAAE,qBAAqB;QAC3B,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,kDAAkD;aAChE;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,oDAAoD;aAClE;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,kEAAkE;aAChF;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mEAAmE;aACjF;SACF;QACD,qBAAqB,EAAE,IAAI;KAC5B;IAED,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,KAAK,CAAC,EAAE;QAC1B,IAAI,EAAE,OAAO;QACb,MAAM,EAAE;YACN,EAAE,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,2CAA2C;aACzD;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,uBAAuB;aACrC;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yBAAyB;aACvC;YACD,EAAE,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yBAAyB;aACvC;YACD,GAAG,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+BAA+B;aAC7C;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,sCAAsC;aACpD;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,wCAAwC;aACtD;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,kDAAkD;aAChE;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,yDAAyD;aACvE;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;gBAC3B,WAAW,EACT,+EAA+E;aAClF;SACF;QACD,qBAAqB,EAAE,IAAI;KAC5B;IAED,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,OAAO,CAAC,EAAE;QAC5B,IAAI,EAAE,SAAS;QACf,MAAM,EAAE;YACN,EAAE,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,mDAAmD;aACjE;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,gDAAgD;aAC9D;YACD,eAAe,EAAE;gBACf,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,6DAA6D;aAC3E;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,4BAA4B;gBACzC,UAAU,EAAE,IAAI;gBAChB,iBAAiB,EAAE,6CAA6C;aACjE;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+DAA+D;aAC7E;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,qDAAqD;aACnE;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,gEAAgE;aAC9E;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;gBAC3B,WAAW,EAAE,8EAA8E;aAC5F;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,+CAA+C;aAC7D;SACF;QACD,qBAAqB,EAAE,IAAI;KAC5B;IAED,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,GAAG,CAAC,EAAE;QACxB,IAAI,EAAE,KAAK;QACX,MAAM,EAAE;YACN,EAAE,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,0DAA0D;aACxE;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,iDAAiD;aAC/D;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS;gBACf,WAAW,EAAE,uDAAuD;aACrE;YACD,iBAAiB,EAAE;gBACjB,IAAI,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;gBAC3B,WAAW,EAAE,6EAA6E;aAC3F;SACF;QACD,qBAAqB,EAAE,IAAI;KAC5B;IAED,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,SAAS,CAAC,EAAE;QAC9B,IAAI,EAAE,WAAW;QACjB,MAAM,EAAE,EAAE;QACV,qBAAqB,EAAE,IAAI;KAC5B;IAED,gFAAgF;IAChF,CAAC,sCAAkB,CAAC,iBAAiB,CAAC,EAAE;QACtC,IAAI,EAAE,mBAAmB;QACzB,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,yEAAyE;aACvF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;gBAC1B,WAAW,EAAE,+CAA+C;aAC7D;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,8CAA8C;aAC5D;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,gEAAgE;aAC9E;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,wDAAwD;aACtE;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,2DAA2D;aACzE;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sDAAsD;aACpE;SACF;QACD,qBAAqB,EAAE,IAAI;KAC5B;CACF,CAAC;AAEF,iFAAiF;AAEjF;;;GAGG;AACH,SAAgB,oBAAoB,CAClC,QAAwC;IAExC,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC7C,OAAO,2BAAmB,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/frontmatter/index.ts"],"names":[],"mappings":";;;AAAA,8EAA8E;AAC9E,kEAAkE;AAClE,mEAMuC;AAFrC,wHAAA,mBAAmB,OAAA;AACnB,yHAAA,oBAAoB,OAAA"}