@rocket.chat/core-typings 6.3.0-rc.0 → 6.3.0-rc.2

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @rocket.chat/core-typings
 
+## 6.3.0-rc.2
+
+## 6.3.0-rc.1
+
 ## 6.3.0-rc.0
 
 ### Patch Changes
@@ -8,4 +12,10 @@
 - 9da856cc67: fix: Resume on-hold chat not working with max-chat's allowed per agent config
 - 12d97e16c2: feat: Allow Incoming Webhooks to override destination channel
 
+## 6.2.10
+
+## 6.2.9
+
+## 6.2.7
+
 ## 6.2.6

package/dist/ACDQueues.d.ts

@@ -0,0 +1,35 @@
+export interface IQueueSummary {
+    name: string;
+    loggedin: string;
+    available: string;
+    callers: string;
+    holdtime: string;
+    talktime: string;
+    logestholdtime: string;
+}
+export interface IQueueMember {
+    name: string;
+    location: string;
+    stateinterface: string;
+    membership: string;
+    penalty: string;
+    callstaken: string;
+    lastcall: string;
+    lastpause: string;
+    incall: string;
+    status: string;
+    paused: string;
+    pausedreason: string;
+    wrapuptime: string;
+}
+export interface IQueueDetails {
+    name: string;
+    strategy: string;
+    calls: string;
+    holdtime: string;
+    talktime: string;
+    completed: string;
+    abandoned: string;
+    logestholdtime: string;
+    members: IQueueMember[];
+}

package/dist/ACDQueues.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ACDQueues.js.map

package/dist/ACDQueues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACDQueues.js","sourceRoot":"","sources":["../src/ACDQueues.ts"],"names":[],"mappings":""}

package/dist/AppOverview.d.ts

@@ -0,0 +1,104 @@
+import type { AppStatus } from '@rocket.chat/apps-engine/definition/AppStatus';
+import type { App, AppSubscriptionStatus } from './Apps';
+export type AppOverview = {
+    appId: string;
+    latest: Latest;
+    isAddon: boolean;
+    addonId: string;
+    isEnterpriseOnly: boolean;
+    isBundle: boolean;
+    bundledAppIds: any[];
+    bundledIn: bundledIn[];
+    isPurchased: boolean;
+    isSubscribed: boolean;
+    subscriptionInfo: SubscriptionInfo;
+    price: number;
+    purchaseType: string;
+    pricingPlans: PricingPlan[];
+    isUsageBased: boolean;
+    createdAt: string;
+    modifiedAt: string;
+    iconFileContent?: string;
+    marketplaceVersion?: string;
+    marketplace?: unknown;
+};
+export type bundledIn = {
+    bundleId: string;
+    bundleName: string;
+    apps: App[];
+    addonTierId: string;
+};
+export type Latest = {
+    internalId: string;
+    id: string;
+    name: string;
+    nameSlug: string;
+    version: string;
+    categories: string[];
+    languages: string[];
+    description: string;
+    privacyPolicySummary: string;
+    detailedDescription: DetailedDescription;
+    detailedChangelog: DetailedChangelog;
+    requiredApiVersion: string;
+    permissions: Permission[];
+    author: Author;
+    classFile: string;
+    iconFile: string;
+    iconFileData: string;
+    status: AppStatus;
+    isVisible: boolean;
+    createdDate: string;
+    modifiedDate: string;
+    isPurchased: boolean;
+    isSubscribed: boolean;
+    subscriptionInfo: SubscriptionInfo;
+    compileJobId: string;
+    compiled: boolean;
+    tosLink: string;
+    privacyLink: string;
+};
+export type DetailedDescription = {
+    raw: string;
+    rendered: string;
+};
+export type DetailedChangelog = {
+    raw: string;
+    rendered: string;
+};
+export type Permission = {
+    name: string;
+    scopes?: string[];
+};
+export type Author = {
+    name: string;
+    support: string;
+    homepage: string;
+};
+export type SubscriptionInfo = {
+    typeOf: string;
+    status: AppSubscriptionStatus;
+    statusFromBilling: boolean;
+    isSeatBased: boolean;
+    seats: number;
+    maxSeats: number;
+    license: License;
+    startDate: string;
+    periodEnd: string;
+    endDate: string;
+    externallyManaged: boolean;
+    isSubscribedViaBundle: boolean;
+};
+export type License = {
+    license: string;
+    version: number;
+    expireDate: string;
+};
+export type PricingPlan = {
+    id: string;
+    enabled: boolean;
+    price: number;
+    trialDays: number;
+    strategy: string;
+    isPerSeat: boolean;
+};

