@scalar/workspace-store 0.19.0 → 0.20.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scalar/workspace-store
 
+## 0.20.0
+
+### Minor Changes
+
+- [#7279](https://github.com/scalar/scalar/pull/7279) [`7ccd035`](https://github.com/scalar/scalar/commit/7ccd0351de104f78ef9c6e16538753d302c50d47) Thanks [@DemonHa](https://github.com/DemonHa)! - feat(api-client): integrate new sidebar with v2 routing
+
+### Patch Changes
+
+- [#7305](https://github.com/scalar/scalar/pull/7305) [`c7a4690`](https://github.com/scalar/scalar/commit/c7a4690cec484ee16cee8dcba7ef5cb0fbb98133) Thanks [@amritk](https://github.com/amritk)! - chore: minor auth changes, code re-org, type safety
+
+- Updated dependencies [[`9c9dbba`](https://github.com/scalar/scalar/commit/9c9dbbaa940667303f0ace59469fd78c2a741937), [`4bec1ba`](https://github.com/scalar/scalar/commit/4bec1ba332e919c4ee32dcfbfb07bd8ee42c4d74)]:
+  - @scalar/helpers@0.1.1
+  - @scalar/json-magic@0.8.1
+
 ## 0.19.0
 
 ### Minor Changes

package/dist/events/definitions/auth.d.ts

@@ -1,5 +1,23 @@
-import type { AuthMeta, SecuritySchemeUpdate } from '../../mutators/auth.js';
+import type { PartialDeep } from 'type-fest';
+import type { AuthMeta } from '../../mutators/auth.js';
 import type { SecurityRequirementObject, SecuritySchemeObject } from '../../schemas/v3.1/strict/openapi-document.js';
+import type { ApiKeyObject, HttpObject, OAuth2Object } from '../../schemas/v3.1/strict/security-scheme.js';
+/**
+ * SecuritySchemeUpdate represents the possible updates that can be made
+ * to an OpenAPI security scheme object via UI interactions.
+ *
+ * - `http`: Updates to HTTP type schemes (e.g. basic, bearer), allowing token, username, and password changes.
+ * - `apiKey`: Updates to API Key type schemes, allowing the key name and its value to be updated.
+ * - `oauth2`: Updates to OAuth2 type schemes for each supported OAuth2 flow.
+ *    - Can set various properties such as auth/token URLs, tokens, PKCE method, client credentials, etc.
+ */
+export type SecuritySchemeUpdatePayload = ({
+    type: 'http';
+} & Partial<Omit<HttpObject, 'type'>>) | ({
+    type: 'apiKey';
+} & Partial<Omit<ApiKeyObject, 'type'>>) | ({
+    type: 'oauth2';
+} & PartialDeep<Omit<OAuth2Object, 'type'>>);
 /** Event definitions for auth */
 export type AuthEvents = {
     /**
@@ -39,7 +57,7 @@ export type AuthEvents = {
      */
     'auth:update:security-scheme': {
         /** The data to update the security scheme with */
-        data: SecuritySchemeUpdate;
+        payload: SecuritySchemeUpdatePayload;
         /** The name of the security scheme to update */
         name: string;
     };

package/dist/events/definitions/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACrE,OAAO,KAAK,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAA;AAE7G,iCAAiC;AACjC,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;OAMG;IACH,uCAAuC,EAAE;QACvC,2EAA2E;QAC3E,oBAAoB,EAAE,yBAAyB,EAAE,CAAA;QACjD,wEAAwE;QACxE,UAAU,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,oBAAoB,CAAA;SAAE,EAAE,CAAA;QAC5D,2DAA2D;QAC3D,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;IAED;;;;;OAKG;IACH,0BAA0B,EAAE;QAC1B,iDAAiD;QACjD,KAAK,EAAE,MAAM,CAAA;QACb,2CAA2C;QAC3C,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;IAED;;;;OAIG;IACH,6BAA6B,EAAE;QAC7B,kDAAkD;QAClD,IAAI,EAAE,oBAAoB,CAAA;QAC1B,gDAAgD;QAChD,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IAED;;;OAGG;IACH,6BAA6B,EAAE;QAC7B,6DAA6D;QAC7D,EAAE,EAAE,MAAM,EAAE,CAAA;QACZ,+DAA+D;QAC/D,IAAI,EAAE,MAAM,CAAA;QACZ,oDAAoD;QACpD,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,2CAA2C;QAC3C,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;IAED;;;;;;;;;OASG;IACH,6BAA6B,EAAE;QAC7B,8CAA8C;QAC9C,KAAK,EAAE,MAAM,EAAE,CAAA;KAChB,CAAA;CACF,CAAA"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAE5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAA;AAC7G,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAA;AAEnG;;;;;;;;GAQG;AACH,MAAM,MAAM,2BAA2B,GACnC,CAAC;IACC,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,GACtC,CAAC;IACC,IAAI,EAAE,QAAQ,CAAA;CACf,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,GACxC,CAAC;IACC,IAAI,EAAE,QAAQ,CAAA;CACf,GAAG,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;AAEhD,iCAAiC;AACjC,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;OAMG;IACH,uCAAuC,EAAE;QACvC,2EAA2E;QAC3E,oBAAoB,EAAE,yBAAyB,EAAE,CAAA;QACjD,wEAAwE;QACxE,UAAU,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,oBAAoB,CAAA;SAAE,EAAE,CAAA;QAC5D,2DAA2D;QAC3D,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;IAED;;;;;OAKG;IACH,0BAA0B,EAAE;QAC1B,iDAAiD;QACjD,KAAK,EAAE,MAAM,CAAA;QACb,2CAA2C;QAC3C,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;IAED;;;;OAIG;IACH,6BAA6B,EAAE;QAC7B,kDAAkD;QAClD,OAAO,EAAE,2BAA2B,CAAA;QACpC,gDAAgD;QAChD,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IAED;;;OAGG;IACH,6BAA6B,EAAE;QAC7B,6DAA6D;QAC7D,EAAE,EAAE,MAAM,EAAE,CAAA;QACZ,+DAA+D;QAC/D,IAAI,EAAE,MAAM,CAAA;QACZ,oDAAoD;QACpD,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,2CAA2C;QAC3C,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;IAED;;;;;;;;;OASG;IACH,6BAA6B,EAAE;QAC7B,8CAA8C;QAC9C,KAAK,EAAE,MAAM,EAAE,CAAA;KAChB,CAAA;CACF,CAAA"}

package/dist/events/definitions/document.d.ts

@@ -7,8 +7,12 @@ export type DocumentEvents = {
      */
     'document:update:info': PartialDeep<InfoObject>;
     /**
-     * Update the icon of the active document/workspace
+     * Update the icon of the active document
      */
     'document:update:icon': string;
+    /**
+     * Toggle use document security
+     */
+    'document:toggle:document-security': undefined;
 };
 //# sourceMappingURL=document.d.ts.map

package/dist/events/definitions/document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAE5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAE5D,iDAAiD;AACjD,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,sBAAsB,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IAC/C;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;CAC/B,CAAA"}
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAE5C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAE5D,iDAAiD;AACjD,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,sBAAsB,EAAE,WAAW,CAAC,UAAU,CAAC,CAAA;IAC/C;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;IAC9B;;OAEG;IACH,mCAAmC,EAAE,SAAS,CAAA;CAC/C,CAAA"}

package/dist/events/definitions/index.d.ts

@@ -1,5 +1,4 @@
 import type { EnvironmentEvents } from '../../events/definitions/environment.js';
-import type { ServerObject } from '../../schemas/v3.1/strict/openapi-document.js';
 import type { AnalyticsEvents } from './analytics.js';
 import type { AuthEvents } from './auth.js';
 import type { DocumentEvents } from './document.js';
@@ -7,6 +6,6 @@ import type { MetaEvents } from './meta.js';
 import type { OperationEvents } from './operation.js';
 import type { ServerEvents } from './server.js';
 import type { UIEvents } from './ui.js';
-export type ApiReferenceEvents<T extends keyof ServerObject = keyof ServerObject> = AuthEvents & AnalyticsEvents & DocumentEvents & EnvironmentEvents & MetaEvents & OperationEvents & ServerEvents<T> & UIEvents;
+export type ApiReferenceEvents = AuthEvents & AnalyticsEvents & DocumentEvents & EnvironmentEvents & MetaEvents & OperationEvents & ServerEvents & UIEvents;
 export type { CollectionType } from './common.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/events/definitions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,IAAI,UAAU,GAC5F,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,eAAe,GACf,YAAY,CAAC,CAAC,CAAC,GACf,QAAQ,CAAA;AAEV,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AAEzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,kBAAkB,GAAG,UAAU,GACzC,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,eAAe,GACf,YAAY,GACZ,QAAQ,CAAA;AAEV,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA"}

package/dist/events/definitions/server.d.ts

@@ -1,50 +1,42 @@
 import type { ServerObject } from '../../schemas/v3.1/strict/openapi-document.js';
-export type ServerEvents<T extends keyof ServerObject = keyof ServerObject> = {
+export type ServerEvents = {
     /**
-     * Add a new server to the document
+     * Add a new blank server to the document
      */
-    'add:server': {
-        /** The new server payload to add */
-        server: ServerObject;
-    };
+    'server:add:server': undefined;
     /**
-     * Delete a server from the document
+     * Update the entire server object
      */
-    'delete:server': {
-        /** The URL of the server to delete */
-        url: string;
+    'server:update:server': {
+        /** The index of the server to update */
+        index: number;
+        /** The new server payload to update */
+        server: Partial<ServerObject>;
     };
     /**
-     * Update the selected server via URL
+     * Delete a server from the document
      */
-    'update:selected-server': {
-        /** The new selected server URL */
-        url: string;
+    'server:delete:server': {
+        /** The index of the server to delete */
+        index: number;
     };
     /**
      * Update the selected server variable for the document
      */
-    'update:selected-server-variables': {
+    'server:update:variables': {
+        /** The index of the server to update */
+        index: number;
         /** The key of the variable to update */
         key: string;
         /** The new value of the variable */
         value: string;
     };
     /**
-     * Update the selected server properties for the document
-     */
-    'update:selected-server-properties': {
-        /** The key of the property to update */
-        key: T;
-        /** The new value of the property */
-        value: ServerObject[T];
-    };
-    /**
-     * Replace all servers in the document
+     * Update the selected server for the document
      */
-    'update:all-servers': {
-        /** The new servers to replace the current servers with */
-        servers: ServerObject[];
+    'server:update:selected': {
+        /** The index of the server to update */
+        index: number;
     };
 };
 //# sourceMappingURL=server.d.ts.map

package/dist/events/definitions/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,IAAI;IAC5E;;OAEG;IACH,YAAY,EAAE;QACZ,oCAAoC;QACpC,MAAM,EAAE,YAAY,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,eAAe,EAAE;QACf,sCAAsC;QACtC,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD;;OAEG;IACH,wBAAwB,EAAE;QACxB,kCAAkC;QAClC,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD;;OAEG;IACH,kCAAkC,EAAE;QAClC,wCAAwC;QACxC,GAAG,EAAE,MAAM,CAAA;QACX,oCAAoC;QACpC,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;OAEG;IACH,mCAAmC,EAAE;QACnC,wCAAwC;QACxC,GAAG,EAAE,CAAC,CAAA;QACN,oCAAoC;QACpC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;KACvB,CAAA;IACD;;OAEG;IACH,oBAAoB,EAAE;QACpB,0DAA0D;QAC1D,OAAO,EAAE,YAAY,EAAE,CAAA;KACxB,CAAA;CACF,CAAA"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,mBAAmB,EAAE,SAAS,CAAA;IAC9B;;OAEG;IACH,sBAAsB,EAAE;QACtB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAA;QACb,uCAAuC;QACvC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;KAC9B,CAAA;IACD;;OAEG;IACH,sBAAsB,EAAE;QACtB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;OAEG;IACH,yBAAyB,EAAE;QACzB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAA;QACb,wCAAwC;QACxC,GAAG,EAAE,MAAM,CAAA;QACX,oCAAoC;QACpC,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;OAEG;IACH,wBAAwB,EAAE;QACxB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA"}

package/dist/events/index.d.ts

@@ -1,5 +1,5 @@
 export { type WorkspaceEventBus, createWorkspaceEventBus } from './bus.js';
-export type { CollectionType } from './definitions/index.js';
+export type { ApiReferenceEvents, CollectionType } from './definitions/index.js';
 export { onCustomEvent } from './listeners.js';
-export { type ApiReferenceEvent, type ApiReferenceEvents, emitCustomEvent } from './old-definitions.js';
+export { emitCustomEvent } from './old-definitions.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/events/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,OAAO,CAAA;AACvE,YAAY,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,kBAAkB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,OAAO,CAAA;AACvE,YAAY,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/events/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/events/index.ts"],
-  "sourcesContent": ["// biome-ignore lint/performance/noBarrelFile: Entry point for /events\nexport { type WorkspaceEventBus, createWorkspaceEventBus } from './bus'\nexport type { CollectionType } from './definitions'\nexport { onCustomEvent } from './listeners'\nexport { type ApiReferenceEvent, type ApiReferenceEvents, emitCustomEvent } from './old-definitions'\n"],
-  "mappings": "AACA,SAAiC,+BAA+B;AAEhE,SAAS,qBAAqB;AAC9B,SAA0D,uBAAuB;",
+  "sourcesContent": ["// biome-ignore lint/performance/noBarrelFile: Entry point for /events\nexport { type WorkspaceEventBus, createWorkspaceEventBus } from './bus'\nexport type { ApiReferenceEvents, CollectionType } from './definitions'\nexport { onCustomEvent } from './listeners'\nexport { emitCustomEvent } from './old-definitions'\n"],
+  "mappings": "AACA,SAAiC,+BAA+B;AAEhE,SAAS,qBAAqB;AAC9B,SAAS,uBAAuB;",
   "names": []
 }

package/dist/mutators/auth.d.ts

@@ -1,7 +1,6 @@
 import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { AuthEvents } from '../events/definitions/auth.js';
 import type { WorkspaceDocument } from '../schemas.js';
-import type { SecurityRequirementObject } from '../schemas/v3.1/strict/security-requirement.js';
-import type { SecuritySchemeObject } from '../schemas/v3.1/strict/security-scheme.js';
 /**
  * AuthMeta defines the meta information needed to specify whether the authentication operation
  * is being performed at the document level (entire API), or for a specific operation (specific path and method).
@@ -40,52 +39,7 @@ export type AuthMeta = {
  * })
  * ```
  */
-export declare const updateSelectedSecuritySchemes: ({ document, selectedRequirements, newSchemes, meta, }: {
-    document: WorkspaceDocument | null;
-    selectedRequirements: SecurityRequirementObject[];
-    newSchemes: {
-        name: string;
-        scheme: SecuritySchemeObject;
-    }[];
-    meta: AuthMeta;
-}) => void;
-/**
- * SecuritySchemeUpdate represents the possible updates that can be made
- * to an OpenAPI security scheme object via UI interactions.
- *
- * - `http`: Updates to HTTP type schemes (e.g. basic, bearer), allowing token, username, and password changes.
- * - `apiKey`: Updates to API Key type schemes, allowing the key name and its value to be updated.
- * - `oauth2`: Updates to OAuth2 type schemes for each supported OAuth2 flow.
- *    - Can set various properties such as auth/token URLs, tokens, PKCE method, client credentials, etc.
- */
-export type SecuritySchemeUpdate = {
-    type: 'http';
-    payload: Partial<{
-        token: string;
-        username: string;
-        password: string;
-    }>;
-} | {
-    type: 'apiKey';
-    payload: Partial<{
-        name: string;
-        value: string;
-    }>;
-} | {
-    type: 'oauth2';
-    flow: 'implicit' | 'password' | 'clientCredentials' | 'authorizationCode';
-    payload: Partial<{
-        authUrl: string;
-        tokenUrl: string;
-        token: string;
-        redirectUrl: string;
-        clientId: string;
-        clientSecret: string;
-        usePkce: 'no' | 'SHA-256' | 'plain';
-        username: string;
-        password: string;
-    }>;
-};
+export declare const updateSelectedSecuritySchemes: (document: WorkspaceDocument | null, { selectedRequirements, newSchemes, meta }: AuthEvents["auth:update:selected-security-schemes"]) => void;
 /**
  * Updates a security scheme in the OpenAPI document's components object.
  * Handles updates for HTTP, API Key, and OAuth2 types, saving secret information and configuration for UI-auth flows.
@@ -109,15 +63,11 @@ export type SecuritySchemeUpdate = {
  *   name: 'MyHttpAuth',
  * })
  */
-export declare const updateSecurityScheme: ({ document, data, name, }: {
-    document: WorkspaceDocument | null;
-    data: SecuritySchemeUpdate;
-    name: string;
-}) => void;
+export declare const updateSecurityScheme: (document: WorkspaceDocument | null, { payload, name }: AuthEvents["auth:update:security-scheme"]) => import("../schemas/v3.1/strict/security-scheme.js").ApiKeyObject | import("../schemas/v3.1/strict/security-scheme.js").HttpObject | import("../schemas/v3.1/strict/security-scheme.js").OAuth2Object | import("../schemas/v3.1/strict/security-scheme.js").OpenIdConnectObject | undefined;
 /**
  * Sets the selected authentication tab (scheme) index for the given OpenAPI document or operation.
- * - When on the document level, updates the 'x-selected-index' on the document's x-scalar-selected-security extension.
- * - When on an operation (endpoint) level, updates the 'x-selected-index' for that operation's x-scalar-selected-security.
+ * - When on the document level, updates the 'selectedIndex' on the document's x-scalar-selected-security extension.
+ * - When on an operation (endpoint) level, updates the 'selectedIndex' for that operation's x-scalar-selected-security.
  *
  * Also initializes the x-scalar-selected-security extension if it does not exist.
  *
@@ -140,11 +90,7 @@ export declare const updateSecurityScheme: ({ document, data, name, }: {
  *   meta: { type: 'operation', path: '/pets', method: 'get' }
  * });
  */
-export declare const updateSelectedAuthTab: ({ document, index, meta, }: {
-    document: WorkspaceDocument | null;
-    index: number;
-    meta: AuthMeta;
-}) => void;
+export declare const updateSelectedAuthTab: (document: WorkspaceDocument | null, { index, meta }: AuthEvents["auth:update:active-index"]) => void;
 /**
  * Updates the scopes for a specific security requirement in the selected security schemes of
  * a document or operation.
@@ -160,8 +106,8 @@ export declare const updateSelectedAuthTab: ({ document, index, meta, }: {
  * ```ts
  * // Suppose your document (or operation) x-scalar-selected-security looks like:
  * // "x-scalar-selected-security": {
- * //   "x-selected-index": 0,
- * //   "x-schemes": [
+ * //   selectedIndex: 0,
+ * //   selectedSchemes: [
  * //     { "OAuth": ["read:pets"] },
  * //     { "ApiKeyAuth": [] }
  * //   ]
@@ -177,13 +123,7 @@ export declare const updateSelectedAuthTab: ({ document, index, meta, }: {
  * // After, the first scheme becomes: { "OAuth": ["write:pets"] }
  * ```
  */
-export declare const updateSelectedScopes: ({ document, id, name, scopes, meta, }: {
-    document: WorkspaceDocument | null;
-    id: string[];
-    name: string;
-    scopes: string[];
-    meta: AuthMeta;
-}) => void;
+export declare const updateSelectedScopes: (document: WorkspaceDocument | null, { id, name, scopes, meta }: AuthEvents["auth:update:selected-scopes"]) => void;
 /**
  * Deletes one or more security schemes from an OpenAPI WorkspaceDocument,
  * and removes all references to those schemes from selected security, document-level security,
@@ -203,8 +143,5 @@ export declare const updateSelectedScopes: ({ document, id, name, scopes, meta,
  * - All document-level and operation-level security entries referencing those schemes are removed.
  * - Any extended x-scalar-selected-security references to those schemes are also removed.
  */
-export declare const deleteSecurityScheme: ({ document, names }: {
-    document: WorkspaceDocument | null;
-    names: string[];
-}) => void;
+export declare const deleteSecurityScheme: (document: WorkspaceDocument | null, { names }: AuthEvents["auth:delete:security-scheme"]) => void;
 //# sourceMappingURL=auth.d.ts.map

package/dist/mutators/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/mutators/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAInE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAA;AAC3F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAA;AAEjF;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAChB;IACE,IAAI,EAAE,UAAU,CAAA;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;CACnB,CAAA;AAEL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,6BAA6B,GAAI,uDAK3C;IACD,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,oBAAoB,EAAE,yBAAyB,EAAE,CAAA;IACjD,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,oBAAoB,CAAA;KAAE,EAAE,CAAA;IAC5D,IAAI,EAAE,QAAQ,CAAA;CACf,SA4EA,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAC;QACf,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAC,CAAA;CACH,GACD;IACE,IAAI,EAAE,QAAQ,CAAA;IACd,OAAO,EAAE,OAAO,CAAC;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;KACd,CAAC,CAAA;CACH,GACD;IACE,IAAI,EAAE,QAAQ,CAAA;IACd,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,mBAAmB,GAAG,mBAAmB,CAAA;IACzE,OAAO,EAAE,OAAO,CAAC;QACf,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,EAAE,MAAM,CAAA;QACnB,QAAQ,EAAE,MAAM,CAAA;QAChB,YAAY,EAAE,MAAM,CAAA;QACpB,OAAO,EAAE,IAAI,GAAG,SAAS,GAAG,OAAO,CAAA;QACnC,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAC,CAAA;CACH,CAAA;AAEL;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,oBAAoB,GAAI,2BAIlC;IACD,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,IAAI,EAAE,oBAAoB,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb,SAwEA,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,qBAAqB,GAAI,4BAInC;IACD,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,QAAQ,CAAA;CACf,SA8BA,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,oBAAoB,GAAI,uCAMlC;IACD,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,EAAE,EAAE,MAAM,EAAE,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,IAAI,EAAE,QAAQ,CAAA;CACf,SAoCA,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,oBAAoB,GAAI,qBAAqB;IAAE,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,SA4DhH,CAAA"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/mutators/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAI3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAGlD;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAChB;IACE,IAAI,EAAE,UAAU,CAAA;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;CACnB,CAAA;AAEL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,6BAA6B,GACxC,UAAU,iBAAiB,GAAG,IAAI,EAClC,4CAA4C,UAAU,CAAC,uCAAuC,CAAC,SA6EhG,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,oBAAoB,GAC/B,UAAU,iBAAiB,GAAG,IAAI,EAClC,mBAAmB,UAAU,CAAC,6BAA6B,CAAC,mRAc7D,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,qBAAqB,GAChC,UAAU,iBAAiB,GAAG,IAAI,EAClC,iBAAiB,UAAU,CAAC,0BAA0B,CAAC,SA+BxD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,oBAAoB,GAC/B,UAAU,iBAAiB,GAAG,IAAI,EAClC,4BAA4B,UAAU,CAAC,6BAA6B,CAAC,SAqCtE,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,oBAAoB,GAC/B,UAAU,iBAAiB,GAAG,IAAI,EAClC,WAAW,UAAU,CAAC,6BAA6B,CAAC,SA6DrD,CAAA"}

package/dist/mutators/auth.js

@@ -1,11 +1,7 @@
 import { generateUniqueValue } from "../helpers/generate-unique-value.js";
 import { getResolvedRef } from "../helpers/get-resolved-ref.js";
-const updateSelectedSecuritySchemes = ({
-  document,
-  selectedRequirements,
-  newSchemes,
-  meta
-}) => {
+import { mergeObjects } from "../helpers/merge-object.js";
+const updateSelectedSecuritySchemes = (document, { selectedRequirements, newSchemes, meta }) => {
   if (!document) {
     return;
   }
@@ -42,88 +38,31 @@ const updateSelectedSecuritySchemes = ({
   }
   if (!target["x-scalar-selected-security"]) {
     target["x-scalar-selected-security"] = {
-      "x-selected-index": -1,
-      "x-schemes": []
+      selectedIndex: -1,
+      selectedSchemes: []
     };
   }
-  const selectedIndex = target["x-scalar-selected-security"]["x-selected-index"];
-  target["x-scalar-selected-security"]["x-schemes"] = newSelectedSecuritySchemes;
+  const selectedIndex = target["x-scalar-selected-security"].selectedIndex;
+  target["x-scalar-selected-security"].selectedSchemes = newSelectedSecuritySchemes;
   if (newSelectedSecuritySchemes.length > 0 && selectedIndex < 0) {
-    target["x-scalar-selected-security"]["x-selected-index"] = 0;
+    target["x-scalar-selected-security"].selectedIndex = 0;
   }
   if (selectedIndex >= newSelectedSecuritySchemes.length) {
-    target["x-scalar-selected-security"]["x-selected-index"] = newSelectedSecuritySchemes.length - 1;
+    target["x-scalar-selected-security"].selectedIndex = newSelectedSecuritySchemes.length - 1;
   }
 };
-const updateSecurityScheme = ({
-  document,
-  data,
-  name
-}) => {
-  if (!document) {
-    return;
-  }
-  const target = getResolvedRef(document.components?.securitySchemes?.[name]);
+const updateSecurityScheme = (document, { payload, name }) => {
+  const target = getResolvedRef(document?.components?.securitySchemes?.[name]);
   if (!target) {
+    console.error(`Security scheme ${name} not found`);
     return;
   }
-  if (target.type === "http" && data.type === "http") {
-    if (data.payload.username) {
-      target["x-scalar-secret-username"] = data.payload.username;
-    }
-    if (data.payload.password) {
-      target["x-scalar-secret-password"] = data.payload.password;
-    }
-    if (data.payload.token) {
-      target["x-scalar-secret-token"] = data.payload.token;
-    }
-  } else if (target.type === "apiKey" && data.type === "apiKey") {
-    if (data.payload.name) {
-      target.name = data.payload.name;
-    }
-    if (data.payload.value) {
-      target["x-scalar-secret-token"] = data.payload.value;
-    }
-  } else if (target.type === "oauth2" && data.type === "oauth2") {
-    const flow = target.flows[data.flow];
-    if (!flow) {
-      return;
-    }
-    if (data.payload.authUrl && "authorizationUrl" in flow) {
-      flow.authorizationUrl = data.payload.authUrl;
-    }
-    if (data.payload.tokenUrl && "tokenUrl" in flow) {
-      flow.tokenUrl = data.payload.tokenUrl;
-    }
-    if (data.payload.token && "x-scalar-secret-token" in flow) {
-      flow["x-scalar-secret-token"] = data.payload.token;
-    }
-    if (data.payload.redirectUrl && "x-scalar-secret-redirect-uri" in flow) {
-      flow["x-scalar-secret-redirect-uri"] = data.payload.redirectUrl;
-    }
-    if (data.payload.clientId && "x-scalar-secret-client-id" in flow) {
-      flow["x-scalar-secret-client-id"] = data.payload.clientId;
-    }
-    if (data.payload.clientSecret && "x-scalar-secret-client-secret" in flow) {
-      flow["x-scalar-secret-client-secret"] = data.payload.clientSecret;
-    }
-    if (data.payload.usePkce && "x-usePkce" in flow) {
-      flow["x-usePkce"] = data.payload.usePkce;
-    }
-    if (data.payload.username && "x-scalar-secret-username" in flow) {
-      flow["x-scalar-secret-username"] = data.payload.username;
-    }
-    if (data.payload.password && "x-scalar-secret-password" in flow) {
-      flow["x-scalar-secret-password"] = data.payload.password;
-    }
+  if (target.type === payload.type) {
+    mergeObjects(target, payload);
   }
-  return;
+  return target;
 };
-const updateSelectedAuthTab = ({
-  document,
-  index,
-  meta
-}) => {
+const updateSelectedAuthTab = (document, { index, meta }) => {
   if (!document) {
     return;
   }
@@ -139,19 +78,13 @@ const updateSelectedAuthTab = ({
   }
   if (!target["x-scalar-selected-security"]) {
     target["x-scalar-selected-security"] = {
-      "x-selected-index": 0,
-      "x-schemes": []
+      selectedIndex: 0,
+      selectedSchemes: []
     };
   }
-  target["x-scalar-selected-security"]["x-selected-index"] = index;
+  target["x-scalar-selected-security"].selectedIndex = index;
 };
-const updateSelectedScopes = ({
-  document,
-  id,
-  name,
-  scopes,
-  meta
-}) => {
+const updateSelectedScopes = (document, { id, name, scopes, meta }) => {
   if (!document) {
     return;
   }
@@ -165,7 +98,7 @@ const updateSelectedScopes = ({
   if (!target) {
     return;
   }
-  const selectedSchemes = target["x-scalar-selected-security"]?.["x-schemes"];
+  const selectedSchemes = target["x-scalar-selected-security"]?.selectedSchemes;
   if (!selectedSchemes) {
     return;
   }
@@ -175,7 +108,7 @@ const updateSelectedScopes = ({
   }
   scheme[name] = scopes;
 };
-const deleteSecurityScheme = ({ document, names }) => {
+const deleteSecurityScheme = (document, { names }) => {
   if (!document) {
     return;
   }
@@ -191,7 +124,7 @@ const deleteSecurityScheme = ({ document, names }) => {
   };
   if (document["x-scalar-selected-security"]) {
     const selectedSecurity = document["x-scalar-selected-security"];
-    selectedSecurity["x-schemes"] = filterSecuritySchemes(selectedSecurity["x-schemes"]);
+    selectedSecurity.selectedSchemes = filterSecuritySchemes(selectedSecurity.selectedSchemes);
   }
   if (document["security"]) {
     document["security"] = filterSecuritySchemes(document["security"]);
@@ -206,8 +139,8 @@ const deleteSecurityScheme = ({ document, names }) => {
         resolvedOperation["security"] = filterSecuritySchemes(resolvedOperation["security"]);
       }
       if ("x-scalar-selected-security" in resolvedOperation && resolvedOperation["x-scalar-selected-security"]) {
-        resolvedOperation["x-scalar-selected-security"]["x-schemes"] = filterSecuritySchemes(
-          resolvedOperation["x-scalar-selected-security"]["x-schemes"]
+        resolvedOperation["x-scalar-selected-security"].selectedSchemes = filterSecuritySchemes(
+          resolvedOperation["x-scalar-selected-security"].selectedSchemes
         );
       }
     });