@cogenta/starters 0.1.5

package/dist/blueprints/association.d.ts

@@ -0,0 +1,322 @@
+import type { VocabularyBlock } from '@cogenta/blocks';
+import { type CollectionDefinition } from '@cogenta/schema';
+import { type BlueprintContentPack, type RecommendedAgentHint } from './content-pack.js';
+import type { DemoMediaSpec } from './demo-media.js';
+import type { BlueprintMenus, MenuItemSpec } from './menus.js';
+import type { BlueprintWidget } from './widgets.js';
+/**
+ * The `association` blueprint (L27, `@cogenta/theme-association`): a
+ * neighbourhood charity in a northern English town, run from an old library
+ * on Elm Street. It keeps a Thursday food bank, a homework club, a community
+ * garden and a winter coat bank going with three hundred volunteers and two
+ * part-time staff, and its site has the pages such a charity actually needs:
+ * what it does, a calendar of dated events with a page each, how to
+ * volunteer, how to give, where the money goes, its story and trustees, how
+ * to reach it, and its privacy notice.
+ *
+ * **No payment system, and nothing that pretends to be one.** A blueprint
+ * writes content; contract B has no payment block and nothing in a page can
+ * take a card. So every "Donate" leads to a Donate page that says how to give
+ * for real: a standing order set up with the donor's own bank from details
+ * the treasurer sends on request, a cheque by post, cash at the hall on a
+ * Thursday, Gift Aid, payroll giving and gifts in wills, with an email and a
+ * telephone number that work on any device. The bank account number is sent
+ * by the treasurer rather than printed on a page: a demonstration site left
+ * online with a plausible account number on it would send real money to a
+ * stranger.
+ *
+ * The same honesty holds for volunteering: the Volunteer page names each
+ * role and its hours, and signing up is an email, a telephone call or
+ * turning up at the next orientation evening, which is a real event page.
+ *
+ * The organisation is the site: its name comes from `SeedContext.siteName`,
+ * in the copy, the testimonial and the email addresses, and falls back to
+ * `DEFAULT_ASSOCIATION_NAME`. The town, the street and the people are
+ * invented. The telephone number is in Ofcom's range reserved for drama
+ * (01632 960xxx), so it can never ring anyone.
+ */
+export declare const DEFAULT_ASSOCIATION_NAME = "Riverside Neighbours";
+export declare const ASSOCIATION_PHONE = "01632 960418";
+export declare const ASSOCIATION_ADDRESS = "The Old Library, 220 Elm Street, Ashworth AW4 2LT";
+export declare const CHARITY_NUMBER = "1299418";
+/**
+ * An event: a date and time (`date`, with `endsAt` when it has an end), a
+ * place and its street address, what it costs and whether to book. The
+ * theme reads these by name, lists events as a dated calendar and opens each
+ * event's own page on its date.
+ */
+export declare const event: {
+    readonly name: "event";
+    readonly labels: {
+        readonly singular: "Event";
+        readonly plural: "Events";
+    };
+    readonly routing: {
+        readonly pattern: "/events/:slug";
+    };
+    readonly fields: {
+        readonly seoTitle: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly seoDescription: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly seoImage: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "media";
+            readonly options: {
+                accept: readonly ("audio" | "file" | "image" | "video")[];
+                many: boolean;
+            };
+        };
+        readonly seoNoindex: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "boolean";
+            readonly options: {};
+        };
+        readonly title: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly slug: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "slug";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly date: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "datetime";
+            readonly options: {};
+        };
+        readonly endsAt: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "datetime";
+            readonly options: {};
+        };
+        readonly location: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly address: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly cost: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly booking: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly description: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly coverImage: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "media";
+            readonly options: {
+                accept: readonly ("audio" | "file" | "image" | "video")[];
+                many: boolean;
+            };
+        };
+        readonly blocks: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "blocks";
+            readonly options: {
+                allow: "*" | readonly string[];
+            };
+        };
+    };
+    readonly indexes: readonly [readonly ["slug"], readonly ["date"]];
+    readonly permissions: {
+        readonly read: readonly ['public'];
+        readonly create: readonly ['editor', 'admin'];
+        readonly update: readonly ['editor', 'admin'];
+        readonly delete: readonly ['admin'];
+    };
+};
+/** A programme: something the charity runs every week or every season. */
+export declare const programme: {
+    readonly name: "programme";
+    readonly labels: {
+        readonly singular: "Programme";
+        readonly plural: "Programmes";
+    };
+    readonly routing: {
+        readonly pattern: "/what-we-do/:slug";
+    };
+    readonly fields: {
+        readonly seoTitle: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly seoDescription: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly seoImage: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "media";
+            readonly options: {
+                accept: readonly ("audio" | "file" | "image" | "video")[];
+                many: boolean;
+            };
+        };
+        readonly seoNoindex: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "boolean";
+            readonly options: {};
+        };
+        readonly title: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly slug: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "slug";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly summary: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly schedule: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly location: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly address: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly audience: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly cost: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly contact: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "text";
+            readonly options: Readonly<Record<string, unknown>>;
+        };
+        readonly coverImage: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "media";
+            readonly options: {
+                accept: readonly ("audio" | "file" | "image" | "video")[];
+                many: boolean;
+            };
+        };
+        readonly blocks: import("@cogenta/schema").FieldDefinition & {
+            readonly kind: "blocks";
+            readonly options: {
+                allow: "*" | readonly string[];
+            };
+        };
+    };
+    readonly indexes: readonly [readonly ["slug"]];
+    readonly permissions: {
+        readonly read: readonly ['public'];
+        readonly create: readonly ['editor', 'admin'];
+        readonly update: readonly ['editor', 'admin'];
+        readonly delete: readonly ['admin'];
+    };
+};
+export declare const page: CollectionDefinition;
+export declare const ASSOCIATION_COLLECTIONS: readonly CollectionDefinition[];
+export declare function nameOf(siteName: string | undefined): string;
+/** `volunteer@commonground.org.uk` for "Common Ground": the organisation's own name, as a mailbox. */
+export declare function associationEmail(siteName: string | undefined, mailbox?: string): string;
+type Media = Readonly<Record<string, string>>;
+export interface AssociationProgramme {
+    readonly slug: string;
+    readonly title: string;
+    readonly summary: string;
+    readonly schedule: string;
+    readonly location: string;
+    readonly audience: string;
+    readonly cost: string;
+    readonly mailbox: string;
+    /** `DemoMediaSpec.name` of its photograph. */
+    readonly photo: string;
+    /** The page's own text: `## ` headings and paragraphs. `{name}` is the organisation. */
+    readonly body: readonly string[];
+}
+export declare const ASSOCIATION_PROGRAMMES: readonly AssociationProgramme[];
+export declare function associationProgrammeBlocks(item: AssociationProgramme, siteName?: string): readonly VocabularyBlock[];
+export interface AssociationDemoEvent {
+    readonly title: string;
+    readonly slug: string;
+    /** Days from scaffold time, so the calendar is never empty and never stale. */
+    readonly daysFromNow: number;
+    readonly start: readonly [hour: number, minute: number];
+    readonly end: readonly [hour: number, minute: number];
+    readonly location: string;
+    readonly address: string;
+    readonly cost: string;
+    readonly booking: string;
+    readonly description: string;
+    /** `DemoMediaSpec.name` of its photograph, when it has one. */
+    readonly photo?: string;
+    /** The page's own text: `## ` headings and paragraphs. */
+    readonly body: readonly string[];
+}
+/**
+ * Six dates, one to six weeks out. The copy never names a weekday, because
+ * the day of the week depends on when the site is created.
+ */
+export declare const ASSOCIATION_DEMO_EVENTS: readonly AssociationDemoEvent[];
+export declare function associationEventBlocks(item: AssociationDemoEvent): readonly VocabularyBlock[];
+export interface AssociationDemoPage {
+    readonly title: string;
+    readonly slug: string;
+    readonly blocks: readonly VocabularyBlock[];
+}
+export declare const ASSOCIATION_PARTNERS: readonly [{
+    readonly key: 'partner-ashworth-college';
+    readonly name: 'Ashworth College';
+}, {
+    readonly key: 'partner-ashworth-council';
+    readonly name: 'Ashworth Borough Council';
+}, {
+    readonly key: 'partner-brindle-and-sons';
+    readonly name: 'Brindle & Sons';
+}, {
+    readonly key: 'partner-kestrel-homes';
+    readonly name: 'Kestrel Homes';
+}, {
+    readonly key: 'partner-linden-trust';
+    readonly name: 'The Linden Trust';
+}, {
+    readonly key: 'partner-marlow-street-pharmacy';
+    readonly name: 'Marlow Street Pharmacy';
+}];
+/**
+ * Every page, in the order the charity would present them. A function of
+ * `media` (`SeedContext.media`) and of the site's name: several blocks need
+ * ids `seedDemoMedia` only knows at scaffold time, and the copy names the
+ * organisation the site belongs to. With no media, every picture block is
+ * left out rather than emitted empty.
+ */
+export declare function buildAssociationDemoPages(media: Media, siteName?: string): readonly AssociationDemoPage[];
+/** Header navigation and the header's standing ask. The footer is grouped in columns: see `ASSOCIATION_FOOTER`. */
+export declare const ASSOCIATION_MENUS: BlueprintMenus;
+export interface FooterColumn {
+    readonly heading: string;
+    readonly links: readonly MenuItemSpec[];
+}
+export declare const ASSOCIATION_FOOTER: readonly FooterColumn[];
+export declare function associationFooterNote(siteName: string | undefined): string;
+export declare const ASSOCIATION_SITE_SETTINGS: Readonly<Record<string, unknown>>;
+export declare const ASSOCIATION_WIDGETS: readonly BlueprintWidget[];
+/**
+ * Bundled photographs (`assets/photos/association/`), every one looked at
+ * full size: lettering printed on aprons, T-shirts, caps, boxes and signs was
+ * retouched or cropped out, and a picture with too much of it (a river
+ * clean-up among labelled bins) was dropped. The partner wordmarks were
+ * rendered once from OFL typefaces. `spec` is only the fallback a missing
+ * file would get.
+ */
+export declare const ASSOCIATION_MEDIA_SPECS: readonly DemoMediaSpec[];
+export declare const ASSOCIATION_RECOMMENDED_AGENTS: readonly RecommendedAgentHint[];
+export declare const associationContentPack: BlueprintContentPack;
+export {};
+//# sourceMappingURL=association.d.ts.map

