@kaspernj/api-maker 1.0.2159 → 1.0.2161

package/build/model-events.d.ts

@@ -1,369 +1,162 @@
+/** @typedef {import("./base-model.js").default} BaseModel */
+/** @typedef {string | number | boolean | null} EventArgumentPrimitive */
+/** @typedef {EventArgumentPrimitive | EventArgumentPrimitive[]} EventArgumentValue */
+/** @typedef {{args: Record<string, EventArgumentValue>, eventName: string, model: BaseModel}} ModelEventPayload */
+/** @typedef {{args: Record<string, EventArgumentValue>, eventName: string}} ModelClassEventPayload */
+/** @typedef {{model: BaseModel}} ModelMutationPayload */
 /** Model and model-class ActionCable event connectors. */
 export default class ModelEvents {
     /**
-     * @param {import("./base-model.js").default} model
+     * Connects to a named event on one persisted model instance.
+     * @param {BaseModel} model
      * @param {string} eventName
-     * @param {(...args: any[]) => void} callback
+     * @param {(payload: ModelEventPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
-    static connect(model: {
-        changes: {};
-        newRecord: boolean;
-        relationshipsCache: {};
-        relationships: {};
-        abilities: Record<string, any>;
-        modelData: {};
-        assignAttributes(newAttributes: Record<string, any>): void;
-        attributes(): Record<string, any>;
-        can(givenAbilityName: string): boolean;
-        clone(): /*elided*/ any;
-        cacheKey(): number | string;
-        localCacheKey(): string;
-        fullCacheKey(): string;
-        create(attributes?: Record<string, any>, options?: object): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        createRaw(rawData: FormData | Record<string, any>, options?: object): Promise<{
-            model: /*elided*/ any;
-            response: any;
-        }>;
-        destroy(): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        ensureAbilities(listOfAbilities: string[]): Promise<void>;
-        getAttributes(): Record<string, any>;
-        handleResponseError(response: object): never;
-        identifierKey(): number | string;
-        _identifierKey: string | number;
-        isAssociationLoaded(associationName: string): boolean;
-        isAssociationLoadedUnderscore(associationNameUnderscore: string): boolean;
-        isAssociationPresent(associationName: string): boolean;
-        ensureAssociationLoaded(associationName: string): Promise<any>;
-        ensureAssociationLoadedUnderscore(associationNameUnderscore: string): Promise<any>;
-        isAttributeChanged(attributeName: string): boolean;
-        isChanged(): boolean;
-        isNewRecord(): boolean;
-        isPersisted(): boolean;
-        savedChangeToAttribute(attributeName: string): boolean;
-        setNewModel(model: /*elided*/ any): void;
-        setNewModelData(model: /*elided*/ any): void;
-        previousModelData: any;
-        _isDateChanged(oldValue: any, newValue: any): boolean | void;
-        _isIntegerChanged(oldValue: any, newValue: any): boolean | void;
-        _isStringChanged(oldValue: any, newValue: any): boolean | void;
-        modelClassData(): ModelClassDataType;
-        reload(): Promise<void>;
-        save(): Promise<{
-            model: /*elided*/ any;
-            response?: object;
-        }>;
-        saveRaw(rawData: any, options?: {}): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        update(newAttributes?: Record<string, any>, options?: ParseValidationErrorsOptions): Promise<{
-            model: /*elided*/ any;
-            response?: object;
-        }>;
-        _refreshModelFromResponse(response: object): void;
-        _refreshModelDataFromResponse(response: object): void;
-        updateRaw(rawData: FormData | Record<string, any>, options?: ParseValidationErrorsOptions & {
-            simpleModelErrors?: boolean;
-        }): Promise<{
-            response: object;
-            model: /*elided*/ any;
-        }>;
-        isValid(): never;
-        isValidOnServer(): Promise<{
-            valid: boolean;
-            errors: Record<string, any>;
-        }>;
-        modelClass(): Record<string, any>;
-        preloadRelationship(relationshipName: string, model: /*elided*/ any | /*elided*/ any[] | null): void;
-        markForDestruction(): void;
-        _markedForDestruction: boolean;
-        markedForDestruction(): boolean;
-        uniqueKey(): number;
-        uniqueKeyValue: number;
-        _callMemberCommand(args: Record<string, any>, commandArgs: Record<string, any>): Promise<object>;
-        readAttribute(attributeName: string): any;
-        readAttributeUnderscore(attributeName: string): any;
-        isAttributeLoaded(attributeName: any): boolean;
-        _isPresent(value: any): boolean;
-        _loadBelongsToReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<any | null>;
-        _readBelongsToReflection({ reflectionName }: {
-            modelClass: any;
-            reflectionName: string;
-        }): any | null;
-        _loadHasManyReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<Array<any>>;
-        _loadHasOneReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<any>;
-        _readHasOneReflection({ reflectionName }: {
-            modelClass: any;
-            reflectionName: string;
-        }): any | null;
-        _readModelDataFromArgs(args?: {
-            data?: {
-                b?: Record<string, any>;
-                a?: Record<string, any>;
-                r?: any;
-            };
-            collection?: import("./collection.js").default<any>;
-        }): void;
-        collection: import("./collection.js").default<any>;
-        preloadedRelationships: any;
-        _readPreloadedRelationships(preloaded: {
-            getModel: (relationshipType: string, relationshipId: number | string) => /*elided*/ any;
-        }): void;
-        primaryKey(): number | string;
-    }, eventName: string, callback: (...args: any[]) => void): import("./cable-subscription.js").default;
+    static connect(model: BaseModel, eventName: string, callback: (payload: ModelEventPayload) => void): import("./cable-subscription.js").default;
     /**
+     * Connects to a named model-class event stream.
      * @param {typeof import("./base-model.js").default} modelClass
      * @param {string} eventName
-     * @param {(...args: any[]) => void} callback
+     * @param {(payload: ModelClassEventPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
-    static connectModelClass(modelClass: typeof import("./base-model.js").default, eventName: string, callback: (...args: any[]) => void): import("./cable-subscription.js").default;
+    static connectModelClass(modelClass: typeof import("./base-model.js").default, eventName: string, callback: (payload: ModelClassEventPayload) => void): import("./cable-subscription.js").default;
     /**
+     * Connects to created events for a model class.
      * @param {typeof import("./base-model.js").default} modelClass
-     * @param {(...args: any[]) => void} callback
+     * @param {(payload: ModelMutationPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
-    static connectCreated(modelClass: typeof import("./base-model.js").default, callback: (...args: any[]) => void): import("./cable-subscription.js").default;
+    static connectCreated(modelClass: typeof import("./base-model.js").default, callback: (payload: ModelMutationPayload) => void): import("./cable-subscription.js").default;
     /**
-     * @param {import("./base-model.js").default} model
-     * @param {(...args: any[]) => void} callback
+     * Connects to destroy events for one persisted model instance.
+     * @param {BaseModel} model
+     * @param {(payload: ModelMutationPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
-    static connectDestroyed(model: {
-        changes: {};
-        newRecord: boolean;
-        relationshipsCache: {};
-        relationships: {};
-        abilities: Record<string, any>;
-        modelData: {};
-        assignAttributes(newAttributes: Record<string, any>): void;
-        attributes(): Record<string, any>;
-        can(givenAbilityName: string): boolean;
-        clone(): /*elided*/ any;
-        cacheKey(): number | string;
-        localCacheKey(): string;
-        fullCacheKey(): string;
-        create(attributes?: Record<string, any>, options?: object): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        createRaw(rawData: FormData | Record<string, any>, options?: object): Promise<{
-            model: /*elided*/ any;
-            response: any;
-        }>;
-        destroy(): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        ensureAbilities(listOfAbilities: string[]): Promise<void>;
-        getAttributes(): Record<string, any>;
-        handleResponseError(response: object): never;
-        identifierKey(): number | string;
-        _identifierKey: string | number;
-        isAssociationLoaded(associationName: string): boolean;
-        isAssociationLoadedUnderscore(associationNameUnderscore: string): boolean;
-        isAssociationPresent(associationName: string): boolean;
-        ensureAssociationLoaded(associationName: string): Promise<any>;
-        ensureAssociationLoadedUnderscore(associationNameUnderscore: string): Promise<any>;
-        isAttributeChanged(attributeName: string): boolean;
-        isChanged(): boolean;
-        isNewRecord(): boolean;
-        isPersisted(): boolean;
-        savedChangeToAttribute(attributeName: string): boolean;
-        setNewModel(model: /*elided*/ any): void;
-        setNewModelData(model: /*elided*/ any): void;
-        previousModelData: any;
-        _isDateChanged(oldValue: any, newValue: any): boolean | void;
-        _isIntegerChanged(oldValue: any, newValue: any): boolean | void;
-        _isStringChanged(oldValue: any, newValue: any): boolean | void;
-        modelClassData(): ModelClassDataType;
-        reload(): Promise<void>;
-        save(): Promise<{
-            model: /*elided*/ any;
-            response?: object;
-        }>;
-        saveRaw(rawData: any, options?: {}): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        update(newAttributes?: Record<string, any>, options?: ParseValidationErrorsOptions): Promise<{
-            model: /*elided*/ any;
-            response?: object;
-        }>;
-        _refreshModelFromResponse(response: object): void;
-        _refreshModelDataFromResponse(response: object): void;
-        updateRaw(rawData: FormData | Record<string, any>, options?: ParseValidationErrorsOptions & {
-            simpleModelErrors?: boolean;
-        }): Promise<{
-            response: object;
-            model: /*elided*/ any;
-        }>;
-        isValid(): never;
-        isValidOnServer(): Promise<{
-            valid: boolean;
-            errors: Record<string, any>;
-        }>;
-        modelClass(): Record<string, any>;
-        preloadRelationship(relationshipName: string, model: /*elided*/ any | /*elided*/ any[] | null): void;
-        markForDestruction(): void;
-        _markedForDestruction: boolean;
-        markedForDestruction(): boolean;
-        uniqueKey(): number;
-        uniqueKeyValue: number;
-        _callMemberCommand(args: Record<string, any>, commandArgs: Record<string, any>): Promise<object>;
-        readAttribute(attributeName: string): any;
-        readAttributeUnderscore(attributeName: string): any;
-        isAttributeLoaded(attributeName: any): boolean;
-        _isPresent(value: any): boolean;
-        _loadBelongsToReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<any | null>;
-        _readBelongsToReflection({ reflectionName }: {
-            modelClass: any;
-            reflectionName: string;
-        }): any | null;
-        _loadHasManyReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<Array<any>>;
-        _loadHasOneReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<any>;
-        _readHasOneReflection({ reflectionName }: {
-            modelClass: any;
-            reflectionName: string;
-        }): any | null;
-        _readModelDataFromArgs(args?: {
-            data?: {
-                b?: Record<string, any>;
-                a?: Record<string, any>;
-                r?: any;
-            };
-            collection?: import("./collection.js").default<any>;
-        }): void;
-        collection: import("./collection.js").default<any>;
-        preloadedRelationships: any;
-        _readPreloadedRelationships(preloaded: {
-            getModel: (relationshipType: string, relationshipId: number | string) => /*elided*/ any;
-        }): void;
-        primaryKey(): number | string;
-    }, callback: (...args: any[]) => void): import("./cable-subscription.js").default;
+    static connectDestroyed(model: BaseModel, callback: (payload: ModelMutationPayload) => void): import("./cable-subscription.js").default;
     /**
-     * @param {import("./base-model.js").default} model
-     * @param {(...args: any[]) => void} callback
+     * Connects to update events for one persisted model instance.
+     * @param {BaseModel} model
+     * @param {(payload: ModelMutationPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
-    static connectUpdated(model: {
-        changes: {};
-        newRecord: boolean;
-        relationshipsCache: {};
-        relationships: {};
-        abilities: Record<string, any>;
-        modelData: {};
-        assignAttributes(newAttributes: Record<string, any>): void;
-        attributes(): Record<string, any>;
-        can(givenAbilityName: string): boolean;
-        clone(): /*elided*/ any;
-        cacheKey(): number | string;
-        localCacheKey(): string;
-        fullCacheKey(): string;
-        create(attributes?: Record<string, any>, options?: object): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        createRaw(rawData: FormData | Record<string, any>, options?: object): Promise<{
-            model: /*elided*/ any;
-            response: any;
-        }>;
-        destroy(): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        ensureAbilities(listOfAbilities: string[]): Promise<void>;
-        getAttributes(): Record<string, any>;
-        handleResponseError(response: object): never;
-        identifierKey(): number | string;
-        _identifierKey: string | number;
-        isAssociationLoaded(associationName: string): boolean;
-        isAssociationLoadedUnderscore(associationNameUnderscore: string): boolean;
-        isAssociationPresent(associationName: string): boolean;
-        ensureAssociationLoaded(associationName: string): Promise<any>;
-        ensureAssociationLoadedUnderscore(associationNameUnderscore: string): Promise<any>;
-        isAttributeChanged(attributeName: string): boolean;
-        isChanged(): boolean;
-        isNewRecord(): boolean;
-        isPersisted(): boolean;
-        savedChangeToAttribute(attributeName: string): boolean;
-        setNewModel(model: /*elided*/ any): void;
-        setNewModelData(model: /*elided*/ any): void;
-        previousModelData: any;
-        _isDateChanged(oldValue: any, newValue: any): boolean | void;
-        _isIntegerChanged(oldValue: any, newValue: any): boolean | void;
-        _isStringChanged(oldValue: any, newValue: any): boolean | void;
-        modelClassData(): ModelClassDataType;
-        reload(): Promise<void>;
-        save(): Promise<{
-            model: /*elided*/ any;
-            response?: object;
-        }>;
-        saveRaw(rawData: any, options?: {}): Promise<{
-            model: /*elided*/ any;
-            response: object;
-        }>;
-        update(newAttributes?: Record<string, any>, options?: ParseValidationErrorsOptions): Promise<{
-            model: /*elided*/ any;
-            response?: object;
-        }>;
-        _refreshModelFromResponse(response: object): void;
-        _refreshModelDataFromResponse(response: object): void;
-        updateRaw(rawData: FormData | Record<string, any>, options?: ParseValidationErrorsOptions & {
-            simpleModelErrors?: boolean;
-        }): Promise<{
-            response: object;
-            model: /*elided*/ any;
-        }>;
-        isValid(): never;
-        isValidOnServer(): Promise<{
-            valid: boolean;
-            errors: Record<string, any>;
-        }>;
-        modelClass(): Record<string, any>;
-        preloadRelationship(relationshipName: string, model: /*elided*/ any | /*elided*/ any[] | null): void;
-        markForDestruction(): void;
-        _markedForDestruction: boolean;
-        markedForDestruction(): boolean;
-        uniqueKey(): number;
-        uniqueKeyValue: number;
-        _callMemberCommand(args: Record<string, any>, commandArgs: Record<string, any>): Promise<object>;
-        readAttribute(attributeName: string): any;
-        readAttributeUnderscore(attributeName: string): any;
-        isAttributeLoaded(attributeName: any): boolean;
-        _isPresent(value: any): boolean;
-        _loadBelongsToReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<any | null>;
-        _readBelongsToReflection({ reflectionName }: {
-            modelClass: any;
-            reflectionName: string;
-        }): any | null;
-        _loadHasManyReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<Array<any>>;
-        _loadHasOneReflection(args: import("./collection.js").CollectionArgsType<any>, queryArgs?: import("./collection.js").QueryArgsType): Promise<any>;
-        _readHasOneReflection({ reflectionName }: {
-            modelClass: any;
-            reflectionName: string;
-        }): any | null;
-        _readModelDataFromArgs(args?: {
-            data?: {
-                b?: Record<string, any>;
-                a?: Record<string, any>;
-                r?: any;
-            };
-            collection?: import("./collection.js").default<any>;
-        }): void;
-        collection: import("./collection.js").default<any>;
-        preloadedRelationships: any;
-        _readPreloadedRelationships(preloaded: {
-            getModel: (relationshipType: string, relationshipId: number | string) => /*elided*/ any;
-        }): void;
-        primaryKey(): number | string;
-    }, callback: (...args: any[]) => void): import("./cable-subscription.js").default;
+    static connectUpdated(model: BaseModel, callback: (payload: ModelMutationPayload) => void): import("./cable-subscription.js").default;
 }
