@arcote.tech/arc 0.1.7 → 0.1.8

package/dist/command/command.d.ts

@@ -37,6 +37,7 @@ export declare class ArcCommand<Name extends string, Params extends ArcObjectAny
         name: Name;
         description: string | undefined;
         parameters: any;
+        strict: boolean;
     };
 }
 export declare function command<Name extends string>(name: Name): ArcCommand<Name, null, any[], any[]>;

package/dist/context/context.d.ts

@@ -24,6 +24,7 @@ export type RemoveFalseAndResolvedPromiseFromArray<T extends any[]> = T extends
 export declare class ArcContext<const E extends ArcContextElementAny[]> {
     readonly elements: E;
     constructor(elements: E);
+    get<Element extends E[number]>(name: Element["name"]): Element;
     getSyncListeners(eventType: string, authContext: AuthContext): EventListener<any>[];
     getAsyncListeners(eventType: string, authContext: AuthContext): EventListener<any>[];
     pipe<const NewElements extends (ArcContextElementAny | false | Promise<{

package/dist/elements/abstract.d.ts

@@ -11,10 +11,12 @@ export type Validators = Validator<any>[];
 export type GetValidator<A extends ArcAbstract<any>> = A extends ArcAbstract<infer T> ? T : [];
 export declare abstract class ArcAbstract<V extends Validators> implements ArcElement {
     protected validations: V;
+    protected _description?: string;
     constructor(validations?: V);
     abstract serialize(value: any): any;
     abstract deserialize(value: any): any;
     abstract parse(value: any): any;
+    description(description: string): this;
     default(defaultValueOrCallback: (() => ReturnType<this["deserialize"]>) | ReturnType<this["deserialize"]>): ArcDefault<this>;
     optional(): ArcOptional<this>;
     branded<Brand extends string | symbol>(name: Brand): ArcBranded<this, Brand>;

package/dist/elements/any.d.ts

@@ -4,7 +4,7 @@ export declare class ArcAny<T, V extends Validators = []> extends ArcAbstract<V>
     parse(value: T): any;
     serialize(value: T): any;
     deserialize(value: any): T;
-    toJsonSchema(): {};
+    toJsonSchema(): any;
 }
 export declare function any<T extends any>(): ArcAny<T, any>;
 //# sourceMappingURL=any.d.ts.map

package/dist/elements/array.d.ts

@@ -54,10 +54,7 @@ export declare class ArcArray<E extends ArcElement, V extends Validators = [
         name: Name;
         validator: Fn;
     }]>>>;
-    toJsonSchema(): {
-        type: string;
-        items: any;
-    };
+    toJsonSchema(): any;
 }
 export type ArcArrayAny = ArcArray<any>;
 export declare function array<E extends ArcElement>(element: E): ArcArray<E, [{

package/dist/elements/blob.d.ts

@@ -67,11 +67,7 @@ export declare class ArcBlob<V extends Validators = [typeof blobValidator]> exte
      * Override parse to validate blob objects
      */
     parse(value: any): Blob;
-    toJsonSchema(): {
-        type: string;
-        contentEncoding: string;
-        contentMediaType: string;
-    };
+    toJsonSchema(): any;
 }
 export declare function blob(): ArcBlob<[{
     readonly name: "blob";

package/dist/elements/boolean.d.ts

@@ -11,9 +11,7 @@ export declare class ArcBoolean<V extends Validators> extends ArcPrimitive<V, bo
         name: Name;
         validator: Fn;
     }]>>>;
-    toJsonSchema(): {
-        type: string;
-    };
+    toJsonSchema(): any;
 }
 export declare function boolean(): ArcBoolean<Validators>;
 //# sourceMappingURL=boolean.d.ts.map

package/dist/elements/date.d.ts

@@ -30,10 +30,7 @@ export declare class ArcDate<V extends Validators = [typeof dateValidator]> exte
         name: Name;
         validator: Fn;
     }]>>>;
-    toJsonSchema(): {
-        type: string;
-        format: string;
-    };
+    toJsonSchema(): any;
 }
 export declare function date(): ArcDate<[{
     name: "type";

package/dist/elements/file.d.ts

@@ -127,11 +127,7 @@ export declare class ArcFile<V extends Validators = [typeof fileValidator]> exte
      * Override parse to validate file objects
      */
     parse(value: any): File;
-    toJsonSchema(): {
-        type: string;
-        contentEncoding: string;
-        contentMediaType: string;
-    };
+    toJsonSchema(): any;
 }
 export declare function file(): ArcFile<[{
     readonly name: "file";

package/dist/elements/number.d.ts

@@ -27,9 +27,7 @@ export declare class ArcNumber<V extends Validators = [typeof numberValidator]>
         name: Name;
         validator: Fn;
     }]>>>;
-    toJsonSchema(): {
-        type: string;
-    };
+    toJsonSchema(): any;
 }
 export declare function number(): ArcNumber<[{
     name: "type";

package/dist/elements/object.d.ts

@@ -81,7 +81,10 @@ export declare function object<E extends ArcRawShape>(element: E): ArcObject<E,
     name: "schema";
     validator: (value: any) => false | { [key in keyof E]: ReturnType<E[key]["validate"]>; };
 }]>;
