tonightpass 0.0.0 → 0.0.2

package/dist/index.d.ts

@@ -1,7 +1,8 @@
-import { Options } from 'redaxios';
-import * as src from 'src';
+import * as redaxios from 'redaxios';
+import { Options, Response } from 'redaxios';
 import { ParamValue } from 'pathcat';
-import * as _tonightpass_shared_types from '@tonightpass/shared-types';
+
+declare const DEFAULT_API_URL = "https://api.tonightpass.com";
 
 declare const EMAIL_REGEX: RegExp;
 declare const PASSWORD_REGEX: RegExp;
@@ -11,6 +12,85 @@ declare const BCRYPT_HASH: RegExp;
 declare const PHONE_NUMBER_REGEX: RegExp;
 declare const IMAGE_URL_REGEX: RegExp;
 
+type SuccessfulAPIResponse<T> = {
+    success: true;
+    data: T;
+};
+type ErroredAPIResponse = {
+    success: false;
+    message: string;
+    errors?: {
+        [key: string]: string;
+    };
+};
+type APIResponse<T> = SuccessfulAPIResponse<T> | ErroredAPIResponse;
+type Endpoint<M extends Options["method"], Path extends string, Res, Body = undefined> = {
+    method: M;
+    path: Path;
+    res: Res;
+    body: Body;
+};
+type Endpoints = CareersEndpoints | HealthEndpoints | ProfileEndpoints | UserEndpoints;
+
+type CareersOffice = {
+    id: number | null;
+    isDefault: boolean | null;
+    name: string | null;
+    city: string | null;
+    countryIso: string | null;
+};
+type CareersJob = {
+    id: number;
+    createdAt: string;
+    lastUpdatedAt: string;
+    externalId: null | string;
+    title: string;
+    status: "ALL" | "ONLINE" | "ARCHIVED";
+    remote: boolean;
+    office: CareersOffice;
+    workplaceType: string;
+    remoteType?: string;
+    description?: string;
+    categoryId?: number;
+    employmentTypeId?: number;
+};
+type CareersCategory = {
+    slug: string;
+    name: string;
+    subCategories?: (CareersCategory & {
+        id: number;
+    })[];
+};
+type CareersEmploymentType = {
+    id: number;
+    name: string;
+    slug: string;
+};
+type CareersEndpoints = Endpoint<"GET", "/careers/categories", CareersCategory[], {
+    language?: string;
+}> | Endpoint<"GET", "/careers/employmentTypes", CareersEmploymentType[], {
+    language?: string;
+}> | Endpoint<"GET", "/careers/jobs", CareersJob[], {
+    page?: number;
+    pageSize?: number;
+    createdAtGte: string;
+    createdAtLt?: string;
+    updatedAtGte?: string;
+    updatedAtLt?: string;
+    status?: "ALL" | "ONLINE" | "ARCHIVED";
+    content?: boolean;
+    titleLike?: string;
+    countryCode?: string;
+    externalId?: string;
+}> | Endpoint<"GET", "/careers/jobs/:id", CareersJob, {
+    id: number;
+}> | Endpoint<"GET", "/careers/offices", CareersOffice[], {
+    page?: number;
+    pageSize?: number;
+    countryCode?: string;
+    cityNameLike?: string;
+}>;
+
 type EventTicket = {
     id: string;
     name: string;
@@ -114,6 +194,11 @@ type UserConnectionClient = {
     name: string;
     version: string;
 };
+type UserEndpoints = Endpoint<"GET", "/users", User[]> | Endpoint<"GET", "/users/:id", User, {
+    id: string;
+}> | Endpoint<"GET", "/users/me", User> | Endpoint<"GET", "/check/:identifier", UserIdentifier, {
+    identifier: string;
+}> | Endpoint<"PUT", "/users/:id", User, UpdateUserDto>;
 
 type Organization = {
     id: string;
@@ -211,6 +296,19 @@ declare enum EventStyleType {
     Art = "art"
 }
 
+type Health<Key extends string> = {
+    status: string;
+    details: {
+        [key in Key]: {
+            status: string;
+            details: {
+                status: string;
+            };
+        };
+    };
+};
+type HealthEndpoints = Endpoint<"GET", "/health/database", Health<"database">> | Endpoint<"GET", "/health/http", Health<"app">>;
+
 type UserToken = {
     id: string;
     type: UserTokenType;
@@ -281,20 +379,7 @@ interface ProfileMetadata {
     hasBlocked: boolean;
     canDM: boolean;
 }
-
-type APIResponse<TData = any> = ({
-    success: true;
-    data: TData;
-} | APIError) & {
-    statusCode: number;
-};
-type APIError = {
-    success: false;
-    message: string;
-    errors?: {
-        [key: string]: string;
-    };
-};
+type ProfileEndpoints = Endpoint<"GET", "/profiles/:username", UserIdentity>;
 
 type Location$1 = {
     name?: string;
@@ -357,53 +442,174 @@ declare class UpdateIdentityDto implements Partial<Pick<UserIdentity, "firstName
     birthDate?: Date;
 }
 
-type ApiRequestConfig = Exclude<Options, "method">;
-declare const request: <TData>(url: string, options?: ApiRequestConfig) => Promise<APIResponse<TData>>;
-
-type BaseRequest = <TData>(url: string, options?: ApiRequestConfig) => Promise<APIResponse<TData>>;
-type RequestResponse = {
-    get: BaseRequest;
-    post: BaseRequest;
-    put: BaseRequest;
-    delete: BaseRequest;
-};
-declare const requester: (auth?: boolean) => RequestResponse;
+interface APIRequestOptions extends Options {
+}
+declare const request: <T>(url: string, options?: Options) => Promise<redaxios.Response<APIResponse<T>>>;
 
+type ExtractRouteParams<T extends string> = string extends T ? Record<string, string | number | undefined> : T extends `${string}:${infer Param}/${infer Rest}` ? {
+    [k in Param | keyof ExtractRouteParams<Rest>]: string | number;
+} : T extends `${string}:${infer Param}` ? {
+    [k in Param]: string | number;
+} : object;
+type ExtractEndpoint<Method extends string, Path extends string> = Extract<Endpoints, {
+    path: Path;
+    method: Method;
+}>;
+type PathsFor<M extends Options["method"]> = Extract<Endpoints, {
+    method: M;
+}>["path"];
+type Query<Path extends string> = ExtractRouteParams<Path> & Record<string, string | number | undefined>;
+declare class TonightPassAPIError<T> extends Error {
+    readonly response: Response<APIResponse<T>>;
+    readonly data: ErroredAPIResponse;
+    readonly status: number;
+    constructor(response: Response<APIResponse<T>>, data: ErroredAPIResponse);
+}
 interface ClientOptions {
-    readonly baseUrl: string;
+    readonly baseURL: string;
 }
 declare class Client {
-    private readonly options;
+    private options;
     readonly url: (path: string, params: Record<string, ParamValue>) => string;
-    private request;
     constructor(options: ClientOptions);
-    get<T>(url: string, options?: ApiRequestConfig): Promise<src.APIResponse<T>>;
-    post<T>(url: string, options?: ApiRequestConfig): Promise<src.APIResponse<T>>;
-    put<T>(url: string, options?: ApiRequestConfig): Promise<src.APIResponse<T>>;
-    delete<T>(url: string, options?: ApiRequestConfig): Promise<src.APIResponse<T>>;
+    setOptions(options: ClientOptions): void;
+    get<Path extends PathsFor<"GET">>(path: Path, query?: Query<Path>, options?: APIRequestOptions): Promise<(Extract<Endpoint<"GET", "/careers/categories", CareersCategory[], {
+        language?: string | undefined;
+    }>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/careers/employmentTypes", CareersEmploymentType[], {
+        language?: string | undefined;
+    }>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/careers/jobs", CareersJob[], {
+        page?: number | undefined;
+        pageSize?: number | undefined;
+        createdAtGte: string;
+        createdAtLt?: string | undefined;
+        updatedAtGte?: string | undefined;
+        updatedAtLt?: string | undefined;
+        status?: "ALL" | "ONLINE" | "ARCHIVED" | undefined;
+        content?: boolean | undefined;
+        titleLike?: string | undefined;
+        countryCode?: string | undefined;
+        externalId?: string | undefined;
+    }>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/careers/jobs/:id", CareersJob, {
+        id: number;
+    }>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/careers/offices", CareersOffice[], {
+        page?: number | undefined;
+        pageSize?: number | undefined;
+        countryCode?: string | undefined;
+        cityNameLike?: string | undefined;
+    }>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/health/database", Health<"database">>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/health/http", Health<"app">>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<ProfileEndpoints, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/users", User[]>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/users/:id", User, {
+        id: string;
+    }>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/users/me", User>, {
+        path: Path;
+        method: "GET";
+    }> | Extract<Endpoint<"GET", "/check/:identifier", UserIdentifier, {
+        identifier: string;
+    }>, {
+        path: Path;
+        method: "GET";
+    }>)["res"]>;
+    post<Path extends Extract<Endpoints, {
+        method: "POST";
+    }>["path"]>(path: Path, body: Extract<Endpoints, {
+        path: Path;
+        method: "POST";
+    }>["body"], query?: Query<Path>, options?: APIRequestOptions): Promise<never>;
+    put<Path extends Extract<Endpoints, {
+        method: "PUT";
+    }>["path"]>(path: Path, body: Extract<Endpoints, {
+        path: Path;
+        method: "PUT";
+    }>["body"], query?: Query<Path>, options?: APIRequestOptions): Promise<Extract<Endpoint<"PUT", "/users/:id", User, UpdateUserDto>, {
+        path: Path;
+        method: "PUT";
+    }>["res"]>;
+    patch<Path extends Extract<Endpoints, {
+        method: "PATCH";
+    }>["path"]>(path: Path, body: Extract<Endpoints, {
+        path: Path;
+        method: "PATCH";
+    }>["body"], query?: Query<Path>, options?: APIRequestOptions): Promise<never>;
+    delete<Path extends Extract<Endpoints, {
+        method: "DELETE";
+    }>["path"]>(path: Path, query?: Query<Path>, options?: APIRequestOptions): Promise<never>;
+    private requester;
 }
 
 declare function sdk<T>(builder: (client: Client) => T): (client: Client) => T;
 
