tonightpass 0.0.0 → 0.0.2

package/src/rest/endpoints.ts

@@ -0,0 +1,41 @@
+import { Options } from "redaxios";
+
+import {
+  CareersEndpoints,
+  HealthEndpoints,
+  ProfileEndpoints,
+  UserEndpoints,
+} from "./types";
+
+export type SuccessfulAPIResponse<T> = {
+  success: true;
+  data: T;
+};
+
+export type ErroredAPIResponse = {
+  success: false;
+  message: string;
+  errors?: {
+    [key: string]: string;
+  };
+};
+
+export type APIResponse<T> = SuccessfulAPIResponse<T> | ErroredAPIResponse;
+
+export type Endpoint<
+  M extends Options["method"],
+  Path extends string,
+  Res,
+  Body = undefined,
+> = {
+  method: M;
+  path: Path;
+  res: Res;
+  body: Body;
+};
+
+export type Endpoints =
+  | CareersEndpoints
+  | HealthEndpoints
+  | ProfileEndpoints
+  | UserEndpoints;

package/src/rest/index.ts

@@ -0,0 +1,5 @@
+export * from "./dtos";
+export * from "./request";
+export * from "./types";
+export * from "./client";
+export * from "./endpoints";

package/src/rest/request/index.ts

@@ -0,0 +1 @@
+export * from "./request";

package/src/rest/request/request.ts

@@ -0,0 +1,30 @@
+import axios, { Options } from "redaxios";
+
+import { isBrowser } from "../../utils";
+import { APIResponse } from "../endpoints";
+
+const instance = axios.create({
+  headers: {
+    "Content-Type": "application/json",
+    Accept: "application/json",
+    ...(!isBrowser && { "User-Agent": "tonightpass-api-client" }),
+  },
+  responseType: "json",
+  transformRequest: [
+    function (data) {
+      return JSON.stringify(data);
+    },
+  ],
+});
+
+export interface APIRequestOptions extends Options {}
+
+export const request = async <T>(url: string, options?: Options) => {
+  const response = instance<APIResponse<T>>(url, { ...options })
+    .then((response) => response)
+    .catch((error: Error) => {
+      throw error;
+    });
+
+  return response;
+};

package/src/rest/types/careers/index.ts

@@ -0,0 +1,87 @@
+import { Endpoint } from "../../endpoints";
+
+export type CareersOffice = {
+  id: number | null;
+  isDefault: boolean | null;
+  name: string | null;
+  city: string | null;
+  countryIso: string | null;
+};
+
+export 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;
+};
+
+export type CareersCategory = {
+  slug: string;
+  name: string;
+  subCategories?: (CareersCategory & {
+    id: number;
+  })[];
+};
+
+export type CareersEmploymentType = {
+  id: number;
+  name: string;
+  slug: string;
+};
+
+export 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;
+      }
+    >;

package/src/rest/types/event/index.ts

@@ -0,0 +1,60 @@
+import { EventTicket } from "./ticket";
+import { Location } from "..";
+import { Organization } from "../organizations";
+
+export * from "./ticket";
+
+export type Event = {
+  title: string;
+  description: string;
+  slug: string;
+  organization: Organization;
+  type: EventType;
+  public: boolean;
+  flyers: string[];
+  trailers: string[];
+  location: Location;
+  tickets: EventTicket[];
+  styles: EventStyle[];
+  startAt: Date;
+  endAt: Date;
+  updatedAt: Date;
+  createdAt: Date;
+};
+
+export 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",
+}
+
+export type EventStyle = {
+  type: EventStyleType;
+  emoji: string;
+  name: string;
+};
+
+export enum EventStyleType {
+  Music = "music",
+  Dress = "dress",
+  Sport = "sport",
+  Food = "food",
+  Art = "art",
+}

package/src/rest/types/event/ticket/index.ts

