@chrt-inc/typescript-sdk 1.562.0 → 1.563.0

package/dist/esm/api/resources/utils/resources/dev/types/OrderBuilderStreamEvent.d.mts

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Unified SSE data schema for Fern SDK generation. The SSE `event:` frame
+ * carries the discriminator (progress | complete | error); only relevant
+ * fields are serialized per event type via exclude_none.
+ */
+export interface OrderBuilderStreamEvent {
+    event: OrderBuilderStreamEvent.Event;
+    message?: string | null;
+    order_id?: string | null;
+    order_short_id?: string | null;
+    summary?: string | null;
+    validation_passed?: boolean | null;
+    validation_issues?: string[] | null;
+    notes?: string[] | null;
+    error?: string | null;
+}
+export declare namespace OrderBuilderStreamEvent {
+    type Event = "progress" | "complete" | "error";
+    const Event: {
+        readonly Progress: "progress";
+        readonly Complete: "complete";
+        readonly Error: "error";
+    };
+}

package/dist/esm/api/resources/utils/resources/dev/types/OrderBuilderStreamEvent.mjs

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export var OrderBuilderStreamEvent;
+(function (OrderBuilderStreamEvent) {
+    OrderBuilderStreamEvent.Event = {
+        Progress: "progress",
+        Complete: "complete",
+        Error: "error",
+    };
+})(OrderBuilderStreamEvent || (OrderBuilderStreamEvent = {}));

package/dist/esm/api/resources/utils/resources/dev/types/index.d.mts

@@ -0,0 +1 @@
+export * from "./OrderBuilderStreamEvent.mjs";

package/dist/esm/api/resources/utils/resources/dev/types/index.mjs

@@ -0,0 +1 @@
+export * from "./OrderBuilderStreamEvent.mjs";

package/dist/esm/api/resources/utils/resources/index.d.mts

@@ -1,3 +1,4 @@
 export * as dev from "./dev/index.mjs";
+export * from "./dev/types/index.mjs";
 export * as root from "./root/index.mjs";
 export * from "./dev/client/requests/index.mjs";

package/dist/esm/api/resources/utils/resources/index.mjs

@@ -1,3 +1,4 @@
 export * as dev from "./dev/index.mjs";
+export * from "./dev/types/index.mjs";
 export * as root from "./root/index.mjs";
 export * from "./dev/client/requests/index.mjs";

package/dist/esm/api/types/TaskClientUpdate1.d.mts

