@nuasite/cms-core 0.54.0 → 0.56.0
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/types/check-write.d.ts +8 -2
- package/dist/types/check-write.d.ts.map +1 -1
- package/dist/types/collection-scanner.d.ts.map +1 -1
- package/dist/types/content-config-ast.d.ts +5 -1
- package/dist/types/content-config-ast.d.ts.map +1 -1
- package/dist/types/editor-write-model.d.ts +6 -2
- package/dist/types/editor-write-model.d.ts.map +1 -1
- package/dist/types/handlers/entry-ops.d.ts.map +1 -1
- package/dist/types/index.d.ts +2 -2
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/shared.d.ts +33 -2
- package/dist/types/shared.d.ts.map +1 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/check-write.ts +53 -14
- package/src/collection-scanner.ts +14 -0
- package/src/content-config-ast.ts +105 -1
- package/src/editor-write-model.ts +10 -4
- package/src/handlers/entry-ops.ts +134 -18
- package/src/index.ts +14 -2
- package/src/shared.ts +60 -2
|
@@ -15,10 +15,16 @@
|
|
|
15
15
|
* Where `blankRequiredFields` says the write guard in `handlers/entry-ops.ts` would reject
|
|
16
16
|
* the create before it reaches disk, there is no finding to make — with the exception of
|
|
17
17
|
* `hidden` fields, which that guard skips.
|
|
18
|
-
* - **"+ Add" in a
|
|
18
|
+
* - **"+ Add" in a list** — an object-array field gains an item built by `newRepeaterItem`,
|
|
19
19
|
* which seeds the keys the config declares required and omits the rest. What survives is a
|
|
20
20
|
* required key the config does not know about: `addArrayItem` seeds from the same config the
|
|
21
|
-
* editor renders from, so neither can supply a key neither can see.
|
|
21
|
+
* editor renders from, so neither can supply a key neither can see. A list of scalars —
|
|
22
|
+
* `z.array(reference('tags'))` and friends — is simulated too: it appends `blankFieldValue`
|
|
23
|
+
* for the item type, which is what every editor's "+ Add" does.
|
|
24
|
+
*
|
|
25
|
+
* Both simulated writes end with `withoutBlankArrayItems`, because that is the last thing
|
|
26
|
+
* `handlers/entry-ops.ts` does before serializing. Predicting the pre-write record would
|
|
27
|
+
* report a failure the server no longer allows to happen.
|
|
22
28
|
*/
|
|
23
29
|
import type { CheckFinding } from './check';
|
|
24
30
|
import { type LoadedCollections } from './check-entries';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"check-write.d.ts","sourceRoot":"","sources":["../../src/check-write.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"check-write.d.ts","sourceRoot":"","sources":["../../src/check-write.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,EAAwD,KAAK,iBAAiB,EAAoB,MAAM,iBAAiB,CAAA;AAChI,OAAO,KAAK,EAAE,YAAY,EAAe,MAAM,sBAAsB,CAAA;AAWrE,OAAO,EAAkD,KAAK,WAAW,EAAa,MAAM,eAAe,CAAA;AAG3G,MAAM,WAAW,eAAe;IAC/B,MAAM,EAAE,YAAY,CAAA;IACpB,WAAW,EAAE,iBAAiB,CAAA;IAC9B,OAAO,EAAE,WAAW,CAAA;IACpB,4FAA4F;IAC5F,KAAK,CAAC,EAAE,MAAM,IAAI,CAAA;CAClB;AA2JD,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CA+GvF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collection-scanner.d.ts","sourceRoot":"","sources":["../../src/collection-scanner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAmD,MAAM,oBAAoB,CAAA;AAG/G,OAAO,EAAE,KAAK,UAAU,EAA2D,MAAM,sBAAsB,CAAA;AAC/G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;
|
|
1
|
+
{"version":3,"file":"collection-scanner.d.ts","sourceRoot":"","sources":["../../src/collection-scanner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAmD,MAAM,oBAAoB,CAAA;AAG/G,OAAO,EAAE,KAAK,UAAU,EAA2D,MAAM,sBAAsB,CAAA;AAC/G,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAkiC/C;;;;;;GAMG;AACH,wBAAsB,eAAe,CACpC,EAAE,EAAE,aAAa,EACjB,UAAU,GAAE,MAAsB,EAClC,UAAU,GAAE,UAAsB,GAChC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAoF/C"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type CollectionLayout, type FieldHints, type FieldType, type PathnameSpec } from '@nuasite/cms-types';
|
|
1
|
+
import { type CollectionLayout, type DerivedTransform, type FieldHints, type FieldType, type PathnameSpec } from '@nuasite/cms-types';
|
|
2
2
|
import type { CmsFileSystem } from './fs/types';
|
|
3
3
|
export interface ParsedReference {
|
|
4
4
|
target: string;
|
|
@@ -32,6 +32,10 @@ export interface ParsedFieldLayout {
|
|
|
32
32
|
width?: 'full' | 'half';
|
|
33
33
|
order?: number;
|
|
34
34
|
hidden?: boolean;
|
|
35
|
+
/** Name of the field this one is computed from (`n.text({ derivedFrom: 'category' })`). */
|
|
36
|
+
derivedFrom?: string;
|
|
37
|
+
/** Named transform for the derived value; absent means `slugifyHref`. */
|
|
38
|
+
derivedTransform?: DerivedTransform;
|
|
35
39
|
}
|
|
36
40
|
export interface ParsedCollection {
|
|
37
41
|
name: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"content-config-ast.d.ts","sourceRoot":"","sources":["../../src/content-config-ast.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,KAAK,gBAAgB,EAErB,KAAK,UAAU,EACf,KAAK,SAAS,
|
|
1
|
+
{"version":3,"file":"content-config-ast.d.ts","sourceRoot":"","sources":["../../src/content-config-ast.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,KAAK,gBAAgB,EAErB,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,SAAS,EAId,KAAK,YAAY,EACjB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE/C,MAAM,WAAW,eAAe;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,WAAW;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,SAAS,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,KAAK,CAAC,EAAE,UAAU,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE;QAAE,SAAS,EAAE,KAAK,GAAG,MAAM,CAAA;KAAE,CAAA;IACvC,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,2GAA2G;IAC3G,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,sCAAsC;IACtC,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,mFAAmF;IACnF,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,6GAA6G;IAC7G,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC1B;AAED,oEAAoE;AACpE,MAAM,WAAW,iBAAiB;IACjC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,2FAA2F;IAC3F,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;CACnC;AAED,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,+FAA+F;IAC/F,aAAa,CAAC,EAAE,IAAI,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,kFAAkF;IAClF,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,kGAAkG;IAClG,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,8FAA8F;IAC9F,QAAQ,CAAC,EAAE,IAAI,CAAA;IACf,2GAA2G;IAC3G,SAAS,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;AAExD,sEAAsE;AACtE,MAAM,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,YAAY,CAAA;CAAE,CAAC,CAAA;AAmK/E;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,CAqBpG;AAED,wEAAwE;AACxE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,YAAY,CA+JpF"}
|
|
@@ -14,15 +14,19 @@
|
|
|
14
14
|
* and misses the ones that can — which is why none of it may be reimplemented anywhere.
|
|
15
15
|
*/
|
|
16
16
|
import { type WriteModelField } from '@nuasite/cms-types';
|
|
17
|
-
export {
|
|
17
|
+
export { blankFieldValue, blankRequiredFields, isBlankFieldValue, newRepeaterItem, type RepeaterItemField, type RequiredGuardField, seedValueForRequiredField, withoutBlankArrayItems, type WriteModelField, } from '@nuasite/cms-types';
|
|
18
18
|
/**
|
|
19
19
|
* The frontmatter the editor holds when "create entry" opens, before the user types.
|
|
20
20
|
*
|
|
21
21
|
* `title` is excluded because the create form carries it in its own header field, and
|
|
22
22
|
* hidden fields are excluded because the form cannot fill them in. Neither is missing from
|
|
23
23
|
* the finished entry — see `applyCreateRouteFields`, which is what puts `title` back.
|
|
24
|
+
*
|
|
25
|
+
* The values come from `blankFieldValue`, the same function `draftForCreate` in `cms-client`
|
|
26
|
+
* asks. The two used to seed differently, so this — and the check built on it — described a
|
|
27
|
+
* write only one of the two editors ever made.
|
|
24
28
|
*/
|
|
25
|
-
export declare function newEntryFrontmatter(fields: WriteModelField[]
|
|
29
|
+
export declare function newEntryFrontmatter(fields: WriteModelField[]): Record<string, unknown>;
|
|
26
30
|
/** Whether the create route treats a collection's files as markdown entries or as plain data. */
|
|
27
31
|
export type CollectionKind = 'markdown' | 'data';
|
|
28
32
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"editor-write-model.d.ts","sourceRoot":"","sources":["../../src/editor-write-model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,
|
|
1
|
+
{"version":3,"file":"editor-write-model.d.ts","sourceRoot":"","sources":["../../src/editor-write-model.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAmB,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAE1E,OAAO,EACN,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,eAAe,EACf,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,yBAAyB,EACzB,sBAAsB,EACtB,KAAK,eAAe,GACpB,MAAM,oBAAoB,CAAA;AAE3B;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAOtF;AAED,iGAAiG;AACjG,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,MAAM,CAAA;AAEhD;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,IAAI,EAAE,cAAc,EACpB,KAAK,GAAE,MAAM,IAAuB,GAClC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAIzB;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAM/F"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entry-ops.d.ts","sourceRoot":"","sources":["../../../src/handlers/entry-ops.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAIlG,OAAO,EAAE,KAAK,UAAU,
|
|
1
|
+
{"version":3,"file":"entry-ops.d.ts","sourceRoot":"","sources":["../../../src/handlers/entry-ops.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAIlG,OAAO,EAAE,KAAK,UAAU,EAAwC,MAAM,uBAAuB,CAAA;AAE7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAOhD,MAAM,WAAW,cAAc;IAC9B,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAA;IACf,wCAAwC;IACxC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,aAAa,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,2EAA2E;IAC3E,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,uEAAuE;IACvE,2BAA2B,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAA;CAC/E;AA0ED,4EAA4E;AAC5E,MAAM,WAAW,UAAU;IAC1B,KAAK,EAAE,UAAU,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;;GAOG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAOvI;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAEvG;AAMD,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG;IAAE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAgCvG;AAKD,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAWlG;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC/B,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACvD,MAAM,CAuDR;AAgMD,MAAM,WAAW,gBAAgB;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,4FAA4F;IAC5F,aAAa,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,gBAAgB;IAChC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACrC,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAMD,wBAAsB,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAiBnH;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,cAAc,CAAC,CAuDtG;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,cAAc,CAAC,CAqEtG;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAY/G;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CA+B3H;AAMD,MAAM,WAAW,iBAAiB;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,oBAAoB;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACb;AAwED,wBAAsB,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,cAAc,CAAC,CA8BxG;AAED,wBAAsB,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC,CAwB9G;AAED,kFAAkF;AAClF,wBAAsB,qBAAqB,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAGlH"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ export { scanComponentDefinitions } from './component-registry';
|
|
|
9
9
|
export { type ParseCache, parseConfigSource, parseContentConfig, type ParsedCollection, type ParsedConfig, type ParsedField, type ParsedReference, } from './content-config-ast';
|
|
10
10
|
export { createCmsCore } from './core';
|
|
11
11
|
export type { CmsCore, CmsCoreOptions } from './core';
|
|
12
|
-
export { applyCreateRouteFields, blankRequiredFields, type CollectionKind,
|
|
12
|
+
export { applyCreateRouteFields, blankFieldValue, blankRequiredFields, type CollectionKind, isBlankFieldValue, newEntryFrontmatter, newRepeaterItem, omitEmptyOnCreate, type RepeaterItemField, type RequiredGuardField, seedValueForRequiredField, withoutBlankArrayItems, type WriteModelField, } from './editor-write-model';
|
|
13
13
|
export { globToRegExp } from './fs/glob';
|
|
14
14
|
export { createNodeFs } from './fs/node-fs';
|
|
15
15
|
export type { CmsFileSystem } from './fs/types';
|
|
@@ -18,5 +18,5 @@ export { type ContemberStorageOptions, createContemberStorageAdapter, createLoca
|
|
|
18
18
|
export { parseProjectCmsConfig, parseProjectCmsConfigSource } from './project-config-ast';
|
|
19
19
|
export { describeIssue, type LiveIssue, type LiveParseResult, type LiveSchema, type LiveSchemas, schemaFor } from './schema-port';
|
|
20
20
|
export { acceptsMissing, firstAcceptedEntry, governsPath, pointAt, type ProbePoint, rejectsValueAt } from './schema-probe';
|
|
21
|
-
export { computePathnameFromSpec, escapeHtml, relativeImportPath, resolvePathnameFromSpec, slugify, slugifyHref } from './shared';
|
|
21
|
+
export { applyDerivedTransform, computeDerivedFieldUpdates, computePathnameFromSpec, type DerivedFieldSpec, escapeHtml, relativeImportPath, resolvePathnameFromSpec, slugify, slugifyHref, } from './shared';
|
|
22
22
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,aAAa,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAC5I,OAAO,EACN,cAAc,EACd,SAAS,EACT,eAAe,EACf,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,aAAa,EACb,UAAU,GACV,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,mBAAmB,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAA;AACvE,OAAO,EAAE,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AACtE,OAAO,EAAE,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,EACN,KAAK,UAAU,EACf,iBAAiB,EACjB,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,eAAe,GACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACrD,OAAO,EACN,sBAAsB,EACtB,mBAAmB,EACnB,KAAK,cAAc,EACnB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,aAAa,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAC5I,OAAO,EACN,cAAc,EACd,SAAS,EACT,eAAe,EACf,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,aAAa,EACb,UAAU,GACV,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,mBAAmB,EAAE,KAAK,cAAc,EAAE,MAAM,cAAc,CAAA;AACvE,OAAO,EAAE,gBAAgB,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AACtE,OAAO,EAAE,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,EACN,KAAK,UAAU,EACf,iBAAiB,EACjB,kBAAkB,EAClB,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,KAAK,eAAe,GACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACrD,OAAO,EACN,sBAAsB,EACtB,eAAe,EACf,mBAAmB,EACnB,KAAK,cAAc,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,yBAAyB,EACzB,sBAAsB,EACtB,KAAK,eAAe,GACpB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAC/C,OAAO,EACN,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,gBAAgB,EAChB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,gBAAgB,EAChB,KAAK,oBAAoB,EACzB,oBAAoB,EACpB,KAAK,gBAAgB,GACrB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EACN,KAAK,uBAAuB,EAC5B,6BAA6B,EAC7B,yBAAyB,EACzB,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EACjB,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,WAAW,EACX,WAAW,EACX,KAAK,gBAAgB,EACrB,wBAAwB,GACxB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAA;AACzF,OAAO,EAAE,aAAa,EAAE,KAAK,SAAS,EAAE,KAAK,eAAe,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AACjI,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,UAAU,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC1H,OAAO,EACN,qBAAqB,EACrB,0BAA0B,EAC1B,uBAAuB,EACvB,KAAK,gBAAgB,EACrB,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,OAAO,EACP,WAAW,GACX,MAAM,UAAU,CAAA"}
|
package/dist/types/shared.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { type CollectionDefinition, type DerivedTransform, type PathnameSpec, slugify } from '@nuasite/cms-types';
|
|
2
2
|
/**
|
|
3
3
|
* Compose a collection entry's page URL from a declarative {@link PathnameSpec}
|
|
4
4
|
* and the entry's frontmatter `data`.
|
|
@@ -35,7 +35,38 @@ export declare function isPlainRecord(value: unknown): value is Record<string, u
|
|
|
35
35
|
* Re-exported from `@nuasite/cms-types` so the server and every client slugify identically —
|
|
36
36
|
* a host deriving a slug locally is predicting this write. See `cms-types/src/slug.ts`.
|
|
37
37
|
*/
|
|
38
|
-
export { slugify }
|
|
38
|
+
export { slugify };
|
|
39
|
+
/** A field's derived-value declaration, the subset of `FieldDefinition` the recompute reads. */
|
|
40
|
+
export interface DerivedFieldSpec {
|
|
41
|
+
name: string;
|
|
42
|
+
derivedFrom?: string;
|
|
43
|
+
derivedTransform?: DerivedTransform;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Apply a derived field's named transform to its source value.
|
|
47
|
+
*
|
|
48
|
+
* `slug` reuses `slugify` deliberately, and `slugify` **keeps `/`** — it is written to name
|
|
49
|
+
* files on disk, where a nested entry path has to survive. So `transform: 'slug'` on a value
|
|
50
|
+
* that already contains a slash keeps it (`"news/2024"` → `"news/2024"`). That is a conscious
|
|
51
|
+
* reuse of the existing function, not a bug: the transform is documented as "the `slugifyHref`
|
|
52
|
+
* fold without the leading slash", and every other separator still collapses to `-`.
|
|
53
|
+
*/
|
|
54
|
+
export declare function applyDerivedTransform(value: string, transform: DerivedTransform | undefined): string;
|
|
55
|
+
/**
|
|
56
|
+
* Values every derived field in `fields` should hold given `data`, keyed by field name.
|
|
57
|
+
*
|
|
58
|
+
* The single definition of "recompute derived fields", shared by every write path in
|
|
59
|
+
* `cms-core`. A source field that is missing, not a string, or blank yields no entry at all —
|
|
60
|
+
* the existing value is left alone rather than blanked, because "no source" is not "empty
|
|
61
|
+
* result". An empty source is deliberately in that group: every transform maps `''` to
|
|
62
|
+
* something that looks like a value (`slugifyHref('')` is `'/'`, a link to the site root), and
|
|
63
|
+
* writing that into content is worse than leaving the previous value in place. Whitespace-only
|
|
64
|
+
* counts as empty for the same reason — it slugifies to the same thing.
|
|
65
|
+
*
|
|
66
|
+
* `hidden` is deliberately not consulted: an author who sets `hidden: false` on a declared
|
|
67
|
+
* derived field still gets it computed, they only also get to see it.
|
|
68
|
+
*/
|
|
69
|
+
export declare function computeDerivedFieldUpdates(fields: readonly DerivedFieldSpec[], data: Record<string, unknown>): Record<string, unknown>;
|
|
39
70
|
/**
|
|
40
71
|
* Escape HTML special characters to prevent injection.
|
|
41
72
|
* Covers &, <, >, ", and ' — the full set needed for both text content and attribute values.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../src/shared.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,gBAAgB,EAAE,KAAK,YAAY,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAiBjH;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,SAAS,CAe7G;AAED;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CACtC,GAAG,EAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,EAC3C,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GACvC,MAAM,GAAG,SAAS,CAKpB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAShD;AAED,mFAAmF;AACnF,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE9E;AAED;;;GAGG;AACH,OAAO,EAAE,OAAO,EAAE,CAAA;AAElB,gGAAgG;AAChG,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;CACnC;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,GAAG,SAAS,GAAG,MAAM,CAYpG;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,0BAA0B,CACzC,MAAM,EAAE,SAAS,gBAAgB,EAAE,EACnC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CASzB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAO/C;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAa3E"}
|