@@ -0,0 +1,36 @@
+import { Currency } from "../..";
+
+export 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;
+};
+
+export type EventTicketType = "e-ticket" | "other";
+
+export enum EventTicketCategory {
+  ENTRY = "entry",
+  PACKAGE = "package",
+  MEAL = "meal",
+  DRINK = "drink",
+  PARKING = "parking",
+  ACCOMMODATION = "accommodation",
+  CAMPING = "camping",
+  LOCKER = "locker",
+  SHUTTLE = "shuttle",
+  OTHER = "other",
+}

package/src/rest/types/health/index.ts

@@ -0,0 +1,17 @@
+import { Endpoint } from "../../endpoints";
+
+export type Health<Key extends string> = {
+  status: string;
+  details: {
+    [key in Key]: {
+      status: string;
+      details: {
+        status: string;
+      };
+    };
+  };
+};
+
+export type HealthEndpoints =
+  | Endpoint<"GET", "/health/database", Health<"database">>
+  | Endpoint<"GET", "/health/http", Health<"app">>;

package/src/rest/types/index.ts

@@ -0,0 +1,33 @@
+export * from "./careers";
+export * from "./event";
+export * from "./health";
+export * from "./organizations";
+export * from "./token";
+export * from "./users";
+export * from "./order";
+export * from "./profiles";
+
+export type Location = {
+  name?: string;
+  address: string;
+  zipCode: string;
+  city: string;
+  country: string;
+  geometry?: {
+    latitude: number;
+    longitude: number;
+  };
+};
+
+// Currency
+export enum Currency {
+  EUR = "EUR",
+  USD = "USD",
+  GBP = "GBP",
+}
+
+// I18n
+export enum Language {
+  FR = "fr",
+  EN = "en",
+}

package/src/rest/types/order/index.ts

@@ -0,0 +1,46 @@
+import { Currency } from "..";
+import { Event, EventTicket } from "../event";
+import { User } from "../users";
+
+export enum OrderStatus {
+  Created = "created",
+  Cancelled = "cancelled",
+  Completed = "completed",
+  Pending = "pending",
+  Confirmed = "confirmed",
+  Declined = "declined",
+  Refunded = "refunded",
+  PartiallyRefunded = "partially_refunded",
+  Expired = "expired",
+}
+
+export type OrderItem = {
+  id: string;
+  ticket: EventTicket;
+  isUsed: boolean;
+  updatedAt: Date;
+  createdAt: Date;
+};
+
+export type Order = {
+  id: string;
+  owner: User;
+  members: User[];
+  status: OrderStatus;
+  event: Event;
+  items: OrderItem[];
+  promoCode?: PromoCode;
+  total: number;
+  currency: Currency;
+  createdAt: Date;
+};
+
+export type PromoCode = {
+  id: string;
+  code: string;
+  used: number;
+  discount: number;
+  isActive: boolean;
+  expirationAt: Date;
+  createdAt: Date;
+};

package/src/rest/types/organizations/index.ts

@@ -0,0 +1,54 @@
+import { Location, Profile, ProfileMetadata } from "..";
+import { Event } from "../event";
+import { EventTicket } from "../event/ticket";
+import { User } from "../users";
+
+export type Organization = {
+  id: string;
+  slug: string;
+  identity: OrganizationIdentity;
+  members: OrganizationMember[];
+  location?: Location;
+  events: Event[];
+  savedTickets: EventTicket[];
+  verified: boolean;
+  updatedAt: Date;
+  createdAt: Date;
+};
+
+export type OrganizationIdentity = Profile & {
+  socialLinks: OrganizationSocialLink[];
+
+  metadata: ProfileMetadata & {
+    eventsCount: number;
+    viewsCount: number;
+    membersCount: number;
+  };
+};
+
+export type OrganizationSocialLink = {
+  type: OrganizationSocialType;
+  url: string;
+};
+
+export enum OrganizationSocialType {
+  Facebook = "facebook",
+  Twitter = "twitter",
+  Instagram = "instagram",
+  Linkedin = "linkedin",
+  Youtube = "youtube",
+  Website = "website",
+}
+
+export type OrganizationMember = {
+  user: User;
+  role: OrganizationMemberRole;
+  createdAt: Date;
+};
+
+export enum OrganizationMemberRole {
+  EMPLOYEE = 0,
+  MANAGER = 1,
+  ADMINISTRATOR = 2,
+  OWNER = 3,
+}

