@fintekkers/ledger-models 0.4.43 → 0.4.45

package/node/wrappers/util/object-types.ts

@@ -1,207 +1,182 @@
 /**
- * Compact object type and version (LM-297), stage 1: write both forms, read the new one.
+ * Object type and version (LM-297, LM-318).
  *
- * Every message with `string object_class = 1` and `string version = 2` also
- * carries `ObjectTypeProto object_type = 1001` and `uint32 version_major /
- * version_minor / version_patch = 1002-1004`. Writers call `stamp`, which sets
- * the strings and the new fields. Readers call `readType` / `readVersion` (or
- * `upgrade`), which use the new fields and fall back to the deprecated strings,
- * logging one `console.warn` per distinct pair of strings. A fallback never
- * throws: an unknown object_class gives OBJECT_TYPE_UNKNOWN and a malformed
- * version gives 0.0.0. Empty strings are the proto3 default and fall back
- * silently.
- *
- * google-protobuf cannot read the `(legacy_object_class)` options at runtime,
- * so the string map comes from object-type-legacy.json, generated by
- * scripts/gen-object-type-legacy-map.py. See docs/adr/compact_object_type_and_version.md.
+ * Every message that names its type carries `ObjectTypeProto object_type = 1`
+ * and `VersionProto version = 2`. Writers call `stamp`, which sets the type and
+ * `SCHEMA_VERSION`; `stampOwn` passes the message's own type (LM-320). Readers
+ * call `readType` / `readVersion`. The old `object_class` / `version` strings
+ * were replaced in place by LM-318: bytes written before it are not readable.
+ * See docs/adr/compact_object_type_and_version.md.
  */
 import { ObjectTypeProto } from '../../fintekkers/models/util/object_type_pb';
