@rest-vir/define-service 0.0.2

package/dist/web-socket/web-socket-definition.js

@@ -0,0 +1,78 @@
+import { defineShape, indexedKeys, optional, or, unknownShape, } from 'object-shape-tester';
+import { assertValidEndpointPath } from '../endpoint/endpoint-path.js';
+import { ensureServiceDefinitionError } from '../service/service-definition.error.js';
+import { originRequirementShape } from '../util/origin.js';
+/**
+ * Shape definition for {@link WebSocketInit}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export const webSocketInitShape = defineShape({
+    messageFromClientShape: unknownShape(),
+    messageFromHostShape: unknownShape(),
+    searchParamsShape: unknownShape(),
+    /**
+     * Set a required client origin for this WebSocket.
+     *
+     * - If this is omitted, the service's origin requirement is used instead.
+     * - If this is explicitly set to `undefined`, this endpoint allows any origins (regardless of the
+     *   service's origin requirement).
+     * - Any other set value overrides the service's origin requirement (if it has any).
+     */
+    requiredClientOrigin: originRequirementShape,
+    customProps: optional(or(undefined, indexedKeys({
+        keys: unknownShape(),
+        values: unknownShape(),
+        required: false,
+    }))),
+    protocolsShape: unknownShape(),
+});
+/**
+ * Attaches message type-only getters to a WebSocket definition.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export function attachWebSocketShapeTypeGetters(webSocketDefinition) {
+    Object.defineProperties(webSocketDefinition, {
+        MessageFromClientType: {
+            enumerable: false,
+            get() {
+                throw new Error('.MessageFromClientType should not be used as a value.');
+            },
+        },
+        MessageFromHostType: {
+            enumerable: false,
+            get() {
+                throw new Error('.MessageFromHostType should not be used as a value.');
+            },
+        },
+        ProtocolsType: {
+            enumerable: false,
+            get() {
+                throw new Error('.ProtocolsType should not be used as a value.');
+            },
+        },
+    });
+}
+/**
+ * Asserts the the WebSocket definition is valid.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/define-service
+ * @package [`@rest-vir/define-service`](https://www.npmjs.com/package/@rest-vir/define-service)
+ */
+export function assertValidWebSocketDefinition(webSocketDefinition) {
+    try {
+        assertValidEndpointPath(webSocketDefinition.path);
+    }
+    catch (error) {
+        throw ensureServiceDefinitionError(error, {
+            serviceName: webSocketDefinition.service.serviceName,
+            ...webSocketDefinition,
+        });
+    }
+}

package/package.json

@@ -0,0 +1,68 @@
+{
+    "name": "@rest-vir/define-service",
+    "version": "0.0.2",
+    "description": "Define an connect to a declarative and type safe REST and WebSocket service.",
+    "keywords": [
+        "rest",
+        "api",
+        "express",
+        "service",
+        "backend",
+        "server",
+        "websocket",
+        "vir"
+    ],
+    "homepage": "https://github.com/electrovir/rest-vir",
+    "bugs": {
+        "url": "https://github.com/electrovir/rest-vir/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/electrovir/rest-vir.git"
+    },
+    "license": "(MIT or CC0 1.0)",
+    "author": {
+        "name": "electrovir",
+        "url": "https://github.com/electrovir"
+    },
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "virmator frontend build",
+        "compile": "virmator compile",
+        "docs": "md-code README.md",
+        "start": "virmator frontend",
+        "test": "virmator test web",
+        "test:coverage": "npm run test coverage",
+        "test:docs": "npm run docs check",
+        "test:update": "npm test update"
+    },
+    "dependencies": {
+        "@augment-vir/assert": "^31.9.1",
+        "@augment-vir/common": "^31.9.1",
+        "date-vir": "^7.2.0",
+        "object-shape-tester": "^5.1.1",
+        "type-fest": "^4.35.0",
+        "url-vir": "^2.1.1"
+    },
+    "devDependencies": {
+        "@augment-vir/test": "^31.9.1",
+        "@web/dev-server-esbuild": "^1.0.4",
+        "@web/test-runner": "^0.20.0",
+        "@web/test-runner-commands": "^0.9.0",
+        "@web/test-runner-playwright": "^0.11.0",
+        "@web/test-runner-visual-regression": "^0.10.0",
+        "istanbul-smart-text-reporter": "^1.1.5",
+        "markdown-code-example-inserter": "^3.0.3",
+        "typedoc": "^0.27.7",
+        "ws": "^8.18.0"
+    },
+    "engines": {
+        "node": ">=22"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}