@honeybadger-io/js 6.5.2 → 6.6.0

package/dist/browser/transport.d.ts

@@ -1,6 +1,9 @@
 import { Types } from '@honeybadger-io/core';
 export declare class BrowserTransport implements Types.Transport {
-    send(options: Types.TransportOptions, payload?: Types.NoticeTransportPayload | undefined): Promise<{
+    private headers;
+    constructor(headers?: Record<string, string>);
+    defaultHeaders(): Record<string, string>;
+    send<T>(options: Types.TransportOptions, payload?: T): Promise<{
         statusCode: number;
         body: string;
     }>;

package/dist/server/checkins-manager/checkin.d.ts

@@ -0,0 +1,31 @@
+import { CheckinDto, CheckinPayload, CheckinResponsePayload } from './types/types';
+export declare class Checkin implements CheckinDto {
+    id?: string;
+    projectId: string;
+    name: string;
+    scheduleType: 'simple' | 'cron';
+    slug?: string;
+    reportPeriod?: string;
+    gracePeriod?: string;
+    cronSchedule?: string;
+    cronTimezone?: string;
+    /**
+       * Only set when the checkin has been deleted
+       * after an update request.
+       * Note: this property exists only locally.
+       */
+    private deleted;
+    constructor(props: CheckinDto);
+    isDeleted(): boolean;
+    markAsDeleted(): void;
+    validate(): void;
+    asRequestPayload(): CheckinPayload;
+    /**
+     * Compares two checkins, usually the one from the API and the one from the config file.
+     * If the one in the config file does not match the checkin from the API,
+     * then we issue an update request.
+     */
+    isInSync(other: Checkin): boolean;
+    static fromResponsePayload(projectId: string, payload: CheckinResponsePayload): Checkin;
+}
+//# sourceMappingURL=checkin.d.ts.map

package/dist/server/checkins-manager/client.d.ts

@@ -0,0 +1,21 @@
+import { Types } from '@honeybadger-io/core';
+import { Checkin } from './types/checkin';
+export declare class CheckinsClient {
+    private readonly BASE_URL;
+    private readonly cache;
+    private readonly config;
+    private readonly logger;
+    private readonly transport;
+    constructor(config: {
+        personalAuthToken: string;
+        logger: Types.Logger;
+    }, transport: Types.Transport);
+    listForProject(projectId: string): Promise<Checkin[]>;
+    get(projectId: string, checkinId: string): Promise<Checkin>;
+    create(checkin: Checkin): Promise<Checkin>;
+    update(checkin: Checkin): Promise<Checkin>;
+    remove(checkin: Checkin): Promise<void>;
+    private getHeaders;
+    private getErrorMessage;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/server/checkins-manager/index.d.ts

@@ -0,0 +1,15 @@
+import { Types } from '@honeybadger-io/core';
+import { CheckinsClient } from './types/client';
+import { CheckinsConfig } from './types/types';
+import { Checkin } from './types/checkin';
+export declare class CheckinsManager {
+    private readonly client;
+    config: Required<CheckinsConfig>;
+    logger: Types.Logger;
+    constructor(config: Partial<CheckinsConfig>, client?: CheckinsClient);
+    sync(): Promise<Checkin[]>;
+    private getLocalCheckins;
+    private createOrUpdate;
+    private remove;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/server/checkins-manager/types.d.ts

@@ -0,0 +1,66 @@
+import { Types } from '@honeybadger-io/core';
+export declare type CheckinDto = {
+    /**
+     * Checkin identifier.
+     */
+    id?: string;
+    /**
+     * Checkin name.
+     */
+    name: string;
+    /**
+     * Checkin slug.
+     */
+    slug?: string;
+    /**
+     * Valid values are "simple" or "cron".
+     * If you specify "cron", then the "cron_schedule" field is required.
+     */
+    scheduleType: 'simple' | 'cron';
+    /**
+     * For simple check-ins, the amount of time that can elapse before the check-in is reported as missing.
+     * E.g., "1 day" would require a hit to the API daily to maintain the "reporting" status.
+     * Valid time periods are "minute", "hour", "day", "week", and "month": "5 minutes", "7 days", etc.
+     */
+    reportPeriod?: string;
+    /**
+     * The amount of time to allow a job to not report before it's reported as missing.
+     * Valid values are the same as the report_report field.
+     */
+    gracePeriod?: string;
+    /**
+     * For a scheduleType of "cron", the cron-compatible string that defines when the job should be expected to hit the API.
+     */
+    cronSchedule?: string;
+    /**
+     * The timezone setting for your server that is running the cron job to be monitored.
+     * Valid timezone values are listed here {@link https://docs.honeybadger.io/api/check-ins/timezones here}.
+     */
+    cronTimezone?: string;
+    /**
+     * The project ID that this checkin belongs to.
+     */
+    projectId: string;
+};
+export declare type CheckinsConfig = {
+    debug?: boolean;
+    logger?: Types.Logger;
+    personalAuthToken: string;
+    checkins: CheckinDto[];
+};
+export declare type CheckinPayload = {
+    name: string;
+    slug?: string;
+    schedule_type: 'simple' | 'cron';
+    report_period?: string;
+    grace_period?: string;
+    cron_schedule?: string;
+    cron_timezone?: string;
+};
+export declare type CheckinTransportPayload = {
+    check_in: CheckinPayload;
+};
+export declare type CheckinResponsePayload = {
+    id: string;
+} & CheckinPayload;
+//# sourceMappingURL=types.d.ts.map

package/dist/server/checkins-sync-exec.d.ts

@@ -0,0 +1,2 @@
+declare const syncCheckins: any;
+//# sourceMappingURL=checkins-sync-exec.d.ts.map