@datasworn-community/build-tools 0.2.0

package/schema-source/schema/utils/typebox.ts

@@ -0,0 +1,141 @@
+/** Utilities for manipulating TypeBox schemata. */
+import {
+	CloneType,
+	type ObjectOptions,
+	type Static,
+	type TInteger,
+	type TLiteral,
+	type TNull,
+	type TNumber,
+	/** Transform an object of literal values into a schema representing the object. */
+	type TObject,
+	type TOptional,
+	type TProperties,
+	type TRef,
+	type TRefUnsafe,
+	type TSchema,
+	type TString,
+	Type,
+	TypeGuard
+} from '@sinclair/typebox'
+import { isEmpty, isUndefined } from 'lodash-es'
+import JtdType from '../../scripts/json-typedef/typedef.js'
+import { JsonTypeDef } from '../Symbols.js'
+import type { TDiscriminatedUnion } from './DiscriminatedUnion.js'
+import type { TNullable } from './Nullable.js'
+import type { TUnionEnum } from './UnionEnum.js'
+
+export type ExtractKeysOfValueType<ObjectType, ValueType> = {
+	[P in keyof ObjectType]: ObjectType[P] extends ValueType ? P : never
+}[keyof ObjectType]
+
+export type PickByType<ObjectType, ValueType> = {
+	[P in keyof ObjectType as ExtractKeysOfValueType<
+		ObjectType,
+		ValueType
+	>]: ObjectType[P]
+}
+
+export function keysWithDefaults<T extends TObject>(schema: T) {
+	const keys: string[] = []
+
+	for (const [key, subschema] of Object.entries(schema.properties)) {
+		// skip if it's already optional
+		if (TypeGuard.IsOptional(subschema)) continue
+		if (isUndefined(subschema.default)) continue
+
+		keys.push(key)
+	}
+
+	return keys as Array<keyof Static<T>>
+}
+
+export function NoDefaults<T extends TObject>(
+	schema: T,
+	options: ObjectOptions = {}
+) {
+	const newSchema = CloneType(schema, options)
+	for (const key in newSchema.properties)
+		delete newSchema.properties[key]?.default
+
+	return newSchema
+}
+
+export function WithDefaults<T extends TObject>(
+	schema: T,
+	defaults: Partial<Static<T>>,
+	options: ObjectOptions = {}
+) {
+	const newSchema = CloneType(schema, options)
+
+	for (const key in defaults) {
+		newSchema.properties[key] ||= {} as any
+		newSchema.properties[key].default = defaults[key]
+	}
+
+	return newSchema
+}
+/** Resolves to `{const: 0}` in JSON schema, and falls back to uint8 for JSON TypeDef */
+
+export const LiteralZero = Type.Literal(0, {
+	default: 0,
+	[JsonTypeDef]: { schema: JtdType.Int8() }
+})
+// manually set to "integer" b/c Type.Literal defaults to "number"
+LiteralZero.type = 'integer'
+export type LiteralZero = 0
+/**
+ * A schema that resolves to a given type.
+ * @template T - The static type of the schema.
+ */
+
+export type TSchemaOf<T> = TSchema & { static: T }
+/**
+ * A schema that resolves to a type, which may be optional or nullable.
+ * @template T - The static type of the schema.
+ */
+
+export type TFuzzySchemaOf<T> =
+	| TSchemaOf<T>
+	| (TSchema & { static: T | undefined })
+	| (TSchema & { static: T | null })
+/**
+ * Assigns descriptions to the properties of an object schema.
+ * @param schema - The object schema.
+ * @param descriptions - The descriptions to be set on each property.
+ * @param override - Should non-empty descriptions be overwritten? (default: true)
+ * @returns The mutated object schema.
+ */
+
+export function setDescriptions<T extends TObject>(
+	schema: T,
+	descriptions: { [P in keyof Static<TObject>]?: string | undefined },
+	override = true
+) {
+	for (const property in descriptions) {
+		const description = descriptions[property]
+		if (!override && !isEmpty(schema.properties[property].description)) continue
+		if (typeof description !== 'string' && typeof description !== 'undefined')
+			continue
+		schema.properties[property].description = description
+	}
+
+	return schema
+}
+export type TFuzzyRef<T extends TSchema> = T | TRefUnsafe<T> | TRef<string>
+
+export type TFuzzyString = TFuzzyRef<
+	TString | TLiteral<string> | TUnionEnum<string[]>
+>
+export type TFuzzyObject<Props extends TProperties = TProperties> = TFuzzyRef<
+	| TObject<Props>
+	| (TDiscriminatedUnion<any, string> & {
+			static: Static<TObject<Props>>
+	  })
+>
+export type TFuzzyNumber = TFuzzyRef<
+	TNumber | TInteger | TLiteral<number> | TUnionEnum<number[]>
+>
+export type TFuzzyOptional<T extends TSchema> = T | TOptional<T>
+
+export type TFuzzyNull<T extends TSchema> = TFuzzyRef<T> | TNullable<T> | TNull

package/schema-source/scripts/const.ts

@@ -0,0 +1,55 @@
+import path from 'node:path'
+import { DATASWORN_SCHEMA_VERSION } from '@datasworn-community/core'
+
+const root = process.cwd()
+
+export const VERSION = DATASWORN_SCHEMA_VERSION
+
+export const PKG_NAME = 'Datasworn'
+export const SCHEMA_NAME = 'Datasworn'
+export const SOURCE_SCHEMA_NAME = 'DataswornSource'
+
+export const PKG_SCOPE_OFFICIAL = '@datasworn'
+export const PKG_SCOPE_COMMUNITY = '@datasworn-community'
+
+export const ROOT_OUTPUT = path.join(root, 'datasworn')
+export const ROOT_SOURCE_DATA = path.join(root, 'source_data')
+export const ROOT_HISTORY = path.join(root, 'packages/core/migration')
+export const DIR_HISTORY_CURRENT = path.join(ROOT_HISTORY, VERSION)
+export const ROOT_TYPES_OUT = path.join(root, 'packages/core/src')
+export const CORE_COMMON = path.join(root, 'packages/core/src')
+
+export const SCHEMA_PATH = path.join(
+	root,
+	'packages/core/json/datasworn.schema.json'
+)
+export const SOURCE_SCHEMA_PATH = path.join(
+	root,
+	'packages/core/json/datasworn-source.schema.json'
+)
+export const SOURCEDATA_SCHEMA_PATH = SOURCE_SCHEMA_PATH
+
+export const SCHEMA_DELVE_OUT = path.join(
+	ROOT_OUTPUT,
+	'datasworn-delve.schema.json'
+)
+export const SCHEMA_DELVE_IN = path.join(
+	ROOT_OUTPUT,
+	'datasworn-delve-source.schema.json'
+)
+
+export const SCHEMA_ID = 'https://ironswornrpg.com/datasworn.schema.json'
+export const SOURCE_SCHEMA_ID =
+	'https://ironswornrpg.com/datasworn-source.schema.json'
+export const DELVE_SCHEMA_ID =
+	'https://ironswornrpg.com/datasworn-delve.schema.json'
+export const DELVE_SOURCE_ID =
+	'https://ironswornrpg.com/datasworn-delve-source.schema.json'
+
+/** JSON schema draft used by Datasworn. */
+export const $schema = 'http://json-schema.org/draft-07/schema#' as const
+/** The standard key for definitions in the JSON schema draft. */
+export const DefsKey = 'definitions' as const
+
+/** Identifier for the type at the root of a Datasworn JSON file. */
+export const rootSchemaName = 'RulesPackage'