@webority/tokens 0.0.0-stage → 0.90.0

package/LICENSE

@@ -0,0 +1,5 @@
+Copyright (c) Webority Technologies. All rights reserved.
+
+This software and its source code are proprietary and confidential to
+Webority Technologies. Use is restricted to Webority products and teams under
+internal license. Redistribution outside Webority Technologies is prohibited.

package/dist/_virtual/_rolldown/runtime.js

@@ -0,0 +1 @@
+import"node:module";var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,t,n)=>()=>{if(n)throw n[0];try{return e&&(t=e(e=0)),t}catch(e){throw n=[e],e}},s=(e,t)=>()=>(t||(e((t={exports:{}}).exports,t),e=null),t.exports),c=(e,n)=>{let r={};for(var i in e)t(r,i,{get:e[i],enumerable:!0});return n||t(r,Symbol.toStringTag,{value:`Module`}),r},l=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},u=(n,r,a)=>(a=n==null?{}:e(i(n)),l(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n)),d=e=>a.call(e,`module.exports`)?e[`module.exports`]:l(t({},`__esModule`,{value:!0}),e);export{s as __commonJSMin,o as __esmMin,c as __exportAll,d as __toCommonJS,u as __toESM};

package/dist/brand.d.ts

@@ -0,0 +1,33 @@
+/** The parsed library source trees the model already holds. */
+export interface LibrarySources {
+    palette: object;
+    scale: object;
+    meaning: object;
+    modeDark: object;
+}
+
+/** A validated brand: base overrides every mode, dark overrides the dark context only. */
+export interface BrandLayer {
+    name: string;
+    base: object;
+    dark: object;
+}
+
+/** The recorded deviations, keyed by slug (src/deviations.json). */
+export type Deviations = Readonly<Record<string, { reason: string }>>;
+
+/** Reads and validates a product brand file; throws one Error listing every problem. */
+export declare function loadBrand(path: string, library: LibrarySources, deviations: Deviations): BrandLayer;
+
+export declare const BRAND_OUTPUT_FILES: {
+    readonly css: "brand.css";
+    readonly bootstrap: "_brand-variables.scss";
+    readonly web: "webority-web.json";
+    readonly web390: "webority-web-390.json";
+    readonly phoneTheme: "webority-phone.json";
+    readonly phone: "brand.phone.js";
+    readonly email: "email.json";
+};
+
+/** The folder inside each head that receives the copies of the generated files. */
+export declare const HEAD_FOLDER: "generated";

package/dist/brand.js

