@edgeone/pages-blob 0.0.1

package/README.md

@@ -0,0 +1,154 @@
+# @edgeone/pages-blob
+
+Blob storage SDK for EdgeOne Pages Functions, providing persistent key-value storage across deployments.
+
+## Installation
+
+```bash
+npm install @edgeone/pages-blob
+```
+
+## Usage
+
+### Inside Pages Functions (automatic authentication)
+
+```js
+import { getStore } from "@edgeone/pages-blob";
+
+const store = getStore("my-store");
+
+// Write
+await store.set("key", "value");
+await store.setJSON("config", { theme: "dark" });
+
+// Read
+const text = await store.get("key");
+const json = await store.get("config", { type: "json" });
+
+// Delete
+await store.delete("key");
+
+// List
+const { blobs } = await store.list({ prefix: "users/" });
+```
+
+### External access (API Token mode)
+
+When calling from outside Pages Functions, you must supply **both** `token` and `projectId`:
+
+```js
+const store = getStore({
+  name: "my-store",
+  projectId: "pages-urtsvuwmfvli", // required
+  token: "c+KH5...", // required
+});
+```
+
+Omitting `projectId` throws `MissingProjectIdError`.
+
+### Strong consistency (read-after-write)
+
+By default reads use eventual consistency (CDN-cached, lower latency). To
+guarantee read-after-write consistency, use `"strong"`:
+
+```js
+// Store-level default — all reads use strong consistency
+const store = getStore({ name: "my-store", consistency: "strong" });
+
+// Per-call override
+await store.get("key", { consistency: "strong" });
+await store.getMetadata("key", { consistency: "strong" });
+await store.list({ consistency: "strong" });
+```
+
+`"eventual"` (the default) has lower latency; `"strong"` guarantees the
+freshest value at the cost of bypassing the cache layer.
+
+### List all stores
+
+```js
+import { listStores } from "@edgeone/pages-blob";
+
+// Inside Pages Functions
+const { stores } = await listStores();
+
+// External access (token mode) - both fields required
+const { stores } = await listStores({
+  projectId: "pages-urtsvuwmfvli",
+  token: "c+KH5...",
+});
+```
+
+## API
+
+### `getStore(name | options)`
+
+Get a Store instance.
+
+| Parameter             | Type                     | Description                                     |
+| --------------------- | ------------------------ | ----------------------------------------------- |
+| `name`                | `string`                 | Store name                                      |
+| `options.name`        | `string`                 | Store name                                      |
+| `options.projectId`   | `string`                 | Project ID (**required** for external access)   |
+| `options.token`       | `string`                 | Access token (**required** for external access) |
+| `options.consistency` | `"eventual" \| "strong"` | Default read consistency (default `"eventual"`) |
+
+### `store.set(key, value, options?)`
+
+Write a Blob. `value` supports `string | ArrayBuffer | Blob | ReadableStream`.
+
+- `options.onlyIfNew`: only write if the key does not already exist
+- `options.cacheControl`: custom `Cache-Control` header for the stored object (default: `"max-age=0, stale-while-revalidate=60"`; pass `null` to omit)
+
+### `store.setJSON(key, value, options?)`
+
+Write JSON (serialized automatically). Accepts the same `options` as `store.set`.
+
+### `store.get(key, options?)`
+
+Read a Blob. Returns `null` if it does not exist.
+
+- `options.type`: `"text"` (default) | `"json"` | `"arrayBuffer"` | `"blob"` | `"stream"`
+- `options.consistency`: `"eventual"` | `"strong"` (overrides Store-level default)
+
+### `store.getMetadata(key, options?)`
+
+Read blob metadata without downloading the body. Returns `null` if the key does not exist.
+
+Returns: `{ cacheControl?, contentType?, etag?, headers? }`
+
+- `options.consistency`: `"eventual"` | `"strong"`
+
+### `store.getWithHeaders(key, options?)`
+
+Read a blob along with all response headers. Returns `null` if the key does not exist.
+
+Returns: `{ body: string, headers: Record<string, string> }`
+
+- `options.consistency`: `"eventual"` | `"strong"`
+
+### `store.delete(key)`
+
+Delete a Blob.
+
+### `store.list(options?)`
+
+List Blobs. Automatically aggregates all pages by default.
+
+- `options.prefix`: prefix filter
+- `options.directories`: group by directory
+- `options.paginate`: set to `false` for manual pagination
+- `options.cursor`: resume from a previous pagination cursor
+- `options.consistency`: `"eventual"` | `"strong"`
+
+Returns: `{ blobs: Array<{ key, etag }>, directories: string[] }`
+
+### `listStores(options?)`
+
+List all Stores under the project.
+
+- `options.projectId`: Project ID (**required** for external access)
+- `options.token`: Access token (**required** for external access)
+- `options.consistency`: `"eventual"` | `"strong"`
+
+Returns: `{ stores: Array<{ name: string }> }`

