node-autotask 0.67.0 → 0.68.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/MCP_TOOL_CATALOG.json +28 -9
  3. package/README.md +1 -1
  4. package/capabilities.json +107 -8
  5. package/dist/capabilities-data.js +106 -7
  6. package/dist/capabilities.cjs +4 -4
  7. package/dist/capabilities.js +1 -1
  8. package/dist/{chunk-UCPSQ6GN.js → chunk-BF22HBNT.js} +2 -2
  9. package/dist/{chunk-54L7KKUD.cjs → chunk-CG6OPTFG.cjs} +31 -31
  10. package/dist/{chunk-N7WB65IS.js → chunk-DPJLN5BB.js} +2598 -2305
  11. package/dist/{chunk-C7M7PXLW.cjs → chunk-HFWOHUVF.cjs} +173 -173
  12. package/dist/{chunk-4GH73U2I.js → chunk-JCMXQUIC.js} +3 -3
  13. package/dist/{chunk-EXLJHU5W.js → chunk-OUVUQQXH.js} +2 -2
  14. package/dist/{chunk-7GBOQ7YA.cjs → chunk-SGH7F2CH.cjs} +3 -3
  15. package/dist/{chunk-VO4ABDZA.cjs → chunk-V2GE763R.cjs} +2602 -2308
  16. package/dist/{index-CYlKHo5N.d.ts → index-DQ08uOH0.d.ts} +45 -5
  17. package/dist/{index-D_1wP3Je.d.cts → index-mIsdpO5d.d.cts} +45 -5
  18. package/dist/index.cjs +84 -84
  19. package/dist/index.d.cts +2 -2
  20. package/dist/index.d.ts +2 -2
  21. package/dist/index.js +5 -5
  22. package/dist/operations/index.cjs +50 -50
  23. package/dist/operations/index.d.cts +2 -2
  24. package/dist/operations/index.d.ts +2 -2
  25. package/dist/operations/index.js +2 -2
  26. package/dist/pool.cjs +29 -11
  27. package/dist/pool.js +25 -7
  28. package/dist/resources/index.cjs +27 -27
  29. package/dist/resources/index.d.cts +1 -1
  30. package/dist/resources/index.d.ts +1 -1
  31. package/dist/resources/index.js +3 -3
  32. package/docs/API.md +3 -3
  33. package/docs/VENDOR-QUIRKS.md +32 -0
  34. package/package.json +1 -1
