@brydio/manifest 0.1.0-alpha.7 → 0.1.0-alpha.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brydio/manifest",
-  "version": "0.1.0-alpha.7",
+  "version": "0.1.0-alpha.9",
   "description": "The shape of a Brydio app's manifest, its collections' schemas, and the checks that say what is wrong with one.",
   "type": "module",
   "license": "MIT",
@@ -10,7 +10,7 @@
     "url": "https://github.com/nakel-ola/brydio-sdk",
     "directory": "packages/manifest"
   },
-  "gitHead": "0df91ca1c2a40d63ffcb0cad08f5f4b3278064f3",
+  "gitHead": "9d77a54e497543ae7b921cf86551c171cbeb0352",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/index.d.ts

@@ -7,7 +7,7 @@ export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema, br
 export { BRAND_FIELDS, BRAND_LIMITS, brandFilePath, brandPathsOf, brandProblems, brandShapeOf, isBrandPath, pngVerdict, svgColours, toolsProblem, type BrandField, type RequirementCode, type RequirementFiles, type RequirementProblem, } from './requirements.js';
 export { BUNDLE_MANIFEST, BUNDLE_MAX_BYTES, BUNDLE_PATH_MAX_CHARS, bundleBytes, bundleHash, brandOf, bundleProblem, codeOf, isBundlePath, isScriptPath, sizeOf, type BundleFiles, type BundleProblem, type BundleProblemCode, } from './bundle.js';
 export { COLOUR_TOKENS, FIELD_LIMITS, RESERVED_FIELDS, describeType, isSearchable, isSortable, isStructured, parseFieldType, structuredFields, valueProblem, valueSchema, FieldTypeInvalid, type DocumentOf, type FieldKind, type FieldType, type FieldValue, type FieldsOf, } from './field-types.js';
-export { appManifestSchema, collectionOf, collectionsOf, dataProblems, labelOf, manifestExtensionsSchema, MAX_APP_SECRETS, MAX_SECRET_CHARS, SECRET_NAME, storedExtensionsSchema, type AppManifestWithData, type CollectionSpec, type DataProblem, type DataProblemCode, type ManifestExtensions, type SecretSpec, } from './schema.js';
+export { appManifestSchema, collectionOf, collectionsOf, dataProblems, effectivePlacementKey, labelOf, manifestExtensionsSchema, MAX_APP_SECRETS, MAX_SECRET_CHARS, PLACEMENT_KEY, SECRET_NAME, storedExtensionsSchema, type AppManifestWithData, type CollectionSpec, type DataProblem, type DataProblemCode, type ManifestExtensions, type SecretSpec, } from './schema.js';
 export { DOCUMENT_LIMITS } from './document-limits.js';
 export { HOST_CAPABILITIES, KNOWN_HOST_GRANTS, isHostCapability, unknownHostGrant } from './grants.js';
 export { diffSchemas, migrationProblems, migrationSchema, migrationStepSchema, migrationsSchema, publishedMigrationProblems, schemaOf, type Migration, type MigrationCode, type MigrationProblem, type MigrationStep, type SchemaChange, } from './migrations.js';

package/src/index.js

@@ -7,7 +7,7 @@ export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema, br
 export { BRAND_FIELDS, BRAND_LIMITS, brandFilePath, brandPathsOf, brandProblems, brandShapeOf, isBrandPath, pngVerdict, svgColours, toolsProblem, } from "./requirements.js";
 export { BUNDLE_MANIFEST, BUNDLE_MAX_BYTES, BUNDLE_PATH_MAX_CHARS, bundleBytes, bundleHash, brandOf, bundleProblem, codeOf, isBundlePath, isScriptPath, sizeOf, } from "./bundle.js";
 export { COLOUR_TOKENS, FIELD_LIMITS, RESERVED_FIELDS, describeType, isSearchable, isSortable, isStructured, parseFieldType, structuredFields, valueProblem, valueSchema, FieldTypeInvalid, } from "./field-types.js";
