@secrecy/lib 1.0.0-dev.27 → 1.0.0-dev.28

package/dist/BaseClient.d.ts

@@ -0,0 +1,274 @@
+import type { DownloadProgress as DLProgress } from "ky";
+import type { Document } from "bson";
+import type { UserSession } from "./client/types/index.js";
+import type { SecrecyEnv } from "./client/helpers.js";
+import type { Lang, PayInputType, PlanKind, Thunder, UserRole } from "./zeus/index.js";
+import type { ErrorAccessDenied, ErrorLimit, ErrorNotFound, ErrorNotExist, ErrorLangNotExist, ErrorBasic } from "./error.js";
+export declare type SuccessResponse<T> = {
+    __typename: "SuccessResponse";
+    data: T;
+};
+export declare type DownloadProgress = DLProgress;
+export declare type PayInput = {
+    type: PayInputType;
+    token: string;
+    firstName: string;
+    lastName: string;
+    street: string;
+    postalCode: string;
+    city: string;
+    country: string;
+    month: string;
+    year: string;
+    cvv: string;
+    number: string;
+};
+export declare type MailLimits = {
+    count?: string | undefined;
+    fileCount?: string | undefined;
+    fileSize?: string | undefined;
+    hardCount?: string | undefined;
+    hardFileCount?: string | undefined;
+    hardFileSize?: string | undefined;
+    perFileSize?: string | undefined;
+};
+export declare type Limits = {
+    downloadBandwidth?: string | undefined;
+    downloadCount?: string | undefined;
+    hardFileCount?: string | undefined;
+    hardFileSize?: string | undefined;
+    perFileSize?: string | undefined;
+    receivedMails: MailLimits;
+    sentMails: MailLimits;
+    uploadBandwidth?: string | undefined;
+    uploadCount?: string | undefined;
+};
+export declare type GodUser = {
+    id: string;
+    firstname: string;
+    lastname: string;
+    email: string;
+    phone: string;
+};
+export declare type GodFatherAndChildren = {
+    godFather: GodUser | null;
+    godChildren: GodUser[];
+};
+export declare type Plan = {
+    codes: string[];
+    kind: PlanKind;
+    limits: Limits;
+};
+export declare type SubscriptionState = "active" | "canceled" | "paused" | "expired" | "future" | "in_trial" | "live" | "past_due";
+export declare type SubscriptionCollectionMethod = "automatic" | "manual";
+declare type RecurlyInvoiceStatus = "pending" | "paid" | "failed" | "past_due" | "open" | "closed" | "voided" | "processing";
+export declare type Subscription = {
+    autorenew: boolean;
+    activatedAt?: Date | null | undefined;
+    currentPeriodEndsAt?: Date | null | undefined;
+    currentPeriodStartedAt?: Date | null | undefined;
+    canceledAt?: Date | null | undefined;
+    createdAt?: Date | null | undefined;
+    expiresAt?: Date | null | undefined;
+    pausedAt?: Date | null | undefined;
+    trialEndsAt?: Date | null | undefined;
+    trialStartedAt?: Date | null | undefined;
+    updatedAt?: Date | null | undefined;
+    collectionMethod: SubscriptionCollectionMethod;
+    state: SubscriptionState;
+    plan?: string | null | undefined;
+    planCode?: string | null | undefined;
+    total?: number | null | undefined;
+};
+export declare type RecurlyInvoices = {
+    pdf: string;
+    date: Date;
+    due: Date;
+    status: RecurlyInvoiceStatus;
+    total: number;
+    name: string;
+    currency: string;
+};
+export declare type PaymentInfos = {
+    hostedUrl: string;
+    currentSubscription: Subscription;
+    invoices: RecurlyInvoices[];
+};
+export declare type SendReport = {
+    id: string;
+    user: {
+        id: string;
+        firstname: string;
+        lastname: string;
+        email: string;
+    };
+    reportedUser: {
+        id: string;
+        firstname: string;
+        lastname: string;
+        email: string;
+    };
+    customMessage?: string | undefined;
+};
+declare const plansCodes: readonly ["basic_month", "advanced_month", "pro_month", "basic_year", "advanced_year", "pro_year"];
+export declare type SecrecyPlansCodes = typeof plansCodes[number];
+export declare function isValidPlan(planCode: string): planCode is SecrecyPlansCodes;
+export declare type UserData<T extends Record<string, unknown> = Record<string, unknown>> = {
+    isSuperuser: boolean;
+    isSearchable: boolean;
+} & T;
+export declare type FolderSize = {
+    size: bigint;
+    sizeBefore: bigint;
+};
+export declare type AppDBConfigField = {
+    name: string;
+    type: "string" | "number" | "boolean" | "object";
+    isArray?: boolean | undefined;
+    isNullable?: boolean | undefined;
+    isEditable?: boolean | undefined;
+    isKey?: boolean | undefined;
+    default?: unknown;
+};
+export declare type AppDBConfig = {
+    fields: AppDBConfigField[];
+};
+export declare type FaqItem = {
+    order: number;
+    question: string;
+    answer: string;
+};
+export declare type BlogItem = {
+    id: string;
+    blogId: string;
+    order: number;
+    author: string;
+    body: string;
+    date: Date;
+    image: string;
+    imageAlt: string;
+    summary: string;
+    title: string;
+};
+export declare type UserBase = {
+    email: string;
+    phone: string;
+    lastname: string;
+    role: UserRole;
+    firstname: string;
+    id: string;
+    deletedAt: Date | null;
+    lastLogin: Date;
+    lang: Lang;
+};
+declare type WithPublicKey = {
+    withPublicKey?: boolean;
+};
+export declare type User<T extends WithPublicKey = WithPublicKey> = T extends {
+    withPublicKey: true;
+} ? UserBase & {
+    publicKey: string;
+} : UserBase;
+declare type ClassGetUserParams = WithPublicKey & {
+    userId?: string;
+};
+declare type StaticGetUserParams = ClassGetUserParams & {
+    env: SecrecyEnv;
+};
+export declare type CloudLimits = {
+    count: bigint;
+    maxCount: bigint | null;
+    size: bigint;
+    maxSize: bigint | null;
+};
+export declare type MailLimitsValues = {
+    count: bigint;
+    maxCount: bigint | null;
+    fileSize: bigint;
+    maxFileSize: bigint | null;
+    fileCount: bigint;
+    maxFileCount: bigint | null;
+};
+export declare type QueryLimits = {
+    cloud: CloudLimits;
+    mail: {
+        sent: MailLimitsValues;
+        received: MailLimitsValues;
+    };
+};
+export declare class BaseClient {
+    static readonly getBaseUrl: (env?: SecrecyEnv, graphcdn?: boolean) => string;
+    private static readonly _getBaseClient;
+    protected client: ReturnType<typeof Thunder>;
+    sessionId: string;
+    constructor(session: string, env: SecrecyEnv);
+    sessions(): Promise<SuccessResponse<UserSession[]> | ErrorNotFound | null>;
+    logout(sessionId?: string | null | undefined): Promise<void>;
+    me<T extends WithPublicKey = WithPublicKey>(params?: T): Promise<SuccessResponse<User<T>> | ErrorNotFound | null>;
+    static user<T extends StaticGetUserParams>(params: T, sessionId?: string | null | undefined): Promise<SuccessResponse<User<T>> | ErrorNotFound | null>;
+    user<T extends ClassGetUserParams>(params: T): Promise<SuccessResponse<User<T>> | ErrorNotFound | null>;
+    updateProfile({ firstname, lastname, lang }: {
+        firstname: string | null;
+        lastname: string | null;
+        lang: Lang | null;
+    }): Promise<SuccessResponse<User> | ErrorNotFound | ErrorAccessDenied | null>;
+    static plans(env: SecrecyEnv, sessionId?: string | null | undefined): Promise<SuccessResponse<Plan[]> | null>;
+    pay(planCode: SecrecyPlansCodes, input: PayInput, autoRenew?: boolean | null | undefined): Promise<SuccessResponse<boolean> | ErrorAccessDenied | null>;
+    cancelPayment(): Promise<SuccessResponse<boolean> | ErrorAccessDenied | null>;
+    paymentInfos(): Promise<SuccessResponse<PaymentInfos> | ErrorAccessDenied | null>;
+    limits(): Promise<SuccessResponse<QueryLimits> | ErrorAccessDenied | ErrorNotExist | ErrorLimit | ErrorNotFound | null>;
+    godFatherAndChildren(): Promise<SuccessResponse<GodFatherAndChildren> | ErrorNotFound | null>;
+    static updateAppDBConfig({ appCode, config, env, sessionId }: {
+        appCode: string;
+        config: AppDBConfig;
+        env: SecrecyEnv;
+        sessionId?: string | null | undefined;
+    }): Promise<SuccessResponse<AppDBConfig> | ErrorAccessDenied | null>;
+    static getAppDBConfig(appCode: string, env: SecrecyEnv, sessionId?: string | null | undefined): Promise<SuccessResponse<AppDBConfig> | ErrorAccessDenied | ErrorNotFound | ErrorNotExist | null>;
+    static getFAQ({ lang, env, sessionId }: {
+        lang?: Lang;
+        env: SecrecyEnv;
+        sessionId?: string | null | undefined;
+    }): Promise<SuccessResponse<FaqItem[]> | ErrorAccessDenied | null>;
+    static getBlog({ env, lang, sessionId }: {
+        env: SecrecyEnv;
+        lang?: Lang | null | undefined;
+        sessionId?: string | null | undefined;
+    }): Promise<SuccessResponse<BlogItem[]> | ErrorLangNotExist | null>;
+    reportUser(reportedUserId: string, customMessage?: string): Promise<SuccessResponse<SendReport> | ErrorAccessDenied | ErrorNotFound | null>;
+    static deleteUser({ sessionId, userId, env }: {
+        sessionId: string;
+        userId?: string;
+        env: SecrecyEnv;
+    }): Promise<SuccessResponse<boolean> | ErrorAccessDenied | null>;
+    dbGet<U>({ field, userId }: {
+        field: string;
+        userId?: string | null | undefined;
+    }): Promise<SuccessResponse<U> | ErrorAccessDenied | ErrorNotExist | ErrorNotFound | null>;
+    dbSet<T extends UserData, U extends Document>({ value, userId }: {
+        value: U;
+        userId?: string | null | undefined;
+    }): Promise<SuccessResponse<T> | ErrorAccessDenied | ErrorNotFound | null>;
+    dbSearch<T>({ search, field }: {
+        field: string;
+        search: string;
+    }): Promise<SuccessResponse<T[]> | ErrorAccessDenied | ErrorBasic | ErrorNotExist | null>;
+    deleteFolder({ id }: {
+        id: string;
+    }): Promise<SuccessResponse<boolean> | ErrorNotExist | ErrorAccessDenied | null>;
+    moveFolders({ foldersId, parentFolderId }: {
+        foldersId: string[];
+        parentFolderId?: string | null | undefined;
+    }): Promise<SuccessResponse<boolean> | ErrorAccessDenied | null>;
+    moveFiles({ filesId, parentFolderId }: {
+        filesId: string[];
+        parentFolderId?: string | null | undefined;
+    }): Promise<SuccessResponse<boolean> | ErrorAccessDenied | null>;
+    folderSize({ folderId }: {
+        folderId?: string | null | undefined;
+    }): Promise<SuccessResponse<FolderSize> | ErrorAccessDenied | null>;
+    getSponsorshipLink({ backUrl }: {
+        backUrl: string;
+    }): Promise<string | null>;
+}
+export {};