node-autotask 0.10.0 → 0.12.0

package/dist/operations/index.d.cts

@@ -1,7 +1,7 @@
-import { a as AutotaskClient, eN as BlindSurfaceInfo, eO as RelationshipResource, eP as BlindSurfaceInventory, eQ as BlindSurfaceRow, eR as CreateBlockerKind, eS as CreateGuidanceReport, eT as FieldCacheKind, g as AutotaskConfigError } from '../index-BOyh7S65.cjs';
-export { eU as FIELD_CACHE_KINDS } from '../index-BOyh7S65.cjs';
-import { I as Identifier, cE as EmptyReasonInfo, dI as PickListValue, a as FilterCondition } from '../index-cQ6CRexR.cjs';
-export { hp as PICKLIST_VALUE_NOT_SERVED_NOTE } from '../index-cQ6CRexR.cjs';
+import { a as AutotaskClient, eN as BlindSurfaceInfo, eO as RelationshipResource, eP as BlindSurfaceInventory, eQ as BlindSurfaceRow, eR as CreateBlockerKind, eS as CreateGuidanceReport, eT as FieldCacheKind, g as AutotaskConfigError } from '../index-D8I6taEo.cjs';
+export { eU as FIELD_CACHE_KINDS } from '../index-D8I6taEo.cjs';
+import { I as Identifier, cE as EmptyReasonInfo, dI as PickListValue, a as FilterCondition } from '../index-BXtKN1M5.cjs';
+export { hp as PICKLIST_VALUE_NOT_SERVED_NOTE } from '../index-BXtKN1M5.cjs';
 import { CapabilityRecord } from '../capabilities.cjs';
 
 /**
@@ -195,9 +195,27 @@ declare const AGGREGATE_TOP_MAX = 100;
 declare const AGGREGATE_DEFAULT_TOP = 25;
 /** The walk-mode default record cap = the house `BOUNDED_QUERY_MAX_LIMIT` (the hard max — `queryBounded` rejects above it). */
 declare const AGGREGATE_DEFAULT_LIMIT = 2500;
