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

package/dist/index.js

@@ -5,16 +5,61 @@ var __export = (target, all) => {
 };
 
 // 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";
   }
 };
 
@@ -154,7 +199,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) {
@@ -178,6 +223,7 @@ __export(assetApi_exports, {
   mergeOutcome: () => mergeOutcome,
   momentless: () => momentless,
   outcomeOf: () => outcomeOf,
+  parseViolation: () => parseViolation,
   preview: () => preview,
   queries: () => queries,
   query: () => query,
@@ -343,15 +389,25 @@ 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: !token && rest.length > 1 ? 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) {
   return {
+    requestId: typeof response.requestId === "string" && response.requestId ? response.requestId : null,
     created: (response.assetsCreated?.oidTokens ?? []).map(momentless),
     modified: (response.assetsModified?.oidTokens ?? []).map(momentless),
     operated: (response.assetsOperatedOn?.oidTokens ?? []).map(momentless),
@@ -360,24 +416,28 @@ function outcomeOf(response) {
     durationSeconds: typeof response.durationSeconds === "number" ? response.durationSeconds : null
   };
 }
-var emptyOutcome = () => ({ created: [], modified: [], operated: [], failures: [], queryResults: [], durationSeconds: null });
+var emptyOutcome = () => ({ requestId: null, created: [], modified: [], operated: [], failures: [], queryResults: [], durationSeconds: null });
 function mergeOutcome(into, done, offset) {
   into.created.push(...done.created);
   into.modified.push(...done.modified);
   into.operated.push(...done.operated);
   into.failures.push(...done.failures.map((f) => ({ ...f, index: f.index === null ? null : f.index + offset })));
   into.queryResults.push(...done.queryResults);
+  into.requestId = null;
   if (done.durationSeconds !== null) into.durationSeconds = (into.durationSeconds ?? 0) + done.durationSeconds;
   return into;
 }
 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) => {
@@ -413,7 +473,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) => {
@@ -435,7 +495,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;
@@ -443,7 +503,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] ?? []);
 }
@@ -481,7 +541,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}`;
@@ -577,9 +637,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";
   }
@@ -612,7 +672,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("; ")}`);
@@ -678,7 +738,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 });
   }
@@ -695,16 +755,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;
@@ -921,18 +979,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;
   }
@@ -940,7 +998,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);
@@ -1046,6 +1104,65 @@ async function reversible(transport, receipt, options = {}) {
   return { commands, drifted, reactivated };
 }
 
