@monkvision/types - npm Package Compare versions

Comparing version 4.5.6 to 4.6.0

lib/config.d.ts

@@ -8,2 +8,15 @@ import { CameraResolution, CompressionOptions } from './camera';
 /**
+ * The types of insepction capture workflow.
+ */
+export declare enum CaptureWorkflow {
+    /**
+     * PhotoCapture workflow.
+     */
+    PHOTO = "photo",
+    /**
+     * VideoCapture workflow.
+     */
+    VIDEO = "video"
+}
+/**
  * Enumeration of the tutorial options.
@@ -17,7 +30,7 @@ */
     /**
-     * Photo capture is enable.
+     * Photo capture is enabled.
      */
     ENABLED = "enabled",
     /**
-     * Photo capture is enable only time.
+     * Photo capture is enabled only time.
      */
@@ -27,2 +40,21 @@ FIRST_TIME_ONLY = "first_time_only"
 /**
+ * Enumeration of the Add Damage options.
+ */
+export declare enum AddDamage {
+    /**
+     * Add Damage is disabled.
+     */
+    DISABLED = "disabled",
+    /**
+     * Add Damage is enabled with Two Shot:
+     * First shot for the zoom out image and second for the close up. The vehicle part will be infered.
+     */
+    TWO_SHOT = "two_shot",
+    /**
+     * Add Damage is enabled with Part select:
+     * Parts must be selected before taken a single close up shot.
+     */
+    PART_SELECT = "part_select"
+}
+/**
  * Configuration used to configure the Camera and picture output of the SDK.
@@ -55,19 +87,16 @@ */
 /**
- * The configuration options for inspection capture applications.
+ * Shared config used by both PhotoCapture and VideoCapture apps.
  */