-export type ArcObjectMerge<A extends ArcObjectAny, B extends ArcObjectAny> = [A, B] extends [
+export type ArcObjectMerge<A extends ArcObjectAny, B extends ArcObjectAny> = [
+    A,
+    B
+] extends [
     ArcObject<infer AShape, infer AValidators>,
     ArcObject<infer BShape, infer BValidators>
 ] ? ArcObject<AShape & BShape, [...AValidators, ...BValidators]> : never;

package/dist/elements/record.d.ts

@@ -19,11 +19,7 @@ export declare class ArcRecord<Key extends ArcKey, E extends ArcElement, V exten
     parse(value: Record<util.FirstArgument<Key["parse"]>, util.FirstArgument<E["parse"]>>): Record<ReturnType<Key["parse"]>, ReturnType<E["parse"]>>;
     serialize(value: Record<ReturnType<Key["serialize"]>, ReturnType<E["serialize"]>>): Record<ReturnType<Key["serialize"]>, ReturnType<E["serialize"]>>;
     deserialize(value: Record<ReturnType<Key["deserialize"]>, ReturnType<E["deserialize"]>>): Record<ReturnType<Key["deserialize"]>, ReturnType<E["deserialize"]>>;
-    toJsonSchema(): {
-        type: string;
-        propertyNames: any;
-        additionalProperties: any;
-    };
+    toJsonSchema(): any;
 }
 export type ArcRecordAny = ArcRecord<any, any>;
 export declare function record<Key extends ArcKey, E extends ArcElement>(key: Key, element: E): ArcRecord<Key, E, [{

package/dist/elements/string-enum.d.ts

@@ -13,10 +13,7 @@ export declare class ArcStringEnum<const T extends string[], V extends Validator
     parse<Value extends T[number]>(value: Value): Value;
     serialize<Value extends T[number]>(value: Value): Value;
     deserialize<Value extends T[number]>(value: Value): Value;
-    toJsonSchema(): {
-        readonly type: "string";
-        readonly enum: T;
-    };
+    toJsonSchema(): any;
     getEnumerators(): T;
 }
 export type ArcStringEnumAny = ArcStringEnum<any>;

package/dist/elements/string.d.ts

@@ -64,9 +64,7 @@ export declare class ArcString<V extends Validators = [typeof stringValidator]>
             currentEmail: string;
         } | undefined;
     }]>;
