@gi-tcg/gts-runtime 0.4.4 → 0.4.6

package/dist/index.d.ts

@@ -57,76 +57,6 @@ declare class BindingContext {
 declare function createDefine(rootVM: IViewModel<any, any, any>, node: SingleAttributeNode): void;
 declare function createBinding(rootVM: IViewModel<any, any, any>, node: SingleAttributeNode): unknown[];
 //#endregion
-//#region ../../node_modules/@standard-schema/spec/dist/index.d.ts
-/** The Standard Typed interface. This is a base type extended by other specs. */
-interface StandardTypedV1<Input = unknown, Output = Input> {
-  /** The Standard properties. */
-  readonly "~standard": StandardTypedV1.Props<Input, Output>;
-}
-declare namespace StandardTypedV1 {
-  /** The Standard Typed properties interface. */
-  interface Props<Input = unknown, Output = Input> {
-    /** The version number of the standard. */
-    readonly version: 1;
-    /** The vendor name of the schema library. */
-    readonly vendor: string;
-    /** Inferred types associated with the schema. */
-    readonly types?: Types<Input, Output> | undefined;
-  }
-  /** The Standard Typed types interface. */
-  interface Types<Input = unknown, Output = Input> {
-    /** The input type of the schema. */
-    readonly input: Input;
-    /** The output type of the schema. */
-    readonly output: Output;
-  }
-  /** Infers the input type of a Standard Typed. */
-  type InferInput<Schema extends StandardTypedV1> = NonNullable<Schema["~standard"]["types"]>["input"];
-  /** Infers the output type of a Standard Typed. */
-  type InferOutput<Schema extends StandardTypedV1> = NonNullable<Schema["~standard"]["types"]>["output"];
-}
-/** The Standard Schema interface. */
-/** The Standard JSON Schema interface. */
-interface StandardJSONSchemaV1<Input = unknown, Output = Input> {
-  /** The Standard JSON Schema properties. */
-  readonly "~standard": StandardJSONSchemaV1.Props<Input, Output>;
-}
-declare namespace StandardJSONSchemaV1 {
-  /** The Standard JSON Schema properties interface. */
-  interface Props<Input = unknown, Output = Input> extends StandardTypedV1.Props<Input, Output> {
-    /** Methods for generating the input/output JSON Schema. */
-    readonly jsonSchema: StandardJSONSchemaV1.Converter;
-  }
-  /** The Standard JSON Schema converter interface. */
-  interface Converter {
-    /** Converts the input type to JSON Schema. May throw if conversion is not supported. */
-    readonly input: (options: StandardJSONSchemaV1.Options) => Record<string, unknown>;
-    /** Converts the output type to JSON Schema. May throw if conversion is not supported. */
-    readonly output: (options: StandardJSONSchemaV1.Options) => Record<string, unknown>;
-  }
-  /**
-   * The target version of the generated JSON Schema.
-   *
-   * It is *strongly recommended* that implementers support `"draft-2020-12"` and `"draft-07"`, as they are both in wide use. All other targets can be implemented on a best-effort basis. Libraries should throw if they don't support a specified target.
-   *
-   * The `"openapi-3.0"` target is intended as a standardized specifier for OpenAPI 3.0 which is a superset of JSON Schema `"draft-04"`.
-   */
-  type Target = "draft-2020-12" | "draft-07" | "openapi-3.0" | ({} & string);
-  /** The options for the input/output methods. */
-  interface Options {
-    /** Specifies the target version of the generated JSON Schema. Support for all versions is on a best-effort basis. If a given version is not supported, the library should throw. */
-    readonly target: Target;
-    /** Explicit support for additional vendor-specific parameters, if needed. */
-    readonly libraryOptions?: Record<string, unknown> | undefined;
-  }
-  /** The Standard types interface. */
-  interface Types<Input = unknown, Output = Input> extends StandardTypedV1.Types<Input, Output> {}
-  /** Infers the input type of a Standard. */
-  type InferInput<Schema extends StandardTypedV1> = StandardTypedV1.InferInput<Schema>;
-  /** Infers the output type of a Standard. */
-  type InferOutput<Schema extends StandardTypedV1> = StandardTypedV1.InferOutput<Schema>;
-}
-//#endregion
 //#region src/view_model.d.ts
 interface AttributeBlockDefinition {
   "~action"?: AttributeDefinition | undefined;
@@ -199,14 +129,6 @@ declare class AttributeDefHelper<ModelT> {
 declare function defineViewModel<T, const BlockDef extends Partial<Record<string | Action, AttributeDefinition>>, CtorArgs extends any[] = [], InitMeta = void>(Ctor: new (...args: CtorArgs) => T, modelDefFn: (helper: AttributeDefHelper<T>) => BlockDef, initMeta?: InitMeta): IViewModel<T, BlockDef & {
   "~meta": InitMeta;
 }, CtorArgs>;
-type SimpleViewModel<T> = IViewModel<T, { [K in keyof T]-?: {
-  (value: T[K]): AttributeReturn.Done;
-  uniqueKey(): K;
-  required(): {} extends Pick<T, K> ? false : true;
-} } & {
-  "~meta": undefined;
-}, []>;
-declare function defineSimpleViewModel<const T extends StandardJSONSchemaV1>(schema: T): SimpleViewModel<StandardJSONSchemaV1.InferInput<T>>;
 interface AttributeDefinition {
   (...args: any[]): AttributePositionalReturnBase;
   as?(): any;
@@ -237,4 +159,109 @@ type AttributeBinder<Model, T extends AttributeDefinition> = (model: Model, posi
   "~meta": void;
 }>) => T["as"] extends (() => infer U) ? U : void;
 //#endregion
-export { type AttributeReturn as AR, type AttributeReturn, type Action, type AttributeDefinition, type IViewModel, type Meta, type NamedAttributesNode, type NamedDefinition, type Prelude, type SimpleViewModel, type SingleAttributeNode, type View, createBinding, createDefine, defineSimpleViewModel, defineViewModel };
+//#region ../../node_modules/@standard-schema/spec/dist/index.d.ts
+/** The Standard Typed interface. This is a base type extended by other specs. */
+interface StandardTypedV1<Input = unknown, Output = Input> {
+  /** The Standard properties. */
+  readonly "~standard": StandardTypedV1.Props<Input, Output>;
+}
+declare namespace StandardTypedV1 {
+  /** The Standard Typed properties interface. */
+  interface Props<Input = unknown, Output = Input> {
+    /** The version number of the standard. */
+    readonly version: 1;
+    /** The vendor name of the schema library. */
+    readonly vendor: string;
+    /** Inferred types associated with the schema. */
+    readonly types?: Types<Input, Output> | undefined;
+  }
+  /** The Standard Typed types interface. */
+  interface Types<Input = unknown, Output = Input> {
+    /** The input type of the schema. */
+    readonly input: Input;
+    /** The output type of the schema. */
+    readonly output: Output;
+  }
+  /** Infers the input type of a Standard Typed. */
+  type InferInput<Schema extends StandardTypedV1> = NonNullable<Schema["~standard"]["types"]>["input"];
+  /** Infers the output type of a Standard Typed. */
+  type InferOutput<Schema extends StandardTypedV1> = NonNullable<Schema["~standard"]["types"]>["output"];
+}
+/** The Standard Schema interface. */
+/** The Standard JSON Schema interface. */
+interface StandardJSONSchemaV1<Input = unknown, Output = Input> {
+  /** The Standard JSON Schema properties. */
+  readonly "~standard": StandardJSONSchemaV1.Props<Input, Output>;
+}
+declare namespace StandardJSONSchemaV1 {
+  /** The Standard JSON Schema properties interface. */
+  interface Props<Input = unknown, Output = Input> extends StandardTypedV1.Props<Input, Output> {
+    /** Methods for generating the input/output JSON Schema. */
+    readonly jsonSchema: StandardJSONSchemaV1.Converter;
+  }
+  /** The Standard JSON Schema converter interface. */
+  interface Converter {
+    /** Converts the input type to JSON Schema. May throw if conversion is not supported. */
+    readonly input: (options: StandardJSONSchemaV1.Options) => Record<string, unknown>;
+    /** Converts the output type to JSON Schema. May throw if conversion is not supported. */
+    readonly output: (options: StandardJSONSchemaV1.Options) => Record<string, unknown>;
+  }
+  /**
+   * The target version of the generated JSON Schema.
+   *
+   * It is *strongly recommended* that implementers support `"draft-2020-12"` and `"draft-07"`, as they are both in wide use. All other targets can be implemented on a best-effort basis. Libraries should throw if they don't support a specified target.
+   *
+   * The `"openapi-3.0"` target is intended as a standardized specifier for OpenAPI 3.0 which is a superset of JSON Schema `"draft-04"`.
+   */
+  type Target = "draft-2020-12" | "draft-07" | "openapi-3.0" | ({} & string);
+  /** The options for the input/output methods. */
+  interface Options {
+    /** Specifies the target version of the generated JSON Schema. Support for all versions is on a best-effort basis. If a given version is not supported, the library should throw. */
+    readonly target: Target;
+    /** Explicit support for additional vendor-specific parameters, if needed. */
+    readonly libraryOptions?: Record<string, unknown> | undefined;
+  }
+  /** The Standard types interface. */
+  interface Types<Input = unknown, Output = Input> extends StandardTypedV1.Types<Input, Output> {}
+  /** Infers the input type of a Standard. */
+  type InferInput<Schema extends StandardTypedV1> = StandardTypedV1.InferInput<Schema>;
+  /** Infers the output type of a Standard. */
+  type InferOutput<Schema extends StandardTypedV1> = StandardTypedV1.InferOutput<Schema>;
+}
+//#endregion
+//#region src/utilts.d.ts
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+type LastOf<T> = UnionToIntersection<T extends any ? () => T : never> extends (() => infer R) ? R : never;
+type IsSingleton<T, L = LastOf<T>> = [T] extends [never] ? false : [Exclude<T, L>] extends [never] ? true : false;
+//#endregion
+//#region src/simple_view_model.d.ts
+interface SimpleViewModelOptions {
+  /**
+  * Recursively parse nested objects as sub-view models.
+  */
+  recursive?: boolean;
+  /**
+  * Treat boolean-compatible properties as switches, i.e. the presence
+  * of the attribute without a value sets the property to `true`.
+  *
+  * Ignored if the `recursive` option is enabled and a object value is acceptable.
+  */
+  booleanSwitch?: boolean;
+}
+type ExtractObject<T> = T extends object ? T : never;
+type SimpleViewModelAttribute<ValueT, Options extends SimpleViewModelOptions> = {
+  (value: ValueT): AttributeReturn.Done;
+} & (Options["recursive"] extends true ? IsSingleton<ExtractObject<ValueT>> extends true ? {
+  (): AttributeReturn.With<SimpleViewModel<ExtractObject<ValueT>, Options>>;
+} : Options["booleanSwitch"] extends true ? [true] extends [ValueT] ? {
+  (): AttributeReturn.Done;
+} : {} : {} : {});
+type SimpleViewModel<T, Options extends SimpleViewModelOptions = {}> = IViewModel<T, { [K in keyof T]-?: SimpleViewModelAttribute<T[K], Options> & {
+  uniqueKey(): K;
+  required(): {} extends Pick<T, K> ? false : true;
+} } & {
+  "~meta": undefined;
+}, []>;
+declare function defineSimpleViewModel<const T extends StandardJSONSchemaV1, const Options extends SimpleViewModelOptions = {}>(schema: T, options?: Options): SimpleViewModel<StandardJSONSchemaV1.InferInput<T>, Options>;
+//#endregion
+export { type AttributeReturn as AR, type AttributeReturn, type Action, type AttributeDefinition, type IViewModel, type Meta, type NamedAttributesNode, type NamedDefinition, type Prelude, type SimpleViewModel, type SimpleViewModelOptions, type SingleAttributeNode, type View, createBinding, createDefine, defineSimpleViewModel, defineViewModel };

package/dist/index.js

@@ -1,3 +1,4 @@
+import { Ajv2020 } from "ajv/dist/2020.js";
 //#region src/view.ts
 var View = class {
 	#phantom;
@@ -130,16 +131,59 @@ function defineViewModel(Ctor, modelDefFn, initMeta) {
 	helper["~assignActions"](defResult);
 	return vm;
 }
-function defineSimpleViewModel(schema) {
-	const jsonSchema = schema["~standard"].jsonSchema.input({ target: "draft-2020-12" });
+//#endregion
+//#region src/simple_view_model.ts
+const ajv = new Ajv2020({ strict: false });
+function isBooleanCompatible(propSchema) {
+	try {
+		return ajv.compile(propSchema)(true);
+	} catch {
+		return false;
+	}
+}
+function extractObjectSchema(propSchema) {
+	if (propSchema.type === "object") return propSchema;
+	if (Array.isArray(propSchema.anyOf)) {
+		const objectBranches = propSchema.anyOf.filter((s) => s && typeof s === "object" && s.type === "object");
+		if (objectBranches.length === 1) return objectBranches[0];
+	}
+	return null;
+}
+function createSimpleViewModelFromJsonSchema(jsonSchema, options) {
 	const vm = new ViewModel(class SimpleViewModel {});
 	const helper = new AttributeDefHelper(vm);
 	const defResult = {};
-	for (const key of Object.keys(jsonSchema.properties ?? {})) defResult[key] = helper.simpleAttribute()(function(value) {
-		this[key] = value;
-	});
+	for (const key of Object.keys(jsonSchema.properties ?? {})) {
+		const propSchema = jsonSchema.properties[key];
+		if (!propSchema) continue;
+		defResult[key] = registerAttribute(helper, key, propSchema, options);
+	}
 	helper["~assignActions"](defResult);
 	return vm;
 }
+function registerAttribute(helper, key, propSchema, options) {
+	let objectSchema = null;
+	if (options.recursive && (objectSchema = extractObjectSchema(propSchema))) {
+		const subVM = createSimpleViewModelFromJsonSchema(objectSchema, options);
+		return helper.attribute((model, positionals, named) => {
+			if (positionals.length > 0) model[key] = positionals[0];
+			else model[key] = subVM.parse(named);
+		});
+	}
+	if (options.booleanSwitch && isBooleanCompatible(propSchema)) return helper.simpleAttribute()(function(...args) {
+		this[key] = args.length > 0 ? args[0] : true;
+	});
+	return helper.simpleAttribute()(function(value) {
+		this[key] = value;
+	});
+}
+function defineSimpleViewModel(schema, options) {
+	const resolvedOptions = {
+		booleanSwitch: false,
+		recursive: false,
+		...options
+	};
+	return createSimpleViewModelFromJsonSchema(schema["~standard"].jsonSchema.input({ target: "draft-2020-12" }), resolvedOptions);
+}
 //#endregion
 export { createBinding, createDefine, defineSimpleViewModel, defineViewModel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gi-tcg/gts-runtime",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "repository": {
     "type": "git",
     "url": "https://github.com/piovium/gts.git"
@@ -18,12 +18,15 @@
     "src",
     "dist"
   ],
-  "dependencies": {},
+  "dependencies": {
+    "ajv": "^8.20.0"
+  },
   "devDependencies": {
     "@standard-schema/spec": "^1.1.0",
     "json-schema-typed": "^8.0.2"
   },
   "scripts": {
-    "build": "tsdown --platform neutral"
+    "build": "tsdown --platform neutral",
+    "test": "vitest"
   }
 }

package/src/index.ts

@@ -1,10 +1,13 @@
 export {
   defineViewModel,
-  defineSimpleViewModel,
   type AttributeDefinition,
   type IViewModel,
-  type SimpleViewModel,
 } from "./view_model.ts";
+export {
+  defineSimpleViewModel,
+  type SimpleViewModel,
+  type SimpleViewModelOptions,
+} from "./simple_view_model.ts";
 export type { AttributeReturn, AR } from "./attribute_return.ts";
 export type { Action, Prelude, Meta, NamedDefinition } from "./symbols.ts";
 

package/src/simple_view_model.ts

@@ -0,0 +1,160 @@
+import type { StandardJSONSchemaV1 } from "@standard-schema/spec";
+import {
+  AttributeDefHelper,
+  ViewModel,
+  type IViewModel,
+  type AttributeAction,
+} from "./view_model.ts";
+import type { AttributeReturn } from "./attribute_return.ts";
+import { Ajv2020 } from "ajv/dist/2020.js";
+import type { IsSingleton } from "./utilts.ts";
+
+export interface SimpleViewModelOptions {
+  /**
+   * Recursively parse nested objects as sub-view models.
+   */
+  recursive?: boolean;
+  /**
+   * Treat boolean-compatible properties as switches, i.e. the presence
+   * of the attribute without a value sets the property to `true`.
+   *
+   * Ignored if the `recursive` option is enabled and a object value is acceptable.
+   */
+  booleanSwitch?: boolean;
+}
+
+type ExtractObject<T> = T extends object ? T : never;
+
+type SimpleViewModelAttribute<
+  ValueT,
+  Options extends SimpleViewModelOptions,
+> = {
+  (value: ValueT): AttributeReturn.Done;
+} & (Options["recursive"] extends true
+  ? IsSingleton<ExtractObject<ValueT>> extends true
+    ? {
+        (): AttributeReturn.With<
+          SimpleViewModel<ExtractObject<ValueT>, Options>
+        >;
+      }
+    : Options["booleanSwitch"] extends true
+      ? [true] extends [ValueT]
+        ? { (): AttributeReturn.Done }
+        : {}
+      : {}
+  : {});
+
+export type SimpleViewModel<
+  T,
+  Options extends SimpleViewModelOptions = {},
+> = IViewModel<
+  T,
+  {
+    [K in keyof T]-?: SimpleViewModelAttribute<T[K], Options> & {
+      uniqueKey(): K;
+      required(): {} extends Pick<T, K> ? false : true;
+    };
+  } & {
+    "~meta": undefined;
+  },
+  []
+>;
+
+const ajv = new Ajv2020({ strict: false });
+
+function isBooleanCompatible(propSchema: Record<string, unknown>): boolean {
+  try {
+    const validate = ajv.compile(propSchema);
+    return validate(true);
+  } catch {
+    return false;
+  }
+}
+
+function extractObjectSchema(
+  propSchema: Record<string, unknown>,
+): Record<string, unknown> | null {
+  if (propSchema.type === "object") {
+    return propSchema;
+  }
+  if (Array.isArray(propSchema.anyOf)) {
+    const objectBranches = propSchema.anyOf.filter(
+      (s: any) => s && typeof s === "object" && s.type === "object",
+    );
+    if (objectBranches.length === 1) {
+      return objectBranches[0] as Record<string, unknown>;
+    }
+  }
+  return null;
+}
+
+function createSimpleViewModelFromJsonSchema(
+  jsonSchema: Record<string, unknown>,
+  options: SimpleViewModelOptions,
+): IViewModel<any, any, []> {
+  const Ctor = class SimpleViewModel {};
+  const vm = new ViewModel<any, any, []>(Ctor);
+  const helper = new AttributeDefHelper(vm);
+  const defResult: Record<string, any> = {};
+  for (const key of Object.keys(jsonSchema.properties ?? {})) {
+    const propSchema = (jsonSchema.properties as Record<string, unknown>)[key];
+    if (!propSchema) {
+      continue;
+    }
+    defResult[key] = registerAttribute(
+      helper,
+      key,
+      propSchema as Record<string, unknown>,
+      options,
+    );
+  }
+  helper["~assignActions"](defResult);
+  return vm as any;
+}
+
+function registerAttribute(
+  helper: AttributeDefHelper<any>,
+  key: string,
+  propSchema: Record<string, unknown>,
+  options: SimpleViewModelOptions,
+): unknown {
+  let objectSchema: Record<string, unknown> | null = null;
+  if (options.recursive && (objectSchema = extractObjectSchema(propSchema))) {
+    const subVM = createSimpleViewModelFromJsonSchema(objectSchema, options);
+    return helper.attribute((model, positionals, named) => {
+      if (positionals.length > 0) {
+        model[key] = positionals[0];
+      } else {
+        model[key] = subVM.parse(named);
+      }
+    });
+  }
+
+  if (options.booleanSwitch && isBooleanCompatible(propSchema)) {
+    return helper.simpleAttribute()(function (this: any, ...args: any[]) {
+      this[key] = args.length > 0 ? args[0] : true;
+    });
+  }
+
+  return helper.simpleAttribute()(function (this: any, value) {
+    this[key] = value;
+  });
+}
+
+export function defineSimpleViewModel<
+  const T extends StandardJSONSchemaV1,
+  const Options extends SimpleViewModelOptions = {},
+>(
+  schema: T,
+  options?: Options,
+): SimpleViewModel<StandardJSONSchemaV1.InferInput<T>, Options> {
+  const resolvedOptions: SimpleViewModelOptions = {
+    booleanSwitch: false,
+    recursive: false,
+    ...options,
+  };
+  const jsonSchema = schema["~standard"].jsonSchema.input({
+    target: "draft-2020-12",
+  });
+  return createSimpleViewModelFromJsonSchema(jsonSchema, resolvedOptions);
+}

package/src/utilts.ts

@@ -0,0 +1,26 @@
+// we just write this time by time.
+// we know this is not a good way to write typescript, but thats the only way to achieve our goal
+
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
+  k: infer I,
+) => void
+  ? I
+  : never;
+
+type LastOf<T> =
+  UnionToIntersection<T extends any ? () => T : never> extends () => infer R
+    ? R
+    : never;
+
+type Push<T extends any[], V> = [...T, V];
+export type TuplifyUnion<
+  T,
+  L = LastOf<T>,
+  N = [T] extends [never] ? true : false,
+> = true extends N ? [] : Push<TuplifyUnion<Exclude<T, L>>, L>;
+
+export type IsSingleton<T, L = LastOf<T>> = [T] extends [never]
+  ? false
+  : [Exclude<T, L>] extends [never]
+    ? true
+    : false;

package/src/view_model.ts

@@ -1,7 +1,6 @@
 import type { AttributeReturn } from "./attribute_return.ts";
 import type { Action, Meta, NamedDefinition } from "./symbols.ts";
 import { View } from "./view.ts";
-import type { StandardJSONSchemaV1 } from "@standard-schema/spec";
 
 export interface AttributeBlockDefinition {
   "~action"?: AttributeDefinition | undefined;
@@ -55,7 +54,7 @@ type LazyAttributeActionOrBinder<ModelT> = (
   named: View<any>,
 ) => unknown;
 
-class ViewModel<
+export class ViewModel<
   ModelT,
   BlockDef extends AttributeBlockDefinition,
   CtorArgs extends any[],
@@ -154,7 +153,7 @@ type WithSimpleOptions<Base, Options extends SimpleAttributeOptions> = Base &
     ? { uniqueKey(): Options["uniqueKey"] }
     : {});
 
-class AttributeDefHelper<ModelT> {
+export class AttributeDefHelper<ModelT> {
   #viewModel: ViewModel<ModelT, any, any>;
   constructor(viewModel: ViewModel<ModelT, any, any>) {
     this.#viewModel = viewModel;
@@ -296,37 +295,6 @@ export function defineViewModel<
   return vm;
 }
 
-export type SimpleViewModel<T> = IViewModel<
-  T,
-  {
-    [K in keyof T]-?: {
-      (value: T[K]): AttributeReturn.Done;
-      uniqueKey(): K;
-      required(): {} extends Pick<T, K> ? false : true;
-    };
-  } & { "~meta": undefined },
-  []
->;
-
-export function defineSimpleViewModel<const T extends StandardJSONSchemaV1>(
-  schema: T,
-): SimpleViewModel<StandardJSONSchemaV1.InferInput<T>> {
-  const jsonSchema = schema["~standard"].jsonSchema.input({
-    target: "draft-2020-12",
-  });
-  const Ctor = class SimpleViewModel {};
-  const vm = new ViewModel<any, any, []>(Ctor);
-  const helper = new AttributeDefHelper(vm);
-  const defResult: Record<string, any> = {};
-  for (const key of Object.keys(jsonSchema.properties ?? {})) {
-    defResult[key] = helper.simpleAttribute()(function (this: any, value) {
-      this[key] = value;
-    });
-  }
-  helper["~assignActions"](defResult);
-  return vm as any;
-}
-
 export interface AttributeDefinition {
   (...args: any[]): AttributePositionalReturnBase;
   as?(): any;