@directus/api 11.0.1 → 11.1.0

package/dist/websocket/types.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import type { Accountability, Query } from '@directus/types';
+import type { IncomingMessage } from 'http';
+import type internal from 'stream';
+import type { WebSocket } from 'ws';
+export type AuthenticationState = {
+    accountability: Accountability | null;
+    expires_at: number | null;
+    refresh_token?: string;
+};
+export type WebSocketClient = WebSocket & AuthenticationState & {
+    uid: string | number;
+    auth_timer: NodeJS.Timer | null;
+};
+export type UpgradeRequest = IncomingMessage & AuthenticationState;
+export type SubscriptionEvent = 'create' | 'update' | 'delete';
+export type Subscription = {
+    uid?: string | number;
+    query?: Query;
+    item?: string | number;
+    event?: SubscriptionEvent;
+    collection: string;
+    client: WebSocketClient;
+};
+export type UpgradeContext = {
+    request: IncomingMessage;
+    socket: internal.Duplex;
+    head: Buffer;
+};
+export type GraphQLSocket = {
+    client: WebSocketClient;
+};

package/dist/websocket/types.js

@@ -0,0 +1 @@
+export {};

package/dist/websocket/utils/get-expires-at-for-token.d.ts

@@ -0,0 +1 @@
+export declare function getExpiresAtForToken(token: string): number | null;

package/dist/websocket/utils/get-expires-at-for-token.js

@@ -0,0 +1,8 @@
+import jwt from 'jsonwebtoken';
+export function getExpiresAtForToken(token) {
+    const decoded = jwt.decode(token);
+    if (decoded && typeof decoded === 'object' && decoded.exp) {
+        return decoded.exp;
+    }
+    return null;
+}

package/dist/websocket/utils/message.d.ts

@@ -0,0 +1,4 @@
+import type { WebSocketClient } from '../types.js';
+export declare const fmtMessage: (type: string, data?: Record<string, any>, uid?: string | number) => string;
+export declare const safeSend: (client: WebSocketClient, data: string, delay?: number) => Promise<unknown>;
+export declare const getMessageType: (message: any) => string;

package/dist/websocket/utils/message.js

@@ -0,0 +1,27 @@
+// a simple util for building a message object
+export const fmtMessage = (type, data = {}, uid) => {
+    const message = { type, ...data };
+    if (uid !== undefined) {
+        message['uid'] = uid;
+    }
+    return JSON.stringify(message);
+};
+// we may need this later for slow connections
+export const safeSend = async (client, data, delay = 100) => {
+    if (client.readyState !== client.OPEN)
+        return false;
+    if (client.bufferedAmount > 0) {
+        // wait for the buffer to clear
+        return new Promise((resolve) => {
+            setTimeout(() => {
+                safeSend(client, data, delay).then((success) => resolve(success));
+            }, delay);
+        });
+    }
+    client.send(data);
+    return true;
+};
+// an often used message type extractor function
+export const getMessageType = (message) => {
+    return typeof message !== 'object' || Array.isArray(message) || message === null ? '' : String(message.type);
+};

package/dist/websocket/utils/wait-for-message.d.ts

@@ -0,0 +1,4 @@
+import type { WebSocket } from 'ws';
+import { WebSocketMessage } from '../messages.js';
+export declare const waitForAnyMessage: (client: WebSocket, timeout: number) => Promise<Record<string, any>>;
+export declare const waitForMessageType: (client: WebSocket, type: string, timeout: number) => Promise<WebSocketMessage>;

package/dist/websocket/utils/wait-for-message.js

