tands 0.1.0 → 0.3.0

package/README.md

@@ -13,6 +13,8 @@ npx tands dev                      # a local workspace for it, on http://localho
 - **`tands check [manifest]`** checks a manifest (a file, or its address) as a workspace would.
 - **`tands dev [manifest address]`** stands in for a workspace: your tab as someone you choose,
   real tokens signed with its own keys, your data in memory, your events and your actions.
+- **`tands publish [--changes "…"]`** sends a new version of your listed app to the marketplace
+  for review, with a publishing key from its workspace (`TANDS_URL`, `TANDS_PUBLISH_KEY`).
 
 For your own build, the SDK is [`@tabs-and-spaces/sdk`](https://www.npmjs.com/package/@tabs-and-spaces/sdk).
 

package/dist/sdk/tands-sdk-server.js

@@ -1,3 +1,11 @@
+// ../sdk/src/protocol.ts
+var isHome = (context) => Boolean(context.home);
+function withReadOnly(context) {
+  const workspace = context.workspace;
+  if (!workspace || typeof workspace.readOnly === "boolean") return context;
+  return { ...context, workspace: { ...workspace, readOnly: false } };
+}
+
 // ../sdk/src/server.ts
 var TokenError = class extends Error {
 };
@@ -55,7 +63,7 @@ async function verifyToken(token, {
     throw new TokenError("It has expired.");
   }
   return {
-    context: payload.ctx,
+    context: withReadOnly(payload.ctx),
     issuer: String(payload.iss),
     expiresAt: new Date(payload.exp * 1e3),
     action: typeof payload.act === "string" ? payload.act : null
@@ -121,6 +129,20 @@ function dataClient({ dataKey, dataUrl }, fetcher = fetch) {
     }
   };
 }
+async function reportEvent({ key, eventsUrl }, name, fields = {}, fetcher = fetch) {
+  const response = await fetcher(eventsUrl, {
+    method: "POST",
+    headers: { "content-type": "application/json", authorization: `Bearer ${key}` },
+    body: JSON.stringify({ name, data: fields })
+  });
+  if (!response.ok) {
+    const body = await response.json().catch(() => null);
+    throw new DataError(
+      body?.error?.message ?? `It answered ${response.status}.`,
+      body?.error?.code ?? null
+    );
+  }
+}
 var DataError = class extends Error {
   constructor(message, code) {
     super(message);
@@ -133,5 +155,7 @@ export {
   TokenError,
   dataClient,
   fetchKeys,
+  isHome,
+  reportEvent,
   verifyToken
 };

package/dist/sdk/tands-sdk.js

@@ -1,5 +1,6 @@
 // ../sdk/src/protocol.ts
 var PROTOCOL_VERSION = 1;
+var isHome = (context) => Boolean(context.home);
 var isRecord = (value) => typeof value === "object" && value !== null;
 function readAppMessage(data) {
   if (!isRecord(data) || data.tands !== PROTOCOL_VERSION) return null;
@@ -10,6 +11,27 @@ function readAppMessage(data) {
   if (data.type === "data" && typeof data.id === "string" && data.id.length <= 64 && isRecord(data.request) && typeof data.request.op === "string") {
     return { tands: 1, type: "data", id: data.id, request: data.request };
   }
+  if (data.type === "eventKey" && typeof data.id === "string" && data.id.length <= 64) {
+    return { tands: 1, type: "eventKey", id: data.id };
+  }
+  if (data.type === "openTrigger" && typeof data.id === "string" && data.id.length <= 64 && (data.event === void 0 || data.event === null || typeof data.event === "string" && data.event.length <= 40)) {
+    return {
+      tands: 1,
+      type: "openTrigger",
+      id: data.id,
+      event: typeof data.event === "string" ? data.event : null
+    };
+  }
+  const id = (value) => typeof value === "string" && value.length > 0 && value.length <= 64;
+  if (data.type === "open" && id(data.id) && id(data.space) && (data.tab === void 0 || data.tab === null || id(data.tab))) {
+    return {
+      tands: 1,
+      type: "open",
+      id: data.id,
+      space: data.space,
+      tab: typeof data.tab === "string" ? data.tab : null
+    };
+  }
   if (data.type === "event" && typeof data.id === "string" && data.id.length <= 64 && typeof data.name === "string" && data.name.length <= 40 && (data.data === void 0 || isRecord(data.data))) {
     return {
       tands: 1,
@@ -21,6 +43,11 @@ function readAppMessage(data) {
   }
   return null;
 }
+function withReadOnly(context) {
+  const workspace = context.workspace;
+  if (!workspace || typeof workspace.readOnly === "boolean") return context;
+  return { ...context, workspace: { ...workspace, readOnly: false } };
+}
 function readHostMessage(data) {
   if (!isRecord(data) || data.tands !== PROTOCOL_VERSION) return null;
   const theme = data.theme === "dark" ? "dark" : "light";
@@ -29,7 +56,7 @@ function readHostMessage(data) {
       return isRecord(data.context) && typeof data.token === "string" && typeof data.expiresAt === "string" ? {
         tands: 1,
         type: "context",
-        context: data.context,
+        context: withReadOnly(data.context),
         token: data.token,
         expiresAt: data.expiresAt,
         theme
@@ -48,6 +75,8 @@ function readHostMessage(data) {
       } : null;
     case "theme":
       return { tands: 1, type: "theme", theme };
+    case "readOnly":
+      return typeof data.readOnly === "boolean" ? { tands: 1, type: "readOnly", readOnly: data.readOnly } : null;
     default:
       return null;
   }
@@ -75,6 +104,7 @@ function connect({ timeoutMs = 1e4, window: win = window } = {}) {
     let theme = "light";
     let counter = 0;
     const themeListeners = /* @__PURE__ */ new Set();
+    const readOnlyListeners = /* @__PURE__ */ new Set();
     const waiting = /* @__PURE__ */ new Map();
     let pending = null;
     const send = (message) => parent.postMessage(message, hostOrigin ?? "*");
@@ -119,6 +149,11 @@ function connect({ timeoutMs = 1e4, window: win = window } = {}) {
           waiter.reject(new WorkspaceError(message.message, message.code ?? null));
           return;
         }
+        case "readOnly":
+          if (!context || context.workspace.readOnly === message.readOnly) return;
+          context = { ...context, workspace: { ...context.workspace, readOnly: message.readOnly } };
+          for (const listener of readOnlyListeners) listener(message.readOnly);
+          return;
         case "theme":
           theme = message.theme;
           for (const listener of themeListeners) listener(theme);
@@ -137,6 +172,9 @@ function connect({ timeoutMs = 1e4, window: win = window } = {}) {
       get context() {
         return context;
       },
+      get readOnly() {
+        return context.workspace.readOnly;
+      },
       get theme() {
         return theme;
       },
@@ -155,6 +193,19 @@ function connect({ timeoutMs = 1e4, window: win = window } = {}) {
       async emit(name, fields = {}) {
         await ask((id) => ({ tands: 1, type: "event", id, name, data: fields }));
       },
+      requestEventKey: () => ask((id) => ({ tands: 1, type: "eventKey", id })),
+      async open(target) {
+        await ask((id) => ({
+          tands: 1,
+          type: "open",
+          id,
+          space: target.space,
+          tab: target.tab ?? null
+        }));
+      },
+      async openTrigger(event) {
+        await ask((id) => ({ tands: 1, type: "openTrigger", id, event: event ?? null }));
+      },
       values(scope) {
         return {
           get: async (key) => (await data({ op: "values.get", scope, key })).value,
@@ -180,6 +231,10 @@ function connect({ timeoutMs = 1e4, window: win = window } = {}) {
           }
         };
       },
+      onReadOnly(listener) {
+        readOnlyListeners.add(listener);
+        return () => readOnlyListeners.delete(listener);
+      },
       onTheme(listener) {
         themeListeners.add(listener);
         return () => themeListeners.delete(listener);
@@ -198,6 +253,7 @@ export {
   PROTOCOL_VERSION,
   WorkspaceError,
   connect,
+  isHome,
   readAppMessage,
   readHostMessage
 };