compiled_types.ts

import type {AWSAccessKeyAuthentication} from './types';
import type {AWSAssumeRoleAuthentication} from './types';
import type {Authentication} from './types';
import type {AuthenticationType} from './types';
import type {CodaApiBearerTokenAuthentication} from './types';
import type {CustomAuthentication} from './types';
import type {CustomHeaderTokenAuthentication} from './types';
import type {DistributiveOmit} from './type_utils';
import type {Format} from './types';
import type {HeaderBearerTokenAuthentication} from './types';
import type {MetadataFormulaMetadata} from './api';
import type {MultiQueryParamTokenAuthentication} from './types';
import type {NoAuthentication} from './types';
import type {OAuth2Authentication} from './types';
import type {ObjectPackFormulaMetadata} from './api';
import type {PackDefinition} from './types';
import type {PackFormulaMetadata} from './api';
import type {PackVersionDefinition} from './types';
import type {PostSetup} from './types';
import type {QueryParamTokenAuthentication} from './types';
import type {SyncTable} from './api';
import type {VariousAuthentication} from './types';
import type {WebBasicAuthentication} from './types';

// TODO(jonathan): Anything in this file that gets exported in index.ts should probably
// be removed from there and put into a separate entrypoint. These types should
// only need to be used by `coda` code that handles implementation and rendering
// of pack listings.

/** @hidden */
export type PackSyncTable = Omit<
  SyncTable,
  'getter' | 'getName' | 'getSchema' | 'listDynamicUrls' | 'getDisplayUrl'
> & {
  getter: PackFormulaMetadata;
  isDynamic?: boolean;
  hasDynamicSchema?: boolean;
  getSchema?: MetadataFormulaMetadata;
  getName?: MetadataFormulaMetadata;
  getDisplayUrl?: MetadataFormulaMetadata;
  listDynamicUrls?: MetadataFormulaMetadata;
};

/** @hidden */
export interface PackFormatMetadata extends Omit<Format, 'matchers'> {
  matchers: string[];
}

/** @hidden */
export type PostSetupMetadata = Omit<PostSetup, 'getOptions' | 'getOptionsFormula'> & {
  getOptions?: MetadataFormulaMetadata; // TODO(packs-dev): Make this required after migration.
  getOptionsFormula?: MetadataFormulaMetadata;
};

/** @hidden */
export type AuthenticationMetadata = DistributiveOmit<
  Authentication,
  'getConnectionName' | 'getConnectionUserId' | 'postSetup'
> & {
  getConnectionName?: MetadataFormulaMetadata;
  getConnectionUserId?: MetadataFormulaMetadata;
  postSetup?: PostSetupMetadata[];
};

/** @hidden */
type AuthenticationToMetadata<T extends Authentication> = DistributiveOmit<
  T,
  'getConnectionName' | 'getConnectionUserId' | 'postSetup'
> & {
  getConnectionName?: MetadataFormulaMetadata;
  getConnectionUserId?: MetadataFormulaMetadata;
  postSetup?: PostSetupMetadata[];
};

/** @hidden */
export interface AuthenticationMetadataTypeMap {
  [AuthenticationType.AWSAccessKey]: AuthenticationToMetadata<AWSAccessKeyAuthentication>;
  [AuthenticationType.AWSAssumeRole]: AuthenticationToMetadata<AWSAssumeRoleAuthentication>;
  [AuthenticationType.CodaApiHeaderBearerToken]: AuthenticationToMetadata<CodaApiBearerTokenAuthentication>;
  [AuthenticationType.CustomHeaderToken]: AuthenticationToMetadata<CustomHeaderTokenAuthentication>;
  [AuthenticationType.Custom]: AuthenticationToMetadata<CustomAuthentication>;
  [AuthenticationType.HeaderBearerToken]: AuthenticationToMetadata<HeaderBearerTokenAuthentication>;
  [AuthenticationType.MultiQueryParamToken]: AuthenticationToMetadata<MultiQueryParamTokenAuthentication>;
  [AuthenticationType.None]: AuthenticationToMetadata<NoAuthentication>;
  [AuthenticationType.QueryParamToken]: AuthenticationToMetadata<QueryParamTokenAuthentication>;
  [AuthenticationType.Various]: AuthenticationToMetadata<VariousAuthentication>;
  [AuthenticationType.WebBasic]: AuthenticationToMetadata<WebBasicAuthentication>;
  [AuthenticationType.OAuth2]: AuthenticationToMetadata<OAuth2Authentication>;
}

