@vendure/dashboard 3.2.0

package/src/lib/framework/registry/global-registry.ts

@@ -0,0 +1,46 @@
+import { GlobalRegistryContents } from './registry-types.js';
+
+/**
+ * There are certain global objects that are used in the configuration and extension
+ * of the dashboard. Due to the way that Vite bundles and executes the code,
+ * we cannot rely on closures over variables in the root scope, as the same variable
+ * in different bundles will be different instances.
+ *
+ * This class is used to register and retrieve these global objects.
+ */
+class GlobalRegistry {
+    private static instance: GlobalRegistry;
+    private registry: Map<string, any> = new Map();
+
+    constructor() {
+        if (!GlobalRegistry.instance) {
+            GlobalRegistry.instance = this;
+        }
+        return GlobalRegistry.instance;
+    }
+
+    public register<T extends GlobalRegistryKey>(key: T, value: GlobalRegistryContents[T]) {
+        if (!this.registry.has(key)) {
+            this.registry.set(key, value);
+        }
+    }
+
+    public get<T extends GlobalRegistryKey>(key: T): GlobalRegistryContents[T] {
+        return this.registry.get(key);
+    }
+
+    public set<T extends GlobalRegistryKey>(
+        key: T,
+        updater: (oldValue: GlobalRegistryContents[T]) => GlobalRegistryContents[T],
+    ) {
+        const oldValue = this.get(key);
+        this.registry.set(key, updater(oldValue));
+    }
+}
+
+export type GlobalRegistryKey = keyof GlobalRegistryContents;
+
+const _globalRegistry: GlobalRegistry = (globalThis as any).globalRegistry ?? new GlobalRegistry();
+(globalThis as any).globalRegistry = _globalRegistry;
+
+export const globalRegistry = _globalRegistry;

package/src/lib/framework/registry/registry-types.ts

@@ -0,0 +1,15 @@
+import { DashboardWidgetDefinition } from '../dashboard-widget/types.js';
+import { DashboardActionBarItem } from '../extension-api/extension-api-types.js';
+import { DashboardPageBlockDefinition } from '../extension-api/extension-api-types.js';
+import { NavMenuConfig } from '../nav-menu/nav-menu-extensions.js';
+
+export interface GlobalRegistryContents {
+    extensionSourceChangeCallbacks: Set<() => void>;
+    registerDashboardExtensionCallbacks: Set<() => void>;
+    navMenuConfig: NavMenuConfig;
+    dashboardActionBarItemRegistry: Map<string, DashboardActionBarItem[]>;
+    dashboardPageBlockRegistry: Map<string, DashboardPageBlockDefinition[]>;
+    dashboardWidgetRegistry: Map<string, DashboardWidgetDefinition>;
+}
+
+export type GlobalRegistryKey = keyof GlobalRegistryContents;

package/src/lib/graphql/api.ts

@@ -0,0 +1,61 @@
+import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
+import { AwesomeGraphQLClient } from 'awesome-graphql-client';
+import { DocumentNode, parse, print } from 'graphql';
+import { uiConfig } from 'virtual:vendure-ui-config';
+
+const API_URL = uiConfig.apiHost + (uiConfig.apiPort !== 'auto' ? `:${uiConfig.apiPort}` : '') + '/admin-api';
+
+export type Variables = object;
+export type RequestDocument = string | DocumentNode;
+
+const awesomeClient = new AwesomeGraphQLClient({
+    endpoint: API_URL,
+    fetch: async (url: string, options: RequestInit = {}) => {
+        return fetch(url, {
+            ...options,
+            credentials: 'include',
+            mode: 'cors',
+        });
+    },
+});
+
+export type VariablesAndRequestHeadersArgs<V extends Variables> =
+    V extends Record<any, never>
+        ? [variables?: V, requestHeaders?: HeadersInit]
+        : [variables: V, requestHeaders?: HeadersInit];
+
+function query<T, V extends Variables = Variables>(
+    document: RequestDocument | TypedDocumentNode<T, V>,
+    variables?: V,
+): Promise<T> {
+    const documentString = typeof document === 'string' ? document : print(document);
+    return awesomeClient.request(documentString, variables) as any;
+}
+
+function mutate<T, V extends Variables = Variables>(
+    document: TypedDocumentNode<T, V>,
+): (variables: V) => Promise<T>;
+function mutate(document: RequestDocument): (variables: Variables) => Promise<unknown>;
+function mutate<T, V extends Variables = Variables>(
+    document: TypedDocumentNode<T, V>,
+    variables: V,
+): Promise<T>;
+function mutate(document: RequestDocument, variables: Variables): Promise<unknown>;
+function mutate<T, V extends Variables = Variables>(
+    document: RequestDocument | TypedDocumentNode<T, V>,
+    maybeVariables?: V,
+): Promise<T> | ((variables: V) => Promise<T>) {
+    const documentString = typeof document === 'string' ? document : print(document);
+    if (maybeVariables) {
+        return awesomeClient.request(documentString, maybeVariables) as any;
+    } else {
+        return (variables: V): Promise<T> => {
+            return awesomeClient.request(documentString, variables) as any;
+        };
+    }
+}
+
+export const api = {
+    query,
+    mutate,
+};

package/src/lib/graphql/fragments.tsx

@@ -0,0 +1,54 @@
+import { graphql, ResultOf } from "./graphql.js";
+
+export const assetFragment = graphql(`
+    fragment Asset on Asset {
+        id
+        createdAt
+        updatedAt
+        name
+        fileSize
+        mimeType
+        type
+        preview
+        source
+        width
+        height
+        focalPoint {
+            x
+            y
+        }
+    }
+`);
+
+export type AssetFragment = ResultOf<typeof assetFragment>;
+
+export const configurableOperationFragment = graphql(`
+    fragment ConfigurableOperation on ConfigurableOperation {
+        args {
+            name
+            value
+        }
+        code
+    }
+`);
+
+export type ConfigurableOperationFragment = ResultOf<typeof configurableOperationFragment>;
+
+export const configurableOperationDefFragment = graphql(`
+    fragment ConfigurableOperationDef on ConfigurableOperationDefinition {
+        args {
+            name
+            type
+            required
+            defaultValue
+            list
+            ui
+            label
+            description
+        }
+        code
+        description
+    }
+`);
+
+export type ConfigurableOperationDefFragment = ResultOf<typeof configurableOperationDefFragment>;