@scalar/api-client 2.42.0 → 3.0.0

package/dist/store/active-entities.js

@@ -1,139 +0,0 @@
-import { flattenEnvVars } from "../libs/string-template.js";
-import { PathId } from "../routes.js";
-import { getRouterParams } from "./router-params.js";
-import { computed, inject } from "vue";
-import { environmentSchema } from "@scalar/oas-utils/entities/environment";
-import { isDefined } from "@scalar/oas-utils/helpers";
-//#region src/store/active-entities.ts
-/**
-* Create the active entities store
-*
-* We need the factory function to pass the router instance
-*/
-var createActiveEntitiesStore = ({ collections, requestExamples, requests, router, servers, workspaces }) => {
-	/** Gives the required UID usually per route */
-	const activeRouterParams = computed(getRouterParams(router));
-	/** The currently selected workspace OR the first one */
-	const activeWorkspace = computed(() => workspaces[activeRouterParams.value[PathId.Workspace]] ?? Object.values(workspaces)[0]);
-	/** Ordered list of the active workspace's collections with drafts last */
-	const activeWorkspaceCollections = computed(() => activeWorkspace.value?.collections.map((uid) => collections[uid]).filter(isDefined).sort((a, b) => {
-		if (a.info?.title === "Drafts") return 1;
-		if (b.info?.title === "Drafts") return -1;
-		return 0;
-	}) ?? []);
-	/** Simplified list of servers in the workspace for displaying */
-	const activeWorkspaceServers = computed(() => activeWorkspaceCollections.value?.flatMap((collection) => collection.servers.map((uid) => servers[uid])));
-	/** Simplified list of requests in the workspace for displaying */
-	const activeWorkspaceRequests = computed(() => activeWorkspaceCollections.value?.flatMap((collection) => collection.requests) ?? []);
-	/** The currently selected environment */
-	const activeEnvironment = computed(() => {
-		if (!activeWorkspace.value?.activeEnvironmentId) return environmentSchema.parse({
-			uid: "default",
-			color: "#FFFFFF",
-			name: "No Environment",
-			value: JSON.stringify(activeWorkspace.value?.environments, null, 2)
-		});
-		const activeEnvironmentCollection = activeWorkspaceCollections.value.find((c) => c["x-scalar-environments"]?.[activeWorkspace.value?.activeEnvironmentId ?? ""]);
-		if (activeEnvironmentCollection && activeWorkspace.value?.activeEnvironmentId) return environmentSchema.parse({
-			uid: activeWorkspace.value.activeEnvironmentId,
-			name: activeWorkspace.value.activeEnvironmentId,
-			value: JSON.stringify(activeEnvironmentCollection["x-scalar-environments"]?.[activeWorkspace.value?.activeEnvironmentId]?.variables, null, 2),
-			color: activeEnvironmentCollection["x-scalar-environments"]?.[activeWorkspace.value?.activeEnvironmentId]?.color || "#FFFFFF",
-			isDefault: false
-		});
-		return environmentSchema.parse({
-			uid: "default",
-			color: "#FFFFFF",
-			name: "No Environment",
-			value: JSON.stringify(activeWorkspace.value.environments, null, 2)
-		});
-	});
-	/**
-	* Request associated with the current route
-	*
-	* undefined must be handled as we may have no requests
-	*/
-	const activeRequest = computed(() => {
-		const key = activeRouterParams.value[PathId.Request];
-		const collection = collections[activeRouterParams.value.collection] || collections[activeWorkspace.value?.collections[0] ?? ""];
-		return requests[key] || requests[collection?.requests[0] ?? ""] || Object.values(requests)[0];
-	});
-	/** Grabs the currently active example using the path param */
-	const activeExample = computed(() => {
-		return requestExamples[activeRouterParams.value[PathId.Examples] === "default" ? activeRequest.value?.examples[0] || "" : activeRouterParams.value[PathId.Examples]];
-	});
-	/**
-	* First collection that the active request is in
-	*/
-	const activeCollection = computed(() => {
-		const collection = collections[activeRouterParams.value[PathId.Collection]];
-		if (collection) return collection;
-		const requestUid = activeRequest.value?.uid;
-		if (requestUid) return Object.values(collections).find((c) => c.requests?.includes(requestUid));
-		return collections[activeWorkspace.value?.collections[0] ?? collections[0]?.uid ?? ""];
-	});
-	/** The currently selected server in the addressBar */
-	const activeServer = computed(() => {
-		if (activeRequest.value?.selectedServerUid) {
-			const server = servers[activeRequest.value.selectedServerUid];
-			if (server) return server;
-		}
-		if (activeCollection.value?.selectedServerUid) {
-			const server = servers[activeCollection.value.selectedServerUid];
-			if (server) return server;
-		}
-	});
-	return {
-		activeCollection,
-		activeCookieId: computed(() => activeRouterParams.value[PathId.Cookies] === "default" ? activeWorkspace.value?.cookies[0] ?? "default" : activeRouterParams.value[PathId.Cookies]),
-		activeExample,
-		activeRequest,
-		activeRouterParams,
-		activeEnvironment,
-		activeServer,
-		activeWorkspace,
-		activeWorkspaceCollections,
-		activeWorkspaceServers,
-		activeEnvVariables: computed(() => {
-			const globalEnvironment = activeWorkspace.value?.environments ?? {};
-			const collectionEnvironment = activeEnvironment.value.uid ? JSON.parse(activeEnvironment.value.value) : {};
-			const globalEnvVars = flattenEnvVars(globalEnvironment).map(([key, value]) => ({
-				key,
-				value,
-				source: "global"
-			}));
-			const collectionEnvVars = flattenEnvVars(collectionEnvironment).map(([key, value]) => ({
-				key,
-				value,
-				source: "collection"
-			}));
-			const mergedEnvVars = /* @__PURE__ */ new Map();
-			collectionEnvVars.forEach((envVar) => {
-				mergedEnvVars.set(envVar.key, envVar);
-			});
-			globalEnvVars.forEach((envVar) => {
-				if (!mergedEnvVars.has(envVar.key)) mergedEnvVars.set(envVar.key, envVar);
-			});
-			return Array.from(mergedEnvVars.values());
-		}),
-		activeWorkspaceRequests
-	};
-};
-var ACTIVE_ENTITIES_SYMBOL = Symbol();
-/**
-* The active entities store
-*
-* This store returns anything related to the currently active entities
-* The only reason this is a store and not a simple hook is due to storing the current router here
-*
-* @deprecated due to components being used outside of the client now, we should prop drill instead of this hook/store
-*/
-var useActiveEntities = () => {
-	const store = inject(ACTIVE_ENTITIES_SYMBOL);
-	if (!store) throw new Error("Active entities store not provided");
-	return store;
-};
-//#endregion
-export { ACTIVE_ENTITIES_SYMBOL, createActiveEntitiesStore, useActiveEntities };
-
-//# sourceMappingURL=active-entities.js.map

