@panorama-industries/effect-vercel-blob 0.2.0 → 0.3.0

package/README.md

@@ -12,3 +12,24 @@ pnpm add @panorama-industries/effect-vercel-blob effect
 
 - `effect` `^4.0.6` (peer dependency)
 - ESM only
+
+## Usage
+
+```ts
+import { BlobStore, blobLayer, BlobLive } from "@panorama-industries/effect-vercel-blob";
+import { Effect, Layer } from "effect";
+import { FetchHttpClient } from "effect/http";
+
+// From the environment: BLOB_READ_WRITE_TOKEN, or Vercel OIDC with BLOB_STORE_ID.
+const Blob = BlobLive.pipe(Layer.provide(FetchHttpClient.layer));
+
+// Or with explicit values, which take precedence over the environment.
+const BlobWithToken = blobLayer({ token: "vercel_blob_rw_…" }).pipe(
+  Layer.provide(FetchHttpClient.layer),
+);
+
+const program = Effect.gen(function* () {
+  const blob = yield* BlobStore;
+  return yield* blob.list();
+}).pipe(Effect.provide(Blob));
+```

package/dist/implementation/blob-live.d.ts

@@ -1,16 +1,26 @@
-import type { Config } from "effect";
 import type { HttpClient } from "effect/http";
-import { Layer } from "effect";
+import { Config, Layer } from "effect";
 import type { BlobSignedUrls } from "../contracts/blob-signed-urls.ts";
 import type { BlobStore } from "../contracts/blob-store.ts";
 import type { BlobUploads } from "../contracts/blob-uploads.ts";
+import type { BlobConfigOptions } from "./blob-config-live.ts";
 /**
- * Store, signed URLs and upload routes configured from the Vercel environment
- * (`BLOB_READ_WRITE_TOKEN`, or the function's OIDC token with `BLOB_STORE_ID`). Provide an
- * `HttpClient`, e.g. `FetchHttpClient.layer`.
+ * Store, signed URLs and upload routes, with the given values taking precedence over the Vercel
+ * environment (see `blobConfigLayer`). Provides Vercel OIDC and the system environment itself, so
+ * only an `HttpClient` is left to provide, e.g. `FetchHttpClient.layer`.
  *
- * Compose the individual layers instead to override configuration (`blobConfigLayer`) or to
- * refresh OIDC tokens in local development (`VercelOidcRefreshingLive`).
+ * Compose the individual layers instead to refresh OIDC tokens in local development
+ * (`VercelOidcRefreshingLive`).
+ */
+export declare const blobLayer: (options?: BlobConfigOptions) => Layer.Layer<BlobStore | BlobSignedUrls | BlobUploads, Config.ConfigError, HttpClient.HttpClient>;
+/**
+ * {@link blobLayer} with its options read from `Config`, either one `Config` of the options or a
+ * record of a `Config` per option, e.g. `blobLayerConfig({ token: Config.Redacted("MY_TOKEN") })`.
+ */
+export declare const blobLayerConfig: (options: Config.Wrap<BlobConfigOptions>) => Layer.Layer<BlobStore | BlobSignedUrls | BlobUploads, Config.ConfigError, HttpClient.HttpClient>;
+/**
+ * {@link blobLayer} configured from the Vercel environment alone (`BLOB_READ_WRITE_TOKEN`, or the
+ * function's OIDC token with `BLOB_STORE_ID`).
  */
 export declare const BlobLive: Layer.Layer<BlobStore | BlobSignedUrls | BlobUploads, Config.ConfigError, HttpClient.HttpClient>;
 //# sourceMappingURL=blob-live.d.ts.map