@@ -0,0 +1,45 @@
+import { parseJSON } from '@directus/utils';
+import { WebSocketMessage } from '../messages.js';
+import { getMessageType } from './message.js';
+export const waitForAnyMessage = (client, timeout) => {
+    return new Promise((resolve, reject) => {
+        client.on('message', awaitMessage);
+        const timer = setTimeout(() => {
+            client.off('message', awaitMessage);
+            reject();
+        }, timeout);
+        function awaitMessage(event) {
+            try {
+                clearTimeout(timer);
+                client.off('message', awaitMessage);
+                resolve(parseJSON(event.toString()));
+            }
+            catch (err) {
+                reject(err);
+            }
+        }
+    });
+};
+export const waitForMessageType = (client, type, timeout) => {
+    return new Promise((resolve, reject) => {
+        client.on('message', awaitMessage);
+        const timer = setTimeout(() => {
+            client.off('message', awaitMessage);
+            reject();
+        }, timeout);
+        function awaitMessage(event) {
+            let msg;
+            try {
+                msg = WebSocketMessage.parse(parseJSON(event.toString()));
+            }
+            catch {
+                return;
+            }
+            if (getMessageType(msg) === type) {
+                clearTimeout(timer);
+                client.off('message', awaitMessage);
+                resolve(msg);
+            }
+        }
+    });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@directus/api",
-  "version": "11.0.1",
+  "version": "11.1.0",
   "description": "Directus is a real-time API and App dashboard for managing SQL database content",
   "keywords": [
     "directus",
@@ -92,6 +92,7 @@
     "fs-extra": "11.1.1",
     "graphql": "16.6.0",
     "graphql-compose": "9.0.10",
+    "graphql-ws": "5.12.0",
     "helmet": "7.0.0",
     "icc": "3.0.0",
     "inquirer": "9.2.4",
@@ -139,20 +140,23 @@
     "uuid-validate": "0.0.3",
     "vm2": "3.9.19",
     "wellknown": "0.5.0",
-    "@directus/app": "10.3.0",
-    "@directus/constants": "10.2.0",
-    "@directus/exceptions": "10.0.2",
-    "@directus/extensions-sdk": "10.1.3",
-    "@directus/pressure": "1.0.3",
+    "ws": "8.12.1",
+    "zod": "3.21.4",
+    "zod-validation-error": "1.0.1",
+    "@directus/app": "10.3.1",
+    "@directus/constants": "10.2.1",
+    "@directus/exceptions": "10.0.3",
+    "@directus/extensions-sdk": "10.1.4",
+    "@directus/pressure": "1.0.4",
     "@directus/schema": "10.0.1",
     "@directus/specs": "10.1.1",
-    "@directus/storage": "10.0.2",
-    "@directus/storage-driver-azure": "10.0.4",
-    "@directus/storage-driver-cloudinary": "10.0.4",
-    "@directus/storage-driver-gcs": "10.0.4",
-    "@directus/storage-driver-local": "10.0.4",
-    "@directus/storage-driver-s3": "10.0.4",
-    "@directus/utils": "10.0.4"
+    "@directus/storage": "10.0.3",
+    "@directus/storage-driver-azure": "10.0.5",
+    "@directus/storage-driver-cloudinary": "10.0.5",
+    "@directus/storage-driver-gcs": "10.0.5",
+    "@directus/storage-driver-local": "10.0.5",
+    "@directus/storage-driver-s3": "10.0.5",
+    "@directus/utils": "10.0.5"
   },
   "devDependencies": {
     "@ngneat/falso": "6.4.0",
@@ -191,6 +195,7 @@
     "@types/uuid": "9.0.1",
     "@types/uuid-validate": "0.0.1",
     "@types/wellknown": "0.5.4",
+    "@types/ws": "8.5.4",
     "@vitest/coverage-c8": "0.31.1",
     "copyfiles": "2.4.1",
     "form-data": "4.0.0",
@@ -199,7 +204,7 @@
     "typescript": "5.0.4",
     "vitest": "0.31.1",
     "@directus/tsconfig": "0.0.7",
-    "@directus/types": "10.1.0"
+    "@directus/types": "10.1.1"
   },
   "optionalDependencies": {
     "@keyv/redis": "2.5.8",