173 lines
5.4 KiB
TypeScript
173 lines
5.4 KiB
TypeScript
import type { AppCategories, Prisma } from "@prisma/client";
|
|
|
|
import type { Tag } from "@calcom/app-store/types";
|
|
|
|
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 AppData = {
|
|
/**
|
|
* TODO: We must assert that if `location` is set in App config.json, then it must have atleast Messaging or Conferencing as a category.
|
|
* This is because we fetch only those credentials(as an optimization) which match that category.
|
|
*/
|
|
location?: EventLocationTypeFromAppMeta;
|
|
tag?: Tag;
|
|
} | null;
|
|
|
|
/**
|
|
* 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
|
|
* Whether 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}_automation`
|
|
| `${string}_analytics`
|
|
| `${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;
|
|
/** TODO determine if we should use this instead of category */
|
|
variant:
|
|
| "calendar"
|
|
| "payment"
|
|
| "conferencing"
|
|
| "video"
|
|
| "other"
|
|
| "other_calendar"
|
|
| "web3"
|
|
| "automation";
|
|
/** The slug for the app store public page inside `/apps/[slug] */
|
|
slug: string;
|
|
|
|
/** The category to which this app belongs. Remove all usages of category and then remove the prop */
|
|
/*
|
|
* @deprecated Use categories
|
|
*/
|
|
category?: string;
|
|
|
|
/** The category to which this app belongs. */
|
|
/**
|
|
* Messaging and Conferencing(Earlier called Video) are considered location apps and are fetched when configuring an event-type location.
|
|
*/
|
|
categories: AppCategories[];
|
|
/**
|
|
* `User` is the broadest category. `EventType` is when you want to add features to EventTypes.
|
|
* See https://app.gitbook.com/o/6snd8PyPYMhg0wUw6CeQ/s/VXRprBTuMlihk37NQgUU/~/changes/6xkqZ4qvJ3Xh9k8UaWaZ/engineering/product-specs/app-store#user-apps for more details
|
|
*/
|
|
extendsFeature?: "EventType" | "User";
|
|
/** 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;
|
|
/**
|
|
* Whether if the app is installed globally or needs user intervention.
|
|
* Used to show Connect/Disconnect buttons in App Store
|
|
* */
|
|
isGlobal?: boolean;
|
|
/**
|
|
* For apps that are accessible on an alternate URL(which is simpler and shorter), this can be set.
|
|
* e.g. Routing Forms App is available as /routing-forms in addition to regular /apps/routing-forms.
|
|
*/
|
|
simplePath?: string;
|
|
/** A contact email, mainly to ask for support */
|
|
email: string;
|
|
/** 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;
|
|
teamsPlanRequired?: {
|
|
upgradeUrl: string;
|
|
};
|
|
appData?: AppData;
|
|
/**
|
|
* @deprecated
|
|
* Used only by legacy apps which had slug different from their directory name.
|
|
*/
|
|
dirName?: string;
|
|
isTemplate?: boolean;
|
|
__template?: string;
|
|
/** Slug of an app needed to be installed before the current app can be added */
|
|
dependencies?: string[];
|
|
/** Enables video apps to be used for team events. Non Video/Conferencing apps don't honor this as they support team installation always. */
|
|
concurrentMeetings?: boolean;
|
|
|
|
createdAt?: string;
|
|
}
|
|
|
|
export type AppFrontendPayload = Omit<App, "key"> & {
|
|
/** We should type error if keys are leaked to the frontend */
|
|
isDefault?: boolean;
|
|
key?: never;
|
|
dependencyData?: {
|
|
name?: string;
|
|
installed?: boolean;
|
|
}[];
|
|
/** Number of users who currently have this App installed */
|
|
installCount?: number;
|
|
};
|
|
|
|
export type AppMeta = App;
|