node-autotask 0.33.0 → 0.34.0

package/capabilities.schema.json

@@ -396,6 +396,38 @@
                         }
                       }
                     },
+                    "caveats": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "kind",
+                          "note"
+                        ],
+                        "properties": {
+                          "kind": {
+                            "enum": [
+                              "not-persisted"
+                            ]
+                          },
+                          "fields": {
+                            "type": "array",
+                            "items": {
+                              "type": "string",
+                              "minLength": 1
+                            }
+                          },
+                          "note": {
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "remedyOp": {
+                            "type": "string",
+                            "minLength": 1
+                          }
+                        }
+                      }
+                    },
                     "createRequirements": {
                       "type": "object",
                       "properties": {

package/dist/capabilities.cjs

@@ -2,9 +2,9 @@
 
 
 
-var _chunkSP2SJJZXcjs = require('./chunk-SP2SJJZX.cjs');
+var _chunkFOOHJBPPcjs = require('./chunk-FOOHJBPP.cjs');
 
 
 
 
-exports.CAPABILITIES = _chunkSP2SJJZXcjs.CAPABILITIES; exports.CAPABILITY_GROUPS = _chunkSP2SJJZXcjs.CAPABILITY_GROUPS; exports.CAPABILITY_PLAN_HASHES = _chunkSP2SJJZXcjs.CAPABILITY_PLAN_HASHES;
+exports.CAPABILITIES = _chunkFOOHJBPPcjs.CAPABILITIES; exports.CAPABILITY_GROUPS = _chunkFOOHJBPPcjs.CAPABILITY_GROUPS; exports.CAPABILITY_PLAN_HASHES = _chunkFOOHJBPPcjs.CAPABILITY_PLAN_HASHES;

package/dist/capabilities.d.cts

@@ -25,6 +25,17 @@ interface CapabilityArgSchema {
         default?: number | boolean | string | string[];
     }>;
 }
+/** One per-operation caveat (issue #249): the closed-kind row served on `metadata.caveats`. */
+interface CapabilityCaveat {
+    /** The closed caveat kind. `not-persisted`: the op accepts the listed `fields` but the vendor does not store them. */
+    kind: 'not-persisted';
+    /** The affected vendor field names (required for `not-persisted`). */
+    fields?: string[];
+    /** One sentence for the caller. */
+    note: string;
+    /** The operation id that does what this op cannot (e.g. 'time_entries.moveToTicket'). */
+    remedyOp?: string;
+}
 /** One registered capability (a plan row that is implemented/tested). */
 interface CapabilityRecord {
     /** Plan row id, e.g. 'companies.query' or 'companies.search'. */
@@ -104,6 +115,7 @@ interface CapabilityRecord {
     };
     /** Stable error codes this operation can emit (plan column pass-through). */
     errors: string[];
+    /** The descriptor bag (purpose, usage, ...). Optional `caveats?: CapabilityCaveat[]` (issue #249) names fields an op accepts but the vendor does not store. */
     metadata: Record<string, unknown>;
     /** Compact summary shape name, or null. */
     compact: string | null;
@@ -132,4 +144,4 @@ declare const CAPABILITIES: CapabilityRecord[];
 /** The plan hash per built group (staleness gate input). */
 declare const CAPABILITY_PLAN_HASHES: Record<string, string>;
 
-export { CAPABILITIES, CAPABILITY_GROUPS, CAPABILITY_PLAN_HASHES, type CapabilityArgSchema, type CapabilityRecord };
+export { CAPABILITIES, CAPABILITY_GROUPS, CAPABILITY_PLAN_HASHES, type CapabilityArgSchema, type CapabilityCaveat, type CapabilityRecord };

package/dist/capabilities.d.ts

@@ -25,6 +25,17 @@ interface CapabilityArgSchema {
         default?: number | boolean | string | string[];
     }>;
 }
+/** One per-operation caveat (issue #249): the closed-kind row served on `metadata.caveats`. */
+interface CapabilityCaveat {
+    /** The closed caveat kind. `not-persisted`: the op accepts the listed `fields` but the vendor does not store them. */
+    kind: 'not-persisted';
+    /** The affected vendor field names (required for `not-persisted`). */
+    fields?: string[];
+    /** One sentence for the caller. */
+    note: string;
+    /** The operation id that does what this op cannot (e.g. 'time_entries.moveToTicket'). */
+    remedyOp?: string;
+}
 /** One registered capability (a plan row that is implemented/tested). */
 interface CapabilityRecord {
     /** Plan row id, e.g. 'companies.query' or 'companies.search'. */
@@ -104,6 +115,7 @@ interface CapabilityRecord {
     };
     /** Stable error codes this operation can emit (plan column pass-through). */
     errors: string[];
+    /** The descriptor bag (purpose, usage, ...). Optional `caveats?: CapabilityCaveat[]` (issue #249) names fields an op accepts but the vendor does not store. */
     metadata: Record<string, unknown>;
     /** Compact summary shape name, or null. */
     compact: string | null;
@@ -132,4 +144,4 @@ declare const CAPABILITIES: CapabilityRecord[];
 /** The plan hash per built group (staleness gate input). */
 declare const CAPABILITY_PLAN_HASHES: Record<string, string>;
 
-export { CAPABILITIES, CAPABILITY_GROUPS, CAPABILITY_PLAN_HASHES, type CapabilityArgSchema, type CapabilityRecord };
+export { CAPABILITIES, CAPABILITY_GROUPS, CAPABILITY_PLAN_HASHES, type CapabilityArgSchema, type CapabilityCaveat, type CapabilityRecord };

package/dist/capabilities.js

@@ -2,7 +2,7 @@ import {
   CAPABILITIES,
   CAPABILITY_GROUPS,
   CAPABILITY_PLAN_HASHES
-} from "./chunk-VKE56TTN.js";
+} from "./chunk-4MUBUSTL.js";
 export {
   CAPABILITIES,
   CAPABILITY_GROUPS,