@open-captable-protocol/canton 0.2.244 → 0.2.245
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.
|
@@ -88,6 +88,7 @@ export declare function normalizeObjectType<T extends string>(objectType: T): st
|
|
|
88
88
|
* 1. Converts PlanSecurity object_type to EquityCompensation equivalent
|
|
89
89
|
* 2. Normalizes quantity_source based on quantity presence (see normalizeQuantitySource)
|
|
90
90
|
* 3. Strips Document fields that the DAML contract does not model (e.g. `date`)
|
|
91
|
+
* 4. Canonicalizes Stakeholder relationships (`current_relationship` -> `current_relationships`)
|
|
91
92
|
*
|
|
92
93
|
* @param data - The OCF data object that may contain an object_type field
|
|
93
94
|
* @returns The data with normalized fields (shallow copy if modified)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"planSecurityAliases.d.ts","sourceRoot":"","sources":["../../src/utils/planSecurityAliases.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"planSecurityAliases.d.ts","sourceRoot":"","sources":["../../src/utils/planSecurityAliases.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AAEH;;GAEG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;CAQ3C,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;CAQhC,CAAC;AAEX,4CAA4C;AAC5C,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,wCAAwC,CAAC;AAE3F,4CAA4C;AAC5C,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,6BAA6B,CAAC;AAEhF;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,sBAAsB,CAErF;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,IAAI,sBAAsB,CAEjG;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAKrE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,EAAE,CAAC,GAAG,MAAM,CAK3E;AAiJD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAoB9E"}
|
|
@@ -1,4 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PLAN_SECURITY_OBJECT_TYPE_MAP = exports.PLAN_SECURITY_TO_EQUITY_COMPENSATION_MAP = void 0;
|
|
4
|
+
exports.isPlanSecurityEntityType = isPlanSecurityEntityType;
|
|
5
|
+
exports.isPlanSecurityObjectType = isPlanSecurityObjectType;
|
|
6
|
+
exports.normalizeEntityType = normalizeEntityType;
|
|
7
|
+
exports.normalizeObjectType = normalizeObjectType;
|
|
8
|
+
exports.normalizeOcfData = normalizeOcfData;
|
|
9
|
+
const typeGuards_1 = require("./typeGuards");
|
|
2
10
|
/**
|
|
3
11
|
* Plan Security to Equity Compensation alias mappings.
|
|
4
12
|
*
|
|
@@ -10,13 +18,6 @@
|
|
|
10
18
|
* Reference: The OCF standard includes both TX_PLAN_SECURITY_* and TX_EQUITY_COMPENSATION_*
|
|
11
19
|
* object types in the OcfObjectReference schema.
|
|
12
20
|
*/
|
|
13
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
-
exports.PLAN_SECURITY_OBJECT_TYPE_MAP = exports.PLAN_SECURITY_TO_EQUITY_COMPENSATION_MAP = void 0;
|
|
15
|
-
exports.isPlanSecurityEntityType = isPlanSecurityEntityType;
|
|
16
|
-
exports.isPlanSecurityObjectType = isPlanSecurityObjectType;
|
|
17
|
-
exports.normalizeEntityType = normalizeEntityType;
|
|
18
|
-
exports.normalizeObjectType = normalizeObjectType;
|
|
19
|
-
exports.normalizeOcfData = normalizeOcfData;
|
|
20
21
|
/**
|
|
21
22
|
* Entity type aliases: maps PlanSecurity entity types to their EquityCompensation equivalents.
|
|
22
23
|
*/
|
|
@@ -168,6 +169,50 @@ function stripDocumentNonDamlFields(data) {
|
|
|
168
169
|
}
|
|
169
170
|
return result;
|
|
170
171
|
}
|
|
172
|
+
function normalizeStakeholderRelationships(data) {
|
|
173
|
+
const isStakeholderObject = data.object_type === 'STAKEHOLDER' || (0, typeGuards_1.isOcfStakeholder)(data);
|
|
174
|
+
if (!isStakeholderObject)
|
|
175
|
+
return data;
|
|
176
|
+
const relationshipsValue = data.current_relationships;
|
|
177
|
+
if (relationshipsValue !== undefined && !Array.isArray(relationshipsValue)) {
|
|
178
|
+
throw new Error(`Invalid stakeholder current_relationships: expected array, got ${typeof relationshipsValue}`);
|
|
179
|
+
}
|
|
180
|
+
if (Array.isArray(relationshipsValue)) {
|
|
181
|
+
const normalizedRelationships = [];
|
|
182
|
+
for (const value of relationshipsValue) {
|
|
183
|
+
if (typeof value !== 'string') {
|
|
184
|
+
throw new Error(`Invalid stakeholder current_relationships entry: expected string, got ${typeof value}`);
|
|
185
|
+
}
|
|
186
|
+
const trimmed = value.trim();
|
|
187
|
+
if (trimmed.length === 0) {
|
|
188
|
+
throw new Error('Invalid stakeholder current_relationships entry: empty string');
|
|
189
|
+
}
|
|
190
|
+
normalizedRelationships.push(trimmed);
|
|
191
|
+
}
|
|
192
|
+
const uniqueSortedRelationships = Array.from(new Set(normalizedRelationships)).sort();
|
|
193
|
+
const alreadyNormalized = uniqueSortedRelationships.length === relationshipsValue.length &&
|
|
194
|
+
uniqueSortedRelationships.every((value, index) => value === relationshipsValue[index]);
|
|
195
|
+
if (alreadyNormalized)
|
|
196
|
+
return data;
|
|
197
|
+
return {
|
|
198
|
+
...data,
|
|
199
|
+
current_relationships: uniqueSortedRelationships,
|
|
200
|
+
};
|
|
201
|
+
}
|
|
202
|
+
if (data.current_relationship !== undefined && typeof data.current_relationship !== 'string') {
|
|
203
|
+
throw new Error(`Invalid stakeholder current_relationship: expected string, got ${typeof data.current_relationship}`);
|
|
204
|
+
}
|
|
205
|
+
if (typeof data.current_relationship !== 'string')
|
|
206
|
+
return data;
|
|
207
|
+
const legacyRelationship = data.current_relationship.trim();
|
|
208
|
+
if (legacyRelationship.length === 0) {
|
|
209
|
+
throw new Error('Invalid stakeholder current_relationship: empty string');
|
|
210
|
+
}
|
|
211
|
+
return {
|
|
212
|
+
...data,
|
|
213
|
+
current_relationships: [legacyRelationship],
|
|
214
|
+
};
|
|
215
|
+
}
|
|
171
216
|
/**
|
|
172
217
|
* Normalize OCF data for consistent comparison.
|
|
173
218
|
*
|
|
@@ -175,6 +220,7 @@ function stripDocumentNonDamlFields(data) {
|
|
|
175
220
|
* 1. Converts PlanSecurity object_type to EquityCompensation equivalent
|
|
176
221
|
* 2. Normalizes quantity_source based on quantity presence (see normalizeQuantitySource)
|
|
177
222
|
* 3. Strips Document fields that the DAML contract does not model (e.g. `date`)
|
|
223
|
+
* 4. Canonicalizes Stakeholder relationships (`current_relationship` -> `current_relationships`)
|
|
178
224
|
*
|
|
179
225
|
* @param data - The OCF data object that may contain an object_type field
|
|
180
226
|
* @returns The data with normalized fields (shallow copy if modified)
|
|
@@ -204,6 +250,8 @@ function normalizeOcfData(data) {
|
|
|
204
250
|
}
|
|
205
251
|
// Strip Document fields that DAML cannot store (e.g. `date`)
|
|
206
252
|
result = stripDocumentNonDamlFields(result);
|
|
253
|
+
// Canonicalize deprecated/current stakeholder relationship fields
|
|
254
|
+
result = normalizeStakeholderRelationships(result);
|
|
207
255
|
return result;
|
|
208
256
|
}
|
|
209
257
|
//# sourceMappingURL=planSecurityAliases.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"planSecurityAliases.js","sourceRoot":"","sources":["../../src/utils/planSecurityAliases.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"planSecurityAliases.js","sourceRoot":"","sources":["../../src/utils/planSecurityAliases.ts"],"names":[],"mappings":";;;AAqDA,4DAEC;AAQD,4DAEC;AAgBD,kDAKC;AAgBD,kDAKC;AAyKD,4CAoBC;AAvSD,6CAAgD;AAEhD;;;;;;;;;;GAUG;AAEH;;GAEG;AACU,QAAA,wCAAwC,GAAG;IACtD,oBAAoB,EAAE,4BAA4B;IAClD,oBAAoB,EAAE,4BAA4B;IAClD,wBAAwB,EAAE,gCAAgC;IAC1D,sBAAsB,EAAE,8BAA8B;IACtD,mBAAmB,EAAE,2BAA2B;IAChD,sBAAsB,EAAE,8BAA8B;IACtD,oBAAoB,EAAE,4BAA4B;CAC1C,CAAC;AAEX;;GAEG;AACU,QAAA,6BAA6B,GAAG;IAC3C,yBAAyB,EAAE,iCAAiC;IAC5D,yBAAyB,EAAE,iCAAiC;IAC5D,6BAA6B,EAAE,qCAAqC;IACpE,2BAA2B,EAAE,mCAAmC;IAChE,wBAAwB,EAAE,gCAAgC;IAC1D,2BAA2B,EAAE,mCAAmC;IAChE,yBAAyB,EAAE,iCAAiC;CACpD,CAAC;AAQX;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,IAAY;IACnD,OAAO,IAAI,IAAI,gDAAwC,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,UAAkB;IACzD,OAAO,UAAU,IAAI,qCAA6B,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,mBAAmB,CAAmB,IAAO;IAC3D,IAAI,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,OAAO,gDAAwC,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,mBAAmB,CAAmB,UAAa;IACjE,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC;QACzC,OAAO,qCAA6B,CAAC,UAAU,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,uBAAuB,CAAoC,IAAO;IACzE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IAE3D,4EAA4E;IAC5E,6EAA6E;IAC7E,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,CAAC,IAAI,cAAc,KAAK,aAAa,EAAE,CAAC;QACtF,MAAM,EAAE,eAAe,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QAC7C,OAAO,IAAS,CAAC;IACnB,CAAC;IAED,mGAAmG;IACnG,iFAAiF;IACjF,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAChF,OAAO,EAAE,GAAG,IAAI,EAAE,eAAe,EAAE,aAAa,EAAO,CAAC;IAC1D,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,wBAAwB,GAAwB,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAExE;;;;;GAKG;AACH,SAAS,0BAA0B,CAAoC,IAAO;IAC5E,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;IACpC,IAAI,UAAU,KAAK,UAAU;QAAE,OAAO,IAAI,CAAC;IAE3C,0DAA0D;IAC1D,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACxF,IAAI,CAAC,gBAAgB;QAAE,OAAO,IAAI,CAAC;IAEnC,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACvC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IACD,OAAO,MAAW,CAAC;AACrB,CAAC;AAmBD,SAAS,iCAAiC,CAAoC,IAAO;IACnF,MAAM,mBAAmB,GAAG,IAAI,CAAC,WAAW,KAAK,aAAa,IAAI,IAAA,6BAAgB,EAAC,IAAI,CAAC,CAAC;IACzF,IAAI,CAAC,mBAAmB;QAAE,OAAO,IAAI,CAAC;IAEtC,MAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CAAC;IACtD,IAAI,kBAAkB,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,kEAAkE,OAAO,kBAAkB,EAAE,CAAC,CAAC;IACjH,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACtC,MAAM,uBAAuB,GAAa,EAAE,CAAC;QAC7C,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE,CAAC;YACvC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,yEAAyE,OAAO,KAAK,EAAE,CAAC,CAAC;YAC3G,CAAC;YACD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;YACnF,CAAC;YACD,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,yBAAyB,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACtF,MAAM,iBAAiB,GACrB,yBAAyB,CAAC,MAAM,KAAK,kBAAkB,CAAC,MAAM;YAC9D,yBAAyB,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;QACzF,IAAI,iBAAiB;YAAE,OAAO,IAAI,CAAC;QAEnC,OAAO;YACL,GAAG,IAAI;YACP,qBAAqB,EAAE,yBAAyB;SACjD,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,oBAAoB,KAAK,QAAQ,EAAE,CAAC;QAC7F,MAAM,IAAI,KAAK,CACb,kEAAkE,OAAO,IAAI,CAAC,oBAAoB,EAAE,CACrG,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,IAAI,CAAC,oBAAoB,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC/D,MAAM,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC;IAC5D,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,qBAAqB,EAAE,CAAC,kBAAkB,CAAC;KAC5C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,gBAAgB,CAAoC,IAAO;IACzE,4DAA4D;IAC5D,IAAI,MAAM,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAE3C,gEAAgE;IAChE,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC;IACtC,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC;QAC3E,MAAM,GAAG;YACP,GAAG,MAAM;YACT,WAAW,EAAE,qCAA6B,CAAC,UAAU,CAAC;SACvD,CAAC;IACJ,CAAC;IAED,6DAA6D;IAC7D,MAAM,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC;IAE5C,kEAAkE;IAClE,MAAM,GAAG,iCAAiC,CAAC,MAAM,CAAC,CAAC;IAEnD,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-captable-protocol/canton",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.245",
|
|
4
4
|
"description": "A TypeScript SDK for interacting with the Open CapTable Protocol (OCP) Factory contract on Canton blockchain",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/index.js",
|