@synnaxlabs/client 0.54.2 → 0.56.0

package/src/framer/writer.ts

@@ -60,14 +60,14 @@ const baseWriterConfigZ = z.object({
   /** controlSubject sets the control subject of the writer. */
   controlSubject: control.subjectZ.optional(),
   /** authorities set the control authority to set for each channel on the writer.
-   * Defaults to absolute authority. If not working with concurrent control,
-   * it's best to leave this as the default.
+   * Defaults to absolute authority. If not working with concurrent control, it's best
+   * to leave this as the default.
    */
   authorities: z
     .union([control.authorityZ.transform((a) => [a]), control.authorityZ.array()])
     .default([control.ABSOLUTE_AUTHORITY]),
-  /** mode sets the persistence and streaming mode of the writer. The default
-   * mode is WriterModePersistStream.
+  /** mode sets the persistence and streaming mode of the writer. The default mode is
+   * WriterModePersistStream.
    */
   mode: writerModeZ.default(WriterMode.PersistStream),
   /**
@@ -76,19 +76,23 @@ const baseWriterConfigZ = z.object({
    */
   errOnUnauthorized: z.boolean().default(false),
   /**
-   * enableAutoCommit determines whether the writer will automatically commit.
-   * If enableAutoCommit is true, then the writer will commit after each write, and
-   * will flush that commit to index after the specified autoIndexPersistInterval.
+   * enableAutoCommit determines whether the writer will automatically commit. If
+   * enableAutoCommit is true, then the writer will commit after each write, and will
+   * flush that commit to index after the specified autoIndexPersistInterval.
    */
   enableAutoCommit: z.boolean().default(true),
   /** autoIndexPersistInterval sets the interval at which commits will be flushed to
    * disk. */
   autoIndexPersistInterval: TimeSpan.z.default(TimeSpan.SECOND),
-  /*
-   * useHighPerformanceCodec sets whether the writer will use the synnax frame
-   * encoder as opposed to the standard JSON encoding mechanisms for frames.
+  /**
+   * autoIndex causes Synnax to automatically generate timestamps for any index channel
+   * that is not included in a write call. The first sample in each write is stamped at
+   * the time the write is received, and subsequent samples are spaced 1 nanosecond
+   * apart. Generated timestamps are guaranteed to be strictly monotonic across all
+   * writes on the writer. If the writer is opened with data channels whose index
+   * channels are not included, those index channels are added implicitly.
    */
-  useHighPerformanceCodec: z.boolean().default(true),
+  autoIndex: z.boolean().default(false),
 });
 
 const netWriterConfigZ = baseWriterConfigZ.extend({
@@ -212,8 +216,7 @@ export class Writer {
   ): Promise<Writer> {
     const cfg = zod.parse(writerConfigZ, config);
     const adapter = await WriteAdapter.open(retriever, cfg.channels);
-    if (cfg.useHighPerformanceCodec)
-      client = client.withCodec(new WSWriterCodec(adapter.codec));
+    client = client.withCodec(new WSWriterCodec(adapter.codec));
     const stream = await client.stream("/frame/write", reqZ, resZ);
     const writer = new Writer(stream, adapter);
     await writer.execute({
@@ -245,13 +248,14 @@ export class Writer {
    * @param frame - The frame to write to the database. The frame must:
    *
    *    1. Have exactly one array for each key in the list of keys provided to the
-   *    writer's open method.
+   *       writer's open method.
    *    2. Have equal length arrays for each key.
    *    3. When writing to an index (i.e. TimeStamp) channel, the values must be
-   *    monotonically increasing.
+   *       monotonically increasing.
    *
-   * @returns false if the writer has accumulated an error. In this case, the caller
-   * should acknowledge the error by calling the error method or closing the writer.
+   * @throws if the writer has accumulated an error. Once write throws, all subsequent
+   * calls to write and commit will also throw, and the writer must be closed and
+   * re-opened to continue writing.
    */
   async write(
     channelsOrData:
@@ -263,7 +267,11 @@ export class Writer {
     if (this.closeErr != null) throw this.closeErr;
     if (this.stream.received()) return await this.close();
     const frame = await this.adapter.adapt(channelsOrData, series);
-    this.stream.send({ command: WriterCommand.Write, frame: frame.toPayload() });
+    try {
+      this.stream.send({ command: WriterCommand.Write, frame: frame.toPayload() });
+    } catch (err) {
+      if (!EOF.matches(err)) throw err;
+    }
   }
 
   async setAuthority(
@@ -283,9 +291,9 @@ export class Writer {
    * Commits the written frames to the database. Commit is synchronous, meaning that it
    * will not return until all frames have been committed to the database.
    *
-   * @returns false if the commit failed due to an error. In this case, the caller
-   * should acknowledge the error by calling the error method or closing the writer.
-   * After the caller acknowledges the error, they can attempt to commit again.
+   * @returns the timestamp of the last sample written to the writer.
+   * @throws if the commit fails or any previous writer method has thrown. Once commit
+   * throws, the writer must be closed and re-opened to continue use.
    */
   async commit(): Promise<TimeStamp> {
     if (this.closeErr != null) throw this.closeErr;
@@ -315,18 +323,35 @@ export class Writer {
         if (WriterClosedError.matches(this.closeErr)) return null;
         throw this.closeErr;
       }
-      const [res, err] = await this.stream.receive();
-      if (err != null) this.closeErr = EOF.matches(err) ? new WriterClosedError() : err;
-      else this.closeErr = errors.decode(res?.err);
+      try {
+        const res = await this.stream.receive();
+        this.closeErr = errors.decode(res?.err);
+      } catch (err) {
+        if (!(err instanceof Error)) throw err;
+        this.closeErr = EOF.matches(err) ? new WriterClosedError() : err;
+      }
     }
   }
 
   private async execute(req: WriteRequest): Promise<Response> {
-    const err = this.stream.send(req);
-    if (err != null) await this.closeInternal(err);
+    try {
+      this.stream.send(req);
+    } catch (err) {
+      if (!(err instanceof Error)) throw err;
+      // A send failure is always EOF or StreamClosed, never WriterClosedError, so
+      // closeInternal re-throws here and the receive loop below is reached only when
+      // the send succeeds.
+      await this.closeInternal(err);
+    }
     while (true) {
-      const [res, err] = await this.stream.receive();
-      if (err != null) await this.closeInternal(err);
+      let res: Response;
+      try {
+        res = await this.stream.receive();
+      } catch (err) {
+        if (!(err instanceof Error)) throw err;
+        await this.closeInternal(err);
+        continue;
+      }
       const resErr = errors.decode(res?.err);
       if (resErr != null) await this.closeInternal(resErr);
       if (res?.command == req.command) return res;

package/src/group/client.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array } from "@synnaxlabs/x";
 import z from "zod";
 
@@ -39,8 +39,7 @@ export class Client {
   }
 
   async create(args: CreateArgs): Promise<Group> {
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/ontology/create-group",
       args,
       createReqZ,
@@ -50,8 +49,7 @@ export class Client {
   }
 
   async rename(key: Key, name: string): Promise<void> {
-    await sendRequired(
-      this.client,
+    await this.client.send(
       "/ontology/rename-group",
       { key, name },
       renameReqZ,
@@ -60,8 +58,7 @@ export class Client {
   }
 
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired(
-      this.client,
+    await this.client.send(
       "/ontology/delete-group",
       { keys: array.toArray(keys) },
       deleteReqZ,

package/src/index.ts

@@ -8,6 +8,7 @@
 // included in the file licenses/APL.txt.
 
 export { access } from "@/access";
+export { actions } from "@/actions";
 export { arc } from "@/arc";
 export { channel } from "@/channel";
 export { Channel, isCalculated } from "@/channel/client";
@@ -67,7 +68,7 @@ export {
   TimeRange,
   TimeSpan,
   TimeStamp,
-  type TimeStampStringFormat,
+  type TimestampFormat,
+  type TimeZone,
   type TypedArray,
-  type TZInfo,
 } from "@synnaxlabs/x";

package/src/label/client.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array } from "@synnaxlabs/x";
 import z from "zod";
 
@@ -66,8 +66,7 @@ export class Client {
   async retrieve(args: RetrieveMultipleParams): Promise<Label[]>;
   async retrieve(args: RetrieveArgs): Promise<Label | Label[]> {
     const isSingle = "key" in args;
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/label/retrieve",
       args,
       retrieveArgsZ,
@@ -78,8 +77,7 @@ export class Client {
   }
 
   async label(id: ontology.ID, labels: Key[], opts: SetOptions = {}): Promise<void> {
-    await sendRequired<typeof setReqZ, typeof emptyResZ>(
-      this.client,
+    await this.client.send(
       "/label/set",
       { id, labels, replace: opts.replace },
       setReqZ,
@@ -88,21 +86,14 @@ export class Client {
   }
 
   async remove(id: ontology.ID, labels: Key[]): Promise<void> {
-    await sendRequired<typeof removeReqZ, typeof emptyResZ>(
-      this.client,
-      "/label/remove",
-      { id, labels },
-      removeReqZ,
-      emptyResZ,
-    );
+    await this.client.send("/label/remove", { id, labels }, removeReqZ, emptyResZ);
   }
 
   async create(label: New): Promise<Label>;
   async create(labels: New[]): Promise<Label[]>;
   async create(labels: New | New[]): Promise<Label | Label[]> {
     const isMany = Array.isArray(labels);
-    const res = await sendRequired<typeof createReqZ, typeof createResZ>(
-      this.client,
+    const res = await this.client.send(
       "/label/create",
       { labels: array.toArray(labels) },
       createReqZ,
@@ -112,8 +103,7 @@ export class Client {
   }
 
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired<typeof deleteReqZ, typeof emptyResZ>(
-      this.client,
+    await this.client.send(
       "/label/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,

package/src/label/label.spec.ts

@@ -7,6 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
+import { id } from "@synnaxlabs/x";
 import { describe, expect, it } from "vitest";
 
 import { label } from "@/label";
@@ -34,6 +35,17 @@ describe("Label", () => {
       const retrieved = await client.labels.retrieve({ key: v.key });
       expect(retrieved).toEqual(v);
     });
+    it("should retrieve labels by search term", async () => {
+      const prefix = `searchable-label-${id.create()}`;
+      const names = [`${prefix}-1`, `${prefix}-2`];
+      await client.labels.create(names.map((name) => ({ name, color: "#E774D0" })));
+      await expect
+        .poll(async () => {
+          const results = await client.labels.retrieve({ searchTerm: prefix });
+          return results.map((l) => l.name).sort();
+        })
+        .toEqual(names);
+    });
   });
 
   describe("delete", () => {

package/src/lineplot/client.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array, caseconv, record } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -61,8 +61,7 @@ export class Client {
     linePlots: New | New[],
   ): Promise<LinePlot | LinePlot[]> {
     const isMany = Array.isArray(linePlots);
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/lineplot/create",
       { workspace, linePlots: array.toArray(linePlots) },
       createReqZ,
@@ -72,23 +71,11 @@ export class Client {
   }
 
   async rename(key: Key, name: string): Promise<void> {
-    await sendRequired(
-      this.client,
-      "/lineplot/rename",
-      { key, name },
-      renameReqZ,
-      emptyResZ,
-    );
+    await this.client.send("/lineplot/rename", { key, name }, renameReqZ, emptyResZ);
   }
 
   async setData(key: Key, data: record.Unknown): Promise<void> {
-    await sendRequired(
-      this.client,
-      "/lineplot/set-data",
-      { key, data },
-      setDataReqZ,
-      emptyResZ,
-    );
+    await this.client.send("/lineplot/set-data", { key, data }, setDataReqZ, emptyResZ);
   }
 
   async retrieve(args: RetrieveSingleParams): Promise<LinePlot>;
@@ -97,8 +84,7 @@ export class Client {
     args: RetrieveSingleParams | RetrieveMultipleParams,
   ): Promise<LinePlot | LinePlot[]> {
     const isSingle = singleRetrieveArgsZ.safeParse(args).success;
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/lineplot/retrieve",
       args,
       retrieveArgsZ,
@@ -109,8 +95,7 @@ export class Client {
   }
 
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired(
-      this.client,
+    await this.client.send(
       "/lineplot/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,

package/src/log/client.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array, caseconv, record } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -51,8 +51,7 @@ export class Client {
   async create(workspace: workspace.Key, logs: New[]): Promise<Log[]>;
   async create(workspace: workspace.Key, logs: New | New[]): Promise<Log | Log[]> {
     const isMany = Array.isArray(logs);
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/log/create",
       { workspace, logs: array.toArray(logs) },
       createReqZ,
@@ -62,23 +61,11 @@ export class Client {
   }
 
   async rename(key: Key, name: string): Promise<void> {
-    await sendRequired(
-      this.client,
-      "/log/rename",
-      { key, name },
-      renameReqZ,
-      emptyResZ,
-    );
+    await this.client.send("/log/rename", { key, name }, renameReqZ, emptyResZ);
   }
 
   async setData(key: Key, data: record.Unknown): Promise<void> {
-    await sendRequired(
-      this.client,
-      "/log/set-data",
-      { key, data },
-      setDataReqZ,
-      emptyResZ,
-    );
+    await this.client.send("/log/set-data", { key, data }, setDataReqZ, emptyResZ);
   }
 
   async retrieve(args: RetrieveSingleParams): Promise<Log>;
@@ -87,8 +74,7 @@ export class Client {
     args: RetrieveSingleParams | RetrieveMultipleParams,
   ): Promise<Log | Log[]> {
     const isSingle = singleRetrieveArgsZ.safeParse(args).success;
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/log/retrieve",
       args,
       retrieveArgsZ,
@@ -99,8 +85,7 @@ export class Client {
   }
 
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired(
-      this.client,
+    await this.client.send(
       "/log/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,

package/src/ontology/client.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array, strings } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -163,8 +163,7 @@ export class Client {
   }
 
   private async execRetrieve(request: RetrieveRequest): Promise<Resource[]> {
-    const { resources } = await sendRequired(
-      this.client,
+    const { resources } = await this.client.send(
       "/ontology/retrieve",
       request,
       retrieveReqZ,

package/src/ontology/ontology.spec.ts

@@ -154,6 +154,16 @@ describe("Ontology", () => {
       expect(parents.length).toEqual(1);
       expect(parents[0].name).toEqual(name);
     });
+    test("retrieve by search term", async () => {
+      const name = randomName();
+      const g = await client.groups.create({ parent: ontology.ROOT_ID, name });
+      await expect
+        .poll(async () => {
+          const results = await client.ontology.retrieve({ searchTerm: name });
+          return results.find((r) => r.id.key === g.key);
+        })
+        .toMatchObject({ name, id: { type: "group", key: g.key } });
+    });
   });
 
   describe("write", () => {

package/src/ontology/types.gen.ts

@@ -15,7 +15,6 @@ export const RESOURCE_TYPES = [
   "arc",
   "builtin",
   "channel",
-  "cluster",
   "device",
   "framer",
   "group",

package/src/ontology/writer.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
 import { type ID, idZ } from "@/ontology/payload";
@@ -24,8 +24,7 @@ export class Writer {
   }
 
   async addChildren(id: ID, ...children: ID[]): Promise<void> {
-    await sendRequired<typeof addRemoveChildrenReqZ, typeof emptyResZ>(
-      this.client,
+    await this.client.send(
       "/ontology/add-children",
       { id, children },
       addRemoveChildrenReqZ,
@@ -34,8 +33,7 @@ export class Writer {
   }
 
   async removeChildren(id: ID, ...children: ID[]): Promise<void> {
-    await sendRequired<typeof addRemoveChildrenReqZ, typeof emptyResZ>(
-      this.client,
+    await this.client.send(
       "/ontology/remove-children",
       { id, children },
       addRemoveChildrenReqZ,
@@ -44,8 +42,7 @@ export class Writer {
   }
 
   async moveChildren(from: ID, to: ID, ...children: ID[]): Promise<void> {
-    await sendRequired<typeof moveChildrenReqZ, typeof emptyResZ>(
-      this.client,
+    await this.client.send(
       "/ontology/move-children",
       { from, to, children },
       moveChildrenReqZ,

package/src/rack/client.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -82,8 +82,7 @@ export class Client {
   }
 
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
-      this.client,
+    await this.client.send(
       "/rack/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,
@@ -95,8 +94,7 @@ export class Client {
   async create(racks: New[]): Promise<Rack[]>;
   async create(rack: New | New[]): Promise<Rack | Rack[]> {
     const isSingle = !Array.isArray(rack);
-    const res = await sendRequired<typeof createReqZ, typeof createResZ>(
-      this.client,
+    const res = await this.client.send(
       "/rack/create",
       { racks: array.toArray(rack) },
       createReqZ,
@@ -110,8 +108,7 @@ export class Client {
   async retrieve(args: RetrieveMultipleParams): Promise<Rack[]>;
   async retrieve(args: RetrieveArgs): Promise<Rack | Rack[]> {
     const isSingle = "key" in args || "name" in args;
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/rack/retrieve",
       args,
       retrieveArgsZ,

package/src/rack/rack.spec.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { TimeStamp, zod } from "@synnaxlabs/x";
+import { id, TimeStamp, zod } from "@synnaxlabs/x";
 import { describe, expect, it } from "vitest";
 
 import { type rack } from "@/rack";
@@ -77,6 +77,17 @@ describe("Rack", () => {
       expect(retrieved.key).toBe(r.key);
       expect(retrieved.name).toEqual(name);
     });
+    it("should retrieve racks by search term", async () => {
+      const prefix = `searchable-rack-${id.create()}`;
+      const names = [`${prefix}-1`, `${prefix}-2`];
+      await client.racks.create(names.map((name) => ({ name })));
+      await expect
+        .poll(async () => {
+          const results = await client.racks.retrieve({ searchTerm: prefix });
+          return results.map((r) => r.name).sort();
+        })
+        .toEqual(names);
+    });
   });
   describe("integrations", () => {
     it("should create a rack with integrations and retrieve them", async () => {

package/src/ranger/alias/client.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -64,8 +64,7 @@ export class Client {
         else toFetch.push(alias);
       });
     if (toFetch.length === 0) return cached;
-    const res = await sendRequired<typeof resolveReqZ, typeof resolveResZ>(
-      this.client,
+    const res = await this.client.send(
       "/range/alias/resolve",
       { range: this.rangeKey, aliases: toFetch },
       resolveReqZ,
@@ -76,8 +75,7 @@ export class Client {
   }
 
   async set(aliases: Record<channel.Key, string>): Promise<void> {
-    await sendRequired<typeof setReqZ, typeof setResZ>(
-      this.client,
+    await this.client.send(
       "/range/alias/set",
       { range: this.rangeKey, aliases },
       setReqZ,
@@ -87,8 +85,7 @@ export class Client {
 
   async list(): Promise<Record<channel.Key, string>> {
     return (
-      await sendRequired<typeof listReqZ, typeof listResZ>(
-        this.client,
+      await this.client.send(
         "/range/alias/list",
         { range: this.rangeKey },
         listReqZ,
@@ -104,8 +101,7 @@ export class Client {
     alias: channel.Key | channel.Key[],
   ): Promise<string | Record<channel.Key, string>> {
     const isSingle = typeof alias === "number";
-    const res = await sendRequired<typeof retrieveReqZ, typeof retrieveResZ>(
-      this.client,
+    const res = await this.client.send(
       "/range/alias/retrieve",
       { range: this.rangeKey, channels: array.toArray(alias) },
       retrieveReqZ,
@@ -115,8 +111,7 @@ export class Client {
   }
 
   async delete(aliases: channel.Key | channel.Key[]): Promise<void> {
-    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
-      this.client,
+    await this.client.send(
       "/range/alias/delete",
       { range: this.rangeKey, channels: array.toArray(aliases) },
       deleteReqZ,

package/src/ranger/client.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import {
   array,
   color,
@@ -249,8 +249,7 @@ export class Client {
   async retrieve(params: RetrieveRequest): Promise<Range[]>;
   async retrieve(params: RetrieveArgs): Promise<Range | Range[]> {
     const isSingle = typeof params === "string";
-    const { ranges } = await sendRequired(
-      this.unaryClient,
+    const { ranges } = await this.unaryClient.send(
       "/range/retrieve",
       params,
       retrieveArgsZ,