@kensio/colophon 2.4.0 → 2.5.0

package/dist/validate/texture.js

@@ -0,0 +1,34 @@
+import { checkKeys, isRecord } from "./check.js";
+import { dotsTextureKeys, grainTextureKeys, rulesTextureKeys, textureTypes, } from "./keys.js";
+import { describeUnknownValue } from "./values.js";
+/**
+ * Check a texture against the keys of whichever treatment it declares.
+ *
+ * The same reasoning as a background's: `textureSvg` draws anything it does
+ * not recognise as the last variant it checks for, so an unknown `type` would
+ * come out as a set of ruled lines nobody asked for. A texture with no `type`
+ * is left to the type checker, since without one there is no telling which
+ * keys were meant.
+ */
+export function checkTexture(texture, path, problems) {
+    if (!isRecord(texture)) {
+        return;
+    }
+    const { type } = texture;
+    if (type === "grain") {
+        checkKeys(texture, path, grainTextureKeys, problems);
+        return;
+    }
+    if (type === "dots") {
+        checkKeys(texture, path, dotsTextureKeys, problems);
+        return;
+    }
+    if (type === "rules") {
+        checkKeys(texture, path, rulesTextureKeys, problems);
+        return;
+    }
+    if (typeof type === "string") {
+        problems.push(describeUnknownValue("texture type", "types", type, textureTypes));
+    }
+}
+//# sourceMappingURL=texture.js.map

