@scalar/workspace-store 0.28.1 → 0.28.3

package/dist/entities/auth/index.js

@@ -0,0 +1,89 @@
+import { preventPollution } from "@scalar/helpers/object/prevent-pollution";
+import { reactive } from "vue";
+import {
+  DocumentAuthSchema,
+  SecretsAuthUnionSchema
+} from "../../entities/auth/schema.js";
+import { createDetectChangesProxy } from "../../helpers/detect-changes-proxy.js";
+import { safeAssign } from "../../helpers/general.js";
+import { unpackProxyObject } from "../../helpers/unpack-proxy.js";
+import { coerceValue } from "../../schemas/typebox-coerce.js";
+import {
+  AuthSchema,
+  SecretsAuthSchema
+} from "./schema.js";
+const createAuthStore = ({ hooks } = {}) => {
+  const auth = reactive(
+    createDetectChangesProxy(
+      {},
+      {
+        hooks: {
+          onAfterChange: (path) => {
+            if (path.length < 1) {
+              return;
+            }
+            const [documentName] = path;
+            if (typeof documentName !== "string") {
+              return;
+            }
+            hooks?.onAuthChange?.(documentName);
+          }
+        }
+      }
+    )
+  );
+  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);
+  };
+  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 }
+    };
+    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;
+    }
+  };
+  const clearDocumentAuth = (documentName) => {
+    delete auth[documentName];
+  };
+  const load = (data) => {
+    safeAssign(auth, coerceValue(DocumentAuthSchema, data));
+  };
+  const exportAuth = () => {
+    return unpackProxyObject(auth);
+  };
+  return {
+    getAuthSecrets,
+    setAuthSecrets,
+    getAuthSelectedSchemas,
+    setAuthSelectedSchemas,
+    clearDocumentAuth,
+    load,
+    export: exportAuth
+  };
+};
+export {
+  AuthSchema,
+  SecretsAuthSchema,
+  createAuthStore
+};
+//# sourceMappingURL=index.js.map

