@cloudcrane/app-spec 0.7.1 → 0.7.2

package/dist/src/index.d.ts

@@ -8,6 +8,7 @@ export { leakProblems } from "./leak.js";
 export { CLOUDCRANE_CATALOG, CLOUDCRANE_CATALOG_ID, catalogFor, cloudcraneCatalog } from "./catalog.js";
 export { deriveBlueprint, type BlueprintV1 } from "./blueprint.js";
 export { USES, USE_NAMES, NEEDS_ORIGIN, featuresOf, type Use } from "./uses.js";
+export { DECLARABLE, PAGE_ONLY, type Declarable, type PageOnlyUse } from "./uses.page.js";
 export { pageOf, pageProblems, wrapPage, type PageApp } from "./page.js";
 export { designWarnings, statesWarnings, contrast, rgbOf, CORE_ROLES, TEXT_PAIRS, TEXT_CONTRAST } from "./design.js";
 export { memoryProblems, keptShape, type KeptType } from "./memory.js";

package/dist/src/index.js

@@ -10,6 +10,7 @@ export { leakProblems } from "./leak.js";
 export { CLOUDCRANE_CATALOG, CLOUDCRANE_CATALOG_ID, catalogFor, cloudcraneCatalog } from "./catalog.js";
 export { deriveBlueprint } from "./blueprint.js";
 export { USES, USE_NAMES, NEEDS_ORIGIN, featuresOf } from "./uses.js";
+export { DECLARABLE, PAGE_ONLY } from "./uses.page.js";
 export { pageOf, pageProblems, wrapPage } from "./page.js";
 export { designWarnings, statesWarnings, contrast, rgbOf, CORE_ROLES, TEXT_PAIRS, TEXT_CONTRAST } from "./design.js";
 export { memoryProblems, keptShape } from "./memory.js";

package/dist/src/reach.js

@@ -1,4 +1,4 @@
-import { USE_NAMES } from "./uses.js";
+import { DECLARABLE } from "./uses.page.js";
 // What it can reach, checked against the code: a coded or page component's code may name only the sites in `network`
 // and use only the device features in `uses`, so what the person is shown before the app opens is everything it does.
 // Refusals, not warnings. The same reading CloudCrane's checks give an app's code (its apps.rules.ts and
