@skmtc/core 0.0.368 → 0.0.369

package/esm/oas/integer/Integer.d.ts

@@ -7,15 +7,36 @@ export type IntegerFields = {
     enums?: number[];
 };
 export declare class OasInteger {
-    #private;
-    oasType: 'schema';
-    type: 'integer';
+    /**
+     * Object is part the 'schema' set which is used
+     * to define data types in an OpenAPI document.
+     */
+    oasType: "schema";
+    /**
+     * Constant value 'integer' useful for type narrowing and tagged unions.
+     */
+    type: "integer";
+    /**
+     * A short summary of the integer.
+     */
+    title: string | undefined;
+    /**
+     * A description of the integer.
+     */
+    description: string | undefined;
+    /**
+     * Indicates whether value can be null.
+     */
+    nullable: boolean | undefined;
+    /**
+     * The format of the integer.
+     */
+    format: 'int32' | 'int64' | undefined;
+    /**
+     * An array of allowed values for the integer.
+     */
+    enums: number[] | undefined;
     constructor(fields: IntegerFields);
-    get title(): string | undefined;
-    get description(): string | undefined;
-    get nullable(): boolean | undefined;
-    get format(): 'int32' | 'int64' | undefined;
-    get enums(): number[] | undefined;
     isRef(): this is OasRef<'schema'>;
     resolve(): OasInteger;
     resolveOnce(): OasInteger;

package/esm/oas/integer/Integer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Integer.d.ts","sourceRoot":"","sources":["../../../src/oas/integer/Integer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,qBAAa,UAAU;;IACrB,OAAO,EAAE,QAAQ,CAAW;IAC5B,IAAI,EAAE,SAAS,CAAY;gBAGf,MAAM,EAAE,aAAa;IAIjC,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,QAAQ,IAAI,OAAO,GAAG,SAAS,CAElC;IAED,IAAI,MAAM,IAAI,OAAO,GAAG,OAAO,GAAG,SAAS,CAE1C;IAED,IAAI,KAAK,IAAI,MAAM,EAAE,GAAG,SAAS,CAEhC;IAED,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,UAAU;IAIrB,WAAW,IAAI,UAAU;CAG1B"}
+{"version":3,"file":"Integer.d.ts","sourceRoot":"","sources":["../../../src/oas/integer/Integer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,qBAAa,UAAU;IACrB;;;OAGG;IACH,OAAO,WAAoB;IAC3B;;OAEG;IACH,IAAI,YAAqB;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;gBAEf,MAAM,EAAE,aAAa;IAQjC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,UAAU;IAIrB,WAAW,IAAI,UAAU;CAG1B"}

package/esm/oas/integer/Integer.js

@@ -1,46 +1,74 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _OasInteger_fields;
 export class OasInteger {
     constructor(fields) {
+        /**
+         * Object is part the 'schema' set which is used
+         * to define data types in an OpenAPI document.
+         */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'schema'
         });
+        /**
+         * Constant value 'integer' useful for type narrowing and tagged unions.
+         */
         Object.defineProperty(this, "type", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'integer'
         });
-        _OasInteger_fields.set(this, void 0);
-        __classPrivateFieldSet(this, _OasInteger_fields, fields, "f");
-    }
-    get title() {
-        return __classPrivateFieldGet(this, _OasInteger_fields, "f").title;
-    }
-    get description() {
-        return __classPrivateFieldGet(this, _OasInteger_fields, "f").description;
-    }
-    get nullable() {
-        return __classPrivateFieldGet(this, _OasInteger_fields, "f").nullable;
-    }
-    get format() {
-        return __classPrivateFieldGet(this, _OasInteger_fields, "f").format;
-    }
-    get enums() {
-        return __classPrivateFieldGet(this, _OasInteger_fields, "f").enums;
+        /**
+         * A short summary of the integer.
+         */
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * A description of the integer.
+         */
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Indicates whether value can be null.
+         */
+        Object.defineProperty(this, "nullable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The format of the integer.
+         */
+        Object.defineProperty(this, "format", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * An array of allowed values for the integer.
+         */
+        Object.defineProperty(this, "enums", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.title = fields.title;
+        this.description = fields.description;
+        this.nullable = fields.nullable;
+        this.format = fields.format;
+        this.enums = fields.enums;
     }
     isRef() {
         return false;
@@ -52,4 +80,3 @@ export class OasInteger {
         return this;
     }
 }
-_OasInteger_fields = new WeakMap();

package/esm/oas/number/Number.d.ts

@@ -4,14 +4,32 @@ export type NumberFields = {
     description?: string;
     nullable?: boolean;
 };
+/**
+ * Object representing a number in the OpenAPI Specification.
+ */
 export declare class OasNumber {
-    #private;
-    oasType: 'schema';
-    type: 'number';
+    /**
+     * Object is part the 'schema' set which is used
+     * to define data types in an OpenAPI document.
+     */
+    oasType: "schema";
+    /**
+     * Constant value 'number' useful for type narrowing and tagged unions.
+     */
+    type: "number";
+    /**
+     * A short summary of the number.
+     */
+    title: string | undefined;
+    /**
+     * A description of the number.
+     */
+    description: string | undefined;
+    /**
+     * Indicates whether value can be null.
+     */
+    nullable: boolean | undefined;
     constructor(fields: NumberFields);
-    get title(): string | undefined;
-    get description(): string | undefined;
-    get nullable(): boolean | undefined;
     isRef(): this is OasRef<'schema'>;
     resolve(): OasNumber;
     resolveOnce(): OasNumber;

package/esm/oas/number/Number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Number.d.ts","sourceRoot":"","sources":["../../../src/oas/number/Number.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,qBAAa,SAAS;;IACpB,OAAO,EAAE,QAAQ,CAAW;IAC5B,IAAI,EAAE,QAAQ,CAAW;gBAGb,MAAM,EAAE,YAAY;IAIhC,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,QAAQ,IAAI,OAAO,GAAG,SAAS,CAElC;IAED,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;CAGzB"}
+{"version":3,"file":"Number.d.ts","sourceRoot":"","sources":["../../../src/oas/number/Number.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,OAAO,WAAoB;IAC3B;;OAEG;IACH,IAAI,WAAoB;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;gBAEjB,MAAM,EAAE,YAAY;IAMhC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;CAGzB"}

package/esm/oas/number/Number.js

@@ -1,40 +1,57 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _OasNumber_fields;
+/**
+ * Object representing a number in the OpenAPI Specification.
+ */
 export class OasNumber {
     constructor(fields) {
+        /**
+         * Object is part the 'schema' set which is used
+         * to define data types in an OpenAPI document.
+         */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'schema'
         });
+        /**
+         * Constant value 'number' useful for type narrowing and tagged unions.
+         */
         Object.defineProperty(this, "type", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'number'
         });
-        _OasNumber_fields.set(this, void 0);
-        __classPrivateFieldSet(this, _OasNumber_fields, fields, "f");
-    }
-    get title() {
-        return __classPrivateFieldGet(this, _OasNumber_fields, "f").title;
-    }
-    get description() {
-        return __classPrivateFieldGet(this, _OasNumber_fields, "f").description;
-    }
-    get nullable() {
-        return __classPrivateFieldGet(this, _OasNumber_fields, "f").nullable;
+        /**
+         * A short summary of the number.
+         */
+        Object.defineProperty(this, "title", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * A description of the number.
+         */
+        Object.defineProperty(this, "description", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Indicates whether value can be null.
+         */
+        Object.defineProperty(this, "nullable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.title = fields.title;
+        this.description = fields.description;
+        this.nullable = fields.nullable;
     }
     isRef() {
         return false;
@@ -46,4 +63,3 @@ export class OasNumber {
         return this;
     }
 }
-_OasNumber_fields = new WeakMap();

package/esm/oas/object/Object.d.ts

@@ -9,28 +9,72 @@ export type OasObjectFields = {
     additionalProperties?: boolean | OasSchema | OasRef<'schema'> | undefined;
     nullable?: boolean | undefined;
 };
-export type RemovePropertyArgs = {
-    name: string;
-};
 export type AddPropertyArgs = {
     name: string;
     schema: OasSchema | OasRef<'schema'> | CustomValue | undefined;
     required?: boolean;
 };
+/**
+ * Object representing an object and/or a record in the OpenAPI Specification.
+ *
+ * Objects have fixed, named fields. Records have any number of fields that do not have predefined names.
+ */
 export declare class OasObject {
-    oasType: 'schema';
-    type: 'object';
-    title?: string;
-    description?: string;
-    properties?: Record<string, OasSchema | OasRef<'schema'> | CustomValue> | undefined;
-    required?: string[] | undefined;
-    additionalProperties?: boolean | OasSchema | OasRef<'schema'> | undefined;
-    nullable?: boolean | undefined;
+    /**
+     * Object is part the 'schema' set which is used
+     * to define data types in an OpenAPI document.
+     */
+    oasType: "schema";
+    /**
+     * Constant value 'object' useful for type narrowing and tagged unions.
+     */
+    type: "object";
+    /**
+     * A short summary of the object.
+     */
+    title: string | undefined;
+    /**
+     * A description of the object.
+     */
+    description: string | undefined;
+    /**
+     * Indicates whether value can be null.
+     */
+    nullable: boolean | undefined;
+    /**
+     * A record which maps property names of the object to their schemas.
+     */
+    properties: Record<string, OasSchema | OasRef<'schema'> | CustomValue> | undefined;
+    /**
+     * An array of required property names.
+     */
+    required: string[] | undefined;
+    /**
+     * Indicates whether additional properties are allowed.
+     *
+     * This is equivalent to a Record type in TypeScript.
+     */
+    additionalProperties: boolean | OasSchema | OasRef<'schema'> | undefined;
     constructor(fields: OasObjectFields);
     /** Creates new empty OasObject */
     static empty(): OasObject;
+    /**
+     * Adds a new property to the object.
+     *
+     * @param {AddPropertyArgs} args - The arguments for adding a property.
+     * @param {string} args.name - The name of the property to add.
+     * @param {OasSchema | OasRef<'schema'> | CustomValue | undefined} args.schema - The schema of the property to add.
+     * @param {boolean} args.required - Whether the property is required.
+     * @returns {OasObject} A new OasObject with the added property.
+     */
     addProperty({ name, schema, required }: AddPropertyArgs): OasObject;
-    removeProperty({ name }: RemovePropertyArgs): OasObject;
+    /**
+     * Removes a property from the object.
+     *
+     * @param {string} name - The name of the property to remove.
+     * @returns {OasObject} A new OasObject with the removed property.
+     */
+    removeProperty(name: string): OasObject;
     isRef(): this is OasRef<'schema'>;
     resolve(): OasObject;
     resolveOnce(): OasObject;

package/esm/oas/object/Object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Object.d.ts","sourceRoot":"","sources":["../../../src/oas/object/Object.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAE7D,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EACP,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,GAC1D,SAAS,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC/B,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACzE,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,GAAG,SAAS,CAAA;IAC9D,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,qBAAa,SAAS;IACpB,OAAO,EAAE,QAAQ,CAAW;IAC5B,IAAI,EAAE,QAAQ,CAAW;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EACP,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,GAC1D,SAAS,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC/B,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACzE,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;gBAElB,MAAM,EAAE,eAAe;IASnC,kCAAkC;IAClC,MAAM,CAAC,KAAK,IAAI,SAAS;IAOzB,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,eAAe,GAAG,SAAS;IAkBnE,cAAc,CAAC,EAAE,IAAI,EAAE,EAAE,kBAAkB,GAAG,SAAS;IAiBvD,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;CAGzB"}
+{"version":3,"file":"Object.d.ts","sourceRoot":"","sources":["../../../src/oas/object/Object.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAE7D,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EACP,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,GAC1D,SAAS,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC/B,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACzE,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,GAAG,SAAS,CAAA;IAC9D,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,OAAO,WAAoB;IAC3B;;OAEG;IACH,IAAI,WAAoB;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B;;OAEG;IACH,UAAU,EACN,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAC,GAC1D,SAAS,CAAA;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC9B;;;;OAIG;IACH,oBAAoB,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;gBAE5D,MAAM,EAAE,eAAe;IASnC,kCAAkC;IAClC,MAAM,CAAC,KAAK,IAAI,SAAS;IAOzB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,eAAe,GAAG,SAAS;IAkBnE;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAiBvC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;CAGzB"}

package/esm/oas/object/Object.js

@@ -1,48 +1,80 @@
+/**
+ * Object representing an object and/or a record in the OpenAPI Specification.
+ *
+ * Objects have fixed, named fields. Records have any number of fields that do not have predefined names.
+ */
 export class OasObject {
     constructor(fields) {
+        /**
+         * Object is part the 'schema' set which is used
+         * to define data types in an OpenAPI document.
+         */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'schema'
         });
+        /**
+         * Constant value 'object' useful for type narrowing and tagged unions.
+         */
         Object.defineProperty(this, "type", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'object'
         });
+        /**
+         * A short summary of the object.
+         */
         Object.defineProperty(this, "title", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /**
+         * A description of the object.
+         */
         Object.defineProperty(this, "description", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "properties", {
+        /**
+         * Indicates whether value can be null.
+         */
+        Object.defineProperty(this, "nullable", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "required", {
+        /**
+         * A record which maps property names of the object to their schemas.
+         */
+        Object.defineProperty(this, "properties", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "additionalProperties", {
+        /**
+         * An array of required property names.
+         */
+        Object.defineProperty(this, "required", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "nullable", {
+        /**
+         * Indicates whether additional properties are allowed.
+         *
+         * This is equivalent to a Record type in TypeScript.
+         */
+        Object.defineProperty(this, "additionalProperties", {
             enumerable: true,
             configurable: true,
             writable: true,
@@ -62,6 +94,15 @@ export class OasObject {
             required: []
         });
     }
+    /**
+     * Adds a new property to the object.
+     *
+     * @param {AddPropertyArgs} args - The arguments for adding a property.
+     * @param {string} args.name - The name of the property to add.
+     * @param {OasSchema | OasRef<'schema'> | CustomValue | undefined} args.schema - The schema of the property to add.
+     * @param {boolean} args.required - Whether the property is required.
+     * @returns {OasObject} A new OasObject with the added property.
+     */
     addProperty({ name, schema, required }) {
         if (!schema) {
             return this;
@@ -78,7 +119,13 @@ export class OasObject {
             nullable: this.nullable
         });
     }
-    removeProperty({ name }) {
+    /**
+     * Removes a property from the object.
+     *
+     * @param {string} name - The name of the property to remove.
+     * @returns {OasObject} A new OasObject with the removed property.
+     */
+    removeProperty(name) {
         if (!this.properties?.[name]) {
             return this;
         }

package/esm/oas/string/String.d.ts

@@ -6,18 +6,42 @@ export type StringFields = {
     enums?: string[];
     nullable?: boolean;
 };
+/**
+ * Object representing a string in the OpenAPI Specification.
+ */
 export declare class OasString {
-    #private;
-    oasType: 'schema';
-    type: 'string';
+    /**
+     * Object is part the 'schema' set which is used
+     * to define data types in an OpenAPI document.
+     */
+    oasType: "schema";
+    /**
+     * Constant value 'string' useful for type narrowing and tagged unions.
+     */
+    type: "string";
+    /**
+     * A short summary of the string.
+     */
+    title: string | undefined;
+    /**
+     * A description of the string.
+     */
+    description: string | undefined;
+    /**
+     * The format of the string.
+     */
+    format: string | undefined;
+    /**
+     * An array of allowed values for the string.
+     */
+    enums: string[] | undefined;
+    /**
+     * Indicates whether value can be null.
+     */
+    nullable: boolean | undefined;
     constructor(fields: StringFields);
-    get title(): string | undefined;
-    get description(): string | undefined;
-    get nullable(): boolean | undefined;
     isRef(): this is OasRef<'schema'>;
     resolve(): OasString;
     resolveOnce(): OasString;
-    get format(): string | undefined;
-    get enums(): string[] | undefined;
 }
 //# sourceMappingURL=String.d.ts.map

package/esm/oas/string/String.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"String.d.ts","sourceRoot":"","sources":["../../../src/oas/string/String.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,qBAAa,SAAS;;IACpB,OAAO,EAAE,QAAQ,CAAW;IAC5B,IAAI,EAAE,QAAQ,CAAW;gBAGb,MAAM,EAAE,YAAY;IAIhC,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,QAAQ,IAAI,OAAO,GAAG,SAAS,CAElC;IAED,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;IAIxB,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAE/B;IAMD,IAAI,KAAK,IAAI,MAAM,EAAE,GAAG,SAAS,CAEhC;CACF"}
+{"version":3,"file":"String.d.ts","sourceRoot":"","sources":["../../../src/oas/string/String.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,OAAO,WAAoB;IAC3B;;OAEG;IACH,IAAI,WAAoB;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;gBAEjB,MAAM,EAAE,YAAY;IAYhC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;CAGzB"}