@awsmbiz/inbis-cloudflare 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,20 @@
-# Temporary Holding Version
+# @awsmbiz/inbis-cloudflare
 
-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.
+Typed helpers for reading a Worker's `env`. Packages never read bindings by global name;
+the app passes the `env` it was given per request.
+
+```ts
+import { requireBinding, requireSecret, requireVar } from "@awsmbiz/inbis-cloudflare";
+
+const db = requireBinding(env, "DB");               // D1Database (non-null)
+const secret = requireSecret(env, "AUTH_SECRET");   // set with `wrangler secret put`
+const origins = requireVar(env, "TRUSTED_ORIGINS"); // `vars` in wrangler.jsonc
+```
+
+Names are checked against the `Env` type (generate it with `wrangler types`).
+`requireSecret` and `requireVar` only accept keys whose type is a string.
+
+When a binding is missing, or a secret or variable is missing or blank, the helpers throw
+an `AppError` with `500 CONFIGURATION_ERROR` and the message "The server is
+misconfigured.". The binding name appears only in the error's `cause`, which is logged
+but never returned, and secret values are never included.

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+type StringKeys<E> = { [K in keyof E]-?: NonNullable<E[K]> extends string ? K : never; }[keyof E] & string;
+/**
+ * Returns `env[name]`, or throws a 500 `CONFIGURATION_ERROR` when the binding
+ * is missing from the Worker's configuration.
+ */
+export declare function requireBinding<E extends object, K extends keyof E & string>(env: E, name: K): NonNullable<E[K]>;
+/**
+ * Returns the Worker secret `name` (set with `wrangler secret put`), or throws
+ * a 500 `CONFIGURATION_ERROR` when it is missing or blank. The value is never
+ * included in the error.
+ */
+export declare function requireSecret<E extends object>(env: E, name: StringKeys<E>): string;
+/**
+ * Returns the plain-text Worker variable `name` (`vars` in the wrangler
+ * config), or throws a 500 `CONFIGURATION_ERROR` when it is missing or blank.
+ */
+export declare function requireVar<E extends object>(env: E, name: StringKeys<E>): string;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,42 @@
+import { AppError } from "@awsmbiz/inbis-core";
+// src/env.ts
+function misconfigured(detail) {
+	return new AppError({
+		code: "CONFIGURATION_ERROR",
+		status: 500,
+		message: "The server is misconfigured.",
+		cause: new Error(detail)
+	});
+}
+/**
+* Returns `env[name]`, or throws a 500 `CONFIGURATION_ERROR` when the binding
+* is missing from the Worker's configuration.
+*/
+function requireBinding(env, name) {
+	const value = env[name];
+	if (value === void 0 || value === null) throw misconfigured(`Missing binding: ${name}`);
+	return value;
+}
+function requireString(env, name, kind) {
+	const value = env[name];
+	if (typeof value !== "string" || value.trim() === "") throw misconfigured(`Missing or blank ${kind}: ${name}`);
+	return value;
+}
+/**
+* Returns the Worker secret `name` (set with `wrangler secret put`), or throws
+* a 500 `CONFIGURATION_ERROR` when it is missing or blank. The value is never
+* included in the error.
+*/
+function requireSecret(env, name) {
+	return requireString(env, name, "secret");
+}
+/**
+* Returns the plain-text Worker variable `name` (`vars` in the wrangler
+* config), or throws a 500 `CONFIGURATION_ERROR` when it is missing or blank.
+*/
+function requireVar(env, name) {
+	return requireString(env, name, "variable");
+}
+export { requireBinding, requireSecret, requireVar };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/env.ts"],"sourcesContent":["import { AppError } from \"@awsmbiz/inbis-core\";\n\ntype StringKeys<E> = { [K in keyof E]-?: NonNullable<E[K]> extends string ? K : never }[keyof E] &\n  string;\n\nfunction misconfigured(detail: string): AppError {\n  // The caller-facing message never names the binding; the cause is for logs only.\n  return new AppError({\n    code: \"CONFIGURATION_ERROR\",\n    status: 500,\n    message: \"The server is misconfigured.\",\n    cause: new Error(detail),\n  });\n}\n\n/**\n * Returns `env[name]`, or throws a 500 `CONFIGURATION_ERROR` when the binding\n * is missing from the Worker's configuration.\n */\nexport function requireBinding<E extends object, K extends keyof E & string>(\n  env: E,\n  name: K,\n): NonNullable<E[K]> {\n  const value = env[name];\n  if (value === undefined || value === null) {\n    throw misconfigured(`Missing binding: ${name}`);\n  }\n  return value;\n}\n\nfunction requireString<E extends object>(env: E, name: StringKeys<E>, kind: string): string {\n  const value: unknown = env[name];\n  if (typeof value !== \"string\" || value.trim() === \"\") {\n    throw misconfigured(`Missing or blank ${kind}: ${name}`);\n  }\n  return value;\n}\n\n/**\n * Returns the Worker secret `name` (set with `wrangler secret put`), or throws\n * a 500 `CONFIGURATION_ERROR` when it is missing or blank. The value is never\n * included in the error.\n */\nexport function requireSecret<E extends object>(env: E, name: StringKeys<E>): string {\n  return requireString(env, name, \"secret\");\n}\n\n/**\n * Returns the plain-text Worker variable `name` (`vars` in the wrangler\n * config), or throws a 500 `CONFIGURATION_ERROR` when it is missing or blank.\n */\nexport function requireVar<E extends object>(env: E, name: StringKeys<E>): string {\n  return requireString(env, name, \"variable\");\n}\n"],"mappings":";;AAKA,SAAS,cAAc,QAA0B;CAE/C,OAAO,IAAI,SAAS;EAClB,MAAM;EACN,QAAQ;EACR,SAAS;EACT,OAAO,IAAI,MAAM,MAAM;CACzB,CAAC;AACH;;;;;AAMA,SAAgB,eACd,KACA,MACmB;CACnB,MAAM,QAAQ,IAAI;CAClB,IAAI,UAAU,KAAA,KAAa,UAAU,MACnC,MAAM,cAAc,oBAAoB,MAAM;CAEhD,OAAO;AACT;AAEA,SAAS,cAAgC,KAAQ,MAAqB,MAAsB;CAC1F,MAAM,QAAiB,IAAI;CAC3B,IAAI,OAAO,UAAU,YAAY,MAAM,KAAK,MAAM,IAChD,MAAM,cAAc,oBAAoB,KAAK,IAAI,MAAM;CAEzD,OAAO;AACT;;;;;;AAOA,SAAgB,cAAgC,KAAQ,MAA6B;CACnF,OAAO,cAAc,KAAK,MAAM,QAAQ;AAC1C;;;;;AAMA,SAAgB,WAA6B,KAAQ,MAA6B;CAChF,OAAO,cAAc,KAAK,MAAM,UAAU;AAC5C"}

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@awsmbiz/inbis-cloudflare",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Cloudflare Workers helpers for Inbis packages: typed access to bindings, variables and secrets.",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/awsmbiz/inbis-platform.git",
+    "directory": "packages/cloudflare"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@awsmbiz/inbis-core": "0.1.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "0.18.5",
+    "@cloudflare/vitest-plugin": "1.4.11",
+    "@cloudflare/workers-types": "5.20261030.1",
+    "@awsmbiz/inbis-eslint-config": "0.1.0",
+    "@awsmbiz/inbis-tsconfig": "0.1.0",
+    "eslint": "10.14.0",
+    "publint": "0.3.25",
+    "tsdown": "0.23.4",
+    "typescript": "6.0.3",
+    "vitest": "5.0.5"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc",
+    "lint": "eslint . --max-warnings 0",
+    "test": "vitest run",
+    "check:exports": "publint --strict && attw --pack . --profile esm-only"
+  }
 }