aa86873dd7
* build: typecheck the test suites Tests were in no TypeScript program: no tsconfig included tests/** or packages/*/tests/**, and bun strips types without checking them, so a fixture could drop a required field and keep passing until something read it. @types/bun moves to the root because it was installed per package only, and #cli-tests/* joins the paths the root config already carries. * test: fix the type errors the test suites were hiding Typechecking the tests turned up 1123 errors. Most were ordinary strictness, but some were real: `NodeChange` bound to Figma's plugin typings rather than the Kiwi codec in thirteen .fig tests, materializeInstance was called with six arguments against five so the blobs and source children were dropped, CanvasKit pixels were written to a plain object that never reached WASM, and assertions were made through accessors that do not exist, so they asserted nothing. Fixtures that had quietly lost a required field now carry it, nullable results are narrowed through the existing expectDefined helper rather than assumed, and stand-ins for CanvasKit and the editor go through one named helper instead of an unexplained cast at each site. No test was deleted, skipped, or weakened, and no `any`, non-null assertion, or ts-expect-error was introduced. * docs: record what typechecking the tests established Pins the app program's global types with an assertion rather than a note, since an unpinned types list lets any root @types package decide which platform src/** is judged against. The two environment faults that look like code regressions — Vite's dependency pre-bundle outliving a package rebuild, and heavy .fig suites failing under load — go to the development docs, where an explanation belongs. * fix: align @types/bun and keep node types resolvable when extended The root manifest declared a newer @types/bun than every package, which check:monorepo rejects, and pinning the app program's types left them unresolvable from a config that extends this one out of tree. * fix: fail the test typecheck when the compiler itself fails The gate matched diagnostics by substring, so a compiler or config failure that named no test file printed a pass while having checked nothing. Diagnostics are now split by whether they name a file: an unscoped one is the run failing and stops the gate, a test file's is a finding, and a source file's stays out by design. Also drops the parameter planComponentConstruction never read, and makes the inner-shadow verification script exit non-zero when it renders no image instead of logging and succeeding. * chore: merge master into tests-typecheck |
||
|---|---|---|
| .. | ||
| scripts | ||
| src | ||
| tests | ||
| NOTICE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.test.json | ||
| tsdown.config.ts | ||
@open-pencil/kiwi
Scene-graph-agnostic Kiwi runtime utilities for OpenPencil.
This package owns pure Kiwi schema parsing, Figma Kiwi schema data, low-level Figma message encode/decode, raw fig-kiwi container helpers, and GUID formatting. Complete .fig archive parsing lives in @open-pencil/fig; SceneGraph integration remains outside this package.
Credits and licensing
The schema runtime is based on Kiwi, a
schema-based binary format and JavaScript implementation by Evan Wallace.
The original Kiwi implementation is copyright (c) 2016–2023 Evan Wallace and
is licensed under the MIT License. OpenPencil's adapted runtime is distributed
under the terms of that license; see NOTICE.
bun add @open-pencil/kiwi
Package-local checks
cd packages/kiwi
bun run check
Package scripts:
bun run test— package-local Bun tests for schema runtime, Figma schema guards, codec, container, parse, GUID, and variable bindingsbun run typecheck— type-checkssrc, tests, and package scriptsbun run build— builds the distributabledistentrypointsbun run smoke:dist— imports built output and exercises the public APIbun run check— runs typecheck, tests, build, and dist smoke in sequence
Schema runtime
import { compileSchema, parseSchema, validateSchema } from '@open-pencil/kiwi/schema-runtime'
const schema = parseSchema(`
message Point {
float x = 1;
float y = 2;
}
`)
validateSchema(schema)
const codec = compileSchema(schema)
const bytes = codec.encodeMessage({ x: 12, y: 24 })
const point = codec.decodeMessage(bytes)
Figma Kiwi codec
import { createNodeChangesMessage, encodeMessage, initCodec } from '@open-pencil/kiwi/fig/codec'
await initCodec()
const message = createNodeChangesMessage(1, 1, [
{
guid: { sessionID: 1, localID: 1 },
phase: 'CREATED',
type: 'RECTANGLE',
name: 'Card',
size: { x: 320, y: 180 }
}
])
const bytes = encodeMessage(message)
Boolean operation payloads use Figma's Kiwi enum names. SceneGraph EXCLUDE is a core-level concept and should be serialized as Kiwi XOR before calling the low-level codec.
FIG Kiwi containers
import { buildFigKiwi, parseFigKiwiChunks } from '@open-pencil/kiwi/fig/container'
const container = buildFigKiwi(new Uint8Array([1, 2, 3]))
const chunks = parseFigKiwiChunks(container)
Raw fig-kiwi payload decoding
import { decodeFigKiwiCanvas } from '@open-pencil/kiwi/fig/parse'
const decoded = decodeFigKiwiCanvas(canvasBytes)
console.log(decoded.nodeChanges.length, decoded.blobs.length)
Use parseFigBuffer() from @open-pencil/fig for complete zipped .fig files, including image resources. Use @open-pencil/core/io for conversion into an editable SceneGraph.
GUID helpers
import { guidToString, stringToGuid } from '@open-pencil/kiwi/fig/guid'
const id = guidToString({ sessionID: 1, localID: 42 })
const guid = stringToGuid('1:42')
Public subpaths
@open-pencil/kiwi@open-pencil/kiwi/schema-runtime@open-pencil/kiwi/fig@open-pencil/kiwi/fig/codec@open-pencil/kiwi/fig/container@open-pencil/kiwi/fig/guid@open-pencil/kiwi/fig/parse
@open-pencil/kiwi must not import @open-pencil/core, #core/*, app code, Vue code, CLI code, or MCP code.