@dpkit/core/build/package/Package.d.ts

Fast TypeScript data management framework built on top of the Data Package standard and Polars DataFrames

import type { Metadata } from "../general/index.ts";
import type { License, Resource, Source } from "../resource/index.ts";
import type { Contributor } from "./Contributor.ts";
/**
 * Data Package interface built on top of the Frictionless Data specification
 * @see https://datapackage.org/standard/data-package/
 */
export interface Package extends Metadata {
    /**
     * Data resources in this package (required)
     */
    resources: Resource[];
    /**
     * Unique package identifier
     * Should use lowercase alphanumeric characters, periods, hyphens, and underscores
     */
    name?: string;
    /**
     * Package schema URL for validation
     */
    $schema?: string;
    /**
     * Human-readable title
     */
    title?: string;
    /**
     * A description of the package
     */
    description?: string;
    /**
     * A URL for the home page of the package
     */
    homepage?: string;
    /**
     * Version of the package using SemVer
     * @example "1.0.0"
     */
    version?: string;
    /**
     * License information
     */
    licenses?: License[];
    /**
     * List of contributors
     */
    contributors?: Contributor[];
    /**
     * Data sources for this package
     */
    sources?: Source[];
    /**
     * Keywords for the package
     */
    keywords?: string[];
    /**
     * Create time of the package
     * @format ISO 8601 format
     */
    created?: string;
    /**
     * Package image
     */
    image?: string;
}