@aws-amplify/data-schema 1.2.8 → 1.3.0

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

@@ -0,0 +1,18 @@
+import type { RefTypeParamShape } from '../../RefType';
+/**
+ * Dereferences an `a.ref()` against a given "bag" of independently resolved types.
+ *
+ * This util will examine the ref for requiredness and array-ness and wrap/augment
+ * to referred-to type accordingly.
+ */
+export type ResolveRef<RefShape extends RefTypeParamShape, RefBag extends Record<string, {
+    __entityType: string;
+    type: unknown;
+}>> = ResolveRefValueArrayTraits<RefShape, ApplyRequiredness<RefShape['link'] extends keyof RefBag ? RefBag[RefShape['link']]['type'] : never, RefShape['valueRequired']>>;
+type ApplyRequiredness<Value, MakeRequired extends boolean> = MakeRequired extends true ? Exclude<Value, null> : Value | null | undefined;
+/**
+ * Converts the resolved RefType Value type into Array<> according to the
+ * `array` and `arrayRequired` properties of the RefType
+ */
+type ResolveRefValueArrayTraits<Ref extends RefTypeParamShape, Value> = Ref['array'] extends false ? Value : Ref['arrayRequired'] extends true ? Array<Value> : Array<Value> | null | undefined;
+export {};

package/dist/esm/ClientSchema/utilities/ResolveRef.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=ResolveRef.mjs.map

package/dist/esm/ClientSchema/utilities/ResolveRef.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResolveRef.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

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

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

package/dist/esm/ClientSchema/utilities/SchemaMetadata.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=SchemaMetadata.mjs.map

package/dist/esm/ClientSchema/utilities/SchemaMetadata.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaMetadata.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

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

@@ -0,0 +1,4 @@
+export * from './ExtractNestedTypes';
+export * from './ResolveField';
+export * from './ResolveRef';
+export * from './SchemaMetadata';

package/dist/esm/ClientSchema/utilities/index.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=index.mjs.map

package/dist/esm/ClientSchema/utilities/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/esm/MappedTypes/ImplicitFieldInjector.d.ts

@@ -1,4 +1,4 @@
-import type { PrimaryIndexIrShape } from '../runtime/';
+import type { PrimaryIndexIrShape } from '../util';
 type DefaultIdentifierFields = {
     readonly id: string;
 };

package/dist/esm/MappedTypes/ModelMetadata.d.ts

@@ -1,5 +1,5 @@
 import { type UnionToIntersection, type ExcludeEmpty } from '@aws-amplify/data-schema-types';