package/src/rest/types/profiles/index.ts

@@ -0,0 +1,30 @@
+import { Endpoint } from "../../endpoints";
+import { UserIdentity } from "../users";
+
+export interface Profile {
+  type: "user" | "organization";
+
+  displayName: string;
+  description: string;
+
+  profilePictureUrl?: string;
+  bannerUrl?: string;
+
+  metadata: ProfileMetadata;
+
+  createdAt: Date;
+}
+
+export interface ProfileMetadata {
+  followersCount: number;
+
+  isBlocked: boolean;
+  hasBlocked: boolean;
+  canDM: boolean;
+}
+
+export type ProfileEndpoints = Endpoint<
+  "GET",
+  "/profiles/:username",
+  UserIdentity
+>;

package/src/rest/types/token/index.ts

@@ -0,0 +1,15 @@
+export type UserToken = {
+  id: string;
+  type: UserTokenType;
+  value: string;
+  createdAt: Date;
+  expiresAt: Date;
+};
+
+export enum UserTokenType {
+  Authentication = "authentication",
+  OrganizationInvite = "organization_invite",
+  PasswordRecovery = "password_recovery",
+  EmailValidation = "email_validation",
+  PhoneValidation = "phone_validation",
+}

package/src/rest/types/users/index.ts

@@ -0,0 +1,104 @@
+import { Currency, Language, Location, Profile, ProfileMetadata } from "..";
+import { UpdateUserDto } from "../../dtos";
+import { Endpoint } from "../../endpoints";
+
+export type User = {
+  id: string;
+  identifier: UserIdentifier;
+  password: string;
+  identity: UserIdentity;
+  role: UserRole;
+  addresses: Location[];
+  preferences: UserPreferences;
+  connections: UserConnection[];
+  verified: boolean;
+  updatedAt: Date;
+  createdAt: Date;
+};
+
+export type UserIdentifier = {
+  email?: string;
+  phoneNumber?: string;
+  username: string;
+
+  [key: string]: string | undefined;
+};
+
+export type UserIdentity = Profile & {
+  firstName: string;
+  lastName: string;
+  fullName: string;
+  gender: UserIdentityGender;
+  birthDate: Date;
+
+  metadata: ProfileMetadata & {
+    followingCount: number;
+    hasPassPlus: boolean;
+    idValid: boolean;
+  };
+};
+
+export enum UserRole {
+  USER = 0,
+  DEVELOPER = 8,
+  ADMINISTRATOR = 10,
+}
+
+export type UserIdentityGender =
+  | "male"
+  | "female"
+  | "non-binary"
+  | "gender-fluid"
+  | "neutral"
+  | "other"
+  | string;
+
+export type UserPreferences = {
+  language: Language;
+  currency: Currency;
+  notifications: {
+    email: {
+      newsletter: boolean;
+      message: boolean;
+    };
+    push: {
+      message: boolean;
+    };
+  };
+};
+
+export type UserConnection = {
+  ip: string;
+  os: UserConnectionOS;
+  device: UserConnectionDevice;
+  client: UserConnectionClient;
+  updatedAt: Date;
+  createdAt: Date;
+};
+
+export type UserConnectionOS = {
+  name: string;
+  version: string;
+};
+
+export type UserConnectionDevice = {
+  type: string;
+  brand: string;
+};
+
+export type UserConnectionClient = {
+  name: string;
+  version: string;
+};
+
+export 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>;