@@ -0,0 +1,2 @@
+import{readFileSync as e}from"node:fs";var t=Object.freeze({css:`brand.css`,bootstrap:`_brand-variables.scss`,web:`webority-web.json`,web390:`webority-web-390.json`,phoneTheme:`webority-phone.json`,phone:`brand.phone.js`,email:`email.json`}),n=`generated`,r=/\{([a-z0-9-]+(?:\.[a-z0-9-]+)+)\}/g,i=[`palette`,`color`,`effect`,`font`,`radius`],a=[`space`,`text`,`shadow`,`section`,`component`];function o(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}function s(e){return o(e)&&Object.hasOwn(e,`$value`)}function c(e,t){let n=[],r=(e,t)=>{for(let i of Object.keys(e)){if(i.startsWith(`$`))continue;let a=e[i],c=`${t}.${i}`;s(a)?n.push({path:c,node:a}):o(a)&&r(a,c)}};return r(e,t),n}function l(e,t){let n=e;for(let e of t.split(`.`)){if(!o(n)||!Object.hasOwn(n,e))return!1;n=n[e]}return s(n)}function u(e){let t=e?.$extensions?.[`com.webority`];return o(t)?t:{}}function d(e){return/^[a-z0-9]+(-[a-z0-9]+)*$/.test(e)&&!/^[0-9]+$/.test(e)}function f(t,n,f){let p;try{p=JSON.parse(e(t,`utf8`))}catch(e){throw Error(`${t}: (file): cannot be read as JSON (${e.message}). Restore the file or fix the JSON`)}if(!o(p))throw Error(`${t}: (file): is not a JSON object. Write the brand as one object with the groups palette, color, effect, font and radius`);let m=[],h=(e,n,r)=>{let i=`${t}: ${e}: ${n}. ${r}`;m.includes(i)||m.push(i)},g=u(p);for(let e of Object.keys(g))e!==`brand`&&e!==`deviation`&&h(`$extensions.com.webority.${e}`,`is not a brand file key`,`Remove it`);let _=Object.hasOwn(g,`deviation`),v=_&&typeof g.deviation==`string`&&Object.hasOwn(f,g.deviation);_&&!v&&h(`$extensions.com.webority.deviation`,`${g.deviation} is not in deviations.json`,`Use a key of deviations.json`),(typeof g.brand!=`string`||!/^[a-z][a-z0-9]*(-[a-z0-9]+)*$/.test(g.brand))&&h(`$extensions.com.webority.brand`,`is missing or not kebab case`,`Name the product in kebab case, such as capnix`);let y={};for(let e of Object.keys(p))if(!e.startsWith(`$`)){if(!i.includes(e)&&!a.includes(e)){h(e,`is not a brand group`,`A brand file holds only palette, color, effect, font and radius, plus the groups a recorded deviation allows`);continue}if(a.includes(e)&&!v){h(e,`this group needs a recorded deviation`,`Add $extensions.com.webority.deviation naming an entry of deviations.json, or remove the group`);continue}if(!o(p[e])){h(e,`is not a group`,`Write it as an object of tokens`);continue}y[e]=p[e]}for(let[e,t]of Object.entries(y))for(let{path:n,node:r}of c(t,e)){let t=u(r);for(let e of Object.keys(t))e!==`platforms`&&e!==`dark`&&h(n,`$extensions.com.webority.${e} is not allowed on a token`,`Remove it`);if(Object.hasOwn(t,`platforms`)){let e=t.platforms;Array.isArray(e)&&e.length>0&&e.every(e=>e===`web`||e===`phone`)||h(n,`$extensions.com.webority.platforms is not a list of web and phone`,`Write it as ["phone"], ["web"] or both`)}Object.hasOwn(t,`dark`)&&e!==`color`&&e!==`effect`&&h(n,`$extensions.com.webority.dark applies to colour and effect tokens only`,`Remove it`)}for(let{path:e,node:t}of c(y.palette??{},`palette`))e.split(`.`).slice(1).every(d)||h(e,`the step name is not kebab case`,`Name it such as primary-500`),typeof t.$value!=`string`&&h(e,`$value is not a string`,`Write the colour as text such as "#0F766E" or a reference such as "{palette.primary}"`);let b=(e,t,r)=>{let i=`${e}.${t}`,a=u(r),o=l(n.meaning,i);typeof r.$value!=`string`&&h(i,`$value is not a string`,e===`color`?`Write a colour or a reference such as "{palette.primary}"`:`Write the effect as text such as a filter, colour or gradient`),o?l(n.modeDark,i)&&typeof a.dark!=`string`&&h(i,`needs $extensions.com.webority.dark because the meaning has a dark value`,`Add the dark value beside the light one`):(d(t)||h(i,`the name is not kebab case`,`Name it in kebab case`),(typeof r.$description!=`string`||r.$description===``)&&h(i,`is not a fleet meaning and has no $description`,`Add a $description saying what the colour is for, or use a meaning the library defines`)),Object.hasOwn(a,`dark`)&&typeof a.dark!=`string`&&h(i,`$extensions.com.webority.dark is not a string`,`Write a colour or a reference`)};for(let e of[`color`,`effect`]){let t=y[e]??{};for(let n of Object.keys(t))if(!n.startsWith(`$`)){if(!s(t[n])){h(`${e}.${n}`,`is not a token`,`Give it a $value`);continue}b(e,n,t[n])}}let x=Object.keys(n.scale.font??{}).filter(e=>s(n.scale.font[e]));for(let{path:e,node:t}of c(y.font??{},`font`)){l(n.scale,e)||h(e,`is not a fleet font`,`Use one of ${x.join(`, `)}`);let r=t.$value;(!Array.isArray(r)||r.length===0||!r.every(e=>typeof e==`string`))&&h(e,`$value is not a list of font family names`,`Write it as ["Webority Sans", "system-ui", "sans-serif"]`)}let S=Object.keys(n.scale.radius??{}).filter(e=>s(n.scale.radius[e]));for(let{path:e,node:t}of c(y.radius??{},`radius`)){l(n.scale,e)||h(e,`is not on the radius scale`,`Use one of ${S.join(`, `)}`);let r=t.$value;(!(o(r)&&typeof r.value==`number`&&Number.isFinite(r.value)&&r.value>=0)||r.unit!==`px`)&&h(e,`$value is not { value, unit }`,`Write it as { "value": 12, "unit": "px" }`)}let C=structuredClone(p);delete C.$extensions,delete C.$description;for(let e of[`color`,`effect`])for(let{node:t}of c(C[e]??{},e))Object.hasOwn(u(t),`dark`)&&(delete t.$extensions[`com.webority`].dark,Object.keys(t.$extensions[`com.webority`]).length===0&&delete t.$extensions[`com.webority`],Object.keys(t.$extensions).length===0&&delete t.$extensions);let w=e=>l(C,e)||l(n.palette,e)||l(n.scale,e)||l(n.meaning,e);for(let e of Object.keys(y))for(let{path:t,node:n}of c(y[e],e)){let e=[n.$value,u(n).dark].filter(e=>typeof e==`string`);for(let n of e)for(let e of n.matchAll(r))w(e[1])||h(t,`references {${e[1]}}, which no palette step, meaning, scale step or brand token defines`,`Name an existing token or add it to the brand file`)}if(m.length>0)throw Error(m.join(`
+`));let T={};for(let e of[`color`,`effect`])for(let{path:t,node:n}of c(y[e]??{},e)){let r=u(n).dark;if(typeof r!=`string`)continue;let i=t.slice(e.length+1);T[e]??={},T[e][i]=n.$type===void 0?{$value:r}:{$value:r,$type:n.$type}}return{name:g.brand,base:C,dark:T}}export{t as BRAND_OUTPUT_FILES,n as HEAD_FOLDER,f as loadBrand};

