TypeScript types for plugins have very unspecific types #323

Activity

1. davidesigner commented on Nov 24, 2024

   

   davidesigner

   on Nov 24, 2024

   More actions

   If it can help someone, here is my solution to have a better TS support inside plugins.

   // utils.ts
   
   interface AnalyticsFuncProps<C extends object> {
     abort: (message: string) => {};
     config: C;
     instance: any;
     plugins: any;
   }
   
   interface PayloadProps<T extends 'page' | 'track' | 'identify'> {
     anonymousId: string;
     meta: any;
     options: any;
     type: T;
     userId: string | null;
   }
   
   interface InitializeFuncProps<C extends object = {}> extends AnalyticsFuncProps<C> {
     payload: {
       disabled: any[];
       meta: any;
       plugins: string[];
       type: 'initialize';
     };
   }
   
   interface PageFuncProps<C extends object = {}> extends AnalyticsFuncProps<C> {
     payload: PayloadProps<'page'>;
   }
   
   interface TrackFuncProps<C extends object = {}> extends AnalyticsFuncProps<C> {
     payload: PayloadProps<'track'>;
   }
   
   interface IdentifyFuncProps<C extends object = {}> extends AnalyticsFuncProps<C> {
     payload: PayloadProps<'identify'> & {
       traits: Record<string, unknown>;
     };
   }
   
   export interface AnalyticsPlugin<C extends object = {}> extends LibAnalyticsPlugin {
     name: string;
     config?: C;
     initializeStart?: (props: InitializeFuncProps<C>) => void;
     initialize?: (props: InitializeFuncProps<C>) => void;
     pageStart?: (props: PageFuncProps<C>) => void;
     page?: (props: PageFuncProps<C>) => void;
     trackStart?: (props: TrackFuncProps<C>) => void;
     track?: (props: TrackFuncProps<C>) => void;
     identify?: (props: IdentifyFuncProps<C>) => void;
     loaded?: () => boolean;
   }

   // custom-plugin.ts
   
   export function customPlugin(settings: { myPluginSetting: string }, hasUserOptIn: boolean | undefined) {
     const configuration = { ...settings, hasUserOptIn };
     
     return {
       name: "analytics-plugin-custom",
       config: configuration,
       initialize: ({ config }) => {
         // ...
       },
       identify: ({ payload: { userId } }) => {
         // ...
       },
       page: ({ payload: { context } }) => {
         // ...
       },
       track: ({ payload: { event, context, properties } }) => {
         // ...
       },
       reset: () => {
         // ...
       },
       loaded: () => true,
     } satisfies AnalyticsPlugin<typeof configuration>;
   }

   👍React with 👍1Reacted by Robert Vitonsky
2. vitonsky commented on Mar 1, 2026

   

   vitonsky

   on Mar 1, 2026

   More actions

   +1, @DavidWells what status of this problem?

   The package looks nice, but it seems a bit abandoned. This issue is created 4 years ago and described problem with types is still here.

   It seems a @davidesigner have wrote the nice typings above, should we add this in package?
   Do you need a help with this task?