@scalar/workspace-store 0.40.2 → 0.40.3

package/dist/entities/auth/index.js

@@ -1,103 +1,98 @@
-import { preventPollution } from "@scalar/helpers/object/prevent-pollution";
-import { reactive } from "vue";
-import {
-  DocumentAuthSchema,
-  SecretsAuthUnionSchema
-} from "../../entities/auth/schema.js";
-import { safeAssign } from "../../helpers/general.js";
-import { unpackProxyObject } from "../../helpers/unpack-proxy.js";
-import { coerceValue } from "../../schemas/typebox-coerce.js";
-import {
-  AuthSchema,
-  OpenIDConnectSchema,
-  SecretsAuthSchema
-} from "./schema.js";
-const createAuthStore = ({ hooks } = {}) => {
-  const auth = reactive({});
-  const getAuthSecrets = (documentName, schemeName) => {
-    return auth[documentName]?.secrets?.[schemeName];
-  };
-  const setAuthSecrets = (documentName, schemeName, data) => {
-    auth[documentName] ||= { secrets: {}, selected: { document: void 0, path: void 0 } };
-    auth[documentName].secrets[schemeName] = coerceValue(SecretsAuthUnionSchema, data);
-    hooks?.onAuthChange?.(documentName);
-  };
-  const clearAuthSecrets = (documentName, schemeName) => {
-    delete auth[documentName]?.secrets?.[schemeName];
-    hooks?.onAuthChange?.(documentName);
-  };
-  const getAuthSelectedSchemas = (payload) => {
-    if (payload.type === "document") {
-      return auth[payload.documentName]?.selected?.document;
-    }
-    return auth[payload.documentName]?.selected?.path?.[payload.path]?.[payload.method];
-  };
-  const setAuthSelectedSchemas = (payload, selectedSchemes) => {
-    auth[payload.documentName] ||= {
-      secrets: {},
-      selected: { document: void 0, path: void 0 }
+import { preventPollution } from '@scalar/helpers/object/prevent-pollution';
+import { reactive } from 'vue';
+import { DocumentAuthSchema, SecretsAuthUnionSchema, } from '../../entities/auth/schema.js';
+import { safeAssign } from '../../helpers/general.js';
+import { unpackProxyObject } from '../../helpers/unpack-proxy.js';
+import { coerceValue } from '../../schemas/typebox-coerce.js';
+export { AuthSchema, OpenIDConnectSchema, SecretsAuthSchema, } from './schema.js';
+/**
+ * Factory function to create a new AuthStore instance.
+ */
+export const createAuthStore = ({ hooks } = {}) => {
+    // Vue reactive object to hold all authentication state
+    const auth = reactive({});
+    const getAuthSecrets = (documentName, schemeName) => {
+        return auth[documentName]?.secrets?.[schemeName];
+    };
+    const setAuthSecrets = (documentName, schemeName, data) => {
+        auth[documentName] ||= { secrets: {}, selected: { document: undefined, path: undefined } };
+        auth[documentName].secrets[schemeName] = coerceValue(SecretsAuthUnionSchema, data);
+        hooks?.onAuthChange?.(documentName);
+    };
+    const clearAuthSecrets = (documentName, schemeName) => {
+        delete auth[documentName]?.secrets?.[schemeName];
+        hooks?.onAuthChange?.(documentName);
+    };
+    const getAuthSelectedSchemas = (payload) => {
+        if (payload.type === 'document') {
+            return auth[payload.documentName]?.selected?.document;
+        }
+        return auth[payload.documentName]?.selected?.path?.[payload.path]?.[payload.method];
+    };
+    const setAuthSelectedSchemas = (payload, selectedSchemes) => {
+        auth[payload.documentName] ||= {
+            secrets: {},
+            selected: { document: undefined, path: undefined },
+        };
+        // TypeScript needs a non-null assertion here since we just ensured it exists
+        const documentAuth = auth[payload.documentName];
+        if (payload.type === 'document') {
+            documentAuth.selected.document = selectedSchemes;
+        }
+        else {
+            // Prevent assigning dangerous keys to the path items object
+            preventPollution(payload.path);
+            preventPollution(payload.method);
+            documentAuth.selected.path ||= {};
+            documentAuth.selected.path[payload.path] ||= {};
+            const pathAuth = documentAuth.selected.path[payload.path];
+            pathAuth[payload.method] = selectedSchemes;
+        }
+        hooks?.onAuthChange?.(payload.documentName);
+    };
+    const clearAuthSelectedSchemas = (payload) => {
+        const documentAuth = auth[payload.documentName];
+        if (!documentAuth) {
+            return;
+        }
+        if (payload.type === 'document') {
+            delete documentAuth.selected.document;
+            hooks?.onAuthChange?.(payload.documentName);
+            return;
+        }
+        // Prevent altering dangerous keys to the path items object
+        preventPollution(payload.method);
+        preventPollution(payload.path);
+        const pathAuth = documentAuth.selected.path?.[payload.path];
+        if (!pathAuth) {
+            return;
+        }
+        delete pathAuth[payload.method];
+        hooks?.onAuthChange?.(payload.documentName);
+    };
+    const clearDocumentAuth = (documentName) => {
+        delete auth[documentName];
+        hooks?.onAuthChange?.(documentName);
+    };
+    const load = (data) => {
+        safeAssign(auth, coerceValue(DocumentAuthSchema, data));
+        // Trigger change events for all loaded documents
+        Object.keys(data).forEach((documentName) => {
+            hooks?.onAuthChange?.(documentName);
+        });
+    };
+    const exportAuth = () => {
+        return unpackProxyObject(auth);
+    };
+    return {
+        clearAuthSelectedSchemas,
+        getAuthSecrets,
+        setAuthSecrets,
+        clearAuthSecrets,
+        getAuthSelectedSchemas,
+        setAuthSelectedSchemas,
+        clearDocumentAuth,
+        load,
+        export: exportAuth,
     };
-    const documentAuth = auth[payload.documentName];
-    if (payload.type === "document") {
-      documentAuth.selected.document = selectedSchemes;
-    } else {
-      preventPollution(payload.path);
-      preventPollution(payload.method);
-      documentAuth.selected.path ||= {};
-      documentAuth.selected.path[payload.path] ||= {};
-      const pathAuth = documentAuth.selected.path[payload.path];
-      pathAuth[payload.method] = selectedSchemes;
-    }
-    hooks?.onAuthChange?.(payload.documentName);
-  };
-  const clearAuthSelectedSchemas = (payload) => {
-    const documentAuth = auth[payload.documentName];
-    if (!documentAuth) {
-      return;
-    }
-    if (payload.type === "document") {
-      delete documentAuth.selected.document;
-      hooks?.onAuthChange?.(payload.documentName);
-      return;
-    }
-    preventPollution(payload.method);
-    preventPollution(payload.path);
-    const pathAuth = documentAuth.selected.path?.[payload.path];
-    if (!pathAuth) {
-      return;
-    }
-    delete pathAuth[payload.method];
-    hooks?.onAuthChange?.(payload.documentName);
-  };
-  const clearDocumentAuth = (documentName) => {
-    delete auth[documentName];
-    hooks?.onAuthChange?.(documentName);
-  };
-  const load = (data) => {
-    safeAssign(auth, coerceValue(DocumentAuthSchema, data));
-    Object.keys(data).forEach((documentName) => {
-      hooks?.onAuthChange?.(documentName);
-    });
-  };
-  const exportAuth = () => {
-    return unpackProxyObject(auth);
-  };
-  return {
-    clearAuthSelectedSchemas,
-    getAuthSecrets,
-    setAuthSecrets,
-    clearAuthSecrets,
-    getAuthSelectedSchemas,
-    setAuthSelectedSchemas,
-    clearDocumentAuth,
-    load,
-    export: exportAuth
-  };
-};
-export {
-  AuthSchema,
-  OpenIDConnectSchema,
-  SecretsAuthSchema,
-  createAuthStore
 };
-//# sourceMappingURL=index.js.map

package/dist/entities/auth/schema.js

@@ -1,123 +1,49 @@
-import { Type } from "@scalar/typebox";
-import { compose } from "../../schemas/compose.js";
-import { XScalarCredentialsLocationSchema } from "../../schemas/extensions/security/x-scalar-credentials-location.js";
-import {
-  XScalarSecretClientIdSchema,
-  XScalarSecretClientSecretSchema,
-  XScalarSecretHTTPSchema,
-  XScalarSecretRefreshTokenSchema,
-  XScalarSecretRedirectUriSchema,
-  XScalarSecretTokenSchema
-} from "../../schemas/extensions/security/x-scalar-security-secrets.js";
-import {
-  OAuthFlowAuthorizationCodeSchema,
-  OAuthFlowClientCredentialsSchema,
-  OAuthFlowImplicitSchema,
-  OAuthFlowPasswordSchema
-} from "../../schemas/v3.1/strict/oauth-flow.js";
-import { SecurityRequirementObjectSchema } from "../../schemas/v3.1/strict/openapi-document.js";
-const SecretsApiKeySchema = compose(
-  Type.Object({
-    type: Type.Literal("apiKey")
-  }),
-  XScalarSecretTokenSchema
-);
-const SecretsHttpSchema = compose(
-  Type.Object({
-    type: Type.Literal("http")
-  }),
-  XScalarSecretTokenSchema,
-  XScalarSecretHTTPSchema
-);
-const SecretsOAuthFlowCommonSchema = compose(
-  XScalarSecretClientIdSchema,
-  XScalarSecretTokenSchema,
-  XScalarSecretRefreshTokenSchema
-);
+import { Type } from '@scalar/typebox';
+import { compose } from '../../schemas/compose.js';
+import { XScalarCredentialsLocationSchema } from '../../schemas/extensions/security/x-scalar-credentials-location.js';
+import { XScalarSecretClientIdSchema, XScalarSecretClientSecretSchema, XScalarSecretHTTPSchema, XScalarSecretRefreshTokenSchema, XScalarSecretRedirectUriSchema, XScalarSecretTokenSchema, } from '../../schemas/extensions/security/x-scalar-security-secrets.js';
+import { OAuthFlowAuthorizationCodeSchema, OAuthFlowClientCredentialsSchema, OAuthFlowImplicitSchema, OAuthFlowPasswordSchema, } from '../../schemas/v3.1/strict/oauth-flow.js';
+import { SecurityRequirementObjectSchema } from '../../schemas/v3.1/strict/openapi-document.js';
+const SecretsApiKeySchema = compose(Type.Object({
+    type: Type.Literal('apiKey'),
+}), XScalarSecretTokenSchema);
+const SecretsHttpSchema = compose(Type.Object({
+    type: Type.Literal('http'),
+}), XScalarSecretTokenSchema, XScalarSecretHTTPSchema);
+const SecretsOAuthFlowCommonSchema = compose(XScalarSecretClientIdSchema, XScalarSecretTokenSchema, XScalarSecretRefreshTokenSchema);
 const SecretsOAuthFlowsSchema = Type.Object({
-  implicit: Type.Optional(compose(SecretsOAuthFlowCommonSchema, XScalarSecretRedirectUriSchema)),
-  password: Type.Optional(
-    compose(
-      SecretsOAuthFlowCommonSchema,
-      XScalarSecretHTTPSchema,
-      XScalarSecretClientSecretSchema,
-      XScalarCredentialsLocationSchema
-    )
-  ),
-  clientCredentials: Type.Optional(
-    compose(SecretsOAuthFlowCommonSchema, XScalarSecretClientSecretSchema, XScalarCredentialsLocationSchema)
-  ),
-  authorizationCode: Type.Optional(
-    compose(
-      SecretsOAuthFlowCommonSchema,
-      XScalarSecretClientSecretSchema,
-      XScalarSecretRedirectUriSchema,
-      XScalarCredentialsLocationSchema
-    )
-  )
+    implicit: Type.Optional(compose(SecretsOAuthFlowCommonSchema, XScalarSecretRedirectUriSchema)),
+    password: Type.Optional(compose(SecretsOAuthFlowCommonSchema, XScalarSecretHTTPSchema, XScalarSecretClientSecretSchema, XScalarCredentialsLocationSchema)),
+    clientCredentials: Type.Optional(compose(SecretsOAuthFlowCommonSchema, XScalarSecretClientSecretSchema, XScalarCredentialsLocationSchema)),
+    authorizationCode: Type.Optional(compose(SecretsOAuthFlowCommonSchema, XScalarSecretClientSecretSchema, XScalarSecretRedirectUriSchema, XScalarCredentialsLocationSchema)),
 });
-const OAuthSchema = compose(
-  Type.Object({
-    type: Type.Literal("oauth2")
-  }),
-  SecretsOAuthFlowsSchema
-);
-const OpenIDConnectSchema = Type.Object({
-  type: Type.Literal("openIdConnect"),
-  implicit: Type.Optional(
-    compose(OAuthFlowImplicitSchema, SecretsOAuthFlowCommonSchema, XScalarSecretRedirectUriSchema)
-  ),
-  password: Type.Optional(
-    compose(
-      OAuthFlowPasswordSchema,
-      SecretsOAuthFlowCommonSchema,
-      XScalarSecretHTTPSchema,
-      XScalarSecretClientSecretSchema,
-      XScalarCredentialsLocationSchema
-    )
-  ),
-  clientCredentials: Type.Optional(
-    compose(
-      OAuthFlowClientCredentialsSchema,
-      SecretsOAuthFlowCommonSchema,
-      XScalarSecretClientSecretSchema,
-      XScalarCredentialsLocationSchema
-    )
-  ),
-  authorizationCode: Type.Optional(
-    compose(
-      OAuthFlowAuthorizationCodeSchema,
-      SecretsOAuthFlowCommonSchema,
-      XScalarSecretClientSecretSchema,
-      XScalarSecretRedirectUriSchema,
-      XScalarCredentialsLocationSchema
-    )
-  )
+const OAuthSchema = compose(Type.Object({
+    type: Type.Literal('oauth2'),
+}), SecretsOAuthFlowsSchema);
+/** OpenID Connect schema contain the base flows as well since it doesn't exist in the spec */
+export const OpenIDConnectSchema = Type.Object({
+    type: Type.Literal('openIdConnect'),
+    implicit: Type.Optional(compose(OAuthFlowImplicitSchema, SecretsOAuthFlowCommonSchema, XScalarSecretRedirectUriSchema)),
+    password: Type.Optional(compose(OAuthFlowPasswordSchema, SecretsOAuthFlowCommonSchema, XScalarSecretHTTPSchema, XScalarSecretClientSecretSchema, XScalarCredentialsLocationSchema)),
+    clientCredentials: Type.Optional(compose(OAuthFlowClientCredentialsSchema, SecretsOAuthFlowCommonSchema, XScalarSecretClientSecretSchema, XScalarCredentialsLocationSchema)),
+    authorizationCode: Type.Optional(compose(OAuthFlowAuthorizationCodeSchema, SecretsOAuthFlowCommonSchema, XScalarSecretClientSecretSchema, XScalarSecretRedirectUriSchema, XScalarCredentialsLocationSchema)),
 });
-const SecretsAuthUnionSchema = Type.Union([
-  SecretsApiKeySchema,
-  SecretsHttpSchema,
-  OAuthSchema,
-  OpenIDConnectSchema
+export const SecretsAuthUnionSchema = Type.Union([
+    SecretsApiKeySchema,
+    SecretsHttpSchema,
+    OAuthSchema,
+    OpenIDConnectSchema,
 ]);
-const SecretsAuthSchema = Type.Record(Type.String(), SecretsAuthUnionSchema);
+export const SecretsAuthSchema = Type.Record(Type.String(), SecretsAuthUnionSchema);
 const SelectedSecuritySchema = Type.Object({
-  selectedIndex: Type.Number(),
-  selectedSchemes: Type.Array(SecurityRequirementObjectSchema)
+    selectedIndex: Type.Number(),
+    selectedSchemes: Type.Array(SecurityRequirementObjectSchema),
 });
-const AuthSchema = Type.Object({
-  secrets: SecretsAuthSchema,
-  selected: Type.Object({
-    document: Type.Optional(SelectedSecuritySchema),
-    path: Type.Optional(Type.Record(Type.String(), Type.Record(Type.String(), Type.Optional(SelectedSecuritySchema))))
-  })
+export const AuthSchema = Type.Object({
+    secrets: SecretsAuthSchema,
+    selected: Type.Object({
+        document: Type.Optional(SelectedSecuritySchema),
+        path: Type.Optional(Type.Record(Type.String(), Type.Record(Type.String(), Type.Optional(SelectedSecuritySchema)))),
+    }),
 });
-const DocumentAuthSchema = Type.Record(Type.String(), AuthSchema);
-export {
-  AuthSchema,
-  DocumentAuthSchema,
-  OpenIDConnectSchema,
-  SecretsAuthSchema,
-  SecretsAuthUnionSchema
-};
-//# sourceMappingURL=schema.js.map
+export const DocumentAuthSchema = Type.Record(Type.String(), AuthSchema);

package/dist/entities/history/index.js

@@ -1,62 +1,82 @@
-import { reactive } from "vue";
-import { DocumentHistorySchema } from "../../entities/history/schema.js";
-import { safeAssign } from "../../helpers/general.js";
-import { unpackProxyObject } from "../../helpers/unpack-proxy.js";
-import { coerceValue } from "../../schemas/typebox-coerce.js";
+import { reactive } from 'vue';
+import { DocumentHistorySchema } from '../../entities/history/schema.js';
+import { safeAssign } from '../../helpers/general.js';
+import { unpackProxyObject } from '../../helpers/unpack-proxy.js';
+import { coerceValue } from '../../schemas/typebox-coerce.js';
 const HISTORY_LIMIT = 5;
-const createHistoryStore = ({
-  hooks
-}) => {
-  const history = reactive({});
-  const getHistory = (documentName, path, method) => {
-    return history[documentName]?.[path]?.[method];
-  };
-  const addHistory = (documentName, path, method, entry) => {
-    history[documentName] ||= {};
-    history[documentName][path] ||= {};
-    history[documentName][path][method] ||= [];
-    if (history[documentName][path][method].length >= HISTORY_LIMIT) {
-      history[documentName][path][method] = unpackProxyObject(
-        history[documentName][path][method].filter((_, i) => i !== 0),
-        { depth: 1 }
-      );
-    }
-    history[documentName][path][method].push(entry);
-    hooks?.onHistoryChange?.(documentName);
-  };
-  const clearOperationHistory = (documentName, path, method) => {
-    delete history[documentName]?.[path]?.[method];
-    hooks?.onHistoryChange?.(documentName);
-  };
-  const clearPathHistory = (documentName, path) => {
-    delete history[documentName]?.[path];
-    hooks?.onHistoryChange?.(documentName);
-  };
-  const clearDocumentHistory = (documentName) => {
-    delete history[documentName];
-    hooks?.onHistoryChange?.(documentName);
-  };
-  const load = (data) => {
-    const coercedData = coerceValue(DocumentHistorySchema, data);
-    safeAssign(history, coercedData);
-    Object.keys(coercedData).forEach((documentName) => {
-      hooks?.onHistoryChange?.(documentName);
-    });
-  };
-  const exportHistory = () => {
-    return unpackProxyObject(history);
-  };
-  return {
-    getHistory,
-    addHistory,
-    clearOperationHistory,
-    clearPathHistory,
-    clearDocumentHistory,
-    load,
-    export: exportHistory
-  };
+/**
+ * Creates a reactive history store for tracking request and response entries for documents and operations.
+ *
+ * @param hooks (Optional) - Lifecycle hooks for store events, such as onHistoryChange.
+ * @returns HistoryStore - Methods for interacting with the operation history.
+ *
+ * ## Example
+ * ```ts
+ * const historyStore = createHistoryStore({
+ *   hooks: {
+ *     onHistoryChange: (documentName, operationName, history) => {
+ *       console.log(`History changed for ${documentName}/${operationName}`, history)
+ *     }
+ *   }
+ * })
+ *
+ * // Add a history entry
+ * historyStore.addHistory('petstore.yaml', 'getPets', { ...entry })
+ *
+ * // Get history entries for an operation
+ * const entries = historyStore.getHistory('petstore.yaml', 'getPets')
+ * ```
+ */
+export const createHistoryStore = ({ hooks, }) => {
+    const history = reactive({});
+    const getHistory = (documentName, path, method) => {
+        return history[documentName]?.[path]?.[method];
+    };
+    const addHistory = (documentName, path, method, entry) => {
+        history[documentName] ||= {};
+        history[documentName][path] ||= {};
+        history[documentName][path][method] ||= [];
+        // We want to make sure that the history is not full
+        if (history[documentName][path][method].length >= HISTORY_LIMIT) {
+            // Delete the oldest entry
+            // We need to unpack the history array to avoid proxy object issues
+            history[documentName][path][method] = unpackProxyObject(history[documentName][path][method].filter((_, i) => i !== 0), { depth: 1 });
+        }
+        // Add the new entry to the history
+        history[documentName][path][method].push(entry);
+        // Explicitly trigger the change event once after all modifications
+        hooks?.onHistoryChange?.(documentName);
+    };
+    const clearOperationHistory = (documentName, path, method) => {
+        delete history[documentName]?.[path]?.[method];
+        hooks?.onHistoryChange?.(documentName);
+    };
+    const clearPathHistory = (documentName, path) => {
+        delete history[documentName]?.[path];
+        hooks?.onHistoryChange?.(documentName);
+    };
+    const clearDocumentHistory = (documentName) => {
+        delete history[documentName];
+        hooks?.onHistoryChange?.(documentName);
+    };
+    const load = (data) => {
+        const coercedData = coerceValue(DocumentHistorySchema, data);
+        safeAssign(history, coercedData);
+        // Trigger change events for all loaded documents
+        Object.keys(coercedData).forEach((documentName) => {
+            hooks?.onHistoryChange?.(documentName);
+        });
+    };
+    const exportHistory = () => {
+        return unpackProxyObject(history);
+    };
+    return {
+        getHistory,
+        addHistory,
+        clearOperationHistory,
+        clearPathHistory,
+        clearDocumentHistory,
+        load,
+        export: exportHistory,
+    };
 };
-export {
-  createHistoryStore
-};
-//# sourceMappingURL=index.js.map