@brydio/manifest 0.1.0-alpha.5 → 0.1.0-alpha.50

package/src/grants.d.ts

@@ -6,8 +6,18 @@
  * `apps/api/src/apps/manifest/grants.ts`, and the `grant_unknown` sentence in
  * `apps/api/src/apps/publishing/app-publish.service.ts`.
  */
-/** The host grants with a name of their own. A connection's is `connection:<name>`. */
-export declare const HOST_CAPABILITIES: readonly ["navigate", "message", "members", "projects", "model"];
+/**
+ * The host grants with a name of their own. A connection's is `connection:<name>`.
+ *
+ * `chats` and `chat` differ: `chats` is the typed Brydio API's reach into the
+ * person's assistant conversations; `chat` is a handler's `chat.post`, the
+ * app posting one of its cards into a workspace room (FO03). `directory` is
+ * a handler's `directory.*` and a screen's `useProfile` (FO02); `webhooks`
+ * is a handler's `webhooks.send` (FO07); `timers` is a handler's
+ * `timers.*`, running one of the app's own tools later (PJ01); `calendar`
+ * is a handler's `calendar.*`, the caller's events on the event layer (CA02).
+ */
+export declare const HOST_CAPABILITIES: readonly ["navigate", "message", "members", "projects", "files", "chats", "model", "secrets", "notify", "approvals", "chat", "directory", "webhooks", "timers", "calendar"];
 /** The older name for `HOST_CAPABILITIES`, kept for what already imports it. */
 export declare const KNOWN_HOST_GRANTS: readonly string[];
 /** True for a host grant Brydio knows how to honour: a named capability, or one connection. */

package/src/grants.js

@@ -7,8 +7,34 @@
  * `apps/api/src/apps/publishing/app-publish.service.ts`.
  */
 import { BUNDLE_MANIFEST } from "./bundle.js";
-/** The host grants with a name of their own. A connection's is `connection:<name>`. */
-export const HOST_CAPABILITIES = ['navigate', 'message', 'members', 'projects', 'model'];
+/**
+ * The host grants with a name of their own. A connection's is `connection:<name>`.
+ *
+ * `chats` and `chat` differ: `chats` is the typed Brydio API's reach into the
+ * person's assistant conversations; `chat` is a handler's `chat.post`, the
+ * app posting one of its cards into a workspace room (FO03). `directory` is
+ * a handler's `directory.*` and a screen's `useProfile` (FO02); `webhooks`
+ * is a handler's `webhooks.send` (FO07); `timers` is a handler's
+ * `timers.*`, running one of the app's own tools later (PJ01); `calendar`
+ * is a handler's `calendar.*`, the caller's events on the event layer (CA02).
+ */
+export const HOST_CAPABILITIES = [
+    'navigate',
+    'message',
+    'members',
+    'projects',
+    'files',
+    'chats',
+    'model',
+    'secrets',
+    'notify',
+    'approvals',
+    'chat',
+    'directory',
+    'webhooks',
+    'timers',
+    'calendar',
+];
 /** The older name for `HOST_CAPABILITIES`, kept for what already imports it. */
 export const KNOWN_HOST_GRANTS = HOST_CAPABILITIES;
 const CONNECTION = /^connection:[a-z0-9][a-z0-9_-]{0,59}$/;

package/src/index.d.ts

@@ -3,14 +3,19 @@
  * types, the tools Brydio generates from them, and the bundle rules. Each is
  * a copy of the server's own, so an app that passes here passes there.
  */
