@distilled.cloud/archil 1.0.0-rc.11 → 1.0.0-rc.13

package/README.md

@@ -0,0 +1,34 @@
+# @distilled.cloud/archil
+
+Effect-native SDK for [archil](https://www.npmjs.com/package/@distilled.cloud/archil).
+
+## Installation
+
+```bash
+npm install @distilled.cloud/archil effect
+```
+
+## Quick start
+
+```ts
+import { Effect, Layer } from "effect";
+import * as FetchHttpClient from "effect/http/FetchHttpClient";
+import * as Archil from "@distilled.cloud/archil";
+
+const program = Effect.gen(function* () {
+  const result = yield* Archil.listDisks({});
+  return result;
+});
+
+const Live = Layer.mergeAll(
+  FetchHttpClient.layer,
+  Archil.CredentialsFromEnv,
+  Archil.ArchilProtocol,
+);
+
+program.pipe(Effect.provide(Live), Effect.runPromise);
+```
+
+## Auth
+
+Required: `ARCHIL_API_KEY`. Optional: `ARCHIL_API_BASE_URL`. Sent as `Authorization: Bearer`.

package/lib/protocol.d.ts

@@ -1,17 +1,17 @@
 import type * as Layer from "effect/Layer";
-import type * as HttpClient from "effect/unstable/http/HttpClient";
-import type * as HttpClientError from "effect/unstable/http/HttpClientError";
+import type * as HttpClient from "effect/http/HttpClient";
+import type * as HttpClientError from "effect/http/HttpClientError";
 import type * as API from "@distilled.cloud/core/api";
 import type { API_ERRORS, ConfigError } from "@distilled.cloud/core/errors";
 import { Credentials } from "./credentials.ts";
-import { UnknownArchilError } from "./errors.ts";
+import { UnknownArchilError, ArchilParseError } from "./errors.ts";
 /**
  * Error channel shared by every generated Archil operation. Generated service
  * files annotate operations with `API.OperationMethod<I, O, ArchilOpError,
  * ArchilOpContext>` explicitly so the compiler never infers these back out of
  * the schema generics.
  */
-export type ArchilOpError = InstanceType<(typeof API_ERRORS)[number]> | UnknownArchilError | ConfigError | HttpClientError.HttpClientError;
+export type ArchilOpError = InstanceType<(typeof API_ERRORS)[number]> | UnknownArchilError | ConfigError | HttpClientError.HttpClientError | ArchilParseError;
 /** Context (requirements) shared by every generated Archil operation. */
 export type ArchilOpContext = Credentials | HttpClient.HttpClient;
 export declare const ArchilProtocol: Layer.Layer<API.Protocol>;

package/lib/protocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,KAAK,KAAK,UAAU,MAAM,iCAAiC,CAAC;AACnE,OAAO,KAAK,KAAK,eAAe,MAAM,sCAAsC,CAAC;AAC7E,OAAO,KAAK,KAAK,GAAG,MAAM,2BAA2B,CAAC;AAEtD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GACzC,kBAAkB,GAClB,WAAW,GACX,eAAe,CAAC,eAAe,CAAC;AAEpC,yEAAyE;AACzE,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC;AAElE,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAiCjD,CAAC"}
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAE3C,OAAO,KAAK,KAAK,UAAU,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,KAAK,eAAe,MAAM,6BAA6B,CAAC;AACpE,OAAO,KAAK,KAAK,GAAG,MAAM,2BAA2B,CAAC;AAEtD,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,YAAY,CAAC,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GACzC,kBAAkB,GAClB,WAAW,GACX,eAAe,CAAC,eAAe,GAC/B,gBAAgB,CAAC;AAErB,yEAAyE;AACzE,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC;AAElE,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAkCjD,CAAC"}

package/lib/protocol.js

@@ -17,7 +17,7 @@ import * as Effect from "effect/Effect";
 import * as Redacted from "effect/Redacted";
 import { makeRestProtocol } from "@distilled.cloud/core/protocol-rest";
 import { Credentials } from "./credentials.js";
-import { UnknownArchilError } from "./errors.js";
+import { UnknownArchilError, ArchilParseError } from "./errors.js";
 export const ArchilProtocol = makeRestProtocol({
     // The Credentials service holds an effect — resolving it here (per
     // request, on the calling fiber) picks up context-provided credentials.
@@ -47,5 +47,6 @@ export const ArchilProtocol = makeRestProtocol({
                 : undefined),
         body,
     }),
+    parseError: ({ body, cause }) => new ArchilParseError({ body, cause }),
 });
 //# sourceMappingURL=protocol.js.map