package/dist/AppOverview.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AppOverview.js.map

package/dist/AppOverview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppOverview.js","sourceRoot":"","sources":["../src/AppOverview.ts"],"names":[],"mappings":""}

package/dist/AppRequests.d.ts

@@ -0,0 +1,38 @@
+export type AppRequestFilter = 'unseen' | 'seen' | 'notification-sent' | 'notification-not-sent' | '';
+export type AppRequestEndUser = {
+    id: string;
+    username: string;
+    name: string;
+    nickname: string;
+    emails: string[];
+};
+export type AppRequest = {
+    id: string;
+    appId: string;
+    requester: AppRequestEndUser;
+    admins: AppRequestEndUser[];
+    workspaceId: string;
+    message: string;
+    seen: boolean;
+    seenAt: string;
+    notificationSent: boolean;
+    notificationSentAt: string;
+    createdDate: string;
+};
+export type Meta = {
+    limit: 25 | 50 | 100;
+    offset: number;
+    sort: string;
+    filter: string;
+    total: number;
+};
+export type PaginatedAppRequests = {
+    data: AppRequest[];
+    meta: Meta;
+};
+export type AppRequestsStats = {
+    data: {
+        totalSeen: number;
+        totalUnseen: number;
+    };
+};

package/dist/AppRequests.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AppRequests.js.map

package/dist/AppRequests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppRequests.js","sourceRoot":"","sources":["../src/AppRequests.ts"],"names":[],"mappings":""}

package/dist/Apps.d.ts

@@ -0,0 +1,122 @@
+import type { AppStatus } from '@rocket.chat/apps-engine/definition/AppStatus';
+export type AppScreenshot = {
+    id: string;
+    appId: string;
+    fileName: string;
+    accessUrl: string;
+    thumbnailUrl: string;
+    createdAt: string;
+    modifiedAt: string;
+};
+export type AppTiers = {
+    perUnit: boolean;
+    minimum: number;
+    maximum: number;
+    price: number;
+};
+export type AppPricingPlan = {
+    id: string;
+    enabled: boolean;
+    price: number;
+    trialDays: number;
+    strategy: string;
+    isPerSeat: boolean;
+    tiers?: AppTiers[];
+};
+export type AppLicense = {
+    license: string;
+    version: number;
+    expireDate: string;
+};
+export declare enum AppSubscriptionStatus {
+    Trialing = "trialing",
+    Active = "active",
+    Cancelled = "cancelled",
+    Cancelling = "cancelling",
+    PastDue = "pastDue"
+}
+export type AppSubscriptionInfo = {
+    typeOf: string;
+    status: AppSubscriptionStatus;
+    statusFromBilling: boolean;
+    isSeatBased: boolean;
+    seats: number;
+    maxSeats: number;
+    license: AppLicense;
+    startDate: string;
+    periodEnd: string;
+    endDate: string;
+    isSubscribedViaBundle: boolean;
+};
+export type AppPermission = {
+    name: string;
+    required?: boolean;
+};
+export type PurchaseType = 'buy' | 'subscription';
+export type AppRequestStats = {
+    appId: string;
+    totalSeen: number;
+    totalUnseen: number;
+};
+export type App = {
+    id: string;
+    iconFileData: string;
+    name: string;
+    appRequestStats: AppRequestStats;
+    author: {
+        name: string;
+        homepage: string;
+        support: string;
+    };
+    description: string;
+    shortDescription?: string;
+    privacyPolicySummary: string;
+    detailedDescription: {
+        raw: string;
+        rendered: string;
+    };
+    detailedChangelog: {
+        raw: string;
+        rendered: string;
+    };
+    categories: string[];
+    version: string;
+    versionIncompatible?: boolean;
+    price: number;
+    purchaseType: PurchaseType;
+    pricingPlans: AppPricingPlan[];
+    iconFileContent: string;
+    installed?: boolean;
+    isEnterpriseOnly?: boolean;
+    isPurchased?: boolean;
+    isSubscribed: boolean;
+    bundledIn: {
+        bundleId: string;
+        bundleName: string;
+        apps: App[];
+        addonTierId?: string;
+    }[];
+    marketplaceVersion: string;
+    latest: App;
+    status?: AppStatus;
+    subscriptionInfo: AppSubscriptionInfo;
+    licenseValidation?: {
+        errors: {
+            [key: string]: string;
+        };
+        warnings: {
+            [key: string]: string;
+        };
+    };
+    tosLink: string;
+    privacyLink: string;
+    marketplace?: unknown;
+    modifiedAt: string;
+    permissions: AppPermission[];
+    languages: string[];
+    createdDate: string;
+    requestedEndUser?: boolean;
+    private: boolean;
+    documentationUrl: string;
+    migrated: boolean;
+};

