@kravc/schema 2.7.6 → 2.8.0-alpha.1

package/dist/helpers/getReferenceIds.d.ts

@@ -0,0 +1,169 @@
+import Schema from '../Schema';
+/**
+ * Recursively extracts all referenced schema IDs from a schema structure.
+ *
+ * **Intent:** Traverse a schema's entire structure (including nested objects and arrays)
+ * to collect all schema IDs that are referenced via `$ref` properties. This enables
+ * dependency resolution, schema bundling, and validation of schema completeness.
+ *
+ * **Use Cases:**
+ * - **Dependency Resolution:** Identify all schemas that a given schema depends on,
+ *   ensuring they are loaded before validation
+ * - **Schema Bundling:** Collect all related schemas into a single bundle for
+ *   distribution or storage
+ * - **Validation Preparation:** Pre-load all referenced schemas to ensure complete
+ *   validation context
+ * - **Dependency Graph Building:** Understand the relationships and dependencies
+ *   between schemas in a schema registry
+ * - **Schema Analysis:** Analyze schema complexity by identifying all dependencies
+ * - **Circular Reference Detection:** (Note: current implementation does not handle
+ *   circular references and will recurse infinitely)
+ *
+ * **Behavior:**
+ * - Returns an empty array for enum schemas (they don't reference other schemas)
+ * - Recursively traverses nested object properties
+ * - Handles array items that reference schemas or contain object properties
+ * - Follows nested references to collect transitive dependencies
+ * - Returns unique schema IDs (deduplicates if same schema is referenced multiple times)
+ * - Throws an error if a referenced schema is not found in the schemasMap
+ *
+ * **Example - Simple Reference:**
+ * ```typescript
+ * const userSchema = new Schema({
+ *   profile: { $ref: 'Profile' }
+ * }, 'User');
+ *
+ * const profileSchema = new Schema({
+ *   name: { type: 'string' }
+ * }, 'Profile');
+ *
+ * const schemasMap = { 'Profile': profileSchema };
+ * const referenceIds = getReferenceIds(userSchema, schemasMap);
+ * // Returns: ['Profile']
+ * ```
+ *
+ * **Example - Multiple References:**
+ * ```typescript
+ * const orderSchema = new Schema({
+ *   customer: { $ref: 'Customer' },
+ *   product: { $ref: 'Product' },
+ *   shipping: { $ref: 'Address' }
+ * }, 'Order');
+ *
+ * const schemasMap = {
+ *   'Customer': customerSchema,
+ *   'Product': productSchema,
+ *   'Address': addressSchema
+ * };
+ * const referenceIds = getReferenceIds(orderSchema, schemasMap);
+ * // Returns: ['Customer', 'Product', 'Address']
+ * ```
+ *
+ * **Example - Nested References:**
+ * ```typescript
+ * const userSchema = new Schema({
+ *   profile: { $ref: 'Profile' }
+ * }, 'User');
+ *
+ * const profileSchema = new Schema({
+ *   address: { $ref: 'Address' }
+ * }, 'Profile');
+ *
+ * const addressSchema = new Schema({
+ *   street: { type: 'string' }
+ * }, 'Address');
+ *
+ * const schemasMap = {
+ *   'Profile': profileSchema,
+ *   'Address': addressSchema
+ * };
+ * const referenceIds = getReferenceIds(userSchema, schemasMap);
+ * // Returns: ['Profile', 'Address'] (includes transitive dependencies)
+ * ```
+ *
+ * **Example - Array with Reference Items:**
+ * ```typescript
+ * const orderSchema = new Schema({
+ *   items: {
+ *     type: 'array',
+ *     items: { $ref: 'OrderItem' }
+ *   }
+ * }, 'Order');
+ *
+ * const schemasMap = { 'OrderItem': orderItemSchema };
+ * const referenceIds = getReferenceIds(orderSchema, schemasMap);
+ * // Returns: ['OrderItem']
+ * ```
+ *
+ * **Example - Nested Object Properties:**
+ * ```typescript
+ * const userSchema = new Schema({
+ *   contact: {
+ *     type: 'object',
+ *     properties: {
+ *       address: { $ref: 'Address' }
+ *     }
+ *   }
+ * }, 'User');
+ *
+ * const schemasMap = { 'Address': addressSchema };
+ * const referenceIds = getReferenceIds(userSchema, schemasMap);
+ * // Returns: ['Address']
+ * ```
+ *
+ * **Example - Complex Mixed Structure:**
+ * ```typescript
+ * const orderSchema = new Schema({
+ *   customer: { $ref: 'Customer' },
+ *   items: {
+ *     type: 'array',
+ *     items: {
+ *       type: 'object',
+ *       properties: {
+ *         product: { $ref: 'Product' }
+ *       }
+ *     }
+ *   },
+ *   shipping: {
+ *     type: 'object',
+ *     properties: {
+ *       address: { $ref: 'Address' }
+ *     }
+ *   }
+ * }, 'Order');
+ *
+ * const schemasMap = {
+ *   'Customer': customerSchema,
+ *   'Product': productSchema,
+ *   'Address': addressSchema
+ * };
+ * const referenceIds = getReferenceIds(orderSchema, schemasMap);
+ * // Returns: ['Customer', 'Product', 'Address']
+ * ```
+ *
+ * **Example - Duplicate References:**
+ * ```typescript
+ * const schema = new Schema({
+ *   field1: { $ref: 'SharedSchema' },
+ *   field2: { $ref: 'SharedSchema' }
+ * }, 'Test');
+ *
+ * const schemasMap = { 'SharedSchema': sharedSchema };
+ * const referenceIds = getReferenceIds(schema, schemasMap);
+ * // Returns: ['SharedSchema'] (deduplicated)
+ * ```
+ *
+ * @param schema - The schema to extract references from
+ * @param schemasMap - A map of schema IDs to Schema instances, used to resolve
+ *   referenced schemas and traverse nested references
+ * @returns An array of unique schema IDs that are referenced (directly or indirectly)
+ *   by the given schema
+ * @throws Error if a referenced schema is not found in the schemasMap
+ *
+ * **Limitations:**
+ * - Does not handle circular references (will cause infinite recursion)
+ * - Requires all referenced schemas to be present in schemasMap
+ */
+declare const getReferenceIds: (schema: Schema, schemasMap: Record<string, Schema>) => string[];
+export default getReferenceIds;
+//# sourceMappingURL=getReferenceIds.d.ts.map