package/dist/blueprints/association.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"association.d.ts","sourceRoot":"","sources":["../../src/blueprints/association.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAExE,OAAO,EACL,KAAK,oBAAoB,EAW1B,MAAM,iBAAiB,CAAA;AAExB,OAAO,EACL,KAAK,oBAAoB,EAEzB,KAAK,oBAAoB,EAI1B,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,eAAO,MAAM,wBAAwB,yBAAyB,CAAA;AAC9D,eAAO,MAAM,iBAAiB,iBAAiB,CAAA;AAE/C,eAAO,MAAM,mBAAmB,sDAAsD,CAAA;AAGtF,eAAO,MAAM,cAAc,YAAY,CAAA;AASvC;;;;;GAKG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAZT,QAAQ;mCACN,QAAQ,EAAE,OAAO;mCACjB,QAAQ,EAAE,OAAO;mCACjB,OAAO;;CAoChB,CAAA;AAEF,0EAA0E;AAC1E,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCA1Cb,QAAQ;mCACN,QAAQ,EAAE,OAAO;mCACjB,QAAQ,EAAE,OAAO;mCACjB,OAAO;;CA8DhB,CAAA;AAEF,eAAO,MAAM,IAAI,sBAAiC,CAAA;AAElD,eAAO,MAAM,uBAAuB,EAAE,SAAS,oBAAoB,EAA6B,CAAA;AAUhG,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAG3D;AAED,sGAAsG;AACtG,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,SAAU,GAAG,MAAM,CAQxF;AA8FD,KAAK,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;AA4B7C,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,8CAA8C;IAC9C,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,wFAAwF;IACxF,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAA;CACjC;AAED,eAAO,MAAM,sBAAsB,EAAE,SAAS,oBAAoB,EAqFjE,CAAA;AAED,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,oBAAoB,EAC1B,QAAQ,CAAC,EAAE,MAAM,GAChB,SAAS,eAAe,EAAE,CAa5B;AAMD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,+EAA+E;IAC/E,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACvD,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACrD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,CAAA;CACjC;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,SAAS,oBAAoB,EA0HlE,CAAA;AAUD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,oBAAoB,GAAG,SAAS,eAAe,EAAE,CAS7F;AAMD,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,MAAM,EAAE,SAAS,eAAe,EAAE,CAAA;CAC5C;AAED,eAAO,MAAM,oBAAoB;aAC7B,GAAG,EAAE,0BAA0B;aAAE,IAAI,EAAE,kBAAkB;;aACzD,GAAG,EAAE,0BAA0B;aAAE,IAAI,EAAE,0BAA0B;;aACjE,GAAG,EAAE,0BAA0B;aAAE,IAAI,EAAE,gBAAgB;;aACvD,GAAG,EAAE,uBAAuB;aAAE,IAAI,EAAE,eAAe;;aACnD,GAAG,EAAE,sBAAsB;aAAE,IAAI,EAAE,kBAAkB;;aACrD,GAAG,EAAE,gCAAgC;aAAE,IAAI,EAAE,wBAAwB;EAC/D,CAAA;AAmpBV;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,KAAK,EACZ,QAAQ,CAAC,EAAE,MAAM,GAChB,SAAS,mBAAmB,EAAE,CAahC;AAMD,mHAAmH;AACnH,eAAO,MAAM,iBAAiB,EAAE,cAY/B,CAAA;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,CAAA;CACxC;AAED,eAAO,MAAM,kBAAkB,EAAE,SAAS,YAAY,EA2BrD,CAAA;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAY1E;AAED,eAAO,MAAM,yBAAyB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAYvE,CAAA;AA6BD,eAAO,MAAM,mBAAmB,EAAE,SAAS,eAAe,EAkDzD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,EAAE,SAAS,aAAa,EA6D3D,CAAA;AAeD,eAAO,MAAM,8BAA8B,EAAE,SAAS,oBAAoB,EAYzE,CAAA;AAuGD,eAAO,MAAM,sBAAsB,EAAE,oBASpC,CAAA"}