@finsys/core 4.5.0 → 4.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1097,8 +1097,8 @@ type CanonicalFieldValue = number | string | boolean | null;
1097
1097
  * stay assignment-compatible. A telco adapter that needs an MSISDN
1098
1098
  * declares it once at the interface level:
1099
1099
  *
1100
- * interface CelcomExt { msisdn: string }
1101
- * const celcomTelco: SourceAdapter<CelcomExt> = {
1100
+ * interface TelcoPartnerExt { msisdn: string }
1101
+ * const telcoAdapter: SourceAdapter<TelcoPartnerExt> = {
1102
1102
  * async fetch(identity) {
1103
1103
  * identity.msisdn // string (typed via E)
1104
1104
  * identity.ic // string (core)
@@ -1112,7 +1112,7 @@ type CanonicalFieldValue = number | string | boolean | null;
1112
1112
  interface SourceAdapter<E extends Record<string, unknown> = {}> {
1113
1113
  /**
1114
1114
  * Globally unique id for this adapter instance. By convention:
1115
- * `<vendor>-<category-short>-v<n>` — e.g. `celcom-telco-v1`. Vendor
1115
+ * `<vendor>-<category-short>-v<n>` — e.g. `example-telco-v1`. Vendor
1116
1116
  * names appear here in deployment-specific code, NEVER in
1117
1117
  * finsys-core. The id is what the registry uses to dedupe + what
1118
1118
  * provenance records pin to.
@@ -1249,10 +1249,10 @@ interface SourceAdapter<E extends Record<string, unknown> = {}> {
1249
1249
  *
1250
1250
  * Narrowing example (the ergonomics win this type is designed to deliver):
1251
1251
  *
1252
- * interface CelcomExt { msisdn: string; accountRef: string }
1252
+ * interface TelcoPartnerExt { msisdn: string; accountRef: string }
1253
1253
  *
1254
1254
  * // declare adapter with the extension shape baked in:
1255
- * const celcom: SourceAdapter<CelcomExt> = {
1255
+ * const telcoAdapter: SourceAdapter<TelcoPartnerExt> = {
1256
1256
  * async fetch(identity) {
1257
1257
  * identity.ic // string
1258
1258
  * identity.msisdn // string (NOT unknown — narrowed by E)
@@ -1434,7 +1434,7 @@ interface AdapterManifest {
1434
1434
  readonly manifestVersion: 1;
1435
1435
  /**
1436
1436
  * Globally unique adapter id. Conventional pattern:
1437
- * `<vendor>-<category-short>-v<n>` (e.g. `celcom-telco-v1`). The id is
1437
+ * `<vendor>-<category-short>-v<n>` (e.g. `example-telco-v1`). The id is
1438
1438
  * what `SourceAdapter#id` returns + what provenance records pin to.
1439
1439
  */
1440
1440
  readonly id: string;
package/dist/index.d.ts CHANGED
@@ -1097,8 +1097,8 @@ type CanonicalFieldValue = number | string | boolean | null;
1097
1097
  * stay assignment-compatible. A telco adapter that needs an MSISDN
1098
1098
  * declares it once at the interface level:
1099
1099
  *
1100
- * interface CelcomExt { msisdn: string }
1101
- * const celcomTelco: SourceAdapter<CelcomExt> = {
1100
+ * interface TelcoPartnerExt { msisdn: string }
1101
+ * const telcoAdapter: SourceAdapter<TelcoPartnerExt> = {
1102
1102
  * async fetch(identity) {
1103
1103
  * identity.msisdn // string (typed via E)
1104
1104
  * identity.ic // string (core)
@@ -1112,7 +1112,7 @@ type CanonicalFieldValue = number | string | boolean | null;
1112
1112
  interface SourceAdapter<E extends Record<string, unknown> = {}> {
1113
1113
  /**
1114
1114
  * Globally unique id for this adapter instance. By convention:
1115
- * `<vendor>-<category-short>-v<n>` — e.g. `celcom-telco-v1`. Vendor
1115
+ * `<vendor>-<category-short>-v<n>` — e.g. `example-telco-v1`. Vendor
1116
1116
  * names appear here in deployment-specific code, NEVER in
1117
1117
  * finsys-core. The id is what the registry uses to dedupe + what
1118
1118
  * provenance records pin to.
@@ -1249,10 +1249,10 @@ interface SourceAdapter<E extends Record<string, unknown> = {}> {
1249
1249
  *
1250
1250
  * Narrowing example (the ergonomics win this type is designed to deliver):
1251
1251
  *
1252
- * interface CelcomExt { msisdn: string; accountRef: string }
1252
+ * interface TelcoPartnerExt { msisdn: string; accountRef: string }
1253
1253
  *
1254
1254
  * // declare adapter with the extension shape baked in:
1255
- * const celcom: SourceAdapter<CelcomExt> = {
1255
+ * const telcoAdapter: SourceAdapter<TelcoPartnerExt> = {
1256
1256
  * async fetch(identity) {
1257
1257
  * identity.ic // string
1258
1258
  * identity.msisdn // string (NOT unknown — narrowed by E)
@@ -1434,7 +1434,7 @@ interface AdapterManifest {
1434
1434
  readonly manifestVersion: 1;
1435
1435
  /**
1436
1436
  * Globally unique adapter id. Conventional pattern:
1437
- * `<vendor>-<category-short>-v<n>` (e.g. `celcom-telco-v1`). The id is
1437
+ * `<vendor>-<category-short>-v<n>` (e.g. `example-telco-v1`). The id is
1438
1438
  * what `SourceAdapter#id` returns + what provenance records pin to.
1439
1439
  */
1440
1440
  readonly id: string;