package/dist/helpers/getReferenceIds.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getReferenceIds.d.ts","sourceRoot":"","sources":["../../src/helpers/getReferenceIds.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,WAAW,CAAC;AAU/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoKG;AACH,QAAA,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,YAAY,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAAM,EA6FnF,CAAC;AAEF,eAAe,eAAe,CAAC"}

package/dist/helpers/getReferenceIds.js

@@ -0,0 +1,241 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const Schema_1 = __importDefault(require("../Schema"));
+const got_1 = __importDefault(require("./got"));
+/**
+ * Recursively extracts all referenced schema IDs from a schema structure.
+ *
+ * **Intent:** Traverse a schema's entire structure (including nested objects and arrays)
+ * to collect all schema IDs that are referenced via `$ref` properties. This enables
+ * dependency resolution, schema bundling, and validation of schema completeness.
+ *
+ * **Use Cases:**
+ * - **Dependency Resolution:** Identify all schemas that a given schema depends on,
+ *   ensuring they are loaded before validation
+ * - **Schema Bundling:** Collect all related schemas into a single bundle for
+ *   distribution or storage
+ * - **Validation Preparation:** Pre-load all referenced schemas to ensure complete
+ *   validation context
+ * - **Dependency Graph Building:** Understand the relationships and dependencies
+ *   between schemas in a schema registry
+ * - **Schema Analysis:** Analyze schema complexity by identifying all dependencies
+ * - **Circular Reference Detection:** (Note: current implementation does not handle
+ *   circular references and will recurse infinitely)
+ *
+ * **Behavior:**
+ * - Returns an empty array for enum schemas (they don't reference other schemas)
+ * - Recursively traverses nested object properties
+ * - Handles array items that reference schemas or contain object properties
+ * - Follows nested references to collect transitive dependencies
+ * - Returns unique schema IDs (deduplicates if same schema is referenced multiple times)
+ * - Throws an error if a referenced schema is not found in the schemasMap
+ *
+ * **Example - Simple Reference:**
+ * ```typescript
+ * const userSchema = new Schema({
+ *   profile: { $ref: 'Profile' }
+ * }, 'User');
+ *
+ * const profileSchema = new Schema({
+ *   name: { type: 'string' }
+ * }, 'Profile');
+ *
+ * const schemasMap = { 'Profile': profileSchema };
+ * const referenceIds = getReferenceIds(userSchema, schemasMap);
+ * // Returns: ['Profile']
+ * ```
+ *
+ * **Example - Multiple References:**
+ * ```typescript
+ * const orderSchema = new Schema({
+ *   customer: { $ref: 'Customer' },
+ *   product: { $ref: 'Product' },
+ *   shipping: { $ref: 'Address' }
+ * }, 'Order');
+ *
+ * const schemasMap = {
+ *   'Customer': customerSchema,
+ *   'Product': productSchema,
+ *   'Address': addressSchema
+ * };
+ * const referenceIds = getReferenceIds(orderSchema, schemasMap);
+ * // Returns: ['Customer', 'Product', 'Address']
+ * ```
+ *
+ * **Example - Nested References:**
+ * ```typescript
+ * const userSchema = new Schema({
+ *   profile: { $ref: 'Profile' }
+ * }, 'User');
+ *
+ * const profileSchema = new Schema({
+ *   address: { $ref: 'Address' }
+ * }, 'Profile');
+ *
+ * const addressSchema = new Schema({
+ *   street: { type: 'string' }
+ * }, 'Address');
+ *
+ * const schemasMap = {
+ *   'Profile': profileSchema,
+ *   'Address': addressSchema
+ * };
+ * const referenceIds = getReferenceIds(userSchema, schemasMap);
+ * // Returns: ['Profile', 'Address'] (includes transitive dependencies)
+ * ```
+ *
+ * **Example - Array with Reference Items:**
+ * ```typescript
+ * const orderSchema = new Schema({
+ *   items: {
+ *     type: 'array',
+ *     items: { $ref: 'OrderItem' }
+ *   }
+ * }, 'Order');
+ *
+ * const schemasMap = { 'OrderItem': orderItemSchema };
+ * const referenceIds = getReferenceIds(orderSchema, schemasMap);
+ * // Returns: ['OrderItem']
+ * ```
+ *
+ * **Example - Nested Object Properties:**
+ * ```typescript
+ * const userSchema = new Schema({
+ *   contact: {
+ *     type: 'object',
+ *     properties: {
+ *       address: { $ref: 'Address' }
+ *     }
+ *   }
+ * }, 'User');
+ *
+ * const schemasMap = { 'Address': addressSchema };
+ * const referenceIds = getReferenceIds(userSchema, schemasMap);
+ * // Returns: ['Address']
+ * ```
+ *
+ * **Example - Complex Mixed Structure:**
+ * ```typescript
+ * const orderSchema = new Schema({
+ *   customer: { $ref: 'Customer' },
+ *   items: {
+ *     type: 'array',
+ *     items: {
+ *       type: 'object',
+ *       properties: {
+ *         product: { $ref: 'Product' }
+ *       }
+ *     }
+ *   },
+ *   shipping: {
+ *     type: 'object',
+ *     properties: {
+ *       address: { $ref: 'Address' }
+ *     }
+ *   }
+ * }, 'Order');
+ *
+ * const schemasMap = {
+ *   'Customer': customerSchema,
+ *   'Product': productSchema,
+ *   'Address': addressSchema
+ * };
+ * const referenceIds = getReferenceIds(orderSchema, schemasMap);
+ * // Returns: ['Customer', 'Product', 'Address']
+ * ```
+ *
+ * **Example - Duplicate References:**
+ * ```typescript
+ * const schema = new Schema({
+ *   field1: { $ref: 'SharedSchema' },
+ *   field2: { $ref: 'SharedSchema' }
+ * }, 'Test');
+ *
+ * const schemasMap = { 'SharedSchema': sharedSchema };
+ * const referenceIds = getReferenceIds(schema, schemasMap);
+ * // Returns: ['SharedSchema'] (deduplicated)
+ * ```
+ *
+ * @param schema - The schema to extract references from
+ * @param schemasMap - A map of schema IDs to Schema instances, used to resolve
+ *   referenced schemas and traverse nested references
+ * @returns An array of unique schema IDs that are referenced (directly or indirectly)
+ *   by the given schema
+ * @throws Error if a referenced schema is not found in the schemasMap
+ *
+ * **Limitations:**
+ * - Does not handle circular references (will cause infinite recursion)
+ * - Requires all referenced schemas to be present in schemasMap
+ */
+const getReferenceIds = (schema, schemasMap) => {
+    /** Returns schema from the map by ID */
+    const getSchema = (id) => (0, got_1.default)(schemasMap, id, 'Schema "$PATH" not found');
+    let referenceIds = [];
+    const { jsonSchema } = schema;
+    const { enum: isEnum } = jsonSchema;
+    if (isEnum) {
+        return [];
+    }
+    const objectSchema = jsonSchema;
+    for (const propertyName in objectSchema.properties) {
+        const property = objectSchema.properties[propertyName];
+        const { $ref: refSchemaId } = property;
+        const isReference = !(0, lodash_1.isUndefined)(refSchemaId);
+        if (isReference) {
+            const refJsonSchema = getSchema(refSchemaId);
+            const nestedReferenceIds = getReferenceIds(refJsonSchema, schemasMap);
+            referenceIds = [
+                refSchemaId,
+                ...referenceIds,
+                ...nestedReferenceIds
+            ];
+            continue;
+        }
+        const { type } = property;
+        const isObject = type === 'object';
+        if (isObject) {
+            // istanbul ignore next - unreachable defensive code: properties is always set by normalizeProperties in Schema constructor
+            const { properties = {} } = property;
+            const nestedSchema = new Schema_1.default(properties, `${objectSchema.id}.${propertyName}.properties`);
+            const nestedReferenceIds = getReferenceIds(nestedSchema, schemasMap);
+            referenceIds = [
+                ...referenceIds,
+                ...nestedReferenceIds
+            ];
+            continue;
+        }
+        const isArray = type === 'array';
+        if (!isArray) {
+            continue;
+        }
+        const { items } = property;
+        const itemRefSchemaId = items.$ref;
+        if (itemRefSchemaId) {
+            const itemJsonSchema = getSchema(itemRefSchemaId);
+            const nestedReferenceIds = getReferenceIds(itemJsonSchema, schemasMap);
+            referenceIds = [
+                itemRefSchemaId,
+                ...referenceIds,
+                ...nestedReferenceIds
+            ];
+            continue;
+        }
+        const itemProperties = items.properties;
+        if (itemProperties) {
+            const itemSchema = new Schema_1.default(itemProperties, `${objectSchema.id}.${propertyName}.items.properties`);
+            const itemReferenceIds = getReferenceIds(itemSchema, schemasMap);
+            referenceIds = [
+                ...referenceIds,
+                ...itemReferenceIds
+            ];
+            continue;
+        }
+    }
+    return (0, lodash_1.uniq)(referenceIds);
+};
+exports.default = getReferenceIds;
+//# sourceMappingURL=getReferenceIds.js.map