package/dist/validate/texture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"texture.js","sourceRoot":"","sources":["../../src/validate/texture.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,GACb,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEnD;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAgB,EAChB,IAAY,EACZ,QAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QACrD,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACpB,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;QACpD,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QACrD,OAAO;IACT,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,CAClE,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/validate/values.d.ts

@@ -3,19 +3,19 @@
  * the field, `plural` heads the list of what it does accept.
  */
 export declare function describeUnknownValue(noun: string, plural: string, value: string, known: readonly string[]): string;
-/**
- * Check a background against the keys of whichever variant it declares.
- *
- * A misspelt `type` is worth reporting on its own: `backgroundSvg` treats
- * anything that is not `solid` as a gradient, so `gradiant` silently becomes
- * one and then falls over on the stops it does not have. A background with no
- * `type` at all is left alone, since the type is what says which keys apply,
- * and guessing would report the keys rather than the omission.
- */
-export declare function checkBackground(background: unknown, path: string, problems: string[]): void;
 /**
  * Check the slug strategy names a real one. Only a string can be a strategy;
  * anything else is a shape the type checker already covers, as elsewhere here.
  */
 export declare function checkSlugStrategy(content: unknown, problems: string[]): void;
+/**
+ * Check a theme names one of the curated set.
+ *
+ * A theme that does not exist is nothing at all: the config resolves as though
+ * it had never been named and the images come out in the neutral default
+ * palette. Every unknown value here is worth reporting, but this one more than
+ * most, because a theme is the one field whose whole purpose is to be the
+ * look.
+ */
+export declare function checkTheme(theme: unknown, problems: string[]): void;
 //# sourceMappingURL=values.d.ts.map

package/dist/validate/values.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"values.d.ts","sourceRoot":"","sources":["../../src/validate/values.ts"],"names":[],"mappings":"AAeA;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,CAMR;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,OAAO,EACnB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAAE,GACjB,IAAI,CAsCN;AAaD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAmB5E"}
+{"version":3,"file":"values.d.ts","sourceRoot":"","sources":["../../src/validate/values.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,CAMR;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAmB5E;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAUnE"}

package/dist/validate/values.js

@@ -1,5 +1,6 @@
-import { checkEach, checkKeys, isRecord } from "./check.js";
-import { backgroundTypes, gradientBackgroundKeys, gradientPointKeys, backgroundFits, gradientStopKeys, imageBackgroundKeys, imageSourceKeys, scrimKeys, slugStrategies, solidBackgroundKeys, } from "./keys.js";
+import { themeNames } from "../theme/index.js";
+import { isRecord } from "./check.js";
+import { slugStrategies } from "./keys.js";
 import { nearestName } from "./suggest.js";
 /**
  * Report a value that is not one of the names a field accepts. `noun` names
@@ -11,49 +12,6 @@ export function describeUnknownValue(noun, plural, value, known) {
         ? `Unknown ${noun} "${value}". Valid ${plural}: ${known.join(", ")}.`
         : `Unknown ${noun} "${value}". Did you mean "${suggestion}"?`;
 }
-/**
- * Check a background against the keys of whichever variant it declares.
- *
- * A misspelt `type` is worth reporting on its own: `backgroundSvg` treats
- * anything that is not `solid` as a gradient, so `gradiant` silently becomes
- * one and then falls over on the stops it does not have. A background with no
- * `type` at all is left alone, since the type is what says which keys apply,
- * and guessing would report the keys rather than the omission.
- */
-export function checkBackground(background, path, problems) {
-    if (!isRecord(background)) {
-        return;
-    }
-    const { type, stops, from, to } = background;
-    if (type === "solid") {
-        checkKeys(background, path, solidBackgroundKeys, problems);
-        return;
-    }
-    if (type === "image") {
-        checkKeys(background, path, imageBackgroundKeys, problems);
-        checkKeys(background["source"], `${path}.source`, imageSourceKeys, problems);
-        checkKeys(background["scrim"], `${path}.scrim`, scrimKeys, problems);
-        checkFit(background["fit"], problems);
-        return;
-    }
-    if (type === "gradient") {
-        checkKeys(background, path, gradientBackgroundKeys, problems);
-        checkEach(stops, `${path}.stops`, gradientStopKeys, problems);
-        checkKeys(from, `${path}.from`, gradientPointKeys, problems);
-        checkKeys(to, `${path}.to`, gradientPointKeys, problems);
-        return;
-    }
-    if (typeof type === "string") {
-        problems.push(describeUnknownValue("background type", "types", type, backgroundTypes));
-    }
-}
-/** Check a background image's fit names one of the two there are. */
-function checkFit(fit, problems) {
-    if (typeof fit !== "string" || backgroundFits.includes(fit)) {
-        return;
-    }
-    problems.push(describeUnknownValue("background fit", "fits", fit, backgroundFits));
-}
 /**
  * Check the slug strategy names a real one. Only a string can be a strategy;
  * anything else is a shape the type checker already covers, as elsewhere here.
@@ -68,4 +26,22 @@ export function checkSlugStrategy(content, problems) {
     }
     problems.push(describeUnknownValue("slug strategy", "strategies", strategy, slugStrategies));
 }
+/**
+ * Check a theme names one of the curated set.
+ *
+ * A theme that does not exist is nothing at all: the config resolves as though
+ * it had never been named and the images come out in the neutral default
+ * palette. Every unknown value here is worth reporting, but this one more than
+ * most, because a theme is the one field whose whole purpose is to be the
+ * look.
+ */
+export function checkTheme(theme, problems) {
+    // Widened on the way in: the names are typed as the union everywhere else,
+    // and what is being checked here is a string that may well not be one.
+    const known = themeNames;
+    if (typeof theme !== "string" || known.includes(theme)) {
+        return;
+    }
+    problems.push(describeUnknownValue("theme", "themes", theme, known));
+}
 //# sourceMappingURL=values.js.map

package/dist/validate/values.js.map

@@ -1 +1 @@
-{"version":3,"file":"values.js","sourceRoot":"","sources":["../../src/validate/values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,sBAAsB,EACtB,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,SAAS,EACT,cAAc,EACd,mBAAmB,GACpB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAY,EACZ,MAAc,EACd,KAAa,EACb,KAAwB;IAExB,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAE7C,OAAO,UAAU,KAAK,SAAS;QAC7B,CAAC,CAAC,WAAW,IAAI,KAAK,KAAK,YAAY,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QACrE,CAAC,CAAC,WAAW,IAAI,KAAK,KAAK,oBAAoB,UAAU,IAAI,CAAC;AAClE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC7B,UAAmB,EACnB,IAAY,EACZ,QAAkB;IAElB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,UAAU,CAAC;IAE7C,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAC3D,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;QAC3D,SAAS,CACP,UAAU,CAAC,QAAQ,CAAC,EACpB,GAAG,IAAI,SAAS,EAChB,eAAe,EACf,QAAQ,CACT,CAAC;QACF,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrE,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;QACtC,OAAO;IACT,CAAC;IAED,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;QACxB,SAAS,CAAC,UAAU,EAAE,IAAI,EAAE,sBAAsB,EAAE,QAAQ,CAAC,CAAC;QAC9D,SAAS,CAAC,KAAK,EAAE,GAAG,IAAI,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;QAC9D,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,OAAO,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QAC7D,SAAS,CAAC,EAAE,EAAE,GAAG,IAAI,KAAK,EAAE,iBAAiB,EAAE,QAAQ,CAAC,CAAC;QACzD,OAAO;IACT,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,iBAAiB,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,CAAC,CACxE,CAAC;IACJ,CAAC;AACH,CAAC;AAED,qEAAqE;AACrE,SAAS,QAAQ,CAAC,GAAY,EAAE,QAAkB;IAChD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO;IACT,CAAC;IAED,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,CACpE,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB,EAAE,QAAkB;IACpE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEzC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtE,OAAO;IACT,CAAC;IAED,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAClB,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,cAAc,CACf,CACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"values.js","sourceRoot":"","sources":["../../src/validate/values.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAY,EACZ,MAAc,EACd,KAAa,EACb,KAAwB;IAExB,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAE7C,OAAO,UAAU,KAAK,SAAS;QAC7B,CAAC,CAAC,WAAW,IAAI,KAAK,KAAK,YAAY,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QACrE,CAAC,CAAC,WAAW,IAAI,KAAK,KAAK,oBAAoB,UAAU,IAAI,CAAC;AAClE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAAgB,EAAE,QAAkB;IACpE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEzC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtE,OAAO;IACT,CAAC;IAED,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAClB,eAAe,EACf,YAAY,EACZ,QAAQ,EACR,cAAc,CACf,CACF,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAAC,KAAc,EAAE,QAAkB;IAC3D,2EAA2E;IAC3E,uEAAuE;IACvE,MAAM,KAAK,GAAsB,UAAU,CAAC;IAE5C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,OAAO;IACT,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;AACvE,CAAC"}

package/package.json

@@ -8,7 +8,7 @@
   },
   "homepage": "https://github.com/KensioSoftware/colophon#readme",
   "license": "Apache-2.0",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",