chore: refactor component-schemas into package

.moon/workspace.yml

@@ -2,6 +2,7 @@
 $schema: "https://moonrepo.dev/schemas/workspace.json"
 projects:
   tokens: "packages/tokens"
+  componentSchemas: "packages/component-schemas"
   visualizer: "docs/visualizer"
   site: "docs/site"
   root: "."

docs/site/lib/components.js

@@ -101,8 +101,16 @@ export async function getAllComponentSlugs() {
 }
 
 export async function getComponentData(slug) {
+  // not sure, if this should use the public/schemas folder, like getAllComponentSlugs()
   const schemaDir = path.resolve(
-    path.join(process.cwd(), "..", "..", "packages", "tokens", "schemas"),
+    path.join(
+      process.cwd(),
+      "..",
+      "..",
+      "packages",
+      "component-schemas",
+      "schemas",
+    ),
   );
   const file = await readJSON(
     path.join(schemaDir, "components", `${slug}.json`),

docs/site/moon.yml

@@ -16,7 +16,18 @@ fileGroups:
   target:
     - "/site/[!visualizer]"
 tasks:
-  copySchema:
+  copyComponentSchema:
+    command:
+      - cp
+      - -r
+      - ../../packages/component-schemas/schemas
+      - public/
+    platform: system
+    inputs:
+      - /packages/component-schemas/schemas/**/*.json
+    outputs:
+      - public/schemas
+  copyTokenTypeSchema:
     command:
       - cp
       - -r
@@ -33,7 +44,8 @@ tasks:
       - build
     platform: node
     deps:
-      - ~:copySchema
+      - ~:copyComponentSchema
+      - ~:copyTokenTypeSchema
     outputs:
       - "/site/"
   clean:

docs/site/public/schemas/token-types/color-set.json

@@ -73,7 +73,11 @@
     "private": {},
     "deprecated": {},
     "deprecated_comment": {},
-    "uuid": {}
+    "uuid": {
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$",
+      "format": "uuid"
+    }
   },
-  "required": ["sets"]
+  "required": ["sets", "uuid"]
 }

docs/site/public/schemas/token-types/scale-set.json

@@ -49,7 +49,11 @@
     "private": {},
     "deprecated": {},
     "deprecated_comment": {},
-    "uuid": {}
+    "uuid": {
+      "type": "string",
+      "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$",
+      "format": "uuid"
+    }
   },
-  "required": ["sets"]
+  "required": ["sets", "uuid"]
 }

packages/component-schemas/index.js

@@ -0,0 +1,52 @@
+/*
+Copyright 2024 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+import { glob } from "glob";
+
+import { resolve } from "path";
+import { readFile } from "fs/promises";
+import * as url from "url";
+import { writeFile } from "fs/promises";
+import { format } from "prettier";
+
+const readJson = async (fileName) =>
+  JSON.parse(await readFile(fileName, "utf8"));
+
+const writeJson = async (fileName, jsonData) => {
+  await writeFile(
+    fileName,
+    await format(JSON.stringify(jsonData), { parser: "json-stringify" }),
+  );
+};
+
+const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
+
+export const schemaFileNames = await glob(
+  `${resolve(__dirname, "./schemas")}/**/*.json`,
+);
+
+export const getFile = async (schemaFileName) =>
+  await readJson(resolve(__dirname, "src", tokenFileName));
+
+export const getAllSchemas = async () => {
+  return await Promise.all(schemaFileNames.map(getFileTokens)).then(
+    (tokenFileDataAr) => {
+      return tokenFileDataAr.reduce(
+        (tokenDataAcc, tokenFileData) => ({
+          ...tokenDataAcc,
+          ...tokenFileData,
+        }),
+        {},
+      );
+    },
+  );
+};

packages/component-schemas/moon.yml

@@ -0,0 +1,56 @@
+# Copyright 2024 Adobe. All rights reserved.
+# This file is licensed to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License. You may obtain a copy
+# of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software distributed under
+# the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+# OF ANY KIND, either express or implied. See the License for the specific language
+# governing permissions and limitations under the License.
+$schema: "https://moonrepo.dev/schemas/project.json"
+type: library
+fileGroups:
+  schemas:
+    - "schemas/**/*.{yaml,yml,json}"
+  tests:
+    - "test/**/*"
+tasks:
+  build:
+    deps:
+      - ~:make
+      - ~:buildSchemas
+  buildSchemas:
+    command:
+      - cp
+      - -R
+      - schemas/
+      - dist/v1
+    platform: node
+  make:
+    command:
+      - mkdir
+      - -p
+      - dist/v1
+    platform: node
+  clean:
+    command:
+      - rm
+      - -rf
+      - dist
+    platform: node
+  test:
+    command:
+      - pnpm
+      - ava
+    inputs:
+      - "@globs(schemas)"
+      - "@globs(tests)"
+    deps:
+      - ~:buildSchemas
+    platform: node
+  test-watch:
+    command:
+      - ava
+      - --watch
+    local: true
+    platform: node

packages/component-schemas/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "spectrum-component-api-schemas",
+  "version": "1.0.0",
+  "description": "",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adobe/spectrum-tokens.git"
+  },
+  "author": "Garth Braithwaite <[email protected]> (https://garthdb.com/)",
+  "bugs": {
+    "url": "https://github.com/adobe/spectrum-tokens/issues"
+  },
+  "publishConfig": {
+    "provenance": true
+  },
+  "homepage": "https://github.com/adobe/spectrum-tokens/tree/main/packages/component-schemas#readme",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "ajv": "^8.12.0",
+    "ajv-formats": "^3.0.1",
+    "glob": "^10.3.12"
+  }
+}