-declare const health: (client: src.Client) => {
-    http: () => Promise<_tonightpass_shared_types.APIResponse<{
-        status: string;
-        details: {
-            app: {
-                status: string;
-                details: {
-                    status: string;
-                };
-            };
-        };
-    }>>;
+declare const health: (client: Client) => {
+    database: () => Promise<Health<"database">>;
+    http: () => Promise<Health<"app">>;
 };
 
 declare const users: (client: Client) => {
-    me: {
-        get: () => Promise<_tonightpass_shared_types.APIResponse<User>>;
-        update: (data: UpdateUserDto) => Promise<_tonightpass_shared_types.APIResponse<User>>;
-    };
+    getAll: () => Promise<User[]>;
+    get: (id: string) => Promise<CareersCategory[] | CareersEmploymentType[] | CareersJob[] | CareersJob | CareersOffice[] | Health<"database"> | Health<"app"> | UserIdentity | User[] | User | UserIdentifier>;
+    me: () => Promise<User>;
+    check: (identifier: string) => Promise<CareersCategory[] | CareersEmploymentType[] | CareersJob[] | CareersJob | CareersOffice[] | Health<"database"> | Health<"app"> | UserIdentity | User[] | User | UserIdentifier>;
+    update: (id: string, data: UpdateUserDto) => Promise<User>;
 };
 
-export { type APIError, type APIResponse, type ApiRequestConfig, BCRYPT_HASH, Client, type ClientOptions, CreateUserDto, Currency, EMAIL_REGEX, type Event, type EventStyle, EventStyleType, type EventTicket, EventTicketCategory, type EventTicketType, EventType, IMAGE_URL_REGEX, Language, type Location$1 as Location, NAME_REGEX, type Order, type OrderItem, OrderStatus, type Organization, type OrganizationIdentity, type OrganizationMember, OrganizationMemberRole, type OrganizationSocialLink, OrganizationSocialType, PASSWORD_REGEX, PHONE_NUMBER_REGEX, type Profile, type ProfileMetadata, type PromoCode, SLUG_REGEX, SignInUserDto, UpdateUserDto, type User, type UserConnection, type UserConnectionClient, type UserConnectionDevice, type UserConnectionOS, type UserIdentifier, type UserIdentity, type UserIdentityGender, type UserPreferences, UserRole, type UserToken, UserTokenType, health, request, requester, sdk, users };
+declare class TonightPass {
+    readonly client: Client;
+    readonly careers: {
+        categories: {
+            getAll: (query?: Query<"/careers/categories"> | undefined) => Promise<CareersCategory[]>;
+        };
+        employmentTypes: {
+            getAll: (query?: Query<"/careers/employmentTypes"> | undefined) => Promise<CareersEmploymentType[]>;
+        };
+        jobs: {
+            getAll: (query?: Query<"/careers/jobs"> | undefined) => Promise<CareersJob[]>;
+            get: (id: number) => Promise<CareersJob>;
+        };
+        offices: {
+            getAll: (query?: Query<"/careers/offices"> | undefined) => Promise<CareersOffice[]>;
+        };
+    };
+    readonly health: {
+        database: () => Promise<Health<"database">>;
+        http: () => Promise<Health<"app">>;
+    };
+    readonly users: {
+        getAll: () => Promise<User[]>;
+        get: (id: string) => Promise<CareersCategory[] | CareersEmploymentType[] | CareersJob[] | CareersJob | CareersOffice[] | Health<"database"> | Health<"app"> | UserIdentity | User[] | User | UserIdentifier>;
+        me: () => Promise<User>;
+        check: (identifier: string) => Promise<CareersCategory[] | CareersEmploymentType[] | CareersJob[] | CareersJob | CareersOffice[] | Health<"database"> | Health<"app"> | UserIdentity | User[] | User | UserIdentifier>;
+        update: (id: string, data: UpdateUserDto) => Promise<User>;
+    };
+    constructor(options: ClientOptions);
+}
+
+declare const isBrowser: boolean;
+
+export { type APIRequestOptions, type APIResponse, BCRYPT_HASH, type CareersCategory, type CareersEmploymentType, type CareersEndpoints, type CareersJob, type CareersOffice, Client, type ClientOptions, CreateUserDto, Currency, DEFAULT_API_URL, EMAIL_REGEX, type Endpoint, type Endpoints, type ErroredAPIResponse, type Event, type EventStyle, EventStyleType, type EventTicket, EventTicketCategory, type EventTicketType, EventType, type ExtractEndpoint, type ExtractRouteParams, type Health, type HealthEndpoints, IMAGE_URL_REGEX, Language, type Location$1 as Location, NAME_REGEX, type Order, type OrderItem, OrderStatus, type Organization, type OrganizationIdentity, type OrganizationMember, OrganizationMemberRole, type OrganizationSocialLink, OrganizationSocialType, PASSWORD_REGEX, PHONE_NUMBER_REGEX, type PathsFor, type Profile, type ProfileEndpoints, type ProfileMetadata, type PromoCode, type Query, SLUG_REGEX, SignInUserDto, type SuccessfulAPIResponse, TonightPass, TonightPassAPIError, UpdateUserDto, type User, type UserConnection, type UserConnectionClient, type UserConnectionDevice, type UserConnectionOS, type UserEndpoints, type UserIdentifier, type UserIdentity, type UserIdentityGender, type UserPreferences, UserRole, type UserToken, UserTokenType, health, isBrowser, request, sdk, users };