@slothmoney/agent-cli 0.2.0 → 0.3.0

package/dist/contracts.js

@@ -38,12 +38,18 @@ function validateAssignment(value, index) {
     const assignment = requireObject(value, label);
     rejectUnknownFields(assignment, new Set([
         'transactionRef',
+        'assignmentScope',
         'categoryId',
         'lineItemId',
         'categorySplits',
         'incomeSubtype',
     ]), label);
     requireString(assignment.transactionRef, `${label}.transactionRef`);
+    if (assignment.assignmentScope !== undefined
+        && assignment.assignmentScope !== 'personal'
+        && assignment.assignmentScope !== 'joint') {
+        throw new UsageError(`${label}.assignmentScope must be personal or joint`);
+    }
     if (assignment.categoryId !== undefined && assignment.categoryId !== null) {
         requireString(assignment.categoryId, `${label}.categoryId`);
     }
@@ -74,6 +80,9 @@ function validateAssignment(value, index) {
     }
     return {
         transactionRef: assignment.transactionRef,
+        ...(assignment.assignmentScope !== undefined
+            ? { assignmentScope: assignment.assignmentScope }
+            : {}),
         ...(assignment.categoryId !== undefined ? { categoryId: assignment.categoryId } : {}),
         ...(assignment.lineItemId !== undefined ? { lineItemId: assignment.lineItemId } : {}),
         ...(categorySplits !== undefined ? { categorySplits } : {}),
@@ -130,6 +139,20 @@ function isTransaction(value) {
         && (value.categoryId === null || typeof value.categoryId === 'string')
         && (value.lineItemId === null || typeof value.lineItemId === 'string')
         && Array.isArray(value.categorySplits)
+        && (value.jointBudgetContribution === null
+            || (isObject(value.jointBudgetContribution)
+                && typeof value.jointBudgetContribution.eligible === 'boolean'
+                && typeof value.jointBudgetContribution.included === 'boolean'
+                && Number.isInteger(value.jointBudgetContribution.amountPence)
+                && Number(value.jointBudgetContribution.amountPence) > 0
+                && (value.jointBudgetContribution.categoryId === null
+                    || typeof value.jointBudgetContribution.categoryId === 'string')
+                && (value.jointBudgetContribution.lineItemId === null
+                    || typeof value.jointBudgetContribution.lineItemId === 'string')
+                && Array.isArray(value.jointBudgetContribution.categorySplits)
+                && (value.jointBudgetContribution.incomeSubtype === null
+                    || value.jointBudgetContribution.incomeSubtype === 'pay'
+                    || value.jointBudgetContribution.incomeSubtype === 'interest')))
         && (value.incomeSubtype === null
             || value.incomeSubtype === 'pay'
             || value.incomeSubtype === 'interest'));
@@ -143,12 +166,28 @@ function isTransactionsResponse(value) {
 function isAssignmentResponse(value) {
     return (isObject(value)
         && Array.isArray(value.succeeded)
-        && value.succeeded.every((item) => isObject(item) && typeof item.transactionRef === 'string')
+        && value.succeeded.every((item) => (isObject(item)
+            && typeof item.transactionRef === 'string'
+            && (item.assignmentScope === 'personal' || item.assignmentScope === 'joint')))
         && Array.isArray(value.failed)
         && value.failed.every((item) => (isObject(item)
             && typeof item.error === 'string'
             && (item.transactionRef === undefined || typeof item.transactionRef === 'string'))));
 }
+export function validateJointBudgetSettingsResponse(value) {
+    if (!isObject(value)
+        || Object.keys(value).some((key) => !new Set([
+            'includeSharedPersonalTransactions',
+            'updatedAt',
+            'updatedBy',
+        ]).has(key))
+        || typeof value.includeSharedPersonalTransactions !== 'boolean'
+        || (value.updatedAt !== null && !isIsoDateTime(value.updatedAt))
+        || (value.updatedBy !== null && typeof value.updatedBy !== 'string')) {
+        throw new ApiError('Invalid joint budget settings response from the Agent API');
+    }
+    return value;
+}
 function isHttpUrl(value) {
     if (typeof value !== 'string')
         return false;
@@ -175,6 +214,55 @@ function isPartnerResponse(value) {
         && isIsoDateTime(value.expiresAt)
         && value.status === 'open');
 }
+function hasOnlyFields(value, fields) {
+    const allowed = new Set(fields);
+    return Object.keys(value).every((key) => allowed.has(key));
+}
+function isGoal(value) {
+    return (isObject(value)
+        && hasOnlyFields(value, [
+            'id',
+            'name',
+            'targetAmount',
+            'targetMonthKey',
+            'isAchieved',
+            'sharedWithPartner',
+        ])
+        && typeof value.id === 'string'
+        && value.id.trim().length > 0
+        && typeof value.name === 'string'
+        && value.name.trim().length > 0
+        && (value.targetAmount === null
+            || (typeof value.targetAmount === 'number' && Number.isFinite(value.targetAmount)))
+        && (value.targetMonthKey === null
+            || (typeof value.targetMonthKey === 'string'
+                && /^\d{4}-(0[1-9]|1[0-2])$/.test(value.targetMonthKey)))
+        && typeof value.isAchieved === 'boolean'
+        && typeof value.sharedWithPartner === 'boolean');
+}
+function isCurrency(value) {
+    return typeof value === 'string' && /^[A-Z]{3}$/.test(value);
+}
+function isGoalsResponse(value) {
+    return (isObject(value)
+        && hasOnlyFields(value, ['currency', 'goals'])
+        && isCurrency(value.currency)
+        && Array.isArray(value.goals)
+        && value.goals.every(isGoal));
+}
+function isGoalMutationResponse(value) {
+    return (isObject(value)
+        && hasOnlyFields(value, ['currency', 'goal'])
+        && isCurrency(value.currency)
+        && isGoal(value.goal));
+}
+function isGoalDeleteResponse(value) {
+    return (isObject(value)
+        && hasOnlyFields(value, ['deleted', 'deletedGoalId'])
+        && value.deleted === true
+        && typeof value.deletedGoalId === 'string'
+        && value.deletedGoalId.trim().length > 0);
+}
 export function parseApiResponse(command, value) {
     const valid = command === 'categories'
         ? isCategoryResponse(value)
@@ -182,7 +270,13 @@ export function parseApiResponse(command, value) {
             ? isTransactionsResponse(value)
             : command === 'assign'
                 ? isAssignmentResponse(value)
-                : isPartnerResponse(value);
+                : command === 'ask-partner'
+                    ? isPartnerResponse(value)
+                    : command === 'goals-list'
+                        ? isGoalsResponse(value)
+                        : command === 'goals-delete'
+                            ? isGoalDeleteResponse(value)
+                            : isGoalMutationResponse(value);
     if (!valid) {
         const label = command === 'assign' ? 'assignment' : command;
         throw new ApiError(`Invalid ${label} response from the Agent API`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slothmoney/agent-cli",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Command-line access to the Sloth Money Agent API.",
   "type": "module",
   "bin": {