@app-studio/web 0.9.21 → 0.9.22

package/docs/README.md

@@ -1,24 +1,31 @@
 # App Studio Web Component Library Documentation
 
-Welcome to the documentation for the App Studio Web Component Library. This documentation provides comprehensive guides, API references, and examples to help you build high-quality components and applications using our library.
+Welcome to the comprehensive documentation for the App Studio Web Component Library. This documentation provides guides, API references, and examples to help you build high-quality components and applications.
 
-## Documentation Structure
+## 📖 Documentation Structure
 
-- **Getting Started**: Quick start guides to help you begin using the library
-- **Component Development**: Detailed guides for building components
-- **Design System**: Information about the design system, theming, and styling
-- **API Reference**: Detailed API documentation for all components
-- **Tutorials**: Step-by-step tutorials for common tasks
-- **Contributing**: Guidelines for contributing to the library
+### Core Documentation
+- **[Getting Started](./getting-started/introduction.md)** - Quick introduction and setup
+- **[Component Development](./component-development/guide.md)** - Building and contributing components
+- **[API Integration](./api-integration.md)** - Backend integration patterns
+- **[Design System](./design-system/theming.md)** - Theming and styling guidelines
 
-## Using This Documentation
+### Specialized Documentation
+- **[ADK Components](../README-ADK.md)** - Agent Development Kit integration
+- **[API Reference](./api-reference/README.md)** - Detailed component APIs
+- **[Tutorials](./tutorials/README.md)** - Step-by-step guides
+- **[Contributing](./contributing/documentation.md)** - Contribution guidelines
 
-The documentation is organized to support different learning styles and needs:
+## 🚀 Quick Navigation
 
-- If you're new to the library, start with the [Getting Started](./getting-started/introduction.md) guide
-- If you're building components, refer to the [Component Development Guide](./component-development/guide.md)
-- If you need detailed API information, check the [API Reference](./api-reference/README.md)
-- If you want to learn through examples, explore the [Tutorials](./tutorials/README.md)
+### For New Users
+Start with the [Getting Started Guide](./getting-started/introduction.md) to understand the library basics and setup process.
+
+### For Developers
+Refer to the [Component Development Guide](./component-development/guide.md) for building and customizing components.
+
+### For ADK Integration
+Check the [ADK Components documentation](../README-ADK.md) for agent-specific functionality.
 
 ## Documentation Tools
 

package/docs/documentation-system.md

@@ -104,8 +104,50 @@ To update component documentation:
 2. Review the generated documentation
 3. Make any necessary manual adjustments
 
+## Documentation Maintenance Rules
+
+### Rule 1: Single Source of Truth
+- Each topic should have ONE authoritative documentation file
+- Avoid duplicating content across multiple files
+- Use cross-references instead of copying content
+- **Prohibited**: Creating multiple files covering the same topic
+
+### Rule 2: Clear File Responsibilities
+- **README.md**: Project overview, quick start, navigation to specialized docs
+- **README-ADK.md**: ADK-specific functionality ONLY
+- **docs/README.md**: Documentation hub and navigation
+- **docs/api-integration.md**: Backend integration patterns
+- **Component docs**: Individual component usage and APIs
+
+### Rule 3: Content Validation Checklist
+Before adding/updating documentation:
+- ✅ Check for existing content on the same topic
+- ✅ Verify all code examples work
+- ✅ Ensure links are valid and up-to-date
+- ✅ Follow consistent markdown formatting
+- ✅ Update related files if needed
+- ✅ Remove outdated information
+
+### Rule 4: Mandatory Updates
+Documentation MUST be updated when:
+- Adding new components or features
+- Changing component APIs or props
+- Modifying integration patterns
+- Updating dependencies or requirements
+- Changing project structure
+
+### Rule 5: Quality Standards
+- Use clear, concise language
+- Include practical, working examples
+- Follow consistent formatting and terminology
+- Link related documentation appropriately
+- Test all code examples before publishing
+- Include accessibility information where relevant
+- Document best practices and common pitfalls
+
 ## Documentation Best Practices
 
