@lionweb/validation 0.7.2 → 0.8.0-beta.0

package/src/validators/definitions/QueryDefinitions.ts

@@ -0,0 +1,146 @@
+import { MessageGroup } from "../generic/schema/SyntaxDefinition.js";
+
+export const QueryDefinitions: MessageGroup = {
+    name: "Query",
+    taggedUnionProperty: "messageKind",
+    sharedProperties: [
+        {
+            name: "messageKind",
+            type: "String",
+            isList: false,
+            isOptional: false,
+            mayBeNull: false,
+        },
+        {
+            name: "protocolMessages",
+            type: "ProtocolMessage",
+            isList: false,
+            isOptional: false,
+            mayBeNull: false,
+        },
+        {
+            name: "queryId",
+            type: "QueryId",
+            isList: false,
+            isOptional: false,
+            mayBeNull: false,
+        },
+    ],
+    messages: [
+        {
+            name: "SubscribeToChangingPartitionsRequest",
+            properties: [
+                {
+                    name: "creation",
+                    type: "Boolean",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "deletion",
+                    type: "Boolean",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "partitions",
+                    type: "Boolean",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "SubscribeToPartitionContentsRequest",
+            properties: [
+                {
+                    name: "partition",
+                    type: "LionWebId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "UnsubscribeFromPartitionContentsRequest",
+            properties: [
+                {
+                    name: "partition",
+                    type: "LionWebId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "SignOnRequest",
+            properties: [
+                {
+                    name: "deltaProtocolVersion",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "clientId",
+                    type: "ClientId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "repositoryId",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "signOffRequest",
+            properties: [],
+        },
+        {
+            name: "ReconnectRequest",
+            properties: [
+                {
+                    name: "participationId",
+                    type: "ParticipationId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "lastReceivedSequenceNumber",
+                    type: "EventSequenceNumber",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "GetAvailableIdsRequest",
+            properties: [
+                {
+                    name: "count",
+                    type: "Number",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "ListPartitionsRequest",
+            properties: [],
+        },
+    ],
+};

package/src/validators/definitions/README.md

@@ -0,0 +1,17 @@
+# Definitions
+
+The files in this folder contain the definitions for the format of the delta and bulkapi messages.
+
+The definitions are in the format used by the Validator in this package and used to validate the structure of delta messages and bulkapi requests.
+
+**NB.** These files are generated from a LionWeb model (will add reference later on) and should not be changed manually. 
+
+## ChunkDefinitions
+Contains all the type definitions for the LionWeb serialization format as described in the specification.
+
+## Command, Event, Query, Request, Response - definitions
+These files contain the type definitions for all the delta messages in the LionWeb specification.
+For easy cross-reference, the TSDoc of each delta contains a link to the place in the LionWeb specification where the delta is defined.
+
+## DeltaType Definitions
+This file contains the type definitions for the types of the properties being used in the Delta ,messages.

package/src/validators/definitions/RequestDefinitions.ts

@@ -0,0 +1,316 @@
+import { MessageGroup } from "../generic/schema/SyntaxDefinition.js";
+
+export const RequestDefinitions: MessageGroup = {
+    name: "Request",
+    taggedUnionProperty: "messageKind",
+    sharedProperties: [
+        {
+            name: "messageKind",
+            type: "String",
+            isList: false,
+            isOptional: false,
+            mayBeNull: false,
+        },
+        {
+            name: "protocolMessages",
+            type: "ProtocolMessage",
+            isList: true,
+            isOptional: false,
+            mayBeNull: false,
+        },
+        {
+            name: "queryId",
+            type: "QueryId",
+            isList: false,
+            isOptional: false,
+            mayBeNull: false,
+        },
+    ],
+    messages: [
+        {
+            name: "SubscribeToChangingPartitions",
+            properties: [
+                {
+                    name: "creation",
+                    type: "Boolean",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "deletion",
+                    type: "Boolean",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "partitions",
+                    type: "Boolean",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "messageKind",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "protocolMessages",
+                    type: "ProtocolMessage",
+                    isList: true,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "queryId",
+                    type: "QueryId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "SubscribeToPartitionContents",
+            properties: [
+                {
+                    name: "partition",
+                    type: "LionWebId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "messageKind",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "protocolMessages",
+                    type: "ProtocolMessage",
+                    isList: true,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "queryId",
+                    type: "QueryId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "UnsubscribeFromPartitionContents",
+            properties: [
+                {
+                    name: "partition",
+                    type: "LionWebId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "messageKind",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "protocolMessages",
+                    type: "ProtocolMessage",
+                    isList: true,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "queryId",
+                    type: "QueryId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "SignOn",
+            properties: [
+                {
+                    name: "deltaProtocolVersion",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "clientId",
+                    type: "ClientId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "repositoryId",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "messageKind",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "protocolMessages",
+                    type: "ProtocolMessage",
+                    isList: true,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "queryId",
+                    type: "QueryId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "SignOff",
+            properties: [
+                {
+                    name: "messageKind",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "protocolMessages",
+                    type: "ProtocolMessage",
+                    isList: true,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "queryId",
+                    type: "QueryId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "Reconnect",
+            properties: [
+                {
+                    name: "participationId",
+                    type: "ParticipationId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "lastReceivedSequenceNumber",
+                    type: "SequenceNumber",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "messageKind",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "protocolMessages",
+                    type: "ProtocolMessage",
+                    isList: true,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "queryId",
+                    type: "QueryId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "GetAvailableIds",
+            properties: [
+                {
+                    name: "count",
+                    type: "Number",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "messageKind",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "protocolMessages",
+                    type: "ProtocolMessage",
+                    isList: true,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "queryId",
+                    type: "QueryId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+        {
+            name: "ListPartitions",
+            properties: [
+                {
+                    name: "messageKind",
+                    type: "String",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "protocolMessages",
+                    type: "ProtocolMessage",
+                    isList: true,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+                {
+                    name: "queryId",
+                    type: "QueryId",
+                    isList: false,
+                    isOptional: false,
+                    mayBeNull: false,
+                },
+            ],
+        },
+    ],
+};