tonightpass 0.0.0 → 0.0.2

package/.turbo/turbo-build.log

@@ -1,17 +1,21 @@
-
-> tonightpass@0.0.0 build /Users/antoine/workspace/dev/javascript/tonightpass/tonightpass/packages/node
-> tsup
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.0.2
-CLI Using tsup config: /Users/antoine/workspace/dev/javascript/tonightpass/tonightpass/packages/node/tsup.config.ts
-CLI Target: esnext
-CLI Cleaning output folder
-CJS Build start
-CJS dist/index.js     1012.00 B
-CJS dist/index.js.map 210.00 B
-CJS ⚡️ Build success in 19ms
-DTS Build start
-DTS ⚡️ Build success in 6642ms
-DTS dist/index.d.ts 55.00 B
+
+> tonightpass@0.0.2 build /home/runner/work/tonightpass/tonightpass/packages/node
+> tsup
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.0.2
+CLI Using tsup config: /home/runner/work/tonightpass/tonightpass/packages/node/tsup.config.ts
+CLI Target: esnext
+CJS Build start
+ESM Build start
+CJS dist/index.js     7.27 KB
+CJS dist/index.js.map 24.96 KB
+CJS ⚡️ Build success in 227ms
+ESM dist/index.mjs     6.39 KB
+ESM dist/index.mjs.map 24.96 KB
+ESM ⚡️ Build success in 228ms
+DTS Build start
+DTS ⚡️ Build success in 2585ms
+DTS dist/index.d.ts  18.43 KB
+DTS dist/index.d.mts 18.43 KB

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# tonightpass
+
+## 0.0.2
+
+### Patch Changes
+
+- [`276f52e`](https://github.com/tonightpass/tonightpass/commit/276f52eb551e2dce6173c3331119a68780cea8d0) Thanks [@AntoineKM](https://github.com/AntoineKM)! - Add TonightPass exports
+
+## 0.0.1
+
+### Patch Changes
+
+- [#187](https://github.com/tonightpass/tonightpass/pull/187) [`3218ecc`](https://github.com/tonightpass/tonightpass/commit/3218ecc8bdfda8d5bc1ca3988d8eb56de39d9ccb) Thanks [@AntoineKM](https://github.com/AntoineKM)! - Add tonightpass

package/dist/index.d.mts

@@ -0,0 +1,615 @@
+import * as redaxios from 'redaxios';
+import { Options, Response } from 'redaxios';
+import { ParamValue } from 'pathcat';
+
+declare const DEFAULT_API_URL = "https://api.tonightpass.com";
+
+declare const EMAIL_REGEX: RegExp;
+declare const PASSWORD_REGEX: RegExp;
+declare const NAME_REGEX: RegExp;
+declare const SLUG_REGEX: RegExp;
+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;
+    description?: string;
+    price: number;
+    displayPrice: number;
+    quantity: number;
+    type: EventTicketType;
+    category: EventTicketCategory;
+    currency: Currency;
+    vatRate: number;
+    externalId?: string;
+    isVisible: boolean;
+    isFeesIncluded: boolean;
+    startAt: Date;
+    endAt: Date;
+    updatedAt: Date;
+    createdAt: Date;
+};
+type EventTicketType = "e-ticket" | "other";
+declare enum EventTicketCategory {
+    ENTRY = "entry",
+    PACKAGE = "package",
+    MEAL = "meal",
+    DRINK = "drink",
+    PARKING = "parking",
+    ACCOMMODATION = "accommodation",
+    CAMPING = "camping",
+    LOCKER = "locker",
+    SHUTTLE = "shuttle",
+    OTHER = "other"
+}
+
+type User = {
+    id: string;
+    identifier: UserIdentifier;
+    password: string;
+    identity: UserIdentity;
+    role: UserRole;
+    addresses: Location$1[];
+    preferences: UserPreferences;
+    connections: UserConnection[];
+    verified: boolean;
+    updatedAt: Date;
+    createdAt: Date;
+};
+type UserIdentifier = {
+    email?: string;
+    phoneNumber?: string;
+    username: string;
+    [key: string]: string | undefined;
+};
+type UserIdentity = Profile & {
+    firstName: string;
+    lastName: string;
+    fullName: string;
+    gender: UserIdentityGender;
+    birthDate: Date;
+    metadata: ProfileMetadata & {
+        followingCount: number;
+        hasPassPlus: boolean;
+        idValid: boolean;
+    };
+};
+declare enum UserRole {
+    USER = 0,
+    DEVELOPER = 8,
+    ADMINISTRATOR = 10
+}
+type UserIdentityGender = "male" | "female" | "non-binary" | "gender-fluid" | "neutral" | "other" | string;
+type UserPreferences = {
+    language: Language;
+    currency: Currency;
+    notifications: {
+        email: {
+            newsletter: boolean;
+            message: boolean;
+        };
+        push: {
+            message: boolean;
+        };
+    };
+};
+type UserConnection = {
+    ip: string;
+    os: UserConnectionOS;
+    device: UserConnectionDevice;
+    client: UserConnectionClient;
+    updatedAt: Date;
+    createdAt: Date;
+};
+type UserConnectionOS = {
+    name: string;
+    version: string;
+};
+type UserConnectionDevice = {
+    type: string;
+    brand: string;
+};
+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;
+    slug: string;
+    identity: OrganizationIdentity;
+    members: OrganizationMember[];
+    location?: Location$1;
+    events: Event[];
+    savedTickets: EventTicket[];
+    verified: boolean;
+    updatedAt: Date;
+    createdAt: Date;
+};
+type OrganizationIdentity = Profile & {
+    socialLinks: OrganizationSocialLink[];
+    metadata: ProfileMetadata & {
+        eventsCount: number;
+        viewsCount: number;
+        membersCount: number;
+    };
+};
+type OrganizationSocialLink = {
+    type: OrganizationSocialType;
+    url: string;
+};
+declare enum OrganizationSocialType {
+    Facebook = "facebook",
+    Twitter = "twitter",
+    Instagram = "instagram",
+    Linkedin = "linkedin",
+    Youtube = "youtube",
+    Website = "website"
+}
+type OrganizationMember = {
+    user: User;
+    role: OrganizationMemberRole;
+    createdAt: Date;
+};
+declare enum OrganizationMemberRole {
+    EMPLOYEE = 0,
+    MANAGER = 1,
+    ADMINISTRATOR = 2,
+    OWNER = 3
+}
+
+type Event = {
+    title: string;
+    description: string;
+    slug: string;
+    organization: Organization;
+    type: EventType;
+    public: boolean;
+    flyers: string[];
+    trailers: string[];
+    location: Location$1;
+    tickets: EventTicket[];
+    styles: EventStyle[];
+    startAt: Date;
+    endAt: Date;
+    updatedAt: Date;
+    createdAt: Date;
+};
+declare enum EventType {
+    Clubbing = "clubbing",
+    Concert = "concert",
+    Afterwork = "afterwork",
+    DancingLunch = "dancing_lunch",
+    Diner = "diner",
+    Garden = "garden",
+    AfterBeach = "after_beach",
+    Festival = "festival",
+    Spectacle = "spectacle",
+    Cruise = "cruise",
+    OutsideAnimation = "outside_animation",
+    Sport = "sport",
+    Match = "match",
+    Seminar = "seminar",
+    Conference = "conference",
+    WellnessDay = "wellness_day",
+    Workshop = "workshop",
+    TradeFair = "trade_fair",
+    ConsumerShow = "consumer_show",
+    Membership = "membership"
+}
+type EventStyle = {
+    type: EventStyleType;
+    emoji: string;
+    name: string;
+};
+declare enum EventStyleType {
+    Music = "music",
+    Dress = "dress",
+    Sport = "sport",
+    Food = "food",
+    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;
+    value: string;
+    createdAt: Date;
+    expiresAt: Date;
+};
+declare enum UserTokenType {
+    Authentication = "authentication",
+    OrganizationInvite = "organization_invite",
+    PasswordRecovery = "password_recovery",
+    EmailValidation = "email_validation",
+    PhoneValidation = "phone_validation"
+}
+
+declare enum OrderStatus {
+    Created = "created",
+    Cancelled = "cancelled",
+    Completed = "completed",
+    Pending = "pending",
+    Confirmed = "confirmed",
+    Declined = "declined",
+    Refunded = "refunded",
+    PartiallyRefunded = "partially_refunded",
+    Expired = "expired"
+}
+type OrderItem = {
+    id: string;
+    ticket: EventTicket;
+    isUsed: boolean;
+    updatedAt: Date;
+    createdAt: Date;
+};
+type Order = {
+    id: string;
+    owner: User;
+    members: User[];
+    status: OrderStatus;
+    event: Event;
+    items: OrderItem[];
+    promoCode?: PromoCode;
+    total: number;
+    currency: Currency;
+    createdAt: Date;
+};
+type PromoCode = {
+    id: string;
+    code: string;
+    used: number;
+    discount: number;
+    isActive: boolean;
+    expirationAt: Date;
+    createdAt: Date;
+};
+
+interface Profile {
+    type: "user" | "organization";
+    displayName: string;
+    description: string;
+    profilePictureUrl?: string;
+    bannerUrl?: string;
+    metadata: ProfileMetadata;
+    createdAt: Date;
+}
+interface ProfileMetadata {
+    followersCount: number;
+    isBlocked: boolean;
+    hasBlocked: boolean;
+    canDM: boolean;
+}
+type ProfileEndpoints = Endpoint<"GET", "/profiles/:username", UserIdentity>;
+
+type Location$1 = {
+    name?: string;
+    address: string;
+    zipCode: string;
+    city: string;
+    country: string;
+    geometry?: {
+        latitude: number;
+        longitude: number;
+    };
+};
+declare enum Currency {
+    EUR = "EUR",
+    USD = "USD",
+    GBP = "GBP"
+}
+declare enum Language {
+    FR = "fr",
+    EN = "en"
+}
+
+declare class CreateUserDto {
+    identifier: UserIdentifier;
+    password: string;
+    identity: CreateUserIdentituDto;
+    addresses: Location[];
+}
+declare class CreateUserIdentituDto {
+    firstName: string;
+    lastName: string;
+    gender: UserIdentityGender;
+    profilePictureUrl?: string;
+    birthDate: Date;
+}
+
+declare class SignInUserDto {
+    identifier: string;
+    password: string;
+}
+
+declare class UpdateUserDto {
+    identifier?: UpdateIdentifierDto;
+    identity?: UpdateIdentityDto;
+    password?: string;
+}
+declare class UpdateIdentifierDto implements Partial<Pick<UserIdentifier, "email" | "phoneNumber" | "username">> {
+    email?: string;
+    phoneNumber?: string;
+    username?: string;
+}
+declare class UpdateIdentityDto implements Partial<Pick<UserIdentity, "firstName" | "lastName" | "displayName" | "description" | "profilePictureUrl" | "bannerUrl" | "gender" | "birthDate">> {
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    description?: string;
+    profilePictureUrl?: string | undefined;
+    bannerUrl?: string | undefined;
+    gender?: string;
+    birthDate?: Date;
+}
+
+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;
+}
+declare class Client {
+    private options;
+    readonly url: (path: string, params: Record<string, ParamValue>) => string;
+    constructor(options: ClientOptions);
+    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: Client) => {
+    database: () => Promise<Health<"database">>;
+    http: () => Promise<Health<"app">>;
+};
+
+declare const users: (client: Client) => {
+    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>;
+};
+
+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 };