package/dist/build.js

@@ -0,0 +1,5 @@
+import{__toESM as e}from"./_virtual/_rolldown/runtime.js";import{BRAND_OUTPUT_FILES as t,HEAD_FOLDER as n,loadBrand as r}from"./brand.js";import{require__2020 as i}from"./node_modules/.pnpm/ajv@8.20.0/node_modules/ajv/dist/2020.js";import a from"./canvas-renames.js";import o from"./deviations.js";import{emitCanvas as s}from"./emit/canvas.js";import{emitEmail as c}from"./emit/email.js";import{emitMeanings as l}from"./emit/meanings.js";import{emitPhoneBrand as u,emitPhoneTheme as d,phoneSets as f}from"./emit/phone.js";import{emitWeb as p}from"./emit/web.js";import{loadModel as m}from"./model/index.js";import{mkdir as h,readFile as g,writeFile as _}from"node:fs/promises";import v from"node:path";var y=e(i(),1),b=new URL(`../schema/design-map.schema.json`,import.meta.url),x=new URL(`../package.json`,import.meta.url),S={palette:`palette.tokens.json`,scale:`scale.tokens.json`,meaning:`meaning.tokens.json`,modeDark:`mode.dark.tokens.json`},C=/^.+: \S+: .+\. .+$/;async function w(e){let n=v.resolve(e.root??process.cwd()),i=e.check===!0,{version:S}=JSON.parse(await g(x,`utf8`)),w=[],O=[],k=async(e,t)=>{if(i){let n=null;try{n=await g(e,`utf8`)}catch(e){if(e.code!==`ENOENT`)throw e}n!==t&&O.push(e);return}await h(v.dirname(e),{recursive:!0}),await _(e,t,`utf8`),w.push(e)};if(e.library===!0){if(e.brand!==void 0)throw Error(`brand: --brand: not allowed with --library. Remove it.`);if(!e.out)throw Error(`brand: --out: required with --library. Pass --out <dir>.`);let r=v.resolve(n,e.out),i=await m(),o=s(i),c=[[v.join(r,`canvas`,t.web),T(o.web)],[v.join(r,`canvas`,t.web390),T(o.web390)],[v.join(r,`canvas`,t.phoneTheme),T(o.phone)],[v.join(r,`meanings.json`),T(l(i))],[v.join(r,`canvas`,`renames.json`),T(a)]];if(e.web){let t=p(i),r=v.resolve(n,e.web);c.push([r,t.tokens]),c.push([v.join(v.dirname(r),`_bootstrap.generated.scss`),t.bootstrap])}if(e.phone){let t=d({light:f(i,`light`),dark:f(i,`dark`)});c.push([v.resolve(n,e.phone),t.contents])}for(let[e,t]of c)await k(e,t);return{written:w,stale:O}}let A=v.join(n,`.webority`,`design.json`),j;try{j=await g(A,`utf8`)}catch(e){throw e.code===`ENOENT`?Error(`${A}: file missing. Run from the repo root or create the design map.`):e}let M;try{M=JSON.parse(j)}catch(e){throw Error(`${A}: /: ${e.message}. Fix the design map.`)}let N=JSON.parse(await g(b,`utf8`)),P=new y.Ajv2020({allErrors:!0,strict:!1}).compile(N);if(!P(M))throw Error(P.errors.map(e=>`${A}: ${e.instancePath||`/`}: ${e.message}. Fix the design map.`).join(`
+`));let F=M.tokens.brands,I=M.tokens.heads??[];if((e.brand!==void 0||e.out!==void 0)&&F.length>1)throw Error(`brand: --brand/--out: the repo has ${F.length} brands. Remove the flag to build every brand.`);let L=[];if(F.forEach((e,t)=>{e.source===`library`&&L.push(`${A}: tokens.brands[${t}].source: "library" is built with --library. Run webority brand --library --out <dir>.`)}),I.forEach((e,t)=>{F.some(t=>t.name===e.brand)||L.push(`${A}: tokens.heads[${t}].brand: no brand named ${e.brand}. Add it to tokens.brands.`)}),L.length>0)throw Error(L.join(`
+`));let R=await D(),z=await m(),B={light:f(z,`light`),dark:f(z,`dark`)},V=[];for(let i of F){let a=F.length===1&&e.brand!==void 0?e.brand:i.source,l=F.length===1&&e.out!==void 0?e.out:i.export,d=v.resolve(n,a);try{let e=r(d,R,o),a=await m({brand:e}),h=s(a),g=p(a,{library:z}),_=u(B,{light:f(a,`light`),dark:f(a,`dark`)},{package:`@webority/tokens`,version:S,brand:e.name}),y=T(c(h.web,h.web390)),b={css:g.css,phone:_.contents,email:y},x=v.resolve(n,l),C=[[v.join(x,t.css),g.css],[v.join(x,t.bootstrap),g.variables],[v.join(x,t.web),T(h.web)],[v.join(x,t.web390),T(h.web390)],[v.join(x,t.phoneTheme),T(h.phone)],[v.join(x,t.phone),_.contents],[v.join(x,t.email),y]];V.push(...C);for(let e of I)e.brand===i.name&&V.push(E(n,e,b))}catch(e){for(let t of String(e?.message??e).split(`
+`))t.length!==0&&L.push(C.test(t)?t:`${d}: -: ${t}. Fix the source.`)}}if(L.length>0)throw Error(L.join(`
+`));for(let[e,t]of V)await k(e,t);return{written:w,stale:O}}function T(e){return`${JSON.stringify(e,null,4)}\n`}function E(e,r,i){let a=v.resolve(e,r.path);return r.kind===`razor`?[v.join(a,`wwwroot`,n,t.css),i.css]:r.kind===`spa`?[v.join(a,`src`,n,t.css),i.css]:r.kind===`phone`?[v.join(a,n,t.phone),i.phone]:[v.join(a,n,t.email),i.email]}async function D(){let e={};for(let[t,n]of Object.entries(S))e[t]=JSON.parse(await g(new URL(`./source/${n}`,import.meta.url),`utf8`));return e}export{w as brand};