package/dist/Apps.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppSubscriptionStatus = void 0;
+var AppSubscriptionStatus;
+(function (AppSubscriptionStatus) {
+    AppSubscriptionStatus["Trialing"] = "trialing";
+    AppSubscriptionStatus["Active"] = "active";
+    AppSubscriptionStatus["Cancelled"] = "cancelled";
+    AppSubscriptionStatus["Cancelling"] = "cancelling";
+    AppSubscriptionStatus["PastDue"] = "pastDue";
+})(AppSubscriptionStatus || (exports.AppSubscriptionStatus = AppSubscriptionStatus = {}));
+//# sourceMappingURL=Apps.js.map

package/dist/Apps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Apps.js","sourceRoot":"","sources":["../src/Apps.ts"],"names":[],"mappings":";;;AAmCA,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAChC,8CAAqB,CAAA;IACrB,0CAAiB,CAAA;IACjB,gDAAuB,CAAA;IACvB,kDAAyB,CAAA;IACzB,4CAAmB,CAAA;AACpB,CAAC,EANW,qBAAqB,qCAArB,qBAAqB,QAMhC"}

package/dist/AppsTokens.d.ts

@@ -0,0 +1,11 @@
+import type { IRocketChatRecord } from './IRocketChatRecord';
+export interface IAppsTokens extends IRocketChatRecord {
+    token: string;
+    authToken: string;
+    appName: string;
+    userId: string | null;
+    metadata: Record<string, any>;
+    enabled: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/dist/AppsTokens.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AppsTokens.js.map

package/dist/AppsTokens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppsTokens.js","sourceRoot":"","sources":["../src/AppsTokens.ts"],"names":[],"mappings":""}

package/dist/CustomFieldMetadata.d.ts

@@ -0,0 +1,11 @@
+import type { SelectOption } from '@rocket.chat/fuselage';
+export type CustomFieldMetadata = {
+    name: string;
+    label?: string;
+    type: 'select' | 'text';
+    required?: boolean;
+    defaultValue?: any;
+    minLength?: number;
+    maxLength?: number;
+    options?: SelectOption[];
+};

package/dist/CustomFieldMetadata.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CustomFieldMetadata.js.map

package/dist/CustomFieldMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomFieldMetadata.js","sourceRoot":"","sources":["../src/CustomFieldMetadata.ts"],"names":[],"mappings":""}

package/dist/FeaturedApps.d.ts

@@ -0,0 +1,6 @@
+import type { AppOverview } from './AppOverview';
+export type FeaturedAppsSection = {
+    i18nLabel: string;
+    slug: string;
+    apps: AppOverview[];
+};

package/dist/FeaturedApps.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FeaturedApps.js.map

package/dist/FeaturedApps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FeaturedApps.js","sourceRoot":"","sources":["../src/FeaturedApps.ts"],"names":[],"mappings":""}

package/dist/IAnalytic.d.ts

@@ -0,0 +1,29 @@
+import type { IRocketChatRecord } from './IRocketChatRecord';
+interface IAnalyticsBase extends IRocketChatRecord {
+    type: 'messages' | 'users' | 'seat-request';
+    date: number;
+}
+export interface IAnalyticsMessages extends IAnalyticsBase {
+    type: 'messages';
+    room: {
+        _id: string;
+        name?: string;
+        t: string;
+        usernames: string[];
+    };
+}
+export interface IAnalyticsUsers extends IAnalyticsBase {
+    type: 'users';
+    room: {
+        _id: string;
+        name?: string;
+        t: string;
+        usernames: string[];
+    };
+}
+export interface IAnalyticsSeatRequest extends IAnalyticsBase {
+    type: 'seat-request';
+    count: number;
+}
+export type IAnalytic = IAnalyticsBase | IAnalyticsMessages | IAnalyticsUsers | IAnalyticsSeatRequest;
+export {};

package/dist/IAnalytic.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAnalytic.js.map

package/dist/IAnalytic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAnalytic.js","sourceRoot":"","sources":["../src/IAnalytic.ts"],"names":[],"mappings":""}

package/dist/IAutoTranslate.d.ts

@@ -0,0 +1,25 @@
+export interface IProviderMetadata {
+    name: string;
+    displayName: string;
+    settings: {
+        apiKey: string;
+        apiEndPointUrl: string;
+    };
+}
+export interface IDeepLTranslation {
+    detected_source_language: string;
+    text: string;
+}
+export interface IGoogleTranslation {
+    translatedText: string;
+}
+export interface ISupportedLanguage {
+    language: string;
+    name: string;
+}
+export interface ISupportedLanguages {
+    [language: string]: ISupportedLanguage[];
+}
+export interface ITranslationResult {
+    [language: string]: string;
+}

package/dist/IAutoTranslate.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAutoTranslate.js.map

package/dist/IAutoTranslate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAutoTranslate.js","sourceRoot":"","sources":["../src/IAutoTranslate.ts"],"names":[],"mappings":""}

package/dist/IAvatar.d.ts

@@ -0,0 +1,2 @@
+import type { IUpload } from './IUpload';
+export type IAvatar = IUpload;

package/dist/IAvatar.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IAvatar.js.map

package/dist/IAvatar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAvatar.js","sourceRoot":"","sources":["../src/IAvatar.ts"],"names":[],"mappings":""}

package/dist/IBanner.d.ts

@@ -0,0 +1,30 @@
+import type { IRocketChatRecord } from './IRocketChatRecord';
+import type { IUser } from './IUser';
+import type { UiKitBannerPayload } from './UIKit';
+export declare enum BannerPlatform {
+    Web = "web",
+    Mobile = "mobile"
+}
+export interface IBanner extends IRocketChatRecord {
+    platform: BannerPlatform[];
+    expireAt: Date;
+    startAt: Date;
+    roles?: string[];
+    createdBy: Pick<IUser, '_id' | 'username'>;
+    createdAt: Date;
+    view: UiKitBannerPayload;
+    active?: boolean;
+    inactivedAt?: Date;
+    snapshot?: string;
+}
+export type InactiveBanner = IBanner & {
+    active: false;
+    inactivedAt: Date;
+};
+export declare const isInactiveBanner: (banner: IBanner) => banner is InactiveBanner;
+export interface IBannerDismiss extends IRocketChatRecord {
+    userId: IUser['_id'];
+    bannerId: IBanner['_id'];
+    dismissedAt: Date;
+    dismissedBy: Pick<IUser, '_id' | 'username'>;
+}

package/dist/IBanner.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isInactiveBanner = exports.BannerPlatform = void 0;
+var BannerPlatform;
+(function (BannerPlatform) {
+    BannerPlatform["Web"] = "web";
+    BannerPlatform["Mobile"] = "mobile";
+})(BannerPlatform || (exports.BannerPlatform = BannerPlatform = {}));
+const isInactiveBanner = (banner) => banner.active === false;
+exports.isInactiveBanner = isInactiveBanner;
+//# sourceMappingURL=IBanner.js.map

package/dist/IBanner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBanner.js","sourceRoot":"","sources":["../src/IBanner.ts"],"names":[],"mappings":";;;AAIA,IAAY,cAGX;AAHD,WAAY,cAAc;IACzB,6BAAW,CAAA;IACX,mCAAiB,CAAA;AAClB,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAmBM,MAAM,gBAAgB,GAAG,CAAC,MAAe,EAA4B,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,KAAK,CAAC;AAA1F,QAAA,gBAAgB,oBAA0E"}

package/dist/IBaseData.d.ts

@@ -0,0 +1,3 @@
+export interface IBaseData {
+    _id: string;
+}

package/dist/IBaseData.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IBaseData.js.map

package/dist/IBaseData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseData.js","sourceRoot":"","sources":["../src/IBaseData.ts"],"names":[],"mappings":""}

package/dist/ICalendarEvent.d.ts

@@ -0,0 +1,13 @@
+import type { IRocketChatRecord } from './IRocketChatRecord';
+import type { IUser } from './IUser';
+export interface ICalendarEvent extends IRocketChatRecord {
+    startTime: Date;
+    uid: IUser['_id'];
+    subject: string;
+    description: string;
+    notificationSent: boolean;
+    externalId?: string;
+    meetingUrl?: string;
+    reminderMinutesBeforeStart?: number;
+    reminderTime?: Date;
+}

package/dist/ICalendarEvent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ICalendarEvent.js.map

package/dist/ICalendarEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICalendarEvent.js","sourceRoot":"","sources":["../src/ICalendarEvent.ts"],"names":[],"mappings":""}

package/dist/ICloud.d.ts

@@ -0,0 +1,41 @@
+export type CloudRegistrationStatus = {
+    connectToCloud: boolean;
+    email: string;
+    token: string;
+    uniqueId: string;
+    workspaceId: string;
+    workspaceRegistered: boolean;
+};
+export type CloudRegistrationIntentData = {
+    device_code: string;
+    user_code: string;
+    verification_url: string;
+    interval: number;
+    expires_in: number;
+};
+type CloudConfirmationPollDataPending = {
+    status: 'authorization_pending';
+};
+type CloudConfirmationPollDataSuccess = {
+    successful: boolean;
+    payload: {
+        workspaceId: string;
+        client_name: string;
+        client_id: string;
+        client_secret: string;
+        redirect_uris: Array<string>;
+        publicKey: string;
+        client_secret_expires_at: number;
+        registration_client_uri: string;
+        licenseData: {
+            version: number;
+            address: string;
+            license: string;
+            updatedAt: string;
+            modules: string;
+            expireAt: string;
+        };
+    };
+};
+export type CloudConfirmationPollData = CloudConfirmationPollDataPending | CloudConfirmationPollDataSuccess;
+export {};

package/dist/ICloud.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ICloud.js.map

package/dist/ICloud.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICloud.js","sourceRoot":"","sources":["../src/ICloud.ts"],"names":[],"mappings":""}

package/dist/ICredentialToken.d.ts

@@ -0,0 +1,9 @@
+export interface ICredentialToken {
+    _id: string;
+    userInfo: {
+        username?: string;
+        attributes?: any;
+        profile?: Record<string, any>;
+    };
+    expireAt: Date;
+}

package/dist/ICredentialToken.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ICredentialToken.js.map

package/dist/ICredentialToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICredentialToken.js","sourceRoot":"","sources":["../src/ICredentialToken.ts"],"names":[],"mappings":""}