+### Content Organization
 - Keep documentation up-to-date with code changes
 - Include examples for all components and features
 - Use consistent formatting and terminology
@@ -114,6 +156,45 @@ To update component documentation:
 - Include accessibility information
 - Document best practices and common pitfalls
 
+### File Naming Conventions
+- Use kebab-case for file names: `component-development.md`
+- Use descriptive names that clearly indicate content
+- Avoid generic names like `guide.md` or `docs.md`
+
+## Documentation Maintenance Workflow
+
+### Before Making Changes
+1. **Audit existing documentation**:
+   ```bash
+   # Check for duplicate content
+   grep -r "your-search-term" docs/
+
+   # Find broken links
+   find docs/ -name "*.md" -exec grep -l "broken-link" {} \;
+   ```
+
+2. **Validate current structure**:
+   - Ensure no topic is covered in multiple files
+   - Check that all links work
+   - Verify code examples are current
+
+### After Making Changes
+1. **Update related documentation**:
+   - Update cross-references
+   - Check for outdated information
+   - Ensure consistency across files
+
+2. **Run documentation tools**:
+   ```bash
+   npm run create-docs
+   npm run bot-doc -- ComponentName src/components/ComponentName
+   ```
+
+### Regular Maintenance Tasks
+- **Weekly**: Check for broken links and outdated examples
+- **Monthly**: Review documentation structure for redundancies
+- **Per Release**: Update all version-specific information
+
 ## Troubleshooting
 
 If you encounter issues with the documentation system:
@@ -141,3 +222,12 @@ If MDX files are not rendering correctly:
 1. Check the MDX syntax
 2. Ensure the MDX file is in the correct location
 3. Check for errors in the console
