@designcrowd/fe-shared-lib 1.5.20-dts-upgrades-2 → 1.5.21-BestLogoIcons-3

package/docs/plans/2026-01-19-typescript-declarations-design.md

@@ -1,114 +0,0 @@
-# fe-shared-lib TypeScript Declarations Design
-
-## Overview & Goals
-
-**Objective**: Add TypeScript declaration file to `@designcrowd/fe-shared-lib` so consumers get basic type checking and IDE autocomplete without converting the library to TypeScript.
-
-**Success Criteria**:
-- BrandCrowd.Nuxt's 117 `TS7016` errors for `@designcrowd/fe-shared-lib` resolve
-- Commonly-used components (Button, Modal, Icon, etc.) have typed props
-- Less-used components have minimal stub declarations
-- No changes to existing JavaScript/Vue component code
-
-**Approach**:
-1. Create `index.d.ts` at package root declaring all exports from `index.js`
-2. Add `"types": "./index.d.ts"` to `package.json` exports
-3. Define detailed prop interfaces for ~10 most-used components
-4. Use generic `DefineComponent<{}, {}, any>` for remaining components
-5. Publish new version for BrandCrowd.Nuxt to consume
-
-**Files to Create/Modify**:
-- `index.d.ts` (new) - Main declaration file
-- `package.json` - Add types field to exports
-
-## Implementation Details
-
-**Structure of `index.d.ts`**:
-
-```typescript
-import { DefineComponent, PropType } from 'vue';
-
-// ============ Detailed Component Types ============
-// Most-used components with full prop definitions
-
-export interface ButtonProps {
-  label?: string;
-  variant?: 'primary' | 'secondary' | 'success' | 'danger' | 'link';
-  size?: 'sm' | 'md' | 'lg';
-  disabled?: boolean;
-  isBusy?: boolean;
-  fullWidth?: boolean;
-  icon?: string;
-  // ... other props from examining Button.vue
-}
-
-export const Button: DefineComponent<ButtonProps>;
-export const Modal: DefineComponent<ModalProps>;
-export const Icon: DefineComponent<IconProps>;
-// ... ~10 detailed components
-
-// ============ Stub Component Types ============
-// Less-used components - typed but generic
-
-export const UploadYourLogoDropzone: DefineComponent<{}, {}, any>;
-export const SignUpModal: DefineComponent<{}, {}, any>;
-// ... remaining ~45 components
-
-// ============ Utilities ============
-export function setSharedLibLocaleAsync(locale: string): Promise<void>;
-export function tr(key: string, params?: Record<string, any>): string;
-
-// ============ API Clients ============
-export const brandPageApiClient: any;
-export const brandCrowdApiClient: any;
-```
-
-**Components to fully type** (based on usage frequency):
-1. Button
-2. Modal
-3. Icon
-4. Dropdown
-5. TextInput
-6. Textarea
-7. Checkbox
-8. Toggle
-9. Loader
-10. Select
-
-## Verification & Publishing
-
-**Local Testing** (before publishing):
-1. Create `index.d.ts` in fe-shared-lib
-2. In BrandCrowd.Nuxt, run `npm link ../fe-shared-lib`
-3. Run `npx vue-tsc --noEmit` - verify TS7016 errors for fe-shared-lib resolve
-4. Check IDE autocomplete works for Button props in a .vue file
-
-**Publishing Workflow**:
-1. Bump version in `package.json` (e.g., `1.5.20` → `1.5.21`)
-2. Commit with message: `Add TypeScript declarations for consumers`
-3. Build and publish: `npm publish` (or via CI pipeline)
-4. In BrandCrowd.Nuxt: `npm update @designcrowd/fe-shared-lib`
-
-**Iterative Improvement**:
-After initial release, prop types can be refined by:
-- Examining actual component `.vue` files for accurate prop definitions
-- Adding missing props as consumers report them
-- Eventually generating declarations from JSDoc or migrating to TypeScript
-
-**Rollback Plan**:
-If declarations cause issues, consumers can add to their own `types/vendor-modules.d.ts`:
-```typescript
-declare module '@designcrowd/fe-shared-lib';
-```
-This overrides the package's declarations with a permissive stub.
-
-## Checklist
-
-- [ ] Create `index.d.ts` with all exports from `index.js`
-- [ ] Add detailed prop interfaces for 10 most-used components
-- [ ] Add stub declarations for remaining components
-- [ ] Add types for utility functions (setSharedLibLocaleAsync, tr)
-- [ ] Update `package.json` with types field in exports
-- [ ] Test locally with `npm link` in BrandCrowd.Nuxt
-- [ ] Verify TS7016 errors resolve
-- [ ] Bump version and publish