@object-ui/plugin-markdown 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,48 @@
+# @object-ui/plugin-markdown
+
+## 0.3.0
+
+### Minor Changes
+
+- Unified version across all packages to 0.3.0 for consistent versioning
+
+## 0.2.2
+
+### Patch Changes
+
+- New plugin-object and ObjectQL SDK updates
+
+  **Added:**
+  - New Plugin: @object-ui/plugin-object - ObjectQL plugin for automatic table and form generation
+    - ObjectTable: Auto-generates tables from ObjectQL object schemas
+    - ObjectForm: Auto-generates forms from ObjectQL object schemas with create/edit/view modes
+    - Full TypeScript support with comprehensive type definitions
+  - Type Definitions: Added ObjectTableSchema and ObjectFormSchema to @object-ui/types
+  - ObjectQL Integration: Enhanced ObjectQLDataSource with getObjectSchema() method using MetadataApiClient
+
+  **Changed:**
+  - Updated @objectql/sdk from ^1.8.3 to ^1.9.1
+  - Updated @objectql/types from ^1.8.3 to ^1.9.1
+
+- Updated dependencies
+  - @object-ui/types@0.3.0
+  - @object-ui/core@0.2.2
+  - @object-ui/react@0.2.2
+  - @object-ui/components@0.2.2
+
+## 0.2.1
+
+### Patch Changes
+
+- Patch release: Add automated changeset workflow and CI/CD improvements
+
+  This release includes infrastructure improvements:
+  - Added changeset-based version management
+  - Enhanced CI/CD workflows with GitHub Actions
+  - Improved documentation for contributing and releasing
+
+- Updated dependencies
+  - @object-ui/types@0.2.1
+  - @object-ui/core@0.2.1
+  - @object-ui/react@0.2.1
+  - @object-ui/components@0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ObjectQL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,111 @@
+# Plugin Markdown - Lazy-Loaded Markdown Renderer
+
+A lazy-loaded markdown component for Object UI based on react-markdown with GitHub Flavored Markdown support.
+
+## Features
+
+- **Internal Lazy Loading**: react-markdown is loaded on-demand using `React.lazy()` and `Suspense`
+- **Zero Configuration**: Just import the package and use `type: 'markdown'` in your schema
+- **Automatic Registration**: Components auto-register with the ComponentRegistry
+- **Skeleton Loading**: Shows a skeleton while react-markdown loads
+- **XSS Protection**: All content is sanitized via rehype-sanitize
+- **GitHub Flavored Markdown**: Full support for tables, strikethrough, task lists, etc.
+
+## Installation
+
+```bash
+pnpm add @object-ui/plugin-markdown
+```
+
+## Usage
+
+### Automatic Registration (Side-Effect Import)
+
+```typescript
+// In your app entry point (e.g., App.tsx or main.tsx)
+import '@object-ui/plugin-markdown';
+
+// Now you can use markdown type in your schemas
+const schema = {
+  type: 'markdown',
+  content: '# Hello World\n\nThis is **markdown** text.'
+};
+```
+
+### Manual Integration
+
+```typescript
+import { markdownComponents } from '@object-ui/plugin-markdown';
+import { ComponentRegistry } from '@object-ui/core';
+
+// Manually register if needed
+Object.entries(markdownComponents).forEach(([type, component]) => {
+  ComponentRegistry.register(type, component);
+});
+```
+
+### TypeScript Support
+
+The plugin exports TypeScript types for full type safety:
+
+```typescript
+import type { MarkdownSchema } from '@object-ui/plugin-markdown';
+
+const schema: MarkdownSchema = {
+  type: 'markdown',
+  content: '# Hello World\n\nThis is **markdown** text.'
+};
+```
+
+## Schema API
+
+```typescript
+{
+  type: 'markdown',
+  content?: string,    // Markdown content (supports GitHub Flavored Markdown)
+  className?: string   // Tailwind classes
+}
+```
+
+## Supported Markdown Features
+
+- Headers (H1-H6)
+- Bold, italic, and inline code
+- Links and images
+- Lists (ordered, unordered, and nested)
+- Tables
+- Blockquotes
+- Code blocks with syntax highlighting
+- Strikethrough
+- Task lists
+- Autolinks
+
+## Lazy Loading Architecture
+
+The plugin uses a two-file pattern for optimal code splitting:
+
+1. **`MarkdownImpl.tsx`**: Contains the actual react-markdown import (heavy ~100-200 KB)
+2. **`index.tsx`**: Entry point with `React.lazy()` wrapper (light)
+
+When bundled, Vite automatically creates separate chunks:
+- `index.js` (~200 bytes) - The entry point
+- `MarkdownImpl-xxx.js` (~100-200 KB) - The lazy-loaded implementation
+
+The react-markdown library is only downloaded when a `markdown` component is actually rendered, not on initial page load.
+
+## Bundle Size Impact
+
+By using lazy loading, the main application bundle stays lean:
+- Without lazy loading: +100-200 KB on initial load
+- With lazy loading: +0.19 KB on initial load, +100-200 KB only when markdown is rendered
+
+This results in significantly faster initial page loads for applications that don't use markdown on every page.
+
+## Development
+
+```bash
+# Build the plugin
+pnpm build
+
+# The package will generate proper ESM and UMD builds with lazy loading preserved
+```