package/dist/store/active-entities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"active-entities.js","names":[],"sources":["../../src/store/active-entities.ts"],"sourcesContent":["import type { Cookie } from '@scalar/oas-utils/entities/cookie'\nimport { type Environment, environmentSchema } from '@scalar/oas-utils/entities/environment'\nimport type { Collection, Request, RequestExample, Server } from '@scalar/oas-utils/entities/spec'\nimport type { Workspace } from '@scalar/oas-utils/entities/workspace'\nimport { isDefined } from '@scalar/oas-utils/helpers'\nimport { type InjectionKey, computed, inject } from 'vue'\nimport type { Router } from 'vue-router'\n\nimport { flattenEnvVars } from '@/libs/string-template'\nimport { PathId } from '@/routes'\n\nimport { getRouterParams } from './router-params'\n\ntype CreateActiveEntitiesStoreParams = {\n  collections: Record<string, Collection>\n  environments: Record<string, Environment>\n  requestExamples: Record<string, RequestExample>\n  requests: Record<string, Request>\n  servers: Record<string, Server>\n  workspaces: Record<string, Workspace>\n  router?: Router\n}\n\nexport type EnvVariable = {\n  key: string\n  value: any\n  source: 'global' | 'collection'\n}\n\n/**\n * Create the active entities store\n *\n * We need the factory function to pass the router instance\n */\nexport const createActiveEntitiesStore = ({\n  collections,\n  requestExamples,\n  requests,\n  router,\n  servers,\n  workspaces,\n}: CreateActiveEntitiesStoreParams) => {\n  /** Gives the required UID usually per route */\n  const activeRouterParams = computed(getRouterParams(router))\n\n  /** The currently selected workspace OR the first one */\n  const activeWorkspace = computed(\n    () => workspaces[activeRouterParams.value[PathId.Workspace]] ?? Object.values(workspaces)[0],\n  )\n\n  /** Ordered list of the active workspace's collections with drafts last */\n  const activeWorkspaceCollections = computed(\n    () =>\n      activeWorkspace.value?.collections\n        .map((uid) => collections[uid])\n        .filter(isDefined)\n        .sort((a, b) => {\n          if (a.info?.title === 'Drafts') {\n            return 1\n          }\n          if (b.info?.title === 'Drafts') {\n            return -1\n          }\n          return 0\n        }) ?? [],\n  )\n\n  /** Simplified list of servers in the workspace for displaying */\n  const activeWorkspaceServers = computed(() =>\n    activeWorkspaceCollections.value?.flatMap((collection) => collection.servers.map((uid) => servers[uid])),\n  )\n\n  /** Simplified list of requests in the workspace for displaying */\n  const activeWorkspaceRequests = computed(\n    () => activeWorkspaceCollections.value?.flatMap((collection) => collection.requests) ?? [],\n  )\n\n  /** The currently selected environment */\n  const activeEnvironment = computed(() => {\n    if (!activeWorkspace.value?.activeEnvironmentId) {\n      return environmentSchema.parse({\n        uid: 'default',\n        color: '#FFFFFF',\n        name: 'No Environment',\n        value: JSON.stringify(activeWorkspace.value?.environments, null, 2),\n      })\n    }\n\n    const activeEnvironmentCollection = activeWorkspaceCollections.value.find(\n      (c) => c['x-scalar-environments']?.[activeWorkspace.value?.activeEnvironmentId ?? ''],\n    )\n\n    if (activeEnvironmentCollection && activeWorkspace.value?.activeEnvironmentId) {\n      return environmentSchema.parse({\n        uid: activeWorkspace.value.activeEnvironmentId,\n        name: activeWorkspace.value.activeEnvironmentId,\n        value: JSON.stringify(\n          activeEnvironmentCollection['x-scalar-environments']?.[activeWorkspace.value?.activeEnvironmentId]?.variables,\n          null,\n          2,\n        ),\n        color:\n          activeEnvironmentCollection['x-scalar-environments']?.[activeWorkspace.value?.activeEnvironmentId]?.color ||\n          '#FFFFFF',\n        isDefault: false,\n      })\n    }\n\n    return environmentSchema.parse({\n      uid: 'default',\n      color: '#FFFFFF',\n      name: 'No Environment',\n      value: JSON.stringify(activeWorkspace.value.environments, null, 2),\n    })\n  })\n\n  /**\n   * Request associated with the current route\n   *\n   * undefined must be handled as we may have no requests\n   */\n  const activeRequest = computed(() => {\n    const key = activeRouterParams.value[PathId.Request]\n\n    // Can use this fallback to get an active request\n    const collection =\n      collections[activeRouterParams.value.collection] || collections[activeWorkspace.value?.collections[0] ?? '']\n\n    return requests[key] || requests[collection?.requests[0] ?? ''] || Object.values(requests)[0]\n  })\n\n  /** Grabs the currently active example using the path param */\n  const activeExample = computed(() => {\n    const key =\n      activeRouterParams.value[PathId.Examples] === 'default'\n        ? activeRequest.value?.examples[0] || ''\n        : activeRouterParams.value[PathId.Examples]\n\n    return requestExamples[key]\n  })\n\n  /**\n   * First collection that the active request is in\n   */\n  const activeCollection = computed(() => {\n    // Grab the collection from route parameters.\n    const collection = collections[activeRouterParams.value[PathId.Collection]]\n\n    if (collection) {\n      return collection\n    }\n\n    // If no collection is found, try to grab the collection from the request.\n    const requestUid = activeRequest.value?.uid\n    if (requestUid) {\n      return Object.values(collections).find((c) => c.requests?.includes(requestUid))\n    }\n\n    // If no collection is found, try to grab the collection from the workspace.\n    const fallbackUid = activeWorkspace.value?.collections[0] ?? collections[0]?.uid ?? ''\n\n    return collections[fallbackUid]\n  })\n\n  /** The currently selected server in the addressBar */\n  const activeServer = computed(() => {\n    // Request has a selected server\n    if (activeRequest.value?.selectedServerUid) {\n      // Return server if selected\n      const server = servers[activeRequest.value.selectedServerUid]\n      if (server) {\n        return server\n      }\n    }\n\n    // Collection has a selected server\n    if (activeCollection.value?.selectedServerUid) {\n      // Return server if selected\n      const server = servers[activeCollection.value.selectedServerUid]\n      if (server) {\n        return server\n      }\n    }\n\n    return undefined\n  })\n\n  /** Cookie associated with the current route */\n  const activeCookieId = computed(() =>\n    activeRouterParams.value[PathId.Cookies] === 'default'\n      ? (activeWorkspace.value?.cookies[0] ?? ('default' as Cookie['uid']))\n      : activeRouterParams.value[PathId.Cookies],\n  )\n\n  /**\n   * Active list all available substitution variables. Server variables\n   * will be populated into the environment on spec loading\n   */\n  const activeEnvVariables = computed<EnvVariable[]>(() => {\n    const globalEnvironment = activeWorkspace.value?.environments ?? {}\n    const collectionEnvironment = activeEnvironment.value.uid ? JSON.parse(activeEnvironment.value.value) : {}\n\n    const globalEnvVars: EnvVariable[] = flattenEnvVars(globalEnvironment).map(([key, value]) => ({\n      key,\n      value,\n      source: 'global',\n    }))\n\n    const collectionEnvVars: EnvVariable[] = flattenEnvVars(collectionEnvironment).map(([key, value]) => ({\n      key,\n      value,\n      source: 'collection',\n    }))\n\n    const mergedEnvVars = new Map<string, EnvVariable>()\n\n    collectionEnvVars.forEach((envVar) => {\n      mergedEnvVars.set(envVar.key, envVar)\n    })\n\n    globalEnvVars.forEach((envVar) => {\n      if (!mergedEnvVars.has(envVar.key)) {\n        mergedEnvVars.set(envVar.key, envVar)\n      }\n    })\n\n    return Array.from(mergedEnvVars.values())\n  })\n\n  return {\n    activeCollection,\n    activeCookieId,\n    activeExample,\n    activeRequest,\n    activeRouterParams,\n    activeEnvironment,\n    activeServer,\n    activeWorkspace,\n    activeWorkspaceCollections,\n    activeWorkspaceServers,\n    activeEnvVariables,\n    activeWorkspaceRequests,\n  }\n}\n\nexport type ActiveEntitiesStore = ReturnType<typeof createActiveEntitiesStore>\nexport const ACTIVE_ENTITIES_SYMBOL = Symbol() as InjectionKey<ActiveEntitiesStore>\n\n/**\n * The active entities store\n *\n * This store returns anything related to the currently active entities\n * The only reason this is a store and not a simple hook is due to storing the current router here\n *\n * @deprecated due to components being used outside of the client now, we should prop drill instead of this hook/store\n */\nexport const useActiveEntities = (): ActiveEntitiesStore => {\n  const store = inject(ACTIVE_ENTITIES_SYMBOL)\n  if (!store) {\n    throw new Error('Active entities store not provided')\n  }\n  return store\n}\n"],"mappings":";;;;;;;;;;;;AAkCA,IAAa,6BAA6B,EACxC,aACA,iBACA,UACA,QACA,SACA,iBACqC;;CAErC,MAAM,qBAAqB,SAAS,gBAAgB,OAAO,CAAC;;CAG5D,MAAM,kBAAkB,eAChB,WAAW,mBAAmB,MAAM,OAAO,eAAe,OAAO,OAAO,WAAW,CAAC,GAC3F;;CAGD,MAAM,6BAA6B,eAE/B,gBAAgB,OAAO,YACpB,KAAK,QAAQ,YAAY,KAAK,CAC9B,OAAO,UAAU,CACjB,MAAM,GAAG,MAAM;AACd,MAAI,EAAE,MAAM,UAAU,SACpB,QAAO;AAET,MAAI,EAAE,MAAM,UAAU,SACpB,QAAO;AAET,SAAO;GACP,IAAI,EAAE,CACb;;CAGD,MAAM,yBAAyB,eAC7B,2BAA2B,OAAO,SAAS,eAAe,WAAW,QAAQ,KAAK,QAAQ,QAAQ,KAAK,CAAC,CACzG;;CAGD,MAAM,0BAA0B,eACxB,2BAA2B,OAAO,SAAS,eAAe,WAAW,SAAS,IAAI,EAAE,CAC3F;;CAGD,MAAM,oBAAoB,eAAe;AACvC,MAAI,CAAC,gBAAgB,OAAO,oBAC1B,QAAO,kBAAkB,MAAM;GAC7B,KAAK;GACL,OAAO;GACP,MAAM;GACN,OAAO,KAAK,UAAU,gBAAgB,OAAO,cAAc,MAAM,EAAE;GACpE,CAAC;EAGJ,MAAM,8BAA8B,2BAA2B,MAAM,MAClE,MAAM,EAAE,2BAA2B,gBAAgB,OAAO,uBAAuB,IACnF;AAED,MAAI,+BAA+B,gBAAgB,OAAO,oBACxD,QAAO,kBAAkB,MAAM;GAC7B,KAAK,gBAAgB,MAAM;GAC3B,MAAM,gBAAgB,MAAM;GAC5B,OAAO,KAAK,UACV,4BAA4B,2BAA2B,gBAAgB,OAAO,sBAAsB,WACpG,MACA,EACD;GACD,OACE,4BAA4B,2BAA2B,gBAAgB,OAAO,sBAAsB,SACpG;GACF,WAAW;GACZ,CAAC;AAGJ,SAAO,kBAAkB,MAAM;GAC7B,KAAK;GACL,OAAO;GACP,MAAM;GACN,OAAO,KAAK,UAAU,gBAAgB,MAAM,cAAc,MAAM,EAAE;GACnE,CAAC;GACF;;;;;;CAOF,MAAM,gBAAgB,eAAe;EACnC,MAAM,MAAM,mBAAmB,MAAM,OAAO;EAG5C,MAAM,aACJ,YAAY,mBAAmB,MAAM,eAAe,YAAY,gBAAgB,OAAO,YAAY,MAAM;AAE3G,SAAO,SAAS,QAAQ,SAAS,YAAY,SAAS,MAAM,OAAO,OAAO,OAAO,SAAS,CAAC;GAC3F;;CAGF,MAAM,gBAAgB,eAAe;AAMnC,SAAO,gBAJL,mBAAmB,MAAM,OAAO,cAAc,YAC1C,cAAc,OAAO,SAAS,MAAM,KACpC,mBAAmB,MAAM,OAAO;GAGtC;;;;CAKF,MAAM,mBAAmB,eAAe;EAEtC,MAAM,aAAa,YAAY,mBAAmB,MAAM,OAAO;AAE/D,MAAI,WACF,QAAO;EAIT,MAAM,aAAa,cAAc,OAAO;AACxC,MAAI,WACF,QAAO,OAAO,OAAO,YAAY,CAAC,MAAM,MAAM,EAAE,UAAU,SAAS,WAAW,CAAC;AAMjF,SAAO,YAFa,gBAAgB,OAAO,YAAY,MAAM,YAAY,IAAI,OAAO;GAGpF;;CAGF,MAAM,eAAe,eAAe;AAElC,MAAI,cAAc,OAAO,mBAAmB;GAE1C,MAAM,SAAS,QAAQ,cAAc,MAAM;AAC3C,OAAI,OACF,QAAO;;AAKX,MAAI,iBAAiB,OAAO,mBAAmB;GAE7C,MAAM,SAAS,QAAQ,iBAAiB,MAAM;AAC9C,OAAI,OACF,QAAO;;GAKX;AA4CF,QAAO;EACL;EACA,gBA3CqB,eACrB,mBAAmB,MAAM,OAAO,aAAa,YACxC,gBAAgB,OAAO,QAAQ,MAAO,YACvC,mBAAmB,MAAM,OAAO,SACrC;EAwCC;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA,oBA1CyB,eAA8B;GACvD,MAAM,oBAAoB,gBAAgB,OAAO,gBAAgB,EAAE;GACnE,MAAM,wBAAwB,kBAAkB,MAAM,MAAM,KAAK,MAAM,kBAAkB,MAAM,MAAM,GAAG,EAAE;GAE1G,MAAM,gBAA+B,eAAe,kBAAkB,CAAC,KAAK,CAAC,KAAK,YAAY;IAC5F;IACA;IACA,QAAQ;IACT,EAAE;GAEH,MAAM,oBAAmC,eAAe,sBAAsB,CAAC,KAAK,CAAC,KAAK,YAAY;IACpG;IACA;IACA,QAAQ;IACT,EAAE;GAEH,MAAM,gCAAgB,IAAI,KAA0B;AAEpD,qBAAkB,SAAS,WAAW;AACpC,kBAAc,IAAI,OAAO,KAAK,OAAO;KACrC;AAEF,iBAAc,SAAS,WAAW;AAChC,QAAI,CAAC,cAAc,IAAI,OAAO,IAAI,CAChC,eAAc,IAAI,OAAO,KAAK,OAAO;KAEvC;AAEF,UAAO,MAAM,KAAK,cAAc,QAAQ,CAAC;IACzC;EAcA;EACD;;AAIH,IAAa,yBAAyB,QAAQ;;;;;;;;;AAU9C,IAAa,0BAA+C;CAC1D,MAAM,QAAQ,OAAO,uBAAuB;AAC5C,KAAI,CAAC,MACH,OAAM,IAAI,MAAM,qCAAqC;AAEvD,QAAO"}