@scalar/api-client 2.0.63 → 2.1.0

package/dist/store/servers.d.ts

@@ -0,0 +1,99 @@
+import type { StoreContext } from '../store/store-context';
+import { type ServerPayload } from '@scalar/oas-utils/entities/spec';
+/** Create storage objects for servers */
+export declare function createStoreServers(useLocalStorage: boolean): {
+    servers: Record<string, {
+        uid: string;
+        description?: string | undefined;
+        url?: string | undefined;
+        variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+            enum?: [string, ...string[]];
+        }> | undefined;
+    }>;
+    serverMutators: {
+        add: (item: {
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }) => void;
+        delete: (uid: string) => void;
+        set: (item: {
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }) => void;
+        edit: <P extends "description" | "url" | "variables" | "uid" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "url" | "variables" | "uid" ? {
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "url" | "variables" | "uid" ? R extends import("@scalar/object-utils/nested").Path<{
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }[K]> ? import("@scalar/object-utils/nested").PathValue<{
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
+        untrackedEdit: <P extends "description" | "url" | "variables" | "uid" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "url" | "variables" | "uid" ? {
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "url" | "variables" | "uid" ? R extends import("@scalar/object-utils/nested").Path<{
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }[K]> ? import("@scalar/object-utils/nested").PathValue<{
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
+        undo: (uid: string) => void;
+        redo: (uid: string) => void;
+        loadLocalStorage: (instances: {
+            uid: string;
+            description?: string | undefined;
+            url?: string | undefined;
+            variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+                enum?: [string, ...string[]];
+            }> | undefined;
+        }[]) => void;
+    };
+};
+/** Extended mutators and data for servers */
+export declare function extendedServerDataFactory({ serverMutators, collections, collectionMutators, requests, requestMutators, }: StoreContext): {
+    addServer: (payload: ServerPayload, parentUid: string) => {
+        uid: string;
+        description?: string | undefined;
+        url?: string | undefined;
+        variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
+            enum?: [string, ...string[]];
+        }> | undefined;
+    };
+    deleteServer: (serverUid: string, collectionUid: string) => void;
+};
+//# sourceMappingURL=servers.d.ts.map

package/dist/store/servers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"servers.d.ts","sourceRoot":"","sources":["../../src/store/servers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAEL,KAAK,aAAa,EAEnB,MAAM,iCAAiC,CAAA;AAKxC,yCAAyC;AACzC,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,OAAO;;;;;;gBAqEqtC,CAAC;;;;;;;;;oBAAD,CAAC;;;;;;;;;oBAAD,CAAC;;;;;;;;oBAAD,CAAC;;;;;;;oBAAD,CAAC;;;;;;;oBAAD,CAAC;;;;;;;;oBAAD,CAAC;;;;;;;oBAAD,CAAC;;;;;;;oBAAD,CAAC;;;;;;;;;;oBAAD,CAAC;;;;EAxDhxC;AAED,6CAA6C;AAC7C,wBAAgB,yBAAyB,CAAC,EACxC,cAAc,EACd,WAAW,EACX,kBAAkB,EAClB,QAAQ,EACR,eAAe,GAChB,EAAE,YAAY;yBAKe,aAAa,aAAa,MAAM;;;;;gBA0CktC,CAAC;;;8BAjB9uC,MAAM,iBAAiB,MAAM;EAgB/D"}

package/dist/store/servers.js

@@ -0,0 +1,46 @@
+import { serverSchema as f } from "@scalar/oas-utils/entities/spec";
+import { LS_KEYS as a } from "@scalar/oas-utils/helpers";
+import { mutationFactory as u } from "@scalar/object-utils/mutator-record";
+import { reactive as m } from "vue";
+function F(s) {
+  const r = m({}), v = u(
+    r,
+    m({}),
+    s && a.SERVER
+  );
+  return {
+    servers: r,
+    serverMutators: v
+  };
+}
+function R({
+  serverMutators: s,
+  collections: r,
+  collectionMutators: v,
+  requests: S,
+  requestMutators: d
+}) {
+  return {
+    addServer: (o, e) => {
+      const t = f.parse(o);
+      return r[e] ? v.edit(e, "servers", [
+        ...r[e].servers,
+        t.uid
+      ]) : S[e] && d.edit(e, "servers", [
+        ...S[e].servers,
+        t.uid
+      ]), s.add(t), t;
+    },
+    deleteServer: (o, e) => {
+      v.edit(
+        e,
+        "servers",
+        r[e].servers.filter((t) => t !== o)
+      ), s.delete(o);
+    }
+  };
+}
+export {
+  F as createStoreServers,
+  R as extendedServerDataFactory
+};

package/dist/store/store-context.d.ts

@@ -0,0 +1,29 @@
+import type { RouterPathParams } from '../store/router-params.js';
+import type { Cookie } from '@scalar/oas-utils/entities/cookie';
+import type { Environment } from '@scalar/oas-utils/entities/environment';
+import type { Collection, Request, RequestExample, SecurityScheme, Server, Tag } from '@scalar/oas-utils/entities/spec';
+import type { Workspace } from '@scalar/oas-utils/entities/workspace';
+import type { Mutators } from '@scalar/object-utils/mutator-record';
+import type { ComputedRef } from 'vue';
+export type StoreContext = {
+    routerParams: ComputedRef<RouterPathParams>;
+    collections: Record<string, Collection>;
+    collectionMutators: Mutators<Collection>;
+    tags: Record<string, Tag>;
+    tagMutators: Mutators<Tag>;
+    requests: Record<string, Request>;
+    requestMutators: Mutators<Request>;
+    requestExamples: Record<string, RequestExample>;
+    requestExampleMutators: Mutators<RequestExample>;
+    cookies: Record<string, Cookie>;
+    cookieMutators: Mutators<Cookie>;
+    environments: Record<string, Environment>;
+    environmentMutators: Mutators<Environment>;
+    servers: Record<string, Server>;
+    serverMutators: Mutators<Server>;
+    securitySchemes: Record<string, SecurityScheme>;
+    securitySchemeMutators: Mutators<SecurityScheme>;
+    workspaces: Record<string, Workspace>;
+    workspaceMutators: Mutators<Workspace>;
+};
+//# sourceMappingURL=store-context.d.ts.map

package/dist/store/store-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-context.d.ts","sourceRoot":"","sources":["../../src/store/store-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAA;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AACzE,OAAO,KAAK,EACV,UAAU,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACd,MAAM,EACN,GAAG,EACJ,MAAM,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,KAAK,CAAA;AAEtC,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAA;IAE3C,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvC,kBAAkB,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAA;IAExC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA;IAE1B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,eAAe,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IAElC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,sBAAsB,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAA;IAEhD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAEhC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACzC,mBAAmB,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAA;IAE1C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IAEhC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,sBAAsB,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAA;IAEhD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrC,iBAAiB,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;CACvC,CAAA"}