@danjojojo/strapi-audit-trail 0.0.0-stage → 1.0.1

package/dist/admin/src/types/actions.types.d.ts

@@ -0,0 +1,16 @@
+import { ActionContext, ActionComponent, ActionDescription } from './internal.types';
+export type HeaderActionType = (props: ActionContext) => ActionDescription | null;
+export type PlaceHeaderAction = (props: {
+    /**
+     * @description Pass the actions array.
+     */
+    actions: ActionComponent[];
+    /**
+     * @description Pass the action components to be placed in the header.
+     */
+    component: ActionComponent[];
+    /**
+     * @description Specify the target where the action component will be placed in the header. This will put the action component before the target.
+     */
+    placeBefore?: ActionComponent['type'];
+}) => ActionComponent[];

package/dist/admin/src/types/block.types.d.ts

@@ -0,0 +1,27 @@
+import { MediaEntry } from './field-value.types';
+/** FOR BASE BLOCK */
+export interface BaseBlock {
+    children: React.ReactNode;
+}
+/** FOR LIST BLOCK */
+export interface ListBlockProps extends BaseBlock {
+    format: 'ordered' | 'unordered';
+}
+/** FOR IMAGE BLOCK */
+export interface ImageBlockProps extends BaseBlock {
+    data: MediaEntry;
+}
+/** FOR HEADING BLOCK */
+export type HeadingTag = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+export interface HeadingBlockProps extends BaseBlock {
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+}
+/** FOR BLOCK TOOLKIT */
+export interface ToolkitProps {
+    icon: React.JSX.Element;
+    label: string;
+}
+/** FOR BLOCK RENDERER */
+export interface BlocksRendererProps {
+    value: any;
+}

package/dist/admin/src/types/container.types.d.ts

@@ -0,0 +1,50 @@
+export interface GetContainersParams {
+    schema: string | undefined;
+    layout: string | undefined;
+}
+export interface ContainerField {
+    id: string;
+    label: string;
+    size: number;
+    settings: SettingsContent;
+    metadata: MetadataContent;
+    schema: SchemaContent;
+}
+export interface GetContainersResult {
+    type: 'normal' | 'dynamiczone';
+    fields: ContainerField[][];
+}
+export interface FieldLayout {
+    name: string;
+    size: number;
+}
+export type SchemaContent = {
+    type: string;
+    required?: boolean;
+    relation?: string;
+    component?: string;
+    repeatable?: boolean;
+    multiple?: boolean;
+    customField?: string;
+};
+export type SettingsContent = {
+    mainField: string | null;
+};
+export type MetadataContent = {
+    edit: {
+        mainField?: string | null;
+    };
+    list: {
+        label: string;
+    };
+};
+export type Schema = Record<string, SchemaContent>;
+export type Metadatas = Record<string, MetadataContent>;
+export interface Layout {
+    settings: SettingsContent;
+    metadatas: Metadatas;
+    layouts: {
+        list: string[];
+        edit: FieldLayout[][];
+    };
+}

package/dist/admin/src/types/detail.types.d.ts

@@ -0,0 +1,8 @@
+export interface DetailContentLayoutProps {
+    content: React.ReactNode;
+    rightSidebar: React.ReactNode;
+    isLoading: boolean;
+    isInvalid: boolean;
+    hasError: boolean;
+    isEmpty: boolean;
+}

package/dist/admin/src/types/dialog.types.d.ts

@@ -0,0 +1,8 @@
+export interface BaseDialogProps<T> {
+    data: T;
+    onClose: () => void;
+}
+export interface DialogGridItemProps {
+    label: string;
+    children: React.ReactNode;
+}

package/dist/admin/src/types/field-value.types.d.ts

