@akanjs/cli 1.0.20 → 2.1.0-rc.1

package/src/guidelines/utilUiUsage/utilUiUsage.instruction.md

@@ -1,339 +0,0 @@
-# @util/ui Component Library Guide
-
-This guide explains how to use the `@util/ui` component library in the Akan.js framework. The `libs/util/ui` directory contains a comprehensive React component library designed for modern web applications with consistent styling, type safety, and advanced functionality.
-
-## Importing Components
-
-Import components from the `@util/ui` package:
-
-```tsx
-// Single component import
-import { Button } from "@util/ui";
-
-// Multiple components import
-import { Button, Input, Link, Image } from "@util/ui";
-
-// Namespace component import
-import { Dialog } from "@akanjs/ui";
-```
-
-## Component Organization and Usage
-
-The component library follows a namespace pattern where complex components expose subcomponents as properties:
-
-```tsx
-// Namespaced component usage example
-<Dialog>
-  <Dialog.Trigger>Open Dialog</Dialog.Trigger>
-  <Dialog.Modal>
-    <Dialog.Title>Title</Dialog.Title>
-    <Dialog.Content>Content</Dialog.Content>
-    <Dialog.Action>
-      <button>Confirm</button>
-    </Dialog.Action>
-  </Dialog.Modal>
-</Dialog>
-```
-
-## Common Component Patterns
-
-### Form Fields and Data Input
-
-The library provides comprehensive form components with built-in validation:
-
-```tsx
-// Button with loading state handling
-<Button
-  onClick={async (e, { onError }) => {
-    try {
-      const result = await saveData();
-      return result;
-    } catch (error) {
-      onError("Failed to save");
-    }
-  }}
-  onSuccess={(result) => handleSuccess(result)}
->
-  Save
-</Button>
-
-// Text input with validation
-<Input
-  value={inputValue}
-  onChange={(value) => setInputValue(value)}
-  validate={(value) => value.length > 0 || "Field is required"}
-  placeholder="Enter value"
-  inputClassName="w-full"
-  cacheKey="unique-input-key" // For session storage persistence
-  icon={<SomeIcon />}
-/>
-
-// Select dropdown
-<Select
-  value={selectedValue}
-  options={optionsList}
-  searchable
-  onChange={(value) => setSelectedValue(value)}
-  renderOption={(option) => <span>{option.label}</span>}
-/>
-```
-
-### Data Display Components
-
-Use these components to present data:
-
-```tsx
-// Image with optimized loading
-<Image
-  src="/path/to/image.jpg"
-  alt="Description"
-  className="rounded-md"
-  width={400}
-  height={300}
-/>
-
-// Avatar for user profiles
-<Avatar
-  src={user.profileImage}
-  className="w-10 h-10"
-/>
-
-// Empty state
-<Empty
-  description="No items found"
-  minHeight={200}
-/>
-
-// Chart visualization
-<Chart.Bar
-  data={chartData}
-  options={chartOptions}
-/>
-```
-
-### Navigation Components
-
-The library provides various navigation patterns:
-
-```tsx
-// Adaptive link (auto-switches between CSR/Next.js)
-<Link href="/some-path">Go to Page</Link>
-
-// Back navigation
-<Link.Back>Go Back</Link.Back>
-
-// Tabbed interface
-<Tab.Provider defaultMenu="tab1">
-  <div className="flex">
-    <Tab.Menu menu="tab1">Tab 1</Tab.Menu>
-    <Tab.Menu menu="tab2">Tab 2</Tab.Menu>
-  </div>
-  <Tab.Panel menu="tab1">
-    Content for tab 1
-  </Tab.Panel>
-  <Tab.Panel menu="tab2" loading="lazy">
-    Content for tab 2
-  </Tab.Panel>
-</Tab.Provider>
-```
-
-### Layout Components
-
-Create consistent layouts across your application:
-
-```tsx
-// Page layout with header
-<Layout>
-  <Layout.Header type="hide">Header Content</Layout.Header>
-  <main>Page Content</main>
-  <Layout.Navbar>Navigation Items</Layout.Navbar>
-</Layout>
-
-// Modal dialog
-<Modal
-  open={isModalOpen}
-  onCancel={() => setModalOpen(false)}
-  title="Modal Title"
->
-  Modal content goes here
-</Modal>
-
-// Mobile bottom sheet
-<BottomSheet
-  open={isBottomSheetOpen}
-  onCancel={() => setBottomSheetOpen(false)}
-  type="half"
->
-  Bottom sheet content
-</BottomSheet>
-```
-
-### Media and File Components
-
-Handle files and media with these components:
-
-```tsx
-// Single image upload with cropping
-<Upload.Image
-  file={imageFile}
-  onChange={async (file) => {
-    // Handle file upload
-    const uploadedFile = await uploadFile(file);
-    setImageFile(uploadedFile);
-  }}
-  onRemove={() => setImageFile(null)}
-/>
-
-// Multiple file upload
-<Upload.FileList
-  multiple
-  fileList={fileList}
-  onChange={async (files) => {
-    // Handle multiple file upload
-    const uploadedFiles = await uploadFiles(files);
-    setFileList([...fileList, ...uploadedFiles]);
-  }}
-  onRemove={(file) => {
-    setFileList(fileList.filter(f => f.id !== file.id));
-  }}
-/>
-```
-
-### Loading and Feedback Components
-
-Provide user feedback with these components:
-
-```tsx
-// Loading area overlay
-<Loading.Area />
-
-// Loading spinner
-<Loading.Spin isCenter />
-
-// Progress bar
-<Loading.ProgressBar value={75} max={100} />
-
-// Loading skeleton
-<Loading.Skeleton />
-```
-
-## Integration with Akan.js Architecture
-
-The `@util/ui` components are designed to work within the Akan.js module architecture pattern:
-
-### In Model.Template.tsx
-
-```tsx
-// Form templates for creating/editing records
-import { Button, Input, Select } from "@util/ui";
-
-export const UserTemplate = ({ user, onSubmit }) => {
-  return (
-    <form onSubmit={onSubmit}>
-      <Input
-        label="Username"
-        value={user.username}
-        onChange={(value) => updateUser({ username: value })}
-        validate={(value) => value.length > 3 || "Username too short"}
-      />
-      <Select label="Role" value={user.role} options={roleOptions} onChange={(value) => updateUser({ role: value })} />
-      <Button type="submit">Save User</Button>
-    </form>
-  );
-};
-```
-
-### In Model.Unit.tsx
-
-```tsx
-// Card/list item components for displaying records
-import { Avatar, Link } from "@util/ui";
-
-export const UserUnit = ({ user }) => {
-  return (
-    <div className="flex items-center rounded border p-4">
-      <Avatar src={user.profileImage} className="mr-4" />
-      <div>
-        <h3>{user.name}</h3>
-        <p>{user.email}</p>
-      </div>
-      <Link href={`/users/${user.id}`}>View Profile</Link>
-    </div>
-  );
-};
-```
-
-### In Model.View.tsx
-
-```tsx
-// Full page views for displaying detailed records
-import { Tab, Layout, Loading } from "@util/ui";
-
-export const UserView = ({ user, isLoading }) => {
-  if (isLoading) return <Loading.Area />;
-
-  return (
-    <Layout>
-      <Layout.Header>{user.name}'s Profile</Layout.Header>
-      <Tab.Provider defaultMenu="details">
-        <Tab.Menu menu="details">Details</Tab.Menu>
-        <Tab.Menu menu="activity">Activity</Tab.Menu>
-
-        <Tab.Panel menu="details">{/* User details content */}</Tab.Panel>
-        <Tab.Panel menu="activity" loading="lazy">
-          {/* User activity content */}
-        </Tab.Panel>
-      </Tab.Provider>
-    </Layout>
-  );
-};
-```
-
-## Best Practices
-
-1. **Component Selection**
-
-   - Use the most specific component for the task
-   - Prefer namespaced components for complex UI elements
-   - Combine components to create consistent patterns
-
-2. **Props Usage**
-
-   - Only use the documented props for each component
-   - Follow the TypeScript interfaces for proper type checking
-   - Use className props for styling customization
-
-3. **Styling**
-
-   - Use Tailwind CSS classes for styling customization
-   - Maintain consistent spacing and layout
-   - Follow responsive design patterns
-
-4. **Accessibility**
-
-   - Use proper ARIA attributes when required
-   - Ensure keyboard navigation works correctly
-   - Maintain color contrast requirements
-
-5. **Performance**
-   - Use lazy loading for heavy components
-   - Implement proper memoization for complex components
-   - Keep render cycles efficient
-
-## [Strict Caution]
-
-- Every component must be used exactly as described in this documentation
-- Do not add any additional props to the components beyond those documented
-- Only the components explicitly listed in the documentation are available
-- Follow the established patterns for component composition and layout
-
-## Framework Integration Features
-
-- TypeScript support with strict typing
-- Responsive design with mobile-first approach
-- Internationalization (i18n) integration
-- Session storage caching for form inputs
-- Accessibility compliance
-- Consistent DaisyUI/Tailwind CSS styling
-- Modern React patterns (hooks, context, providers)
-- Error handling and validation systems