@@ -66,6 +66,7 @@ const USED_BY = {
     voice: [/\b(webkit)?SpeechRecognition\b/],
     contacts: [/\bnavigator\.contacts\b/, /\bContactsManager\b/],
     nfc: [/\bNDEF(Reader|Message|Record)\b/],
+    notifications: [/\bccRemind\b/, /\bNotification\b/, /\bPushManager\b/],
 };
 /** Features a spec can't declare, so code that uses them is refused. */
 const NOT_FOR_SPECS = [
@@ -87,7 +88,7 @@ export function reachProblems(spec) {
         if (buildsAddressAtRuntime(code))
             problems.push({ at, problem: "builds a request's address while it runs, so no one can tell which site it reaches: write each address out in full" });
         // camera and microphone share getUserMedia: either one declared covers it.
-        for (const what of USE_NAMES) {
+        for (const what of DECLARABLE) {
             if (declared.has(what) || !USED_BY[what].some((p) => p.test(code)))
                 continue;
             if ((what === "camera" || what === "microphone") && (declared.has("camera") || declared.has("microphone")))

package/dist/src/schema.d.ts

@@ -296,14 +296,14 @@ export declare const SpecSchema: z.ZodEffects<z.ZodObject<{
     }>, "many">>;
     /** The device features the app uses, by CloudCrane's names, each once with why; anything not listed is blocked. */
     uses: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        what: z.ZodEnum<["camera" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc", ...("camera" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc")[]]>;
+        what: z.ZodEnum<["camera" | "notifications" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc", ...("camera" | "notifications" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc")[]]>;
         why: z.ZodString;
     }, "strict", z.ZodTypeAny, {
         why: string;
-        what: "camera" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
+        what: "camera" | "notifications" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
     }, {
         why: string;
-        what: "camera" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
+        what: "camera" | "notifications" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
     }>, "many">>;
     /**
      * What it does: each screen in words, and what it shows when there's nothing yet, while it loads, offline, and when
@@ -566,7 +566,7 @@ export declare const SpecSchema: z.ZodEffects<z.ZodObject<{
     }[];
     uses: {
         why: string;
-        what: "camera" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
+        what: "camera" | "notifications" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
     }[];
     journeys: {
         title: string;
@@ -683,7 +683,7 @@ export declare const SpecSchema: z.ZodEffects<z.ZodObject<{
     }[] | undefined;
     uses?: {
         why: string;
-        what: "camera" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
+        what: "camera" | "notifications" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
     }[] | undefined;
     screens?: {
         id: string;
@@ -782,7 +782,7 @@ export declare const SpecSchema: z.ZodEffects<z.ZodObject<{
     }[];
     uses: {
         why: string;
-        what: "camera" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
+        what: "camera" | "notifications" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
     }[];
     journeys: {
         title: string;
@@ -899,7 +899,7 @@ export declare const SpecSchema: z.ZodEffects<z.ZodObject<{
     }[] | undefined;
     uses?: {
         why: string;
-        what: "camera" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
+        what: "camera" | "notifications" | "microphone" | "location" | "motion" | "screen-awake" | "gamepad" | "voice" | "contacts" | "nfc";
     }[] | undefined;
     screens?: {
         id: string;

package/dist/src/schema.js

@@ -1,5 +1,6 @@
 import { z } from "zod";
-import { NEEDS_ORIGIN, USE_NAMES } from "./uses.js";
+import { NEEDS_ORIGIN } from "./uses.js";
+import { DECLARABLE, PAGE_ONLY } from "./uses.page.js";
 // The CloudCrane app spec: an A2UI surface (the screens) in a small envelope for
 // what A2UI doesn't cover. Nothing in it is code from the app it came from:
 // screens are A2UI components, the look is DTCG design tokens, rules are CEL
@@ -175,8 +176,8 @@ export const SpecSchema = z
         .default([]),
     /** The device features the app uses, by CloudCrane's names, each once with why; anything not listed is blocked. */
     uses: z
-        .array(z.object({ what: z.enum(USE_NAMES), why: Text(300) }).strict())
-        .max(USE_NAMES.length)
+        .array(z.object({ what: z.enum(DECLARABLE), why: Text(300) }).strict())
+        .max(DECLARABLE.length)
         .default([]),
     /**
      * What it does: each screen in words, and what it shows when there's nothing yet, while it loads, offline, and when
@@ -245,4 +246,11 @@ export const SpecSchema = z
     const needsOrigin = s.uses.some((u) => NEEDS_ORIGIN.includes(u.what));
     if (needsOrigin && !Object.values(s.components).some((c) => c.kit === "page"))
         ctx.addIssue({ code: z.ZodIssueCode.custom, path: ["uses"], message: "the camera and microphone work only in a page-kit component" });
+    for (const u of s.uses)
+        if (PAGE_ONLY.includes(u.what) && !s.page)
+            ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                path: ["uses"],
+                message: `${u.what} works only in a page spec (an HTML app as a spec, with page set): CloudCrane gives it to the app's page, not to its screens or a coded component`,
+            });
 });

package/dist/src/uses.page.d.ts

@@ -0,0 +1,6 @@
+import { type Use } from "./uses.js";
+export declare const PAGE_ONLY: readonly ["notifications"];
+export type PageOnlyUse = (typeof PAGE_ONLY)[number];
+/** Every name `uses` can declare: the device features, then what only a page spec can. */
+export declare const DECLARABLE: [Use | PageOnlyUse, ...(Use | PageOnlyUse)[]];
+export type Declarable = (typeof DECLARABLE)[number];

package/dist/src/uses.page.js

@@ -0,0 +1,8 @@
+import { USE_NAMES } from "./uses.js";
+// What only a page spec (an HTML app as a spec) can declare: CloudCrane gives it to the app's page, never to its
+// screens or a frame. Kept out of uses.ts, which the runtime bundles (and locks by hash): none of these needs a
+// browser feature, so the runtime has nothing to do with them.
+// - notifications: reminders at a time, through CloudCrane's ccRemind.
+export const PAGE_ONLY = ["notifications"];
+/** Every name `uses` can declare: the device features, then what only a page spec can. */
+export const DECLARABLE = [...USE_NAMES, ...PAGE_ONLY];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudcrane/app-spec",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "The CloudCrane app spec: its schema, the expression language its rules are written in, and the checks that keep partner code out of it.",
   "keywords": [
     "cloudcrane",

package/schema/app-spec.v1.json

@@ -364,7 +364,8 @@
               "gamepad",
               "voice",
               "contacts",
-              "nfc"
+              "nfc",
+              "notifications"
             ]
           },
           "why": {
@@ -379,7 +380,7 @@
         ],
         "additionalProperties": false
       },
-      "maxItems": 9,
+      "maxItems": 10,
       "default": []
     },
     "screens": {