@backstage/backend-defaults 0.2.18 → 0.3.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @backstage/backend-defaults
 
+## 0.3.0-next.1
+
+### Minor Changes
+
+- 02103be: Deprecated and moved over core services to `@backstage/backend-defaults`
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-app-api@0.7.6-next.1
+  - @backstage/backend-plugin-api@0.6.19-next.1
+  - @backstage/plugin-permission-node@0.7.30-next.1
+  - @backstage/backend-common@0.23.0-next.1
+  - @backstage/config-loader@1.8.0
+  - @backstage/plugin-events-node@0.3.5-next.0
+
+## 0.2.19-next.0
+
+### Patch Changes
+
+- 6551b3d: Added core service factories and implementations from
+  `@backstage/backend-app-api`. They are now available as subpath exports, e.g.
+  `@backstage/backend-defaults/scheduler` is where the service factory and default
+  implementation of `coreServices.scheduler` now lives. They have been marked as
+  deprecated in their old locations.
+- Updated dependencies
+  - @backstage/backend-app-api@0.7.6-next.0
+  - @backstage/backend-common@0.22.1-next.0
+  - @backstage/plugin-events-node@0.3.5-next.0
+  - @backstage/backend-plugin-api@0.6.19-next.0
+  - @backstage/plugin-permission-node@0.7.30-next.0
+  - @backstage/config-loader@1.8.0
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
 ## 0.2.18
 
 ### Patch Changes

package/cache/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/backend-defaults",
+  "version": "0.3.0-next.1",
+  "main": "../dist/cache.cjs.js",
+  "types": "../dist/cache.d.ts"
+}

package/config.d.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Config {
+  /**
+   * Options used by the default discovery service.
+   */
+  discovery?: {
+    /**
+     * A list of target baseUrls and the associated plugins.
+     */
+    endpoints: Array<{
+      /**
+       * The target base URL to use for the plugin.
+       *
+       * Can be either a string or an object with internal and external keys.
+       * Targets with `{{pluginId}}` or `{{ pluginId }} in the URL will be replaced with the plugin ID.
+       */
+      target: string | { internal: string; external: string };
+      /**
+       * Array of plugins which use the target base URL.
+       */
+      plugins: string[];
+    }>;
+  };
+}

package/database/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/backend-defaults",
+  "version": "0.3.0-next.1",
+  "main": "../dist/database.cjs.js",
+  "types": "../dist/database.d.ts"
+}

package/discovery/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/backend-defaults",
+  "version": "0.3.0-next.1",
+  "main": "../dist/discovery.cjs.js",
+  "types": "../dist/discovery.d.ts"
+}

package/dist/cache.cjs.js