-export type CaptureAppConfig = CameraConfig & ComplianceOptions & {
+export type SharedCaptureAppConfig = CameraConfig & {
     /**
-     * An optional list of additional tasks to run on every Sight of the inspection.
+     * An optional list of additional tasks to run on every image of the inspection.
      */
     additionalTasks?: TaskName[];
     /**
-     * Record associating each sight with a list of tasks to execute for it. If not provided, the default tasks of the
-     * sight will be used.
-     */
-    tasksBySight?: Record<string, TaskName[]>;
-    /**
      * Value indicating if tasks should be started at the end of the inspection :
      * - If not provided or if value is set to `false`, no tasks will be started.
-     * - If set to `true`, the tasks described by the `tasksBySight` param (or, if not provided, the default tasks of
-     * each sight) will be started.
+     * - If set to `true`, for photo capture apps : the tasks described by the `tasksBySight` param (or, if not provided,
+     * the default tasks of each sight) will be started.
+     * - If set to `true`, for video capture apps : the default tasks of each sight (and also optionally the ones
+     *   described by the `additionalTasks` param) will be started.
      * - If an array of tasks is provided, the tasks started will be the ones contained in the array.
@@ -79,2 +108,59 @@ *
     /**
+     * Use this prop to enforce a specific device orientation for the Camera screen.
+     */
+    enforceOrientation?: DeviceOrientation;
+    /**
+     * Boolean indicating if manual login and logout in the app should be enabled or not.
+     */
+    allowManualLogin: boolean;
+    /**
+     * Boolean indicating if the application state (such as auth token, inspection ID etc.) should be fetched from the
+     * URL search params or not.
+     */
+    fetchFromSearchParams: boolean;
+    /**
+     * The API domain used to communicate with the API.
+     */
+    apiDomain: string;
+    /**
+     * The API domain used to communicate with the resize microservice.
+     */
+    thumbnailDomain: string;
+    /**
+     * Required API permissions to use the app.
+     */
+    requiredApiPermissions?: MonkApiPermission[];
+    /**
+     * Optional color palette to extend the default Monk palette.
+     */
+    palette?: Partial<MonkPalette>;
+} & ({
+    /**
+     * Boolean indicating if automatic inspection creation should be allowed or not.
+     */
+    allowCreateInspection: false;
+} | {
+    /**
+     * Boolean indicating if automatic inspection creation should be allowed or not.
+     */
+    allowCreateInspection: true;
+    /**
+     * Options used when automatically creating an inspection.
+     */
+    createInspectionOptions: CreateInspectionOptions;
+});
+/**
+ * The configuration options for inspection capture applications using the PhotoCapture workflow.
+ */
+export type PhotoCaptureAppConfig = SharedCaptureAppConfig & ComplianceOptions & {
+    /**
+     * The capture workflow of the capture app.
+     */
+    workflow: CaptureWorkflow.PHOTO;
+    /**
+     * Record associating each sight with a list of tasks to execute for it. If not provided, the default tasks of the
+     * sight will be used.
+     */
+    tasksBySight?: Record<string, TaskName[]>;
+    /**
      * Boolean indicating if the close button should be displayed in the HUD on top of the Camera preview.
@@ -86,6 +172,2 @@ *
     /**
-     * Use this prop to enforce a specific device orientation for the Camera screen.
-     */
-    enforceOrientation?: DeviceOrientation;
-    /**
      * A number indicating the maximum allowed duration in milliseconds for an upload before raising a "Bad Connection"
@@ -111,8 +193,7 @@ * warning to the user. Set this value to -1 to never show this warning to the user.
     /**
-     * Boolean indicating if `Add Damage` feature should be enabled or not. If disabled, the `Add Damage` button will
-     * be hidden.
+     * Options for Add Damage. If disabled, the `Add Damage` button will be hidden.
      *
-     * @default true
+     * @default AddDamage.PART_SELECT.
      */
-    enableAddDamage?: boolean;
+    addDamage?: AddDamage;
     /**
@@ -134,6 +215,2 @@ * A collection of sight guidelines in different language with a list of sightIds associate to it.
     /**
-     * Boolean indicating if manual login and logout in the app should be enabled or not.
-     */
-    allowManualLogin: boolean;
-    /**
      * Boolean indicating if vehicle type selection should be enabled if the vehicle type is not defined.
@@ -143,15 +220,2 @@ */
     /**
-     * Boolean indicating if the application state (such as auth token, inspection ID etc.) should be fetched from the
-     * URL search params or not.
-     */
-    fetchFromSearchParams: boolean;
-    /**
-     * The API domain used to communicate with the API.
-     */
-    apiDomain: string;
-    /**
-     * The API domain used to communicate with the resize micro service.
-     */
-    thumbnailDomain: string;
-    /**
      * Options for displaying the photo capture tutorial.
@@ -175,10 +239,2 @@ *
     enableSightTutorial?: boolean;
-    /**
-     * Required API permissions to use the app.
-     */
-    requiredApiPermissions?: MonkApiPermission[];
-    /**
-     * Optional color palette to extend the default Monk palette.
-     */
-    palette?: Partial<MonkPalette>;
 } & ({
@@ -206,21 +262,54 @@ /**
     sights: Record<SteeringWheelPosition, Partial<Record<VehicleType, string[]>>>;
-}) & ({
+});
+/**
+ * The configuration options for inspection capture applications using the VideoCapture workflow.
+ */
+export type VideoCaptureAppConfig = SharedCaptureAppConfig & {
     /**
-     * Boolean indicating if automatic inspection creation should be allowed or not.
+     * The capture workflow of the capture app.
      */
-    allowCreateInspection: false;
-} | {
+    workflow: CaptureWorkflow.VIDEO;
     /**
-     * Boolean indicating if automatic inspection creation should be allowed or not.
+     * The minimum duration of a recording in milliseconds.
+     *
+     * @default 15000
      */
-    allowCreateInspection: true;
+    minRecordingDuration?: number;
     /**
-     * Options used when automatically creating an inspection.
+     * The maximum number of retries for failed image uploads.
+     *
+     * @default 3
      */
-    createInspectionOptions: CreateInspectionOptions;
-});
+    maxRetryCount?: number;
+    /**
+     * Boolean indicating if a warning should be shown to the user when they are walking too fast around the vehicle.
+     *
+     * @default true
+     */
+    enableFastWalkingWarning?: boolean;
+    /**
+     * Boolean indicating if a warning should be shown to the user when they are shaking their phone too much.
+     *
+     * @default true
+     */
+    enablePhoneShakingWarning?: boolean;
+    /**
+     * The duration (in milliseconds) to wait between fast walking warnings. We recommend setting this value to at least
+     * 1000.
+     *
+     * @default 4000
+     */
+    fastWalkingWarningCooldown?: number;
+    /**
+     * The duration (in milliseconds) to wait between phone shaking warnings. We recommend setting this value to at least
+     * 1000.
+     *
+     * @default 4000
+     */
+    phoneShakingWarningCooldown?: number;
+};
 /**
  * Live configuration used to configure Monk apps on the go.
  */
-export type LiveConfig = CaptureAppConfig & {
+export type LiveConfig = (PhotoCaptureAppConfig | VideoCaptureAppConfig) & {
     /**
@@ -227,0 +316,0 @@ * The ID of the live config, used to fetch it from the API.

lib/config.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PhotoCaptureTutorialOption = void 0;
+exports.AddDamage = exports.PhotoCaptureTutorialOption = exports.CaptureWorkflow = void 0;
 /**
+ * The types of insepction capture workflow.
+ */
+var CaptureWorkflow;
+(function (CaptureWorkflow) {
+    /**
+     * PhotoCapture workflow.
+     */
+    CaptureWorkflow["PHOTO"] = "photo";
+    /**
+     * VideoCapture workflow.
+     */
+    CaptureWorkflow["VIDEO"] = "video";
+})(CaptureWorkflow = exports.CaptureWorkflow || (exports.CaptureWorkflow = {}));
+/**
  * Enumeration of the tutorial options.
@@ -14,9 +28,29 @@ */
     /**
-     * Photo capture is enable.
+     * Photo capture is enabled.
      */
     PhotoCaptureTutorialOption["ENABLED"] = "enabled";
     /**
-     * Photo capture is enable only time.
+     * Photo capture is enabled only time.
      */
     PhotoCaptureTutorialOption["FIRST_TIME_ONLY"] = "first_time_only";
 })(PhotoCaptureTutorialOption = exports.PhotoCaptureTutorialOption || (exports.PhotoCaptureTutorialOption = {}));
+/**
+ * Enumeration of the Add Damage options.
+ */
+var AddDamage;
+(function (AddDamage) {
+    /**
+     * Add Damage is disabled.
+     */
+    AddDamage["DISABLED"] = "disabled";
+    /**
+     * Add Damage is enabled with Two Shot:
+     * First shot for the zoom out image and second for the close up. The vehicle part will be infered.
+     */
+    AddDamage["TWO_SHOT"] = "two_shot";
+    /**
+     * Add Damage is enabled with Part select:
+     * Parts must be selected before taken a single close up shot.
+     */
+    AddDamage["PART_SELECT"] = "part_select";
+})(AddDamage = exports.AddDamage || (exports.AddDamage = {}));

lib/utils.d.ts

@@ -28,2 +28,19 @@ /**
 /**
+ * Object containing the current 3D rotation of a device on the 3 main rotation axis.
+ */
+export interface DeviceRotation {
+    /**
+     * The device orientation around the Z axis (yaw).
+     */
+    alpha: number;
+    /**
+     * The device orientation around the X axis (pitch).
+     */
+    beta: number;
+    /**
+     * The device orientation around the Y axis (roll).
+     */
+    gamma: number;
+}
+/**
  * Enumeration of the possible sort orders.
@@ -30,0 +47,0 @@ */

package.json

 {
   "name": "@monkvision/types",
-  "version": "4.5.6",
+  "version": "4.6.0",
   "license": "BSD-3-Clause-Clear",
@@ -29,6 +29,6 @@ "packageManager": "yarn@3.2.4",
   "devDependencies": {
-    "@monkvision/eslint-config-base": "4.5.6",
-    "@monkvision/eslint-config-typescript": "4.5.6",
-    "@monkvision/prettier-config": "4.5.6",
-    "@monkvision/typescript-config": "4.5.6",
+    "@monkvision/eslint-config-base": "4.6.0",
+    "@monkvision/eslint-config-typescript": "4.6.0",
+    "@monkvision/prettier-config": "4.6.0",
+    "@monkvision/typescript-config": "4.6.0",
     "@types/node": "^18.11.9",
@@ -67,3 +67,3 @@ "@typescript-eslint/eslint-plugin": "^5.43.0",
   "homepage": "https://github.com/monkvision/monkjs",
-  "gitHead": "c12e283e4abf1f810fdbc924a2d199652b92db30"
+  "gitHead": "68caf5a157e344b2187519616c9fe35eecafc65b"
 }

No alert changes

Improved metrics

Total package byte prevSize

126271

increased by3.29%

Lines of code

3643

increased by4%

No dependency changes