+/** The closed date-bucket suffix set (issue #101). */
+type DateBucket = 'month' | 'week' | 'year';
+declare const AGGREGATE_DATE_BUCKETS: readonly DateBucket[];
+/**
+ * The ISO bucket label of a date field value (issue #101), anchored on UTC —
+ * the same anchor the date-window ops use when `tz` is omitted: a date-only
+ * value is its UTC day, a zoned datetime is read at its instant, a zoneless
+ * datetime is read as a UTC wall time. Returns `null` for null/undefined
+ * (the one null bucket group — the raw-fold key normalisation) and the RAW
+ * value unchanged when it parses as no date (its own deterministic group —
+ * no silent drop).
+ */
+declare function dateBucketLabel(value: unknown, bucket: DateBucket): unknown;
 /** The closed opts bag for `operations.aggregate`. */
 interface AggregateOptions {
-    /** The group-by vendor field names (the group key = the field tuple). */
+    /** The group-by vendor field names (the group key = the field tuple). A
+     *  DATE-TYPED field may carry the closed bucket suffix `<field>@month` |
+     *  `<field>@week` | `<field>@year` (issue #101): the group key is named
+     *  by the full spec and carries the ISO bucket label (`2026-09` /
+     *  `2026-W38` / `2026`) read on the UTC calendar (the date-window ops'
+     *  omitted-`tz` anchor). */
     groupBy?: string[];
     /** The numeric vendor field names to sum per group. */
     sum?: string[];
@@ -894,4 +912,4 @@ declare function invokeWrite(client: AutotaskClient, operation: string, args?: r
  */
 declare function invokeDelete(client: AutotaskClient, operation: string, args?: readonly unknown[], opts?: InvokeOptions): Promise<unknown>;
 
-export { AGGREGATE_DEFAULT_LIMIT, AGGREGATE_DEFAULT_TOP, AGGREGATE_TOP_MAX, type AggregateGroup, type AggregateOptions, type AggregateResult, BLIND_SURFACE_KINDS, type BlindSurfaceKind, type BlindSurfaceOptions, BlindSurfaceRow, CREATE_BLOCKER_KINDS, type CreateGuidanceOptions, EXPAND_RESOURCE_NAMES_MAX_IDS, type ExpandResourceNameRow, type ExpandResourceNamesOptions, type ExpandResourceNamesResult, FETCH_BY_IDS_CHUNK_SIZE, FETCH_BY_IDS_MAX_ITEMS, FETCH_MANY_MAX_ITEMS, FIELD_CATALOG_HONESTY_NOTE, type FetchByIdsOptions, type FetchManyItem, type FetchManyItemError, type FetchManyItemResult, type FetchManyOptions, type FetchManyResult, FieldCacheKind, type FieldCatalogFieldRow, type FieldCatalogOptions, type FieldCatalogResult, type FieldCatalogRow, type FieldCatalogRowError, INVOKE_OPTION_KEYS, type InvokeMode, type InvokeOptions, MAX_FIELD_CATALOG_WIRE, PARAMS_BAG_KEYS, type ProbeReachabilityOptions, type ProbeReachabilityResult, type ProbeSurfaceRow, RECOVERY_CONFIRM, RECOVERY_DEFAULT_LIMIT, RECOVERY_MAX_LIMIT, type RecoveryDeleteBoundary, type RecoveryInput, type RecoveryMatch, type RecoveryOptions, type RecoveryResult, type ResolveAnyOptions, type ResolveAnyResourceOutcome, type ResolveAnyResult, type SearchAcrossResourcesOptions, type SearchAcrossResourcesResult, type SearchAcrossResourcesRow, WORKFLOW_RESOURCES, aggregate, blindSurfaces, createGuidance, expandResourceNames, fetchByIds, fetchMany, fieldCatalog, invoke, invokeDelete, invokeRead, invokeWrite, needsConfirmation, probeReachability, recovery, relationshipMap, resolveAny, searchAcrossResources, unknownKeysRefusal, validateDispatchArgs, validateFetchManyItems, validateInvokeOptions, validateParamsBag };
+export { AGGREGATE_DATE_BUCKETS, AGGREGATE_DEFAULT_LIMIT, AGGREGATE_DEFAULT_TOP, AGGREGATE_TOP_MAX, type AggregateGroup, type AggregateOptions, type AggregateResult, BLIND_SURFACE_KINDS, type BlindSurfaceKind, type BlindSurfaceOptions, BlindSurfaceRow, CREATE_BLOCKER_KINDS, type CreateGuidanceOptions, type DateBucket, EXPAND_RESOURCE_NAMES_MAX_IDS, type ExpandResourceNameRow, type ExpandResourceNamesOptions, type ExpandResourceNamesResult, FETCH_BY_IDS_CHUNK_SIZE, FETCH_BY_IDS_MAX_ITEMS, FETCH_MANY_MAX_ITEMS, FIELD_CATALOG_HONESTY_NOTE, type FetchByIdsOptions, type FetchManyItem, type FetchManyItemError, type FetchManyItemResult, type FetchManyOptions, type FetchManyResult, FieldCacheKind, type FieldCatalogFieldRow, type FieldCatalogOptions, type FieldCatalogResult, type FieldCatalogRow, type FieldCatalogRowError, INVOKE_OPTION_KEYS, type InvokeMode, type InvokeOptions, MAX_FIELD_CATALOG_WIRE, PARAMS_BAG_KEYS, type ProbeReachabilityOptions, type ProbeReachabilityResult, type ProbeSurfaceRow, RECOVERY_CONFIRM, RECOVERY_DEFAULT_LIMIT, RECOVERY_MAX_LIMIT, type RecoveryDeleteBoundary, type RecoveryInput, type RecoveryMatch, type RecoveryOptions, type RecoveryResult, type ResolveAnyOptions, type ResolveAnyResourceOutcome, type ResolveAnyResult, type SearchAcrossResourcesOptions, type SearchAcrossResourcesResult, type SearchAcrossResourcesRow, WORKFLOW_RESOURCES, aggregate, blindSurfaces, createGuidance, dateBucketLabel, expandResourceNames, fetchByIds, fetchMany, fieldCatalog, invoke, invokeDelete, invokeRead, invokeWrite, needsConfirmation, probeReachability, recovery, relationshipMap, resolveAny, searchAcrossResources, unknownKeysRefusal, validateDispatchArgs, validateFetchManyItems, validateInvokeOptions, validateParamsBag };

package/dist/operations/index.d.ts

@@ -1,7 +1,7 @@
-import { a as AutotaskClient, eN as BlindSurfaceInfo, eO as RelationshipResource, eP as BlindSurfaceInventory, eQ as BlindSurfaceRow, eR as CreateBlockerKind, eS as CreateGuidanceReport, eT as FieldCacheKind, g as AutotaskConfigError } from '../index-DGgMD8aq.js';
-export { eU as FIELD_CACHE_KINDS } from '../index-DGgMD8aq.js';
-import { I as Identifier, cE as EmptyReasonInfo, dI as PickListValue, a as FilterCondition } from '../index-cQ6CRexR.js';
-export { hp as PICKLIST_VALUE_NOT_SERVED_NOTE } from '../index-cQ6CRexR.js';
+import { a as AutotaskClient, eN as BlindSurfaceInfo, eO as RelationshipResource, eP as BlindSurfaceInventory, eQ as BlindSurfaceRow, eR as CreateBlockerKind, eS as CreateGuidanceReport, eT as FieldCacheKind, g as AutotaskConfigError } from '../index-uAxAcRol.js';
+export { eU as FIELD_CACHE_KINDS } from '../index-uAxAcRol.js';
+import { I as Identifier, cE as EmptyReasonInfo, dI as PickListValue, a as FilterCondition } from '../index-BXtKN1M5.js';
+export { hp as PICKLIST_VALUE_NOT_SERVED_NOTE } from '../index-BXtKN1M5.js';
 import { CapabilityRecord } from '../capabilities.js';
 
 /**
@@ -195,9 +195,27 @@ declare const AGGREGATE_TOP_MAX = 100;
 declare const AGGREGATE_DEFAULT_TOP = 25;
 /** The walk-mode default record cap = the house `BOUNDED_QUERY_MAX_LIMIT` (the hard max — `queryBounded` rejects above it). */
 declare const AGGREGATE_DEFAULT_LIMIT = 2500;
+/** The closed date-bucket suffix set (issue #101). */
+type DateBucket = 'month' | 'week' | 'year';
+declare const AGGREGATE_DATE_BUCKETS: readonly DateBucket[];
+/**
+ * The ISO bucket label of a date field value (issue #101), anchored on UTC —
+ * the same anchor the date-window ops use when `tz` is omitted: a date-only
+ * value is its UTC day, a zoned datetime is read at its instant, a zoneless
+ * datetime is read as a UTC wall time. Returns `null` for null/undefined
+ * (the one null bucket group — the raw-fold key normalisation) and the RAW
+ * value unchanged when it parses as no date (its own deterministic group —
+ * no silent drop).
+ */
+declare function dateBucketLabel(value: unknown, bucket: DateBucket): unknown;
 /** The closed opts bag for `operations.aggregate`. */
 interface AggregateOptions {
-    /** The group-by vendor field names (the group key = the field tuple). */
+    /** The group-by vendor field names (the group key = the field tuple). A
+     *  DATE-TYPED field may carry the closed bucket suffix `<field>@month` |
+     *  `<field>@week` | `<field>@year` (issue #101): the group key is named
+     *  by the full spec and carries the ISO bucket label (`2026-09` /
+     *  `2026-W38` / `2026`) read on the UTC calendar (the date-window ops'
+     *  omitted-`tz` anchor). */
     groupBy?: string[];
     /** The numeric vendor field names to sum per group. */
     sum?: string[];
@@ -894,4 +912,4 @@ declare function invokeWrite(client: AutotaskClient, operation: string, args?: r
  */
 declare function invokeDelete(client: AutotaskClient, operation: string, args?: readonly unknown[], opts?: InvokeOptions): Promise<unknown>;
 
-export { AGGREGATE_DEFAULT_LIMIT, AGGREGATE_DEFAULT_TOP, AGGREGATE_TOP_MAX, type AggregateGroup, type AggregateOptions, type AggregateResult, BLIND_SURFACE_KINDS, type BlindSurfaceKind, type BlindSurfaceOptions, BlindSurfaceRow, CREATE_BLOCKER_KINDS, type CreateGuidanceOptions, EXPAND_RESOURCE_NAMES_MAX_IDS, type ExpandResourceNameRow, type ExpandResourceNamesOptions, type ExpandResourceNamesResult, FETCH_BY_IDS_CHUNK_SIZE, FETCH_BY_IDS_MAX_ITEMS, FETCH_MANY_MAX_ITEMS, FIELD_CATALOG_HONESTY_NOTE, type FetchByIdsOptions, type FetchManyItem, type FetchManyItemError, type FetchManyItemResult, type FetchManyOptions, type FetchManyResult, FieldCacheKind, type FieldCatalogFieldRow, type FieldCatalogOptions, type FieldCatalogResult, type FieldCatalogRow, type FieldCatalogRowError, INVOKE_OPTION_KEYS, type InvokeMode, type InvokeOptions, MAX_FIELD_CATALOG_WIRE, PARAMS_BAG_KEYS, type ProbeReachabilityOptions, type ProbeReachabilityResult, type ProbeSurfaceRow, RECOVERY_CONFIRM, RECOVERY_DEFAULT_LIMIT, RECOVERY_MAX_LIMIT, type RecoveryDeleteBoundary, type RecoveryInput, type RecoveryMatch, type RecoveryOptions, type RecoveryResult, type ResolveAnyOptions, type ResolveAnyResourceOutcome, type ResolveAnyResult, type SearchAcrossResourcesOptions, type SearchAcrossResourcesResult, type SearchAcrossResourcesRow, WORKFLOW_RESOURCES, aggregate, blindSurfaces, createGuidance, expandResourceNames, fetchByIds, fetchMany, fieldCatalog, invoke, invokeDelete, invokeRead, invokeWrite, needsConfirmation, probeReachability, recovery, relationshipMap, resolveAny, searchAcrossResources, unknownKeysRefusal, validateDispatchArgs, validateFetchManyItems, validateInvokeOptions, validateParamsBag };
+export { AGGREGATE_DATE_BUCKETS, AGGREGATE_DEFAULT_LIMIT, AGGREGATE_DEFAULT_TOP, AGGREGATE_TOP_MAX, type AggregateGroup, type AggregateOptions, type AggregateResult, BLIND_SURFACE_KINDS, type BlindSurfaceKind, type BlindSurfaceOptions, BlindSurfaceRow, CREATE_BLOCKER_KINDS, type CreateGuidanceOptions, type DateBucket, EXPAND_RESOURCE_NAMES_MAX_IDS, type ExpandResourceNameRow, type ExpandResourceNamesOptions, type ExpandResourceNamesResult, FETCH_BY_IDS_CHUNK_SIZE, FETCH_BY_IDS_MAX_ITEMS, FETCH_MANY_MAX_ITEMS, FIELD_CATALOG_HONESTY_NOTE, type FetchByIdsOptions, type FetchManyItem, type FetchManyItemError, type FetchManyItemResult, type FetchManyOptions, type FetchManyResult, FieldCacheKind, type FieldCatalogFieldRow, type FieldCatalogOptions, type FieldCatalogResult, type FieldCatalogRow, type FieldCatalogRowError, INVOKE_OPTION_KEYS, type InvokeMode, type InvokeOptions, MAX_FIELD_CATALOG_WIRE, PARAMS_BAG_KEYS, type ProbeReachabilityOptions, type ProbeReachabilityResult, type ProbeSurfaceRow, RECOVERY_CONFIRM, RECOVERY_DEFAULT_LIMIT, RECOVERY_MAX_LIMIT, type RecoveryDeleteBoundary, type RecoveryInput, type RecoveryMatch, type RecoveryOptions, type RecoveryResult, type ResolveAnyOptions, type ResolveAnyResourceOutcome, type ResolveAnyResult, type SearchAcrossResourcesOptions, type SearchAcrossResourcesResult, type SearchAcrossResourcesRow, WORKFLOW_RESOURCES, aggregate, blindSurfaces, createGuidance, dateBucketLabel, expandResourceNames, fetchByIds, fetchMany, fieldCatalog, invoke, invokeDelete, invokeRead, invokeWrite, needsConfirmation, probeReachability, recovery, relationshipMap, resolveAny, searchAcrossResources, unknownKeysRefusal, validateDispatchArgs, validateFetchManyItems, validateInvokeOptions, validateParamsBag };