@apolitical/component-library 5.5.0 → 5.5.1-bht.0

package/form/types/publish-article-form/index.d.ts

@@ -1 +1,2 @@
 export { default as PublishArticleForm } from './publish-article-form';
+export type { IPublishArticleFormProps } from './publish-article-form.types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/component-library",
-  "version": "5.5.0",
+  "version": "5.5.1-bht.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/user/member/index.d.ts

@@ -1,3 +1,3 @@
-export type { MemberProps, MemberDetailsProps } from './member';
 export { default as Member } from './member';
+export type { IMemberComponentProps, MemberProps, MemberDetailsProps, } from './member.types';
 export { getMember } from './member.helpers';

package/user/member/member.d.ts

@@ -1,81 +1,9 @@
 import React from 'react';
-import { type IProfileFormProps } from '../../form';
-import { IBadgesObject } from '../badge';
-import { IBadgesOption } from '../badges';
-export type MemberDetailsProps = {
-    /** The user's unique ID */
-    id?: string;
-    /** The user's name */
-    name?: string;
-    /** The user's profile URL; we usually get this from the ID, but we won't if `false` is passed in */
-    link?: false | string;
-    /** The user's job title */
-    jobTitle?: string;
-    /** The organisation the user works for */
-    organization?: string;
-    /** The user's location */
-    location?: {
-        country?: string;
-        en?: string;
-    };
-    /** The user's profile picture */
-    image?: {
-        thumbnail?: string;
-    };
-    /** An error, shown if the user doesn't exist */
-    error?: string;
-    /** The user's badges */
-    badges?: IBadgesObject;
-};
-export type MemberProps = 'apolitical' | 'community' | 'deleted' | MemberDetailsProps;
-interface Props {
-    /** The element to render around the content */
-    element?: 'li' | 'div';
-    /** Details about the Apolitical member */
-    member?: MemberProps;
-    /** The alt text for the image */
-    alt?: string;
-    /** Additional content to show with the member details */
-    additionalContent?: false | {
-        createdAt?: Date | string;
-        didEdit?: boolean;
-        customMessage?: string;
-    };
-    /** Whether to show badges and the scope of the badge */
-    badges?: IBadgesOption;
-    /**  Optional styling */
-    styling?: {
-        /** The size of the component */
-        size?: 'medium' | 'large';
-        /** The type of component to render, e.g. with card styling */
-        variant?: 'inline' | 'card';
-        /** Whether the user details should be condensed into one line */
-        isCondensed?: boolean;
-        /** Whether to shift the additional content onto a new line after the badges. Hide the Job title + Organisation */
-        additionalContentNewLine?: boolean;
-    };
-    /** Optional functions for the wrapper */
-    functions?: {
-        /** Optional onclick function */
-        onClick?: (e: React.MouseEvent) => void;
-        /** Props for the profile modal */
-        profile?: IProfileFormProps;
-    };
-    /** The optional test ID for Jest */
-    'data-testid'?: string;
-    /** The GTM context to use */
-    gtmContext?: string;
-    /** The GTM event to use */
-    gtmType?: string;
-    /** Additional classes */
-    className?: string;
-}
-declare const Member: ({ element, member: memberDetails, alt, additionalContent, styling, functions, gtmContext, gtmType, className, badges, ...props }: Props) => React.DetailedReactHTMLElement<{
+import { IMemberComponentProps } from './member.types';
+declare const Member: ({ element, member: memberDetails, alt, additionalContent, styling, functions, gtmContext, gtmType, className, badges, ...props }: IMemberComponentProps) => React.DetailedReactHTMLElement<{
     children: import("react/jsx-runtime").JSX.Element;
-    /** Optional onclick function */
-    onClick?: ((e: React.MouseEvent) => void) | undefined;
+    onClick?: ((e: React.MouseEvent<Element, MouseEvent>) => void) | undefined;
     className: string;
-    /** The optional test ID for Jest */
     'data-testid'?: string | undefined;
 }, HTMLElement>;
 export default Member;

package/user/member/member.helpers.d.ts

@@ -1,4 +1,4 @@
-import { MemberProps } from './member';
+import type { MemberProps } from './member.types';
 export declare const getMember: (member: MemberProps) => {
     image: string;
     name?: undefined;

package/user/member/member.types.d.ts

@@ -0,0 +1,72 @@
+import React from 'react';
+import { type IProfileFormProps } from '../../form';
+import { IBadgesObject } from '../badge';
+import { IBadgesOption } from '../badges';
+export type MemberDetailsProps = {
+    /** The user's unique ID */
+    id?: string;
+    /** The user's name */
+    name?: string;
+    /** The user's profile URL; we usually get this from the ID, but we won't if `false` is passed in */
+    link?: false | string;
+    /** The user's job title */
+    jobTitle?: string;
+    /** The organisation the user works for */
+    organization?: string;
+    /** The user's location */
+    location?: {
+        country?: string;
+        en?: string;
+    };
+    /** The user's profile picture */
+    image?: {
+        thumbnail?: string;
+    };
+    /** An error, shown if the user doesn't exist */
+    error?: string;
+    /** The user's badges */
+    badges?: IBadgesObject;
+};
+export type MemberProps = 'apolitical' | 'community' | 'deleted' | MemberDetailsProps;
+export interface IMemberComponentProps {
+    /** The element to render around the content */
+    element?: 'li' | 'div';
+    /** Details about the Apolitical member */
+    member?: MemberProps;
+    /** The alt text for the image */
+    alt?: string;
+    /** Additional content to show with the member details */
+    additionalContent?: false | {
+        createdAt?: Date | string;
+        didEdit?: boolean;
+        customMessage?: string;
+    };
+    /** Whether to show badges and the scope of the badge */
+    badges?: IBadgesOption;
+    /**  Optional styling */
+    styling?: {
+        /** The size of the component */
+        size?: 'medium' | 'large';
+        /** The type of component to render, e.g. with card styling */
+        variant?: 'inline' | 'card';
+        /** Whether the user details should be condensed into one line */
+        isCondensed?: boolean;
+        /** Whether to shift the additional content onto a new line after the badges. Hide the Job title + Organisation */
+        additionalContentNewLine?: boolean;
+    };
+    /** Optional functions for the wrapper */
+    functions?: {
+        /** Optional onclick function */
+        onClick?: (e: React.MouseEvent) => void;
+        /** Props for the profile modal */
+        profile?: IProfileFormProps;
+    };
+    /** The optional test ID for Jest */
+    'data-testid'?: string;
+    /** The GTM context to use */
+    gtmContext?: string;
+    /** The GTM event to use */
+    gtmType?: string;
+    /** Additional classes */
+    className?: string;
+}