package/src/library/library.command.d.ts

@@ -1,9 +0,0 @@
-import { Lib, Workspace } from "@akanjs/devkit";
-import { LibraryScript } from "./library.script";
-export declare class LibraryCommand {
-    libraryScript: LibraryScript;
-    createLibrary(libName: string, workspace: Workspace): Promise<void>;
-    removeLibrary(lib: Lib): Promise<void>;
-    syncLibrary(lib: Lib): Promise<void>;
-    installLibrary(libName: string, workspace: Workspace): Promise<void>;
-}

package/src/library/library.runner.d.ts

@@ -1,9 +0,0 @@
-import { Lib, LibExecutor, Workspace } from "@akanjs/devkit";
-export declare class LibraryRunner {
-    #private;
-    createLibrary(libName: string, workspace: Workspace): Promise<LibExecutor>;
-    removeLibrary(lib: Lib): Promise<void>;
-    installLibrary(workspace: Workspace, libName: string): Promise<LibExecutor>;
-    mergeLibraryDependencies(lib: Lib): Promise<void>;
-    testLibrary(lib: Lib): Promise<void>;
-}

package/src/library/library.script.d.ts

@@ -1,9 +0,0 @@
-import type { Lib, Workspace } from "@akanjs/devkit";
-export declare class LibraryScript {
-    #private;
-    syncLibrary(lib: Lib): Promise<import("@akanjs/devkit").AppInfo | import("@akanjs/devkit").LibInfo>;
-    createLibrary(libName: string, workspace: Workspace): Promise<void>;
-    removeLibrary(lib: Lib): Promise<void>;
-    installLibrary(workspace: Workspace, libName: string): Promise<void>;
-    testLibrary(lib: Lib): Promise<void>;
-}

