@orbit-work/block-sdk 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,33 @@
-# Temporary Holding Version
+# JSON block SDK
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@orbit-work/block-sdk` is an independent, publishable npm package with an ESM
+entry and TypeScript declarations. It has no runtime dependencies or knowledge,
+identity, UI or React behavior.
+
+```ts
+import { getBlockData } from "@orbit-work/block-sdk"
+
+const data = await getBlockData<unknown>("my-config", {
+  env: "pre", // uat | pre | prod
+  signal: controller.signal,
+  timeoutMs: 3000,
+})
+```
+
+The key is a standalone path identifier, unrelated to app IDs. Requests read
+`https://s.fzcdn1.com/cdn/h5-data/<configKey>/<env>/data.json` with anonymous GET,
+`credentials: "omit"`, `cache: "no-store"`, and no redirects. The default timeout
+is three seconds and covers the response body. There is no persistent cache or
+offline fallback. `BlockDataError.code` distinguishes `invalid-options`, `network`,
+`http` (with `status`), `timeout`, `cancelled`, and `json` failures.
+
+The generic is a TypeScript return type, not runtime validation. Each consumer
+validates its own JSON fields and handles failures.
+
+Public exports: `getBlockData`, `BlockDataError`, `BlockEnvironment`,
+`GetBlockDataOptions`, and `BlockErrorCode`. The browser and Node.js 20+ use their
+native Fetch API.
+
+Build and test with `pnpm --filter @orbit-work/block-sdk test`.
+`pnpm --filter @orbit-work/block-sdk pack` builds an installable tarball; it does
+not publish to the registry.

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+type BlockEnvironment = "uat" | "pre" | "prod";
+type GetBlockDataOptions = {
+    env: BlockEnvironment;
+    signal?: AbortSignal;
+    timeoutMs?: number;
+};
+type BlockErrorCode = "invalid-options" | "network" | "http" | "timeout" | "cancelled" | "json";
+declare class BlockDataError extends Error {
+    readonly code: BlockErrorCode;
+    readonly status?: number;
+    constructor(code: BlockErrorCode, status?: number);
+}
+/** Dora's config key identifies a block, independently of any application ID. */
+declare function getBlockData<T = unknown>(configKey: string, options: GetBlockDataOptions): Promise<T>;
+
+export { BlockDataError, type BlockEnvironment, type BlockErrorCode, type GetBlockDataOptions, getBlockData };

package/dist/index.js

