@confighub/api 0.8.19 → 0.8.20

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.
package/dist/index.d.cts CHANGED
@@ -5024,7 +5024,7 @@ interface components {
5024
5024
  /** @description Selects the stage's Spaces: a where expression over Spaces, intersected with the change order's InScopeSpaceIDs. Nothing else is implied, so a workflow can be shared across components. Empty selects every Space in the change order's scope. */
5025
5025
  WhereSpace?: string;
5026
5026
  };
5027
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Declarations and Subscriptions are set by whoever manages it, not by the client. */
5027
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
5028
5028
  Channel: {
5029
5029
  /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
5030
5030
  Annotations?: {
@@ -5044,6 +5044,10 @@ interface components {
5044
5044
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5045
5045
  */
5046
5046
  readonly ClaimToken?: string;
5047
+ /** @description The commands the channel handles, by name, each with its signature. Set here, out of band; a connecting client verifies its handlers against them. */
5048
+ Commands?: {
5049
+ [key: string]: components["schemas"]["CommandSignature"];
5050
+ };
5047
5051
  /**
5048
5052
  * @description Claimed while a client holds the lease, Unclaimed otherwise.
5049
5053
  * @enum {string}
@@ -5055,8 +5059,6 @@ interface components {
5055
5059
  * @example 2025-04-04T11:50:02.95102-07:00
5056
5060
  */
5057
5061
  readonly CreatedAt?: string;
5058
- /** @description The commands the channel handles, by name, each with its signature. Set here, out of band; a connecting client verifies its handlers against them. */
5059
- Declarations?: components["schemas"]["ChannelDeclarations"];
5060
5062
  /** @description An optional set of gates that, if any is present, will block deletion. */
5061
5063
  DeleteGates?: {
5062
5064
  [key: string]: boolean;
@@ -5122,11 +5124,6 @@ interface components {
5122
5124
  Channel?: components["schemas"]["Channel"];
5123
5125
  Error?: components["schemas"]["ResponseError"];
5124
5126
  };
5125
- ChannelDeclarations: {
5126
- Commands?: {
5127
- [key: string]: components["schemas"]["CommandSignature"];
5128
- };
5129
- };
5130
5127
  /** @description ChannelLease is the lease a client holds on a Channel: its ClaimToken, carried by every poll and release, and the TTL in seconds a poll renews it for. */
5131
5128
  ChannelLease: {
5132
5129
  /**
@@ -16963,7 +16960,7 @@ interface operations {
16963
16960
  * An example conjunction is:
16964
16961
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
16965
16962
  *
16966
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Condition, CreatedAt, Declarations, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
16963
+ * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
16967
16964
  *
16968
16965
  * The whole string must be query-encoded.
16969
16966
  */
@@ -17167,7 +17164,7 @@ interface operations {
17167
17164
  * An example conjunction is:
17168
17165
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17169
17166
  *
17170
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Condition, CreatedAt, Declarations, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17167
+ * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17171
17168
  *
17172
17169
  * The whole string must be query-encoded.
17173
17170
  */
@@ -17367,7 +17364,7 @@ interface operations {
17367
17364
  * An example conjunction is:
17368
17365
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17369
17366
  *
17370
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Condition, CreatedAt, Declarations, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17367
+ * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17371
17368
  *
17372
17369
  * The whole string must be query-encoded.
17373
17370
  */
@@ -17442,7 +17439,9 @@ interface operations {
17442
17439
  Annotations?: {
17443
17440
  [key: string]: string | null;
17444
17441
  } | null;
17445
- Declarations?: Record<string, never> | null;
17442
+ Commands?: {
17443
+ [key: string]: Record<string, never> | null;
17444
+ } | null;
17446
17445
  /** @description An optional set of gates that, if any is present, will block deletion */
17447
17446
  DeleteGates?: {
17448
17447
  [key: string]: boolean | null;
@@ -33046,7 +33045,7 @@ interface operations {
33046
33045
  * An example conjunction is:
33047
33046
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
33048
33047
  *
33049
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Condition, CreatedAt, Declarations, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
33048
+ * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
33050
33049
  *
33051
33050
  * The whole string must be query-encoded.
33052
33051
  */
@@ -33236,7 +33235,7 @@ interface operations {
33236
33235
  };
33237
33236
  };
33238
33237
  responses: {
33239
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Declarations and Subscriptions are set by whoever manages it, not by the client. */
33238
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
33240
33239
  200: {
33241
33240
  headers: {
33242
33241
  [name: string]: unknown;
@@ -33432,7 +33431,7 @@ interface operations {
33432
33431
  };
33433
33432
  };
33434
33433
  responses: {
33435
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Declarations and Subscriptions are set by whoever manages it, not by the client. */
33434
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
33436
33435
  200: {
33437
33436
  headers: {
33438
33437
  [name: string]: unknown;
@@ -33625,7 +33624,9 @@ interface operations {
33625
33624
  Annotations?: {
33626
33625
  [key: string]: string | null;
33627
33626
  } | null;
33628
- Declarations?: Record<string, never> | null;
33627
+ Commands?: {
33628
+ [key: string]: Record<string, never> | null;
33629
+ } | null;
33629
33630
  /** @description An optional set of gates that, if any is present, will block deletion */
33630
33631
  DeleteGates?: {
33631
33632
  [key: string]: boolean | null;
@@ -33651,7 +33652,7 @@ interface operations {
33651
33652
  };
33652
33653
  };
33653
33654
  responses: {
33654
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Declarations and Subscriptions are set by whoever manages it, not by the client. */
33655
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
33655
33656
  200: {
33656
33657
  headers: {
33657
33658
  [name: string]: unknown;
package/dist/index.d.ts CHANGED
@@ -5024,7 +5024,7 @@ interface components {
5024
5024
  /** @description Selects the stage's Spaces: a where expression over Spaces, intersected with the change order's InScopeSpaceIDs. Nothing else is implied, so a workflow can be shared across components. Empty selects every Space in the change order's scope. */
5025
5025
  WhereSpace?: string;
5026
5026
  };
5027
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Declarations and Subscriptions are set by whoever manages it, not by the client. */
5027
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
5028
5028
  Channel: {
5029
5029
  /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
5030
5030
  Annotations?: {
@@ -5044,6 +5044,10 @@ interface components {
5044
5044
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5045
5045
  */
5046
5046
  readonly ClaimToken?: string;
5047
+ /** @description The commands the channel handles, by name, each with its signature. Set here, out of band; a connecting client verifies its handlers against them. */
5048
+ Commands?: {
5049
+ [key: string]: components["schemas"]["CommandSignature"];
5050
+ };
5047
5051
  /**
5048
5052
  * @description Claimed while a client holds the lease, Unclaimed otherwise.
5049
5053
  * @enum {string}
@@ -5055,8 +5059,6 @@ interface components {
5055
5059
  * @example 2025-04-04T11:50:02.95102-07:00
5056
5060
  */
5057
5061
  readonly CreatedAt?: string;
5058
- /** @description The commands the channel handles, by name, each with its signature. Set here, out of band; a connecting client verifies its handlers against them. */
5059
- Declarations?: components["schemas"]["ChannelDeclarations"];
5060
5062
  /** @description An optional set of gates that, if any is present, will block deletion. */
5061
5063
  DeleteGates?: {
5062
5064
  [key: string]: boolean;
@@ -5122,11 +5124,6 @@ interface components {
5122
5124
  Channel?: components["schemas"]["Channel"];
5123
5125
  Error?: components["schemas"]["ResponseError"];
5124
5126
  };
5125
- ChannelDeclarations: {
5126
- Commands?: {
5127
- [key: string]: components["schemas"]["CommandSignature"];
5128
- };
5129
- };
5130
5127
  /** @description ChannelLease is the lease a client holds on a Channel: its ClaimToken, carried by every poll and release, and the TTL in seconds a poll renews it for. */
5131
5128
  ChannelLease: {
5132
5129
  /**
@@ -16963,7 +16960,7 @@ interface operations {
16963
16960
  * An example conjunction is:
16964
16961
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
16965
16962
  *
16966
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Condition, CreatedAt, Declarations, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
16963
+ * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
16967
16964
  *
16968
16965
  * The whole string must be query-encoded.
16969
16966
  */
@@ -17167,7 +17164,7 @@ interface operations {
17167
17164
  * An example conjunction is:
17168
17165
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17169
17166
  *
17170
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Condition, CreatedAt, Declarations, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17167
+ * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17171
17168
  *
17172
17169
  * The whole string must be query-encoded.
17173
17170
  */
@@ -17367,7 +17364,7 @@ interface operations {
17367
17364
  * An example conjunction is:
17368
17365
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17369
17366
  *
17370
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Condition, CreatedAt, Declarations, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17367
+ * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
17371
17368
  *
17372
17369
  * The whole string must be query-encoded.
17373
17370
  */
@@ -17442,7 +17439,9 @@ interface operations {
17442
17439
  Annotations?: {
17443
17440
  [key: string]: string | null;
17444
17441
  } | null;
17445
- Declarations?: Record<string, never> | null;
17442
+ Commands?: {
17443
+ [key: string]: Record<string, never> | null;
17444
+ } | null;
17446
17445
  /** @description An optional set of gates that, if any is present, will block deletion */
17447
17446
  DeleteGates?: {
17448
17447
  [key: string]: boolean | null;
@@ -33046,7 +33045,7 @@ interface operations {
33046
33045
  * An example conjunction is:
33047
33046
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
33048
33047
  *
33049
- * Supported attributes for filtering on Channel: Annotations, ChannelID, Condition, CreatedAt, Declarations, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
33048
+ * Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
33050
33049
  *
33051
33050
  * The whole string must be query-encoded.
33052
33051
  */
@@ -33236,7 +33235,7 @@ interface operations {
33236
33235
  };
33237
33236
  };
33238
33237
  responses: {
33239
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Declarations and Subscriptions are set by whoever manages it, not by the client. */
33238
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
33240
33239
  200: {
33241
33240
  headers: {
33242
33241
  [name: string]: unknown;
@@ -33432,7 +33431,7 @@ interface operations {
33432
33431
  };
33433
33432
  };
33434
33433
  responses: {
33435
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Declarations and Subscriptions are set by whoever manages it, not by the client. */
33434
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
33436
33435
  200: {
33437
33436
  headers: {
33438
33437
  [name: string]: unknown;
@@ -33625,7 +33624,9 @@ interface operations {
33625
33624
  Annotations?: {
33626
33625
  [key: string]: string | null;
33627
33626
  } | null;
33628
- Declarations?: Record<string, never> | null;
33627
+ Commands?: {
33628
+ [key: string]: Record<string, never> | null;
33629
+ } | null;
33629
33630
  /** @description An optional set of gates that, if any is present, will block deletion */
33630
33631
  DeleteGates?: {
33631
33632
  [key: string]: boolean | null;
@@ -33651,7 +33652,7 @@ interface operations {
33651
33652
  };
33652
33653
  };
33653
33654
  responses: {
33654
- /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Declarations and Subscriptions are set by whoever manages it, not by the client. */
33655
+ /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
33655
33656
  200: {
33656
33657
  headers: {
33657
33658
  [name: string]: unknown;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.8.19",
3
+ "version": "0.8.20",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {