microboard-temp 0.13.71 → 0.13.72

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.
Files changed (2) hide show
  1. package/README.md +18 -44
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,52 +1,26 @@
1
- # Plan for Open-Sourcing the Board Component
1
+ # Microboard
2
2
 
3
- To open-source the Board component, we'll need to:
3
+ Microboard is a framework-agnostic interactive whiteboard library published as an npm package from this repository.
4
4
 
5
- ## Extract the Board code to a standalone library
5
+ ## Release And Integration Contract
6
6
 
7
- 1. Identify all files and dependencies related to the Board component
8
- 2. Create a new repository with appropriate folder structure for a component library
9
- 3. Move the relevant code while maintaining internal relationships between files
7
+ This repository publishes from the long-lived `trunk` branch. Every push to `trunk` runs [`.github/workflows/npm-publish.yml`](.github/workflows/npm-publish.yml). After a successful publish, the workflow emits the `microboard_published` event to both downstream consumers so their staging environments can validate against the latest shared core.
10
8
 
11
- ## Preserve git history from the original repository
9
+ The source of truth for that contract is [`docs/npm-publish-integration-contract.md`](docs/npm-publish-integration-contract.md).
12
10
 
13
- 1. Use `git filter-branch` or `git-filter-repo` to extract only the Board-related files and their history
14
- 2. This ensures all commits, authors, and timestamps are preserved for the component
15
- 3. Alternative approach: use `git subtree` if the component is in a distinct directory
11
+ That document defines:
16
12
 
17
- ## Set up proper packaging and exports
13
+ - what constitutes a successful publish
14
+ - the event emitted after publish
15
+ - the payload sent to downstream repositories
16
+ - required GitHub secrets, variables, and token permissions
17
+ - the shared operational checklist for cross-repository communication
18
18
 
19
- 1. Configure package.json with name, version, description, and license
20
- 2. Set up main, module, and types fields to support different import methods
21
- 3. Define which files should be published via the "files" field in package.json
19
+ ## Local Commands
22
20
 
23
- ## Adjust imports to work with the library setup
24
-
25
- 1. Update relative imports to match the new file structure
26
- 2. Ensure named exports are consistent and well-documented
27
- 3. Consider creating barrel files (index.js) for simpler importing
28
-
29
- ## Update any internal references
30
-
31
- 1. Replace any references to internal services with configurable options
32
- 2. Create adapter interfaces for external dependencies
33
- 3. Ensure the component can work in isolation without company-specific code
34
-
35
- ## Set up proper documentation in README.md
36
-
37
- 1. Write clear installation and usage instructions
38
- 2. Document the component API, props, and configuration options
39
- 3. Include examples showing common use cases and customization
40
- 4. Add contributing guidelines and code of conduct
41
-
42
- ## Set up a CI/CD pipeline for the GitHub repo
43
-
44
- 1. Configure GitHub Actions to run tests and builds on PRs
45
- 2. Add linting and type checking to the pipeline
46
- 3. Set up automated code quality checks and test coverage reporting
47
-
48
- ## Configure npm publishing workflow
49
-
50
- 1. Create a release process for versioning and publishing
51
- 2. Set up npm automation for consistent package releases
52
- 3. Configure access tokens and permissions for secure publishing
21
+ ```bash
22
+ bun install
23
+ bun run build
24
+ bun test
25
+ eslint src/**/*.{ts,tsx}
26
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "microboard-temp",
3
- "version": "0.13.71",
3
+ "version": "0.13.72",
4
4
  "description": "A flexible interactive whiteboard library",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",