-export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema } from './base.js';
-export { BUNDLE_MANIFEST, BUNDLE_MAX_BYTES, BUNDLE_PATH_MAX_CHARS, bundleBytes, bundleHash, 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, storedExtensionsSchema, type AppManifestWithData, type CollectionSpec, type DataProblem, type DataProblemCode, type ManifestExtensions, } from './schema.js';
+export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema, brandImagesSchema } from './base.js';
+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, coeditedFields, FIELD_LIMITS, RESERVED_FIELDS, describeType, isCoedited, isSearchable, isSortable, isStructured, parseFieldType, structuredFields, valueProblem, valueSchema, FieldTypeInvalid, type DocumentOf, type FieldKind, type FieldType, type FieldValue, type FieldsOf, } from './field-types.js';
+export { appManifestSchema, appToolPrefix, collectionOf, crossAppTool, collectionsOf, dataProblems, effectivePlacementKey, HOME_CARD_SIZES, labelOf, manifestExtensionsSchema, newAppManifestSchema, SIZED_PLACEMENT_KINDS, MAX_APP_SECRETS, MAX_SECRET_CHARS, PLACEMENT_KEY, SECRET_NAME, storedExtensionsSchema, type AppManifestWithData, type CollectionSpec, type DataProblem, type DataProblemCode, type DataProblemOptions, type HomeCardSize, type ManifestExtensions, type SecretSpec, } from './schema.js';
+export { OPEN_LIMITS, OPEN_TYPES, choicesProblem, definitionOf, definitionTypeProblem, describeField, fieldTypeOf, hasChoices, isPlainOpenType, keyFromName, keyProblem, missingRequired, moveValue, openSchemaProblems, openSpec, openValueProblem, type Moved, type OpenField, type OpenFieldChange, type OpenFieldValue, type OpenProblem, type OpenProblemCode, type OpenSchemaFlag, type OpenType, } from './open-schema.js';
+export { CONFIRM_LIMITS, confirmEmailProblems, confirmEmailSpec, type ConfirmEmailDeclared, type ConfirmEmailSpec, type ConfirmProblemCode, } from './confirm-email.js';
+export { ANONYMOUS_LIMITS, ANONYMOUS_WRITER, anonymousProblems, anonymousSpec, type AnonymousDeclared, type AnonymousProblemCode, type AnonymousSpec, } from './anonymous.js';
+export { editorsOf, editorsProblems, READERS_LIMIT, readersOf, readersProblems, type EditorsProblemCode, type ReadersProblemCode } from './readers.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';
-export { SECRET_MESSAGE, findSecrets, secretsInJson, type SecretFound } from './secrets.js';
+export { DEVELOPER_KEY_MESSAGE, SECRET_MESSAGE, developerKeyIn, findSecrets, holdsDeveloperKey, secretsInJson, type SecretFound, } from './secrets.js';
 export { compareVersions, sdkRefusal, type SdkSupport } from './sdk.js';
 export { TOOL_WRITES, generatedToolsOf, toolNames, type GeneratedTool, type ToolVerb } from './tools.js';
 export { validateManifest, validateManifestText, type ManifestProblem, type ManifestProblemCode, type ManifestValidation, } from './validate.js';

package/src/index.js

@@ -3,14 +3,19 @@
  * types, the tools Brydio generates from them, and the bundle rules. Each is
  * a copy of the server's own, so an app that passes here passes there.
  */
-export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema } from "./base.js";
-export { BUNDLE_MANIFEST, BUNDLE_MAX_BYTES, BUNDLE_PATH_MAX_CHARS, bundleBytes, bundleHash, 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, storedExtensionsSchema, } from "./schema.js";
+export { APP_NAME_FORMAT, MANIFEST_LIMITS, SEMVER_FORMAT, baseManifestSchema, brandImagesSchema } from "./base.js";
+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, coeditedFields, FIELD_LIMITS, RESERVED_FIELDS, describeType, isCoedited, isSearchable, isSortable, isStructured, parseFieldType, structuredFields, valueProblem, valueSchema, FieldTypeInvalid, } from "./field-types.js";
+export { appManifestSchema, appToolPrefix, collectionOf, crossAppTool, collectionsOf, dataProblems, effectivePlacementKey, HOME_CARD_SIZES, labelOf, manifestExtensionsSchema, newAppManifestSchema, SIZED_PLACEMENT_KINDS, MAX_APP_SECRETS, MAX_SECRET_CHARS, PLACEMENT_KEY, SECRET_NAME, storedExtensionsSchema, } from "./schema.js";
+export { OPEN_LIMITS, OPEN_TYPES, choicesProblem, definitionOf, definitionTypeProblem, describeField, fieldTypeOf, hasChoices, isPlainOpenType, keyFromName, keyProblem, missingRequired, moveValue, openSchemaProblems, openSpec, openValueProblem, } from "./open-schema.js";
+export { CONFIRM_LIMITS, confirmEmailProblems, confirmEmailSpec, } from "./confirm-email.js";
+export { ANONYMOUS_LIMITS, ANONYMOUS_WRITER, anonymousProblems, anonymousSpec, } from "./anonymous.js";
+export { editorsOf, editorsProblems, READERS_LIMIT, readersOf, readersProblems } from "./readers.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";
-export { SECRET_MESSAGE, findSecrets, secretsInJson } from "./secrets.js";
+export { DEVELOPER_KEY_MESSAGE, SECRET_MESSAGE, developerKeyIn, findSecrets, holdsDeveloperKey, secretsInJson, } from "./secrets.js";
 export { compareVersions, sdkRefusal } from "./sdk.js";
 export { TOOL_WRITES, generatedToolsOf, toolNames } from "./tools.js";
 export { validateManifest, validateManifestText, } from "./validate.js";

