@larsgw/formica 0.7.1 → 0.7.3

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [0.7.3](https://github.com/identification-resources/formica/compare/v0.7.2...v0.7.3) (2025-04-17)
+
+
+### Features
+
+* **catalog:** update validation for identifiers ([156a703](https://github.com/identification-resources/formica/commit/156a7036ab09c411d091bc9d0f628831a30ba3f5))
+
+
+
+## [0.7.2](https://github.com/identification-resources/formica/compare/v0.7.1...v0.7.2) (2025-04-02)
+
+
+### Features
+
+* **catalog:** add validation for taxa.csv ([59cfcf2](https://github.com/identification-resources/formica/commit/59cfcf28ebbef42e28e648e800c178a7d528f37a))
+
+
+
 ## [0.7.1](https://github.com/identification-resources/formica/compare/v0.7.0...v0.7.1) (2025-03-25)
 
 

package/lib/catalog/index.js

@@ -12,6 +12,7 @@ function getTypeInfo(type) {
         case 'authors': return index_1.TYPE_INFO.authors;
         case 'places': return index_1.TYPE_INFO.places;
         case 'publishers': return index_1.TYPE_INFO.publishers;
+        case 'taxa': return index_1.TYPE_INFO.taxa;
         case 'catalog': return index_1.TYPE_INFO.catalog;
         default: throw new TypeError("Unknown type \"".concat(type, "\""));
     }

package/lib/catalog/tables/author.js

@@ -22,10 +22,12 @@ var Author = /** @class */ (function (_super) {
     __extends(Author, _super);
     function Author(values) {
         return _super.call(this, values, {
-            name: { required: true, multiple: false },
+            name: { required: true, multiple: true },
+            id: { required: true, multiple: false, format: value_1.FORMATS.AUTHOR_ID },
             qid: { required: false, multiple: false, format: value_1.FORMATS.QID },
-            main_full_name: { required: false, multiple: false },
-            full_names: { required: false, multiple: true }
+            display_name: { required: false, multiple: false },
+            full_names: { required: false, multiple: true },
+            duplicate_of: { required: false, multiple: false, format: value_1.FORMATS.AUTHOR_ID }
         }) || this;
     }
     return Author;

package/lib/catalog/tables/index.js

@@ -4,10 +4,12 @@ exports.TYPE_INFO = void 0;
 var author_1 = require("./author");
 var publisher_1 = require("./publisher");
 var place_1 = require("./place");
+var taxon_1 = require("./taxon");
 var work_1 = require("./work");
 exports.TYPE_INFO = {
-    authors: [author_1.Author, 'name'],
-    publishers: [publisher_1.Publisher, 'name'],
-    places: [place_1.Place, 'name'],
+    authors: [author_1.Author, 'id'],
+    publishers: [publisher_1.Publisher, 'id'],
+    places: [place_1.Place, 'id'],
+    taxa: [taxon_1.Taxon, 'id'],
     catalog: [work_1.Work, 'id']
 };

package/lib/catalog/tables/place.js

@@ -23,8 +23,10 @@ var Place = /** @class */ (function (_super) {
     function Place(values) {
         return _super.call(this, values, {
             name: { required: true, multiple: false },
+            id: { required: true, multiple: false, format: value_1.FORMATS.PLACE_ID },
             qid: { required: false, multiple: false, format: value_1.FORMATS.QID },
-            display_name: { required: false, multiple: false }
+            display_name: { required: false, multiple: false },
+            duplicate_of: { required: false, multiple: false, format: value_1.FORMATS.PLACE_ID }
         }) || this;
     }
     return Place;

package/lib/catalog/tables/publisher.js

@@ -22,10 +22,12 @@ var Publisher = /** @class */ (function (_super) {
     __extends(Publisher, _super);
     function Publisher(values) {
         return _super.call(this, values, {
-            name: { required: true, multiple: false },
+            name: { required: true, multiple: true },
+            id: { required: true, multiple: false, format: value_1.FORMATS.PUBLISHER_ID },
             qid: { required: false, multiple: false, format: value_1.FORMATS.QID },
-            full_name: { required: false, multiple: false },
-            long_name: { required: false, multiple: true }
+            display_name: { required: false, multiple: false },
+            full_names: { required: false, multiple: true },
+            duplicate_of: { required: false, multiple: false, format: value_1.FORMATS.PUBLISHER_ID }
         }) || this;
     }
     return Publisher;

package/lib/catalog/tables/taxon.d.ts

@@ -0,0 +1,4 @@
+import { Entity } from '../entity';
+export declare class Taxon extends Entity {
+    constructor(values: Record<string, string>);
+}

package/lib/catalog/tables/taxon.js

@@ -0,0 +1,37 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Taxon = void 0;
+var value_1 = require("../value");
+var entity_1 = require("../entity");
+var Taxon = /** @class */ (function (_super) {
+    __extends(Taxon, _super);
+    function Taxon(values) {
+        return _super.call(this, values, {
+            name: { required: true, multiple: false },
+            id: { required: true, multiple: false, format: value_1.FORMATS.TAXON_ID },
+            qid: { required: false, multiple: false, format: value_1.FORMATS.QID },
+            rank: { required: false, multiple: false },
+            gbif: { required: false, multiple: false, format: value_1.FORMATS.INTEGER },
+            children_gbif: { required: false, multiple: true, format: value_1.FORMATS.INTEGER },
+            ancestors_gbif: { required: false, multiple: true, format: value_1.FORMATS.INTEGER },
+            duplicate_of: { required: false, multiple: false, format: value_1.FORMATS.TAXON_ID }
+        }) || this;
+    }
+    return Taxon;
+}(entity_1.Entity));
+exports.Taxon = Taxon;

package/lib/catalog/tables/work.js

@@ -22,7 +22,7 @@ var Work = /** @class */ (function (_super) {
     __extends(Work, _super);
     function Work(values) {
         return _super.call(this, values, {
-            id: { required: true, multiple: false, format: value_1.FORMATS.ID },
+            id: { required: true, multiple: false, format: value_1.FORMATS.WORK_ID },
             title: { required: true, multiple: value_1.CHECK.MULTILANG },
             author: { required: false, multiple: true },
             url: { required: false, multiple: true, format: value_1.FORMATS.URL },
@@ -49,10 +49,10 @@ var Work = /** @class */ (function (_super) {
             region: { required: true, multiple: true },
             complete: { required: false, multiple: false, format: value_1.FORMATS.COMPLETE },
             target_taxa: { required: false, multiple: true },
-            listed_in: { required: false, multiple: true, format: value_1.FORMATS.ID },
-            part_of: { required: false, multiple: true, format: value_1.FORMATS.ID },
-            version_of: { required: false, multiple: true, format: value_1.FORMATS.ID },
-            duplicate_of: { required: false, multiple: false, format: value_1.FORMATS.ID }
+            listed_in: { required: false, multiple: true, format: value_1.FORMATS.WORK_ID },
+            part_of: { required: false, multiple: true, format: value_1.FORMATS.WORK_ID },
+            version_of: { required: false, multiple: true, format: value_1.FORMATS.WORK_ID },
+            duplicate_of: { required: false, multiple: false, format: value_1.FORMATS.WORK_ID }
         }) || this;
     }
     Work.prototype.deriveFields = function () {

package/lib/catalog/value.d.ts

@@ -2,13 +2,18 @@ export declare const FORMATS: {
     ENTRY_TYPE: string[];
     KEY_TYPE: string[];
     COMPLETE: string[];
-    ID: RegExp;
+    WORK_ID: RegExp;
+    AUTHOR_ID: RegExp;
+    PLACE_ID: RegExp;
+    PUBLISHER_ID: RegExp;
+    TAXON_ID: RegExp;
     EDTF_0: RegExp;
     ISSN_L: RegExp;
     ISBN: RegExp;
     DOI: RegExp;
     QID: RegExp;
     URL: RegExp;
+    INTEGER: RegExp;
     LICENSE(value: SingleValue): true;
     LANGUAGE(value: SingleValue): any;
 };

package/lib/catalog/value.js

@@ -10,13 +10,18 @@ exports.FORMATS = {
     ENTRY_TYPE: ['print', 'online', 'cd', 'application'],
     KEY_TYPE: ['key', 'matrix', 'reference', 'gallery', 'checklist', 'supplement', 'collection', 'algorithm'],
     COMPLETE: ['TRUE', 'FALSE'],
-    ID: /^B\d+$/,
+    WORK_ID: /^B[1-9]\d*$/,
+    AUTHOR_ID: /^A[1-9]\d*$/,
+    PLACE_ID: /^G[1-9]\d*$/,
+    PUBLISHER_ID: /^P[1-9]\d*$/,
+    TAXON_ID: /^T[1-9]\d*$/,
     EDTF_0: /^(\d{4}(-\d{2}(-\d{2}(T\d{2}:\d{2}:\d{2}(Z|[-+]\d{2}(:\d{2})?))?)?)?|\d{4}(-\d{2}(-\d{2})?)?\/(\d{4}(-\d{2}(-\d{2})?)?|\.\.))$/,
     ISSN_L: /^[0-9]{4}-[0-9]{3}[0-9X]$/,
     ISBN: /^(\d{13}|\d{9}[0-9X])$/,
     DOI: /^10\./,
     QID: /^Q[1-9][0-9]*$/,
     URL: /^(ftp|http|https):\/\/((?:[a-z0-9][a-z0-9-_]*?[a-z0-9]?\.)+(?:xn--)?[a-z0-9]+)(:\d*)?((?:\/(?:%\d\d|[!$&'()*+,\-.0-9";=@A-Z_a-z~])*)*)(\?(?:%\d\d|[!$&'()*+,\-./0-9:;=?@A-Z_a-z~])*)?(#(?:%\d\d|[!$&'()*+,\-./0-9:;=?@A-Z_a-z~])*)?/i,
+    INTEGER: /^(0|[1-9]\d*)$/,
     LICENSE: function (value) { return /^<(public domain|.+\?)>$/.test(value) || !!spdxLicenseList[value]; },
     LANGUAGE: function (value) { return ietfTagList.test(value); }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@larsgw/formica",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "description": "SDK and tools for data from the Library of Identification Resources",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/catalog/index.ts

@@ -8,6 +8,7 @@ function getTypeInfo (type: string): [typeof Entity, string] {
         case 'authors': return TYPE_INFO.authors
         case 'places': return TYPE_INFO.places
         case 'publishers': return TYPE_INFO.publishers
+        case 'taxa': return TYPE_INFO.taxa
         case 'catalog': return TYPE_INFO.catalog
         default: throw new TypeError(`Unknown type "${type}"`)
     }

package/src/catalog/tables/author.ts

@@ -4,10 +4,12 @@ import { Entity } from '../entity'
 export class Author extends Entity {
     constructor (values: Record<string, string>) {
         super(values, {
-            name: { required: true, multiple: false },
+            name: { required: true, multiple: true },
+            id: { required: true, multiple: false, format: FORMATS.AUTHOR_ID },
             qid: { required: false, multiple: false, format: FORMATS.QID },
-            main_full_name: { required: false, multiple: false },
-            full_names: { required: false, multiple: true }
+            display_name: { required: false, multiple: false },
+            full_names: { required: false, multiple: true },
+            duplicate_of: { required: false, multiple: false, format: FORMATS.AUTHOR_ID }
         })
     }
 }

package/src/catalog/tables/index.ts

@@ -2,11 +2,13 @@ import { Entity } from '../entity'
 import { Author } from './author'
 import { Publisher } from './publisher'
 import { Place } from './place'
+import { Taxon } from './taxon'
 import { Work } from './work'
 
 export const TYPE_INFO: Record<string, [typeof Entity, string]> = {
-    authors: [Author, 'name'],
-    publishers: [Publisher, 'name'],
-    places: [Place, 'name'],
+    authors: [Author, 'id'],
+    publishers: [Publisher, 'id'],
+    places: [Place, 'id'],
+    taxa: [Taxon, 'id'],
     catalog: [Work, 'id']
 }

package/src/catalog/tables/place.ts

@@ -5,8 +5,10 @@ export class Place extends Entity {
     constructor (values: Record<string, string>) {
         super(values, {
             name: { required: true, multiple: false },
+            id: { required: true, multiple: false, format: FORMATS.PLACE_ID },
             qid: { required: false, multiple: false, format: FORMATS.QID },
-            display_name: { required: false, multiple: false }
+            display_name: { required: false, multiple: false },
+            duplicate_of: { required: false, multiple: false, format: FORMATS.PLACE_ID }
         })
     }
 }

package/src/catalog/tables/publisher.ts

@@ -4,10 +4,12 @@ import { Entity } from '../entity'
 export class Publisher extends Entity {
     constructor (values: Record<string, string>) {
         super(values, {
-            name: { required: true, multiple: false },
+            name: { required: true, multiple: true },
+            id: { required: true, multiple: false, format: FORMATS.PUBLISHER_ID },
             qid: { required: false, multiple: false, format: FORMATS.QID },
-            full_name: { required: false, multiple: false },
-            long_name: { required: false, multiple: true }
+            display_name: { required: false, multiple: false },
+            full_names: { required: false, multiple: true },
+            duplicate_of: { required: false, multiple: false, format: FORMATS.PUBLISHER_ID }
         })
     }
 }

package/src/catalog/tables/taxon.ts

@@ -0,0 +1,17 @@
+import { FORMATS } from '../value'
+import { Entity } from '../entity'
+
+export class Taxon extends Entity {
+    constructor (values: Record<string, string>) {
+        super(values, {
+            name: { required: true, multiple: false },
+            id: { required: true, multiple: false, format: FORMATS.TAXON_ID },
+            qid: { required: false, multiple: false, format: FORMATS.QID },
+            rank: { required: false, multiple: false },
+            gbif: { required: false, multiple: false, format: FORMATS.INTEGER },
+            children_gbif: { required: false, multiple: true, format: FORMATS.INTEGER },
+            ancestors_gbif: { required: false, multiple: true, format: FORMATS.INTEGER },
+            duplicate_of: { required: false, multiple: false, format: FORMATS.TAXON_ID }
+        })
+    }
+}

package/src/catalog/tables/work.ts

@@ -4,7 +4,7 @@ import { Entity } from '../entity'
 export class Work extends Entity {
     constructor (values: Record<string, string>) {
         super(values, {
-            id: { required: true, multiple: false, format: FORMATS.ID },
+            id: { required: true, multiple: false, format: FORMATS.WORK_ID },
             title: { required: true, multiple: CHECK.MULTILANG },
             author: { required: false, multiple: true },
             url: { required: false, multiple: true, format: FORMATS.URL },
@@ -31,10 +31,10 @@ export class Work extends Entity {
             region: { required: true, multiple: true },
             complete: { required: false, multiple: false, format: FORMATS.COMPLETE },
             target_taxa: { required: false, multiple: true },
-            listed_in: { required: false, multiple: true, format: FORMATS.ID },
-            part_of: { required: false, multiple: true, format: FORMATS.ID },
-            version_of: { required: false, multiple: true, format: FORMATS.ID },
-            duplicate_of: { required: false, multiple: false, format: FORMATS.ID }
+            listed_in: { required: false, multiple: true, format: FORMATS.WORK_ID },
+            part_of: { required: false, multiple: true, format: FORMATS.WORK_ID },
+            version_of: { required: false, multiple: true, format: FORMATS.WORK_ID },
+            duplicate_of: { required: false, multiple: false, format: FORMATS.WORK_ID }
         })
     }
 

package/src/catalog/value.ts

@@ -10,13 +10,18 @@ export const FORMATS = {
     KEY_TYPE: ['key', 'matrix', 'reference', 'gallery', 'checklist', 'supplement', 'collection', 'algorithm'],
     COMPLETE: ['TRUE', 'FALSE'],
 
-    ID: /^B\d+$/,
+    WORK_ID: /^B[1-9]\d*$/,
+    AUTHOR_ID: /^A[1-9]\d*$/,
+    PLACE_ID: /^G[1-9]\d*$/,
+    PUBLISHER_ID: /^P[1-9]\d*$/,
+    TAXON_ID: /^T[1-9]\d*$/,
     EDTF_0: /^(\d{4}(-\d{2}(-\d{2}(T\d{2}:\d{2}:\d{2}(Z|[-+]\d{2}(:\d{2})?))?)?)?|\d{4}(-\d{2}(-\d{2})?)?\/(\d{4}(-\d{2}(-\d{2})?)?|\.\.))$/,
     ISSN_L: /^[0-9]{4}-[0-9]{3}[0-9X]$/,
     ISBN: /^(\d{13}|\d{9}[0-9X])$/,
     DOI: /^10\./,
     QID: /^Q[1-9][0-9]*$/,
     URL: /^(ftp|http|https):\/\/((?:[a-z0-9][a-z0-9-_]*?[a-z0-9]?\.)+(?:xn--)?[a-z0-9]+)(:\d*)?((?:\/(?:%\d\d|[!$&'()*+,\-.0-9";=@A-Z_a-z~])*)*)(\?(?:%\d\d|[!$&'()*+,\-./0-9:;=?@A-Z_a-z~])*)?(#(?:%\d\d|[!$&'()*+,\-./0-9:;=?@A-Z_a-z~])*)?/i,
+    INTEGER: /^(0|[1-9]\d*)$/,
 
     LICENSE (value: SingleValue) { return /^<(public domain|.+\?)>$/.test(value) || !!spdxLicenseList[value] },
     LANGUAGE (value: SingleValue) { return ietfTagList.test(value) }