@confighub/api 0.1.3 → 0.4.0

package/dist/index.d.ts

@@ -395,6 +395,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/me/browser-session": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create a single-use link that signs a browser in as the current user
+         * @description Returns a short-lived, single-use URL. Opening it exchanges the ticket for a session cookie. Intended for instances with no identity provider, where the browser has no other way to authenticate.
+         */
+        post: operations["CreateBrowserSession"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/oauth_client": {
         parameters: {
             query?: never;
@@ -2519,9 +2539,10 @@ interface components {
             BoundProvidedProperties?: {
                 [key: string]: string;
             };
+            /** @description Value a defaulting function writes at this path, if any */
+            DefaultValue?: unknown;
             /** @description Description of the attribute */
             Description?: string;
-            GetterInvocation?: components["schemas"]["FunctionInvocation"];
             /** @description Whether this attribute is a needed value */
             IsNeeded?: boolean;
             /** @description Whether this attribute is a provided value */
@@ -2538,8 +2559,6 @@ interface components {
             ProvidedProperties?: {
                 [key: string]: string;
             };
-            /** @description Function invocation used to set the attribute (except for the value), if any */
-            SetterInvocations?: components["schemas"]["FunctionInvocation"][];
         };
         AttributeInfo: {
             /** @description Name of the registered attribute */
@@ -2780,10 +2799,21 @@ interface components {
             /** @description Status indicates the current status of the bridge worker. Possible values include Connected, Disconnected, ActionSent, ActionResultReceived. */
             Status?: string;
         };
+        BrowserSessionResponse: {
+            ExpiresIn?: number;
+            Ticket?: string;
+            URL?: string;
+        };
         /** @description Defines a change's identity as it moves between Spaces. */
         ChangeOrder: {
             /** @description AbortedReason says why the ChangeOrder was given up on. Setting it is what aborts one: a ChangeOrder with a reason is Aborted whatever its Links say. */
             AbortedReason?: string;
+            /**
+             * Format: uuid
+             * @description AdoptedEndTagID is the Tag whose marks were taken as the ChangeOrder's boundary, when it was created with one, and empty when the boundary was each Unit's head Revision.
+             * @example 248df4b7-aa70-47b8-a036-33ac447e668d
+             */
+            readonly AdoptedEndTagID?: string;
             /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
             Annotations?: {
                 [key: string]: string;
@@ -2815,7 +2845,7 @@ interface components {
             DisplayName?: string;
             /**
              * Format: uuid
-             * @description EndTagID is the identifier of the set of Revisions that end the ChangeOrder. Settable at creation to adopt an existing Tag as the boundary; the ChangeOrder creates one on each in-scope Unit's head Revision if it is not set.
+             * @description EndTagID is the identifier of the set of Revisions that end the ChangeOrder. The ChangeOrder always mints this Tag itself; supplying one at creation adopts its marks as the boundary, and the supplied Tag is recorded as AdoptedEndTagID and never written to. Without one the boundary is each Unit's head Revision.
              * @example 248df4b7-aa70-47b8-a036-33ac447e668d
              */
             EndTagID?: string;
@@ -2833,11 +2863,21 @@ interface components {
              * @example 248df4b7-aa70-47b8-a036-33ac447e668d
              */
             OrganizationID?: string;
+            /** @description ReleasedRestoredSpaceIDs is where the undoing has been released: the Spaces in RestoredSpaceIDs whose Units are released at or past the Revision the restore Tag marks. Covering ReleasedSpaceIDs is what State reports as RestoreReleased. Derived when the ChangeOrder is read. */
+            readonly ReleasedRestoredSpaceIDs?: components["schemas"]["UUID"][];
             /** @description ReleasedSpaceIDs is where the ChangeOrder has been released: the Spaces in scope whose Units in the Space's release are applied at or past the Revision the end Tag marks. Derived when the ChangeOrder is read. */
             readonly ReleasedSpaceIDs?: components["schemas"]["UUID"][];
             /** @description ResolvedSpaceIDs is where the ChangeOrder has been fully propagated to: the Spaces in scope whose Links of its UpdateType have all merged it, plus the Space it resides in. Derived when the ChangeOrder is read. */
             readonly ResolvedSpaceIDs?: components["schemas"]["UUID"][];
-            /** @description SkippedUnits names the Units of the ChangeOrder's Space that it covers nothing of, mapped to the reason. Written when the scope is derived. */
+            /**
+             * Format: uuid
+             * @description RestoreTagID is the Tag marking the Revisions that undid the ChangeOrder. The first restore mints it; every restore after that marks with the same Tag. Empty until something has been restored.
+             * @example 248df4b7-aa70-47b8-a036-33ac447e668d
+             */
+            readonly RestoreTagID?: string;
+            /** @description RestoredSpaceIDs is where the ChangeOrder has been undone: the Spaces whose Units all carry the restore Tag. Derived when the ChangeOrder is read. */
+            readonly RestoredSpaceIDs?: components["schemas"]["UUID"][];
+            /** @description SkippedUnits names the Units of the ChangeOrder's Space that it carries no Revisions of, mapped to the reason. Written when the scope is derived. A skipped Unit may still be marked by the ChangeOrder's Tags, when the Spaces in scope had already taken it. */
             readonly SkippedUnits?: {
                 [key: string]: string;
             };
@@ -2857,7 +2897,7 @@ interface components {
              * @example 248df4b7-aa70-47b8-a036-33ac447e668d
              */
             readonly StartTagID?: string;
-            /** @description State is how far the ChangeOrder has got: New until a Space other than its own has taken it, InProgress while some have and some have not, Resolved once every Space in scope has, Released once every Space in scope has released what it took, and Aborted whenever AbortedReason is set. Derived when the ChangeOrder is read. */
+            /** @description State is how far the ChangeOrder has got: New until a Space other than its own has taken it, InProgress while some have and some have not, Resolved once every Space in scope has, Released once every Space in scope has released what it took, Aborted whenever AbortedReason is set, Restored once every Space that had taken it has been restored to the Revisions before it, and RestoreReleased once every Space that had released it has released the restored Revisions. Derived when the ChangeOrder is read. */
             readonly State?: string;
             /** @description UpdateType is the Link UpdateType this ChangeOrder follows when propagating. UpgradeUnit, the clone lineage, is the default; MergeUnits is the other supported value. */
             UpdateType?: string;
@@ -3030,6 +3070,7 @@ interface components {
             EndTag?: components["schemas"]["Tag"];
             Error?: components["schemas"]["ResponseError"];
             Organization?: components["schemas"]["Organization"];
+            RestoreTag?: components["schemas"]["Tag"];
             Space?: components["schemas"]["Space"];
             StartTag?: components["schemas"]["Tag"];
         };
@@ -3308,6 +3349,7 @@ interface components {
             Clearance?: components["schemas"]["Clearance"];
             /** @description Function name */
             FunctionName?: string;
+            Guards?: components["schemas"]["GuardStamp"];
             /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
             Params?: {
                 [key: string]: unknown;
@@ -3347,6 +3389,7 @@ interface components {
         FunctionInvocationsResponse: {
             /** @description The resulting configuration data; present only when the invocation changed it */
             ConfigData?: string;
+            Conflicts?: components["schemas"]["MutationConflictList"];
             /** @description SHA256 of the resulting configuration data, whether or not ConfigData is present */
             DataHash?: string;
             Error?: components["schemas"]["ResponseError"];
@@ -3479,6 +3522,9 @@ interface components {
                 [key: string]: string;
             };
         };
+        GuardStamp: {
+            [key: string]: string;
+        };
         /** @description Defines a stored, reusable call to one or more functions, executed in the order they are listed. */
         Invocation: {
             /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
@@ -3617,6 +3663,7 @@ interface components {
              * @example 248df4b7-aa70-47b8-a036-33ac447e668d
              */
             FromUnitID: string;
+            Guards?: components["schemas"]["GuardStamp"];
             /** @description SHA256 hash of the resolution-relevant Link fields, used to detect changes that require re-resolution. */
             readonly Hash?: string;
             /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -4429,7 +4476,6 @@ interface components {
             BoundProvidedProperties?: {
                 [key: string]: string;
             };
-            GetterInvocation?: components["schemas"]["FunctionInvocation"];
             /** @description Whether this attribute is a needed value */
             IsNeeded?: boolean;
             /** @description Whether this attribute is a provided value */
@@ -4448,7 +4494,6 @@ interface components {
                 [key: string]: string;
             };
             ResourceType?: string;
-            SetterInvocation?: components["schemas"]["FunctionInvocation"];
         };
         ResponseError: {
             /** @description Additional context messages */
@@ -5130,6 +5175,7 @@ interface components {
             FailOpenAfter?: number | null;
             /** @description Function name */
             FunctionName?: string;
+            Guards?: components["schemas"]["GuardStamp"];
             /** @description SHA256 hash of the trigger's specification fields, used to detect changes. */
             readonly Hash?: string;
             /**
@@ -8209,7 +8255,7 @@ interface operations {
                  *     An example conjunction is:
                  *     `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
                  *
-                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedSpaceIDs, ResolvedSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
+                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -8251,7 +8297,7 @@ interface operations {
                  *     The attribute names are case-sensitive, PascalCase, and
                  *     expected in a comma-separated list format as in the JSON encoding.
                  *
-                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, SpaceID, StartTagID.
+                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -8377,7 +8423,7 @@ interface operations {
                  *     An example conjunction is:
                  *     `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
                  *
-                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedSpaceIDs, ResolvedSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
+                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -8419,7 +8465,7 @@ interface operations {
                  *     The attribute names are case-sensitive, PascalCase, and
                  *     expected in a comma-separated list format as in the JSON encoding.
                  *
-                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, SpaceID, StartTagID.
+                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -8645,7 +8691,7 @@ interface operations {
                  *     An example conjunction is:
                  *     `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
                  *
-                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedSpaceIDs, ResolvedSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
+                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -8687,7 +8733,7 @@ interface operations {
                  *     The attribute names are case-sensitive, PascalCase, and
                  *     expected in a comma-separated list format as in the JSON encoding.
                  *
-                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, SpaceID, StartTagID.
+                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -8829,7 +8875,7 @@ interface operations {
                  *     An example conjunction is:
                  *     `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
                  *
-                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedSpaceIDs, ResolvedSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
+                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -8871,7 +8917,7 @@ interface operations {
                  *     The attribute names are case-sensitive, PascalCase, and
                  *     expected in a comma-separated list format as in the JSON encoding.
                  *
-                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, SpaceID, StartTagID.
+                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -10769,6 +10815,8 @@ interface operations {
                 protect?: boolean;
                 /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
                 clearance?: string;
+                /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
+                guards?: string;
                 /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
                 change_set_id?: string;
                 /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
@@ -12166,6 +12214,10 @@ interface operations {
                     DownstreamSetters?: (Record<string, never> | null)[] | null;
                     /** Format: uuid */
                     FromUnitID?: string | null;
+                    /** @description Guards to record on the paths this link's resolve writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. Sibling to Protect: Protect claims the paths, Guards say why. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Refused on UpgradeUnit and MergeUnits links, whose guards arrive by propagation from upstream. */
+                    Guards?: {
+                        [key: string]: string | null;
+                    } | null;
                     /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
                     Labels?: {
                         [key: string]: string | null;
@@ -12577,6 +12629,10 @@ interface operations {
                     DownstreamSetters?: (Record<string, never> | null)[] | null;
                     /** Format: uuid */
                     FromUnitID?: string | null;
+                    /** @description Guards to record on the paths this link's resolve writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. Sibling to Protect: Protect claims the paths, Guards say why. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Refused on UpgradeUnit and MergeUnits links, whose guards arrive by propagation from upstream. */
+                    Guards?: {
+                        [key: string]: string | null;
+                    } | null;
                     /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
                     Labels?: {
                         [key: string]: string | null;
@@ -12761,6 +12817,89 @@ interface operations {
             };
         };
     };
+    CreateBrowserSession: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BrowserSessionResponse"];
+                };
+            };
+            /** @description BrowserSession request is invalid (Bad Request). */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StandardErrorResponse"];
+                };
+            };
+            /** @description Unauthorized access. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StandardErrorResponse"];
+                };
+            };
+            /** @description Forbidden access. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StandardErrorResponse"];
+                };
+            };
+            /** @description BrowserSession not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StandardErrorResponse"];
+                };
+            };
+            /** @description BrowserSession data conflict. Data has changed since last read. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StandardErrorResponse"];
+                };
+            };
+            /** @description Something went wrong while processing BrowserSession. */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StandardErrorResponse"];
+                };
+            };
+            /** @description Unexpected error. */
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StandardErrorResponse"];
+                };
+            };
+        };
+    };
     ListOAuthClients: {
         parameters: {
             query?: never;
@@ -17293,7 +17432,7 @@ interface operations {
                  *     An example conjunction is:
                  *     `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
                  *
-                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedSpaceIDs, ResolvedSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
+                 *     Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -17335,7 +17474,7 @@ interface operations {
                  *     The attribute names are case-sensitive, PascalCase, and
                  *     expected in a comma-separated list format as in the JSON encoding.
                  *
-                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, SpaceID, StartTagID.
+                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -17527,7 +17666,7 @@ interface operations {
                  *     The attribute names are case-sensitive, PascalCase, and
                  *     expected in a comma-separated list format as in the JSON encoding.
                  *
-                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, SpaceID, StartTagID.
+                 *     Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
                  *
                  *     The whole string must be query-encoded.
                  */
@@ -19406,6 +19545,8 @@ interface operations {
                 protect?: boolean;
                 /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
                 clearance?: string;
+                /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
+                guards?: string;
                 /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
                 change_set_id?: string;
                 /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
@@ -20887,6 +21028,10 @@ interface operations {
                     DownstreamSetters?: (Record<string, never> | null)[] | null;
                     /** Format: uuid */
                     FromUnitID?: string | null;
+                    /** @description Guards to record on the paths this link's resolve writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. Sibling to Protect: Protect claims the paths, Guards say why. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Refused on UpgradeUnit and MergeUnits links, whose guards arrive by propagation from upstream. */
+                    Guards?: {
+                        [key: string]: string | null;
+                    } | null;
                     /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
                     Labels?: {
                         [key: string]: string | null;
@@ -23802,6 +23947,10 @@ interface operations {
                     FailOpenAfter?: number | null;
                     /** @description Function name */
                     FunctionName?: string | null;
+                    /** @description Guards to record on the paths this trigger's function writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. Sibling to Protect: Protect claims the paths, Guards say why. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Only meaningful for a mutating trigger, and part of the trigger's Hash, unlike Protect. */
+                    Guards?: {
+                        [key: string]: string | null;
+                    } | null;
                     /** Format: uuid */
                     InvocationID?: string | null;
                     /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -24322,6 +24471,8 @@ interface operations {
                 protect?: boolean;
                 /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
                 clearance?: string;
+                /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
+                guards?: string;
                 /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
                 squash?: boolean;
                 /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -24400,7 +24551,7 @@ interface operations {
                 tag?: string;
                 /** @description Must match ChangeSetID of affected Units if config Data is changed unless in dry run mode */
                 change_set_id?: string;
-                /** @description ChangeOrder to promote, with upgrade or resolve. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is not where the change order starts is an error, since merging anyway would replay what it already has or skip what it does not, and with resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. */
+                /** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is not where the change order starts is an error, since merging anyway would replay what it already has or skip what it does not, and with resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
                 change_order?: string;
                 /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
                 subgroup?: string;
@@ -24622,6 +24773,8 @@ interface operations {
                 protect?: boolean;
                 /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
                 clearance?: string;
+                /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
+                guards?: string;
                 /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
                 squash?: boolean;
                 /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -24700,7 +24853,7 @@ interface operations {
                 tag?: string;
                 /** @description Must match ChangeSetID of affected Units if config Data is changed unless in dry run mode */
                 change_set_id?: string;
-                /** @description ChangeOrder to promote, with upgrade or resolve. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is not where the change order starts is an error, since merging anyway would replay what it already has or skip what it does not, and with resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. */
+                /** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is not where the change order starts is an error, since merging anyway would replay what it already has or skip what it does not, and with resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
                 change_order?: string;
                 /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
                 subgroup?: string;
@@ -25122,6 +25275,8 @@ interface operations {
                 protect?: boolean;
                 /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
                 clearance?: string;
+                /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
+                guards?: string;
                 /** @description Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
                 merge_base?: string;
                 /** @description Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */
@@ -29549,6 +29704,10 @@ interface operations {
                     FailOpenAfter?: number | null;
                     /** @description Function name */
                     FunctionName?: string | null;
+                    /** @description Guards to record on the paths this trigger's function writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. Sibling to Protect: Protect claims the paths, Guards say why. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Only meaningful for a mutating trigger, and part of the trigger's Hash, unlike Protect. */
+                    Guards?: {
+                        [key: string]: string | null;
+                    } | null;
                     /** Format: uuid */
                     InvocationID?: string | null;
                     /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -29955,6 +30114,10 @@ interface operations {
                     FailOpenAfter?: number | null;
                     /** @description Function name */
                     FunctionName?: string | null;
+                    /** @description Guards to record on the paths this trigger's function writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. Sibling to Protect: Protect claims the paths, Guards say why. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Only meaningful for a mutating trigger, and part of the trigger's Hash, unlike Protect. */
+                    Guards?: {
+                        [key: string]: string | null;
+                    } | null;
                     /** Format: uuid */
                     InvocationID?: string | null;
                     /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -30875,6 +31038,8 @@ interface operations {
                 protect?: boolean;
                 /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
                 clearance?: string;
+                /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
+                guards?: string;
                 /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
                 squash?: boolean;
                 /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -30953,7 +31118,7 @@ interface operations {
                 tag?: string;
                 /** @description Must match ChangeSetID of affected Units if config Data is changed unless in dry run mode */
                 change_set_id?: string;
-                /** @description ChangeOrder to promote, with upgrade or resolve. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is not where the change order starts is an error, since merging anyway would replay what it already has or skip what it does not, and with resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. */
+                /** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is not where the change order starts is an error, since merging anyway would replay what it already has or skip what it does not, and with resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
                 change_order?: string;
                 /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
                 subgroup?: string;
@@ -34035,4 +34200,20 @@ declare function getRevisionMutationSources(client: ConfigHubClient, ref: Revisi
     };
 }, `${string}/${string}`>>;
 
-export { type ConfigHubClient, type ConfigHubClientOptions, type MutationSourcesResponse, type ReadDataOptions, type ReadDataResult, type ReleaseRef, type RevisionRef, type UnitCreateOrUpdateResponse, type UnitRef, type WriteDataOptions, type WriteDataResult, type components, createConfigHubClient, getReleaseData, getRevisionData, getRevisionMutationSources, getUnitData, getUnitMutationSources, type operations, type paths, putUnitData };
+declare const SLUG_PATTERN: RegExp;
+declare const SLUG_MAX_LENGTH = 128;
+declare const SLUG_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), and periods (.)";
+declare const LABEL_KEY_PATTERN: RegExp;
+declare const LABEL_KEY_MAX_LENGTH = 128;
+declare const LABEL_KEY_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), periods (.), and forward slashes (/)";
+declare const LABEL_VALUE_PATTERN: RegExp;
+declare const LABEL_VALUE_MAX_LENGTH = 128;
+declare const LABEL_VALUE_PATTERN_MESSAGE = "Must start and end with a printable character (no leading/trailing spaces). Quotes, backslashes, and wildcards are not allowed";
+declare const ANNOTATION_KEY_PATTERN: RegExp;
+declare const ANNOTATION_KEY_MAX_LENGTH = 128;
+declare const ANNOTATION_KEY_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), periods (.), and forward slashes (/)";
+declare const ANNOTATION_VALUE_PATTERN: RegExp;
+declare const ANNOTATION_VALUE_MAX_LENGTH = 1024;
+declare const ANNOTATION_VALUE_PATTERN_MESSAGE = "Any content is allowed, including multiline text";
+
+export { ANNOTATION_KEY_MAX_LENGTH, ANNOTATION_KEY_PATTERN, ANNOTATION_KEY_PATTERN_MESSAGE, ANNOTATION_VALUE_MAX_LENGTH, ANNOTATION_VALUE_PATTERN, ANNOTATION_VALUE_PATTERN_MESSAGE, type ConfigHubClient, type ConfigHubClientOptions, LABEL_KEY_MAX_LENGTH, LABEL_KEY_PATTERN, LABEL_KEY_PATTERN_MESSAGE, LABEL_VALUE_MAX_LENGTH, LABEL_VALUE_PATTERN, LABEL_VALUE_PATTERN_MESSAGE, type MutationSourcesResponse, type ReadDataOptions, type ReadDataResult, type ReleaseRef, type RevisionRef, SLUG_MAX_LENGTH, SLUG_PATTERN, SLUG_PATTERN_MESSAGE, type UnitCreateOrUpdateResponse, type UnitRef, type WriteDataOptions, type WriteDataResult, type components, createConfigHubClient, getReleaseData, getRevisionData, getRevisionMutationSources, getUnitData, getUnitMutationSources, type operations, type paths, putUnitData };

package/dist/index.js

@@ -123,6 +123,23 @@ function getRevisionMutationSources(client, ref) {
   });
 }
 
-export { createConfigHubClient, getReleaseData, getRevisionData, getRevisionMutationSources, getUnitData, getUnitMutationSources, putUnitData };
+// src/validation.ts
+var SLUG_PATTERN = /^[A-Za-z0-9]([\-_.A-Za-z0-9]*[A-Za-z0-9])?$/;
+var SLUG_MAX_LENGTH = 128;
+var SLUG_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), and periods (.)";
+var LABEL_KEY_PATTERN = /^[A-Za-z0-9]([\-_\./A-Za-z0-9]*[A-Za-z0-9])?$/;
+var LABEL_KEY_MAX_LENGTH = 128;
+var LABEL_KEY_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), periods (.), and forward slashes (/)";
+var LABEL_VALUE_PATTERN = /^[\-_@/#$%&~+=!?.,:;(){}\[\]<>|A-Za-z0-9](([\-_@/#$%&~+=!?.,:;(){}\[\]<>|A-Za-z0-9]| )*[\-_@/#$%&~+=!?.,:;(){}\[\]<>|A-Za-z0-9])?$/;
+var LABEL_VALUE_MAX_LENGTH = 128;
+var LABEL_VALUE_PATTERN_MESSAGE = "Must start and end with a printable character (no leading/trailing spaces). Quotes, backslashes, and wildcards are not allowed";
+var ANNOTATION_KEY_PATTERN = /^[A-Za-z0-9]([\-_\./A-Za-z0-9]*[A-Za-z0-9])?$/;
+var ANNOTATION_KEY_MAX_LENGTH = 128;
+var ANNOTATION_KEY_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), periods (.), and forward slashes (/)";
+var ANNOTATION_VALUE_PATTERN = /^(.|\n)*$/;
+var ANNOTATION_VALUE_MAX_LENGTH = 1024;
+var ANNOTATION_VALUE_PATTERN_MESSAGE = "Any content is allowed, including multiline text";
+
+export { ANNOTATION_KEY_MAX_LENGTH, ANNOTATION_KEY_PATTERN, ANNOTATION_KEY_PATTERN_MESSAGE, ANNOTATION_VALUE_MAX_LENGTH, ANNOTATION_VALUE_PATTERN, ANNOTATION_VALUE_PATTERN_MESSAGE, LABEL_KEY_MAX_LENGTH, LABEL_KEY_PATTERN, LABEL_KEY_PATTERN_MESSAGE, LABEL_VALUE_MAX_LENGTH, LABEL_VALUE_PATTERN, LABEL_VALUE_PATTERN_MESSAGE, SLUG_MAX_LENGTH, SLUG_PATTERN, SLUG_PATTERN_MESSAGE, createConfigHubClient, getReleaseData, getRevisionData, getRevisionMutationSources, getUnitData, getUnitMutationSources, putUnitData };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map