shinkansen-transmission 2.2.234 → 2.3.0

package/src/transmission/common/index.d.mts

@@ -1,123 +1,188 @@
-declare module '#transmission/transmission/common' {
-  type ObjectLiteralType = ZashikiTypes.ObjectLiteralType
-  type ObjectType = ZashikiTypes.ObjectType
-  type ArrayLiteralType = ZashikiTypes.ArrayLiteralType
-  type ArrayType = ZashikiTypes.ArrayType
+type ObjectLiteralType = TransmissionTypes.ObjectLiteralType
+type ObjectType = TransmissionTypes.ObjectType
+
+type ItemsType = TransmissionTypes.ItemsType
+
+type TransmissionStringMetaType = TransmissionTypes.Transmission.StringMetaType
+type TransmissionNumberMetaType = TransmissionTypes.Transmission.NumberMetaType
+type TransmissionArrayMetaType = TransmissionTypes.Transmission.ArrayMetaType
+type TransmissionObjectMetaType = TransmissionTypes.Transmission.ObjectMetaType
+type TransmissionBooleanMetaType = TransmissionTypes.Transmission.BooleanMetaType
+type TransmissionNullMetaType = TransmissionTypes.Transmission.NullMetaType
+
+type TransmissionStringElementsType = TransmissionTypes.Transmission.StringElementsType
+type TransmissionNumberElementsType = TransmissionTypes.Transmission.NumberElementsType
+type TransmissionArrayElementsType = TransmissionTypes.Transmission.ArrayElementsType
+type TransmissionObjectElementsType = TransmissionTypes.Transmission.ObjectElementsType
+type TransmissionBooleanElementsType = TransmissionTypes.Transmission.BooleanElementsType
+type TransmissionNullElementsType = TransmissionTypes.Transmission.NullElementsType
+
+type EnumType = TransmissionTypes.EnumType
+type OneOfType = TransmissionTypes.OneOfType
+type AnyOfType = TransmissionTypes.AnyOfType
+type FieldType = TransmissionTypes.FieldType
+
+type SchemaType = TransmissionTypes.SchemaType
 
-  type SchemaType = ZashikiTypes.SchemaType
+type StringSchemaType = TransmissionTypes.StringSchemaType
+type NumberSchemaType = TransmissionTypes.NumberSchemaType
+type ArraySchemaType = TransmissionTypes.ArraySchemaType
+type ObjectSchemaType = TransmissionTypes.ObjectSchemaType
+type BooleanSchemaType = TransmissionTypes.BooleanSchemaType
+type NullSchemaType = TransmissionTypes.NullSchemaType
 
-  export function isObject (v: unknown): boolean
-  export function isArray (v: unknown): boolean
-  export function isPrimitive (v: unknown): boolean
-  export function isSchema (v: SchemaType | undefined): boolean
-  export function isStringSchema (schema: SchemaType | undefined): boolean
-  export function isNumberSchema (schema: SchemaType | undefined): boolean
-  export function isArraySchema (schema: SchemaType | undefined): boolean
-  export function isObjectSchema (schema: SchemaType | undefined): boolean
-  export function isBooleanSchema (schema: SchemaType | undefined): boolean
-  export function isNullSchema (schema: SchemaType | undefined): boolean
+type ValuesType = TransmissionTypes.ValuesType
+type ParamsType = TransmissionTypes.ParamsType
 
-  export function getTitle (schema: SchemaType | undefined): { title: string } | ObjectLiteralType
-  export function getDescription (schema: SchemaType | undefined): { description: string } | ObjectLiteralType
-  export function getIsReadOnly (schema: SchemaType | undefined): { readOnly: boolean } | ObjectLiteralType
-  export function getIsWriteOnly (schema: SchemaType | undefined): { writeOnly: boolean } | ObjectLiteralType
+export function isObject (v?: unknown): v is (Record<PropertyKey, string | number | object | boolean | null | string[] | number[] | object[] | boolean[] | null[]> | Record<PropertyKey, never>)
+export function isArray (v?: unknown): v is (string[] | number[] | object[] | boolean[] | null[])
+export function isPrimitive (v?: unknown): v is string | number | boolean | null
 
-  export function getSelectedItems (values: ObjectType | ObjectLiteralType, uri: string | undefined): ArrayType
+export function isSchema (v?: SchemaType | object): v is SchemaType
+export function isStringSchema (schema?: SchemaType): schema is StringSchemaType
+export function isNumberSchema (schema?: SchemaType): schema is NumberSchemaType
+export function isArraySchema (schema?: SchemaType): schema is ArraySchemaType
+export function isObjectSchema (schema?: SchemaType): schema is ObjectSchemaType
+export function isBooleanSchema (schema?: SchemaType): schema is BooleanSchemaType
+export function isNullSchema (schema?: SchemaType): schema is NullSchemaType
 
-  export function isParentUri (parentUri: string | undefined, uri: string | undefined): boolean
+export function getTitle (schema?: SchemaType): { title: string } | ObjectLiteralType
+export function getDescription (schema?: SchemaType): { description: string } | ObjectLiteralType
+export function getIsReadOnly (schema?: SchemaType): { readOnly: boolean } | ObjectLiteralType
+export function getIsWriteOnly (schema?: SchemaType): { writeOnly: boolean } | ObjectLiteralType
 
-  export function getMetaProps (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType
-  export function getMetaDefaultValue (schema: SchemaType | undefined): { defaultValue: string } | ObjectLiteralType
-  export function hasMetaValue (values: ObjectType | ObjectLiteralType, uri: string | undefined, schema: SchemaType | undefined): boolean
-  export function getMetaValue (values: ObjectType | ObjectLiteralType, uri: string | undefined, schema: SchemaType | undefined): { value: string } | ObjectLiteralType
+export function getSelectedItems (values?: ValuesType, uri?: string): Array<string | number | boolean | null>
 
-  export function transformValue (schema: SchemaType | undefined): SchemaType | ObjectType | ObjectLiteralType | ArrayType | ArrayLiteralType | undefined
+export function isParentUri (parentUri?: string, uri?: string): boolean
 
-  export function findByKey (parentUri: string | undefined, uri: string | undefined): (key: string) => boolean
-  export function findByIndex (parentUri: string | undefined, uri: string | undefined): (schema: SchemaType, index: number) => boolean
-  export function findByValue (value: unknown): (schema: SchemaType) => boolean
-  export function findByEqual (value: unknown): (schema: SchemaType) => boolean
+export function getMetaProps (params?: ParamsType, uri?: string): TransmissionStringMetaType | TransmissionNumberMetaType | TransmissionArrayMetaType | TransmissionObjectMetaType | TransmissionBooleanMetaType | TransmissionNullMetaType | Record<string, never>
+export function hasMetaDefaultValue (schema?: SchemaType): boolean
+export function getMetaDefaultValue (schema?: SchemaType): { defaultValue: string } | ObjectLiteralType
+export function hasMetaValue (values?: ValuesType, uri?: string, schema?: SchemaType): boolean
+export function getMetaValue (values?: ValuesType, uri?: string, schema?: SchemaType): { value: string } | ObjectLiteralType
 
-  export function toString (value: unknown): string
+export function transformToValue (schema?: string | number | object | boolean | null): string | number | object | boolean | null | undefined
 
-  export function getObject (value: { properties: ObjectType /* object */ }, parentUri: string | undefined, uri: string | undefined): ObjectType
-  export function getArray (value: { items: ObjectType | ObjectLiteralType | ArrayType | ArrayLiteralType /* object or array */ }, parentUri: string | undefined, uri: string | undefined): ArrayType
-  export function getSchema (schema: SchemaType | ObjectType, parentUri: string | undefined, uri: string | undefined): ObjectType | ObjectLiteralType | ArrayType | ArrayLiteralType | SchemaType
+export function findByUri (parentUri: string, uri: string): (key: string | number) => boolean
+export function findByValue (value?: string | number | object | boolean | null): (item?: string | number | object | boolean | null | string[] | number[] | object[] | boolean[] | null[]) => boolean
+export function findByEqual (value?: string | number | object | boolean | null): (item?: string | number | object | boolean | null | string[] | number[] | object[] | boolean[] | null[]) => boolean
 
-  export function transformValueIndexFor (array: ArrayType, value: unknown): string
-  export function transformEqualIndexFor (array: ArrayType, value: unknown): string
+export function toString (value?: string | number | object | boolean | null): string
 
-  export function hasValue (values: ObjectType | ObjectLiteralType, uri: string | undefined, schema: SchemaType | undefined): boolean
-  export function getValue (values: ObjectType | ObjectLiteralType, uri: string | undefined, schema: SchemaType | undefined): string
+export function getArray (schema?: { items?: SchemaType | SchemaType[] }, parentUri?: string, uri?: string): SchemaType | undefined
+export function getObject (schema?: { properties?: Record<string, SchemaType> }, parentUri?: string, uri?: string): SchemaType | undefined
 
-  export function getValueForEnum (v: string | number, schema: SchemaType): string
-  export function getIndexForEnum (values: ObjectType | ObjectLiteralType, parentUri: string | undefined, uri: string | undefined, schema: SchemaType | undefined): number
+declare function getSchema (
+  schema: (
+    StringSchemaType |
+    NumberSchemaType |
+    ArraySchemaType |
+    ObjectSchemaType |
+    BooleanSchemaType |
+    NullSchemaType
+  ),
+  parentUri?: string,
+  uri?: string
+): SchemaType | undefined
 
-  export function getValueForAnyOf (v: string | number, schema: SchemaType): string
-  export function getIndexForAnyOf (values: ObjectType | ObjectLiteralType, parentUri: string | undefined, uri: string | undefined, schema: SchemaType | undefined): number
+declare function getSchema (
+  schema?: ObjectLiteralType | ObjectType,
+  parentUri?: string,
+  uri?: string
+): SchemaType | undefined
 
-  export function getValueForOneOf (v: string | number, schema: SchemaType): string
-  export function getIndexForOneOf (values: ObjectType | ObjectLiteralType, parentUri: string | undefined, uri: string | undefined, schema: SchemaType | undefined): number
+export { getSchema }
 
-  export function getElementsProps (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType | ObjectLiteralType
-  export function getElementsTitleProps (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType | ObjectLiteralType
-  export function getElementsDescriptionProps (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType | ObjectLiteralType
+export function transformValueIndexFor (array: string[] | number[] | object[] | boolean[] | null[], value?: string | number | object | boolean | null): string
+export function transformEqualIndexFor (array: string[] | number[] | object[] | boolean[] | null[], value?: string | number | object | boolean | null): string
 
-  export function getElementsFieldPropsForEnum (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType | ObjectLiteralType
-  export function getElementsFieldPropsForOneOf (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType | ObjectLiteralType
-  export function getElementsFieldPropsForAnyOf (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType | ObjectLiteralType
-  export function getElementsFieldPropsForAllOf (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType | ObjectLiteralType
+export function hasValue (values?: ValuesType, uri?: string, schema?: SchemaType): boolean
+export function getValue (values?: ValuesType, uri?: string, schema?: SchemaType): string
 
-  export function getElementsFieldProps (params: ObjectType | ObjectLiteralType, uri: string | undefined): ObjectType | ObjectLiteralType
-  export function getElementsFieldValue (values: ObjectType | ObjectLiteralType, uri: string | undefined, schema: SchemaType | undefined): { value: string } | ObjectLiteralType
+export function getValueForEnum (v: string | number, schema?: { enum?: ItemsType }): string
+export function getIndexForEnum (values?: ValuesType, parentUri?: string, uri?: string, schema?: SchemaType): number
 
-  export function hasEnum (schema: SchemaType | undefined): boolean
-  export function getEnum (schema: SchemaType | undefined): ObjectType | ObjectLiteralType | ArrayType | ArrayLiteralType
+export function getValueForAnyOf (v: string | number, schema?: { anyOf?: ItemsType }): string
+export function getIndexForAnyOf (values?: ValuesType, parentUri?: string, uri?: string, schema?: SchemaType): number
 
-  export function hasConst (schema: SchemaType | undefined): boolean
-  export function getConst (schema: SchemaType | undefined): unknown
+export function getValueForOneOf (v: string | number, schema?: { oneOf?: ItemsType }): string
+export function getIndexForOneOf (values: ValuesType, parentUri?: string, uri?: string, schema?: SchemaType): number
 
-  export function hasDefault (schema: SchemaType | undefined): boolean
-  export function getDefault (schema: SchemaType | undefined): unknown
+export function getElementsProps (params?: ParamsType, uri?: string): TransmissionStringElementsType | TransmissionNumberElementsType | TransmissionArrayElementsType | TransmissionObjectElementsType | TransmissionBooleanElementsType | TransmissionNullElementsType | Record<string, never>
 
-  export function hasAnyOf (schema: SchemaType | undefined): boolean
-  export function getAnyOf (schema: SchemaType | undefined): ObjectType | ObjectLiteralType | ArrayType | ArrayLiteralType
+export function getElementsFieldPropsForEnum (params?: ParamsType, uri?: string): EnumType | ObjectLiteralType
+export function getElementsFieldPropsForOneOf (params?: ParamsType, uri?: string): OneOfType | ObjectLiteralType
+export function getElementsFieldPropsForAnyOf (params?: ParamsType, uri?: string): AnyOfType | ObjectLiteralType
+export function getElementsFieldPropsForAllOf (params?: ParamsType, uri?: string): FieldType | ObjectLiteralType
+export function getElementsFieldProps (params?: ParamsType, uri?: string): FieldType | ObjectLiteralType
+export function getElementsFieldValue (values?: ValuesType, uri?: string, schema?: SchemaType): { value: string } | ObjectLiteralType
 
-  export function hasOneOf (schema: SchemaType | undefined): boolean
-  export function getOneOf (schema: SchemaType | undefined): ObjectType | ObjectLiteralType | ArrayType | ArrayLiteralType
+export function hasEnum (schema?: { enum?: ItemsType }): schema is { enum: ItemsType }
 
-  export function hasAllOf (schema: SchemaType | undefined): boolean
-  export function getAllOf (schema: SchemaType | undefined): ObjectType | ObjectLiteralType | ArrayType | ArrayLiteralType
+declare function getEnum (schema: { enum: ItemsType }): ItemsType
+declare function getEnum (schema?: { enum?: ItemsType }): ItemsType | undefined
 
-  export function getUri (uri: string | undefined, resource: string | undefined): string
+export { getEnum }
 
-  export function normaliseUri (uri: string | undefined): string
+export function hasConst (schema?: { const?: string | number | object | boolean | null }): schema is { const: string | number | object | boolean | null }
 
-  export function getMin (schema: SchemaType | undefined): { min: number } | ObjectLiteralType
-  export function getMax (schema: SchemaType | undefined): { max: number } | ObjectLiteralType
+declare function getConst (schema: { const: string | number | object | boolean | null }): string | number | object | boolean | null
+declare function getConst (schema?: { const?: string | number | object | boolean | null }): string | number | object | boolean | null | undefined
 
-  export function getMinLength (schema: SchemaType | undefined): { minLength: number } | ObjectLiteralType
-  export function getMaxLength (schema: SchemaType | undefined): { maxLength: number } | ObjectLiteralType
+export { getConst }
 
-  export function getMinItems (schema: SchemaType | undefined): { minItems: number } | ObjectLiteralType
-  export function getMaxItems (schema: SchemaType | undefined): { maxItems: number } | ObjectLiteralType
+export function hasDefault (schema?: { default?: string | number | object | boolean | null }): schema is { default: string | number | object | boolean | null }
 
-  export function getHasUniqueItems (schema: SchemaType | undefined): { hasUniqueItems: boolean } | ObjectLiteralType
+declare function getDefault (schema: { default: string | number | object | boolean | null }): string | number | object | boolean | null
+declare function getDefault (schema?: { default?: string | number | object | boolean | null }): string | number | object | boolean | null | undefined
 
-  export function getMinContains (schema: SchemaType | undefined): { minContains: number } | ObjectLiteralType
-  export function getMaxContains (schema: SchemaType | undefined): { maxContains: number } | ObjectLiteralType
+export { getDefault }
 
-  export function getMinProperties (schema: SchemaType | undefined): { minProperties: number } | ObjectLiteralType
-  export function getMaxProperties (schema: SchemaType | undefined): { maxProperties: number } | ObjectLiteralType
+export function hasAnyOf (schema?: { anyOf?: ItemsType }): schema is { anyOf: ItemsType }
 
-  export function getIsExclusiveMin (schema: SchemaType | undefined): { isExclusiveMin: boolean } | ObjectLiteralType
-  export function getIsExclusiveMax (schema: SchemaType | undefined): { isExclusiveMax: boolean } | ObjectLiteralType
+declare function getAnyOf (schema: { anyOf: ItemsType }): ItemsType
+declare function getAnyOf (schema?: { anyOf?: ItemsType }): ItemsType | undefined
 
-  export function getPattern (schema: SchemaType | undefined): { pattern: string } | ObjectLiteralType
+export { getAnyOf }
 
-  export function getStep (schema: SchemaType | undefined): { step: number } | ObjectLiteralType
-}
+export function hasOneOf (schema?: { oneOf?: ItemsType }): schema is { oneOf: ItemsType }
 
-declare module 'shinkansen-transmission/transmission/common' {
-  export * from '#transmission/transmission/common'
-}
+declare function getOneOf (schema: { oneOf: ItemsType }): ItemsType
+declare function getOneOf (schema?: { oneOf?: ItemsType }): ItemsType | undefined
+
+export { getOneOf }
+
+export function hasAllOf (schema?: { allOf?: ItemsType }): schema is { allOf: ItemsType }
+
+declare function getAllOf (schema: { allOf: ItemsType }): ItemsType
+declare function getAllOf (schema?: { allOf?: ItemsType }): ItemsType | undefined
+
+export { getAllOf }
+
+export function getUri (uri?: string, resource?: string | number): string
+
+export function normaliseUri (uri?: string): string
+
+export function getMin (schema?: { minimum?: number }): { min: number } | ObjectLiteralType
+export function getMax (schema?: { maximum?: number }): { max: number } | ObjectLiteralType
+
+export function getMinLength (schema?: { minLength?: number }): { minLength: number } | ObjectLiteralType
+export function getMaxLength (schema?: { maxLength?: number }): { maxLength: number } | ObjectLiteralType
+
+export function getMinItems (schema?: { minItems?: number }): { minItems: number } | ObjectLiteralType
+export function getMaxItems (schema?: { maxItems?: number }): { maxItems: number } | ObjectLiteralType
+
+export function getHasUniqueItems (schema?: { uniqueItems?: boolean }): { hasUniqueItems: boolean } | ObjectLiteralType
+
+export function getMinContains (schema?: { minContains?: number }): { minContains: number } | ObjectLiteralType
+export function getMaxContains (schema?: { maxContains?: number }): { maxContains: number } | ObjectLiteralType
+
+export function getMinProperties (schema?: { minProperties?: number }): { minProperties: number } | ObjectLiteralType
+export function getMaxProperties (schema?: { maxProperties?: number }): { maxProperties: number } | ObjectLiteralType
+
+export function getIsExclusiveMin (schema?: { exclusiveMinimum?: boolean }): { isExclusiveMin: boolean } | ObjectLiteralType
+export function getIsExclusiveMax (schema?: { exclusiveMaximum?: boolean }): { isExclusiveMax: boolean } | ObjectLiteralType
+
+export function getPattern (schema?: { pattern?: RegExp }): { pattern: RegExp } | ObjectLiteralType
+
+export function getStep (schema?: { multipleOf?: number }): { step: number } | ObjectLiteralType