+export type BaseModel = {
+    abilities: import("./base-model.js").ModelAbilityMap;
+    changes: import("./base-model.js").ModelDataMap;
+    collection: import("./collection.js").default<any>;
+    _identifierKey: string | number;
+    _markedForDestruction: boolean;
+    modelData: import("./base-model.js").ModelDataMap;
+    newRecord: boolean;
+    previousModelData: any;
+    preloadedRelationships: import("./base-model.js").PreloadedRelationshipMap;
+    relationshipsCache: import("./base-model.js").LoadedRelationshipMap;
+    relationships: import("./base-model.js").LoadedRelationshipMap;
+    uniqueKeyValue: number;
+    assignAttributes(newAttributes: ModelDataMap): void;
+    attributes(): ModelDataMap;
+    can(givenAbilityName: string): boolean;
+    clone(): /*elided*/ any;
+    cacheKey(): number | string;
+    localCacheKey(): string;
+    fullCacheKey(): string;
+    create(attributes?: ModelDataMap, options?: ParseValidationErrorsOptions): Promise<{
+        model: /*elided*/ any;
+        response: ModelCommandResponse;
+    }>;
+    createRaw(rawData: RawDataInput, options?: ParseValidationErrorsOptions): Promise<{
+        model: /*elided*/ any;
+        response: ModelCommandResponse;
+    }>;
+    destroy(): Promise<{
+        model: /*elided*/ any;
+        response: ModelCommandResponse;
+    }>;
+    ensureAbilities(listOfAbilities: string[]): Promise<void>;
+    getAttributes(): ModelDataMap;
+    handleResponseError(response: ModelCommandResponse): never;
+    identifierKey(): number | string;
+    isAssociationLoaded(associationName: string): boolean;
+    isAssociationLoadedUnderscore(associationNameUnderscore: string): boolean;
+    isAssociationPresent(associationName: string): boolean;
+    ensureAssociationLoaded(associationName: string): Promise<LoadedRelationshipValue>;
+    ensureAssociationLoadedUnderscore(associationNameUnderscore: string): Promise<LoadedRelationshipValue>;
+    isAttributeChanged(attributeName: string): boolean;
+    isChanged(): boolean;
+    isNewRecord(): boolean;
+    isPersisted(): boolean;
+    savedChangeToAttribute(attributeName: string): boolean;
+    setNewModel(model: /*elided*/ any): void;
+    setNewModelData(model: /*elided*/ any): void;
+    _isDateChanged(oldValue: ModelValue | null | undefined, newValue: ModelValue | null | undefined): boolean | void;
+    _isIntegerChanged(oldValue: ModelValue | null | undefined, newValue: ModelValue | null | undefined): boolean | void;
+    _isStringChanged(oldValue: ModelValue | null | undefined, newValue: ModelValue | null | undefined): boolean | void;
+    modelClassData(): ModelClassDataType;
+    reload(): Promise<void>;
+    save(): Promise<{
+        model: /*elided*/ any;
+        response?: object;
+    }>;
+    saveRaw(rawData: RawDataInput, options?: ParseValidationErrorsOptions & {
+        simpleModelErrors?: boolean;
+    }): Promise<{
+        model: /*elided*/ any;
+        response: ModelCommandResponse;
+    }>;
+    update(newAttributes?: ModelDataMap, options?: ParseValidationErrorsOptions): Promise<{
+        model: /*elided*/ any;
+        response?: object;
+    }>;
+    _refreshModelFromResponse(response: ModelCommandResponse): void;
+    _refreshModelDataFromResponse(response: ModelCommandResponse): void;
+    updateRaw(rawData: RawDataInput, options?: ParseValidationErrorsOptions & {
+        simpleModelErrors?: boolean;
+    }): Promise<{
+        response: ModelCommandResponse;
+        model: /*elided*/ any;
+    }>;
+    isValid(): never;
+    isValidOnServer(): Promise<{
+        valid: boolean;
+        errors: ValidationResponseErrors;
+    }>;
+    modelClass(): BaseModelClassType;
+    preloadRelationship(relationshipName: string, model: /*elided*/ any | /*elided*/ any[] | null): void;
+    markForDestruction(): void;
+    markedForDestruction(): boolean;
+    uniqueKey(): number;
+    _callMemberCommand(args: ModelCommandDescriptor, commandArgs: ModelCommandOptions): import("./command-execution.js").default;
+    readAttribute(attributeName: string): ModelValue | null | undefined;
+    readAttributeUnderscore(attributeName: string): ModelValue | null | undefined;
+    isAttributeLoaded(attributeName: string): boolean;
+    _isPresent(value: ModelValue | null | undefined): boolean;
+    _loadBelongsToReflection(args: RelationshipLoadArgs, queryArgs?: import("./collection.js").QueryArgsType): Promise</*elided*/ any | null>;
+    _readBelongsToReflection({ reflectionName }: RelationshipLoadArgs): /*elided*/ any | null;
+    _loadHasManyReflection(args: RelationshipLoadArgs, queryArgs?: import("./collection.js").QueryArgsType): Promise</*elided*/ any[]>;
+    _loadHasOneReflection(args: RelationshipLoadArgs, queryArgs?: import("./collection.js").QueryArgsType): Promise</*elided*/ any | null>;
+    _readHasOneReflection({ reflectionName }: RelationshipLoadArgs): /*elided*/ any | null;
+    _readModelDataFromArgs(args?: BaseModelArgsObject): void;
+    _readPreloadedRelationships(preloaded: {
+        getModel: (relationshipType: string, relationshipId: number | string) => /*elided*/ any;
+    }): void;
+    primaryKey(): number | string;
+};
+export type EventArgumentPrimitive = string | number | boolean | null;
+export type EventArgumentValue = EventArgumentPrimitive | EventArgumentPrimitive[];
+export type ModelEventPayload = {
+    args: Record<string, EventArgumentValue>;
+    eventName: string;
+    model: BaseModel;
+};
+export type ModelClassEventPayload = {
+    args: Record<string, EventArgumentValue>;
+    eventName: string;
+};
+export type ModelMutationPayload = {
+    model: BaseModel;
+};
 //# sourceMappingURL=model-events.d.ts.map