@@ -32,7 +32,7 @@ import { L as Logger } from './logger-B1gYmFre.js';
32
32
  * queryBounded noteChars free-text cap (issue #61 — response-side only);
33
33
  * - docs/VENDOR-QUIRKS.md §11.7/§11.8/§11.9/§11.10/§11.11/§11.12 render the same facts.
34
34
  *
35
- * planHash: 448bad244d0dfa1f8af0f6dfa4bc1a080ca60a114dc10366660585ff2dbc3e55
35
+ * planHash: 04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70
36
36
  */
37
37
 
38
38
  /** One pinned blind-surface stamp (the result-time sentinel object). */
@@ -450,7 +450,7 @@ interface AutotaskConfig {
450
450
  /**
451
451
  * The SDK's in-memory caches (issue #286), ON by default: an absent block
452
452
  * builds them with the defaults; `cache: false` turns every channel off
453
- * (every read goes to the wire). Two channels:
453
+ * (every read goes to the wire). Ordinary read channels:
454
454
  * - single-record reads (get-by-id, the id branch of `resolve`, the
455
455
  * composite FK reads and `operations.expandResourceNames` names): `ttlMs`
456
456
  * (default `DEFAULT_READ_CACHE_TTL_MS`, 5 min); the reference tables
@@ -459,12 +459,16 @@ interface AutotaskConfig {
459
459
  * - entity field metadata: `fieldTtlMs` (default
460
460
  * `DEFAULT_FIELD_CACHE_TTL_MS`, 5 min); a vendor drift signal drops the
461
461
  * entity's entries.
462
- * Lists, queries, counts, mutations and errors are never cached. TTLs are
462
+ * A separate companies.searchFuzzy name index refreshes every 30 min
463
+ * (`companyIndexTtlMs`) and after company mutations. cache: false disables it.
464
+ * Ordinary lists, queries, counts, mutations and errors are never cached. TTLs are
463
465
  * positive integers (ms).
464
466
  */
465
467
  cache?: false | {
466
468
  ttlMs?: number;
467
469
  fieldTtlMs?: number;
470
+ /** Company fuzzy-name index refresh interval (default 30 minutes). */
471
+ companyIndexTtlMs?: number;
468
472
  /**
469
473
  * Advanced (issue #219 N6): supply the record-cache INSTANCE instead of
470
474
  * letting the client build one. `ClientPool` shares one per tenant
@@ -593,6 +597,8 @@ interface ResolvedAutotaskConfig {
593
597
  readCache?: TtlCache;
594
598
  /** The field-metadata cache (absent only for `cache: false`). */
595
599
  fieldCache?: TtlCache;
600
+ /** Separate fuzzy company-name index refresh interval (absent when cache is off). */
601
+ companyIndexTtlMs?: number;
596
602
  /** Resolved update fallback gate (final value; OFF by default, issue #34). */
597
603
  update: {
598
604
  putFallback: boolean;
@@ -720,6 +726,7 @@ declare class HttpClient {
720
726
  readonly resolution: ResolutionCaps;
721
727
  /** Record-read cache (absent only for `cache: false`; issue #286). */
722
728
  readonly readCache: TtlCache | undefined;
729
+ readonly companyIndexTtlMs: number | undefined;
723
730
  /** Field-metadata cache for the entityInformation trio (absent only for `cache: false`). */
724
731
  readonly fieldCache: TtlCache | undefined;
725
732
  /** Resolved update fallback gate (issue #34; OFF by default). */
@@ -881,6 +888,14 @@ declare class AuthenticateResource {
881
888
  get(): Promise<AuthTokenResultModel>;
882
889
  }
883
890
 
891
+ /** SDK-owned company-name index, separate from the clone-on-read record cache. */
892
+
893
+ type CompanyNameRecord = Pick<Company, 'id' | 'companyName' | 'isActive' | 'parentCompanyID'>;
894
+ interface CompanyIndexState {
895
+ state: 'warm' | 'building' | 'cold' | 'off';
896
+ builtAt?: string;
897
+ }
898
+
884
899
  interface CompanySearchOptions {
885
900
  /** Max companies to return (default 25, clamped to 1..500). */
886
901
  limit?: number;
@@ -903,6 +918,29 @@ interface CompanyFamilyRow extends Company {
903
918
  family?: CompanyFamily;
904
919
  }
905
920
 
921
+ interface CompanyFuzzySearchOptions {
922
+ limit?: number;
923
+ includeFamily?: boolean;
924
+ includeInactive?: boolean;
925
+ }
926
+ interface FuzzyCompanyRow {
927
+ record: CompanyNameRecord & {
928
+ family?: CompanyFamily;
929
+ };
930
+ distance: number;
931
+ matchedTerms: string[];
932
+ /** Number of query words covered. */
933
+ coverage: number;
934
+ source: 'index' | 'live' | 'both';
935
+ }
936
+ interface CompanyFuzzySearchResult {
937
+ items: FuzzyCompanyRow[];
938
+ tier: 'index+live' | 'live';
939
+ truncated: boolean;
940
+ pieces: string[];
941
+ index: CompanyIndexState;
942
+ }
943
+
906
944
  /** One hop's status: ok (record served), missing (the pointer is absent — or,
907
945
  * for a level hop, the parent association row did not resolve so the pointer
908
946
  * was never read), unresolved (the pointer exists but the vendor returned no
@@ -1244,6 +1282,8 @@ declare class CompaniesResource extends GenericResource<Company, CompanyCreate,
1244
1282
  * capped at 50 with the childIDsTruncated flag; the blind-surface blindNote — the
1245
1283
  * family is reported as SEEN BY THIS API USER, never as complete). */
1246
1284
  search(query: string, opts?: CompanySearchOptions): Promise<CompanyFamilyRow[]>;
1285
+ /** Typo-tolerant candidates from an uncached live query plus the SDK name index. */
1286
+ searchFuzzy(query: string, opts?: CompanyFuzzySearchOptions): Promise<CompanyFuzzySearchResult>;
1247
1287
  /** `search` with an empty result explained. Same closed opts discipline as `search`: only `limit` is
1248
1288
  * accepted here (an unknown key is refused pre-request, zero wire — never silently dropped); the
1249
1289
  * family block is a `search`-only option. */
@@ -3765,5 +3805,5 @@ declare class GenericResource<T = Record<string, unknown>, TCreate extends objec
3765
3805
  download(parentId: Identifier, id: Identifier): Promise<Buffer>;
3766
3806
  }
3767
3807
 
3768
- export { VersionResource as $, TicketChargesResource as B, CompaniesResource as C, TicketsResource as D, EntityInformationResource as E, GenericResource as G, InventoryProductsResource as I, ModulesResource as M, QuotesResource as Q, ResourceTimeOffAdditionalResource as R, SIMPLE_RESOURCES as S, TimeEntriesResource as V, TimeOffRequestsResource as Y, TtlCache as Z, VersionInformationResource as _, AutotaskClient as a, ZONES as a0, ZoneInformationResource as a1, FIELD_CACHE_KINDS as ab, AuthenticateResource as c, ConfigurationItemsResource as d, ContactsResource as e, ContractsResource as g, InvoicesResource as j, ResourceTimeOffBalancesResource as v, ResourcesResource as w, ServiceCallsResource as x, ThresholdInformationResource as z };
3769
- export type { AutotaskConfig as A, TimeEntriesPostedCountResult as F, HelperFlags as H, TimeEntriesPostedPagingOptions as J, TimeEntriesPostedWindowCountOptions as K, TimeEntriesPostedWindowListOptions as L, TimeEntriesPostedWindowOptions as N, OpsFlags as O, ProfitRateSource as P, TicketChangeStatusResult as T, TimeEntriesPostedWindowResult as U, TimeEntryReviewFields as W, TimeEntryReviewResult as X, ZoneName as a2, RowNamesSummary as a3, BlindSurfaceInfo as a4, RelationshipResource as a5, CreateGuidanceValueRequirement as a6, CreateGuidanceRow as a7, CreateBlockerKind as a8, CreateGuidanceReport as a9, FieldCacheKind as aa, TicketChangeStatusNoChange as b, ContractsProfitabilityResult as f, CostRateResolution as h, GenericResourceConfig as i, ProfitabilityActivityCategory as k, ProfitabilityDataQualityWarning as l, ProfitabilityHighestCostTicket as m, ProfitabilityLabourCostMethod as n, ProfitabilityMiscoding as o, ProfitabilityMonthlyRow as p, ProfitabilityOpenRenewalItem as q, ProfitabilityOptions as r, ProfitabilityPart as s, ProfitabilityPartDigest as t, ProfitabilityRevenueByType as u, SimpleResourceEntry as y };
3808
+ export { TimeOffRequestsResource as $, CompaniesResource as C, ThresholdInformationResource as D, EntityInformationResource as E, GenericResource as G, InventoryProductsResource as I, TicketChargesResource as J, TicketsResource as K, ModulesResource as M, QuotesResource as Q, ResourceTimeOffAdditionalResource as R, SIMPLE_RESOURCES as S, TimeEntriesResource as Y, AutotaskClient as a, TtlCache as a0, VersionInformationResource as a1, VersionResource as a2, ZONES as a3, ZoneInformationResource as a4, FIELD_CACHE_KINDS as ae, AuthenticateResource as c, ConfigurationItemsResource as f, ContactsResource as g, ContractsResource as i, InvoicesResource as l, ResourceTimeOffBalancesResource as x, ResourcesResource as y, ServiceCallsResource as z };
3809
+ export type { AutotaskConfig as A, SimpleResourceEntry as B, FuzzyCompanyRow as F, HelperFlags as H, TimeEntriesPostedCountResult as L, TimeEntriesPostedPagingOptions as N, OpsFlags as O, ProfitRateSource as P, TicketChangeStatusResult as T, TimeEntriesPostedWindowCountOptions as U, TimeEntriesPostedWindowListOptions as V, TimeEntriesPostedWindowOptions as W, TimeEntriesPostedWindowResult as X, TimeEntryReviewFields as Z, TimeEntryReviewResult as _, ZoneName as a5, RowNamesSummary as a6, BlindSurfaceInfo as a7, RelationshipResource as a8, CreateGuidanceValueRequirement as a9, CreateGuidanceRow as aa, CreateBlockerKind as ab, CreateGuidanceReport as ac, FieldCacheKind as ad, TicketChangeStatusNoChange as b, CompanyFuzzySearchOptions as d, CompanyFuzzySearchResult as e, ContractsProfitabilityResult as h, CostRateResolution as j, GenericResourceConfig as k, ProfitabilityActivityCategory as m, ProfitabilityDataQualityWarning as n, ProfitabilityHighestCostTicket as o, ProfitabilityLabourCostMethod as p, ProfitabilityMiscoding as q, ProfitabilityMonthlyRow as r, ProfitabilityOpenRenewalItem as s, ProfitabilityOptions as t, ProfitabilityPart as u, ProfitabilityPartDigest as v, ProfitabilityRevenueByType as w };
@@ -32,7 +32,7 @@ import { L as Logger } from './logger-B1gYmFre.cjs';
32
32
  * queryBounded noteChars free-text cap (issue #61 — response-side only);
33
33
  * - docs/VENDOR-QUIRKS.md §11.7/§11.8/§11.9/§11.10/§11.11/§11.12 render the same facts.
34
34
  *
35
- * planHash: 448bad244d0dfa1f8af0f6dfa4bc1a080ca60a114dc10366660585ff2dbc3e55
35
+ * planHash: 04fb614dcdd035a01636e51cf38d8178aeef7c9a1b45faf4af6187875800bd70
36
36
  */
37
37
 
38
38
  /** One pinned blind-surface stamp (the result-time sentinel object). */
@@ -450,7 +450,7 @@ interface AutotaskConfig {
450
450
  /**
451
451
  * The SDK's in-memory caches (issue #286), ON by default: an absent block
452
452
  * builds them with the defaults; `cache: false` turns every channel off
453
- * (every read goes to the wire). Two channels:
453
+ * (every read goes to the wire). Ordinary read channels:
454
454
  * - single-record reads (get-by-id, the id branch of `resolve`, the
455
455
  * composite FK reads and `operations.expandResourceNames` names): `ttlMs`
456
456
  * (default `DEFAULT_READ_CACHE_TTL_MS`, 5 min); the reference tables
@@ -459,12 +459,16 @@ interface AutotaskConfig {
459
459
  * - entity field metadata: `fieldTtlMs` (default
460
460
  * `DEFAULT_FIELD_CACHE_TTL_MS`, 5 min); a vendor drift signal drops the
461
461
  * entity's entries.
462
- * Lists, queries, counts, mutations and errors are never cached. TTLs are
462
+ * A separate companies.searchFuzzy name index refreshes every 30 min
463
+ * (`companyIndexTtlMs`) and after company mutations. cache: false disables it.
464
+ * Ordinary lists, queries, counts, mutations and errors are never cached. TTLs are
463
465
  * positive integers (ms).
464
466
  */
465
467
  cache?: false | {
466
468
  ttlMs?: number;
467
469
  fieldTtlMs?: number;
470
+ /** Company fuzzy-name index refresh interval (default 30 minutes). */
471
+ companyIndexTtlMs?: number;
468
472
  /**
469
473
  * Advanced (issue #219 N6): supply the record-cache INSTANCE instead of
470
474
  * letting the client build one. `ClientPool` shares one per tenant
@@ -593,6 +597,8 @@ interface ResolvedAutotaskConfig {
593
597
  readCache?: TtlCache;
594
598
  /** The field-metadata cache (absent only for `cache: false`). */
595
599
  fieldCache?: TtlCache;
600
+ /** Separate fuzzy company-name index refresh interval (absent when cache is off). */
601
+ companyIndexTtlMs?: number;
596
602
  /** Resolved update fallback gate (final value; OFF by default, issue #34). */
597
603
  update: {
598
604
  putFallback: boolean;
@@ -720,6 +726,7 @@ declare class HttpClient {
720
726
  readonly resolution: ResolutionCaps;
721
727
  /** Record-read cache (absent only for `cache: false`; issue #286). */
722
728
  readonly readCache: TtlCache | undefined;
729
+ readonly companyIndexTtlMs: number | undefined;
723
730
  /** Field-metadata cache for the entityInformation trio (absent only for `cache: false`). */
724
731
  readonly fieldCache: TtlCache | undefined;
725
732
  /** Resolved update fallback gate (issue #34; OFF by default). */
@@ -881,6 +888,14 @@ declare class AuthenticateResource {
881
888
  get(): Promise<AuthTokenResultModel>;
882
889
  }
883
890
 
891
+ /** SDK-owned company-name index, separate from the clone-on-read record cache. */
892
+
893
+ type CompanyNameRecord = Pick<Company, 'id' | 'companyName' | 'isActive' | 'parentCompanyID'>;
894
+ interface CompanyIndexState {
895
+ state: 'warm' | 'building' | 'cold' | 'off';
896
+ builtAt?: string;
897
+ }
898
+
884
899
  interface CompanySearchOptions {
885
900
  /** Max companies to return (default 25, clamped to 1..500). */
886
901
  limit?: number;
@@ -903,6 +918,29 @@ interface CompanyFamilyRow extends Company {
903
918
  family?: CompanyFamily;
904
919
  }
905
920
 
921
+ interface CompanyFuzzySearchOptions {
922
+ limit?: number;
923
+ includeFamily?: boolean;
924
+ includeInactive?: boolean;
925
+ }
926
+ interface FuzzyCompanyRow {
927
+ record: CompanyNameRecord & {
928
+ family?: CompanyFamily;
929
+ };
930
+ distance: number;
931
+ matchedTerms: string[];
932
+ /** Number of query words covered. */
933
+ coverage: number;
934
+ source: 'index' | 'live' | 'both';
935
+ }
936
+ interface CompanyFuzzySearchResult {
937
+ items: FuzzyCompanyRow[];
938
+ tier: 'index+live' | 'live';
939
+ truncated: boolean;
940
+ pieces: string[];
941
+ index: CompanyIndexState;
942
+ }
943
+
906
944
  /** One hop's status: ok (record served), missing (the pointer is absent — or,
907
945
  * for a level hop, the parent association row did not resolve so the pointer
908
946
  * was never read), unresolved (the pointer exists but the vendor returned no
@@ -1244,6 +1282,8 @@ declare class CompaniesResource extends GenericResource<Company, CompanyCreate,
1244
1282
  * capped at 50 with the childIDsTruncated flag; the blind-surface blindNote — the
1245
1283
  * family is reported as SEEN BY THIS API USER, never as complete). */
1246
1284
  search(query: string, opts?: CompanySearchOptions): Promise<CompanyFamilyRow[]>;
1285
+ /** Typo-tolerant candidates from an uncached live query plus the SDK name index. */
1286
+ searchFuzzy(query: string, opts?: CompanyFuzzySearchOptions): Promise<CompanyFuzzySearchResult>;
1247
1287
  /** `search` with an empty result explained. Same closed opts discipline as `search`: only `limit` is
1248
1288
  * accepted here (an unknown key is refused pre-request, zero wire — never silently dropped); the
1249
1289
  * family block is a `search`-only option. */
@@ -3765,5 +3805,5 @@ declare class GenericResource<T = Record<string, unknown>, TCreate extends objec
3765
3805
  download(parentId: Identifier, id: Identifier): Promise<Buffer>;
3766
3806
  }
3767
3807
 
3768
- export { VersionResource as $, TicketChargesResource as B, CompaniesResource as C, TicketsResource as D, EntityInformationResource as E, GenericResource as G, InventoryProductsResource as I, ModulesResource as M, QuotesResource as Q, ResourceTimeOffAdditionalResource as R, SIMPLE_RESOURCES as S, TimeEntriesResource as V, TimeOffRequestsResource as Y, TtlCache as Z, VersionInformationResource as _, AutotaskClient as a, ZONES as a0, ZoneInformationResource as a1, FIELD_CACHE_KINDS as ab, AuthenticateResource as c, ConfigurationItemsResource as d, ContactsResource as e, ContractsResource as g, InvoicesResource as j, ResourceTimeOffBalancesResource as v, ResourcesResource as w, ServiceCallsResource as x, ThresholdInformationResource as z };
3769
- export type { AutotaskConfig as A, TimeEntriesPostedCountResult as F, HelperFlags as H, TimeEntriesPostedPagingOptions as J, TimeEntriesPostedWindowCountOptions as K, TimeEntriesPostedWindowListOptions as L, TimeEntriesPostedWindowOptions as N, OpsFlags as O, ProfitRateSource as P, TicketChangeStatusResult as T, TimeEntriesPostedWindowResult as U, TimeEntryReviewFields as W, TimeEntryReviewResult as X, ZoneName as a2, RowNamesSummary as a3, BlindSurfaceInfo as a4, RelationshipResource as a5, CreateGuidanceValueRequirement as a6, CreateGuidanceRow as a7, CreateBlockerKind as a8, CreateGuidanceReport as a9, FieldCacheKind as aa, TicketChangeStatusNoChange as b, ContractsProfitabilityResult as f, CostRateResolution as h, GenericResourceConfig as i, ProfitabilityActivityCategory as k, ProfitabilityDataQualityWarning as l, ProfitabilityHighestCostTicket as m, ProfitabilityLabourCostMethod as n, ProfitabilityMiscoding as o, ProfitabilityMonthlyRow as p, ProfitabilityOpenRenewalItem as q, ProfitabilityOptions as r, ProfitabilityPart as s, ProfitabilityPartDigest as t, ProfitabilityRevenueByType as u, SimpleResourceEntry as y };
3808
+ export { TimeOffRequestsResource as $, CompaniesResource as C, ThresholdInformationResource as D, EntityInformationResource as E, GenericResource as G, InventoryProductsResource as I, TicketChargesResource as J, TicketsResource as K, ModulesResource as M, QuotesResource as Q, ResourceTimeOffAdditionalResource as R, SIMPLE_RESOURCES as S, TimeEntriesResource as Y, AutotaskClient as a, TtlCache as a0, VersionInformationResource as a1, VersionResource as a2, ZONES as a3, ZoneInformationResource as a4, FIELD_CACHE_KINDS as ae, AuthenticateResource as c, ConfigurationItemsResource as f, ContactsResource as g, ContractsResource as i, InvoicesResource as l, ResourceTimeOffBalancesResource as x, ResourcesResource as y, ServiceCallsResource as z };
3809
+ export type { AutotaskConfig as A, SimpleResourceEntry as B, FuzzyCompanyRow as F, HelperFlags as H, TimeEntriesPostedCountResult as L, TimeEntriesPostedPagingOptions as N, OpsFlags as O, ProfitRateSource as P, TicketChangeStatusResult as T, TimeEntriesPostedWindowCountOptions as U, TimeEntriesPostedWindowListOptions as V, TimeEntriesPostedWindowOptions as W, TimeEntriesPostedWindowResult as X, TimeEntryReviewFields as Z, TimeEntryReviewResult as _, ZoneName as a5, RowNamesSummary as a6, BlindSurfaceInfo as a7, RelationshipResource as a8, CreateGuidanceValueRequirement as a9, CreateGuidanceRow as aa, CreateBlockerKind as ab, CreateGuidanceReport as ac, FieldCacheKind as ad, TicketChangeStatusNoChange as b, CompanyFuzzySearchOptions as d, CompanyFuzzySearchResult as e, ContractsProfitabilityResult as h, CostRateResolution as j, GenericResourceConfig as k, ProfitabilityActivityCategory as m, ProfitabilityDataQualityWarning as n, ProfitabilityHighestCostTicket as o, ProfitabilityLabourCostMethod as p, ProfitabilityMiscoding as q, ProfitabilityMonthlyRow as r, ProfitabilityOpenRenewalItem as s, ProfitabilityOptions as t, ProfitabilityPart as u, ProfitabilityPartDigest as v, ProfitabilityRevenueByType as w };