@@ -0,0 +1,60 @@
+// src/index.ts
+var BlockDataError = class extends Error {
+  code;
+  status;
+  constructor(code, status) {
+    super(`Block data request failed: ${code}`);
+    this.name = "BlockDataError";
+    this.code = code;
+    this.status = status;
+  }
+};
+async function getBlockData(configKey, options) {
+  const timeoutMs = options.timeoutMs ?? 3e3;
+  if (typeof configKey !== "string" || !/^[A-Za-z0-9][A-Za-z0-9_-]*$/.test(configKey) || !["uat", "pre", "prod"].includes(options.env) || !Number.isFinite(timeoutMs) || timeoutMs <= 0)
+    throw new BlockDataError("invalid-options");
+  const controller = new AbortController();
+  let timedOut = false;
+  const cancel = () => controller.abort();
+  if (options.signal?.aborted) throw new BlockDataError("cancelled");
+  options.signal?.addEventListener("abort", cancel, { once: true });
+  const timer = setTimeout(() => {
+    timedOut = true;
+    controller.abort();
+  }, timeoutMs);
+  try {
+    let response;
+    try {
+      response = await fetch(`https://s.fzcdn1.com/cdn/h5-data/${configKey}/${options.env}/data.json`, {
+        method: "GET",
+        credentials: "omit",
+        cache: "no-store",
+        redirect: "error",
+        referrerPolicy: "no-referrer",
+        signal: controller.signal
+      });
+    } catch {
+      throw new BlockDataError("network");
+    }
+    if (!response.ok) throw new BlockDataError("http", response.status);
+    try {
+      const data = await response.json();
+      if (controller.signal.aborted) throw new BlockDataError("cancelled");
+      return data;
+    } catch {
+      throw new BlockDataError("json");
+    }
+  } catch (error) {
+    if (options.signal?.aborted) throw new BlockDataError("cancelled");
+    if (timedOut) throw new BlockDataError("timeout");
+    throw error instanceof BlockDataError ? error : new BlockDataError("network");
+  } finally {
+    clearTimeout(timer);
+    options.signal?.removeEventListener("abort", cancel);
+  }
+}
+export {
+  BlockDataError,
+  getBlockData
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type BlockEnvironment = \"uat\" | \"pre\" | \"prod\"\n\nexport type GetBlockDataOptions = { env: BlockEnvironment; signal?: AbortSignal; timeoutMs?: number }\n\nexport type BlockErrorCode = \"invalid-options\" | \"network\" | \"http\" | \"timeout\" | \"cancelled\" | \"json\"\n\nexport class BlockDataError extends Error {\n  readonly code: BlockErrorCode\n  readonly status?: number\n  constructor(code: BlockErrorCode, status?: number) {\n    super(`Block data request failed: ${code}`)\n    this.name = \"BlockDataError\"\n    this.code = code\n    this.status = status\n  }\n}\n\n/** Dora's config key identifies a block, independently of any application ID. */\nexport async function getBlockData<T = unknown>(configKey: string, options: GetBlockDataOptions): Promise<T> {\n  const timeoutMs = options.timeoutMs ?? 3000\n  if (\n    typeof configKey !== \"string\" ||\n    !/^[A-Za-z0-9][A-Za-z0-9_-]*$/.test(configKey) ||\n    ![\"uat\", \"pre\", \"prod\"].includes(options.env) ||\n    !Number.isFinite(timeoutMs) ||\n    timeoutMs <= 0\n  )\n    throw new BlockDataError(\"invalid-options\")\n\n  const controller = new AbortController()\n  let timedOut = false\n  const cancel = () => controller.abort()\n  if (options.signal?.aborted) throw new BlockDataError(\"cancelled\")\n  options.signal?.addEventListener(\"abort\", cancel, { once: true })\n  const timer = setTimeout(() => {\n    timedOut = true\n    controller.abort()\n  }, timeoutMs)\n  try {\n    let response: Response\n    try {\n      response = await fetch(`https://s.fzcdn1.com/cdn/h5-data/${configKey}/${options.env}/data.json`, {\n        method: \"GET\",\n        credentials: \"omit\",\n        cache: \"no-store\",\n        redirect: \"error\",\n        referrerPolicy: \"no-referrer\",\n        signal: controller.signal,\n      })\n    } catch {\n      throw new BlockDataError(\"network\")\n    }\n    if (!response.ok) throw new BlockDataError(\"http\", response.status)\n    try {\n      const data = (await response.json()) as T\n      if (controller.signal.aborted) throw new BlockDataError(\"cancelled\")\n      return data\n    } catch {\n      throw new BlockDataError(\"json\")\n    }\n  } catch (error) {\n    if (options.signal?.aborted) throw new BlockDataError(\"cancelled\")\n    if (timedOut) throw new BlockDataError(\"timeout\")\n    throw error instanceof BlockDataError ? error : new BlockDataError(\"network\")\n  } finally {\n    clearTimeout(timer)\n    options.signal?.removeEventListener(\"abort\", cancel)\n  }\n}\n"],"mappings":";AAMO,IAAM,iBAAN,cAA6B,MAAM;AAAA,EAC/B;AAAA,EACA;AAAA,EACT,YAAY,MAAsB,QAAiB;AACjD,UAAM,8BAA8B,IAAI,EAAE;AAC1C,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,SAAS;AAAA,EAChB;AACF;AAGA,eAAsB,aAA0B,WAAmB,SAA0C;AAC3G,QAAM,YAAY,QAAQ,aAAa;AACvC,MACE,OAAO,cAAc,YACrB,CAAC,8BAA8B,KAAK,SAAS,KAC7C,CAAC,CAAC,OAAO,OAAO,MAAM,EAAE,SAAS,QAAQ,GAAG,KAC5C,CAAC,OAAO,SAAS,SAAS,KAC1B,aAAa;AAEb,UAAM,IAAI,eAAe,iBAAiB;AAE5C,QAAM,aAAa,IAAI,gBAAgB;AACvC,MAAI,WAAW;AACf,QAAM,SAAS,MAAM,WAAW,MAAM;AACtC,MAAI,QAAQ,QAAQ,QAAS,OAAM,IAAI,eAAe,WAAW;AACjE,UAAQ,QAAQ,iBAAiB,SAAS,QAAQ,EAAE,MAAM,KAAK,CAAC;AAChE,QAAM,QAAQ,WAAW,MAAM;AAC7B,eAAW;AACX,eAAW,MAAM;AAAA,EACnB,GAAG,SAAS;AACZ,MAAI;AACF,QAAI;AACJ,QAAI;AACF,iBAAW,MAAM,MAAM,oCAAoC,SAAS,IAAI,QAAQ,GAAG,cAAc;AAAA,QAC/F,QAAQ;AAAA,QACR,aAAa;AAAA,QACb,OAAO;AAAA,QACP,UAAU;AAAA,QACV,gBAAgB;AAAA,QAChB,QAAQ,WAAW;AAAA,MACrB,CAAC;AAAA,IACH,QAAQ;AACN,YAAM,IAAI,eAAe,SAAS;AAAA,IACpC;AACA,QAAI,CAAC,SAAS,GAAI,OAAM,IAAI,eAAe,QAAQ,SAAS,MAAM;AAClE,QAAI;AACF,YAAM,OAAQ,MAAM,SAAS,KAAK;AAClC,UAAI,WAAW,OAAO,QAAS,OAAM,IAAI,eAAe,WAAW;AACnE,aAAO;AAAA,IACT,QAAQ;AACN,YAAM,IAAI,eAAe,MAAM;AAAA,IACjC;AAAA,EACF,SAAS,OAAO;AACd,QAAI,QAAQ,QAAQ,QAAS,OAAM,IAAI,eAAe,WAAW;AACjE,QAAI,SAAU,OAAM,IAAI,eAAe,SAAS;AAChD,UAAM,iBAAiB,iBAAiB,QAAQ,IAAI,eAAe,SAAS;AAAA,EAC9E,UAAE;AACA,iBAAa,KAAK;AAClB,YAAQ,QAAQ,oBAAoB,SAAS,MAAM;AAAA,EACrD;AACF;","names":[]}

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "@orbit-work/block-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Anonymous JSON block client for CDN-published Dora data.",
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "prepack": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "test": "pnpm run build && node --test \"src/**/*.test.mjs\""
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.6.3"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}