@brydio/manifest 0.1.0-alpha.59 → 0.1.0-alpha.61

package/src/schema.d.ts

@@ -112,8 +112,8 @@ declare const extensionShape: {
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
             small: "small";
-            medium: "medium";
             large: "large";
+            medium: "medium";
         }>>>;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
@@ -185,6 +185,10 @@ declare const extensionShape: {
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         entry: z.ZodString;
+        kind: z.ZodOptional<z.ZodEnum<{
+            tree: "tree";
+            frame: "frame";
+        }>>;
     }, z.core.$strip>>>;
     grants: z.ZodOptional<z.ZodObject<{
         tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -249,6 +253,13 @@ declare const extensionShape: {
      * still loads; `POST /apps/publish` requires it and checks it (A5-F04-S03).
      */
     sdk: z.ZodOptional<z.ZodString>;
+    /**
+     * The app's own colours and shape (PB21): an accent, named colours each
+     * with a light and a dark value, a rounding and a density. No font: every
+     * app uses Brydio's. Checked by `themeProblems` (`look.ts`), Brydio's one
+     * rule set, copied.
+     */
+    theme: z.ZodOptional<z.ZodUnknown>;
 };
 /** One problem with an app's additions, named down to the field. */
 export interface DataProblem {
@@ -301,8 +312,8 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
             small: "small";
-            medium: "medium";
             large: "large";
+            medium: "medium";
         }>>>;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
@@ -374,6 +385,10 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         entry: z.ZodString;
+        kind: z.ZodOptional<z.ZodEnum<{
+            tree: "tree";
+            frame: "frame";
+        }>>;
     }, z.core.$strip>>>;
     grants: z.ZodOptional<z.ZodObject<{
         tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -421,6 +436,7 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
         }, z.core.$strip>], "op">>;
     }, z.core.$strip>>>;
     sdk: z.ZodOptional<z.ZodString>;
+    theme: z.ZodOptional<z.ZodUnknown>;
 }, z.core.$strip>;
 /**
  * The additions as code reads a manifest that was checked whole when it was
@@ -443,8 +459,8 @@ export declare const storedExtensionsSchema: z.ZodObject<{
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
             small: "small";
-            medium: "medium";
             large: "large";
+            medium: "medium";
         }>>>;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
@@ -516,6 +532,10 @@ export declare const storedExtensionsSchema: z.ZodObject<{
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         entry: z.ZodString;
+        kind: z.ZodOptional<z.ZodEnum<{
+            tree: "tree";
+            frame: "frame";
+        }>>;
     }, z.core.$strip>>>;
     grants: z.ZodOptional<z.ZodObject<{
         tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -563,6 +583,7 @@ export declare const storedExtensionsSchema: z.ZodObject<{
         }, z.core.$strip>], "op">>;
     }, z.core.$strip>>>;
     sdk: z.ZodOptional<z.ZodString>;
+    theme: z.ZodOptional<z.ZodUnknown>;
 }, z.core.$strip>;
 /** E5's manifest with the additions: the whole `.brydio/app.json` of an app. */
 export declare const appManifestSchema: z.ZodObject<{
@@ -620,8 +641,8 @@ export declare const appManifestSchema: z.ZodObject<{
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
             small: "small";
-            medium: "medium";
             large: "large";
+            medium: "medium";
         }>>>;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
@@ -693,6 +714,10 @@ export declare const appManifestSchema: z.ZodObject<{
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         entry: z.ZodString;
+        kind: z.ZodOptional<z.ZodEnum<{
+            tree: "tree";
+            frame: "frame";
+        }>>;
     }, z.core.$strip>>>;
     grants: z.ZodOptional<z.ZodObject<{
         tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -740,6 +765,7 @@ export declare const appManifestSchema: z.ZodObject<{
         }, z.core.$strip>], "op">>;
     }, z.core.$strip>>>;
     sdk: z.ZodOptional<z.ZodString>;
