@weaveprotocol/core 0.1.0

package/dist/schemas/index.d.ts

@@ -0,0 +1,410 @@
+/**
+ * @module schemas
+ * A standard library of well-known record shapes — reactions, comments, tags,
+ * attachments, references. Optional, and nothing special: the protocol knows
+ * none of them. Each is an ordinary collection definition, and a space learns
+ * one the same way it learns any other, when someone defines it there:
+ *
+ * ```ts
+ * import { reaction, comment, useSchemas } from '@weaveprotocol/core/schemas';
+ *
+ * await useSchemas(node, space.id, [reaction, comment]);
+ * await node.records.put(space.id, reaction, { emoji: '👍' }, {
+ *   links: [{ rel: 'about', to: post.key }],
+ * });
+ * ```
+ *
+ * The point of sharing them is agreement, not privilege: two apps that both
+ * use `std.reaction` see each other's reactions. An app that prefers its own
+ * shape defines its own collection instead, and loses nothing but that.
+ *
+ * **Two kinds.** Most of these are annotations: they attach to anything
+ * (their links point at `'*'`). A few are common nouns — a chat message, a
+ * task on a board, a poll — shared so that two chat apps, or a board and a to-do list,
+ * read the same records. Nouns say exactly what they point at. Keep both lists
+ * small — each entry is only worth it if nearly every app would otherwise
+ * invent the same thing.
+ *
+ * Nouns that keep a hand-made order carry a `position`: a string that sorts
+ * where the record goes. {@link positionBetween} makes one between two others,
+ * so moving a card rewrites only that card, and two people moving cards at
+ * once never renumber each other's. It is optional, so a record made by
+ * something that knows nothing of order still counts: it goes at the end.
+ */
+import type { DefineCollection, P2PNode } from '../node/types.js';
+import type { Typed } from '../query/types.js';
+import type { LinkDeclaration } from '../records/links.js';
+/** An emoji reaction to any record. Link it: `{ rel: 'about', to: <key> }`. */
+export declare const reaction: {
+    readonly name: "std.reaction";
+    readonly title: "Reaction";
+    readonly description: "An emoji reaction to any record.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly emoji: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 16;
+            };
+        };
+        readonly required: readonly ["emoji"];
+    };
+    readonly links: {
+        readonly about: LinkDeclaration;
+    };
+    readonly rules: {
+        readonly edit: "creator";
+        readonly delete: "creator";
+        readonly onePer: readonly ["@author", "link:about", "emoji"];
+    };
+} & Typed<Reaction>;
+export interface Reaction {
+    readonly emoji: string;
+}
+/** A comment on any record, optionally a reply to another comment. */
+export declare const comment: {
+    readonly name: "std.comment";
+    readonly title: "Comment";
+    readonly description: "A comment on any record, optionally replying to another comment.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly text: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 10000;
+            };
+        };
+        readonly required: readonly ["text"];
+    };
+    readonly links: {
+        readonly about: LinkDeclaration;
+        readonly replyTo: {
+            readonly to: readonly ["std.comment"];
+            readonly cardinality: "one";
+            readonly description: "The comment this replies to";
+        };
+    };
+    readonly permissions: readonly ["moderate"];
+    readonly rules: {
+        readonly edit: "creator";
+        readonly delete: readonly ["creator", "can:moderate"];
+    };
+} & Typed<Comment>;
+export interface Comment {
+    readonly text: string;
+}
+/** A label on one or more records. */
+export declare const tag: {
+    readonly name: "std.tag";
+    readonly title: "Tag";
+    readonly description: "A label on one or more records.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly label: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 100;
+            };
+        };
+        readonly required: readonly ["label"];
+    };
+    readonly links: {
+        readonly about: {
+            readonly to: "*";
+            readonly cardinality: "many";
+            readonly description: "The records tagged";
+        };
+    };
+    readonly permissions: readonly ["moderate"];
+    readonly rules: {
+        readonly edit: "creator";
+        readonly delete: readonly ["creator", "can:moderate"];
+    };
+} & Typed<Tag>;
+export interface Tag {
+    readonly label: string;
+}
+/** A file attached to a record. Describes the file; storing its bytes is separate. */
+export declare const attachment: {
+    readonly name: "std.attachment";
+    readonly title: "Attachment";
+    readonly description: "A file attached to a record. Describes the file; storing its bytes is not part of this.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly name: {
+                readonly type: "string";
+                readonly minLength: 1;
+            };
+            readonly mime: {
+                readonly type: "string";
+                readonly minLength: 1;
+            };
+            readonly size: {
+                readonly type: "integer";
+                readonly minimum: 0;
+            };
+            readonly url: {
+                readonly type: "string";
+            };
+        };
+        readonly required: readonly ["name", "mime"];
+    };
+    readonly links: {
+        readonly about: LinkDeclaration;
+    };
+    readonly permissions: readonly ["moderate"];
+    readonly rules: {
+        readonly edit: "creator";
+        readonly delete: readonly ["creator", "can:moderate"];
+    };
+} & Typed<Attachment>;
+export interface Attachment {
+    readonly name: string;
+    readonly mime: string;
+    readonly size?: number;
+    readonly url?: string;
+}
+/** A note that one record refers to another. */
+export declare const reference: {
+    readonly name: "std.reference";
+    readonly title: "Reference";
+    readonly description: "A note that one record refers to another.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly note: {
+                readonly type: "string";
+            };
+        };
+    };
+    readonly links: {
+        readonly about: LinkDeclaration;
+        readonly to: LinkDeclaration;
+    };
+    readonly permissions: readonly ["moderate"];
+    readonly rules: {
+        readonly edit: "creator";
+        readonly delete: readonly ["creator", "can:moderate"];
+    };
+} & Typed<Reference>;
+export interface Reference {
+    readonly note?: string;
+}
+/**
+ * A chat message. The space is the room; order is by when it was written.
+ * It can share one record — a poll to vote on, a task — which a chat that
+ * knows the record's kind shows in place. The text should still make sense
+ * alone ("Poll: Where to?"), for chats that don't.
+ */
+export declare const message: {
+    readonly name: "std.message";
+    readonly title: "Message";
+    readonly description: "A chat message, optionally replying to another, or sharing a record.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly text: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 10000;
+            };
+        };
+        readonly required: readonly ["text"];
+    };
+    readonly links: {
+        readonly replyTo: {
+            readonly to: readonly ["std.message"];
+            readonly cardinality: "one";
+            readonly description: "The message this replies to";
+        };
+        readonly shares: {
+            readonly to: "*";
+            readonly cardinality: "one";
+            readonly description: "A record this message shares, like a poll";
+        };
+    };
+    readonly permissions: readonly ["moderate"];
+    readonly rules: {
+        readonly edit: "creator";
+        readonly delete: readonly ["creator", "can:moderate"];
+    };
+} & Typed<Message>;
+export interface Message {
+    readonly text: string;
+}
+/** A column on a board — To do, Doing, Done — in the order it sits. */
+export declare const column: {
+    readonly name: "std.column";
+    readonly title: "Column";
+    readonly description: "A column on a board, holding tasks.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly name: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 200;
+            };
+            readonly position: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 200;
+                readonly description: "Sorts where the column goes";
+            };
+        };
+        readonly required: readonly ["name"];
+    };
+} & Typed<Column>;
+export interface Column {
+    readonly name: string;
+    readonly position?: string;
+}
+/** A task, in the column it sits in and at a place in it. */
+export declare const task: {
+    readonly name: "std.task";
+    readonly title: "Task";
+    readonly description: "A task, placed in a column.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly title: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 500;
+            };
+            readonly notes: {
+                readonly type: "string";
+                readonly maxLength: 10000;
+            };
+            readonly position: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 200;
+                readonly description: "Sorts where the task goes in its column";
+            };
+        };
+        readonly required: readonly ["title"];
+    };
+    readonly links: {
+        readonly column: {
+            readonly to: readonly ["std.column"];
+            readonly cardinality: "one";
+            readonly description: "The column it sits in";
+        };
+    };
+} & Typed<Task>;
+export interface Task {
+    readonly title: string;
+    readonly notes?: string;
+    readonly position?: string;
+}
+/**
+ * A question with fixed options. The options cannot change once it is asked —
+ * votes point at them by position — but whoever asked can close it.
+ */
+export declare const poll: {
+    readonly name: "std.poll";
+    readonly title: "Poll";
+    readonly description: "A question with options to vote on.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly question: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 500;
+            };
+            readonly options: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 200;
+                };
+            };
+            readonly closed: {
+                readonly type: "boolean";
+                readonly description: "No more votes, as the asker sees it";
+            };
+        };
+        readonly required: readonly ["question", "options"];
+    };
+    readonly permissions: readonly ["moderate"];
+    readonly rules: {
+        readonly edit: "creator";
+        readonly delete: readonly ["creator", "can:moderate"];
+        readonly fixed: readonly ["options"];
+    };
+} & Typed<Poll>;
+export interface Poll {
+    readonly question: string;
+    readonly options: ReadonlyArray<string>;
+    readonly closed?: boolean;
+}
+/**
+ * One person's vote on a poll: the position of their choice in its options.
+ * One per person per poll — voting again changes it; deleting takes it back.
+ */
+export declare const vote: {
+    readonly name: "std.vote";
+    readonly title: "Vote";
+    readonly description: "A vote on a poll: one per person, changed by voting again.";
+    readonly schema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly choice: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly 'x-choicesFrom': {
+                    readonly rel: "about";
+                    readonly field: "options";
+                };
+            };
+        };
+        readonly required: readonly ["choice"];
+    };
+    readonly links: {
+        readonly about: {
+            readonly to: readonly ["std.poll"];
+            readonly cardinality: "one";
+            readonly description: "The poll voted on";
+        };
+    };
+    readonly rules: {
+        readonly edit: "creator";
+        readonly delete: "creator";
+        readonly onePer: readonly ["@author", "link:about"];
+    };
+} & Typed<Vote>;
+export interface Vote {
+    readonly choice: number;
+}
+/** Shapes that attach to anything */
+export declare const standardAnnotations: ReadonlyArray<DefineCollection>;
+/** Common nouns apps share */
+export declare const standardNouns: ReadonlyArray<DefineCollection>;
+/** Everything in the library */
+export declare const standardSchemas: ReadonlyArray<DefineCollection>;
+/**
+ * A `position` that sorts after `before` and ahead of `after` — either may be
+ * missing, for the ends. Positions compare as plain strings and never end in
+ * `0`, so there is always room for another between any two. Equal positions
+ * (two people dropping in the same spot at once) are fine; sort those by key.
+ */
+export declare function positionBetween(before?: string | null, after?: string | null): string;
+/**
+ * Makes sure a space knows these collections: defines the ones it has no
+ * definition for, and leaves the rest alone — so calling it every time a
+ * space opens is fine, and it never bumps a definition someone else owns.
+ * A space you cannot write in is skipped.
+ */
+export declare function useSchemas(node: P2PNode, spaceId: string, schemas: ReadonlyArray<DefineCollection>): Promise<void>;
+export { app, appScreen, checkApp, reviewApp, proposeApp, addApp, copyApp, MAX_APP_COLLECTIONS } from './apps.js';
+export { SCREEN_GUIDE, SCREEN_CLIENT, screenDocument, createScreenBridge } from './screens.js';
+export type { ScreenBridge, ScreenRecord, ScreenViewer } from './screens.js';
+export type { App, AppDefinition, AppReview, AppNeedReview } from './apps.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/schemas/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,OAAO,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAY/C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAI3D,+EAA+E;AAC/E,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;mBAQnB,CAAC;AACH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,sEAAsE;AACtE,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAWlB,CAAC;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,sCAAsC;AACtC,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;cAQd,CAAC;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,sFAAsF;AACtF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAiBrB,CAAC;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,gDAAgD;AAChD,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;oBAQpB,CAAC;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAWlB,CAAC;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,uEAAuE;AACvE,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;iBAYjB,CAAC;AACH,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,6DAA6D;AAC7D,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAcf,CAAC;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAef,CAAC;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAWf,CAAC;AACH,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,qCAAqC;AACrC,eAAO,MAAM,mBAAmB,EAAE,aAAa,CAAC,gBAAgB,CAAmD,CAAC;AACpH,8BAA8B;AAC9B,eAAO,MAAM,aAAa,EAAE,aAAa,CAAC,gBAAgB,CAAuC,CAAC;AAClG,gCAAgC;AAChC,eAAO,MAAM,eAAe,EAAE,aAAa,CAAC,gBAAgB,CAA8C,CAAC;AAI3G;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAoBrF;AAED;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAOxH;AAED,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAClH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC/F,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC7E,YAAY,EAAE,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC"}