package/src/migrations.d.ts

@@ -115,7 +115,7 @@ export type SchemaChange = {
  * Hodler's `diffManifests` to show, and none of them moves a record.
  */
 export declare function diffSchemas(from: unknown, to: unknown): SchemaChange[];
-export type MigrationCode = 'migration_step_invalid' | 'migration_step_pointless' | 'migration_default_missing' | 'migration_default_invalid' | 'migration_unexplained' | 'migration_type_changed' | 'migration_value_removed';
+export type MigrationCode = 'migration_step_invalid' | 'migration_step_pointless' | 'migration_default_missing' | 'migration_default_invalid' | 'migration_unexplained' | 'migration_type_changed' | 'migration_value_removed' | 'migration_anonymous_changed';
 export interface MigrationProblem {
     code: MigrationCode;
     collection: string;

package/src/migrations.js

@@ -181,6 +181,35 @@ export function migrationProblems(from, to, steps) {
                 break;
         }
     }
+    problems.push(...anonymityChanges(from, to));
+    return problems;
+}
+/**
+ * A kept collection that becomes anonymous, stops being, or moves its group
+ * (P13): no step can say what its records become. Records kept before kept
+ * their writers and times, and records kept since were read only by group.
+ */
+function anonymityChanges(from, to) {
+    const before = record(record(from).data);
+    const after = record(record(to).data);
+    const problems = [];
+    for (const [name, declared] of Object.entries(after)) {
+        if (!(name in before))
+            continue;
+        const was = record(record(before[name]).anonymous).group;
+        const now = record(record(declared).anonymous).group;
+        if (was === now)
+            continue;
+        problems.push({
+            code: 'migration_anonymous_changed',
+            collection: name,
+            message: was === undefined
+                ? `${name} already keeps records with their writers, so it can't become anonymous; keep anonymous answers in a new collection.`
+                : now === undefined
+                    ? `${name} keeps anonymous answers, so it stays anonymous.`
+                    : `${name}'s anonymous answers stay grouped by ${String(was)}.`,
+        });
+    }
     return problems;
 }
 /** The old schema with the steps applied, and every step that could not apply or changed nothing. */

package/src/open-schema.d.ts

