@backstage/plugin-scaffolder-react 1.8.4-next.0 → 1.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/CHANGELOG.md +43 -0
  2. package/alpha/package.json +1 -1
  3. package/dist/alpha.d.ts +5 -0
  4. package/dist/alpha.esm.js +95 -33
  5. package/dist/alpha.esm.js.map +1 -1
  6. package/dist/esm/{ref-DURDhsGA.esm.js → ref-NRtFlQHB.esm.js} +5 -2
  7. package/dist/esm/ref-NRtFlQHB.esm.js.map +1 -0
  8. package/dist/index.d.ts +3 -1
  9. package/dist/index.esm.js +2 -2
  10. package/package.json +41 -41
  11. package/dist/esm/ref-DURDhsGA.esm.js.map +0 -1
package/dist/esm/{ref-DURDhsGA.esm.js → ref-NRtFlQHB.esm.js} RENAMED
@@ -4,7 +4,10 @@ import { createApiRef } from '@backstage/core-plugin-api';
4
4
 
5
5
  const SecretsContext = createVersionedContext("secrets-context");
6
6
  const SecretsContextProvider = (props) => {
7
- const [secrets, setSecrets] = useState({});
7
+ const { initialSecrets = {} } = props;
8
+ const [secrets, setSecrets] = useState({
9
+ ...initialSecrets
10
+ });
8
11
  return /* @__PURE__ */ React.createElement(
9
12
  SecretsContext.Provider,
10
13
  {
@@ -39,4 +42,4 @@ const scaffolderApiRef = getOrCreateGlobalSingleton(
39
42
  );
40
43
 
41
44
  export { SecretsContextProvider as S, scaffolderApiRef as s, useTemplateSecrets as u };
42
- //# sourceMappingURL=ref-DURDhsGA.esm.js.map
45
+ //# sourceMappingURL=ref-NRtFlQHB.esm.js.map
package/dist/esm/ref-NRtFlQHB.esm.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ref-NRtFlQHB.esm.js","sources":["../../src/secrets/SecretsContext.tsx","../../src/api/ref.ts"],"sourcesContent":["/*\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 */\nimport {\n createVersionedContext,\n createVersionedValueMap,\n} from '@backstage/version-bridge';\nimport React, {\n useState,\n useCallback,\n useContext,\n PropsWithChildren,\n} from 'react';\n\n/**\n * The contents of the `SecretsContext`\n */\ntype SecretsContextContents = {\n secrets: Record<string, string>;\n setSecrets: React.Dispatch<React.SetStateAction<Record<string, string>>>;\n};\n\n/**\n * The context to hold the Secrets.\n */\nconst SecretsContext = createVersionedContext<{\n 1: SecretsContextContents;\n}>('secrets-context');\n\n/**\n * The Context Provider that holds the state for the secrets.\n * @public\n */\nexport const SecretsContextProvider = (\n props: PropsWithChildren<{ initialSecrets?: Record<string, string> }>,\n) => {\n const { initialSecrets = {} } = props;\n const [secrets, setSecrets] = useState<Record<string, string>>({\n ...initialSecrets,\n });\n\n return (\n <SecretsContext.Provider\n value={createVersionedValueMap({ 1: { secrets, setSecrets } })}\n >\n {props.children}\n </SecretsContext.Provider>\n );\n};\n\n/**\n * The return type from the useTemplateSecrets hook.\n * @public\n */\nexport interface ScaffolderUseTemplateSecrets {\n setSecrets: (input: Record<string, string>) => void;\n secrets: Record<string, string>;\n}\n\n/**\n * Hook to access the secrets context to be able to set secrets that are\n * passed to the Scaffolder backend.\n * @public\n */\nexport const useTemplateSecrets = (): ScaffolderUseTemplateSecrets => {\n const value = useContext(SecretsContext)?.atVersion(1);\n\n if (!value) {\n throw new Error(\n 'useTemplateSecrets must be used within a SecretsContextProvider',\n );\n }\n\n const { setSecrets: updateSecrets, secrets = {} } = value;\n\n const setSecrets = useCallback(\n (input: Record<string, string>) => {\n updateSecrets(currentSecrets => ({ ...currentSecrets, ...input }));\n },\n [updateSecrets],\n );\n\n return { setSecrets, secrets };\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 { createApiRef } from '@backstage/core-plugin-api';\nimport { ScaffolderApi } from './types';\nimport { getOrCreateGlobalSingleton } from '@backstage/version-bridge';\n\n/** @public */\nexport const scaffolderApiRef = getOrCreateGlobalSingleton(\n 'scaffolder:scaffolder-api-ref',\n () =>\n createApiRef<ScaffolderApi>({\n id: 'plugin.scaffolder.service',\n }),\n);\n"],"names":[],"mappings":";;;;AAqCA,MAAM,cAAA,GAAiB,uBAEpB,iBAAiB,CAAA,CAAA;AAMP,MAAA,sBAAA,GAAyB,CACpC,KACG,KAAA;AACH,EAAA,MAAM,EAAE,cAAA,GAAiB,EAAC,EAAM,GAAA,KAAA,CAAA;AAChC,EAAA,MAAM,CAAC,OAAA,EAAS,UAAU,CAAA,GAAI,QAAiC,CAAA;AAAA,IAC7D,GAAG,cAAA;AAAA,GACJ,CAAA,CAAA;AAED,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,cAAe,CAAA,QAAA;AAAA,IAAf;AAAA,MACC,KAAA,EAAO,wBAAwB,EAAE,CAAA,EAAG,EAAE,OAAS,EAAA,UAAA,IAAc,CAAA;AAAA,KAAA;AAAA,IAE5D,KAAM,CAAA,QAAA;AAAA,GACT,CAAA;AAEJ,EAAA;AAgBO,MAAM,qBAAqB,MAAoC;AA5EtE,EAAA,IAAA,EAAA,CAAA;AA6EE,EAAA,MAAM,KAAQ,GAAA,CAAA,EAAA,GAAA,UAAA,CAAW,cAAc,CAAA,KAAzB,mBAA4B,SAAU,CAAA,CAAA,CAAA,CAAA;AAEpD,EAAA,IAAI,CAAC,KAAO,EAAA;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,iEAAA;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,EAAE,UAAY,EAAA,aAAA,EAAe,OAAU,GAAA,IAAO,GAAA,KAAA,CAAA;AAEpD,EAAA,MAAM,UAAa,GAAA,WAAA;AAAA,IACjB,CAAC,KAAkC,KAAA;AACjC,MAAA,aAAA,CAAc,qBAAmB,EAAE,GAAG,cAAgB,EAAA,GAAG,OAAQ,CAAA,CAAA,CAAA;AAAA,KACnE;AAAA,IACA,CAAC,aAAa,CAAA;AAAA,GAChB,CAAA;AAEA,EAAO,OAAA,EAAE,YAAY,OAAQ,EAAA,CAAA;AAC/B;;AC1EO,MAAM,gBAAmB,GAAA,0BAAA;AAAA,EAC9B,+BAAA;AAAA,EACA,MACE,YAA4B,CAAA;AAAA,IAC1B,EAAI,EAAA,2BAAA;AAAA,GACL,CAAA;AACL;;;;"}
package/dist/index.d.ts CHANGED
@@ -353,7 +353,9 @@ type TemplateParameterSchema = {
353
353
  * The Context Provider that holds the state for the secrets.
354
354
  * @public
355
355
  */
356
- declare const SecretsContextProvider: (props: PropsWithChildren<{}>) => React__default.JSX.Element;
356
+ declare const SecretsContextProvider: (props: PropsWithChildren<{
357
+ initialSecrets?: Record<string, string>;
358
+ }>) => React__default.JSX.Element;
357
359
  /**
358
360
  * The return type from the useTemplateSecrets hook.
359
361
  * @public
package/dist/index.esm.js CHANGED
@@ -1,6 +1,6 @@
1
1
  import { attachComponentData, useElementFilter, useApi } from '@backstage/core-plugin-api';
2
- import { s as scaffolderApiRef } from './esm/ref-DURDhsGA.esm.js';
3
- export { S as SecretsContextProvider, u as useTemplateSecrets } from './esm/ref-DURDhsGA.esm.js';
2
+ import { s as scaffolderApiRef } from './esm/ref-NRtFlQHB.esm.js';
3
+ export { S as SecretsContextProvider, u as useTemplateSecrets } from './esm/ref-NRtFlQHB.esm.js';
4
4
  import { useImmerReducer } from 'use-immer';
5
5
  import { useEffect } from 'react';
6
6
  import '@backstage/version-bridge';
package/package.json CHANGED
@@ -1,13 +1,24 @@
1
1
  {
2
2
  "name": "@backstage/plugin-scaffolder-react",
3
+ "version": "1.8.4",
3
4
  "description": "A frontend library that helps other Backstage plugins interact with the Scaffolder",
4
- "version": "1.8.4-next.0",
5
- "main": "./dist/index.esm.js",
6
- "types": "./dist/index.d.ts",
7
- "license": "Apache-2.0",
5
+ "backstage": {
6
+ "role": "web-library"
7
+ },
8
8
  "publishConfig": {
9
9
  "access": "public"
10
10
  },
11
+ "keywords": [
12
+ "backstage"
13
+ ],
14
+ "homepage": "https://backstage.io",
15
+ "repository": {
16
+ "type": "git",
17
+ "url": "https://github.com/backstage/backstage",
18
+ "directory": "plugins/scaffolder-react"
19
+ },
20
+ "license": "Apache-2.0",
21
+ "sideEffects": false,
11
22
  "exports": {
12
23
  ".": {
13
24
  "import": "./dist/index.esm.js",
@@ -21,38 +32,31 @@
21
32
  },
22
33
  "./package.json": "./package.json"
23
34
  },
24
- "backstage": {
25
- "role": "web-library"
26
- },
27
- "homepage": "https://backstage.io",
28
- "repository": {
29
- "type": "git",
30
- "url": "https://github.com/backstage/backstage",
31
- "directory": "plugins/scaffolder-react"
32
- },
33
- "keywords": [
34
- "backstage"
35
+ "main": "./dist/index.esm.js",
36
+ "types": "./dist/index.d.ts",
37
+ "files": [
38
+ "dist",
39
+ "alpha"
35
40
  ],
36
- "sideEffects": false,
37
41
  "scripts": {
38
42
  "build": "backstage-cli package build",
43
+ "clean": "backstage-cli package clean",
39
44
  "lint": "backstage-cli package lint",
40
- "test": "backstage-cli package test",
41
45
  "prepack": "backstage-cli package prepack",
42
46
  "postpack": "backstage-cli package postpack",
43
- "clean": "backstage-cli package clean",
44
- "start": "backstage-cli package start"
47
+ "start": "backstage-cli package start",
48
+ "test": "backstage-cli package test"
45
49
  },
46
50
  "dependencies": {
47
- "@backstage/catalog-client": "^1.6.3",
51
+ "@backstage/catalog-client": "^1.6.4",
48
52
  "@backstage/catalog-model": "^1.4.5",
49
- "@backstage/core-components": "^0.14.4-next.0",
50
- "@backstage/core-plugin-api": "^1.9.1",
51
- "@backstage/plugin-catalog-react": "^1.11.3-next.0",
53
+ "@backstage/core-components": "^0.14.4",
54
+ "@backstage/core-plugin-api": "^1.9.2",
55
+ "@backstage/plugin-catalog-react": "^1.11.3",
52
56
  "@backstage/plugin-scaffolder-common": "^1.5.1",
53
- "@backstage/theme": "^0.5.2",
57
+ "@backstage/theme": "^0.5.3",
54
58
  "@backstage/types": "^1.1.1",
55
- "@backstage/version-bridge": "^1.0.7",
59
+ "@backstage/version-bridge": "^1.0.8",
56
60
  "@material-ui/core": "^4.12.2",
57
61
  "@material-ui/icons": "^4.9.1",
58
62
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -67,7 +71,7 @@
67
71
  "flatted": "3.3.1",
68
72
  "humanize-duration": "^3.25.1",
69
73
  "json-schema": "^0.4.0",
70
- "json-schema-library": "^7.3.9",
74
+ "json-schema-library": "^9.0.0",
71
75
  "lodash": "^4.17.21",
72
76
  "luxon": "^3.0.0",
73
77
  "qs": "^6.9.4",
@@ -77,27 +81,23 @@
77
81
  "zod": "^3.22.4",
78
82
  "zod-to-json-schema": "^3.20.4"
79
83
  },
80
- "peerDependencies": {
81
- "react": "^16.13.1 || ^17.0.0 || ^18.0.0",
82
- "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
83
- "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
84
- },
85
84
  "devDependencies": {
86
- "@backstage/cli": "^0.26.3-next.0",
87
- "@backstage/core-app-api": "^1.12.3",
88
- "@backstage/plugin-catalog": "^1.19.0-next.0",
85
+ "@backstage/cli": "^0.26.3",
86
+ "@backstage/core-app-api": "^1.12.4",
87
+ "@backstage/plugin-catalog": "^1.19.0",
89
88
  "@backstage/plugin-catalog-common": "^1.0.22",
90
- "@backstage/test-utils": "^1.5.3",
91
- "@testing-library/dom": "^9.0.0",
89
+ "@backstage/test-utils": "^1.5.4",
90
+ "@testing-library/dom": "^10.0.0",
92
91
  "@testing-library/jest-dom": "^6.0.0",
93
- "@testing-library/react": "^14.0.0",
92
+ "@testing-library/react": "^15.0.0",
94
93
  "@testing-library/user-event": "^14.0.0",
95
94
  "@types/humanize-duration": "^3.18.1",
96
95
  "@types/luxon": "^3.0.0"
97
96
  },
98
- "files": [
99
- "dist",
100
- "alpha"
101
- ],
97
+ "peerDependencies": {
98
+ "react": "^16.13.1 || ^17.0.0 || ^18.0.0",
99
+ "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
100
+ "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
101
+ },
102
102
  "module": "./dist/index.esm.js"
103
103
  }
package/dist/esm/ref-DURDhsGA.esm.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"ref-DURDhsGA.esm.js","sources":["../../src/secrets/SecretsContext.tsx","../../src/api/ref.ts"],"sourcesContent":["/*\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 */\nimport {\n createVersionedContext,\n createVersionedValueMap,\n} from '@backstage/version-bridge';\nimport React, {\n useState,\n useCallback,\n useContext,\n PropsWithChildren,\n} from 'react';\n\n/**\n * The contents of the `SecretsContext`\n */\ntype SecretsContextContents = {\n secrets: Record<string, string>;\n setSecrets: React.Dispatch<React.SetStateAction<Record<string, string>>>;\n};\n\n/**\n * The context to hold the Secrets.\n */\nconst SecretsContext = createVersionedContext<{\n 1: SecretsContextContents;\n}>('secrets-context');\n\n/**\n * The Context Provider that holds the state for the secrets.\n * @public\n */\nexport const SecretsContextProvider = (props: PropsWithChildren<{}>) => {\n const [secrets, setSecrets] = useState<Record<string, string>>({});\n\n return (\n <SecretsContext.Provider\n value={createVersionedValueMap({ 1: { secrets, setSecrets } })}\n >\n {props.children}\n </SecretsContext.Provider>\n );\n};\n\n/**\n * The return type from the useTemplateSecrets hook.\n * @public\n */\nexport interface ScaffolderUseTemplateSecrets {\n setSecrets: (input: Record<string, string>) => void;\n secrets: Record<string, string>;\n}\n\n/**\n * Hook to access the secrets context to be able to set secrets that are\n * passed to the Scaffolder backend.\n * @public\n */\nexport const useTemplateSecrets = (): ScaffolderUseTemplateSecrets => {\n const value = useContext(SecretsContext)?.atVersion(1);\n\n if (!value) {\n throw new Error(\n 'useTemplateSecrets must be used within a SecretsContextProvider',\n );\n }\n\n const { setSecrets: updateSecrets, secrets = {} } = value;\n\n const setSecrets = useCallback(\n (input: Record<string, string>) => {\n updateSecrets(currentSecrets => ({ ...currentSecrets, ...input }));\n },\n [updateSecrets],\n );\n\n return { setSecrets, secrets };\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 { createApiRef } from '@backstage/core-plugin-api';\nimport { ScaffolderApi } from './types';\nimport { getOrCreateGlobalSingleton } from '@backstage/version-bridge';\n\n/** @public */\nexport const scaffolderApiRef = getOrCreateGlobalSingleton(\n 'scaffolder:scaffolder-api-ref',\n () =>\n createApiRef<ScaffolderApi>({\n id: 'plugin.scaffolder.service',\n }),\n);\n"],"names":[],"mappings":";;;;AAqCA,MAAM,cAAA,GAAiB,uBAEpB,iBAAiB,CAAA,CAAA;AAMP,MAAA,sBAAA,GAAyB,CAAC,KAAiC,KAAA;AACtE,EAAA,MAAM,CAAC,OAAS,EAAA,UAAU,CAAI,GAAA,QAAA,CAAiC,EAAE,CAAA,CAAA;AAEjE,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,cAAe,CAAA,QAAA;AAAA,IAAf;AAAA,MACC,KAAA,EAAO,wBAAwB,EAAE,CAAA,EAAG,EAAE,OAAS,EAAA,UAAA,IAAc,CAAA;AAAA,KAAA;AAAA,IAE5D,KAAM,CAAA,QAAA;AAAA,GACT,CAAA;AAEJ,EAAA;AAgBO,MAAM,qBAAqB,MAAoC;AAvEtE,EAAA,IAAA,EAAA,CAAA;AAwEE,EAAA,MAAM,KAAQ,GAAA,CAAA,EAAA,GAAA,UAAA,CAAW,cAAc,CAAA,KAAzB,mBAA4B,SAAU,CAAA,CAAA,CAAA,CAAA;AAEpD,EAAA,IAAI,CAAC,KAAO,EAAA;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,iEAAA;AAAA,KACF,CAAA;AAAA,GACF;AAEA,EAAA,MAAM,EAAE,UAAY,EAAA,aAAA,EAAe,OAAU,GAAA,IAAO,GAAA,KAAA,CAAA;AAEpD,EAAA,MAAM,UAAa,GAAA,WAAA;AAAA,IACjB,CAAC,KAAkC,KAAA;AACjC,MAAA,aAAA,CAAc,qBAAmB,EAAE,GAAG,cAAgB,EAAA,GAAG,OAAQ,CAAA,CAAA,CAAA;AAAA,KACnE;AAAA,IACA,CAAC,aAAa,CAAA;AAAA,GAChB,CAAA;AAEA,EAAO,OAAA,EAAE,YAAY,OAAQ,EAAA,CAAA;AAC/B;;ACrEO,MAAM,gBAAmB,GAAA,0BAAA;AAAA,EAC9B,+BAAA;AAAA,EACA,MACE,YAA4B,CAAA;AAAA,IAC1B,EAAI,EAAA,2BAAA;AAAA,GACL,CAAA;AACL;;;;"}