-import { type PrimaryIndexIrShape } from '../runtime/';
+import type { PrimaryIndexIrShape } from '../util';
 import type { ModelType } from '../ModelType';
 import type { ModelRelationalFieldParamShape } from '../ModelRelationalField';
 export type ModelIdentifier<T> = {

package/dist/esm/MappedTypes/ResolveFieldProperties.d.ts

@@ -4,7 +4,7 @@ import type { ModelField } from '../ModelField';
 import type { ModelType, ModelTypeParamShape } from '../ModelType';
 import type { GenericModelSchema } from '../ModelSchema';
 import type { ModelRelationalField, ModelRelationalFieldParamShape } from '../ModelRelationalField';
-import type { PrimaryIndexIrShape } from '../runtime/';
+import type { PrimaryIndexIrShape } from '../util/';
 import type { ResolveSchema, SchemaTypes } from './ResolveSchema';
 import type { InjectImplicitModelFields } from './ImplicitFieldInjector';
 import type { ModelIdentifier } from './ModelMetadata';

package/dist/esm/ModelSchema.d.ts

@@ -6,6 +6,10 @@ import type { CustomOperation, CustomOperationParamShape, InternalCustom, Mutati
 import { AllowModifier, SchemaAuthorization } from './Authorization';
 import { Brand } from './util';
 import { ModelRelationalField, ModelRelationalFieldParamShape } from './ModelRelationalField';
+export { ModelType } from './ModelType';
+export { EnumType } from './EnumType';
+export { CustomType } from './CustomType';
+export { CustomOperation } from './CustomOperation';
 export declare const rdsSchemaBrandName = "RDSSchema";
 export declare const rdsSchemaBrand: Brand<"RDSSchema">;
 export type RDSSchemaBrand = Brand<typeof rdsSchemaBrandName>;
@@ -15,8 +19,8 @@ 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;
-type ModelSchemaContents = Record<string, SchemaContent>;
-type InternalSchemaModels = Record<string, InternalModel | EnumType<any> | CustomType<any> | InternalCustom>;
+export type ModelSchemaContents = Record<string, SchemaContent>;
+type InternalSchemaModels = Record<string, InternalModel | EnumType | CustomType<any> | InternalCustom>;
 export type ModelSchemaParamShape = {
     types: ModelSchemaContents;
     authorization: SchemaAuthorization<any, any, any>[];
@@ -42,6 +46,9 @@ export type ModelSchema<T extends ModelSchemaParamShape, UsedMethods extends 'au
     authorization: <AuthRules extends SchemaAuthorization<any, any, any>>(callback: (allow: AllowModifier) => AuthRules | AuthRules[]) => ModelSchema<SetTypeSubArg<T, 'authorization', AuthRules[]>, UsedMethods | 'authorization'>;
 }, UsedMethods> & BaseSchema<T> & DDBSchemaBrand;
 type RDSModelSchemaFunctions = 'addToSchema' | 'addQueries' | 'addMutations' | 'addSubscriptions' | 'authorization' | 'setRelationships' | 'setAuthorization' | 'renameModelFields' | 'renameModels';
+type OmitFromEach<Models, Modifier extends string> = {
+    [ModelName in keyof Models]: Omit<Models[ModelName], Modifier>;
+};
 export type RDSModelSchema<T extends RDSModelSchemaParamShape, UsedMethods extends RDSModelSchemaFunctions = never, RelationshipTemplate extends Record<string, ModelRelationalField<ModelRelationalFieldParamShape, string, any, any>> = Record<string, ModelRelationalField<ModelRelationalFieldParamShape, string, any, any>>> = Omit<{
     addToSchema: <AddedTypes extends AddToSchemaContents>(types: AddedTypes) => RDSModelSchema<SetTypeSubArg<T, 'types', T['types'] & AddedTypes>, UsedMethods | 'addToSchema'>;
     /**
@@ -57,8 +64,8 @@ export type RDSModelSchema<T extends RDSModelSchemaParamShape, UsedMethods exten
      */
     addSubscriptions: <Subscriptions extends Record<string, SubscriptionCustomOperation>>(types: Subscriptions) => RDSModelSchema<SetTypeSubArg<T, 'types', T['types'] & Subscriptions>, UsedMethods | 'addSubscriptions'>;
     authorization: <AuthRules extends SchemaAuthorization<any, any, any>>(callback: (allow: AllowModifier) => AuthRules | AuthRules[]) => RDSModelSchema<SetTypeSubArg<T, 'authorization', AuthRules[]>, UsedMethods | 'authorization'>;
-    setAuthorization: (callback: (models: BaseSchema<T, true>['models'], schema: RDSModelSchema<T, UsedMethods | 'setAuthorization'>) => void) => RDSModelSchema<T>;
-    setRelationships: <Relationships extends ReadonlyArray<Partial<Record<keyof T['types'], RelationshipTemplate>>>>(callback: (models: BaseSchema<T, true>['models']) => Relationships) => RDSModelSchema<UnionToIntersection<Relationships[number]> extends infer RelationshipsDefs ? RelationshipsDefs extends Record<string, RelationshipTemplate> ? SetTypeSubArg<T, 'types', {
+    setAuthorization: (callback: (models: OmitFromEach<BaseSchema<T, true>['models'], 'secondaryIndexes'>, schema: RDSModelSchema<T, UsedMethods | 'setAuthorization'>) => void) => RDSModelSchema<T>;
+    setRelationships: <Relationships extends ReadonlyArray<Partial<Record<keyof T['types'], RelationshipTemplate>>>>(callback: (models: OmitFromEach<BaseSchema<T, true>['models'], 'authorization' | 'fields' | 'secondaryIndexes'>) => Relationships) => RDSModelSchema<UnionToIntersection<Relationships[number]> extends infer RelationshipsDefs ? RelationshipsDefs extends Record<string, RelationshipTemplate> ? SetTypeSubArg<T, 'types', {
         [ModelName in keyof T['types']]: ModelName extends keyof RelationshipsDefs ? AddRelationshipFieldsToModelTypeFields<T['types'][ModelName], RelationshipsDefs[ModelName]> : T['types'][ModelName];
     }> : T : T, UsedMethods | 'setRelationships'>;
     renameModels: <NewName extends string, CurName extends string = keyof BaseSchema<T>['models'] & string, const ChangeLog extends readonly [CurName, NewName][] = []>(callback: () => ChangeLog) => RDSModelSchema<SetTypeSubArg<T, 'types', RenameModelArr<ChangeLog, T['types']>>, UsedMethods | 'renameModels'>;
@@ -116,4 +123,3 @@ export type CustomPathData = {
     stack: string | undefined;
     entry: string;
 };
-export {};

package/dist/esm/ModelType.d.ts

@@ -1,5 +1,5 @@
 import type { SetTypeSubArg } from '@aws-amplify/data-schema-types';
-import type { PrimaryIndexIrShape, SecondaryIndexIrShape } from './runtime';
+import { type PrimaryIndexIrShape, type SecondaryIndexIrShape } from './util';
 import type { InternalField, BaseModelField } from './ModelField';
 import type { ModelRelationalField, InternalRelationalField, ModelRelationalFieldParamShape } from './ModelRelationalField';
 import { type AllowModifier, type Authorization } from './Authorization';
@@ -80,6 +80,13 @@ export type InternalModel = SchemaModelType<ModelType<ModelTypeParamShape>, stri
  * @returns true if the given value is a ModelSchema
  */
 export declare const isSchemaModelType: (modelType: any | SchemaModelType) => modelType is ModelType<ModelTypeParamShape, "identifier">;
+export type ModelDefaultIdentifier = {
+    pk: {
+        readonly id: string;
+    };
+    sk: never;
+    compositeSk: never;
+};
 /**
  * A data model that creates a matching Amazon DynamoDB table and provides create, read (list and get), update,
  * delete, and subscription APIs.
@@ -89,13 +96,7 @@ export declare const isSchemaModelType: (modelType: any | SchemaModelType) => mo
  */
 export declare function model<T extends ModelFields>(fields: T): ModelType<{
     fields: T;
-    identifier: {
-        pk: {
-            id: string;
-        };
-        sk: never;
-        compositeSk: never;
-    };
+    identifier: ModelDefaultIdentifier;
     secondaryIndexes: [];
     authorization: [];
 }>;

package/dist/esm/ModelType.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ModelType.mjs","sources":["../../src/ModelType.ts"],"sourcesContent":["import { brand } from './util';\nimport { allow } from './Authorization';\nimport { modelIndex, } from './ModelIndex';\nconst brandName = 'modelType';\nfunction _model(fields) {\n    const data = {\n        fields,\n        identifier: ['id'],\n        secondaryIndexes: [],\n        authorization: [],\n    };\n    const builder = {\n        identifier(identifier) {\n            data.identifier = identifier;\n            return this;\n        },\n        secondaryIndexes(callback) {\n            data.secondaryIndexes = callback(modelIndex);\n            return this;\n        },\n        authorization(callback) {\n            const { resource: _, ...rest } = allow;\n            const rules = callback(rest);\n            data.authorization = Array.isArray(rules) ? rules : [rules];\n            return this;\n        },\n        ...brand(brandName),\n    };\n    return {\n        ...builder,\n        data,\n        relationships(relationships) {\n            data.fields = { ...data.fields, ...relationships };\n        },\n        fields: data.fields,\n    };\n}\n/**\n * Model Type type guard\n * @param modelType - api-next ModelType\n * @returns true if the given value is a ModelSchema\n */\nexport const isSchemaModelType = (modelType) => {\n    const internalType = modelType;\n    return (typeof internalType === 'object' &&\n        internalType.data !== undefined &&\n        internalType.data.fields !== undefined &&\n        internalType.data.authorization !== undefined &&\n        internalType.data.identifier !== undefined &&\n        internalType.data.secondaryIndexes !== undefined &&\n        typeof internalType.relationships === 'function');\n};\n/**\n * A data model that creates a matching Amazon DynamoDB table and provides create, read (list and get), update,\n * delete, and subscription APIs.\n *\n * @param fields database table fields. Supports scalar types and relationship types.\n * @returns a data model definition\n */\nexport function model(fields) {\n    return _model(fields);\n}\n"],"names":[],"mappings":";;;;AAGA,MAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,SAAS,MAAM,CAAC,MAAM,EAAE;AACxB,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,MAAM;AACd,QAAQ,UAAU,EAAE,CAAC,IAAI,CAAC;AAC1B,QAAQ,gBAAgB,EAAE,EAAE;AAC5B,QAAQ,aAAa,EAAE,EAAE;AACzB,KAAK,CAAC;AACN,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,UAAU,CAAC,UAAU,EAAE;AAC/B,YAAY,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;AACzC,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,gBAAgB,CAAC,QAAQ,EAAE;AACnC,YAAY,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AACzD,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,aAAa,CAAC,QAAQ,EAAE;AAChC,YAAY,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;AACnD,YAAY,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AACzC,YAAY,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;AACxE,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC;AAC3B,KAAK,CAAC;AACN,IAAI,OAAO;AACX,QAAQ,GAAG,OAAO;AAClB,QAAQ,IAAI;AACZ,QAAQ,aAAa,CAAC,aAAa,EAAE;AACrC,YAAY,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,aAAa,EAAE,CAAC;AAC/D,SAAS;AACT,QAAQ,MAAM,EAAE,IAAI,CAAC,MAAM;AAC3B,KAAK,CAAC;AACN,CAAC;AACD;AACA;AACA;AACA;AACA;AACY,MAAC,iBAAiB,GAAG,CAAC,SAAS,KAAK;AAChD,IAAI,MAAM,YAAY,GAAG,SAAS,CAAC;AACnC,IAAI,QAAQ,OAAO,YAAY,KAAK,QAAQ;AAC5C,QAAQ,YAAY,CAAC,IAAI,KAAK,SAAS;AACvC,QAAQ,YAAY,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS;AAC9C,QAAQ,YAAY,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS;AACrD,QAAQ,YAAY,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS;AAClD,QAAQ,YAAY,CAAC,IAAI,CAAC,gBAAgB,KAAK,SAAS;AACxD,QAAQ,OAAO,YAAY,CAAC,aAAa,KAAK,UAAU,EAAE;AAC1D,EAAE;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,KAAK,CAAC,MAAM,EAAE;AAC9B,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;AAC1B;;;;"}
+{"version":3,"file":"ModelType.mjs","sources":["../../src/ModelType.ts"],"sourcesContent":["import { brand, } from './util';\nimport { allow } from './Authorization';\nimport { modelIndex, } from './ModelIndex';\nconst brandName = 'modelType';\nfunction _model(fields) {\n    const data = {\n        fields,\n        identifier: ['id'],\n        secondaryIndexes: [],\n        authorization: [],\n    };\n    const builder = {\n        identifier(identifier) {\n            data.identifier = identifier;\n            return this;\n        },\n        secondaryIndexes(callback) {\n            data.secondaryIndexes = callback(modelIndex);\n            return this;\n        },\n        authorization(callback) {\n            const { resource: _, ...rest } = allow;\n            const rules = callback(rest);\n            data.authorization = Array.isArray(rules) ? rules : [rules];\n            return this;\n        },\n        ...brand(brandName),\n    };\n    return {\n        ...builder,\n        data,\n        relationships(relationships) {\n            data.fields = { ...data.fields, ...relationships };\n        },\n        fields: data.fields,\n    };\n}\n/**\n * Model Type type guard\n * @param modelType - api-next ModelType\n * @returns true if the given value is a ModelSchema\n */\nexport const isSchemaModelType = (modelType) => {\n    const internalType = modelType;\n    return (typeof internalType === 'object' &&\n        internalType.data !== undefined &&\n        internalType.data.fields !== undefined &&\n        internalType.data.authorization !== undefined &&\n        internalType.data.identifier !== undefined &&\n        internalType.data.secondaryIndexes !== undefined &&\n        typeof internalType.relationships === 'function');\n};\n/**\n * A data model that creates a matching Amazon DynamoDB table and provides create, read (list and get), update,\n * delete, and subscription APIs.\n *\n * @param fields database table fields. Supports scalar types and relationship types.\n * @returns a data model definition\n */\nexport function model(fields) {\n    return _model(fields);\n}\n"],"names":[],"mappings":";;;;AAGA,MAAM,SAAS,GAAG,WAAW,CAAC;AAC9B,SAAS,MAAM,CAAC,MAAM,EAAE;AACxB,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,MAAM;AACd,QAAQ,UAAU,EAAE,CAAC,IAAI,CAAC;AAC1B,QAAQ,gBAAgB,EAAE,EAAE;AAC5B,QAAQ,aAAa,EAAE,EAAE;AACzB,KAAK,CAAC;AACN,IAAI,MAAM,OAAO,GAAG;AACpB,QAAQ,UAAU,CAAC,UAAU,EAAE;AAC/B,YAAY,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;AACzC,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,gBAAgB,CAAC,QAAQ,EAAE;AACnC,YAAY,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AACzD,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,aAAa,CAAC,QAAQ,EAAE;AAChC,YAAY,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;AACnD,YAAY,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;AACzC,YAAY,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;AACxE,YAAY,OAAO,IAAI,CAAC;AACxB,SAAS;AACT,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC;AAC3B,KAAK,CAAC;AACN,IAAI,OAAO;AACX,QAAQ,GAAG,OAAO;AAClB,QAAQ,IAAI;AACZ,QAAQ,aAAa,CAAC,aAAa,EAAE;AACrC,YAAY,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,aAAa,EAAE,CAAC;AAC/D,SAAS;AACT,QAAQ,MAAM,EAAE,IAAI,CAAC,MAAM;AAC3B,KAAK,CAAC;AACN,CAAC;AACD;AACA;AACA;AACA;AACA;AACY,MAAC,iBAAiB,GAAG,CAAC,SAAS,KAAK;AAChD,IAAI,MAAM,YAAY,GAAG,SAAS,CAAC;AACnC,IAAI,QAAQ,OAAO,YAAY,KAAK,QAAQ;AAC5C,QAAQ,YAAY,CAAC,IAAI,KAAK,SAAS;AACvC,QAAQ,YAAY,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS;AAC9C,QAAQ,YAAY,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS;AACrD,QAAQ,YAAY,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS;AAClD,QAAQ,YAAY,CAAC,IAAI,CAAC,gBAAgB,KAAK,SAAS;AACxD,QAAQ,OAAO,YAAY,CAAC,aAAa,KAAK,UAAU,EAAE;AAC1D,EAAE;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,KAAK,CAAC,MAAM,EAAE;AAC9B,IAAI,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;AAC1B;;;;"}