@cumulus/types/api/collections.d.ts

TypeScript definitions for working with Cumulus data structures

export type DuplicateHandling = 'error' | 'replace' | 'skip' | 'version';

export type CollectionId = string;

export interface CollectionFile {
  bucket: string,
  regex: string,
  sampleFileName: string,
  checksumFor?: string
  type?: string,
  url_path?: string,
  lzards?: {
    backup: boolean
  }
}

export interface PartialCollectionRecord {
  duplicateHandling?: DuplicateHandling,
  files?: CollectionFile[],
  granuleId?: string,
  granuleIdExtraction?: string,
  ignoreFilesConfigForDiscovery?: boolean,
  name?: string,
  process?: string,
  reportToEms?: boolean,
  sampleFileName?: string,
  tags?: string[],
  meta?: object,
  url_path?: string,
  version?: string,
  createdAt?: number,
  updatedAt?: number
}

export interface NewCollectionRecord extends PartialCollectionRecord {
  files: CollectionFile[],
  granuleId: string,
  granuleIdExtraction: string,
  name: string,
  sampleFileName: string,
  version: string
}

export interface CollectionRecord extends NewCollectionRecord {
  createdAt: number,
  updatedAt: number
}