package/dist/helpers/getReferenceIds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getReferenceIds.js","sourceRoot":"","sources":["../../src/helpers/getReferenceIds.ts"],"names":[],"mappings":";;;;;AAAA,mCAA2C;AAE3C,uDAA+B;AAC/B,gDAAwB;AASxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoKG;AACH,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,UAAkC,EAAY,EAAE;IACvF,wCAAwC;IACxC,MAAM,SAAS,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAA,aAAG,EAAC,UAAU,EAAE,EAAE,EAAE,0BAA0B,CAAC,CAAC;IAElF,IAAI,YAAY,GAAa,EAAE,CAAC;IAEhC,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IAC9B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAI,UAAyB,CAAC;IAEpD,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,YAAY,GAAI,UAA2B,CAAC;IAElD,KAAK,MAAM,YAAY,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;QACnD,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;QAEvD,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAI,QAAoC,CAAC;QAEpE,MAAM,WAAW,GAAG,CAAC,IAAA,oBAAW,EAAC,WAAW,CAAC,CAAC;QAE9C,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,aAAa,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;YAC7C,MAAM,kBAAkB,GAAG,eAAe,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;YAEtE,YAAY,GAAG;gBACb,WAAW;gBACX,GAAG,YAAY;gBACf,GAAG,kBAAkB;aACtB,CAAC;YAEF,SAAS;QACX,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,GAAI,QAAuD,CAAC;QAE1E,MAAM,QAAQ,GAAG,IAAI,KAAK,QAAQ,CAAC;QAEnC,IAAI,QAAQ,EAAE,CAAC;YACb,2HAA2H;YAC3H,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAI,QAAiC,CAAC;YAE/D,MAAM,YAAY,GAAG,IAAI,gBAAM,CAAC,UAAU,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,YAAY,aAAa,CAAC,CAAC;YAC7F,MAAM,kBAAkB,GAAG,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YAErE,YAAY,GAAG;gBACb,GAAG,YAAY;gBACf,GAAG,kBAAkB;aACtB,CAAC;YAEF,SAAS;QACX,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,KAAK,OAAO,CAAC;QAEjC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,SAAS;QACX,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAI,QAAgC,CAAC;QAEpD,MAAM,eAAe,GAAI,KAAiC,CAAC,IAAI,CAAC;QAEhE,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,cAAc,GAAG,SAAS,CAAC,eAAe,CAAC,CAAC;YAClD,MAAM,kBAAkB,GAAG,eAAe,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;YAEvE,YAAY,GAAG;gBACb,eAAe;gBACf,GAAG,YAAY;gBACf,GAAG,kBAAkB;aACtB,CAAC;YAEF,SAAS;QACX,CAAC;QAED,MAAM,cAAc,GAAI,KAA8B,CAAC,UAAU,CAAC;QAElE,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,UAAU,GAAG,IAAI,gBAAM,CAAC,cAAc,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,YAAY,mBAAmB,CAAC,CAAC;YACrG,MAAM,gBAAgB,GAAG,eAAe,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAEjE,YAAY,GAAG;gBACb,GAAG,YAAY;gBACf,GAAG,gBAAgB;aACpB,CAAC;YAEF,SAAS;QACX,CAAC;IACH,CAAC;IAED,OAAO,IAAA,aAAI,EAAC,YAAY,CAAC,CAAC;AAC5B,CAAC,CAAC;AAEF,kBAAe,eAAe,CAAC"}