package/lib/protocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAI5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAiBjD,MAAM,CAAC,MAAM,cAAc,GACzB,gBAAgB,CAAS;IACvB,mEAAmE;IACnE,wEAAwE;IACxE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC;QACnC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC;IACxB,CAAC,CAAC;IACF,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU;IACpC,yEAAyE;IACzE,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACnB,aAAa,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;KAC5C,CAAC;IACF,mEAAmE;IACnE,mEAAmE;IACnE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CACxC,IAAI,kBAAkB,CAAC;QACrB,IAAI,EACF,OAAO,IAAI,KAAK,QAAQ;YACtB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,KAAK,SAAS;gBAClB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;gBACd,CAAC,CAAC,SAAS;QACjB,OAAO,EACL,OAAO;YACP,CAAC,IAAI,KAAK,IAAI;gBACd,OAAO,IAAI,KAAK,QAAQ;gBACxB,OAAO,IAAI,IAAI;gBACf,OAAQ,IAA2B,CAAC,KAAK,KAAK,QAAQ;gBACpD,CAAC,CAAE,IAA0B,CAAC,KAAK;gBACnC,CAAC,CAAC,SAAS,CAAC;QAChB,IAAI;KACL,CAAC;CACL,CAAC,CAAC"}
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAI5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEvE,OAAO,EAAE,WAAW,EAAe,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAkBnE,MAAM,CAAC,MAAM,cAAc,GACzB,gBAAgB,CAAS;IACvB,mEAAmE;IACnE,wEAAwE;IACxE,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC;QACnC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC;IACxB,CAAC,CAAC;IACF,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU;IACpC,yEAAyE;IACzE,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACnB,aAAa,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;KAC5C,CAAC;IACF,mEAAmE;IACnE,mEAAmE;IACnE,YAAY,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CACxC,IAAI,kBAAkB,CAAC;QACrB,IAAI,EACF,OAAO,IAAI,KAAK,QAAQ;YACtB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,IAAI,KAAK,SAAS;gBAClB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;gBACd,CAAC,CAAC,SAAS;QACjB,OAAO,EACL,OAAO;YACP,CAAC,IAAI,KAAK,IAAI;gBACd,OAAO,IAAI,KAAK,QAAQ;gBACxB,OAAO,IAAI,IAAI;gBACf,OAAQ,IAA2B,CAAC,KAAK,KAAK,QAAQ;gBACpD,CAAC,CAAE,IAA0B,CAAC,KAAK;gBACnC,CAAC,CAAC,SAAS,CAAC;QAChB,IAAI;KACL,CAAC;IACJ,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,IAAI,gBAAgB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;CACvE,CAAC,CAAC"}

package/lib/response-validation.test.d.ts

@@ -0,0 +1,4 @@
+import { ArchilParseError } from "./errors.ts";
+import type { ArchilOpError } from "./protocol.ts";
+export declare const parseErrorIsDeclared: [ArchilParseError] extends [ArchilOpError] ? true : false;
+//# sourceMappingURL=response-validation.test.d.ts.map

package/lib/response-validation.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-validation.test.d.ts","sourceRoot":"","sources":["../src/response-validation.test.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAsCnD,eAAO,MAAM,oBAAoB,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,aAAa,CAAC,GACzE,IAAI,GACJ,KAAY,CAAC"}

package/lib/response-validation.test.js

@@ -0,0 +1,34 @@
+import { describe, expect, test } from "bun:test";
+import { runValidationModes } from "@distilled.cloud/core/testing";
+import * as Effect from "effect/Effect";
+import { fromApiKey } from "./credentials.js";
+import { ArchilParseError } from "./errors.js";
+import * as Retry from "./retry.js";
+import { listApiTokens } from "./services/archil.js";
+// listApiTokens declares `{ success: boolean; data: { tokens?: ApiTokenResponse[] } }`.
+const run = (body) => runValidationModes(listApiTokens({}).pipe(Retry.none, Effect.provide(fromApiKey({ apiKey: "test" }))), { body });
+describe("Archil response validation", () => {
+    test("a matching body succeeds unchanged in both modes", async () => {
+        const body = {
+            success: true,
+            data: { tokens: [{ id: "tok_1", name: "ci", tokenSuffix: "abcd" }] },
+        };
+        const { lenient, strict } = await run(JSON.stringify(body));
+        expect(lenient).toMatchObject({ _tag: "Success", success: body });
+        expect(strict).toMatchObject({ _tag: "Success", success: body });
+    });
+    test("a body missing required members: lenient returns it, strict fails", async () => {
+        const { lenient, strict } = await run("{}");
+        expect(lenient).toMatchObject({ _tag: "Success", success: {} });
+        expect(strict._tag).toBe("Failure");
+        expect(strict.failure).toBeInstanceOf(ArchilParseError);
+    });
+    test("a non-JSON body: lenient returns the text, strict fails", async () => {
+        const { lenient, strict } = await run("not json");
+        expect(lenient).toMatchObject({ _tag: "Success", success: "not json" });
+        expect(strict.failure).toBeInstanceOf(ArchilParseError);
+    });
+});
+// ArchilParseError is part of every operation's declared error type.
+export const parseErrorIsDeclared = true;
+//# sourceMappingURL=response-validation.test.js.map