package/src/module/module.command.d.ts

@@ -1,10 +0,0 @@
-import { Module, Sys } from "@akanjs/devkit";
-import { ModuleScript } from "./module.script";
-export declare class ModuleCommand {
-    moduleScript: ModuleScript;
-    createModule(moduleName: string, sys: Sys, page: boolean): Promise<void>;
-    removeModule(module: Module): Promise<void>;
-    createView(module: Module): Promise<void>;
-    createUnit(module: Module): Promise<void>;
-    createTemplate(module: Module): Promise<void>;
-}

package/src/module/module.prompt.d.ts

@@ -1,13 +0,0 @@
-import type { FileContent } from "@akanjs/devkit";
-export interface ComponentDefaultDescriptionProps {
-    sysName: string;
-    modelName: string;
-    ModelName: string;
-    constant: string;
-    properties: {
-        key: string;
-        source: string;
-    }[];
-    exampleFiles: FileContent[];
-}
-export declare const componentDefaultDescription: ({ modelName, ModelName, exampleFiles, constant, properties, }: ComponentDefaultDescriptionProps) => string;

package/src/module/module.request.d.ts

@@ -1,63 +0,0 @@
-import type { AppConfigResult, LibConfigResult } from "@akanjs/config";
-import { type FileContent, Prompter } from "@akanjs/devkit";
-interface ModuleRequestProps {
-    sysType: "app" | "lib";
-    sysName: string;
-    config: LibConfigResult | AppConfigResult;
-    modelName: string;
-}
-export declare class ModuleRequest extends Prompter {
-    sysType: "app" | "lib";
-    sysName: string;
-    config: LibConfigResult | AppConfigResult;
-    modelName: string;
-    constructor(options: ModuleRequestProps);
-    requestModelConstant({ modelDesc, modelSchemaDesign, boilerplate, exampleFiles, }: {
-        modelDesc: string;
-        modelSchemaDesign: string;
-        boilerplate: string;
-        exampleFiles: FileContent[];
-    }): Promise<string>;
-}
-interface RequestProps {
-    sysName: string;
-    modelName: string;
-    ModelName?: string;
-    boilerplate: string;
-    properties?: {
-        key: string;
-        source: string;
-    }[];
-    exampleFiles: FileContent[];
-}
-interface RequestDictionaryProps extends RequestProps {
-    constant: string;
-    modelDesc: string;
-    modelSchemaDesign: string;
-}
-export declare const requestDictionary: ({ sysName, modelName, constant, modelDesc, modelSchemaDesign, boilerplate, exampleFiles, }: RequestDictionaryProps) => string;
-interface RequestTemplateProps extends RequestProps {
-    constant: string;
-    properties: {
-        key: string;
-        source: string;
-    }[];
-}
-export declare const requestTemplate: ({ sysName, modelName, ModelName, boilerplate, constant, properties, exampleFiles, }: RequestTemplateProps) => string;
-interface RequestViewProps extends RequestProps {
-    constant: string;
-    properties: {
-        key: string;
-        source: string;
-    }[];
-}
-export declare const requestView: ({ sysName, modelName, ModelName, boilerplate, constant, properties, exampleFiles, }: RequestViewProps) => string;
-interface RequestUnitProps extends RequestProps {
-    constant: string;
-    properties: {
-        key: string;
-        source: string;
-    }[];
-}
-export declare const requestUnit: ({ sysName, modelName, ModelName, constant, properties, boilerplate, exampleFiles, }: RequestUnitProps) => string;
-export {};