+// src/wire/fields.ts
+var fields_exports = {};
+__export(fields_exports, {
+  visibleFields: () => visibleFields,
+  visibleFieldsByAsset: () => visibleFieldsByAsset
+});
+async function visibleFields(transport, types, scopes) {
+  if (!types.length) return {};
+  const params = [...scopes.map((s) => `scopeOid=${encodeURIComponent(momentless(s))}`), ...types.map((t) => `assetTypeToken=${encodeURIComponent(t)}`)].join("&");
+  const answer = await transport.request({ method: "GET", path: `/api/visibleFields?${params}`, responseType: "json" });
+  if (!Array.isArray(answer)) throw new ApiError("api/visibleFields did not answer a list", 200, "BAD_RESPONSE", answer);
+  const out = {};
+  for (const entry of answer) if (entry && typeof entry.assetType === "string") out[entry.assetType] = Array.isArray(entry.fields) ? entry.fields.filter((f) => typeof f === "string") : [];
+  return out;
+}
+async function visibleFieldsByAsset(transport, oid) {
+  const answer = await transport.request({ method: "GET", path: "/api/visibleFieldsByAsset", query: { oidToken: momentless(oid) }, responseType: "json" });
+  if (!Array.isArray(answer)) throw new ApiError("api/visibleFieldsByAsset did not answer a list", 200, "BAD_RESPONSE", answer);
+  return answer.filter((f) => typeof f === "string");
+}
+
+// src/services/fields.ts
+async function lineage(schema, type) {
+  const out = [];
+  for (let t = type; t && !out.includes(t); ) {
+    out.push(t);
+    const def = await schema.load(t);
+    t = def?.Base;
+  }
+  return out;
+}
+function importantName(token, types) {
+  const dot = token.indexOf(".");
+  if (dot < 0) return token;
+  return types.includes(token.slice(0, dot)) ? token.slice(dot + 1) : null;
+}
+async function describe2(transport, schema, type, scope) {
+  const scopeOid = momentless(scope);
+  const types = await lineage(schema, type);
+  const definition = await schema.load(type);
+  const required = definition ? Object.values(definition.Attributes).filter((a) => a.IsRequired && !a.IsReadOnly).map((a) => a.Name).sort() : [];
+  const [visible, [row]] = await Promise.all([
+    visibleFields(transport, [type], [scopeOid]),
+    query(transport, { from: "Scope", select: [{ from: "Scheme", select: ["ImportantFields", "IsRequiredAtClose"] }], filter: ["ID=$scope"], with: { $scope: scopeOid }, page: { size: 1, start: 0 } }, { lookup: schema })
+  ]);
+  const scheme = row?.Scheme ?? null;
+  const tokens = Array.isArray(scheme?.ImportantFields) ? scheme.ImportantFields.filter((t) => typeof t === "string") : [];
+  const important = [...new Set(tokens.map((t) => importantName(t, types)).filter((n) => !!n))].sort();
+  return {
+    type,
+    scope: scopeOid,
+    scheme: scheme ? momentless(scheme._oid) : null,
+    required,
+    visible: visible[type] ?? [],
+    important,
+    requiredAtClose: scheme?.IsRequiredAtClose === true
+  };
+}
+
 // src/types/asset.ts
 var ASSET_STATE_CODES = { Future: 0, Active: 64, Closed: 128, Dead: 192, Template: 200, OldBrokenDownStory: 208, Deprecated: 254, Deleted: 255 };
 var STATE_OF_CODE = Object.fromEntries(Object.entries(ASSET_STATE_CODES).map(([name, code]) => [code, name]));
@@ -1111,7 +1228,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)) {
@@ -1132,7 +1249,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
@@ -1194,7 +1311,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" }));
 }
 
@@ -1321,7 +1438,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 = {}) {
@@ -1341,7 +1458,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 {
@@ -1371,6 +1488,8 @@ __export(rest1_exports, {
   history: () => history,
   list: () => list2,
   momentless: () => momentless,
+  operate: () => operate,
+  template: () => template,
   toQuery: () => toQuery
 });
 var toRef = (doc) => ({ _oid: momentless(doc.idref) });
@@ -1402,8 +1521,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(","),
@@ -1415,16 +1534,29 @@ 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);
 }
