@unityclaw/skills 1.1.1 → 1.1.3

package/unityclaw-document-convert/SKILL.md

@@ -1,424 +0,0 @@
----
-name: unityclaw-document-convert
-description: Convert documents between formats (PDF, Word, PPT, Excel, Image)
-version: 1.1.1
-metadata:
-  openclaw:
-    requires:
-      env:
-        - UNITYCLAW_API_KEY
-      bins:
-        - node
-        - npm
-    primaryEnv: UNITYCLAW_API_KEY
-    emoji: "📄"
-    homepage: https://unityclaw.com
-    install:
-      - kind: node
-        package: "@unityclaw/sdk"
-        bins: []
----
-
-# UnityClaw Document Convert
-
-Convert documents between various formats including PDF, Word, PowerPoint, Excel, and images.
-Recommended API is unified `client.document.convertDocument(...)`.
-
-## Installation
-
-```bash
-npm install @unityclaw/sdk
-```
-
-## Configuration
-
-Set your API key using one of these methods:
-
-```bash
-# Method 1: Use SDK CLI (recommended - persists across sessions)
-npx @unityclaw/sdk config set apiKey your-api-key
-
-# Method 2: Environment variable
-export UNITYCLAW_API_KEY=your-api-key
-```
-
-## Response Structure
-
-> **IMPORTANT:** The result has a nested structure. Use `result.success` to check overall success, and access data via `result.response.data`.
-
-```typescript
-interface UnityClawResult {
-  success: boolean;        // ✅ Use this to check if SDK call succeeded
-  taskId: string;          // Task identifier
-  taskFolder: string;      // Path to task folder with logs
-  duration: number;        // Request duration in ms
-  response: {              // API response object
-    code: number;          // 0 = success
-    data: Array<{          // ✅ Result data here
-      name: string;
-      contentType: string;
-      content: string;     // URL to converted document
-    }> | null;
-  };
-  logs: Array<{ timestamp; level; message }>;
-  attachments: any[];
-}
-```
-
-## Quick Start
-
-```typescript
-import { UnityClawClient } from '@unityclaw/sdk';
-
-const client = new UnityClawClient();
-
-// Convert PDF to Word (unified API)
-const result = await client.document.convertDocument({
-  attachment: [
-    { path: './files/document.pdf' }
-  ],
-  input_format: 'pdf',
-  output_format: 'docx'
-});
-
-// ✅ Correct: Check result.success, access data via result.response.data
-if (result.success && result.response?.data) {
-  console.log('Converted document:', result.response.data);
-}
-```
-
-## Available APIs
-
-### Image Conversions
-
-| Method | Description |
-|--------|-------------|
-| `image2Word()` | Convert image to Word document |
-| `image2Ppt()` | Convert image to PowerPoint |
-| `image2Excel()` | Convert image to Excel |
-| `image2Pdf()` | Convert image to PDF |
-
-### PDF Conversions
-
-| Method | Description |
-|--------|-------------|
-| `pdf2Word()` | Convert PDF to Word document |
-| `pdf2Ppt()` | Convert PDF to PowerPoint |
-| `pdf2Excel()` | Convert PDF to Excel |
-| `pdf2Image()` | Convert PDF to images |
-
-### Generic Conversion
-
-| Method | Description |
-|--------|-------------|
-| `convertDocument()` | Recommended unified conversion API |
-| `convert()` | Generic conversion with format specification |
-
-## API Reference
-
-### Image to Word
-
-```typescript
-await client.document.image2Word({
-  attachment: AttachmentFieldItem[]
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-### Image to PowerPoint
-
-```typescript
-await client.document.image2Ppt({
-  attachment: AttachmentFieldItem[]
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-### Image to Excel
-
-```typescript
-await client.document.image2Excel({
-  attachment: AttachmentFieldItem[]
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-### Image to PDF
-
-```typescript
-await client.document.image2Pdf({
-  attachment: AttachmentFieldItem[]
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-### PDF to Word
-
-```typescript
-await client.document.pdf2Word({
-  attachment: AttachmentFieldItem[]
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-### PDF to PowerPoint
-
-```typescript
-await client.document.pdf2Ppt({
-  attachment: AttachmentFieldItem[]
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-### PDF to Excel
-
-```typescript
-await client.document.pdf2Excel({
-  attachment: AttachmentFieldItem[]
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-### PDF to Image
-
-```typescript
-await client.document.pdf2Image({
-  attachment: AttachmentFieldItem[]
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-### Generic Convert
-
-```typescript
-await client.document.convert({
-  attachment: AttachmentFieldItem[];
-  input_format?: string;
-  output_format: string;
-}): Promise<APIResponse<AttachmentResult[]>>
-```
-
-## Examples
-
-### PDF to Word
-
-```typescript
-const client = new UnityClawClient();
-
-const result = await client.document.pdf2Word({
-  attachment: [
-    { tmp_url: 'https://example.com/report.pdf', name: 'report.pdf' }
-  ]
-});
-
-if (result.success && result.response?.data) {
-  console.log('Word document:', result.response.data[0].content);
-}
-```
-
-### PDF to PowerPoint
-
-```typescript
-const result = await client.document.pdf2Ppt({
-  attachment: [
-    { tmp_url: 'https://example.com/slides.pdf', name: 'slides.pdf' }
-  ]
-});
-```
-
-### PDF to Excel
-
-```typescript
-const result = await client.document.pdf2Excel({
-  attachment: [
-    { tmp_url: 'https://example.com/data.pdf', name: 'data.pdf' }
-  ]
-});
-```
-
-### PDF to Image
-
-```typescript
-const result = await client.document.pdf2Image({
-  attachment: [
-    { tmp_url: 'https://example.com/document.pdf', name: 'document.pdf' }
-  ]
-});
-
-// Returns array of images (one per page)
-if (result.success && result.response?.data) {
-  result.response.data.forEach((img, i) => {
-    console.log(`Page ${i + 1}: ${img.content}`);
-  });
-}
-```
-
-### Image to Word (OCR)
-
-```typescript
-const result = await client.document.image2Word({
-  attachment: [
-    { tmp_url: 'https://example.com/scanned-doc.jpg', name: 'scanned.jpg' }
-  ]
-});
-```
-
-### Image to PowerPoint
-
-```typescript
-const result = await client.document.image2Ppt({
-  attachment: [
-    { tmp_url: 'https://example.com/diagram.png', name: 'diagram.png' }
-  ]
-});
-```
-
-### Image to Excel
-
-```typescript
-const result = await client.document.image2Excel({
-  attachment: [
-    { tmp_url: 'https://example.com/spreadsheet.png', name: 'spreadsheet.png' }
-  ]
-});
-```
-
-### Image to PDF
-
-```typescript
-const result = await client.document.image2Pdf({
-  attachment: [
-    { tmp_url: 'https://example.com/page1.jpg', name: 'page1.jpg' },
-    { tmp_url: 'https://example.com/page2.jpg', name: 'page2.jpg' }
-  ]
-});
-```
-
-### Generic Convert
-
-```typescript
-// Image to PDF
-const result = await client.document.convert({
-  attachment: [{ tmp_url: 'https://...', name: 'image.jpg' }],
-  input_format: 'image',
-  output_format: 'pdf'
-});
-
-// PDF to Word
-const result = await client.document.convert({
-  attachment: [{ tmp_url: 'https://...', name: 'doc.pdf' }],
-  input_format: 'pdf',
-  output_format: 'word'
-});
-```
-
-### Batch Conversion
-
-```typescript
-const pdfFiles = [
-  { tmp_url: 'https://example.com/doc1.pdf', name: 'doc1.pdf' },
-  { tmp_url: 'https://example.com/doc2.pdf', name: 'doc2.pdf' },
-  { tmp_url: 'https://example.com/doc3.pdf', name: 'doc3.pdf' }
-];
-
-const results = await Promise.all(
-  pdfFiles.map(file => client.document.pdf2Word({ attachment: [file] }))
-);
-
-results.forEach((result, i) => {
-  if (result.success && result.response?.data) {
-    console.log(`File ${i + 1} converted: ${result.response.data?.[0]?.content}`);
-  }
-});
-```
-
-### Convert Then Translate
-
-```typescript
-// Convert image to Word, then translate
-const converted = await client.document.image2Word({
-  attachment: [{ tmp_url: 'https://...', name: 'image.jpg' }]
-});
-
-if (converted.success && converted.response?.data) {
-  const translated = await client.document.translate({
-    attachment: converted.response.data,
-    source_language: 'en',
-    target_language: 'zh'
-  });
-
-  console.log('Translated document:', translated.response?.data);
-}
-```
-
-## Response Format
-
-```typescript
-interface AttachmentResult {
-  name: string;
-  contentType: 'attachment/url';
-  content: string;  // URL to converted document
-}
-```
-
-## Error Handling
-
-```typescript
-const result = await client.document.pdf2Word({
-  attachment: [{ tmp_url: 'https://...', name: 'doc.pdf' }]
-});
-
-if (!result.success) {
-  console.error('Request failed');
-  console.log('Check logs:', result.logs);
-  return;
-}
-
-if (result.response?.code !== 0) {
-  console.error('API error:', result.response);
-  return;
-}
-
-// Success
-console.log('Success:', result.response.data);
-```
-
-## Task Folders
-
-Each execution creates a task folder:
-
-```typescript
-const result = await client.document.pdf2Word({
-  attachment: [{ tmp_url: 'https://...', name: 'doc.pdf' }]
-});
-
-console.log('Task ID:', result.taskId);
-console.log('Task Folder:', result.taskFolder);
-console.log('Downloaded Files:', result.attachments);
-```
-
-## Conversion Matrix
-
-| From | To | Method |
-|------|-----|--------|
-| PDF | Word | `pdf2Word()` |
-| PDF | PowerPoint | `pdf2Ppt()` |
-| PDF | Excel | `pdf2Excel()` |
-| PDF | Image | `pdf2Image()` |
-| Image | Word | `image2Word()` |
-| Image | PowerPoint | `image2Ppt()` |
-| Image | Excel | `image2Excel()` |
-| Image | PDF | `image2Pdf()` |
-
-## Best Practices
-
-1. **File Size**: Large files may take longer to process
-2. **Format Fidelity**: Complex formatting may have minor differences
-3. **Batch Processing**: Use Promise.all for multiple files
-4. **Error Recovery**: Always check result.code before proceeding
-
-## Related Skills
-
-- [unityclaw-document-translation](../unityclaw-document-translation/SKILL.md) - Translate documents
-- [unityclaw-image-compress](../unityclaw-image-compress/SKILL.md) - Compress images before conversion
-
-<!-- SDK_VERSION_RULE_START -->
-## SDK Version Check Rule
-
-- Before invoking this skill, check local `@unityclaw/sdk` version.
-- Required minimum SDK version: `1.1.1`
-- If local SDK version is lower than this skill version, stop and prompt user to upgrade SDK first.
-- Suggested command: `npm i @unityclaw/sdk@latest`
-<!-- SDK_VERSION_RULE_END -->

package/unityclaw-idp-business-extraction/SKILL.md

@@ -1,63 +0,0 @@
----
-name: unityclaw-idp-business-extraction
-description: Extract fields from business documents (business license, business card)
-version: 1.1.1
-metadata:
-  openclaw:
-    requires:
-      env:
-        - UNITYCLAW_API_KEY
-      bins:
-        - node
-        - npm
-    primaryEnv: UNITYCLAW_API_KEY
-    emoji: "🏢"
-    homepage: https://unityclaw.com
-    install:
-      - kind: node
-        package: "@unityclaw/sdk"
-        bins: []
----
-
-# UnityClaw IDP - Business Extraction
-
-Use this skill for business document extraction:
-- `business_license`
-- `business_card`
-
-## SDK APIs
-
-```typescript
-await client.idp.businessLicense({ attachments: [{ path: './files/business-license.jpg' }] });
-await client.idp.businessCard({ attachments: [{ path: './files/business-card.jpg' }] });
-```
-
-Or generic API:
-
-```typescript
-await client.idp.extract('business_license', {
-  attachments: [{ path: './files/business-license.jpg' }]
-});
-```
-
-## Input
-
-```typescript
-{
-  attachments: AttachmentInput[]
-}
-```
-
-## Notes
-
-- This skill groups enterprise scenarios to avoid over-generic routing.
-- Output fields vary between license and card extraction.
-
-<!-- SDK_VERSION_RULE_START -->
-## SDK Version Check Rule
-
-- Before invoking this skill, check local `@unityclaw/sdk` version.
-- Required minimum SDK version: `1.1.1`
-- If local SDK version is lower than this skill version, stop and prompt user to upgrade SDK first.
-- Suggested command: `npm i @unityclaw/sdk@latest`
-<!-- SDK_VERSION_RULE_END -->

package/unityclaw-idp-contract-extraction/SKILL.md

@@ -1,63 +0,0 @@
----
-name: unityclaw-idp-contract-extraction
-description: Extract structured fields from contract files
-version: 1.1.1
-metadata:
-  openclaw:
-    requires:
-      env:
-        - UNITYCLAW_API_KEY
-      bins:
-        - node
-        - npm
-    primaryEnv: UNITYCLAW_API_KEY
-    emoji: "📑"
-    homepage: https://unityclaw.com
-    install:
-      - kind: node
-        package: "@unityclaw/sdk"
-        bins: []
----
-
-# UnityClaw IDP - Contract Extraction
-
-Use this skill for contract parsing:
-- `contract`
-
-## SDK APIs
-
-```typescript
-await client.idp.contract({
-  attachments: [{ path: './files/contract.pdf' }]
-});
-```
-
-Or generic API:
-
-```typescript
-await client.idp.extract('contract', {
-  attachments: [{ path: './files/contract.pdf' }]
-});
-```
-
-## Input
-
-```typescript
-{
-  attachments: AttachmentInput[]
-}
-```
-
-## Notes
-
-- Preferred for long contract OCR + key field extraction scenarios.
-- Read extracted data from `result.response.data`.
-
-<!-- SDK_VERSION_RULE_START -->
-## SDK Version Check Rule
-
-- Before invoking this skill, check local `@unityclaw/sdk` version.
-- Required minimum SDK version: `1.1.1`
-- If local SDK version is lower than this skill version, stop and prompt user to upgrade SDK first.
-- Suggested command: `npm i @unityclaw/sdk@latest`
-<!-- SDK_VERSION_RULE_END -->

package/unityclaw-idp-invoice-extraction/SKILL.md

@@ -1,65 +0,0 @@
----
-name: unityclaw-idp-invoice-extraction
-description: Extract fields from invoice and ticket documents (VAT, train, taxi)
-version: 1.1.1
-metadata:
-  openclaw:
-    requires:
-      env:
-        - UNITYCLAW_API_KEY
-      bins:
-        - node
-        - npm
-    primaryEnv: UNITYCLAW_API_KEY
-    emoji: "🧾"
-    homepage: https://unityclaw.com
-    install:
-      - kind: node
-        package: "@unityclaw/sdk"
-        bins: []
----
-
-# UnityClaw IDP - Invoice Extraction
-
-Use this skill for invoice/ticket extraction:
-- `vat_invoice`
-- `train_invoice`
-- `taxi_invoice`
-
-## SDK APIs
-
-```typescript
-await client.idp.vatInvoice({ attachments: [{ path: './files/vat-invoice.pdf' }] });
-await client.idp.trainInvoice({ attachments: [{ path: './files/train-ticket.jpg' }] });
-await client.idp.taxiInvoice({ attachments: [{ path: './files/taxi-invoice.jpg' }] });
-```
-
-Or generic API:
-
-```typescript
-await client.idp.extract('vat_invoice', {
-  attachments: [{ path: './files/vat-invoice.pdf' }]
-});
-```
-
-## Input
-
-```typescript
-{
-  attachments: AttachmentInput[]
-}
-```
-
-## Notes
-
-- Files can be image/PDF according to each underlying IDP type.
-- Output schema differs by type; parse from `result.response.data`.
-
-<!-- SDK_VERSION_RULE_START -->
-## SDK Version Check Rule
-
-- Before invoking this skill, check local `@unityclaw/sdk` version.
-- Required minimum SDK version: `1.1.1`
-- If local SDK version is lower than this skill version, stop and prompt user to upgrade SDK first.
-- Suggested command: `npm i @unityclaw/sdk@latest`
-<!-- SDK_VERSION_RULE_END -->

package/unityclaw-idp-personal-documents/SKILL.md

@@ -1,69 +0,0 @@
----
-name: unityclaw-idp-personal-documents
-description: Extract structured fields from personal identity documents (ID card, vehicle license, bank card)
-version: 1.1.1
-metadata:
-  openclaw:
-    requires:
-      env:
-        - UNITYCLAW_API_KEY
-      bins:
-        - node
-        - npm
-    primaryEnv: UNITYCLAW_API_KEY
-    emoji: "🪪"
-    homepage: https://unityclaw.com
-    install:
-      - kind: node
-        package: "@unityclaw/sdk"
-        bins: []
----
-
-# UnityClaw IDP - Personal Documents
-
-Use this skill for personal document extraction:
-- `id_card`
-- `vehicle_license`
-- `bank_card`
-
-## SDK APIs
-
-```typescript
-await client.idp.idCard({ attachments: [{ path: './files/id-card.jpg' }] });
-await client.idp.vehicleLicense({ attachments: [{ path: './files/vehicle-license.jpg' }] });
-await client.idp.bankCard({ attachments: [{ path: './files/bank-card.jpg' }] });
-```
-
-Or generic API:
-
-```typescript
-await client.idp.extract('id_card', {
-  attachments: [{ path: './files/id-card.jpg' }]
-});
-```
-
-## Input
-
-```typescript
-{
-  attachments: AttachmentInput[]
-}
-```
-
-`AttachmentInput` supports:
-- `tmp_url`
-- local path (`path` / `localPath` / `filePath`), SDK auto-uploads to `/api/upload`
-
-## Notes
-
-- This category is split from invoice/business/contract to improve skill routing success.
-- Output fields vary by type; read from `result.response.data`.
-
-<!-- SDK_VERSION_RULE_START -->
-## SDK Version Check Rule
-
-- Before invoking this skill, check local `@unityclaw/sdk` version.
-- Required minimum SDK version: `1.1.1`
-- If local SDK version is lower than this skill version, stop and prompt user to upgrade SDK first.
-- Suggested command: `npm i @unityclaw/sdk@latest`
-<!-- SDK_VERSION_RULE_END -->