package/src/module/module.runner.d.ts

@@ -1,53 +0,0 @@
-import { type Module, Workspace } from "@akanjs/devkit";
-export declare class ModuleRunner {
-    createModule(workspace: Workspace, sysType: "app" | "lib", sysName: string, moduleName: string, description: string): Promise<void>;
-    removeModule(module: Module): Promise<void>;
-    createComponentTemplate(module: Module, type: "unit" | "view" | "template" | "zone" | "util"): Promise<{
-        component: {
-            filename: string;
-            content: string;
-        };
-    }>;
-    createModuleTemplate(module: Module): Promise<{
-        constant: {
-            filename: string;
-            content: string;
-        };
-        dictionary: {
-            filename: string;
-            content: string;
-        };
-        service: {
-            filename: string;
-            content: string;
-        };
-        store: {
-            filename: string;
-            content: string;
-        };
-        signal: {
-            filename: string;
-            content: string;
-        };
-        unit: {
-            filename: string;
-            content: string;
-        };
-        view: {
-            filename: string;
-            content: string;
-        };
-        template: {
-            filename: string;
-            content: string;
-        };
-        zone: {
-            filename: string;
-            content: string;
-        };
-        util: {
-            filename: string;
-            content: string;
-        };
-    }>;
-}

package/src/module/module.script.d.ts