package/dist/schemas/index.js

@@ -0,0 +1,208 @@
+/**
+ * A definition that also carries its records' type, so querying or writing
+ * with it is typed — `include: { votes: { rel: 'about', from: vote } }` gives
+ * votes as `Vote`. The schemas here are plain JSON Schema, so the type is said
+ * alongside rather than worked out.
+ */
+const typed = () => (definition) => definition;
+const about = (description) => ({ to: '*', cardinality: 'one', description });
+/** An emoji reaction to any record. Link it: `{ rel: 'about', to: <key> }`. */
+export const reaction = typed()({
+    name: 'std.reaction',
+    title: 'Reaction',
+    description: 'An emoji reaction to any record.',
+    schema: { type: 'object', properties: { emoji: { type: 'string', minLength: 1, maxLength: 16 } }, required: ['emoji'] },
+    links: { about: about('The record reacted to') },
+    // One of each emoji per person per record; only yours to take back.
+    rules: { edit: 'creator', delete: 'creator', onePer: ['@author', 'link:about', 'emoji'] },
+});
+/** A comment on any record, optionally a reply to another comment. */
+export const comment = typed()({
+    name: 'std.comment',
+    title: 'Comment',
+    description: 'A comment on any record, optionally replying to another comment.',
+    schema: { type: 'object', properties: { text: { type: 'string', minLength: 1, maxLength: 10000 } }, required: ['text'] },
+    links: {
+        about: about('The record commented on'),
+        replyTo: { to: ['std.comment'], cardinality: 'one', description: 'The comment this replies to' },
+    },
+    permissions: ['moderate'],
+    rules: { edit: 'creator', delete: ['creator', 'can:moderate'] },
+});
+/** A label on one or more records. */
+export const tag = typed()({
+    name: 'std.tag',
+    title: 'Tag',
+    description: 'A label on one or more records.',
+    schema: { type: 'object', properties: { label: { type: 'string', minLength: 1, maxLength: 100 } }, required: ['label'] },
+    links: { about: { to: '*', cardinality: 'many', description: 'The records tagged' } },
+    permissions: ['moderate'],
+    rules: { edit: 'creator', delete: ['creator', 'can:moderate'] },
+});
+/** A file attached to a record. Describes the file; storing its bytes is separate. */
+export const attachment = typed()({
+    name: 'std.attachment',
+    title: 'Attachment',
+    description: 'A file attached to a record. Describes the file; storing its bytes is not part of this.',
+    schema: {
+        type: 'object',
+        properties: {
+            name: { type: 'string', minLength: 1 },
+            mime: { type: 'string', minLength: 1 },
+            size: { type: 'integer', minimum: 0 },
+            url: { type: 'string' },
+        },
+        required: ['name', 'mime'],
+    },
+    links: { about: about('The record the file is attached to') },
+    permissions: ['moderate'],
+    rules: { edit: 'creator', delete: ['creator', 'can:moderate'] },
+});
+/** A note that one record refers to another. */
+export const reference = typed()({
+    name: 'std.reference',
+    title: 'Reference',
+    description: 'A note that one record refers to another.',
+    schema: { type: 'object', properties: { note: { type: 'string' } } },
+    links: { about: about('The record doing the referring'), to: about('The record referred to') },
+    permissions: ['moderate'],
+    rules: { edit: 'creator', delete: ['creator', 'can:moderate'] },
+});
+/**
+ * A chat message. The space is the room; order is by when it was written.
+ * It can share one record — a poll to vote on, a task — which a chat that
+ * knows the record's kind shows in place. The text should still make sense
+ * alone ("Poll: Where to?"), for chats that don't.
+ */
+export const message = typed()({
+    name: 'std.message',
+    title: 'Message',
+    description: 'A chat message, optionally replying to another, or sharing a record.',
+    schema: { type: 'object', properties: { text: { type: 'string', minLength: 1, maxLength: 10000 } }, required: ['text'] },
+    links: {
+        replyTo: { to: ['std.message'], cardinality: 'one', description: 'The message this replies to' },
+        shares: { to: '*', cardinality: 'one', description: 'A record this message shares, like a poll' },
+    },
+    permissions: ['moderate'],
+    rules: { edit: 'creator', delete: ['creator', 'can:moderate'] },
+});
+/** A column on a board — To do, Doing, Done — in the order it sits. */
+export const column = typed()({
+    name: 'std.column',
+    title: 'Column',
+    description: 'A column on a board, holding tasks.',
+    schema: {
+        type: 'object',
+        properties: {
+            name: { type: 'string', minLength: 1, maxLength: 200 },
+            position: { type: 'string', minLength: 1, maxLength: 200, description: 'Sorts where the column goes' },
+        },
+        required: ['name'],
+    },
+});
+/** A task, in the column it sits in and at a place in it. */
+export const task = typed()({
+    name: 'std.task',
+    title: 'Task',
+    description: 'A task, placed in a column.',
+    schema: {
+        type: 'object',
+        properties: {
+            title: { type: 'string', minLength: 1, maxLength: 500 },
+            notes: { type: 'string', maxLength: 10000 },
+            position: { type: 'string', minLength: 1, maxLength: 200, description: 'Sorts where the task goes in its column' },
+        },
+        required: ['title'],
+    },
+    links: { column: { to: ['std.column'], cardinality: 'one', description: 'The column it sits in' } },
+});
+/**
+ * A question with fixed options. The options cannot change once it is asked —
+ * votes point at them by position — but whoever asked can close it.
+ */
+export const poll = typed()({
+    name: 'std.poll',
+    title: 'Poll',
+    description: 'A question with options to vote on.',
+    schema: {
+        type: 'object',
+        properties: {
+            question: { type: 'string', minLength: 1, maxLength: 500 },
+            options: { type: 'array', items: { type: 'string', minLength: 1, maxLength: 200 } },
+            closed: { type: 'boolean', description: 'No more votes, as the asker sees it' },
+        },
+        required: ['question', 'options'],
+    },
+    permissions: ['moderate'],
+    rules: { edit: 'creator', delete: ['creator', 'can:moderate'], fixed: ['options'] },
+});
+/**
+ * One person's vote on a poll: the position of their choice in its options.
+ * One per person per poll — voting again changes it; deleting takes it back.
+ */
+export const vote = typed()({
+    name: 'std.vote',
+    title: 'Vote',
+    description: "A vote on a poll: one per person, changed by voting again.",
+    schema: {
+        type: 'object',
+        properties: { choice: { type: 'integer', minimum: 0, 'x-choicesFrom': { rel: 'about', field: 'options' } } },
+        required: ['choice'],
+    },
+    links: { about: { to: ['std.poll'], cardinality: 'one', description: 'The poll voted on' } },
+    rules: { edit: 'creator', delete: 'creator', onePer: ['@author', 'link:about'] },
+});
+/** Shapes that attach to anything */
+export const standardAnnotations = [reaction, comment, tag, attachment, reference];
+/** Common nouns apps share */
+export const standardNouns = [message, column, task, poll, vote];
+/** Everything in the library */
+export const standardSchemas = [...standardAnnotations, ...standardNouns];
+const DIGITS = '0123456789abcdefghijklmnopqrstuvwxyz';
+/**
+ * A `position` that sorts after `before` and ahead of `after` — either may be
+ * missing, for the ends. Positions compare as plain strings and never end in
+ * `0`, so there is always room for another between any two. Equal positions
+ * (two people dropping in the same spot at once) are fine; sort those by key.
+ */
+export function positionBetween(before, after) {
+    const a = before ?? '';
+    let b = after && after > a ? after : null;
+    let out = '';
+    for (let i = 0;; i++) {
+        const low = i < a.length ? DIGITS.indexOf(a[i]) : 0;
+        const high = b !== null ? (i < b.length ? DIGITS.indexOf(b[i]) : 0) : DIGITS.length;
+        if (low === high) {
+            out += DIGITS[low];
+            continue;
+        }
+        // At an open end, step by one rather than halving, so a list that only
+        // ever grows at the end (or the start) keeps short positions.
+        const open = i < a.length ? (b === null ? 'after' : null) : b !== null ? 'before' : null;
+        const mid = open === 'after' ? low + 1 : open === 'before' ? high - 1 : Math.floor((low + high) / 2);
+        if (mid > low && mid < high)
+            return out + DIGITS[mid];
+        // Adjacent digits: keep the lower one, and anything above the rest of `a` will do.
+        out += DIGITS[low];
+        b = null;
+    }
+}
+/**
+ * Makes sure a space knows these collections: defines the ones it has no
+ * definition for, and leaves the rest alone — so calling it every time a
+ * space opens is fine, and it never bumps a definition someone else owns.
+ * A space you cannot write in is skipped.
+ */
+export async function useSchemas(node, spaceId, schemas) {
+    const summary = await node.spaces.get(spaceId);
+    if (!summary?.writable)
+        return;
+    const known = new Set((await node.collections.list(spaceId)).filter((c) => c.version !== null).map((c) => c.name));
+    for (const schema of schemas) {
+        if (!known.has(schema.name))
+            await node.collections.define(spaceId, schema);
+    }
+}
+export { app, appScreen, checkApp, reviewApp, proposeApp, addApp, copyApp, MAX_APP_COLLECTIONS } from './apps.js';
+export { SCREEN_GUIDE, SCREEN_CLIENT, screenDocument, createScreenBridge } from './screens.js';
+//# sourceMappingURL=index.js.map