+async function operate(transport, oid, op) {
+  const [type, id] = momentless(oid).split(":");
+  if (!type || !id) throw new UsageError(`"${oid}" is not an OID token (Story:1234)`);
+  const doc = await transport.request({ method: "POST", path: `/rest-1.v1/Data/${encodeURIComponent(type)}/${encodeURIComponent(id)}`, query: { op }, responseType: "json" });
+  if (!doc || typeof doc.id !== "string" || !doc.id) throw new ApiError(`rest-1 ${op} on ${oid} did not answer with an asset`, 200, "BAD_RESPONSE", doc);
+  const moment = doc.id.split(":")[2] ?? null;
+  return { oid: momentless(doc.id), moment };
+}
+async function template(transport, type, options = {}) {
+  const doc = await transport.request({ method: "GET", path: `/rest-1.v1/New/${encodeURIComponent(type)}`, query: { ctx: options.ctx ? momentless(options.ctx) : void 0 }, responseType: "json" });
+  const { _oid: _ignored, ...values } = fromAssetDocument({ ...doc, id: doc.id || `${type}:0` });
+  return values;
+}
 var history = (transport, target, params) => {
   const [type, id] = target.split(":");
   const path = id ? `/rest-1.v1/Hist/${encodeURIComponent(type)}/${encodeURIComponent(id)}` : `/rest-1.v1/Hist/${encodeURIComponent(type)}`;
@@ -1432,6 +1564,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;
@@ -1463,6 +1597,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),
@@ -1471,12 +1647,88 @@ 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 the other endpoints cannot do: deleted assets
+   * (`deleted: true`), one asset by OID without a page, history (one row
+   * per moment), a new asset's template (`template`: what the type's
+   * initializer fills in for a context — a Timebox's next name and dates,
+   * a Story's carry-over from a Request), and an operation's result
+   * (`operate`: api/asset performs a Copy but never says what it made;
+   * rest-1 answers the new OID). 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),
+    template: (type, options) => template(this.transport, type, options),
+    operate: (oid, op) => operate(this.transport, oid, op)
+  };
+  /** Copy an asset (the server's Copy operation) and answer the copy's OID: the one thing api/asset's `execute: "Copy"` does not say. */
+  async copy(oid) {
+    return (await operate(this.transport, oid, "Copy")).oid;
+  }
+  /**
+   * What a form needs for an asset type in a scope: the attributes the
+   * server requires to create one (meta), the ones the product shows there
+   * (api/visibleFields, custom fields included once configured), and the
+   * scope's scheme's important fields and whether they are enforced at
+   * close. `visible` alone answers for several types and scopes at once.
+   */
+  fields = {
+    describe: (type, scope) => describe2(this.transport, this.schema, type, scope),
+    visible: (types, scopes) => visibleFields(this.transport, types, scopes),
+    visibleByAsset: (oid) => visibleFieldsByAsset(this.transport, oid)
+  };
+  /** @deprecated since 1.0.0-alpha.3: use `client.query` / `client.queries` (the same endpoint, query.v1; only the name moved). 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` (rows, through query.v1) or `client.queryPage` (rows and a total, through api/asset as this does). 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
@@ -1499,7 +1751,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),
@@ -1509,7 +1761,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
@@ -1519,55 +1772,27 @@ 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),
+  /** Where a browser opens things on this instance: an asset's page, an attachment's bytes, an embedded image. */
+  urls = {
     /**
-     * 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.
+     * The asset's page, from an OID token or an asset Number (S-01001,
+     * what a person typed and what a message shows): assetdetail.v1
+     * resolves either and redirects to the type's own detail page; a signed-
+     * out reader lands there after logging in. Anything else is a UsageError.
      */
-    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 });
+    asset: (ref) => {
+      const base = this.config.baseUrl.replace(/\/+$/, "");
+      const text = ref.trim();
+      if (isOidToken(text)) return `${base}/assetdetail.v1?oid=${momentless(text)}`;
+      if (isAssetNumber(text)) return `${base}/assetdetail.v1?Number=${encodeURIComponent(text)}`;
+      throw new UsageError(`"${ref}" is neither an OID token (Story:1234) nor an asset number (S-1234)`);
     },
-    queries: async (qs) => {
-      await this.schema.ensureFor(qs);
-      return queries(this.transport, qs, { lookup: this.schema });
-    }
+    attachment: (id) => attachmentUrl(this.config.baseUrl, id),
+    embeddedImage: (id) => embeddedImageUrl(this.config.baseUrl, id)
   };
 };
 export {
@@ -1586,19 +1811,25 @@ export {
   TypeCache,
   UNGUARDABLE_TYPES,
   UnguardableError,
+  UsageError,
+  WrappedError,
   assetApi_exports as assetApi,
   assetStateOf,
   attachment_exports as attachment,
   createFetchTransport,
   describe as describeBatch,
+  fields_exports as fields,
   guard,
+  importantName,
   isAssetNumber,
   isOidToken,
+  kindOf,
   loc2_exports as loc2,
   meta_exports as meta,
   momentless,
   namesOf,
   parseOid,
+  parseViolation,
   queryV1_exports as queryV1,
   resolveNumbers,
   resolveRef,