@@ -1,17 +0,0 @@
-import { type Module, type Sys, Workspace } from "@akanjs/devkit";
-import { PageScript } from "../page/page.script";
-export declare class ModuleScript {
-    #private;
-    pageScript: PageScript;
-    createModuleTemplate(sys: Sys, name: string, { page }?: {
-        page?: boolean;
-    }): Promise<void>;
-    createModule(sys: Sys, name: string, description?: string, schemaDescription?: string): Promise<void>;
-    createModule_(sys: Sys, name: string, description: string, schemaDescription: string): Promise<void>;
-    removeModule(mod: Module): Promise<void>;
-    createService(workspace: Workspace, name: string): Promise<void>;
-    createTest(workspace: Workspace, name: string): Promise<void>;
-    createTemplate(mod: Module): Promise<void>;
-    createUnit(mod: Module): Promise<void>;
-    createView(mod: Module): Promise<void>;
-}

package/src/package/package.command.d.ts

@@ -1,10 +0,0 @@
-import { Pkg, Workspace } from "@akanjs/devkit";
-import { PackageScript } from "./package.script";
-export declare class PackageCommand {
-    packageScript: PackageScript;
-    version(workspace: Workspace): Promise<void>;
-    createPackage(name: string, workspace: Workspace): Promise<void>;
-    removePackage(pkg: Pkg): Promise<void>;
-    syncPackage(pkg: Pkg): Promise<void>;
-    buildPackage(pkg: Pkg): Promise<void>;
-}

package/src/package/package.runner.d.ts

@@ -1,9 +0,0 @@
-import { type PackageJson, type Pkg, type Workspace } from "@akanjs/devkit";
-export declare class PackageRunner {
-    version(workspace: Workspace): Promise<void>;
-    createPackage(workspace: Workspace, pkgName: string): Promise<void>;
-    removePackage(pkg: Pkg): Promise<void>;
-    scanSync(pkg: Pkg): Promise<import("@akanjs/devkit").PkgInfo>;
-    buildPackage(pkg: Pkg): Promise<void>;
-    updateWorskpaceRootPackageJson(workspace: Workspace, rootPackageJson: PackageJson): void;
-}

package/src/package/package.script.d.ts

@@ -1,10 +0,0 @@
-import { type Pkg, type Workspace } from "@akanjs/devkit";
-export declare class PackageScript {
-    #private;
-    version(workspace: Workspace): Promise<void>;
-    createPackage(workspace: Workspace, pkgName: string): Promise<void>;
-    removePackage(pkg: Pkg): Promise<void>;
-    syncPackage(pkg: Pkg): Promise<import("@akanjs/devkit").PkgInfo>;
-    buildPackage(pkg: Pkg): Promise<void>;
-    updateWorskpaceRootPackageJson(workspace: Workspace): void;
-}

package/src/page/page.command.d.ts

@@ -1,6 +0,0 @@
-import { App, Module } from "@akanjs/devkit";
-import { PageScript } from "./page.script";
-export declare class PageCommand {
-    pageScript: PageScript;
-    createCrudPage(app: App, module: Module, basePath: string | null, single: boolean): Promise<void>;
-}

package/src/page/page.runner.d.ts

@@ -1,8 +0,0 @@
-import { App, Module } from "@akanjs/devkit";
-export declare class PageRunner {
-    createCrudPage(module: Module, { app, basePath, single }: {
-        app: App;
-        basePath: string | null;
-        single: boolean;
-    }): Promise<void>;
-}

package/src/page/page.script.d.ts

@@ -1,9 +0,0 @@
-import { App, Module } from "@akanjs/devkit";
-export declare class PageScript {
-    #private;
-    createCrudPage(module: Module, { app, basePath, single }: {
-        app: App;
-        basePath: string | null;
-        single: boolean;
-    }): Promise<void>;
-}