@@ -0,0 +1,128 @@
+import { type FieldType } from './field-types.js';
+import type { CollectionSpec } from './schema.js';
+/**
+ * Open-schema collections (P5).
+ *
+ * A collection flagged `openSchema: { fields: "columns", table?: "table" }`
+ * keeps the fields its manifest declares, and also the fields its companion
+ * collection's records define, per table. This file is the manifest half:
+ * which types a definition may name, what the companion must declare, how a
+ * definition reads as a `FieldType` the store already knows, and how a value
+ * moves when its field changes type. The store half is
+ * `apps/data/open-schema.ts`.
+ */
+/** The types a field definition may name. */
+export declare const OPEN_TYPES: readonly ["text", "long_text", "number", "currency", "percent", "rating", "date", "datetime", "checkbox", "select", "multi_select", "person", "link", "url", "email", "phone", "attachment"];
+export type OpenType = (typeof OPEN_TYPES)[number];
+export declare const OPEN_LIMITS: {
+    /** Live rows one table may hold (DB-Q2, owner 30 Sep): measured at this size. */
+    readonly rowsPerTable: 50000;
+    /** Live field definitions one table may hold. */
+    readonly fieldsPerTable: 200;
+    /** The highest a rating may be. */
+    readonly ratingMax: 10;
+};
+/** The flag as the manifest writes it. */
+export interface OpenSchemaFlag {
+    /** The companion collection whose records define the fields. */
+    fields: string;
+    /** A `string` field on both collections naming a row's or a definition's table. */
+    table?: string;
+}
+/** One live field, read from a companion record. */
+export interface OpenField {
+    /** The companion record's id. */
+    id: string;
+    /** Stable across renames: what rows, tools, filters and sorts use. */
+    key: string;
+    name: string;
+    type: OpenType;
+    /** Null for a collection with no `table`. */
+    table: string | null;
+    choices: string[];
+    required: boolean;
+    currency?: string;
+    precision?: number;
+    linkTo?: string;
+    description?: string;
+}
+export type OpenProblemCode = 'data_open_fields_unknown' | 'data_open_fields_shape' | 'data_open_table_unknown';
+export interface OpenProblem {
+    code: OpenProblemCode;
+    field?: string;
+    message: string;
+}
+/**
+ * Everything wrong with one collection's `openSchema`, given every
+ * collection's raw schema. Empty when it is right.
+ */
+export declare function openSchemaProblems(collection: string, flag: OpenSchemaFlag, data: Readonly<Record<string, {
+    schema: Record<string, unknown>;
+    openSchema?: OpenSchemaFlag;
+}>>): OpenProblem[];
+/** A definition's type as the store's own field type: what `checked` and the list path read. */
+export declare function fieldTypeOf(field: OpenField): FieldType;
+/** True for a type whose values a definition must list. */
+export declare const hasChoices: (type: OpenType) => boolean;
+/** A definition in a few words, for an answer or a tool: `Amount (deal_size): currency, USD`. */
+export declare function describeField(field: OpenField): string;
+/**
+ * A key made from a name: `"Deal size"` → `deal_size`, suffixed when taken.
+ * Always a field name the tools can use, never a reserved one.
+ */
+export declare function keyFromName(name: string, taken: ReadonlySet<string>): string;
+/** Why a key cannot be a field's key here, or null. */
+export declare function keyProblem(key: string, fixed: ReadonlySet<string>, taken: ReadonlySet<string>): string | null;
+/** The choices a definition lists, checked: some, short, distinct. */
+export declare function choicesProblem(type: OpenType, choices: readonly string[]): string | null;
+/**
+ * What the store's own field type cannot say about an open value: a web
+ * address, an email, a rating's range, a date with no time, the choices of a
+ * multi-select. Null when it is fine; `checked` then checks the rest.
+ */
+export declare function openValueProblem(field: OpenField, value: unknown): string | null;
+/** True when a create leaves a required field out. */
+export declare const missingRequired: (field: OpenField, value: unknown) => boolean;
+/** What happened to one value when its field changed. */
+export type Moved = {
+    outcome: 'kept' | 'converted';
+    value: unknown;
+} | {
+    outcome: 'cleared';
+};
+/**
+ * One value moved from a field's old definition to its new one (P5 retype):
+ * kept when it is still right, converted when it can be read as the new type,
+ * else cleared. Never invents a choice.
+ */
+export declare function moveValue(value: unknown, from: OpenField, to: OpenField): Moved;
+/**
+ * What a field definition's change did to its table's rows: counts, never
+ * values. `rows` is how many held a value for the field. A definition's
+ * `update` or `delete` answer carries it as `fieldChange` when values moved.
+ */
+export interface OpenFieldChange {
+    field: string;
+    op: 'retype' | 'choices' | 'delete';
+    rows: number;
+    kept: number;
+    converted: number;
+    cleared: number;
+}
+/** One value an open field may hold, as a row hands it out. */
+export type OpenFieldValue = string | number | boolean | string[] | null;
+/** Open types whose values are kept in the plain column: filtered, and all but the two lists sorted. */
+export declare const isPlainOpenType: (type: OpenType) => boolean;
+/**
+ * One companion record as a definition, or null when it cannot be one.
+ * `table` is the field naming its table, if the collection has tables.
+ */
+export declare function definitionOf(id: string, body: Record<string, unknown>, table: string | null): OpenField | null;
+/**
+ * The collection's spec with one table's live fields folded in: what a row
+ * is checked against and what a list filters and sorts on. A fixed field
+ * always wins over a definition of the same key.
+ */
+export declare function openSpec(base: CollectionSpec, fields: readonly OpenField[]): CollectionSpec;
+/** Why a definition's type and choices don't go together, or null. */
+export declare function definitionTypeProblem(body: Record<string, unknown>): string | null;