@@ -0,0 +1,193 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var Keyv = require('keyv');
+var crypto = require('crypto');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var Keyv__default = /*#__PURE__*/_interopDefaultCompat(Keyv);
+
+class DefaultCacheClient {
+  #client;
+  #clientFactory;
+  #options;
+  constructor(client, clientFactory, options) {
+    this.#client = client;
+    this.#clientFactory = clientFactory;
+    this.#options = options;
+  }
+  async get(key) {
+    const k = this.getNormalizedKey(key);
+    const value = await this.#client.get(k);
+    return value;
+  }
+  async set(key, value, opts = {}) {
+    const k = this.getNormalizedKey(key);
+    await this.#client.set(k, value, opts.ttl);
+  }
+  async delete(key) {
+    const k = this.getNormalizedKey(key);
+    await this.#client.delete(k);
+  }
+  withOptions(options) {
+    const newOptions = { ...this.#options, ...options };
+    return new DefaultCacheClient(
+      this.#clientFactory(newOptions),
+      this.#clientFactory,
+      newOptions
+    );
+  }
+  /**
+   * Ensures keys are well-formed for any/all cache stores.
+   */
+  getNormalizedKey(candidateKey) {
+    const wellFormedKey = Buffer.from(candidateKey).toString("base64");
+    if (wellFormedKey.length < 200) {
+      return wellFormedKey;
+    }
+    return crypto.createHash("sha256").update(candidateKey).digest("base64");
+  }
+}
+
+class CacheManager {
+  /**
+   * Keys represent supported `backend.cache.store` values, mapped to factories
+   * that return Keyv instances appropriate to the store.
+   */
+  storeFactories = {
+    redis: this.createRedisStoreFactory(),
+    memcache: this.createMemcacheStoreFactory(),
+    memory: this.createMemoryStoreFactory()
+  };
+  logger;
+  store;
+  connection;
+  useRedisSets;
+  errorHandler;
+  defaultTtl;
+  /**
+   * Creates a new {@link CacheManager} instance by reading from the `backend`
+   * config section, specifically the `.cache` key.
+   *
+   * @param config - The loaded application configuration.
+   */
+  static fromConfig(config, options = {}) {
+    const store = config.getOptionalString("backend.cache.store") || "memory";
+    const defaultTtl = config.getOptionalNumber("backend.cache.defaultTtl");
+    const connectionString = config.getOptionalString("backend.cache.connection") || "";
+    const useRedisSets = config.getOptionalBoolean("backend.cache.useRedisSets") ?? true;
+    const logger = options.logger?.child({
+      type: "cacheManager"
+    });
+    return new CacheManager(
+      store,
+      connectionString,
+      useRedisSets,
+      options.onError,
+      logger,
+      defaultTtl
+    );
+  }
+  /** @internal */
+  constructor(store, connectionString, useRedisSets, errorHandler, logger, defaultTtl) {
+    if (!this.storeFactories.hasOwnProperty(store)) {
+      throw new Error(`Unknown cache store: ${store}`);
+    }
+    this.logger = logger;
+    this.store = store;
+    this.connection = connectionString;
+    this.useRedisSets = useRedisSets;
+    this.errorHandler = errorHandler;
+    this.defaultTtl = defaultTtl;
+  }
+  /**
+   * Generates a PluginCacheManager for consumption by plugins.
+   *
+   * @param pluginId - The plugin that the cache manager should be created for.
+   *        Plugin names should be unique.
+   */
+  forPlugin(pluginId) {
+    return {
+      getClient: (defaultOptions = {}) => {
+        const clientFactory = (options) => {
+          const concreteClient = this.getClientWithTtl(
+            pluginId,
+            options.defaultTtl ?? this.defaultTtl
+          );
+          concreteClient.on("error", (err) => {
+            this.logger?.error("Failed to create cache client", err);
+            if (typeof this.errorHandler === "function") {
+              this.errorHandler(err);
+            }
+          });
+          return concreteClient;
+        };
+        return new DefaultCacheClient(
+          clientFactory(defaultOptions),
+          clientFactory,
+          defaultOptions
+        );
+      }
+    };
+  }
+  getClientWithTtl(pluginId, ttl) {
+    return this.storeFactories[this.store](pluginId, ttl);
+  }
+  createRedisStoreFactory() {
+    const KeyvRedis = require("@keyv/redis");
+    let store;
+    return (pluginId, defaultTtl) => {
+      if (!store) {
+        store = new KeyvRedis(this.connection);
+      }
+      return new Keyv__default.default({
+        namespace: pluginId,
+        ttl: defaultTtl,
+        store,
+        useRedisSets: this.useRedisSets
+      });
+    };
+  }
+  createMemcacheStoreFactory() {
+    const KeyvMemcache = require("@keyv/memcache");
+    let store;
+    return (pluginId, defaultTtl) => {
+      if (!store) {
+        store = new KeyvMemcache(this.connection);
+      }
+      return new Keyv__default.default({
+        namespace: pluginId,
+        ttl: defaultTtl,
+        store
+      });
+    };
+  }
+  createMemoryStoreFactory() {
+    const store = /* @__PURE__ */ new Map();
+    return (pluginId, defaultTtl) => new Keyv__default.default({
+      namespace: pluginId,
+      ttl: defaultTtl,
+      store
+    });
+  }
+}
+
+const cacheServiceFactory = backendPluginApi.createServiceFactory({
+  service: backendPluginApi.coreServices.cache,
+  deps: {
+    config: backendPluginApi.coreServices.rootConfig,
+    plugin: backendPluginApi.coreServices.pluginMetadata,
+    logger: backendPluginApi.coreServices.rootLogger
+  },
+  async createRootContext({ config, logger }) {
+    return CacheManager.fromConfig(config, { logger });
+  },
+  async factory({ plugin }, manager) {
+    return manager.forPlugin(plugin.getId()).getClient();
+  }
+});
+
+exports.CacheManager = CacheManager;
+exports.cacheServiceFactory = cacheServiceFactory;
+//# sourceMappingURL=cache.cjs.js.map

package/dist/cache.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.cjs.js","sources":["../src/entrypoints/cache/CacheClient.ts","../src/entrypoints/cache/CacheManager.ts","../src/entrypoints/cache/cacheServiceFactory.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  CacheService,\n  CacheServiceOptions,\n  CacheServiceSetOptions,\n} from '@backstage/backend-plugin-api';\nimport { JsonValue } from '@backstage/types';\nimport { createHash } from 'crypto';\nimport Keyv from 'keyv';\n\nexport type CacheClientFactory = (options: CacheServiceOptions) => Keyv;\n\n/**\n * A basic, concrete implementation of the CacheService, suitable for almost\n * all uses in Backstage.\n */\nexport class DefaultCacheClient implements CacheService {\n  #client: Keyv;\n  #clientFactory: CacheClientFactory;\n  #options: CacheServiceOptions;\n\n  constructor(\n    client: Keyv,\n    clientFactory: CacheClientFactory,\n    options: CacheServiceOptions,\n  ) {\n    this.#client = client;\n    this.#clientFactory = clientFactory;\n    this.#options = options;\n  }\n\n  async get<TValue extends JsonValue>(\n    key: string,\n  ): Promise<TValue | undefined> {\n    const k = this.getNormalizedKey(key);\n    const value = await this.#client.get(k);\n    return value as TValue | undefined;\n  }\n\n  async set(\n    key: string,\n    value: JsonValue,\n    opts: CacheServiceSetOptions = {},\n  ): Promise<void> {\n    const k = this.getNormalizedKey(key);\n    await this.#client.set(k, value, opts.ttl);\n  }\n\n  async delete(key: string): Promise<void> {\n    const k = this.getNormalizedKey(key);\n    await this.#client.delete(k);\n  }\n\n  withOptions(options: CacheServiceOptions): CacheService {\n    const newOptions = { ...this.#options, ...options };\n    return new DefaultCacheClient(\n      this.#clientFactory(newOptions),\n      this.#clientFactory,\n      newOptions,\n    );\n  }\n\n  /**\n   * Ensures keys are well-formed for any/all cache stores.\n   */\n  private getNormalizedKey(candidateKey: string): string {\n    // Remove potentially invalid characters.\n    const wellFormedKey = Buffer.from(candidateKey).toString('base64');\n\n    // Memcache in particular doesn't do well with keys > 250 bytes.\n    // Padded because a plugin ID is also prepended to the key.\n    if (wellFormedKey.length < 200) {\n      return wellFormedKey;\n    }\n\n    return createHash('sha256').update(candidateKey).digest('base64');\n  }\n}\n","/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  CacheService,\n  CacheServiceOptions,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport Keyv from 'keyv';\nimport { DefaultCacheClient } from './CacheClient';\nimport { CacheManagerOptions } from './types';\n\ntype StoreFactory = (pluginId: string, defaultTtl: number | undefined) => Keyv;\n\n/*\n * TODO(freben): This class intentionally inlines the CacheManagerOptions and\n * PluginCacheManager types, to not break the api reports in backend-common\n * which re-exports it. When backend-common is deprecated, we can stop inlining\n * those types.\n */\n\n/**\n * Implements a Cache Manager which will automatically create new cache clients\n * for plugins when requested. All requested cache clients are created with the\n * connection details provided.\n *\n * @public\n */\nexport class CacheManager {\n  /**\n   * Keys represent supported `backend.cache.store` values, mapped to factories\n   * that return Keyv instances appropriate to the store.\n   */\n  private readonly storeFactories = {\n    redis: this.createRedisStoreFactory(),\n    memcache: this.createMemcacheStoreFactory(),\n    memory: this.createMemoryStoreFactory(),\n  };\n\n  private readonly logger?: LoggerService;\n  private readonly store: keyof CacheManager['storeFactories'];\n  private readonly connection: string;\n  private readonly useRedisSets: boolean;\n  private readonly errorHandler: CacheManagerOptions['onError'];\n  private readonly defaultTtl?: number;\n\n  /**\n   * Creates a new {@link CacheManager} instance by reading from the `backend`\n   * config section, specifically the `.cache` key.\n   *\n   * @param config - The loaded application configuration.\n   */\n  static fromConfig(\n    config: Config,\n    options: {\n      /**\n       * An optional logger for use by the PluginCacheManager.\n       */\n      logger?: LoggerService;\n\n      /**\n       * An optional handler for connection errors emitted from the underlying data\n       * store.\n       */\n      onError?: (err: Error) => void;\n    } = {},\n  ): CacheManager {\n    // If no `backend.cache` config is provided, instantiate the CacheManager\n    // with an in-memory cache client.\n    const store = config.getOptionalString('backend.cache.store') || 'memory';\n    const defaultTtl = config.getOptionalNumber('backend.cache.defaultTtl');\n    const connectionString =\n      config.getOptionalString('backend.cache.connection') || '';\n    const useRedisSets =\n      config.getOptionalBoolean('backend.cache.useRedisSets') ?? true;\n    const logger = options.logger?.child({\n      type: 'cacheManager',\n    });\n    return new CacheManager(\n      store,\n      connectionString,\n      useRedisSets,\n      options.onError,\n      logger,\n      defaultTtl,\n    );\n  }\n\n  /** @internal */\n  constructor(\n    store: string,\n    connectionString: string,\n    useRedisSets: boolean,\n    errorHandler: CacheManagerOptions['onError'],\n    logger?: LoggerService,\n    defaultTtl?: number,\n  ) {\n    if (!this.storeFactories.hasOwnProperty(store)) {\n      throw new Error(`Unknown cache store: ${store}`);\n    }\n    this.logger = logger;\n    this.store = store as keyof CacheManager['storeFactories'];\n    this.connection = connectionString;\n    this.useRedisSets = useRedisSets;\n    this.errorHandler = errorHandler;\n    this.defaultTtl = defaultTtl;\n  }\n\n  /**\n   * Generates a PluginCacheManager for consumption by plugins.\n   *\n   * @param pluginId - The plugin that the cache manager should be created for.\n   *        Plugin names should be unique.\n   */\n  forPlugin(pluginId: string): {\n    getClient(options?: CacheServiceOptions): CacheService;\n  } {\n    return {\n      getClient: (defaultOptions = {}) => {\n        const clientFactory = (options: CacheServiceOptions) => {\n          const concreteClient = this.getClientWithTtl(\n            pluginId,\n            options.defaultTtl ?? this.defaultTtl,\n          );\n\n          // Always provide an error handler to avoid stopping the process.\n          concreteClient.on('error', (err: Error) => {\n            // In all cases, just log the error.\n            this.logger?.error('Failed to create cache client', err);\n\n            // Invoke any custom error handler if provided.\n            if (typeof this.errorHandler === 'function') {\n              this.errorHandler(err);\n            }\n          });\n\n          return concreteClient;\n        };\n\n        return new DefaultCacheClient(\n          clientFactory(defaultOptions),\n          clientFactory,\n          defaultOptions,\n        );\n      },\n    };\n  }\n\n  private getClientWithTtl(pluginId: string, ttl: number | undefined): Keyv {\n    return this.storeFactories[this.store](pluginId, ttl);\n  }\n\n  private createRedisStoreFactory(): StoreFactory {\n    const KeyvRedis = require('@keyv/redis');\n    let store: typeof KeyvRedis | undefined;\n    return (pluginId, defaultTtl) => {\n      if (!store) {\n        store = new KeyvRedis(this.connection);\n      }\n      return new Keyv({\n        namespace: pluginId,\n        ttl: defaultTtl,\n        store,\n        useRedisSets: this.useRedisSets,\n      });\n    };\n  }\n\n  private createMemcacheStoreFactory(): StoreFactory {\n    const KeyvMemcache = require('@keyv/memcache');\n    let store: typeof KeyvMemcache | undefined;\n    return (pluginId, defaultTtl) => {\n      if (!store) {\n        store = new KeyvMemcache(this.connection);\n      }\n      return new Keyv({\n        namespace: pluginId,\n        ttl: defaultTtl,\n        store,\n      });\n    };\n  }\n\n  private createMemoryStoreFactory(): StoreFactory {\n    const store = new Map();\n    return (pluginId, defaultTtl) =>\n      new Keyv({\n        namespace: pluginId,\n        ttl: defaultTtl,\n        store,\n      });\n  }\n}\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  coreServices,\n  createServiceFactory,\n} from '@backstage/backend-plugin-api';\nimport { CacheManager } from './CacheManager';\n\n/**\n * @public\n */\nexport const cacheServiceFactory = createServiceFactory({\n  service: coreServices.cache,\n  deps: {\n    config: coreServices.rootConfig,\n    plugin: coreServices.pluginMetadata,\n    logger: coreServices.rootLogger,\n  },\n  async createRootContext({ config, logger }) {\n    return CacheManager.fromConfig(config, { logger });\n  },\n  async factory({ plugin }, manager) {\n    return manager.forPlugin(plugin.getId()).getClient();\n  },\n});\n"],"names":["createHash","Keyv","createServiceFactory","coreServices"],"mappings":";;;;;;;;;;AA+BO,MAAM,kBAA2C,CAAA;AAAA,EACtD,OAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EAEA,WAAA,CACE,MACA,EAAA,aAAA,EACA,OACA,EAAA;AACA,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA,CAAA;AACtB,IAAA,IAAA,CAAK,QAAW,GAAA,OAAA,CAAA;AAAA,GAClB;AAAA,EAEA,MAAM,IACJ,GAC6B,EAAA;AAC7B,IAAM,MAAA,CAAA,GAAI,IAAK,CAAA,gBAAA,CAAiB,GAAG,CAAA,CAAA;AACnC,IAAA,MAAM,KAAQ,GAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,IAAI,CAAC,CAAA,CAAA;AACtC,IAAO,OAAA,KAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,GACJ,CAAA,GAAA,EACA,KACA,EAAA,IAAA,GAA+B,EAChB,EAAA;AACf,IAAM,MAAA,CAAA,GAAI,IAAK,CAAA,gBAAA,CAAiB,GAAG,CAAA,CAAA;AACnC,IAAA,MAAM,KAAK,OAAQ,CAAA,GAAA,CAAI,CAAG,EAAA,KAAA,EAAO,KAAK,GAAG,CAAA,CAAA;AAAA,GAC3C;AAAA,EAEA,MAAM,OAAO,GAA4B,EAAA;AACvC,IAAM,MAAA,CAAA,GAAI,IAAK,CAAA,gBAAA,CAAiB,GAAG,CAAA,CAAA;AACnC,IAAM,MAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,CAAO,CAAC,CAAA,CAAA;AAAA,GAC7B;AAAA,EAEA,YAAY,OAA4C,EAAA;AACtD,IAAA,MAAM,aAAa,EAAE,GAAG,IAAK,CAAA,QAAA,EAAU,GAAG,OAAQ,EAAA,CAAA;AAClD,IAAA,OAAO,IAAI,kBAAA;AAAA,MACT,IAAA,CAAK,eAAe,UAAU,CAAA;AAAA,MAC9B,IAAK,CAAA,cAAA;AAAA,MACL,UAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA;AAAA;AAAA,EAKQ,iBAAiB,YAA8B,EAAA;AAErD,IAAA,MAAM,gBAAgB,MAAO,CAAA,IAAA,CAAK,YAAY,CAAA,CAAE,SAAS,QAAQ,CAAA,CAAA;AAIjE,IAAI,IAAA,aAAA,CAAc,SAAS,GAAK,EAAA;AAC9B,MAAO,OAAA,aAAA,CAAA;AAAA,KACT;AAEA,IAAA,OAAOA,kBAAW,QAAQ,CAAA,CAAE,OAAO,YAAY,CAAA,CAAE,OAAO,QAAQ,CAAA,CAAA;AAAA,GAClE;AACF;;AClDO,MAAM,YAAa,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKP,cAAiB,GAAA;AAAA,IAChC,KAAA,EAAO,KAAK,uBAAwB,EAAA;AAAA,IACpC,QAAA,EAAU,KAAK,0BAA2B,EAAA;AAAA,IAC1C,MAAA,EAAQ,KAAK,wBAAyB,EAAA;AAAA,GACxC,CAAA;AAAA,EAEiB,MAAA,CAAA;AAAA,EACA,KAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjB,OAAO,UAAA,CACL,MACA,EAAA,OAAA,GAWI,EACU,EAAA;AAGd,IAAA,MAAM,KAAQ,GAAA,MAAA,CAAO,iBAAkB,CAAA,qBAAqB,CAAK,IAAA,QAAA,CAAA;AACjE,IAAM,MAAA,UAAA,GAAa,MAAO,CAAA,iBAAA,CAAkB,0BAA0B,CAAA,CAAA;AACtE,IAAA,MAAM,gBACJ,GAAA,MAAA,CAAO,iBAAkB,CAAA,0BAA0B,CAAK,IAAA,EAAA,CAAA;AAC1D,IAAA,MAAM,YACJ,GAAA,MAAA,CAAO,kBAAmB,CAAA,4BAA4B,CAAK,IAAA,IAAA,CAAA;AAC7D,IAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,MAAA,EAAQ,KAAM,CAAA;AAAA,MACnC,IAAM,EAAA,cAAA;AAAA,KACP,CAAA,CAAA;AACD,IAAA,OAAO,IAAI,YAAA;AAAA,MACT,KAAA;AAAA,MACA,gBAAA;AAAA,MACA,YAAA;AAAA,MACA,OAAQ,CAAA,OAAA;AAAA,MACR,MAAA;AAAA,MACA,UAAA;AAAA,KACF,CAAA;AAAA,GACF;AAAA;AAAA,EAGA,YACE,KACA,EAAA,gBAAA,EACA,YACA,EAAA,YAAA,EACA,QACA,UACA,EAAA;AACA,IAAA,IAAI,CAAC,IAAA,CAAK,cAAe,CAAA,cAAA,CAAe,KAAK,CAAG,EAAA;AAC9C,MAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,KACjD;AACA,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;AACb,IAAA,IAAA,CAAK,UAAa,GAAA,gBAAA,CAAA;AAClB,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA,CAAA;AACpB,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA,CAAA;AACpB,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAAA,GACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,UAAU,QAER,EAAA;AACA,IAAO,OAAA;AAAA,MACL,SAAW,EAAA,CAAC,cAAiB,GAAA,EAAO,KAAA;AAClC,QAAM,MAAA,aAAA,GAAgB,CAAC,OAAiC,KAAA;AACtD,UAAA,MAAM,iBAAiB,IAAK,CAAA,gBAAA;AAAA,YAC1B,QAAA;AAAA,YACA,OAAA,CAAQ,cAAc,IAAK,CAAA,UAAA;AAAA,WAC7B,CAAA;AAGA,UAAe,cAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,GAAe,KAAA;AAEzC,YAAK,IAAA,CAAA,MAAA,EAAQ,KAAM,CAAA,+BAAA,EAAiC,GAAG,CAAA,CAAA;AAGvD,YAAI,IAAA,OAAO,IAAK,CAAA,YAAA,KAAiB,UAAY,EAAA;AAC3C,cAAA,IAAA,CAAK,aAAa,GAAG,CAAA,CAAA;AAAA,aACvB;AAAA,WACD,CAAA,CAAA;AAED,UAAO,OAAA,cAAA,CAAA;AAAA,SACT,CAAA;AAEA,QAAA,OAAO,IAAI,kBAAA;AAAA,UACT,cAAc,cAAc,CAAA;AAAA,UAC5B,aAAA;AAAA,UACA,cAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF,CAAA;AAAA,GACF;AAAA,EAEQ,gBAAA,CAAiB,UAAkB,GAA+B,EAAA;AACxE,IAAA,OAAO,KAAK,cAAe,CAAA,IAAA,CAAK,KAAK,CAAA,CAAE,UAAU,GAAG,CAAA,CAAA;AAAA,GACtD;AAAA,EAEQ,uBAAwC,GAAA;AAC9C,IAAM,MAAA,SAAA,GAAY,QAAQ,aAAa,CAAA,CAAA;AACvC,IAAI,IAAA,KAAA,CAAA;AACJ,IAAO,OAAA,CAAC,UAAU,UAAe,KAAA;AAC/B,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAQ,KAAA,GAAA,IAAI,SAAU,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAAA,OACvC;AACA,MAAA,OAAO,IAAIC,qBAAK,CAAA;AAAA,QACd,SAAW,EAAA,QAAA;AAAA,QACX,GAAK,EAAA,UAAA;AAAA,QACL,KAAA;AAAA,QACA,cAAc,IAAK,CAAA,YAAA;AAAA,OACpB,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEQ,0BAA2C,GAAA;AACjD,IAAM,MAAA,YAAA,GAAe,QAAQ,gBAAgB,CAAA,CAAA;AAC7C,IAAI,IAAA,KAAA,CAAA;AACJ,IAAO,OAAA,CAAC,UAAU,UAAe,KAAA;AAC/B,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAQ,KAAA,GAAA,IAAI,YAAa,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AAAA,OAC1C;AACA,MAAA,OAAO,IAAIA,qBAAK,CAAA;AAAA,QACd,SAAW,EAAA,QAAA;AAAA,QACX,GAAK,EAAA,UAAA;AAAA,QACL,KAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEQ,wBAAyC,GAAA;AAC/C,IAAM,MAAA,KAAA,uBAAY,GAAI,EAAA,CAAA;AACtB,IAAA,OAAO,CAAC,QAAA,EAAU,UAChB,KAAA,IAAIA,qBAAK,CAAA;AAAA,MACP,SAAW,EAAA,QAAA;AAAA,MACX,GAAK,EAAA,UAAA;AAAA,MACL,KAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACL;AACF;;ACrLO,MAAM,sBAAsBC,qCAAqB,CAAA;AAAA,EACtD,SAASC,6BAAa,CAAA,KAAA;AAAA,EACtB,IAAM,EAAA;AAAA,IACJ,QAAQA,6BAAa,CAAA,UAAA;AAAA,IACrB,QAAQA,6BAAa,CAAA,cAAA;AAAA,IACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,GACvB;AAAA,EACA,MAAM,iBAAA,CAAkB,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC1C,IAAA,OAAO,YAAa,CAAA,UAAA,CAAW,MAAQ,EAAA,EAAE,QAAQ,CAAA,CAAA;AAAA,GACnD;AAAA,EACA,MAAM,OAAA,CAAQ,EAAE,MAAA,IAAU,OAAS,EAAA;AACjC,IAAA,OAAO,QAAQ,SAAU,CAAA,MAAA,CAAO,KAAM,EAAC,EAAE,SAAU,EAAA,CAAA;AAAA,GACrD;AACF,CAAC;;;;;"}

package/dist/cache.d.ts

@@ -0,0 +1,84 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { LoggerService, CacheServiceOptions, CacheService } from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+
+/**
+ * @public
+ */
+declare const cacheServiceFactory: () => _backstage_backend_plugin_api.ServiceFactory<_backstage_backend_plugin_api.CacheService, "plugin">;
+
+/**
+ * Implements a Cache Manager which will automatically create new cache clients
+ * for plugins when requested. All requested cache clients are created with the
+ * connection details provided.
+ *
+ * @public
+ */
+declare class CacheManager {
+    /**
+     * Keys represent supported `backend.cache.store` values, mapped to factories
+     * that return Keyv instances appropriate to the store.
+     */
+    private readonly storeFactories;
+    private readonly logger?;
+    private readonly store;
+    private readonly connection;
+    private readonly useRedisSets;
+    private readonly errorHandler;
+    private readonly defaultTtl?;
+    /**
+     * Creates a new {@link CacheManager} instance by reading from the `backend`
+     * config section, specifically the `.cache` key.
+     *
+     * @param config - The loaded application configuration.
+     */
+    static fromConfig(config: Config, options?: {
+        /**
+         * An optional logger for use by the PluginCacheManager.
+         */
+        logger?: LoggerService;
+        /**
+         * An optional handler for connection errors emitted from the underlying data
+         * store.
+         */
+        onError?: (err: Error) => void;
+    }): CacheManager;
+    /**
+     * Generates a PluginCacheManager for consumption by plugins.
+     *
+     * @param pluginId - The plugin that the cache manager should be created for.
+     *        Plugin names should be unique.
+     */
+    forPlugin(pluginId: string): {
+        getClient(options?: CacheServiceOptions): CacheService;
+    };
+    private getClientWithTtl;
+    private createRedisStoreFactory;
+    private createMemcacheStoreFactory;
+    private createMemoryStoreFactory;
+}
+
+/**
+ * Options given when constructing a {@link CacheManager}.
+ *
+ * @public
+ */
+type CacheManagerOptions = {
+    /**
+     * An optional logger for use by the PluginCacheManager.
+     */
+    logger?: LoggerService;
+    /**
+     * An optional handler for connection errors emitted from the underlying data
+     * store.
+     */
+    onError?: (err: Error) => void;
+};
+/**
+ * @public
+ */
+interface PluginCacheManager {
+    getClient(options?: CacheServiceOptions): CacheService;
+}
+
+export { CacheManager, type CacheManagerOptions, type PluginCacheManager, cacheServiceFactory };