+    theme: z.ZodOptional<z.ZodUnknown>;
 }, z.core.$strip>;
 /**
  * A manifest being written now, as `brydio validate`, `build` and `dev` read
@@ -801,8 +827,8 @@ export declare const newAppManifestSchema: z.ZodObject<{
         screen: z.ZodString;
         sizes: z.ZodOptional<z.ZodArray<z.ZodEnum<{
             small: "small";
-            medium: "medium";
             large: "large";
+            medium: "medium";
         }>>>;
         label: z.ZodOptional<z.ZodString>;
         icon: z.ZodOptional<z.ZodString>;
@@ -874,6 +900,10 @@ export declare const newAppManifestSchema: z.ZodObject<{
     }, z.core.$strip>>;
     screens: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         entry: z.ZodString;
+        kind: z.ZodOptional<z.ZodEnum<{
+            tree: "tree";
+            frame: "frame";
+        }>>;
     }, z.core.$strip>>>;
     grants: z.ZodOptional<z.ZodObject<{
         tools: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -921,6 +951,7 @@ export declare const newAppManifestSchema: z.ZodObject<{
         }, z.core.$strip>], "op">>;
     }, z.core.$strip>>>;
     sdk: z.ZodOptional<z.ZodString>;
+    theme: z.ZodOptional<z.ZodUnknown>;
 }, z.core.$strip>;
 export type ManifestExtensions = z.infer<typeof manifestExtensionsSchema>;
 export type AppManifestWithData = z.infer<typeof appManifestSchema>;

package/src/schema.js

@@ -1,6 +1,8 @@
 import { z } from 'zod';
 import { MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema as manifestSchema } from "./base.js";
 import { COLLECTION_NAME, FIELD_LIMITS, FIELD_NAME, FieldTypeInvalid, isSearchable, isSortable, isStructured, parseFieldType, RESERVED_FIELDS, } from "./field-types.js";
+import { themeProblems } from "./look.js";
+import { SCREEN_KINDS } from "./screen-kinds.js";
 import { migrationsSchema } from "./migrations.js";
 import { openSchemaProblems } from "./open-schema.js";
 import { confirmEmailProblems, confirmEmailSchema } from "./confirm-email.js";
@@ -162,17 +164,34 @@ const collectionSchema = z.object({
     /** One of its string[] fields: the user ids who alone may change a record, when it names any (DW06). */
     editors: editorsSchema.optional(),
 });
