config-schema: added initial API types

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

plugins/config-schema/package.json

@@ -20,6 +20,7 @@
     "clean": "backstage-cli clean"
   },
   "dependencies": {
+    "@backstage/config": "^0.1.4",
     "@backstage/core": "^0.7.3",
     "@backstage/theme": "^0.2.5",
     "@material-ui/core": "^4.11.0",

plugins/config-schema/src/api/index.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * 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 { configSchemaApiRef } from './types';
+export type { ConfigSchemaApi } from './types';

plugins/config-schema/src/api/types.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2021 Spotify AB
+ *
+ * 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 { JsonObject } from '@backstage/config';
+import { createApiRef, Observable } from '@backstage/core';
+
+export interface ConfigSchemaResult {
+  schema?: JsonObject;
+}
+
+export interface ConfigSchemaApi {
+  schema$(): Observable<ConfigSchemaResult>;
+}
+
+export const configSchemaApiRef = createApiRef<ConfigSchemaApi>({
+  id: 'plugin.config-schema',
+});