@scalar/api-client-react 1.4.9 → 1.4.11

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @scalar/api-client-react
 
+## 1.4.11
+
+### Patch Changes
+
+- [#8466](https://github.com/scalar/scalar/pull/8466): chore: new build pipeline
+
+## 1.4.10
+
+### Patch Changes
+
+#### Updated Dependencies
+
+- **@scalar/api-client@2.38.1**
+  - [#8468](https://github.com/scalar/scalar/pull/8468): fix: example extraction, environment navigation and general UI fixes
+  - [#8451](https://github.com/scalar/scalar/pull/8451): fix(api-client): default-close auth when not required
+
 ## 1.4.9
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export type { OpenClientPayload } from './ApiClientModalProvider.js';
-export { ApiClientModalProvider, useApiClientModal } from './ApiClientModalProvider.js';
+export type { OpenClientPayload } from './ApiClientModalProvider';
+export { ApiClientModalProvider, useApiClientModal } from './ApiClientModalProvider';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,5 +1,115 @@
-import { ApiClientModalProvider as o, useApiClientModal as l } from "./ApiClientModalProvider.js";
-export {
-  o as ApiClientModalProvider,
-  l as useApiClientModal
+"use client";
+import { createContext, useContext, useEffect, useRef, useSyncExternalStore } from "react";
+import { jsx, jsxs } from "react/jsx-runtime";
+//#region src/client-store.ts
+globalThis.__VUE_OPTIONS_API__ = true;
+globalThis.__VUE_PROD_HYDRATION_MISMATCH_DETAILS__ = true;
+globalThis.__VUE_PROD_DEVTOOLS__ = false;
+/** Client state */
+var state = {
+	createClient: null,
+	clientDict: {}
 };
+/** Set of listener functions to be called when state changes */
+var listeners = /* @__PURE__ */ new Set();
+/** Subscribe to state changes */
+var subscribe = (listener) => {
+	listeners.add(listener);
+	return () => listeners.delete(listener);
+};
+/** Get the current state at this moment in time */
+var getSnapshot = () => state;
+/** Trigger all listeners */
+var emit = () => listeners.forEach((listener) => listener());
+/** Set the create client state */
+var setCreateClient = (clientFactory) => {
+	state = {
+		...state,
+		createClient: clientFactory
+	};
+	emit();
+};
+/** Add a client to the client dict */
+var addClient = (url, client) => {
+	state = {
+		...state,
+		clientDict: {
+			...state.clientDict,
+			[url]: client
+		}
+	};
+	emit();
+};
+/** Remove a client from the client dict */
+var removeClient = (url) => {
+	const { [url]: _, ...clientDict } = state.clientDict;
+	state = {
+		...state,
+		clientDict
+	};
+	emit();
+};
+var clientStore = {
+	getSnapshot,
+	subscribe,
+	setCreateClient,
+	addClient,
+	removeClient
+};
+//#endregion
+//#region src/ApiClientModalProvider.tsx
+var ApiClientModalContext = createContext(null);
+/** Ensures we only load createClient once */
+var isLoading = false;
+/** Hack: this is strictly to prevent creation of extra clients as the store lags a bit */
+var clientDict = {};
+/**
+* Api Client Modal React
+*
+* Provider which mounts the Scalar Api Client Modal vue app.
+* Rebuilt to support multiple instances when using a unique spec.url
+*/
+var ApiClientModalProvider = ({ children, initialRequest, configuration = {} }) => {
+	const key = configuration.spec?.url || "default";
+	const el = useRef(null);
+	const state = useSyncExternalStore(clientStore.subscribe, clientStore.getSnapshot, clientStore.getSnapshot);
+	useEffect(() => {
+		const loadApiClientJs = async () => {
+			isLoading = true;
+			const { createApiClientModal } = await import("@scalar/api-client/layouts/Modal");
+			clientStore.setCreateClient(createApiClientModal);
+		};
+		if (!isLoading) loadApiClientJs();
+	}, []);
+	useEffect(() => {
+		if (!el.current || !state.createClient || clientDict[key]) return () => null;
+		const { client: _client } = state.createClient({
+			el: el.current,
+			configuration
+		});
+		const updateConfig = async () => {
+			await _client.updateConfig(configuration);
+			if (initialRequest) _client.route(initialRequest);
+		};
+		clientStore.addClient(key, _client);
+		clientDict[key] = _client;
+		updateConfig();
+		return () => {
+			_client.app.unmount();
+			clientStore.removeClient(key);
+			delete clientDict[key];
+		};
+	}, [el.current, state.createClient]);
+	return /* @__PURE__ */ jsxs(ApiClientModalContext.Provider, {
+		value: state.clientDict[key] ?? null,
+		children: [/* @__PURE__ */ jsx("div", {
+			className: "scalar-app",
+			ref: el
+		}), children]
+	});
+};
+var useApiClientModal = () => useContext(ApiClientModalContext);
+//#endregion
+export { ApiClientModalProvider, useApiClientModal };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/client-store.ts","../src/ApiClientModalProvider.tsx"],"sourcesContent":["import type { ApiClient, createApiClientModal } from '@scalar/api-client/layouts/Modal'\n\n// These are required for the vue bundler version\nglobalThis.__VUE_OPTIONS_API__ = true\nglobalThis.__VUE_PROD_HYDRATION_MISMATCH_DETAILS__ = true\nglobalThis.__VUE_PROD_DEVTOOLS__ = false\n\n/** Client state */\nlet state = {\n  createClient: null as typeof createApiClientModal | null,\n  clientDict: {} as Record<string, ApiClient>,\n}\n\n/** Set of listener functions to be called when state changes */\nconst listeners = new Set<() => void>()\n\n/** Subscribe to state changes */\nconst subscribe = (listener: () => void) => {\n  listeners.add(listener)\n  return () => listeners.delete(listener)\n}\n\n/** Get the current state at this moment in time */\nconst getSnapshot = () => state\n\n/** Trigger all listeners */\nconst emit = () => listeners.forEach((listener) => listener())\n\n/** Set the create client state */\nconst setCreateClient = (clientFactory: typeof createApiClientModal) => {\n  state = { ...state, createClient: clientFactory }\n  emit()\n}\n\n/** Add a client to the client dict */\nconst addClient = (url: string, client: ApiClient) => {\n  state = { ...state, clientDict: { ...state.clientDict, [url]: client } }\n  emit()\n}\n\n/** Remove a client from the client dict */\nconst removeClient = (url: string) => {\n  const { [url]: _, ...clientDict } = state.clientDict\n  state = { ...state, clientDict }\n  emit()\n}\n\nexport const clientStore = {\n  getSnapshot,\n  subscribe,\n  setCreateClient,\n  addClient,\n  removeClient,\n}\n","'use client'\n\nimport type { ApiClient } from '@scalar/api-client/layouts/Modal'\nimport type { OpenClientPayload } from '@scalar/api-client/libs'\nimport type { ApiClientConfiguration } from '@scalar/types/api-reference'\nimport type { PropsWithChildren } from 'react'\nimport { createContext, useContext, useEffect, useRef, useSyncExternalStore } from 'react'\n\nexport type { OpenClientPayload }\n\nimport { clientStore } from './client-store'\n\nimport './style.css'\n\nconst ApiClientModalContext = createContext<ApiClient | null>(null)\n\ntype Props = PropsWithChildren<{\n  /** Choose a request to initially route to */\n  initialRequest?: OpenClientPayload\n  /** Configuration for the Api Client */\n  configuration?: Partial<ApiClientConfiguration>\n}>\n\n/** Ensures we only load createClient once */\nlet isLoading = false\n\n/** Hack: this is strictly to prevent creation of extra clients as the store lags a bit */\nconst clientDict: Record<string, ApiClient> = {}\n\n/**\n * Api Client Modal React\n *\n * Provider which mounts the Scalar Api Client Modal vue app.\n * Rebuilt to support multiple instances when using a unique spec.url\n */\nexport const ApiClientModalProvider = ({ children, initialRequest, configuration = {} }: Props) => {\n  const key = configuration.spec?.url || 'default'\n  const el = useRef<HTMLDivElement | null>(null)\n\n  const state = useSyncExternalStore(clientStore.subscribe, clientStore.getSnapshot, clientStore.getSnapshot)\n\n  // Lazyload the js to create the client, but we only wanna call this once\n  useEffect(() => {\n    const loadApiClientJs = async () => {\n      isLoading = true\n      const { createApiClientModal } = await import('@scalar/api-client/layouts/Modal')\n      clientStore.setCreateClient(createApiClientModal)\n    }\n    if (!isLoading) {\n      void loadApiClientJs()\n    }\n  }, [])\n\n  useEffect(() => {\n    if (!el.current || !state.createClient || clientDict[key]) {\n      return () => null\n    }\n\n    // Check for cached client first\n    const { client: _client } = state.createClient({\n      el: el.current,\n      configuration,\n    })\n\n    const updateConfig = async () => {\n      await _client.updateConfig(configuration!)\n      if (initialRequest) {\n        _client.route(initialRequest)\n      }\n    }\n\n    // Add the client to the store and dict\n    clientStore.addClient(key, _client)\n    clientDict[key] = _client\n\n    // We update the config as we are using the sync version\n    void updateConfig()\n\n    // Ensure we unmount the vue app on unmount\n    return () => {\n      _client.app.unmount()\n      clientStore.removeClient(key)\n      delete clientDict[key]\n    }\n  }, [el.current, state.createClient])\n\n  return (\n    <ApiClientModalContext.Provider value={state.clientDict[key] ?? null}>\n      <div\n        className=\"scalar-app\"\n        ref={el}\n      />\n      {children}\n    </ApiClientModalContext.Provider>\n  )\n}\n\nexport const useApiClientModal = (): ApiClient | null => useContext(ApiClientModalContext)\n"],"mappings":";;;;AAGA,WAAW,sBAAsB;AACjC,WAAW,0CAA0C;AACrD,WAAW,wBAAwB;;AAGnC,IAAI,QAAQ;CACV,cAAc;CACd,YAAY,EAAA;CACb;;AAGD,IAAM,4BAAY,IAAI,KAAiB;;AAGvC,IAAM,aAAa,aAAyB;AAC1C,WAAU,IAAI,SAAS;AACvB,cAAa,UAAU,OAAO,SAAS;;;AAIzC,IAAM,oBAAoB;;AAG1B,IAAM,aAAa,UAAU,SAAS,aAAa,UAAU,CAAC;;AAG9D,IAAM,mBAAmB,kBAA+C;AACtE,SAAQ;EAAE,GAAG;EAAO,cAAc;EAAe;AACjD,OAAM;;;AAIR,IAAM,aAAa,KAAa,WAAsB;AACpD,SAAQ;EAAE,GAAG;EAAO,YAAY;GAAE,GAAG,MAAM;IAAa,MAAM;;EAAU;AACxE,OAAM;;;AAIR,IAAM,gBAAgB,QAAgB;CACpC,MAAM,GAAG,MAAM,GAAG,GAAG,eAAe,MAAM;AAC1C,SAAQ;EAAE,GAAG;EAAO;EAAY;AAChC,OAAM;;AAGR,IAAa,cAAc;CACzB;CACA;CACA;CACA;CACA;CACD;;;ACvCD,IAAM,wBAAwB,cAAgC,KAAK;;AAUnE,IAAI,YAAY;;AAGhB,IAAM,aAAwC,EAAE;;;;;;;AAQhD,IAAa,0BAA0B,EAAE,UAAU,gBAAgB,gBAAgB,EAAE,OAAc;CACjG,MAAM,MAAM,cAAc,MAAM,OAAO;CACvC,MAAM,KAAK,OAA8B,KAAK;CAE9C,MAAM,QAAQ,qBAAqB,YAAY,WAAW,YAAY,aAAa,YAAY,YAAY;AAG3G,iBAAgB;EACd,MAAM,kBAAkB,YAAY;AAClC,eAAY;GACZ,MAAM,EAAE,yBAAyB,MAAM,OAAO;AAC9C,eAAY,gBAAgB,qBAAqB;;AAEnD,MAAI,CAAC,UACE,kBAAiB;IAEvB,EAAE,CAAC;AAEN,iBAAgB;AACd,MAAI,CAAC,GAAG,WAAW,CAAC,MAAM,gBAAgB,WAAW,KACnD,cAAa;EAIf,MAAM,EAAE,QAAQ,YAAY,MAAM,aAAa;GAC7C,IAAI,GAAG;GACP;GACD,CAAC;EAEF,MAAM,eAAe,YAAY;AAC/B,SAAM,QAAQ,aAAa,cAAe;AAC1C,OAAI,eACF,SAAQ,MAAM,eAAe;;AAKjC,cAAY,UAAU,KAAK,QAAQ;AACnC,aAAW,OAAO;AAGb,gBAAc;AAGnB,eAAa;AACX,WAAQ,IAAI,SAAS;AACrB,eAAY,aAAa,IAAI;AAC7B,UAAO,WAAW;;IAEnB,CAAC,GAAG,SAAS,MAAM,aAAa,CAAC;AAEpC,QACE,qBAAC,sBAAsB,UAAvB;EAAgC,OAAO,MAAM,WAAW,QAAQ;YAAhE,CACE,oBAAC,OAAD;GACE,WAAU;GACV,KAAK;GACL,CAAA,EACD,SAAA;;;AAKP,IAAa,0BAA4C,WAAW,sBAAsB"}