@@ -0,0 +1,25 @@
+export interface Relation {
+    id?: number | string;
+    documentId?: string;
+    [key: string]: any;
+}
+export interface MediaEntry {
+    id?: number | string;
+    name: string;
+    alternativeText?: string | null;
+    url: string;
+    caption?: string | null;
+    width: number;
+    height: number;
+    formats?: Record<string, unknown>;
+    hash: string;
+    ext: string;
+    mime: string;
+    size: number;
+    previewUrl?: string | null;
+    provider: string;
+    provider_metadata?: unknown | null;
+    createdAt: string;
+    updatedAt: string;
+    [key: string]: any;
+}

package/dist/admin/src/types/fields-container.types.d.ts

@@ -0,0 +1,8 @@
+import { GetContainersResult } from './container.types';
+export interface BaseContainerProps {
+    children: React.ReactNode;
+}
+export interface DefaultContainerProps {
+    container: GetContainersResult | null;
+    renderFields: (fields: GetContainersResult['fields'][number][number]) => React.JSX.Element;
+}

package/dist/admin/src/types/fields.types.d.ts

@@ -0,0 +1,101 @@
+import { GetContainersResult, MetadataContent, SchemaContent, SettingsContent } from './container.types';
+/** BASE FIELD */
+export interface FieldProps {
+    label: string;
+    children?: React.ReactNode;
+    paddingBottom?: string;
+    type?: string;
+    value?: any;
+    required?: boolean;
+}
+/** BOOLEAN FIELD */
+export interface BooleanProps {
+    label: string;
+    value: string;
+    schema: SchemaContent;
+}
+/** RELATION FIELD */
+export interface RelationProps {
+    label: string;
+    value: any;
+    metadata: MetadataContent;
+    schema: SchemaContent;
+}
+export interface RelationButton {
+    value: string;
+}
+export interface ScrollableRelationButtons {
+    itemsLength: number;
+    children: React.ReactNode;
+}
+/** MEDIA FIELD */
+export interface MediaProps {
+    label: string;
+    value: any;
+    schema: SchemaContent;
+}
+/** INPUT FIELD */
+export interface InputFieldProps {
+    label: string;
+    value: any;
+    schema: SchemaContent;
+}
+/** DOCUMENT VIEW FIELD */
+export interface RenderFieldProps {
+    label: string;
+    type: string;
+    value: any;
+    schema: SchemaContent;
+    metadata: MetadataContent;
+    settings: SettingsContent;
+}
+/** DYNAMIC ZONE PROPS */
+export interface DynamiczoneProps {
+    value: any[];
+}
+/** COMPONENT PROPS */
+export interface ComponentProps {
+    label: string;
+    value: any | any[];
+    schema: SchemaContent;
+    settings: SettingsContent;
+}
+/** SINGLE COMPONENT PROPS */
+export interface SingleComponentProps {
+    containers: GetContainersResult[] | null;
+    renderFields: (fields: GetContainersResult['fields'][number][number]) => React.JSX.Element;
+}
+/** REPEATABLE COMPONENT PROPS */
+export interface RepeatableComponentProps {
+    containers: GetContainersResult[] | null;
+    value: any[];
+    renderTitle: (value: any, container: GetContainersResult) => string;
+    renderFields: (fields: GetContainersResult['fields'][number][number], value: any) => React.JSX.Element;
+}
+/** DYNAMIC ZONE COMPONENT PROPS */
+export interface DynamiczoneComponentProps {
+    value: any[];
+    renderTitle: (value: any, container: GetContainersResult) => string;
+    renderContainers: (value: any) => GetContainersResult[] | null;
+    renderFields: (fields: GetContainersResult['fields'][number][number], value: any) => React.JSX.Element;
+}
+export interface CustomInputFieldProps extends InputFieldProps {
+    customField: string;
+}
+export interface CustomFieldInputProps {
+    name: string;
+    value: unknown;
+    disabled?: boolean;
+    attribute?: {
+        type: string;
+        customField: string;
+    };
+    onChange?: (event: {
+        target: {
+            name: string;
+            value: unknown;
+            type: string;
+        };
+    }) => void;
+    [key: string]: unknown;
+}