package/lib/response-validation.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-validation.test.js","sourceRoot":"","sources":["../src/response-validation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAGrD,wFAAwF;AACxF,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE,CAC3B,kBAAkB,CAChB,aAAa,CAAC,EAAE,CAAC,CAAC,IAAI,CACpB,KAAK,CAAC,IAAI,EACV,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAC/C,EACD,EAAE,IAAI,EAAE,CACT,CAAC;AAEJ,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,IAAI,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,IAAI,GAAG;YACX,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE;SACrE,CAAC;QACF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QACnF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,CAAE,MAAc,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACxE,MAAM,CAAE,MAAc,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,qEAAqE;AACrE,MAAM,CAAC,MAAM,oBAAoB,GAErB,IAAI,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@distilled.cloud/archil",
-  "version": "1.0.0-rc.11",
+  "version": "1.0.0-rc.13",
   "repository": {
     "type": "git",
     "url": "https://github.com/alchemy-run/distilled",
@@ -64,15 +64,15 @@
     }
   },
   "dependencies": {
-    "@distilled.cloud/core": "1.0.0-rc.11"
+    "@distilled.cloud/core": "1.0.0-rc.13"
   },
   "devDependencies": {
     "@types/bun": "1.3.14",
     "@types/node": "26.2.0",
-    "@effect/platform-bun": ">=4.0.0-rc.115 || >=4.0.0"
+    "@effect/platform-bun": "^4.0.0"
   },
   "peerDependencies": {
-    "effect": ">=4.0.0-rc.115 || >=4.0.0"
+    "effect": "^4.0.0"
   },
   "scripts": {
     "build": "tsc -b",

package/src/protocol.ts

@@ -16,13 +16,13 @@
 import * as Effect from "effect/Effect";
 import type * as Layer from "effect/Layer";
 import * as Redacted from "effect/Redacted";
-import type * as HttpClient from "effect/unstable/http/HttpClient";
-import type * as HttpClientError from "effect/unstable/http/HttpClientError";
+import type * as HttpClient from "effect/http/HttpClient";
+import type * as HttpClientError from "effect/http/HttpClientError";
 import type * as API from "@distilled.cloud/core/api";
 import { makeRestProtocol } from "@distilled.cloud/core/protocol-rest";
 import type { API_ERRORS, ConfigError } from "@distilled.cloud/core/errors";
 import { Credentials, type Config } from "./credentials.ts";
-import { UnknownArchilError } from "./errors.ts";
+import { UnknownArchilError, ArchilParseError } from "./errors.ts";
 
 /**
  * Error channel shared by every generated Archil operation. Generated service
@@ -34,7 +34,8 @@ export type ArchilOpError =
   | InstanceType<(typeof API_ERRORS)[number]>
   | UnknownArchilError
   | ConfigError
-  | HttpClientError.HttpClientError;
+  | HttpClientError.HttpClientError
+  | ArchilParseError;
 
 /** Context (requirements) shared by every generated Archil operation. */
 export type ArchilOpContext = Credentials | HttpClient.HttpClient;
@@ -72,4 +73,5 @@ export const ArchilProtocol: Layer.Layer<API.Protocol> =
             : undefined),
         body,
       }),
+    parseError: ({ body, cause }) => new ArchilParseError({ body, cause }),
   });

package/src/response-validation.test.ts

@@ -0,0 +1,48 @@
+import { describe, expect, test } from "bun:test";
+import { runValidationModes } from "@distilled.cloud/core/testing";
+import * as Effect from "effect/Effect";
+import { fromApiKey } from "./credentials.ts";
+import { ArchilParseError } from "./errors.ts";
+import * as Retry from "./retry.ts";
+import { listApiTokens } from "./services/archil.ts";
+import type { ArchilOpError } from "./protocol.ts";
+
+// listApiTokens declares `{ success: boolean; data: { tokens?: ApiTokenResponse[] } }`.
+const run = (body: string) =>
+  runValidationModes(
+    listApiTokens({}).pipe(
+      Retry.none,
+      Effect.provide(fromApiKey({ apiKey: "test" })),
+    ),
+    { body },
+  );
+
+describe("Archil response validation", () => {
+  test("a matching body succeeds unchanged in both modes", async () => {
+    const body = {
+      success: true,
+      data: { tokens: [{ id: "tok_1", name: "ci", tokenSuffix: "abcd" }] },
+    };
+    const { lenient, strict } = await run(JSON.stringify(body));
+    expect(lenient).toMatchObject({ _tag: "Success", success: body });
+    expect(strict).toMatchObject({ _tag: "Success", success: body });
+  });
+
+  test("a body missing required members: lenient returns it, strict fails", async () => {
+    const { lenient, strict } = await run("{}");
+    expect(lenient).toMatchObject({ _tag: "Success", success: {} });
+    expect(strict._tag).toBe("Failure");
+    expect((strict as any).failure).toBeInstanceOf(ArchilParseError);
+  });
+
+  test("a non-JSON body: lenient returns the text, strict fails", async () => {
+    const { lenient, strict } = await run("not json");
+    expect(lenient).toMatchObject({ _tag: "Success", success: "not json" });
+    expect((strict as any).failure).toBeInstanceOf(ArchilParseError);
+  });
+});
+
+// ArchilParseError is part of every operation's declared error type.
+export const parseErrorIsDeclared: [ArchilParseError] extends [ArchilOpError]
+  ? true
+  : false = true;