package/dist/helpers/got.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Safe required property access: returns a value at `path` or throws if it is `undefined`.
+ *
+ * **Intent:** Provide strict, fail-fast access to nested object properties. Unlike `lodash/get`,
+ * which returns `undefined` for missing keys, `got` treats missing data as an error and throws
+ * with a clear message including the path. Use it when the property is required and absence
+ * indicates a bug or invalid input.
+ *
+ * **Use cases:**
+ * - **Schema / config lookups:** Fetching a schema or config by ID from a map where absence
+ *   means invalid reference (e.g. `got(schemasMap, schemaId, 'Schema "$PATH" not found')`).
+ * - **Validated config access:** Reading required config or options after validation, when
+ *   you want to avoid `undefined` checks downstream.
+ * - **Strict data traversal:** Walking nested structures (APIs, parsed JSON) where missing
+ *   keys should fail immediately with a descriptive error instead of propagating `undefined`.
+ *
+ * **Behavior:** Only `undefined` triggers an error. Falsy but defined values (`null`, `0`,
+ * `false`, `''`, `[]`, `{}`) are returned as-is. Uses lodash `get` path syntax: dot notation
+ * (`a.b.c`), bracket notation (`items[0]`), or mixed (`data.items[0].id`).
+ *
+ * @param object - Root object to read from.
+ * @param path - Lodash-style path (e.g. `'user.profile.name'`, `'items[0].id'`).
+ * @param errorTemplate - Error message template; `$PATH` is replaced with `path`. Default:
+ *   `'Value is undefined for "$PATH"'`.
+ * @returns The value at `path`.
+ * @throws {Error} When the value at `path` is `undefined`.
+ *
+ * @example
+ * // Simple property
+ * got({ name: 'Jane' }, 'name');
+ * // => 'Jane'
+ *
+ * @example
+ * // Nested path
+ * got({ user: { profile: { role: 'admin' } } }, 'user.profile.role');
+ * // => 'admin'
+ *
+ * @example
+ * // Array index
+ * got({ items: ['a', 'b'] }, 'items[0]');
+ * // => 'a'
+ *
+ * @example
+ * // Falsy but defined values are returned
+ * got({ count: 0, enabled: false }, 'count');
+ * // => 0
+ *
+ * @example
+ * // Custom error for schema lookups
+ * got(schemasMap, schemaId, 'Schema "$PATH" not found');
+ * // => schema for schemaId, or throws with that message
+ *
+ * @example
+ * // Missing property throws
+ * got({ name: 'Jane' }, 'age');
+ * // throws Error('Value is undefined for "age"')
+ */
+declare function got<T>(object: Record<string, T>, path: string, errorTemplate?: string): T;
+export default got;
+//# sourceMappingURL=got.d.ts.map

