feat: general framework improvements

.changeset/twenty-kids-own.md

@@ -0,0 +1,23 @@
+---
+"@dpkit/camtrap": minor
+"@dpkit/parquet": minor
+"@dpkit/extend": minor
+"@dpkit/github": minor
+"@dpkit/zenodo": minor
+"dpkit": minor
+"@dpkit/excel": minor
+"@dpkit/table": minor
+"@dpkit/avro": minor
+"@dpkit/ckan": minor
+"@dpkit/core": minor
+"@dpkit/file": minor
+"@dpkit/json": minor
+"@dpkit/cli": minor
+"@dpkit/csv": minor
+"@dpkit/ods": minor
+"@dpkit/zip": minor
+"@dpkit/db": minor
+"@dpkit/ui": minor
+---
+
+General framework improvements

CONTRIBUTING.md

@@ -1,8 +1,8 @@
 ---
 title: Contributing
+sidebar:
+  order: 2
 ---
-# Contributing to dpkit
-
 Thank you for your interest in contributing to dpkit! This document provides guidelines and instructions for contributing to this project.
 
 ## Project Overview

README.md

@@ -1,9 +1,9 @@
-# Data Package in TypeScript
+# dpkit
 
 [![Build](https://img.shields.io/github/actions/workflow/status/datisthq/dpkit/general.yaml?branch=main)](https://github.com/datisthq/dpkit/actions)
 [![Coverage](https://img.shields.io/codecov/c/github/datisthq/dpkit/main)](https://codecov.io/gh/datisthq/dpkit)
 
-Data Package implementation in TypeScript. Data Package is a standard consisting of a set of simple yet extensible specifications to describe datasets, data files and tabular data. It is a data definition language (DDL) and data API that facilitates findability, accessibility, interoperability, and reusability (FAIR) of data. For more information, please visit the [documentation portal](https://dpkit.datist.io).
+dpkit is a fast TypeScript data management framework based on the Data Package standard. It supports various formats like CSV, JSON, and Parquet and integrates with data platforms such as CKAN, Zenodo, and GitHub. For more information, please visit the [documentation portal](https://dpkit.datist.io).
 
 ## Funding
 

avro/README.md

@@ -1,3 +1,3 @@
 # @dpkit/avro
 
-Data Package implementation in TypeScript. Data Package is a standard consisting of a set of simple yet extensible specifications to describe datasets, data files and tabular data. It is a data definition language (DDL) and data API that facilitates findability, accessibility, interoperability, and reusability (FAIR) of data. For more information, please visit the [documentation portal](https://dpkit.datist.io).
+dpkit is a fast TypeScript data management framework based on the Data Package standard. It supports various formats like CSV, JSON, and Parquet and integrates with data platforms such as CKAN, Zenodo, and GitHub. For more information, please visit the [documentation portal](https://dpkit.datist.io).

avro/package.json

@@ -6,7 +6,7 @@
   "license": "MIT",
   "author": "Evgeny Karev",
   "repository": "https://github.com/datisthq/dpkit",
-  "description": "Data Package implementation in TypeScript.",
+  "description": "Fast TypeScript data management framework based on the Data Package standard",
   "keywords": [
     "data",
     "package",

bin/README.md

@@ -1,3 +1,3 @@
 # @dpkit/bin
 
-Data Package implementation in TypeScript. Data Package is a standard consisting of a set of simple yet extensible specifications to describe datasets, data files and tabular data. It is a data definition language (DDL) and data API that facilitates findability, accessibility, interoperability, and reusability (FAIR) of data. For more information, please visit the [documentation portal](https://dpkit.datist.io).
+dpkit is a fast TypeScript data management framework based on the Data Package standard. It supports various formats like CSV, JSON, and Parquet and integrates with data platforms such as CKAN, Zenodo, and GitHub. For more information, please visit the [documentation portal](https://dpkit.datist.io).

camtrap/OVERVIEW.md

@@ -0,0 +1,2 @@
+# @dpkit/camtrap
+

camtrap/README.md

@@ -0,0 +1,3 @@
+# @dpkit/camtrap
+
+dpkit is a fast TypeScript data management framework based on the Data Package standard. It supports various formats like CSV, JSON, and Parquet and integrates with data platforms such as CKAN, Zenodo, and GitHub. For more information, please visit the [documentation portal](https://dpkit.datist.io).

camtrap/index.ts

@@ -0,0 +1 @@
+export * from "./package/index.js"

camtrap/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@dpkit/camtrap",
+  "type": "module",
+  "main": "build/index.js",
+  "version": "0.1.0",
+  "license": "MIT",
+  "author": "Evgeny Karev",
+  "repository": "https://github.com/datisthq/dpkit",
+  "description": "Fast TypeScript data management framework based on the Data Package standard",
+  "keywords": [
+    "data",
+    "package",
+    "typescript",
+    "validation",
+    "quality",
+    "fair",
+    "camtrap"
+  ],
+  "scripts": {
+    "build": "tsc --build"
+  },
+  "dependencies": {
+    "@dpkit/core": "workspace:*"
+  }
+}

camtrap/package/Package.ts

@@ -0,0 +1,270 @@
+import type { Package } from "@dpkit/core"
+import type { Contributor, License } from "@dpkit/core"
+
+/**
+ * Camera Trap Data Package interface based on the TDWG specification
+ * @see https://camtrap-dp.tdwg.org/metadata/
+ */
+export interface CamtrapPackage extends Package {
+  /**
+   * Package profile identifier
+   * @required
+   */
+  profile: string
+
+  /**
+   * Creation date of the package
+   * @required
+   * @format ISO 8601
+   */
+  created: string
+
+  /**
+   * Contributors to the package
+   * @required
+   */
+  contributors: CamtrapContributor[]
+
+  /**
+   * Project metadata
+   * @required
+   */
+  project: {
+    /**
+     * Project identifier
+     */
+    id?: string
+
+    /**
+     * Project title
+     * @required
+     */
+    title: string
+
+    /**
+     * Project acronym
+     */
+    acronym?: string
+
+    /**
+     * Project description
+     */
+    description?: string
+
+    /**
+     * Project URL or path
+     */
+    path?: string
+
+    /**
+     * Sampling design methodology
+     * @required
+     */
+    samplingDesign:
+      | "simpleRandom"
+      | "systematicRandom"
+      | "clusteredRandom"
+      | "experimental"
+      | "targeted"
+      | "opportunistic"
+
+    /**
+     * Capture method used
+     * @required
+     */
+    captureMethod: Array<"activityDetection" | "timeLapse">
+
+    /**
+     * Whether individual animals were identified
+     * @required
+     */
+    individualAnimals: boolean
+
+    /**
+     * Level at which observations are recorded
+     * @required
+     */
+    observationLevel: Array<"media" | "event">
+  }
+
+  /**
+   * Spatial coverage of the data
+   * @required
+   */
+  spatial: GeoJSON
+
+  /**
+   * Temporal coverage of the data
+   * @required
+   */
+  temporal: {
+    /**
+     * Start date of temporal coverage
+     * @required
+     * @format ISO 8601
+     */
+    start: string
+
+    /**
+     * End date of temporal coverage
+     * @required
+     * @format ISO 8601
+     */
+    end: string
+  }
+
+  /**
+   * Taxonomic coverage of the data
+   * @required
+   */
+  taxonomic: TaxonomicCoverage[]
+
+  /**
+   * Precision of geographic coordinates
+   */
+  coordinatePrecision?: number
+
+  /**
+   * Bibliographic citation for the dataset
+   */
+  bibliographicCitation?: string
+
+  /**
+   * Related identifiers for the dataset
+   */
+  relatedIdentifiers?: RelatedIdentifier[]
+
+  /**
+   * Licenses for the package
+   * Extended with scope property
+   */
+  licenses?: CamtrapLicense[]
+}
+
+/**
+ * GeoJSON specification for spatial data
+ */
+export interface GeoJSON {
+  type: string
+  coordinates?: number[] | number[][] | number[][][] | number[][][][]
+  geometries?: any[]
+  bbox?: number[]
+  properties?: Record<string, any>
+}
+
+/**
+ * Taxonomic Coverage specification
+ */
+export interface TaxonomicCoverage {
+  /**
+   * Scientific name of the taxon
+   */
+  scientificName: string
+
+  /**
+   * Taxonomic identifier
+   */
+  taxonID?: string
+
+  /**
+   * Taxonomic rank
+   */
+  taxonRank?:
+    | "kingdom"
+    | "phylum"
+    | "class"
+    | "order"
+    | "family"
+    | "genus"
+    | "species"
+    | "subspecies"
+
+  /**
+   * Kingdom classification
+   */
+  kingdom?: string
+
+  /**
+   * Phylum classification
+   */
+  phylum?: string
+
+  /**
+   * Class classification
+   */
+  class?: string
+
+  /**
+   * Order classification
+   */
+  order?: string
+
+  /**
+   * Family classification
+   */
+  family?: string
+
+  /**
+   * Genus classification
+   */
+  genus?: string
+
+  /**
+   * Vernacular (common) names by language code
+   */
+  vernacularNames?: Record<string, string>
+}
+
+/**
+ * Related identifier specification
+ */
+export interface RelatedIdentifier {
+  /**
+   * Identifier value
+   */
+  identifier: string
+
+  /**
+   * Relationship type
+   */
+  relation:
+    | "isPartOf"
+    | "hasPart"
+    | "isVersionOf"
+    | "isSourceOf"
+    | "isDerivedFrom"
+    | "isDocumentedBy"
+    | "documents"
+    | "isReferencedBy"
+    | "references"
+
+  /**
+   * Identifier scheme
+   */
+  scheme?: "DOI" | "ARK" | "URL" | "HANDLE" | "PURL"
+}
+
+/**
+ * Extended Contributor interface specific to Camera Trap Data Package
+ */
+export interface CamtrapContributor extends Contributor {
+  /**
+   * Role of the contributor in the project
+   */
+  role?:
+    | "contact"
+    | "principalInvestigator"
+    | "rightsHolder"
+    | "publisher"
+    | "contributor"
+}
+
+/**
+ * Extended License interface specific to Camera Trap Data Package
+ */
+export interface CamtrapLicense extends License {
+  /**
+   * Scope of the license
+   */
+  scope: "data" | "media"
+}

camtrap/package/index.ts

@@ -0,0 +1 @@
+export type { CamtrapPackage } from "./Package.ts"

camtrap/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": ["index.ts"],
+  "projectDocuments": ["CHANGELOG.md", "OVERVIEW.md"],
+  "skipErrorChecking": true
+}

ckan/OVERVIEW.md

@@ -0,0 +1,2 @@
+# @dpkit/ckan
+

ckan/README.md

@@ -1,3 +1,3 @@
 # @dpkit/ckan
 
-Data Package implementation in TypeScript. Data Package is a standard consisting of a set of simple yet extensible specifications to describe datasets, data files and tabular data. It is a data definition language (DDL) and data API that facilitates findability, accessibility, interoperability, and reusability (FAIR) of data. For more information, please visit the [documentation portal](https://dpkit.datist.io).
+dpkit is a fast TypeScript data management framework based on the Data Package standard. It supports various formats like CSV, JSON, and Parquet and integrates with data platforms such as CKAN, Zenodo, and GitHub. For more information, please visit the [documentation portal](https://dpkit.datist.io).