@augeo/smelt 1.2.2 → 1.2.3

package/dist/schema.d.mts

@@ -248,18 +248,20 @@ interface SectionToggle1 {
 //#endregion
 //#region lib/schema.d.ts
 /**
- * Identity helper for authoring a Shopify section schema. The `const T`
- * parameter preserves literal types so the schema author gets autocomplete
- * for setting `type` values, `id`s, etc.
+ * Identity helper for authoring a Shopify section schema. Typing the parameter
+ * as `SectionSchema` directly (rather than a generic `<const T>`) gives the
+ * author both autocomplete for `type` values, `id`s, etc. and excess-property
+ * checking — a bare type parameter would silently accept unknown keys.
  *
  * Use in `<name>.schema.ts` files under `src/sections/`.
  */
-declare function defineSchemaSection<const T extends SectionSchema>(schema: T): T;
+declare function defineSchemaSection(schema: SectionSchema): SectionSchema;
 /**
- * Identity helper for authoring a Shopify theme-block schema.
+ * Identity helper for authoring a Shopify theme-block schema. See
+ * {@link defineSchemaSection} for why the parameter is typed directly.
  *
  * Use in `<name>.schema.ts` files under `src/blocks/`.
  */
-declare function defineSchemaBlock<const T extends ThemeBlockSchema>(schema: T): T;
+declare function defineSchemaBlock(schema: ThemeBlockSchema): ThemeBlockSchema;
 //#endregion
 export { type SectionSchema, type ThemeBlockSchema, defineSchemaBlock, defineSchemaSection };

package/dist/schema.mjs

@@ -1,8 +1,9 @@
 //#region lib/schema.ts
 /**
-* Identity helper for authoring a Shopify section schema. The `const T`
-* parameter preserves literal types so the schema author gets autocomplete
-* for setting `type` values, `id`s, etc.
+* Identity helper for authoring a Shopify section schema. Typing the parameter
+* as `SectionSchema` directly (rather than a generic `<const T>`) gives the
+* author both autocomplete for `type` values, `id`s, etc. and excess-property
+* checking — a bare type parameter would silently accept unknown keys.
 *
 * Use in `<name>.schema.ts` files under `src/sections/`.
 */
@@ -10,7 +11,8 @@ function defineSchemaSection(schema) {
 	return schema;
 }
 /**
-* Identity helper for authoring a Shopify theme-block schema.
+* Identity helper for authoring a Shopify theme-block schema. See
+* {@link defineSchemaSection} for why the parameter is typed directly.
 *
 * Use in `<name>.schema.ts` files under `src/blocks/`.
 */

package/lib/schema.ts

@@ -13,25 +13,23 @@ import type { ThemeBlockSchema } from "./schema-block.generated.ts";
 import type { SectionSchema } from "./schema-section.generated.ts";
 
 /**
- * Identity helper for authoring a Shopify section schema. The `const T`
- * parameter preserves literal types so the schema author gets autocomplete
- * for setting `type` values, `id`s, etc.
+ * Identity helper for authoring a Shopify section schema. Typing the parameter
+ * as `SectionSchema` directly (rather than a generic `<const T>`) gives the
+ * author both autocomplete for `type` values, `id`s, etc. and excess-property
+ * checking — a bare type parameter would silently accept unknown keys.
  *
  * Use in `<name>.schema.ts` files under `src/sections/`.
  */
-export function defineSchemaSection<const T extends SectionSchema>(
-	schema: T,
-): T {
+export function defineSchemaSection(schema: SectionSchema): SectionSchema {
 	return schema;
 }
 
 /**
- * Identity helper for authoring a Shopify theme-block schema.
+ * Identity helper for authoring a Shopify theme-block schema. See
+ * {@link defineSchemaSection} for why the parameter is typed directly.
  *
  * Use in `<name>.schema.ts` files under `src/blocks/`.
  */
-export function defineSchemaBlock<const T extends ThemeBlockSchema>(
-	schema: T,
-): T {
+export function defineSchemaBlock(schema: ThemeBlockSchema): ThemeBlockSchema {
 	return schema;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@augeo/smelt",
-	"version": "1.2.2",
+	"version": "1.2.3",
 	"description": "Library + CLI for building Shopify themes from a colocated component tree",
 	"license": "MIT",
 	"type": "module",