@@ -6,6 +6,8 @@ export interface TaskClientUpdate1 {
     location?: Chrt.LocationFeature | null;
     action?: TaskClientUpdate1.Action | null;
     time_windows?: Chrt.TimeWindow1[];
+    order_placer_comments?: string | null;
+    order_placer_comments__set_to_None?: boolean;
     directory_entry_ids?: string[];
 }
 export declare namespace TaskClientUpdate1 {

package/dist/esm/core/index.d.mts

@@ -4,4 +4,5 @@ export * as url from "./url/index.mjs";
 export * from "./auth/index.mjs";
 export * from "./base64.mjs";
 export * from "./form-data-utils/index.mjs";
+export * from "./stream/index.mjs";
 export * as file from "./file/index.mjs";

package/dist/esm/core/index.mjs

@@ -4,4 +4,5 @@ export * as url from "./url/index.mjs";
 export * from "./auth/index.mjs";
 export * from "./base64.mjs";
 export * from "./form-data-utils/index.mjs";
+export * from "./stream/index.mjs";
 export * as file from "./file/index.mjs";

package/dist/esm/core/stream/Stream.d.mts

@@ -0,0 +1,46 @@
+export declare namespace Stream {
+    interface Args {
+        /**
+         * The HTTP response stream to read from.
+         */
+        stream: ReadableStream;
+        /**
+         * The event shape to use for parsing the stream data.
+         */
+        eventShape: JsonEvent | SseEvent;
+        /**
+         * An abort signal to stop the stream.
+         */
+        signal?: AbortSignal;
+    }
+    interface JsonEvent {
+        type: "json";
+        messageTerminator: string;
+    }
+    interface SseEvent {
+        type: "sse";
+        streamTerminator?: string;
+    }
+}
+export declare class Stream<T> implements AsyncIterable<T> {
+    private stream;
+    private parse;
+    /**
+     * The prefix to use for each message. For example,
+     * for SSE, the prefix is "data: ".
+     */
+    private prefix;
+    private messageTerminator;
+    private streamTerminator;
+    private controller;
+    constructor({ stream, parse, eventShape, signal }: Stream.Args & {
+        parse: (val: unknown) => Promise<T>;
+    });
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+    private decodeChunk;
+}
+/**
+ * Browser polyfill for ReadableStream
+ */
+export declare function readableStreamAsyncIterable<T>(stream: any): AsyncIterableIterator<T>;

package/dist/esm/core/stream/Stream.mjs

@@ -0,0 +1,164 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+import { RUNTIME } from "../runtime/index.mjs";
+const DATA_PREFIX = "data:";
+export class Stream {
+    constructor({ stream, parse, eventShape, signal }) {
+        this.controller = new AbortController();
+        this.stream = stream;
+        this.parse = parse;
+        if (eventShape.type === "sse") {
+            this.prefix = DATA_PREFIX;
+            this.messageTerminator = "\n";
+            this.streamTerminator = eventShape.streamTerminator;
+        }
+        else {
+            this.messageTerminator = eventShape.messageTerminator;
+        }
+        signal === null || signal === void 0 ? void 0 : signal.addEventListener("abort", () => this.controller.abort());
+    }
+    iterMessages() {
+        return __asyncGenerator(this, arguments, function* iterMessages_1() {
+            var _a, e_1, _b, _c;
+            this.controller.signal;
+            const stream = readableStreamAsyncIterable(this.stream);
+            let buf = "";
+            let prefixSeen = false;
+            try {
+                for (var _d = true, stream_1 = __asyncValues(stream), stream_1_1; stream_1_1 = yield __await(stream_1.next()), _a = stream_1_1.done, !_a; _d = true) {
+                    _c = stream_1_1.value;
+                    _d = false;
+                    const chunk = _c;
+                    buf += this.decodeChunk(chunk);
+                    let terminatorIndex;
+                    while ((terminatorIndex = buf.indexOf(this.messageTerminator)) >= 0) {
+                        let line = buf.slice(0, terminatorIndex + 1);
+                        buf = buf.slice(terminatorIndex + this.messageTerminator.length);
+                        if (!line.trim()) {
+                            continue;
+                        }
+                        if (!prefixSeen && this.prefix != null) {
+                            const prefixIndex = line.indexOf(this.prefix);
+                            if (prefixIndex === -1) {
+                                continue;
+                            }
+                            prefixSeen = true;
+                            line = line.slice(prefixIndex + this.prefix.length);
+                        }
+                        if (this.streamTerminator != null && line.includes(this.streamTerminator)) {
+                            return yield __await(void 0);
+                        }
+                        const message = yield __await(this.parse(JSON.parse(line)));
+                        yield yield __await(message);
+                        prefixSeen = false;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_d && !_a && (_b = stream_1.return)) yield __await(_b.call(stream_1));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        });
+    }
+    [Symbol.asyncIterator]() {
+        return __asyncGenerator(this, arguments, function* _a() {
+            var _b, e_2, _c, _d;
+            try {
+                for (var _e = true, _f = __asyncValues(this.iterMessages()), _g; _g = yield __await(_f.next()), _b = _g.done, !_b; _e = true) {
+                    _d = _g.value;
+                    _e = false;
+                    const message = _d;
+                    yield yield __await(message);
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (!_e && !_b && (_c = _f.return)) yield __await(_c.call(_f));
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+        });
+    }
+    decodeChunk(chunk) {
+        let decoded = "";
+        // If TextDecoder is present, use it
+        if (typeof TextDecoder !== "undefined") {
+            const decoder = new TextDecoder("utf8");
+            decoded += decoder.decode(chunk);
+        }
+        // Buffer is present in Node.js environment
+        else if (RUNTIME.type === "node" && typeof chunk !== "undefined") {
+            decoded += Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
+        }
+        return decoded;
+    }
+}
+/**
+ * Browser polyfill for ReadableStream
+ */
+// biome-ignore lint/suspicious/noExplicitAny: allow explicit any
+export function readableStreamAsyncIterable(stream) {
+    if (stream[Symbol.asyncIterator]) {
+        return stream;
+    }
+    const reader = stream.getReader();
+    return {
+        next() {
+            return __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const result = yield reader.read();
+                    if (result === null || result === void 0 ? void 0 : result.done) {
+                        reader.releaseLock();
+                    } // release lock when stream becomes closed
+                    return result;
+                }
+                catch (e) {
+                    reader.releaseLock(); // release lock when stream becomes errored
+                    throw e;
+                }
+            });
+        },
+        return() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const cancelPromise = reader.cancel();
+                reader.releaseLock();
+                yield cancelPromise;
+                return { done: true, value: undefined };
+            });
+        },
+        [Symbol.asyncIterator]() {
+            return this;
+        },
+    };
+}