-import legacyMirror from './object-type-legacy.json';
-
-/** Any generated message that carries object_class / version and their compact form. */
+import { VersionProto } from '../../fintekkers/models/util/version_pb';
+import { PortfolioProto } from '../../fintekkers/models/portfolio/portfolio_pb';
+import { PositionProto } from '../../fintekkers/models/position/position_pb';
+import { PositionFilterProto } from '../../fintekkers/models/position/position_filter_pb';
+import { PriceProto } from '../../fintekkers/models/price/price_pb';
+import { IssuanceProto } from '../../fintekkers/models/security/bond/issuance_pb';
+import { IdentifierProto } from '../../fintekkers/models/security/identifier/identifier_pb';
+import { IndexCompositionProto } from '../../fintekkers/models/security/index_composition_pb';
+import { SecurityProto } from '../../fintekkers/models/security/security_pb';
+import { TenorProto } from '../../fintekkers/models/security/tenor_pb';
+import { StrategyProto } from '../../fintekkers/models/strategy/strategy_pb';
+import { StrategyAllocationProto } from '../../fintekkers/models/strategy/strategy_allocation_pb';
+import { TransactionProto } from '../../fintekkers/models/transaction/transaction_pb';
+import { API_Key } from '../../fintekkers/models/util/api/api_key_pb';
+import { DateRangeProto } from '../../fintekkers/models/util/date_range_pb';
+import { NodePartition } from '../../fintekkers/models/util/lock/node_partition_pb';
+import { NodeState } from '../../fintekkers/models/util/lock/node_state_pb';
+import { CreateIndexCompositionRequestProto, CreateIndexCompositionResponseProto } from '../../fintekkers/requests/index_composition/create_index_composition_request_pb';
+import { GetIndexCompositionRequestProto, GetIndexCompositionResponseProto } from '../../fintekkers/requests/index_composition/get_index_composition_request_pb';
+import { CreatePortfolioRequestProto } from '../../fintekkers/requests/portfolio/create_portfolio_request_pb';
+import { CreatePortfolioResponseProto } from '../../fintekkers/requests/portfolio/create_portfolio_response_pb';
+import { QueryPortfolioRequestProto } from '../../fintekkers/requests/portfolio/query_portfolio_request_pb';
+import { QueryPortfolioResponseProto } from '../../fintekkers/requests/portfolio/query_portfolio_response_pb';
+import { QueryPositionRequestProto } from '../../fintekkers/requests/position/query_position_request_pb';
+import { QueryPositionResponseProto } from '../../fintekkers/requests/position/query_position_response_pb';
+import { CreatePriceRequestProto } from '../../fintekkers/requests/price/create_price_request_pb';
+import { CreatePriceResponseProto } from '../../fintekkers/requests/price/create_price_response_pb';
+import { QueryPriceRequestProto } from '../../fintekkers/requests/price/query_price_request_pb';
+import { QueryPriceResponseProto } from '../../fintekkers/requests/price/query_price_response_pb';
+import { CreateSecurityRequestProto } from '../../fintekkers/requests/security/create_security_request_pb';
+import { CreateSecurityResponseProto } from '../../fintekkers/requests/security/create_security_response_pb';
+import { GetFieldValuesRequestProto } from '../../fintekkers/requests/security/get_field_values_request_pb';
+import { GetFieldValuesResponseProto } from '../../fintekkers/requests/security/get_field_values_response_pb';
+import { GetFieldsResponseProto } from '../../fintekkers/requests/security/get_fields_response_pb';
+import { QuerySecurityRequestProto } from '../../fintekkers/requests/security/query_security_request_pb';
+import { QuerySecurityResponseProto } from '../../fintekkers/requests/security/query_security_response_pb';
+import { CreateTransactionRequestProto } from '../../fintekkers/requests/transaction/create_transaction_request_pb';
+import { CreateTransactionResponseProto } from '../../fintekkers/requests/transaction/create_transaction_response_pb';
+import { QueryTransactionRequestProto } from '../../fintekkers/requests/transaction/query_transaction_request_pb';
+import { QueryTransactionResponseProto } from '../../fintekkers/requests/transaction/query_transaction_response_pb';
+import { DeleteRequestProto, DeleteResponseProto } from '../../fintekkers/requests/util/delete_request_pb';
+import { LockRequestProto } from '../../fintekkers/requests/util/lock/lock_request_pb';
+import { LockResponseProto } from '../../fintekkers/requests/util/lock/lock_response_pb';
+import { CurveRequestProto } from '../../fintekkers/requests/valuation/curve_request_pb';
+import { CurveResponseProto } from '../../fintekkers/requests/valuation/curve_response_pb';
+import { ValuationRequestProto } from '../../fintekkers/requests/valuation/valuation_request_pb';
+import { ValuationResponseProto } from '../../fintekkers/requests/valuation/valuation_response_pb';
+
+/** Any generated message that carries object_type and version. */
 export interface ObjectTyped {
-  getObjectClass(): string;
-  setObjectClass(value: string): unknown;
-  getVersion(): string;
-  setVersion(value: string): unknown;
   getObjectType(): ObjectTypeProto;
   setObjectType(value: ObjectTypeProto): unknown;
-  getVersionMajor(): number;
-  setVersionMajor(value: number): unknown;
-  getVersionMinor(): number;
-  setVersionMinor(value: number): unknown;
-  getVersionPatch(): number;
-  setVersionPatch(value: number): unknown;
+  hasVersion(): boolean;
+  getVersion(): VersionProto | undefined;
+  setVersion(value?: VersionProto): unknown;
 }
 
 /** [major, minor, patch], each a uint32. */
 export type Version = [number, number, number];
 
-const UINT32_MAX = 0xffffffff;
-const VERSION_PATTERN = /^[0-9]+\.[0-9]+\.[0-9]+$/;
-
-function buildLegacyMap(): Map<string, ObjectTypeProto> {
-  const map = new Map<string, ObjectTypeProto>();
-  for (const [legacy, name] of Object.entries(legacyMirror.legacy_object_class)) {
-    if (!Object.prototype.hasOwnProperty.call(ObjectTypeProto, name)) {
-      throw new Error(`object-type-legacy.json names ${name}, which ObjectTypeProto lacks: regenerate it`);
-    }
-    map.set(legacy, ObjectTypeProto[name as keyof typeof ObjectTypeProto]);
-  }
-  return map;
-}
-
-const LEGACY = buildLegacyMap();
-const warned = new Set<string>();
-const UNKNOWN_NAME = Object.keys(ObjectTypeProto)
-  .find((name) => ObjectTypeProto[name as keyof typeof ObjectTypeProto] === ObjectTypeProto.OBJECT_TYPE_UNKNOWN) as string;
-const PREFIX = UNKNOWN_NAME.slice(0, -'UNKNOWN'.length);
-const CAMEL_BOUNDARY = /(?<=[a-z0-9])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])/g;
-const ownTypes = new WeakMap<object, ObjectTypeProto>();
-
-/** The ObjectTypeProto value an object_class string stands for, or OBJECT_TYPE_UNKNOWN. */
-export function fromLegacy(objectClass: string): ObjectTypeProto {
-  return LEGACY.get(objectClass) ?? ObjectTypeProto.OBJECT_TYPE_UNKNOWN;
-}
-
-/**
- * The ObjectTypeProto value named for a message type, or OBJECT_TYPE_UNKNOWN.
- * Uses the enum's naming rule: `QuerySecurityRequestProto` ->
- * OBJECT_TYPE_QUERY_SECURITY_REQUEST.
- */
-export function ownType(messageName: string): ObjectTypeProto {
-  const base = messageName.endsWith('Proto') ? messageName.slice(0, -'Proto'.length) : messageName;
-  const name = PREFIX + base.replace(CAMEL_BOUNDARY, '_').toUpperCase();
-  return Object.prototype.hasOwnProperty.call(ObjectTypeProto, name)
-    ? ObjectTypeProto[name as keyof typeof ObjectTypeProto]
-    : ObjectTypeProto.OBJECT_TYPE_UNKNOWN;
-}
+/** The schema version `stamp` writes. Not the library release. */
+export const SCHEMA_VERSION: Version = [0, 0, 1];
 
 /**
- * The generated class name of `message`. google-protobuf's classes are
- * anonymous functions, but each generated module exports its classes under
- * the global `proto` namespace by full name, so search that.
+ * Sets object_type and version (`SCHEMA_VERSION`) on `message`; returns it.
+ * `objectType` is the message's own ObjectTypeProto value.
  */