package/dist/index.d.ts

@@ -0,0 +1,205 @@
+// ─── Public Types ───
+
+/**
+ * Read consistency mode
+ * - "eventual" (default): uses the CDN-cached domain, lower latency
+ * - "strong": uses the no-cache domain, guarantees read-after-write
+ */
+export type ConsistencyMode = "eventual" | "strong";
+
+export interface StoreOptions {
+  name: string;
+  /** Project ID, required when using token mode (external access) */
+  projectId: string;
+  /** API Token, required for external access */
+  token: string;
+  /**
+   * Default consistency mode applied to all read operations (get / getMetadata / getWithHeaders / list)
+   * Can be overridden per-call via options.consistency
+   */
+  consistency?: ConsistencyMode;
+}
+
+export type BlobInput = string | ArrayBuffer | Blob | ReadableStream;
+
+export interface SetOptions {
+  /** Conditional write: only write if the key does not already exist */
+  onlyIfNew?: boolean;
+  /**
+   * Cache-Control response header for writes
+   * - If omitted: uses SDK default "max-age=0, stale-while-revalidate=60"
+   * - If string: overrides with this value
+   * - If null: does not send Cache-Control at all
+   */
+  cacheControl?: string | null;
+}
+
+export interface GetOptions {
+  type?: BlobResponseType;
+  /** Consistency mode for this read, overrides the Store-level default */
+  consistency?: ConsistencyMode;
+}
+
+export type BlobResponseType = "text" | "json" | "arrayBuffer" | "blob" | "stream";
+
+export interface ListOptions {
+  prefix?: string;
+  directories?: boolean;
+  cursor?: string;
+  /** Defaults to true, automatically aggregates all pages */
+  paginate?: boolean;
+  /** Consistency mode for this listing, overrides the Store-level default */
+  consistency?: ConsistencyMode;
+}
+
+export interface ListResult {
+  blobs: BlobInfo[];
+  directories: string[];
+}
+
+export interface BlobInfo {
+  key: string;
+  etag: string;
+}
+
+export interface StoreListResult {
+  stores: { name: string }[];
+}
+
+// ─── Store Class ───
+
+/**
+ * Store instance providing blob storage read/write operations.
+ * Obtained via getStore(), supports persistence across deployments.
+ */
+export declare class Store {
+  /**
+   * Write a blob
+   */
+  set(key: string, value: BlobInput, options?: SetOptions): Promise<void>;
+
+  /**
+   * Write JSON (convenience method)
+   */
+  setJSON(key: string, value: unknown, options?: SetOptions): Promise<void>;
+
+  /**
+   * Read a blob
+   *
+   * Return type depends on the type parameter:
+   * - "text" (default): string
+   * - "json": any
+   * - "arrayBuffer": ArrayBuffer
+   * - "blob": Blob
+   * - "stream": ReadableStream
+   *
+   * Returns null if the key does not exist.
+   */
+  get(key: string): Promise<string | null>;
+  get(key: string, options: { type?: "text"; consistency?: ConsistencyMode }): Promise<string | null>;
+  get(key: string, options: { type: "json"; consistency?: ConsistencyMode }): Promise<any | null>;
+  get(key: string, options: { type: "arrayBuffer"; consistency?: ConsistencyMode }): Promise<ArrayBuffer | null>;
+  get(key: string, options: { type: "blob"; consistency?: ConsistencyMode }): Promise<Blob | null>;
+  get(key: string, options: { type: "stream"; consistency?: ConsistencyMode }): Promise<ReadableStream | null>;
+
+  /**
+   * Read blob metadata (without downloading body)
+   *
+   * Returns null if the key does not exist.
+   */
+  getMetadata(key: string, options?: { consistency?: ConsistencyMode }): Promise<{
+    cacheControl?: string;
+    contentType?: string;
+    etag?: string;
+    headers?: Record<string, string>;
+  } | null>;
+
+  /**
+   * Read object with all response headers (for verifying CDN behavior)
+   *
+   * Returns null if the key does not exist.
+   */
+  getWithHeaders(key: string, options?: { consistency?: ConsistencyMode }): Promise<{
+    body: string;
+    headers: Record<string, string>;
+  } | null>;
+
+  /**
+   * Delete a blob
+   */
+  delete(key: string): Promise<void>;
+
+  /**
+   * List blobs
+   *
+   * Automatically aggregates all pages by default. Set paginate: false for manual pagination.
+   */
+  list(options?: ListOptions): Promise<ListResult>;
+}
+
+// ─── Error Classes ───
+
+/**
+ * Pages Blob error base class
+ */
+export declare class PagesBlobError extends Error {
+  code: string;
+  constructor(code: string, message: string);
+}
+
+export declare class InvalidKeyError extends PagesBlobError {
+  constructor(detail: string);
+}
+
+export declare class InvalidStoreNameError extends PagesBlobError {
+  constructor(detail: string);
+}
+
+export declare class QuotaExceededError extends PagesBlobError {
+  constructor();
+}
+
+export declare class RateLimitedError extends PagesBlobError {
+  constructor();
+}
+
+export declare class MissingProjectIdError extends PagesBlobError {
+  constructor();
+}
+
+export declare class PreconditionFailedError extends PagesBlobError {
+  constructor();
+}
+
+// ─── Public Functions ───
+
+/**
+ * Get a Store instance
+ *
+ * Automatically authenticated inside Pages Functions, no configuration needed:
+ * ```js
+ * const store = getStore("my-store");
+ * ```
+ *
+ * External access (API token mode) requires both projectId and token:
+ * ```js
+ * const store = getStore({
+ *   name: "my-store",
+ *   projectId: "pages-urtsvuwmfvli", // required
+ *   token: "c+KH5...",               // required
+ * });
+ * ```
+ */
+export declare function getStore(name: string): Store;
+export declare function getStore(options: StoreOptions): Store;
+
+/**
+ * List all stores under the project
+ *
+ * External access (API token mode) requires both projectId and token.
+ */
+export declare function listStores(options?: {
+  projectId: string;
+  token: string;
+  consistency?: ConsistencyMode;
+}): Promise<StoreListResult>;

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";var D=Object.defineProperty;var te=Object.getOwnPropertyDescriptor;var ne=Object.getOwnPropertyNames;var re=Object.prototype.hasOwnProperty;var se=(t,e)=>{for(var r in e)D(t,r,{get:e[r],enumerable:!0})},oe=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of ne(e))!re.call(t,o)&&o!==r&&D(t,o,{get:()=>e[o],enumerable:!(n=te(e,o))||n.enumerable});return t};var ie=t=>oe(D({},"__esModule",{value:!0}),t);var ke={};se(ke,{InvalidKeyError:()=>y,InvalidStoreNameError:()=>m,MissingProjectIdError:()=>C,PagesBlobError:()=>f,PreconditionFailedError:()=>p,QuotaExceededError:()=>P,RateLimitedError:()=>R,Store:()=>x,getStore:()=>Te,listStores:()=>Ie});module.exports=ie(ke);var f=class extends Error{code;constructor(e,r){super(`PagesBlob: ${r}`),this.name="PagesBlobError",this.code=e}},y=class extends f{constructor(e){super("INVALID_KEY",e)}},m=class extends f{constructor(e){super("INVALID_STORE_NAME",e)}},S=class extends f{constructor(e){super("MISSING_ENVIRONMENT",`Environment not configured for Pages Blob. Missing: ${e.join(", ")}. Supply these properties when creating a store, or ensure the function is running in a Pages environment.`)}},P=class extends f{constructor(){super("QUOTA_EXCEEDED","storage quota exceeded")}},R=class extends f{constructor(){super("RATE_LIMITED","request rate limited, please retry later")}},C=class extends f{constructor(){super("MISSING_PROJECT_ID","projectId is required when using API token mode. Please supply { name, projectId, token } to getStore() / listStores().")}},h=class extends f{constructor(e){super("CREDENTIAL_ERROR",e)}},l=class extends f{constructor(e,r){super("COS_ERROR",`COS returned ${e}: ${r}`)}},p=class extends f{constructor(){super("PRECONDITION_FAILED","conditional write failed (key already exists)")}};function w(t){if(t==="")throw new y("Blob key must not be empty.");if(t.startsWith("/")||t.startsWith("%2F"))throw new y("Blob key must not start with forward slash (/).");if(new TextEncoder().encode(t).length>600)throw new y("Blob key must be a sequence of Unicode characters whose UTF-8 encoding is at most 600 bytes long.")}function $(t){if(t==="")throw new m("Store name must not be empty.");if(t.includes("/")||t.includes(":"))throw new m("Store name must not contain forward slashes (/) or colons (:).");if(!/^[a-zA-Z0-9_-]+$/.test(t))throw new m("Store name must only contain letters, digits, underscores, and hyphens.");if(new TextEncoder().encode(t).length>64)throw new m("Store name must be a sequence of Unicode characters whose UTF-8 encoding is at most 64 bytes long.")}var x=class{cosClient;storeName;defaultConsistency;constructor(e,r,n="eventual"){this.cosClient=e,this.storeName=r,this.defaultConsistency=n}resolveConsistency(e){return e??this.defaultConsistency}async set(e,r,n){w(e);let o=await this.cosClient.putObject(this.storeName,e,r,{onlyIfNew:n?.onlyIfNew,cacheControl:n?.cacheControl});if(n?.onlyIfNew&&o.statusCode===412)throw new p}async setJSON(e,r,n){w(e);let o=JSON.stringify(r),s=await this.cosClient.putObject(this.storeName,e,o,{onlyIfNew:n?.onlyIfNew,contentType:"application/json",cacheControl:n?.cacheControl});if(n?.onlyIfNew&&s.statusCode===412)throw new p}async get(e,r){w(e);let n=this.resolveConsistency(r?.consistency),o=await this.cosClient.getObject(this.storeName,e,n);if(o===null)return null;let{body:s}=o,i=r?.type??"text",a=new TextDecoder("utf-8");switch(i){case"text":return a.decode(s);case"json":return JSON.parse(a.decode(s));case"arrayBuffer":return s.buffer.slice(s.byteOffset,s.byteOffset+s.byteLength);case"blob":return new Blob([s]);case"stream":return new ReadableStream({start(c){c.enqueue(s),c.close()}});default:return a.decode(s)}}async getMetadata(e,r){w(e);let n=this.resolveConsistency(r?.consistency);return this.cosClient.headObject(this.storeName,e,n)}async getWithHeaders(e,r){w(e);let n=this.resolveConsistency(r?.consistency),o=await this.cosClient.getObject(this.storeName,e,n);return o?{body:new TextDecoder("utf-8").decode(o.body),headers:o.headers||{}}:null}async delete(e){w(e),await this.cosClient.deleteObject(this.storeName,e)}async list(e){let r=e?.paginate!==!1,n=[],o=[],s=this.resolveConsistency(e?.consistency),i=e?.cursor||"",a=!0;for(;a;){let c=await this.cosClient.listObjects(this.storeName,{prefix:e?.prefix,delimiter:e?.directories?"/":void 0,marker:i||void 0,maxKeys:1e3,consistency:s});for(let d of c.contents)n.push({key:d.key,etag:d.etag});o.push(...c.commonPrefixes),!r||!c.isTruncated?a=!1:i=c.nextMarker}return{blobs:n,directories:o}}};var ae=new TextEncoder;function N(t){let e=ae.encode(t),r=new ArrayBuffer(e.byteLength),n=new Uint8Array(r);return n.set(e),n}function H(t){let e=t instanceof Uint8Array?t:new Uint8Array(t),r="";for(let n=0;n<e.length;n++)r+=e[n].toString(16).padStart(2,"0");return r}async function L(t,e){let r=await crypto.subtle.importKey("raw",N(t),{name:"HMAC",hash:"SHA-1"},!1,["sign"]),n=await crypto.subtle.sign("HMAC",r,N(e));return H(n)}async function ce(t){let e=await crypto.subtle.digest("SHA-1",N(t));return H(e)}function v(t){return encodeURIComponent(t).replace(/[!'()*]/g,e=>"%"+e.charCodeAt(0).toString(16).toUpperCase())}function de(t){return t.split("/").map(e=>v(e)).join("/")}var le=new Set(["cache-control","content-disposition","content-encoding","content-length","content-md5","content-type","expect","expires","if-match","if-modified-since","if-none-match","if-unmodified-since","origin","range","transfer-encoding"]);function ue(t){return t==="host"||t==="x-cos-security-token"?!1:!!(le.has(t)||t.startsWith("x-cos-"))}function K(t){if(!t)return[];let e=[];for(let[r,n]of Object.entries(t))n!=null&&e.push([r.toLowerCase(),String(n)]);return e.sort(([r],[n])=>r<n?-1:r>n?1:0),e}function q(t){return t.map(([e,r])=>`${v(e)}=${v(r)}`).join("&")}function U(t){return t.map(([e])=>v(e)).join(";")}async function ge(t){let e=t.method.toLowerCase(),r=t.pathname.startsWith("/")?t.pathname:`/${t.pathname}`,n=Math.floor(Date.now()/1e3),o=n+(t.expireSeconds??3600),s=`${n};${o}`,a=K(t.headers).filter(([j])=>ue(j)),c=U(a),d=q(a),u=K(t.query),g=U(u),M=q(u),O=`${e}
+${r}
+${M}
+${d}
+`,V=`sha1
+${s}
+${await ce(O)}
+`,J=await L(t.secretKey,s),Q=await L(J,V),Z=["q-sign-algorithm=sha1",`q-ak=${t.secretId}`,`q-sign-time=${s}`,`q-key-time=${s}`,`q-header-list=${c}`,`q-url-param-list=${g}`,`q-signature=${Q}`].join("&"),_={};for(let[j,ee]of a)_[j]=ee;return{authorization:Z,signedHeaders:_}}async function b(t){let e=new URL(t.domain),r=t.key?`/${de(t.key)}`:"/";if(e.pathname=r,t.query)for(let[s,i]of Object.entries(t.query))i!=null&&e.searchParams.set(s,String(i));let{authorization:n}=await ge({method:t.method,pathname:r,query:t.query,headers:t.headers,secretId:t.credential.secretId,secretKey:t.credential.secretKey}),o=new Headers;if(t.headers)for(let[s,i]of Object.entries(t.headers))i!=null&&o.set(s,String(i));return o.set("Authorization",n),t.credential.sessionToken&&o.set("x-cos-security-token",t.credential.sessionToken),fetch(e.toString(),{method:t.method,headers:o,body:t.body??void 0,signal:t.signal})}var fe="blob.edgeone.site",he="blob-nocache.edgeone.site",k=class{credentialManager;bucket="";region="";keyPrefix="";cachedDomain="";uncachedDomain="";initialized=!1;constructor(e){this.credentialManager=e}computeSubdomain(e){let r=[];if(e.appId&&r.push(e.appId),e.zoneId&&r.push(e.zoneId),e.projectId&&r.push(e.projectId),r.length===3)return r.join("-");if(e.resourcePrefix){let o=e.resourcePrefix.replace(/\/?\*$/,"").split("/").filter(Boolean);if(o.length>=3)return o.slice(0,3).join("-")}return""}async ensureInitialized(){if(this.initialized)return;let e=await this.credentialManager.getCredential();!this.keyPrefix&&e.resourcePrefix&&(this.keyPrefix=e.resourcePrefix.replace(/\/?\*$/,""));let r=e.edgeRegion==="CN",n=e.cosMainland,o=e.cosOverseas,s=r?n||o:o||n;!this.bucket&&s&&(this.bucket=s.bucket,this.region=s.region);let i=this.computeSubdomain(e);if(!i)throw new l(0,"unable to derive tenant subdomain from credential; missing appId/zoneId/projectId or resourcePrefix");this.cachedDomain=`https://${i}.${fe}`,this.uncachedDomain=`https://${i}.${he}`,this.initialized=!0}async resolveDomain(e){return await this.ensureInitialized(),e==="strong"?this.uncachedDomain:this.cachedDomain}async resolveCredential(){let e=await this.credentialManager.getCredential();return{secretId:e.tmpSecretId,secretKey:e.tmpSecretKey,sessionToken:e.sessionToken}}buildCosKey(e,r){return`${this.keyPrefix}/${e}/${r}`}async getDomains(){return await this.ensureInitialized(),{cached:this.cachedDomain,uncached:this.uncachedDomain}}async putObject(e,r,n,o){let s=await this.resolveDomain("eventual"),i=await this.resolveCredential(),a=this.buildCosKey(e,r),d=o?.cacheControl===null?void 0:o?.cacheControl??"max-age=0, stale-while-revalidate=60",u={};o?.onlyIfNew&&(u["If-None-Match"]="*"),d&&(u["Cache-Control"]=d),o?.contentType&&(u["Content-Type"]=o.contentType);try{let g=await b({domain:s,method:"PUT",key:a,headers:u,body:n,credential:i});if(g.status===412)return await g.arrayBuffer().catch(()=>{}),{etag:"",statusCode:412};if(!g.ok){let O=await T(g);throw new l(g.status,O||`putObject failed: ${g.status}`)}let M=g.headers.get("etag")||"";return await g.arrayBuffer().catch(()=>{}),{etag:M,statusCode:g.status}}catch(g){throw g instanceof l?g:new l(0,g.message||String(g))}}async getObject(e,r,n){let o=await this.resolveDomain(n),s=await this.resolveCredential(),i=this.buildCosKey(e,r);try{let a=await b({domain:o,method:"GET",key:i,credential:s});if(a.status===404)return await a.arrayBuffer().catch(()=>{}),null;if(!a.ok){let u=await T(a);throw new l(a.status,u||`getObject failed: ${a.status}`)}let c=new Uint8Array(await a.arrayBuffer()),d=z(a.headers);return{body:c,contentType:d["content-type"],headers:d}}catch(a){throw a instanceof l?a:new l(0,a.message||String(a))}}async headObject(e,r,n){let o=await this.resolveDomain(n),s=await this.resolveCredential(),i=this.buildCosKey(e,r);try{let a=await b({domain:o,method:"HEAD",key:i,credential:s});if(a.status===404)return null;if(!a.ok){let d=await T(a);throw new l(a.status,d||`headObject failed: ${a.status}`)}let c=z(a.headers);return{cacheControl:c["cache-control"],contentType:c["content-type"],etag:c.etag,headers:c}}catch(a){throw a instanceof l?a:new l(0,a.message||String(a))}}async deleteObject(e,r){let n=await this.resolveDomain("eventual"),o=await this.resolveCredential(),s=this.buildCosKey(e,r);try{let i=await b({domain:n,method:"DELETE",key:s,credential:o});if(i.status===204||i.status===404||i.ok){await i.arrayBuffer().catch(()=>{});return}let a=await T(i);throw new l(i.status,a||`deleteObject failed: ${i.status}`)}catch(i){throw i instanceof l?i:new l(0,i.message||String(i))}}async listObjects(e,r){let n=`${this.keyPrefix}/${e}/`,o=r?.prefix?n+r.prefix:n,s=await this.getBucketRaw({prefix:o,delimiter:r?.delimiter,marker:r?.marker,maxKeys:r?.maxKeys,consistency:r?.consistency}),i=s.contents.map(c=>{let d=c.key,u=d.startsWith(n)?d.slice(n.length):d;return u?{key:u,etag:c.etag}:null}).filter(c=>c!==null),a=s.commonPrefixes.map(c=>c.startsWith(n)?c.slice(n.length):c).filter(c=>!!c);return{contents:i,commonPrefixes:a,isTruncated:s.isTruncated,nextMarker:s.nextMarker}}async listStores(e){let r=[],n="",o=!0;for(;o;){await this.ensureInitialized();let s=`${this.keyPrefix}/`,i=await this.getBucketRaw({prefix:s,delimiter:"/",maxKeys:1e3,marker:n||void 0,consistency:e});for(let a of i.commonPrefixes){let c=a.startsWith(s)?a.slice(s.length,-1):a.slice(0,-1);c&&r.push(c)}if(o=i.isTruncated,n=i.nextMarker,!o||!n)break}return r}async getBucketRaw(e){let r=await this.resolveDomain(e.consistency),n=await this.resolveCredential(),o={prefix:e.prefix};e.delimiter&&(o.delimiter=e.delimiter),e.marker&&(o.marker=e.marker),e.maxKeys&&(o["max-keys"]=e.maxKeys);try{let s=await b({domain:r,method:"GET",query:o,credential:n});if(!s.ok){let a=await T(s);throw new l(s.status,a||`getBucket failed: ${s.status}`)}let i=await s.text();return me(i)}catch(s){throw s instanceof l?s:new l(0,s.message||String(s))}}};async function T(t){try{return await t.text()}catch{return""}}function z(t){let e={};return t.forEach((r,n)=>{e[n.toLowerCase()]=r}),e}function me(t){let e=[],r=/<Contents>([\s\S]*?)<\/Contents>/g,n;for(;(n=r.exec(t))!==null;){let d=n[1],u=I(d,"Key"),g=I(d,"ETag");u!==null&&e.push({key:B(u),etag:g||""})}let o=[],s=/<CommonPrefixes>([\s\S]*?)<\/CommonPrefixes>/g;for(;(n=s.exec(t))!==null;){let d=n[1],u=I(d,"Prefix");u!==null&&o.push(B(u))}let a=I(t,"IsTruncated")==="true",c=I(t,"NextMarker")||"";return{contents:e,commonPrefixes:o,isTruncated:a,nextMarker:B(c)}}function I(t,e){let n=new RegExp(`<${e}>([\\s\\S]*?)<\\/${e}>`).exec(t);return n?n[1]:null}function B(t){return t.replace(/&lt;/g,"<").replace(/&gt;/g,">").replace(/&quot;/g,'"').replace(/&apos;/g,"'").replace(/&amp;/g,"&")}var ye="X-RateLimit-Reset";async function A(t,e,r=5){e.signal?.throwIfAborted?.();try{let n=await fetch(t,e);if(r>0&&(n.status===429||n.status>=500)){let o=Y(n.headers.get(ye));return await X(o,e.signal),A(t,e,r-1)}return n}catch(n){if(r===0||n instanceof DOMException&&n.name==="AbortError")throw n;let o=Y();return await X(o,e.signal),A(t,e,r-1)}}function Y(t){return t?Math.max(Number(t)*1e3-Date.now(),1e3):5e3}function X(t,e){return new Promise((r,n)=>{if(e?.aborted)return n(e.reason);let o=setTimeout(()=>{e?.removeEventListener("abort",s),r()},t),s=()=>{clearTimeout(o),n(e.reason)};e?.addEventListener("abort",s,{once:!0})})}var F="prod";var pe=300,we="https://blob-sts.edgeone.site/",E=class{authToken;projectId;cached=null;constructor(e,r){this.authToken=e,this.projectId=r}async getCredential(){if(this.cached&&!this.isExpired(this.cached))return this.cached;let e=await this.fetchCredential();return this.cached=e,e}clearCache(){this.cached=null}isExpired(e){let r=Math.floor(Date.now()/1e3);return e.expiredTime-r<pe}async fetchCredential(){for(let r=1;r<=3;r++){let n=await A(we,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.authToken}`,"X-Env":F},body:JSON.stringify(this.projectId?{ProjectId:this.projectId}:{})});if(n.status===413)throw new h("storage quota exceeded");if(n.status===429)throw new h("rate limited, please retry later");if(!n.ok){let i=await n.text().catch(()=>"unknown error");throw new h(`failed to obtain STS credential: ${n.status} ${i}`)}let o=await n.json(),s=o.data&&typeof o.data=="object"?o.data:o;if(s.tmpSecretId&&s.tmpSecretKey&&s.sessionToken&&s.expiredTime){let i=s.cosMainland,a=s.cosOverseas,c=n.headers.get("X-Edge-Region")||void 0;return{tmpSecretId:s.tmpSecretId,tmpSecretKey:s.tmpSecretKey,sessionToken:s.sessionToken,expiredTime:s.expiredTime,appId:s.appId||void 0,zoneId:s.zoneId||void 0,projectId:s.projectId||void 0,resourcePrefix:s.resourcePrefix||void 0,cosMainland:i||void 0,cosOverseas:a||void 0,edgeRegion:c}}if(s.code!==void 0&&s.code!==0){let i=s.msg||s.message||"unknown error";throw new h(`credential exchange failed (code=${s.code}): ${i}`)}if(o.code!==void 0&&o.code!==0){let i=o.msg||o.message||"unknown error";throw new h(`credential exchange failed (code=${o.code}): ${i}`)}if(r<3){await Ce(1e3*r);continue}throw new h("invalid STS credential response")}throw new h("invalid STS credential response")}};function Ce(t){return new Promise(e=>setTimeout(e,t))}var xe="{{PAGES_BLOB_DEPLOY_CREDENTIAL}}";function W(){let t=be();if(t)return{deployCredential:t};let e=Se("PAGES_BLOB_DEPLOY_CREDENTIAL");return e?{deployCredential:e}:{}}function be(){let t=xe;if(!(t.startsWith("{{")&&t.endsWith("}}")))return t||void 0}function Se(t){if(typeof process<"u"&&process.env)return process.env[t]}function Te(t){let e=typeof t=="string"?t:t.name;$(e);let r=G(typeof t=="string"?void 0:t),n=new E(r.authToken,r.projectId),o=new k(n);return new x(o,e,r.consistency??"eventual")}async function Ie(t){let e=G(t?{name:"__list__",projectId:t.projectId,token:t.token,consistency:t.consistency}:void 0),r=new E(e.authToken,e.projectId);return{stores:(await new k(r).listStores(e.consistency)).map(s=>({name:s}))}}function G(t){if(t?.token){if(!t.projectId)throw new C;return{authToken:t.token,projectId:t.projectId,consistency:t.consistency}}if(t?.projectId&&!t.token)throw new S(["token"]);let e=W();if(!e.deployCredential)throw new S(["deployCredential"]);return{authToken:e.deployCredential,consistency:t?.consistency}}0&&(module.exports={InvalidKeyError,InvalidStoreNameError,MissingProjectIdError,PagesBlobError,PreconditionFailedError,QuotaExceededError,RateLimitedError,Store,getStore,listStores});

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@edgeone/pages-blob",
+  "version": "0.0.1",
+  "description": "Blob storage SDK for EdgeOne Pages functions",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsup && cp src/public-types.d.ts dist/index.d.ts",
+    "dev": "tsup --watch",
+    "test": "npm run build && cd __tests__/npm-install-test && npm install && npm test",
+    "typecheck": "tsc --noEmit",
+    "prepack": "npm run clean && npm run build && npm run typecheck"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "license": "MIT"
+}