@scalar/api-reference 1.57.5 → 1.59.0

package/dist/plugins/persistance-plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"persistance-plugin.d.ts","sourceRoot":"","sources":["../../src/plugins/persistance-plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAA;AAI/E;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,kDAK/B;IACD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAChC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,CAAA;CACxC,KAAG,eAsDH,CAAA"}

package/dist/plugins/persistance-plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"persistance-plugin.js","names":[],"sources":["../../src/plugins/persistance-plugin.ts"],"sourcesContent":["import { debounce } from '@scalar/helpers/general/debounce'\nimport type { WorkspacePlugin } from '@scalar/workspace-store/workspace-plugin'\n\nimport { authStorage, clientStorage } from '@/helpers/storage'\n\n/**\n * Plugin to persist workspace state changes with debounced writes.\n */\nexport const persistencePlugin = ({\n  debounceDelay = 500,\n  maxWait = 10000,\n  prefix = '',\n  persistAuth = false,\n}: {\n  debounceDelay?: number\n  /** Maximum time in milliseconds to wait before forcing execution, even with continuous calls. */\n  maxWait?: number\n  /**\n   * Prefix to use for local storage keys.\n   * This can be a string or a function returning a string.\n   * For example, to persist data per document, use the document name as the prefix.\n   */\n  prefix?: string | (() => string)\n  /**\n   * Determines whether authentication details should be persisted.\n   * Accepts a boolean or a function that returns a boolean.\n   * Allows for conditional persistence logic, e.g., based on environment or user settings.\n   */\n  persistAuth?: boolean | (() => boolean)\n}): WorkspacePlugin => {\n  // Debounced execute function for batching similar state changes\n  const { execute } = debounce({ delay: debounceDelay, maxWait })\n  const authPersistence = authStorage()\n  const clientPersistence = clientStorage()\n\n  /**\n   * Resolves the prefix to use for local storage keys.\n   * If 'prefix' is a string, returns it directly.\n   * If 'prefix' is a function, calls and returns its value.\n   */\n  const getPrefix = () => {\n    if (typeof prefix === 'string') {\n      return prefix\n    }\n\n    return prefix()\n  }\n\n  const getPersistAuth = () => {\n    if (typeof persistAuth === 'function') {\n      return persistAuth()\n    }\n\n    return persistAuth\n  }\n\n  return {\n    hooks: {\n      /**\n       * Handles all workspace state change events.\n       * Each write is debounced by a key to prevent frequent writes for the same entity.\n       */\n      onWorkspaceStateChanges(event) {\n        // If the event is for workspace meta data, debounce by workspaceId\n        if (event.type === 'meta') {\n          // Persist the meta fields\n          const defaultClient = event.value['x-scalar-default-client']\n          if (defaultClient !== undefined) {\n            execute('x-scalar-default-client', () => clientPersistence.set(defaultClient))\n          }\n          return\n        }\n\n        // Persist auth and [server](TODO)\n        if (getPersistAuth() && event.type === 'auth') {\n          execute('auth', () => authPersistence.setAuth(getPrefix(), event.value))\n        }\n\n        // No action for other event types\n        return\n      },\n    },\n  }\n}\n"],"mappings":";;;;;;AAQA,IAAa,qBAAqB,EAChC,gBAAgB,KAChB,UAAU,KACV,SAAS,IACT,cAAc,YAiBO;CAErB,MAAM,EAAE,YAAY,SAAS;EAAE,OAAO;EAAe;EAAS,CAAC;CAC/D,MAAM,kBAAkB,aAAa;CACrC,MAAM,oBAAoB,eAAe;;;;;;CAOzC,MAAM,kBAAkB;AACtB,MAAI,OAAO,WAAW,SACpB,QAAO;AAGT,SAAO,QAAQ;;CAGjB,MAAM,uBAAuB;AAC3B,MAAI,OAAO,gBAAgB,WACzB,QAAO,aAAa;AAGtB,SAAO;;AAGT,QAAO,EACL,OAAO,EAKL,wBAAwB,OAAO;AAE7B,MAAI,MAAM,SAAS,QAAQ;GAEzB,MAAM,gBAAgB,MAAM,MAAM;AAClC,OAAI,kBAAkB,KAAA,EACpB,SAAQ,iCAAiC,kBAAkB,IAAI,cAAc,CAAC;AAEhF;;AAIF,MAAI,gBAAgB,IAAI,MAAM,SAAS,OACrC,SAAQ,cAAc,gBAAgB,QAAQ,WAAW,EAAE,MAAM,MAAM,CAAC;IAM7E,EACF"}