@ixo/topic-protocol 1.0.0-rc.7 → 1.0.0-rc.8
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/README.md +3 -1
- package/dist/src/contracts/precompiled.d.ts +30 -0
- package/dist/src/contracts/precompiled.js +29 -0
- package/dist/src/contracts/precompiled.js.map +1 -0
- package/dist/src/contracts/validator.js +5 -35
- package/dist/src/contracts/validator.js.map +1 -1
- package/dist/src/contracts/validators.generated.d.ts +47 -0
- package/dist/src/contracts/validators.generated.js +55104 -0
- package/dist/src/contracts/validators.generated.js.map +1 -0
- package/dist/src/v2/index.d.ts +2 -1
- package/dist/src/v2/index.js +2 -1
- package/dist/src/v2/index.js.map +1 -1
- package/dist/src/v2/schemas.d.ts +638 -0
- package/dist/src/v2/schemas.js +13 -0
- package/dist/src/v2/schemas.js.map +1 -0
- package/dist/src/v2/validate.d.ts +1 -638
- package/dist/src/v2/validate.js +5 -24
- package/dist/src/v2/validate.js.map +1 -1
- package/dist/src/v2/validators.generated.d.ts +8 -0
- package/dist/src/v2/validators.generated.js +5140 -0
- package/dist/src/v2/validators.generated.js.map +1 -0
- package/package.json +7 -5
- package/dist/schemas/v2/common.schema.json +0 -68
package/README.md
CHANGED
|
@@ -9,13 +9,15 @@ identity of a discussion.
|
|
|
9
9
|
|
|
10
10
|
## Status
|
|
11
11
|
|
|
12
|
-
**Version:** 1.0.0-rc.
|
|
12
|
+
**Version:** 1.0.0-rc.8
|
|
13
13
|
|
|
14
14
|
The normative Topic Shape progression and Portal Now projection are defined in
|
|
15
15
|
[Topic Shape Framework v1](docs/topic-shape-framework.md).
|
|
16
16
|
|
|
17
17
|
The [rc.4 lifecycle integration guide](docs/implementation/lifecycle-rc4.md) describes admission, result evidence, and pinned-source compatibility.
|
|
18
18
|
|
|
19
|
+
The [rc.8 runtime note](docs/implementation/precompiled-validators-rc8.md) explains the precompiled contract validators that let the package run where code generation from strings is forbidden, such as Cloudflare Workers.
|
|
20
|
+
|
|
19
21
|
**Maturity:** Draft implementation candidate
|
|
20
22
|
**Execution source of truth:** [Linear Topic Protocol project](https://linear.app/ixo-world/project/topic-protocol-4ea58bc7910d)
|
|
21
23
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Runtime support for the precompiled JSON-schema validators emitted by
|
|
3
|
+
* `scripts/build-validators.mjs`. The generated modules import from here so the
|
|
4
|
+
* package never loads the Ajv compiler at runtime; Ajv compiles schemas by
|
|
5
|
+
* generating code from strings, which Cloudflare Workers forbid
|
|
6
|
+
* (`EvalError: Code generation from strings disallowed`).
|
|
7
|
+
*/
|
|
8
|
+
/** The subset of Ajv's `ErrorObject` that the protocol reads. */
|
|
9
|
+
export interface PrecompiledValidationError {
|
|
10
|
+
readonly instancePath: string;
|
|
11
|
+
readonly schemaPath: string;
|
|
12
|
+
readonly keyword: string;
|
|
13
|
+
readonly params: Readonly<Record<string, unknown>>;
|
|
14
|
+
readonly message?: string;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* A validate function emitted by `ajv/dist/standalone`. After a call, `errors`
|
|
18
|
+
* holds the failures of that call (or `null` when the data was valid), exactly
|
|
19
|
+
* like an Ajv `ValidateFunction`.
|
|
20
|
+
*/
|
|
21
|
+
export interface PrecompiledValidator {
|
|
22
|
+
(data: unknown): boolean;
|
|
23
|
+
errors?: PrecompiledValidationError[] | null;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Count Unicode code points the way Ajv does for `minLength` / `maxLength`
|
|
27
|
+
* (surrogate pairs count once). Ported from `ajv/dist/runtime/ucs2length.js`
|
|
28
|
+
* (MIT, Evgeny Poberezkin) so the generated validators do not depend on Ajv.
|
|
29
|
+
*/
|
|
30
|
+
export declare function ucs2length(value: string): number;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Runtime support for the precompiled JSON-schema validators emitted by
|
|
3
|
+
* `scripts/build-validators.mjs`. The generated modules import from here so the
|
|
4
|
+
* package never loads the Ajv compiler at runtime; Ajv compiles schemas by
|
|
5
|
+
* generating code from strings, which Cloudflare Workers forbid
|
|
6
|
+
* (`EvalError: Code generation from strings disallowed`).
|
|
7
|
+
*/
|
|
8
|
+
/**
|
|
9
|
+
* Count Unicode code points the way Ajv does for `minLength` / `maxLength`
|
|
10
|
+
* (surrogate pairs count once). Ported from `ajv/dist/runtime/ucs2length.js`
|
|
11
|
+
* (MIT, Evgeny Poberezkin) so the generated validators do not depend on Ajv.
|
|
12
|
+
*/
|
|
13
|
+
export function ucs2length(value) {
|
|
14
|
+
const units = value.length;
|
|
15
|
+
let length = 0;
|
|
16
|
+
let position = 0;
|
|
17
|
+
while (position < units) {
|
|
18
|
+
length += 1;
|
|
19
|
+
const unit = value.charCodeAt(position);
|
|
20
|
+
position += 1;
|
|
21
|
+
if (unit >= 0xd800 && unit <= 0xdbff && position < units) {
|
|
22
|
+
const next = value.charCodeAt(position);
|
|
23
|
+
if ((next & 0xfc00) === 0xdc00)
|
|
24
|
+
position += 1;
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
return length;
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=precompiled.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"precompiled.js","sourceRoot":"","sources":["../../../src/contracts/precompiled.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAqBH;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;IAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,OAAO,QAAQ,GAAG,KAAK,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,CAAC;QACZ,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxC,QAAQ,IAAI,CAAC,CAAC;QACd,IAAI,IAAI,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,IAAI,QAAQ,GAAG,KAAK,EAAE,CAAC;YACzD,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,MAAM;gBAAE,QAAQ,IAAI,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -1,45 +1,15 @@
|
|
|
1
|
-
import { Ajv2020, } from "ajv/dist/2020.js";
|
|
2
|
-
import * as formatsModule from "ajv-formats";
|
|
3
1
|
import { TopicProtocolError } from "../errors.js";
|
|
4
2
|
import { SCHEMA_REGISTRY, } from "./schemas.js";
|
|
5
|
-
|
|
6
|
-
const validators = new Map();
|
|
7
|
-
const addFormats = formatsModule.default;
|
|
8
|
-
addFormats(ajv);
|
|
9
|
-
ajv.addKeyword({
|
|
10
|
-
keyword: "uniqueItemProperty",
|
|
11
|
-
type: "array",
|
|
12
|
-
schemaType: "string",
|
|
13
|
-
validate: (property, data) => {
|
|
14
|
-
if (!Array.isArray(data))
|
|
15
|
-
return true;
|
|
16
|
-
const seen = new Set();
|
|
17
|
-
for (const item of data) {
|
|
18
|
-
if (typeof item !== "object" || item === null || Array.isArray(item))
|
|
19
|
-
continue;
|
|
20
|
-
const value = item[property];
|
|
21
|
-
if (seen.has(value))
|
|
22
|
-
return false;
|
|
23
|
-
seen.add(value);
|
|
24
|
-
}
|
|
25
|
-
return true;
|
|
26
|
-
},
|
|
27
|
-
});
|
|
28
|
-
for (const schema of Object.values(SCHEMA_REGISTRY))
|
|
29
|
-
ajv.addSchema(schema);
|
|
30
|
-
const dateTimeValidator = ajv.compile({ type: "string", format: "date-time" });
|
|
3
|
+
import { CONTRACT_VALIDATORS, dateTime as dateTimeValidator } from "./validators.generated.js";
|
|
31
4
|
function isContractName(value) {
|
|
32
5
|
return Object.hasOwn(SCHEMA_REGISTRY, value);
|
|
33
6
|
}
|
|
34
7
|
function validatorFor(name) {
|
|
35
|
-
const
|
|
36
|
-
if (
|
|
37
|
-
|
|
38
|
-
const schema = SCHEMA_REGISTRY[name];
|
|
39
|
-
const validator = ajv.getSchema(schema.$id);
|
|
40
|
-
if (validator === undefined)
|
|
8
|
+
const validator = CONTRACT_VALIDATORS.get(name);
|
|
9
|
+
if (validator === undefined) {
|
|
10
|
+
const schema = SCHEMA_REGISTRY[name];
|
|
41
11
|
throw new Error(`Schema is not registered: ${schema.$id}`);
|
|
42
|
-
|
|
12
|
+
}
|
|
43
13
|
return validator;
|
|
44
14
|
}
|
|
45
15
|
export function isJsonDateTime(value) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../../src/contracts/validator.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../../src/contracts/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,OAAO,EACL,eAAe,GAEhB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAY/F,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,YAAY,CAAC,IAAkB;IACtC,MAAM,SAAS,GAAG,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAA6B,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;IAC7D,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,cAAc,CAAC,KAAiC;IACvD,MAAM,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;IACxE,OAAO;QACL,YAAY,EAAE,IAAI;QAClB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,OAAO,EAAE,GAAG,IAAI,IAAI,KAAK,CAAC,OAAO,IAAI,YAAY,EAAE;KACpD,CAAC;AACJ,CAAC;AAED,SAAS,4BAA4B,CAAC,KAAc,EAAE,MAAM,GAAG,EAAE;IAC/D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1F,MAAM,OAAO,GAAG,KAA0C,CAAC;IAC3D,MAAM,SAAS,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAC3D,IAAI,OAAO,SAAS,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IACpD,MAAM,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAClD,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CACtE,OAAO,KAAK,KAAK,QAAQ;WACtB,KAAK,KAAK,IAAI;WACd,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;WACpB,KAA2C,CAAC,EAAE,KAAK,SAAS,CACjE,CAAC;QAAE,OAAO,SAAS,CAAC;IACrB,MAAM,YAAY,GAAG,GAAG,MAAM,mCAAmC,CAAC;IAClE,OAAO;QACL,YAAY;QACZ,OAAO,EAAE,yBAAyB;QAClC,OAAO,EAAE,GAAG,YAAY,wCAAwC;KACjE,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,IAAkB,EAAE,KAAc;IACxD,IAAI,IAAI,KAAK,cAAc,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,4BAA4B,CAAC,KAAK,CAAC,CAAC;QAClD,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,IAAI,KAAK,qBAAqB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACrH,MAAM,KAAK,GAAG,4BAA4B,CAAE,KAA2C,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7G,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,IAAkB,EAClB,KAAc;IAEd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,kBAAkB,CAC1B,kBAAkB,EAClB,oCAAoC,MAAM,CAAC,IAAI,CAAC,EAAE,EAClD,EAAE,IAAI,EAAE,CACT,CAAC;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,SAAS,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC;IAClG,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3C,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAkB,EAAE,KAAc;IAC/D,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,IAAI,MAAM,CAAC,EAAE;QAAE,OAAO;IACtB,MAAM,IAAI,kBAAkB,CAC1B,4BAA4B,EAC5B,GAAG,IAAI,6BAA6B,EACpC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAC1C,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { type PrecompiledValidator } from "./precompiled.js";
|
|
2
|
+
import type { ContractName } from "./schemas.js";
|
|
3
|
+
export declare const actionReceipt: PrecompiledValidator;
|
|
4
|
+
export declare const agentRun: PrecompiledValidator;
|
|
5
|
+
export declare const approvalDecision: PrecompiledValidator;
|
|
6
|
+
export declare const claimRecord: PrecompiledValidator;
|
|
7
|
+
export declare const decisionToPayTemplateV2: PrecompiledValidator;
|
|
8
|
+
export declare const decisionToPayTemplate: PrecompiledValidator;
|
|
9
|
+
export declare const deliveryDecision: PrecompiledValidator;
|
|
10
|
+
export declare const deliveryPacket: PrecompiledValidator;
|
|
11
|
+
export declare const evaluationAssertion: PrecompiledValidator;
|
|
12
|
+
export declare const externalProjectSnapshot: PrecompiledValidator;
|
|
13
|
+
export declare const externalSessionBinding: PrecompiledValidator;
|
|
14
|
+
export declare const externalWorkBinding: PrecompiledValidator;
|
|
15
|
+
export declare const externalWorkStateMap: PrecompiledValidator;
|
|
16
|
+
export declare const jobCard: PrecompiledValidator;
|
|
17
|
+
export declare const payableObligationV2: PrecompiledValidator;
|
|
18
|
+
export declare const payableObligation: PrecompiledValidator;
|
|
19
|
+
export declare const paymentTermsV2: PrecompiledValidator;
|
|
20
|
+
export declare const paymentTerms: PrecompiledValidator;
|
|
21
|
+
export declare const projectPlan: PrecompiledValidator;
|
|
22
|
+
export declare const projectProjection: PrecompiledValidator;
|
|
23
|
+
export declare const roomPolicy: PrecompiledValidator;
|
|
24
|
+
export declare const settlementReceipt: PrecompiledValidator;
|
|
25
|
+
export declare const topicActionRequest: PrecompiledValidator;
|
|
26
|
+
export declare const topicCapsule: PrecompiledValidator;
|
|
27
|
+
export declare const topicContractBody: PrecompiledValidator;
|
|
28
|
+
export declare const topicContractState: PrecompiledValidator;
|
|
29
|
+
export declare const topicFileAttachment: PrecompiledValidator;
|
|
30
|
+
export declare const topicFlowBinding: PrecompiledValidator;
|
|
31
|
+
export declare const topicIndexEntry: PrecompiledValidator;
|
|
32
|
+
export declare const topicIndex: PrecompiledValidator;
|
|
33
|
+
export declare const topicKindProfile: PrecompiledValidator;
|
|
34
|
+
export declare const topicMessage: PrecompiledValidator;
|
|
35
|
+
export declare const topicOperation: PrecompiledValidator;
|
|
36
|
+
export declare const topicPreferences: PrecompiledValidator;
|
|
37
|
+
export declare const topicRecipe: PrecompiledValidator;
|
|
38
|
+
export declare const topicRecordMessage: PrecompiledValidator;
|
|
39
|
+
export declare const topicRecord: PrecompiledValidator;
|
|
40
|
+
export declare const topicRelation: PrecompiledValidator;
|
|
41
|
+
export declare const topicRoot: PrecompiledValidator;
|
|
42
|
+
export declare const topicShape: PrecompiledValidator;
|
|
43
|
+
export declare const topicSourceMessage: PrecompiledValidator;
|
|
44
|
+
export declare const topicState: PrecompiledValidator;
|
|
45
|
+
export declare const workItemSnapshot: PrecompiledValidator;
|
|
46
|
+
export declare const dateTime: PrecompiledValidator;
|
|
47
|
+
export declare const CONTRACT_VALIDATORS: ReadonlyMap<ContractName, PrecompiledValidator>;
|