@adobe/spectrum-tokens 12.24.1 → 12.25.0

package/src/layout-component.json

@@ -7525,6 +7525,7 @@
   },
   "accordion-top-to-text-spacious-small": {
     "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/token-types/scale-set.json",
+    "component": "accordion",
     "sets": {
       "desktop": {
         "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/token-types/dimension.json",

package/tasks/addPrivate.js

@@ -0,0 +1,22 @@
+/*
+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 { getFileTokens, writeJson, __dirname } from "../index.js";
+import { resolve } from "path";
+
+const tokenData = await getFileTokens("color-palette.json");
+const result = {};
+
+for (const [key, value] of Object.entries(tokenData)) {
+  result[key] = { ...value, ...{ private: true } };
+}
+
+writeJson(`${resolve(__dirname, "./src")}/color-palette.json`, result);

package/tasks/diff.js

@@ -16,7 +16,7 @@ import { fileURLToPath } from "url";
 import { detailedDiff, diff } from "deep-object-diff";
 import { exec } from "node:child_process";
 import { promisify } from "util";
-import tar from "tar";
+import { x } from "tar";
 import tmp from "tmp-promise";
 
 const execP = promisify(exec);
@@ -65,7 +65,7 @@ async function getOldTokens() {
   const { stdout, stderr } = await execP(
     `npm pack @adobe/spectrum-tokens@${tag} --pack-destination ${tmpDir.path}`,
   );
-  await tar.x({
+  await x({
     cwd: tmpDir.path,
     file: join(tmpDir.path, stdout.trim()),
   });

package/test/checkComponentProps.js

@@ -0,0 +1,25 @@
+/*
+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 test from "ava";
+import { getFileTokens } from "../index.js";
+
+test("ensure all component tokens are have component data", async (t) => {
+  const tokenData = {
+    ...(await getFileTokens("color-component.json")),
+    ...(await getFileTokens("layout-component.json")),
+  };
+  const result = Object.keys(tokenData).filter(
+    (tokenName) => !Object.hasOwn(tokenData[tokenName], "component"),
+  );
+  t.deepEqual(result, []);
+});

package/test/checkId.test.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2023 Adobe. All rights reserved.
+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
@@ -20,45 +20,31 @@ const files = await Promise.all(
   ),
 );
 
-const uuids = [];
-const missingUUIDs = [];
-const VALUE = "value";
-const UUID = "uuid";
-
-function isObject(a) {
-  return (
-    !!a &&
-    a.constructor &&
-    (a.constructor === Object || a.constructor.name === "Object")
-  );
-}
-
-// check for and add uuids
-function checkUUID(json, name) {
-  // if it is in want of uuid, give it one
-  if (json[VALUE] && !json[UUID]) {
-    if (!json[UUID] || uuids.includes(json[UUID])) {
-      if (name) {
-        missingUUIDs.push(name);
-      } else {
-        missingUUIDs.push(json[VALUE]);
+const findDuplicateUUIDs = (json) => {
+  const uuids = [];
+  const duplicateUUIDs = [];
+  const gather = (json, name) => {
+    if (json.uuid) {
+      if (uuids.includes(json.uuid)) {
+        duplicateUUIDs.push({ uuid: json.uuid, name });
       }
+      uuids.push(json.uuid);
     }
-
-    uuids.push(json[UUID]);
-  }
-
-  // handle the json's children
-  Object.keys(json).forEach((key) => {
-    if (isObject(json[key])) {
-      checkUUID(json[key], key);
-    }
-  });
-}
-
-test("check for uuids", async (t) => {
+    Object.keys(json).forEach((key) => {
+      if (typeof json[key] === "object") {
+        gather(json[key], key);
+      }
+    });
+  };
+  gather(json);
+  return duplicateUUIDs;
+};
+
+test("ensure uuids are unique", async (t) => {
+  let allTokens = {};
   for (const file of files) {
-    checkUUID(file);
+    allTokens = { ...allTokens, ...file };
   }
-  t.deepEqual(missingUUIDs, []);
+  const duplicateUUIDs = findDuplicateUUIDs(allTokens);
+  t.deepEqual(duplicateUUIDs, [], "duplicate uuids found");
 });

package/test/checkManifest.test.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2023 Adobe. All rights reserved.
+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

package/test/checkPrivate.js

@@ -0,0 +1,22 @@
+/*
+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 test from "ava";
+import { getFileTokens } from "../index.js";
+
+test("ensure all color-palette.json tokens are private", async (t) => {
+  const tokenData = await getFileTokens("color-palette.json");
+  const result = Object.keys(tokenData).filter(
+    (tokenName) => !Object.hasOwn(tokenData[tokenName], "private"),
+  );
+  t.deepEqual(result, []);
+});

package/test/checkUniqueTokenNames.js

@@ -0,0 +1,32 @@
+/*
+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 test from "ava";
+import { readFile } from "fs/promises";
+import { tokenFileNames } from "../index.js";
+import findDuplicatedPropertyKeys from "find-duplicated-property-keys";
+
+test("check for duplicate token names across all token files", async (t) => {
+  const result = await Promise.all(
+    tokenFileNames.map(async (tokenFileName) => {
+      const tokenDataString = await readFile(tokenFileName, "utf8");
+      return tokenDataString.substring(
+        tokenDataString.indexOf("{") + 1,
+        tokenDataString.lastIndexOf("}"),
+      );
+    }),
+  ).then((tokenDataArray) => {
+    return findDuplicatedPropertyKeys(`{${tokenDataArray.join(",")}}`);
+  });
+  // t.pass();
+  t.deepEqual(result, []);
+});

package/test/componentSchemaValidator.test.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2023 Adobe. All rights reserved.
+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

package/test/deprecateExpress.test.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2023 Adobe. All rights reserved.
+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

package/test/drover.test.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2023 Adobe. All rights reserved.
+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

package/test/schemaValidator.test.js

@@ -0,0 +1,74 @@
+/*
+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 test from "ava";
+import Ajv from "ajv/dist/2020.js";
+import addFormats from "ajv-formats";
+import { glob } from "glob";
+import { readFile } from "fs/promises";
+
+const readJSON = async (filePath) =>
+  JSON.parse(await readFile(filePath, "utf8"));
+const componentSchema = await readJSON("schemas/component.json");
+
+const fileNames = await glob("schemas/components/*.json");
+const files = await Promise.all(
+  fileNames.map(async (fileName) => {
+    return { fileName, json: await readJSON(fileName) };
+  }),
+);
+
+const ajv = new Ajv();
+addFormats(ajv);
+ajv.addMetaSchema(componentSchema);
+const schemaFiles = await glob("schemas/types/*.json");
+for (const schemaFile of schemaFiles) {
+  const schema = await readJSON(schemaFile);
+  ajv.addSchema(schema);
+}
+
+for (const keyword of Object.keys(componentSchema.properties)) {
+  ajv.addKeyword({ keyword, metaSchema: componentSchema.properties[keyword] });
+}
+
+test("component schema should be valid", async (t) => {
+  const valid = ajv.validateSchema(componentSchema);
+  t.true(valid);
+});
+
+test("Every component schema should validate against the definition", (t) => {
+  let valid = true;
+  for (const file of files) {
+    if (!ajv.validateSchema(file.json)) {
+      valid = false;
+      console.log(`${file.fileName} failed validation`);
+      console.log(ajv.errors);
+    }
+  }
+  t.true(valid);
+});
+
+test("component examples should validate against the definition", (t) => {
+  let valid = true;
+  for (const file of files) {
+    const validate = ajv.compile(file.json);
+    if (!Object.hasOwn(file.json, "examples")) file.json.examples = [];
+    for (const example of file.json.examples) {
+      if (!validate(example)) {
+        valid = false;
+        console.log(`${file.fileName} failed validation`);
+        console.log(validate.errors);
+      }
+    }
+  }
+  t.true(valid);
+});

package/test/schemaValidators/alias.test.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2023 Adobe. All rights reserved.
+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

package/test/tokenSchemaValidator.test.js

@@ -1,5 +1,5 @@
 /*
-Copyright 2023 Adobe. All rights reserved.
+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