Partial support for duplicated symbols

[jhugman]

 According to The Big O of Code Reviews, this is a O(n) change.

This PR partially fixes #68:

• it re-exports each named crate as default export.
• it documents working with megazords.
• including the limitations of the Swift backend.

The second part to fix #68 is a little more involved, but is not yet worth it:

• for imported types and their converters, the bindings should use a more fully qualified name. e.g.

Instead of:

import { Crate1 } from "./crate1";
import crate1 from "./crate1";

const { FfiConverterTypeCrate1 } = crate1.converters;

// In use
type MyType = {
  scalar: Crate1,
  optional: Crate1 | undefined,
  list: Array<Crate1>,
}

// FfiConverterTypeCrate1 being used.
const lift = FfiConverterTypeCrate1.lift.bind(FfiConverterTypeCrate1);

The next part needs to generate code:

import * as crate1 from "./crate1";

// In use
type MyType = {
  scalar: crate1.Crate1,
  optional: crate1.Crate1 | undefined,
  list: Array<crate1.Crate1>,
}

// FfiConverterTypeCrate1 being used.
const lift = crate1.converters.FfiConverterTypeCrate1.lift.bind(crate1.converters.FfiConverterTypeCrate1);

I think I will file a new issue with this in, and close #68.

[Johennes]

Reviewed and tested with https://github.com/unomed-dev/react-native-matrix-sdk and I think this looks good. Here are the changes it caused for reference:

diff --git a/src/index.tsx b/src/index.tsx
index 242ba02..36133d2 100644
--- a/src/index.tsx
+++ b/src/index.tsx
@@ -12,17 +12,31 @@ export * from './generated/matrix_sdk_crypto';
 export * from './generated/matrix_sdk_ffi';
 export * from './generated/matrix_sdk_ui';
 
+// Now import the bindings so we can:
+// - intialize them
+// - export them as namespaced objects as the default export.
+import * as matrix_sdk from './generated/matrix_sdk';
+import * as matrix_sdk_base from './generated/matrix_sdk_base';
+import * as matrix_sdk_common from './generated/matrix_sdk_common';
+import * as matrix_sdk_crypto from './generated/matrix_sdk_crypto';
+import * as matrix_sdk_ffi from './generated/matrix_sdk_ffi';
+import * as matrix_sdk_ui from './generated/matrix_sdk_ui';
+
 // Initialize the generated bindings: mostly checksums, but also callbacks.
-import matrix_sdk_ from './generated/matrix_sdk';
-import matrix_sdk_base_ from './generated/matrix_sdk_base';
-import matrix_sdk_common_ from './generated/matrix_sdk_common';
-import matrix_sdk_crypto_ from './generated/matrix_sdk_crypto';
-import matrix_sdk_ffi_ from './generated/matrix_sdk_ffi';
-import matrix_sdk_ui_ from './generated/matrix_sdk_ui';
+matrix_sdk.default.initialize();
+matrix_sdk_base.default.initialize();
+matrix_sdk_common.default.initialize();
+matrix_sdk_crypto.default.initialize();
+matrix_sdk_ffi.default.initialize();
+matrix_sdk_ui.default.initialize();
+
+// Export the crates as individually namespaced objects.
+export default {
+  matrix_sdk,
+  matrix_sdk_base,
+  matrix_sdk_common,
+  matrix_sdk_crypto,
+  matrix_sdk_ffi,
+  matrix_sdk_ui,
+};
 
-matrix_sdk_.initialize();
-matrix_sdk_base_.initialize();
-matrix_sdk_common_.initialize();
-matrix_sdk_crypto_.initialize();
-matrix_sdk_ffi_.initialize();
-matrix_sdk_ui_.initialize();

[Johennes]

Suggested change

	This may be solved in Swift at some point— e.g. by adding prefixes— but until then, duplicate identifiers will cause a Typescript compilation error as the types are smooshed together in `index.tsx`.
	This may be solved in Swift at some point — e.g. by adding prefixes — but until then, duplicate identifiers will cause a Typescript compilation error as the types are smooshed together in `index.tsx`.

[jhugman]

I have several em dashes throughout the documentation with this style.

Let's fix them all in one separate PR.

[Johennes]

Oh ok. I wasn't aware it's a particular style, apologies. If that's the case, we can just keep it like this everywhere.

[jhugman]

Swift work seems to being tracked in this issue.