// Stripped-down version of `PackVersionDefinition` that doesn't contain formula definitions.
/** @hidden */
export type PackVersionMetadata = Omit<
  PackVersionDefinition,
  'formulas' | 'formats' | 'defaultAuthentication' | 'syncTables'
> & {
  formulas: PackFormulaMetadata[];
  formats: PackFormatMetadata[];
  syncTables: PackSyncTable[];
  defaultAuthentication?: AuthenticationMetadata;
};

// Stripped-down version of `PackDefinition` that doesn't contain formula definitions.
/** @hidden */
export type PackMetadata = PackVersionMetadata &
  Pick<
    PackDefinition,
    | 'id'
    | 'name'
    | 'shortDescription'
    | 'description'
    | 'permissionsDescription'
    | 'category'
    | 'logoPath'
    | 'exampleImages'
    | 'exampleVideoIds'
    | 'minimumFeatureSet'
    | 'quotas'
    | 'rateLimits'
    | 'isSystem'
  >;

// Re-exported values for use in browser code.

/** @hidden */
export type ExternalPackAuthenticationType = AuthenticationType;
/** @hidden */
export type ExternalPackFormulas = PackFormulaMetadata[];
/** @hidden */
export type ExternalObjectPackFormula = ObjectPackFormulaMetadata;
/** @hidden */
export type ExternalPackFormula = PackFormulaMetadata;
/** @hidden */
export type ExternalPackFormat = Omit<Format, 'matchers'> & {matchers?: string[]};
/** @hidden */
export type ExternalPackFormatMetadata = PackFormatMetadata;
/** @hidden */
export type ExternalSyncTable = PackSyncTable;

type BasePackVersionMetadata = Omit<
  PackVersionMetadata,
  'defaultAuthentication' | 'systemConnectionAuthentication' | 'formulas' | 'formats' | 'syncTables'
>;

// Further stripped-down version of `PackVersionMetadata` that contains only what the browser needs.
/** @hidden */
export interface ExternalPackVersionMetadata extends BasePackVersionMetadata {
  authentication: {
    type: ExternalPackAuthenticationType;
    params?: Array<{name: string; description: string}>;
    requiresEndpointUrl: boolean;
    endpointDomain?: string;
    postSetup?: PostSetupMetadata[];
    deferConnectionSetup?: boolean;
    shouldAutoAuthSetup?: boolean;
    oauthScopes?: string[];
    oauthAuthorizationUrl?: string;
    oauthTokenUrl?: string;
    networkDomain?: string | string[];
  };
  instructionsUrl?: string;

  // User-facing components
  formulas?: ExternalPackFormulas;
  formats?: ExternalPackFormat[];
  syncTables?: ExternalSyncTable[];
}

// Further stripped-down version of `PackMetadata` that contains only what the browser needs.
/** @hidden */
export type ExternalPackMetadata = ExternalPackVersionMetadata &
  Pick<
    PackMetadata,
    | 'id'
    | 'name'
    | 'shortDescription'
    | 'description'
    | 'permissionsDescription'
    | 'category'
    | 'logoPath'
    | 'exampleImages'
    | 'exampleVideoIds'
    | 'minimumFeatureSet'
    | 'quotas'
    | 'rateLimits'
    | 'isSystem'
  >;

/** @hidden */
export interface PackUpload {
  // PackMetadata is only for legacy packs. This should be removed once
  // all the feature's we're relying on from legacy pack defs like quotas
  // have been migrated or retired.
  metadata: PackVersionMetadata | PackMetadata;
  sdkVersion: string;
  bundle: string;
  sourceMap: string;
}