@versionone/agility-sdk 1.0.0-alpha.5 → 1.0.0-alpha.6

package/dist/index.d.cts

@@ -163,7 +163,7 @@ interface UnauthorizedContext {
 declare function createFetchTransport(config: FetchTransportConfig): Transport;
 
 interface ClientConfig extends Pick<FetchTransportConfig, "credentials" | "onUnauthorized" | "unauthorizedStatuses"> {
-    /** The instance base URL: "https://www7.v1host.com/V1Production". */
+    /** The instance base URL: "https://agility.example.com/MyInstance". */
     baseUrl: string;
     /** A ready Authorization header value ("Basic …" for a dev instance). Wins over accessToken. */
     authorization?: string;
@@ -187,13 +187,13 @@ type Oid = string;
 /** An ISO-8601 date-time as the API renders it, e.g. "2026-09-06T13:52:51.903". */
 type DateString = string;
 /**
- * An AssetState as the model carries it: the names of Core's AssetState
- * enum (VersionOne/AssetState.cs: Future 0, Active 64, Closed 128, Dead 192,
+ * An AssetState as the model carries it: the names of the server's AssetState
+ * enum (Future 0, Active 64, Closed 128, Dead 192,
  * OldBrokenDownStory 208, Deprecated 254, Deleted 255). rest-1 renders the
  * number and query.v1 the name; the wire layer normalises to the name.
  */
 type AssetStateValue = "Future" | "Active" | "Closed" | "Dead" | "Template" | "OldBrokenDownStory" | "Deprecated" | "Deleted";
-/** Core's AssetState codes, by name — the rest-1 rendering. */
+/** The server's AssetState codes, by name — the rest-1 rendering. */
 declare const ASSET_STATE_CODES: Record<AssetStateValue, number>;
 /**
  * An AssetState by name, whichever way the endpoint spelled it: api/asset
@@ -295,7 +295,7 @@ declare namespace attachment {
  *
  * Two ways in for the bytes, chosen by size:
  *   - inline: one api/asset create with Content as Base64. One request,
- *     what agility-rooms does; the JSON is a third larger than the file.
+ *     what a browser app consumer does; the JSON is a third larger than the file.
  *   - two-step, as the docs prescribe for anything not tiny: create the
  *     Attachment with empty Content, then POST the raw bytes. A failed
  *     upload leaves an empty Attachment, which is reported, not hidden.
@@ -4178,7 +4178,7 @@ interface QueryBody<F extends string = string> {
  * scalar or a single relation (null clears it). A multi-value relation is
  * changed with `{ add: [...], remove: [...] }`. A plain list does NOT
  * replace a multi-value relation: the server ADDS its members, like rest-1's
- * `act: "add"` (seen live on v1sdktesting, 2026-11-07). To set one exactly,
+ * `act: "add"` (seen live on the API-testing instance, 2026-11-07). To set one exactly,
  * remove what should go and add what should come. A change comment goes in
  * the update node as `ChangeComment`.
  */
@@ -4621,7 +4621,7 @@ declare class Schema implements AttributeLookup {
 
 /**
  * The batch service: an api/asset batch sent with a record of what it did.
- * Ported from gh-v1's lib/batch.js — preview, describe, snapshot, send
+ * Ported from the CLI consumer's batch module — preview, describe, snapshot, send
  * (guarded by default), receipt, reverse — minus what is the CLI's: file
  * I/O, console output, permalinks and the confirm prompt (a callback here).
  *
@@ -4634,7 +4634,7 @@ declare class Schema implements AttributeLookup {
  * which were skipped by the guard; and a reverse batch that undoes what
  * succeeded, best effort, with a note for anything it cannot.
  *
- * Closing a workitem cascades: Core's Inactivate and QuickClose also close
+ * Closing a workitem cascades: the server's Inactivate and QuickClose also close
  * its open descendants, and Reactivate reopens only the asset it names. So
  * before a batch that closes, the receipt records each closing target's
  * open descendants; after it, the ones the close actually closed; and the
@@ -4853,7 +4853,7 @@ declare function importantName(token: string, types: readonly AssetTypeToken[]):
 /**
  * The guard: an api/asset batch sent as a compare-and-set, so a change only
  * lands on an asset nobody else has changed since it was read. Ported from
- * gh-v1's lib/batch.js `guarded()`, with a different stamp.
+ * the CLI consumer's batch `guarded()`, with a different stamp.
  *
  * How: preview the batch (the server's projection expands every query-
  * scoped update and execute into one command per asset), read each touched

package/dist/index.d.ts

@@ -163,7 +163,7 @@ interface UnauthorizedContext {
 declare function createFetchTransport(config: FetchTransportConfig): Transport;
 
 interface ClientConfig extends Pick<FetchTransportConfig, "credentials" | "onUnauthorized" | "unauthorizedStatuses"> {
-    /** The instance base URL: "https://www7.v1host.com/V1Production". */
+    /** The instance base URL: "https://agility.example.com/MyInstance". */
     baseUrl: string;
     /** A ready Authorization header value ("Basic …" for a dev instance). Wins over accessToken. */
     authorization?: string;
@@ -187,13 +187,13 @@ type Oid = string;
 /** An ISO-8601 date-time as the API renders it, e.g. "2026-09-06T13:52:51.903". */
 type DateString = string;
 /**
- * An AssetState as the model carries it: the names of Core's AssetState
- * enum (VersionOne/AssetState.cs: Future 0, Active 64, Closed 128, Dead 192,
+ * An AssetState as the model carries it: the names of the server's AssetState
+ * enum (Future 0, Active 64, Closed 128, Dead 192,
  * OldBrokenDownStory 208, Deprecated 254, Deleted 255). rest-1 renders the
  * number and query.v1 the name; the wire layer normalises to the name.
  */
 type AssetStateValue = "Future" | "Active" | "Closed" | "Dead" | "Template" | "OldBrokenDownStory" | "Deprecated" | "Deleted";
-/** Core's AssetState codes, by name — the rest-1 rendering. */
+/** The server's AssetState codes, by name — the rest-1 rendering. */
 declare const ASSET_STATE_CODES: Record<AssetStateValue, number>;
 /**
  * An AssetState by name, whichever way the endpoint spelled it: api/asset
@@ -295,7 +295,7 @@ declare namespace attachment {
  *
  * Two ways in for the bytes, chosen by size:
  *   - inline: one api/asset create with Content as Base64. One request,
- *     what agility-rooms does; the JSON is a third larger than the file.
+ *     what a browser app consumer does; the JSON is a third larger than the file.
  *   - two-step, as the docs prescribe for anything not tiny: create the
  *     Attachment with empty Content, then POST the raw bytes. A failed
  *     upload leaves an empty Attachment, which is reported, not hidden.
@@ -4178,7 +4178,7 @@ interface QueryBody<F extends string = string> {
  * scalar or a single relation (null clears it). A multi-value relation is
  * changed with `{ add: [...], remove: [...] }`. A plain list does NOT
  * replace a multi-value relation: the server ADDS its members, like rest-1's
- * `act: "add"` (seen live on v1sdktesting, 2026-11-07). To set one exactly,
+ * `act: "add"` (seen live on the API-testing instance, 2026-11-07). To set one exactly,
  * remove what should go and add what should come. A change comment goes in
  * the update node as `ChangeComment`.
  */
@@ -4621,7 +4621,7 @@ declare class Schema implements AttributeLookup {
 
 /**
  * The batch service: an api/asset batch sent with a record of what it did.
- * Ported from gh-v1's lib/batch.js — preview, describe, snapshot, send
+ * Ported from the CLI consumer's batch module — preview, describe, snapshot, send
  * (guarded by default), receipt, reverse — minus what is the CLI's: file
  * I/O, console output, permalinks and the confirm prompt (a callback here).
  *
@@ -4634,7 +4634,7 @@ declare class Schema implements AttributeLookup {
  * which were skipped by the guard; and a reverse batch that undoes what
  * succeeded, best effort, with a note for anything it cannot.
  *
- * Closing a workitem cascades: Core's Inactivate and QuickClose also close
+ * Closing a workitem cascades: the server's Inactivate and QuickClose also close
  * its open descendants, and Reactivate reopens only the asset it names. So
  * before a batch that closes, the receipt records each closing target's
  * open descendants; after it, the ones the close actually closed; and the
@@ -4853,7 +4853,7 @@ declare function importantName(token: string, types: readonly AssetTypeToken[]):
 /**
  * The guard: an api/asset batch sent as a compare-and-set, so a change only
  * lands on an asset nobody else has changed since it was read. Ported from
- * gh-v1's lib/batch.js `guarded()`, with a different stamp.
+ * the CLI consumer's batch `guarded()`, with a different stamp.
  *
  * How: preview the batch (the server's projection expands every query-
  * scoped update and execute into one command per asset), read each touched