-    toJsonSchema(): {
-        type: string;
-    };
+    toJsonSchema(): any;
     url(): ArcString<[...V, {
         name: "url";
         validator: (value: string) => {

package/dist/index.js

@@ -116,9 +116,15 @@ class ArcDefault {
 // elements/abstract.ts
 class ArcAbstract {
   validations;
+  _description;
   constructor(validations = []) {
     this.validations = validations;
   }
+  description(description) {
+    const clone = this.clone();
+    clone._description = description;
+    return clone;
+  }
   default(defaultValueOrCallback) {
     return new ArcDefault(this, defaultValueOrCallback);
   }
@@ -131,6 +137,7 @@ class ArcAbstract {
   clone() {
     const Constructor = this.constructor;
     const newInstance = Object.assign(new Constructor, this);
+    newInstance._description = this._description;
     return newInstance;
   }
   validate(value) {
@@ -153,7 +160,11 @@ class ArcAbstract {
     return newInstance;
   }
   toJsonSchema() {
-    return {};
+    const schema = {};
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
   getValidations() {
     return this.validations;
@@ -276,7 +287,11 @@ class ArcString extends ArcPrimitive {
     });
   }
   toJsonSchema() {
-    return { type: "string" };
+    const schema = { type: "string" };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
   url() {
     const regex = /^(https?):\/\/(?![-0-9])(?!www\.[0-9])(?:[a-zA-Z0-9-]+(?::[a-zA-Z0-9-]+)?@)?(?:localhost|\b(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b|[a-zA-Z0-9-]+\.)?[a-zA-Z0-9-]+\.(?:[a-zA-Z]{2,}|[a-zA-Z]{2}\.[a-zA-Z]{2})(?::\d{1,5})?(?!\/\/)(?:\/[a-zA-Z0-9-._~:?#\[\]@!$&'()*+,;=]*)*(?!\/{2})(?:;[a-zA-Z0-9-._~:?#\[\]@!$&'()*+,;=]*)*(\?(?!=)[a-zA-Z0-9&=;]*)?(\#[a-zA-Z0-9-]*)?$|^(https?):\/\/(localhost|\b(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b)(?::\d{1,5})?(?!\/\/)(?:\/[a-zA-Z0-9-._~:?#\[\]@!$&'()*+,;=]*)*(?!\/{2})(?:;[a-zA-Z0-9-._~:?#\[\]@!$&'()*+,;=]*)*(\?(?!=)[a-zA-Z0-9&=;]*)?(\#[a-zA-Z0-9-]*)?$/;
@@ -358,7 +373,11 @@ class ArcAny extends ArcAbstract {
     return value;
   }
   toJsonSchema() {
-    return {};
+    const schema = {};
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
 }
 function any() {
@@ -442,6 +461,10 @@ class ArcObject extends ArcAbstract {
   }
   serializePartial(value) {
     return Object.entries(value).reduce((acc, [key, value2]) => {
+      if (!this.rawShape[key]) {
+        console.warn(`No element found for key: ${key}`);
+        return acc;
+      }
       acc[key] = this.rawShape[key].serialize(value2);
       return acc;
     }, {});
@@ -486,6 +509,9 @@ class ArcObject extends ArcAbstract {
     };
     if (required.length)
       schema.required = required;
+    if (this._description) {
+      schema.description = this._description;
+    }
     return schema;
   }
 }
@@ -578,10 +604,14 @@ class ArcArray extends ArcAbstract {
     return instance;
   }
   toJsonSchema() {
-    return {
+    const schema = {
       type: "array",
       items: this.parent.toJsonSchema?.() ?? {}
     };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
 }
 function array(element) {
@@ -675,11 +705,15 @@ class ArcBlob extends ArcPrimitive {
     throw new Error("Expected Blob object");
   }
   toJsonSchema() {
-    return {
+    const schema = {
       type: "string",
       contentEncoding: "base64",
       contentMediaType: "application/octet-stream"
     };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
 }
 function blob() {
@@ -700,7 +734,11 @@ class ArcBoolean extends ArcPrimitive {
     return instance;
   }
   toJsonSchema() {
-    return { type: "boolean" };
+    const schema = { type: "boolean" };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
 }
 function boolean() {
@@ -742,10 +780,14 @@ class ArcDate extends ArcAbstract {
     return instance;
   }
   toJsonSchema() {
-    return {
+    const schema = {
       type: "string",
       format: "date-time"
     };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
 }
 function date() {
@@ -915,11 +957,15 @@ class ArcFile extends ArcPrimitive {
     throw new Error("Expected File object");
   }
   toJsonSchema() {
-    return {
+    const schema = {
       type: "string",
       contentEncoding: "base64",
       contentMediaType: "application/octet-stream"
     };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
 }
 function file() {
@@ -949,7 +995,11 @@ class ArcNumber extends ArcPrimitive {
     return instance;
   }
   toJsonSchema() {
-    return { type: "number" };
+    const schema = { type: "number" };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
 }
 function number() {
@@ -1058,11 +1108,15 @@ class ArcRecord extends ArcAbstract {
     }, {});
   }
   toJsonSchema() {
-    return {
+    const schema = {
       type: "object",
       propertyNames: this.key.toJsonSchema?.() ?? {},
       additionalProperties: this.element.toJsonSchema?.() ?? {}
     };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
 }
 function record(key, element) {
@@ -1094,10 +1148,14 @@ class ArcStringEnum extends ArcAbstract {
     return value;
   }
   toJsonSchema() {
-    return {
+    const schema = {
       type: "string",
       enum: this.values
     };
+    if (this._description) {
+      schema.description = this._description;
+    }
+    return schema;
   }
   getEnumerators() {
     return this.values;
@@ -1521,7 +1579,8 @@ class ArcCommand extends ArcContextElement {
       type: "function",
       name: this.name,
       description: this._description ?? undefined,
-      parameters: parametersSchema
+      parameters: parametersSchema,
+      strict: true
     };
   }
 }
@@ -1534,6 +1593,9 @@ class ArcContext {
   constructor(elements) {
     this.elements = elements;
   }
+  get(name) {
+    return this.elements.find((element2) => element2.name === name);
+  }
   getSyncListeners(eventType, authContext) {
     const listeners = [];
     this.elements.forEach((element2) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@arcote.tech/arc",
   "type": "module",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "private": false,
   "author": "Przemysław Krasiński [arcote.tech]",
   "description": "Arc is a framework designed to align code closely with business logic, streamlining development and enhancing productivity.",