interface-base

The domain-agnostic base types, functions and other utilities used for defining API interfaces.

The domain-specific assets should be defined in <service>-interface packages.

Interface packages

For a service interface to be available to consumers, it is defined in a <service>-interface package.

The following are expected from each package, if applicable:

Note that only the above files are exported from the package. So please ensure all relevant assets are exported in these specific files.

For better organisation, split your assets in other .ts files and use index.ts to export them. E.g.

export * from "./cardDepositRequest.js";
export * from "./cashDepositRequest.js";
export * from "./deposit.js";
Copy

Add a new interface package

1. Copy and rename one of the existing <service>-interface packages
2. Update the package name in the following files:
   • packages/<service>-interface/project.json
   • packages/<service>-interface/README.md
3. Add the new package to tsconfig.base.json:

   "@cfxlabsinc/<service>-interface/*": [
      "packages/<service>-interface/src/*/index.ts"
    ],
   Copy

4. Update the code in packages/<service>-interface/src to implement your new interface.