127 lines
3.8 KiB
TypeScript
127 lines
3.8 KiB
TypeScript
import type { Prisma } from "@prisma/client";
|
|
|
|
import { Optional } from "./utils";
|
|
|
|
type CommonProperties = {
|
|
default?: false;
|
|
type: string;
|
|
label: string;
|
|
messageForOrganizer?: string;
|
|
iconUrl?: string;
|
|
variable?: "locationLink";
|
|
defaultValueVariable?: "link";
|
|
attendeeInputType?: null;
|
|
attendeeInputPlaceholder?: null;
|
|
};
|
|
|
|
type StaticLinkBasedEventLocation = {
|
|
linkType: "static";
|
|
urlRegExp: string;
|
|
organizerInputPlaceholder?: string;
|
|
organizerInputType?: "text" | "phone";
|
|
} & CommonProperties;
|
|
|
|
type DynamicLinkBasedEventLocation = {
|
|
linkType: "dynamic";
|
|
urlRegExp?: null;
|
|
organizerInputType?: null;
|
|
organizerInputPlaceholder?: null;
|
|
} & CommonProperties;
|
|
|
|
export type EventLocationTypeFromAppMeta = StaticLinkBasedEventLocation | DynamicLinkBasedEventLocation;
|
|
|
|
type EventLocationAppData = {
|
|
location: EventLocationTypeFromAppMeta;
|
|
};
|
|
|
|
/**
|
|
* This is the definition for an app store's app metadata.
|
|
* This is used to display App info, categorize or hide certain apps in the app store.
|
|
*/
|
|
export interface App {
|
|
/**
|
|
* @deprecated
|
|
* Wheter if the app is installed or not. Usually we check for api keys in env
|
|
* variables to determine if this is true or not.
|
|
* */
|
|
installed?: boolean;
|
|
/** The app type */
|
|
type:
|
|
| `${string}_calendar`
|
|
| `${string}_messaging`
|
|
| `${string}_payment`
|
|
| `${string}_video`
|
|
| `${string}_web3`
|
|
| `${string}_other`
|
|
| `${string}_other_calendar`;
|
|
|
|
/**
|
|
* @deprecated
|
|
*
|
|
* Use name instead. Remove this property after ensuring name has the required value everywhere
|
|
* */
|
|
title?: string;
|
|
/** The display name for the app */
|
|
name: string;
|
|
/** A brief description, usually found in the app's package.json */
|
|
description: string;
|
|
/**
|
|
* @deprecated logo is used instead
|
|
* The icon to display in /apps/installed
|
|
*/
|
|
imageSrc?: string;
|
|
/** TODO determine if we should use this instead of category */
|
|
variant: "calendar" | "payment" | "conferencing" | "video" | "other" | "other_calendar" | "web3";
|
|
/** The slug for the app store public page inside `/apps/[slug] */
|
|
slug: string;
|
|
|
|
/** The category to which this app belongs, currently we have `calendar`, `payment` or `video` */
|
|
/*
|
|
* @deprecated Use categories
|
|
*/
|
|
category: string;
|
|
|
|
/** The category to which this app belongs, currently we have `calendar`, `payment` or `video` */
|
|
categories?: string[];
|
|
|
|
/** An absolute url to the app logo */
|
|
logo: string;
|
|
/** Company or individual publishing this app */
|
|
publisher: string;
|
|
/** App's website */
|
|
url: string;
|
|
/** Optional documentation website URL */
|
|
docsUrl?: string;
|
|
/** Wether if the app is verified by Cal.com or not */
|
|
verified: boolean;
|
|
/** Wether the app should appear in the trending section of the app store */
|
|
trending: boolean;
|
|
/** Rating from 0 to 5, harcoded for now. Should be fetched later on. */
|
|
rating: number;
|
|
/** Number of reviews, harcoded for now. Should be fetched later on. */
|
|
reviews: number;
|
|
/**
|
|
* Wheter if the app is installed globally or needs user intervention.
|
|
* Used to show Connect/Disconnect buttons in App Store
|
|
* */
|
|
isGlobal?: boolean;
|
|
/** A contact email, mainly to ask for support */
|
|
email: string;
|
|
|
|
/** Needed API Keys (usually for global apps) */
|
|
key?: Prisma.JsonValue;
|
|
/** Needed API Keys (usually for global apps) */
|
|
key?: Prisma.JsonValue;
|
|
/** If not free, what kind of fees does the app have */
|
|
feeType?: "monthly" | "usage-based" | "one-time" | "free";
|
|
/** 0 = free. if type="usage-based" it's the price per booking */
|
|
price?: number;
|
|
/** only required for "usage-based" billing. % of commission for paid bookings */
|
|
commission?: number;
|
|
licenseRequired?: boolean;
|
|
isProOnly?: boolean;
|
|
appData?: EventLocationAppData;
|
|
}
|
|
|
|
export type AppMeta = Optional<App, "rating" | "trending" | "reviews" | "verified">;
|