@backstage-community/plugin-3scale-backend 3.0.1 → 3.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## @janus-idp/backstage-plugin-3scale-backend [1.8.0](https://github.com/janus-idp/backstage-plugins/compare/@janus-idp/backstage-plugin-3scale-backend@1.7.1...@janus-idp/backstage-plugin-3scale-backend@1.8.0) (2024-07-25)
 
+## 3.0.2
+
+### Patch Changes
+
+- 3f84dd4: Removed `export-dynamic` script and Janus IDP cli from the build process and npm release.
+
 ## 3.0.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-3scale-backend",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "license": "Apache-2.0",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
@@ -25,10 +25,8 @@
   "scripts": {
     "build": "backstage-cli package build",
     "clean": "backstage-cli package clean",
-    "export-dynamic": "janus-cli package export-dynamic-plugin --no-embed-as-dependencies",
     "lint": "backstage-cli package lint",
     "postpack": "backstage-cli package postpack",
-    "postversion": "yarn run export-dynamic",
     "prepack": "backstage-cli package prepack",
     "start": "backstage-cli package start",
     "test": "backstage-cli package test --passWithNoTests --coverage"
@@ -49,18 +47,15 @@
     "@backstage/cli": "^0.28.0",
     "@backstage/config": "^1.2.0",
     "@backstage/plugin-catalog-backend": "^1.27.1",
-    "@janus-idp/cli": "1.13.1",
     "@types/supertest": "6.0.2",
     "@types/swagger2openapi": "^7.0.4",
-    "msw": "1.3.3",
+    "msw": "1.3.4",
     "supertest": "7.0.0"
   },
   "files": [
-    "dist",
+    "app-config.example.yaml",
     "config.d.ts",
-    "dist-dynamic/*.*",
-    "dist-dynamic/dist/**",
-    "app-config.yaml"
+    "dist"
   ],
   "configSchema": "config.d.ts",
   "repository": {

package/dist-dynamic/README.md

@@ -1,61 +0,0 @@
-# 3scale Backstage provider
-
-The 3scale Backstage provider plugin synchronizes the 3scale content into the [Backstage](https://backstage.io/) catalog.
-
-## For administrators
-
-### Installation
-
-Run the following command to install the 3scale Backstage provider plugin:
-
-```console
-yarn workspace backend add @backstage-community/plugin-3scale-backend
-```
-
-### Configuration
-
-3scale Backstage provider allows configuration of one or multiple providers using the `app-config.yaml` configuration file of Backstage.
-
-#### New Backend Procedure
-
-1. Use a `threeScaleApiEntity` marker to start configuring the `app-config.yaml` file of Backstage:
-
-   ```yaml title="app-config.yaml"
-   catalog:
-     providers:
-       threeScaleApiEntity:
-         dev:
-           baseUrl: https://<TENANT>-admin.3scale.net
-           accessToken: <ACCESS_TOKEN>
-           schedule: # optional; same options as in TaskScheduleDefinition
-             # supports cron, ISO duration, "human duration" as used in code
-             frequency: { minutes: 30 }
-             # supports ISO duration, "human duration" as used in code
-             timeout: { minutes: 3 }
-   ```
-
-   **NOTE**
-   Make sure to configure the schedule inside the `app-config.yaml` file. The default schedule is a frequency of 30 minutes and a timeout of 3 minutes.
-
-2. Add the following code to the `packages/backend/src/index.ts` file:
-
-   ```ts title="packages/backend/src/index.ts"
-   const backend = createBackend();
-
-   /* highlight-add-next-line */
-   backend.add(import('@backstage-community/plugin-3scale-backend'));
-
-   backend.start();
-   ```
-
-### Troubleshooting
-
-When you start your Backstage application, you can see some log lines as follows:
-
-```log
-[1] 2023-02-13T15:26:09.356Z catalog info Discovered ApiEntity API type=plugin target=ThreeScaleApiEntityProvider:dev
-[1] 2023-02-13T15:26:09.423Z catalog info Discovered ApiEntity Red Hat Event (DEV, v1.2.0) type=plugin target=ThreeScaleApiEntityProvider:dev
-[1] 2023-02-13T15:26:09.620Z catalog info Discovered ApiEntity Red Hat Event (TEST, v1.1.0) type=plugin target=ThreeScaleApiEntityProvider:dev
-[1] 2023-02-13T15:26:09.819Z catalog info Discovered ApiEntity Red Hat Event (PROD, v1.1.0) type=plugin target=ThreeScaleApiEntityProvider:dev
-[1] 2023-02-13T15:26:09.819Z catalog info Applying the mutation with 3 entities type=plugin target=ThreeScaleApiEntityProvider:dev
-```

package/dist-dynamic/app-config.yaml

@@ -1,11 +0,0 @@
-catalog:
-  providers:
-    threeScaleApiEntity:
-      dev:
-        baseUrl: '${THREESCALE_BASE_URL}' # https://<TENANT>-admin.3scale.net
-        accessToken: '${THREESCALE_ACCESS_TOKEN}'
-        schedule: # optional; same options as in TaskScheduleDefinition
-          # supports cron, ISO duration, "human duration" as used in code
-          frequency: { minutes: 1 }
-          # supports ISO duration, "human duration" as used in code
-          timeout: { minutes: 1 }

package/dist-dynamic/config.d.ts

@@ -1,38 +0,0 @@
-/*
- * Copyright 2024 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.
- */
-
-import type { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
-
-export interface Config {
-  catalog?: {
-    providers?: {
-      threeScaleApiEntity?: {
-        [key: string]: {
-          /**
-           * ThreeScaleConfig
-           */
-          baseUrl: string;
-          /** @visibility secret */
-          accessToken: string;
-          systemLabel?: string;
-          ownerLabel?: string;
-          addLabels?: boolean;
-          schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
-        };
-      };
-    };
-  };
-}

package/dist-dynamic/package.json

@@ -1,58 +0,0 @@
-{
-  "name": "@backstage-community/plugin-3scale-backend-dynamic",
-  "version": "1.8.5",
-  "license": "Apache-2.0",
-  "main": "./dist/index.cjs.js",
-  "types": "src/index.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "backstage": {
-    "role": "backend-plugin-module",
-    "supported-versions": "1.28.4",
-    "pluginId": "3scale",
-    "pluginPackage": "@backstage-community/plugin-3scale-backend"
-  },
-  "exports": {
-    ".": {
-      "require": "./dist/index.cjs.js",
-      "default": "./dist/index.cjs.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "dist",
-    "config.d.ts",
-    "app-config.yaml"
-  ],
-  "configSchema": "config.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/backstage/community-plugins",
-    "directory": "workspaces/3scale/plugins/3scale-backend"
-  },
-  "keywords": [
-    "support:tech-preview",
-    "lifecycle:active",
-    "backstage",
-    "plugin"
-  ],
-  "homepage": "https://red.ht/rhdh",
-  "bugs": "https://github.com/backstage/community-plugins/issues",
-  "author": "Red Hat",
-  "bundleDependencies": true,
-  "peerDependencies": {
-    "@backstage/backend-plugin-api": "^1.0.0",
-    "@backstage/catalog-model": "^1.7.0",
-    "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-catalog-node": "^1.13.0"
-  },
-  "overrides": {
-    "@aws-sdk/util-utf8-browser": {
-      "@smithy/util-utf8": "^2.0.0"
-    }
-  },
-  "resolutions": {
-    "@aws-sdk/util-utf8-browser": "npm:@smithy/util-utf8@~2"
-  }
-}

package/dist-dynamic/yarn.lock

@@ -1,16 +0,0 @@
-# This file is generated by running "yarn install" inside your project.
-# Manual changes might be lost - proceed with caution!
-
-__metadata:
-  version: 6
-
-"@backstage-community/plugin-3scale-backend-dynamic@workspace:.":
-  version: 0.0.0-use.local
-  resolution: "@backstage-community/plugin-3scale-backend-dynamic@workspace:."
-  peerDependencies:
-    "@backstage/backend-plugin-api": ^1.0.0
-    "@backstage/catalog-model": ^1.7.0
-    "@backstage/errors": ^1.2.4
-    "@backstage/plugin-catalog-node": ^1.13.0
-  languageName: unknown
-  linkType: soft