From 4cfacd936bbaf32eaecefa706a181f5642e20ded Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Wed, 11 Sep 2024 13:33:53 +0200
Subject: [PATCH] frontend-internal: opaqueType.create -> .createInstance

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .../src/wiring/OpaqueType.test.ts             | 58 +++++++++----------
 .../src/wiring/OpaqueType.ts                  |  2 +-
 .../src/wiring/createExtension.ts             |  2 +-
 3 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/packages/frontend-internal/src/wiring/OpaqueType.test.ts b/packages/frontend-internal/src/wiring/OpaqueType.test.ts
index edf23cd732..f952f9cdbb 100644
--- a/packages/frontend-internal/src/wiring/OpaqueType.test.ts
+++ b/packages/frontend-internal/src/wiring/OpaqueType.test.ts
@@ -33,14 +33,14 @@ describe('OpaqueType', () => {
       versions: ['v1'],
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       // @ts-expect-error - wrong type
       $$type: 'wrong-type',
       version: 'v1',
       foo: 'bar',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       // @ts-expect-error - unsupported version
       version: 'v2',
@@ -48,25 +48,25 @@ describe('OpaqueType', () => {
     });
 
     // @ts-expect-error - missing version
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       foo: 'bar',
     });
 
     // @ts-expect-error - missing internal field
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
       // @ts-expect-error - invalid internal field
       foo: 3,
     });
 
-    const myInstance = OpaqueMyType.create({
+    const myInstance = OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
       foo: 'bar',
@@ -170,14 +170,14 @@ describe('OpaqueType', () => {
       versions: ['v1', 'v2', 'v3'],
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       // @ts-expect-error - wrong type
       $$type: 'wrong-type',
       version: 'v1',
       foo: 'bar',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       // @ts-expect-error - unsupported version
       version: 'v0',
@@ -185,45 +185,45 @@ describe('OpaqueType', () => {
     });
 
     // @ts-expect-error - missing version
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       foo: 'bar',
     });
 
     // @ts-expect-error - missing internal field
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
       // @ts-expect-error - invalid internal field
       foo: 3,
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v2',
       // @ts-expect-error - version mismatch
       foo: 'bar',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
       // @ts-expect-error - version mismatch
       bar: 'foo',
     });
 
-    const myInstanceV1 = OpaqueMyType.create({
+    const myInstanceV1 = OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
       foo: 'bar',
     });
 
-    const myInstanceV2 = OpaqueMyType.create({
+    const myInstanceV2 = OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v2',
       bar: 'foo',
@@ -293,13 +293,13 @@ describe('OpaqueType', () => {
       versions: [undefined],
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       // @ts-expect-error - wrong type
       $$type: 'wrong-type',
       foo: 'bar',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       // @ts-expect-error - unsupported version
       version: 'v1',
@@ -307,19 +307,19 @@ describe('OpaqueType', () => {
     });
 
     // @ts-expect-error - missing internal field
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: undefined,
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: undefined,
       // @ts-expect-error - invalid internal field
       foo: 3,
     });
 
-    const myInstance = OpaqueMyType.create({
+    const myInstance = OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: undefined,
       foo: 'bar',
@@ -370,14 +370,14 @@ describe('OpaqueType', () => {
       versions: [undefined, 'v1'],
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       // @ts-expect-error - wrong type
       $$type: 'wrong-type',
       version: 'v1',
       foo: 'bar',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       // @ts-expect-error - unsupported version
       version: 'v3',
@@ -385,45 +385,45 @@ describe('OpaqueType', () => {
     });
 
     // @ts-expect-error - missing version
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       foo: 'bar',
     });
 
     // @ts-expect-error - missing internal field
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
       // @ts-expect-error - invalid internal field
       foo: 3,
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: undefined,
       // @ts-expect-error - version mismatch
       foo: 'bar',
     });
 
-    OpaqueMyType.create({
+    OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
       // @ts-expect-error - version mismatch
       bar: 'foo',
     });
 
-    const myInstanceV1 = OpaqueMyType.create({
+    const myInstanceV1 = OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: 'v1',
       foo: 'bar',
     });
 
-    const myInstanceV2 = OpaqueMyType.create({
+    const myInstanceV2 = OpaqueMyType.createInstance({
       $$type: 'my-type',
       version: undefined,
       bar: 'foo',
diff --git a/packages/frontend-internal/src/wiring/OpaqueType.ts b/packages/frontend-internal/src/wiring/OpaqueType.ts
index 5a13529388..5f571a5d4b 100644
--- a/packages/frontend-internal/src/wiring/OpaqueType.ts
+++ b/packages/frontend-internal/src/wiring/OpaqueType.ts
@@ -120,7 +120,7 @@ export class OpaqueType<
    *
    * By providing a type argument you can narrow the return to specific type parameters.
    */
-  create<TBase extends T['public'] = T['public']>(
+  createInstance<TBase extends T['public'] = T['public']>(
     value: T['public'] & T['versions'] & Object, // & Object to allow for object properties too, e.g. toString()
   ): TBase {
     return value as unknown as TBase;
diff --git a/packages/frontend-plugin-api/src/wiring/createExtension.ts b/packages/frontend-plugin-api/src/wiring/createExtension.ts
index 78e66dffe5..92c8bc7be9 100644
--- a/packages/frontend-plugin-api/src/wiring/createExtension.ts
+++ b/packages/frontend-plugin-api/src/wiring/createExtension.ts
@@ -377,7 +377,7 @@ export function createExtension<
       ),
     );
 
-  return OpaqueExtensionDefinition.create({
+  return OpaqueExtensionDefinition.createInstance({
     $$type: '@backstage/ExtensionDefinition',
     version: 'v2',
     T: undefined as unknown as {