@velocity-astro/cms-core 0.1.0-beta.1 → 0.1.0-beta.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/access.d.ts +17 -1
- package/dist/access.d.ts.map +1 -1
- package/dist/access.js +17 -1
- package/dist/access.js.map +1 -1
- package/dist/cms.d.ts +7 -2
- package/dist/cms.d.ts.map +1 -1
- package/dist/cms.js +5 -2
- package/dist/cms.js.map +1 -1
- package/dist/events.d.ts +6 -1
- package/dist/events.d.ts.map +1 -1
- package/dist/events.js.map +1 -1
- package/dist/fields/blocks.d.ts +5 -0
- package/dist/fields/blocks.d.ts.map +1 -1
- package/dist/fields/blocks.js +12 -0
- package/dist/fields/blocks.js.map +1 -1
- package/dist/fields/index.d.ts +67 -5
- package/dist/fields/index.d.ts.map +1 -1
- package/dist/fields/index.js +77 -7
- package/dist/fields/index.js.map +1 -1
- package/dist/index.d.ts +12 -10
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +10 -8
- package/dist/index.js.map +1 -1
- package/dist/model.d.ts +108 -1
- package/dist/model.d.ts.map +1 -1
- package/dist/model.js.map +1 -1
- package/dist/page-address.d.ts +2 -0
- package/dist/page-address.d.ts.map +1 -1
- package/dist/page-address.js +2 -0
- package/dist/page-address.js.map +1 -1
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +5 -34
- package/dist/plugin.js.map +1 -1
- package/dist/ports.d.ts +75 -1
- package/dist/ports.d.ts.map +1 -1
- package/dist/rich-text.d.ts +20 -0
- package/dist/rich-text.d.ts.map +1 -1
- package/dist/rich-text.js +148 -0
- package/dist/rich-text.js.map +1 -1
- package/dist/schema-builder.d.ts +8 -0
- package/dist/schema-builder.d.ts.map +1 -1
- package/dist/schema-builder.js +36 -1
- package/dist/schema-builder.js.map +1 -1
- package/dist/seal.d.ts +22 -0
- package/dist/seal.d.ts.map +1 -0
- package/dist/seal.js +51 -0
- package/dist/seal.js.map +1 -0
- package/dist/search-text.d.ts +5 -0
- package/dist/search-text.d.ts.map +1 -1
- package/dist/search-text.js +7 -0
- package/dist/search-text.js.map +1 -1
- package/dist/services/media-service.d.ts +29 -4
- package/dist/services/media-service.d.ts.map +1 -1
- package/dist/services/media-service.js +88 -14
- package/dist/services/media-service.js.map +1 -1
- package/dist/services/pipeline-service.d.ts +4 -0
- package/dist/services/pipeline-service.d.ts.map +1 -1
- package/dist/services/pipeline-service.js +13 -1
- package/dist/services/pipeline-service.js.map +1 -1
- package/dist/services/schema-service.d.ts +4 -0
- package/dist/services/schema-service.d.ts.map +1 -1
- package/dist/services/schema-service.js +10 -1
- package/dist/services/schema-service.js.map +1 -1
- package/dist/services/settings-service.d.ts +157 -0
- package/dist/services/settings-service.d.ts.map +1 -0
- package/dist/services/settings-service.js +377 -0
- package/dist/services/settings-service.js.map +1 -0
- package/dist/testing/contracts.d.ts +3 -1
- package/dist/testing/contracts.d.ts.map +1 -1
- package/dist/testing/contracts.js +45 -1
- package/dist/testing/contracts.js.map +1 -1
- package/dist/testing/in-memory.d.ts +11 -2
- package/dist/testing/in-memory.d.ts.map +1 -1
- package/dist/testing/in-memory.js +41 -2
- package/dist/testing/in-memory.js.map +1 -1
- package/dist/testing/index.d.ts +2 -2
- package/dist/testing/index.d.ts.map +1 -1
- package/dist/testing/index.js +2 -2
- package/dist/testing/index.js.map +1 -1
- package/package.json +1 -1
package/dist/access.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export type Role = 'owner' | 'editor' | 'author';
|
|
2
|
-
export type Permission = 'schema:write' | 'entry:read' | 'entry:write' | 'entry:publish' | 'entry:delete' | 'form:write' | 'submission:read' | 'submission:manage' | 'contact:read' | 'contact:manage' | 'user:manage' | 'plugin:manage';
|
|
2
|
+
export type Permission = 'schema:write' | 'entry:read' | 'entry:write' | 'entry:publish' | 'entry:delete' | 'form:write' | 'submission:read' | 'submission:manage' | 'contact:read' | 'contact:manage' | 'user:manage' | 'plugin:manage' | 'settings:manage';
|
|
3
3
|
/**
|
|
4
4
|
* Whoever is asking for something: a signed-in person, a plugin, the CLI or an AI agent.
|
|
5
5
|
* All four pass through the same permission checks.
|
|
@@ -14,6 +14,22 @@ export interface Actor {
|
|
|
14
14
|
*/
|
|
15
15
|
readonly permissions?: readonly Permission[];
|
|
16
16
|
}
|
|
17
|
+
/** What a role grants, in a fixed order. */
|
|
18
|
+
export declare function permissionsOf(role: Role): Permission[];
|
|
19
|
+
/** The roles an access token may act as. Managing people, plugins, settings and content types stays with a person. */
|
|
20
|
+
export declare const TOKEN_ROLES: readonly Role[];
|
|
21
|
+
/** What an access token may do beyond its role's writing, each ticked by the owner who makes it. */
|
|
22
|
+
export interface TokenAllowances {
|
|
23
|
+
/** May publish, unpublish, schedule and delete for good. Left out, what the token writes stays a draft. */
|
|
24
|
+
readonly publish: boolean;
|
|
25
|
+
/** May read and change contacts, deals and what visitors sent, which are personal data. */
|
|
26
|
+
readonly personalData: boolean;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Exactly what a token may do: its role's grants, less publishing and personal data unless the
|
|
30
|
+
* owner allowed them. Never more than an editor.
|
|
31
|
+
*/
|
|
32
|
+
export declare function tokenPermissions(role: Role, allowed: TokenAllowances): Permission[];
|
|
17
33
|
/** Every role there is, from most to least allowed. */
|
|
18
34
|
export declare const ROLES: readonly Role[];
|
|
19
35
|
export declare class AccessControl {
|
package/dist/access.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"access.d.ts","sourceRoot":"","sources":["../src/access.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjD,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,GAAG,cAAc,GAAG,YAAY,GAAG,iBAAiB,GAAG,mBAAmB,GAAG,cAAc,GAAG,gBAAgB,GAAG,aAAa,GAAG,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"access.d.ts","sourceRoot":"","sources":["../src/access.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjD,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,GAAG,cAAc,GAAG,YAAY,GAAG,iBAAiB,GAAG,mBAAmB,GAAG,cAAc,GAAG,gBAAgB,GAAG,aAAa,GAAG,eAAe,GAAG,iBAAiB,CAAC;AAE7P;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC;IACnD,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;CAC9C;AAQD,4CAA4C;AAC5C,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,EAAE,CAEtD;AAED,sHAAsH;AACtH,eAAO,MAAM,WAAW,EAAE,SAAS,IAAI,EAAyB,CAAC;AAEjE,oGAAoG;AACpG,MAAM,WAAW,eAAe;IAC9B,2GAA2G;IAC3G,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,2FAA2F;IAC3F,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;CAChC;AAKD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,GAAG,UAAU,EAAE,CAGnF;AAED,uDAAuD;AACvD,eAAO,MAAM,KAAK,EAAE,SAAS,IAAI,EAAkC,CAAC;AAEpE,qBAAa,aAAa;IACxB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO;IAIlD,2FAA2F;IAC3F,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;CASpD"}
|
package/dist/access.js
CHANGED
|
@@ -1,9 +1,25 @@
|
|
|
1
1
|
import { ForbiddenError } from './errors.js';
|
|
2
2
|
const GRANTS = {
|
|
3
|
-
owner: new Set(['schema:write', 'entry:read', 'entry:write', 'entry:publish', 'entry:delete', 'form:write', 'submission:read', 'submission:manage', 'contact:read', 'contact:manage', 'user:manage', 'plugin:manage']),
|
|
3
|
+
owner: new Set(['schema:write', 'entry:read', 'entry:write', 'entry:publish', 'entry:delete', 'form:write', 'submission:read', 'submission:manage', 'contact:read', 'contact:manage', 'user:manage', 'plugin:manage', 'settings:manage']),
|
|
4
4
|
editor: new Set(['entry:read', 'entry:write', 'entry:publish', 'entry:delete', 'form:write', 'submission:read', 'submission:manage', 'contact:read', 'contact:manage']),
|
|
5
5
|
author: new Set(['entry:read', 'entry:write']),
|
|
6
6
|
};
|
|
7
|
+
/** What a role grants, in a fixed order. */
|
|
8
|
+
export function permissionsOf(role) {
|
|
9
|
+
return [...GRANTS[role]];
|
|
10
|
+
}
|
|
11
|
+
/** The roles an access token may act as. Managing people, plugins, settings and content types stays with a person. */
|
|
12
|
+
export const TOKEN_ROLES = ['editor', 'author'];
|
|
13
|
+
const PUBLISHING = new Set(['entry:publish', 'entry:delete']);
|
|
14
|
+
const PERSONAL = new Set(['submission:read', 'submission:manage', 'contact:read', 'contact:manage']);
|
|
15
|
+
/**
|
|
16
|
+
* Exactly what a token may do: its role's grants, less publishing and personal data unless the
|
|
17
|
+
* owner allowed them. Never more than an editor.
|
|
18
|
+
*/
|
|
19
|
+
export function tokenPermissions(role, allowed) {
|
|
20
|
+
const base = TOKEN_ROLES.includes(role) ? GRANTS[role] : GRANTS.author;
|
|
21
|
+
return [...base].filter((permission) => (allowed.publish || !PUBLISHING.has(permission)) && (allowed.personalData || !PERSONAL.has(permission)));
|
|
22
|
+
}
|
|
7
23
|
/** Every role there is, from most to least allowed. */
|
|
8
24
|
export const ROLES = ['owner', 'editor', 'author'];
|
|
9
25
|
export class AccessControl {
|
package/dist/access.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"access.js","sourceRoot":"","sources":["../src/access.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAqB7C,MAAM,MAAM,GAAoD;IAC9D,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"access.js","sourceRoot":"","sources":["../src/access.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAqB7C,MAAM,MAAM,GAAoD;IAC9D,KAAK,EAAE,IAAI,GAAG,CAAC,CAAC,cAAc,EAAE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC;IACzO,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,cAAc,EAAE,YAAY,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IACvK,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;CAC/C,CAAC;AAEF,4CAA4C;AAC5C,MAAM,UAAU,aAAa,CAAC,IAAU;IACtC,OAAO,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3B,CAAC;AAED,sHAAsH;AACtH,MAAM,CAAC,MAAM,WAAW,GAAoB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAUjE,MAAM,UAAU,GAA4B,IAAI,GAAG,CAAC,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC,CAAC;AACvF,MAAM,QAAQ,GAA4B,IAAI,GAAG,CAAC,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAE9H;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAU,EAAE,OAAwB;IACnE,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IACvE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;AACnJ,CAAC;AAED,uDAAuD;AACvD,MAAM,CAAC,MAAM,KAAK,GAAoB,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAEpE,MAAM,OAAO,aAAa;IACxB,GAAG,CAAC,KAAY,EAAE,UAAsB;QACtC,OAAO,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACzG,CAAC;IAED,2FAA2F;IAC3F,OAAO,CAAC,KAAY,EAAE,UAAsB;QAC1C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,cAAc,CACtB,KAAK,CAAC,WAAW;gBACf,CAAC,CAAC,OAAO,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,oBAAoB,UAAU,IAAI;gBAClE,CAAC,CAAC,OAAO,KAAK,CAAC,IAAI,yBAAyB,UAAU,IAAI,CAC7D,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}
|
package/dist/cms.d.ts
CHANGED
|
@@ -3,12 +3,13 @@ import { EventBus } from './events.js';
|
|
|
3
3
|
import type { FieldType } from './field-type.js';
|
|
4
4
|
import { PageHeads } from './pages.js';
|
|
5
5
|
import { PluginHost } from './plugin.js';
|
|
6
|
-
import type { Clock, ContactRepository, DealRepository, EntryRepository, FormRepository, IdGenerator, NameLookup, PipelineStore, CustomFieldsStore, PluginStore, SchemaRepository, SubmissionRepository, Team } from './ports.js';
|
|
6
|
+
import type { Clock, ContactRepository, DealRepository, EntryRepository, FormRepository, IdGenerator, NameLookup, PipelineStore, SettingsStore, CustomFieldsStore, PluginStore, SchemaRepository, SubmissionRepository, Team } from './ports.js';
|
|
7
7
|
import type { Registry } from './registry.js';
|
|
8
8
|
import { ContentService } from './services/content-service.js';
|
|
9
9
|
import { ContactService } from './services/contact-service.js';
|
|
10
10
|
import { DealService } from './services/deal-service.js';
|
|
11
11
|
import { PipelineService } from './services/pipeline-service.js';
|
|
12
|
+
import { SettingsService } from './services/settings-service.js';
|
|
12
13
|
import { CustomFieldsService } from './services/custom-fields-service.js';
|
|
13
14
|
import { FormService } from './services/form-service.js';
|
|
14
15
|
import { SubmissionService } from './services/submission-service.js';
|
|
@@ -24,7 +25,7 @@ export interface CmsOptions {
|
|
|
24
25
|
readonly media?: MediaServiceOptions;
|
|
25
26
|
/** The secret that signs preview links, and the language of the pages at a type's `urlPattern`. Without a secret there are no previews. */
|
|
26
27
|
readonly previews?: PreviewServiceOptions;
|
|
27
|
-
/** What
|
|
28
|
+
/** What the keys and passwords of plugins and of the site's settings are sealed with. Left out, the previews' secret is used; with neither, none can be saved. */
|
|
28
29
|
readonly secret?: string;
|
|
29
30
|
/**
|
|
30
31
|
* Where forms and what visitors send through them are kept. Without them both are kept in
|
|
@@ -38,6 +39,8 @@ export interface CmsOptions {
|
|
|
38
39
|
readonly deals?: DealRepository;
|
|
39
40
|
/** Where the stages of the pipeline are kept once someone changes them. Without one, in memory. */
|
|
40
41
|
readonly pipeline?: PipelineStore;
|
|
42
|
+
/** Where what an owner sets up in the editor's settings is kept. Without one, in memory. */
|
|
43
|
+
readonly settings?: SettingsStore;
|
|
41
44
|
/** Where the fields a site adds to its contacts and deals are kept. Without one, in memory. */
|
|
42
45
|
readonly customFields?: CustomFieldsStore;
|
|
43
46
|
/** Who is on the team, so a contact can be given to one of them. Without it nobody can be. */
|
|
@@ -67,6 +70,8 @@ export interface Cms {
|
|
|
67
70
|
/** The stages a contact moves through. */
|
|
68
71
|
readonly pipeline: PipelineService;
|
|
69
72
|
readonly customFields: CustomFieldsService;
|
|
73
|
+
/** What an owner sets up for the site in the editor, such as how its email is sent. */
|
|
74
|
+
readonly settings: SettingsService;
|
|
70
75
|
/** What contacts may buy, what each is worth and how far along it is. */
|
|
71
76
|
readonly deals: DealService;
|
|
72
77
|
readonly previews: PreviewService;
|
package/dist/cms.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cms.d.ts","sourceRoot":"","sources":["../src/cms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"cms.d.ts","sourceRoot":"","sources":["../src/cms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,iBAAiB,EAAE,WAAW,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAEjP,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACrF,OAAO,EAAE,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAC3F,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAC;IACjC,4CAA4C;IAC5C,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACtC,4GAA4G;IAC5G,QAAQ,CAAC,KAAK,CAAC,EAAE,mBAAmB,CAAC;IACrC,2IAA2I;IAC3I,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAC1C,kKAAkK;IAClK,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC;IAC5C,iGAAiG;IACjG,QAAQ,CAAC,QAAQ,CAAC,EAAE,iBAAiB,CAAC;IACtC,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAChC,mGAAmG;IACnG,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,4FAA4F;IAC5F,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,+FAA+F;IAC/F,QAAQ,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC;IAC1C,8FAA8F;IAC9F,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;IACnC,yGAAyG;IACzG,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAC7B,0DAA0D;IAC1D,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;CACnE;AAED,2FAA2F;AAC3F,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC;IAC7B,sDAAsD;IACtD,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAAC;IACxC,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC;IAC3C,uFAAuF;IACvF,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,yEAAyE;IACzE,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IACrC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC;IAC/B,uFAAuF;IACvF,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,yHAAyH;IACzH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC3B;AAKD;;;GAGG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,UAAU,GAAG,GAAG,CA0BlD"}
|
package/dist/cms.js
CHANGED
|
@@ -4,11 +4,13 @@ import { createFieldRegistry } from './fields/index.js';
|
|
|
4
4
|
import { PublishChecks } from './checks.js';
|
|
5
5
|
import { PageHeads } from './pages.js';
|
|
6
6
|
import { PluginHost } from './plugin.js';
|
|
7
|
-
import { InMemoryContactRepository, InMemoryDealRepository, InMemoryFormRepository, InMemoryPipelineStore, InMemoryCustomFieldsStore, InMemoryPluginStore, InMemorySubmissionRepository } from './testing/in-memory.js';
|
|
7
|
+
import { InMemoryContactRepository, InMemoryDealRepository, InMemoryFormRepository, InMemoryPipelineStore, InMemorySettingsStore, InMemoryCustomFieldsStore, InMemoryPluginStore, InMemorySubmissionRepository } from './testing/in-memory.js';
|
|
8
8
|
import { ContentService } from './services/content-service.js';
|
|
9
9
|
import { ContactService } from './services/contact-service.js';
|
|
10
10
|
import { DealService } from './services/deal-service.js';
|
|
11
11
|
import { PipelineService } from './services/pipeline-service.js';
|
|
12
|
+
import { SettingsService } from './services/settings-service.js';
|
|
13
|
+
import { SecretSeal } from './seal.js';
|
|
12
14
|
import { CustomFieldsService } from './services/custom-fields-service.js';
|
|
13
15
|
import { FormService } from './services/form-service.js';
|
|
14
16
|
import { SubmissionService } from './services/submission-service.js';
|
|
@@ -45,6 +47,7 @@ export function createCms(options) {
|
|
|
45
47
|
const previews = new PreviewService(content, schema, clock, options.previews);
|
|
46
48
|
const sealWith = options.secret ?? options.previews?.secret;
|
|
47
49
|
const plugins = new PluginHost({ fields, events, checks, pages, store: options.pluginStore ?? new InMemoryPluginStore(), ids, schema, content, access, clock, ...(sealWith !== undefined && { secret: sealWith }), ...(options.lookup && { lookup: options.lookup }), ...(options.onPluginFault && { onFault: options.onPluginFault }) });
|
|
48
|
-
|
|
50
|
+
const settings = new SettingsService(options.settings ?? new InMemorySettingsStore(), new SecretSeal(sealWith, 'velocity-cms site settings'), access, events);
|
|
51
|
+
return { settings, schema, content, media, forms, submissions, contacts, pipeline, customFields, deals, previews, fields, events, access, plugins, pages };
|
|
49
52
|
}
|
|
50
53
|
//# sourceMappingURL=cms.js.map
|
package/dist/cms.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cms.js","sourceRoot":"","sources":["../src/cms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"cms.js","sourceRoot":"","sources":["../src/cms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AAE/O,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,YAAY,EAA4B,MAAM,6BAA6B,CAAC;AACrF,OAAO,EAAE,cAAc,EAA8B,MAAM,+BAA+B,CAAC;AAC3F,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAuE7D,MAAM,WAAW,GAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;AACnE,MAAM,SAAS,GAAgB,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;AAE9E;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,OAAmB;IAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,mBAAmB,EAAE,CAAC;IACvD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC;IAC3C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,SAAS,CAAC;IACrC,MAAM,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACpF,MAAM,MAAM,GAAG,IAAI,aAAa,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,IAAI,SAAS,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IACxG,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACrE,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,sBAAsB,EAAE,CAAC;IAChE,MAAM,eAAe,GAAG,OAAO,CAAC,WAAW,IAAI,IAAI,4BAA4B,EAAE,CAAC;IAClF,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,SAAS,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9F,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,yBAAyB,EAAE,CAAC;IACzE,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,sBAAsB,EAAE,CAAC;IAChE,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,qBAAqB,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAClJ,MAAM,YAAY,GAAG,IAAI,mBAAmB,CAAC,OAAO,CAAC,YAAY,IAAI,IAAI,yBAAyB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IAC1I,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;IACnK,MAAM,KAAK,GAAG,IAAI,WAAW,CAAC,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACzK,MAAM,WAAW,GAAG,IAAI,iBAAiB,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC3H,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9E,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC5D,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,WAAW,IAAI,IAAI,mBAAmB,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,aAAa,EAAE,CAAC,EAAE,CAAC,CAAC;IAC1U,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,qBAAqB,EAAE,EAAE,IAAI,UAAU,CAAC,QAAQ,EAAE,4BAA4B,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9J,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC7J,CAAC"}
|
package/dist/events.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Actor } from './access.js';
|
|
2
2
|
import type { Permission } from './access.js';
|
|
3
|
-
import type { Contact, CustomFields, Deal, ContentTypeDef, Entry, FormDef, MediaFile, Pipeline, Submission } from './model.js';
|
|
3
|
+
import type { Contact, CustomFields, Deal, ContentTypeDef, Entry, FormDef, MediaFile, Pipeline, SettingsArea, Submission } from './model.js';
|
|
4
4
|
/** Everything the CMS announces, and what each announcement carries. */
|
|
5
5
|
export interface CmsEvents {
|
|
6
6
|
'type.saved': {
|
|
@@ -111,6 +111,11 @@ export interface CmsEvents {
|
|
|
111
111
|
fields: CustomFields;
|
|
112
112
|
actor: Actor;
|
|
113
113
|
};
|
|
114
|
+
/** One part of the site's settings was saved, such as how its email is sent. It carries no key. */
|
|
115
|
+
'settings.saved': {
|
|
116
|
+
area: SettingsArea;
|
|
117
|
+
actor: Actor;
|
|
118
|
+
};
|
|
114
119
|
'media.uploaded': {
|
|
115
120
|
file: MediaFile;
|
|
116
121
|
actor: Actor;
|
package/dist/events.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7I,wEAAwE;AACxE,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE;QAAE,IAAI,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACrD,mFAAmF;IACnF,eAAe,EAAE;QAAE,IAAI,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACxD,eAAe,EAAE;QAAE,IAAI,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACxD,aAAa,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAC9C,2FAA2F;IAC3F,iBAAiB,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACjE,mBAAmB,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACnE,+FAA+F;IAC/F,eAAe,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,MAAM,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAC/D,sDAAsD;IACtD,gBAAgB,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACjD,2EAA2E;IAC3E,eAAe,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAChD,YAAY,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAC9C,+FAA+F;IAC/F,cAAc,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAChD,eAAe,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACjD,cAAc,EAAE;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAChD,oFAAoF;IACpF,qBAAqB,EAAE;QAAE,UAAU,EAAE,UAAU,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IACjE,oDAAoD;IACpD,oBAAoB,EAAE;QAAE,UAAU,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAC/D,mGAAmG;IACnG,oBAAoB,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,SAAS,MAAM,EAAE,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAC/E,iFAAiF;IACjF,yGAAyG;IACzG,eAAe,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAC;QAAC,QAAQ,CAAC,EAAE,IAAI,CAAA;KAAE,CAAC;IACtE,4EAA4E;IAC5E,iBAAiB,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACtD,uDAAuD;IACvD,YAAY,EAAE;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC;IAC5C,cAAc,EAAE;QAAE,IAAI,EAAE,IAAI,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAC7C,qDAAqD;IACrD,gBAAgB,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACvD,qEAAqE;IACrE,qBAAqB,EAAE;QAAE,MAAM,EAAE,YAAY,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IAC9D,mGAAmG;IACnG,gBAAgB,EAAE;QAAE,IAAI,EAAE,YAAY,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACvD,gBAAgB,EAAE;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACpD,eAAe,EAAE;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACnD,mEAAmE;IACnE,gBAAgB,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;IACnD,+FAA+F;IAC/F,eAAe,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACrC;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,SAAS,EAAE,UAAU,CAAC,CAAC,CAO9E,CAAC;AAEF,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAExD,qBAAa,QAAQ;;IAGnB,qEAAqE;IACrE,EAAE,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI;IAOrF,yEAAyE;IACnE,IAAI,CAAC,CAAC,SAAS,MAAM,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAKtF"}
|
package/dist/events.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAqDA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAA2D;IACjF,qBAAqB,EAAE,iBAAiB;IACxC,oBAAoB,EAAE,iBAAiB;IACvC,eAAe,EAAE,cAAc;IAC/B,iBAAiB,EAAE,cAAc;IACjC,YAAY,EAAE,cAAc;IAC5B,cAAc,EAAE,cAAc;CAC/B,CAAC;AAIF,MAAM,OAAO,QAAQ;IACV,UAAU,GAAG,IAAI,GAAG,EAAyC,CAAC;IAEvE,qEAAqE;IACrE,EAAE,CAA4B,KAAQ,EAAE,QAAgC;QACtE,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC;QAC1D,SAAS,CAAC,GAAG,CAAC,QAA2B,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACtC,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,QAA2B,CAAC,CAAC;IAC7D,CAAC;IAED,yEAAyE;IACzE,KAAK,CAAC,IAAI,CAA4B,KAAQ,EAAE,OAAqB;QACnE,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YACxD,MAAO,QAAmC,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;CACF"}
|
package/dist/fields/blocks.d.ts
CHANGED
|
@@ -12,6 +12,11 @@ export interface NewBlock {
|
|
|
12
12
|
readonly icon?: string;
|
|
13
13
|
/** What the picker files it under, such as `Content`. */
|
|
14
14
|
readonly group?: string;
|
|
15
|
+
/**
|
|
16
|
+
* A picture of the block for the picker, as a path on the site: a file the template keeps in
|
|
17
|
+
* `public/`, such as `/cms/blocks/call-to-action.webp`. Wide, 16 by 9, and small.
|
|
18
|
+
*/
|
|
19
|
+
readonly thumbnail?: string;
|
|
15
20
|
readonly fields?: readonly NewField[];
|
|
16
21
|
}
|
|
17
22
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../../src/fields/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAA4B,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE9E,OAAO,EAAE,SAAS,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAGpF,mEAAmE;AACnE,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,qDAAqD;IACrD,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC;IACrC,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAGrD;AAED,UAAU,aAAa;IACrB,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAWD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,SAAS,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC;IACrE,QAAQ,CAAC,IAAI,YAAY;IACzB,QAAQ,CAAC,MAAM,YAAY;IAC3B,QAAQ,CAAC,OAAO;;;;sBAIb;IAEH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY;;;;;;;;;;;IAqCjE,0FAA0F;IACjF,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,GAAG,WAAW,EAAE;IAWvG;;;;;OAKG;IACM,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa;;;
|
|
1
|
+
{"version":3,"file":"blocks.d.ts","sourceRoot":"","sources":["../../src/fields/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAA4B,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE9E,OAAO,EAAE,SAAS,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAGpF,mEAAmE;AACnE,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,qDAAqD;IACrD,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC;IACrC,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,yDAAyD;IACzD,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAGrD;AAED,UAAU,aAAa;IACrB,MAAM,EAAE,QAAQ,EAAE,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAWD;;;GAGG;AACH,qBAAa,WAAY,SAAQ,SAAS,CAAC,UAAU,EAAE,EAAE,aAAa,CAAC;IACrE,QAAQ,CAAC,IAAI,YAAY;IACzB,QAAQ,CAAC,MAAM,YAAY;IAC3B,QAAQ,CAAC,OAAO;;;;sBAIb;IAEH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY;;;;;;;;;;;IAqCjE,0FAA0F;IACjF,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,GAAG,WAAW,EAAE;IAWvG;;;;;OAKG;IACM,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa;;;CAgC9I"}
|
package/dist/fields/blocks.js
CHANGED
|
@@ -124,6 +124,7 @@ export class BlocksField extends FieldType {
|
|
|
124
124
|
...(input.description !== undefined && { description: input.description }),
|
|
125
125
|
...(input.icon !== undefined && { icon: input.icon }),
|
|
126
126
|
...(input.group !== undefined && { group: input.group }),
|
|
127
|
+
...(input.thumbnail !== undefined && { thumbnail: sitePath(input.key, input.thumbnail) }),
|
|
127
128
|
fields,
|
|
128
129
|
// A retired block sent back with the rest is stored state, not a description: it stays retired.
|
|
129
130
|
...(typeof input.retiredAt === 'string' && { retiredAt: input.retiredAt }),
|
|
@@ -134,6 +135,17 @@ export class BlocksField extends FieldType {
|
|
|
134
135
|
return { ...described, blocks: [...blocks, ...retired] };
|
|
135
136
|
}
|
|
136
137
|
}
|
|
138
|
+
/**
|
|
139
|
+
* A block's picture is loaded by the editor, so it may only be a file of the site itself: a path
|
|
140
|
+
* from its top, never another site's address.
|
|
141
|
+
*/
|
|
142
|
+
function sitePath(key, value) {
|
|
143
|
+
if (typeof value === 'string' && /^\/[^/\\\s][^\\\s]*$/.test(value))
|
|
144
|
+
return value;
|
|
145
|
+
throw new ValidationError(`The picture of the block "${key}" must be a path on the site, such as "/cms/blocks/${key}.webp". Put the file in the site's public folder and give its path.`, [
|
|
146
|
+
{ path: ['blocks', key, 'thumbnail'], message: 'A path on the site is needed' },
|
|
147
|
+
]);
|
|
148
|
+
}
|
|
137
149
|
/** A section without the properties that were sent as `undefined`, so what is stored compares equal to what was sent. */
|
|
138
150
|
function withoutUnset(value) {
|
|
139
151
|
return { id: value.id, block: value.block, data: value.data, ...(value.hidden === true && { hidden: true }) };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"blocks.js","sourceRoot":"","sources":["../../src/fields/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,UAAU,EAAiB,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAyC,MAAM,kBAAkB,CAAC;AAEpF,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"blocks.js","sourceRoot":"","sources":["../../src/fields/blocks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,UAAU,EAAiB,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAyC,MAAM,kBAAkB,CAAC;AAEpF,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAoBvE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,WAAW,CAAC,KAAe;IACzC,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,KAAK,CAAC;AACf,CAAC;AAQD,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAa,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,2BAA2B,CAAC,CAAC;AAErG,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IACvB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IACvC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,OAAO,WAAY,SAAQ,SAAsC;IAC5D,IAAI,GAAG,QAAQ,CAAC;IAChB,MAAM,GAAG,QAAQ,CAAC;IAClB,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;QAC1B,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;QACvC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;KAC5C,CAAC,CAAC;IAEH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAiB,EAAE,OAAqB;QAC/D,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,GAAG,GAAG,OAAO;aAChB,WAAW,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;YACjC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,gGAAgG,EAAE,CAAC,CAAC;gBACpK,OAAO;YACT,CAAC;YACD,gGAAgG;YAChG,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS;gBAAE,OAAO;YAC1C,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC/E,IAAI,OAAO,CAAC,OAAO;gBAAE,OAAO;YAC5B,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBACzC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACjG,CAAC;QACH,CAAC,CAAC;aACD,SAAS,CAAC,CAAC,KAAK,EAAc,EAAE;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,OAAO,GAAG,KAAK,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACpI,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE,OAAO;gBAAE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;YAC5D,qFAAqF;YACrF,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7K,OAAO,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;QACL,IAAI,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,GAAG,KAAK,SAAS;YAAE,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,GAAG,KAAK,SAAS;YAAE,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1C,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;YAC/B,QAAQ,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;gBAChC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;oBAAE,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,mDAAmD,EAAE,CAAC,CAAC;gBACnJ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,0FAA0F;IACjF,QAAQ,CAAC,KAAmB,EAAE,EAAE,MAAM,EAAiB,EAAE,OAAqB;QACrF,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/D,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI;gBAAE,SAAS;YAC7E,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;QACpG,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACM,MAAM,CAAC,SAA4C,EAAE,QAAuD,EAAE,OAAsB;QAC3I,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAE,QAAQ,CAAC,QAAQ,CAAgB,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7F,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QACjE,MAAM,MAAM,GAAe,EAAE,CAAC;QAC9B,KAAK,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAyD,EAAE,CAAC;YACxG,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;gBACrG,MAAM,IAAI,eAAe,CAAC,mBAAmB,KAAK,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC,CAAC,CAAC;YAC9I,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,KAAK,CAAC,GAAG,CAAC;gBAAE,MAAM,IAAI,aAAa,CAAC,4BAA4B,KAAK,CAAC,GAAG,uBAAuB,CAAC,CAAC;YAC3I,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACrC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YACrE,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC5F,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CACrG,CAAC;YACF,MAAM,CAAC,IAAI,CAAC;gBACV,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBACjF,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,GAAG,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;gBAC1E,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;gBACrD,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;gBACxD,GAAG,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACzF,MAAM;gBACN,gGAAgG;gBAChG,GAAG,CAAC,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC;aAC3E,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7J,OAAO,EAAE,GAAG,SAAS,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;IAC3D,CAAC;CACF;AAED;;;GAGG;AACH,SAAS,QAAQ,CAAC,GAAW,EAAE,KAAc;IAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAClF,MAAM,IAAI,eAAe,CAAC,6BAA6B,GAAG,sDAAsD,GAAG,qEAAqE,EAAE;QACxL,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,OAAO,EAAE,8BAA8B,EAAE;KAChF,CAAC,CAAC;AACL,CAAC;AAED,yHAAyH;AACzH,SAAS,YAAY,CAAC,KAA8F;IAClH,OAAO,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,IAAI,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AAChH,CAAC"}
|
package/dist/fields/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from 'zod';
|
|
|
2
2
|
import { FieldType, type DefineContext, type FieldContext } from '../field-type.js';
|
|
3
3
|
import type { FieldDef } from '../model.js';
|
|
4
4
|
import { Registry } from '../registry.js';
|
|
5
|
-
import { type RichText } from '../rich-text.js';
|
|
5
|
+
import { type RichText, type RichTextFormat } from '../rich-text.js';
|
|
6
6
|
export { BlocksField, defineBlock, type NewBlock } from './blocks.js';
|
|
7
7
|
export { LinkField, type AddressLink, type EntryLink, type LinkValue } from './link.js';
|
|
8
8
|
declare const noOptions: z.ZodObject<{}, z.core.$strip>;
|
|
@@ -83,16 +83,20 @@ export declare class PhoneField extends FieldType<string, NoOptions> {
|
|
|
83
83
|
schema(): z.ZodString;
|
|
84
84
|
get takesSubmissions(): boolean;
|
|
85
85
|
}
|
|
86
|
+
/** Whether a value is a colour a swatch can show. */
|
|
87
|
+
export declare function isSwatchColour(value: unknown): value is string;
|
|
86
88
|
/** One choice from a fixed list. */
|
|
87
89
|
export declare class SelectField extends FieldType<string, {
|
|
88
90
|
choices: string[];
|
|
89
91
|
labels?: Record<string, Record<string, string>> | undefined;
|
|
92
|
+
swatches?: Record<string, string> | undefined;
|
|
90
93
|
}> {
|
|
91
94
|
readonly type = "select";
|
|
92
95
|
readonly editor = "select";
|
|
93
96
|
readonly options: z.ZodObject<{
|
|
94
97
|
choices: z.ZodArray<z.ZodString>;
|
|
95
98
|
labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
99
|
+
swatches: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>>;
|
|
96
100
|
}, z.core.$strip>;
|
|
97
101
|
schema({ choices }: {
|
|
98
102
|
choices: string[];
|
|
@@ -101,6 +105,44 @@ export declare class SelectField extends FieldType<string, {
|
|
|
101
105
|
}>;
|
|
102
106
|
get takesSubmissions(): boolean;
|
|
103
107
|
}
|
|
108
|
+
/** Whether a value is a colour a `color` field holds. */
|
|
109
|
+
export declare function isHexColour(value: unknown): value is string;
|
|
110
|
+
/**
|
|
111
|
+
* A colour of the site's theme that a person sets, such as the brand colour: a hex colour and
|
|
112
|
+
* nothing else, so a template can put it in a style without it ever being an address or more CSS.
|
|
113
|
+
* The template decides where it is used, and what goes with it (the text on it, its shades).
|
|
114
|
+
*/
|
|
115
|
+
export declare class ColorField extends FieldType<string, {
|
|
116
|
+
presets?: string[] | undefined;
|
|
117
|
+
}> {
|
|
118
|
+
readonly type = "color";
|
|
119
|
+
readonly editor = "color-picker";
|
|
120
|
+
readonly options: z.ZodObject<{
|
|
121
|
+
presets: z.ZodOptional<z.ZodArray<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>>;
|
|
122
|
+
}, z.core.$strip>;
|
|
123
|
+
schema(): z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* One of the fonts a template offers for a part of the site, such as its headings. What is
|
|
127
|
+
* stored is the font's name among `choices`; the template loads the font and decides where it
|
|
128
|
+
* goes, so only fonts it has can be chosen.
|
|
129
|
+
*/
|
|
130
|
+
export declare class FontField extends FieldType<string, {
|
|
131
|
+
choices: string[];
|
|
132
|
+
labels?: Record<string, Record<string, string>> | undefined;
|
|
133
|
+
}> {
|
|
134
|
+
readonly type = "font";
|
|
135
|
+
readonly editor = "font-picker";
|
|
136
|
+
readonly options: z.ZodObject<{
|
|
137
|
+
choices: z.ZodArray<z.ZodString>;
|
|
138
|
+
labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
139
|
+
}, z.core.$strip>;
|
|
140
|
+
schema({ choices }: {
|
|
141
|
+
choices: string[];
|
|
142
|
+
}): z.ZodEnum<{
|
|
143
|
+
[x: string]: string;
|
|
144
|
+
}>;
|
|
145
|
+
}
|
|
104
146
|
/**
|
|
105
147
|
* A link to an entry of another content type, such as a listing's agent.
|
|
106
148
|
*
|
|
@@ -149,17 +191,37 @@ export interface PublicRichText {
|
|
|
149
191
|
/** The words alone, one entry per paragraph, heading or list item. */
|
|
150
192
|
readonly paragraphs: readonly string[];
|
|
151
193
|
}
|
|
194
|
+
/** The settings of a rich text field. */
|
|
195
|
+
export interface RichTextOptions {
|
|
196
|
+
/** What the field may hold beyond paragraphs. Left out, everything the format has. */
|
|
197
|
+
readonly formats?: readonly RichTextFormat[] | undefined;
|
|
198
|
+
}
|
|
152
199
|
/**
|
|
153
200
|
* Text with headings, lists, bold, italics and links. Stored as a tree, never as HTML, and given
|
|
154
201
|
* to the site as HTML made from that tree. A field that was plain text, or a list of
|
|
155
202
|
* paragraphs, can be changed to this type: what is stored is read as paragraphs.
|
|
203
|
+
*
|
|
204
|
+
* A field shown in a tight spot of a design names the formats that spot was drawn for
|
|
205
|
+
* (`formats`): the editor offers only those, and anything else that reaches a save (pasted, or
|
|
206
|
+
* sent by a script) is turned into plain paragraphs, never refused, so no words are lost. What is
|
|
207
|
+
* handed to the site is limited the same way, for text saved before the field was.
|
|
156
208
|
*/
|
|
157
|
-
export declare class RichTextField extends FieldType<RichText,
|
|
209
|
+
export declare class RichTextField extends FieldType<RichText, RichTextOptions> {
|
|
158
210
|
readonly type = "richtext";
|
|
159
211
|
readonly editor = "rich-text";
|
|
160
|
-
readonly options: z.ZodObject<{
|
|
161
|
-
|
|
162
|
-
|
|
212
|
+
readonly options: z.ZodObject<{
|
|
213
|
+
formats: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
214
|
+
bold: "bold";
|
|
215
|
+
italic: "italic";
|
|
216
|
+
link: "link";
|
|
217
|
+
headings: "headings";
|
|
218
|
+
lists: "lists";
|
|
219
|
+
quotes: "quotes";
|
|
220
|
+
}>>>;
|
|
221
|
+
}, z.core.$strip>;
|
|
222
|
+
schema({ formats }: RichTextOptions): z.ZodType<RichText, unknown, z.core.$ZodTypeInternals<RichText, unknown>>;
|
|
223
|
+
define(described: Readonly<Record<string, unknown>>): Readonly<Record<string, unknown>>;
|
|
224
|
+
toPublic(value: RichText | string | readonly string[], { formats }: RichTextOptions): PublicRichText;
|
|
163
225
|
}
|
|
164
226
|
/** Several fields kept together as one value, such as an address. */
|
|
165
227
|
export declare class GroupField extends FieldType<Record<string, unknown>, {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fields/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,SAAS,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fields/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,SAAS,EAAE,KAAK,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAqG,KAAK,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAKxK,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AAExF,QAAA,MAAM,SAAS,gCAAe,CAAC;AAC/B,KAAK,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAE3C,qBAAa,SAAU,SAAQ,SAAS,CAAC,MAAM,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAAC;IACtG,QAAQ,CAAC,IAAI,UAAU;IACvB,QAAQ,CAAC,MAAM,gBAAgB;IAC/B,QAAQ,CAAC,OAAO;;;sBAGb;IAEH,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE;IAIxD,IAAa,gBAAgB,YAE5B;CACF;AAED,qBAAa,WAAY,SAAQ,SAAS,CACxC,MAAM,EACN;IAAE,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CACzE;IACC,QAAQ,CAAC,IAAI,YAAY;IACzB,QAAQ,CAAC,MAAM,kBAAkB;IACjC,QAAQ,CAAC,OAAO;;;;sBAIb;IAEH,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE;IAOtG,IAAa,gBAAgB,YAE5B;IAED,2GAA2G;IAClG,aAAa,CAAC,GAAG,EAAE,OAAO;CAOpC;AAED,qBAAa,YAAa,SAAQ,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC;IAC7D,QAAQ,CAAC,IAAI,aAAa;IAC1B,QAAQ,CAAC,MAAM,YAAY;IAC3B,QAAQ,CAAC,OAAO,iCAAa;IAE7B,MAAM;IAIN,IAAa,gBAAgB,YAE5B;IAED,yGAAyG;IAChG,aAAa,CAAC,GAAG,EAAE,OAAO;CAGpC;AAED,+CAA+C;AAC/C,qBAAa,SAAU,SAAQ,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;IACzD,QAAQ,CAAC,IAAI,UAAU;IACvB,QAAQ,CAAC,MAAM,iBAAiB;IAChC,QAAQ,CAAC,OAAO,iCAAa;IAE7B,MAAM;IAIN,IAAa,gBAAgB,YAE5B;CACF;AAED,qBAAa,QAAS,SAAQ,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;IACxD,QAAQ,CAAC,IAAI,SAAS;IACtB,QAAQ,CAAC,MAAM,eAAe;IAC9B,QAAQ,CAAC,OAAO,iCAAa;IAE7B,MAAM;IAIN,IAAa,gBAAgB,YAE5B;CACF;AAED,4EAA4E;AAC5E,qBAAa,UAAW,SAAQ,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;IAC1D,QAAQ,CAAC,IAAI,WAAW;IACxB,QAAQ,CAAC,MAAM,iBAAiB;IAChC,QAAQ,CAAC,OAAO,iCAAa;IAE7B,MAAM;IAIN,IAAa,gBAAgB,YAE5B;CACF;AAED,yFAAyF;AACzF,qBAAa,UAAW,SAAQ,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;IAC1D,QAAQ,CAAC,IAAI,WAAW;IACxB,QAAQ,CAAC,MAAM,iBAAiB;IAChC,QAAQ,CAAC,OAAO,iCAAa;IAE7B,MAAM;IAIN,IAAa,gBAAgB,YAE5B;CACF;AAQD,qDAAqD;AACrD,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE9D;AAED,oCAAoC;AACpC,qBAAa,WAAY,SAAQ,SAAS,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;CAAE,CAAC;IACnL,QAAQ,CAAC,IAAI,YAAY;IACzB,QAAQ,CAAC,MAAM,YAAY;IAC3B,QAAQ,CAAC,OAAO;;;;sBAWb;IAEH,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE;;;IAIzC,IAAa,gBAAgB,YAE5B;CACF;AAKD,yDAAyD;AACzD,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE3D;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,SAAS,CAAC,MAAM,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;CAAE,CAAC;IACnF,QAAQ,CAAC,IAAI,WAAW;IACxB,QAAQ,CAAC,MAAM,kBAAkB;IACjC,QAAQ,CAAC,OAAO;;sBAGb;IAEH,MAAM;CAGP;AAED;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,SAAS,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAA;CAAE,CAAC;IAClI,QAAQ,CAAC,IAAI,UAAU;IACvB,QAAQ,CAAC,MAAM,iBAAiB;IAChC,QAAQ,CAAC,OAAO;;;sBAKb;IAEH,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE;;;CAG1C;AAED;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,SAAS,CAAC,MAAM,EAAE;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAC;IACnE,QAAQ,CAAC,IAAI,eAAe;IAC5B,QAAQ,CAAC,MAAM,eAAe;IAC9B,QAAQ,CAAC,OAAO;;sBAGb;IAEH,MAAM;CAGP;AAED;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;IACzD,QAAQ,CAAC,IAAI,UAAU;IACvB,QAAQ,CAAC,MAAM,iBAAiB;IAChC,QAAQ,CAAC,OAAO,iCAAa;IAE7B,MAAM;CAGP;AAED;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;IAC1D,QAAQ,CAAC,IAAI,WAAW;IACxB,QAAQ,CAAC,MAAM,WAAW;IAC1B,QAAQ,CAAC,OAAO,iCAAa;IAE7B,MAAM;CAGP;AAED,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,kDAAkD;IAClD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sEAAsE;IACtE,QAAQ,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;CACxC;AAED,yCAAyC;AACzC,MAAM,WAAW,eAAe;IAC9B,sFAAsF;IACtF,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,cAAc,EAAE,GAAG,SAAS,CAAC;CAC1D;AAED;;;;;;;;;GASG;AACH,qBAAa,aAAc,SAAQ,SAAS,CAAC,QAAQ,EAAE,eAAe,CAAC;IACrE,QAAQ,CAAC,IAAI,cAAc;IAC3B,QAAQ,CAAC,MAAM,eAAe;IAC9B,QAAQ,CAAC,OAAO;;;;;;;;;sBAAwE;IAExF,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,eAAe;IAI1B,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAOvF,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,eAAe,GAAG,cAAc;CAM9G;AAKD,qEAAqE;AACrE,qBAAa,UAAW,SAAQ,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAC;IACxF,QAAQ,CAAC,IAAI,WAAW;IACxB,QAAQ,CAAC,MAAM,WAAW;IAC1B,QAAQ,CAAC,OAAO;;sBAAmC;IAEnD,MAAM,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;KAAE,EAAE,OAAO,EAAE,YAAY;IAIvD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;KAAE,EAAE,OAAO,EAAE,YAAY;IAIlG,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa;;;IAKpI,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,QAAQ,EAAE;IAItE,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,QAAQ,EAAE;;;CAG1F;AAED,UAAU,WAAW;IACnB,wDAAwD;IACxD,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;IACvD,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED,mEAAmE;AACnE,qBAAa,SAAU,SAAQ,SAAS,CAAC,OAAO,EAAE,EAAE,WAAW,CAAC;IAC9D,QAAQ,CAAC,IAAI,UAAU;IACvB,QAAQ,CAAC,MAAM,UAAU;IACzB,QAAQ,CAAC,OAAO;;;;;;;sBAIb;IAEH,MAAM,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY;IAQlD,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY;IAOrE,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa;;;;;;IAO7I,sDAAsD;IAC7C,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,QAAQ,EAAE;IAKpG,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,QAAQ,EAAE,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC;;;;;;CAKxH;AAED,0FAA0F;AAC1F,wBAAgB,mBAAmB,IAAI,QAAQ,CAAC,SAAS,CAAC,CAoBzD"}
|
package/dist/fields/index.js
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from 'zod';
|
|
|
2
2
|
import { defineFields } from '../define-fields.js';
|
|
3
3
|
import { FieldType } from '../field-type.js';
|
|
4
4
|
import { Registry } from '../registry.js';
|
|
5
|
-
import { fromPlainText, richTextHtml, richTextParagraphs, richTextSchema } from '../rich-text.js';
|
|
5
|
+
import { fromPlainText, limitRichText, RICH_TEXT_FORMATS, richTextHtml, richTextParagraphs, richTextSchema } from '../rich-text.js';
|
|
6
6
|
import { buildFieldsSchema, toPublicData } from '../schema-builder.js';
|
|
7
7
|
import { BlocksField } from './blocks.js';
|
|
8
8
|
import { LinkField } from './link.js';
|
|
@@ -115,6 +115,15 @@ export class PhoneField extends FieldType {
|
|
|
115
115
|
return true;
|
|
116
116
|
}
|
|
117
117
|
}
|
|
118
|
+
/**
|
|
119
|
+
* A colour as a swatch may say it: a hex colour, or one of CSS's colour functions holding only
|
|
120
|
+
* numbers. It is drawn as a sample beside a choice, so it must be a colour and nothing else.
|
|
121
|
+
*/
|
|
122
|
+
const SWATCH_COLOUR = /^(?:#(?:[0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})|(?:oklch|oklab|rgb|hsl)\([0-9.%,/ -]+\))$/i;
|
|
123
|
+
/** Whether a value is a colour a swatch can show. */
|
|
124
|
+
export function isSwatchColour(value) {
|
|
125
|
+
return typeof value === 'string' && value.length <= 64 && SWATCH_COLOUR.test(value);
|
|
126
|
+
}
|
|
118
127
|
/** One choice from a fixed list. */
|
|
119
128
|
export class SelectField extends FieldType {
|
|
120
129
|
type = 'select';
|
|
@@ -124,6 +133,12 @@ export class SelectField extends FieldType {
|
|
|
124
133
|
choices: z.array(z.string()).min(1),
|
|
125
134
|
/** What the editor calls each choice, per language: `{ 'coming-soon': { en: 'Coming soon' } }`. */
|
|
126
135
|
labels: z.record(z.string(), z.record(z.string(), z.string())).optional(),
|
|
136
|
+
/**
|
|
137
|
+
* A sample colour for each choice, where the choices are looks of the template's own (a
|
|
138
|
+
* section's background): `{ secondary: '#f4f1ec' }`. The editor then shows the choices as
|
|
139
|
+
* swatches. The value stored is still the choice's name, never the colour.
|
|
140
|
+
*/
|
|
141
|
+
swatches: z.record(z.string(), z.string().refine(isSwatchColour, 'A swatch is a hex colour or a CSS colour function, such as #f4f1ec or oklch(96% 0.01 80).')).optional(),
|
|
127
142
|
});
|
|
128
143
|
schema({ choices }) {
|
|
129
144
|
return z.enum(choices);
|
|
@@ -132,6 +147,46 @@ export class SelectField extends FieldType {
|
|
|
132
147
|
return true;
|
|
133
148
|
}
|
|
134
149
|
}
|
|
150
|
+
/** A hex colour: `#rgb` or `#rrggbb`, what a colour picker hands back. */
|
|
151
|
+
const HEX_COLOUR = /^#(?:[0-9a-f]{3}|[0-9a-f]{6})$/i;
|
|
152
|
+
/** Whether a value is a colour a `color` field holds. */
|
|
153
|
+
export function isHexColour(value) {
|
|
154
|
+
return typeof value === 'string' && HEX_COLOUR.test(value);
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* A colour of the site's theme that a person sets, such as the brand colour: a hex colour and
|
|
158
|
+
* nothing else, so a template can put it in a style without it ever being an address or more CSS.
|
|
159
|
+
* The template decides where it is used, and what goes with it (the text on it, its shades).
|
|
160
|
+
*/
|
|
161
|
+
export class ColorField extends FieldType {
|
|
162
|
+
type = 'color';
|
|
163
|
+
editor = 'color-picker';
|
|
164
|
+
options = z.object({
|
|
165
|
+
/** Colours to suggest, a press away, as hex colours: the template's own palette. At most 12. */
|
|
166
|
+
presets: z.array(z.string().refine(isHexColour, 'A suggested colour is a hex colour, such as #1f3a5f.')).max(12).optional(),
|
|
167
|
+
});
|
|
168
|
+
schema() {
|
|
169
|
+
return z.string().refine(isHexColour, 'Type a hex colour, such as #1f3a5f.');
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* One of the fonts a template offers for a part of the site, such as its headings. What is
|
|
174
|
+
* stored is the font's name among `choices`; the template loads the font and decides where it
|
|
175
|
+
* goes, so only fonts it has can be chosen.
|
|
176
|
+
*/
|
|
177
|
+
export class FontField extends FieldType {
|
|
178
|
+
type = 'font';
|
|
179
|
+
editor = 'font-picker';
|
|
180
|
+
options = z.object({
|
|
181
|
+
/** The fonts that can be chosen, by the names the template knows them by: `['inter', 'fraunces']`. */
|
|
182
|
+
choices: z.array(z.string()).min(1),
|
|
183
|
+
/** What the editor calls each font, per language: `{ fraunces: { en: 'Fraunces' } }`. */
|
|
184
|
+
labels: z.record(z.string(), z.record(z.string(), z.string())).optional(),
|
|
185
|
+
});
|
|
186
|
+
schema({ choices }) {
|
|
187
|
+
return z.enum(choices);
|
|
188
|
+
}
|
|
189
|
+
}
|
|
135
190
|
/**
|
|
136
191
|
* A link to an entry of another content type, such as a listing's agent.
|
|
137
192
|
*
|
|
@@ -182,17 +237,30 @@ export class ImageField extends FieldType {
|
|
|
182
237
|
* Text with headings, lists, bold, italics and links. Stored as a tree, never as HTML, and given
|
|
183
238
|
* to the site as HTML made from that tree. A field that was plain text, or a list of
|
|
184
239
|
* paragraphs, can be changed to this type: what is stored is read as paragraphs.
|
|
240
|
+
*
|
|
241
|
+
* A field shown in a tight spot of a design names the formats that spot was drawn for
|
|
242
|
+
* (`formats`): the editor offers only those, and anything else that reaches a save (pasted, or
|
|
243
|
+
* sent by a script) is turned into plain paragraphs, never refused, so no words are lost. What is
|
|
244
|
+
* handed to the site is limited the same way, for text saved before the field was.
|
|
185
245
|
*/
|
|
186
246
|
export class RichTextField extends FieldType {
|
|
187
247
|
type = 'richtext';
|
|
188
248
|
editor = 'rich-text';
|
|
189
|
-
options =
|
|
190
|
-
schema() {
|
|
191
|
-
return richTextSchema;
|
|
192
|
-
}
|
|
193
|
-
|
|
249
|
+
options = z.object({ formats: z.array(z.enum(RICH_TEXT_FORMATS)).optional() });
|
|
250
|
+
schema({ formats }) {
|
|
251
|
+
return formats === undefined ? richTextSchema : richTextSchema.transform((text) => limitRichText(text, formats));
|
|
252
|
+
}
|
|
253
|
+
define(described) {
|
|
254
|
+
// Each format once, in the order the editor shows them.
|
|
255
|
+
const formats = described['formats'];
|
|
256
|
+
if (!Array.isArray(formats))
|
|
257
|
+
return described;
|
|
258
|
+
return { ...described, formats: RICH_TEXT_FORMATS.filter((format) => formats.includes(format)) };
|
|
259
|
+
}
|
|
260
|
+
toPublic(value, { formats }) {
|
|
194
261
|
// What was saved before the field became rich text is still plain.
|
|
195
|
-
const
|
|
262
|
+
const stored = typeof value === 'string' || Array.isArray(value) ? fromPlainText(value) : value;
|
|
263
|
+
const text = limitRichText(stored, formats);
|
|
196
264
|
return { html: richTextHtml(text), paragraphs: richTextParagraphs(text) };
|
|
197
265
|
}
|
|
198
266
|
}
|
|
@@ -273,6 +341,8 @@ export function createFieldRegistry() {
|
|
|
273
341
|
.register(new EmailField())
|
|
274
342
|
.register(new PhoneField())
|
|
275
343
|
.register(new SelectField())
|
|
344
|
+
.register(new ColorField())
|
|
345
|
+
.register(new FontField())
|
|
276
346
|
.register(new ReferenceField())
|
|
277
347
|
.register(new ImageField())
|
|
278
348
|
.register(new RichTextField())
|