@clearly-hub/node 0.1.0 → 0.1.1

package/README.md

@@ -43,7 +43,8 @@ Hono, Bun or Deno. Mount it at `/clearly-hub/*`.
 **3. Add the script and a button:**
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@clearly-hub/browser/dist/clearly-hub.js"></script>
+<!-- @0.1: follows 0.1.x fixes, not a breaking 0.2 -->
+<script src="https://cdn.jsdelivr.net/npm/@clearly-hub/browser@0.1/dist/clearly-hub.js"></script>
 
 <clearly-hub-button action="sign-in"></clearly-hub-button>
 <clearly-hub-button action="DATA_PICKER"></clearly-hub-button>

package/dist/index.cjs

@@ -44,6 +44,17 @@ var SCREEN_ACTIONS = [
 function isScreenAction(value) {
   return SCREEN_ACTIONS.includes(value);
 }
+function checkScreenData(action, data) {
+  if (action !== "REGISTER_RESOURCE") return void 0;
+  const { url, format } = data ?? {};
+  if (typeof url !== "string" || !url || typeof format !== "string" || !format) {
+    return 'REGISTER_RESOURCE needs data with a url and a format, for example { url, format: "geojson" }';
+  }
+  if (!url.startsWith("https://")) {
+    return "REGISTER_RESOURCE needs a public https url: Clearly.HUB refuses other addresses";
+  }
+  return void 0;
+}
 
 // ../shared/src/protocol.ts
 var DEFAULT_BASE_PATH = "/clearly-hub";
@@ -291,6 +302,14 @@ function openScreen(url, session, { config, screens }) {
   if (!isScreenAction(action)) return errorPage(400, `Unknown screen: ${action}`);
   const display = url.searchParams.get("display") === "redirect" ? "redirect" : "popup";
   const dataParam = url.searchParams.get("data");
+  let data;
+  try {
+    data = dataParam ? JSON.parse(dataParam) : void 0;
+  } catch {
+    return errorPage(400, "The screen data is not valid JSON");
+  }
+  const dataProblem = checkScreenData(action, data);
+  if (dataProblem) return errorPage(400, dataProblem);
   const state = crypto.randomUUID();
   session.screens = pruneScreens(session.screens);
   session.screens[state] = {
@@ -300,14 +319,7 @@ function openScreen(url, session, { config, screens }) {
     returnTo: safeReturnTo(url, config),
     createdAt: Date.now()
   };
-  return redirect(
-    screens.screenUrl(
-      action,
-      state,
-      session.user?.email,
-      dataParam ? JSON.parse(dataParam) : void 0
-    )
-  );
+  return redirect(screens.screenUrl(action, state, session.user?.email, data));
 }
 async function receiveAnswer(url, session, { config, screens }) {
   const query = readRawQuery(url);

package/dist/index.d.cts

@@ -10,6 +10,7 @@ interface ScreenData {
         format: string;
     };
 }
+declare function checkScreenData(action: ScreenAction, data: unknown): string | undefined;
 interface HubRef {
     _id: string;
     name: string;
@@ -164,5 +165,5 @@ declare function clearlyHub(options: ClearlyHubOptions): {
 };
 type ClearlyHub = ReturnType<typeof clearlyHub>;
 
-export { ANSWER_CHANNEL, DEFAULT_AUTH_URL, DEFAULT_BASE_PATH, DEFAULT_HUB_URL, DEFAULT_ISSUER, ROUTES, SCREEN_ACTIONS, clearlyHub, isScreenAction };
+export { ANSWER_CHANNEL, DEFAULT_AUTH_URL, DEFAULT_BASE_PATH, DEFAULT_HUB_URL, DEFAULT_ISSUER, ROUTES, SCREEN_ACTIONS, checkScreenData, clearlyHub, isScreenAction };
 export type { AnswerMessage, AppSubscription, ClearlyHub, ClearlyHubOptions, ClearlyHubUrls, CookieSource, HubRef, HubSubscription, PickedResource, ScreenAction, ScreenAnswers, ScreenData, ScreenDisplay, ScreenResult, Session, SessionUser, SignedInPerson };

package/dist/index.d.ts

@@ -10,6 +10,7 @@ interface ScreenData {
         format: string;
     };
 }
+declare function checkScreenData(action: ScreenAction, data: unknown): string | undefined;
 interface HubRef {
     _id: string;
     name: string;
@@ -164,5 +165,5 @@ declare function clearlyHub(options: ClearlyHubOptions): {
 };
 type ClearlyHub = ReturnType<typeof clearlyHub>;
 
-export { ANSWER_CHANNEL, DEFAULT_AUTH_URL, DEFAULT_BASE_PATH, DEFAULT_HUB_URL, DEFAULT_ISSUER, ROUTES, SCREEN_ACTIONS, clearlyHub, isScreenAction };
+export { ANSWER_CHANNEL, DEFAULT_AUTH_URL, DEFAULT_BASE_PATH, DEFAULT_HUB_URL, DEFAULT_ISSUER, ROUTES, SCREEN_ACTIONS, checkScreenData, clearlyHub, isScreenAction };
 export type { AnswerMessage, AppSubscription, ClearlyHub, ClearlyHubOptions, ClearlyHubUrls, CookieSource, HubRef, HubSubscription, PickedResource, ScreenAction, ScreenAnswers, ScreenData, ScreenDisplay, ScreenResult, Session, SessionUser, SignedInPerson };

package/dist/index.js

@@ -8,6 +8,17 @@ var SCREEN_ACTIONS = [
 function isScreenAction(value) {
   return SCREEN_ACTIONS.includes(value);
 }
+function checkScreenData(action, data) {
+  if (action !== "REGISTER_RESOURCE") return void 0;
+  const { url, format } = data ?? {};
+  if (typeof url !== "string" || !url || typeof format !== "string" || !format) {
+    return 'REGISTER_RESOURCE needs data with a url and a format, for example { url, format: "geojson" }';
+  }
+  if (!url.startsWith("https://")) {
+    return "REGISTER_RESOURCE needs a public https url: Clearly.HUB refuses other addresses";
+  }
+  return void 0;
+}
 
 // ../shared/src/protocol.ts
 var DEFAULT_BASE_PATH = "/clearly-hub";
@@ -255,6 +266,14 @@ function openScreen(url, session, { config, screens }) {
   if (!isScreenAction(action)) return errorPage(400, `Unknown screen: ${action}`);
   const display = url.searchParams.get("display") === "redirect" ? "redirect" : "popup";
   const dataParam = url.searchParams.get("data");
+  let data;
+  try {
+    data = dataParam ? JSON.parse(dataParam) : void 0;
+  } catch {
+    return errorPage(400, "The screen data is not valid JSON");
+  }
+  const dataProblem = checkScreenData(action, data);
+  if (dataProblem) return errorPage(400, dataProblem);
   const state = crypto.randomUUID();
   session.screens = pruneScreens(session.screens);
   session.screens[state] = {
@@ -264,14 +283,7 @@ function openScreen(url, session, { config, screens }) {
     returnTo: safeReturnTo(url, config),
     createdAt: Date.now()
   };
-  return redirect(
-    screens.screenUrl(
-      action,
-      state,
-      session.user?.email,
-      dataParam ? JSON.parse(dataParam) : void 0
-    )
-  );
+  return redirect(screens.screenUrl(action, state, session.user?.email, data));
 }
 async function receiveAnswer(url, session, { config, screens }) {
   const query = readRawQuery(url);

package/package.json

@@ -1,10 +1,16 @@
 {
   "name": "@clearly-hub/node",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Clearly.HUB for Node servers: sign-in, hosted screens, subscriptions and usage in one handler",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Future Insight Group BV",
-  "keywords": ["clearly-hub", "oup", "open-urban-platform", "oidc", "sdk"],
+  "keywords": [
+    "clearly-hub",
+    "oup",
+    "open-urban-platform",
+    "oidc",
+    "sdk"
+  ],
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -33,7 +39,7 @@
     "openid-client": "^6.8.8"
   },
   "devDependencies": {
-    "@clearly-hub/shared": "0.1.0"
+    "@clearly-hub/shared": "*"
   },
   "engines": {
     "node": ">=20"