+
+### Duplicate Content Issues
+
+If you find duplicate content:
+
+1. Identify the authoritative source
+2. Remove duplicate content
+3. Add cross-references to the authoritative source
+4. Update any links pointing to removed content

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@app-studio/web",
-  "version": "0.9.21",
+  "version": "0.9.22",
   "main": "dist/index.js",
   "typings": "dist/components/index.d.ts",
   "files": [
@@ -46,6 +46,7 @@
     "create-example": "ts-node scripts/create-example.ts",
     "page-imports": "ts-node scripts/generate-page-imports.ts",
     "create-pages": "npm run create-indices && ts-node scripts/create-pages.ts && npm run page-imports",
+    "validate-docs": "node scripts/validate-docs.js",
     "api:local": "react-api  --useUnionTypes --input http://localhost:3000/docs/swagger.json --output ./src/services/api  && prettier --write ./src/services/api"
   },
   "eslintConfig": {

package/dist/services/api/models/CreateApplicationParams.d.ts

@@ -1,10 +0,0 @@
-export declare type CreateApplicationParams = {
-    /**
-     * Grant Id to be assigned to the application to be created.
-     */
-    grantId?: string;
-    /**
-     * Project Id to be assigned to the application to be created.
-     */
-    projectId?: string;
-};

package/dist/services/api/models/CreateGrantParams.d.ts

@@ -1,10 +0,0 @@
-export declare type CreateGrantParams = {
-    /**
-     * The title of the grant to be created.
-     */
-    name: string;
-    /**
-     * The project Id of the grant
-     */
-    projectId: string;
-};

package/dist/services/api/models/CreateProjectParams.d.ts

@@ -1,10 +0,0 @@
-export declare type CreateProjectParams = {
-    /**
-     * The name of the project to be created.
-     */
-    name: string;
-    /**
-     * The description of the project to be created.
-     */
-    description?: string;
-};

package/dist/services/api/models/FindApplicationParams.d.ts

@@ -1,19 +0,0 @@
-export declare type FindApplicationParams = {
-    name?: string;
-    /**
-     * Order by field
-     */
-    sortField?: 'id' | 'userId' | 'name' | 'imageUrl' | 'image' | 'createdAt' | 'updatedAt';
-    /**
-     * Order sort
-     */
-    sortOrder?: 'asc' | 'desc';
-    /**
-     * Number or result to return
-     */
-    take?: number;
-    /**
-     * Number or result to skip
-     */
-    skip?: number;
-};

package/dist/services/api/models/FindPageParams.d.ts

@@ -1,22 +0,0 @@
-export declare type FindPageParams = {
-    /**
-     * Page Id
-     */
-    projectId: string;
-    /**
-     * Order by field
-     */
-    sortField?: string;
-    /**
-     * Order sort
-     */
-    sortOrder?: string;
-    /**
-     * Number or result to return
-     */
-    take?: number;
-    /**
-     * Number or result to skip
-     */
-    skip?: number;
-};

package/dist/services/api/models/FixPageParams.d.ts

@@ -1,10 +0,0 @@
-export declare type FixPageParams = {
-    /**
-     * User requirement
-     */
-    prompt: string;
-    /**
-     * Selected Html Element
-     */
-    html: string;
-};

package/dist/services/api/models/UpdateApplicationParams.d.ts

@@ -1,6 +0,0 @@
-export declare type UpdateApplicationParams = {
-    /**
-     * Application title
-     */
-    name: string;
-};

package/dist/services/api/models/UpdateComponentPropsParams.d.ts

@@ -1,10 +0,0 @@
-export declare type UpdateComponentPropsParams = {
-    /**
-     * Prompt
-     */
-    prompt: string;
-    /**
-     * Json Content
-     */
-    json: any;
-};

package/dist/services/api/models/UpdateGrantParams.d.ts

@@ -1,6 +0,0 @@
-export declare type UpdateGrantParams = {
-    /**
-     * Grant title
-     */
-    name: string;
-};

package/dist/services/api/models/UpdatePageParams.d.ts

@@ -1,14 +0,0 @@
-export declare type UpdatePageParams = {
-    /**
-     * The code to be associated with the page
-     */
-    code?: string;
-    /**
-     * The configs to be associated with the page
-     */
-    configs?: Array<string>;
-    /**
-     * The url to be associated with the page
-     */
-    urlPath?: string;
-};

package/dist/services/api/models/UpdateProjectParams.d.ts

@@ -1,10 +0,0 @@
-export declare type UpdateProjectParams = {
-    /**
-     * Project title
-     */
-    name: string;
-    /**
-     * Project workers
-     */
-    workers: Array<string>;
-};

package/dist/services/api/services/ApplicationService.d.ts

@@ -1,83 +0,0 @@
-import type { CreateApplicationParams } from '../models/CreateApplicationParams';
-import type { FindApplicationParams } from '../models/FindApplicationParams';
-import type { UpdateApplicationParams } from '../models/UpdateApplicationParams';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { UseRequestOption, UseRequestProperties } from '@app-studio/react-request';
-/**
- * As a admin, i want to create a application
- * @param requestBody
- * @returns any Application created
- * @throws ApiError
- */
-export declare const applicationControllerCreate: (requestBody: CreateApplicationParams) => CancelablePromise<any>;
-/**
- * I want to read all the application
- * @returns any Application data
- * @throws ApiError
- */
-export declare const applicationControllerGetAll: () => CancelablePromise<any>;
-/**
- * I want to read an application
- * @param id
- * @returns any Application data
- * @throws ApiError
- */
-export declare const applicationControllerGet: (id: string) => CancelablePromise<any>;
-/**
- * As a admin, i want to delete a application
- * @param id
- * @returns any application delete
- * @throws ApiError
- */
-export declare const applicationControllerDelete: (id: string) => CancelablePromise<any>;
-/**
- * As a admin, i want to update a application
- * @param id
- * @param requestBody
- * @returns any Application Updated
- * @throws ApiError
- */
-export declare const applicationControllerUpdate: (id: string, requestBody: UpdateApplicationParams) => CancelablePromise<any>;
-/**
- * I want to find application by name
- * @param requestBody
- * @returns any Application found
- * @throws ApiError
- */
-export declare const applicationControllerFind: (requestBody: FindApplicationParams) => CancelablePromise<any>;
-/**
- * Validate application
- * @param stepId
- * @param requestBody
- * @returns any Workflow created
- * @throws ApiError
- */
-export declare const applicationWorkflowControllerFillApplication: (stepId: string, requestBody: CreateApplicationParams) => CancelablePromise<any>;
-export declare const useApplicationControllerCreateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (requestBody: CreateApplicationParams) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useApplicationControllerGetAllService: ({ method, ...options }?: UseRequestOption) => {
-    run: () => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useApplicationControllerGetService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useApplicationControllerDeleteService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useApplicationControllerUpdateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string, requestBody: UpdateApplicationParams) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useApplicationControllerFindService: ({ method, ...options }?: UseRequestOption) => {
-    run: (requestBody: FindApplicationParams) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useApplicationWorkflowControllerFillApplicationService: ({ method, ...options }?: UseRequestOption) => {
-    run: (stepId: string, requestBody: CreateApplicationParams) => void;
-    data: any;
-} & UseRequestProperties;

package/dist/services/api/services/ComponentRevisionService.d.ts

@@ -1,25 +0,0 @@
-import type { CreateComponentRevisionParams } from '../models/CreateComponentRevisionParams';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { UseRequestOption, UseRequestProperties } from '@app-studio/react-request';
-/**
- * As a user, i want to create a componentRevision
- * @param requestBody
- * @returns any ComponentRevision created
- * @throws ApiError
- */
-export declare const componentRevisionControllerCreate: (requestBody: CreateComponentRevisionParams) => CancelablePromise<any>;
-/**
- * As a user, i want to find by componentRevision based on a componentRevision identifier
- * @param id
- * @returns any ComponentRevision fetched successfully
- * @throws ApiError
- */
-export declare const componentRevisionControllerRead: (id: string) => CancelablePromise<any>;
-export declare const useComponentRevisionControllerCreateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (requestBody: CreateComponentRevisionParams) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useComponentRevisionControllerReadService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;

package/dist/services/api/services/FileService.d.ts

@@ -1,30 +0,0 @@
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { UseRequestOption, UseRequestProperties } from '@app-studio/react-request';
-/**
- * Upload a file.
- * @param id
- * @param stepId
- * @param formData
- * @returns any File Upload Succeed
- * @throws ApiError
- */
-export declare const grantFileControllerCreate: (id: string, stepId: string, formData: {
-    file?: Blob;
-}) => CancelablePromise<any>;
-/**
- * As a admin, i want to delete a grantFile
- * @param id
- * @returns any grantFile delete
- * @throws ApiError
- */
-export declare const grantFileControllerDelete: (id: string) => CancelablePromise<any>;
-export declare const useGrantFileControllerCreateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string, stepId: string, formData: {
-        file?: Blob;
-    }) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useGrantFileControllerDeleteService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;

package/dist/services/api/services/GrantService.d.ts

@@ -1,100 +0,0 @@
-import type { CreateGrantParams } from '../models/CreateGrantParams';
-import type { UpdateGrantParams } from '../models/UpdateGrantParams';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { UseRequestOption, UseRequestProperties } from '@app-studio/react-request';
-/**
- * Validate grant
- * @param grantId
- * @param stepId
- * @returns any Workflow created
- * @throws ApiError
- */
-export declare const grantWorkflowControllerValidateUploadGrantFiles: (grantId: string, stepId: string, onProgress: any) => CancelablePromise<any>;
-/**
- * Upload a file.
- * @param id
- * @param stepId
- * @param formData
- * @returns any File Upload Succeed
- * @throws ApiError
- */
-export declare const grantFileControllerCreate: (id: string, stepId: string, formData: {
-    file?: Blob;
-}) => CancelablePromise<any>;
-/**
- * As a admin, i want to delete a grantFile
- * @param id
- * @returns any grantFile delete
- * @throws ApiError
- */
-export declare const grantFileControllerDelete: (id: string) => CancelablePromise<any>;
-/**
- * As a admin, i want to create a grant
- * @param requestBody
- * @returns any Grant created
- * @throws ApiError
- */
-export declare const grantControllerCreate: (requestBody: CreateGrantParams) => CancelablePromise<any>;
-/**
- * I want to read an grant
- * @param id
- * @returns any Grant data
- * @throws ApiError
- */
-export declare const grantControllerGet: (id: string) => CancelablePromise<any>;
-/**
- * As a admin, i want to delete a grant
- * @param id
- * @returns any grant delete
- * @throws ApiError
- */
-export declare const grantControllerDelete: (id: string) => CancelablePromise<any>;
-/**
- * As a admin, i want to update a grant
- * @param id
- * @param requestBody
- * @returns any Grant Updated
- * @throws ApiError
- */
-export declare const grantControllerUpdate: (id: string, requestBody: UpdateGrantParams) => CancelablePromise<any>;
-/**
- * I want to read all the grant
- * @param projectId
- * @returns any Grant data
- * @throws ApiError
- */
-export declare const grantControllerGetAll: (projectId: string) => CancelablePromise<any>;
-export declare const useGrantWorkflowControllerValidateUploadGrantFilesService: ({ method, ...options }?: UseRequestOption) => {
-    run: (grantId: string, stepId: string) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useGrantFileControllerCreateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string, stepId: string, formData: {
-        file?: Blob;
-    }) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useGrantFileControllerDeleteService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useGrantControllerCreateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (requestBody: CreateGrantParams) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useGrantControllerGetService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useGrantControllerDeleteService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useGrantControllerUpdateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string, requestBody: UpdateGrantParams) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useGrantControllerGetAllService: ({ method, ...options }?: UseRequestOption) => {
-    run: (projectId: string) => void;
-    data: any;
-} & UseRequestProperties;