package/dist/esm/core/stream/index.d.mts

@@ -0,0 +1 @@
+export { Stream } from "./Stream.mjs";

package/dist/esm/core/stream/index.mjs

@@ -0,0 +1 @@
+export { Stream } from "./Stream.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.562.0";
+export declare const SDK_VERSION = "1.563.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.562.0";
+export const SDK_VERSION = "1.563.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chrt-inc/typescript-sdk",
-    "version": "1.562.0",
+    "version": "1.563.0",
     "private": false,
     "repository": "github:chrt-inc/typescript-sdk",
     "type": "commonjs",

package/reference.md

@@ -7610,7 +7610,7 @@ await client.orgs.orgInfoForConnections.forwarder.updateV1();
 
 ## Shipping Docs
 
-<details><summary><code>client.shipping.docs.<a href="/src/api/resources/shipping/resources/docs/client/Client.ts">postGenerateV1</a>({ ...params }) -> unknown</code></summary>
+<details><summary><code>client.shipping.docs.<a href="/src/api/resources/shipping/resources/docs/client/Client.ts">postGenerateV1</a>({ ...params }) -> core.BinaryResponse</code></summary>
 <dl>
 <dd>
 
@@ -9784,7 +9784,7 @@ await client.shipping.tasks.addToTaskGroupV1("task_group_id", {
 <dl>
 <dd>
 
-Updates a task. Task must be in STAGED status. | authz_personas=[lig_owner_operators] | (TaskClientUpdate1) -> (PydanticObjectId)
+Updates a task. Operational fields require STAGED status (lig_owner_operators). order_placer_comments can be edited on any non-DRAFT task (order_creator_org_operators). | (TaskClientUpdate1) -> (PydanticObjectId)
 
 </dd>
 </dl>
@@ -11518,6 +11518,7 @@ await client.shipping.orders.expanded.listForForwarderOperatorsV1({
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled: true,
     body: {},
 });
 ```
@@ -11600,6 +11601,7 @@ await client.shipping.orders.expanded.listForShipperOperatorsV1({
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_order_cancelled_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_order_cancelled_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled: true,
     body: {},
 });
 ```
@@ -12690,6 +12692,7 @@ await client.shipping.taskGroups.expanded.listForCourierOperatorsV1({
     filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled: true,
     body: {},
 });
 ```
@@ -12772,6 +12775,7 @@ await client.shipping.taskGroups.expanded.listForCourierDriverV1({
     filter_skipped_at_timestamp_gte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_lte: "2024-01-15T09:30:00Z",
     filter_exception_at_timestamp_gte: "2024-01-15T09:30:00Z",
+    filter_order_cancelled: true,
     body: {},
 });
 ```
@@ -16540,7 +16544,7 @@ await client.utils.dev.postAgentOrderBuilderV1({
 </dl>
 </details>
 
-<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderBuilderStreamV1</a>({ ...params }) -> void</code></summary>
+<details><summary><code>client.utils.dev.<a href="/src/api/resources/utils/resources/dev/client/Client.ts">postAgentOrderBuilderStreamV1</a>({ ...params }) -> core.Stream&lt;Chrt.OrderBuilderStreamEvent&gt;</code></summary>
 <dl>
 <dd>
 
@@ -16552,7 +16556,7 @@ await client.utils.dev.postAgentOrderBuilderV1({
 <dl>
 <dd>
 
-Same as /agent/order-builder/v1 but streams progress events via SSE as each workflow step completes. | (OrderBuilderReq) -> SSE stream of OrderBuilderProgressEvent, final OrderBuilderRes
+Same as /agent/order-builder/v1 but streams progress events via SSE as each workflow step completes. | (OrderBuilderReq) -> SSE stream of OrderBuilderStreamEvent
 
 </dd>
 </dl>
@@ -16568,10 +16572,13 @@ Same as /agent/order-builder/v1 but streams progress events via SSE as each work
 <dd>
 
 ```typescript
-await client.utils.dev.postAgentOrderBuilderStreamV1({
+const response = await client.utils.dev.postAgentOrderBuilderStreamV1({
     order_short_id: "order_short_id",
     text: "text",
 });
+for await (const item of response) {
+    console.log(item);
+}
 ```
 
 </dd>