@polytric/openws-spec 0.0.1 → 0.0.3

package/spec.js

@@ -1,62 +0,0 @@
-const S = require("@pocketgems/schema");
-
-const keyPattern = "[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9]";
-
-const OpenWSSchema = S.obj({
-  openws: S.str.enum("0.0.1").desc("The OpenWS schema version"),
-  info: S.obj({
-    title: S.str.desc("A title for the overall system.").optional(),
-    description: S.str
-      .desc(
-        "A high level description of the overall system, including all networks and all participants"
-      )
-      .optional(),
-    version: S.str.desc("A version string").optional(),
-  }),
-  networks: S.map
-    .min(1)
-    .keyPattern(keyPattern)
-    .value(
-        S.obj({
-            participants:         S.map
-            .min(2)
-            .keyPattern(keyPattern)
-            .desc(
-              "A participant is a server or client in the network. Multiple server and clients can coexist in the same network. The simplest network contains a server-client pair."
-            )
-            .value(
-              S.obj({
-                endpoints: S.arr(
-                    S.obj({
-                        host: S.str,
-                        port: S.int.min(0).max(65535).default(443),
-                        path: S.str.default('/'),
-                    })
-                ).min(1).optional().desc('A participant can declare an endpoint to accept connections from other participants, normally used by servers'),
-                handlers: S.map
-                  .min(1)
-                  .keyPattern(keyPattern)
-                  .value(
-                    S.obj({
-                      payload: S.obj({})
-                        .min(1)
-                        .desc(
-                            "Must be a valid JSON schema spec. For brevity, openws omits this spec, but implementations should valid this"
-                        ),
-                      description: S.str.optional()
-                    })
-                  )
-                  .desc(
-                    "A handler is implemented by a participant, and participants can invoke others handlers. The OpenWS spec only defines the shape of the payload, and how things get encoded / decoded on the wire, it doesn't determine behavior (through through description the behavior can be documented)."
-                  ),
-              })
-            ),    
-        })
-    ),
-});
-
-if (require.main === module) {
-  console.log(JSON.stringify(OpenWSSchema.jsonSchema()));
-}
-
-module.exports = OpenWSSchema;

package/spec.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"openws":{"type":"string","enum":["0.0.1"],"description":"The OpenWS schema version"},"info":{"type":"object","properties":{"title":{"type":"string","description":"A title for the overall system."},"description":{"type":"string","description":"A high level description of the overall system, including all networks and all participants"},"version":{"type":"string","description":"A version string"}},"additionalProperties":false},"networks":{"type":"object","minProperties":1,"patternProperties":{"^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9]$":{"type":"object","properties":{"participants":{"type":"object","minProperties":2,"description":"A participant is a server or client in the network. Multiple server and clients can coexist in the same network. The simplest network contains a server-client pair.","patternProperties":{"^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9]$":{"type":"object","properties":{"endpoints":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"integer","minimum":0,"maximum":65535,"default":443},"path":{"type":"string","default":"/"}},"required":["host","port","path"],"additionalProperties":false},"minItems":1,"description":"A participant can declare an endpoint to accept connections from other participants, normally used by servers"},"handlers":{"type":"object","minProperties":1,"patternProperties":{"^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9]$":{"type":"object","properties":{"payload":{"type":"object","minProperties":1,"description":"Must be a valid JSON schema spec. For brevity, openws omits this spec, but implementations should valid this","additionalProperties":true},"description":{"type":"string"}},"required":["payload"],"additionalProperties":false}},"description":"A handler is implemented by a participant, and participants can invoke others handlers. The OpenWS spec only defines the shape of the payload, and how things get encoded / decoded on the wire, it doesn't determine behavior (through through description the behavior can be documented).","additionalProperties":false}},"required":["handlers"],"additionalProperties":false}},"additionalProperties":false}},"required":["participants"],"additionalProperties":false}},"additionalProperties":false}},"required":["openws","info","networks"],"additionalProperties":false,"$schema":"http://json-schema.org/draft-07/schema#"}