@fintekkers/ledger-models 0.4.42 → 0.4.44

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

@@ -1,11 +1,11 @@
-// Compact object type and version (LM-297): writers set both forms, readers
-// translate the strings-only form. Rows come from the shared fixture
-// test-fixtures/object-type-legacy.json, which Java, Python and Rust also load.
+// Object type and version (LM-297, LM-318): `stamp` writes object_type = 1
+// and version = 2 (0.0.1), and bytes from earlier releases are not readable.
 import * as fs from 'fs';
 import * as path from 'path';
 import { Decimal } from 'decimal.js';
 
 import { ObjectTypeProto } from '../../fintekkers/models/util/object_type_pb';
+import { VersionProto } from '../../fintekkers/models/util/version_pb';
 import { SecurityProto } from '../../fintekkers/models/security/security_pb';
 import { PriceProto } from '../../fintekkers/models/price/price_pb';
 import { TransactionProto } from '../../fintekkers/models/transaction/transaction_pb';
@@ -34,146 +34,43 @@ import { SecurityService } from '../services/security-service/SecurityService';
 import { TransactionService } from '../services/transaction-service/TransactionService';
 import { PortfolioService } from '../services/portfolio-service/PortfolioService';
 
-interface FixtureCase {
-  name: string;
-  source: string;
-  message: string;
-  object_class: string;
-  version: string;
-  bytes: string;
-  expect: { object_type: keyof typeof ObjectTypeProto; version: number[]; warns: boolean };
-}
-
-const REPO_ROOT = path.resolve(__dirname, '../../../..');
-const CASES: FixtureCase[] = JSON.parse(
-  fs.readFileSync(path.join(REPO_ROOT, 'test-fixtures', 'object-type-legacy.json'), 'utf8')).cases;
-const COMPACT_NUMBERS: Record<string, number> = {
-  object_type: 1001, version_major: 1002, version_minor: 1003, version_patch: 1004,
-};
-
-type MessageClass = { deserializeBinary(bytes: Uint8Array): ObjectTyped & { serializeBinary(): Uint8Array } };
-
-/** Generated message classes by proto full name: the package is the directory under node/. */
-function messageClasses(): Map<string, MessageClass> {
-  const root = path.resolve(__dirname, '../../fintekkers');
-  const classes = new Map<string, MessageClass>();
-  const walk = (dir: string): void => {
-    for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
-      const full = path.join(dir, entry.name);
-      if (entry.isDirectory()) {
-        walk(full);
-      } else if (entry.name.endsWith('_pb.js')) {
-        const pkg = path.relative(path.dirname(root), dir).split(path.sep).join('.');
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        for (const [name, cls] of Object.entries(require(full))) {
-          classes.set(`${pkg}.${name}`, cls as MessageClass);
-        }
-      }
-    }
-  };
-  walk(root);
-  return classes;
-}
-
-const CLASSES = messageClasses();
-
-function decode(c: FixtureCase) {
-  const cls = CLASSES.get(c.message);
-  if (!cls) throw new Error(`no generated class for ${c.message}`);
-  return cls.deserializeBinary(Buffer.from(c.bytes, 'base64'));
-}
-
-/** Field numbers present at the top level of an encoded message. */
-function topLevelFieldNumbers(data: Uint8Array): number[] {
-  const numbers: number[] = [];
-  let i = 0;
-  const varint = (): number => {
-    let result = 0;
-    let scale = 1;
-    for (;;) {
-      const b = data[i++];
-      result += (b & 0x7f) * scale;
-      scale *= 128;
-      if (!(b & 0x80)) return result;
-    }
-  };
-  while (i < data.length) {
-    const key = varint();
-    numbers.push(Math.floor(key / 8));
-    const wireType = key % 8;
-    if (wireType === 0) varint();
-    else if (wireType === 1) i += 8;
-    else if (wireType === 2) {
-      const length = varint();
-      i += length;
-    }
-    else if (wireType === 5) i += 4;
-    else throw new Error(`unexpected wire type ${wireType}`);
-  }
-  return numbers;
-}
-
-let warn: jest.SpyInstance;
-
-beforeEach(() => {
-  objectTypes.resetWarningsForTests();
-  warn = jest.spyOn(console, 'warn').mockImplementation(() => undefined);
-});
-
-afterEach(() => {
-  warn.mockRestore();
-  objectTypes.resetWarningsForTests();
+// A PriceProto written by ledger-models v0.4.33: object_class / version
+// strings in fields 1 and 2.
+const OLD_PRICE = path.resolve(__dirname, '../../../../ledger-models-protos/fixtures/legacy_v0433/price.bin');
+
+// ---- stamp round-trips (metric 2) ----
+
+test('a stamped price round-trips type and version', () => {
+  const price = objectTypes.stamp(new PriceProto(), ObjectTypeProto.OBJECT_TYPE_PRICE);
+  const bytes = price.serializeBinary();
+  // Exactly field 1 (varint 11) and field 2 ({patch: 1}): nothing at the
+  // removed 1001-1004.
+  expect(Array.from(bytes)).toEqual([0x08, 11, 0x12, 0x02, 0x18, 0x01]);
+
+  const reread = PriceProto.deserializeBinary(bytes);
+  expect(objectTypes.readType(reread)).toBe(ObjectTypeProto.OBJECT_TYPE_PRICE);
+  expect(objectTypes.readVersion(reread)).toEqual([0, 0, 1]);
+  const version = reread.getVersion() as VersionProto;
+  expect([version.getMajor(), version.getMinor(), version.getPatch()]).toEqual([0, 0, 1]);
+  // Nothing unknown kept on re-serialising.
+  expect(Array.from(reread.serializeBinary())).toEqual(Array.from(bytes));
 });
 
-const fallbackWarnings = (): number => warn.mock.calls.filter((args) => String(args[0]).includes('(LM-297)')).length;
-
-// ---- Loading the old form translates it (metric 3) ----
-
-describe.each(CASES.map((c) => [c.name, c] as const))('fixture row %s', (_name, c) => {
-  test('decodes to the expected type and version', () => {
-    const message = decode(c);
-    expect(objectTypes.readType(message)).toBe(ObjectTypeProto[c.expect.object_type]);
-    expect(objectTypes.readVersion(message)).toEqual(c.expect.version);
-    expect(fallbackWarnings()).toBe(c.expect.warns ? 1 : 0);
-  });
-
-  test('re-serialises with the compact fields once upgraded', () => {
-    const data = objectTypes.upgrade(decode(c)).serializeBinary();
-    const expected: Record<string, number> = {
-      object_type: ObjectTypeProto[c.expect.object_type],
-      version_major: c.expect.version[0],
-      version_minor: c.expect.version[1],
-      version_patch: c.expect.version[2],
-    };
-    const present = topLevelFieldNumbers(data);
-    for (const [name, number] of Object.entries(COMPACT_NUMBERS)) {
-      expect([name, present.includes(number)]).toEqual([name, expected[name] !== 0]);
-    }
-    const reread = CLASSES.get(c.message)!.deserializeBinary(data);
-    expect([reread.getObjectType(), reread.getVersionMajor(), reread.getVersionMinor(), reread.getVersionPatch()])
-      .toEqual([expected.object_type, expected.version_major, expected.version_minor, expected.version_patch]);
-    expect([reread.getObjectClass(), reread.getVersion()]).toEqual([c.object_class, c.version]);
-  });
+test('an unstamped message reads as unknown and absent', () => {
+  const price = PriceProto.deserializeBinary(new PriceProto().serializeBinary());
+  expect(objectTypes.readType(price)).toBe(ObjectTypeProto.OBJECT_TYPE_UNKNOWN);
+  expect(objectTypes.readVersion(price)).toBeUndefined();
 });
 
-// ---- Reading the strings is deprecated (metric 4) ----
-
-test('three strings-only decodes of one type warn once', () => {
-  const c = CASES.find((row) => row.name === 'js-PositionFilterProto')!;
-  for (let i = 0; i < 3; i++) {
-    objectTypes.upgrade(decode(c));
-  }
-  expect(fallbackWarnings()).toBe(1);
-});
+// ---- Old bytes are not readable (metric 3) ----
 
-test('the new form does not warn', () => {
-  const message = objectTypes.stamp(new PriceProto(), ObjectTypeProto.OBJECT_TYPE_PRICE, 'Price', '0.0.1');
-  objectTypes.readType(message);
-  objectTypes.readVersion(message);
-  expect(fallbackWarnings()).toBe(0);
+test('bytes from v0.4.33 are not readable', () => {
+  // Field 2 held the string "0.0.1", which does not parse as a VersionProto.
+  const old = new Uint8Array(fs.readFileSync(OLD_PRICE));
+  expect(() => PriceProto.deserializeBinary(old)).toThrow();
 });
 
-// ---- Writers set both forms (metric 2) ----
+// ---- Every library writer stamps the new form (metric 2) ----
 
 /** A service with its gRPC client swapped for one that records each request. */
 function capturingService<S extends object>(cls: { prototype: S }, response: () => unknown): { service: S; requests: ObjectTyped[] } {
@@ -226,7 +123,7 @@ async function linkResolverRequests(): Promise<ObjectTyped[]> {
   return requests;
 }
 
-type Writer = [string, () => Promise<ObjectTyped>, ObjectTypeProto, string, string];
+type Writer = [string, () => Promise<ObjectTyped>, ObjectTypeProto];
 
 async function lastRequest<S extends object>(cls: { prototype: S }, call: (service: S) => Promise<unknown>): Promise<ObjectTyped> {
   const { service, requests } = capturingService(cls, () => new SummaryProto());
@@ -236,41 +133,41 @@ async function lastRequest<S extends object>(cls: { prototype: S }, call: (servi
 
 const LIBRARY_WRITERS: Writer[] = [
   ['Price.fromSimple', async () => Price.fromSimple(UUID.random().toString(), 1, new Date()).proto,
-    ObjectTypeProto.OBJECT_TYPE_PRICE, 'Price', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_PRICE],
   ['Price.create', async () => Price.create(new Decimal(1), security(), ZonedDateTime.now()).proto,
-    ObjectTypeProto.OBJECT_TYPE_PRICE, 'Price', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_PRICE],
   ['PositionFilter.toProto', async () => filter().toProto(),
-    ObjectTypeProto.OBJECT_TYPE_POSITION_FILTER, 'PositionFilter', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_POSITION_FILTER],
   ['QueryPositionRequest.toProto', async () => new QueryPositionRequest(
     filter(), PositionTypeProto.TRANSACTION, PositionViewProto.DEFAULT_VIEW, [], [], ZonedDateTime.now()).toProto(),
-  ObjectTypeProto.OBJECT_TYPE_QUERY_POSITION_REQUEST, '', '1.0.0'],
+  ObjectTypeProto.OBJECT_TYPE_QUERY_POSITION_REQUEST],
   ['Transaction', async () => transaction().proto,
-    ObjectTypeProto.OBJECT_TYPE_TRANSACTION, 'Transaction', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_TRANSACTION],
   ['Transaction strategy allocation', async () => transaction().proto.getStrategyAllocation()!,
-    ObjectTypeProto.OBJECT_TYPE_STRATEGY_ALLOCATION, 'StrategyAllocation', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_STRATEGY_ALLOCATION],
   ['PriceService.validateCreateOrUpdate', () => lastRequest(PriceService, (s) => s.validateCreateOrUpdate(new PriceProto())),
-    ObjectTypeProto.OBJECT_TYPE_CREATE_PRICE_REQUEST, 'PriceRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_CREATE_PRICE_REQUEST],
   ['PriceService.search', () => lastRequest(PriceService, (s) => s.search(asOf, filter())),
-    ObjectTypeProto.OBJECT_TYPE_QUERY_PRICE_REQUEST, 'PriceRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_QUERY_PRICE_REQUEST],
   ['SecurityService.validateCreateSecurity', () => lastRequest(SecurityService, (s) => s.validateCreateSecurity(new SecurityProto())),
-    ObjectTypeProto.OBJECT_TYPE_CREATE_SECURITY_REQUEST, 'SecurityRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_CREATE_SECURITY_REQUEST],
   ['SecurityService.searchSecurity', () => lastRequest(SecurityService, (s) => s.searchSecurity(asOf, filter())),
-    ObjectTypeProto.OBJECT_TYPE_QUERY_SECURITY_REQUEST, 'SecurityRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_QUERY_SECURITY_REQUEST],
   ['TransactionService.validateCreateTransaction', () => lastRequest(TransactionService,
     (s) => s.validateCreateTransaction({ proto: new TransactionProto() } as Transaction)),
-  ObjectTypeProto.OBJECT_TYPE_CREATE_TRANSACTION_REQUEST, 'TransactionRequest', '0.0.1'],
+  ObjectTypeProto.OBJECT_TYPE_CREATE_TRANSACTION_REQUEST],
   ['TransactionService.searchTransaction', () => lastRequest(TransactionService, (s) => s.searchTransaction(asOf, filter())),
-    ObjectTypeProto.OBJECT_TYPE_QUERY_TRANSACTION_REQUEST, 'SecurityRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_QUERY_TRANSACTION_REQUEST],
   ['PortfolioService.validateCreatePortfolio', () => lastRequest(PortfolioService, (s) => s.validateCreatePortfolio(new PortfolioProto())),
-    ObjectTypeProto.OBJECT_TYPE_CREATE_PORTFOLIO_REQUEST, 'PortfolioRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_CREATE_PORTFOLIO_REQUEST],
   ['PortfolioService.searchPortfolio', () => lastRequest(PortfolioService, (s) => s.searchPortfolio(asOf, filter())),
-    ObjectTypeProto.OBJECT_TYPE_QUERY_PORTFOLIO_REQUEST, 'PortfolioRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_QUERY_PORTFOLIO_REQUEST],
   ['LinkResolver securities', async () => (await linkResolverRequests())[0],
-    ObjectTypeProto.OBJECT_TYPE_QUERY_SECURITY_REQUEST, 'SecurityRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_QUERY_SECURITY_REQUEST],
   ['LinkResolver portfolios', async () => (await linkResolverRequests())[1],
-    ObjectTypeProto.OBJECT_TYPE_QUERY_PORTFOLIO_REQUEST, 'PortfolioRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_QUERY_PORTFOLIO_REQUEST],
   ['LinkResolver transactions', async () => (await linkResolverRequests())[2],
-    ObjectTypeProto.OBJECT_TYPE_QUERY_TRANSACTION_REQUEST, 'TransactionRequest', '0.0.1'],
+    ObjectTypeProto.OBJECT_TYPE_QUERY_TRANSACTION_REQUEST],
 ];
 
 function transaction(): Transaction {
@@ -286,22 +183,10 @@ function transaction(): Transaction {
   });
 }
 
-test.each(LIBRARY_WRITERS)('%s sets strings and compact fields that agree', async (_name, build, type, objectClass, version) => {
+test.each(LIBRARY_WRITERS)('%s stamps the type and schema version', async (_name, build, type) => {
   const message = await build();
 
-  expect([message.getObjectClass(), message.getVersion()]).toEqual([objectClass, version]);
-  // The message's own type. Some JS writers put a query request's string on the
-  // create request too; the string still sits on one enum value.
-  expect(message.getObjectType()).toBe(type);
-  if (objectClass) {
-    expect(objectTypes.fromLegacy(objectClass)).not.toBe(ObjectTypeProto.OBJECT_TYPE_UNKNOWN);
-  }
-  expect([message.getVersionMajor(), message.getVersionMinor(), message.getVersionPatch()])
-    .toEqual(objectTypes.parseVersion(version));
-  expect(objectTypes.readVersion(message)).toEqual(objectTypes.parseVersion(version));
-  expect(fallbackWarnings()).toBe(0);
-});
-
-test('stamp rejects a malformed version', () => {
-  expect(() => objectTypes.stamp(new PriceProto(), ObjectTypeProto.OBJECT_TYPE_PRICE, 'Price', '1.2')).toThrow();
+  expect(objectTypes.readType(message)).toBe(type);
+  expect(objectTypes.readVersion(message)).toEqual(objectTypes.SCHEMA_VERSION);
+  expect(objectTypes.SCHEMA_VERSION).toEqual([0, 0, 1]);
 });

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

@@ -1,207 +1,53 @@
 /**
- * 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`. 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';
+import { VersionProto } from '../../fintekkers/models/util/version_pb';
 
-/** Any generated message that carries object_class / version and their compact form. */
+/** 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 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.
- */
-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]];
-}
+/** The schema version `stamp` writes. Not the library release. */
+export const SCHEMA_VERSION: Version = [0, 0, 1];
 
 /**
- * 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.
+ * Sets object_type and version (`SCHEMA_VERSION`) on `message`; returns it.
+ * `objectType` is the message's own ObjectTypeProto value.
  */
-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()];
-}
-
-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)');
-  }
-  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;
-}
-
 /**
- * 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.42",
+  "version": "0.4.44",
   "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"}