@scalar/api-client 2.38.3 → 2.39.0

package/dist/store/store.js

@@ -0,0 +1,180 @@
+import { createStoreCollections, extendedCollectionDataFactory } from "./collections.js";
+import { createStoreCookies } from "./cookies.js";
+import { createStoreEnvironments, extendedEnvironmentDataFactory } from "./environment.js";
+import { createStoreEvents } from "./events.js";
+import { importSpecFileFactory } from "./import-spec.js";
+import { createStoreRequestExamples, extendedExampleDataFactory } from "./request-example.js";
+import { createStoreRequests, extendedRequestDataFactory } from "./requests.js";
+import { createStoreSecuritySchemes, extendedSecurityDataFactory } from "./security-schemes.js";
+import { createStoreServers, extendedServerDataFactory } from "./servers.js";
+import { createStoreTags, extendedTagDataFactory } from "./tags.js";
+import { createStoreWorkspaces, extendedWorkspaceDataFactory } from "./workspace.js";
+import { inject, reactive, ref, toRaw } from "vue";
+import { useModal } from "@scalar/components";
+//#region src/store/store.ts
+/**
+* Factory function for creating the centralized store for the API client.
+*
+* This store manages all data and state for the application.
+* It should be instantiated once and injected into the app's root component.
+*/
+var createWorkspaceStore = ({ useLocalStorage = true, showSidebar = true, proxyUrl, theme, hideClientButton = false, _integration }) => {
+	const { collections, collectionMutators } = createStoreCollections(useLocalStorage);
+	const { tags, tagMutators } = createStoreTags(useLocalStorage);
+	const { requests, requestMutators } = createStoreRequests(useLocalStorage);
+	const { requestExamples, requestExampleMutators } = createStoreRequestExamples(useLocalStorage);
+	const { cookies, cookieMutators } = createStoreCookies(useLocalStorage);
+	const { environments, environmentMutators } = createStoreEnvironments(useLocalStorage);
+	const { servers, serverMutators } = createStoreServers(useLocalStorage);
+	const { securitySchemes, securitySchemeMutators } = createStoreSecuritySchemes(useLocalStorage);
+	const { workspaces, workspaceMutators } = createStoreWorkspaces(useLocalStorage);
+	const storeContext = {
+		collections,
+		collectionMutators,
+		tags,
+		tagMutators,
+		requests,
+		requestMutators,
+		requestExamples,
+		requestExampleMutators,
+		cookies,
+		cookieMutators,
+		environments,
+		environmentMutators,
+		servers,
+		serverMutators,
+		securitySchemes,
+		securitySchemeMutators,
+		workspaces,
+		workspaceMutators
+	};
+	const { addTag, deleteTag } = extendedTagDataFactory(storeContext);
+	const { addRequest, deleteRequest, findRequestParents } = extendedRequestDataFactory(storeContext, addTag);
+	const { deleteEnvironment } = extendedEnvironmentDataFactory(storeContext);
+	const { addServer, deleteServer } = extendedServerDataFactory(storeContext);
+	const { addCollection, deleteCollection } = extendedCollectionDataFactory(storeContext);
+	const { addRequestExample, deleteRequestExample } = extendedExampleDataFactory(storeContext);
+	const { addWorkspace, deleteWorkspace } = extendedWorkspaceDataFactory(storeContext);
+	const { addSecurityScheme, deleteSecurityScheme } = extendedSecurityDataFactory(storeContext);
+	const { addCollectionEnvironment, removeCollectionEnvironment } = extendedCollectionDataFactory(storeContext);
+	/** Running request history list */
+	const requestHistory = reactive([]);
+	const { importSpecFile, importSpecFromUrl } = importSpecFileFactory(storeContext);
+	/** Helper function to manage the sidebar width */
+	const sidebarWidth = ref((useLocalStorage ? localStorage?.getItem("sidebarWidth") : void 0) || "280px");
+	const setSidebarWidth = (width) => {
+		sidebarWidth.value = width;
+		if (useLocalStorage) localStorage?.setItem("sidebarWidth", width);
+	};
+	/** This state is to be used by the API Client Modal component to control the modal */
+	const modalState = useModal();
+	Object.values(workspaces).forEach(({ uid }) => {
+		if (proxyUrl) workspaceMutators.edit(uid, "proxyUrl", proxyUrl);
+		if (theme) workspaceMutators.edit(uid, "themeId", theme);
+	});
+	/**
+	* For debugging purposes, expose this method for dumping the data stores
+	*/
+	if (typeof window !== "undefined") window.dataDump = () => ({
+		collections: toRaw(collections),
+		cookies: toRaw(cookies),
+		environments: toRaw(environments),
+		requestExamples: toRaw(requestExamples),
+		requests: toRaw(requests),
+		securitySchemes: toRaw(securitySchemes),
+		servers: toRaw(servers),
+		tags: toRaw(tags),
+		workspaces: toRaw(workspaces)
+	});
+	return {
+		workspaces,
+		collections,
+		tags,
+		cookies,
+		environments,
+		requestExamples,
+		requests,
+		servers,
+		securitySchemes,
+		modalState,
+		events: createStoreEvents(),
+		sidebarWidth,
+		setSidebarWidth,
+		proxyUrl,
+		hideClientButton,
+		showSidebar,
+		integration: _integration,
+		importSpecFile,
+		importSpecFromUrl,
+		cookieMutators,
+		collectionMutators: {
+			...collectionMutators,
+			rawAdd: collectionMutators.add,
+			add: addCollection,
+			delete: deleteCollection,
+			addEnvironment: addCollectionEnvironment,
+			removeEnvironment: removeCollectionEnvironment
+		},
+		environmentMutators: {
+			...environmentMutators,
+			delete: deleteEnvironment
+		},
+		requestMutators: {
+			...requestMutators,
+			rawAdd: requestMutators.add,
+			add: addRequest,
+			delete: deleteRequest
+		},
+		findRequestParents,
+		requestExampleMutators: {
+			...requestExampleMutators,
+			rawAdd: requestExampleMutators.add,
+			add: addRequestExample,
+			delete: deleteRequestExample
+		},
+		requestHistory,
+		securitySchemeMutators: {
+			...securitySchemeMutators,
+			rawAdd: securitySchemeMutators.add,
+			add: addSecurityScheme,
+			delete: deleteSecurityScheme
+		},
+		serverMutators: {
+			...serverMutators,
+			rawAdd: serverMutators.add,
+			add: addServer,
+			delete: deleteServer
+		},
+		tagMutators: {
+			...tagMutators,
+			rawAdd: tagMutators.add,
+			add: addTag,
+			delete: deleteTag
+		},
+		workspaceMutators: {
+			...workspaceMutators,
+			rawAdd: workspaceMutators.add,
+			add: addWorkspace,
+			delete: deleteWorkspace
+		},
+		addCollectionEnvironment,
+		removeCollectionEnvironment
+	};
+};
+/** Set as a string so that different instances of api-client can reference inject the same store */
+var WORKSPACE_SYMBOL = "WORKSPACE_SYMBOL";
+/**
+* Global hook which contains the store for the whole app
+*
+* The rawAdd methods are the mutator.add methods. Some add methods have been replaced when we need some side effects
+* ex: add examples when adding a request
+*/
+var useWorkspace = () => {
+	const store = inject(WORKSPACE_SYMBOL);
+	if (!store) throw new Error("Workspace store not provided");
+	return store;
+};
+//#endregion
+export { WORKSPACE_SYMBOL, createWorkspaceStore, useWorkspace };
+
+//# sourceMappingURL=store.js.map