-const screenSchema = z.object({
+const screenSchema = z
+    .object({
     /**
      * Relative to the bundle's root: `screens/board.js` or `screens/board.mjs`.
      * The server's schema said `.js` only while its store and the mount took
-     * `.mjs` too; the schema gives (E1 and Hodler, 16 Sep 14:04 and 14:12).
+     * `.mjs` too; the schema gives (E1 and Hodler, 16 Sep 14:04 and 14:12). A
+     * frame screen's entry is its page, `screens/settings.html` (PB27).
      */
     entry: z
         .string()
         .min(1)
         .max(200)
-        .regex(/^(?!\/)(?!.*\.\.)[A-Za-z0-9_\-./]+\.m?js$/, 'An entry is a .js or .mjs path inside the bundle.'),
+        .regex(/^(?!\/)(?!.*\.\.)[A-Za-z0-9_\-./]+\.(?:m?js|html)$/, 'An entry is a .js or .mjs path inside the bundle, or an .html page for a frame screen.'),
+    /** `tree` (the default): drawn by Brydio from the app's elements. `frame`: the app's own HTML and CSS (PB27). */
+    kind: z.enum(SCREEN_KINDS).optional(),
+})
+    .superRefine((screen, ctx) => {
+    const page = screen.entry.endsWith('.html');
+    if ((screen.kind === 'frame') !== page) {
+        ctx.addIssue({
+            code: 'custom',
+            path: ['entry'],
+            message: screen.kind === 'frame'
+                ? 'A frame screen’s entry is an .html page inside the bundle.'
+                : 'An .html entry is a frame screen: give the screen "kind": "frame".',
+            params: { code: 'screen_kind_entry' },
+        });
+    }
 });
 /** Most custom tools one app may declare (A3-F08). */
 export const MAX_CUSTOM_TOOLS = 100;
@@ -270,6 +289,13 @@ const extensionShape = {
      * still loads; `POST /apps/publish` requires it and checks it (A5-F04-S03).
      */
     sdk: z.string().max(MANIFEST_LIMITS.versionChars).regex(SEMVER_FORMAT).optional(),
+    /**
+     * The app's own colours and shape (PB21): an accent, named colours each
+     * with a light and a dark value, a rounding and a density. No font: every
+     * app uses Brydio's. Checked by `themeProblems` (`look.ts`), Brydio's one
+     * rule set, copied.
+     */
+    theme: z.unknown().optional(),
 };
 export function dataProblems(additions, options = {}) {
     const problems = [];
@@ -706,6 +732,9 @@ function secretProblems(additions, options) {
     return problems;
 }
 const refuse = (additions, ctx, options = {}) => {
+    for (const problem of themeProblems(additions.theme)) {
+        ctx.addIssue({ code: 'custom', message: problem.message, path: problem.path.split('.'), params: { code: problem.code } });
+    }
     for (const problem of dataProblems(additions, options)) {
         ctx.addIssue({
             code: 'custom',

package/src/screen-kinds.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The two kinds of screen (`tasks/app-publishing` PB27). A copy of Brydio's
+ * `apps/api/src/apps/manifest/screen-kinds.ts`.
+ *
+ * A **tree screen** is the app's elements, drawn by Brydio (PB21 to PB24). A
+ * **frame screen** is the app's own HTML and CSS, drawn in a sandboxed frame
+ * on an origin that holds only app code. The manifest says which, per screen:
+ * `{ "kind": "frame", "entry": "screens/settings.html" }`. Left out, a screen
+ * is a tree screen, so every manifest from before keeps its meaning.
+ */
+export declare const SCREEN_KINDS: readonly ["tree", "frame"];
+export type ScreenKind = (typeof SCREEN_KINDS)[number];
+/** Which kind one of the manifest's screens is; `tree` when it says nothing. */
+export declare function screenKindOf(manifest: unknown, screen: string): ScreenKind;
+/** The manifest's screens of one kind, by name. */
+export declare function screensOfKind(manifest: unknown, kind: ScreenKind): string[];
+/** Every frame screen's page, by its path inside the bundle. */
+export declare function framePagesOf(manifest: unknown): Set<string>;

package/src/screen-kinds.js

@@ -0,0 +1,30 @@
+/**
+ * The two kinds of screen (`tasks/app-publishing` PB27). A copy of Brydio's
+ * `apps/api/src/apps/manifest/screen-kinds.ts`.
+ *
+ * A **tree screen** is the app's elements, drawn by Brydio (PB21 to PB24). A
+ * **frame screen** is the app's own HTML and CSS, drawn in a sandboxed frame
+ * on an origin that holds only app code. The manifest says which, per screen:
+ * `{ "kind": "frame", "entry": "screens/settings.html" }`. Left out, a screen
+ * is a tree screen, so every manifest from before keeps its meaning.
+ */
+export const SCREEN_KINDS = ['tree', 'frame'];
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+/** Which kind one of the manifest's screens is; `tree` when it says nothing. */
+export function screenKindOf(manifest, screen) {
+    const screens = isRecord(manifest) && isRecord(manifest.screens) ? manifest.screens : {};
+    const declared = Object.prototype.hasOwnProperty.call(screens, screen) ? screens[screen] : undefined;
+    return isRecord(declared) && declared.kind === 'frame' ? 'frame' : 'tree';
+}
+/** The manifest's screens of one kind, by name. */
+export function screensOfKind(manifest, kind) {
+    const screens = isRecord(manifest) && isRecord(manifest.screens) ? manifest.screens : {};
+    return Object.keys(screens).filter(screen => screenKindOf(manifest, screen) === kind);
+}
+/** Every frame screen's page, by its path inside the bundle. */
+export function framePagesOf(manifest) {
+    const screens = isRecord(manifest) && isRecord(manifest.screens) ? manifest.screens : {};
+    return new Set(screensOfKind(manifest, 'frame')
+        .map(screen => screens[screen].entry)
+        .filter((entry) => typeof entry === 'string'));
+}

package/src/validate.d.ts

@@ -1,3 +1,4 @@
+import type { LookProblemCode } from './look.js';
 import { type AppManifestWithData, type DataProblemCode } from './schema.js';
 /**
  * Reading a manifest and saying what is wrong with it, the way Brydio would.
@@ -9,7 +10,9 @@ import { type AppManifestWithData, type DataProblemCode } from './schema.js';
  * `manifest_invalid` with the path to it, so an app's builder can find the
  * line.
  */
-export type ManifestProblemCode = DataProblemCode | 'manifest_not_json' | 'manifest_invalid';
+export type ManifestProblemCode = DataProblemCode | LookProblemCode
+/** A frame screen without an .html page, or an .html entry that isn't a frame screen (PB27). */
+ | 'screen_kind_entry' | 'manifest_not_json' | 'manifest_invalid';
 export interface ManifestProblem {
     code: ManifestProblemCode;
     message: string;