package/build/model-events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model-events.d.ts","sourceRoot":"/src/","sources":["model-events.js"],"names":[],"mappings":"AAGA,0DAA0D;AAC1D;IACE;;;;;OAKG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAwD4zpB,CAAC;;;;;;;;oBAA2iB,CAAC;;;;;6BAAypE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBA5Dx/uB,MAAM,YACN,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GACtB,OAAO,yBAAyB,EAAE,OAAO,CAOrD;IAED;;;;;OAKG;IACH,qCALW,cAAc,iBAAiB,EAAE,OAAO,aACxC,MAAM,YACN,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GACtB,OAAO,yBAAyB,EAAE,OAAO,CAOrD;IAED;;;;OAIG;IACH,kCAJW,cAAc,iBAAiB,EAAE,OAAO,YACxC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GACtB,OAAO,yBAAyB,EAAE,OAAO,CAOrD;IAED;;;;OAIG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAmB4zpB,CAAC;;;;;;;;oBAA2iB,CAAC;;;;;6BAAypE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAtBx/uB,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GACtB,OAAO,yBAAyB,EAAE,OAAO,CAOrD;IAED;;;;OAIG;IACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAO4zpB,CAAC;;;;;;;;oBAA2iB,CAAC;;;;;6BAAypE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAVx/uB,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GACtB,OAAO,yBAAyB,EAAE,OAAO,CAOrD;CACF"}
+{"version":3,"file":"model-events.d.ts","sourceRoot":"/src/","sources":["model-events.js"],"names":[],"mappings":"AAIA,6DAA6D;AAC7D,yEAAyE;AACzE,sFAAsF;AACtF,mHAAmH;AACnH,sGAAsG;AACtG,yDAAyD;AAEzD,0DAA0D;AAC1D;IACE;;;;;;OAMG;IACH,sBALW,SAAS,aACT,MAAM,YACN,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,GAClC,OAAO,yBAAyB,EAAE,OAAO,CAOrD;IAED;;;;;;OAMG;IACH,qCALW,cAAc,iBAAiB,EAAE,OAAO,aACxC,MAAM,YACN,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,GACvC,OAAO,yBAAyB,EAAE,OAAO,CAOrD;IAED;;;;;OAKG;IACH,kCAJW,cAAc,iBAAiB,EAAE,OAAO,YACxC,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,GACrC,OAAO,yBAAyB,EAAE,OAAO,CAOrD;IAED;;;;;OAKG;IACH,+BAJW,SAAS,YACT,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,GACrC,OAAO,yBAAyB,EAAE,OAAO,CAOrD;IAED;;;;;OAKG;IACH,6BAJW,SAAS,YACT,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,GACrC,OAAO,yBAAyB,EAAE,OAAO,CAOrD;CACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBACmyzB,CAAC;;;yBAA6O,CAAC;;;;;;;gBAAoc,CAAC;;;;;yBAAm7E,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCA3E935B,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI;iCAChC,sBAAsB,GAAG,sBAAsB,EAAE;gCACjD;IAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAC;qCAC/E;IAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAC;mCAC7D;IAAC,KAAK,EAAE,SAAS,CAAA;CAAC"}

