@aws-amplify/data-schema 1.25.5 → 1.26.0

package/dist/esm/ClientSchema/Core/ClientModel.d.ts

@@ -9,7 +9,7 @@ import type { EnumType } from '../../EnumType';
 import type { CustomType, CustomTypeParamShape } from '../../CustomType';
 import type { RefType } from '../../RefType';
 import type { StringFilter, NumericFilter, ModelPrimaryCompositeKeyInput, PrimaryIndexIrShape, SecondaryIndexIrShape, KindaPretty } from '../../util';
-export interface ClientModel<Bag extends Record<string, unknown>, Metadata extends SchemaMetadata<any>, IsRDS extends boolean, T extends ModelTypeParamShape, K extends keyof Bag & string> extends ClientSchemaProperty {
+export interface ClientModel<Bag extends Record<string, unknown>, Metadata extends SchemaMetadata<any, any>, IsRDS extends boolean, T extends ModelTypeParamShape, K extends keyof Bag & string> extends ClientSchemaProperty {
     __entityType: 'model';
     type: KindaPretty<ClientFields<Bag, Metadata, IsRDS, T>>;
     createType: Prettify<CreateModelInput<ClientModel<Bag, Metadata, IsRDS, T, K>>>;
@@ -43,8 +43,8 @@ export interface ClientModel<Bag extends Record<string, unknown>, Metadata exten
 type DisabledOpsToMap<Ops extends ReadonlyArray<DisableOperationsOptions>> = {
     [Op in Ops[number] as Op extends 'queries' ? 'list' | 'get' | 'observeQuery' : Op extends 'mutations' ? 'create' | 'update' | 'delete' : Op extends 'subscriptions' ? 'onCreate' | 'onUpdate' | 'onDelete' | 'observeQuery' : Op extends 'list' ? 'list' | 'observeQuery' : Op]: true;
 };
-type ClientFields<Bag extends Record<string, unknown>, Metadata extends SchemaMetadata<any>, IsRDS extends boolean, T extends ModelTypeParamShape> = ResolveFields<Bag, T['fields']> & If<Not<IsRDS>, ImplicitIdentifier<T>> & AuthFields<Metadata, T> & Omit<SystemFields<IsRDS>, keyof ResolveFields<Bag, T['fields']>>;
-type FlatClientFields<Bag extends Record<string, unknown>, Metadata extends SchemaMetadata<any>, IsRDS extends boolean, T extends ModelTypeParamShape, ModelName extends keyof Bag & string> = FlatResolveFields<Bag, T['fields'], ModelName> & If<Not<IsRDS>, ImplicitIdentifier<T>> & AuthFields<Metadata, T> & Omit<SystemFields<IsRDS>, keyof ResolveFields<Bag, T['fields']>>;
+type ClientFields<Bag extends Record<string, unknown>, Metadata extends SchemaMetadata<any, any>, IsRDS extends boolean, T extends ModelTypeParamShape> = ResolveFields<Bag, T['fields']> & If<Not<IsRDS>, ImplicitIdentifier<T>> & AuthFields<Metadata, T> & Omit<SystemFields<IsRDS>, keyof ResolveFields<Bag, T['fields']>>;
+type FlatClientFields<Bag extends Record<string, unknown>, Metadata extends SchemaMetadata<any, any>, IsRDS extends boolean, T extends ModelTypeParamShape, ModelName extends keyof Bag & string> = FlatResolveFields<Bag, T['fields'], ModelName, Metadata['selectionSetDepth']> & If<Not<IsRDS>, ImplicitIdentifier<T>> & AuthFields<Metadata, T> & Omit<SystemFields<IsRDS>, keyof ResolveFields<Bag, T['fields']>>;
 type SystemFields<IsRDS extends boolean> = IsRDS extends false ? {
     readonly createdAt: string;
     readonly updatedAt: string;
@@ -71,7 +71,7 @@ type Not<T extends boolean> = T extends true ? false : true;
  *
  */
 export type ListOptionsPkParams<Bag extends Record<string, unknown>, T extends ModelTypeParamShape> = T['identifier']['sk'] extends never ? unknown : Prettify<Partial<IndexQueryInput<Bag, T['identifier']>>>;
-type AuthFields<SchemaMeta extends SchemaMetadata<any>, Model extends ModelTypeParamShape> = (Model['authorization'][number] extends never ? SchemaMeta['authFields'] extends never ? object : SchemaMeta['authFields'] : ImpliedAuthFields<Model['authorization'][number]> extends never ? object : ImpliedAuthFields<Model['authorization'][number]>) & ImpliedAuthFieldsFromFields<Model>;
+type AuthFields<SchemaMeta extends SchemaMetadata<any, any>, Model extends ModelTypeParamShape> = (Model['authorization'][number] extends never ? SchemaMeta['authFields'] extends never ? object : SchemaMeta['authFields'] : ImpliedAuthFields<Model['authorization'][number]> extends never ? object : ImpliedAuthFields<Model['authorization'][number]>) & ImpliedAuthFieldsFromFields<Model>;
 type ImpliedAuthFieldsFromFields<T> = UnionToIntersection<T extends ModelTypeParamShape ? T['fields'][keyof T['fields']] extends ModelField<any, any, infer Auth> | ModelRelationshipField<any, any, any, infer Auth> | RefType<any, any, infer Auth> ? Auth extends Authorization<any, any, any> ? ImpliedAuthFields<Auth> : object : object : object>;
 type NestedTypes<Bag extends Record<string, unknown>, T extends ModelTypeParamShape> = {
     [K in keyof T['fields'] as T['fields'][K] extends EnumType | CustomType<CustomTypeParamShape> ? K : never]: K extends keyof Bag ? {

package/dist/esm/ClientSchema/index.d.ts

@@ -1,23 +1,24 @@
 import type { __modelMeta__ } from '../runtime/client';
-import type { BaseSchema, ConversationType, CustomOperation, CustomType, EnumType, GenericModelSchema, ModelSchemaContents, ModelType } from '../ModelSchema';
+import type { BaseSchema, ClientSchemaOptions, ConversationType, CustomOperation, CustomType, EnumType, GenericModelSchema, ModelSchemaContents, ModelType } from '../ModelSchema';
 import type { ClientCustomOperation, ClientCustomType, ClientEnum, ClientModel } from './Core';
 import type { CombinedModelSchema, CombinedSchemaIndexesUnion } from '../CombineSchema';
 import type { SchemaMetadata } from './utilities/SchemaMetadata';
 import type { Brand, Select, SpreadTuple } from '../util';
 import { ClientConversation } from './ai/ClientConversation';
-export type ClientSchema<Schema extends GenericModelSchema<any> | CombinedModelSchema<any>> = Schema extends GenericModelSchema<any> ? InternalClientSchema<Schema> : Schema extends CombinedModelSchema<any> ? InternalCombinedSchema<Schema> : never;
-type InternalClientSchema<CustomerSchema extends ModelSchemaContents | BaseSchema<any, any>, Metadata extends SchemaMetadata<any> = never, IsRDS extends boolean = never> = CustomerSchema extends ModelSchemaContents ? {
+export type { ClientSchemaOptions } from '../ModelSchema';
+export type ClientSchema<Schema extends GenericModelSchema<any> | CombinedModelSchema<any>, Options extends ClientSchemaOptions = ClientSchemaOptions> = Schema extends GenericModelSchema<any> ? InternalClientSchema<Schema, Options> : Schema extends CombinedModelSchema<any> ? InternalCombinedSchema<Schema, Options> : never;
+type InternalClientSchema<CustomerSchema extends ModelSchemaContents | BaseSchema<any, any>, Options extends ClientSchemaOptions = ClientSchemaOptions, Metadata extends SchemaMetadata<any, any> = never, IsRDS extends boolean = never> = CustomerSchema extends ModelSchemaContents ? {
     [K in keyof CustomerSchema as K extends string ? K : never]: K extends string ? ClientSchemaProperty<CustomerSchema, Metadata, IsRDS, K> : never;
-} : CustomerSchema extends BaseSchema<any, any> ? InternalClientSchema<CustomerSchema['data']['types'], SchemaMetadata<CustomerSchema>, CustomerSchema extends Brand<'RDSSchema'> ? true : false> : never;
-type ClientSchemaProperty<T extends ModelSchemaContents, Metadata extends SchemaMetadata<any>, IsRDS extends boolean, K extends keyof T & string> = T[K] extends Brand<'enum'> ? RemapEnum<T, T[K]> : T[K] extends Brand<'customType'> ? RemapCustomType<T, Metadata, IsRDS, T[K]> : T[K] extends Brand<'queryCustomOperation' | 'mutationCustomOperation' | 'subscriptionCustomOperation' | 'generationCustomOperation'> ? RemapCustomOperation<T, Metadata, IsRDS, T[K]> : T[K] extends Brand<'modelType'> ? RemapModel<T, Metadata, IsRDS, T[K], K> : T[K] extends Brand<'conversationCustomOperation'> ? RemapAIRoute<T, T[K]> : never;
+} : CustomerSchema extends BaseSchema<any, any> ? InternalClientSchema<CustomerSchema['data']['types'], Options, SchemaMetadata<CustomerSchema, Options>, CustomerSchema extends Brand<'RDSSchema'> ? true : false> : never;
+type ClientSchemaProperty<T extends ModelSchemaContents, Metadata extends SchemaMetadata<any, any>, IsRDS extends boolean, K extends keyof T & string> = T[K] extends Brand<'enum'> ? RemapEnum<T, T[K]> : T[K] extends Brand<'customType'> ? RemapCustomType<T, Metadata, IsRDS, T[K]> : T[K] extends Brand<'queryCustomOperation' | 'mutationCustomOperation' | 'subscriptionCustomOperation' | 'generationCustomOperation'> ? RemapCustomOperation<T, Metadata, IsRDS, T[K]> : T[K] extends Brand<'modelType'> ? RemapModel<T, Metadata, IsRDS, T[K], K> : T[K] extends Brand<'conversationCustomOperation'> ? RemapAIRoute<T, T[K]> : never;
 type RemapEnum<_T extends ModelSchemaContents, E> = E extends EnumType<infer values> ? ClientEnum<values> : never;
-type RemapCustomType<T extends ModelSchemaContents, Metadata extends SchemaMetadata<any>, IsRDS extends boolean, E> = E extends CustomType<infer CT> ? ClientCustomType<InternalClientSchema<T, Metadata, IsRDS>, CT> : never;
-type RemapCustomOperation<T extends ModelSchemaContents, Metadata extends SchemaMetadata<any>, IsRDS extends boolean, E> = E extends CustomOperation<infer CO, any> ? ClientCustomOperation<InternalClientSchema<T, Metadata, IsRDS>, CO> : never;
-type RemapModel<T extends ModelSchemaContents, Metadata extends SchemaMetadata<any>, IsRDS extends boolean, E, K extends keyof T & string> = E extends ModelType<infer MT, any> ? ClientModel<InternalClientSchema<T, Metadata, IsRDS>, Metadata, IsRDS, MT, K> : never;
+type RemapCustomType<T extends ModelSchemaContents, Metadata extends SchemaMetadata<any, any>, IsRDS extends boolean, E> = E extends CustomType<infer CT> ? ClientCustomType<InternalClientSchema<T, ClientSchemaOptions, Metadata, IsRDS>, CT> : never;
+type RemapCustomOperation<T extends ModelSchemaContents, Metadata extends SchemaMetadata<any, any>, IsRDS extends boolean, E> = E extends CustomOperation<infer CO, any> ? ClientCustomOperation<InternalClientSchema<T, ClientSchemaOptions, Metadata, IsRDS>, CO> : never;
+type RemapModel<T extends ModelSchemaContents, Metadata extends SchemaMetadata<any, any>, IsRDS extends boolean, E, K extends keyof T & string> = E extends ModelType<infer MT, any> ? ClientModel<InternalClientSchema<T, ClientSchemaOptions, Metadata, IsRDS>, Metadata, IsRDS, MT, K> : never;
 type RemapAIRoute<_T extends ModelSchemaContents, E> = E extends ConversationType ? ClientConversation : never;
-type GetInternalClientSchema<Schema> = Schema extends GenericModelSchema<any> ? InternalClientSchema<Schema> : never;
-type CombinedClientSchemas<Schemas extends CombinedModelSchema<any>['schemas']> = {
-    [Index in keyof Schemas]: Index extends CombinedSchemaIndexesUnion ? GetInternalClientSchema<Schemas[Index]> : never;
+type GetInternalClientSchema<Schema, Options extends ClientSchemaOptions = ClientSchemaOptions> = Schema extends GenericModelSchema<any> ? InternalClientSchema<Schema, Options> : never;
+type CombinedClientSchemas<Schemas extends CombinedModelSchema<any>['schemas'], Options extends ClientSchemaOptions = ClientSchemaOptions> = {
+    [Index in keyof Schemas]: Index extends CombinedSchemaIndexesUnion ? GetInternalClientSchema<Schemas[Index], Options> : never;
 };
 /**
  * Types for unwrapping and combining generic type args into client-consumable types
@@ -27,7 +28,7 @@ type CombinedClientSchemas<Schemas extends CombinedModelSchema<any>['schemas']>
  *
  * @internal @typeParam ClientSchemas - The tuple of client schemas to combine
  */
-type InternalCombinedSchema<Combined extends CombinedModelSchema<any>, ClientSchemas extends [...any] = CombinedClientSchemas<Combined['schemas']>> = SpreadTuple<{
+type InternalCombinedSchema<Combined extends CombinedModelSchema<any>, Options extends ClientSchemaOptions = ClientSchemaOptions, ClientSchemas extends [...any] = CombinedClientSchemas<Combined['schemas'], Options>> = SpreadTuple<{
     [I in keyof ClientSchemas]: I extends CombinedSchemaIndexesUnion ? Omit<ClientSchemas[I], typeof __modelMeta__> : never;
 }>;
 export type ClientSchemaByEntityTypeBaseShape = {
@@ -66,4 +67,3 @@ export type ClientSchemaByEntityType<T> = {
         __entityType: 'customGeneration';
     }>;
 };
-export {};

package/dist/esm/ClientSchema/utilities/ResolveField.d.ts

@@ -5,6 +5,7 @@ import { CustomType } from '../../CustomType';
 import { RefType, RefTypeParamShape } from '../../RefType';
 import { ResolveRef } from './ResolveRef';
 import { LazyLoader } from '../../runtime';
+import type { DefaultSelectionSetDepth } from '../../ModelSchema';
 import type { ModelTypeParamShape } from '../../ModelType';
 type ExtendsNever<T> = [T] extends [never] ? true : false;
 /**
@@ -21,13 +22,13 @@ export type ResolveFields<Bag extends Record<string, any>, T> = ShallowPretty<{
 } & {
     [K in keyof T as IsRequired<T[K]> extends true ? never : K]+?: ResolveIndividualField<Bag, T[K]>;
 }>;
-export type FlatResolveFields<Bag extends Record<string, any>, T, FlatModelName extends keyof Bag & string = never> = ShallowPretty<{
-    [K in keyof T]: ResolveIndividualField<Bag, T[K], FlatModelName>;
+export type FlatResolveFields<Bag extends Record<string, any>, T, FlatModelName extends keyof Bag & string = never, Depth extends number = DefaultSelectionSetDepth> = ShallowPretty<{
+    [K in keyof T]: ResolveIndividualField<Bag, T[K], FlatModelName, Depth>;
 }>;
 type ShallowPretty<T> = {
     [K in keyof T]: T[K];
 };
-export type ResolveIndividualField<Bag extends Record<string, any>, T, FlatModelName extends keyof Bag & string = never> = T extends BaseModelField<infer FieldShape> ? FieldShape : T extends RefType<infer RefShape, any, any> ? ResolveRef<RefShape, Bag> : T extends ModelRelationshipField<infer RelationshipShape, any, any, any> ? ResolveRelationship<Bag, RelationshipShape, FlatModelName> : T extends CustomType<infer CT> ? ResolveFields<Bag, CT['fields']> | null : T extends EnumType<infer values> ? values[number] | null : never;
+export type ResolveIndividualField<Bag extends Record<string, any>, T, FlatModelName extends keyof Bag & string = never, Depth extends number = DefaultSelectionSetDepth> = T extends BaseModelField<infer FieldShape> ? FieldShape : T extends RefType<infer RefShape, any, any> ? ResolveRef<RefShape, Bag> : T extends ModelRelationshipField<infer RelationshipShape, any, any, any> ? ResolveRelationship<Bag, RelationshipShape, FlatModelName, Depth> : T extends CustomType<infer CT> ? ResolveFields<Bag, CT['fields']> | null : T extends EnumType<infer values> ? values[number] | null : never;
 /**
  * This mapped type eliminates redundant recursive types when
  * generating the ['__meta']['flatModel'] type that serves as the
@@ -56,7 +57,24 @@ export type ResolveIndividualField<Bag extends Record<string, any>, T, FlatModel
 type ShortCircuitBiDirectionalRelationship<Model extends Record<string, any>, ParentModelName extends string, Raw extends ModelTypeParamShape['fields']> = {
     [Field in keyof Model as Field extends keyof Raw ? Raw[Field] extends ModelRelationshipField<infer RelationshipShape, any, any, any> ? RelationshipShape['relationshipType'] extends 'belongsTo' ? RelationshipShape['relatedModel'] extends ParentModelName ? never : Field : Field : Field : Field]: Model[Field];
 };
-type ResolveRelationship<Bag extends Record<string, any>, RelationshipShape extends ModelRelationshipFieldParamShape, ParentModelName extends keyof Bag & string = never> = ExtendsNever<ParentModelName> extends true ? DependentLazyLoaderOpIsAvailable<Bag, RelationshipShape> extends true ? LazyLoader<RelationshipShape['valueRequired'] extends true ? Bag[RelationshipShape['relatedModel']]['type'] : Bag[RelationshipShape['relatedModel']]['type'] | null, RelationshipShape['array']> : never : RelationshipShape['array'] extends true ? Array<ShortCircuitBiDirectionalRelationship<Bag[RelationshipShape['relatedModel']]['__meta']['flatModel'], ParentModelName, Bag[RelationshipShape['relatedModel']]['__meta']['rawType']['fields']>> : ShortCircuitBiDirectionalRelationship<Bag[RelationshipShape['relatedModel']]['__meta']['flatModel'], ParentModelName, Bag[RelationshipShape['relatedModel']]['__meta']['rawType']['fields']>;
+/** Subtract 1 from a depth counter, bounded at 0. Outside 0–5 falls through to 0. */
+type Decrement<N extends number> = N extends 5 ? 4 : N extends 4 ? 3 : N extends 3 ? 2 : N extends 2 ? 1 : N extends 1 ? 0 : 0;
+/**
+ * Replaces each relationship field on the inlined related-model `type` with the
+ * related model's `type` recursively flattened, decrementing `Depth` per hop.
+ * At `Depth=0`, strips relationships entirely so ModelPathInner can't recurse
+ * into a LazyLoader leaf and the cascade terminates.
+ */
+type FlattenRelationships<Bag extends Record<string, any>, Model extends Record<string, any>, RawFields extends Record<string, any>, Depth extends number = DefaultSelectionSetDepth> = Depth extends 0 ? OmitRelationships<Model, RawFields> : {
+    [K in keyof Model]: K extends keyof RawFields ? RawFields[K] extends ModelRelationshipField<infer RS, any, any, any> ? RS['array'] extends true ? Array<FlattenRelationships<Bag, Bag[RS['relatedModel']]['type'], Bag[RS['relatedModel']]['__meta']['rawType']['fields'], Decrement<Depth>>> : FlattenRelationships<Bag, Bag[RS['relatedModel']]['type'], Bag[RS['relatedModel']]['__meta']['rawType']['fields'], Decrement<Depth>> : Model[K] : Model[K];
+};
+/** Terminal case at the depth boundary: drop relationships entirely. */
+type OmitRelationships<Model extends Record<string, any>, RawFields extends Record<string, any>> = {
+    [K in keyof Model as K extends keyof RawFields ? RawFields[K] extends ModelRelationshipField<any, any, any, any> ? never : K : K]: Model[K];
+};
+/** Shared `LazyLoader` shape used by the non-flat branch and the depth=0 short-circuit. */
+type LazyLoaderForRelationship<Bag extends Record<string, any>, RelationshipShape extends ModelRelationshipFieldParamShape> = DependentLazyLoaderOpIsAvailable<Bag, RelationshipShape> extends true ? LazyLoader<RelationshipShape['valueRequired'] extends true ? Bag[RelationshipShape['relatedModel']]['type'] : Bag[RelationshipShape['relatedModel']]['type'] | null, RelationshipShape['array']> : never;
+type ResolveRelationship<Bag extends Record<string, any>, RelationshipShape extends ModelRelationshipFieldParamShape, ParentModelName extends keyof Bag & string = never, Depth extends number = DefaultSelectionSetDepth> = ExtendsNever<ParentModelName> extends true ? LazyLoaderForRelationship<Bag, RelationshipShape> : Depth extends 0 ? LazyLoaderForRelationship<Bag, RelationshipShape> : RelationshipShape['array'] extends true ? Array<ShortCircuitBiDirectionalRelationship<FlattenRelationships<Bag, Bag[RelationshipShape['relatedModel']]['type'], Bag[RelationshipShape['relatedModel']]['__meta']['rawType']['fields'], Decrement<Depth>>, ParentModelName, Bag[RelationshipShape['relatedModel']]['__meta']['rawType']['fields']>> : ShortCircuitBiDirectionalRelationship<FlattenRelationships<Bag, Bag[RelationshipShape['relatedModel']]['type'], Bag[RelationshipShape['relatedModel']]['__meta']['rawType']['fields'], Decrement<Depth>>, ParentModelName, Bag[RelationshipShape['relatedModel']]['__meta']['rawType']['fields']>;
 type DependentLazyLoaderOpIsAvailable<Bag extends Record<string, any>, RelationshipShape extends ModelRelationshipFieldParamShape> = RelationshipShape['relationshipType'] extends 'hasOne' | 'hasMany' ? 'list' extends keyof Bag[RelationshipShape['relatedModel']]['__meta']['disabledOperations'] ? false : true : 'get' extends keyof Bag[RelationshipShape['relatedModel']]['__meta']['disabledOperations'] ? false : true;
 type IsRequired<T> = T extends BaseModelField<infer FieldShape> ? null extends FieldShape ? false : true : T extends RefType<infer RefShape, any, any> ? IsRefRequired<RefShape> : T extends ModelRelationshipField<any, any, any, any> ? true : T extends CustomType<any> | EnumType<any> ? false : never;
 type IsRefRequired<T extends RefTypeParamShape> = T['array'] extends true ? T['arrayRequired'] : T['valueRequired'];

package/dist/esm/ClientSchema/utilities/SchemaMetadata.d.ts

@@ -1,7 +1,8 @@
-import { ImpliedAuthFields } from '../../Authorization';
-import { BaseSchema } from '../../ModelSchema';
-export interface SchemaMetadata<Schema extends BaseSchema<any, any>> {
+import type { ImpliedAuthFields } from '../../Authorization';
+import type { BaseSchema, ClientSchemaOptions, DefaultSelectionSetDepth, SelectionSetDepthValue } from '../../ModelSchema';
+export interface SchemaMetadata<Schema extends BaseSchema<any, any>, Options extends ClientSchemaOptions = ClientSchemaOptions> {
     authFields: AuthFields<Schema>;
+    selectionSetDepth: [Options['selectionSetDepth']] extends [SelectionSetDepthValue] ? Options['selectionSetDepth'] : DefaultSelectionSetDepth;
 }
 type AuthFields<Schema extends Record<string, any>> = Schema['data']['authorization'][number] extends never ? object : ImpliedAuthFields<Schema['data']['authorization'][number]>;
 export {};

package/dist/esm/ModelSchema.d.ts

@@ -21,6 +21,12 @@ type SchemaContent = BaseModelType | CustomType<CustomTypeParamShape> | EnumType
 type AddToSchemaContent = Exclude<SchemaContent, BaseModelType>;
 type AddToSchemaContents = Record<string, AddToSchemaContent>;
 type NonEmpty<T> = keyof T extends never ? never : T;
+export type SelectionSetDepthValue = 0 | 1 | 2 | 3 | 4 | 5;
+/** Default depth applied when ClientSchema is used without an explicit Options arg. */
+export type DefaultSelectionSetDepth = 5;
+export type ClientSchemaOptions = {
+    selectionSetDepth?: SelectionSetDepthValue;
+};
 export type ModelSchemaContents = Record<string, SchemaContent>;
 type InternalSchemaModels = Record<string, InternalModel | EnumType | CustomType<any> | InternalCustom>;
 export type ModelSchemaParamShape = {

package/dist/esm/util/Filters.d.ts

@@ -129,5 +129,5 @@ export type ModelPrimaryCompositeKeyInput<SkIr extends Record<string, string | n
     ge?: SkIr;
     gt?: SkIr;
     between?: [SkIr, SkIr];
-    beginsWith?: SkIr;
+    beginsWith?: Partial<SkIr>;
 };