package/src/sdk/builder.ts

@@ -0,0 +1,5 @@
+import { Client } from "../rest";
+
+export function sdk<T>(builder: (client: Client) => T) {
+  return builder;
+}

package/src/sdk/careers.ts

@@ -0,0 +1,22 @@
+import { sdk } from "./builder";
+import { Query } from "../rest";
+
+export const careers = sdk((client) => ({
+  categories: {
+    getAll: async (query?: Query<"/careers/categories">) =>
+      client.get("/careers/categories", query),
+  },
+  employmentTypes: {
+    getAll: async (query?: Query<"/careers/employmentTypes">) =>
+      client.get("/careers/employmentTypes", query),
+  },
+  jobs: {
+    getAll: async (query?: Query<"/careers/jobs">) =>
+      client.get("/careers/jobs", query),
+    get: async (id: number) => client.get("/careers/jobs/:id", { id }),
+  },
+  offices: {
+    getAll: async (query?: Query<"/careers/offices">) =>
+      client.get("/careers/offices", query),
+  },
+}));

package/src/sdk/health.ts

@@ -0,0 +1,6 @@
+import { sdk } from "./builder";
+
+export const health = sdk((client) => ({
+  database: async () => client.get("/health/database"),
+  http: async () => client.get("/health/http"),
+}));

package/src/sdk/index.ts

@@ -0,0 +1,3 @@
+export * from "./builder";
+export * from "./health";
+export * from "./users";

package/src/sdk/profiles.ts

@@ -0,0 +1,6 @@
+import { sdk } from "./builder";
+
+export const profiles = sdk((client) => ({
+  get: async (username: string) =>
+    client.get("/profiles/:username", { username }),
+}));

package/src/sdk/users.ts

@@ -0,0 +1,12 @@
+import { sdk } from "./builder";
+import { UpdateUserDto } from "../rest";
+
+export const users = sdk((client) => ({
+  getAll: async () => client.get("/users"),
+  get: async (id: string) => client.get("/users", { id }),
+  me: async () => client.get("/users/me"),
+  check: async (identifier: string) =>
+    client.get("/check/:identifier", { identifier }),
+  update: async (id: string, data: UpdateUserDto) =>
+    client.put("/users/:id", data, { id }),
+}));

package/src/tonightpass.ts

@@ -0,0 +1,19 @@
+import { Client, ClientOptions } from "./rest";
+import { health, users } from "./sdk";
+import { careers } from "./sdk/careers";
+
+export class TonightPass {
+  public readonly client: Client;
+
+  public readonly careers;
+  public readonly health;
+  public readonly users;
+
+  constructor(options: ClientOptions) {
+    this.client = new Client(options);
+
+    this.careers = careers(this.client);
+    this.health = health(this.client);
+    this.users = users(this.client);
+  }
+}

package/src/utils/index.ts

@@ -0,0 +1 @@
+export const isBrowser = typeof window !== "undefined";

package/tests/careers/index.ts

@@ -0,0 +1,28 @@
+import assert from "assert";
+import test from "node:test";
+
+import { TonightPass } from "../../src/tonightpass";
+
+export function careersTests(tnp: TonightPass) {
+  test("It gets all careers categories", async () => {
+    const careersCategories = await tnp.careers.categories.getAll();
+    assert.ok(
+      Array.isArray(careersCategories) &&
+        careersCategories.length > 0 &&
+        careersCategories[0].slug,
+    );
+  });
+
+  test("It gets all careers jobs", async () => {
+    const careersJobs = await tnp.careers.jobs.getAll();
+    assert.ok(Array.isArray(careersJobs));
+  });
+
+  test("It gets all careers offices", async () => {
+    const careersOffices = await tnp.careers.offices.getAll({
+      page: 1,
+      pageSize: 10,
+    });
+    assert.ok(Array.isArray(careersOffices));
+  });
+}