@decocms/blocks 8.1.0-next.4 → 8.1.0-next.6
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/protocol/client.d.ts +1 -3
- package/dist/protocol/client.d.ts.map +1 -1
- package/dist/protocol/client.js +0 -2
- package/dist/protocol/client.js.map +1 -1
- package/dist/protocol/conformance/cases/guards.d.ts.map +1 -1
- package/dist/protocol/conformance/cases/guards.js +10 -173
- package/dist/protocol/conformance/cases/guards.js.map +1 -1
- package/dist/protocol/conformance/cases/reads.d.ts.map +1 -1
- package/dist/protocol/conformance/cases/reads.js +24 -53
- package/dist/protocol/conformance/cases/reads.js.map +1 -1
- package/dist/protocol/conformance/cases/writes.d.ts.map +1 -1
- package/dist/protocol/conformance/cases/writes.js +3 -20
- package/dist/protocol/conformance/cases/writes.js.map +1 -1
- package/dist/protocol/conformance/contentHashFixtures.d.ts +0 -29
- package/dist/protocol/conformance/contentHashFixtures.d.ts.map +1 -1
- package/dist/protocol/conformance/contentHashFixtures.js +0 -30
- package/dist/protocol/conformance/contentHashFixtures.js.map +1 -1
- package/dist/protocol/conformance/context.d.ts +4 -29
- package/dist/protocol/conformance/context.d.ts.map +1 -1
- package/dist/protocol/conformance/context.js +4 -13
- package/dist/protocol/conformance/context.js.map +1 -1
- package/dist/protocol/conformance/index.d.ts +1 -1
- package/dist/protocol/conformance/index.d.ts.map +1 -1
- package/dist/protocol/conformance/index.js +4 -4
- package/dist/protocol/conformance/index.js.map +1 -1
- package/dist/protocol/errors.d.ts +5 -9
- package/dist/protocol/errors.d.ts.map +1 -1
- package/dist/protocol/errors.js +4 -4
- package/dist/protocol/errors.js.map +1 -1
- package/dist/protocol/index.d.ts +3 -5
- package/dist/protocol/index.d.ts.map +1 -1
- package/dist/protocol/index.js +3 -5
- package/dist/protocol/index.js.map +1 -1
- package/dist/protocol/params.d.ts.map +1 -1
- package/dist/protocol/params.js +0 -4
- package/dist/protocol/params.js.map +1 -1
- package/dist/protocol/server/assets.d.ts +2 -3
- package/dist/protocol/server/assets.d.ts.map +1 -1
- package/dist/protocol/server/assets.js +2 -9
- package/dist/protocol/server/assets.js.map +1 -1
- package/dist/protocol/server/content.d.ts +2 -3
- package/dist/protocol/server/content.d.ts.map +1 -1
- package/dist/protocol/server/content.js +10 -22
- package/dist/protocol/server/content.js.map +1 -1
- package/dist/protocol/server/core.d.ts +8 -11
- package/dist/protocol/server/core.d.ts.map +1 -1
- package/dist/protocol/server/core.js +8 -24
- package/dist/protocol/server/core.js.map +1 -1
- package/dist/protocol/server/handler.d.ts.map +1 -1
- package/dist/protocol/server/handler.js +11 -23
- package/dist/protocol/server/handler.js.map +1 -1
- package/dist/protocol/server/http.d.ts +6 -4
- package/dist/protocol/server/http.d.ts.map +1 -1
- package/dist/protocol/server/http.js +1 -18
- package/dist/protocol/server/http.js.map +1 -1
- package/dist/protocol/server/index.d.ts +0 -1
- package/dist/protocol/server/index.d.ts.map +1 -1
- package/dist/protocol/server/index.js.map +1 -1
- package/dist/protocol/server/methods/apply.d.ts +2 -2
- package/dist/protocol/server/methods/apply.d.ts.map +1 -1
- package/dist/protocol/server/methods/apply.js +23 -71
- package/dist/protocol/server/methods/apply.js.map +1 -1
- package/dist/protocol/server/methods/read.d.ts +0 -6
- package/dist/protocol/server/methods/read.d.ts.map +1 -1
- package/dist/protocol/server/methods/read.js +7 -31
- package/dist/protocol/server/methods/read.js.map +1 -1
- package/dist/protocol/server/rpc.d.ts +1 -1
- package/dist/protocol/server/rpc.d.ts.map +1 -1
- package/dist/protocol/server/rpc.js +9 -39
- package/dist/protocol/server/rpc.js.map +1 -1
- package/dist/protocol/storage/fs/index.d.ts +0 -3
- package/dist/protocol/storage/fs/index.d.ts.map +1 -1
- package/dist/protocol/storage/fs/index.js +0 -5
- package/dist/protocol/storage/fs/index.js.map +1 -1
- package/dist/protocol/storage/memory.d.ts +1 -6
- package/dist/protocol/storage/memory.d.ts.map +1 -1
- package/dist/protocol/storage/memory.js +1 -30
- package/dist/protocol/storage/memory.js.map +1 -1
- package/dist/protocol/storage.d.ts +7 -50
- package/dist/protocol/storage.d.ts.map +1 -1
- package/dist/protocol/storage.js +1 -1
- package/dist/protocol/storage.js.map +1 -1
- package/dist/protocol/types.d.ts +23 -34
- package/dist/protocol/types.d.ts.map +1 -1
- package/dist/protocol/types.js +10 -10
- package/dist/protocol/types.js.map +1 -1
- package/dist/v8/boundedJson.d.ts +11 -0
- package/dist/v8/boundedJson.d.ts.map +1 -0
- package/dist/v8/boundedJson.js +44 -0
- package/dist/v8/boundedJson.js.map +1 -0
- package/dist/v8/canonical.d.ts +0 -35
- package/dist/v8/canonical.d.ts.map +1 -1
- package/dist/v8/canonical.js +0 -28
- package/dist/v8/canonical.js.map +1 -1
- package/dist/v8/cli/check/index.d.ts +5 -0
- package/dist/v8/cli/check/index.d.ts.map +1 -1
- package/dist/v8/cli/check/index.js +21 -1
- package/dist/v8/cli/check/index.js.map +1 -1
- package/dist/v8/cli/run.js +1 -1
- package/dist/v8/cli/schema/generate.d.ts +3 -1
- package/dist/v8/cli/schema/generate.d.ts.map +1 -1
- package/dist/v8/cli/schema/generate.js +2 -1
- package/dist/v8/cli/schema/generate.js.map +1 -1
- package/dist/v8/cli/serve/server.d.ts +1 -1
- package/dist/v8/cli/serve/server.d.ts.map +1 -1
- package/dist/v8/cli/serve/server.js +63 -23
- package/dist/v8/cli/serve/server.js.map +1 -1
- package/dist/v8/cms.d.ts.map +1 -1
- package/dist/v8/cms.js +7 -6
- package/dist/v8/cms.js.map +1 -1
- package/dist/v8/content.d.ts +6 -5
- package/dist/v8/content.d.ts.map +1 -1
- package/dist/v8/content.js +49 -39
- package/dist/v8/content.js.map +1 -1
- package/dist/v8/draft.d.ts +1 -1
- package/dist/v8/draft.d.ts.map +1 -1
- package/dist/v8/draft.js +24 -2
- package/dist/v8/draft.js.map +1 -1
- package/dist/v8/draftChanges.d.ts +44 -0
- package/dist/v8/draftChanges.d.ts.map +1 -0
- package/dist/v8/draftChanges.js +157 -0
- package/dist/v8/draftChanges.js.map +1 -0
- package/dist/v8/remoteLoader.d.ts +1 -1
- package/dist/v8/remoteLoader.d.ts.map +1 -1
- package/dist/v8/remoteLoader.js +19 -256
- package/dist/v8/remoteLoader.js.map +1 -1
- package/dist/v8/settings.d.ts.map +1 -1
- package/dist/v8/settings.js +9 -6
- package/dist/v8/settings.js.map +1 -1
- package/dist/v8/telemetry.d.ts +4 -0
- package/dist/v8/telemetry.d.ts.map +1 -1
- package/dist/v8/telemetry.js +49 -14
- package/dist/v8/telemetry.js.map +1 -1
- package/dist/v8/types.d.ts +20 -12
- package/dist/v8/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/protocol/client.ts +1 -4
- package/src/protocol/conformance/cases/guards.ts +10 -188
- package/src/protocol/conformance/cases/reads.ts +29 -69
- package/src/protocol/conformance/cases/writes.ts +7 -35
- package/src/protocol/conformance/contentHashFixtures.ts +0 -57
- package/src/protocol/conformance/context.ts +9 -34
- package/src/protocol/conformance/index.ts +4 -9
- package/src/protocol/errors.ts +5 -10
- package/src/protocol/index.ts +2 -10
- package/src/protocol/params.ts +0 -4
- package/src/protocol/server/assets.ts +2 -12
- package/src/protocol/server/content.ts +10 -24
- package/src/protocol/server/core.ts +12 -34
- package/src/protocol/server/handler.ts +11 -30
- package/src/protocol/server/http.ts +1 -19
- package/src/protocol/server/index.ts +0 -1
- package/src/protocol/server/methods/apply.ts +22 -82
- package/src/protocol/server/methods/read.ts +7 -36
- package/src/protocol/server/rpc.ts +7 -47
- package/src/protocol/storage/fs/index.ts +0 -8
- package/src/protocol/storage/memory.ts +1 -36
- package/src/protocol/storage.ts +7 -39
- package/src/protocol/types.ts +21 -38
- package/src/v8/boundedJson.ts +47 -0
- package/src/v8/canonical.ts +0 -47
- package/src/v8/cli/check/index.ts +25 -1
- package/src/v8/cli/run.ts +1 -1
- package/src/v8/cli/schema/generate.ts +4 -1
- package/src/v8/cli/serve/server.ts +65 -29
- package/src/v8/cms.ts +7 -8
- package/src/v8/content.ts +55 -42
- package/src/v8/draft.ts +20 -2
- package/src/v8/draftChanges.ts +172 -0
- package/src/v8/remoteLoader.ts +23 -289
- package/src/v8/settings.ts +13 -6
- package/src/v8/telemetry.ts +58 -13
- package/src/v8/types.ts +23 -13
- package/dist/protocol/server/auth.d.ts +0 -31
- package/dist/protocol/server/auth.d.ts.map +0 -1
- package/dist/protocol/server/auth.js +0 -32
- package/dist/protocol/server/auth.js.map +0 -1
- package/src/protocol/server/auth.ts +0 -49
|
@@ -10,34 +10,20 @@
|
|
|
10
10
|
*
|
|
11
11
|
* Browser-safe: types and small error classes only.
|
|
12
12
|
*/
|
|
13
|
-
import type {
|
|
13
|
+
import type { StorageKind } from "./types.ts";
|
|
14
14
|
/** What a storage tells `describe`. */
|
|
15
15
|
export interface StorageDescription {
|
|
16
16
|
kind: StorageKind;
|
|
17
17
|
/** The app root, relative to the repository root (`"."` when they're the same). */
|
|
18
18
|
root: string;
|
|
19
19
|
readOnly: boolean;
|
|
20
|
-
/** Branch support; `null` when the storage has no refs (`ref` params are then Unsupported). */
|
|
21
|
-
refs: null | {
|
|
22
|
-
default: string;
|
|
23
|
-
autoCreate: boolean;
|
|
24
|
-
};
|
|
25
20
|
/** Where uploads go; `null` when read-only or uploads go elsewhere. */
|
|
26
21
|
assets: null | {
|
|
27
22
|
dir: string;
|
|
28
23
|
maxBytes: number;
|
|
29
24
|
};
|
|
30
|
-
/**
|
|
31
|
-
* Durable request-key receipts. Advertise only when `getReceipt` is
|
|
32
|
-
* implemented and `commit` persists `attempt.receipt` with the mutation.
|
|
33
|
-
*/
|
|
34
|
-
idempotency: null | {
|
|
35
|
-
retentionMs: number;
|
|
36
|
-
};
|
|
37
25
|
/** Overrides the poll interval (default: 2000 for a working tree, 30000 for git). */
|
|
38
26
|
pollIntervalMs?: number;
|
|
39
|
-
/** Lowers the protocol's default limits. Higher values are ignored. */
|
|
40
|
-
limits?: Partial<Limits>;
|
|
41
27
|
}
|
|
42
28
|
/** One saved-block file in a snapshot. */
|
|
43
29
|
export interface StorageFile {
|
|
@@ -52,7 +38,7 @@ export interface StorageFile {
|
|
|
52
38
|
export interface StorageSnapshot {
|
|
53
39
|
/** An opaque revision of the whole set, compared only for equality. */
|
|
54
40
|
revision: string;
|
|
55
|
-
/** The
|
|
41
|
+
/** The branch actually read, for a storage that reads one; `null` for a working tree. */
|
|
56
42
|
resolvedRef: string | null;
|
|
57
43
|
files: StorageFile[];
|
|
58
44
|
}
|
|
@@ -74,20 +60,8 @@ export interface StoredSchema {
|
|
|
74
60
|
text: string;
|
|
75
61
|
resolvedRef: string | null;
|
|
76
62
|
}
|
|
77
|
-
/** A durable receipt for one `blocks.apply` request key. */
|
|
78
|
-
export interface StoredReceipt {
|
|
79
|
-
/** The canonical digest of the request the key was first used with. */
|
|
80
|
-
digest: string;
|
|
81
|
-
/** The revision that commit produced. */
|
|
82
|
-
revision: string;
|
|
83
|
-
/** The versions of the files that commit wrote. */
|
|
84
|
-
versions: Record<string, string>;
|
|
85
|
-
/** The files that commit deleted (`attempt.delete`), so a replay reports the same names. */
|
|
86
|
-
deleted?: string[];
|
|
87
|
-
}
|
|
88
63
|
/** One atomic commit attempt. */
|
|
89
64
|
export interface CommitAttempt {
|
|
90
|
-
ref?: string;
|
|
91
65
|
/** The snapshot the core validated against. */
|
|
92
66
|
base: StorageSnapshot;
|
|
93
67
|
/** Files to write, by file name, with their full content. */
|
|
@@ -102,22 +76,11 @@ export interface CommitAttempt {
|
|
|
102
76
|
expected: Record<string, string | null>;
|
|
103
77
|
/**
|
|
104
78
|
* The schema version the core validated against (`null` = no schema), when
|
|
105
|
-
* the write depends on it (
|
|
79
|
+
* the write depends on it (the secret guard checks `set` against it). When set,
|
|
106
80
|
* a storage MUST reject the attempt as stale if the schema's version at
|
|
107
81
|
* commit time differs, checked atomically with `expected`.
|
|
108
82
|
*/
|
|
109
83
|
expectedSchemaVersion?: string | null;
|
|
110
|
-
/**
|
|
111
|
-
* Persist this receipt atomically with the mutation (only when idempotency
|
|
112
|
-
* is advertised). The key also reserves the request: a storage MUST reject
|
|
113
|
-
* the attempt as stale when a receipt for `receipt.key` already exists,
|
|
114
|
-
* including one written concurrently by another replica, so two requests
|
|
115
|
-
* with the same key never both commit.
|
|
116
|
-
*/
|
|
117
|
-
receipt?: {
|
|
118
|
-
key: string;
|
|
119
|
-
digest: string;
|
|
120
|
-
};
|
|
121
84
|
}
|
|
122
85
|
export type CommitResult = {
|
|
123
86
|
status: "committed";
|
|
@@ -131,11 +94,9 @@ export interface ContentStorage {
|
|
|
131
94
|
describe(): StorageDescription | Promise<StorageDescription>;
|
|
132
95
|
/**
|
|
133
96
|
* Lists the saved-block files. Throws `StorageNotFoundError` when there's no
|
|
134
|
-
* `.deco` folder at all
|
|
97
|
+
* `.deco` folder at all.
|
|
135
98
|
*/
|
|
136
|
-
snapshot(
|
|
137
|
-
ref?: string;
|
|
138
|
-
}): Promise<StorageSnapshot>;
|
|
99
|
+
snapshot(): Promise<StorageSnapshot>;
|
|
139
100
|
/**
|
|
140
101
|
* Reads file bodies (UTF-8 text) from a snapshot, each with the version of
|
|
141
102
|
* the bytes read. A file that vanished is left out. A storage that can't
|
|
@@ -144,21 +105,17 @@ export interface ContentStorage {
|
|
|
144
105
|
*/
|
|
145
106
|
readFiles(snapshot: StorageSnapshot, files: string[]): Promise<Record<string, StoredFileBody>>;
|
|
146
107
|
/** Reads `schema.gen.json`, falling back to `meta.gen.json`; `null` when neither exists. */
|
|
147
|
-
readSchema(
|
|
148
|
-
ref?: string;
|
|
149
|
-
}): Promise<StoredSchema | null>;
|
|
108
|
+
readSchema(): Promise<StoredSchema | null>;
|
|
150
109
|
/** Reads `<root>/.deco/secrets.pub`; `null` without one. */
|
|
151
110
|
readSecretsPublicKey(): Promise<string | null>;
|
|
152
111
|
/** One all-or-nothing commit attempt; durable when it resolves. */
|
|
153
112
|
commit(attempt: CommitAttempt): Promise<CommitResult>;
|
|
154
|
-
/** Looks up a receipt by its scoped key; `null` when unknown or expired. */
|
|
155
|
-
getReceipt?(key: string): Promise<StoredReceipt | null>;
|
|
156
113
|
/** Stores an uploaded file, never overwriting one; returns the stored file name. */
|
|
157
114
|
putAsset?(name: string, body: Uint8Array): Promise<{
|
|
158
115
|
name: string;
|
|
159
116
|
}>;
|
|
160
117
|
}
|
|
161
|
-
/** Thrown by a storage when there's no `.deco` folder
|
|
118
|
+
/** Thrown by a storage when there's no `.deco` folder. */
|
|
162
119
|
export declare class StorageNotFoundError extends Error {
|
|
163
120
|
constructor(message: string);
|
|
164
121
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,mFAAmF;IACnF,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,uEAAuE;IACvE,MAAM,EAAE,IAAI,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,qFAAqF;IACrF,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,0CAA0C;AAC1C,MAAM,WAAW,WAAW;IAC1B,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,OAAO,EAAE,MAAM,CAAC;IAChB,oFAAoF;IACpF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,mDAAmD;AACnD,MAAM,WAAW,eAAe;IAC9B,uEAAuE;IACvE,QAAQ,EAAE,MAAM,CAAC;IACjB,yFAAyF;IACzF,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,WAAW,EAAE,CAAC;CACtB;AAED,wEAAwE;AACxE,MAAM,WAAW,cAAc;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,kCAAkC;AAClC,MAAM,WAAW,YAAY;IAC3B,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,iCAAiC;AACjC,MAAM,WAAW,aAAa;IAC5B,+CAA+C;IAC/C,IAAI,EAAE,eAAe,CAAC;IACtB,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,2DAA2D;IAC3D,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IACxC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,MAAM,YAAY,GACpB;IACE,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,GACD;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC;AAExB,MAAM,WAAW,cAAc;IAC7B,QAAQ,IAAI,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC7D;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IACrC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;IAC/F,4FAA4F;IAC5F,UAAU,IAAI,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;IAC3C,4DAA4D;IAC5D,oBAAoB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC/C,mEAAmE;IACnE,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACtD,oFAAoF;IACpF,QAAQ,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACtE;AAED,0DAA0D;AAC1D,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM;IAAjC,YAAqB,IAAI,EAAE,MAAM,EAGhC;CACF;AAED,6DAA6D;AAC7D,qBAAa,uBAAwB,SAAQ,KAAK;IAChD,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAE1C,YAAY,OAAO,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAIjD;CACF"}
|
package/dist/protocol/storage.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/protocol/storage.ts"],"names":[],"mappings":"AAyHA,0DAA0D;AAC1D,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC7C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAC3B,IAAI;IAAzB,YAAqB,IAAY;QAC/B,KAAK,CAAC,gCAAgC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAD3C,IAAI;QAEvB,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF;AAED,6DAA6D;AAC7D,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IACvC,YAAY,CAAqB;IAE1C,YAAY,OAAe,EAAE,YAAqB;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;QACtC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;CACF"}
|
package/dist/protocol/types.d.ts
CHANGED
|
@@ -9,28 +9,22 @@ export declare const PROTOCOL_VERSION: {
|
|
|
9
9
|
readonly minor: 0;
|
|
10
10
|
};
|
|
11
11
|
export declare const SCHEMA_FORMAT = "deco-meta@1";
|
|
12
|
+
/**
|
|
13
|
+
* The Blocks major a generated schema declares, as its top-level
|
|
14
|
+
* `blocksMajor`. `deco schema` writes it and `deco check` requires it. It is
|
|
15
|
+
* the package's major version, not the full version string, and it is the
|
|
16
|
+
* only signal a host such as the site editor should read to tell a v8 site
|
|
17
|
+
* from a v7 one: the schema's file name (`schema.gen.json` or
|
|
18
|
+
* `meta.gen.json`) doesn't tell. A schema without it, or with another value,
|
|
19
|
+
* is not a v8 schema.
|
|
20
|
+
*/
|
|
21
|
+
export declare const BLOCKS_MAJOR = 8;
|
|
12
22
|
/** The path the local server (`deco serve`) mounts the endpoint at. */
|
|
13
23
|
export declare const RPC_PATH = "/rpc";
|
|
14
24
|
/** The longest batch a request may carry. */
|
|
15
25
|
export declare const MAX_BATCH_CALLS = 10;
|
|
16
26
|
/** The URL prefix every uploaded asset is stored under in a field. */
|
|
17
27
|
export declare const ASSETS_URL_PREFIX = "/assets/";
|
|
18
|
-
export interface Limits {
|
|
19
|
-
/** Names (set plus delete) in one `blocks.apply`. */
|
|
20
|
-
maxOpsPerApply: number;
|
|
21
|
-
/** Bytes of one stored entry. */
|
|
22
|
-
maxBlockBytes: number;
|
|
23
|
-
/** Bytes of one HTTP request body, uncompressed. */
|
|
24
|
-
maxRequestBytes: number;
|
|
25
|
-
/** Uncompressed bytes of the whole block list. */
|
|
26
|
-
maxListBytes: number;
|
|
27
|
-
/** Uncompressed bytes of the schema. */
|
|
28
|
-
maxSchemaBytes: number;
|
|
29
|
-
/** Uncompressed bytes of a whole batch response. */
|
|
30
|
-
maxBatchResponseBytes: number;
|
|
31
|
-
}
|
|
32
|
-
/** The protocol's default limits. A storage or a server can lower them. */
|
|
33
|
-
export declare const DEFAULT_LIMITS: Readonly<Limits>;
|
|
34
28
|
export type StorageKind = "working-tree" | "git";
|
|
35
29
|
export interface DescribeResult {
|
|
36
30
|
protocol: typeof PROTOCOL_NAME;
|
|
@@ -48,20 +42,8 @@ export interface DescribeResult {
|
|
|
48
42
|
/** The app root: the folder that contains `.deco/`, relative to the repository root. */
|
|
49
43
|
root: string;
|
|
50
44
|
schemaFormat: typeof SCHEMA_FORMAT;
|
|
51
|
-
/** Branches; `null` on the local server. */
|
|
52
|
-
refs: null | {
|
|
53
|
-
default: string;
|
|
54
|
-
autoCreate: boolean;
|
|
55
|
-
};
|
|
56
|
-
writes: {
|
|
57
|
-
idempotency: null | {
|
|
58
|
-
retentionMs: number;
|
|
59
|
-
};
|
|
60
|
-
schemaPreconditions: boolean;
|
|
61
|
-
};
|
|
62
45
|
/** Local: 2000; git: 30000, plus on window focus. */
|
|
63
46
|
pollIntervalMs: number;
|
|
64
|
-
limits: Limits;
|
|
65
47
|
/**
|
|
66
48
|
* The app the site editor shows in its Preview tab (and where "open the real
|
|
67
49
|
* page" points); the local server reports `deco serve --preview`. `null`: no preview.
|
|
@@ -92,10 +74,17 @@ export interface DecoMeta {
|
|
|
92
74
|
[key: string]: unknown;
|
|
93
75
|
}
|
|
94
76
|
export interface ReadParams {
|
|
95
|
-
ref?: string;
|
|
96
77
|
ifNoneMatch?: string;
|
|
97
78
|
}
|
|
98
79
|
export type SchemaGetParams = ReadParams;
|
|
80
|
+
/**
|
|
81
|
+
* `schema: null` (with `version: null`) means the site has no schema yet:
|
|
82
|
+
* neither `.deco/schema.gen.json` nor `.deco/meta.gen.json` exists. It's a
|
|
83
|
+
* normal state, not an error: `blocks.list` and `blocks.apply` work without a
|
|
84
|
+
* schema, so a client still lists and edits the blocks (without typed forms)
|
|
85
|
+
* and keeps polling until a schema appears. There's no version to send as
|
|
86
|
+
* `ifNoneMatch`, so the poll reads it unconditionally; the answer is tiny.
|
|
87
|
+
*/
|
|
99
88
|
export type SchemaGetResult = {
|
|
100
89
|
notModified: true;
|
|
101
90
|
version: string;
|
|
@@ -104,6 +93,11 @@ export type SchemaGetResult = {
|
|
|
104
93
|
version: string;
|
|
105
94
|
resolvedRef: string | null;
|
|
106
95
|
schema: DecoMeta;
|
|
96
|
+
} | {
|
|
97
|
+
notModified: false;
|
|
98
|
+
version: null;
|
|
99
|
+
resolvedRef: string | null;
|
|
100
|
+
schema: null;
|
|
107
101
|
};
|
|
108
102
|
export type BlocksListParams = ReadParams;
|
|
109
103
|
/** A file `blocks.list` skipped or shadowed. */
|
|
@@ -133,11 +127,6 @@ export type BlocksListResult = {
|
|
|
133
127
|
diagnostics: Diagnostic[];
|
|
134
128
|
};
|
|
135
129
|
export interface BlocksApplyParams {
|
|
136
|
-
ref?: string;
|
|
137
|
-
/** Retry the same logical write; only when advertised. */
|
|
138
|
-
requestKey?: string;
|
|
139
|
-
/** Reject if the schema changed; only when advertised. */
|
|
140
|
-
ifSchemaMatch?: string;
|
|
141
130
|
/** Whole-entry replace (create or update). */
|
|
142
131
|
set?: Record<string, Record<string, unknown>>;
|
|
143
132
|
/** A missing name counts as deleted. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/protocol/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,aAAa,iBAAiB,CAAC;AAE5C,0DAA0D;AAC1D,eAAO,MAAM,gBAAgB;aAAK,KAAK,EAAE,CAAC;aAAE,KAAK,EAAE,CAAC;CAAW,CAAC;AAEhE,eAAO,MAAM,aAAa,gBAAgB,CAAC;AAE3C,uEAAuE;AACvE,eAAO,MAAM,QAAQ,SAAS,CAAC;AAE/B,6CAA6C;AAC7C,eAAO,MAAM,eAAe,KAAK,CAAC;AAElC,sEAAsE;AACtE,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAE5C,MAAM,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/protocol/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,eAAO,MAAM,aAAa,iBAAiB,CAAC;AAE5C,0DAA0D;AAC1D,eAAO,MAAM,gBAAgB;aAAK,KAAK,EAAE,CAAC;aAAE,KAAK,EAAE,CAAC;CAAW,CAAC;AAEhE,eAAO,MAAM,aAAa,gBAAgB,CAAC;AAE3C;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,IAAI,CAAC;AAE9B,uEAAuE;AACvE,eAAO,MAAM,QAAQ,SAAS,CAAC;AAE/B,6CAA6C;AAC7C,eAAO,MAAM,eAAe,KAAK,CAAC;AAElC,sEAAsE;AACtE,eAAO,MAAM,iBAAiB,aAAa,CAAC;AAE5C,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,KAAK,CAAC;AAEjD,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,OAAO,aAAa,CAAC;IAC/B,OAAO,EAAE;QAAE,KAAK,EAAE,CAAC,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACrC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C,qEAAqE;IACrE,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,wFAAwF;IACxF,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,OAAO,aAAa,CAAC;IACnC,qDAAqD;IACrD,cAAc,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,OAAO,EAAE,IAAI,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,kGAAkG;IAClG,MAAM,EAAE,IAAI,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,iBAAiB,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACtF,sEAAsE;IACtE,OAAO,EAAE,IAAI,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CACvC;AAED,kEAAkE;AAClE,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;KAAE,CAAC;IAChE,MAAM,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;IACnF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC;AAEzC;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GACvB;IAAE,WAAW,EAAE,IAAI,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACtC;IAAE,WAAW,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,MAAM,EAAE,QAAQ,CAAA;CAAE,GACrF;IAAE,WAAW,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,IAAI,CAAC;IAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,MAAM,EAAE,IAAI,CAAA;CAAE,CAAC;AAEpF,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC;AAE1C,gDAAgD;AAChD,MAAM,WAAW,UAAU;IACzB,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,cAAc,GAAG,eAAe,GAAG,WAAW,GAAG,UAAU,CAAC;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,gBAAgB,GACxB;IAAE,WAAW,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACnE;IACE,WAAW,EAAE,KAAK,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAChD,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,iCAAiC;IACjC,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B,CAAC;AAEN,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC9C,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;CACzC;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;CACzC;AAED,sCAAsC;AACtC,MAAM,WAAW,OAAO;IACtB,QAAQ,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;QAAC,MAAM,EAAE,cAAc,CAAA;KAAE,CAAC;IAChF,YAAY,EAAE;QAAE,MAAM,EAAE,eAAe,GAAG,SAAS,CAAC;QAAC,MAAM,EAAE,eAAe,CAAA;KAAE,CAAC;IAC/E,aAAa,EAAE;QAAE,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAAC;QAAC,MAAM,EAAE,gBAAgB,CAAA;KAAE,CAAC;IAClF,cAAc,EAAE;QAAE,MAAM,EAAE,iBAAiB,CAAC;QAAC,MAAM,EAAE,iBAAiB,CAAA;KAAE,CAAC;CAC1E;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC;AAEvC,eAAO,MAAM,YAAY,EAAE,SAAS,UAAU,EAK7C,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAEpC,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAC3D,OAAO,EAAE,KAAK,CAAC;IACf,EAAE,EAAE,KAAK,CAAC;IACV,MAAM,EAAE,CAAC,CAAC;IACV,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAC/B;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;IAAC,MAAM,EAAE,CAAC,CAAA;CAAE,GAC/C;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,CAAC"}
|
package/dist/protocol/types.js
CHANGED
|
@@ -6,22 +6,22 @@ export const PROTOCOL_NAME = "deco-content";
|
|
|
6
6
|
/** Minors only add; a client refuses an unknown major. */
|
|
7
7
|
export const PROTOCOL_VERSION = { major: 1, minor: 0 };
|
|
8
8
|
export const SCHEMA_FORMAT = "deco-meta@1";
|
|
9
|
+
/**
|
|
10
|
+
* The Blocks major a generated schema declares, as its top-level
|
|
11
|
+
* `blocksMajor`. `deco schema` writes it and `deco check` requires it. It is
|
|
12
|
+
* the package's major version, not the full version string, and it is the
|
|
13
|
+
* only signal a host such as the site editor should read to tell a v8 site
|
|
14
|
+
* from a v7 one: the schema's file name (`schema.gen.json` or
|
|
15
|
+
* `meta.gen.json`) doesn't tell. A schema without it, or with another value,
|
|
16
|
+
* is not a v8 schema.
|
|
17
|
+
*/
|
|
18
|
+
export const BLOCKS_MAJOR = 8;
|
|
9
19
|
/** The path the local server (`deco serve`) mounts the endpoint at. */
|
|
10
20
|
export const RPC_PATH = "/rpc";
|
|
11
21
|
/** The longest batch a request may carry. */
|
|
12
22
|
export const MAX_BATCH_CALLS = 10;
|
|
13
23
|
/** The URL prefix every uploaded asset is stored under in a field. */
|
|
14
24
|
export const ASSETS_URL_PREFIX = "/assets/";
|
|
15
|
-
const MiB = 1024 * 1024;
|
|
16
|
-
/** The protocol's default limits. A storage or a server can lower them. */
|
|
17
|
-
export const DEFAULT_LIMITS = Object.freeze({
|
|
18
|
-
maxOpsPerApply: 500,
|
|
19
|
-
maxBlockBytes: 1 * MiB,
|
|
20
|
-
maxRequestBytes: 8 * MiB,
|
|
21
|
-
maxListBytes: 16 * MiB,
|
|
22
|
-
maxSchemaBytes: 16 * MiB,
|
|
23
|
-
maxBatchResponseBytes: 32 * MiB,
|
|
24
|
-
});
|
|
25
25
|
export const METHOD_NAMES = [
|
|
26
26
|
"describe",
|
|
27
27
|
"schema.get",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/protocol/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,cAAc,CAAC;AAE5C,0DAA0D;AAC1D,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAW,CAAC;AAEhE,MAAM,CAAC,MAAM,aAAa,GAAG,aAAa,CAAC;AAE3C,uEAAuE;AACvE,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE/B,6CAA6C;AAC7C,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC;AAElC,sEAAsE;AACtE,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/protocol/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG,cAAc,CAAC;AAE5C,0DAA0D;AAC1D,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAW,CAAC;AAEhE,MAAM,CAAC,MAAM,aAAa,GAAG,aAAa,CAAC;AAE3C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC;AAE9B,uEAAuE;AACvE,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE/B,6CAA6C;AAC7C,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC;AAElC,sEAAsE;AACtE,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;AAyG5C,MAAM,CAAC,MAAM,YAAY,GAA0B;IACjD,UAAU;IACV,YAAY;IACZ,aAAa;IACb,cAAc;CACf,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Network reads the SDK makes on its own (hosted releases, draft changes):
|
|
3
|
+
* a timeout on the whole request, and a JSON body refused as soon as it
|
|
4
|
+
* would exceed a size, before it's buffered whole (a Worker isolate has
|
|
5
|
+
* 128 MB).
|
|
6
|
+
*/
|
|
7
|
+
/** An abort signal that fires after `ms`, where the runtime has `AbortSignal.timeout`. */
|
|
8
|
+
export declare function timeoutSignal(ms: number): AbortSignal | undefined;
|
|
9
|
+
/** Parses a JSON body, refusing it once it passes `maxBytes`. */
|
|
10
|
+
export declare function readBoundedJson(response: Response, label: string, maxBytes: number): Promise<unknown>;
|
|
11
|
+
//# sourceMappingURL=boundedJson.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"boundedJson.d.ts","sourceRoot":"","sources":["../../src/v8/boundedJson.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS,CAIjE;AAED,iEAAiE;AACjE,wBAAsB,eAAe,CACnC,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CA2BlB"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Network reads the SDK makes on its own (hosted releases, draft changes):
|
|
3
|
+
* a timeout on the whole request, and a JSON body refused as soon as it
|
|
4
|
+
* would exceed a size, before it's buffered whole (a Worker isolate has
|
|
5
|
+
* 128 MB).
|
|
6
|
+
*/
|
|
7
|
+
/** An abort signal that fires after `ms`, where the runtime has `AbortSignal.timeout`. */
|
|
8
|
+
export function timeoutSignal(ms) {
|
|
9
|
+
return typeof AbortSignal !== "undefined" && typeof AbortSignal.timeout === "function"
|
|
10
|
+
? AbortSignal.timeout(ms)
|
|
11
|
+
: undefined;
|
|
12
|
+
}
|
|
13
|
+
/** Parses a JSON body, refusing it once it passes `maxBytes`. */
|
|
14
|
+
export async function readBoundedJson(response, label, maxBytes) {
|
|
15
|
+
const tooLarge = () => new Error(`${label}: larger than ${maxBytes} bytes`);
|
|
16
|
+
if (Number(response.headers.get("content-length")) > maxBytes) {
|
|
17
|
+
await response.body?.cancel();
|
|
18
|
+
throw tooLarge();
|
|
19
|
+
}
|
|
20
|
+
if (response.body === null) {
|
|
21
|
+
const text = await response.text();
|
|
22
|
+
if (text.length > maxBytes)
|
|
23
|
+
throw tooLarge();
|
|
24
|
+
return JSON.parse(text);
|
|
25
|
+
}
|
|
26
|
+
const reader = response.body.getReader();
|
|
27
|
+
const decoder = new TextDecoder();
|
|
28
|
+
const parts = [];
|
|
29
|
+
let size = 0;
|
|
30
|
+
for (;;) {
|
|
31
|
+
const { done, value } = await reader.read();
|
|
32
|
+
if (done)
|
|
33
|
+
break;
|
|
34
|
+
size += value.byteLength;
|
|
35
|
+
if (size > maxBytes) {
|
|
36
|
+
await reader.cancel();
|
|
37
|
+
throw tooLarge();
|
|
38
|
+
}
|
|
39
|
+
parts.push(decoder.decode(value, { stream: true }));
|
|
40
|
+
}
|
|
41
|
+
parts.push(decoder.decode());
|
|
42
|
+
return JSON.parse(parts.join(""));
|
|
43
|
+
}
|
|
44
|
+
//# sourceMappingURL=boundedJson.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"boundedJson.js","sourceRoot":"","sources":["../../src/v8/boundedJson.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,0FAA0F;AAC1F,MAAM,UAAU,aAAa,CAAC,EAAU;IACtC,OAAO,OAAO,WAAW,KAAK,WAAW,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,UAAU;QACpF,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,iEAAiE;AACjE,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,QAAkB,EAClB,KAAa,EACb,QAAgB;IAEhB,MAAM,QAAQ,GAAG,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,iBAAiB,QAAQ,QAAQ,CAAC,CAAC;IAC5E,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,GAAG,QAAQ,EAAE,CAAC;QAC9D,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QAC9B,MAAM,QAAQ,EAAE,CAAC;IACnB,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,IAAI,IAAI,CAAC,MAAM,GAAG,QAAQ;YAAE,MAAM,QAAQ,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;IACzC,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,SAAS,CAAC;QACR,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5C,IAAI,IAAI;YAAE,MAAM;QAChB,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC;QACzB,IAAI,IAAI,GAAG,QAAQ,EAAE,CAAC;YACpB,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,MAAM,QAAQ,EAAE,CAAC;QACnB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AACpC,CAAC"}
|
package/dist/v8/canonical.d.ts
CHANGED
|
@@ -32,39 +32,4 @@ export declare const CONTENT_HASH_FORMAT = 1;
|
|
|
32
32
|
* is opaque and may be computed differently (from file versions).
|
|
33
33
|
*/
|
|
34
34
|
export declare function computeContentRevision(blocks: Record<string, unknown>): Promise<string>;
|
|
35
|
-
/** The domain prefix of `blocks.apply` request digests, so they never equal another hash. */
|
|
36
|
-
export declare const APPLY_DIGEST_DOMAIN = "deco-content/blocks.apply@1\n";
|
|
37
|
-
/**
|
|
38
|
-
* The digest a request key is bound to: SHA-256 over the domain prefix and
|
|
39
|
-
* the canonical JSON of every supplied parameter.
|
|
40
|
-
*/
|
|
41
|
-
export declare function applyRequestDigest(params: object): Promise<string>;
|
|
42
|
-
/** The version of the draft overlay manifest format below. */
|
|
43
|
-
export declare const DRAFT_OVERLAY_FORMAT = 1;
|
|
44
|
-
/**
|
|
45
|
-
* A draft overlay manifest (see /next/content-delivery#exact-draft-previews):
|
|
46
|
-
* the complete, cumulative set of a draft's changes, never a patch over an
|
|
47
|
-
* earlier version. `set` maps each changed entry's name to the block hash of
|
|
48
|
-
* its JSON; `delete` names the entries the draft removed (tombstones). The two
|
|
49
|
-
* are disjoint. There is no base revision: the server rendering the draft layers it over the
|
|
50
|
-
* production content it already has.
|
|
51
|
-
*/
|
|
52
|
-
export interface DraftOverlay {
|
|
53
|
-
format: typeof DRAFT_OVERLAY_FORMAT;
|
|
54
|
-
set: Record<string, string>;
|
|
55
|
-
delete: string[];
|
|
56
|
-
}
|
|
57
|
-
/**
|
|
58
|
-
* The block hash of one changed entry: SHA-256 over its canonical JSON,
|
|
59
|
-
* lowercase hex. A draft block asset is stored under it
|
|
60
|
-
* (`/sites/<site>/draft-blocks/<block-hash>.json`), and the SDK checks every
|
|
61
|
-
* asset it downloads hashes to its name.
|
|
62
|
-
*/
|
|
63
|
-
export declare function computeBlockHash(entry: unknown): Promise<string>;
|
|
64
|
-
/**
|
|
65
|
-
* The overlay version: SHA-256 over the manifest's canonical JSON, lowercase
|
|
66
|
-
* hex. The manifest is stored under it (`/sites/<site>/drafts/<version>.json`)
|
|
67
|
-
* and a draft pointer names it after its `@`.
|
|
68
|
-
*/
|
|
69
|
-
export declare function computeOverlayVersion(overlay: DraftOverlay): Promise<string>;
|
|
70
35
|
//# sourceMappingURL=canonical.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"canonical.d.ts","sourceRoot":"","sources":["../../src/v8/canonical.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF;AAsDD,uGAAuG;AACvG,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAIpD;AAKD,uEAAuE;AACvE,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAG1E;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;;;;;;GAQG;AACH,wBAAsB,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAE7F
|
|
1
|
+
{"version":3,"file":"canonical.d.ts","sourceRoot":"","sources":["../../src/v8/canonical.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,qBAAa,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF;AAsDD,uGAAuG;AACvG,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAIpD;AAKD,uEAAuE;AACvE,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAG1E;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,IAAI,CAAC;AAErC;;;;;;;;GAQG;AACH,wBAAsB,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAE7F"}
|
package/dist/v8/canonical.js
CHANGED
|
@@ -99,32 +99,4 @@ export const CONTENT_HASH_FORMAT = 1;
|
|
|
99
99
|
export async function computeContentRevision(blocks) {
|
|
100
100
|
return sha256Hex(canonicalJson(blocks));
|
|
101
101
|
}
|
|
102
|
-
/** The domain prefix of `blocks.apply` request digests, so they never equal another hash. */
|
|
103
|
-
export const APPLY_DIGEST_DOMAIN = "deco-content/blocks.apply@1\n";
|
|
104
|
-
/**
|
|
105
|
-
* The digest a request key is bound to: SHA-256 over the domain prefix and
|
|
106
|
-
* the canonical JSON of every supplied parameter.
|
|
107
|
-
*/
|
|
108
|
-
export function applyRequestDigest(params) {
|
|
109
|
-
return sha256Hex(APPLY_DIGEST_DOMAIN + canonicalJson(params));
|
|
110
|
-
}
|
|
111
|
-
/** The version of the draft overlay manifest format below. */
|
|
112
|
-
export const DRAFT_OVERLAY_FORMAT = 1;
|
|
113
|
-
/**
|
|
114
|
-
* The block hash of one changed entry: SHA-256 over its canonical JSON,
|
|
115
|
-
* lowercase hex. A draft block asset is stored under it
|
|
116
|
-
* (`/sites/<site>/draft-blocks/<block-hash>.json`), and the SDK checks every
|
|
117
|
-
* asset it downloads hashes to its name.
|
|
118
|
-
*/
|
|
119
|
-
export function computeBlockHash(entry) {
|
|
120
|
-
return sha256Hex(canonicalJson(entry));
|
|
121
|
-
}
|
|
122
|
-
/**
|
|
123
|
-
* The overlay version: SHA-256 over the manifest's canonical JSON, lowercase
|
|
124
|
-
* hex. The manifest is stored under it (`/sites/<site>/drafts/<version>.json`)
|
|
125
|
-
* and a draft pointer names it after its `@`.
|
|
126
|
-
*/
|
|
127
|
-
export function computeOverlayVersion(overlay) {
|
|
128
|
-
return sha256Hex(canonicalJson(overlay));
|
|
129
|
-
}
|
|
130
102
|
//# sourceMappingURL=canonical.js.map
|
package/dist/v8/canonical.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"canonical.js","sourceRoot":"","sources":["../../src/v8/canonical.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED,SAAS,KAAK,CAAC,KAAc,EAAE,IAAY,EAAE,IAAiB,EAAE,GAAa;IAC3E,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjB,OAAO;IACT,CAAC;IACD,QAAQ,OAAO,KAAK,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAChC,OAAO;QACT,KAAK,SAAS;YACZ,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACnC,OAAO;QACT,KAAK,QAAQ;YACX,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,kBAAkB,CAAC,GAAG,IAAI,KAAK,KAAK,+BAA+B,CAAC,CAAC;YACjF,CAAC;YACD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,OAAO;QACT,KAAK,QAAQ;YACX,MAAM;QACR;YACE,MAAM,IAAI,kBAAkB,CAAC,GAAG,IAAI,OAAO,OAAO,KAAK,+BAA+B,CAAC,CAAC;IAC5F,CAAC;IACD,MAAM,MAAM,GAAG,KAAe,CAAC;IAC/B,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;QAClB,MAAM,IAAI,kBAAkB,CAAC,GAAG,IAAI,wCAAwC,CAAC,CAAC;IAChF,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC7B,IAAI,KAAK,GAAG,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,IAAI,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACzD,MAAM,IAAI,kBAAkB,CAAC,GAAG,IAAI,iDAAiD,CAAC,CAAC;QACzF,CAAC;QACD,4DAA4D;QAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QACxC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,KAAK,GAAG,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;YACnC,KAAK,CAAE,MAAkC,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,IAAI,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC;IACjC,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACtB,CAAC;AAED,MAAM,GAAG,GAAG,CAAC,KAAkB,EAAE,EAAE,CACjC,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAErF,uEAAuE;AACvE,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAyB;IACvD,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/E,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,KAAqB,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,MAA+B;IAC1E,OAAO,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AAC1C,CAAC
|
|
1
|
+
{"version":3,"file":"canonical.js","sourceRoot":"","sources":["../../src/v8/canonical.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED,SAAS,KAAK,CAAC,KAAc,EAAE,IAAY,EAAE,IAAiB,EAAE,GAAa;IAC3E,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjB,OAAO;IACT,CAAC;IACD,QAAQ,OAAO,KAAK,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAChC,OAAO;QACT,KAAK,SAAS;YACZ,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACnC,OAAO;QACT,KAAK,QAAQ;YACX,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,kBAAkB,CAAC,GAAG,IAAI,KAAK,KAAK,+BAA+B,CAAC,CAAC;YACjF,CAAC;YACD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7D,OAAO;QACT,KAAK,QAAQ;YACX,MAAM;QACR;YACE,MAAM,IAAI,kBAAkB,CAAC,GAAG,IAAI,OAAO,OAAO,KAAK,+BAA+B,CAAC,CAAC;IAC5F,CAAC;IACD,MAAM,MAAM,GAAG,KAAe,CAAC;IAC/B,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;QAClB,MAAM,IAAI,kBAAkB,CAAC,GAAG,IAAI,wCAAwC,CAAC,CAAC;IAChF,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACd,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YAC7B,IAAI,KAAK,GAAG,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,KAAK,CAAC,IAAI,EAAE,GAAG,IAAI,IAAI,KAAK,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;SAAM,CAAC;QACN,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;YACzD,MAAM,IAAI,kBAAkB,CAAC,GAAG,IAAI,iDAAiD,CAAC,CAAC;QACzF,CAAC;QACD,4DAA4D;QAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QACxC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC1B,IAAI,KAAK,GAAG,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;YACnC,KAAK,CAAE,MAAkC,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,IAAI,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChB,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED,uGAAuG;AACvG,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,MAAM,GAAG,GAAa,EAAE,CAAC;IACzB,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC;IACjC,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACtB,CAAC;AAED,MAAM,GAAG,GAAG,CAAC,KAAkB,EAAE,EAAE,CACjC,KAAK,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAErF,uEAAuE;AACvE,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAyB;IACvD,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC/E,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,KAAqB,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,MAA+B;IAC1E,OAAO,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AAC1C,CAAC"}
|
|
@@ -36,6 +36,11 @@ export interface CheckOptions {
|
|
|
36
36
|
cwd?: string;
|
|
37
37
|
reporter?: Reporter;
|
|
38
38
|
}
|
|
39
|
+
/**
|
|
40
|
+
* A schema must declare `"blocksMajor": 8`: the site editor treats a site as
|
|
41
|
+
* v8 only on that field, so a schema without it would edit as a v7 site.
|
|
42
|
+
*/
|
|
43
|
+
export declare function assertBlocksMajor(meta: unknown, file: string): void;
|
|
39
44
|
/** `deco check`. Returns the exit code: 0 when everything fits (warnings aside), 1 otherwise. */
|
|
40
45
|
export declare function check(options?: CheckOptions): number;
|
|
41
46
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v8/cli/check/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v8/cli/check/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAUH,OAAO,EAAmB,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAmB,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE3D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAItD,MAAM,WAAW,OAAO;IACtB,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAC;IACb,gFAAgF;IAChF,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B;AAuqBD,gEAAgE;AAChE,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,EAAE,CAe1E;AAED,iEAAiE;AACjE,wBAAgB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAgB1D;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAmBD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAcnE;AAED,iGAAiG;AACjG,wBAAgB,KAAK,CAAC,OAAO,GAAE,YAAiB,GAAG,MAAM,CAkBxD"}
|
|
@@ -19,6 +19,7 @@
|
|
|
19
19
|
import fs from "node:fs";
|
|
20
20
|
import { Ajv } from "ajv";
|
|
21
21
|
import { isWellFormedCiphertext } from "../../../protocol/secrets.js";
|
|
22
|
+
import { BLOCKS_MAJOR } from "../../../protocol/types.js";
|
|
22
23
|
import { SETTINGS_BLOCK, SETTINGS_TYPE } from "../../builtins/data.js";
|
|
23
24
|
import { isBlock, own } from "../../json.js";
|
|
24
25
|
import { findRouteConflicts } from "../../matchRoute.js";
|
|
@@ -691,12 +692,31 @@ function readSchemaFile(file) {
|
|
|
691
692
|
catch {
|
|
692
693
|
throw new CliError(`no ${file}; run deco schema first`);
|
|
693
694
|
}
|
|
695
|
+
let meta;
|
|
694
696
|
try {
|
|
695
|
-
|
|
697
|
+
meta = JSON.parse(text);
|
|
696
698
|
}
|
|
697
699
|
catch (error) {
|
|
698
700
|
throw new CliError(`${file}: invalid JSON: ${error.message}`);
|
|
699
701
|
}
|
|
702
|
+
assertBlocksMajor(meta, file);
|
|
703
|
+
return meta;
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* A schema must declare `"blocksMajor": 8`: the site editor treats a site as
|
|
707
|
+
* v8 only on that field, so a schema without it would edit as a v7 site.
|
|
708
|
+
*/
|
|
709
|
+
export function assertBlocksMajor(meta, file) {
|
|
710
|
+
const found = typeof meta === "object" && meta !== null && !Array.isArray(meta)
|
|
711
|
+
? meta.blocksMajor
|
|
712
|
+
: undefined;
|
|
713
|
+
if (found === BLOCKS_MAJOR)
|
|
714
|
+
return;
|
|
715
|
+
const what = found === undefined
|
|
716
|
+
? 'has no top-level "blocksMajor"'
|
|
717
|
+
: `has "blocksMajor": ${JSON.stringify(found)}`;
|
|
718
|
+
throw new CliError(`${file} ${what}; expected "blocksMajor": ${BLOCKS_MAJOR}. ` +
|
|
719
|
+
"It was written by an older or different deco schema: run deco schema to regenerate it, then commit it.");
|
|
700
720
|
}
|
|
701
721
|
/** `deco check`. Returns the exit code: 0 when everything fits (warnings aside), 1 otherwise. */
|
|
702
722
|
export function check(options = {}) {
|