package/src/scalar/scalar.command.d.ts

@@ -1,7 +0,0 @@
-import { Sys } from "@akanjs/devkit";
-import { ScalarScript } from "./scalar.script";
-export declare class ScalarCommand {
-    scalarScript: ScalarScript;
-    createScalar(scalarName: string, ai: boolean, sys: Sys): Promise<void>;
-    removeScalar(scalarName: string, sys: Sys): Promise<void>;
-}

package/src/scalar/scalar.prompt.d.ts

@@ -1,23 +0,0 @@
-import { Prompter, type Sys } from "@akanjs/devkit";
-export declare class ScalarPrompt extends Prompter {
-    #private;
-    readonly sys: Sys;
-    readonly name: string;
-    constructor(sys: Sys, name: string);
-    requestUpdateConstant(): Promise<{
-        request: string;
-        validate: undefined;
-    }>;
-    requestCreateConstant(): Promise<{
-        request: string;
-        validate: string[];
-    }>;
-    requestUpdateDictonaryWithInstruction(): Promise<{
-        request: string;
-        validate: string[];
-    }>;
-    requestUpdateDictonaryWithFollowing(): {
-        request: string;
-        validate: string[];
-    };
-}

package/src/scalar/scalar.runner.d.ts

@@ -1,14 +0,0 @@
-import { AiSession, type Sys } from "@akanjs/devkit";
-import { ScalarPrompt } from "./scalar.prompt";
-export declare class ScalarRunner {
-    applyScalarTemplate(sys: Sys, scalarName: string): Promise<void>;
-    createScalarConstant(sys: Sys, scalarName: string): Promise<{
-        session: AiSession;
-        scalarNames: string[];
-        writes: import("@akanjs/devkit").FileContent[];
-        prompt: ScalarPrompt;
-    }>;
-    updateScalarDictionaries(sys: Sys, scalarNames: string[], { session }: {
-        session: AiSession;
-    }): Promise<void>;
-}

package/src/scalar/scalar.script.d.ts

@@ -1,7 +0,0 @@
-import { type Sys } from "@akanjs/devkit";
-export declare class ScalarScript {
-    #private;
-    createScalar(sys: Sys, scalarName: string): Promise<void>;
-    createScalarWithAi(sys: Sys, scalarName: string): Promise<void>;
-    removeScalar(sys: Sys, scalarName: string): Promise<void>;
-}

package/src/templates/__scalar/__model__/__model__.constant.d.ts

@@ -1,7 +0,0 @@
-import type { AppInfo, LibInfo } from "@akanjs/devkit";
-interface Dict {
-    model: string;
-    Model: string;
-}
-export default function getContent(scanInfo: AppInfo | LibInfo | null, dict: Dict): string;
-export {};

package/src/templates/__scalar/__model__/__model__.dictionary.d.ts

@@ -1,7 +0,0 @@
-import type { AppInfo, LibInfo } from "@akanjs/devkit";
-interface Dict {
-    model: string;
-    Model: string;
-}
-export default function getContent(scanInfo: AppInfo | LibInfo | null, dict: Dict): string;
-export {};

package/src/templates/__scalar/__model__/__model__.document.d.ts

@@ -1,7 +0,0 @@
-import type { AppInfo, LibInfo } from "@akanjs/devkit";
-interface Dict {
-    model: string;
-    Model: string;
-}
-export default function getContent(scanInfo: AppInfo | LibInfo | null, dict: Dict): string;
-export {};

package/src/templates/app/akan.config.d.ts

@@ -1,6 +0,0 @@
-import type { AppInfo, LibInfo } from "@akanjs/devkit";
-interface Dict {
-    appName: string;
-}
-export default function getContent(scanInfo: AppInfo | LibInfo | null, dict: Dict): string;
-export {};