-export { appManifestSchema, collectionOf, collectionsOf, dataProblems, labelOf, manifestExtensionsSchema, MAX_APP_SECRETS, MAX_SECRET_CHARS, SECRET_NAME, storedExtensionsSchema, } from "./schema.js";
+export { appManifestSchema, collectionOf, collectionsOf, dataProblems, effectivePlacementKey, labelOf, manifestExtensionsSchema, MAX_APP_SECRETS, MAX_SECRET_CHARS, PLACEMENT_KEY, SECRET_NAME, storedExtensionsSchema, } from "./schema.js";
 export { DOCUMENT_LIMITS } from "./document-limits.js";
 export { HOST_CAPABILITIES, KNOWN_HOST_GRANTS, isHostCapability, unknownHostGrant } from "./grants.js";
 export { diffSchemas, migrationProblems, migrationSchema, migrationStepSchema, migrationsSchema, publishedMigrationProblems, schemaOf, } from "./migrations.js";

package/src/schema.d.ts

@@ -33,6 +33,13 @@ export type PlacementSettingSpec = z.infer<typeof placementSettingSchema>;
  * the limit is for the sidebar's width and a person's patience.
  */
 export declare const MAX_FOLDER_DEPTH = 4;
+/** A stable identity for one independently addable placement offering. */
+export declare const PLACEMENT_KEY: RegExp;
+export declare function effectivePlacementKey(one: {
+    key?: string;
+    kind: string;
+    screen: string;
+}): string;
 /** Most custom tools one app may declare (A3-F08). */
 export declare const MAX_CUSTOM_TOOLS = 20;
 /** A tool name the model and a policy row can both use as it is. */
