@scalar/api-client 2.38.4 → 2.39.1

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.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"}