@envoy/envoy-integrations-sdk 2.3.1 → 2.3.2

package/src/factories/routeBodyFactory.ts

@@ -8,23 +8,21 @@ export const routeBodyFactoryDefaultIds = {
 };
 
 export type RouteBodyFactoryOptions<Config, Params, Payload> = {
-  config: Partial<Config>,
-  params: Params,
-  payload: Payload,
-  scope?: Array<EnvoyUserAPIScope>,
-  locationId?: string,
-  companyId?: string,
-  zoneId?: string,
-  route?: string,
+  config: Partial<Config>;
+  params: Params;
+  payload: Payload;
+  scope?: Array<EnvoyUserAPIScope>;
+  locationId?: string;
+  companyId?: string;
+  zoneId?: string;
+  route?: string;
 };
 
 export default function routeBodyFactory<
   Config extends Record<string, unknown> = Record<string, never>,
   Params extends Record<string, unknown> = Record<string, never>,
   Payload extends Record<string, unknown> = Record<string, never>,
-  >(
-  options: RouteBodyFactoryOptions<Config, Params, Payload>,
-) {
+>(options: RouteBodyFactoryOptions<Config, Params, Payload>) {
   return {
     meta: routeMetaFactory<Config, Params>(
       options.route || '',

package/src/index.ts

@@ -29,6 +29,7 @@ import EnvoyValidationRouteResponseBody from './sdk/EnvoyValidationRouteResponse
 import EnvoyJWT from './util/EnvoyJWT';
 import EnvoySignatureVerifier from './util/EnvoySignatureVerifier';
 import JSONAPIData from './util/json-api/JSONAPIData';
+import JSONAPIResponse from './util/json-api/JSONAPIResponse';
 
 export * from './factories/entryEventBodyFactory';
 export * from './factories/eventBodyFactory';
@@ -80,6 +81,7 @@ export {
   EnvoyUserAPI,
   EnvoyValidationRouteResponseBody,
   JSONAPIData,
+  JSONAPIResponse,
   HttpStatus,
   entryEventBodyFactory,
   eventBodyFactory,

package/src/internal/EnvoyEntryEvent.ts

@@ -1,10 +1,10 @@
 type EnvoyEntryEvent =
-  'entry_sign_in' |
-  'entry_sign_out' |
-  'entry_blacklist_review' |
-  'entry_blacklist_deny' |
-  'employee_entry_sign_in' |
-  'employee_entry_sign_out' |
-  string;
+  | 'entry_sign_in'
+  | 'entry_sign_out'
+  | 'entry_blacklist_review'
+  | 'entry_blacklist_deny'
+  | 'employee_entry_sign_in'
+  | 'employee_entry_sign_out'
+  | string;
 
 export default EnvoyEntryEvent;

package/src/internal/EnvoyInviteEvent.ts

@@ -1,13 +1,13 @@
 type EnvoyInviteEvent =
-  'invite_created' |
-  'invite_updated' |
-  'invite_removed' |
-  'upcoming_visit' |
-  'qr_code_sent' |
-  'employee_invite_created' |
-  'employee_invite_updated' |
-  'employee_invite_removed' |
-  'employee_upcoming_visit' |
-  string;
+  | 'invite_created'
+  | 'invite_updated'
+  | 'invite_removed'
+  | 'upcoming_visit'
+  | 'qr_code_sent'
+  | 'employee_invite_created'
+  | 'employee_invite_updated'
+  | 'employee_invite_removed'
+  | 'employee_upcoming_visit'
+  | string;
 
 export default EnvoyInviteEvent;

package/src/internal/EnvoyOption.ts

@@ -1,7 +1,7 @@
 type EnvoyOption = {
-  label: string,
-  value: string,
-  isDisabled?: boolean,
+  label: string;
+  value: string;
+  isDisabled?: boolean;
 };
 
 export default EnvoyOption;

package/src/internal/EnvoyOptionsRouteParams.ts

@@ -1,7 +1,7 @@
 type EnvoyOptionsRouteParams = {
-  search?: string,
-  page?: number,
-  cursor?: string,
+  search?: string;
+  page?: number;
+  cursor?: string;
 };
 
 export default EnvoyOptionsRouteParams;

package/src/internal/EnvoyPluginJobUpdate.ts

@@ -4,8 +4,8 @@ import EnvoyPluginJobAttachment from '../sdk/EnvoyPluginJobAttachment';
  * @internal
  */
 export default interface EnvoyPluginJobUpdate {
-  status?: string,
-  status_message?: string,
-  failure_reason?: string,
-  attachments: Array<EnvoyPluginJobAttachment>,
+  status?: string;
+  status_message?: string;
+  failure_reason?: string;
+  attachments: Array<EnvoyPluginJobAttachment>;
 }

package/src/internal/EnvoyRemoteValueRouteResponseBody.ts

@@ -1,4 +1,4 @@
 type EnvoyRemoteValueRouteResponseBody = {
-  value: string,
+  value: string;
 };
 export default EnvoyRemoteValueRouteResponseBody;

package/src/internal/EnvoySelectedValuesRouteParams.ts

@@ -1,5 +1,5 @@
 type EnvoySelectedValuesRouteParams = {
-  value: Array<string> | string,
+  value: Array<string> | string;
 };
 
 export default EnvoySelectedValuesRouteParams;

package/src/internal/EnvoyStorageCommand.ts

@@ -7,54 +7,55 @@ export const UNIQUE_NUM_OPTIONS_DEFAULT_MIN = 0;
 export const UNIQUE_NUM_OPTIONS_DEFAULT_MAX = 9_007_199_254_740_991;
 
 export interface EnvoyStorageSetUniqueOptions {
-  chars?: string,
-  size?: number,
+  chars?: string;
+  size?: number;
 }
 
 export interface EnvoyStorageSetUniqueNumOptions {
-  min?: number,
-  max?: number,
+  min?: number;
+  max?: number;
 }
 
 export interface EnvoyBaseStorageCommand {
-  action: 'get' | 'set' | 'set_unique' | 'set_unique_num' | 'unset',
-  key: string,
+  action: 'get' | 'set' | 'set_unique' | 'set_unique_num' | 'unset';
+  key: string;
 }
 
 export interface EnvoyGetStorageCommand extends EnvoyBaseStorageCommand {
-  action: 'get',
+  action: 'get';
 }
 
 export interface EnvoySetStorageCommand extends EnvoyBaseStorageCommand {
-  action: 'set',
-  value: unknown,
+  action: 'set';
+  value: unknown;
 }
 
 export interface EnvoySetUniqueStorageCommand extends EnvoyBaseStorageCommand, EnvoyStorageSetUniqueOptions {
-  action: 'set_unique',
+  action: 'set_unique';
 }
 
 export interface EnvoySetUniqueNumStorageCommand extends EnvoyBaseStorageCommand, EnvoyStorageSetUniqueNumOptions {
-  action: 'set_unique_num',
+  action: 'set_unique_num';
 }
 
 export interface EnvoyUnsetStorageCommand extends EnvoyBaseStorageCommand {
-  action: 'unset',
+  action: 'unset';
 }
 
 export interface EnvoyListStorageCommand {
-  action: 'list',
-  page: number,
+  action: 'list';
+  page: number;
 }
 
 /**
  * @internal
  */
-type EnvoyStorageCommand = EnvoyGetStorageCommand
-| EnvoySetStorageCommand
-| EnvoySetUniqueStorageCommand
-| EnvoySetUniqueNumStorageCommand
-| EnvoyUnsetStorageCommand
-| EnvoyListStorageCommand;
+type EnvoyStorageCommand =
+  | EnvoyGetStorageCommand
+  | EnvoySetStorageCommand
+  | EnvoySetUniqueStorageCommand
+  | EnvoySetUniqueNumStorageCommand
+  | EnvoyUnsetStorageCommand
+  | EnvoyListStorageCommand;
 
 export default EnvoyStorageCommand;

package/src/mocks/EnvoyPluginJobMock.ts

@@ -16,10 +16,8 @@ export default class EnvoyPluginJobMock extends EnvoyPluginJob {
   private static updates: Array<EnvoyPluginJobUpdate> = [];
 
   static attachmentLike(partialAttachment: Partial<EnvoyPluginJobAttachment>) {
-    return EnvoyPluginJobMock.updates.find(
-      ({ attachments }) => attachments.find(
-        (attachment) => isMatch(attachment, partialAttachment),
-      ),
+    return EnvoyPluginJobMock.updates.find(({ attachments }) =>
+      attachments.find((attachment) => isMatch(attachment, partialAttachment)),
     );
   }
 

package/src/mocks/EnvoyPluginStoragePipelineMock.ts

@@ -39,14 +39,22 @@ export default class EnvoyPluginStoragePipelineMock extends EnvoyPluginStoragePi
           }
           case 'set_unique':
             try {
-              const value = EnvoyPluginStoragePipelineMock.setUnique(command.key, command as EnvoyStorageSetUniqueOptions, isGlobal);
+              const value = EnvoyPluginStoragePipelineMock.setUnique(
+                command.key,
+                command as EnvoyStorageSetUniqueOptions,
+                isGlobal,
+              );
               return EnvoyPluginStoragePipelineMock.itemFromKeyValue(command.key, value);
             } catch (err) {
               return null;
             }
           case 'set_unique_num': {
             try {
-              const value = EnvoyPluginStoragePipelineMock.setUniqueNum(command.key, command as EnvoyStorageSetUniqueNumOptions, isGlobal);
+              const value = EnvoyPluginStoragePipelineMock.setUniqueNum(
+                command.key,
+                command as EnvoyStorageSetUniqueNumOptions,
+                isGlobal,
+              );
               return EnvoyPluginStoragePipelineMock.itemFromKeyValue(command.key, value);
             } catch (err) {
               return null;
@@ -101,9 +109,9 @@ export default class EnvoyPluginStoragePipelineMock extends EnvoyPluginStoragePi
     return value;
   }
 
-  static setUnique(key:string, options = DEFAULT_UNIQUE_OPTIONS, isGlobal = false) {
+  static setUnique(key: string, options = DEFAULT_UNIQUE_OPTIONS, isGlobal = false) {
     key = EnvoyPluginStoragePipelineMock.normalizeKey(key, isGlobal);
-    const chars = (options.chars && options.chars.length) ? options.chars : UNIQUE_OPTIONS_DEFAULT_CHARS;
+    const chars = options.chars && options.chars.length ? options.chars : UNIQUE_OPTIONS_DEFAULT_CHARS;
     const size = options.size || UNIQUE_OPTIONS_DEFAULT_SIZE;
     if (!chars || !size) {
       throw new Error('Invalid "chars" or "size" arguments');

package/src/payloads/EntryPayload.ts

@@ -5,85 +5,81 @@ import JSONAPIData from '../util/json-api/JSONAPIData';
  * @category Event
  */
 type EntryPayload = {
-  id: string,
-  type: 'entries',
+  id: string;
+  type: 'entries';
   attributes: {
-    'full-name': string,
-    'phone-number'?: string,
-    email: string | null,
-    'employee-screening-flow': boolean,
-    host: string | null,
-    'host-email': string | null,
-    'private-notes': string | null,
-    'signed-in-at': string,
-    'signed-out-at'?: string,
+    'full-name': string;
+    'phone-number'?: string;
+    email: string | null;
+    'employee-screening-flow': boolean;
+    host: string | null;
+    'host-email': string | null;
+    'private-notes': string | null;
+    'signed-in-at': string;
+    'signed-out-at'?: string;
     thumbnails: {
-      large: string | null,
-      original: string | null,
-      small: string | null,
-    },
-    'flow-name': string,
-    nda?: string,
+      large: string | null;
+      original: string | null;
+      small: string | null;
+    };
+    'flow-name': string;
+    nda?: string;
     'legal-docs'?: Array<{
-      id: string,
-      url: string,
-      'signed-at': string,
+      id: string;
+      url: string;
+      'signed-at': string;
       agreement: {
-        id: string,
-      },
-    }>,
+        id: string;
+      };
+    }>;
     'user-data': Array<{
-      field: string,
-      value: string | null,
-    }>,
+      field: string;
+      value: string | null;
+    }>;
     'approval-status'?: {
-      status: string,
-      'auto-approved': boolean,
+      status: string;
+      'auto-approved': boolean;
       report: Array<{
-        reason?: string,
-        result: string,
-        source: string,
+        reason?: string;
+        result: string;
+        source: string;
         messages: Array<{
           failure: {
-            text: string,
-            header: string,
-          },
-        }>,
-      }>,
-      blacklistReportUUID?: string,
-    },
-  },
+            text: string;
+            header: string;
+          };
+        }>;
+      }>;
+      blacklistReportUUID?: string;
+    };
+  };
   relationships: {
     location: {
-      data: JSONAPIData<'locations'>,
-    },
+      data: JSONAPIData<'locations'>;
+    };
     'visitor-entrance'?: {
-      data: JSONAPIData<'visitor-entrances'>,
-    },
+      data: JSONAPIData<'visitor-entrances'>;
+    };
     device?: {
-      data: JSONAPIData<'devices'>,
-    },
+      data: JSONAPIData<'devices'>;
+    };
     employee?: {
-      data: JSONAPIData<'employees'>,
-    },
+      data: JSONAPIData<'employees'>;
+    };
     invite?: {
-      data: JSONAPIData<'invites'>,
-    },
+      data: JSONAPIData<'invites'>;
+    };
     flow?: {
-      data: JSONAPIData<'flows'>,
-    },
+      data: JSONAPIData<'flows'>;
+    };
     'agreeable-ndas'?: {
-      data: Array<JSONAPIData<'agreeable-ndas'>>,
-    }
-  }
+      data: Array<JSONAPIData<'agreeable-ndas'>>;
+    };
+  };
 };
 