package/dist/services/api/services/ProjectService.d.ts

@@ -1,59 +0,0 @@
-import type { CreateProjectParams } from '../models/CreateProjectParams';
-import type { UpdateProjectParams } from '../models/UpdateProjectParams';
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { UseRequestOption, UseRequestProperties } from '@app-studio/react-request';
-/**
- * As a admin, i want to create a project
- * @param requestBody
- * @returns any Project created
- * @throws ApiError
- */
-export declare const projectControllerCreate: (requestBody: CreateProjectParams) => CancelablePromise<any>;
-/**
- * I want to read all the project
- * @returns any Project data
- * @throws ApiError
- */
-export declare const projectControllerList: () => CancelablePromise<any>;
-/**
- * I want to read an project
- * @param id
- * @returns any Project data
- * @throws ApiError
- */
-export declare const projectControllerGet: (id: string) => CancelablePromise<any>;
-/**
- * As a admin, i want to delete a project
- * @param id
- * @returns any project delete
- * @throws ApiError
- */
-export declare const projectControllerRemove: (id: string) => CancelablePromise<any>;
-/**
- * As a admin, i want to update a project
- * @param id
- * @param requestBody
- * @returns any Project Updated
- * @throws ApiError
- */
-export declare const projectControllerUpdate: (id: string, requestBody: UpdateProjectParams) => CancelablePromise<any>;
-export declare const useProjectControllerCreateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (requestBody: CreateProjectParams) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useProjectControllerListService: ({ method, ...options }?: UseRequestOption) => {
-    run: () => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useProjectControllerGetService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useProjectControllerRemoveService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string) => void;
-    data: any;
-} & UseRequestProperties;
-export declare const useProjectControllerUpdateService: ({ method, ...options }?: UseRequestOption) => {
-    run: (id: string, requestBody: UpdateProjectParams) => void;
-    data: any;
-} & UseRequestProperties;

package/dist/services/api/services/PromptService.d.ts

@@ -1,18 +0,0 @@
-import type { CancelablePromise } from '../core/CancelablePromise';
-import { UseRequestOption, UseRequestProperties } from '@app-studio/react-request';
-/**
- * Upload a file for prompt attachment
- * Upload any file type to be attached to a prompt. Supports documents, images, and other file types up to 10MB.
- * @param formData
- * @returns any File uploaded successfully
- * @throws ApiError
- */
-export declare const promptUploadControllerUploadPromptFile: (formData: {
-    file?: Blob;
-}, onProgress: any) => CancelablePromise<any>;
-export declare const usePromptUploadControllerUploadPromptFileService: ({ method, ...options }?: UseRequestOption) => {
-    run: (formData: {
-        file?: Blob;
-    }) => void;
-    data: any;
-} & UseRequestProperties;