package/dist/store/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","names":[],"sources":["../../src/store/store.ts"],"sourcesContent":["import { useModal } from '@scalar/components'\nimport type { RequestEvent, SecurityScheme } from '@scalar/oas-utils/entities/spec'\nimport type { Path, PathValue } from '@scalar/object-utils/nested'\nimport type { ApiReferenceConfiguration } from '@scalar/types/api-reference'\nimport { inject, reactive, ref, toRaw } from 'vue'\n\nimport { createStoreCollections, extendedCollectionDataFactory } from '@/store/collections'\nimport { createStoreCookies } from '@/store/cookies'\nimport { createStoreEnvironments, extendedEnvironmentDataFactory } from '@/store/environment'\nimport { createStoreEvents } from '@/store/events'\nimport { importSpecFileFactory } from '@/store/import-spec'\nimport { createStoreRequestExamples, extendedExampleDataFactory } from '@/store/request-example'\nimport { createStoreRequests, extendedRequestDataFactory } from '@/store/requests'\nimport { createStoreSecuritySchemes, extendedSecurityDataFactory } from '@/store/security-schemes'\nimport { createStoreServers, extendedServerDataFactory } from '@/store/servers'\nimport type { StoreContext } from '@/store/store-context'\nimport { createStoreTags, extendedTagDataFactory } from '@/store/tags'\nimport { createStoreWorkspaces, extendedWorkspaceDataFactory } from '@/store/workspace'\n\nexport type UpdateScheme = <P extends Path<SecurityScheme>>(\n  path: P,\n  value: NonNullable<PathValue<SecurityScheme, P>>,\n) => void\n\ndeclare global {\n  interface Window {\n    dataDump: () => void\n  }\n}\n\nexport type CreateWorkspaceStoreOptions = {\n  /**\n   * When true, changes made to the store will be saved in the browser's localStorage.\n   *\n   * @default true\n   */\n  useLocalStorage: boolean\n} & Pick<ApiReferenceConfiguration, 'proxyUrl' | 'showSidebar' | 'hideClientButton' | 'theme' | '_integration'>\n\n/**\n * Factory function for creating the centralized store for the API client.\n *\n * This store manages all data and state for the application.\n * It should be instantiated once and injected into the app's root component.\n */\nexport const createWorkspaceStore = ({\n  useLocalStorage = true,\n  showSidebar = true,\n  proxyUrl,\n  theme,\n  hideClientButton = false,\n  _integration,\n}: CreateWorkspaceStoreOptions) => {\n  // ---------------------------------------------------------------------------\n  // Initialize all storage objects\n\n  const { collections, collectionMutators } = createStoreCollections(useLocalStorage)\n  const { tags, tagMutators } = createStoreTags(useLocalStorage)\n  const { requests, requestMutators } = createStoreRequests(useLocalStorage)\n  const { requestExamples, requestExampleMutators } = createStoreRequestExamples(useLocalStorage)\n  const { cookies, cookieMutators } = createStoreCookies(useLocalStorage)\n  const { environments, environmentMutators } = createStoreEnvironments(useLocalStorage)\n  const { servers, serverMutators } = createStoreServers(useLocalStorage)\n  const { securitySchemes, securitySchemeMutators } = createStoreSecuritySchemes(useLocalStorage)\n  const { workspaces, workspaceMutators } = createStoreWorkspaces(useLocalStorage)\n\n  // ---------------------------------------------------------------------------\n  // Extended Mutators - Adds side effects as needed\n\n  // Provide the workspace to the extended mutator factories\n  const storeContext: StoreContext = {\n    collections,\n    collectionMutators,\n    tags,\n    tagMutators,\n    requests,\n    requestMutators,\n    requestExamples,\n    requestExampleMutators,\n    cookies,\n    cookieMutators,\n    environments,\n    environmentMutators,\n    servers,\n    serverMutators,\n    securitySchemes,\n    securitySchemeMutators,\n    workspaces,\n    workspaceMutators,\n  }\n  const { addTag, deleteTag } = extendedTagDataFactory(storeContext)\n  const { addRequest, deleteRequest, findRequestParents } = extendedRequestDataFactory(storeContext, addTag)\n  const { deleteEnvironment } = extendedEnvironmentDataFactory(storeContext)\n  const { addServer, deleteServer } = extendedServerDataFactory(storeContext)\n  const { addCollection, deleteCollection } = extendedCollectionDataFactory(storeContext)\n  const { addRequestExample, deleteRequestExample } = extendedExampleDataFactory(storeContext)\n  const { addWorkspace, deleteWorkspace } = extendedWorkspaceDataFactory(storeContext)\n  const { addSecurityScheme, deleteSecurityScheme } = extendedSecurityDataFactory(storeContext)\n  const { addCollectionEnvironment, removeCollectionEnvironment } = extendedCollectionDataFactory(storeContext)\n\n  // ---------------------------------------------------------------------------\n  // OTHER HELPER DATA\n  /** Running request history list */\n  const requestHistory = reactive<RequestEvent[]>([])\n\n  const { importSpecFile, importSpecFromUrl } = importSpecFileFactory(storeContext)\n\n  /** Helper function to manage the sidebar width */\n  const sidebarWidth = ref((useLocalStorage ? localStorage?.getItem('sidebarWidth') : undefined) || '280px')\n\n  // Set the sidebar width\n  const setSidebarWidth = (width: string) => {\n    sidebarWidth.value = width\n    if (useLocalStorage) {\n      localStorage?.setItem('sidebarWidth', width)\n    }\n  }\n\n  /** This state is to be used by the API Client Modal component to control the modal */\n  const modalState = useModal()\n\n  // Set some defaults on all workspaces\n  Object.values(workspaces).forEach(({ uid }) => {\n    if (proxyUrl) {\n      workspaceMutators.edit(uid, 'proxyUrl', proxyUrl)\n    }\n    if (theme) {\n      workspaceMutators.edit(uid, 'themeId', theme)\n    }\n  })\n\n  /**\n   * For debugging purposes, expose this method for dumping the data stores\n   */\n  if (typeof window !== 'undefined') {\n    window.dataDump = () => ({\n      collections: toRaw(collections),\n      cookies: toRaw(cookies),\n      environments: toRaw(environments),\n      requestExamples: toRaw(requestExamples),\n      requests: toRaw(requests),\n      securitySchemes: toRaw(securitySchemes),\n      servers: toRaw(servers),\n      tags: toRaw(tags),\n      workspaces: toRaw(workspaces),\n    })\n  }\n\n  // ---------------------------------------------------------------------------\n  // Events Busses\n  const events = createStoreEvents()\n\n  return {\n    // ---------------------------------------------------------------------------\n    // STATE\n    workspaces,\n    collections,\n    tags,\n    cookies,\n    environments,\n    requestExamples,\n    requests,\n    servers,\n    securitySchemes,\n    modalState,\n    events,\n    sidebarWidth,\n    setSidebarWidth,\n    proxyUrl,\n    // ---------------------------------------------------------------------------\n    // CONFIGURATION \"PROPS\"\n    // TODO: move these to their own store\n    hideClientButton,\n    showSidebar,\n    integration: _integration,\n    // ---------------------------------------------------------------------------\n    // METHODS\n    importSpecFile,\n    importSpecFromUrl,\n    cookieMutators,\n    collectionMutators: {\n      ...collectionMutators,\n      rawAdd: collectionMutators.add,\n      add: addCollection,\n      delete: deleteCollection,\n      addEnvironment: addCollectionEnvironment,\n      removeEnvironment: removeCollectionEnvironment,\n    },\n    environmentMutators: {\n      ...environmentMutators,\n      delete: deleteEnvironment,\n    },\n    requestMutators: {\n      ...requestMutators,\n      rawAdd: requestMutators.add,\n      add: addRequest,\n      delete: deleteRequest,\n    },\n    findRequestParents,\n    requestExampleMutators: {\n      ...requestExampleMutators,\n      rawAdd: requestExampleMutators.add,\n      add: addRequestExample,\n      delete: deleteRequestExample,\n    },\n    requestHistory,\n    securitySchemeMutators: {\n      ...securitySchemeMutators,\n      rawAdd: securitySchemeMutators.add,\n      add: addSecurityScheme,\n      delete: deleteSecurityScheme,\n    },\n    serverMutators: {\n      ...serverMutators,\n      rawAdd: serverMutators.add,\n      add: addServer,\n      delete: deleteServer,\n    },\n    tagMutators: {\n      ...tagMutators,\n      rawAdd: tagMutators.add,\n      add: addTag,\n      delete: deleteTag,\n    },\n    workspaceMutators: {\n      ...workspaceMutators,\n      rawAdd: workspaceMutators.add,\n      add: addWorkspace,\n      delete: deleteWorkspace,\n    },\n    addCollectionEnvironment,\n    removeCollectionEnvironment,\n  }\n}\n\nexport type WorkspaceStore = ReturnType<typeof createWorkspaceStore>\n/** Set as a string so that different instances of api-client can reference inject the same store */\nexport const WORKSPACE_SYMBOL = 'WORKSPACE_SYMBOL' as const\n\n/**\n * Global hook which contains the store for the whole app\n *\n * The rawAdd methods are the mutator.add methods. Some add methods have been replaced when we need some side effects\n * ex: add examples when adding a request\n */\nexport const useWorkspace = (): WorkspaceStore => {\n  const store = inject<WorkspaceStore>(WORKSPACE_SYMBOL)\n  if (!store) {\n    throw new Error('Workspace store not provided')\n  }\n  return store\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AA6CA,IAAa,wBAAwB,EACnC,kBAAkB,MAClB,cAAc,MACd,UACA,OACA,mBAAmB,OACnB,mBACiC;CAIjC,MAAM,EAAE,aAAa,uBAAuB,uBAAuB,gBAAgB;CACnF,MAAM,EAAE,MAAM,gBAAgB,gBAAgB,gBAAgB;CAC9D,MAAM,EAAE,UAAU,oBAAoB,oBAAoB,gBAAgB;CAC1E,MAAM,EAAE,iBAAiB,2BAA2B,2BAA2B,gBAAgB;CAC/F,MAAM,EAAE,SAAS,mBAAmB,mBAAmB,gBAAgB;CACvE,MAAM,EAAE,cAAc,wBAAwB,wBAAwB,gBAAgB;CACtF,MAAM,EAAE,SAAS,mBAAmB,mBAAmB,gBAAgB;CACvE,MAAM,EAAE,iBAAiB,2BAA2B,2BAA2B,gBAAgB;CAC/F,MAAM,EAAE,YAAY,sBAAsB,sBAAsB,gBAAgB;CAMhF,MAAM,eAA6B;EACjC;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACD;CACD,MAAM,EAAE,QAAQ,cAAc,uBAAuB,aAAa;CAClE,MAAM,EAAE,YAAY,eAAe,uBAAuB,2BAA2B,cAAc,OAAO;CAC1G,MAAM,EAAE,sBAAsB,+BAA+B,aAAa;CAC1E,MAAM,EAAE,WAAW,iBAAiB,0BAA0B,aAAa;CAC3E,MAAM,EAAE,eAAe,qBAAqB,8BAA8B,aAAa;CACvF,MAAM,EAAE,mBAAmB,yBAAyB,2BAA2B,aAAa;CAC5F,MAAM,EAAE,cAAc,oBAAoB,6BAA6B,aAAa;CACpF,MAAM,EAAE,mBAAmB,yBAAyB,4BAA4B,aAAa;CAC7F,MAAM,EAAE,0BAA0B,gCAAgC,8BAA8B,aAAa;;CAK7G,MAAM,iBAAiB,SAAyB,EAAE,CAAC;CAEnD,MAAM,EAAE,gBAAgB,sBAAsB,sBAAsB,aAAa;;CAGjF,MAAM,eAAe,KAAK,kBAAkB,cAAc,QAAQ,eAAe,GAAG,KAAA,MAAc,QAAQ;CAG1G,MAAM,mBAAmB,UAAkB;AACzC,eAAa,QAAQ;AACrB,MAAI,gBACF,eAAc,QAAQ,gBAAgB,MAAM;;;CAKhD,MAAM,aAAa,UAAU;AAG7B,QAAO,OAAO,WAAW,CAAC,SAAS,EAAE,UAAU;AAC7C,MAAI,SACF,mBAAkB,KAAK,KAAK,YAAY,SAAS;AAEnD,MAAI,MACF,mBAAkB,KAAK,KAAK,WAAW,MAAM;GAE/C;;;;AAKF,KAAI,OAAO,WAAW,YACpB,QAAO,kBAAkB;EACvB,aAAa,MAAM,YAAY;EAC/B,SAAS,MAAM,QAAQ;EACvB,cAAc,MAAM,aAAa;EACjC,iBAAiB,MAAM,gBAAgB;EACvC,UAAU,MAAM,SAAS;EACzB,iBAAiB,MAAM,gBAAgB;EACvC,SAAS,MAAM,QAAQ;EACvB,MAAM,MAAM,KAAK;EACjB,YAAY,MAAM,WAAW;EAC9B;AAOH,QAAO;EAGL;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA,QAfa,mBAAmB;EAgBhC;EACA;EACA;EAIA;EACA;EACA,aAAa;EAGb;EACA;EACA;EACA,oBAAoB;GAClB,GAAG;GACH,QAAQ,mBAAmB;GAC3B,KAAK;GACL,QAAQ;GACR,gBAAgB;GAChB,mBAAmB;GACpB;EACD,qBAAqB;GACnB,GAAG;GACH,QAAQ;GACT;EACD,iBAAiB;GACf,GAAG;GACH,QAAQ,gBAAgB;GACxB,KAAK;GACL,QAAQ;GACT;EACD;EACA,wBAAwB;GACtB,GAAG;GACH,QAAQ,uBAAuB;GAC/B,KAAK;GACL,QAAQ;GACT;EACD;EACA,wBAAwB;GACtB,GAAG;GACH,QAAQ,uBAAuB;GAC/B,KAAK;GACL,QAAQ;GACT;EACD,gBAAgB;GACd,GAAG;GACH,QAAQ,eAAe;GACvB,KAAK;GACL,QAAQ;GACT;EACD,aAAa;GACX,GAAG;GACH,QAAQ,YAAY;GACpB,KAAK;GACL,QAAQ;GACT;EACD,mBAAmB;GACjB,GAAG;GACH,QAAQ,kBAAkB;GAC1B,KAAK;GACL,QAAQ;GACT;EACD;EACA;EACD;;;AAKH,IAAa,mBAAmB;;;;;;;AAQhC,IAAa,qBAAqC;CAChD,MAAM,QAAQ,OAAuB,iBAAiB;AACtD,KAAI,CAAC,MACH,OAAM,IAAI,MAAM,+BAA+B;AAEjD,QAAO"}

package/dist/store/tags.d.ts

@@ -1,5 +1,5 @@
 import { type Collection, type Tag, type TagPayload } from '@scalar/oas-utils/entities/spec';
-import type { StoreContext } from '@/store/store-context';
+import type { StoreContext } from '../store/store-context';
 /** Create cookie mutators for the workspace */
 export declare function createStoreTags(useLocalStorage: boolean): {
     tags: Record<string, {

package/dist/store/tags.js

@@ -0,0 +1,54 @@
+import { reactive } from "vue";
+import { schemaModel } from "@scalar/oas-utils/helpers";
+import { LS_KEYS } from "@scalar/helpers/object/local-storage";
+import { tagSchema } from "@scalar/oas-utils/entities/spec";
+import { mutationFactory } from "@scalar/object-utils/mutator-record";
+//#region src/store/tags.ts
+/** Create cookie mutators for the workspace */
+function createStoreTags(useLocalStorage) {
+	const tags = reactive({});
+	return {
+		tags,
+		tagMutators: mutationFactory(tags, reactive({}), useLocalStorage && LS_KEYS.TAG)
+	};
+}
+/**
+* Create the extended mutators for tag with side effects
+* TODO:
+* - tag nesting, add/remove into another tag
+*/
+function extendedTagDataFactory({ collectionMutators, collections, requests, requestMutators, tagMutators }) {
+	/** Add tag */
+	const addTag = (payload, collectionUid) => {
+		const collection = collections[collectionUid];
+		const tag = schemaModel(payload, tagSchema, false);
+		if (!tag || !collection) return console.error("INVALID TAG DATA", payload);
+		collectionMutators.edit(collectionUid, "tags", [...collection.tags, tag.uid]);
+		collectionMutators.edit(collectionUid, "children", [...collection.children, tag.uid]);
+		tagMutators.add(tag);
+		return tag;
+	};
+	/** Delete Tag */
+	const deleteTag = (tag, collectionUid) => {
+		const collection = collections[collectionUid];
+		if (!collection) return;
+		collectionMutators.edit(collectionUid, "tags", collection.tags.filter((uid) => uid !== tag.uid));
+		collectionMutators.edit(collectionUid, "children", collection.children.filter((uid) => uid !== tag.uid));
+		tag.children.forEach((childUid) => {
+			const request = requests[childUid];
+			if (!request) return;
+			const filteredTags = request.tags?.filter((tagName) => tagName !== tag.name);
+			requestMutators.edit(request.uid, "tags", filteredTags);
+			if (!filteredTags?.length && !collection.children.includes(childUid)) collectionMutators.edit(collectionUid, "children", [...collection.children, childUid]);
+		});
+		tagMutators.delete(tag.uid);
+	};
+	return {
+		addTag,
+		deleteTag
+	};
+}
+//#endregion
+export { createStoreTags, extendedTagDataFactory };
+
+//# sourceMappingURL=tags.js.map

package/dist/store/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","names":[],"sources":["../../src/store/tags.ts"],"sourcesContent":["import { LS_KEYS } from '@scalar/helpers/object/local-storage'\nimport { type Collection, type Tag, type TagPayload, tagSchema } from '@scalar/oas-utils/entities/spec'\nimport { schemaModel } from '@scalar/oas-utils/helpers'\nimport { mutationFactory } from '@scalar/object-utils/mutator-record'\nimport { reactive } from 'vue'\n\nimport type { StoreContext } from '@/store/store-context'\n\n/** Create cookie mutators for the workspace */\nexport function createStoreTags(useLocalStorage: boolean) {\n  const tags = reactive<Record<string, Tag>>({})\n\n  const tagMutators = mutationFactory(tags, reactive({}), useLocalStorage && LS_KEYS.TAG)\n\n  return {\n    tags,\n    tagMutators,\n  }\n}\n\n/**\n * Create the extended mutators for tag with side effects\n * TODO:\n * - tag nesting, add/remove into another tag\n */\nexport function extendedTagDataFactory({\n  collectionMutators,\n  collections,\n  requests,\n  requestMutators,\n  tagMutators,\n}: StoreContext) {\n  /** Add tag */\n  const addTag = (payload: TagPayload, collectionUid: Collection['uid']) => {\n    const collection = collections[collectionUid]\n    const tag = schemaModel(payload, tagSchema, false)\n    if (!tag || !collection) {\n      return console.error('INVALID TAG DATA', payload)\n    }\n\n    // Add to collection tags\n    collectionMutators.edit(collectionUid, 'tags', [...collection.tags, tag.uid])\n\n    // Add to parent collection as a child\n    collectionMutators.edit(collectionUid, 'children', [...collection.children, tag.uid])\n\n    tagMutators.add(tag)\n    return tag\n  }\n\n  /** Delete Tag */\n  const deleteTag = (tag: Tag, collectionUid: Collection['uid']) => {\n    const collection = collections[collectionUid]\n\n    if (!collection) {\n      return\n    }\n\n    // Remove from collection tags\n    collectionMutators.edit(\n      collectionUid,\n      'tags',\n      collection.tags.filter((uid) => uid !== tag.uid),\n    )\n\n    // Remove from collection children\n    collectionMutators.edit(\n      collectionUid,\n      'children',\n      collection.children.filter((uid) => uid !== tag.uid),\n    )\n\n    // Loop on each child, just requests for now but will add other tags\n    tag.children.forEach((childUid) => {\n      const request = requests[childUid]\n      if (!request) {\n        return\n      }\n\n      const filteredTags = request.tags?.filter((tagName) => tagName !== tag.name)\n\n      // Remove the tagName from the request\n      requestMutators.edit(request.uid, 'tags', filteredTags)\n\n      // Add to the collection children if there's no more tags\n      if (!filteredTags?.length && !collection.children.includes(childUid)) {\n        collectionMutators.edit(collectionUid, 'children', [...collection.children, childUid])\n      }\n    })\n\n    tagMutators.delete(tag.uid)\n  }\n\n  return { addTag, deleteTag }\n}\n"],"mappings":";;;;;;;AASA,SAAgB,gBAAgB,iBAA0B;CACxD,MAAM,OAAO,SAA8B,EAAE,CAAC;AAI9C,QAAO;EACL;EACA,aAJkB,gBAAgB,MAAM,SAAS,EAAE,CAAC,EAAE,mBAAmB,QAAQ,IAAI;EAKtF;;;;;;;AAQH,SAAgB,uBAAuB,EACrC,oBACA,aACA,UACA,iBACA,eACe;;CAEf,MAAM,UAAU,SAAqB,kBAAqC;EACxE,MAAM,aAAa,YAAY;EAC/B,MAAM,MAAM,YAAY,SAAS,WAAW,MAAM;AAClD,MAAI,CAAC,OAAO,CAAC,WACX,QAAO,QAAQ,MAAM,oBAAoB,QAAQ;AAInD,qBAAmB,KAAK,eAAe,QAAQ,CAAC,GAAG,WAAW,MAAM,IAAI,IAAI,CAAC;AAG7E,qBAAmB,KAAK,eAAe,YAAY,CAAC,GAAG,WAAW,UAAU,IAAI,IAAI,CAAC;AAErF,cAAY,IAAI,IAAI;AACpB,SAAO;;;CAIT,MAAM,aAAa,KAAU,kBAAqC;EAChE,MAAM,aAAa,YAAY;AAE/B,MAAI,CAAC,WACH;AAIF,qBAAmB,KACjB,eACA,QACA,WAAW,KAAK,QAAQ,QAAQ,QAAQ,IAAI,IAAI,CACjD;AAGD,qBAAmB,KACjB,eACA,YACA,WAAW,SAAS,QAAQ,QAAQ,QAAQ,IAAI,IAAI,CACrD;AAGD,MAAI,SAAS,SAAS,aAAa;GACjC,MAAM,UAAU,SAAS;AACzB,OAAI,CAAC,QACH;GAGF,MAAM,eAAe,QAAQ,MAAM,QAAQ,YAAY,YAAY,IAAI,KAAK;AAG5E,mBAAgB,KAAK,QAAQ,KAAK,QAAQ,aAAa;AAGvD,OAAI,CAAC,cAAc,UAAU,CAAC,WAAW,SAAS,SAAS,SAAS,CAClE,oBAAmB,KAAK,eAAe,YAAY,CAAC,GAAG,WAAW,UAAU,SAAS,CAAC;IAExF;AAEF,cAAY,OAAO,IAAI,IAAI;;AAG7B,QAAO;EAAE;EAAQ;EAAW"}

package/dist/store/workspace.d.ts

@@ -1,5 +1,5 @@
 import { type Workspace } from '@scalar/oas-utils/entities/workspace';
-import type { StoreContext } from '@/store/store-context';
+import type { StoreContext } from '../store/store-context';
 /** Create storage for workspace entities */
 export declare function createStoreWorkspaces(useLocalStorage: boolean): {
     workspaces: Record<string, {

package/dist/store/workspace.js

@@ -0,0 +1,57 @@
+import { createInitialRequest } from "./requests.js";
+import { reactive } from "vue";
+import { LS_KEYS } from "@scalar/helpers/object/local-storage";
+import { collectionSchema, requestExampleSchema } from "@scalar/oas-utils/entities/spec";
+import { mutationFactory } from "@scalar/object-utils/mutator-record";
+import { workspaceSchema } from "@scalar/oas-utils/entities/workspace";
+//#region src/store/workspace.ts
+/** Create storage for workspace entities */
+function createStoreWorkspaces(useLocalStorage) {
+	/** Active workspace object (will be associated with an entry in the workspace collection) */
+	const workspaces = reactive({});
+	return {
+		workspaces,
+		workspaceMutators: mutationFactory(workspaces, reactive({}), useLocalStorage && LS_KEYS.WORKSPACE)
+	};
+}
+/** Workspace entities that require store context */
+function extendedWorkspaceDataFactory({ workspaces, workspaceMutators, collectionMutators, requestMutators, requestExampleMutators }) {
+	const addWorkspace = (payload = {}) => {
+		const { request } = createInitialRequest();
+		const example = requestExampleSchema.parse({
+			name: "Example",
+			requestUid: request.uid
+		});
+		request.examples.push(example.uid);
+		const collection = collectionSchema.parse({
+			info: { title: "Drafts" },
+			children: [request.uid],
+			requests: [request.uid]
+		});
+		const workspace = workspaceSchema.parse({
+			...payload,
+			collections: [collection.uid]
+		});
+		requestExampleMutators.add(example);
+		requestMutators.add(request);
+		collectionMutators.add(collection);
+		workspaceMutators.add(workspace);
+		return workspace;
+	};
+	/** Prevent deletion of the default workspace */
+	const deleteWorkspace = (uid) => {
+		if (Object.keys(workspaces).length <= 1) {
+			console.warn("The last workspace cannot be deleted.");
+			return;
+		}
+		workspaceMutators.delete(uid);
+	};
+	return {
+		addWorkspace,
+		deleteWorkspace
+	};
+}
+//#endregion
+export { createStoreWorkspaces, extendedWorkspaceDataFactory };
+
+//# sourceMappingURL=workspace.js.map

package/dist/store/workspace.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.js","names":[],"sources":["../../src/store/workspace.ts"],"sourcesContent":["import { LS_KEYS } from '@scalar/helpers/object/local-storage'\nimport { collectionSchema, requestExampleSchema } from '@scalar/oas-utils/entities/spec'\nimport { type Workspace, workspaceSchema } from '@scalar/oas-utils/entities/workspace'\nimport { mutationFactory } from '@scalar/object-utils/mutator-record'\nimport { reactive } from 'vue'\n\nimport type { StoreContext } from '@/store/store-context'\n\nimport { createInitialRequest } from './requests'\n\n/** Create storage for workspace entities */\nexport function createStoreWorkspaces(useLocalStorage: boolean) {\n  /** Active workspace object (will be associated with an entry in the workspace collection) */\n  const workspaces = reactive<Record<string, Workspace>>({})\n  const workspaceMutators = mutationFactory(workspaces, reactive({}), useLocalStorage && LS_KEYS.WORKSPACE)\n\n  return {\n    workspaces,\n    workspaceMutators,\n  }\n}\n\n/** Workspace entities that require store context */\nexport function extendedWorkspaceDataFactory({\n  workspaces,\n  workspaceMutators,\n  collectionMutators,\n  requestMutators,\n  requestExampleMutators,\n}: StoreContext) {\n  const addWorkspace = (payload: Partial<Workspace> = {}) => {\n    // Create some example data\n    const { request } = createInitialRequest()\n\n    const example = requestExampleSchema.parse({\n      name: 'Example',\n      requestUid: request.uid,\n    })\n\n    request.examples.push(example.uid)\n\n    const collection = collectionSchema.parse({\n      info: {\n        title: 'Drafts',\n      },\n      children: [request.uid],\n      requests: [request.uid],\n    })\n\n    const workspace = workspaceSchema.parse({\n      ...payload,\n      collections: [collection.uid],\n    })\n\n    // Add all entities\n    requestExampleMutators.add(example)\n    requestMutators.add(request)\n    collectionMutators.add(collection)\n    workspaceMutators.add(workspace)\n\n    return workspace\n  }\n\n  /** Prevent deletion of the default workspace */\n  const deleteWorkspace = (uid: Workspace['uid']) => {\n    if (Object.keys(workspaces).length <= 1) {\n      console.warn('The last workspace cannot be deleted.')\n      return\n    }\n    workspaceMutators.delete(uid)\n  }\n\n  return {\n    addWorkspace,\n    deleteWorkspace,\n  }\n}\n"],"mappings":";;;;;;;;AAWA,SAAgB,sBAAsB,iBAA0B;;CAE9D,MAAM,aAAa,SAAoC,EAAE,CAAC;AAG1D,QAAO;EACL;EACA,mBAJwB,gBAAgB,YAAY,SAAS,EAAE,CAAC,EAAE,mBAAmB,QAAQ,UAAU;EAKxG;;;AAIH,SAAgB,6BAA6B,EAC3C,YACA,mBACA,oBACA,iBACA,0BACe;CACf,MAAM,gBAAgB,UAA8B,EAAE,KAAK;EAEzD,MAAM,EAAE,YAAY,sBAAsB;EAE1C,MAAM,UAAU,qBAAqB,MAAM;GACzC,MAAM;GACN,YAAY,QAAQ;GACrB,CAAC;AAEF,UAAQ,SAAS,KAAK,QAAQ,IAAI;EAElC,MAAM,aAAa,iBAAiB,MAAM;GACxC,MAAM,EACJ,OAAO,UACR;GACD,UAAU,CAAC,QAAQ,IAAI;GACvB,UAAU,CAAC,QAAQ,IAAI;GACxB,CAAC;EAEF,MAAM,YAAY,gBAAgB,MAAM;GACtC,GAAG;GACH,aAAa,CAAC,WAAW,IAAI;GAC9B,CAAC;AAGF,yBAAuB,IAAI,QAAQ;AACnC,kBAAgB,IAAI,QAAQ;AAC5B,qBAAmB,IAAI,WAAW;AAClC,oBAAkB,IAAI,UAAU;AAEhC,SAAO;;;CAIT,MAAM,mBAAmB,QAA0B;AACjD,MAAI,OAAO,KAAK,WAAW,CAAC,UAAU,GAAG;AACvC,WAAQ,KAAK,wCAAwC;AACrD;;AAEF,oBAAkB,OAAO,IAAI;;AAG/B,QAAO;EACL;EACA;EACD"}