package/dist/entities/auth/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/entities/auth/index.ts"],
+  "sourcesContent": ["import { preventPollution } from '@scalar/helpers/object/prevent-pollution'\nimport { reactive } from 'vue'\n\nimport {\n  type DocumentAuth,\n  DocumentAuthSchema,\n  type SecretsAuthUnion,\n  SecretsAuthUnionSchema,\n  type SelectedSecurity,\n} from '@/entities/auth/schema'\nimport { createDetectChangesProxy } from '@/helpers/detect-changes-proxy'\nimport { safeAssign } from '@/helpers/general'\nimport { unpackProxyObject } from '@/helpers/unpack-proxy'\nimport { coerceValue } from '@/schemas/typebox-coerce'\n\nexport type {\n  Auth,\n  SecretsApiKey,\n  SecretsAuth,\n  SecretsAuthUnion,\n  SecretsHttp,\n  SecretsOAuth,\n  SecretsOAuthFlows,\n  SelectedSecurity,\n} from './schema'\nexport {\n  AuthSchema,\n  SecretsAuthSchema,\n} from './schema'\n\n/**\n * Interface for the AuthStore used to manage authentication secrets and selection state.\n */\nexport type AuthStore = {\n  /**\n   * Retrieves the authentication secrets for a given document and security scheme.\n   * @param documentName - Name/id of the OpenAPI document.\n   * @param schemeName - Name of the security scheme.\n   * @returns The authentication secrets, or undefined if not found.\n   */\n  getAuthSecrets: (documentName: string, schemeName: string) => SecretsAuthUnion | undefined\n\n  /**\n   * Retrieves the selected schemas for a given document or path.\n   * @param payload - The payload to get the selected schemas for.\n   * @returns The selected schemas, or undefined if not found.\n   */\n  getAuthSelectedSchemas: (\n    payload:\n      | { type: 'document'; documentName: string }\n      | { type: 'operation'; documentName: string; path: string; method: string },\n  ) => SelectedSecurity | undefined\n\n  /**\n   * Sets the selected schemas for a given document or path.\n   * @param payload - The payload to set the selected schemas for.\n   * @param selectedSchemes - The selected schemas to set.\n   */\n  setAuthSelectedSchemas: (\n    payload:\n      | { type: 'document'; documentName: string }\n      | { type: 'operation'; documentName: string; path: string; method: string },\n    selectedSchemes: SelectedSecurity,\n  ) => void\n  /**\n   * Sets the authentication secrets for a given document and security scheme.\n   * @param documentName - Name/id of the OpenAPI document.\n   * @param schemeName - Name of the security scheme.\n   * @param auth - The secret/auth object to set.\n   */\n  setAuthSecrets: (documentName: string, schemeName: string, auth: SecretsAuthUnion) => void\n\n  /**\n   * Removes the authentication data for a given document.\n   * @param documentName - Name/id of the OpenAPI document.\n   */\n  clearDocumentAuth: (documentName: string) => void\n\n  /**\n   * Loads authentication data into the store, replacing existing state.\n   * @param data - A DocumentAuth object.\n   */\n  load: (data: DocumentAuth) => void\n\n  /**\n   * Exports the current authentication state as a plain (non-proxy) DocumentAuth object.\n   * @returns The authentication state.\n   */\n  export: () => DocumentAuth\n}\n\ntype CreateAuthStoreOptions = {\n  hooks?: {\n    onAuthChange?: (documentName: string) => void\n  }\n}\n\n/**\n * Factory function to create a new AuthStore instance.\n */\nexport const createAuthStore = ({ hooks }: CreateAuthStoreOptions = {}): AuthStore => {\n  // Vue reactive object to hold all authentication state\n  const auth = reactive<DocumentAuth>(\n    createDetectChangesProxy(\n      {},\n      {\n        hooks: {\n          onAfterChange: (path) => {\n            if (path.length < 1) {\n              return\n            }\n            const [documentName] = path\n            if (typeof documentName !== 'string') {\n              return\n            }\n            hooks?.onAuthChange?.(documentName)\n          },\n        },\n      },\n    ),\n  )\n\n  const getAuthSecrets: AuthStore['getAuthSecrets'] = (documentName, schemeName) => {\n    return auth[documentName]?.secrets?.[schemeName]\n  }\n\n  const setAuthSecrets: AuthStore['setAuthSecrets'] = (documentName, schemeName, data) => {\n    auth[documentName] ||= { secrets: {}, selected: { document: undefined, path: undefined } }\n    auth[documentName].secrets[schemeName] = coerceValue(SecretsAuthUnionSchema, data)\n  }\n\n  const getAuthSelectedSchemas: AuthStore['getAuthSelectedSchemas'] = (payload) => {\n    if (payload.type === 'document') {\n      return auth[payload.documentName]?.selected?.document\n    }\n    return auth[payload.documentName]?.selected?.path?.[payload.path]?.[payload.method]\n  }\n\n  const setAuthSelectedSchemas: AuthStore['setAuthSelectedSchemas'] = (payload, selectedSchemes) => {\n    auth[payload.documentName] ||= {\n      secrets: {},\n      selected: { document: undefined, path: undefined },\n    }\n\n    // TypeScript needs a non-null assertion here since we just ensured it exists\n    const documentAuth = auth[payload.documentName]!\n\n    if (payload.type === 'document') {\n      documentAuth.selected.document = selectedSchemes\n    } else {\n      // Prevent assigning dangerous keys to the path items object\n      preventPollution(payload.path)\n      preventPollution(payload.method)\n\n      documentAuth.selected.path ||= {}\n      documentAuth.selected.path[payload.path] ||= {}\n      const pathAuth = documentAuth.selected.path[payload.path]!\n      pathAuth[payload.method] = selectedSchemes\n    }\n  }\n\n  const clearDocumentAuth: AuthStore['clearDocumentAuth'] = (documentName) => {\n    delete auth[documentName]\n  }\n\n  const load: AuthStore['load'] = (data) => {\n    safeAssign(auth, coerceValue(DocumentAuthSchema, data))\n  }\n\n  const exportAuth: AuthStore['export'] = () => {\n    return unpackProxyObject(auth)\n  }\n\n  return {\n    getAuthSecrets,\n    setAuthSecrets,\n    getAuthSelectedSchemas,\n    setAuthSelectedSchemas,\n    clearDocumentAuth,\n    load,\n    export: exportAuth,\n  }\n}\n"],
+  "mappings": "AAAA,SAAS,wBAAwB;AACjC,SAAS,gBAAgB;AAEzB;AAAA,EAEE;AAAA,EAEA;AAAA,OAEK;AACP,SAAS,gCAAgC;AACzC,SAAS,kBAAkB;AAC3B,SAAS,yBAAyB;AAClC,SAAS,mBAAmB;AAY5B;AAAA,EACE;AAAA,EACA;AAAA,OACK;AAwEA,MAAM,kBAAkB,CAAC,EAAE,MAAM,IAA4B,CAAC,MAAiB;AAEpF,QAAM,OAAO;AAAA,IACX;AAAA,MACE,CAAC;AAAA,MACD;AAAA,QACE,OAAO;AAAA,UACL,eAAe,CAAC,SAAS;AACvB,gBAAI,KAAK,SAAS,GAAG;AACnB;AAAA,YACF;AACA,kBAAM,CAAC,YAAY,IAAI;AACvB,gBAAI,OAAO,iBAAiB,UAAU;AACpC;AAAA,YACF;AACA,mBAAO,eAAe,YAAY;AAAA,UACpC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,QAAM,iBAA8C,CAAC,cAAc,eAAe;AAChF,WAAO,KAAK,YAAY,GAAG,UAAU,UAAU;AAAA,EACjD;AAEA,QAAM,iBAA8C,CAAC,cAAc,YAAY,SAAS;AACtF,SAAK,YAAY,MAAM,EAAE,SAAS,CAAC,GAAG,UAAU,EAAE,UAAU,QAAW,MAAM,OAAU,EAAE;AACzF,SAAK,YAAY,EAAE,QAAQ,UAAU,IAAI,YAAY,wBAAwB,IAAI;AAAA,EACnF;AAEA,QAAM,yBAA8D,CAAC,YAAY;AAC/E,QAAI,QAAQ,SAAS,YAAY;AAC/B,aAAO,KAAK,QAAQ,YAAY,GAAG,UAAU;AAAA,IAC/C;AACA,WAAO,KAAK,QAAQ,YAAY,GAAG,UAAU,OAAO,QAAQ,IAAI,IAAI,QAAQ,MAAM;AAAA,EACpF;AAEA,QAAM,yBAA8D,CAAC,SAAS,oBAAoB;AAChG,SAAK,QAAQ,YAAY,MAAM;AAAA,MAC7B,SAAS,CAAC;AAAA,MACV,UAAU,EAAE,UAAU,QAAW,MAAM,OAAU;AAAA,IACnD;AAGA,UAAM,eAAe,KAAK,QAAQ,YAAY;AAE9C,QAAI,QAAQ,SAAS,YAAY;AAC/B,mBAAa,SAAS,WAAW;AAAA,IACnC,OAAO;AAEL,uBAAiB,QAAQ,IAAI;AAC7B,uBAAiB,QAAQ,MAAM;AAE/B,mBAAa,SAAS,SAAS,CAAC;AAChC,mBAAa,SAAS,KAAK,QAAQ,IAAI,MAAM,CAAC;AAC9C,YAAM,WAAW,aAAa,SAAS,KAAK,QAAQ,IAAI;AACxD,eAAS,QAAQ,MAAM,IAAI;AAAA,IAC7B;AAAA,EACF;AAEA,QAAM,oBAAoD,CAAC,iBAAiB;AAC1E,WAAO,KAAK,YAAY;AAAA,EAC1B;AAEA,QAAM,OAA0B,CAAC,SAAS;AACxC,eAAW,MAAM,YAAY,oBAAoB,IAAI,CAAC;AAAA,EACxD;AAEA,QAAM,aAAkC,MAAM;AAC5C,WAAO,kBAAkB,IAAI;AAAA,EAC/B;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,QAAQ;AAAA,EACV;AACF;",
+  "names": []
+}