@versionone/agility-sdk 1.0.0-alpha.2 → 1.0.0-alpha.3

package/README.md

@@ -16,7 +16,8 @@ npm install @versionone/agility-sdk@alpha
 import { AgilityApiClient } from "@versionone/agility-sdk";
 
 const client = new AgilityApiClient({ baseUrl: "https://www14.v1host.com/v1sdktesting", accessToken: process.env.V1_ACCESS_TOKEN });
-const stories = await client.queryV1.query({ from: "Story", select: ["Name", "Estimate"], page: { size: 10, start: 0 } });
+const stories = await client.query({ from: "Story", select: ["Name", "Estimate"], page: { size: 10, start: 0 } });
+// stories[0].Estimate is a number | null; stories[0].Nmae does not compile
 ```
 
 ## Working on the SDK
@@ -34,20 +35,26 @@ npm test
 - `npm run typecheck` - run TypeScript type checks
 - `npm run verify` - run typecheck + build + tests
 - `npm run test` - run unit tests
-- `npm run download:metamodel -- <baseAgilityUrl>` - download meta model for a given Agility instance
+- `npm run download:metamodel -- <baseAgilityUrl>` - refresh `metamodel.json` from an instance on the current release (instance-specific definitions stripped; `--raw` keeps them), then `npm run generate:types`. The cleanest source is a dev instance on a blank database (Core's gulp task for that); a hosted instance on the release gives the same file. The generated model is from meta.v1 **26.3.1.13** (hosted, 2026-11-12)
 
 ## Public API
 
-- `AgilityApiClient` - top-level SDK client (`meta`, `data` for rest-1, `assets` for api/asset, `localize` for loc-2, `schema`), and the services on it:
-  - `queryV1.query` / `queryV1.queries` - reads through query.v1: the same query bodies as `assets.query`, rows translated the same way, but the endpoint is read-only and answers with rows alone, so it is the safe place to explore a query
+Changes between alphas are in `CHANGELOG.md`, each with its migration line.
+
+- `AgilityApiClient` - the client. One query body everywhere; the client picks the endpoint:
+  - `query` / `queries` - rows, translated (numbers as numbers, booleans as booleans, a single relation as one `Ref`), through query.v1: read-only, so a request is retried like a GET. A page is required; a refused query throws, never an empty result. Written with a literal `from`, `select` completes from the type's attributes and the rows are typed by what was selected
+  - `get(oid, select)` - one asset or null; `queryPage(q)` - rows with the total and whether more follow; `pages(q, { limit })` / `all(q, { limit })` - page by page up to a limit (default 1000); `me()` - the member the credentials belong to
+  - `assets.send` - an api/asset batch, answered as an `Outcome` (`created`, `modified`, `operated`, `failures` with parsed violations, `queryResults`); `throwOnFailure` throws a `CommandFailureError` carrying the same Outcome. `assets.preview` - the projection. `assets.sendGuarded` - a batch as a compare-and-set on each asset's ChangeDate; changed assets come back `skipped`
+  - `batch.run` / `batch.reversible` - preview, snapshot, (confirm,) send guarded, and a receipt with a reverse batch; undo reactivates a closed asset before deleting it and reopens what a close cascaded to
   - `resolve.numbers` / `resolve.ref` - asset numbers and OID tokens to assets, in one request
-  - `assets.sendGuarded` - a batch as a compare-and-set on each asset's ChangeDate; changed assets come back `skipped`
-  - `attachments.list` / `page` / `info` / `get` / `add` / `put` / `remove` / `url` - files attached to an asset: metadata on the Attachment asset, bytes through attachment.img; `page` adds the total and whether more pages follow; `get`'s `contentType` is the type the server sent the bytes with; `add` sends a small file inline (Base64, one request) and a large one in two steps (create, then upload), and a failed upload throws `AttachmentUploadError` naming the empty attachment it left
-  - `embeddedImages.upload` / `url` / `normalize` - images in rich text: upload returns the `<img src>` URL; `normalize` rewrites `embedded.img` references to this instance's URL. They cannot be deleted
-  - `batch.run` / `batch.reversible` - preview, snapshot, (confirm,) send guarded, and a receipt with a reverse batch. Undo (`batch.reversible`) reactivates a closed asset before deleting it, and a second command on one asset is sent as a second guarded pass. The reverse uses only operations the type has in meta (a created Conversation, which has no `Delete`, is a note), and undoing an `Inactivate` or `QuickClose` reopens the descendants that close cascaded to (`receipt.openDescendants`, `receipt.cascaded`), parent first. A command the server reports as failed lands in `receipt.failed`, not `skipped`. `confirm` sees the touched assets' names; aliased updates/executes are sent as written with `guard: false`; a failure after the send throws `BatchRecordError` carrying the receipt
-- `TypeCache` - one instance's loaded type definitions, shared by many clients (`new AgilityApiClient(config, { types })`): a server that builds a client per user fetches each type once
+  - `attachments.list` / `page` / `info` / `get` / `add` / `put` / `remove` - files attached to an asset; `add` sends a small file inline and a large one in two steps, and a failed upload throws `AttachmentUploadError` naming the empty attachment it left
+  - `embeddedImages.upload` / `normalize` - images in rich text; they cannot be deleted
+  - `urls.asset` / `attachment` / `embeddedImage` - where a browser opens each
+  - `data.list` / `get` / `history` - rest-1 reads, for deleted assets and history; `meta.*` - meta.v1 raw; `schema` - the translated, cached view; `localize` - loc-2 labels for tags (a violation's `tag` is one)
+- Errors: everything thrown is an `ApiError` with a `kind` (`auth`, `forbidden`, `notFound`, `invalid`, `transient`, `aborted`, `commandFailure`, `protocol`, `usage`, `unknown`). A mistake caught before any request is a `UsageError`
+- `TypeCache` - one instance's loaded type definitions, shared by many clients (`new AgilityApiClient(config, { types })`)
 - `createFetchTransport` - configurable HTTP transport: `credentials` for same-origin cookie auth, `onUnauthorized` to re-authenticate on a 401 (resends idempotent requests once), and a per-request `signal`; `client.withSignal(signal)` ties a whole client to one
-- `ApiError` - typed API error; `CommandFailureError` - an api/asset batch in which commands failed (`failures` by index, plus the `response`)
+- The wire modules (`assetApi`, `queryV1`, `rest1`, `meta`, `loc2`, `attachment`) are exported for passthroughs and transport authors; they speak the endpoints' own shapes
 
 API reference: https://docs.digital.ai/agility-api/
 

package/dist/index.cjs

@@ -35,6 +35,8 @@ __export(index_exports, {
   TypeCache: () => TypeCache,
   UNGUARDABLE_TYPES: () => UNGUARDABLE_TYPES,
   UnguardableError: () => UnguardableError,
+  UsageError: () => UsageError,
+  WrappedError: () => WrappedError,
   assetApi: () => assetApi_exports,
   assetStateOf: () => assetStateOf,
   attachment: () => attachment_exports,
@@ -43,11 +45,13 @@ __export(index_exports, {
   guard: () => guard,
   isAssetNumber: () => isAssetNumber,
   isOidToken: () => isOidToken,
+  kindOf: () => kindOf,
   loc2: () => loc2_exports,
   meta: () => meta_exports,
   momentless: () => momentless,
   namesOf: () => namesOf,
   parseOid: () => parseOid,
+  parseViolation: () => parseViolation,
   queryV1: () => queryV1_exports,
   resolveNumbers: () => resolveNumbers,
   resolveRef: () => resolveRef,
@@ -67,16 +71,61 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/core/errors.ts
+function kindOf(status, code) {
+  switch (code) {
+    case "ABORTED":
+      return "aborted";
+    case "TIMEOUT":
+    case "NETWORK_ERROR":
+      return "transient";
+    case "BAD_JSON":
+    case "BAD_RESPONSE":
+      return "protocol";
+    case "USAGE":
+      return "usage";
+    case "CommandFailure":
+      return "commandFailure";
+    case "QUERY_REJECTED":
+    case "TOO_LARGE":
+      return "invalid";
+    case "NOT_FOUND":
+      return "notFound";
+  }
+  if (status === 401) return "auth";
+  if (status === 403) return "forbidden";
+  if (status === 404) return "notFound";
+  if (status === 408 || status === 429 || status >= 500) return "transient";
+  if (status >= 400) return "invalid";
+  return "unknown";
+}
+var causeOf = (details) => details && typeof details === "object" && "cause" in details ? details.cause : void 0;
 var ApiError = class extends Error {
+  /** The HTTP status; 0 when no answer came back (network, timeout, abort, usage). */
   status;
   code;
   details;
-  constructor(message, status, code, details) {
-    super(message);
+  kind;
+  constructor(message, status, code, details, kind = kindOf(status, code)) {
+    const cause = causeOf(details);
+    super(message, cause === void 0 ? void 0 : { cause });
     this.name = "ApiError";
     this.status = status;
     this.code = code;
     this.details = details;
+    this.kind = kind;
+  }
+};
+var UsageError = class extends ApiError {
+  constructor(message, details) {
+    super(message, 0, "USAGE", details, "usage");
+    this.name = "UsageError";
+  }
+};
+var WrappedError = class extends ApiError {
+  constructor(message, code, cause, details) {
+    const inner = cause instanceof ApiError ? cause : void 0;
+    super(message, inner?.status ?? 0, code, { ...details, cause }, inner?.kind ?? "unknown");
+    this.name = "WrappedError";
   }
 };
 
@@ -216,7 +265,7 @@ function isOidToken(value) {
 }
 function parseOid(token) {
   const m = OID_TOKEN.exec(token);
-  if (!m) throw new Error(`"${token}" is not an OID token (Story:1234)`);
+  if (!m) throw new UsageError(`"${token}" is not an OID token (Story:1234)`);
   return { type: m[1], id: Number(m[2]), moment: m[3] === void 0 ? null : Number(m[3]) };
 }
 function momentless(token) {
@@ -240,6 +289,7 @@ __export(assetApi_exports, {
   mergeOutcome: () => mergeOutcome,
   momentless: () => momentless,
   outcomeOf: () => outcomeOf,
+  parseViolation: () => parseViolation,
   preview: () => preview,
   queries: () => queries,
   query: () => query,
@@ -405,11 +455,20 @@ function toNumber(value) {
   const n = typeof value === "string" && value.trim() !== "" ? Number(value) : NaN;
   return Number.isNaN(n) ? value : n;
 }
+function parseViolation(message) {
+  const parts = message.trim().split("'");
+  if (parts[0] !== "Violation" || !parts[1]) return null;
+  const rule = parts[1], rest = parts.slice(2).filter((p) => p !== "");
+  if (rest[0] === "AttributeDefinition" && rest[1] && rest[2]) return { rule, attribute: `${rest[2]}.${rest[1]}`, tag: rest.join("'") };
+  const token = rest.length === 1 && /^[A-Za-z][A-Za-z0-9_]*\.[A-Za-z][A-Za-z0-9_]*$/.test(rest[0]) ? rest[0] : null;
+  return { rule, attribute: token, tag: rest.length ? rest.join("'") : null };
+}
 function failuresOf(response) {
   return (response.commandFailures?.commands ?? []).map(({ error, ...echoed }) => ({
     index: typeof error === "object" && error && typeof error.sourceCommandIndex === "number" ? error.sourceCommandIndex : null,
     message: typeof error === "string" ? error : error?.message || "command failed",
-    echoed
+    echoed,
+    violation: parseViolation(typeof error === "string" ? error : error?.message || "")
   }));
 }
 function outcomeOf(response) {
@@ -435,11 +494,14 @@ function mergeOutcome(into, done, offset) {
 var CommandFailureError = class extends ApiError {
   failures;
   response;
+  /** What the batch did, in the model's terms: the commands that succeeded are committed. */
+  outcome;
   constructor(response, failures = failuresOf(response)) {
     super(failures.map((f) => f.message).join("; ") || "command failed", 200, "CommandFailure", failures);
     this.name = "CommandFailureError";
     this.failures = failures;
     this.response = response;
+    this.outcome = outcomeOf(response);
   }
 };
 var bodyOf = (c) => {
@@ -475,7 +537,7 @@ async function send(transport, commands, options = {}) {
   const results = response.queryResult?.results ?? [];
   let aligned = realign(queries3, results, failed);
   if (!aligned) {
-    if (!failures.some((f) => f.index === null)) throw new Error(`api/asset returned ${results.length} query results for ${queries3.filter((q) => !failed.has(q.index)).length} queries that did not fail; cannot tell which result belongs to which query`);
+    if (!failures.some((f) => f.index === null)) throw new ApiError(`api/asset returned ${results.length} query results for ${queries3.filter((q) => !failed.has(q.index)).length} queries that did not fail; cannot tell which result belongs to which query`, 200, "BAD_RESPONSE", response);
     aligned = queries3.map(() => null);
   }
   const contextOf = (i) => {
@@ -497,7 +559,7 @@ async function query(transport, q, options = {}) {
   return rows ?? [];
 }
 async function queryPage(transport, q, options = {}) {
-  if (!q.page) throw new Error(`query of ${q.from} without a page: every api/asset read must be bounded`);
+  if (!q.page) throw new UsageError(`query of ${q.from} without a page: every api/asset read must be bounded`);
   const response = await send(transport, [{ ...q, needTotal: true }], { ...options, throwOnFailure: true });
   const rows = response.queryResult.results[0] ?? [];
   const reported = response.queryResult.resultMetaData?.[0]?.total;
@@ -505,7 +567,7 @@ async function queryPage(transport, q, options = {}) {
   return { rows, total, more: total === null ? rows.length === q.page.size : q.page.start + rows.length < total };
 }
 async function queries(transport, qs, options = {}) {
-  for (const q of qs) if (!q.page) throw new Error(`query of ${q.from} without a page: every api/asset read must be bounded`);
+  for (const q of qs) if (!q.page) throw new UsageError(`query of ${q.from} without a page: every api/asset read must be bounded`);
   const response = await send(transport, qs, { ...options, throwOnFailure: true });
   return qs.map((_, i) => response.queryResult.results[i] ?? []);
 }
@@ -543,7 +605,7 @@ function fromBase64(text) {
 }
 function numericId(spec) {
   const m = /^(?:[A-Za-z]+:)?(\d+)(?::\d+)?$/.exec(String(spec).trim());
-  if (!m) throw new TypeError(`"${spec}" is not an asset id (5678, or an OID token such as Attachment:5678)`);
+  if (!m) throw new UsageError(`"${spec}" is not an asset id (5678, or an OID token such as Attachment:5678)`);
   return m[1];
 }
 var join = (baseUrl, path) => `${baseUrl.replace(/\/+$/, "")}/${path}`;
@@ -639,9 +701,9 @@ async function get(transport, id) {
   const file = await getFile(transport, meta.id);
   return { ...meta, bytes: file.bytes, contentType: file.contentType ?? meta.contentType, recordedContentType: meta.contentType };
 }
-var AttachmentUploadError = class extends Error {
+var AttachmentUploadError = class extends WrappedError {
   constructor(attachment, cause) {
-    super(`${attachment.oid} was created on its asset with no content, and uploading the file failed: ${cause instanceof Error ? cause.message : String(cause)}`, { cause });
+    super(`${attachment.oid} was created on its asset with no content, and uploading the file failed: ${cause instanceof Error ? cause.message : String(cause)}`, "ATTACHMENT_UPLOAD", cause);
     this.attachment = attachment;
     this.name = "AttachmentUploadError";
   }
@@ -674,7 +736,7 @@ async function remove(transport, id) {
 // src/services/guard.ts
 var CHUNK = 100;
 var UNGUARDABLE_TYPES = ["Idea", "IdeaChangeSet", "IdeaStatus", "IdeaComment", "IdeaCategory", "IdeaForum", "IdeaUser"];
-var UnguardableError = class extends Error {
+var UnguardableError = class extends UsageError {
   reasons;
   constructor(reasons) {
     super(`cannot guard this batch: ${reasons.map((r) => `command ${r.index}: ${r.reason}`).join("; ")}`);
@@ -740,7 +802,7 @@ function guard(projected, stamps) {
       unstamped.push(x.oid);
       continue;
     }
-    if (!STAMP.test(stamp)) throw new Error(`${x.oid}: ChangeDate ${JSON.stringify(stamp)} is not a timestamp; refusing to put it in a filter`);
+    if (!STAMP.test(stamp)) throw new ApiError(`${x.oid}: ChangeDate ${JSON.stringify(stamp)} is not a timestamp; refusing to put it in a filter`, 200, "BAD_RESPONSE", { oid: x.oid, stamp });
     const scope = { from: typeOfOid(x.oid), filter: ["ID=$oid", `ChangeDate='${stamp}'`], with: { $oid: x.oid } };
     commands.push(x.update ? { ...scope, update: x.update } : { ...scope, execute: x.execute });
   }
@@ -757,16 +819,14 @@ function passesOf(projected) {
   }
   return passes;
 }
-var GuardedPassError = class extends Error {
+var GuardedPassError = class extends WrappedError {
   constructor(cause, outcome, sent, pass) {
-    super(`guarded send failed in pass ${pass + 1}${pass ? " (earlier passes applied)" : ""}: ${cause instanceof Error ? cause.message : String(cause)}`, { cause });
-    this.cause = cause;
+    super(`guarded send failed in pass ${pass + 1}${pass ? " (earlier passes applied)" : ""}: ${cause instanceof Error ? cause.message : String(cause)}`, "GUARDED_PASS", cause);
     this.outcome = outcome;
     this.sent = sent;
     this.pass = pass;
     this.name = "GuardedPassError";
   }
-  cause;
   outcome;
   sent;
   pass;
@@ -983,18 +1043,18 @@ function reverseOf(described, before, done, context = {}) {
   if (commands.length) notes.unshift("restores the state recorded at snapshotAt; anything that changed between then and sentAt is not reflected, and a scalar restored to null is cleared, not unset");
   return { commands, notes };
 }
-var BatchRecordError = class extends Error {
+var BatchRecordError = class extends WrappedError {
   receipt;
   constructor(cause, receipt) {
-    super(`the batch was sent and its outcome recorded, but reading the assets back afterwards failed, so receipt.after is incomplete: ${cause instanceof Error ? cause.message : String(cause)}`, { cause });
+    super(`the batch was sent and its outcome recorded, but reading the assets back afterwards failed, so receipt.after is incomplete: ${cause instanceof Error ? cause.message : String(cause)}`, "BATCH_RECORD", cause);
     this.name = "BatchRecordError";
     this.receipt = receipt;
   }
 };
-var BatchSendError = class extends Error {
+var BatchSendError = class extends WrappedError {
   receipt;
   constructor(cause, receipt) {
-    super(`the batch send failed; whether the server applied it is unknown: ${cause instanceof Error ? cause.message : String(cause)}`, { cause });
+    super(`the batch send failed; whether the server applied it is unknown: ${cause instanceof Error ? cause.message : String(cause)}`, "BATCH_SEND", cause);
     this.name = "BatchSendError";
     this.receipt = receipt;
   }
@@ -1002,7 +1062,7 @@ var BatchSendError = class extends Error {
 var now = () => (/* @__PURE__ */ new Date()).toISOString();
 async function runBatch(transport, schema, commands, options = {}) {
   const useGuard = options.guard ?? true;
-  if (!commands.length) throw new Error("the batch is empty");
+  if (!commands.length) throw new UsageError("the batch is empty");
   const refused = unguardable(commands);
   const fatal = refused.filter((r) => r.reason.includes("rejected by the server"));
   if (fatal.length || useGuard && refused.length) throw new UnguardableError(useGuard ? refused : fatal);
@@ -1173,7 +1233,7 @@ async function resolveNumbers(transport, numbers, options = {}) {
   for (const n of numbers) if (!firsts.has(n.trim().toUpperCase())) firsts.set(n.trim().toUpperCase(), n.trim());
   const asked = [...firsts.values()];
   const invalid = asked.filter((n) => !isAssetNumber(n));
-  if (invalid.length) throw new TypeError(`not asset numbers (expected a prefix and digits, S-1234): ${invalid.join(", ")}`);
+  if (invalid.length) throw new UsageError(`not asset numbers (expected a prefix and digits, S-1234): ${invalid.join(", ")}`);
   const byNumber = /* @__PURE__ */ new Map();
   for (let i = 0; i < asked.length; i += CHUNK3) {
     for (const r of await askRoots(transport, asked.slice(i, i + CHUNK3), options.types)) {
@@ -1194,7 +1254,7 @@ async function resolveRef(transport, spec, options = {}) {
     return { number: null, oid, type: typeOfOid(oid), name: null, assetState: null };
   }
   if (isAssetNumber(text)) return (await resolveNumbers(transport, [text], options)).found[0] ?? null;
-  throw new TypeError(`"${spec}" is neither an asset number (S-1234) nor an OID token (Story:1234)`);
+  throw new UsageError(`"${spec}" is neither an asset number (S-1234) nor an OID token (Story:1234)`);
 }
 
 // src/wire/meta.ts
@@ -1256,7 +1316,7 @@ async function getAssetType(transport, token) {
 }
 async function getAttributeDefinition(transport, tokenref) {
   const [type, attribute] = tokenref.split(".");
-  if (!type || !attribute) throw new Error(`"${tokenref}" is not an attribute token ("Story.Name")`);
+  if (!type || !attribute) throw new UsageError(`"${tokenref}" is not an attribute token ("Story.Name")`);
   return toAttributeDefinition(await transport.request({ method: "GET", path: `/meta.v1/${encodeURIComponent(type)}/${encodeURIComponent(attribute)}`, responseType: "json" }));
 }
 
@@ -1383,7 +1443,7 @@ async function localize(transport, tags, options = {}) {
   const encoded = encodeURIComponent(toLson(unique));
   const headers = options.culture ? { "Accept-Language": options.culture } : void 0;
   const result = encoded.length <= (options.maxGetLength ?? DEFAULT_MAX_GET_LENGTH) ? await transport.request({ method: "GET", path: `/loc-2.v1?${encoded}`, headers, responseType: "json" }) : await transport.request({ method: "POST", path: "/loc-2.v1", headers, body: encoded, contentType: "application/x-www-form-urlencoded", responseType: "json", idempotent: true });
-  if (!result || typeof result !== "object" || Array.isArray(result)) throw new Error(`loc-2.v1 answered an array of tags with ${JSON.stringify(result)?.slice(0, 100)}, not an object`);
+  if (!result || typeof result !== "object" || Array.isArray(result)) throw new ApiError(`loc-2.v1 answered an array of tags with ${JSON.stringify(result)?.slice(0, 100)}, not an object`, 200, "BAD_RESPONSE", result);
   return result;
 }
 async function localizeOne(transport, tag, options = {}) {
@@ -1403,7 +1463,7 @@ function rejected(error) {
   return messages.length ? new ApiError(messages.join("; "), error.status, "QUERY_REJECTED", error.details) : error;
 }
 async function queries2(transport, qs, options = {}) {
-  for (const q of qs) if (!q.page) throw new Error(`query of ${q.from} without a page: every query.v1 read must be bounded`);
+  for (const q of qs) if (!q.page) throw new UsageError(`query of ${q.from} without a page: every query.v1 read must be bounded`);
   if (!qs.length) return [];
   let response;
   try {
@@ -1464,8 +1524,8 @@ function fromAssetDocument(doc, { history: history2 = false } = {}) {
 }
 function toQuery(params) {
   return {
-    sel: params.sel?.join(","),
-    where: params.where?.length ? params.where.join(";") : void 0,
+    sel: (params.select ?? params.sel)?.join(","),
+    where: (params.filter ?? params.where)?.length ? (params.filter ?? params.where).join(";") : void 0,
     with: params.with ? Object.entries(params.with).map(([k, v]) => `${k}=${[].concat(v).join(",")}`).join("|") : void 0,
     find: params.find,
     findin: params.findin?.join(","),
@@ -1477,14 +1537,14 @@ function toQuery(params) {
   };
 }
 async function read(transport, path, params, history2) {
-  if (!params.page) throw new Error(`rest-1 read of ${path} without a page: every read must be bounded`);
+  if (!params.page) throw new UsageError(`rest-1 read of ${path} without a page: every read must be bounded`);
   const doc = await transport.request({ method: "GET", path, query: toQuery(params), responseType: "json" });
   return { rows: (doc.Assets ?? []).map((a) => fromAssetDocument(a, { history: history2 })), total: typeof doc.total === "number" && doc.total >= 0 ? doc.total : null, pageSize: doc.pageSize, pageStart: doc.pageStart };
 }
 var list2 = (transport, type, params) => read(transport, `/rest-1.v1/Data/${encodeURIComponent(type)}`, params, false);
-async function get2(transport, oid, sel) {
+async function get2(transport, oid, select) {
   const [type, id] = momentless(oid).split(":");
-  const doc = await transport.request({ method: "GET", path: `/rest-1.v1/Data/${encodeURIComponent(type)}/${encodeURIComponent(id)}`, query: { sel: sel?.join(",") }, responseType: "json" });
+  const doc = await transport.request({ method: "GET", path: `/rest-1.v1/Data/${encodeURIComponent(type)}/${encodeURIComponent(id)}`, query: { sel: select?.join(",") }, responseType: "json" });
   return fromAssetDocument(doc);
 }
 var history = (transport, target, params) => {
@@ -1494,6 +1554,8 @@ var history = (transport, target, params) => {
 };
 
 // src/client.ts
+var DEFAULT_LIMIT = 1e3;
+var ME_SELECT = ["Name", "Username", "Nickname", "Email"];
 var AgilityApiClient = class _AgilityApiClient {
   transport;
   schema;
@@ -1525,6 +1587,48 @@ var AgilityApiClient = class _AgilityApiClient {
     const transport = { request: (options) => base.request({ ...options, signal: options.signal ?? signal }) };
     return new _AgilityApiClient(this.config, { transport, schema: this.schema });
   }
+  async query(q) {
+    await this.schema.ensureFor([q]);
+    return query2(this.transport, q, { lookup: this.schema });
+  }
+  async queries(qs) {
+    await this.schema.ensureFor(qs);
+    return queries2(this.transport, [...qs], { lookup: this.schema });
+  }
+  async get(oid, select) {
+    const rows = await this.query({ from: momentless(oid), ...select ? { select } : {}, page: { size: 1, start: 0 } });
+    return rows[0] ?? null;
+  }
+  async queryPage(q) {
+    await this.schema.ensureFor([q]);
+    return queryPage(this.transport, q, { lookup: this.schema });
+  }
+  async *pages(q, options = {}) {
+    if (!q.page) throw new UsageError(`query of ${q.from} without a page: every read must be bounded`);
+    const limit = options.limit ?? DEFAULT_LIMIT;
+    const size = q.page.size;
+    let start = q.page.start, read2 = 0;
+    while (read2 < limit) {
+      const want = Math.min(size, limit - read2);
+      const rows = await this.query({ ...q, page: { size: want, start } });
+      if (rows.length) yield rows;
+      read2 += rows.length;
+      start += rows.length;
+      if (rows.length < want) return;
+    }
+  }
+  async all(q, options = {}) {
+    const out = [];
+    for await (const page2 of this.pages(q, options)) out.push(...page2);
+    return out;
+  }
+  /** The member these credentials belong to (Member.IsSelf, live 2026-11-12): what a comment's Author is. */
+  async me() {
+    const [row] = await this.query({ from: "Member", select: ME_SELECT, filter: ["IsSelf='true'"], page: { size: 1, start: 0 } });
+    if (!row) throw new ApiError("the server knows no member for these credentials", 0, "NOT_FOUND");
+    return row;
+  }
+  // ---- the endpoints behind the reads -----------------------------------------------
   /** meta.v1: the instance's schema, raw. (The translated, cached view is `schema`.) */
   meta = {
     metamodel: () => getMetamodel(this.transport),
@@ -1533,12 +1637,65 @@ var AgilityApiClient = class _AgilityApiClient {
   };
   /**
    * loc-2.v1: labels for tags, in one request (meta's DisplayName values are
-   * tags). An unmatched tag comes back as itself; the server never says
-   * "missing", so neither does this.
+   * tags, and so is a violation's `tag`). An unmatched tag comes back as
+   * itself; the server never says "missing", so neither does this.
    */
   localize(tags, options) {
     return localize(this.transport, tags, options);
   }
+  /**
+   * rest-1.v1, for what query.v1 cannot do: deleted assets (`deleted:
+   * true`), one asset by OID without a page, and history (one row per
+   * moment). Parameters are spelled as a query's (`select`, `filter`).
+   */
+  data = {
+    list: (type, params) => list2(this.transport, type, params),
+    get: (oid, select) => get2(this.transport, oid, select),
+    history: (target, params) => history(this.transport, target, params)
+  };
+  /** @deprecated since 1.0.0-alpha.3: `client.query` / `client.queries` read through query.v1. Removed in 1.0.0. */
+  queryV1 = {
+    query: (q) => this.query(q),
+    queries: (qs) => this.queries(qs)
+  };
+  // ---- writes -----------------------------------------------------------------------
+  /** api/asset: batches, answered in the model's terms. */
+  assets = {
+    /**
+     * Send a batch. The Outcome says what it did — created, modified and
+     * operated OIDs, failures by index (each with its parsed violation),
+     * query rows per query command — and never the envelope. api/asset
+     * commits per command and answers 200 either way, so a failed command
+     * is in `failures`, or thrown as a CommandFailureError with
+     * `throwOnFailure` (the error carries the same Outcome).
+     */
+    send: async (commands, options) => {
+      await this.schema.ensureFor(commands);
+      return outcomeOf(await send(this.transport, commands, { ...options, lookup: this.schema }));
+    },
+    /** The server's projection of a batch: one command per asset it would touch, nothing applied. */
+    preview: (commands) => preview(this.transport, commands),
+    /**
+     * Send as a compare-and-set: each asset is changed only if nobody has
+     * changed it since the preview read it; the rest come back `skipped`.
+     * Throws UnguardableError, before any request, for shapes it cannot
+     * cover.
+     */
+    sendGuarded: async (commands, options) => {
+      await this.schema.ensureFor(commands);
+      return sendGuarded(this.transport, commands, { ...options, lookup: this.schema });
+    },
+    /** @deprecated since 1.0.0-alpha.3: use `client.query` (or `client.queryPage` for a total). Removed in 1.0.0. */
+    query: async (q) => {
+      await this.schema.ensureFor([q]);
+      return query(this.transport, q, { lookup: this.schema });
+    },
+    /** @deprecated since 1.0.0-alpha.3: use `client.queries`. Removed in 1.0.0. */
+    queries: async (qs) => {
+      await this.schema.ensureFor(qs);
+      return queries(this.transport, qs, { lookup: this.schema });
+    }
+  };
   /**
    * Services: what a person types, turned into assets. Numbers resolve in
    * one api/asset request across every number root; an OID token is taken
@@ -1561,7 +1718,7 @@ var AgilityApiClient = class _AgilityApiClient {
   /**
    * The files attached to assets: metadata on Attachment assets, bytes
    * through attachment.img. `add` sends a small file inline (one request)
-   * and a large one in two steps; `url` is where a browser opens one.
+   * and a large one in two steps.
    */
   attachments = {
     list: (asset, options) => list(this.transport, asset, options),
@@ -1571,7 +1728,8 @@ var AgilityApiClient = class _AgilityApiClient {
     add: (asset, data, options) => add(this.transport, asset, data, options),
     put: (id, data, contentType) => put(this.transport, id, data, contentType),
     remove: (id) => remove(this.transport, id),
-    url: (id) => attachmentUrl(this.config.baseUrl, id)
+    /** @deprecated since 1.0.0-alpha.3: `client.urls.attachment`. Removed in 1.0.0. */
+    url: (id) => this.urls.attachment(id)
   };
   /**
    * Images embedded in an asset's rich text (Description and other long
@@ -1581,55 +1739,16 @@ var AgilityApiClient = class _AgilityApiClient {
    */
   embeddedImages = {
     upload: (asset, data, options) => uploadEmbeddedImage(this.transport, asset, data, options),
-    url: (id) => embeddedImageUrl(this.config.baseUrl, id),
+    /** @deprecated since 1.0.0-alpha.3: `client.urls.embeddedImage`. Removed in 1.0.0. */
+    url: (id) => this.urls.embeddedImage(id),
     normalize: (html) => normalizeEmbeddedImageUrls(html, this.config.baseUrl)
   };
-  /** rest-1.v1: bounded reads, one asset, history. */
-  data = {
-    list: (type, params) => list2(this.transport, type, params),
-    get: (oid, sel) => get2(this.transport, oid, sel),
-    history: (target, params) => history(this.transport, target, params)
-  };
-  /**
-   * query.v1: reads only, the same query bodies as assets.query, rows
-   * translated the same way. The endpoint cannot write, so it is the safe
-   * place to explore a query; its requests may be retried like a GET.
-   */
-  queryV1 = {
-    query: async (q) => {
-      await this.schema.ensureFor([q]);
-      return query2(this.transport, q, { lookup: this.schema });
-    },
-    queries: async (qs) => {
-      await this.schema.ensureFor(qs);
-      return queries2(this.transport, qs, { lookup: this.schema });
-    }
-  };
-  /** api/asset: batches and queries, rows translated through the schema. */
-  assets = {
-    send: async (commands, options) => {
-      await this.schema.ensureFor(commands);
-      return send(this.transport, commands, { ...options, lookup: this.schema });
-    },
-    preview: (commands) => preview(this.transport, commands),
-    /**
-     * Send as a compare-and-set: each asset is changed only if nobody has
-     * changed it since the preview read it; the rest come back `skipped`.
-     * Throws UnguardableError, before any request, for shapes it cannot
-     * cover.
-     */
-    sendGuarded: async (commands, options) => {
-      await this.schema.ensureFor(commands);
-      return sendGuarded(this.transport, commands, { ...options, lookup: this.schema });
-    },
-    query: async (q) => {
-      await this.schema.ensureFor([q]);
-      return query(this.transport, q, { lookup: this.schema });
-    },
-    queries: async (qs) => {
-      await this.schema.ensureFor(qs);
-      return queries(this.transport, qs, { lookup: this.schema });
-    }
+  /** Where a browser opens things on this instance: an asset's page, an attachment's bytes, an embedded image. */
+  urls = {
+    /** The asset's page: assetdetail.v1 redirects to the type's own detail page (live 2026-11-12). */
+    asset: (oid) => `${this.config.baseUrl.replace(/\/+$/, "")}/assetdetail.v1?oid=${momentless(oid)}`,
+    attachment: (id) => attachmentUrl(this.config.baseUrl, id),
+    embeddedImage: (id) => embeddedImageUrl(this.config.baseUrl, id)
   };
 };
 // Annotate the CommonJS export names for ESM import in node:
@@ -1649,6 +1768,8 @@ var AgilityApiClient = class _AgilityApiClient {
   TypeCache,
   UNGUARDABLE_TYPES,
   UnguardableError,
+  UsageError,
+  WrappedError,
   assetApi,
   assetStateOf,
   attachment,
@@ -1657,11 +1778,13 @@ var AgilityApiClient = class _AgilityApiClient {
   guard,
   isAssetNumber,
   isOidToken,
+  kindOf,
   loc2,
   meta,
   momentless,
   namesOf,
   parseOid,
+  parseViolation,
   queryV1,
   resolveNumbers,
   resolveRef,