@@ -78,10 +85,12 @@ declare const secretSchema: z.ZodObject<{
 export type SecretSpec = z.infer<typeof secretSchema>;
 declare const extensionShape: {
     placements: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodOptional<z.ZodString>;
         kind: z.ZodEnum<{
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            home: "home";
         }>;
         screen: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
@@ -198,7 +207,7 @@ export interface DataProblem {
     field?: string;
     message: string;
 }
-export type DataProblemCode = FieldTypeInvalid['code'] | 'data_too_many_collections' | 'data_too_many_fields' | 'data_collection_name_format' | 'data_field_name_format' | 'data_field_reserved' | 'data_label_format' | 'data_label_taken' | 'data_project_field_twice' | 'data_search_unknown_field' | 'data_search_not_text' | 'grant_collection_missing' | 'grant_tool_missing' | 'custom_name_taken' | 'custom_collection_unknown' | 'custom_input_invalid' | 'placement_screen_unknown' | 'placement_children_too_deep' | 'placement_create_tool_unknown' | 'placement_create_not_write' | 'secret_name_taken' | 'grant_secrets_missing';
+export type DataProblemCode = FieldTypeInvalid['code'] | 'data_too_many_collections' | 'data_too_many_fields' | 'data_collection_name_format' | 'data_field_name_format' | 'data_field_reserved' | 'data_label_format' | 'data_label_taken' | 'data_project_field_twice' | 'data_search_unknown_field' | 'data_search_not_text' | 'grant_collection_missing' | 'grant_tool_missing' | 'custom_name_taken' | 'custom_collection_unknown' | 'custom_input_invalid' | 'placement_key_taken' | 'placement_screen_unknown' | 'placement_children_too_deep' | 'placement_create_tool_unknown' | 'placement_create_not_write' | 'secret_name_taken' | 'grant_secrets_missing';
 type Additions = z.infer<z.ZodObject<typeof extensionShape>>;
 /**
  * Everything wrong with an app's additions that a type cannot say.
@@ -213,10 +222,12 @@ export declare function dataProblems(additions: Additions, options?: {
 /** The additions alone, for code that has the rest of the manifest already. */
 export declare const manifestExtensionsSchema: z.ZodObject<{
     placements: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodOptional<z.ZodString>;
         kind: z.ZodEnum<{
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            home: "home";
         }>;
         screen: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
@@ -322,10 +333,12 @@ export declare const manifestExtensionsSchema: z.ZodObject<{
  */
 export declare const storedExtensionsSchema: z.ZodObject<{
     placements: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodOptional<z.ZodString>;
         kind: z.ZodEnum<{
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            home: "home";
         }>;
         screen: z.ZodString;
         label: z.ZodOptional<z.ZodString>;
@@ -466,10 +479,12 @@ export declare const appManifestSchema: z.ZodObject<{
     }, z.core.$strip>>;
     metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     placements: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodOptional<z.ZodString>;
         kind: z.ZodEnum<{
             "project-tab": "project-tab";
             "project-sidebar": "project-sidebar";
             "workspace-sidebar": "workspace-sidebar";
+            home: "home";
         }>;
         screen: z.ZodString;
         label: z.ZodOptional<z.ZodString>;

package/src/schema.js

@@ -48,8 +48,14 @@ const folderLevelSchema = z.object({
     noun: z.string().min(1).max(60).optional(),
     create: folderCreateSchema.optional(),
 });
+/** A stable identity for one independently addable placement offering. */
+export const PLACEMENT_KEY = /^[a-z][a-z0-9-]{0,39}$/;
+export function effectivePlacementKey(one) {
+    return one.key ?? `${one.kind}:${one.screen}`;
+}
 const placementSchema = z.object({
-    kind: z.enum(['project-tab', 'project-sidebar', 'workspace-sidebar']),
+    key: z.string().regex(PLACEMENT_KEY).optional(),
+    kind: z.enum(['project-tab', 'project-sidebar', 'workspace-sidebar', 'home']),
     screen: z.string().min(1).max(FIELD_LIMITS.nameChars),
     label: z.string().min(1).max(60).optional(),
     icon: z.string().max(60).optional(),
@@ -312,7 +318,18 @@ export function dataProblems(additions, options = {}) {
     problems.push(...customToolProblems(additions, options));
     problems.push(...secretProblems(additions, options));
     const screens = new Set(Object.keys(additions.screens ?? {}));
+    const placementKeys = new Set();
     for (const placement of additions.placements ?? []) {
+        const key = effectivePlacementKey(placement);
+        if (placementKeys.has(key)) {
+            problems.push({
+                code: 'placement_key_taken',
+                message: `Two placements use the key "${key}"; each independently addable placement needs its own key.`,
+            });
+        }
+        else {
+            placementKeys.add(key);
+        }
         if (!screens.has(placement.screen)) {
             problems.push({
                 code: 'placement_screen_unknown',

package/src/secrets.js

@@ -35,21 +35,21 @@ const isRealValue = (value) => {
         return false;
     return true;
 };
-function walk(node, at, found) {
+function walk(node, at, found, publicValue = () => false) {
     if (Array.isArray(node)) {
-        node.forEach((one, index) => walk(one, `${at}[${index}]`, found));
+        node.forEach((one, index) => walk(one, `${at}[${index}]`, found, publicValue));
         return;
     }
     if (!node || typeof node !== 'object')
         return;
     for (const [key, value] of Object.entries(node)) {
         const path = at ? `${at}.${key}` : key;
-        if (VALUE_KEYS.has(key) && isRealValue(value)) {
+        if (VALUE_KEYS.has(key) && isRealValue(value) && !publicValue(path)) {
             // Never quoted back: a report that repeated the secret would copy it somewhere else.
             found.push({ code: 'secret_in_bundle', message: SECRET_MESSAGE, path });
             continue;
         }
-        walk(value, path, found);
+        walk(value, path, found, publicValue);
     }
 }
 /**
@@ -59,7 +59,7 @@ function walk(node, at, found) {
  */
 export function secretsInJson(document, at) {
     const found = [];
-    walk(document, at, found);
+    walk(document, at, found, path => /(?:^|\.)placements\[\d+\]\.key$/.test(path));
     return found;
 }
 /** Every secret declared in a bundle's files, as the server finds them. */