package/dist/helpers/got.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"got.d.ts","sourceRoot":"","sources":["../../src/helpers/got.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,iBAAS,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,GAAE,MAA+B,GAAG,CAAC,CAS1G;AAED,eAAe,GAAG,CAAC"}

package/dist/helpers/got.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const DEFAULT_ERROR_TEMPLATE = 'Value is undefined for "$PATH"';
+/**
+ * Safe required property access: returns a value at `path` or throws if it is `undefined`.
+ *
+ * **Intent:** Provide strict, fail-fast access to nested object properties. Unlike `lodash/get`,
+ * which returns `undefined` for missing keys, `got` treats missing data as an error and throws
+ * with a clear message including the path. Use it when the property is required and absence
+ * indicates a bug or invalid input.
+ *
+ * **Use cases:**
+ * - **Schema / config lookups:** Fetching a schema or config by ID from a map where absence
+ *   means invalid reference (e.g. `got(schemasMap, schemaId, 'Schema "$PATH" not found')`).
+ * - **Validated config access:** Reading required config or options after validation, when
+ *   you want to avoid `undefined` checks downstream.
+ * - **Strict data traversal:** Walking nested structures (APIs, parsed JSON) where missing
+ *   keys should fail immediately with a descriptive error instead of propagating `undefined`.
+ *
+ * **Behavior:** Only `undefined` triggers an error. Falsy but defined values (`null`, `0`,
+ * `false`, `''`, `[]`, `{}`) are returned as-is. Uses lodash `get` path syntax: dot notation
+ * (`a.b.c`), bracket notation (`items[0]`), or mixed (`data.items[0].id`).
+ *
+ * @param object - Root object to read from.
+ * @param path - Lodash-style path (e.g. `'user.profile.name'`, `'items[0].id'`).
+ * @param errorTemplate - Error message template; `$PATH` is replaced with `path`. Default:
+ *   `'Value is undefined for "$PATH"'`.
+ * @returns The value at `path`.
+ * @throws {Error} When the value at `path` is `undefined`.
+ *
+ * @example
+ * // Simple property
+ * got({ name: 'Jane' }, 'name');
+ * // => 'Jane'
+ *
+ * @example
+ * // Nested path
+ * got({ user: { profile: { role: 'admin' } } }, 'user.profile.role');
+ * // => 'admin'
+ *
+ * @example
+ * // Array index
+ * got({ items: ['a', 'b'] }, 'items[0]');
+ * // => 'a'
+ *
+ * @example
+ * // Falsy but defined values are returned
+ * got({ count: 0, enabled: false }, 'count');
+ * // => 0
+ *
+ * @example
+ * // Custom error for schema lookups
+ * got(schemasMap, schemaId, 'Schema "$PATH" not found');
+ * // => schema for schemaId, or throws with that message
+ *
+ * @example
+ * // Missing property throws
+ * got({ name: 'Jane' }, 'age');
+ * // throws Error('Value is undefined for "age"')
+ */
+function got(object, path, errorTemplate = DEFAULT_ERROR_TEMPLATE) {
+    const value = (0, lodash_1.get)(object, path);
+    const shouldThrow = (0, lodash_1.isUndefined)(value);
+    if (!shouldThrow) {
+        return value;
+    }
+    throw Error(errorTemplate.replace('$PATH', path));
+}
+;
+exports.default = got;
+//# sourceMappingURL=got.js.map

package/dist/helpers/got.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"got.js","sourceRoot":"","sources":["../../src/helpers/got.ts"],"names":[],"mappings":";;AAAA,mCAA0C;AAE1C,MAAM,sBAAsB,GAAG,gCAAgC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,SAAS,GAAG,CAAI,MAAyB,EAAE,IAAY,EAAE,gBAAwB,sBAAsB;IACrG,MAAM,KAAK,GAAG,IAAA,YAAG,EAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,MAAM,WAAW,GAAG,IAAA,oBAAW,EAAC,KAAK,CAAC,CAAC;IAEvC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;AACpD,CAAC;AAAA,CAAC;AAEF,kBAAe,GAAG,CAAC"}