@aws-amplify/datastore 3.7.3 → 3.7.4-custom-pk.86

package/lib-esm/types.d.ts

@@ -1,6 +1,9 @@
 import { ModelInstanceCreator } from './datastore/datastore';
 import { PredicateAll } from './predicates';
 import { GRAPHQL_AUTH_MODE } from '@aws-amplify/api-graphql';
+import { Auth } from '@aws-amplify/auth';
+import { API } from '@aws-amplify/api';
+import Cache from '@aws-amplify/cache';
 import { Adapter } from './storage/adapter';
 export declare type Schema = UserSchema & {
     version: string;
@@ -43,17 +46,19 @@ declare type SchemaEnum = {
 export declare type ModelAssociation = AssociatedWith | TargetNameAssociation;
 declare type AssociatedWith = {
     connectionType: 'HAS_MANY' | 'HAS_ONE';
-    associatedWith: string;
+    associatedWith: string | string[];
     targetName?: string;
+    targetNames?: string[];
 };
 export declare function isAssociatedWith(obj: any): obj is AssociatedWith;
 declare type TargetNameAssociation = {
     connectionType: 'BELONGS_TO';
-    targetName: string;
+    targetName?: string;
+    targetNames?: string[];
 };
 export declare function isTargetNameAssociation(obj: any): obj is TargetNameAssociation;
 export declare type ModelAttributes = ModelAttribute[];
-declare type ModelAttribute = {
+export declare type ModelAttribute = {
     type: string;
     properties?: Record<string, any>;
 };
@@ -84,6 +89,7 @@ declare type ModelAttributeKey = {
 declare type ModelAttributePrimaryKey = {
     type: 'key';
     properties: {
+        name: never;
         fields: string[];
     };
 };
@@ -176,44 +182,74 @@ export declare type ModelField = {
 export declare type NonModelTypeConstructor<T> = {
     new (init: T): T;
 };
-export declare type PersistentModelConstructor<T extends PersistentModel, K extends PersistentModelMetaData = {
-    readOnlyFields: 'createdAt' | 'updatedAt';
-}> = {
-    new (init: ModelInit<T, K>): T;
-    copyOf(src: T, mutator: (draft: MutableModel<T, K>) => void): T;
-};
-export declare type TypeConstructorMap = Record<string, PersistentModelConstructor<any> | NonModelTypeConstructor<any>>;
-export declare type PersistentModelMetaData = {
-    readOnlyFields: string;
-};
-export declare type PersistentModel = Readonly<{
-    id: string;
-} & Record<string, any>>;
-export declare type ModelInit<T, K extends PersistentModelMetaData = {
-    readOnlyFields: 'createdAt' | 'updatedAt';
-}> = Omit<T, 'id' | K['readOnlyFields']>;
+export declare type PersistentModelConstructor<T extends PersistentModel> = {
+    new (init: ModelInit<T, PersistentModelMetaData<T>>): T;
+    copyOf(src: T, mutator: (draft: MutableModel<T, PersistentModelMetaData<T>>) => void): T;
+};
+export declare type TypeConstructorMap = Record<string, PersistentModelConstructor<any> | NonModelTypeConstructor<unknown>>;
+export declare const __identifierBrand__: unique symbol;
+export declare type IdentifierBrand<T, K> = T & {
+    [__identifierBrand__]: K;
+};
+export declare type ManagedIdentifier<T, F extends keyof T> = IdentifierBrand<{
+    field: F extends string ? F : never;
+    type: T;
+}, 'ManagedIdentifier'>;
+export declare type OptionallyManagedIdentifier<T, F extends keyof T> = IdentifierBrand<{
+    field: F extends string ? F : never;
+    type: T;
+}, 'OptionallyManagedIdentifier'>;
+export declare type CompositeIdentifier<T, K extends Array<keyof T>> = IdentifierBrand<{
+    fields: K;
+    type: T;
+}, 'CompositeIdentifier'>;
+export declare type CustomIdentifier<T, K extends keyof T> = CompositeIdentifier<T, [K]>;
+export declare type Identifier<T> = ManagedIdentifier<T, any> | OptionallyManagedIdentifier<T, any> | CompositeIdentifier<T, any> | CustomIdentifier<T, any>;
+export declare type IdentifierFields<T extends PersistentModel, M extends PersistentModelMetaData<T> = never> = (MetadataOrDefault<T, M>['identifier'] extends ManagedIdentifier<any, any> | OptionallyManagedIdentifier<any, any> ? MetadataOrDefault<T, M>['identifier']['field'] : MetadataOrDefault<T, M>['identifier'] extends CompositeIdentifier<T, infer B> ? B[number] : MetadataOrDefault<T, M>['identifier']['field']) & string;
+export declare type IdentifierFieldsForInit<T extends PersistentModel, M extends PersistentModelMetaData<T>> = MetadataOrDefault<T, M>['identifier'] extends DefaultPersistentModelMetaData | ManagedIdentifier<T, any> ? never : MetadataOrDefault<T, M>['identifier'] extends OptionallyManagedIdentifier<T, any> ? IdentifierFields<T, M> : MetadataOrDefault<T, M>['identifier'] extends CompositeIdentifier<T, any> ? IdentifierFields<T, M> : never;
+export declare const __modelMeta__: unique symbol;
+export declare type PersistentModelMetaData<T> = {
+    identifier?: Identifier<T>;
+    readOnlyFields?: string;
+};
+export declare type DefaultPersistentModelMetaData = {
+    identifier: ManagedIdentifier<{
+        id: string;
+    }, 'id'>;
+    readOnlyFields: never;
+};
+export declare type MetadataOrDefault<T extends PersistentModel, _ extends PersistentModelMetaData<T> = never> = T extends {
+    [__modelMeta__]: PersistentModelMetaData<T>;
+} ? T[typeof __modelMeta__] : DefaultPersistentModelMetaData;
+export declare type PersistentModel = Readonly<Record<string, any>>;
+export declare type MetadataReadOnlyFields<T extends PersistentModel, M extends PersistentModelMetaData<T>> = Extract<MetadataOrDefault<T, M>['readOnlyFields'] | M['readOnlyFields'], keyof T>;
+export declare type ModelInit<T extends PersistentModel, M extends PersistentModelMetaData<T> = {}> = Omit<T, typeof __modelMeta__ | IdentifierFields<T, M> | MetadataReadOnlyFields<T, M>> & (MetadataOrDefault<T, M>['identifier'] extends OptionallyManagedIdentifier<T, any> ? Partial<Pick<T, IdentifierFieldsForInit<T, M>>> : Required<Pick<T, IdentifierFieldsForInit<T, M>>>);
 declare type DeepWritable<T> = {
     -readonly [P in keyof T]: T[P] extends TypeName<T[P]> ? T[P] : DeepWritable<T[P]>;
 };
-export declare type MutableModel<T extends Record<string, any>, K extends PersistentModelMetaData = {
-    readOnlyFields: 'createdAt' | 'updatedAt';
-}> = DeepWritable<Omit<T, 'id' | K['readOnlyFields']>> & Readonly<Pick<T, 'id' | K['readOnlyFields']>>;
+export declare type MutableModel<T extends PersistentModel, M extends PersistentModelMetaData<T> = {}> = DeepWritable<Omit<T, IdentifierFields<T, M> | MetadataReadOnlyFields<T, M>>> & Readonly<Pick<T, IdentifierFields<T, M> | MetadataReadOnlyFields<T, M>>>;
 export declare type ModelInstanceMetadata = {
-    id: string;
     _version: number;
     _lastChangedAt: number;
     _deleted: boolean;
 };
+export declare type IdentifierFieldValue<T extends PersistentModel, M extends PersistentModelMetaData<T>> = MetadataOrDefault<T, M>['identifier'] extends CompositeIdentifier<T, any> ? MetadataOrDefault<T, M>['identifier']['fields'] extends [any] ? T[MetadataOrDefault<T, M>['identifier']['fields'][0]] : never : T[MetadataOrDefault<T, M>['identifier']['field']];
+export declare type IdentifierFieldOrIdentifierObject<T extends PersistentModel, M extends PersistentModelMetaData<T>> = Pick<T, IdentifierFields<T, M>> | IdentifierFieldValue<T, M>;
+export declare function isIdentifierFieldValue<T extends PersistentModel>(obj: any, modelDefinition: SchemaModel): obj is IdentifierFieldValue<T extends PersistentModel ? T : never, any>;
+export declare function isIdentifierFieldOrObject<T extends PersistentModel>(obj: any, modelDefinition: SchemaModel): obj is IdentifierFieldOrIdentifierObject<T, any>;
+export declare function isIdentifierObject<T extends PersistentModel>(obj: any, modelDefinition: SchemaModel): obj is IdentifierFields<T extends PersistentModel ? T : never, any>;
 export declare enum OpType {
     INSERT = "INSERT",
     UPDATE = "UPDATE",
     DELETE = "DELETE"
 }
-export declare type SubscriptionMessage<T extends PersistentModel> = {
+export declare type SubscriptionMessage<T extends PersistentModel> = Pick<InternalSubscriptionMessage<T>, 'opType' | 'element' | 'model' | 'condition'>;
+export declare type InternalSubscriptionMessage<T extends PersistentModel> = {
     opType: OpType;
     element: T;
     model: PersistentModelConstructor<T>;
     condition: PredicatesGroup<T> | null;
+    savedElement?: T;
 };
 export declare type DataStoreSnapshot<T extends PersistentModel> = {
     items: T[];
@@ -332,11 +368,16 @@ export declare type RelationType = {
     modelName: string;
     relationType: 'HAS_ONE' | 'HAS_MANY' | 'BELONGS_TO';
     targetName?: string;
-    associatedWith?: string;
+    targetNames?: string[];
+    associatedWith?: string | string[];
 };
+declare type IndexOptions = {
+    unique?: boolean;
+};
+export declare type IndexesType = Array<[string, string[], IndexOptions?]>;
 export declare type RelationshipType = {
     [modelName: string]: {
-        indexes: string[];
+        indexes: IndexesType;
         relationTypes: RelationType[];
     };
 };
@@ -351,7 +392,7 @@ export declare type DataStoreConfig = {
     DataStore?: {
         authModeStrategyType?: AuthModeStrategyType;
         conflictHandler?: ConflictHandler;
-        errorHandler?: (error: SyncError) => void;
+        errorHandler?: (error: SyncError<PersistentModel>) => void;
         maxRecordsToSync?: number;
         syncPageSize?: number;
         fullSyncInterval?: number;
@@ -361,7 +402,7 @@ export declare type DataStoreConfig = {
     };
     authModeStrategyType?: AuthModeStrategyType;
     conflictHandler?: ConflictHandler;
-    errorHandler?: (error: SyncError) => void;
+    errorHandler?: (error: SyncError<PersistentModel>) => void;
     maxRecordsToSync?: number;
     syncPageSize?: number;
     fullSyncInterval?: number;
@@ -419,17 +460,27 @@ export declare type SyncConflict = {
     operation: OpType;
     attempts: number;
 };
-export declare type SyncError = {
+export declare type SyncError<T extends PersistentModel> = {
     message: string;
-    errorType: string;
-    errorInfo: string;
-    localModel: PersistentModel;
-    remoteModel: PersistentModel;
+    errorType: ErrorType;
+    errorInfo?: string;
+    recoverySuggestion?: string;
+    model?: string;
+    localModel: T;
+    remoteModel: T;
+    process: ProcessName;
     operation: string;
+    cause?: Error;
 };
+export declare type ErrorType = 'ConfigError' | 'BadModel' | 'BadRecord' | 'Unauthorized' | 'Transient' | 'Unknown';
+export declare enum ProcessName {
+    'sync' = "sync",
+    'mutate' = "mutate",
+    'subscribe' = "subscribe"
+}
 export declare const DISCARD: unique symbol;
 export declare type ConflictHandler = (conflict: SyncConflict) => Promise<PersistentModel | typeof DISCARD> | PersistentModel | typeof DISCARD;
-export declare type ErrorHandler = (error: SyncError) => void;
+export declare type ErrorHandler = (error: SyncError<PersistentModel>) => void;
 export declare type DeferredCallbackResolverOptions = {
     callback: () => void;
     maxInterval?: number;
@@ -439,4 +490,9 @@ export declare enum LimitTimerRaceResolvedValues {
     LIMIT = "LIMIT",
     TIMER = "TIMER"
 }
+export declare type AmplifyContext = {
+    Auth: typeof Auth;
+    API: typeof API;
+    Cache: typeof Cache;
+};
 export {};

package/lib-esm/types.js

@@ -34,7 +34,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { exhaustiveCheck, isAWSDate, isAWSTime, isAWSDateTime, isAWSTimestamp, isAWSEmail, isAWSJSON, isAWSURL, isAWSPhone, isAWSIPAddress, } from './util';
+import { exhaustiveCheck, isAWSDate, isAWSTime, isAWSDateTime, isAWSTimestamp, isAWSEmail, isAWSJSON, isAWSURL, isAWSPhone, isAWSIPAddress, extractPrimaryKeyFieldNames, } from './util';
 export function isSchemaModel(obj) {
     return obj && obj.pluralName !== undefined;
 }
@@ -42,7 +42,7 @@ export function isAssociatedWith(obj) {
     return obj && obj.associatedWith;
 }
 export function isTargetNameAssociation(obj) {
-    return obj && obj.targetName;
+    return (obj === null || obj === void 0 ? void 0 : obj.targetName) || (obj === null || obj === void 0 ? void 0 : obj.targetNames);
 }
 export function isModelAttributeAuth(attr) {
     return (attr.type === 'auth' &&
@@ -170,6 +170,27 @@ export function isEnumFieldType(obj) {
         return true;
     return false;
 }
+export function isIdentifierFieldValue(obj, modelDefinition) {
+    var _a;
+    var keys = extractPrimaryKeyFieldNames(modelDefinition);
+    if (keys.length === 1) {
+        var type = ((_a = modelDefinition === null || modelDefinition === void 0 ? void 0 : modelDefinition.fields[keys[0]]) !== null && _a !== void 0 ? _a : {}).type;
+        if (isGraphQLScalarType(type)) {
+            var jsType = GraphQLScalarType.getJSType(type);
+            return typeof obj === jsType;
+        }
+        return false;
+    }
+    return false;
+}
+export function isIdentifierFieldOrObject(obj, modelDefinition) {
+    return (isIdentifierFieldValue(obj, modelDefinition) ||
+        isIdentifierObject(obj, modelDefinition));
+}
+export function isIdentifierObject(obj, modelDefinition) {
+    var keys = extractPrimaryKeyFieldNames(modelDefinition);
+    return (typeof obj === 'object' && obj && keys.every(function (k) { return obj[k] !== undefined; }));
+}
 //#endregion
 //#region Subscription messages
 export var OpType;
@@ -216,11 +237,16 @@ export function syncExpression(modelConstructor, conditionProducer) {
         });
     });
 }
+export var ProcessName;
+(function (ProcessName) {
+    ProcessName["sync"] = "sync";
+    ProcessName["mutate"] = "mutate";
+    ProcessName["subscribe"] = "subscribe";
+})(ProcessName || (ProcessName = {}));
 export var DISCARD = Symbol('DISCARD');
 export var LimitTimerRaceResolvedValues;
 (function (LimitTimerRaceResolvedValues) {
     LimitTimerRaceResolvedValues["LIMIT"] = "LIMIT";
     LimitTimerRaceResolvedValues["TIMER"] = "TIMER";
 })(LimitTimerRaceResolvedValues || (LimitTimerRaceResolvedValues = {}));
-//#endregion
 //# sourceMappingURL=types.js.map

package/lib-esm/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EACN,eAAe,EACf,SAAS,EACT,SAAS,EACT,aAAa,EACb,cAAc,EACd,UAAU,EACV,SAAS,EACT,QAAQ,EACR,UAAU,EACV,cAAc,GACd,MAAM,QAAQ,CAAC;AAiChB,MAAM,UAAU,aAAa,CAAC,GAAQ;IACrC,OAAO,GAAG,IAAkB,GAAI,CAAC,UAAU,KAAK,SAAS,CAAC;AAC3D,CAAC;AAkBD,MAAM,UAAU,gBAAgB,CAAC,GAAQ;IACxC,OAAO,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC;AAClC,CAAC;AAMD,MAAM,UAAU,uBAAuB,CACtC,GAAQ;IAER,OAAO,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC;AAC9B,CAAC;AAuBD,MAAM,UAAU,oBAAoB,CACnC,IAAoB;IAEpB,OAAO,CACN,IAAI,CAAC,IAAI,KAAK,MAAM;QACpB,IAAI,CAAC,UAAU;QACf,IAAI,CAAC,UAAU,CAAC,KAAK;QACrB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAChC,CAAC;AACH,CAAC;AAyBD,MAAM,UAAU,mBAAmB,CAClC,IAAoB;IAEpB,OAAO,CACN,IAAI,CAAC,IAAI,KAAK,KAAK;QACnB,IAAI,CAAC,UAAU;QACf,IAAI,CAAC,UAAU,CAAC,MAAM;QACtB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CACjC,CAAC;AACH,CAAC;AAED,MAAM,UAAU,0BAA0B,CACzC,IAAoB;IAEpB,OAAO,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC3C,IAAoB;IAEpB,OAAO,CACN,mBAAmB,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS;QAClC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CACjC,CAAC;AACH,CAAC;AAYD,MAAM,CAAN,IAAY,uBAMX;AAND,WAAY,uBAAuB;IAClC,4CAAiB,CAAA;IACjB,0CAAe,CAAA;IACf,4CAAiB,CAAA;IACjB,8CAAmB,CAAA;IACnB,4CAAiB,CAAA;AAClB,CAAC,EANW,uBAAuB,KAAvB,uBAAuB,QAMlC;AAED,MAAM,CAAN,IAAY,0BAMX;AAND,WAAY,0BAA0B;IACrC,mDAAqB,CAAA;IACrB,sDAAwB,CAAA;IACxB,2CAAa,CAAA;IACb,yCAAW,CAAA;IACX,gDAAkB,CAAA;AACnB,CAAC,EANW,0BAA0B,KAA1B,0BAA0B,QAMrC;AAGD,MAAM,CAAN,IAAY,iBAeX;AAfD,WAAY,iBAAiB;IAC5B,qDAAE,CAAA;IACF,6DAAM,CAAA;IACN,uDAAG,CAAA;IACH,2DAAK,CAAA;IACL,+DAAO,CAAA;IACP,+DAAO,CAAA;IACP,+DAAO,CAAA;IACP,uEAAW,CAAA;IACX,yEAAY,CAAA;IACZ,iEAAQ,CAAA;IACR,gEAAO,CAAA;IACP,8DAAM,CAAA;IACN,kEAAQ,CAAA;IACR,0EAAY,CAAA;AACb,CAAC,EAfW,iBAAiB,KAAjB,iBAAiB,QAe5B;AAED,WAAiB,iBAAiB;IACjC,SAAgB,SAAS,CACxB,MAGC;QAED,QAAQ,MAAM,EAAE;YACf,KAAK,SAAS;gBACb,OAAO,SAAS,CAAC;YAClB,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,aAAa,CAAC;YACnB,KAAK,UAAU,CAAC;YAChB,KAAK,QAAQ,CAAC;YACd,KAAK,UAAU,CAAC;YAChB,KAAK,cAAc;gBAClB,OAAO,QAAQ,CAAC;YACjB,KAAK,KAAK,CAAC;YACX,KAAK,OAAO,CAAC;YACb,KAAK,cAAc;gBAClB,OAAO,QAAQ,CAAC;YACjB,KAAK,SAAS;gBACb,OAAO,QAAQ,CAAC;YACjB;gBACC,eAAe,CAAC,MAAe,CAAC,CAAC;SAClC;IACF,CAAC;IA5Be,2BAAS,YA4BxB,CAAA;IAED,SAAgB,qBAAqB,CACpC,MAGC;QAED,QAAQ,MAAM,EAAE;YACf,KAAK,SAAS;gBACb,OAAO,SAAS,CAAC;YAClB,KAAK,SAAS;gBACb,OAAO,SAAS,CAAC;YAClB,KAAK,aAAa;gBACjB,OAAO,aAAa,CAAC;YACtB,KAAK,cAAc;gBAClB,OAAO,cAAc,CAAC;YACvB,KAAK,UAAU;gBACd,OAAO,UAAU,CAAC;YACnB,KAAK,SAAS;gBACb,OAAO,SAAS,CAAC;YAClB,KAAK,QAAQ;gBACZ,OAAO,QAAQ,CAAC;YACjB,KAAK,UAAU;gBACd,OAAO,UAAU,CAAC;YACnB,KAAK,cAAc;gBAClB,OAAO,cAAc,CAAC;YACvB;gBACC,OAAO,SAAS,CAAC;SAClB;IACF,CAAC;IA5Be,uCAAqB,wBA4BpC,CAAA;AACF,CAAC,EA5DgB,iBAAiB,KAAjB,iBAAiB,QA4DjC;AAYD,MAAM,UAAU,mBAAmB,CAClC,GAAQ;IAKR,OAAO,GAAG,IAAI,iBAAiB,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;AACpD,CAAC;AAGD,MAAM,UAAU,gBAAgB,CAAC,GAAQ;IACxC,IAAM,UAAU,GAAyB,OAAO,CAAC;IACjD,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC;QAAE,OAAO,IAAI,CAAC;IAExC,OAAO,KAAK,CAAC;AACd,CAAC;AAGD,MAAM,UAAU,mBAAmB,CAAC,GAAQ;IAC3C,IAAM,SAAS,GAA4B,UAAU,CAAC;IACtD,IAAI,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC;QAAE,OAAO,IAAI,CAAC;IAEvC,OAAO,KAAK,CAAC;AACd,CAAC;AAGD,MAAM,UAAU,eAAe,CAAC,GAAQ;IACvC,IAAM,UAAU,GAAwB,MAAM,CAAC;IAC/C,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC;QAAE,OAAO,IAAI,CAAC;IAExC,OAAO,KAAK,CAAC;AACd,CAAC;AA6ED,YAAY;AAEZ,+BAA+B;AAC/B,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IACjB,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;AAClB,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AAyGD,MAAM,UAAU,cAAc,CAC7B,GAAQ;IAER,OAAO,GAAG,IAAyB,GAAI,CAAC,KAAK,KAAK,SAAS,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC/B,GAAQ;IAER,OAAO,GAAG,IAAyB,GAAI,CAAC,IAAI,KAAK,SAAS,CAAC;AAC5D,CAAC;AAQD,MAAM,CAAN,IAAY,QAGX;AAHD,WAAY,QAAQ;IACnB,yCAAK,CAAA;IACL,uCAAI,CAAA;AACL,CAAC,EAHW,QAAQ,KAAR,QAAQ,QAGnB;AAgED,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACxB,wCAAuB,CAAA;IACvB,0CAAyB,CAAA;AAC1B,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AA8FD,MAAM,CAAN,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC/B,2CAAmB,CAAA;IACnB,iDAAyB,CAAA;AAC1B,CAAC,EAHW,oBAAoB,KAApB,oBAAoB,QAG/B;AAkBD,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACzB,mCAAiB,CAAA;IACjB,+BAAa,CAAA;IACb,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AAClB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AA4CD,MAAM,UAAgB,cAAc,CAInC,gBAA+C,EAC/C,iBAA0C;;;YAK1C,sBAAO;oBACN,gBAAgB,kBAAA;oBAChB,iBAAiB,mBAAA;iBACjB,EAAC;;;CACF;AAmBD,MAAM,CAAC,IAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAgBzC,MAAM,CAAN,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACvC,+CAAe,CAAA;IACf,+CAAe,CAAA;AAChB,CAAC,EAHW,4BAA4B,KAA5B,4BAA4B,QAGvC;AACD,YAAY"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EACN,eAAe,EACf,SAAS,EACT,SAAS,EACT,aAAa,EACb,cAAc,EACd,UAAU,EACV,SAAS,EACT,QAAQ,EACR,UAAU,EACV,cAAc,EACd,2BAA2B,GAC3B,MAAM,QAAQ,CAAC;AAoChB,MAAM,UAAU,aAAa,CAAC,GAAQ;IACrC,OAAO,GAAG,IAAkB,GAAI,CAAC,UAAU,KAAK,SAAS,CAAC;AAC3D,CAAC;AAoBD,MAAM,UAAU,gBAAgB,CAAC,GAAQ;IACxC,OAAO,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC;AAClC,CAAC;AAQD,MAAM,UAAU,uBAAuB,CACtC,GAAQ;IAER,OAAO,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,UAAU,MAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,CAAA,CAAC;AAC5C,CAAC;AAuBD,MAAM,UAAU,oBAAoB,CACnC,IAAoB;IAEpB,OAAO,CACN,IAAI,CAAC,IAAI,KAAK,MAAM;QACpB,IAAI,CAAC,UAAU;QACf,IAAI,CAAC,UAAU,CAAC,KAAK;QACrB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAChC,CAAC;AACH,CAAC;AA0BD,MAAM,UAAU,mBAAmB,CAClC,IAAoB;IAEpB,OAAO,CACN,IAAI,CAAC,IAAI,KAAK,KAAK;QACnB,IAAI,CAAC,UAAU;QACf,IAAI,CAAC,UAAU,CAAC,MAAM;QACtB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CACjC,CAAC;AACH,CAAC;AAED,MAAM,UAAU,0BAA0B,CACzC,IAAoB;IAEpB,OAAO,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC3C,IAAoB;IAEpB,OAAO,CACN,mBAAmB,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS;QAClC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CACjC,CAAC;AACH,CAAC;AAYD,MAAM,CAAN,IAAY,uBAMX;AAND,WAAY,uBAAuB;IAClC,4CAAiB,CAAA;IACjB,0CAAe,CAAA;IACf,4CAAiB,CAAA;IACjB,8CAAmB,CAAA;IACnB,4CAAiB,CAAA;AAClB,CAAC,EANW,uBAAuB,KAAvB,uBAAuB,QAMlC;AAED,MAAM,CAAN,IAAY,0BAMX;AAND,WAAY,0BAA0B;IACrC,mDAAqB,CAAA;IACrB,sDAAwB,CAAA;IACxB,2CAAa,CAAA;IACb,yCAAW,CAAA;IACX,gDAAkB,CAAA;AACnB,CAAC,EANW,0BAA0B,KAA1B,0BAA0B,QAMrC;AAGD,MAAM,CAAN,IAAY,iBAeX;AAfD,WAAY,iBAAiB;IAC5B,qDAAE,CAAA;IACF,6DAAM,CAAA;IACN,uDAAG,CAAA;IACH,2DAAK,CAAA;IACL,+DAAO,CAAA;IACP,+DAAO,CAAA;IACP,+DAAO,CAAA;IACP,uEAAW,CAAA;IACX,yEAAY,CAAA;IACZ,iEAAQ,CAAA;IACR,gEAAO,CAAA;IACP,8DAAM,CAAA;IACN,kEAAQ,CAAA;IACR,0EAAY,CAAA;AACb,CAAC,EAfW,iBAAiB,KAAjB,iBAAiB,QAe5B;AAED,WAAiB,iBAAiB;IACjC,SAAgB,SAAS,CACxB,MAGC;QAED,QAAQ,MAAM,EAAE;YACf,KAAK,SAAS;gBACb,OAAO,SAAS,CAAC;YAClB,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,aAAa,CAAC;YACnB,KAAK,UAAU,CAAC;YAChB,KAAK,QAAQ,CAAC;YACd,KAAK,UAAU,CAAC;YAChB,KAAK,cAAc;gBAClB,OAAO,QAAQ,CAAC;YACjB,KAAK,KAAK,CAAC;YACX,KAAK,OAAO,CAAC;YACb,KAAK,cAAc;gBAClB,OAAO,QAAQ,CAAC;YACjB,KAAK,SAAS;gBACb,OAAO,QAAQ,CAAC;YACjB;gBACC,eAAe,CAAC,MAAe,CAAC,CAAC;SAClC;IACF,CAAC;IA5Be,2BAAS,YA4BxB,CAAA;IAED,SAAgB,qBAAqB,CACpC,MAGC;QAED,QAAQ,MAAM,EAAE;YACf,KAAK,SAAS;gBACb,OAAO,SAAS,CAAC;YAClB,KAAK,SAAS;gBACb,OAAO,SAAS,CAAC;YAClB,KAAK,aAAa;gBACjB,OAAO,aAAa,CAAC;YACtB,KAAK,cAAc;gBAClB,OAAO,cAAc,CAAC;YACvB,KAAK,UAAU;gBACd,OAAO,UAAU,CAAC;YACnB,KAAK,SAAS;gBACb,OAAO,SAAS,CAAC;YAClB,KAAK,QAAQ;gBACZ,OAAO,QAAQ,CAAC;YACjB,KAAK,UAAU;gBACd,OAAO,UAAU,CAAC;YACnB,KAAK,cAAc;gBAClB,OAAO,cAAc,CAAC;YACvB;gBACC,OAAO,SAAS,CAAC;SAClB;IACF,CAAC;IA5Be,uCAAqB,wBA4BpC,CAAA;AACF,CAAC,EA5DgB,iBAAiB,KAAjB,iBAAiB,QA4DjC;AAYD,MAAM,UAAU,mBAAmB,CAClC,GAAQ;IAKR,OAAO,GAAG,IAAI,iBAAiB,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;AACpD,CAAC;AAGD,MAAM,UAAU,gBAAgB,CAAC,GAAQ;IACxC,IAAM,UAAU,GAAyB,OAAO,CAAC;IACjD,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC;QAAE,OAAO,IAAI,CAAC;IAExC,OAAO,KAAK,CAAC;AACd,CAAC;AAGD,MAAM,UAAU,mBAAmB,CAAC,GAAQ;IAC3C,IAAM,SAAS,GAA4B,UAAU,CAAC;IACtD,IAAI,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC;QAAE,OAAO,IAAI,CAAC;IAEvC,OAAO,KAAK,CAAC;AACd,CAAC;AAGD,MAAM,UAAU,eAAe,CAAC,GAAQ;IACvC,IAAM,UAAU,GAAwB,MAAM,CAAC;IAC/C,IAAI,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC;QAAE,OAAO,IAAI,CAAC;IAExC,OAAO,KAAK,CAAC;AACd,CAAC;AA+LD,MAAM,UAAU,sBAAsB,CACrC,GAAQ,EACR,eAA4B;;IAE5B,IAAM,IAAI,GAAG,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAE1D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACd,IAAA,0JAAI,CAA4C;QAExD,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE;YAC9B,IAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAEjD,OAAO,OAAO,GAAG,KAAK,MAAM,CAAC;SAC7B;QAED,OAAO,KAAK,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,yBAAyB,CACxC,GAAQ,EACR,eAA4B;IAE5B,OAAO,CACN,sBAAsB,CAAI,GAAG,EAAE,eAAe,CAAC;QAC/C,kBAAkB,CAAI,GAAG,EAAE,eAAe,CAAC,CAC3C,CAAC;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CACjC,GAAQ,EACR,eAA4B;IAE5B,IAAM,IAAI,GAAG,2BAA2B,CAAC,eAAe,CAAC,CAAC;IAE1D,OAAO,CACN,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,UAAA,CAAC,IAAI,OAAA,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,EAApB,CAAoB,CAAC,CACvE,CAAC;AACH,CAAC;AACD,YAAY;AAEZ,+BAA+B;AAC/B,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IACjB,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;IACjB,2BAAiB,CAAA;AAClB,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AA6GD,MAAM,UAAU,cAAc,CAC7B,GAAQ;IAER,OAAO,GAAG,IAAyB,GAAI,CAAC,KAAK,KAAK,SAAS,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC/B,GAAQ;IAER,OAAO,GAAG,IAAyB,GAAI,CAAC,IAAI,KAAK,SAAS,CAAC;AAC5D,CAAC;AAQD,MAAM,CAAN,IAAY,QAGX;AAHD,WAAY,QAAQ;IACnB,yCAAK,CAAA;IACL,uCAAI,CAAA;AACL,CAAC,EAHW,QAAQ,KAAR,QAAQ,QAGnB;AAiED,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACxB,wCAAuB,CAAA;IACvB,0CAAyB,CAAA;AAC1B,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAuGD,MAAM,CAAN,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC/B,2CAAmB,CAAA;IACnB,iDAAyB,CAAA;AAC1B,CAAC,EAHW,oBAAoB,KAApB,oBAAoB,QAG/B;AAkBD,MAAM,CAAN,IAAY,cAKX;AALD,WAAY,cAAc;IACzB,mCAAiB,CAAA;IACjB,+BAAa,CAAA;IACb,mCAAiB,CAAA;IACjB,mCAAiB,CAAA;AAClB,CAAC,EALW,cAAc,KAAd,cAAc,QAKzB;AA4CD,MAAM,UAAgB,cAAc,CAInC,gBAA+C,EAC/C,iBAA0C;;;YAK1C,sBAAO;oBACN,gBAAgB,kBAAA;oBAChB,iBAAiB,mBAAA;iBACjB,EAAC;;;CACF;AA+BD,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACtB,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,sCAAyB,CAAA;AAC1B,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED,MAAM,CAAC,IAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAgBzC,MAAM,CAAN,IAAY,4BAGX;AAHD,WAAY,4BAA4B;IACvC,+CAAe,CAAA;IACf,+CAAe,CAAA;AAChB,CAAC,EAHW,4BAA4B,KAA5B,4BAA4B,QAGvC"}

package/lib-esm/util.d.ts

@@ -1,37 +1,15 @@
 import { ULID } from 'ulid';
-import { ModelInstanceMetadata, PersistentModel, PersistentModelConstructor, PredicateObject, PredicatesGroup, RelationshipType, RelationType, ModelKeys, ModelAttributes, SchemaNamespace, SortPredicatesGroup, NonModelTypeConstructor, DeferredCallbackResolverOptions } from './types';
-export declare const exhaustiveCheck: (obj: never, throwOnError?: boolean) => void;
-export declare const isNullOrUndefined: (val: any) => boolean;
-export declare const validatePredicate: <T extends Readonly<{
-    id: string;
-} & Record<string, any>>>(model: T, groupType: "and" | "or" | "not", predicatesOrGroups: (PredicateObject<T> | PredicatesGroup<T>)[]) => any;
-export declare const validatePredicateField: <T>(value: T, operator: "ne" | "eq" | "le" | "lt" | "ge" | "gt" | "between" | "beginsWith" | "contains" | "notContains", operand: T | [T, T]) => boolean;
-export declare const isModelConstructor: <T extends Readonly<{
-    id: string;
-} & Record<string, any>>>(obj: any) => obj is PersistentModelConstructor<T, {
-    readOnlyFields: "createdAt" | "updatedAt";
-}>;
-export declare function registerNonModelClass(clazz: NonModelTypeConstructor<any>): void;
-export declare const isNonModelConstructor: (obj: any) => obj is NonModelTypeConstructor<any>;
-export declare const processCompositeKeys: (attributes: ModelAttributes) => Set<string>[];
-export declare const establishRelationAndKeys: (namespace: SchemaNamespace) => [RelationshipType, ModelKeys];
-export declare const traverseModel: <T extends Readonly<{
-    id: string;
-} & Record<string, any>>>(srcModelName: string, instance: T, namespace: SchemaNamespace, modelInstanceCreator: <T_1 extends Readonly<{
-    id: string;
-} & Record<string, any>> = Readonly<{
-    id: string;
-} & Record<string, any>>>(modelConstructor: PersistentModelConstructor<T_1, {
-    readOnlyFields: "createdAt" | "updatedAt";
-}>, init: Pick<T_1, Exclude<keyof T_1, "id" | "createdAt" | "updatedAt">> & Partial<ModelInstanceMetadata>) => T_1, getModelConstructorByModelName: (namsespaceName: string, modelName: string) => PersistentModelConstructor<any, {
-    readOnlyFields: "createdAt" | "updatedAt";
-}>) => {
-    modelName: string;
-    item: T;
-    instance: T;
-}[];
-export declare const getIndex: (rel: RelationType[], src: string) => string;
-export declare const getIndexFromAssociation: (indexes: string[], src: string) => string;
+import { Patch } from 'immer';
+import { PersistentModel, PersistentModelConstructor, PredicateObject, PredicatesGroup, RelationshipType, RelationType, ModelKeys, ModelAttributes, SchemaNamespace, SortPredicatesGroup, NonModelTypeConstructor, DeferredCallbackResolverOptions, SchemaModel, ModelAttribute, IndexesType } from './types';
+export declare const errorMessages: {
+    idEmptyString: string;
+};
+export declare function extractKeyIfExists(modelDefinition: SchemaModel): ModelAttribute | undefined;
+export declare function extractPrimaryKeyFieldNames(modelDefinition: SchemaModel): string[];
+export declare function extractPrimaryKeyValues<T extends PersistentModel>(model: T, keyFields: string[]): string[];
+export declare function extractPrimaryKeysAndValues<T extends PersistentModel>(model: T, keyFields: string[]): any;
+export declare function isIdManaged(modelDefinition: SchemaModel): boolean;
+export declare function isIdOptionallyManaged(modelDefinition: SchemaModel): boolean;
 export declare enum NAMESPACES {
     DATASTORE = "datastore",
     USER = "user",
@@ -43,6 +21,23 @@ declare const USER = NAMESPACES.USER;
 declare const SYNC = NAMESPACES.SYNC;
 declare const STORAGE = NAMESPACES.STORAGE;
 export { USER, SYNC, STORAGE, DATASTORE };
+export declare const USER_AGENT_SUFFIX_DATASTORE = "/DataStore";
+export declare const exhaustiveCheck: (obj: never, throwOnError?: boolean) => void;
+export declare const isNullOrUndefined: (val: any) => boolean;
+export declare const validatePredicate: <T extends Readonly<Record<string, any>>>(model: T, groupType: "and" | "or" | "not", predicatesOrGroups: (PredicateObject<T> | PredicatesGroup<T>)[]) => any;
+export declare const validatePredicateField: <T>(value: T, operator: "ne" | "eq" | "le" | "lt" | "ge" | "gt" | "between" | "beginsWith" | "contains" | "notContains", operand: T | [T, T]) => boolean;
+export declare const isModelConstructor: <T extends Readonly<Record<string, any>>>(obj: any) => obj is PersistentModelConstructor<T>;
+export declare function registerNonModelClass(clazz: NonModelTypeConstructor<any>): void;
+export declare const isNonModelConstructor: (obj: any) => obj is NonModelTypeConstructor<any>;
+export declare const processCompositeKeys: (attributes: ModelAttributes) => Set<string>[];
+export declare const establishRelationAndKeys: (namespace: SchemaNamespace) => [RelationshipType, ModelKeys];
+export declare const traverseModel: <T extends Readonly<Record<string, any>>>(srcModelName: string, instance: T, namespace: SchemaNamespace, modelInstanceCreator: <T_1 extends Readonly<Record<string, any>>>(modelConstructor: PersistentModelConstructor<T_1>, init: Partial<T_1>) => T_1, getModelConstructorByModelName: (namsespaceName: string, modelName: string) => PersistentModelConstructor<any>) => {
+    modelName: string;
+    item: T;
+    instance: T;
+}[];
+export declare const getIndex: (rel: RelationType[], src: any) => string;
+export declare const getIndexFromAssociation: (indexes: IndexesType, src: string | string[]) => string;
 export declare const isPrivateMode: () => Promise<unknown>;
 export declare function monotonicUlidFactory(seed?: number): ULID;
 /**
@@ -91,3 +86,23 @@ export declare class DeferredCallbackResolver {
     clear(): void;
     resolve(): void;
 }
+/**
+ * merge two sets of patches created by immer produce.
+ * newPatches take precedent over oldPatches for patches modifying the same path.
+ * In the case many consecutive pathces are merged the original model should
+ * always be the root model.
+ *
+ * Example:
+ * A -> B, patches1
+ * B -> C, patches2
+ *
+ * mergePatches(A, patches1, patches2) to get patches for A -> C
+ *
+ * @param originalSource the original Model the patches should be applied to
+ * @param oldPatches immer produce patch list
+ * @param newPatches immer produce patch list (will take precedence)
+ * @return merged patches
+ */
+export declare function mergePatches<T>(originalSource: T, oldPatches: Patch[], newPatches: Patch[]): Patch[];
+export declare function extractTargetNamesFromSrc(src: any): string[] | undefined;
+export declare function indexNameFromKeys(keys: string[]): string;