-function messageName(ctor: object, namespace: unknown, depth = 0): string | undefined {
-  if (typeof namespace !== 'object' || namespace === null || depth > 8) return undefined;
-  for (const [key, value] of Object.entries(namespace)) {
-    if (value === ctor) return key;
-    const found = messageName(ctor, value, depth + 1);
-    if (found !== undefined) return found;
-  }
-  return undefined;
-}
-
-function ownTypeOf(message: ObjectTyped): ObjectTypeProto {
-  const ctor = message.constructor;
-  let type = ownTypes.get(ctor);
-  if (type === undefined) {
-    const name = messageName(ctor, (globalThis as { proto?: unknown }).proto);
-    type = name === undefined ? ObjectTypeProto.OBJECT_TYPE_UNKNOWN : ownType(name);
-    ownTypes.set(ctor, type);
-  }
-  return type;
-}
-
-/** '1.2.3' -> [1, 2, 3]; null unless exactly three decimal uint32 parts. */
-export function parseVersion(version: string): Version | null {
-  if (!VERSION_PATTERN.test(version)) return null;
-  const parts = version.split('.').map(Number);
-  if (parts.some((p) => p > UINT32_MAX)) return null;
-  return [parts[0], parts[1], parts[2]];
-}
-
-/**
- * Sets object_class / version and their compact form on `message`; returns it.
- * `objectType` is the message's own ObjectTypeProto value. `version` must be
- * empty or three uint32 parts.
- */
-export function stamp<T extends ObjectTyped>(message: T, objectType: ObjectTypeProto, objectClass: string, version: string): T {
-  const parts = version ? parseVersion(version) : [0, 0, 0];
-  if (parts === null) {
-    throw new Error(`version must be MAJOR.MINOR.PATCH, got '${version}'`);
-  }
-  message.setObjectClass(objectClass);
-  message.setVersion(version);
+export function stamp<T extends ObjectTyped>(message: T, objectType: ObjectTypeProto): T {
+  const [major, minor, patch] = SCHEMA_VERSION;
   message.setObjectType(objectType);
-  setCompactVersion(message, parts as Version);
+  message.setVersion(new VersionProto().setMajor(major).setMinor(minor).setPatch(patch));
   return message;
 }
 
-function setCompactVersion(message: ObjectTyped, [major, minor, patch]: Version): void {
-  message.setVersionMajor(major);
-  message.setVersionMinor(minor);
-  message.setVersionPatch(patch);
-}
-
-function compactVersion(message: ObjectTyped): Version {
-  return [message.getVersionMajor(), message.getVersionMinor(), message.getVersionPatch()];
+// Each message with object_type: proto full name, generated class, its own
+// ObjectTypeProto value (LM-320). object-type-coverage.test.ts fails when a
+// message in the descriptor set is missing.
+const OWN_TYPE_ROWS: ReadonlyArray<[string, Function, ObjectTypeProto]> = [
+  ['fintekkers.models.portfolio.PortfolioProto', PortfolioProto, ObjectTypeProto.OBJECT_TYPE_PORTFOLIO],
+  ['fintekkers.models.position.PositionProto', PositionProto, ObjectTypeProto.OBJECT_TYPE_POSITION],
+  ['fintekkers.models.position.PositionFilterProto', PositionFilterProto, ObjectTypeProto.OBJECT_TYPE_POSITION_FILTER],
+  ['fintekkers.models.price.PriceProto', PriceProto, ObjectTypeProto.OBJECT_TYPE_PRICE],
+  ['fintekkers.models.security.IdentifierProto', IdentifierProto, ObjectTypeProto.OBJECT_TYPE_IDENTIFIER],
+  ['fintekkers.models.security.SecurityProto', SecurityProto, ObjectTypeProto.OBJECT_TYPE_SECURITY],
+  ['fintekkers.models.security.TenorProto', TenorProto, ObjectTypeProto.OBJECT_TYPE_TENOR],
+  ['fintekkers.models.strategy.StrategyProto', StrategyProto, ObjectTypeProto.OBJECT_TYPE_STRATEGY],
+  ['fintekkers.models.strategy.StrategyAllocationProto', StrategyAllocationProto, ObjectTypeProto.OBJECT_TYPE_STRATEGY_ALLOCATION],
+  ['fintekkers.models.transaction.TransactionProto', TransactionProto, ObjectTypeProto.OBJECT_TYPE_TRANSACTION],
+  ['fintekkers.requests.portfolio.CreatePortfolioRequestProto', CreatePortfolioRequestProto, ObjectTypeProto.OBJECT_TYPE_CREATE_PORTFOLIO_REQUEST],
+  ['fintekkers.requests.portfolio.QueryPortfolioRequestProto', QueryPortfolioRequestProto, ObjectTypeProto.OBJECT_TYPE_QUERY_PORTFOLIO_REQUEST],
+  ['fintekkers.requests.price.CreatePriceRequestProto', CreatePriceRequestProto, ObjectTypeProto.OBJECT_TYPE_CREATE_PRICE_REQUEST],
+  ['fintekkers.requests.price.QueryPriceRequestProto', QueryPriceRequestProto, ObjectTypeProto.OBJECT_TYPE_QUERY_PRICE_REQUEST],
+  ['fintekkers.requests.security.CreateSecurityRequestProto', CreateSecurityRequestProto, ObjectTypeProto.OBJECT_TYPE_CREATE_SECURITY_REQUEST],
+  ['fintekkers.requests.security.QuerySecurityRequestProto', QuerySecurityRequestProto, ObjectTypeProto.OBJECT_TYPE_QUERY_SECURITY_REQUEST],
+  ['fintekkers.requests.transaction.CreateTransactionRequestProto', CreateTransactionRequestProto, ObjectTypeProto.OBJECT_TYPE_CREATE_TRANSACTION_REQUEST],
+  ['fintekkers.requests.transaction.QueryTransactionRequestProto', QueryTransactionRequestProto, ObjectTypeProto.OBJECT_TYPE_QUERY_TRANSACTION_REQUEST],
+  // LM-320: the rest of the messages with object_type.
+  ['fintekkers.models.security.bond.IssuanceProto', IssuanceProto, ObjectTypeProto.OBJECT_TYPE_ISSUANCE],
+  ['fintekkers.models.security.IndexCompositionProto', IndexCompositionProto, ObjectTypeProto.OBJECT_TYPE_INDEX_COMPOSITION],
+  ['fintekkers.models.util.DateRangeProto', DateRangeProto, ObjectTypeProto.OBJECT_TYPE_DATE_RANGE],
+  ['fintekkers.models.util.api.API_Key', API_Key, ObjectTypeProto.OBJECT_TYPE_API_KEY],
+  ['fintekkers.models.util.lock.NodeState', NodeState, ObjectTypeProto.OBJECT_TYPE_NODE_STATE],
+  ['fintekkers.models.util.lock.NodePartition', NodePartition, ObjectTypeProto.OBJECT_TYPE_NODE_PARTITION],
+  ['fintekkers.requests.index_composition.CreateIndexCompositionRequestProto', CreateIndexCompositionRequestProto, ObjectTypeProto.OBJECT_TYPE_CREATE_INDEX_COMPOSITION_REQUEST],
+  ['fintekkers.requests.index_composition.CreateIndexCompositionResponseProto', CreateIndexCompositionResponseProto, ObjectTypeProto.OBJECT_TYPE_CREATE_INDEX_COMPOSITION_RESPONSE],
+  ['fintekkers.requests.index_composition.GetIndexCompositionRequestProto', GetIndexCompositionRequestProto, ObjectTypeProto.OBJECT_TYPE_GET_INDEX_COMPOSITION_REQUEST],
+  ['fintekkers.requests.index_composition.GetIndexCompositionResponseProto', GetIndexCompositionResponseProto, ObjectTypeProto.OBJECT_TYPE_GET_INDEX_COMPOSITION_RESPONSE],
+  ['fintekkers.requests.portfolio.CreatePortfolioResponseProto', CreatePortfolioResponseProto, ObjectTypeProto.OBJECT_TYPE_CREATE_PORTFOLIO_RESPONSE],
+  ['fintekkers.requests.portfolio.QueryPortfolioResponseProto', QueryPortfolioResponseProto, ObjectTypeProto.OBJECT_TYPE_QUERY_PORTFOLIO_RESPONSE],
+  ['fintekkers.requests.position.QueryPositionRequestProto', QueryPositionRequestProto, ObjectTypeProto.OBJECT_TYPE_QUERY_POSITION_REQUEST],
+  ['fintekkers.requests.position.QueryPositionResponseProto', QueryPositionResponseProto, ObjectTypeProto.OBJECT_TYPE_QUERY_POSITION_RESPONSE],
+  ['fintekkers.requests.price.CreatePriceResponseProto', CreatePriceResponseProto, ObjectTypeProto.OBJECT_TYPE_CREATE_PRICE_RESPONSE],
+  ['fintekkers.requests.price.QueryPriceResponseProto', QueryPriceResponseProto, ObjectTypeProto.OBJECT_TYPE_QUERY_PRICE_RESPONSE],
+  ['fintekkers.requests.security.CreateSecurityResponseProto', CreateSecurityResponseProto, ObjectTypeProto.OBJECT_TYPE_CREATE_SECURITY_RESPONSE],
+  ['fintekkers.requests.security.QuerySecurityResponseProto', QuerySecurityResponseProto, ObjectTypeProto.OBJECT_TYPE_QUERY_SECURITY_RESPONSE],
+  ['fintekkers.requests.security.GetFieldsResponseProto', GetFieldsResponseProto, ObjectTypeProto.OBJECT_TYPE_GET_FIELDS_RESPONSE],
+  ['fintekkers.requests.security.GetFieldValuesRequestProto', GetFieldValuesRequestProto, ObjectTypeProto.OBJECT_TYPE_GET_FIELD_VALUES_REQUEST],
+  ['fintekkers.requests.security.GetFieldValuesResponseProto', GetFieldValuesResponseProto, ObjectTypeProto.OBJECT_TYPE_GET_FIELD_VALUES_RESPONSE],
+  ['fintekkers.requests.transaction.CreateTransactionResponseProto', CreateTransactionResponseProto, ObjectTypeProto.OBJECT_TYPE_CREATE_TRANSACTION_RESPONSE],
+  ['fintekkers.requests.transaction.QueryTransactionResponseProto', QueryTransactionResponseProto, ObjectTypeProto.OBJECT_TYPE_QUERY_TRANSACTION_RESPONSE],
+  ['fintekkers.requests.util.DeleteRequestProto', DeleteRequestProto, ObjectTypeProto.OBJECT_TYPE_DELETE_REQUEST],
+  ['fintekkers.requests.util.DeleteResponseProto', DeleteResponseProto, ObjectTypeProto.OBJECT_TYPE_DELETE_RESPONSE],
+  ['fintekkers.requests.util.lock.LockRequestProto', LockRequestProto, ObjectTypeProto.OBJECT_TYPE_LOCK_REQUEST],
+  ['fintekkers.requests.util.lock.LockResponseProto', LockResponseProto, ObjectTypeProto.OBJECT_TYPE_LOCK_RESPONSE],
+  ['fintekkers.requests.valuation.ValuationRequestProto', ValuationRequestProto, ObjectTypeProto.OBJECT_TYPE_VALUATION_REQUEST],
+  ['fintekkers.requests.valuation.ValuationResponseProto', ValuationResponseProto, ObjectTypeProto.OBJECT_TYPE_VALUATION_RESPONSE],
+  ['fintekkers.requests.valuation.CurveRequestProto', CurveRequestProto, ObjectTypeProto.OBJECT_TYPE_CURVE_REQUEST],
+  ['fintekkers.requests.valuation.CurveResponseProto', CurveResponseProto, ObjectTypeProto.OBJECT_TYPE_CURVE_RESPONSE],
+];
+
+const OWN_TYPES: ReadonlyMap<Function, ObjectTypeProto> = new Map(
+  OWN_TYPE_ROWS.map(([, messageClass, objectType]) => [messageClass, objectType]),
+);
+
+/** Each message with object_type, by proto full name, to its own ObjectTypeProto value. */
+export const OWN_TYPE_NAMES: ReadonlyMap<string, ObjectTypeProto> = new Map(
+  OWN_TYPE_ROWS.map(([fullName, , objectType]) => [fullName, objectType]),
+);
+
+/** The message's own ObjectTypeProto value, or undefined when its class has none. */
+export function ownType(message: object): ObjectTypeProto | undefined {
+  return OWN_TYPES.get(message.constructor);
 }
 
-function decode(message: ObjectTyped): { objectType: ObjectTypeProto; version: Version } {
-  const objectClass = message.getObjectClass();
-  const versionString = message.getVersion();
-  let objectType = message.getObjectType();
-  let version = compactVersion(message);
-  const problems: string[] = [];
-  let usedStrings = false;
-
-  if (objectType === ObjectTypeProto.OBJECT_TYPE_UNKNOWN && objectClass) {
-    usedStrings = true;
-    objectType = fromLegacy(objectClass);
-    if (objectType === ObjectTypeProto.OBJECT_TYPE_UNKNOWN) {
-      problems.push(' (unknown object_class, using OBJECT_TYPE_UNKNOWN)');
-    } else {
-      // Some strings were written on more than one message type (e.g.
-      // 'SecurityRequest' on the create and query requests): the message's
-      // own type wins over the value the string sits on.
-      const own = ownTypeOf(message);
-      if (own !== ObjectTypeProto.OBJECT_TYPE_UNKNOWN) objectType = own;
-    }
-  }
-  if (version.every((p) => p === 0) && versionString) {
-    usedStrings = true;
-    const parsed = parseVersion(versionString);
-    if (parsed === null) {
-      problems.push(' (malformed version, using 0.0.0)');
-    } else {
-      version = parsed;
-    }
-  }
-
-  const key = `${objectClass}\u0000${versionString}`;
-  if (usedStrings && !warned.has(key)) {
-    warned.add(key);
-    console.warn(
-      `${message.constructor.name} read from deprecated strings object_class='${objectClass}' ` +
-      `version='${versionString}'${problems.join('')}; re-save it to write object_type and ` +
-      'version_major/minor/patch (LM-297)');
+/**
+ * `stamp` with the message's own ObjectTypeProto value (LM-320); returns it.
+ * Throws an Error when its class has no own value. Generated classes are
+ * anonymous at runtime, so the error names the class only when it has a name.
+ */
+export function stampOwn<T extends ObjectTyped>(message: T): T {
+  const objectType = ownType(message);
+  if (objectType === undefined) {
+    throw new Error(`${message.constructor?.name || 'this message type'} has no own ObjectTypeProto`);
   }
-  return { objectType, version };
-}
-
-/** The message's ObjectTypeProto value: object_type, else the object_class string. */
-export function readType(message: ObjectTyped): ObjectTypeProto {
-  return decode(message).objectType;
-}
-
-/** The message's [major, minor, patch]: the compact fields, else the version string. */
-export function readVersion(message: ObjectTyped): Version {
-  return decode(message).version;
+  return stamp(message, objectType);
 }
 
 /**
- * Fills the compact fields from the strings where they are unset; returns `message`.
- * The strings are kept, so re-serialising writes both forms.
+ * The message's ObjectTypeProto value; OBJECT_TYPE_UNKNOWN when unset. A value
+ * added after this build is returned as its number.
  */
-export function upgrade<T extends ObjectTyped>(message: T): T {
-  const { objectType, version } = decode(message);
-  message.setObjectType(objectType);
-  setCompactVersion(message, version);
-  return message;
+export function readType(message: ObjectTyped): ObjectTypeProto {
+  return message.getObjectType();
 }
 
-/** Forgets which strings have warned. Tests only. */
-export function resetWarningsForTests(): void {
-  warned.clear();
+/** The message's [major, minor, patch], or undefined when version is absent. */
+export function readVersion(message: ObjectTyped): Version | undefined {
+  const version = message.getVersion();
+  if (!message.hasVersion() || version === undefined) return undefined;
+  return [version.getMajor(), version.getMinor(), version.getPatch()];
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fintekkers/ledger-models",
   "todo": "Replace the version with build script version number",
-  "version": "0.4.43",
+  "version": "0.4.45",
   "description": "ledger model protos ",
   "authors": [
     "David Doherty",

package/node/wrappers/models/position/position.test copy.js

@@ -1,107 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var uuid_1 = require("../utils/uuid");
-var any_pb_1 = require("google-protobuf/google/protobuf/any_pb");
-var decimal_value_pb_1 = require("../../../fintekkers/models/util/decimal_value_pb");
-var position_pb_1 = require("../../../fintekkers/models/position/position_pb");
-var position_util_pb_1 = require("../../../fintekkers/models/position/position_util_pb");
-var field_pb_1 = require("../../../fintekkers/models/position/field_pb");
-var measure_pb_1 = require("../../../fintekkers/models/position/measure_pb");
-var security_pb_1 = require("../../../fintekkers/models/security/security_pb");
-var portfolio_pb_1 = require("../../../fintekkers/models/portfolio/portfolio_pb");
-var position_1 = require("./position");
-var date_1 = require("../utils/date");
-var position_status_pb_1 = require("../../../fintekkers/models/position/position_status_pb");
-test('test the position wrapper', function () { return __awaiter(void 0, void 0, void 0, function () {
-    var isTrue;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, testSerialization()];
-            case 1:
-                isTrue = _a.sent();
-                expect(isTrue).toBe(true);
-                return [2 /*return*/];
-        }
-    });
-}); });
-function testSerialization() {
-    return __awaiter(this, void 0, void 0, function () {
-        var fields, security, portfolio, tradeDate, productType, id, measure, measureValue, tradeDatePacked, idPacked, positionProto, position, tradeDatePosition, securityPosition, portfolioPosition, positionID;
-        return __generator(this, function (_a) {
-            fields = [field_pb_1.FieldProto.ID, field_pb_1.FieldProto.TRADE_DATE, field_pb_1.FieldProto.PRODUCT_TYPE, field_pb_1.FieldProto.PORTFOLIO, field_pb_1.FieldProto.SECURITY];
-            security = new security_pb_1.SecurityProto().setAssetClass("Test");
-            portfolio = new portfolio_pb_1.PortfolioProto().setPortfolioName("Test portfolio");
-            tradeDate = date_1.LocalDate.today().toDate();
-            productType = "Test product type";
-            id = new uuid_1.UUID(uuid_1.UUID.random().toBytes());
-            measure = measure_pb_1.MeasureProto.DIRECTED_QUANTITY;
-            measureValue = new decimal_value_pb_1.DecimalValueProto().setArbitraryPrecisionValue("1.0");
-            tradeDatePacked = new any_pb_1.Any();
-            tradeDatePacked.setTypeUrl("Doesn't matter");
-            tradeDatePacked.setValue(date_1.LocalDate.from(tradeDate).toProto().serializeBinary());
-            idPacked = new any_pb_1.Any();
-            idPacked.setTypeUrl("Doesn't matter");
-            idPacked.setValue(id.toUUIDProto().serializeBinary());
-            positionProto = new position_pb_1.PositionProto();
-            positionProto.setFieldsList([
-                new position_util_pb_1.FieldMapEntry().setField(field_pb_1.FieldProto.TRADE_DATE).setFieldValuePacked(tradeDatePacked),
-                new position_util_pb_1.FieldMapEntry().setField(field_pb_1.FieldProto.SECURITY).setFieldValuePacked(security),
-                new position_util_pb_1.FieldMapEntry().setField(field_pb_1.FieldProto.PORTFOLIO).setFieldValuePacked(portfolio),
-                new position_util_pb_1.FieldMapEntry().setField(field_pb_1.FieldProto.POSITION_STATUS).setEnumValue(position_status_pb_1.PositionStatusProto.EXECUTED),
-                new position_util_pb_1.FieldMapEntry().setField(field_pb_1.FieldProto.PRODUCT_TYPE).setStringValue(productType),
-                new position_util_pb_1.FieldMapEntry().setField(field_pb_1.FieldProto.ID).setFieldValuePacked(idPacked),
-            ]);
-            position = new position_1.Position(positionProto);
-            tradeDatePosition = position.getFieldValue(field_pb_1.FieldProto.TRADE_DATE);
-            expect(tradeDate.getFullYear()).toBe(tradeDatePosition.getFullYear());
-            expect(tradeDate.getMonth()).toBe(tradeDatePosition.getMonth());
-            expect(tradeDate.getDay()).toBe(tradeDatePosition.getDay());
-            securityPosition = position.getFieldValue(field_pb_1.FieldProto.SECURITY);
-            expect(securityPosition.getAssetClass()).toBe(security.getAssetClass());
-            portfolioPosition = position.getFieldValue(field_pb_1.FieldProto.PORTFOLIO);
-            expect(portfolioPosition.getPortfolioName()).toBe(portfolio.getPortfolioName());
-            expect(position.getFieldValue(field_pb_1.FieldProto.PRODUCT_TYPE)).toBe(productType);
-            positionID = position.getFieldValue(field_pb_1.FieldProto.ID);
-            expect(positionID.toString()).toBe(id.toString());
-            expect(position.getFieldValue(field_pb_1.FieldProto.POSITION_STATUS)).toBe(position_status_pb_1.PositionStatusProto.EXECUTED);
-            return [2 /*return*/, true];
-        });
-    });
-}
-//# sourceMappingURL=position.test%20copy.js.map

package/node/wrappers/models/position/position.test copy.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"position.test copy.js","sourceRoot":"","sources":["position.test copy.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,sCAAqC;AACrC,iEAA6D;AAS7D,qFAAqF;AAErF,+EAAsH;AACtH,yFAAqF;AACrF,yEAA0E;AAK1E,6EAA8E;AAC9E,+EAAgF;AAChF,kFAAmF;AACnF,uCAAsC;AACtC,sCAA0C;AAC1C,6FAA6F;AAE7F,IAAI,CAAC,2BAA2B,EAAE;;;;oBACf,qBAAM,iBAAiB,EAAE,EAAA;;gBAAlC,MAAM,GAAG,SAAyB;gBACxC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;KAC7B,CAAC,CAAC;AAEH,SAAe,iBAAiB;;;;YACxB,MAAM,GAAG,CAAC,qBAAU,CAAC,EAAE,EAAE,qBAAU,CAAC,UAAU,EAAE,qBAAU,CAAC,YAAY,EAAE,qBAAU,CAAC,SAAS,EAAE,qBAAU,CAAC,QAAQ,CAAC,CAAC;YAEpH,QAAQ,GAAG,IAAI,2BAAa,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YACrD,SAAS,GAAG,IAAI,6BAAc,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;YACpE,SAAS,GAAG,gBAAS,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,CAAC;YACvC,WAAW,GAAG,mBAAmB,CAAC;YAClC,EAAE,GAAG,IAAI,WAAI,CAAC,WAAI,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAEvC,OAAO,GAAG,yBAAY,CAAC,iBAAiB,CAAC;YACzC,YAAY,GAAG,IAAI,oCAAiB,EAAE,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;YAEvE,eAAe,GAAG,IAAI,YAAG,EAAE,CAAC;YAClC,eAAe,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAC7C,eAAe,CAAC,QAAQ,CAAC,gBAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAE1E,QAAQ,GAAG,IAAI,YAAG,EAAE,CAAC;YAC3B,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,eAAe,EAAE,CAAC,CAAC;YAElD,aAAa,GAAG,IAAI,2BAAa,EAAE,CAAC;YACxC,aAAa,CAAC,aAAa,CAAC;gBACxB,IAAI,gCAAa,EAAE,CAAC,QAAQ,CAAC,qBAAU,CAAC,UAAU,CAAC,CAAC,mBAAmB,CAAC,eAAe,CAAC;gBACxF,IAAI,gCAAa,EAAE,CAAC,QAAQ,CAAC,qBAAU,CAAC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC;gBAC/E,IAAI,gCAAa,EAAE,CAAC,QAAQ,CAAC,qBAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,SAAS,CAAC;gBACjF,IAAI,gCAAa,EAAE,CAAC,QAAQ,CAAC,qBAAU,CAAC,eAAe,CAAC,CAAC,YAAY,CAAC,wCAAmB,CAAC,QAAQ,CAAC;gBACnG,IAAI,gCAAa,EAAE,CAAC,QAAQ,CAAC,qBAAU,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC;gBACjF,IAAI,gCAAa,EAAE,CAAC,QAAQ,CAAC,qBAAU,CAAC,EAAE,CAAC,CAAC,mBAAmB,CAAC,QAAQ,CAAC;aAC5E,CAAC,CAAC;YACC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,aAAa,CAAC,CAAC;YAEvC,iBAAiB,GAAG,QAAQ,CAAC,aAAa,CAAC,qBAAU,CAAC,UAAU,CAAC,CAAC;YACtE,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC,CAAC;YACtE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC,CAAC;YAChE,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC;YAExD,gBAAgB,GAAkB,QAAQ,CAAC,aAAa,CAAC,qBAAU,CAAC,QAAQ,CAAC,CAAC;YAClF,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;YAEpE,iBAAiB,GAAmB,QAAQ,CAAC,aAAa,CAAC,qBAAU,CAAC,SAAS,CAAC,CAAC;YACrF,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAEhF,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,qBAAU,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAEtE,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,qBAAU,CAAC,EAAE,CAAC,CAAC;YACvD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;YAElD,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,qBAAU,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,wCAAmB,CAAC,QAAQ,CAAC,CAAC;YAE9F,sBAAO,IAAI,EAAC;;;CACf"}