@primer/primitives 7.16.0 → 7.17.0-rc.132f02a7

package/src/schemas/validTokenType.ts

@@ -0,0 +1,44 @@
+import {z} from 'zod'
+import {joinFriendly} from '../utilities/joinFriendly'
+import {schemaErrorMessage} from '../utilities/schemaErrorMessage'
+
+const validTypes = [
+  'color',
+  'typography',
+  'dimension',
+  'duration',
+  'border',
+  'shadow',
+  'fontFamily',
+  'fontWeight',
+  'number',
+  'string',
+  'custom-viewportRange',
+] as const
+
+export type TokenType = (typeof validTypes)[number]
+
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore: TODO: fix this
+export const validateType = z.record(
+  z.string(),
+  z.lazy(() => {
+    return z.union([
+      z
+        .object({
+          $value: z.any(),
+          $type: z.string().refine(
+            type => validTypes.includes(type as TokenType),
+            val => ({
+              message: schemaErrorMessage(
+                `Invalid token $type: "${val}"`,
+                `Must be one of the following: ${joinFriendly([...validTypes], 'or')}`,
+              ),
+            }),
+          ),
+        })
+        .required(),
+      validateType,
+    ])
+  }),
+)

package/src/schemas/viewportRangeToken.ts

@@ -0,0 +1,11 @@
+import {z} from 'zod'
+import {baseToken} from './baseToken'
+import {referenceValue} from './referenceValue'
+import {tokenType} from './tokenType'
+
+export const viewportRangeToken = baseToken
+  .extend({
+    $value: z.union([z.string(), referenceValue]),
+    $type: tokenType('custom-viewportRange'),
+  })
+  .strict()

package/src/test-utilities/getMockDictionary.ts

@@ -0,0 +1,22 @@
+import type StyleDictionary from 'style-dictionary'
+import {getMockToken} from './getMockToken'
+
+const mockDictionaryDefault = {
+  tokens: {
+    subgroup: {
+      red: getMockToken({
+        name: 'red',
+        path: ['tokens', 'subgroup', 'red'],
+      }),
+    },
+  },
+}
+
+export const getMockDictionary = (tokens?: StyleDictionary.TransformedTokens): StyleDictionary.Dictionary => ({
+  allTokens: Object.values((tokens || mockDictionaryDefault).tokens.subgroup),
+  tokens: tokens || mockDictionaryDefault,
+  allProperties: Object.values((tokens || mockDictionaryDefault).tokens.subgroup),
+  properties: tokens || mockDictionaryDefault,
+  usesReference: _value => false,
+  getReferences: _value => [],
+})

package/src/test-utilities/getMockFormatterArguments.ts

@@ -0,0 +1,21 @@
+import type {FormatterArguments} from 'style-dictionary/types/Format'
+import {getMockDictionary} from './'
+
+const defaultFormatterArguments: FormatterArguments = {
+  dictionary: getMockDictionary(),
+  file: {
+    destination: 'tokens.ts',
+    options: {
+      showFileHeader: false,
+    },
+  },
+  options: {},
+  platform: {},
+}
+
+export const getMockFormatterArguments = (overrides?: Partial<FormatterArguments>): FormatterArguments => {
+  return {
+    ...defaultFormatterArguments,
+    ...(overrides || {}),
+  }
+}

package/src/test-utilities/getMockParserInput.ts

@@ -0,0 +1,72 @@
+export const parserOutput = {
+  color: {
+    value: 'red',
+    comment: 'a red color',
+    $type: 'color',
+    $extensions: {},
+    alpha: 0.5,
+  },
+}
+
+const parserInput: {[Property in jsonFormats]: string} = {
+  'json.w3c': `{
+    "color": {
+      "$value": 'red',
+      "$description": "a red color",
+      "$type": "color",
+      "$extensions": {},
+      "alpha": 0.5
+    }
+  }`,
+  'json.default': `{
+    "color": {
+      "value": 'red',
+      "description": "a red color",
+      "type": "color",
+      "extensions": {},
+      "alpha": 0.5
+    }
+  }`,
+  'json5.w3c': `{
+    "color": {
+      // comment
+      $value: 'red',
+      "$description": "a red color",
+      '$type': "color",
+      "$extensions": {},
+      alpha: 0.5,
+    }
+  }`,
+  'json5.default': `{
+    "color": {
+      // comment
+      value: 'red',
+      "description": "a red color",
+      'type': "color",
+      "extensions": {},
+      alpha: 0.5,
+    }
+  }`,
+}
+
+type jsonFormats = 'json5.default' | 'json5.w3c' | 'json.default' | 'json.w3c'
+
+/**
+ *
+ * @param contents jsonFormats or string taht replaces content in return
+ * @returns predefined json string or override
+ */
+export const getMockParserInput = (
+  contents: jsonFormats | string,
+  filePath?: string,
+): {filePath: string; contents: string} => {
+  // use predefined if no override
+  if (['json5.default', 'json5.w3c', 'json.default', 'json.w3c'].includes(contents)) {
+    contents = parserInput[contents as jsonFormats]
+  }
+
+  return {
+    filePath: filePath || `path/to/file/token.json`,
+    contents,
+  }
+}

package/src/test-utilities/getMockToken.ts

@@ -0,0 +1,25 @@
+import type StyleDictionary from 'style-dictionary'
+
+const mockTokenDefaults = {
+  name: 'tokenName',
+  path: ['path'],
+  original: {
+    value: 'originalValue',
+    attributes: {},
+  },
+  filePath: 'file.json',
+  isSource: true,
+  value: 'transformedValue',
+  attributes: {},
+}
+/**
+ *
+ * @param valueOverrides partial StyleDictionary.TransformedToken
+ * @returns StyleDictionary.TransformedToken - a merge of {@link mockTokenDefaults} and any valid properties provided in the valueOverrides param
+ */
+export const getMockToken = (valueOverrides: {
+  [key: keyof StyleDictionary.TransformedToken]: unknown
+}): StyleDictionary.TransformedToken => ({
+  ...mockTokenDefaults,
+  ...valueOverrides,
+})

package/src/test-utilities/index.ts

@@ -0,0 +1,4 @@
+export {getMockDictionary} from './getMockDictionary'
+export {getMockToken} from './getMockToken'
+export {getMockParserInput, parserOutput} from './getMockParserInput'
+export {getMockFormatterArguments} from './getMockFormatterArguments'