@yanqirenshi/model.tm 0.0.0-stage → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAKlE,4DAA4D;AAC5D,wBAAgB,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,EAAE,CAUtD;AAED,uBAAuB;AACvB,eAAO,MAAM,aAAa,EAAE,SAAS,OAAO,EAM3C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,SAAS,OAAO,EAgBjD,CAAC;AAEF,4BAA4B;AAC5B,eAAO,MAAM,aAAa,EAAE,SAAS,OAAO,EAG3C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,YAAY,GAAG,OAAO,EAAE,CAShF"}
package/dist/fields.js ADDED
@@ -0,0 +1,72 @@
1
+ // 編集できる項目の一覧。インスペクタ(colonoscope の ModelInspector)に渡す。
2
+ //
3
+ // path はレコードの実際の項目を指す。既定値は withDefaults() で重ねてから渡すので、
4
+ // 書いていない項目(関係の角度など)も、図に描かれている値が初期値として出る。
5
+ // type: 'readonly' は表示だけ。options は取りうる値の一覧(検証にも使う。文字列で持つ)。
6
+ //
7
+ // 名前は、レコードが文字列で持っていれば name、{ logical, physical } で持っていれば
8
+ // name.logical / name.physical を出す(どちらで書いたかを変えない)。
9
+ // エンティティのインスタンス(識別子・属性の行)は entities[] の入れ子で、JSON Merge Patch では 1 要素を指せないので
10
+ // 項目にしない(行を右クリックしたときはマスタを開く)。
11
+ import { CARDINALITIES, ENTITY_TYPES, OPTIONALITIES, SUBSET_KINDS, kindOf } from './defaults.js';
12
+ const CARDINALITY_OPTIONS = CARDINALITIES.map(String);
13
+ const OPTIONALITY_OPTIONS = OPTIONALITIES.map(String);
14
+ /** 名前の項目。name が Name(オブジェクト)なら論理名・物理名の 2 項目、それ以外は名称 1 項目 */
15
+ export function nameFields(record) {
16
+ const name = record.name;
17
+ if (name && typeof name === 'object')
18
+ return [
19
+ { path: 'name.logical', label: '論理名', type: 'text' },
20
+ { path: 'name.physical', label: '物理名', type: 'text' },
21
+ ];
22
+ return [{ path: 'name', label: '名称', type: 'text' }];
23
+ }
24
+ /** エンティティの項目(名前のあと) */
25
+ export const ENTITY_FIELDS = [
26
+ { path: 'type', label: '種別', type: 'text', options: ENTITY_TYPES },
27
+ { path: 'id', label: 'ID', type: 'readonly' },
28
+ { path: 'description', label: '説明', type: 'textarea' },
29
+ { path: 'size.w', label: '幅 (0 で自動)', type: 'number' },
30
+ { path: 'size.h', label: '高さ (0 で自動)', type: 'number' },
31
+ ];
32
+ /**
33
+ * 関係の項目。接続位置はエンティティの中心から見た角度(0=真下・時計回り。90=左 / 180=真上 / 270=右)。
34
+ * カーディナリティ・オプショナリティは空にできる(記号を描かない)。
35
+ */
36
+ export const RELATIONSHIP_FIELDS = [
37
+ { path: 'id', label: 'ID', type: 'readonly' },
38
+ { path: 'type', label: '種類', type: 'text' },
39
+ { path: 'label', label: 'ラベル', type: 'text' },
40
+ { path: 'from.entity', label: '接続元のエンティティ', type: 'readonly' },
41
+ { path: 'from.position', label: '接続元の位置 (角度)', type: 'number' },
42
+ { path: 'from.cardinality', label: '接続元のカーディナリティ (空で無し)', type: 'text', options: CARDINALITY_OPTIONS },
43
+ { path: 'from.optionality', label: '接続元のオプショナリティ (空で無し)', type: 'text', options: OPTIONALITY_OPTIONS },
44
+ { path: 'to.entity', label: '接続先のエンティティ', type: 'readonly' },
45
+ { path: 'to.position', label: '接続先の位置 (角度)', type: 'number' },
46
+ { path: 'to.cardinality', label: '接続先のカーディナリティ (空で無し)', type: 'text', options: CARDINALITY_OPTIONS },
47
+ { path: 'to.optionality', label: '接続先のオプショナリティ (空で無し)', type: 'text', options: OPTIONALITY_OPTIONS },
48
+ { path: 'subset.kind', label: 'サブセットの区分 (same は =、different は ×)', type: 'text', options: SUBSET_KINDS },
49
+ { path: 'subset.code', label: 'サブセットの区分コード', type: 'text' },
50
+ { path: 'mapping.entity', label: '垂下する表 (エンティティ)', type: 'readonly' },
51
+ { path: 'description', label: '説明', type: 'textarea' },
52
+ ];
53
+ /** マスタ(識別子・属性)の項目(名前のあと) */
54
+ export const MASTER_FIELDS = [
55
+ { path: 'description', label: '説明', type: 'textarea' },
56
+ { path: 'id', label: 'ID', type: 'readonly' },
57
+ ];
58
+ /**
59
+ * レコードに応じた項目の一覧。
60
+ * マスタは identifiers / attributes のどちらかをレコードの形から判別できないので、利用側が collection を渡す
61
+ * (項目は同じなので、渡さなくても一覧は変わらない。applyPatch では必須)。
62
+ */
63
+ export function fieldsOf(record, _collection) {
64
+ switch (kindOf(record)) {
65
+ case 'relationship':
66
+ return [...RELATIONSHIP_FIELDS];
67
+ case 'entity':
68
+ return [...nameFields(record), ...ENTITY_FIELDS];
69
+ default:
70
+ return [...nameFields(record), ...MASTER_FIELDS];
71
+ }
72
+ }
@@ -0,0 +1,8 @@
1
+ export type { TmId, TmName, TmEntityType, TmMasterRecord, TmIdentifierRef, TmAttributeRef, TmEntityRecord, TmCardinality, TmOptionality, TmRelationshipEnd, TmRelationshipDetail, TmSubset, TmRelationshipRecord, TmRecord, TmGraph, TmMasterCollection, TmCollection, TmKind, MergePatch, TmChange, TmMove, TmFieldType, TmField, TmValues, } from './types.js';
2
+ export type { TmFilledEnd } from './defaults.js';
3
+ export { ENTITY_TYPES, TYPE_BADGES, TYPE_COLORS, MAPPING_TYPES, SUBSET_KINDS, CARDINALITIES, OPTIONALITIES, ENTITY_DEFAULTS, RELATIONSHIP_DEFAULTS, isEntityType, isRelationship, isEntity, kindOf, nameOf, endWithDefaults, entityWithDefaults, relationshipWithDefaults, withDefaults, } from './defaults.js';
4
+ export { SCHEMAS, IDENTIFIERS_SCHEMA, ATTRIBUTES_SCHEMA, ENTITIES_SCHEMA, RELATIONSHIPS_SCHEMA } from './schema.js';
5
+ export { check, findById } from './check.js';
6
+ export { ENTITY_FIELDS, RELATIONSHIP_FIELDS, MASTER_FIELDS, nameFields, fieldsOf } from './fields.js';
7
+ export { ModelError, collectionOf, titleOf, getByPath, mergePatch, movePatch, applyPatch } from './patch.js';
8
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAYA,YAAY,EACV,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,EAC3F,aAAa,EAAE,aAAa,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,QAAQ,EAAE,oBAAoB,EACrG,QAAQ,EAAE,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,EAC3D,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,GAC7D,MAAM,YAAY,CAAC;AAEpB,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,OAAO,EACL,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EACjG,eAAe,EAAE,qBAAqB,EACtC,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,YAAY,GACpI,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACpH,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACtG,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,16 @@
1
+ // model.tm — TM(T字形ER。d3.ter)の「図ごとの知識」。描画はしない(react / d3 に依存しない)。
2
+ //
3
+ // スキーマ: SCHEMAS / *_SCHEMA(JSON Schema 2020-12。4 コレクション)
4
+ // 整合性ルール: check(data)(id の重複・参照先の存在・CLASS と mapping の結線の規則)
5
+ // 既定値の補完: withDefaults(record) / entityWithDefaults / relationshipWithDefaults / kindOf / nameOf
6
+ // 種別の表示: ENTITY_TYPES / TYPE_BADGES / TYPE_COLORS(d3.ter が読む)
7
+ // 編集できる項目: fieldsOf(record, collection?) / nameFields / ENTITY_FIELDS / RELATIONSHIP_FIELDS / MASTER_FIELDS
8
+ // patch への変換: movePatch(entity, move) / applyPatch(record, values, collection?) / mergePatch(record, patch)
9
+ //
10
+ // view(d3.ter)はこのパッケージの既定値(種別バッジ・配色・角度)を読む。インスペクタ(colonoscope)との間に横の依存は無い。
11
+ // ModelError / mergePatch / getByPath / movePatch と入力の読み取り部品は model.core(#151)のもの。
12
+ export { ENTITY_TYPES, TYPE_BADGES, TYPE_COLORS, MAPPING_TYPES, SUBSET_KINDS, CARDINALITIES, OPTIONALITIES, ENTITY_DEFAULTS, RELATIONSHIP_DEFAULTS, isEntityType, isRelationship, isEntity, kindOf, nameOf, endWithDefaults, entityWithDefaults, relationshipWithDefaults, withDefaults, } from './defaults.js';
13
+ export { SCHEMAS, IDENTIFIERS_SCHEMA, ATTRIBUTES_SCHEMA, ENTITIES_SCHEMA, RELATIONSHIPS_SCHEMA } from './schema.js';
14
+ export { check, findById } from './check.js';
15
+ export { ENTITY_FIELDS, RELATIONSHIP_FIELDS, MASTER_FIELDS, nameFields, fieldsOf } from './fields.js';
16
+ export { ModelError, collectionOf, titleOf, getByPath, mergePatch, movePatch, applyPatch } from './patch.js';
@@ -0,0 +1,21 @@
1
+ import type { TmChange, TmCollection, TmEntityRecord, TmMove, TmRecord, TmValues } from './types.js';
2
+ export { ModelError, getByPath, mergePatch } from '@yanqirenshi/model.core';
3
+ /**
4
+ * レコードを置くコレクション。関係・エンティティは形から決まる。
5
+ * マスタは identifiers / attributes を形から判別できないので collection が要る。
6
+ */
7
+ export declare function collectionOf(record: TmRecord, collection?: TmCollection): TmCollection;
8
+ /** インスペクタの見出し。名前、無ければ id(関係はラベル、無ければ「種類 id」) */
9
+ export declare function titleOf(record: TmRecord): string;
10
+ /**
11
+ * ドラッグで動かしたエンティティの位置を保存する patch。
12
+ * 保存してある position に移動量を足し、整数に丸める(position が無いときは 0, 0 から)。z は触らない。
13
+ */
14
+ export declare function movePatch(entity: TmEntityRecord, move: TmMove): TmChange;
15
+ /**
16
+ * インスペクタの「適用」の値を、保存する patch に変換する。
17
+ * 図に描いている値から変えた項目だけを patch に入れる(変えていない既定の値まで書き込まないため)。
18
+ * 変更が無ければ patch は {}。マスタのときは collection(identifiers / attributes)が要る。
19
+ */
20
+ export declare function applyPatch(record: TmRecord, values: TmValues, collection?: TmCollection): TmChange;
21
+ //# sourceMappingURL=patch.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"patch.d.ts","sourceRoot":"","sources":["../src/patch.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EACE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAkB,MAAM,EAAE,QAAQ,EAAwB,QAAQ,EACrH,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE5E;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,YAAY,GAAG,YAAY,CAWtF;AAED,gDAAgD;AAChD,wBAAgB,OAAO,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,CAWhD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,CAExE;AAmID;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,YAAY,GAAG,QAAQ,CAUlG"}
package/dist/patch.js ADDED
@@ -0,0 +1,164 @@
1
+ // UI の操作(ドラッグ・インスペクタの適用)を、保存する patch(JSON Merge Patch)に変換する。
2
+ //
3
+ // 戻り値は { collection, id, patch }。利用側(iHub など)は図の種類を知らずにこれを保存すればよい。
4
+ // 入力の検証に失敗したときは ModelError を投げる(メッセージは利用者にそのまま見せられる日本語)。
5
+ // 使い方の誤り(マスタなのに collection を渡していない)は ModelError ではなく Error。
6
+ // 読み取り部品(toLength など)と patch の道具は model.core にある(#151)。
7
+ import { ModelError, changedValues as changedValuesOf, movePatch as movePatchTo, put, toDegree, toLength, toOption, toOptionNumberOrNull, toOptionalText, } from '@yanqirenshi/model.core';
8
+ import { CARDINALITIES, ENTITY_TYPES, OPTIONALITIES, SUBSET_KINDS, isEntity, isRelationship, kindOf, nameOf, withDefaults, } from './defaults.js';
9
+ import { fieldsOf } from './fields.js';
10
+ // model.core のものをそのまま公開する(利用側が model.tm だけを読めばよいように)
11
+ export { ModelError, getByPath, mergePatch } from '@yanqirenshi/model.core';
12
+ /**
13
+ * レコードを置くコレクション。関係・エンティティは形から決まる。
14
+ * マスタは identifiers / attributes を形から判別できないので collection が要る。
15
+ */
16
+ export function collectionOf(record, collection) {
17
+ if (isRelationship(record))
18
+ return 'relationships';
19
+ if (isEntity(record))
20
+ return 'entities';
21
+ if (!collection)
22
+ throw new Error('model.tm: マスタ (識別子・属性) のレコードには collection を渡してください。');
23
+ return collection;
24
+ }
25
+ /** インスペクタの見出し。名前、無ければ id(関係はラベル、無ければ「種類 id」) */
26
+ export function titleOf(record) {
27
+ if (isRelationship(record)) {
28
+ if (typeof record.label === 'string' && record.label !== '')
29
+ return record.label;
30
+ return `${record.type || ''} ${String(record.id)}`.trim();
31
+ }
32
+ const name = nameOf(record);
33
+ return name !== '' ? name : String(record.id);
34
+ }
35
+ /**
36
+ * ドラッグで動かしたエンティティの位置を保存する patch。
37
+ * 保存してある position に移動量を足し、整数に丸める(position が無いときは 0, 0 から)。z は触らない。
38
+ */
39
+ export function movePatch(entity, move) {
40
+ return movePatchTo(entity, move, 'entities');
41
+ }
42
+ // インスペクタの入力のうち、図に描いている値(withDefaults)から変わった項目だけ
43
+ function changedValues(record, values, collection) {
44
+ return changedValuesOf(withDefaults(record), values, fieldsOf(record, collection));
45
+ }
46
+ // 幅・高さは 0 以上(0 は「内容に合わせる」)
47
+ const LENGTH = { hint: '(0 で内容に合わせる)' };
48
+ // 名前(name / name.logical / name.physical)。required なら空にできない
49
+ function namePatch(patch, path, value, required) {
50
+ // name と name.logical は空にできない。name.physical は空にできる(論理名だけのモデル)
51
+ if (value === '' && required)
52
+ throw new ModelError('名称を入力してください。');
53
+ put(patch, path, value);
54
+ }
55
+ // エンティティの入力 → patch(name / type / description / size)
56
+ function entityPatch(entity, values) {
57
+ const patch = {};
58
+ for (const [path, value] of changedValues(entity, values)) {
59
+ switch (path) {
60
+ case 'name':
61
+ case 'name.logical':
62
+ namePatch(patch, path, value, true);
63
+ break;
64
+ case 'name.physical':
65
+ namePatch(patch, path, value, false);
66
+ break;
67
+ case 'type':
68
+ put(patch, path, toOption(value, ENTITY_TYPES, '種別'));
69
+ break;
70
+ case 'size.w':
71
+ put(patch, path, toLength(value, '幅', LENGTH));
72
+ break;
73
+ case 'size.h':
74
+ put(patch, path, toLength(value, '高さ', LENGTH));
75
+ break;
76
+ case 'description':
77
+ put(patch, path, toOptionalText(value));
78
+ break;
79
+ }
80
+ }
81
+ return patch;
82
+ }
83
+ const END_LABELS = { from: '接続元', to: '接続先' };
84
+ // 関係の入力 → patch(type / label / from / to / subset / description)
85
+ function relationshipPatch(relationship, values) {
86
+ const patch = {};
87
+ for (const [path, value] of changedValues(relationship, values)) {
88
+ const [head, key] = path.split('.');
89
+ if ((head === 'from' || head === 'to') && key) {
90
+ const label = END_LABELS[head];
91
+ switch (key) {
92
+ case 'position':
93
+ put(patch, path, toDegree(value, `${label}の位置`));
94
+ break;
95
+ case 'cardinality':
96
+ put(patch, path, toOptionNumberOrNull(value, CARDINALITIES, `${label}のカーディナリティ`));
97
+ break;
98
+ case 'optionality':
99
+ put(patch, path, toOptionNumberOrNull(value, OPTIONALITIES, `${label}のオプショナリティ`));
100
+ break;
101
+ }
102
+ continue;
103
+ }
104
+ switch (path) {
105
+ case 'subset.kind':
106
+ put(patch, path, toOption(value, SUBSET_KINDS, 'サブセットの区分'));
107
+ break;
108
+ case 'subset.code':
109
+ // 区分コードを空にするとサブセットの表記を消す(subset ごと除く)
110
+ if (value === '')
111
+ patch.subset = null;
112
+ else
113
+ put(patch, path, value);
114
+ break;
115
+ case 'type':
116
+ case 'label':
117
+ case 'description':
118
+ put(patch, path, toOptionalText(value));
119
+ break;
120
+ }
121
+ }
122
+ // subset を除くときは kind の変更も要らない
123
+ if (patch.subset === null)
124
+ return patch;
125
+ // kind だけを新しく書いて code が無い subset は作らない(d3.ter は code が無ければ描かない)
126
+ const subset = patch.subset;
127
+ if (subset && subset.kind !== undefined && subset.code === undefined && !relationship.subset?.code)
128
+ throw new ModelError('サブセットの区分コードを入力してください。');
129
+ return patch;
130
+ }
131
+ // マスタの入力 → patch(name / description)
132
+ function masterPatch(master, values, collection) {
133
+ const patch = {};
134
+ for (const [path, value] of changedValues(master, values, collection)) {
135
+ switch (path) {
136
+ case 'name':
137
+ case 'name.logical':
138
+ // 識別子・属性の名前は空にできない(エンティティの行に描く文字が無くなる)
139
+ namePatch(patch, path, value, true);
140
+ break;
141
+ case 'name.physical':
142
+ namePatch(patch, path, value, false);
143
+ break;
144
+ case 'description':
145
+ put(patch, path, toOptionalText(value));
146
+ break;
147
+ }
148
+ }
149
+ return patch;
150
+ }
151
+ /**
152
+ * インスペクタの「適用」の値を、保存する patch に変換する。
153
+ * 図に描いている値から変えた項目だけを patch に入れる(変えていない既定の値まで書き込まないため)。
154
+ * 変更が無ければ patch は {}。マスタのときは collection(identifiers / attributes)が要る。
155
+ */
156
+ export function applyPatch(record, values, collection) {
157
+ const target = collectionOf(record, collection);
158
+ const patch = kindOf(record) === 'relationship'
159
+ ? relationshipPatch(record, values)
160
+ : kindOf(record) === 'entity'
161
+ ? entityPatch(record, values)
162
+ : masterPatch(record, values, target);
163
+ return { collection: target, id: record.id, patch };
164
+ }