hexabot/api/src/index.d.ts

72 lines
2.0 KiB
TypeScript
Raw Normal View History

2024-09-10 09:50:11 +00:00
/*
* Copyright © 2024 Hexastack. All rights reserved.
*
* Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
* 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
* 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
*/
import 'mongoose';
import { SubscriberStub } from './chat/schemas/subscriber.schema';
import {
ObjectWithNestedKeys,
2024-10-18 16:50:35 +00:00
RecursivePartial,
WithoutGenericAny,
2024-09-10 09:50:11 +00:00
} from './utils/types/filter.types';
type TOmitId<T> = Omit<T, 'id'>;
type TReplaceId<T> = TOmitId<T> & { _id?: string };
declare module 'express-session' {
interface SessionUser {
id?: string;
first_name?: string;
last_name?: string;
}
interface SessionData<T extends SubscriberStub> {
passport?: {
user?: SessionUser;
};
offline?: {
profile?: T;
isSocket: boolean;
messageQueue: any[];
polling: boolean;
};
}
interface Session {
csrfSecret?: string;
passport?: {
user?: SessionUser;
};
offline?: {
profile?: SubscriberStub;
isSocket: boolean;
messageQueue: any[];
polling: boolean;
};
}
}
declare module 'mongoose' {
// Enforce the typing with an alternative type to FilterQuery compatible with mongoose: version 8.0.0
type TFilterQuery<T, S = TReplaceId<T>> = (
| RecursivePartial<{
[P in keyof S]?:
| (S[P] extends string ? S[P] | RegExp : S[P])
| QuerySelector<S[P]>;
}>
| Partial<ObjectWithNestedKeys<S>>
) &
WithoutGenericAny<RootQuerySelector<S>>;
type THydratedDocument<T> = TOmitId<HydratedDocument<T>>;
}
2024-10-18 16:50:35 +00:00
declare global {
type HyphenToUnderscore<S extends string> = S extends `${infer P}-${infer Q}`
? `${P}_${HyphenToUnderscore<Q>}`
: S;
}