@coffer-org/plugin-documents 1.1.0 → 1.2.0

package/dist/index.d.ts

@@ -1,3 +1,2 @@
 declare const _default: import("@coffer-org/sdk/plugin").PluginManifest;
 export default _default;
-//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,7 +1,7 @@
 import { defineVault } from '@coffer-org/sdk/vault';
 import { definePlugin } from '@coffer-org/sdk/plugin';
-import personal_document from './personal_document/index.js';
-import personIdentity from './person_identity/index.js';
+import personal_document from "./personal_document/index.js";
+import personIdentity from "./person_identity/index.js";
 export default definePlugin({
     id: 'documents',
     version: '1.0.0',
@@ -14,4 +14,3 @@ export default definePlugin({
     ],
     extends_: [personIdentity],
 });
-//# sourceMappingURL=index.js.map

package/dist/person_identity/index.d.ts

@@ -1,3 +1,2 @@
 declare const _default: import("@coffer-org/sdk/extend").ExtendDef;
 export default _default;
-//# sourceMappingURL=index.d.ts.map

package/dist/person_identity/index.js

@@ -1,8 +1,3 @@
-/**
- * Extend: канон ідентичності людини (не прив'язано до фізичного документа).
- * Прив'язується до people/person. На відміну від personal_document (дані,
- * розпізнані з конкретного фізичного документа) — це канонічні значення.
- */
 import { defineExtend } from '@coffer-org/sdk/extend';
 import { field } from '@coffer-org/sdk/fields';
 export default defineExtend({
@@ -10,21 +5,18 @@ export default defineExtend({
     label: 'documents.person_identity.label',
     icon: 'lucide:globe',
     attachTo: [{ vault: 'people', module: 'person' }],
-    claude: `Канон ідентичності людини (не прив'язано до фізичного документа).
-nationality — ISO alpha-2. variants — ім'я/прізвище мовами (field.group multiple: lang+name+surname).`,
+    claude: `Canonical person identity (not tied to a physical document).
+nationality — ISO alpha-2. variants — given/family name per language (field.group multiple: lang+name+surname).`,
     fields: [
         field.select({ key: 'nationality', label: 'documents.person_identity.fields.nationality', options: 'countries' }),
-        field.group({
+        field.keyed({
             key: 'variants',
             label: 'documents.person_identity.fields.variants',
-            multiple: true,
-            unique: ['lang'],
+            by: field.select({ key: 'lang', label: 'documents.person_identity.variants.lang', options: 'languages' }),
             fields: [
-                field.select({ key: 'lang', label: 'documents.person_identity.variants.lang', options: 'languages' }),
                 field.string({ key: 'name', label: 'documents.person_identity.variants.name' }),
                 field.string({ key: 'surname', label: 'documents.person_identity.variants.surname' }),
             ],
         }),
     ],
 });
-//# sourceMappingURL=index.js.map

package/dist/personal_document/index.d.ts

@@ -1,3 +1,2 @@
 declare const _default: import("@coffer-org/sdk/module").ModuleDef;
 export default _default;
-//# sourceMappingURL=index.d.ts.map

package/dist/personal_document/index.js

@@ -11,9 +11,9 @@ export default defineModule({
     fields: [
         field.title({ key: 'name', label: 'core.fields.name' }),
         field.image({ key: 'logo', label: 'documents.personal_document.fields.logo' }),
-        field.text({ key: 'description', label: 'documents.personal_document.fields.description', max: 1000 }),
-        field.string({ key: 'surname', label: 'documents.personal_document.fields.surname', config: { max: 100 } }),
-        field.string({ key: 'given_names', label: 'documents.personal_document.fields.given_names', config: { max: 200 } }),
+        field.text({ key: 'description', label: 'documents.personal_document.fields.description', rules: { max: 1000 } }),
+        field.string({ key: 'surname', label: 'documents.personal_document.fields.surname', rules: { max: 100 } }),
+        field.string({ key: 'given_names', label: 'documents.personal_document.fields.given_names', rules: { max: 200 } }),
         field.select({
             key: 'sex',
             label: 'documents.personal_document.fields.sex',
@@ -24,27 +24,20 @@ export default defineModule({
         }),
         field.date({ key: 'birth_date', label: 'documents.personal_document.fields.birth_date' }),
         field.select({ key: 'nationality', label: 'documents.personal_document.fields.nationality', options: 'countries' }),
-        field.string({ key: 'number', label: 'documents.personal_document.fields.number', config: { max: 50 } }),
-        field.string({ key: 'record_no', label: 'documents.personal_document.fields.record_no', config: { max: 50 } }),
+        field.string({ key: 'number', label: 'documents.personal_document.fields.number', rules: { max: 50 } }),
+        field.string({ key: 'record_no', label: 'documents.personal_document.fields.record_no', rules: { max: 50 } }),
         field.date({ key: 'issued', label: 'documents.personal_document.fields.issued' }),
-        field.date({ key: 'expires', label: 'documents.personal_document.fields.expires' }),
-        field.string({ key: 'authority', label: 'documents.personal_document.fields.authority', config: { max: 200 } }),
-        field.select({
-            key: 'country_code',
-            label: 'documents.personal_document.fields.country_code',
-            options: 'countries',
-        }),
-        field.string({ key: 'storage', label: 'documents.personal_document.fields.storage', config: { max: 200 } }),
-        field.string({ key: 'mrz', label: 'documents.personal_document.fields.mrz', config: { max: 200 } }),
-        field.int({ key: 'remind_days', label: 'documents.personal_document.fields.remind_days', config: { min: 0 } }),
+        field.reminder({ key: 'expires', label: 'documents.personal_document.fields.expires', rules: { lead: 60 } }),
+        field.string({ key: 'authority', label: 'documents.personal_document.fields.authority', rules: { max: 200 } }),
+        field.relation({ key: 'storage', label: 'documents.personal_document.fields.storage', options: { vault: 'things', module: 'storage_location' } }),
+        field.string({ key: 'mrz', label: 'documents.personal_document.fields.mrz', rules: { max: 200 } }),
         field.relation({
             key: 'owner',
             label: 'documents.personal_document.fields.owner',
-            vault: 'people',
-            module: 'person',
+            options: { vault: 'people', module: 'person' },
         }),
         field.image({ key: 'photos', label: 'documents.personal_document.fields.photos', multiple: true }),
-        field.text({ key: 'notes', label: 'documents.personal_document.fields.notes', max: 1000 }),
+        field.text({ key: 'notes', label: 'documents.personal_document.fields.notes', rules: { max: 1000 } }),
         field.select({
             key: 'type',
             label: 'core.fields.type',
@@ -63,4 +56,3 @@ export default defineModule({
         field.tags({ key: 'tags', label: 'documents.personal_document.fields.tags' }),
     ],
 });
-//# sourceMappingURL=index.js.map

package/dist/runtime/index.d.ts

@@ -0,0 +1,2 @@
+import type { PluginHooks } from '@coffer-org/server/plugin-hooks';
+export declare const serverHooks: PluginHooks;

package/dist/runtime/index.js

@@ -0,0 +1,90 @@
+import { fileURLToPath } from 'node:url';
+import { localPost } from '@coffer-org/server/local-api';
+import { seedAsset } from '@coffer-org/server/uploads';
+const asset = (rel) => fileURLToPath(new URL(`../../seed/assets/${rel}`, import.meta.url));
+export const serverHooks = {
+    migrations: [
+        {
+            version: 1,
+            up: async ({ table }) => {
+                await table('documents__personal_document').changeType('storage', 'text', {
+                    transform: (old) => {
+                        if (old)
+                            console.warn(`[documents migration] storage reset: ${String(old)}`);
+                        return null;
+                    },
+                });
+            },
+        },
+    ],
+    seed: [
+        {
+            name: 'demo-documents',
+            run: async () => {
+                const logo = seedAsset(asset('document.svg'));
+                await localPost('documents', 'personal_document', {
+                    name: 'Passport',
+                    type: 'P',
+                    logo,
+                    surname: 'Johnson',
+                    given_names: 'Emma',
+                    sex: 'F',
+                    birth_date: '1990-04-17',
+                    nationality: 'US',
+                    number: 'FA123456',
+                    record_no: '19900417-12345',
+                    issued: '2018-05-20',
+                    expires: '2028-05-20',
+                    authority: '8025',
+                    mrz: 'P<USAJOHNSON<<EMMA<<<<<<<<<<<<<<<<<<<<<<<<<<\nFA1234567USA9004173F2805201<<<<<<<<<<<<<<00',
+                    notes: 'Biometric international passport. Keep in the safe.',
+                    photos: [logo],
+                    tags: ['passport', 'personal'],
+                });
+                await localPost('documents', 'personal_document', {
+                    name: 'ID card',
+                    type: 'ID',
+                    logo,
+                    surname: 'Miller',
+                    given_names: 'James',
+                    sex: 'M',
+                    birth_date: '1985-11-02',
+                    nationality: 'US',
+                    number: '001234567',
+                    record_no: '19851102-67890',
+                    issued: '2019-02-14',
+                    expires: '2029-02-14',
+                    authority: '4641',
+                    mrz: 'IDUSA0012345677<<<<<<<<<<<<<<<\n8511020M2902145USA<<<<<<<<<<<4',
+                    notes: 'National ID card. Linked to the record in the demographic registry.',
+                    photos: [logo],
+                    tags: ['id', 'personal'],
+                });
+                await localPost('documents', 'personal_document', {
+                    name: "Driver's license",
+                    type: 'DL',
+                    logo,
+                    surname: 'Davis',
+                    given_names: 'Olivia',
+                    sex: 'F',
+                    birth_date: '1978-07-29',
+                    nationality: 'US',
+                    number: 'ABC123456',
+                    record_no: '19780729-11223',
+                    issued: '2021-09-01',
+                    expires: '2031-09-01',
+                    authority: 'DMV 8041',
+                    mrz: '',
+                    notes: 'Categories B, C. Duplicate obtained after a replacement.',
+                    photos: [logo],
+                    tags: ['auto', 'personal'],
+                });
+            },
+        },
+    ],
+    agent: {
+        instructions: 'Vault documents — personal documents (personal_document): type, number, issued/expires (ISO), ' +
+            'authority, owner (relation to people). Expiring documents — count by expires.' +
+            ' When a document is reissued — update number/issued/expires via update_record.',
+    },
+};

package/package.json

@@ -1,14 +1,22 @@
 {
   "name": "@coffer-org/plugin-documents",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
   "files": [
-    "dist"
+    "dist",
+    "seed"
   ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./runtime": {
+      "types": "./dist/runtime/index.d.ts",
+      "default": "./dist/runtime/index.js"
     }
   },
   "scripts": {
@@ -17,6 +25,7 @@
     "postpack": "node ../../scripts/swap-exports.mjs src"
   },
   "dependencies": {
-    "@coffer-org/sdk": "^1.1.0"
+    "@coffer-org/sdk": "^1.2.0",
+    "@coffer-org/server": "^1.2.0"
   }
 }

package/seed/assets/document.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 64 64" fill="none">
+  <rect x="12" y="6" width="40" height="52" rx="4" fill="#0ea5e9"/>
+  <rect x="20" y="16" width="24" height="6" rx="2" fill="#e0f2fe"/>
+  <rect x="20" y="28" width="24" height="4" rx="2" fill="#bae6fd"/>
+  <rect x="20" y="38" width="18" height="4" rx="2" fill="#bae6fd"/>
+  <rect x="20" y="46" width="14" height="4" rx="2" fill="#bae6fd"/>
+</svg>

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAKA,wBAWG"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,iBAAiB,MAAM,8BAA8B,CAAC;AAC7D,OAAO,cAAc,MAAM,4BAA4B,CAAC;AAExD,eAAe,YAAY,CAAC;IAC1B,EAAE,EAAE,WAAW;IACf,OAAO,EAAE,OAAO;IAChB,SAAS,EAAE,CAAC,QAAQ,CAAC;IACrB,MAAM,EAAE;QACN;YACE,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,uBAAuB,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;YAC9F,OAAO,EAAE,CAAC,iBAAiB,CAAC;SAC7B;KACF;IACD,QAAQ,EAAE,CAAC,cAAc,CAAC;CAC3B,CAAC,CAAC"}

package/dist/person_identity/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/person_identity/index.ts"],"names":[],"mappings":";AAQA,wBAqBG"}

package/dist/person_identity/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/person_identity/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C,eAAe,YAAY,CAAC;IAC1B,EAAE,EAAE,iBAAiB;IACrB,KAAK,EAAE,iCAAiC;IACxC,IAAI,EAAE,cAAc;IACpB,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IACjD,MAAM,EAAE;sGAC4F;IACpG,MAAM,EAAE;QACN,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,8CAA8C,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QACjH,KAAK,CAAC,KAAK,CAAC;YACV,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,2CAA2C;YAClD,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,CAAC,MAAM,CAAC;YAChB,MAAM,EAAE;gBACN,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,yCAAyC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;gBACrG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,yCAAyC,EAAE,CAAC;gBAC/E,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,4CAA4C,EAAE,CAAC;aACtF;SACF,CAAC;KACH;CACF,CAAC,CAAC"}

package/dist/personal_document/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/personal_document/index.ts"],"names":[],"mappings":";AAGA,wBA8DG"}

package/dist/personal_document/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/personal_document/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C,eAAe,YAAY,CAAC;IAC1B,MAAM,EAAE,mBAAmB;IAC3B,KAAK,EAAE,WAAW;IAClB,KAAK,EAAE,mCAAmC;IAC1C,IAAI,EAAE,gBAAgB;IACtB,KAAK,EAAE;QACL,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC;KAC/C;IACD,MAAM,EAAE;QACN,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC;QACvD,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,yCAAyC,EAAE,CAAC;QAC9E,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,gDAAgD,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;QACtG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,4CAA4C,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QAC3G,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,gDAAgD,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QACnH,KAAK,CAAC,MAAM,CAAC;YACX,GAAG,EAAE,KAAK;YACV,KAAK,EAAE,wCAAwC;YAC/C,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,2CAA2C,EAAE;gBAClE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,2CAA2C,EAAE;aACnE;SACF,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,KAAK,EAAE,+CAA+C,EAAE,CAAC;QACzF,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,gDAAgD,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QACnH,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,2CAA2C,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC;QACxG,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,8CAA8C,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC;QAC9G,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,2CAA2C,EAAE,CAAC;QACjF,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,4CAA4C,EAAE,CAAC;QACnF,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,KAAK,EAAE,8CAA8C,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QAC/G,KAAK,CAAC,MAAM,CAAC;YACX,GAAG,EAAE,cAAc;YACnB,KAAK,EAAE,iDAAiD;YACxD,OAAO,EAAE,WAAW;SACrB,CAAC;QACF,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,4CAA4C,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QAC3G,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,wCAAwC,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;QACnG,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,gDAAgD,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9G,KAAK,CAAC,QAAQ,CAAC;YACb,GAAG,EAAE,OAAO;YACZ,KAAK,EAAE,0CAA0C;YACjD,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;SACjB,CAAC;QACF,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,2CAA2C,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAClG,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,0CAA0C,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;QAC1F,KAAK,CAAC,MAAM,CAAC;YACX,GAAG,EAAE,MAAM;YACX,KAAK,EAAE,kBAAkB;YACzB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE;gBACP,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,4CAA4C,EAAE;gBACnE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,6CAA6C,EAAE;gBACrE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,6CAA6C,EAAE;gBACrE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,6CAA6C,EAAE;gBACrE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,6CAA6C,EAAE;gBACrE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,6CAA6C,EAAE;gBACrE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,6CAA6C,EAAE;gBACrE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,6CAA6C,EAAE;aACtE;SACF,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,yCAAyC,EAAE,CAAC;KAC9E;CACF,CAAC,CAAC"}