package/dist/schemas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":"AAoCA;;;;;GAKG;AACH,MAAM,KAAK,GACT,GAAM,EAAE,CACR,CAAmC,UAAa,EAAgB,EAAE,CAChE,UAAU,CAAC;AAGf,MAAM,KAAK,GAAG,CAAC,WAAmB,EAAmB,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AAEvG,+EAA+E;AAC/E,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAAY,CAAC;IACxC,IAAI,EAAE,cAAc;IACpB,KAAK,EAAE,UAAU;IACjB,WAAW,EAAE,kCAAkC;IAC/C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE;IACvH,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,uBAAuB,CAAC,EAAE;IAChD,oEAAoE;IACpE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE;CAC1F,CAAC,CAAC;AAKH,sEAAsE;AACtE,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAW,CAAC;IACtC,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,SAAS;IAChB,WAAW,EAAE,kEAAkE;IAC/E,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE;IACxH,KAAK,EAAE;QACL,KAAK,EAAE,KAAK,CAAC,yBAAyB,CAAC;QACvC,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,6BAA6B,EAAE;KACjG;IACD,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE;CAChE,CAAC,CAAC;AAKH,sCAAsC;AACtC,MAAM,CAAC,MAAM,GAAG,GAAG,KAAK,EAAO,CAAC;IAC9B,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,KAAK;IACZ,WAAW,EAAE,iCAAiC;IAC9C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE;IACxH,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,oBAAoB,EAAE,EAAE;IACrF,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE;CAChE,CAAC,CAAC;AAKH,sFAAsF;AACtF,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAc,CAAC;IAC5C,IAAI,EAAE,gBAAgB;IACtB,KAAK,EAAE,YAAY;IACnB,WAAW,EAAE,yFAAyF;IACtG,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;YACtC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE;YACtC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;YACrC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SACxB;QACD,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;KAC3B;IACD,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,oCAAoC,CAAC,EAAE;IAC7D,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE;CAChE,CAAC,CAAC;AAQH,gDAAgD;AAChD,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,EAAa,CAAC;IAC1C,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,2CAA2C;IACxD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE;IACpE,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,gCAAgC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,wBAAwB,CAAC,EAAE;IAC9F,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE;CAChE,CAAC,CAAC;AAKH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAW,CAAC;IACtC,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,SAAS;IAChB,WAAW,EAAE,sEAAsE;IACnF,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE;IACxH,KAAK,EAAE;QACL,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,6BAA6B,EAAE;QAChG,MAAM,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,2CAA2C,EAAE;KAClG;IACD,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE;CAChE,CAAC,CAAC;AAKH,uEAAuE;AACvE,MAAM,CAAC,MAAM,MAAM,GAAG,KAAK,EAAU,CAAC;IACpC,IAAI,EAAE,YAAY;IAClB,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,qCAAqC;IAClD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE;YACtD,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,WAAW,EAAE,6BAA6B,EAAE;SACvG;QACD,QAAQ,EAAE,CAAC,MAAM,CAAC;KACnB;CACF,CAAC,CAAC;AAMH,6DAA6D;AAC7D,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EAAQ,CAAC;IAChC,IAAI,EAAE,UAAU;IAChB,KAAK,EAAE,MAAM;IACb,WAAW,EAAE,6BAA6B;IAC1C,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE;YACvD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE;YAC3C,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,WAAW,EAAE,yCAAyC,EAAE;SACnH;QACD,QAAQ,EAAE,CAAC,OAAO,CAAC;KACpB;IACD,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,uBAAuB,EAAE,EAAE;CACpG,CAAC,CAAC;AAOH;;;GAGG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EAAQ,CAAC;IAChC,IAAI,EAAE,UAAU;IAChB,KAAK,EAAE,MAAM;IACb,WAAW,EAAE,qCAAqC;IAClD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE;YAC1D,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE;YACnF,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,qCAAqC,EAAE;SAChF;QACD,QAAQ,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC;KAClC;IACD,WAAW,EAAE,CAAC,UAAU,CAAC;IACzB,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE;CACpF,CAAC,CAAC;AAOH;;;GAGG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EAAQ,CAAC;IAChC,IAAI,EAAE,UAAU;IAChB,KAAK,EAAE,MAAM;IACb,WAAW,EAAE,4DAA4D;IACzE,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,eAAe,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE;QAC5G,QAAQ,EAAE,CAAC,QAAQ,CAAC;KACrB;IACD,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,EAAE;IAC5F,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE;CACjF,CAAC,CAAC;AAKH,qCAAqC;AACrC,MAAM,CAAC,MAAM,mBAAmB,GAAoC,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;AACpH,8BAA8B;AAC9B,MAAM,CAAC,MAAM,aAAa,GAAoC,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAClG,gCAAgC;AAChC,MAAM,CAAC,MAAM,eAAe,GAAoC,CAAC,GAAG,mBAAmB,EAAE,GAAG,aAAa,CAAC,CAAC;AAE3G,MAAM,MAAM,GAAG,sCAAsC,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,MAAsB,EAAE,KAAqB;IAC3E,MAAM,CAAC,GAAG,MAAM,IAAI,EAAE,CAAC;IACvB,IAAI,CAAC,GAAG,KAAK,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1C,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,IAAI,CAAC,GAAG,CAAC,GAAI,CAAC,EAAE,EAAE,CAAC;QACtB,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;QACrF,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;YACnB,SAAS;QACX,CAAC;QACD,uEAAuE;QACvE,8DAA8D;QAC9D,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;QACzF,MAAM,GAAG,GAAG,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACrG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,IAAI;YAAE,OAAO,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACtD,mFAAmF;QACnF,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC,GAAG,IAAI,CAAC;IACX,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAa,EAAE,OAAe,EAAE,OAAwC;IACvG,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/C,IAAI,CAAC,OAAO,EAAE,QAAQ;QAAE,OAAO;IAC/B,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACnH,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC;AAED,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAClH,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC"}