@vepler/sdk 2.167.0 → 3.3.0

package/dist/commonjs/sdk/models/shared/transaction.d.ts

@@ -27,7 +27,7 @@ export type TransactionLease = {
     /**
      * Lease term verbatim from the register (e.g. '125 years from 11 February 2004').
      */
-    termText: string | null;
+    termText?: string | null | undefined;
     /**
      * Parsed lease length in years, where derivable.
      */
@@ -58,23 +58,23 @@ export type TransactionTenure = OpenEnum<typeof TransactionTenure>;
  * A standardised property transaction. All monetary values are in minor currency units.
  */
 export type Transaction = {
-    address: TransactionAddress;
+    address?: TransactionAddress | undefined;
     /**
      * ISO 3166-1 alpha-2 country code.
      */
-    country: string;
+    country?: string | undefined;
     /**
      * Completion (sale) or registration (lease grant) date.
      */
-    date: Date;
+    date?: Date | undefined;
     /**
      * Opaque composite id: {country}:{provider}:{externalId}.
      */
-    id: string;
+    id?: string | undefined;
     /**
      * Transaction kind. 'sale': a completed sale/transfer. 'lease_grant': the grant of a new lease (premium).
      */
-    kind: TransactionKind;
+    kind?: TransactionKind | undefined;
     /**
      * Lease detail; present only when kind is 'lease_grant'.
      */
@@ -87,12 +87,12 @@ export type Transaction = {
     /**
      * Object type discriminator. Always 'transaction'.
      */
-    object: TransactionObject;
-    price: TransactionPrice;
+    object?: TransactionObject | undefined;
+    price?: TransactionPrice | undefined;
     /**
      * Canonical property type.
      */
-    propertyType: string;
+    propertyType?: string | undefined;
     /**
      * Source registry identifier (permission-gated).
      */
@@ -104,7 +104,7 @@ export type Transaction = {
     /**
      * Canonical tenure of the transacted interest. Null when the source did not record a usable tenure.
      */
-    tenure: TransactionTenure | null;
+    tenure?: TransactionTenure | null | undefined;
 };
 /** @internal */
 export declare const TransactionKind$inboundSchema: z.ZodType<TransactionKind, z.ZodTypeDef, unknown>;

package/dist/commonjs/sdk/models/shared/transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transaction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,kBAAkB,EAEnB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,mBAAmB,EAEpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,eAAe;;;CAGlB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,eAAe,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;CAEpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IACX;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAC1B,KAAK,EAAE,gBAAgB,CAAC;IACxB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CACmC,CAAC;AAE7C,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD;AAED,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,aAAa,CAC3D,OAAO,iBAAiB,CACS,CAAC;AAEpC,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CACqC,CAAC;AAE/C,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CAgBP,CAAC;AAEH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAMlD"}
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transaction.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,kBAAkB,EAEnB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,mBAAmB,EAEpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,eAAe;;;CAGlB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,eAAe,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;CAEpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,EAAE,mBAAmB,GAAG,IAAI,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACvC,KAAK,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CACmC,CAAC;AAE7C,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD;AAED,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,aAAa,CAC3D,OAAO,iBAAiB,CACS,CAAC;AAEpC,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CACqC,CAAC;AAE/C,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAC/C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CAiBP,CAAC;AAEH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAMlD"}

package/dist/commonjs/sdk/models/shared/transaction.js

@@ -70,7 +70,7 @@ exports.TransactionKind$inboundSchema = openEnums.inboundSchema(exports.Transact
 /** @internal */
 exports.TransactionLease$inboundSchema = z.object({
     startDate: z.nullable(z.string().datetime({ offset: true }).transform(v => new Date(v))).optional(),
-    termText: z.nullable(z.string()),
+    termText: z.nullable(z.string()).optional(),
     termYears: z.nullable(z.number()).optional(),
 });
 function transactionLeaseFromJSON(jsonString) {
@@ -82,20 +82,21 @@ exports.TransactionObject$inboundSchema = z.nativeEnum(exports.TransactionObject
 exports.TransactionTenure$inboundSchema = openEnums.inboundSchema(exports.TransactionTenure);
 /** @internal */
 exports.Transaction$inboundSchema = z.object({
-    address: transactionaddress_js_1.TransactionAddress$inboundSchema,
-    country: z.string(),
-    date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-    id: z.string(),
-    kind: exports.TransactionKind$inboundSchema,
+    address: transactionaddress_js_1.TransactionAddress$inboundSchema.optional(),
+    country: z.string().optional(),
+    date: z.string().datetime({ offset: true }).transform(v => new Date(v))
+        .optional(),
+    id: z.string().optional(),
+    kind: exports.TransactionKind$inboundSchema.optional(),
     lease: z.nullable(z.lazy(() => exports.TransactionLease$inboundSchema)).optional(),
     location: z.nullable(transactionlocation_js_1.TransactionLocation$inboundSchema).optional(),
     newBuild: z.nullable(z.boolean()).optional(),
-    object: exports.TransactionObject$inboundSchema,
-    price: transactionprice_js_1.TransactionPrice$inboundSchema,
-    propertyType: z.string(),
+    object: exports.TransactionObject$inboundSchema.optional(),
+    price: transactionprice_js_1.TransactionPrice$inboundSchema.optional(),
+    propertyType: z.string().optional(),
     provider: z.string().optional(),
     sources: z.array(z.string()).optional(),
-    tenure: z.nullable(exports.TransactionTenure$inboundSchema),
+    tenure: z.nullable(exports.TransactionTenure$inboundSchema).optional(),
 });
 function transactionFromJSON(jsonString) {
     return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.Transaction$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Transaction' from JSON`);

package/dist/commonjs/sdk/models/shared/transaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transaction.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmJH,4DAQC;AAoCD,kDAQC;AArMD,0CAA4B;AAC5B,wDAAoD;AACpD,gEAAkD;AAIlD,mEAGiC;AACjC,qEAGkC;AAClC,+DAG+B;AAE/B;;GAEG;AACU,QAAA,eAAe,GAAG;IAC7B,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,aAAa;CACjB,CAAC;AAwBX;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,WAAW,EAAE,aAAa;CAClB,CAAC;AAMX;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;CACd,CAAC;AA2DX,gBAAgB;AACH,QAAA,6BAA6B,GAItC,SAAS,CAAC,aAAa,CAAC,uBAAe,CAAC,CAAC;AAE7C,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,QAAQ,CACnB,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC,QAAQ,EAAE;IACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAChC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,+BAA+B,GAExC,CAAC,CAAC,UAAU,CAAC,yBAAiB,CAAC,CAAC;AAEpC,gBAAgB;AACH,QAAA,+BAA+B,GAIxC,SAAS,CAAC,aAAa,CAAC,yBAAiB,CAAC,CAAC;AAE/C,gBAAgB;AACH,QAAA,yBAAyB,GAIlC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,wDAAgC;IACzC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IACvE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,qCAA6B;IACnC,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sCAA8B,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1E,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,0DAAiC,CAAC,CAAC,QAAQ,EAAE;IAClE,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,uCAA+B;IACvC,KAAK,EAAE,oDAA8B;IACrC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,uCAA+B,CAAC;CACpD,CAAC,CAAC;AAEH,SAAgB,mBAAmB,CACjC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrD,yCAAyC,CAC1C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transaction.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmJH,4DAQC;AAqCD,kDAQC;AAtMD,0CAA4B;AAC5B,wDAAoD;AACpD,gEAAkD;AAIlD,mEAGiC;AACjC,qEAGkC;AAClC,+DAG+B;AAE/B;;GAEG;AACU,QAAA,eAAe,GAAG;IAC7B,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,aAAa;CACjB,CAAC;AAwBX;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,WAAW,EAAE,aAAa;CAClB,CAAC;AAMX;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,UAAU;IACpB,SAAS,EAAE,WAAW;CACd,CAAC;AA2DX,gBAAgB;AACH,QAAA,6BAA6B,GAItC,SAAS,CAAC,aAAa,CAAC,uBAAe,CAAC,CAAC;AAE7C,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,QAAQ,CACnB,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAClE,CAAC,QAAQ,EAAE;IACZ,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,+BAA+B,GAExC,CAAC,CAAC,UAAU,CAAC,yBAAiB,CAAC,CAAC;AAEpC,gBAAgB;AACH,QAAA,+BAA+B,GAIxC,SAAS,CAAC,aAAa,CAAC,yBAAiB,CAAC,CAAC;AAE/C,gBAAgB;AACH,QAAA,yBAAyB,GAIlC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,wDAAgC,CAAC,QAAQ,EAAE;IACpD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;SACpE,QAAQ,EAAE;IACb,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,IAAI,EAAE,qCAA6B,CAAC,QAAQ,EAAE;IAC9C,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,sCAA8B,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1E,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,0DAAiC,CAAC,CAAC,QAAQ,EAAE;IAClE,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,uCAA+B,CAAC,QAAQ,EAAE;IAClD,KAAK,EAAE,oDAA8B,CAAC,QAAQ,EAAE;IAChD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,uCAA+B,CAAC,CAAC,QAAQ,EAAE;CAC/D,CAAC,CAAC;AAEH,SAAgB,mBAAmB,CACjC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,iCAAyB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrD,yCAAyC,CAC1C,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/transactionlocation.d.ts

@@ -5,8 +5,8 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * WGS84 point [lon, lat].
  */
 export type TransactionLocationPoint = {
-    lat: number;
-    lon: number;
+    lat?: number | undefined;
+    lon?: number | undefined;
 };
 export type TransactionLocation = {
     /**

package/dist/commonjs/sdk/models/shared/transactionlocation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transactionlocation.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionlocation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,GAAG,IAAI,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D;AAED,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}
+{"version":3,"file":"transactionlocation.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionlocation.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,GAAG,IAAI,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,wBAAwB,EACxB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,gCAAgC,CAC9C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAM/D;AAED,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D"}

package/dist/commonjs/sdk/models/shared/transactionlocation.js

@@ -43,8 +43,8 @@ const z = __importStar(require("zod/v3"));
 const schemas_js_1 = require("../../../lib/schemas.js");
 /** @internal */
 exports.TransactionLocationPoint$inboundSchema = z.object({
-    lat: z.number(),
-    lon: z.number(),
+    lat: z.number().optional(),
+    lon: z.number().optional(),
 });
 function transactionLocationPointFromJSON(jsonString) {
     return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TransactionLocationPoint$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TransactionLocationPoint' from JSON`);

package/dist/commonjs/sdk/models/shared/transactionlocation.js.map

@@ -1 +1 @@
-{"version":3,"file":"transactionlocation.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionlocation.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CH,4EAQC;AAeD,kEAQC;AAzED,0CAA4B;AAC5B,wDAAoD;AA+BpD,gBAAgB;AACH,QAAA,sCAAsC,GAI/C,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,8CAAsC,CAAC,CAAC;SACpE,QAAQ,EAAE;IACb,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CACzC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC"}
+{"version":3,"file":"transactionlocation.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionlocation.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CH,4EAQC;AAeD,kEAQC;AAzED,0CAA4B;AAC5B,wDAAoD;AA+BpD,gBAAgB;AACH,QAAA,sCAAsC,GAI/C,CAAC,CAAC,MAAM,CAAC;IACX,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC1B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC;AAEH,SAAgB,gCAAgC,CAC9C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,8CAAsC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAClE,sDAAsD,CACvD,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,8CAAsC,CAAC,CAAC;SACpE,QAAQ,EAAE;IACb,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC7C,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,SAAgB,2BAA2B,CACzC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,yCAAiC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC7D,iDAAiD,CAClD,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/transactionprice.d.ts

@@ -5,11 +5,11 @@ export type TransactionPrice = {
     /**
      * Transaction amount in MINOR currency units (e.g. pence for GBP). Divide by 100 for pounds.
      */
-    amount: number;
+    amount?: number | undefined;
     /**
      * ISO 4217 currency code.
      */
-    currency: string;
+    currency?: string | undefined;
 };
 /** @internal */
 export declare const TransactionPrice$inboundSchema: z.ZodType<TransactionPrice, z.ZodTypeDef, unknown>;

package/dist/commonjs/sdk/models/shared/transactionprice.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transactionprice.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionprice.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}
+{"version":3,"file":"transactionprice.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionprice.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAMvD"}

package/dist/commonjs/sdk/models/shared/transactionprice.js

@@ -42,8 +42,8 @@ const z = __importStar(require("zod/v3"));
 const schemas_js_1 = require("../../../lib/schemas.js");
 /** @internal */
 exports.TransactionPrice$inboundSchema = z.object({
-    amount: z.number().int(),
-    currency: z.string(),
+    amount: z.number().int().optional(),
+    currency: z.string().optional(),
 });
 function transactionPriceFromJSON(jsonString) {
     return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.TransactionPrice$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TransactionPrice' from JSON`);

package/dist/commonjs/sdk/models/shared/transactionprice.js.map

@@ -1 +1 @@
-{"version":3,"file":"transactionprice.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionprice.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BH,4DAQC;AAlCD,0CAA4B;AAC5B,wDAAoD;AAepD,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACxB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;CACrB,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}
+{"version":3,"file":"transactionprice.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/transactionprice.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BH,4DAQC;AAlCD,0CAA4B;AAC5B,wDAAoD;AAepD,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,sCAA8B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC1D,8CAA8C,CAC/C,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/search.d.ts

@@ -2,6 +2,17 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
 export declare class Search extends ClientSDK {
+    /**
+     * Retrieve the full address record for a selected suggestion
+     *
+     * @remarks
+     * The selection step of the candidate-set search flow. Suggest responses are free and carry only a discovery projection (label + UPRN + match highlights); pass the chosen suggestion's `uprn` here to receive the full address record — address lines, postcode, coordinates and classification.
+     *
+     * Include the `search_id` from the suggest response to complete that search session; the retrieval is then recorded against it. Without a `search_id` (or with one that has expired or is unknown) the endpoint still works as a direct resolve and is recorded as its own transaction.
+     *
+     * This endpoint is charged per retrieved record. Repeat retrievals of the same UPRN within a billing window are charged once — see the `X-Already-Charged` response header.
+     */
+    searchRetrieve(request: operations.SearchRetrieveRequest, options?: RequestOptions): Promise<shared.SearchRetrieveResponse>;
     /**
      * Autocomplete search for UK addresses and locations
      *
@@ -12,7 +23,9 @@ export declare class Search extends ClientSDK {
      * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
      * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
      *
-     * When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
+     * Proximity shapes the RANKING (bias) and membership (restrict) of the address results; pair it with `source=address` for the most predictable proximity behaviour. Suggest returns a discovery projection only — address rows carry the label, UPRN and match highlights, never coordinates, distance or classification. Retrieve a chosen suggestion (`GET /search/retrieve`) for the full record including coordinates.
+     *
+     * Candidate-set sessions: once a query narrows to a small exact match set, the response carries a `search_id` and slim address rows (label + UPRN + match highlights). Pass `search_id` back on subsequent keystrokes to narrow within that set without a new data fetch; when `set_complete` is true the response already contains the complete match set, so further narrowing can happen client-side. Suggest responses are not charged — charging applies when a full record is retrieved.
      */
     searchSuggest(request: operations.SearchSuggestRequest, options?: RequestOptions): Promise<shared.SearchResponse>;
 }

package/dist/commonjs/sdk/search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAGnD,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;;OASG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC;IAQzC;;;;;;;;;;;;;OAaG;IACG,aAAa,CACjB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC;CAOlC"}

package/dist/commonjs/sdk/search.js

@@ -4,10 +4,24 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Search = void 0;
+const searchSearchRetrieve_js_1 = require("../funcs/searchSearchRetrieve.js");
 const searchSearchSuggest_js_1 = require("../funcs/searchSearchSuggest.js");
 const sdks_js_1 = require("../lib/sdks.js");
 const fp_js_1 = require("./types/fp.js");
 class Search extends sdks_js_1.ClientSDK {
+    /**
+     * Retrieve the full address record for a selected suggestion
+     *
+     * @remarks
+     * The selection step of the candidate-set search flow. Suggest responses are free and carry only a discovery projection (label + UPRN + match highlights); pass the chosen suggestion's `uprn` here to receive the full address record — address lines, postcode, coordinates and classification.
+     *
+     * Include the `search_id` from the suggest response to complete that search session; the retrieval is then recorded against it. Without a `search_id` (or with one that has expired or is unknown) the endpoint still works as a direct resolve and is recorded as its own transaction.
+     *
+     * This endpoint is charged per retrieved record. Repeat retrievals of the same UPRN within a billing window are charged once — see the `X-Already-Charged` response header.
+     */
+    async searchRetrieve(request, options) {
+        return (0, fp_js_1.unwrapAsync)((0, searchSearchRetrieve_js_1.searchSearchRetrieve)(this, request, options));
+    }
     /**
      * Autocomplete search for UK addresses and locations
      *
@@ -18,7 +32,9 @@ class Search extends sdks_js_1.ClientSDK {
      * - `geo_mode=bias` (default): soft preference. The best textual matches near the point rank higher, but distant matches are still returned.
      * - `geo_mode=restrict`: hard cutoff. Only address results within `radius_meters` of the point are returned.
      *
-     * When a centre point is supplied, address results include a `distance` (metres from the point). Geographic ranking applies to the address source, so pair it with `source=address` for the most predictable proximity results.
+     * Proximity shapes the RANKING (bias) and membership (restrict) of the address results; pair it with `source=address` for the most predictable proximity behaviour. Suggest returns a discovery projection only — address rows carry the label, UPRN and match highlights, never coordinates, distance or classification. Retrieve a chosen suggestion (`GET /search/retrieve`) for the full record including coordinates.
+     *
+     * Candidate-set sessions: once a query narrows to a small exact match set, the response carries a `search_id` and slim address rows (label + UPRN + match highlights). Pass `search_id` back on subsequent keystrokes to narrow within that set without a new data fetch; when `set_complete` is true the response already contains the complete match set, so further narrowing can happen client-side. Suggest responses are not charged — charging applies when a full record is retrieved.
      */
     async searchSuggest(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, searchSearchSuggest_js_1.searchSearchSuggest)(this, request, options));

package/dist/commonjs/sdk/search.js.map

@@ -1 +1 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,4EAAsE;AACtE,4CAA2D;AAG3D,yCAA4C;AAE5C,MAAa,MAAO,SAAQ,mBAAS;IACnC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAvBD,wBAuBC"}
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../src/sdk/search.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,8EAAwE;AACxE,4EAAsE;AACtE,4CAA2D;AAG3D,yCAA4C;AAE5C,MAAa,MAAO,SAAQ,mBAAS;IACnC;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8CAAoB,EACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,aAAa,CACjB,OAAwC,EACxC,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4CAAmB,EACpC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AA9CD,wBA8CC"}

package/dist/esm/address-search/__tests__/controller.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=controller.test.d.ts.map

package/dist/esm/address-search/__tests__/controller.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controller.test.d.ts","sourceRoot":"","sources":["../../../../src/address-search/__tests__/controller.test.ts"],"names":[],"mappings":""}

package/dist/esm/address-search/__tests__/controller.test.js

@@ -0,0 +1,327 @@
+import { describe, expect, it } from "vitest";
+import { createAddressSearch } from "../controller.js";
+/** Deterministic clock + timer harness injected in place of real timers. */
+function createTimerHarness() {
+    let now = 0;
+    let nextId = 1;
+    const scheduled = new Map();
+    return {
+        timers: {
+            now: () => now,
+            setTimeout: (callback, ms) => {
+                const id = nextId++;
+                scheduled.set(id, { at: now + ms, callback });
+                return id;
+            },
+            clearTimeout: (handle) => {
+                scheduled.delete(handle);
+            },
+        },
+        advance(ms) {
+            now += ms;
+            for (const [id, task] of [...scheduled]) {
+                if (task.at <= now) {
+                    scheduled.delete(id);
+                    task.callback();
+                }
+            }
+        },
+    };
+}
+/** Let promise continuations queued by the transports run. */
+function flush() {
+    return new Promise((resolve) => setTimeout(resolve, 0));
+}
+function suggestion(uprn, title) {
+    return { id: `addr-${uprn}`, title, uprn, source: "address", matchedSubstrings: [], raw: { uprn, title } };
+}
+/** Same rows the server's candidate-set narrowing tests use. */
+const FIXTURE_ROWS = [
+    suggestion("100", "31 Christopher Court, Cherry Lane, Beverley, HU17 9TB"),
+    suggestion("101", "31 Christie Avenue, Beverley, HU17 9TB"),
+    suggestion("102", "112 Green Lane, York, YO42 2RW"),
+];
+const COMPLETE_SET = {
+    suggestions: FIXTURE_ROWS,
+    searchId: "set-1",
+    setComplete: true,
+    billing: null,
+};
+const TIERED_RESULT = {
+    suggestions: [suggestion("900", "Beverley, East Riding of Yorkshire")],
+    searchId: null,
+    setComplete: false,
+    billing: null,
+};
+function createSuggestMock(handler) {
+    const calls = [];
+    const transport = async (request) => {
+        calls.push(request);
+        return handler(request);
+    };
+    return { calls, transport };
+}
+function createRetrieveMock(handler) {
+    const calls = [];
+    return {
+        calls,
+        transport: async (request) => {
+            calls.push(request);
+            return handler(request);
+        },
+    };
+}
+function setup(suggestHandler, overrides = {}) {
+    const harness = createTimerHarness();
+    const suggest = createSuggestMock(suggestHandler);
+    const retrieve = createRetrieveMock(({ suggestion: picked }) => ({
+        record: { uprn: picked.uprn ?? "" },
+    }));
+    const controller = createAddressSearch({
+        suggest: suggest.transport,
+        retrieve: retrieve.transport,
+        timers: harness.timers,
+        ...overrides,
+    });
+    return { controller, suggestCalls: suggest.calls, retrieveCalls: retrieve.calls, advance: harness.advance };
+}
+describe("debounce and minimum length", () => {
+    it("coalesces a fast typing burst into one fetch for the final query", async () => {
+        const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
+        for (const text of ["31 c", "31 ch", "31 chr", "31 chri"]) {
+            controller.input(text);
+            advance(100); // faster than the 250ms debounce
+        }
+        advance(250);
+        await flush();
+        expect(suggestCalls).toHaveLength(1);
+        expect(suggestCalls[0]?.query).toBe("31 chri");
+        expect(controller.getState().status).toBe("ready");
+    });
+    it("never fetches below three characters and clears suggestions", async () => {
+        const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
+        controller.input("31 chri");
+        advance(300);
+        await flush();
+        expect(controller.getState().suggestions.length).toBeGreaterThan(0);
+        controller.input("31");
+        advance(1000);
+        await flush();
+        expect(suggestCalls).toHaveLength(1); // no second fetch
+        expect(controller.getState().status).toBe("idle");
+        expect(controller.getState().suggestions).toEqual([]);
+    });
+});
+describe("candidate-set protocol", () => {
+    it("holds a complete set and narrows extending keystrokes locally — zero further fetches", async () => {
+        const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
+        controller.input("31 chri");
+        advance(300);
+        await flush();
+        expect(suggestCalls).toHaveLength(1);
+        controller.input("31 chris");
+        expect(controller.getState().status).toBe("ready");
+        expect(controller.getState().suggestions.map((s) => s.uprn)).toEqual(["100", "101"]);
+        controller.input("31 christo");
+        expect(controller.getState().suggestions.map((s) => s.uprn)).toEqual(["100"]);
+        expect(controller.getState().searchId).toBe("set-1");
+        expect(controller.getState().setComplete).toBe(true);
+        advance(1000);
+        await flush();
+        expect(suggestCalls).toHaveLength(1); // both narrows were local
+    });
+    it("re-queries WITHOUT a search_id when the local narrow empties (set exhaustion)", async () => {
+        const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
+        controller.input("31 chri");
+        advance(300);
+        await flush();
+        controller.input("31 christopher zzz"); // extends the trigger but matches nothing held
+        expect(controller.getState().status).toBe("debouncing");
+        advance(250);
+        await flush();
+        expect(suggestCalls).toHaveLength(2);
+        expect(suggestCalls[1]?.query).toBe("31 christopher zzz");
+        expect(suggestCalls[1]?.searchId).toBeNull();
+    });
+    it("re-queries when the input no longer extends the trigger prefix (backspace past it)", async () => {
+        const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
+        controller.input("31 chri");
+        advance(300);
+        await flush();
+        controller.input("31 ch"); // backspace past the trigger
+        advance(250);
+        await flush();
+        expect(suggestCalls).toHaveLength(2);
+        expect(suggestCalls[1]?.query).toBe("31 ch");
+        expect(suggestCalls[1]?.searchId).toBeNull();
+    });
+    it("issues at most 2 data fetches across a 10-keystroke chain", async () => {
+        const { controller, suggestCalls, advance } = setup(({ query }) => query.startsWith("31 chri") ? COMPLETE_SET : TIERED_RESULT);
+        const chain = [
+            "31 c",
+            "31 ch",
+            "31 chr",
+            "31 chri", // pause here → fetch 1 returns the complete set
+            "31 chris",
+            "31 christ",
+            "31 christo",
+            "31 christop",
+            "31 christoph",
+            "31 christophz", // typo exhausts the set → fetch 2
+        ];
+        for (const text of chain) {
+            controller.input(text);
+            advance(text === "31 chri" || text === "31 christophz" ? 300 : 100);
+            await flush();
+        }
+        expect(suggestCalls.length).toBeLessThanOrEqual(2);
+        expect(suggestCalls.map((c) => c.query)).toEqual(["31 chri", "31 christophz"]);
+    });
+    it("serves a repeated query from the cache without a fetch and re-adopts its set", async () => {
+        const { controller, suggestCalls, advance } = setup(({ query }) => query.startsWith("31 chri") ? COMPLETE_SET : TIERED_RESULT);
+        controller.input("31 chri");
+        advance(300);
+        await flush();
+        controller.input("beverley town"); // unrelated query displaces the held set context
+        advance(300);
+        await flush();
+        expect(suggestCalls).toHaveLength(2);
+        controller.input("31 chri"); // cache hit — instant, no fetch
+        expect(controller.getState().status).toBe("ready");
+        expect(controller.getState().searchId).toBe("set-1");
+        controller.input("31 christo"); // and the re-adopted set narrows locally
+        expect(controller.getState().suggestions.map((s) => s.uprn)).toEqual(["100"]);
+        advance(1000);
+        await flush();
+        expect(suggestCalls).toHaveLength(2);
+    });
+});
+describe("cancellation and stale responses", () => {
+    it("aborts the in-flight request when a new fetch supersedes it", async () => {
+        let release;
+        const { controller, suggestCalls, advance } = setup(({ query }) => query === "31 chri"
+            ? new Promise((resolve) => {
+                release = resolve;
+            })
+            : TIERED_RESULT);
+        controller.input("31 chri");
+        advance(250); // fetch 1 in flight, unresolved
+        controller.input("112 green");
+        advance(250); // fetch 2 supersedes
+        await flush();
+        expect(suggestCalls).toHaveLength(2);
+        expect(suggestCalls[0]?.signal.aborted).toBe(true);
+        expect(controller.getState().query).toBe("112 green");
+        expect(controller.getState().status).toBe("ready");
+        release?.(COMPLETE_SET); // the stale response finally lands…
+        await flush();
+        expect(controller.getState().suggestions).toEqual(TIERED_RESULT.suggestions); // …and is ignored
+    });
+});
+describe("select", () => {
+    it("fires the retrieve exactly once per selection, with the session id attached", async () => {
+        const { controller, retrieveCalls, advance } = setup(() => COMPLETE_SET);
+        controller.input("31 chri");
+        advance(300);
+        await flush();
+        const picked = controller.getState().suggestions[0];
+        expect(picked).toBeDefined();
+        if (picked === undefined)
+            return;
+        const [first, second] = await Promise.all([controller.select(picked), controller.select(picked)]);
+        expect(retrieveCalls).toHaveLength(1);
+        expect(retrieveCalls[0]?.searchId).toBe("set-1");
+        expect(retrieveCalls[0]?.suggestion.uprn).toBe("100");
+        expect(first).toEqual(second);
+        await controller.select(picked); // later re-selects also reuse the settled retrieve
+        expect(retrieveCalls).toHaveLength(1);
+    });
+    it("clears the idempotency guard when a retrieve fails, so it can be retried", async () => {
+        const harness = createTimerHarness();
+        const suggest = createSuggestMock(() => COMPLETE_SET);
+        let attempts = 0;
+        const controller = createAddressSearch({
+            suggest: suggest.transport,
+            retrieve: async ({ suggestion: picked }) => {
+                attempts += 1;
+                if (attempts === 1)
+                    throw new Error("transient");
+                return { record: { uprn: picked.uprn ?? "" } };
+            },
+            timers: harness.timers,
+        });
+        controller.input("31 chri");
+        harness.advance(300);
+        await flush();
+        const picked = controller.getState().suggestions[0];
+        expect(picked).toBeDefined();
+        if (picked === undefined)
+            return;
+        await expect(controller.select(picked)).rejects.toThrow("transient");
+        await expect(controller.select(picked)).resolves.toEqual({ record: { uprn: "100" } }.record);
+        expect(attempts).toBe(2);
+    });
+});
+describe("billing metadata", () => {
+    it("surfaces suggest billing headers on the state and the billing property", async () => {
+        const billing = { creditsCharged: 0, creditsBalance: 4200, alreadyCharged: false };
+        const { controller, advance } = setup(() => ({ ...COMPLETE_SET, billing }));
+        controller.input("31 chri");
+        advance(300);
+        await flush();
+        expect(controller.getState().billing).toEqual({ ...billing, receivedAt: 300 });
+        expect(controller.billing).toEqual({ ...billing, receivedAt: 300 });
+    });
+    it("updates billing from the retrieve response after a selection", async () => {
+        const harness = createTimerHarness();
+        const suggest = createSuggestMock(() => COMPLETE_SET);
+        const controller = createAddressSearch({
+            suggest: suggest.transport,
+            retrieve: async ({ suggestion: picked }) => ({
+                record: { uprn: picked.uprn ?? "" },
+                billing: { creditsCharged: 4, creditsBalance: 4196, alreadyCharged: false },
+            }),
+            timers: harness.timers,
+        });
+        controller.input("31 chri");
+        harness.advance(300);
+        await flush();
+        const picked = controller.getState().suggestions[0];
+        expect(picked).toBeDefined();
+        if (picked === undefined)
+            return;
+        await controller.select(picked);
+        expect(controller.billing).toEqual({
+            creditsCharged: 4,
+            creditsBalance: 4196,
+            alreadyCharged: false,
+            receivedAt: 300,
+        });
+    });
+});
+describe("subscription surface", () => {
+    it("notifies subscribers on every state change and stops after unsubscribe", async () => {
+        const { controller, advance } = setup(() => COMPLETE_SET);
+        const statuses = [];
+        const unsubscribe = controller.subscribe((state) => statuses.push(state.status));
+        controller.input("31 chri");
+        advance(300);
+        await flush();
+        expect(statuses).toEqual(["debouncing", "loading", "ready"]);
+        unsubscribe();
+        controller.input("31 christo");
+        expect(statuses).toHaveLength(3);
+    });
+    it("dispose cancels pending work and ignores further input", async () => {
+        const { controller, suggestCalls, advance } = setup(() => COMPLETE_SET);
+        controller.input("31 chri");
+        controller.dispose();
+        advance(1000);
+        await flush();
+        controller.input("31 christo");
+        advance(1000);
+        await flush();
+        expect(suggestCalls).toHaveLength(0);
+    });
+});
+//# sourceMappingURL=controller.test.js.map