package/dist/canvas/renames.json

@@ -0,0 +1,159 @@
+{
+    "from": "webority-theme-tokens/1",
+    "to": "webority-theme-tokens/2",
+    "color": {
+        "accent-dark": "primary-hover",
+        "bg-elevated": "bg-subtle",
+        "bg-light": "surface",
+        "bg-muted": "bg-muted",
+        "bg-page": "bg",
+        "border-light": "border",
+        "border-soft": "border-subtle",
+        "border-strong": "border-strong",
+        "chart-1": "chart-1",
+        "chart-2": "chart-2",
+        "chart-3": "chart-3",
+        "chart-4": "chart-4",
+        "chart-5": "chart-5",
+        "chart-6": "chart-6",
+        "chart-7": "chart-7",
+        "chart-8": "chart-8",
+        "chart-diverging-high": "chart-diverging-high",
+        "chart-diverging-low": "chart-diverging-low",
+        "chart-diverging-mid": "chart-diverging-mid",
+        "chart-neutral": "chart-neutral",
+        "chart-seq-0": "chart-seq-0",
+        "chart-seq-1": "chart-seq-1",
+        "chart-seq-2": "chart-seq-2",
+        "chart-seq-3": "chart-seq-3",
+        "chart-seq-4": "chart-seq-4",
+        "chart-seq-5": "chart-seq-5",
+        "chart-seq-6": "chart-seq-6",
+        "danger": "danger",
+        "danger-10": "danger-soft",
+        "danger-20": null,
+        "danger-30": "danger-border",
+        "danger-5": null,
+        "danger-50": null,
+        "danger-active": "danger-pressed",
+        "danger-strong": "danger-strong",
+        "danger-strong-hover": "danger-strong-hover",
+        "danger-text": "danger-text",
+        "fg-2": "text-body",
+        "fg-3": "text-muted",
+        "fg-4": "text-subtle",
+        "fg-5": "border-strong",
+        "field-bg": "field-bg",
+        "field-border": "field-border",
+        "field-border-hover": "field-border-hover",
+        "info": "info",
+        "info-10": "info-soft",
+        "info-20": null,
+        "info-30": "info-border",
+        "info-5": null,
+        "info-50": null,
+        "info-active": "info-pressed",
+        "info-text": "info-text",
+        "ink": null,
+        "neutral-bg-dark": "bg-muted",
+        "neutral-bg-light": "bg-subtle",
+        "neutral-border-dark": "border",
+        "neutral-border-light": "border-subtle",
+        "primary": "primary",
+        "primary-10": "primary-soft",
+        "primary-15": null,
+        "primary-20": null,
+        "primary-30": null,
+        "primary-5": null,
+        "primary-50": null,
+        "primary-hover": "primary-hover",
+        "primary-ink": "primary-text",
+        "primary-pressed": "primary-hover",
+        "primary-text": "on-primary",
+        "progress-track": "progress-track",
+        "scrollbar": "scrollbar",
+        "scrollbar-active": "scrollbar-active",
+        "scrollbar-hover": "scrollbar-hover",
+        "shadow-overlay": null,
+        "shadow-overlay-lg": null,
+        "success": "success",
+        "success-10": "success-soft",
+        "success-20": null,
+        "success-30": "success-border",
+        "success-5": null,
+        "success-50": null,
+        "success-active": "success-pressed",
+        "success-strong": "success-strong",
+        "success-text": "success-text",
+        "surface-mute": "bg-subtle",
+        "surface-soft": null,
+        "surface-violet": null,
+        "surface-violet-soft": null,
+        "text-1": "text-body",
+        "text-2": "text-muted",
+        "text-3": "text-subtle",
+        "text-4": "text-subtle",
+        "text-5": "border-strong",
+        "text-heading": "text",
+        "warning": "warning",
+        "warning-10": "warning-soft",
+        "warning-20": null,
+        "warning-30": "warning-border",
+        "warning-5": null,
+        "warning-50": null,
+        "warning-active": "warning-pressed",
+        "warning-strong": "warning-strong",
+        "warning-strong-hover": "warning-strong-hover",
+        "warning-text": "warning-text"
+    },
+    "font": {
+        "display": "display",
+        "mono": "mono",
+        "sans": "ui"
+    },
+    "text": {
+        "48": "4xl",
+        "64": "5xl",
+        "2xl": "2xl",
+        "3xl": "3xl",
+        "4xl": "4xl",
+        "5xl": "5xl",
+        "6xl": "6xl",
+        "7xl": "7xl",
+        "8xl": "8xl",
+        "base": "base",
+        "lg": "lg",
+        "sm": "sm",
+        "smb": "sm",
+        "xl": "xl",
+        "xs": "xs"
+    },
+    "space": {
+        "2xl": "2xl",
+        "3xl": "3xl",
+        "4xl": "4xl",
+        "lg": "lg",
+        "md": "md",
+        "none": "none",
+        "sm": "sm",
+        "xl": "xl",
+        "xs": "xs",
+        "xxs": "xxs"
+    },
+    "radius": {
+        "lg": "lg",
+        "md": "md",
+        "pill": "pill",
+        "sm": "sm",
+        "xl": "xl"
+    },
+    "shadow": {
+        "card": "card",
+        "card-lifted": null,
+        "card-lifted-hover": null,
+        "overlay": "popover",
+        "overlay-lg": "modal",
+        "thumb": null,
+        "thumb-hover": null
+    }
+}