-export function normalizeEntryPayload(payload : EntryPayload): EntryPayload {
-  const {
-    'signed-in-at': signedInAt,
-    'signed-out-at': signedOutAt,
-    'legal-docs': legalDocs,
-  } = payload.attributes;
+export function normalizeEntryPayload(payload: EntryPayload): EntryPayload {
+  const { 'signed-in-at': signedInAt, 'signed-out-at': signedOutAt, 'legal-docs': legalDocs } = payload.attributes;
   const normalized = { ...payload };
   normalized.attributes['signed-in-at'] = DateTime.fromSQL(signedInAt, { zone: 'UTC' }).toISO();
   if (signedOutAt) {

package/src/payloads/InvitePayload.ts

@@ -5,69 +5,69 @@ import JSONAPIData from '../util/json-api/JSONAPIData';
  * @category Event
  */
 type InvitePayload = {
-  id: string,
-  type: 'invites',
+  id: string;
+  type: 'invites';
   attributes: {
-    'employee-screening-flow': boolean,
-    'full-name': string,
-    email: string | null,
-    'inviter-name': string | null,
-    'inviter-email': string | null,
-    'expected-arrival-time': string,
-    'private-notes': string | null,
-    arrived: boolean,
-    'been-here-before': boolean,
-    'flow-name': string,
-    'flow-id': string,
+    'employee-screening-flow': boolean;
+    'full-name': string;
+    email: string | null;
+    'inviter-name': string | null;
+    'inviter-email': string | null;
+    'expected-arrival-time': string;
+    'private-notes': string | null;
+    arrived: boolean;
+    'been-here-before': boolean;
+    'flow-name': string;
+    'flow-id': string;
     'user-data': Array<{
-      field: string,
-      value: string | null,
-    }>,
-    nda?: string,
-    'secret-token': string,
-    'edit-token': string,
-    'photo-url': string | null,
-    'qr-code': string | null,
-    'qr-code-sent-at': string | null,
-    'preregistration-complete': boolean,
-    'reminder-sent-at': string | null,
+      field: string;
+      value: string | null;
+    }>;
+    nda?: string;
+    'secret-token': string;
+    'edit-token': string;
+    'photo-url': string | null;
+    'qr-code': string | null;
+    'qr-code-sent-at': string | null;
+    'preregistration-complete': boolean;
+    'reminder-sent-at': string | null;
     'legal-docs'?: Array<{
-      id: string,
-      url: string,
-      'signed-at': string,
+      id: string;
+      url: string;
+      'signed-at': string;
       agreement: {
-        id: string,
-      },
-    }>,
-    'signed-in-at'?: string,
-    'signed-out-at'?: string,
-  },
+        id: string;
+      };
+    }>;
+    'signed-in-at'?: string;
+    'signed-out-at'?: string;
+  };
   relationships: {
     entry?: {
-      data: JSONAPIData<'entries'>,
-    },
+      data: JSONAPIData<'entries'>;
+    };
     location: {
-      data: JSONAPIData<'locations'>,
-    },
+      data: JSONAPIData<'locations'>;
+    };
     flow?: {
-      data: JSONAPIData<'flows'>,
-    },
+      data: JSONAPIData<'flows'>;
+    };
     employee?: {
-      data: JSONAPIData<'employees'>,
-    },
+      data: JSONAPIData<'employees'>;
+    };
     'agreeable-ndas'?: {
-      data: Array<JSONAPIData<'agreeable-ndas'>>,
-    },
+      data: Array<JSONAPIData<'agreeable-ndas'>>;
+    };
     tenant?: {
-      data: JSONAPIData<'tenants'>,
-    },
+      data: JSONAPIData<'tenants'>;
+    };
     'invitee-employee'?: {
-      data: JSONAPIData<'employees'>,
-    },
+      data: JSONAPIData<'employees'>;
+    };
     creator?: {
-      data: JSONAPIData<'users'>,
-    },
-  }
+      data: JSONAPIData<'users'>;
+    };
+  };
 };
 
 export function normalizeInvitePayload(payload: InvitePayload): InvitePayload {

package/src/payloads/NotificationPayload.ts

@@ -1,54 +1,54 @@
 type NotificationPayload = {
   recipient: {
     name: {
-      full: string,
-    },
-    email: string | null,
-    user_id: number | null,
-    employee_id: number | null,
-    phone_number: string | null,
-  },
-  message?: string,
+      full: string;
+    };
+    email: string | null;
+    user_id: number | null;
+    employee_id: number | null;
+    phone_number: string | null;
+  };
+  message?: string;
   details?: Array<{
-    label: string,
-    value: string,
-  }>,
+    label: string;
+    value: string;
+  }>;
   actions?: Array<{
-    label: string,
-    callback_url: string,
-  }>,
+    label: string;
+    callback_url: string;
+  }>;
   attachments?: Array<{
-    url: string,
-  }>,
+    url: string;
+  }>;
   channel_overrides?: {
     slack?: {
-      dm_only?: boolean,
-      footer_text?: string,
-      short_details?: boolean,
-      large_image?: boolean,
-      attachments?: Array<Record<string, any>>,
-      message?: string,
-      text?: string,
-    },
+      dm_only?: boolean;
+      footer_text?: string;
+      short_details?: boolean;
+      large_image?: boolean;
+      attachments?: Array<Record<string, any>>;
+      message?: string;
+      text?: string;
+    };
     email?: {
-      from: string,
-      subject: string,
-      html_body: string,
-      text_body: string,
+      from: string;
+      subject: string;
+      html_body: string;
+      text_body: string;
       reply_to?: {
         name: {
-          full: string,
-        },
-        email: string,
-      },
+          full: string;
+        };
+        email: string;
+      };
       bcc?: Array<{
         name: {
-          full: string,
-        },
-        email: string,
-      }>
-    }
-  },
+          full: string;
+        };
+        email: string;
+      }>;
+    };
+  };
 };
 
 export default NotificationPayload;

package/src/resources/FlowResource.ts

@@ -23,12 +23,13 @@ export interface FlowAttributes {
   enabled: boolean;
   'created-at': string;
   'updated-at': string;
+  type: string;
 }
 
 /**
  * @category API Resource
  */
-export type FlowRelationships = 'location' | 'sign-in-field-page' | 'agreement-page';
+export type FlowRelationships = 'location' | 'sign-in-field-page' | 'agreement-page' | 'global-flow';
 
 /**
  * @category API Resource