@yassidev/nuxt-directus 0.0.1

package/README.md

@@ -0,0 +1,84 @@
+<!--
+Get your module up and running quickly.
+
+Find and replace all on all files (CMD+SHIFT+F):
+- Name: My Module
+- Package name: my-module
+- Description: My new Nuxt module
+-->
+
+# My Module
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+My new Nuxt module for doing amazing things.
+
+- [✨ &nbsp;Release Notes](/CHANGELOG.md)
+<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
+<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+<!-- Highlight some of the features your module provide here -->
+- ⛰ &nbsp;Foo
+- 🚠 &nbsp;Bar
+- 🌲 &nbsp;Baz
+
+## Quick Setup
+
+Install the module to your Nuxt application with one command:
+
+```bash
+npx nuxi module add my-module
+```
+
+That's it! You can now use My Module in your Nuxt app ✨
+
+
+## Contribution
+
+<details>
+  <summary>Local development</summary>
+  
+  ```bash
+  # Install dependencies
+  npm install
+  
+  # Generate type stubs
+  npm run dev:prepare
+  
+  # Develop with the playground
+  npm run dev
+  
+  # Build the playground
+  npm run dev:build
+  
+  # Run ESLint
+  npm run lint
+  
+  # Run Vitest
+  npm run test
+  npm run test:watch
+  
+  # Release new version
+  npm run release
+  ```
+
+</details>
+
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/my-module
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-downloads-href]: https://npm.chart.dev/my-module
+
+[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://npmjs.com/package/my-module
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.d.mts

@@ -0,0 +1,575 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { IncomingMessage, ServerResponse } from 'node:http';
+
+type QueryValue = string | number | undefined | null | boolean | Array<QueryValue> | Record<string, any>;
+type QueryObject = Record<string, QueryValue | QueryValue[]>;
+
+/**
+ * A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent)
+ */
+interface CloseEvent extends Event {
+    /**
+     * Returns the WebSocket connection close code provided by the server.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/code)
+     */
+    readonly code: number;
+    /**
+     * Returns the WebSocket connection close reason provided by the server.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/reason)
+     */
+    readonly reason: string;
+    /**
+     * Returns true if the connection closed cleanly; false otherwise.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CloseEvent/wasClean)
+     */
+    readonly wasClean: boolean;
+}
+/**
+ * An event which takes place in the DOM.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event)
+ */
+interface Event {
+    /**
+     * Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/bubbles)
+     */
+    readonly bubbles: boolean;
+    /**
+     * @deprecated
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelBubble)
+     */
+    cancelBubble: boolean;
+    /**
+     * Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/cancelable)
+     */
+    readonly cancelable: boolean;
+    /**
+     * Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composed)
+     */
+    readonly composed: boolean;
+    /**
+     * Returns the object whose event listener's callback is currently being invoked.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/currentTarget)
+     */
+    readonly currentTarget: EventTarget | null;
+    /**
+     * Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/defaultPrevented)
+     */
+    readonly defaultPrevented: boolean;
+    /**
+     * Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/eventPhase)
+     */
+    readonly eventPhase: number;
+    /**
+     * Returns true if event was dispatched by the user agent, and false otherwise.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/isTrusted)
+     */
+    readonly isTrusted: boolean;
+    /**
+     * @deprecated
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/returnValue)
+     */
+    returnValue: boolean;
+    /**
+     * @deprecated
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/srcElement)
+     */
+    readonly srcElement: EventTarget | null;
+    /**
+     * Returns the object to which event is dispatched (its target).
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/target)
+     */
+    readonly target: EventTarget | null;
+    /**
+     * Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/timeStamp)
+     */
+    readonly timeStamp: DOMHighResTimeStamp;
+    /**
+     * Returns the type of event, e.g. "click", "hashchange", or "submit".
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/type)
+     */
+    readonly type: string;
+    /**
+     * Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/composedPath)
+     */
+    composedPath(): EventTarget[];
+    /**
+     * @deprecated
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/initEvent)
+     */
+    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
+    /**
+     * If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/preventDefault)
+     */
+    preventDefault(): void;
+    /**
+     * Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopImmediatePropagation)
+     */
+    stopImmediatePropagation(): void;
+    /**
+     * When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Event/stopPropagation)
+     */
+    stopPropagation(): void;
+    readonly NONE: 0;
+    readonly CAPTURING_PHASE: 1;
+    readonly AT_TARGET: 2;
+    readonly BUBBLING_PHASE: 3;
+}
+/**
+ * EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget)
+ */
+interface EventTarget {
+    /**
+     * Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
+     *
+     * The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
+     *
+     * When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
+     *
+     * When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
+     *
+     * When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
+     *
+     * If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
+     *
+     * The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
+     */
+    addEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: AddEventListenerOptions | boolean): void;
+    /**
+     * Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
+     */
+    dispatchEvent(event: Event): boolean;
+    /**
+     * Removes the event listener in target's event listener list with the same type, callback, and options.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
+     */
+    removeEventListener(type: string, callback: EventListenerOrEventListenerObject | null, options?: EventListenerOptions | boolean): void;
+}
+/**
+ * A message received by a target object.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent)
+ */
+interface MessageEvent$1<T = any> extends Event {
+    /**
+     * Returns the data of the message.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/data)
+     */
+    readonly data: T;
+    /**
+     * Returns the last event ID string, for server-sent events.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/lastEventId)
+     */
+    readonly lastEventId: string;
+    /**
+     * Returns the origin of the message, for server-sent events and cross-document messaging.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/origin)
+     */
+    readonly origin: string;
+    /**
+     * Returns the MessagePort array sent with the message, for cross-document messaging and channel messaging.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/ports)
+     */
+    readonly ports: ReadonlyArray<MessagePort>;
+    /**
+     * Returns the WindowProxy of the source window, for cross-document messaging, and the MessagePort being attached, in the connect event fired at SharedWorkerGlobalScope objects.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/source)
+     */
+    readonly source: MessageEventSource | null;
+    /** @deprecated */
+    initMessageEvent(type: string, bubbles?: boolean, cancelable?: boolean, data?: any, origin?: string, lastEventId?: string, source?: MessageEventSource | null, ports?: MessagePort[]): void;
+}
+/**
+ * Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.
+ *
+ * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket)
+ */
+interface WebSocket extends EventTarget {
+    /**
+     * Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:
+     *
+     * Can be set, to change how binary data is returned. The default is "blob".
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/binaryType)
+     */
+    binaryType: BinaryType | (string & {});
+    /**
+     * Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.
+     *
+     * If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/bufferedAmount)
+     */
+    readonly bufferedAmount: number;
+    /**
+     * Returns the extensions selected by the server, if any.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/extensions)
+     */
+    readonly extensions: string;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/close_event) */
+    onclose: ((this: WebSocket, ev: CloseEvent) => any) | null;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/error_event) */
+    onerror: ((this: WebSocket, ev: Event) => any) | null;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/message_event) */
+    onmessage: ((this: WebSocket, ev: MessageEvent$1) => any) | null;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/open_event) */
+    onopen: ((this: WebSocket, ev: Event) => any) | null;
+    /**
+     * Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/protocol)
+     */
+    readonly protocol: string;
+    /**
+     * Returns the state of the WebSocket object's connection. It can have the values described below.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/readyState)
+     */
+    readonly readyState: number;
+    /**
+     * Returns the URL that was used to establish the WebSocket connection.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/url)
+     */
+    readonly url: string;
+    /**
+     * Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/close)
+     */
+    close(code?: number, reason?: string): void;
+    /**
+     * Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.
+     *
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/WebSocket/send)
+     */
+    send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
+    readonly CONNECTING: 0;
+    readonly OPEN: 1;
+    readonly CLOSING: 2;
+    readonly CLOSED: 3;
+    addEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+}
+
+declare const kNodeInspect: unique symbol;
+
+interface AdapterInternal {
+    ws: unknown;
+    request: UpgradeRequest;
+    peers?: Set<Peer>;
+    context?: Peer["context"];
+}
+declare abstract class Peer<Internal extends AdapterInternal = AdapterInternal> {
+    #private;
+    protected _internal: Internal;
+    protected _topics: Set<string>;
+    protected _id?: string;
+    constructor(internal: Internal);
+    get context(): Record<string, unknown>;
+    /**
+     * Unique random [uuid v4](https://developer.mozilla.org/en-US/docs/Glossary/UUID) identifier for the peer.
+     */
+    get id(): string;
+    /** IP address of the peer */
+    get remoteAddress(): string | undefined;
+    /** upgrade request */
+    get request(): UpgradeRequest;
+    /**
+     * Get the [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) instance.
+     *
+     * **Note:** crossws adds polyfill for the following properties if native values are not available:
+     * - `protocol`: Extracted from the `sec-websocket-protocol` header.
+     * - `extensions`: Extracted from the `sec-websocket-extensions` header.
+     * - `url`: Extracted from the request URL (http -> ws).
+     * */
+    get websocket(): Partial<WebSocket>;
+    /** All connected peers to the server */
+    get peers(): Set<Peer>;
+    /** All topics, this peer has been subscribed to. */
+    get topics(): Set<string>;
+    abstract close(code?: number, reason?: string): void;
+    /** Abruptly close the connection */
+    terminate(): void;
+    /** Subscribe to a topic */
+    subscribe(topic: string): void;
+    /** Unsubscribe from a topic */
+    unsubscribe(topic: string): void;
+    /** Send a message to the peer. */
+    abstract send(data: unknown, options?: {
+        compress?: boolean;
+    }): number | void | undefined;
+    /** Send message to subscribes of topic */
+    abstract publish(topic: string, data: unknown, options?: {
+        compress?: boolean;
+    }): void;
+    toString(): string;
+    [Symbol.toPrimitive](): string;
+    [Symbol.toStringTag](): "WebSocket";
+    [kNodeInspect](): Record<string, unknown>;
+}
+
+declare class WSError extends Error {
+    constructor(...args: any[]);
+}
+
+declare class Message implements Partial<MessageEvent> {
+    #private;
+    /** Access to the original [message event](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/message_event) if available. */
+    readonly event?: MessageEvent;
+    /** Access to the Peer that emitted the message. */
+    readonly peer?: Peer;
+    /** Raw message data (can be of any type). */
+    readonly rawData: unknown;
+    constructor(rawData: unknown, peer: Peer, event?: MessageEvent);
+    /**
+     * Unique random [uuid v4](https://developer.mozilla.org/en-US/docs/Glossary/UUID) identifier for the message.
+     */
+    get id(): string;
+    /**
+     * Get data as [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) value.
+     *
+     * If raw data is in any other format or string, it will be automatically converted and encoded.
+     */
+    uint8Array(): Uint8Array;
+    /**
+     * Get data as [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) or [SharedArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) value.
+     *
+     * If raw data is in any other format or string, it will be automatically converted and encoded.
+     */
+    arrayBuffer(): ArrayBuffer | SharedArrayBuffer;
+    /**
+     * Get data as [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob) value.
+     *
+     * If raw data is in any other format or string, it will be automatically converted and encoded. */
+    blob(): Blob;
+    /**
+     * Get stringified text version of the message.
+     *
+     * If raw data is in any other format, it will be automatically converted and decoded.
+     */
+    text(): string;
+    /**
+     * Get parsed version of the message text with [`JSON.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse).
+     */
+    json<T = unknown>(): T;
+    /**
+     * Message data (value varies based on `peer.websocket.binaryType`).
+     */
+    get data(): unknown;
+    toString(): string;
+    [Symbol.toPrimitive](): string;
+    [kNodeInspect](): {
+        data: unknown;
+    };
+}
+type MaybePromise$1<T> = T | Promise<T>;
+type UpgradeRequest = Request | {
+    url: string;
+    headers: Headers;
+};
+interface Hooks {
+    /** Upgrading */
+    /**
+     *
+     * @param request
+     * @throws {Response}
+     */
+    upgrade: (request: UpgradeRequest & {
+        context: Peer["context"];
+    }) => MaybePromise$1<Response | ResponseInit | void>;
+    /** A message is received */
+    message: (peer: Peer, message: Message) => MaybePromise$1<void>;
+    /** A socket is opened */
+    open: (peer: Peer) => MaybePromise$1<void>;
+    /** A socket is closed */
+    close: (peer: Peer, details: {
+        code?: number;
+        reason?: string;
+    }) => MaybePromise$1<void>;
+    /** An error occurs */
+    error: (peer: Peer, error: WSError) => MaybePromise$1<void>;
+}
+
+interface NodeEventContext {
+    req: IncomingMessage & {
+        originalUrl?: string;
+    };
+    res: ServerResponse;
+}
+interface WebEventContext {
+    request?: Request;
+    url?: URL;
+}
+declare class H3Event<_RequestT extends EventHandlerRequest = EventHandlerRequest> implements Pick<FetchEvent, "respondWith"> {
+    "__is_event__": boolean;
+    node: NodeEventContext;
+    web?: WebEventContext;
+    context: H3EventContext;
+    _method?: HTTPMethod;
+    _path?: string;
+    _headers?: Headers;
+    _requestBody?: BodyInit;
+    _handled: boolean;
+    _onBeforeResponseCalled: boolean | undefined;
+    _onAfterResponseCalled: boolean | undefined;
+    constructor(req: IncomingMessage, res: ServerResponse);
+    get method(): HTTPMethod;
+    get path(): string;
+    get headers(): Headers;
+    get handled(): boolean;
+    respondWith(response: Response | PromiseLike<Response>): Promise<void>;
+    toString(): string;
+    toJSON(): string;
+    /** @deprecated Please use `event.node.req` instead. */
+    get req(): IncomingMessage & {
+        originalUrl?: string;
+    };
+    /** @deprecated Please use `event.node.res` instead. */
+    get res(): ServerResponse<IncomingMessage>;
+}
+
+type SessionDataT = Record<string, any>;
+type SessionData<T extends SessionDataT = SessionDataT> = T;
+declare const getSessionPromise: unique symbol;
+interface Session<T extends SessionDataT = SessionDataT> {
+    id: string;
+    createdAt: number;
+    data: SessionData<T>;
+    [getSessionPromise]?: Promise<Session<T>>;
+}
+
+type RouterMethod = Lowercase<HTTPMethod>;
+interface RouteNode {
+    handlers: Partial<Record<RouterMethod | "all", EventHandler>>;
+    path: string;
+}
+
+type RequestHeaders = Partial<Record<HTTPHeaderName, string | undefined>>;
+type _HTTPHeaderName = "WWW-Authenticate" | "Authorization" | "Proxy-Authenticate" | "Proxy-Authorization" | "Age" | "Cache-Control" | "Clear-Site-Data" | "Expires" | "Pragma" | "Accept-CH" | "Critical-CH" | "Sec-CH-UA" | "Sec-CH-UA-Arch" | "Sec-CH-UA-Bitness" | "Sec-CH-UA-Full-Version-List" | "Sec-CH-UA-Mobile" | "Sec-CH-UA-Model" | "Sec-CH-UA-Platform" | "Sec-CH-UA-Platform-Version" | "Sec-CH-UA-Prefers-Color-Scheme" | "Sec-CH-UA-Prefers-Reduced-Motion" | "Downlink" | "ECT" | "RTT" | "Save-Data" | "Last-Modified" | "ETag" | "If-Match" | "If-None-Match" | "If-Modified-Since" | "If-Unmodified-Since" | "Vary" | "Connection" | "Keep-Alive" | "Accept" | "Accept-Encoding" | "Accept-Language" | "Expect" | "Max-Forwards" | "Cookie" | "Set-Cookie" | "Access-Control-Allow-Origin" | "Access-Control-Allow-Credentials" | "Access-Control-Allow-Headers" | "Access-Control-Allow-Methods" | "Access-Control-Expose-Headers" | "Access-Control-Max-Age" | "Access-Control-Request-Headers" | "Access-Control-Request-Method" | "Origin" | "Timing-Allow-Origin" | "Content-Disposition" | "Content-Length" | "Content-Type" | "Content-Encoding" | "Content-Language" | "Content-Location" | "Forwarded" | "X-Forwarded-For" | "X-Forwarded-Host" | "X-Forwarded-Proto" | "Via" | "Location" | "Refresh" | "From" | "Host" | "Referer" | "Referrer-Policy" | "User-Agent" | "Allow" | "Server" | "Accept-Ranges" | "Range" | "If-Range" | "Content-Range" | "Cross-Origin-Embedder-Policy" | "Cross-Origin-Opener-Policy" | "Cross-Origin-Resource-Policy" | "Content-Security-Policy" | "Content-Security-Policy-Report-Only" | "Expect-CT" | "Origin-Isolation" | "Permissions-Policy" | "Strict-Transport-Security" | "Upgrade-Insecure-Requests" | "X-Content-Type-Options" | "X-Frame-Options" | "X-Permitted-Cross-Domain-Policies" | "X-Powered-By" | "X-XSS-Protection" | "Sec-Fetch-Site" | "Sec-Fetch-Mode" | "Sec-Fetch-User" | "Sec-Fetch-Dest" | "Sec-Purpose" | "Service-Worker-Navigation-Preload" | "Last-Event-ID" | "NEL" | "Ping-From" | "Ping-To" | "Report-To" | "Transfer-Encoding" | "TE" | "Trailer" | "Sec-WebSocket-Key" | "Sec-WebSocket-Extensions" | "Sec-WebSocket-Accept" | "Sec-WebSocket-Protocol" | "Sec-WebSocket-Version" | "Accept-Push-Policy" | "Accept-Signature" | "Alt-Svc" | "Alt-Used" | "Date" | "Early-Data" | "Link" | "Push-Policy" | "Retry-After" | "Signature" | "Signed-Headers" | "Server-Timing" | "Service-Worker-Allowed" | "SourceMap" | "Upgrade" | "X-DNS-Prefetch-Control" | "X-Pingback" | "X-Requested-With" | "X-Robots-Tag";
+type HTTPHeaderName = _HTTPHeaderName | Lowercase<_HTTPHeaderName> | (string & {});
+
+type HTTPMethod = "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE";
+interface H3EventContext extends Record<string, any> {
+    params?: Record<string, string>;
+    /**
+     * Matched router Node
+     *
+     * @experimental The object structure may change in non-major version.
+     */
+    matchedRoute?: RouteNode;
+    sessions?: Record<string, Session>;
+    clientAddress?: string;
+}
+type EventHandlerResponse<T = any> = T | Promise<T>;
+interface EventHandlerRequest {
+    body?: any;
+    query?: QueryObject;
+    routerParams?: Record<string, string>;
+}
+type MaybePromise<T> = T | Promise<T>;
+type EventHandlerResolver = (path: string) => MaybePromise<undefined | {
+    route?: string;
+    handler: EventHandler;
+}>;
+interface EventHandler<Request extends EventHandlerRequest = EventHandlerRequest, Response extends EventHandlerResponse = EventHandlerResponse> {
+    __is_handler__?: true;
+    __resolve__?: EventHandlerResolver;
+    __websocket__?: Partial<Hooks>;
+    (event: H3Event<Request>): Response;
+}
+
+type Duplex = "half" | "full";
+interface ProxyOptions {
+    headers?: RequestHeaders | HeadersInit;
+    fetchOptions?: RequestInit & {
+        duplex?: Duplex;
+    } & {
+        ignoreResponseError?: boolean;
+    };
+    fetch?: typeof fetch;
+    sendStream?: boolean;
+    streamRequest?: boolean;
+    cookieDomainRewrite?: string | Record<string, string>;
+    cookiePathRewrite?: string | Record<string, string>;
+    onResponse?: (event: H3Event, response: Response) => void;
+}
+
+interface ModuleOptions {
+    url?: string;
+    accessToken?: string;
+    composables?: false | {
+        enabled?: boolean;
+        mode?: 'graphql' | 'rest';
+        client?: boolean;
+        server?: boolean;
+    };
+    i18n?: false | {
+        enabled?: boolean;
+        sync?: boolean;
+        prefix?: string;
+    };
+    types?: false | {
+        enabled?: boolean;
+    };
+    proxy?: false | {
+        enabled?: boolean;
+        path?: string;
+        options?: ProxyOptions;
+    };
+    image?: false | {
+        enabled?: boolean;
+        alias?: string;
+    };
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "directus",
+  "configKey": "directus",
+  "version": "0.0.1",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,290 @@
+import { defineNuxtModule, useLogger, updateRuntimeConfig, hasNuxtModule, createResolver, addImports, addServerImports, addTemplate, addTypeTemplate } from 'nuxt/kit';
+import { generateDirectusTypes } from 'directus-sdk-typegen';
+import { readTranslations, updateTranslationsBatch, createTranslations, deleteTranslations, createDirectus, rest, staticToken } from '@directus/sdk';
+import { readFileSync } from 'node:fs';
+
+const NAME = "directus";
+
+const JOIN_LEADING_SLASH_RE = /^\.?\//;
+function hasTrailingSlash(input = "", respectQueryAndFragment) {
+  {
+    return input.endsWith("/");
+  }
+}
+function withoutTrailingSlash(input = "", respectQueryAndFragment) {
+  {
+    return (hasTrailingSlash(input) ? input.slice(0, -1) : input) || "/";
+  }
+}
+function withTrailingSlash(input = "", respectQueryAndFragment) {
+  {
+    return input.endsWith("/") ? input : input + "/";
+  }
+}
+function isNonEmptyURL(url) {
+  return url && url !== "/";
+}
+function joinURL(base, ...input) {
+  let url = base || "";
+  for (const segment of input.filter((url2) => isNonEmptyURL(url2))) {
+    if (url) {
+      const _segment = segment.replace(JOIN_LEADING_SLASH_RE, "");
+      url = withTrailingSlash(url) + _segment;
+    } else {
+      url = segment;
+    }
+  }
+  return url;
+}
+
+function isPlainObject(value) {
+  if (value === null || typeof value !== "object") {
+    return false;
+  }
+  const prototype = Object.getPrototypeOf(value);
+  if (prototype !== null && prototype !== Object.prototype && Object.getPrototypeOf(prototype) !== null) {
+    return false;
+  }
+  if (Symbol.iterator in value) {
+    return false;
+  }
+  if (Symbol.toStringTag in value) {
+    return Object.prototype.toString.call(value) === "[object Module]";
+  }
+  return true;
+}
+
+function _defu(baseObject, defaults, namespace = ".", merger) {
+  if (!isPlainObject(defaults)) {
+    return _defu(baseObject, {}, namespace, merger);
+  }
+  const object = Object.assign({}, defaults);
+  for (const key in baseObject) {
+    if (key === "__proto__" || key === "constructor") {
+      continue;
+    }
+    const value = baseObject[key];
+    if (value === null || value === void 0) {
+      continue;
+    }
+    if (merger && merger(object, key, value, namespace)) {
+      continue;
+    }
+    if (Array.isArray(value) && Array.isArray(object[key])) {
+      object[key] = [...value, ...object[key]];
+    } else if (isPlainObject(value) && isPlainObject(object[key])) {
+      object[key] = _defu(
+        value,
+        object[key],
+        (namespace ? `${namespace}.` : "") + key.toString(),
+        merger
+      );
+    } else {
+      object[key] = value;
+    }
+  }
+  return object;
+}
+function createDefu(merger) {
+  return (...arguments_) => (
+    // eslint-disable-next-line unicorn/no-array-reduce
+    arguments_.reduce((p, c) => _defu(p, c, "", merger), {})
+  );
+}
+const defu = createDefu();
+
+function useDirectus(config) {
+  return createDirectus(config.url).with(rest()).with(staticToken(config.accessToken || ""));
+}
+async function fetchTranslations(locale, config) {
+  const { i18nPrefix } = config;
+  const directus = useDirectus(config);
+  return await directus.request(readTranslations({
+    fields: ["key", "value", "id"],
+    limit: -1,
+    filter: { language: { _eq: locale }, ...i18nPrefix ? { key: { _startsWith: i18nPrefix } } : {} }
+  }));
+}
+async function syncTranslations(locale, translations, config) {
+  const directus = useDirectus(config);
+  const current = await fetchTranslations(locale, config);
+  const payload = {
+    create: [],
+    update: [],
+    remove: []
+  };
+  for (const [key, value] of Object.entries(translations)) {
+    const translation = current.find((t) => t.key === key);
+    if (!translation) {
+      payload.create.push({ key, value, language: locale });
+    } else if (translation.value !== value) {
+      payload.update.push({ id: translation.id, value });
+    }
+  }
+  for (const translation of current) {
+    if (!translations[translation.key]) {
+      payload.remove.push(translation.id);
+    }
+  }
+  if (!payload.create.length && !payload.update.length && !payload.remove.length) {
+    return false;
+  }
+  return Promise.all([
+    payload.update.length > 0 ? directus.request(updateTranslationsBatch(payload.update)) : null,
+    payload.create.length > 0 ? directus.request(createTranslations(payload.create)) : null,
+    payload.remove.length > 0 ? directus.request(deleteTranslations(payload.remove)) : null
+  ]);
+}
+
+const module = defineNuxtModule({
+  meta: { name: NAME },
+  setup(options, nuxt) {
+    const logger = useLogger(NAME);
+    const config = normalizeConfig(options);
+    if (!config.accessToken || !config.url) {
+      logger.error(`Please provide both 'url' and 'accessToken' options.`);
+    }
+    nuxt.options.typescript.hoist ??= [];
+    nuxt.options.typescript.hoist.push("@directus/sdk");
+    updateRuntimeConfig({
+      [NAME]: {
+        url: config.url,
+        accessToken: config.accessToken,
+        i18nPrefix: config.i18n.prefix
+      },
+      public: {
+        [NAME]: {
+          url: config.proxy.enabled ? config.proxy.path : config.composables.client ? config.url : void 0,
+          i18nPrefix: config.i18n.prefix
+        }
+      }
+    });
+    if (config.types.enabled) {
+      setupTypes(config, nuxt, logger);
+    }
+    if (config.composables.enabled) {
+      setupComposables(config, nuxt, logger);
+    }
+    if (config.i18n.enabled) {
+      if (!hasNuxtModule("@nuxtjs/i18n")) return logger.error("@nuxtjs/i18n is not installed! Please install it to use the i18n features of this module.");
+      setupI18n(config, nuxt, logger);
+    }
+    if (config.proxy.enabled) {
+      setupProxy(config, nuxt, logger);
+    }
+    if (config.image.enabled) {
+      if (!hasNuxtModule("@nuxt/image")) return logger.error("@nuxt/image is not installed! Please install it to use the image features of this module.");
+      setupImage(config, nuxt, logger);
+    }
+  }
+});
+function normalizeConfig(options) {
+  return defu({
+    url: options.url,
+    accessToken: options.accessToken,
+    i18n: options.i18n === false ? { enabled: false } : options.i18n,
+    types: options.types === false ? { enabled: false } : options.types,
+    proxy: options.proxy === false ? { enabled: false } : options.proxy,
+    image: options.image === false ? { enabled: false } : options.image,
+    composables: options.composables === false ? { enabled: false } : options.composables
+  }, {
+    url: process.env.DIRECTUS_URL ?? "http://localhost:8055",
+    accessToken: process.env.DIRECTUS_ACCESS_TOKEN ?? "",
+    i18n: { enabled: hasNuxtModule("@nuxtjs/i18n"), sync: true, prefix: void 0 },
+    types: { enabled: true },
+    proxy: { enabled: true, path: "/api", options: {} },
+    image: { enabled: hasNuxtModule("@nuxt/image"), alias: "directus" },
+    composables: { enabled: true, mode: "rest", client: true, server: true }
+  });
+}
+function setupComposables(config, nuxt, logger) {
+  const { resolve } = createResolver(import.meta.url);
+  const path = resolve(`./runtime/composables/${config.composables.mode}`);
+  nuxt.options.alias = defu(nuxt.options.alias, {
+    "#directus": path
+  });
+  if (config.composables.client) {
+    addImports({
+      from: path,
+      name: "useDirectus"
+    });
+  }
+  if (config.composables.server) {
+    addServerImports({
+      from: path,
+      name: "useDirectus"
+    });
+  }
+  logger.info(`Composables have been registered (mode: ${config.composables.mode}).`);
+}
+function setupI18n(config, nuxt, logger) {
+  const { resolve } = createResolver(import.meta.url);
+  const codes = (nuxt.options.i18n?.locales || []).map((locale) => typeof locale === "string" ? locale : locale.code);
+  if (!codes.length) return;
+  if (config.i18n.sync) {
+    const runtimeConfig = {
+      url: config.url,
+      accessToken: config.accessToken,
+      i18nPrefix: config.i18n.prefix
+    };
+    codes.map((code) => {
+      const { dst } = addTemplate({
+        write: true,
+        filename: `../.locales/${code}.json`,
+        getContents: () => fetchTranslations(code, runtimeConfig).then((translations) => {
+          return JSON.stringify(Object.fromEntries(translations.map((translation) => [translation.key, translation.value])), null, 2);
+        })
+      });
+      nuxt.hook("builder:watch", async (event, filePath) => {
+        if (filePath === dst) {
+          const translations = JSON.parse(readFileSync(filePath, "utf-8"));
+          const done = await syncTranslations(code, translations, runtimeConfig);
+          if (!done) return;
+          logger.info(`Synced translations for locale: ${code}`);
+        }
+      });
+    });
+  }
+  nuxt.hook("i18n:registerModule", (register) => {
+    const locales = codes.map((code) => ({
+      code,
+      file: "index.ts"
+    }));
+    register({ langDir: resolve("./runtime/lang"), locales });
+    logger.success("Locales have been registered: " + codes.join(", "));
+  });
+}
+async function setupTypes(config, nuxt, logger) {
+  addTypeTemplate({
+    filename: "directus/types.d.ts",
+    getContents: () => generateDirectusTypes({
+      directusUrl: withoutTrailingSlash(config.url),
+      outputPath: "",
+      directusToken: config.accessToken
+    })
+  });
+  nuxt.options.alias = defu(nuxt.options.alias, {
+    "#directus/types": "./directus/types.d.ts"
+  });
+  logger.info("Directus types have been generated.");
+}
+function setupProxy(config, nuxt, logger) {
+  nuxt.options.routeRules ??= {};
+  nuxt.options.routeRules[joinURL(config.proxy.path, "**")] = {
+    proxy: defu(config.proxy.options, {
+      to: joinURL(config.url, "**")
+    })
+  };
+  logger.info(`Proxy is enabled on path: ${config.proxy.path}`);
+}
+function setupImage(config, nuxt, logger) {
+  nuxt.options.image = defu(nuxt.options.image, {
+    domains: [new URL(config.url).hostname],
+    alias: {
+      [config.image.alias]: joinURL(config.url, "assets")
+    }
+  });
+  logger.info(`Image alias has been registered: ${config.image.alias} -> ${config.url}`);
+}
+
+export { module as default };

package/dist/runtime/composables/graphql.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Use directus (rest)
+ */
+export declare function useDirectus(): import("@directus/sdk").DirectusClient<import("../../../.nuxt/directus/types.js").Schema> & import("@directus/sdk").GraphqlClient<import("../../../.nuxt/directus/types.js").Schema>;

package/dist/runtime/composables/graphql.js

@@ -0,0 +1,5 @@
+import { graphql } from "@directus/sdk";
+import { createBaseDirectus } from "../helpers.js";
+export function useDirectus() {
+  return createBaseDirectus().with(graphql());
+}

package/dist/runtime/composables/rest.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Use directus (rest)
+ */
+export declare function useDirectus(): import("@directus/sdk").DirectusClient<import("../../../.nuxt/directus/types.js").Schema> & import("@directus/sdk").RestClient<import("../../../.nuxt/directus/types.js").Schema>;

package/dist/runtime/composables/rest.js

@@ -0,0 +1,5 @@
+import { rest } from "@directus/sdk";
+import { createBaseDirectus } from "../helpers.js";
+export function useDirectus() {
+  return createBaseDirectus().with(rest());
+}

package/dist/runtime/helpers.d.ts

@@ -0,0 +1,11 @@
+import type { Schema } from '#directus/types';
+/**
+ * Create base directus instance.
+ */
+export declare function createBaseDirectus(): import("@directus/sdk").DirectusClient<Schema>;
+/**
+ * Get i18n translations.
+ */
+export declare function getI18nTranslations(locale: string, config?: any): Promise<{
+    [k: string]: string;
+}>;

package/dist/runtime/helpers.js

@@ -0,0 +1,40 @@
+import { NAME } from "./../constants";
+import { createDirectus } from "@directus/sdk";
+import { parseHost, joinURL } from "ufo";
+import { createError, useRuntimeConfig } from "#imports";
+import { fetchTranslations } from "./../helpers";
+function getRuntimeConfig() {
+  if (import.meta.server) return useRuntimeConfig()[NAME];
+  const base = useRuntimeConfig().public[NAME];
+  return {
+    ...base,
+    url: getRuntimeClientDirectusURL(base.url)
+  };
+}
+function getRuntimeClientDirectusURL(path) {
+  if (!path) throw new Error(`[${NAME}] No Directus URL provided for client.`);
+  const hasHost = !!parseHost(path).hostname;
+  return hasHost ? path : joinURL(window.location.origin, path);
+}
+export function createBaseDirectus() {
+  const { url } = getRuntimeConfig();
+  return createDirectus(url, {
+    globals: {
+      fetch: $fetch.create({
+        baseURL: url,
+        onResponseError({ response }) {
+          const [error] = response._data.errors || [];
+          if (!error) return;
+          throw createError({
+            status: response.status,
+            message: error.message
+          });
+        }
+      })
+    }
+  });
+}
+export async function getI18nTranslations(locale, config = getRuntimeConfig()) {
+  const data = await fetchTranslations(locale, config);
+  return Object.fromEntries(data.map((item) => [item.key, item.value]));
+}

package/dist/runtime/lang/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Define the i18n locale loader.
+ */
+declare const _default: any;
+export default _default;

package/dist/runtime/lang/index.js

@@ -0,0 +1,5 @@
+import { defineI18nLocale } from "#i18n";
+import { getI18nTranslations } from "../helpers.js";
+export default defineI18nLocale((locale) => {
+  return getI18nTranslations(locale);
+});

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@yassidev/nuxt-directus",
+  "version": "0.0.1",
+  "description": "A Nuxt module for better integration with Directus CMS.",
+  "repository": "yassilah/nuxt-directus",
+  "license": "MIT",
+  "type": "module",
+  "private": false,
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "npm run dev:prepare && nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish --access public && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@directus/sdk": "^20.1.0",
+    "@nuxt/kit": "^4.1.3",
+    "directus-sdk-typegen": "^0.2.1"
+  },
+  "build": {
+    "failOnWarn": false
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^2.6.5",
+    "@nuxt/eslint": "1.9.0",
+    "@nuxt/eslint-config": "^1.9.0",
+    "@nuxt/image": "^1.11.0",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.1.3",
+    "@nuxt/test-utils": "^3.19.2",
+    "@nuxtjs/i18n": "^10.1.0",
+    "@types/node": "latest",
+    "changelogen": "^0.6.2",
+    "eslint": "^9.37.0",
+    "nuxt": "^4.1.3",
+    "typescript": "~5.9.3",
+    "vitest": "^3.2.4",
+    "vue-tsc": "^3.1.0"
+  }
+}