@superblocksteam/sdk-api 2.0.157-next.5 → 2.0.157

package/dist/integrations/base/decode-worker-binary-response.test.js

@@ -1,81 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { RestApiValidationError } from "../../errors.js";
-import { decodeWorkerBinaryResponse } from "./decode-worker-binary-response.js";
-describe("decodeWorkerBinaryResponse", () => {
-    it("copies a Uint8Array into a plain Uint8Array with the same bytes", () => {
-        const source = new Uint8Array([1, 2, 255]);
-        const result = decodeWorkerBinaryResponse(source);
-        expect(result).toBeInstanceOf(Uint8Array);
-        expect(result.constructor).toBe(Uint8Array);
-        expect(Array.from(result)).toEqual([1, 2, 255]);
-        source[0] = 9;
-        expect(result[0]).toBe(1);
-    });
-    it("converts worker Buffer JSON into a plain Uint8Array", () => {
-        const result = decodeWorkerBinaryResponse({
-            type: "Buffer",
-            data: [37, 80, 68, 70],
-        });
-        expect(result.constructor).toBe(Uint8Array);
-        expect(Array.from(result)).toEqual([37, 80, 68, 70]);
-    });
-    it("converts empty Buffer JSON into a zero-length Uint8Array", () => {
-        const result = decodeWorkerBinaryResponse({ type: "Buffer", data: [] });
-        expect(result).toBeInstanceOf(Uint8Array);
-        expect(result.byteLength).toBe(0);
-    });
-    it("rejects a missing discriminant", () => {
-        expect(() => decodeWorkerBinaryResponse({ data: [1] })).toThrow(RestApiValidationError);
-    });
-    it("rejects a non-Buffer discriminant", () => {
-        expect(() => decodeWorkerBinaryResponse({ type: "Array", data: [1] })).toThrow(RestApiValidationError);
-    });
-    it("rejects a non-array data field", () => {
-        expect(() => decodeWorkerBinaryResponse({ type: "Buffer", data: "00ff" })).toThrow(RestApiValidationError);
-    });
-    it("rejects a byte outside 0 through 255", () => {
-        expect(() => decodeWorkerBinaryResponse({ type: "Buffer", data: [256] })).toThrow(RestApiValidationError);
-    });
-    it("rejects a negative byte", () => {
-        expect(() => decodeWorkerBinaryResponse({ type: "Buffer", data: [-1] })).toThrow(RestApiValidationError);
-    });
-    it("reports the index of a non-integer byte", () => {
-        try {
-            decodeWorkerBinaryResponse({ type: "Buffer", data: [1, 1.5] });
-        }
-        catch (error) {
-            expect(error).toBeInstanceOf(RestApiValidationError);
-            if (!(error instanceof RestApiValidationError)) {
-                throw error;
-            }
-            expect(error.details.zodError.issues).toEqual([
-                expect.objectContaining({ path: ["data", 1] }),
-            ]);
-            return;
-        }
-        throw new Error("Expected binary response validation to fail");
-    });
-    it("redacts malformed binary data from validation errors", () => {
-        const data = Array.from({ length: 4096 }, () => 0);
-        data[4095] = 256;
-        try {
-            decodeWorkerBinaryResponse({ type: "Buffer", data });
-        }
-        catch (error) {
-            expect(error).toBeInstanceOf(RestApiValidationError);
-            if (!(error instanceof RestApiValidationError)) {
-                throw error;
-            }
-            expect(error.details.data).toEqual({
-                dataType: "binary",
-                redacted: true,
-            });
-            return;
-        }
-        throw new Error("Expected malformed binary response to fail");
-    });
-    it("rejects a string payload", () => {
-        expect(() => decodeWorkerBinaryResponse("not-binary")).toThrow(RestApiValidationError);
-    });
-});
-//# sourceMappingURL=decode-worker-binary-response.test.js.map

