Metadata Structure Design

[ChuckJonas]

Issue to discuss and finalize Metadata structure.

Prototype

interface FieldMetadata {
  apiName: string;
  type?: unknown;
  creatable?: boolean;
  updatable?: boolean;
  childRelationship?: boolean;
  reference?: (() => Metadata<any>);
}
type Metadata<T = {}> = Record<keyof T, FieldMetadata>;

See SObjectDescribeResult for additional metadata returned from salesforce.

[ChuckJonas]

Here's the current field metadata for ts-force

{
    public apiName: string;
    public updateable: boolean;
    public createable: boolean;
    public reference: () => { new(): RestObject; };
    public required: boolean;
    public externalId: boolean;
    public childRelationship: boolean;
    public salesforceType: SalesforceFieldType;
    public salesforceLabel?: string;
}

Thinking we should add required, salesforceType & salesforceLabel.

I don't think I've every actually used externalId in the current version, but it might be nice to have (potentially would allow us to mock upsert)

One very minor thing that we will lose with this data structure is that I was able to generate doc comments using the help text. I don't think that will be possible with the dynamic types we will be created 🤷‍♂