@fleetkeep/cli 0.5.0 → 0.6.0

package/README.md

@@ -39,6 +39,39 @@ not enter them again. Account JSON exports include jobs, journeys and additional
 Xero authorisation and bill review take place in the web portal. Saved SHVL grants and
 credentials are not transferred between products or customer workspaces.
 
+## Service intervals and equipment
+
+Set one service interval in days, weeks or months. The vehicle command clears the
+alternative unit when switching, and converts weeks to days:
+
+```sh
+fleetkeep vehicles update <vehicle-id> --service-interval-weeks 6
+fleetkeep vehicles update <vehicle-id> --service-interval-months 12
+fleetkeep vehicles update <vehicle-id> --clear serviceIntervalDays,serviceIntervalMonths
+fleetkeep api call getWalkaroundSummary
+fleetkeep api call listVehicleEquipment --path id=<vehicle-id>
+fleetkeep api call updateVehicleEquipment --path id=<vehicle-id> --data-file equipment.json
+```
+
+The walkaround summary returns vehicles checked today in London time, not a
+roadworthiness certificate. Equipment payloads support `presetKey`, provider,
+reference, cover dates, reminders and up to eight `details` label/value pairs.
+Use an `Arrangement` detail for the confirmed ownership type, such as `Hired`.
+Omitting details preserves existing values; an empty array explicitly clears them.
+Use `previewEquipmentTemplate` before `applyEquipmentTemplate` for fleet-wide setup.
+
+With the matching API update deployed, `createMaintenance` also accepts
+`forecastConsent: true` and a `forecast` object containing `baselineDate`,
+`baselineMileage`, `intervalMiles`, `annualMileage` and `reminderDays` (0 means on
+the estimated date). Supply the actual last check, not an assumed MOT check date.
+Duplicate setup does not create another reminder; refresh the maintenance list.
+`completeMaintenance` accepts `completedDate` and `completedMileage` for
+an existing forecast. Supply the identical body for preview and confirmation;
+the next cycle retains the saved mileage interval and reminder timing. Ordinary
+maintenance updates cannot edit calculated forecast dates. There are no automatic
+fuel-card feeds in the CLI. Wex credentials and Xero authorisation are entered in
+the website, never through CLI command arguments.
+
 ## Safety model
 
 - `api operations` is generated as a fixed allowlist of the published OpenAPI operation IDs.

package/api-command.mjs

@@ -97,6 +97,9 @@ function operationPath(operation, assignments) {
     if (!values.has(name) || values.get(name) === '') {
       throw new Error(`${operation.id} requires --path ${name}=<value>.`);
     }
+    if (values.get(name) === '.' || values.get(name) === '..') {
+      throw new Error(`--path ${name} must not be a dot segment.`);
+    }
     path = path.replace(`{${name}}`, encodeURIComponent(values.get(name)));
   }
   return path;
@@ -280,9 +283,9 @@ export async function runApiCommand(args) {
     throw new Error('Use `fleetkeep api operations` or `fleetkeep api call`.');
   const operationId = args[1];
   if (!operationId || operationId.startsWith('--')) throw new Error('An operation ID is required.');
-  const operation = operations[operationId];
-  if (!operation) {
+  if (!Object.hasOwn(operations, operationId)) {
     throw new Error(`Unknown or unpublished Fleetkeep operation: ${operationId}.`);
   }
+  const operation = operations[operationId];
   await callOperation(operation, args.slice(2));
 }

package/fleetkeep.mjs

@@ -56,6 +56,8 @@ Vehicle options:
   --last-service-date <YYYY-MM-DD>
   --last-service-mileage <integer>
   --service-interval-months <integer>
+  --service-interval-days <integer>
+  --service-interval-weeks <integer>
   --operational-status <active|standby|in_maintenance|off_road|sold_or_removed>
   --assigned-driver-name <text>
   --assigned-driver-contact <text>
@@ -63,7 +65,10 @@ Vehicle options:
 
 Clearable update fields:
   label, insuranceDueDate, lastServiceDate, lastServiceMileage, serviceIntervalMonths,
-  assignedDriverName, assignedDriverContact, statusNotes
+  serviceIntervalDays, assignedDriverName, assignedDriverContact, statusNotes
+
+Choose one service interval unit. Weeks are stored as days. Setting an interval
+clears the alternative unit so an old interval cannot override the new one.
 
 Environment:
   FLEETKEEP_ACCESS_TOKEN  Optional OAuth token override for automation
@@ -112,6 +117,11 @@ const VEHICLE_OPTIONS = new Map([
     '--service-interval-months',
     { field: 'serviceIntervalMonths', type: 'integer', min: 1, max: 120 }
   ],
+  ['--service-interval-days', { field: 'serviceIntervalDays', type: 'integer', min: 1, max: 3650 }],
+  [
+    '--service-interval-weeks',
+    { field: 'serviceIntervalDays', type: 'integer', min: 1, max: 521, multiplier: 7 }
+  ],
   ['--operational-status', { field: 'operationalStatus', type: 'status' }],
   ['--assigned-driver-name', { field: 'assignedDriverName', type: 'string' }],
   ['--assigned-driver-contact', { field: 'assignedDriverContact', type: 'string' }],
@@ -160,11 +170,22 @@ function parseVehicleValue(name, value, config) {
 
 function vehicleBody(args, { allowClear = false } = {}) {
   const body = {};
+  const intervalOptions = [
+    '--service-interval-days',
+    '--service-interval-weeks',
+    '--service-interval-months'
+  ];
+  if (intervalOptions.filter((name) => args.includes(name)).length > 1) {
+    throw new Error('Choose one service interval unit: days, weeks or months.');
+  }
   const recognised = new Set(['--json']);
   for (const [name, config] of VEHICLE_OPTIONS) {
     recognised.add(name);
     const value = requiredValue(args, name);
-    if (value !== null) body[config.field] = parseVehicleValue(name, value, config);
+    if (value !== null) {
+      const parsed = parseVehicleValue(name, value, config);
+      body[config.field] = config.multiplier ? parsed * config.multiplier : parsed;
+    }
   }
 
   if (allowClear) {
@@ -189,6 +210,8 @@ function vehicleBody(args, { allowClear = false } = {}) {
   for (const arg of args) {
     if (arg.startsWith('--') && !recognised.has(arg)) throw new Error(`Unknown option: ${arg}.`);
   }
+  if (body.serviceIntervalDays != null) body.serviceIntervalMonths = null;
+  if (body.serviceIntervalMonths != null) body.serviceIntervalDays = null;
   return body;
 }
 

package/operations.mjs

@@ -34,6 +34,7 @@ const definitions = [
   ['previewVehicleImport', 'POST', '/api/v1/imports/vehicles/preview', 'vehicles:read'],
   ['applyVehicleImport', 'POST', '/api/v1/imports/vehicles/apply', 'vehicles:write'],
   ['getWalkaroundDefinition', 'GET', '/api/v1/operations/walkaround-definition', 'operations:read'],
+  ['getWalkaroundSummary', 'GET', '/api/v1/operations/walkaround-summary', 'operations:read'],
   [
     'listWalkarounds',
     'GET',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fleetkeep/cli",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Operate every published Fleetkeep API workflow with guarded writes and machine-readable output",
   "type": "module",
   "bin": {