package/build/model-events.js

@@ -1,11 +1,19 @@
+// @ts-check
 import CableConnectionPool from "./cable-connection-pool.js";
 import { digg } from "diggerize";
+/** @typedef {import("./base-model.js").default} BaseModel */
+/** @typedef {string | number | boolean | null} EventArgumentPrimitive */
+/** @typedef {EventArgumentPrimitive | EventArgumentPrimitive[]} EventArgumentValue */
+/** @typedef {{args: Record<string, EventArgumentValue>, eventName: string, model: BaseModel}} ModelEventPayload */
+/** @typedef {{args: Record<string, EventArgumentValue>, eventName: string}} ModelClassEventPayload */
+/** @typedef {{model: BaseModel}} ModelMutationPayload */
 /** Model and model-class ActionCable event connectors. */
 export default class ModelEvents {
     /**
-     * @param {import("./base-model.js").default} model
+     * Connects to a named event on one persisted model instance.
+     * @param {BaseModel} model
      * @param {string} eventName
-     * @param {(...args: any[]) => void} callback
+     * @param {(payload: ModelEventPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
     static connect(model, eventName, callback) {
@@ -14,9 +22,10 @@ export default class ModelEvents {
         return cableSubscription;
     }
     /**
+     * Connects to a named model-class event stream.
      * @param {typeof import("./base-model.js").default} modelClass
      * @param {string} eventName
-     * @param {(...args: any[]) => void} callback
+     * @param {(payload: ModelClassEventPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
     static connectModelClass(modelClass, eventName, callback) {
@@ -25,8 +34,9 @@ export default class ModelEvents {
         return cableSubscription;
     }
     /**
+     * Connects to created events for a model class.
      * @param {typeof import("./base-model.js").default} modelClass
-     * @param {(...args: any[]) => void} callback
+     * @param {(payload: ModelMutationPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
     static connectCreated(modelClass, callback) {
@@ -35,8 +45,9 @@ export default class ModelEvents {
         return cableSubscription;
     }
     /**
-     * @param {import("./base-model.js").default} model
-     * @param {(...args: any[]) => void} callback
+     * Connects to destroy events for one persisted model instance.
+     * @param {BaseModel} model
+     * @param {(payload: ModelMutationPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
     static connectDestroyed(model, callback) {
@@ -45,8 +56,9 @@ export default class ModelEvents {
         return cableSubscription;
     }
     /**
-     * @param {import("./base-model.js").default} model
-     * @param {(...args: any[]) => void} callback
+     * Connects to update events for one persisted model instance.
+     * @param {BaseModel} model
+     * @param {(payload: ModelMutationPayload) => void} callback
      * @returns {import("./cable-subscription.js").default}
      */
     static connectUpdated(model, callback) {
@@ -55,4 +67,4 @@ export default class ModelEvents {
         return cableSubscription;
     }
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kZWwtZXZlbnRzLmpzIiwic291cmNlUm9vdCI6Ii9zcmMvIiwic291cmNlcyI6WyJtb2RlbC1ldmVudHMuanMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxtQkFBbUIsTUFBTSw0QkFBNEIsQ0FBQTtBQUM1RCxPQUFPLEVBQUMsSUFBSSxFQUFDLE1BQU0sV0FBVyxDQUFBO0FBRTlCLDBEQUEwRDtBQUMxRCxNQUFNLENBQUMsT0FBTyxPQUFPLFdBQVc7SUFDOUI7Ozs7O09BS0c7SUFDSCxNQUFNLENBQUMsT0FBTyxDQUFFLEtBQUssRUFBRSxTQUFTLEVBQUUsUUFBUTtRQUN4QyxNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMsS0FBSyxDQUFDLGNBQWMsRUFBRSxFQUFFLE1BQU0sQ0FBQyxDQUFBO1FBQzNELE1BQU0saUJBQWlCLEdBQUcsbUJBQW1CLENBQUMsT0FBTyxFQUFFLENBQUMsWUFBWSxDQUFDLGNBQWMsRUFBRSxLQUFLLENBQUMsVUFBVSxFQUFFLEVBQUUsU0FBUyxFQUFFLFFBQVEsQ0FBQyxDQUFBO1FBRTdILE9BQU8saUJBQWlCLENBQUE7SUFDMUIsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsTUFBTSxDQUFDLGlCQUFpQixDQUFFLFVBQVUsRUFBRSxTQUFTLEVBQUUsUUFBUTtRQUN2RCxNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLGNBQWMsRUFBRSxFQUFFLE1BQU0sQ0FBQyxDQUFBO1FBQ2hFLE1BQU0saUJBQWlCLEdBQUcsbUJBQW1CLENBQUMsT0FBTyxFQUFFLENBQUMsc0JBQXNCLENBQUMsY0FBYyxFQUFFLFNBQVMsRUFBRSxRQUFRLENBQUMsQ0FBQTtRQUVuSCxPQUFPLGlCQUFpQixDQUFBO0lBQzFCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsTUFBTSxDQUFDLGNBQWMsQ0FBRSxVQUFVLEVBQUUsUUFBUTtRQUN6QyxNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLGNBQWMsRUFBRSxFQUFFLE1BQU0sQ0FBQyxDQUFBO1FBQ2hFLE1BQU0saUJBQWlCLEdBQUcsbUJBQW1CLENBQUMsT0FBTyxFQUFFLENBQUMsY0FBYyxDQUFDLGNBQWMsRUFBRSxRQUFRLENBQUMsQ0FBQTtRQUVoRyxPQUFPLGlCQUFpQixDQUFBO0lBQzFCLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsTUFBTSxDQUFDLGdCQUFnQixDQUFFLEtBQUssRUFBRSxRQUFRO1FBQ3RDLE1BQU0sY0FBYyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsY0FBYyxFQUFFLEVBQUUsTUFBTSxDQUFDLENBQUE7UUFDM0QsTUFBTSxpQkFBaUIsR0FBRyxtQkFBbUIsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxnQkFBZ0IsQ0FBQyxjQUFjLEVBQUUsS0FBSyxDQUFDLFVBQVUsRUFBRSxFQUFFLFFBQVEsQ0FBQyxDQUFBO1FBRXRILE9BQU8saUJBQWlCLENBQUE7SUFDMUIsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxNQUFNLENBQUMsY0FBYyxDQUFFLEtBQUssRUFBRSxRQUFRO1FBQ3BDLE1BQU0sY0FBYyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsY0FBYyxFQUFFLEVBQUUsTUFBTSxDQUFDLENBQUE7UUFDM0QsTUFBTSxpQkFBaUIsR0FBRyxtQkFBbUIsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxhQUFhLENBQUMsY0FBYyxFQUFFLEtBQUssQ0FBQyxVQUFVLEVBQUUsRUFBRSxRQUFRLENBQUMsQ0FBQTtRQUVuSCxPQUFPLGlCQUFpQixDQUFBO0lBQzFCLENBQUM7Q0FDRiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBDYWJsZUNvbm5lY3Rpb25Qb29sIGZyb20gXCIuL2NhYmxlLWNvbm5lY3Rpb24tcG9vbC5qc1wiXG5pbXBvcnQge2RpZ2d9IGZyb20gXCJkaWdnZXJpemVcIlxuXG4vKiogTW9kZWwgYW5kIG1vZGVsLWNsYXNzIEFjdGlvbkNhYmxlIGV2ZW50IGNvbm5lY3RvcnMuICovXG5leHBvcnQgZGVmYXVsdCBjbGFzcyBNb2RlbEV2ZW50cyB7XG4gIC8qKlxuICAgKiBAcGFyYW0ge2ltcG9ydChcIi4vYmFzZS1tb2RlbC5qc1wiKS5kZWZhdWx0fSBtb2RlbFxuICAgKiBAcGFyYW0ge3N0cmluZ30gZXZlbnROYW1lXG4gICAqIEBwYXJhbSB7KC4uLmFyZ3M6IGFueVtdKSA9PiB2b2lkfSBjYWxsYmFja1xuICAgKiBAcmV0dXJucyB7aW1wb3J0KFwiLi9jYWJsZS1zdWJzY3JpcHRpb24uanNcIikuZGVmYXVsdH1cbiAgICovXG4gIHN0YXRpYyBjb25uZWN0IChtb2RlbCwgZXZlbnROYW1lLCBjYWxsYmFjaykge1xuICAgIGNvbnN0IG1vZGVsQ2xhc3NOYW1lID0gZGlnZyhtb2RlbC5tb2RlbENsYXNzRGF0YSgpLCBcIm5hbWVcIilcbiAgICBjb25zdCBjYWJsZVN1YnNjcmlwdGlvbiA9IENhYmxlQ29ubmVjdGlvblBvb2wuY3VycmVudCgpLmNvbm5lY3RFdmVudChtb2RlbENsYXNzTmFtZSwgbW9kZWwucHJpbWFyeUtleSgpLCBldmVudE5hbWUsIGNhbGxiYWNrKVxuXG4gICAgcmV0dXJuIGNhYmxlU3Vic2NyaXB0aW9uXG4gIH1cblxuICAvKipcbiAgICogQHBhcmFtIHt0eXBlb2YgaW1wb3J0KFwiLi9iYXNlLW1vZGVsLmpzXCIpLmRlZmF1bHR9IG1vZGVsQ2xhc3NcbiAgICogQHBhcmFtIHtzdHJpbmd9IGV2ZW50TmFtZVxuICAgKiBAcGFyYW0geyguLi5hcmdzOiBhbnlbXSkgPT4gdm9pZH0gY2FsbGJhY2tcbiAgICogQHJldHVybnMge2ltcG9ydChcIi4vY2FibGUtc3Vic2NyaXB0aW9uLmpzXCIpLmRlZmF1bHR9XG4gICAqL1xuICBzdGF0aWMgY29ubmVjdE1vZGVsQ2xhc3MgKG1vZGVsQ2xhc3MsIGV2ZW50TmFtZSwgY2FsbGJhY2spIHtcbiAgICBjb25zdCBtb2RlbENsYXNzTmFtZSA9IGRpZ2cobW9kZWxDbGFzcy5tb2RlbENsYXNzRGF0YSgpLCBcIm5hbWVcIilcbiAgICBjb25zdCBjYWJsZVN1YnNjcmlwdGlvbiA9IENhYmxlQ29ubmVjdGlvblBvb2wuY3VycmVudCgpLmNvbm5lY3RNb2RlbENsYXNzRXZlbnQobW9kZWxDbGFzc05hbWUsIGV2ZW50TmFtZSwgY2FsbGJhY2spXG5cbiAgICByZXR1cm4gY2FibGVTdWJzY3JpcHRpb25cbiAgfVxuXG4gIC8qKlxuICAgKiBAcGFyYW0ge3R5cGVvZiBpbXBvcnQoXCIuL2Jhc2UtbW9kZWwuanNcIikuZGVmYXVsdH0gbW9kZWxDbGFzc1xuICAgKiBAcGFyYW0geyguLi5hcmdzOiBhbnlbXSkgPT4gdm9pZH0gY2FsbGJhY2tcbiAgICogQHJldHVybnMge2ltcG9ydChcIi4vY2FibGUtc3Vic2NyaXB0aW9uLmpzXCIpLmRlZmF1bHR9XG4gICAqL1xuICBzdGF0aWMgY29ubmVjdENyZWF0ZWQgKG1vZGVsQ2xhc3MsIGNhbGxiYWNrKSB7XG4gICAgY29uc3QgbW9kZWxDbGFzc05hbWUgPSBkaWdnKG1vZGVsQ2xhc3MubW9kZWxDbGFzc0RhdGEoKSwgXCJuYW1lXCIpXG4gICAgY29uc3QgY2FibGVTdWJzY3JpcHRpb24gPSBDYWJsZUNvbm5lY3Rpb25Qb29sLmN1cnJlbnQoKS5jb25uZWN0Q3JlYXRlZChtb2RlbENsYXNzTmFtZSwgY2FsbGJhY2spXG5cbiAgICByZXR1cm4gY2FibGVTdWJzY3JpcHRpb25cbiAgfVxuXG4gIC8qKlxuICAgKiBAcGFyYW0ge2ltcG9ydChcIi4vYmFzZS1tb2RlbC5qc1wiKS5kZWZhdWx0fSBtb2RlbFxuICAgKiBAcGFyYW0geyguLi5hcmdzOiBhbnlbXSkgPT4gdm9pZH0gY2FsbGJhY2tcbiAgICogQHJldHVybnMge2ltcG9ydChcIi4vY2FibGUtc3Vic2NyaXB0aW9uLmpzXCIpLmRlZmF1bHR9XG4gICAqL1xuICBzdGF0aWMgY29ubmVjdERlc3Ryb3llZCAobW9kZWwsIGNhbGxiYWNrKSB7XG4gICAgY29uc3QgbW9kZWxDbGFzc05hbWUgPSBkaWdnKG1vZGVsLm1vZGVsQ2xhc3NEYXRhKCksIFwibmFtZVwiKVxuICAgIGNvbnN0IGNhYmxlU3Vic2NyaXB0aW9uID0gQ2FibGVDb25uZWN0aW9uUG9vbC5jdXJyZW50KCkuY29ubmVjdERlc3Ryb3llZChtb2RlbENsYXNzTmFtZSwgbW9kZWwucHJpbWFyeUtleSgpLCBjYWxsYmFjaylcblxuICAgIHJldHVybiBjYWJsZVN1YnNjcmlwdGlvblxuICB9XG5cbiAgLyoqXG4gICAqIEBwYXJhbSB7aW1wb3J0KFwiLi9iYXNlLW1vZGVsLmpzXCIpLmRlZmF1bHR9IG1vZGVsXG4gICAqIEBwYXJhbSB7KC4uLmFyZ3M6IGFueVtdKSA9PiB2b2lkfSBjYWxsYmFja1xuICAgKiBAcmV0dXJucyB7aW1wb3J0KFwiLi9jYWJsZS1zdWJzY3JpcHRpb24uanNcIikuZGVmYXVsdH1cbiAgICovXG4gIHN0YXRpYyBjb25uZWN0VXBkYXRlZCAobW9kZWwsIGNhbGxiYWNrKSB7XG4gICAgY29uc3QgbW9kZWxDbGFzc05hbWUgPSBkaWdnKG1vZGVsLm1vZGVsQ2xhc3NEYXRhKCksIFwibmFtZVwiKVxuICAgIGNvbnN0IGNhYmxlU3Vic2NyaXB0aW9uID0gQ2FibGVDb25uZWN0aW9uUG9vbC5jdXJyZW50KCkuY29ubmVjdFVwZGF0ZShtb2RlbENsYXNzTmFtZSwgbW9kZWwucHJpbWFyeUtleSgpLCBjYWxsYmFjaylcblxuICAgIHJldHVybiBjYWJsZVN1YnNjcmlwdGlvblxuICB9XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kZWwtZXZlbnRzLmpzIiwic291cmNlUm9vdCI6Ii9zcmMvIiwic291cmNlcyI6WyJtb2RlbC1ldmVudHMuanMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsWUFBWTtBQUNaLE9BQU8sbUJBQW1CLE1BQU0sNEJBQTRCLENBQUE7QUFDNUQsT0FBTyxFQUFDLElBQUksRUFBQyxNQUFNLFdBQVcsQ0FBQTtBQUU5Qiw2REFBNkQ7QUFDN0QseUVBQXlFO0FBQ3pFLHNGQUFzRjtBQUN0RixtSEFBbUg7QUFDbkgsc0dBQXNHO0FBQ3RHLHlEQUF5RDtBQUV6RCwwREFBMEQ7QUFDMUQsTUFBTSxDQUFDLE9BQU8sT0FBTyxXQUFXO0lBQzlCOzs7Ozs7T0FNRztJQUNILE1BQU0sQ0FBQyxPQUFPLENBQUUsS0FBSyxFQUFFLFNBQVMsRUFBRSxRQUFRO1FBQ3hDLE1BQU0sY0FBYyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsY0FBYyxFQUFFLEVBQUUsTUFBTSxDQUFDLENBQUE7UUFDM0QsTUFBTSxpQkFBaUIsR0FBRyxtQkFBbUIsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxZQUFZLENBQUMsY0FBYyxFQUFFLEtBQUssQ0FBQyxVQUFVLEVBQUUsRUFBRSxTQUFTLEVBQUUsUUFBUSxDQUFDLENBQUE7UUFFN0gsT0FBTyxpQkFBaUIsQ0FBQTtJQUMxQixDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsTUFBTSxDQUFDLGlCQUFpQixDQUFFLFVBQVUsRUFBRSxTQUFTLEVBQUUsUUFBUTtRQUN2RCxNQUFNLGNBQWMsR0FBRyxJQUFJLENBQUMsVUFBVSxDQUFDLGNBQWMsRUFBRSxFQUFFLE1BQU0sQ0FBQyxDQUFBO1FBQ2hFLE1BQU0saUJBQWlCLEdBQUcsbUJBQW1CLENBQUMsT0FBTyxFQUFFLENBQUMsc0JBQXNCLENBQUMsY0FBYyxFQUFFLFNBQVMsRUFBRSxRQUFRLENBQUMsQ0FBQTtRQUVuSCxPQUFPLGlCQUFpQixDQUFBO0lBQzFCLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILE1BQU0sQ0FBQyxjQUFjLENBQUUsVUFBVSxFQUFFLFFBQVE7UUFDekMsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQyxjQUFjLEVBQUUsRUFBRSxNQUFNLENBQUMsQ0FBQTtRQUNoRSxNQUFNLGlCQUFpQixHQUFHLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxDQUFDLGNBQWMsQ0FBQyxjQUFjLEVBQUUsUUFBUSxDQUFDLENBQUE7UUFFaEcsT0FBTyxpQkFBaUIsQ0FBQTtJQUMxQixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxNQUFNLENBQUMsZ0JBQWdCLENBQUUsS0FBSyxFQUFFLFFBQVE7UUFDdEMsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxjQUFjLEVBQUUsRUFBRSxNQUFNLENBQUMsQ0FBQTtRQUMzRCxNQUFNLGlCQUFpQixHQUFHLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxDQUFDLGdCQUFnQixDQUFDLGNBQWMsRUFBRSxLQUFLLENBQUMsVUFBVSxFQUFFLEVBQUUsUUFBUSxDQUFDLENBQUE7UUFFdEgsT0FBTyxpQkFBaUIsQ0FBQTtJQUMxQixDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxNQUFNLENBQUMsY0FBYyxDQUFFLEtBQUssRUFBRSxRQUFRO1FBQ3BDLE1BQU0sY0FBYyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsY0FBYyxFQUFFLEVBQUUsTUFBTSxDQUFDLENBQUE7UUFDM0QsTUFBTSxpQkFBaUIsR0FBRyxtQkFBbUIsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxhQUFhLENBQUMsY0FBYyxFQUFFLEtBQUssQ0FBQyxVQUFVLEVBQUUsRUFBRSxRQUFRLENBQUMsQ0FBQTtRQUVuSCxPQUFPLGlCQUFpQixDQUFBO0lBQzFCLENBQUM7Q0FDRiIsInNvdXJjZXNDb250ZW50IjpbIi8vIEB0cy1jaGVja1xuaW1wb3J0IENhYmxlQ29ubmVjdGlvblBvb2wgZnJvbSBcIi4vY2FibGUtY29ubmVjdGlvbi1wb29sLmpzXCJcbmltcG9ydCB7ZGlnZ30gZnJvbSBcImRpZ2dlcml6ZVwiXG5cbi8qKiBAdHlwZWRlZiB7aW1wb3J0KFwiLi9iYXNlLW1vZGVsLmpzXCIpLmRlZmF1bHR9IEJhc2VNb2RlbCAqL1xuLyoqIEB0eXBlZGVmIHtzdHJpbmcgfCBudW1iZXIgfCBib29sZWFuIHwgbnVsbH0gRXZlbnRBcmd1bWVudFByaW1pdGl2ZSAqL1xuLyoqIEB0eXBlZGVmIHtFdmVudEFyZ3VtZW50UHJpbWl0aXZlIHwgRXZlbnRBcmd1bWVudFByaW1pdGl2ZVtdfSBFdmVudEFyZ3VtZW50VmFsdWUgKi9cbi8qKiBAdHlwZWRlZiB7e2FyZ3M6IFJlY29yZDxzdHJpbmcsIEV2ZW50QXJndW1lbnRWYWx1ZT4sIGV2ZW50TmFtZTogc3RyaW5nLCBtb2RlbDogQmFzZU1vZGVsfX0gTW9kZWxFdmVudFBheWxvYWQgKi9cbi8qKiBAdHlwZWRlZiB7e2FyZ3M6IFJlY29yZDxzdHJpbmcsIEV2ZW50QXJndW1lbnRWYWx1ZT4sIGV2ZW50TmFtZTogc3RyaW5nfX0gTW9kZWxDbGFzc0V2ZW50UGF5bG9hZCAqL1xuLyoqIEB0eXBlZGVmIHt7bW9kZWw6IEJhc2VNb2RlbH19IE1vZGVsTXV0YXRpb25QYXlsb2FkICovXG5cbi8qKiBNb2RlbCBhbmQgbW9kZWwtY2xhc3MgQWN0aW9uQ2FibGUgZXZlbnQgY29ubmVjdG9ycy4gKi9cbmV4cG9ydCBkZWZhdWx0IGNsYXNzIE1vZGVsRXZlbnRzIHtcbiAgLyoqXG4gICAqIENvbm5lY3RzIHRvIGEgbmFtZWQgZXZlbnQgb24gb25lIHBlcnNpc3RlZCBtb2RlbCBpbnN0YW5jZS5cbiAgICogQHBhcmFtIHtCYXNlTW9kZWx9IG1vZGVsXG4gICAqIEBwYXJhbSB7c3RyaW5nfSBldmVudE5hbWVcbiAgICogQHBhcmFtIHsocGF5bG9hZDogTW9kZWxFdmVudFBheWxvYWQpID0+IHZvaWR9IGNhbGxiYWNrXG4gICAqIEByZXR1cm5zIHtpbXBvcnQoXCIuL2NhYmxlLXN1YnNjcmlwdGlvbi5qc1wiKS5kZWZhdWx0fVxuICAgKi9cbiAgc3RhdGljIGNvbm5lY3QgKG1vZGVsLCBldmVudE5hbWUsIGNhbGxiYWNrKSB7XG4gICAgY29uc3QgbW9kZWxDbGFzc05hbWUgPSBkaWdnKG1vZGVsLm1vZGVsQ2xhc3NEYXRhKCksIFwibmFtZVwiKVxuICAgIGNvbnN0IGNhYmxlU3Vic2NyaXB0aW9uID0gQ2FibGVDb25uZWN0aW9uUG9vbC5jdXJyZW50KCkuY29ubmVjdEV2ZW50KG1vZGVsQ2xhc3NOYW1lLCBtb2RlbC5wcmltYXJ5S2V5KCksIGV2ZW50TmFtZSwgY2FsbGJhY2spXG5cbiAgICByZXR1cm4gY2FibGVTdWJzY3JpcHRpb25cbiAgfVxuXG4gIC8qKlxuICAgKiBDb25uZWN0cyB0byBhIG5hbWVkIG1vZGVsLWNsYXNzIGV2ZW50IHN0cmVhbS5cbiAgICogQHBhcmFtIHt0eXBlb2YgaW1wb3J0KFwiLi9iYXNlLW1vZGVsLmpzXCIpLmRlZmF1bHR9IG1vZGVsQ2xhc3NcbiAgICogQHBhcmFtIHtzdHJpbmd9IGV2ZW50TmFtZVxuICAgKiBAcGFyYW0geyhwYXlsb2FkOiBNb2RlbENsYXNzRXZlbnRQYXlsb2FkKSA9PiB2b2lkfSBjYWxsYmFja1xuICAgKiBAcmV0dXJucyB7aW1wb3J0KFwiLi9jYWJsZS1zdWJzY3JpcHRpb24uanNcIikuZGVmYXVsdH1cbiAgICovXG4gIHN0YXRpYyBjb25uZWN0TW9kZWxDbGFzcyAobW9kZWxDbGFzcywgZXZlbnROYW1lLCBjYWxsYmFjaykge1xuICAgIGNvbnN0IG1vZGVsQ2xhc3NOYW1lID0gZGlnZyhtb2RlbENsYXNzLm1vZGVsQ2xhc3NEYXRhKCksIFwibmFtZVwiKVxuICAgIGNvbnN0IGNhYmxlU3Vic2NyaXB0aW9uID0gQ2FibGVDb25uZWN0aW9uUG9vbC5jdXJyZW50KCkuY29ubmVjdE1vZGVsQ2xhc3NFdmVudChtb2RlbENsYXNzTmFtZSwgZXZlbnROYW1lLCBjYWxsYmFjaylcblxuICAgIHJldHVybiBjYWJsZVN1YnNjcmlwdGlvblxuICB9XG5cbiAgLyoqXG4gICAqIENvbm5lY3RzIHRvIGNyZWF0ZWQgZXZlbnRzIGZvciBhIG1vZGVsIGNsYXNzLlxuICAgKiBAcGFyYW0ge3R5cGVvZiBpbXBvcnQoXCIuL2Jhc2UtbW9kZWwuanNcIikuZGVmYXVsdH0gbW9kZWxDbGFzc1xuICAgKiBAcGFyYW0geyhwYXlsb2FkOiBNb2RlbE11dGF0aW9uUGF5bG9hZCkgPT4gdm9pZH0gY2FsbGJhY2tcbiAgICogQHJldHVybnMge2ltcG9ydChcIi4vY2FibGUtc3Vic2NyaXB0aW9uLmpzXCIpLmRlZmF1bHR9XG4gICAqL1xuICBzdGF0aWMgY29ubmVjdENyZWF0ZWQgKG1vZGVsQ2xhc3MsIGNhbGxiYWNrKSB7XG4gICAgY29uc3QgbW9kZWxDbGFzc05hbWUgPSBkaWdnKG1vZGVsQ2xhc3MubW9kZWxDbGFzc0RhdGEoKSwgXCJuYW1lXCIpXG4gICAgY29uc3QgY2FibGVTdWJzY3JpcHRpb24gPSBDYWJsZUNvbm5lY3Rpb25Qb29sLmN1cnJlbnQoKS5jb25uZWN0Q3JlYXRlZChtb2RlbENsYXNzTmFtZSwgY2FsbGJhY2spXG5cbiAgICByZXR1cm4gY2FibGVTdWJzY3JpcHRpb25cbiAgfVxuXG4gIC8qKlxuICAgKiBDb25uZWN0cyB0byBkZXN0cm95IGV2ZW50cyBmb3Igb25lIHBlcnNpc3RlZCBtb2RlbCBpbnN0YW5jZS5cbiAgICogQHBhcmFtIHtCYXNlTW9kZWx9IG1vZGVsXG4gICAqIEBwYXJhbSB7KHBheWxvYWQ6IE1vZGVsTXV0YXRpb25QYXlsb2FkKSA9PiB2b2lkfSBjYWxsYmFja1xuICAgKiBAcmV0dXJucyB7aW1wb3J0KFwiLi9jYWJsZS1zdWJzY3JpcHRpb24uanNcIikuZGVmYXVsdH1cbiAgICovXG4gIHN0YXRpYyBjb25uZWN0RGVzdHJveWVkIChtb2RlbCwgY2FsbGJhY2spIHtcbiAgICBjb25zdCBtb2RlbENsYXNzTmFtZSA9IGRpZ2cobW9kZWwubW9kZWxDbGFzc0RhdGEoKSwgXCJuYW1lXCIpXG4gICAgY29uc3QgY2FibGVTdWJzY3JpcHRpb24gPSBDYWJsZUNvbm5lY3Rpb25Qb29sLmN1cnJlbnQoKS5jb25uZWN0RGVzdHJveWVkKG1vZGVsQ2xhc3NOYW1lLCBtb2RlbC5wcmltYXJ5S2V5KCksIGNhbGxiYWNrKVxuXG4gICAgcmV0dXJuIGNhYmxlU3Vic2NyaXB0aW9uXG4gIH1cblxuICAvKipcbiAgICogQ29ubmVjdHMgdG8gdXBkYXRlIGV2ZW50cyBmb3Igb25lIHBlcnNpc3RlZCBtb2RlbCBpbnN0YW5jZS5cbiAgICogQHBhcmFtIHtCYXNlTW9kZWx9IG1vZGVsXG4gICAqIEBwYXJhbSB7KHBheWxvYWQ6IE1vZGVsTXV0YXRpb25QYXlsb2FkKSA9PiB2b2lkfSBjYWxsYmFja1xuICAgKiBAcmV0dXJucyB7aW1wb3J0KFwiLi9jYWJsZS1zdWJzY3JpcHRpb24uanNcIikuZGVmYXVsdH1cbiAgICovXG4gIHN0YXRpYyBjb25uZWN0VXBkYXRlZCAobW9kZWwsIGNhbGxiYWNrKSB7XG4gICAgY29uc3QgbW9kZWxDbGFzc05hbWUgPSBkaWdnKG1vZGVsLm1vZGVsQ2xhc3NEYXRhKCksIFwibmFtZVwiKVxuICAgIGNvbnN0IGNhYmxlU3Vic2NyaXB0aW9uID0gQ2FibGVDb25uZWN0aW9uUG9vbC5jdXJyZW50KCkuY29ubmVjdFVwZGF0ZShtb2RlbENsYXNzTmFtZSwgbW9kZWwucHJpbWFyeUtleSgpLCBjYWxsYmFjaylcblxuICAgIHJldHVybiBjYWJsZVN1YnNjcmlwdGlvblxuICB9XG59XG4iXX0=

package/build/model-name.d.ts

@@ -1,12 +1,17 @@
+/**
+ * @typedef {object} ModelClassDataLike
+ * @property {string} camelizedLower
+ * @property {string} i18nKey
+ * @property {string} name
+ * @property {string} paramKey
+ * @typedef {object} ModelNameData
+ * @property {ModelClassDataLike} modelClassData
+ */
 /** Model name helper for i18n lookups and metadata. */
 export default class ModelName {
-    /** @param {{modelClassData: Record<string, any>}} data */
-    constructor(data: {
-        modelClassData: Record<string, any>;
-    });
-    data: {
-        modelClassData: Record<string, any>;
-    };
+    /** @param {ModelNameData} data */
+    constructor(data: ModelNameData);
+    data: ModelNameData;
     /** @returns {string} */
     camelizedLower: () => string;
     /**
@@ -19,4 +24,13 @@ export default class ModelName {
     /** @returns {string} */
     paramKey: () => string;
 }
+export type ModelClassDataLike = {
+    camelizedLower: string;
+    i18nKey: string;
+    name: string;
+    paramKey: string;
+};
+export type ModelNameData = {
+    modelClassData: ModelClassDataLike;
+};
 //# sourceMappingURL=model-name.d.ts.map

package/build/model-name.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model-name.d.ts","sourceRoot":"/src/","sources":["model-name.js"],"names":[],"mappings":"AAGA,uDAAuD;AACvD;IACE,0DAA0D;IAC1D,kBADY;QAAC,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAC,EAGhD;IADC;wBAF2B,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;MAE9B;IAGlB,wBAAwB;IACxB,sBADc,MAAM,CAC0C;IAE9D;;;OAGG;IACH,aAHW;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,GACd,MAAM,CAsBlB;IAED,wBAAwB;IACxB,gBADc,MAAM,CAC8B;CACnD"}
+{"version":3,"file":"model-name.d.ts","sourceRoot":"/src/","sources":["model-name.js"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AAEH,uDAAuD;AACvD;IACE,kCAAkC;IAClC,kBADY,aAAa,EAGxB;IADC,oBAAgB;IAGlB,wBAAwB;IACxB,sBADc,MAAM,CAC0C;IAE9D;;;OAGG;IACH,aAHW;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAC,GACd,MAAM,CAsBlB;IAED,wBAAwB;IACxB,gBADc,MAAM,CAC8B;CACnD;;oBA9Ca,MAAM;aACN,MAAM;UACN,MAAM;cACN,MAAM;;;oBAEN,kBAAkB"}