package/dist/admin/src/types/internal.types.d.ts

@@ -0,0 +1,5 @@
+import { ContentManagerPlugin, DocumentActionComponent, DocumentActionDescription, EditViewContext } from '@strapi/content-manager/strapi-admin';
+export type AppPluginAPI = ContentManagerPlugin['config']['apis'];
+export type ActionContext = EditViewContext;
+export type ActionComponent = DocumentActionComponent;
+export type ActionDescription = DocumentActionDescription;

package/dist/admin/src/types/markdown.types.d.ts

@@ -0,0 +1,6 @@
+export interface MarkdownProps {
+    value: string | any;
+}
+export interface MarkdownCompProps {
+    children: React.ReactNode;
+}

package/dist/admin/src/types/service.types.d.ts

@@ -0,0 +1,93 @@
+import { ACTION_COLORS } from '../constants';
+import { Struct } from '@strapi/strapi';
+export interface CollectionData {
+    uid: string;
+    name: string;
+    kind: Struct.ContentTypeSchema['kind'] | 'others' | 'none';
+}
+export type Columns = keyof AuditLogsData;
+export interface Pagination {
+    page: number;
+    pageSize: number;
+    pageCount: number;
+    total: number;
+}
+export interface AuditLogsData {
+    id: number;
+    documentId: string;
+    action: keyof typeof ACTION_COLORS;
+    collectionName: string;
+    collectionUid: string;
+    contentTypeKind: string;
+    relatedDocumentId: string;
+    actionFrom: string;
+    createdAt: string;
+}
+export interface AuditLogData {
+    id: number;
+    documentId: string;
+    action: keyof typeof ACTION_COLORS;
+    collectionName: string;
+    collectionUid: string;
+    contentTypeKind: string;
+    relatedDocumentId: string;
+    actionFrom: string;
+    createdAt: string;
+    payload: string;
+    documentSchema: string;
+    documentLayout: string;
+    componentsSchema: string;
+    componentsLayout: string;
+    componentsNames: string;
+}
+export interface AuditLoginsData {
+    id: number;
+    documentId: string;
+    emailAddress: string;
+    loginResult: string;
+    requestTime: string;
+    userDetails: string;
+    userClient: string;
+    ipAddress: string;
+    loginErrorReason: string;
+    createdAt: string;
+}
+export interface GetAuditLogs {
+    collectionUid?: string;
+    query?: {
+        _q?: string;
+        sort?: string;
+        page?: number;
+        pageSize?: number;
+    };
+}
+export interface GetAuditLog {
+    collectionUid?: string;
+    documentId?: string;
+    query?: {
+        action?: string;
+        createdAt?: string;
+    };
+}
+export interface GetAuditLogins {
+    query?: {
+        _q?: string;
+        sort?: string;
+        page?: number;
+        pageSize?: number;
+    };
+}
+export type ResponseStatus = 'invalid' | 'network-error' | 'none';
+export type GetAllCollectionsResponse = CollectionData[];
+export interface GetAuditLogsResponse {
+    data: AuditLogsData[];
+    meta: Pagination;
+}
+export interface GetAuditLogResponse {
+    auditLog: AuditLogData;
+    relatedLogs: AuditLogsData[];
+}
+export interface GetAuditLoginsResponse {
+    data: AuditLoginsData[];
+    meta: Pagination;
+}

package/dist/admin/src/types/ui.types.d.ts