package/dist/implementation/blob-live.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blob-live.d.ts","sourceRoot":"","sources":["../../src/implementation/blob-live.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAG9C,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAOhE;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,KAAK,CAChC,SAAS,GAAG,cAAc,GAAG,WAAW,EACxC,MAAM,CAAC,WAAW,EAClB,UAAU,CAAC,UAAU,CAGtB,CAAC"}
+{"version":3,"file":"blob-live.d.ts","sourceRoot":"","sources":["../../src/implementation/blob-live.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAG9C,OAAO,EAAE,MAAM,EAAU,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAO/D;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,aACX,iBAAiB,KACzB,KAAK,CAAC,KAAK,CACZ,SAAS,GAAG,cAAc,GAAG,WAAW,EACxC,MAAM,CAAC,WAAW,EAClB,UAAU,CAAC,UAAU,CAIpB,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,eAAe,YACjB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,KACtC,KAAK,CAAC,KAAK,CACZ,SAAS,GAAG,cAAc,GAAG,WAAW,EACxC,MAAM,CAAC,WAAW,EAClB,UAAU,CAAC,UAAU,CACyC,CAAC;AAEjE;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,KAAK,CAChC,SAAS,GAAG,cAAc,GAAG,WAAW,EACxC,MAAM,CAAC,WAAW,EAClB,UAAU,CAAC,UAAU,CACR,CAAC"}

package/dist/implementation/blob-live.js

@@ -1,16 +1,26 @@
 import { VercelOidcLive, VercelSystemEnvLive } from "@panorama-industries/effect-vercel-core";
-import { Layer } from "effect";
-import { BlobConfigLive } from "./blob-config-live.js";
+import { Config, Effect, Layer } from "effect";
+import { blobConfigLayer } from "./blob-config-live.js";
 import { BlobSignedUrlsLive } from "./blob-signed-urls-live.js";
 import { BlobStoreLive } from "./blob-store-live.js";
 import { BlobUploadsLive } from "./blob-uploads-live.js";
 /**
- * Store, signed URLs and upload routes configured from the Vercel environment
- * (`BLOB_READ_WRITE_TOKEN`, or the function's OIDC token with `BLOB_STORE_ID`). Provide an
- * `HttpClient`, e.g. `FetchHttpClient.layer`.
+ * Store, signed URLs and upload routes, with the given values taking precedence over the Vercel
+ * environment (see `blobConfigLayer`). Provides Vercel OIDC and the system environment itself, so
+ * only an `HttpClient` is left to provide, e.g. `FetchHttpClient.layer`.
  *
- * Compose the individual layers instead to override configuration (`blobConfigLayer`) or to
- * refresh OIDC tokens in local development (`VercelOidcRefreshingLive`).
+ * Compose the individual layers instead to refresh OIDC tokens in local development
+ * (`VercelOidcRefreshingLive`).
  */
-export const BlobLive = Layer.mergeAll(BlobStoreLive, BlobSignedUrlsLive, BlobUploadsLive).pipe(Layer.provide(Layer.mergeAll(BlobConfigLive, VercelOidcLive, VercelSystemEnvLive)));
+export const blobLayer = (options = {}) => Layer.mergeAll(BlobStoreLive, BlobSignedUrlsLive, BlobUploadsLive).pipe(Layer.provide(Layer.mergeAll(blobConfigLayer(options), VercelOidcLive, VercelSystemEnvLive)));
+/**
+ * {@link blobLayer} with its options read from `Config`, either one `Config` of the options or a
+ * record of a `Config` per option, e.g. `blobLayerConfig({ token: Config.Redacted("MY_TOKEN") })`.
+ */
+export const blobLayerConfig = (options) => Layer.unwrap(Effect.map(Config.unwrap(options), blobLayer));
+/**
+ * {@link blobLayer} configured from the Vercel environment alone (`BLOB_READ_WRITE_TOKEN`, or the
+ * function's OIDC token with `BLOB_STORE_ID`).
+ */
+export const BlobLive = blobLayer();
 //# sourceMappingURL=blob-live.js.map

package/dist/implementation/blob-live.js.map

@@ -1 +1 @@
-{"version":3,"file":"blob-live.js","sourceRoot":"","sources":["../../src/implementation/blob-live.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AAC9F,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAM/B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,QAAQ,GAIjB,KAAK,CAAC,QAAQ,CAAC,aAAa,EAAE,kBAAkB,EAAE,eAAe,CAAC,CAAC,IAAI,CACzE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,EAAE,mBAAmB,CAAC,CAAC,CACnF,CAAC"}
+{"version":3,"file":"blob-live.js","sourceRoot":"","sources":["../../src/implementation/blob-live.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AAC9F,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAO/C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,OAAO,GAAsB,EAAE,EAK/B,EAAE,CACF,KAAK,CAAC,QAAQ,CAAC,aAAa,EAAE,kBAAkB,EAAE,eAAe,CAAC,CAAC,IAAI,CACrE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,cAAc,EAAE,mBAAmB,CAAC,CAAC,CAC7F,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,OAAuC,EAKvC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;AAEjE;;;GAGG;AACH,MAAM,CAAC,MAAM,QAAQ,GAIjB,SAAS,EAAE,CAAC"}

package/dist/index.d.ts

@@ -11,5 +11,5 @@ export { BlobStoreLive } from "./implementation/blob-store-live.ts";
 export { BlobSignedUrlsLive } from "./implementation/blob-signed-urls-live.ts";
 export { BlobUploadsLive } from "./implementation/blob-uploads-live.ts";
 export { ClientTokenPayload, getPayloadFromClientToken } from "./internal/client-token.ts";
-export { BlobLive } from "./implementation/blob-live.ts";
+export { BlobLive, blobLayer, blobLayerConfig } from "./implementation/blob-live.ts";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EACL,KAAK,iBAAiB,EACtB,cAAc,EACd,eAAe,GAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EACL,KAAK,iBAAiB,EACtB,cAAc,EACd,eAAe,GAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/index.js

@@ -11,5 +11,5 @@ export { BlobStoreLive } from "./implementation/blob-store-live.js";
 export { BlobSignedUrlsLive } from "./implementation/blob-signed-urls-live.js";
 export { BlobUploadsLive } from "./implementation/blob-uploads-live.js";
 export { ClientTokenPayload, getPayloadFromClientToken } from "./internal/client-token.js";
-export { BlobLive } from "./implementation/blob-live.js";
+export { BlobLive, blobLayer, blobLayerConfig } from "./implementation/blob-live.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAEL,cAAc,EACd,eAAe,GAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAEL,cAAc,EACd,eAAe,GAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "../../.vscode/schemas/package.schema.json",
   "name": "@panorama-industries/effect-vercel-blob",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Effect-native client for Vercel Blob: uploads, downloads, listing, multipart, signed URLs and browser uploads.",
   "keywords": [
     "blob",
@@ -56,7 +56,7 @@
     "provenance": true
   },
   "dependencies": {
-    "@panorama-industries/effect-vercel-core": "^0.2.0"
+    "@panorama-industries/effect-vercel-core": "^0.3.0"
   },
   "devDependencies": {
     "@vercel/blob": "2.8.2",

package/src/implementation/blob-live.ts

@@ -1,30 +1,55 @@
-import type { Config } from "effect";
 import type { HttpClient } from "effect/http";
 
 import { VercelOidcLive, VercelSystemEnvLive } from "@panorama-industries/effect-vercel-core";
-import { Layer } from "effect";
+import { Config, Effect, Layer } from "effect";
 
 import type { BlobSignedUrls } from "../contracts/blob-signed-urls.ts";
 import type { BlobStore } from "../contracts/blob-store.ts";
 import type { BlobUploads } from "../contracts/blob-uploads.ts";
+import type { BlobConfigOptions } from "./blob-config-live.ts";
 
-import { BlobConfigLive } from "./blob-config-live.ts";
+import { blobConfigLayer } from "./blob-config-live.ts";
 import { BlobSignedUrlsLive } from "./blob-signed-urls-live.ts";
 import { BlobStoreLive } from "./blob-store-live.ts";
 import { BlobUploadsLive } from "./blob-uploads-live.ts";
 
 /**
- * Store, signed URLs and upload routes configured from the Vercel environment
- * (`BLOB_READ_WRITE_TOKEN`, or the function's OIDC token with `BLOB_STORE_ID`). Provide an
- * `HttpClient`, e.g. `FetchHttpClient.layer`.
+ * Store, signed URLs and upload routes, with the given values taking precedence over the Vercel
+ * environment (see `blobConfigLayer`). Provides Vercel OIDC and the system environment itself, so
+ * only an `HttpClient` is left to provide, e.g. `FetchHttpClient.layer`.
  *
- * Compose the individual layers instead to override configuration (`blobConfigLayer`) or to
- * refresh OIDC tokens in local development (`VercelOidcRefreshingLive`).
+ * Compose the individual layers instead to refresh OIDC tokens in local development
+ * (`VercelOidcRefreshingLive`).
+ */
+export const blobLayer = (
+  options: BlobConfigOptions = {},
+): Layer.Layer<
+  BlobStore | BlobSignedUrls | BlobUploads,
+  Config.ConfigError,
+  HttpClient.HttpClient
+> =>
+  Layer.mergeAll(BlobStoreLive, BlobSignedUrlsLive, BlobUploadsLive).pipe(
+    Layer.provide(Layer.mergeAll(blobConfigLayer(options), VercelOidcLive, VercelSystemEnvLive)),
+  );
+
+/**
+ * {@link blobLayer} with its options read from `Config`, either one `Config` of the options or a
+ * record of a `Config` per option, e.g. `blobLayerConfig({ token: Config.Redacted("MY_TOKEN") })`.
+ */
+export const blobLayerConfig = (
+  options: Config.Wrap<BlobConfigOptions>,
+): Layer.Layer<
+  BlobStore | BlobSignedUrls | BlobUploads,
+  Config.ConfigError,
+  HttpClient.HttpClient
+> => Layer.unwrap(Effect.map(Config.unwrap(options), blobLayer));
+
+/**
+ * {@link blobLayer} configured from the Vercel environment alone (`BLOB_READ_WRITE_TOKEN`, or the
+ * function's OIDC token with `BLOB_STORE_ID`).
  */
 export const BlobLive: Layer.Layer<
   BlobStore | BlobSignedUrls | BlobUploads,
   Config.ConfigError,
   HttpClient.HttpClient
-> = Layer.mergeAll(BlobStoreLive, BlobSignedUrlsLive, BlobUploadsLive).pipe(
-  Layer.provide(Layer.mergeAll(BlobConfigLive, VercelOidcLive, VercelSystemEnvLive)),
-);
+> = blobLayer();

package/src/index.ts

@@ -15,4 +15,4 @@ export { BlobStoreLive } from "./implementation/blob-store-live.ts";
 export { BlobSignedUrlsLive } from "./implementation/blob-signed-urls-live.ts";
 export { BlobUploadsLive } from "./implementation/blob-uploads-live.ts";
 export { ClientTokenPayload, getPayloadFromClientToken } from "./internal/client-token.ts";
-export { BlobLive } from "./implementation/blob-live.ts";
+export { BlobLive, blobLayer, blobLayerConfig } from "./implementation/blob-live.ts";