@adobe/spectrum-tokens 13.0.0-beta.8 → 13.0.0

package/tasks/addIds.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
@@ -10,15 +10,13 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { glob } from "glob";
 import crypto from "crypto"; // (not the fake money)
 import { writeFile, readFile } from "fs/promises";
-
-const files = await glob("src/**/*.json");
-console.log(files);
+import { tokenFileNames, writeJson } from "../index.js";
 
 const VALUE = "value";
 const UUID = "uuid";
+const SETS = "sets";
 const uuids = [];
 
 // dumb function to check if something is an object
@@ -46,7 +44,7 @@ function findUUIDs(json) {
 // check for and add uuids
 function addUUIDs(json) {
   // if it is in want of uuid, give it one
-  if (json[VALUE] && !json[UUID]) {
+  if (!json[UUID] && (json[VALUE] || json[SETS])) {
     while (!json[UUID] || uuids.includes(json[UUID])) {
       json[UUID] = crypto.randomUUID(); // https://stackoverflow.com/questions/105034/how-do-i-create-a-guid-uuid#2117523
     }
@@ -63,7 +61,7 @@ function addUUIDs(json) {
 }
 
 // run through the files and find uuids
-for (const fileName of files) {
+for (const fileName of tokenFileNames) {
   const fileData = await readFile(fileName, "utf8");
   const fileJSON = JSON.parse(fileData);
 
@@ -71,7 +69,7 @@ for (const fileName of files) {
 }
 
 // run through the files and add uuids
-for (const fileName of files) {
+for (const fileName of tokenFileNames) {
   const fileData = await readFile(fileName, "utf8");
   const fileJSON = JSON.parse(fileData);
 
@@ -79,7 +77,7 @@ for (const fileName of files) {
 
   addUUIDs(fileJSON);
 
-  await writeFile(fileName, JSON.stringify(fileJSON, null, 2));
+  await writeJson(fileName, fileJSON);
 
   if (uuids.length !== existing) {
     console.log(`  added: ${fileName} ${uuids.length - existing} uuids`);

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/buildManifest.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/tasks/buildSpectrumTokens.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/tasks/deprecateExpress.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/tasks/diff.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
@@ -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);
@@ -54,7 +54,11 @@ async function run() {
 async function getNewTokens() {
   try {
     await access(localTokenPath);
-    return JSON.parse(await readFile(localTokenPath, { encoding: "utf8" }));
+    return JSON.parse(
+      convertNumberStringsToNumbers(
+        await readFile(localTokenPath, { encoding: "utf8" }),
+      ),
+    );
   } catch {
     console.error("cannot access");
   }
@@ -65,14 +69,18 @@ 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()),
   });
   const oldTokenPath = join(tmpDir.path, "package", tokenPath);
   await access(oldTokenPath);
   console.log(`Comparing against ${stdout.trim()}`);
-  return JSON.parse(await readFile(oldTokenPath, { encoding: "utf8" }));
+  return JSON.parse(
+    convertNumberStringsToNumbers(
+      await readFile(oldTokenPath, { encoding: "utf8" }),
+    ),
+  );
 }
 
 function calculatePossibleRenames(diffResult, oldTokens, newTokens) {
@@ -92,6 +100,12 @@ function calculatePossibleRenames(diffResult, oldTokens, newTokens) {
   });
 }
 
+function convertNumberStringsToNumbers(dataString) {
+  return dataString.replace(/"([\d]*\.?[\d]*)"/g, (match, p1) => {
+    return p1;
+  });
+}
+
 function logResultCategory(diffResult, categoryKey, msg) {
   const results = diffResult[categoryKey];
   const resultCount = Object.keys(results).length;

package/tasks/lib/augmentExpressTokens.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/checkComponentProps.js

@@ -0,0 +1,29 @@
+/*
+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")),
+    ...(await getFileTokens("icons.json")),
+  };
+  const result = Object.keys(tokenData).filter((tokenName) => {
+    return (
+      !Object.hasOwn(tokenData[tokenName], "component") ||
+      tokenName.indexOf(tokenData[tokenName].component) != 0
+    );
+  });
+  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,42 +20,6 @@ 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 uuids
-// function checkUUID(json, name) {
-//   if (json[VALUE] && !json[UUID]) {
-//     if (!json[UUID]) {
-//       if (name) {
-//         missingUUIDs.push(name);
-//       } else {
-//         missingUUIDs.push(json[VALUE]);
-//       }
-//     }
-//     else if (uuids.includes(json[UUID])) {
-
-//     }
-//     uuids.push(json[UUID]);
-//   }
-
-//   // handle the json's children
-//   Object.keys(json).forEach((key) => {
-//     if (isObject(json[key])) {
-//       checkUUID(json[key], key);
-//     }
-//   });
-// }
 const findDuplicateUUIDs = (json) => {
   const uuids = [];
   const duplicateUUIDs = [];

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/checkSetsUnique.js

@@ -0,0 +1,54 @@
+/*
+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 { getAllTokens, isDeprecated } from "../index.js";
+
+test("Single set properties shouldn't be deprecated", async (t) => {
+  const tokens = await getAllTokens();
+  for (const [tokenName, token] of Object.entries(tokens)) {
+    if (
+      Object.hasOwn(token, "sets") &&
+      !isDeprecated(token) &&
+      JSON.stringify(token.sets).indexOf("deprecated") > -1
+    ) {
+      t.truthy(
+        Object.values(token.sets).every((setValue) =>
+          Object.hasOwn(setValue, "deprecated"),
+        ),
+      );
+    }
+  }
+  t.pass();
+});
+
+test("Sets should have unique values", async (t) => {
+  const tokens = await getAllTokens();
+  const result = Object.keys(tokens).filter((tokenName) => {
+    const token = tokens[tokenName];
+    if (Object.hasOwn(token, "sets") && !isDeprecated(token)) {
+      const setValues = Object.keys(token.sets).reduce(
+        (accumulator, currentValue) =>
+          currentValue != "wireframe"
+            ? [...accumulator, token.sets[currentValue].value]
+            : accumulator,
+        [],
+      );
+      if (setValues.length != new Set(setValues).size) {
+        return true;
+      }
+    } else {
+      return false;
+    }
+  });
+  t.deepEqual(result, [], `${result.length} Duplicate sets found`);
+});

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

@@ -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/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/snapshots/deprecateExpress.test.js.md

@@ -1,4 +1,4 @@
-# Snapshot report for `test/deprecateExpress.test.js`
+# Snapshot report for `packages/tokens/test/deprecateExpress.test.js`
 
 The actual snapshot is saved in `deprecateExpress.test.js.snap`.
 

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