@webority/canvas-kit 0.130.0 → 0.130.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -1
- package/dist/build.js +2 -2
- package/dist/index.js +1 -1
- package/dist/manifest.d.ts +23 -0
- package/dist/manifest.js +1 -1
- package/dist/renames.d.ts +15 -0
- package/dist/renames.js +1 -0
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -28,6 +28,7 @@ The config is a JSON object with these keys. Paths are relative to the config fi
|
|
|
28
28
|
| Key | Meaning |
|
|
29
29
|
| --- | --- |
|
|
30
30
|
| `kit` | The kit key, lowercase letters, digits and hyphens, 2 to 40 characters, for example `sample-kit`. |
|
|
31
|
+
| `renames` | Optional. The folder of rename tables, one `<version>.json` per library release, relative to the config file. The fleet kits set it to `node_modules/@webority/tokens/renames`. The build refuses a missing folder. |
|
|
31
32
|
| `platform` | `Web` or `Phone`. |
|
|
32
33
|
| `libraryPackage` | The Webority library the kit is built on, for example `@webority/ui-react`. |
|
|
33
34
|
| `components` | A glob of `.meta.js` files, for example `src/components/*.meta.js`. |
|
|
@@ -49,7 +50,10 @@ The release folder holds these four files:
|
|
|
49
50
|
- `kit.css`: the styles the bundle imports, or an empty file.
|
|
50
51
|
- `manifest.json`: the components with their props, sources and roles, the library's tokens and icons, and the style
|
|
51
52
|
keys each with its `phoneSupported` flag when a style key table is given. Each component carries its `usage` and each
|
|
52
|
-
prop its `description` and `default`.
|
|
53
|
+
prop its `description` and `default`. With `renames` set in the config, it also carries `renames`: one entry per rename
|
|
54
|
+
table at or below the library version, in ascending version order. Each entry projects the table's prop renames, value
|
|
55
|
+
renames, added and removed props for the components the kit lists; a table's renames of a component the kit does not
|
|
56
|
+
list, or of a prop the kit does not declare, are left out and reported as build warnings.
|
|
53
57
|
- `release.json`: the kit key as `name`, the `version`, the platform, the kit module version, the protocol version, the
|
|
54
58
|
library name and version, and the SHA-256 and byte count of each file above.
|
|
55
59
|
|
package/dist/build.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import{findPackageDir as e,readJson as t,toPosix as n}from"./files.js";import{KIT_MODULE_EXTERNALS as r}from"./kitModule.js";import{libraryFiles as i,readManifest as a}from"./manifest.js";import{digest as o,writeReleaseFolder as s}from"./release.js";import{existsSync as c,realpathSync as l}from"node:fs";import{dirname as u,join as d,resolve as f}from"node:path";import{fileURLToPath as p}from"node:url";import{build as m}from"vite";var h=19,g=[`react-redux`,`react-router-dom`,`axios`],_=[`kit`,`platform`,`libraryPackage`,`components`,`tokens`,`rolesFile`,`styles`,`rendererProtocolVersion`],v=[`kit`,`platform`,`libraryPackage`,`components`,`tokens`,`rendererProtocolVersion`],y=`canvas-kit:entry`,b=`\0${y}`,x=d(u(p(import.meta.url)),`kitModule.js`),S={"process.env.NODE_ENV":JSON.stringify(`production`),"process.env":`{}`,__DEV__:`false`},C=/(?<![\w$."'`])(process\.env|__DEV__)(?![\w$])/;function w(e){let n=t(e);if(typeof n!=`object`||!n||Array.isArray(n))throw Error(`${e} must be a JSON object.`);if(n.entry!==void 0)throw Error(`${e}: A kit lists its components with components, a glob of .meta.js files; entry is retired.`);for(let t of Object.keys(n))if(!_.includes(t))throw Error(`${e} has the unknown key ${t}. The keys are ${_.join(`, `)}.`);for(let t of v)if(n[t]===void 0)throw Error(`${e} needs the key ${t}.`);for(let t of[`kit`,`platform`,`libraryPackage`,`components`,`tokens`])if(typeof n[t]!=`string`)throw Error(`${e}: ${t} must be a string.`);for(let t of[`rolesFile`])if(n[t]!==void 0&&typeof n[t]!=`string`)throw Error(`${e}: ${t} must be a string path.`);if(n.styles!==void 0){if(!Array.isArray(n.styles)||n.styles.some(e=>typeof e!=`string`||e===``))throw Error(`${e}: styles must be a list of style file paths.`);for(let t of n.styles){if(!/\.(css|scss)$/.test(t))throw Error(`${e}: styles names ${t}, which is not a .css or .scss file.`);if(!c(f(u(e),t)))throw Error(`${e}: styles names ${t}, which does not exist.`)}}return n}function T(n){let r=e(n,`react`);if(!r)throw Error(`react is not installed for ${n}. Run pnpm install there.`);let{version:i}=t(d(r,`package.json`));if(Number(String(i).split(`.`)[0])!==h)throw Error(`The product uses React ${i}; the Canvas renderer runs React ${h}. Pin react to ${h}.x and rebuild.`)}function E(e){let{version:n}=t(d(e,`package.json`));if(!n)throw Error(`${d(e,`package.json`)} needs a version; the release is stamped with it.`);return n}function D({styleFiles:e,libraryFile:t,libraryPackage:r,chromeFile:i,manifest:a,libraryNames:o,chromeNames:s,productModules:c}){let l=[...c],u=[...o.map(({fixedProps:e})=>e),...l.map(([,{fixedProps:e}])=>e)].some(e=>e!==void 0),d=e.map(e=>`import ${JSON.stringify(n(e))};`);u&&d.push(`import { createElement } from "react";`),d.push(`import { ${u?`defineKit, withFixedProps`:`defineKit`} } from ${JSON.stringify(n(x))};`),l.forEach(([,{module:e,exportName:t}],r)=>{d.push(`import { ${t} as product${r} } from ${JSON.stringify(n(e))};`)});let f=a.platform===`Phone`,p=f&&r===`@webority/mobile-ui`,m=[...new Set(o.map(({exportName:e})=>e))];p&&!m.includes(`KitThemeBridge`)&&m.push(`KitThemeBridge`),m.length>0&&d.push(`import { ${m.join(`, `)} } from ${JSON.stringify(n(t))};`),s.length>0&&d.push(`import { ${s.join(`, `)} } from ${JSON.stringify(n(i))};`),f&&!p&&d.push(`import { KitThemeBridge } from "@webority/mobile-ui";`);let h=(e,t,n)=>n===void 0?e===t?e:`${e}: ${t}`:`${e}: withFixedProps(createElement, ${t}, ${JSON.stringify(n)}, ${JSON.stringify(e)})`,g=[...o.map(({name:e,exportName:t,fixedProps:n})=>h(e,t,n)),...s,...l.map(([e,{fixedProps:t}],n)=>h(e,`product${n}`,t))],_=Object.fromEntries(a.components.filter(({marker:e})=>e!==null).map(({name:e,marker:t})=>[e,t])),v=f?`, themeBridge: KitThemeBridge`:``;return d.push(`export default defineKit({ components: { ${g.join(`, `)} }, markers: ${JSON.stringify(_)}, tokenValues: ${JSON.stringify(a.tokenValues)}, manifest: ${JSON.stringify(a)}${v} });`,``),d.join(`
|
|
1
|
+
import{findPackageDir as e,readJson as t,toPosix as n}from"./files.js";import{KIT_MODULE_EXTERNALS as r}from"./kitModule.js";import{libraryFiles as i,readManifest as a}from"./manifest.js";import{digest as o,writeReleaseFolder as s}from"./release.js";import{existsSync as c,realpathSync as l}from"node:fs";import{dirname as u,join as d,resolve as f}from"node:path";import{fileURLToPath as p}from"node:url";import{build as m}from"vite";var h=19,g=[`react-redux`,`react-router-dom`,`axios`],_=[`kit`,`platform`,`libraryPackage`,`components`,`tokens`,`rolesFile`,`styles`,`rendererProtocolVersion`,`renames`],v=[`kit`,`platform`,`libraryPackage`,`components`,`tokens`,`rendererProtocolVersion`],y=`canvas-kit:entry`,b=`\0${y}`,x=d(u(p(import.meta.url)),`kitModule.js`),S={"process.env.NODE_ENV":JSON.stringify(`production`),"process.env":`{}`,__DEV__:`false`},C=/(?<![\w$."'`])(process\.env|__DEV__)(?![\w$])/;function w(e){let n=t(e);if(typeof n!=`object`||!n||Array.isArray(n))throw Error(`${e} must be a JSON object.`);if(n.entry!==void 0)throw Error(`${e}: A kit lists its components with components, a glob of .meta.js files; entry is retired.`);for(let t of Object.keys(n))if(!_.includes(t))throw Error(`${e} has the unknown key ${t}. The keys are ${_.join(`, `)}.`);for(let t of v)if(n[t]===void 0)throw Error(`${e} needs the key ${t}.`);for(let t of[`kit`,`platform`,`libraryPackage`,`components`,`tokens`])if(typeof n[t]!=`string`)throw Error(`${e}: ${t} must be a string.`);for(let t of[`rolesFile`])if(n[t]!==void 0&&typeof n[t]!=`string`)throw Error(`${e}: ${t} must be a string path.`);if(n.styles!==void 0){if(!Array.isArray(n.styles)||n.styles.some(e=>typeof e!=`string`||e===``))throw Error(`${e}: styles must be a list of style file paths.`);for(let t of n.styles){if(!/\.(css|scss)$/.test(t))throw Error(`${e}: styles names ${t}, which is not a .css or .scss file.`);if(!c(f(u(e),t)))throw Error(`${e}: styles names ${t}, which does not exist.`)}}return n}function T(n){let r=e(n,`react`);if(!r)throw Error(`react is not installed for ${n}. Run pnpm install there.`);let{version:i}=t(d(r,`package.json`));if(Number(String(i).split(`.`)[0])!==h)throw Error(`The product uses React ${i}; the Canvas renderer runs React ${h}. Pin react to ${h}.x and rebuild.`)}function E(e){let{version:n}=t(d(e,`package.json`));if(!n)throw Error(`${d(e,`package.json`)} needs a version; the release is stamped with it.`);return n}function D({styleFiles:e,libraryFile:t,libraryPackage:r,chromeFile:i,manifest:a,libraryNames:o,chromeNames:s,productModules:c}){let l=[...c],u=[...o.map(({fixedProps:e})=>e),...l.map(([,{fixedProps:e}])=>e)].some(e=>e!==void 0),d=e.map(e=>`import ${JSON.stringify(n(e))};`);u&&d.push(`import { createElement } from "react";`),d.push(`import { ${u?`defineKit, withFixedProps`:`defineKit`} } from ${JSON.stringify(n(x))};`),l.forEach(([,{module:e,exportName:t}],r)=>{d.push(`import { ${t} as product${r} } from ${JSON.stringify(n(e))};`)});let f=a.platform===`Phone`,p=f&&r===`@webority/mobile-ui`,m=[...new Set(o.map(({exportName:e})=>e))];p&&!m.includes(`KitThemeBridge`)&&m.push(`KitThemeBridge`),m.length>0&&d.push(`import { ${m.join(`, `)} } from ${JSON.stringify(n(t))};`),s.length>0&&d.push(`import { ${s.join(`, `)} } from ${JSON.stringify(n(i))};`),f&&!p&&d.push(`import { KitThemeBridge } from "@webority/mobile-ui";`);let h=(e,t,n)=>n===void 0?e===t?e:`${e}: ${t}`:`${e}: withFixedProps(createElement, ${t}, ${JSON.stringify(n)}, ${JSON.stringify(e)})`,g=[...o.map(({name:e,exportName:t,fixedProps:n})=>h(e,t,n)),...s,...l.map(([e,{fixedProps:t}],n)=>h(e,`product${n}`,t))],_=Object.fromEntries(a.components.filter(({marker:e})=>e!==null).map(({name:e,marker:t})=>[e,t])),v=f?`, themeBridge: KitThemeBridge`:``;return d.push(`export default defineKit({ components: { ${g.join(`, `)} }, markers: ${JSON.stringify(_)}, tokenValues: ${JSON.stringify(a.tokenValues)}, manifest: ${JSON.stringify(a)}${v} });`,``),d.join(`
|
|
2
2
|
`)}function O(e){return{name:`canvas-kit-entry`,resolveId(e){return e===y?b:null},load(t){return t===b?e:null}}}function k(e){let t=`${n(d(e,`src`,`services`))}/`;return{name:`canvas-kit-banned-imports`,transform(e,r){let i=n(r.split(`?`)[0]),a=g.find(e=>i.includes(`/node_modules/${e}/`));if(a)throw Error(`The kit imports ${a} (${i}). A kit draws from its props only; the container that renders it holds the state and the calls.`);if(i.startsWith(t))throw Error(`The kit imports ${i}, which is in src/services. A kit draws from its props only; move the call into the container.`);return null}}}async function A({root:e,kit:t,platform:n,styleFiles:i,libraryFile:a,libraryPackage:o,chromeFile:s,libraryNames:c,chromeNames:l,productModules:u,manifest:d}){let f=r[n],p=await m({configFile:!1,root:e,logLevel:`warn`,publicDir:!1,envDir:!1,define:S,plugins:[O(D({styleFiles:i,libraryFile:a,libraryPackage:o,chromeFile:s,manifest:d,libraryNames:c,chromeNames:l,productModules:u})),k(e)],esbuild:{jsx:`automatic`,jsxImportSource:`react`,include:/\.[cm]?[jt]sx?$/},build:{write:!1,minify:!0,target:`es2022`,cssCodeSplit:!1,lib:{entry:y,formats:[`es`],fileName:()=>`kit.js`},rollupOptions:{input:y,external:e=>f.some(t=>e===t||e.startsWith(`${t}/`)),output:{codeSplitting:!1}}}}),h=(Array.isArray(p)?p:[p]).flatMap(e=>e.output),g=h.find(e=>e.type===`chunk`&&e.isEntry);if(!g)throw Error(`The bundle of ${t} has no entry module.`);let _=C.exec(g.code);if(_)throw Error(`The bundle of ${t} still reads ${_[1]}, which the renderer does not define.`);let v=h.filter(e=>e.type===`chunk`&&!e.isEntry);if(v.length>0)throw Error(`The bundle of ${t} split ${v.map(e=>e.fileName).join(`, `)} out of kit.js; a kit must be one file.`);let b=h.filter(e=>e.type===`asset`&&e.fileName.endsWith(`.css`)).map(e=>typeof e.source==`string`?e.source:Buffer.from(e.source).toString(`utf8`)).join(`
|
|
3
|
-
`);return{script:g.code,styles:b}}async function j({configFile:e,outDir:t,styleKeysFile:n,phoneRendererSupportFile:r}){let d=f(e),p=f(t);if(c(p))throw Error(`${p} already exists. A release folder is never overwritten; choose a new folder.`);let m=w(d),h=l(u(d));if(m.platform!==`Phone`&&r!==void 0)throw Error(`Only a Phone kit reads --phone-renderer-support; a Web kit takes no phone support file.`);T(h);let g=m.rolesFile===void 0?void 0:f(h,m.rolesFile),{manifest:_,warnings:v,phoneChromeNames:y,productModules:b}=await a({projectRoot:h,kit:m.kit,platform:m.platform,components:m.components,tokens:m.tokens,libraryPackage:m.libraryPackage,rolesFile:g,rendererProtocolVersion:m.rendererProtocolVersion,phoneRendererSupportFile:r===void 0?void 0:f(r),styleKeysFile:n===void 0?void 0:f(n)}),x=i(h,m.libraryPackage),S=E(h),C=_.components.filter(({source:e,name:t})=>e===m.libraryPackage&&!y.includes(t)).map(({name:e,component:t,fixedProps:n})=>({name:e,exportName:t??e,...n===void 0?{}:{fixedProps:n}})),{script:D,styles:O}=await A({root:h,kit:m.kit,platform:m.platform,styleFiles:(m.styles??[]).map(e=>f(h,e)),libraryFile:x.entryFile,libraryPackage:m.libraryPackage,chromeFile:x.canvasKitFile,libraryNames:C,chromeNames:y,productModules:b,manifest:_}),k={"manifest.json":`${JSON.stringify(_,null,2)}\n`,"kit.js":D,"kit.css":O},j={name:m.kit,version:S,platform:m.platform,kitModuleVersion:2,rendererProtocolVersion:m.rendererProtocolVersion,library:_.library,files:Object.fromEntries(Object.entries(k).map(([e,t])=>[e,o(t)]))};return s(p,k,j),{outDir:p,release:j,manifest:_,warnings:v}}export{j as buildKitRelease,w as readConfig};
|
|
3
|
+
`);return{script:g.code,styles:b}}async function j({configFile:e,outDir:t,styleKeysFile:n,phoneRendererSupportFile:r}){let d=f(e),p=f(t);if(c(p))throw Error(`${p} already exists. A release folder is never overwritten; choose a new folder.`);let m=w(d),h=l(u(d));if(m.platform!==`Phone`&&r!==void 0)throw Error(`Only a Phone kit reads --phone-renderer-support; a Web kit takes no phone support file.`);T(h);let g=m.rolesFile===void 0?void 0:f(h,m.rolesFile),{manifest:_,warnings:v,phoneChromeNames:y,productModules:b}=await a({projectRoot:h,kit:m.kit,platform:m.platform,components:m.components,tokens:m.tokens,libraryPackage:m.libraryPackage,rolesFile:g,rendererProtocolVersion:m.rendererProtocolVersion,phoneRendererSupportFile:r===void 0?void 0:f(r),styleKeysFile:n===void 0?void 0:f(n),renamesDir:m.renames===void 0?void 0:f(h,m.renames)}),x=i(h,m.libraryPackage),S=E(h),C=_.components.filter(({source:e,name:t})=>e===m.libraryPackage&&!y.includes(t)).map(({name:e,component:t,fixedProps:n})=>({name:e,exportName:t??e,...n===void 0?{}:{fixedProps:n}})),{script:D,styles:O}=await A({root:h,kit:m.kit,platform:m.platform,styleFiles:(m.styles??[]).map(e=>f(h,e)),libraryFile:x.entryFile,libraryPackage:m.libraryPackage,chromeFile:x.canvasKitFile,libraryNames:C,chromeNames:y,productModules:b,manifest:_}),k={"manifest.json":`${JSON.stringify(_,null,2)}\n`,"kit.js":D,"kit.css":O},j={name:m.kit,version:S,platform:m.platform,kitModuleVersion:2,rendererProtocolVersion:m.rendererProtocolVersion,library:_.library,files:Object.fromEntries(Object.entries(k).map(([e,t])=>[e,o(t)]))};return s(p,k,j),{outDir:p,release:j,manifest:_,warnings:v}}export{j as buildKitRelease,w as readConfig};
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{buildKitRelease as e,readConfig as t}from"./build.js";import{guidanceOf as n,writeGuidance as r}from"./guidance.js";import{KIT_MODULE_EXTERNALS as i,defineKit as a,kitModuleVersion as o}from"./kitModule.js";import{readManifest as s}from"./manifest.js";import{checkMetaTypes as c}from"./metaCheck.js";import{HTML_TAGS as l,readMetas as u}from"./metas.js";import{readReleaseManifest as d}from"./release.js";export{l as HTML_TAGS,i as KIT_MODULE_EXTERNALS,e as buildKitRelease,c as checkMetaTypes,a as defineKit,n as guidanceOf,o as kitModuleVersion,t as readConfig,s as readManifest,u as readMetas,d as readReleaseManifest,r as writeGuidance};
|
|
1
|
+
import{buildKitRelease as e,readConfig as t}from"./build.js";import{guidanceOf as n,writeGuidance as r}from"./guidance.js";import{KIT_MODULE_EXTERNALS as i,defineKit as a,kitModuleVersion as o}from"./kitModule.js";import{readManifest as s}from"./manifest.js";import{checkMetaTypes as c}from"./metaCheck.js";import{HTML_TAGS as l,readMetas as u}from"./metas.js";import{readReleaseManifest as d}from"./release.js";import{readRenames as f,renamesBetween as p}from"./renames.js";export{l as HTML_TAGS,i as KIT_MODULE_EXTERNALS,e as buildKitRelease,c as checkMetaTypes,a as defineKit,n as guidanceOf,o as kitModuleVersion,t as readConfig,s as readManifest,u as readMetas,d as readReleaseManifest,f as readRenames,p as renamesBetween,r as writeGuidance};
|
package/dist/manifest.d.ts
CHANGED
|
@@ -141,6 +141,29 @@ export interface CanvasManifest {
|
|
|
141
141
|
icons: string[];
|
|
142
142
|
// A product release no longer carries style keys; the embedded Webority manifests keep them as the renderer's table.
|
|
143
143
|
styleKeys?: CanvasManifestStyleKey[];
|
|
144
|
+
// Present on every release built by a canvas-kit that reads rename tables; absent on older releases.
|
|
145
|
+
renames?: CanvasManifestRename[];
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
// A component rename of one library release, as Canvas applies it to a stored document. `name` is the component's name before
|
|
149
|
+
// the release; `to` its name after it when the release renamed it. `props` maps old prop names to new. `values` maps, per new
|
|
150
|
+
// prop name, old literal values to new. `added` lists props the release sets on a converted element that lacks them. `removed`
|
|
151
|
+
// lists props the release dropped, with the table's hint; Canvas drops them on a move and reports the hint.
|
|
152
|
+
export interface CanvasManifestComponentRename {
|
|
153
|
+
name: string;
|
|
154
|
+
to?: string;
|
|
155
|
+
props: Record<string, string>;
|
|
156
|
+
values: Record<string, Record<string, string>>;
|
|
157
|
+
added: Record<string, string | number | boolean>;
|
|
158
|
+
removed: Record<string, string>;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
// The renames of one library release, projected from its rename table for this kit's package. `values` holds the table's
|
|
162
|
+
// component-independent value renames, keyed by prop name. A manifest lists one entry per table at or below its library version.
|
|
163
|
+
export interface CanvasManifestRename {
|
|
164
|
+
version: string;
|
|
165
|
+
components: CanvasManifestComponentRename[];
|
|
166
|
+
values: Record<string, Record<string, string>>;
|
|
144
167
|
}
|
|
145
168
|
|
|
146
169
|
export interface CanvasReleaseFileStamp {
|
package/dist/manifest.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{NOT_DRAWN_FILE as e,checkDrawn as t,componentExports as n,readNotDrawn as r}from"./drawn.js";import{findPackageDir as i,readJson as a,toPosix as o}from"./files.js";import"./kitModule.js";import{checkMetaTypes as s}from"./metaCheck.js";import{ROLES as c,componentModuleOf as l,manifestComponent as u,readMetas as d}from"./metas.js";import{applyPhoneActions as f,phoneChromeEntries as ee,phoneIcons as p}from"./phone.js";import{tokensFromV2 as m,webIcons as h}from"./tokens.js";import{existsSync as g}from"node:fs";import{join as _,relative as
|
|
1
|
+
import{NOT_DRAWN_FILE as e,checkDrawn as t,componentExports as n,readNotDrawn as r}from"./drawn.js";import{findPackageDir as i,readJson as a,toPosix as o}from"./files.js";import"./kitModule.js";import{checkMetaTypes as s}from"./metaCheck.js";import{ROLES as c,componentModuleOf as l,manifestComponent as u,readMetas as d}from"./metas.js";import{applyPhoneActions as f,phoneChromeEntries as ee,phoneIcons as p}from"./phone.js";import{readRenamesWithWarnings as te}from"./renames.js";import{tokensFromV2 as m,webIcons as h}from"./tokens.js";import{existsSync as g}from"node:fs";import{join as _,relative as ne,resolve as v}from"node:path";var y=/^[a-z][a-z0-9-]{1,39}$/,b=[`Web`,`Phone`],x={Web:`WeborityWeb`,Phone:`WeborityPhone`},S={Web:`web`,Phone:`phone`};function C(e,t){let n=_(e,`package.json`),r=g(n)&&a(n).name===t,o=r?e:i(e,t);if(!o)throw Error(`${t} is not installed for ${e}. Run pnpm install there.`);let s=a(_(o,`package.json`)),c=(e,t)=>{if(typeof e==`string`)return t==="default"?e:void 0;if(e&&typeof e==`object`)return typeof e[t]==`string`?e[t]:c(e.import,t)??c(e.default,t)},l=s.exports?.[`.`],u=s.types??c(l,`types`),d=c(l,`default`)??s.main;if(!u)throw Error(`${t} declares no types, and the manifest reads its declaration files.`);if(!d)throw Error(`${t} declares no entry file for its runtime.`);let f=c(s.exports?.[`./canvasKit`],`default`);return{dir:o,pkg:s,isSelf:r,typesFile:_(o,u),entryFile:_(o,d),canvasKitFile:f?_(o,f):null}}function re(e,t,n){let r=a(_(e,`package.json`)),i=r.dependencies?.[t]??r.devDependencies?.[t];if(/^\d+\.\d+\.\d+$/.test(i??``)&&i!==n)throw Error(`${t} is pinned to ${i} in package.json but ${n} is installed. Run pnpm install first.`)}function ie(e,t,n){let r=e.pkg.exports?.[`./canvas-kit/*`];if(typeof r!=`string`)throw Error(`${t} exports no ./canvas-kit/*; a product kit takes the library's components from its kit release.`);let i=_(e.dir,r.replace(`*`,`manifest.json`)),o=a(i);if(!(o?.kind===x[n]&&o.platform===n&&Array.isArray(o.components)&&Array.isArray(o.icons)))throw Error(`${i} is not a ${n} library kit release.`);return o}function w(e,t){let n=S[t];for(let{meta:r,file:i}of e)if(!r.platforms?.includes(n))throw Error(`${i}: platforms: a ${t} kit lists only components that list ${n}`)}function T(e,t){if(!t)return;let n=a(t);if(typeof n!=`object`||!n||Array.isArray(n))throw Error(`${t} must be an object from component name to role.`);for(let[r,i]of Object.entries(n)){let n=e.find(e=>e.name===r);if(!n)throw Error(`${t} names ${r}, which the kit does not have.`);if(!c.includes(i))throw Error(`${t}: ${r} has role ${JSON.stringify(i)}; a role is title or navigation.`);n.role=i}}function ae(e){let t=a(e);if(!Array.isArray(t)||t.some(e=>typeof e?.name!=`string`))throw Error(`${e} must be the style key table: a list of style keys, each with a name.`);return t}function E(e){let t=a(e);if(t?.schema!==1)throw Error(`${e} has schema ${t?.schema}; this reader reads schema 1.`);if(!t.itemActions)throw Error(`${e} has no itemActions; the phone kit's action lists come from it.`);return{flags:t.styleKeys??{},itemActions:t.itemActions}}function D(e,t,n){let r=e.map(({name:e})=>e),i=r.filter(e=>typeof t[e]!=`boolean`),a=Object.keys(t).filter(e=>!r.includes(e));if(i.length>0||a.length>0)throw Error(`${n} must list exactly the style keys of the style key table, each true or false. Missing or not a boolean: ${i.join(`, `)||`none`}. Not in the table: ${a.join(`, `)||`none`}.`)}function O(e,t){return e.map(({name:e,type:n,values:r,appliesTo:i,description:a})=>({name:e,type:n,values:r,appliesTo:i,...t?{phoneSupported:t[e]}:{},description:a}))}var oe=(e,t)=>e.name<t.name?-1:+(e.name>t.name);async function k({projectRoot:a,kit:c,platform:g,entry:S,components:k,tokens:A,libraryPackage:j,rolesFile:M,rendererProtocolVersion:N,phoneRendererSupportFile:P,styleKeysFile:F,renamesDir:I}){if(!y.test(c??``))throw Error(`kit ${JSON.stringify(c)} must be 2 to 40 characters: lowercase letters, digits and hyphens, starting with a letter.`);if(!b.includes(g))throw Error(`platform must be Web or Phone, not ${JSON.stringify(g)}.`);if(!Number.isInteger(N)||N<1)throw Error(`rendererProtocolVersion must be a positive integer, not ${JSON.stringify(N)}.`);if(S!==void 0)throw Error(`A kit lists its components with components, a glob of .meta.js files; entry is retired.`);if(typeof k!=`string`||k===``||typeof A!=`string`||A===``)throw Error(`A kit needs components, a glob of .meta.js files, and tokens, the path of its webority-theme-tokens/2 file.`);let L=v(a),R=C(L,j),z=R.isSelf;if(g===`Phone`&&!P&&!z)throw Error(`A Phone product kit needs phoneRendererSupportFile, the phone renderer's support file; only a phone library's own kit release builds without it.`);z||re(L,j,R.pkg.version);let B=P?E(P):null,V=g===`Phone`?B:null,H=F?ae(F):null;H&&B&&D(H,B.flags,P);let U=z?null:ie(R,j,g),W;W=z?g===`Web`?h(_(R.dir,`dist`)):p(_(R.dir,`lib`,`typescript`,`module`,`components`,`AppIcon`,`catalog.g.d.ts`)):U.icons;let G=[];z&&(G=await d({root:L,components:k,icons:W}),w(G,g),t({libraryPackage:j,exported:n({root:L,typesFile:R.typesFile}),drawnNames:G.map(({meta:e})=>({name:e.name,component:e.component??e.name})),notDrawn:r(_(R.dir,e))}),g===`Web`&&s({root:L,metas:G,componentOf:()=>R.typesFile}));let K=[],q=new Map;if(!z){let e=U.components.map(({name:e})=>e);K=await d({root:L,components:k,knownNames:e,icons:W}),w(K,g);let t=K.map(({meta:e})=>e.name).filter(t=>e.includes(t));if(t.length>0)throw Error(`The kit names ${t.join(`, `)} as ${j} already has them; rename the product components.`);g===`Web`&&s({root:L,metas:K,componentOf:(e,t)=>l(e,t)});for(let{meta:e,file:t}of K)q.set(e.name,{module:l(t,e.component??e.name),exportName:e.component??e.name,fixedProps:e.fixedProps})}let J=[];if(g===`Phone`){if(!R.canvasKitFile)throw Error(`${j} exports no ./canvasKit subpath; a Phone kit takes the device frame parts from it.`);J=ee(R.canvasKitFile,j)}if(z&&g===`Phone`){let e=new Set(G.map(({meta:e})=>e.name)),t=J.filter(({name:t})=>e.has(t)).map(({name:e})=>e);if(t.length>0)throw Error(`${j} exports ${t.join(`, `)} from both its main entry and ./canvasKit.`)}let se=z?G.map(({meta:e})=>u(e,{platform:g,source:j})):U.components,ce=K.map(({meta:e})=>u(e,{platform:g,source:o(ne(L,q.get(e.name).module))})),Y=[...se,...z?J:[],...ce].sort(oe);V&&f(Y,V.itemActions),T(Y,M);let X=i(L,`@webority/tokens`);if(!X)throw Error(`@webority/tokens is not installed for ${L}. Run pnpm install there.`);let Z=m(v(L,A),_(X,`dist`,`meanings.json`),g),Q={kind:z?x[g]:`Product`,library:{name:R.pkg.name,version:R.pkg.version},rendererProtocolVersion:N,platform:g,kitModuleVersion:2,productKit:null,components:Y,tokens:Z.tokens,tokenValues:Z.tokenValues,icons:W,...H?{styleKeys:O(H,V?V.flags:null)}:{}},$=[];if(I!==void 0){let e=te(I,j,R.pkg.version,Y);Q.renames=e.renames,$.push(...e.warnings)}return{manifest:Q,warnings:$,phoneChromeNames:J.map(({name:e})=>e),productModules:q,metas:z?G:K}}export{C as libraryFiles,k as readManifest,E as readPhoneSupport};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { CanvasManifestRename } from "./manifest.js";
|
|
2
|
+
|
|
3
|
+
// Reads every rename table in `renamesDir` whose version is at or below `version`, keeps the rules for `libraryPackage`,
|
|
4
|
+
// drops event-handler props (`on` followed by a capital) and a rule whose component the kit does not list, and answers the
|
|
5
|
+
// projection in ascending version order. Throws when the folder is missing, a table does not parse, or a rule of the table
|
|
6
|
+
// whose version equals `version` names a target prop or value prop the kit's `components` do not declare.
|
|
7
|
+
export function readRenames(
|
|
8
|
+
renamesDir: string,
|
|
9
|
+
libraryPackage: string,
|
|
10
|
+
version: string,
|
|
11
|
+
components: ReadonlyArray<{ name: string; props: ReadonlyArray<{ name: string }> }>,
|
|
12
|
+
): CanvasManifestRename[];
|
|
13
|
+
|
|
14
|
+
// The entries with `from` < version <= `to`, in ascending order; an empty list when `from` is at or above `to`.
|
|
15
|
+
export function renamesBetween(renames: readonly CanvasManifestRename[], from: string, to: string): CanvasManifestRename[];
|
package/dist/renames.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import{existsSync as e,readFileSync as t,readdirSync as n}from"node:fs";import{join as r}from"node:path";var i=/^\d+\.\d+\.\d+\.json$/,a=/^on[A-Z]/;function o(e,t){let n=e.split(`.`).map(Number),r=t.split(`.`).map(Number);for(let e=0;e<Math.max(n.length,r.length);e++){let t=(n[e]??0)-(r[e]??0);if(t!==0)return t}return 0}function s(e){return Object.fromEntries(Object.entries(e).filter(([e])=>!a.test(e)))}function c(e){try{return JSON.parse(t(e,`utf8`))}catch(t){throw Error(`${e} is not valid JSON: ${t.message}`)}}function l(e,t){return e.has(t)||e.set(t,{name:t,props:{},values:{},added:{},removed:{}}),e.get(t)}function u(e,t){let n=new Map,r={};for(let r of e.componentProps??[])if(r.package===t)for(let e of r.components){let t=l(n,e);r.to!==void 0&&(t.props[r.prop]=r.to),r.values!==void 0&&(t.values[r.to??r.prop]={...r.values}),r.to===void 0&&r.values===void 0&&r.flag!==void 0&&(t.removed[r.prop]=r.flag)}for(let r of e.components??[]){if(r.package!==t)continue;let e=l(n,r.from);r.to!==r.from&&(e.to=r.to),Object.assign(e.props,r.renameProps);for(let[t,n]of Object.entries(r.valueMaps))e.values[t]={...e.values[t],...n};Object.assign(e.added,r.addProps),Object.assign(e.removed,r.removeProps)}for(let n of e.props??[])if(n.package===t)for(let e of n.props)r[e]={...r[e],[n.from]:n.to};return{entries:n,values:r}}function d({tableVersion:e,version:t,libraryPackage:n,warnings:r,component:i,prop:a,target:s,declared:c}){if(c.has(s))return!0;if(o(e,t)===0)throw Error(`${e}: ${i}.${a} renames to ${s}, which ${n} ${t} does not declare`);return r.push(`${e}: ${i}.${a} renames to ${s}, which this kit does not declare; left out.`),!1}function f(e,{libraryPackage:t,version:n,components:r,warnings:i}){let a=e.version,{entries:o,values:c}=u(e,t),l=[];for(let e of o.values()){if(!r.find(t=>t.name===e.name)){i.push(`${a}: ${e.name} is not a component of this kit; its renames are left out.`);continue}let o=r.find(t=>t.name===(e.to??e.name)),c=new Set(o?.props.map(e=>e.name)??[]),u=(r,o)=>d({tableVersion:a,version:n,libraryPackage:t,warnings:i,component:e.name,prop:r,target:o,declared:c}),f={};for(let[t,n]of Object.entries(s(e.props)))u(t,n)&&(f[t]=n);let p={};for(let[t,n]of Object.entries(s(e.values)))u(t,t)&&(p[t]=n);let m=s(e.added),h=s(e.removed);(e.to!==void 0||Object.keys(f).length+Object.keys(p).length+Object.keys(m).length+Object.keys(h).length!==0)&&l.push({name:e.name,...e.to===void 0?{}:{to:e.to},props:f,values:p,added:m,removed:h})}return{version:a,components:l,values:s(c)}}function p(t,a,s,l){if(!e(t))throw Error(`${t} does not exist. Set renames in canvas-kit.json to the folder of rename tables.`);let u=n(t).filter(e=>i.test(e)).map(e=>c(r(t,e))).filter(e=>o(e.version,s)<=0).sort((e,t)=>o(e.version,t.version)),d=[];return{renames:u.map(e=>f(e,{libraryPackage:a,version:s,components:l,warnings:d})),warnings:d}}function m(e,t,n,r){return p(e,t,n,r).renames}function h(e,t,n){return e.filter(e=>o(e.version,t)>0&&o(e.version,n)<=0).sort((e,t)=>o(e.version,t.version))}export{m as readRenames,p as readRenamesWithWarnings,h as renamesBetween};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@webority/canvas-kit",
|
|
3
|
-
"version": "0.130.
|
|
3
|
+
"version": "0.130.1",
|
|
4
4
|
"description": "Builds product kits for Webority Canvas: a kit bundle, its manifest, and the spec shape the renderers answer.",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE",
|
|
6
6
|
"private": false,
|
|
@@ -20,6 +20,10 @@
|
|
|
20
20
|
"./source-stamp": {
|
|
21
21
|
"types": "./dist/sourceStamp.d.ts",
|
|
22
22
|
"default": "./dist/sourceStamp.js"
|
|
23
|
+
},
|
|
24
|
+
"./renames": {
|
|
25
|
+
"types": "./dist/renames.d.ts",
|
|
26
|
+
"default": "./dist/renames.js"
|
|
23
27
|
}
|
|
24
28
|
},
|
|
25
29
|
"bin": {
|