package/dist/integrations/base/decode-worker-binary-response.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"decode-worker-binary-response.test.js","sourceRoot":"","sources":["../../../src/integrations/base/decode-worker-binary-response.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAEhF,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAE3C,MAAM,MAAM,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC;QAElD,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,MAAM,GAAG,0BAA0B,CAAC;YACxC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;SACvB,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,MAAM,GAAG,0BAA0B,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAExE,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,CAAC,GAAG,EAAE,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAC7D,sBAAsB,CACvB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,CAAC,GAAG,EAAE,CACV,0BAA0B,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACzD,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,CAAC,GAAG,EAAE,CACV,0BAA0B,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAC7D,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,GAAG,EAAE,CACV,0BAA0B,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAC5D,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,CAAC,GAAG,EAAE,CACV,0BAA0B,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAC3D,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,IAAI,CAAC;YACH,0BAA0B,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;QACjE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;YACrD,IAAI,CAAC,CAAC,KAAK,YAAY,sBAAsB,CAAC,EAAE,CAAC;gBAC/C,MAAM,KAAK,CAAC;YACd,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBAC5C,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC;aAC/C,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QAEjB,IAAI,CAAC;YACH,0BAA0B,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;YACrD,IAAI,CAAC,CAAC,KAAK,YAAY,sBAAsB,CAAC,EAAE,CAAC;gBAC/C,MAAM,KAAK,CAAC;YACd,CAAC;YACD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBACjC,QAAQ,EAAE,QAAQ;gBAClB,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,CAAC,GAAG,EAAE,CAAC,0BAA0B,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAC5D,sBAAsB,CACvB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/src/integrations/base/decode-worker-binary-response.test.ts

@@ -1,107 +0,0 @@
-import { describe, expect, it } from "vitest";
-
-import { RestApiValidationError } from "../../errors.js";
-import { decodeWorkerBinaryResponse } from "./decode-worker-binary-response.js";
-
-describe("decodeWorkerBinaryResponse", () => {
-  it("copies a Uint8Array into a plain Uint8Array with the same bytes", () => {
-    const source = new Uint8Array([1, 2, 255]);
-
-    const result = decodeWorkerBinaryResponse(source);
-
-    expect(result).toBeInstanceOf(Uint8Array);
-    expect(result.constructor).toBe(Uint8Array);
-    expect(Array.from(result)).toEqual([1, 2, 255]);
-    source[0] = 9;
-    expect(result[0]).toBe(1);
-  });
-
-  it("converts worker Buffer JSON into a plain Uint8Array", () => {
-    const result = decodeWorkerBinaryResponse({
-      type: "Buffer",
-      data: [37, 80, 68, 70],
-    });
-
-    expect(result.constructor).toBe(Uint8Array);
-    expect(Array.from(result)).toEqual([37, 80, 68, 70]);
-  });
-
-  it("converts empty Buffer JSON into a zero-length Uint8Array", () => {
-    const result = decodeWorkerBinaryResponse({ type: "Buffer", data: [] });
-
-    expect(result).toBeInstanceOf(Uint8Array);
-    expect(result.byteLength).toBe(0);
-  });
-
-  it("rejects a missing discriminant", () => {
-    expect(() => decodeWorkerBinaryResponse({ data: [1] })).toThrow(
-      RestApiValidationError,
-    );
-  });
-
-  it("rejects a non-Buffer discriminant", () => {
-    expect(() =>
-      decodeWorkerBinaryResponse({ type: "Array", data: [1] }),
-    ).toThrow(RestApiValidationError);
-  });
-
-  it("rejects a non-array data field", () => {
-    expect(() =>
-      decodeWorkerBinaryResponse({ type: "Buffer", data: "00ff" }),
-    ).toThrow(RestApiValidationError);
-  });
-
-  it("rejects a byte outside 0 through 255", () => {
-    expect(() =>
-      decodeWorkerBinaryResponse({ type: "Buffer", data: [256] }),
-    ).toThrow(RestApiValidationError);
-  });
-
-  it("rejects a negative byte", () => {
-    expect(() =>
-      decodeWorkerBinaryResponse({ type: "Buffer", data: [-1] }),
-    ).toThrow(RestApiValidationError);
-  });
-
-  it("reports the index of a non-integer byte", () => {
-    try {
-      decodeWorkerBinaryResponse({ type: "Buffer", data: [1, 1.5] });
-    } catch (error) {
-      expect(error).toBeInstanceOf(RestApiValidationError);
-      if (!(error instanceof RestApiValidationError)) {
-        throw error;
-      }
-      expect(error.details.zodError.issues).toEqual([
-        expect.objectContaining({ path: ["data", 1] }),
-      ]);
-      return;
-    }
-    throw new Error("Expected binary response validation to fail");
-  });
-
-  it("redacts malformed binary data from validation errors", () => {
-    const data = Array.from({ length: 4096 }, () => 0);
-    data[4095] = 256;
-
-    try {
-      decodeWorkerBinaryResponse({ type: "Buffer", data });
-    } catch (error) {
-      expect(error).toBeInstanceOf(RestApiValidationError);
-      if (!(error instanceof RestApiValidationError)) {
-        throw error;
-      }
-      expect(error.details.data).toEqual({
-        dataType: "binary",
-        redacted: true,
-      });
-      return;
-    }
-    throw new Error("Expected malformed binary response to fail");
-  });
-
-  it("rejects a string payload", () => {
-    expect(() => decodeWorkerBinaryResponse("not-binary")).toThrow(
-      RestApiValidationError,
-    );
-  });
-});

package/src/integrations/base/decode-worker-binary-response.ts

@@ -1,62 +0,0 @@
-import { z } from "zod";
-
-import {
-  REDACTED_BINARY_RESPONSE_DATA,
-  RestApiValidationError,
-} from "../../errors.js";
-
-export { REDACTED_BINARY_RESPONSE_DATA };
-
-const workerBinaryResponseSchema = z.union([
-  z.instanceof(Uint8Array).transform((value) => new Uint8Array(value)),
-  z
-    .object({
-      data: z.unknown(),
-      type: z.literal("Buffer"),
-    })
-    .transform((value, context) => {
-      if (!Array.isArray(value.data)) {
-        context.addIssue({
-          code: z.ZodIssueCode.custom,
-          message: "data must be an array of bytes",
-          path: ["data"],
-        });
-        return z.NEVER;
-      }
-
-      const bytes = new Uint8Array(value.data.length);
-      for (let index = 0; index < value.data.length; index += 1) {
-        const item = value.data[index];
-        if (
-          typeof item !== "number" ||
-          !Number.isInteger(item) ||
-          item < 0 ||
-          item > 255
-        ) {
-          context.addIssue({
-            code: z.ZodIssueCode.custom,
-            message: "byte must be an integer from 0 through 255",
-            path: ["data", index],
-          });
-          return z.NEVER;
-        }
-        bytes[index] = item;
-      }
-
-      return bytes;
-    }),
-]);
-
-export function decodeWorkerBinaryResponse(value: unknown): Uint8Array {
-  const result = workerBinaryResponseSchema.safeParse(value);
-  if (!result.success) {
-    throw new RestApiValidationError(
-      `Binary response is malformed: ${result.error.message}`,
-      {
-        data: REDACTED_BINARY_RESPONSE_DATA,
-        zodError: result.error,
-      },
-    );
-  }
-  return result.data;
-}

package/src/integrations/restapiintegration/overlays/response-types-binary.md

@@ -1,51 +0,0 @@
-## Non-JSON Responses
-
-`apiRequest()` decodes responses as JSON by default. For endpoints that return non-JSON payloads, pass `responseType`:
-
-- `"binary"` for PDFs and other byte payloads. The result is a `Uint8Array`
-- `"text"` for XML, CSV, HTML, and other decoded strings
-
-With `responseType: "text"` or `responseType: "binary"` the response schema may be omitted. Text returns the raw string typed `unknown`. Binary returns a `Uint8Array`:
-
-```typescript
-const xml = await ctx.integrations.legacyApi.apiRequest({
-  method: "GET",
-  path: "/report.xml",
-  responseType: "text",
-});
-// xml is the raw XML string (typed unknown)
-
-const pdf = await ctx.integrations.legacyApi.apiRequest({
-  method: "GET",
-  path: "/file.pdf",
-  responseType: "binary",
-});
-// pdf is a Uint8Array
-```
-
-To validate after decoding, pass a schema that matches the decoded value:
-
-```typescript
-const xml = await ctx.integrations.legacyApi.apiRequest(
-  { method: "GET", path: "/report.xml", responseType: "text" },
-  { response: z.string() },
-);
-// xml is typed string
-
-const pdf = await ctx.integrations.legacyApi.apiRequest(
-  { method: "GET", path: "/file.pdf", responseType: "binary" },
-  { response: z.instanceof(Uint8Array) },
-);
-// pdf is typed Uint8Array
-```
-
-Convert binary data to a JSON-safe representation before returning it from an SDK API:
-
-```typescript
-return {
-  contentBase64: Buffer.from(pdf).toString("base64"),
-  filename: "file.pdf",
-};
-```
-
-JSON responses (the default) always require a response schema. Omitting the schema is only allowed together with an explicit `responseType: "text"` or `responseType: "binary"`, so unvalidated JSON is not representable.