@@ -0,0 +1,67 @@
+import { DefaultTheme } from 'styled-components';
+export interface SearchInputProps {
+    value: string;
+    wipeAction: () => void;
+    onChangeAction: (value: string) => void;
+    size?: 'S' | 'M';
+}
+export interface SidebarListItemProps {
+    active: boolean;
+    href: string;
+    label: string;
+}
+export interface SidebarListTitleProps {
+    title: string;
+    count: number;
+}
+export interface HeaderProps {
+    title: string | null | undefined;
+    count?: number;
+    backUrl?: string | null;
+    rightAction?: {
+        icon: React.ReactNode;
+        label: string;
+        url: string;
+    };
+}
+export interface EmptyStateProps {
+    content?: string;
+    hideAction?: boolean;
+    icon?: React.ReactNode;
+    action?: React.ReactNode;
+}
+export interface Colors {
+    backgroundColor: keyof DefaultTheme['colors'];
+    textColor: keyof DefaultTheme['colors'];
+}
+export type BadgeColors = Record<string, Colors>;
+export interface TableProps<T extends Record<string, any>, S extends keyof T & string = keyof T & string> {
+    data: T[];
+    columns: {
+        /** Set which columns to show */
+        show: S[];
+        /** Set which shown columns will be overridden with specific labels */
+        override?: Partial<Record<S, string>>;
+        /** Badge properties */
+        badge?: {
+            /** Set the column which will serve as the badge */
+            column: NoInfer<S>;
+            /** Pass an object of badge column value and BadgeColor */
+            colors?: BadgeColors;
+        };
+        datetime?: S[];
+    };
+    /** Pass here the fields that will be joined, which then makes up the link which will happen when a row is clicked */
+    rowLink?: {
+        path: (keyof T & string)[];
+        params?: (keyof T & string)[];
+    };
+    pagination?: {
+        pageCount: number;
+    };
+    rowDialog?: (data: T, onClose: () => void) => React.JSX.Element;
+}
+export interface StatusProps {
+    value: string;
+    colors: BadgeColors;
+}

package/dist/admin/src/types/utils.types.d.ts

@@ -0,0 +1 @@
+export type TextCase = 'retain' | 'upper' | 'lower' | 'sentence' | 'capitalize';

package/dist/admin/src/types/versions.types.d.ts

@@ -0,0 +1,17 @@
+import { AuditLogsData } from './service.types';
+export interface VersionsSidebarProps {
+    logs: AuditLogsData[];
+    isLoading: boolean;
+    isInvalid?: boolean;
+    hasError?: boolean;
+}
+export interface Version {
+    action: string;
+    createdAt: string;
+}
+export interface VersionButtonProps {
+    onClick: () => void;
+    version: AuditLogsData;
+    isCurrent: boolean;
+    active: boolean;
+}

package/dist/admin/src/utils/getTranslation.d.ts

@@ -0,0 +1,2 @@
+declare const getTranslation: (id: string) => string;
+export { getTranslation };

package/dist/admin/src/utils/numbers.d.ts

@@ -0,0 +1,8 @@
+interface StringToNumberProps {
+    value: string | null;
+    returnedValueIfError: number;
+    minCap?: number;
+    maxCap?: number;
+}
+export declare function stringToNumber({ value, returnedValueIfError, minCap, maxCap, }: StringToNumberProps): number;
+export {};

package/dist/admin/src/utils/placeHeaderAction.d.ts

@@ -0,0 +1,2 @@
+import { PlaceHeaderAction } from '../types/actions.types';
+export declare const placeHeaderAction: PlaceHeaderAction;

package/dist/admin/src/utils/routing.d.ts

@@ -0,0 +1,5 @@
+import { CollectionData } from '../types/service.types';
+export declare const appendToContentManagerPath: (url: string) => string;
+export declare const appendToPluginPath: (url: string) => string;
+export declare const appendCollectionPath: (collection: CollectionData) => string;
+export declare const stripPath: (url: string) => string;

package/dist/admin/src/utils/string.d.ts

@@ -0,0 +1,3 @@
+import { TextCase } from '../types/utils.types';
+export declare function safeParse(text: string | null): any;
+export declare function spaceSnakeCase(text: string, textCase?: TextCase): string;